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., 51 Franklin St, Fifth Floor,
20 * Boston, MA 02110-1301, 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.
38 #include "../../gst/gst-i18n-lib.h"
40 #include <sys/types.h>
43 #ifdef HAVE_SYS_SOCKET_H
44 #include <sys/socket.h>
55 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
60 #include "gstfdsink.h"
61 #include "gstelements_private.h"
64 #include <io.h> /* lseek, open, close, read */
66 #define lseek _lseeki64
71 #ifdef __BIONIC__ /* Android */
80 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
85 GST_DEBUG_CATEGORY_STATIC (gst_fd_sink__debug);
86 #define GST_CAT_DEFAULT gst_fd_sink__debug
89 /* FdSink signals and args */
102 static void gst_fd_sink_uri_handler_init (gpointer g_iface,
103 gpointer iface_data);
106 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_sink_uri_handler_init); \
107 GST_DEBUG_CATEGORY_INIT (gst_fd_sink__debug, "fdsink", 0, "fdsink element");
108 #define gst_fd_sink_parent_class parent_class
109 G_DEFINE_TYPE_WITH_CODE (GstFdSink, gst_fd_sink, GST_TYPE_BASE_SINK, _do_init);
111 static void gst_fd_sink_set_property (GObject * object, guint prop_id,
112 const GValue * value, GParamSpec * pspec);
113 static void gst_fd_sink_get_property (GObject * object, guint prop_id,
114 GValue * value, GParamSpec * pspec);
115 static void gst_fd_sink_dispose (GObject * obj);
117 static gboolean gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query);
118 static GstFlowReturn gst_fd_sink_render (GstBaseSink * sink,
120 static GstFlowReturn gst_fd_sink_render_list (GstBaseSink * bsink,
121 GstBufferList * buffer_list);
122 static gboolean gst_fd_sink_start (GstBaseSink * basesink);
123 static gboolean gst_fd_sink_stop (GstBaseSink * basesink);
124 static gboolean gst_fd_sink_unlock (GstBaseSink * basesink);
125 static gboolean gst_fd_sink_unlock_stop (GstBaseSink * basesink);
126 static gboolean gst_fd_sink_event (GstBaseSink * sink, GstEvent * event);
128 static gboolean gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset);
131 gst_fd_sink_class_init (GstFdSinkClass * klass)
133 GObjectClass *gobject_class;
134 GstElementClass *gstelement_class;
135 GstBaseSinkClass *gstbasesink_class;
137 gobject_class = G_OBJECT_CLASS (klass);
138 gstelement_class = GST_ELEMENT_CLASS (klass);
139 gstbasesink_class = GST_BASE_SINK_CLASS (klass);
141 gobject_class->set_property = gst_fd_sink_set_property;
142 gobject_class->get_property = gst_fd_sink_get_property;
143 gobject_class->dispose = gst_fd_sink_dispose;
145 gst_element_class_set_static_metadata (gstelement_class,
146 "Filedescriptor Sink",
148 "Write data to a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
149 gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
151 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_fd_sink_render);
152 gstbasesink_class->render_list = GST_DEBUG_FUNCPTR (gst_fd_sink_render_list);
153 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_fd_sink_start);
154 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_fd_sink_stop);
155 gstbasesink_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock);
156 gstbasesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock_stop);
157 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_fd_sink_event);
158 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_fd_sink_query);
160 g_object_class_install_property (gobject_class, ARG_FD,
161 g_param_spec_int ("fd", "fd", "An open file descriptor to write to",
162 0, G_MAXINT, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
166 gst_fd_sink_init (GstFdSink * fdsink)
169 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
170 fdsink->bytes_written = 0;
171 fdsink->current_pos = 0;
173 gst_base_sink_set_sync (GST_BASE_SINK (fdsink), FALSE);
177 gst_fd_sink_dispose (GObject * obj)
179 GstFdSink *fdsink = GST_FD_SINK (obj);
181 g_free (fdsink->uri);
184 G_OBJECT_CLASS (parent_class)->dispose (obj);
188 gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query)
190 gboolean res = FALSE;
193 fdsink = GST_FD_SINK (bsink);
195 switch (GST_QUERY_TYPE (query)) {
196 case GST_QUERY_POSITION:
200 gst_query_parse_position (query, &format, NULL);
203 case GST_FORMAT_DEFAULT:
204 case GST_FORMAT_BYTES:
205 gst_query_set_position (query, GST_FORMAT_BYTES, fdsink->current_pos);
213 case GST_QUERY_FORMATS:
214 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
218 gst_query_set_uri (query, fdsink->uri);
221 case GST_QUERY_SEEKING:{
224 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
225 if (format == GST_FORMAT_BYTES || format == GST_FORMAT_DEFAULT) {
226 gst_query_set_seeking (query, GST_FORMAT_BYTES, fdsink->seekable, 0,
229 gst_query_set_seeking (query, format, FALSE, 0, -1);
235 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
243 gst_fd_sink_render_buffers (GstFdSink * sink, GstBuffer ** buffers,
244 guint num_buffers, guint8 * mem_nums, guint total_mems)
250 guint64 bytes_written = 0;
252 ret = gst_writev_buffers (GST_OBJECT_CAST (sink), sink->fd, sink->fdset,
253 buffers, num_buffers, mem_nums, total_mems, &bytes_written, skip);
255 sink->bytes_written += bytes_written;
256 sink->current_pos += bytes_written;
257 skip += bytes_written;
262 ret = gst_base_sink_wait_preroll (GST_BASE_SINK (sink));
263 if (ret != GST_FLOW_OK)
271 gst_fd_sink_render_list (GstBaseSink * bsink, GstBufferList * buffer_list)
278 guint i, num_buffers;
280 sink = GST_FD_SINK_CAST (bsink);
282 num_buffers = gst_buffer_list_length (buffer_list);
283 if (num_buffers == 0)
286 /* extract buffers from list and count memories */
287 buffers = g_newa (GstBuffer *, num_buffers);
288 mem_nums = g_newa (guint8, num_buffers);
289 for (i = 0, total_mems = 0; i < num_buffers; ++i) {
290 buffers[i] = gst_buffer_list_get (buffer_list, i);
291 mem_nums[i] = gst_buffer_n_memory (buffers[i]);
292 total_mems += mem_nums[i];
296 gst_fd_sink_render_buffers (sink, buffers, num_buffers, mem_nums,
303 GST_LOG_OBJECT (sink, "empty buffer list");
309 gst_fd_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
315 sink = GST_FD_SINK_CAST (bsink);
317 n_mem = gst_buffer_n_memory (buffer);
320 flow = gst_fd_sink_render_buffers (sink, &buffer, 1, &n_mem, n_mem);
328 gst_fd_sink_check_fd (GstFdSink * fdsink, int fd, GError ** error)
330 struct stat stat_results;
333 /* see that it is a valid file descriptor */
334 if (fstat (fd, &stat_results) < 0)
337 if (!S_ISREG (stat_results.st_mode))
340 /* see if it is a seekable stream */
341 result = lseek (fd, 0, SEEK_CUR);
352 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is seekable", fd);
358 GST_ELEMENT_ERROR (fdsink, RESOURCE, WRITE, (NULL),
359 ("File descriptor %d is not valid: %s", fd, g_strerror (errno)));
360 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
361 "File descriptor %d is not valid: %s", fd, g_strerror (errno));
366 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is a pipe", fd);
372 gst_fd_sink_start (GstBaseSink * basesink)
375 GstPollFD fd = GST_POLL_FD_INIT;
377 fdsink = GST_FD_SINK (basesink);
378 if (!gst_fd_sink_check_fd (fdsink, fdsink->fd, NULL))
381 if ((fdsink->fdset = gst_poll_new (TRUE)) == NULL)
385 gst_poll_add_fd (fdsink->fdset, &fd);
386 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
388 fdsink->bytes_written = 0;
389 fdsink->current_pos = 0;
391 fdsink->seekable = gst_fd_sink_do_seek (fdsink, 0);
392 GST_INFO_OBJECT (fdsink, "seeking supported: %d", fdsink->seekable);
399 GST_ELEMENT_ERROR (fdsink, RESOURCE, OPEN_READ_WRITE, (NULL),
406 gst_fd_sink_stop (GstBaseSink * basesink)
408 GstFdSink *fdsink = GST_FD_SINK (basesink);
411 gst_poll_free (fdsink->fdset);
412 fdsink->fdset = NULL;
419 gst_fd_sink_unlock (GstBaseSink * basesink)
421 GstFdSink *fdsink = GST_FD_SINK (basesink);
423 GST_LOG_OBJECT (fdsink, "Flushing");
424 GST_OBJECT_LOCK (fdsink);
425 fdsink->unlock = TRUE;
426 gst_poll_set_flushing (fdsink->fdset, TRUE);
427 GST_OBJECT_UNLOCK (fdsink);
433 gst_fd_sink_unlock_stop (GstBaseSink * basesink)
435 GstFdSink *fdsink = GST_FD_SINK (basesink);
437 GST_LOG_OBJECT (fdsink, "No longer flushing");
438 GST_OBJECT_LOCK (fdsink);
439 fdsink->unlock = FALSE;
440 gst_poll_set_flushing (fdsink->fdset, FALSE);
441 GST_OBJECT_UNLOCK (fdsink);
447 gst_fd_sink_update_fd (GstFdSink * fdsink, int new_fd, GError ** error)
450 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
451 "File descriptor %d is not valid", new_fd);
455 if (!gst_fd_sink_check_fd (fdsink, new_fd, error))
459 GST_OBJECT_LOCK (fdsink);
461 GstPollFD fd = GST_POLL_FD_INIT;
464 gst_poll_remove_fd (fdsink->fdset, &fd);
467 gst_poll_add_fd (fdsink->fdset, &fd);
468 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
471 g_free (fdsink->uri);
472 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
474 GST_OBJECT_UNLOCK (fdsink);
485 gst_fd_sink_set_property (GObject * object, guint prop_id,
486 const GValue * value, GParamSpec * pspec)
490 fdsink = GST_FD_SINK (object);
496 fd = g_value_get_int (value);
497 gst_fd_sink_update_fd (fdsink, fd, NULL);
501 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
507 gst_fd_sink_get_property (GObject * object, guint prop_id, GValue * value,
512 fdsink = GST_FD_SINK (object);
516 g_value_set_int (value, fdsink->fd);
519 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
525 gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset)
529 result = lseek (fdsink->fd, new_offset, SEEK_SET);
534 fdsink->current_pos = new_offset;
536 GST_DEBUG_OBJECT (fdsink, "File descriptor %d to seek to position "
537 "%" G_GUINT64_FORMAT, fdsink->fd, fdsink->current_pos);
544 GST_DEBUG_OBJECT (fdsink, "File descriptor %d failed to seek to position "
545 "%" G_GUINT64_FORMAT, fdsink->fd, new_offset);
551 gst_fd_sink_event (GstBaseSink * sink, GstEvent * event)
556 fdsink = GST_FD_SINK (sink);
558 type = GST_EVENT_TYPE (event);
561 case GST_EVENT_SEGMENT:
563 const GstSegment *segment;
565 gst_event_parse_segment (event, &segment);
567 if (segment->format == GST_FORMAT_BYTES) {
568 /* only try to seek and fail when we are going to a different
570 if (fdsink->current_pos != segment->start) {
571 /* FIXME, the seek should be performed on the pos field, start/stop are
572 * just boundaries for valid bytes offsets. We should also fill the file
573 * with zeroes if the new position extends the current EOF (sparse streams
574 * and segment accumulation). */
575 if (!gst_fd_sink_do_seek (fdsink, (guint64) segment->start))
579 GST_DEBUG_OBJECT (fdsink,
580 "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
581 gst_format_get_name (segment->format));
589 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
593 GST_ELEMENT_ERROR (fdsink, RESOURCE, SEEK, (NULL),
594 ("Error while seeking on file descriptor %d: %s",
595 fdsink->fd, g_strerror (errno)));
596 gst_event_unref (event);
602 /*** GSTURIHANDLER INTERFACE *************************************************/
605 gst_fd_sink_uri_get_type (GType type)
610 static const gchar *const *
611 gst_fd_sink_uri_get_protocols (GType type)
613 static const gchar *protocols[] = { "fd", NULL };
619 gst_fd_sink_uri_get_uri (GstURIHandler * handler)
621 GstFdSink *sink = GST_FD_SINK (handler);
623 /* FIXME: make thread-safe */
624 return g_strdup (sink->uri);
628 gst_fd_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
631 GstFdSink *sink = GST_FD_SINK (handler);
634 if (sscanf (uri, "fd://%d", &fd) != 1) {
635 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
636 "File descriptor URI could not be parsed");
640 return gst_fd_sink_update_fd (sink, fd, error);
644 gst_fd_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
646 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
648 iface->get_type = gst_fd_sink_uri_get_type;
649 iface->get_protocols = gst_fd_sink_uri_get_protocols;
650 iface->get_uri = gst_fd_sink_uri_get_uri;
651 iface->set_uri = gst_fd_sink_uri_set_uri;