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
26 * @see_also: #GstFdSrc
28 * Write data to a unix file descriptor.
30 * This element will synchronize on the clock before writing the data on the
31 * socket. For file descriptors where this does not make sense (files, ...) the
32 * #GstBaseSink:sync property can be used to disable synchronisation.
39 #include "../../gst/gst-i18n-lib.h"
41 #include <sys/types.h>
44 #ifdef HAVE_SYS_SOCKET_H
45 #include <sys/socket.h>
56 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
61 #include "gstfdsink.h"
62 #include "gstelements_private.h"
65 #include <io.h> /* lseek, open, close, read */
67 #define lseek _lseeki64
72 #ifdef __BIONIC__ /* Android */
81 static GstStaticPadTemplate sinktemplate = GST_STATIC_PAD_TEMPLATE ("sink",
86 GST_DEBUG_CATEGORY_STATIC (gst_fd_sink__debug);
87 #define GST_CAT_DEFAULT gst_fd_sink__debug
90 /* FdSink signals and args */
103 static void gst_fd_sink_uri_handler_init (gpointer g_iface,
104 gpointer iface_data);
107 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_sink_uri_handler_init); \
108 GST_DEBUG_CATEGORY_INIT (gst_fd_sink__debug, "fdsink", 0, "fdsink element");
109 #define gst_fd_sink_parent_class parent_class
110 G_DEFINE_TYPE_WITH_CODE (GstFdSink, gst_fd_sink, GST_TYPE_BASE_SINK, _do_init);
112 static void gst_fd_sink_set_property (GObject * object, guint prop_id,
113 const GValue * value, GParamSpec * pspec);
114 static void gst_fd_sink_get_property (GObject * object, guint prop_id,
115 GValue * value, GParamSpec * pspec);
116 static void gst_fd_sink_dispose (GObject * obj);
118 static gboolean gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query);
119 static GstFlowReturn gst_fd_sink_render (GstBaseSink * sink,
121 static GstFlowReturn gst_fd_sink_render_list (GstBaseSink * bsink,
122 GstBufferList * buffer_list);
123 static gboolean gst_fd_sink_start (GstBaseSink * basesink);
124 static gboolean gst_fd_sink_stop (GstBaseSink * basesink);
125 static gboolean gst_fd_sink_unlock (GstBaseSink * basesink);
126 static gboolean gst_fd_sink_unlock_stop (GstBaseSink * basesink);
127 static gboolean gst_fd_sink_event (GstBaseSink * sink, GstEvent * event);
129 static gboolean gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset);
132 gst_fd_sink_class_init (GstFdSinkClass * klass)
134 GObjectClass *gobject_class;
135 GstElementClass *gstelement_class;
136 GstBaseSinkClass *gstbasesink_class;
138 gobject_class = G_OBJECT_CLASS (klass);
139 gstelement_class = GST_ELEMENT_CLASS (klass);
140 gstbasesink_class = GST_BASE_SINK_CLASS (klass);
142 gobject_class->set_property = gst_fd_sink_set_property;
143 gobject_class->get_property = gst_fd_sink_get_property;
144 gobject_class->dispose = gst_fd_sink_dispose;
146 gst_element_class_set_static_metadata (gstelement_class,
147 "Filedescriptor Sink",
149 "Write data to a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
150 gst_element_class_add_static_pad_template (gstelement_class, &sinktemplate);
152 gstbasesink_class->render = GST_DEBUG_FUNCPTR (gst_fd_sink_render);
153 gstbasesink_class->render_list = GST_DEBUG_FUNCPTR (gst_fd_sink_render_list);
154 gstbasesink_class->start = GST_DEBUG_FUNCPTR (gst_fd_sink_start);
155 gstbasesink_class->stop = GST_DEBUG_FUNCPTR (gst_fd_sink_stop);
156 gstbasesink_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock);
157 gstbasesink_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_sink_unlock_stop);
158 gstbasesink_class->event = GST_DEBUG_FUNCPTR (gst_fd_sink_event);
159 gstbasesink_class->query = GST_DEBUG_FUNCPTR (gst_fd_sink_query);
161 g_object_class_install_property (gobject_class, ARG_FD,
162 g_param_spec_int ("fd", "fd", "An open file descriptor to write to",
163 0, G_MAXINT, 1, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
167 gst_fd_sink_init (GstFdSink * fdsink)
170 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
171 fdsink->bytes_written = 0;
172 fdsink->current_pos = 0;
174 gst_base_sink_set_sync (GST_BASE_SINK (fdsink), FALSE);
178 gst_fd_sink_dispose (GObject * obj)
180 GstFdSink *fdsink = GST_FD_SINK (obj);
182 g_free (fdsink->uri);
185 G_OBJECT_CLASS (parent_class)->dispose (obj);
189 gst_fd_sink_query (GstBaseSink * bsink, GstQuery * query)
191 gboolean res = FALSE;
194 fdsink = GST_FD_SINK (bsink);
196 switch (GST_QUERY_TYPE (query)) {
197 case GST_QUERY_POSITION:
201 gst_query_parse_position (query, &format, NULL);
204 case GST_FORMAT_DEFAULT:
205 case GST_FORMAT_BYTES:
206 gst_query_set_position (query, GST_FORMAT_BYTES, fdsink->current_pos);
214 case GST_QUERY_FORMATS:
215 gst_query_set_formats (query, 2, GST_FORMAT_DEFAULT, GST_FORMAT_BYTES);
219 gst_query_set_uri (query, fdsink->uri);
222 case GST_QUERY_SEEKING:{
225 gst_query_parse_seeking (query, &format, NULL, NULL, NULL);
226 if (format == GST_FORMAT_BYTES || format == GST_FORMAT_DEFAULT) {
227 gst_query_set_seeking (query, GST_FORMAT_BYTES, fdsink->seekable, 0,
230 gst_query_set_seeking (query, format, FALSE, 0, -1);
236 res = GST_BASE_SINK_CLASS (parent_class)->query (bsink, query);
244 gst_fd_sink_render_buffers (GstFdSink * sink, GstBuffer ** buffers,
245 guint num_buffers, guint8 * mem_nums, guint total_mems)
251 guint64 bytes_written = 0;
253 ret = gst_writev_buffers (GST_OBJECT_CAST (sink), sink->fd, sink->fdset,
254 buffers, num_buffers, mem_nums, total_mems, &bytes_written, skip);
256 sink->bytes_written += bytes_written;
257 sink->current_pos += bytes_written;
258 skip += bytes_written;
263 ret = gst_base_sink_wait_preroll (GST_BASE_SINK (sink));
264 if (ret != GST_FLOW_OK)
272 gst_fd_sink_render_list (GstBaseSink * bsink, GstBufferList * buffer_list)
279 guint i, num_buffers;
281 sink = GST_FD_SINK_CAST (bsink);
283 num_buffers = gst_buffer_list_length (buffer_list);
284 if (num_buffers == 0)
287 /* extract buffers from list and count memories */
288 buffers = g_newa (GstBuffer *, num_buffers);
289 mem_nums = g_newa (guint8, num_buffers);
290 for (i = 0, total_mems = 0; i < num_buffers; ++i) {
291 buffers[i] = gst_buffer_list_get (buffer_list, i);
292 mem_nums[i] = gst_buffer_n_memory (buffers[i]);
293 total_mems += mem_nums[i];
297 gst_fd_sink_render_buffers (sink, buffers, num_buffers, mem_nums,
304 GST_LOG_OBJECT (sink, "empty buffer list");
310 gst_fd_sink_render (GstBaseSink * bsink, GstBuffer * buffer)
316 sink = GST_FD_SINK_CAST (bsink);
318 n_mem = gst_buffer_n_memory (buffer);
321 flow = gst_fd_sink_render_buffers (sink, &buffer, 1, &n_mem, n_mem);
329 gst_fd_sink_check_fd (GstFdSink * fdsink, int fd, GError ** error)
331 struct stat stat_results;
334 /* see that it is a valid file descriptor */
335 if (fstat (fd, &stat_results) < 0)
338 if (!S_ISREG (stat_results.st_mode))
341 /* see if it is a seekable stream */
342 result = lseek (fd, 0, SEEK_CUR);
353 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is seekable", fd);
359 GST_ELEMENT_ERROR (fdsink, RESOURCE, WRITE, (NULL),
360 ("File descriptor %d is not valid: %s", fd, g_strerror (errno)));
361 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
362 "File descriptor %d is not valid: %s", fd, g_strerror (errno));
367 GST_DEBUG_OBJECT (fdsink, "File descriptor %d is a pipe", fd);
373 gst_fd_sink_start (GstBaseSink * basesink)
376 GstPollFD fd = GST_POLL_FD_INIT;
378 fdsink = GST_FD_SINK (basesink);
379 if (!gst_fd_sink_check_fd (fdsink, fdsink->fd, NULL))
382 if ((fdsink->fdset = gst_poll_new (TRUE)) == NULL)
386 gst_poll_add_fd (fdsink->fdset, &fd);
387 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
389 fdsink->bytes_written = 0;
390 fdsink->current_pos = 0;
392 fdsink->seekable = gst_fd_sink_do_seek (fdsink, 0);
393 GST_INFO_OBJECT (fdsink, "seeking supported: %d", fdsink->seekable);
400 GST_ELEMENT_ERROR (fdsink, RESOURCE, OPEN_READ_WRITE, (NULL),
407 gst_fd_sink_stop (GstBaseSink * basesink)
409 GstFdSink *fdsink = GST_FD_SINK (basesink);
412 gst_poll_free (fdsink->fdset);
413 fdsink->fdset = NULL;
420 gst_fd_sink_unlock (GstBaseSink * basesink)
422 GstFdSink *fdsink = GST_FD_SINK (basesink);
424 GST_LOG_OBJECT (fdsink, "Flushing");
425 GST_OBJECT_LOCK (fdsink);
426 fdsink->unlock = TRUE;
427 gst_poll_set_flushing (fdsink->fdset, TRUE);
428 GST_OBJECT_UNLOCK (fdsink);
434 gst_fd_sink_unlock_stop (GstBaseSink * basesink)
436 GstFdSink *fdsink = GST_FD_SINK (basesink);
438 GST_LOG_OBJECT (fdsink, "No longer flushing");
439 GST_OBJECT_LOCK (fdsink);
440 fdsink->unlock = FALSE;
441 gst_poll_set_flushing (fdsink->fdset, FALSE);
442 GST_OBJECT_UNLOCK (fdsink);
448 gst_fd_sink_update_fd (GstFdSink * fdsink, int new_fd, GError ** error)
451 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_REFERENCE,
452 "File descriptor %d is not valid", new_fd);
456 if (!gst_fd_sink_check_fd (fdsink, new_fd, error))
460 GST_OBJECT_LOCK (fdsink);
462 GstPollFD fd = GST_POLL_FD_INIT;
465 gst_poll_remove_fd (fdsink->fdset, &fd);
468 gst_poll_add_fd (fdsink->fdset, &fd);
469 gst_poll_fd_ctl_write (fdsink->fdset, &fd, TRUE);
472 g_free (fdsink->uri);
473 fdsink->uri = g_strdup_printf ("fd://%d", fdsink->fd);
475 GST_OBJECT_UNLOCK (fdsink);
486 gst_fd_sink_set_property (GObject * object, guint prop_id,
487 const GValue * value, GParamSpec * pspec)
491 fdsink = GST_FD_SINK (object);
497 fd = g_value_get_int (value);
498 gst_fd_sink_update_fd (fdsink, fd, NULL);
502 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
508 gst_fd_sink_get_property (GObject * object, guint prop_id, GValue * value,
513 fdsink = GST_FD_SINK (object);
517 g_value_set_int (value, fdsink->fd);
520 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
526 gst_fd_sink_do_seek (GstFdSink * fdsink, guint64 new_offset)
530 result = lseek (fdsink->fd, new_offset, SEEK_SET);
535 fdsink->current_pos = new_offset;
537 GST_DEBUG_OBJECT (fdsink, "File descriptor %d to seek to position "
538 "%" G_GUINT64_FORMAT, fdsink->fd, fdsink->current_pos);
545 GST_DEBUG_OBJECT (fdsink, "File descriptor %d failed to seek to position "
546 "%" G_GUINT64_FORMAT, fdsink->fd, new_offset);
552 gst_fd_sink_event (GstBaseSink * sink, GstEvent * event)
557 fdsink = GST_FD_SINK (sink);
559 type = GST_EVENT_TYPE (event);
562 case GST_EVENT_SEGMENT:
564 const GstSegment *segment;
566 gst_event_parse_segment (event, &segment);
568 if (segment->format == GST_FORMAT_BYTES) {
569 /* only try to seek and fail when we are going to a different
571 if (fdsink->current_pos != segment->start) {
572 /* FIXME, the seek should be performed on the pos field, start/stop are
573 * just boundaries for valid bytes offsets. We should also fill the file
574 * with zeroes if the new position extends the current EOF (sparse streams
575 * and segment accumulation). */
576 if (!gst_fd_sink_do_seek (fdsink, (guint64) segment->start))
580 GST_DEBUG_OBJECT (fdsink,
581 "Ignored SEGMENT event of format %u (%s)", (guint) segment->format,
582 gst_format_get_name (segment->format));
590 return GST_BASE_SINK_CLASS (parent_class)->event (sink, event);
594 GST_ELEMENT_ERROR (fdsink, RESOURCE, SEEK, (NULL),
595 ("Error while seeking on file descriptor %d: %s",
596 fdsink->fd, g_strerror (errno)));
597 gst_event_unref (event);
603 /*** GSTURIHANDLER INTERFACE *************************************************/
606 gst_fd_sink_uri_get_type (GType type)
611 static const gchar *const *
612 gst_fd_sink_uri_get_protocols (GType type)
614 static const gchar *protocols[] = { "fd", NULL };
620 gst_fd_sink_uri_get_uri (GstURIHandler * handler)
622 GstFdSink *sink = GST_FD_SINK (handler);
624 /* FIXME: make thread-safe */
625 return g_strdup (sink->uri);
629 gst_fd_sink_uri_set_uri (GstURIHandler * handler, const gchar * uri,
632 GstFdSink *sink = GST_FD_SINK (handler);
635 if (sscanf (uri, "fd://%d", &fd) != 1) {
636 g_set_error (error, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
637 "File descriptor URI could not be parsed");
641 return gst_fd_sink_update_fd (sink, fd, error);
645 gst_fd_sink_uri_handler_init (gpointer g_iface, gpointer iface_data)
647 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
649 iface->get_type = gst_fd_sink_uri_get_type;
650 iface->get_protocols = gst_fd_sink_uri_get_protocols;
651 iface->get_uri = gst_fd_sink_uri_get_uri;
652 iface->set_uri = gst_fd_sink_uri_set_uri;