2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
7 * This library is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Library General Public
9 * License as published by the Free Software Foundation; either
10 * version 2 of the License, or (at your option) any later version.
12 * This library is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Library General Public License for more details.
17 * You should have received a copy of the GNU Library General Public
18 * License along with this library; if not, write to the
19 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
20 * Boston, MA 02111-1307, USA.
24 * SECTION:element-fdsink
25 * @see_also: #GstFdSrc
27 * Write data to a unix file descriptor.
29 * This element will synchronize on the clock before writing the data on the
30 * socket. For file descriptors where this does not make sense (files, ...) the
31 * #GstBaseSink:sync property can be used to disable synchronisation.
33 * Last reviewed on 2006-04-28 (0.10.6)
40 #include "../../gst/gst-i18n-lib.h"
42 #include <sys/types.h>
45 #include <io.h> /* lseek, open, close, read */
47 #define lseek _lseeki64
53 #ifdef HAVE_SYS_SOCKET_H
54 #include <sys/socket.h>
65 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
70 #include "gstfdsink.h"
72 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
77 GST_DEBUG_CATEGORY_STATIC (gst_fd_sink__debug);
78 #define GST_CAT_DEFAULT gst_fd_sink__debug
81 /* FdSink signals and args */
94 static void gst_fd_sink_uri_handler_init (gpointer g_iface,
98 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_sink_uri_handler_init); \
99 GST_DEBUG_CATEGORY_INIT (gst_fd_sink__debug, "fdsink", 0, "fdsink element");
100 #define gst_fd_sink_parent_class parent_class
101 G_DEFINE_TYPE_WITH_CODE (GstFdSink, gst_fd_sink, GST_TYPE_BASE_SINK, _do_init);
103 static void gst_fd_sink_set_property (GObject * object, guint prop_id,
104 const GValue * value, GParamSpec * pspec);
105 static void gst_fd_sink_get_property (GObject * object, guint prop_id,
106 GValue * value, GParamSpec * pspec);
107 static void gst_fd_sink_dispose (GObject * obj);
109 static gboolean gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query);
110 static GstFlowReturn gst_fd_sink_render (GstBaseSink * sink,
112 static gboolean gst_fd_sink_start (GstBaseSink * basesink);
113 static gboolean gst_fd_sink_stop (GstBaseSink * basesink);
114 static gboolean gst_fd_sink_unlock (GstBaseSink * basesink);
115 static gboolean gst_fd_sink_unlock_stop (GstBaseSink * basesink);
116 static gboolean gst_fd_sink_event (GstBaseSink * sink, GstEvent * event);
118 static gboolean gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset);
121 gst_fd_sink_class_init (GstFdSinkClass * klass)
123 GObjectClass *gobject_class;
124 GstElementClass *gstelement_class;
125 GstBaseSinkClass *gstbasesink_class;
127 gobject_class = G_OBJECT_CLASS (klass);
128 gstelement_class = GST_ELEMENT_CLASS (klass);
129 gstbasesink_class = GST_BASE_SINK_CLASS (klass);
131 gobject_class->set_property = gst_fd_sink_set_property;
132 gobject_class->get_property = gst_fd_sink_get_property;
133 gobject_class->dispose = gst_fd_sink_dispose;
135 gst_element_class_set_details_simple (gstelement_class,
136 "Filedescriptor Sink",
138 "Write data to a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
139 gst_element_class_add_pad_template (gstelement_class,
140 gst_static_pad_template_get (&sinktemplate));
142 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_fd_sink_render);
143 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_fd_sink_start);
144 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_fd_sink_stop);
145 gstbasesink_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock);
146 gstbasesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock_stop);
147 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_fd_sink_event);
148 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_fd_sink_query);
150 g_object_class_install_property (gobject_class, ARG_FD,
151 g_param_spec_int ("fd", "fd", "An open file descriptor to write to",
152 0, G_MAXINT, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
156 gst_fd_sink_init (GstFdSink * fdsink)
159 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
160 fdsink->bytes_written = 0;
161 fdsink->current_pos = 0;
163 gst_base_sink_set_sync (GST_BASE_SINK (fdsink), FALSE);
167 gst_fd_sink_dispose (GObject * obj)
169 GstFdSink *fdsink = GST_FD_SINK (obj);
171 g_free (fdsink->uri);
174 G_OBJECT_CLASS (parent_class)->dispose (obj);
178 gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query)
180 gboolean res = FALSE;
183 fdsink = GST_FD_SINK (bsink);
185 switch (GST_QUERY_TYPE (query)) {
186 case GST_QUERY_POSITION:
190 gst_query_parse_position (query, &format, NULL);
193 case GST_FORMAT_DEFAULT:
194 case GST_FORMAT_BYTES:
195 gst_query_set_position (query, GST_FORMAT_BYTES, fdsink->current_pos);
203 case GST_QUERY_FORMATS:
204 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
208 gst_query_set_uri (query, fdsink->uri);
212 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
220 gst_fd_sink_render (GstBaseSink * sink, GstBuffer * buffer)
232 fdsink = GST_FD_SINK (sink);
234 g_return_val_if_fail (fdsink->fd >= 0, GST_FLOW_ERROR);
236 gst_buffer_map (buffer, &info, GST_MAP_READ);
244 GST_DEBUG_OBJECT (fdsink, "going into select, have %" G_GSIZE_FORMAT
245 " bytes to write", info.size);
246 retval = gst_poll_wait (fdsink->fdset, GST_CLOCK_TIME_NONE);
247 } while (retval == -1 && (errno == EINTR || errno == EAGAIN));
257 GST_DEBUG_OBJECT (fdsink, "writing %" G_GSIZE_FORMAT " bytes to"
258 " file descriptor %d", info.size, fdsink->fd);
260 written = write (fdsink->fd, ptr, left);
262 /* check for errors */
263 if (G_UNLIKELY (written < 0)) {
264 /* try to write again on non-fatal errors */
265 if (errno == EAGAIN || errno == EINTR)
268 /* else go to our error handler */
272 /* all is fine when we get here */
275 fdsink->bytes_written += written;
276 fdsink->current_pos += written;
278 GST_DEBUG_OBJECT (fdsink, "wrote %d bytes, %" G_GSIZE_FORMAT " left", written,
281 /* short write, select and try to write the remainder */
282 if (G_UNLIKELY (left > 0))
285 gst_buffer_unmap (buffer, &info);
292 GST_ELEMENT_ERROR (fdsink, RESOURCE, READ, (NULL),
293 ("select on file descriptor: %s.", g_strerror (errno)));
294 GST_DEBUG_OBJECT (fdsink, "Error during select");
295 gst_buffer_unmap (buffer, &info);
296 return GST_FLOW_ERROR;
300 GST_DEBUG_OBJECT (fdsink, "Select stopped");
301 gst_buffer_unmap (buffer, &info);
302 return GST_FLOW_FLUSHING;
310 GST_ELEMENT_ERROR (fdsink, RESOURCE, NO_SPACE_LEFT, (NULL), (NULL));
313 GST_ELEMENT_ERROR (fdsink, RESOURCE, WRITE, (NULL),
314 ("Error while writing to file descriptor %d: %s",
315 fdsink->fd, g_strerror (errno)));
318 gst_buffer_unmap (buffer, &info);
319 return GST_FLOW_ERROR;
324 gst_fd_sink_check_fd (GstFdSink * fdsink, int fd, GError ** error)
326 struct stat stat_results;
329 /* see that it is a valid file descriptor */
330 if (fstat (fd, &stat_results) < 0)
333 if (!S_ISREG (stat_results.st_mode))
336 /* see if it is a seekable stream */
337 result = lseek (fd, 0, SEEK_CUR);
348 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is seekable", fd);
354 GST_ELEMENT_ERROR (fdsink, RESOURCE, WRITE, (NULL),
355 ("File descriptor %d is not valid: %s", fd, g_strerror (errno)));
356 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
357 "File descriptor %d is not valid: %s", fd, g_strerror (errno));
362 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is a pipe", fd);
368 gst_fd_sink_start (GstBaseSink * basesink)
371 GstPollFD fd = GST_POLL_FD_INIT;
373 fdsink = GST_FD_SINK (basesink);
374 if (!gst_fd_sink_check_fd (fdsink, fdsink->fd, NULL))
377 if ((fdsink->fdset = gst_poll_new (TRUE)) == NULL)
381 gst_poll_add_fd (fdsink->fdset, &fd);
382 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
384 fdsink->bytes_written = 0;
385 fdsink->current_pos = 0;
392 GST_ELEMENT_ERROR (fdsink, RESOURCE, OPEN_READ_WRITE, (NULL),
399 gst_fd_sink_stop (GstBaseSink * basesink)
401 GstFdSink *fdsink = GST_FD_SINK (basesink);
404 gst_poll_free (fdsink->fdset);
405 fdsink->fdset = NULL;
412 gst_fd_sink_unlock (GstBaseSink * basesink)
414 GstFdSink *fdsink = GST_FD_SINK (basesink);
416 GST_LOG_OBJECT (fdsink, "Flushing");
417 GST_OBJECT_LOCK (fdsink);
418 gst_poll_set_flushing (fdsink->fdset, TRUE);
419 GST_OBJECT_UNLOCK (fdsink);
425 gst_fd_sink_unlock_stop (GstBaseSink * basesink)
427 GstFdSink *fdsink = GST_FD_SINK (basesink);
429 GST_LOG_OBJECT (fdsink, "No longer flushing");
430 GST_OBJECT_LOCK (fdsink);
431 gst_poll_set_flushing (fdsink->fdset, FALSE);
432 GST_OBJECT_UNLOCK (fdsink);
438 gst_fd_sink_update_fd (GstFdSink * fdsink, int new_fd, GError ** error)
441 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
442 "File descriptor %d is not valid", new_fd);
446 if (!gst_fd_sink_check_fd (fdsink, new_fd, error))
450 GST_OBJECT_LOCK (fdsink);
452 GstPollFD fd = GST_POLL_FD_INIT;
455 gst_poll_remove_fd (fdsink->fdset, &fd);
458 gst_poll_add_fd (fdsink->fdset, &fd);
459 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
462 g_free (fdsink->uri);
463 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
465 GST_OBJECT_UNLOCK (fdsink);
476 gst_fd_sink_set_property (GObject * object, guint prop_id,
477 const GValue * value, GParamSpec * pspec)
481 fdsink = GST_FD_SINK (object);
487 fd = g_value_get_int (value);
488 gst_fd_sink_update_fd (fdsink, fd, NULL);
492 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
498 gst_fd_sink_get_property (GObject * object, guint prop_id, GValue * value,
503 fdsink = GST_FD_SINK (object);
507 g_value_set_int (value, fdsink->fd);
510 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
516 gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset)
520 result = lseek (fdsink->fd, new_offset, SEEK_SET);
525 fdsink->current_pos = new_offset;
527 GST_DEBUG_OBJECT (fdsink, "File descriptor %d to seek to position "
528 "%" G_GUINT64_FORMAT, fdsink->fd, fdsink->current_pos);
535 GST_DEBUG_OBJECT (fdsink, "File descriptor %d failed to seek to position "
536 "%" G_GUINT64_FORMAT, fdsink->fd, new_offset);
542 gst_fd_sink_event (GstBaseSink * sink, GstEvent * event)
547 fdsink = GST_FD_SINK (sink);
549 type = GST_EVENT_TYPE (event);
552 case GST_EVENT_SEGMENT:
554 const GstSegment *segment;
556 gst_event_parse_segment (event, &segment);
558 if (segment->format == GST_FORMAT_BYTES) {
559 /* only try to seek and fail when we are going to a different
561 if (fdsink->current_pos != segment->start) {
562 /* FIXME, the seek should be performed on the pos field, start/stop are
563 * just boundaries for valid bytes offsets. We should also fill the file
564 * with zeroes if the new position extends the current EOF (sparse streams
565 * and segment accumulation). */
566 if (!gst_fd_sink_do_seek (fdsink, (guint64) segment->start))
570 GST_DEBUG_OBJECT (fdsink,
571 "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
572 gst_format_get_name (segment->format));
580 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
584 GST_ELEMENT_ERROR (fdsink, RESOURCE, SEEK, (NULL),
585 ("Error while seeking on file descriptor %d: %s",
586 fdsink->fd, g_strerror (errno)));
587 gst_event_unref (event);
593 /*** GSTURIHANDLER INTERFACE *************************************************/
596 gst_fd_sink_uri_get_type (GType type)
601 static const gchar *const *
602 gst_fd_sink_uri_get_protocols (GType type)
604 static const gchar *protocols[] = { "fd", NULL };
610 gst_fd_sink_uri_get_uri (GstURIHandler * handler)
612 GstFdSink *sink = GST_FD_SINK (handler);
614 /* FIXME: make thread-safe */
615 return g_strdup (sink->uri);
619 gst_fd_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
622 GstFdSink *sink = GST_FD_SINK (handler);
625 if (sscanf (uri, "fd://%d", &fd) != 1) {
626 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
627 "File descriptor URI could not be parsed");
631 return gst_fd_sink_update_fd (sink, fd, error);
635 gst_fd_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
637 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
639 iface->get_type = gst_fd_sink_uri_get_type;
640 iface->get_protocols = gst_fd_sink_uri_get_protocols;
641 iface->get_uri = gst_fd_sink_uri_get_uri;
642 iface->set_uri = gst_fd_sink_uri_set_uri;