2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
4 * 2005 Philippe Khalaf <burger@speedy.org>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
21 * Boston, MA 02110-1301, USA.
24 * SECTION:element-fdsrc
25 * @see_also: #GstFdSink
27 * Read data from a unix file descriptor.
29 * To generate data, enter some data on the console followed by enter.
30 * The above mentioned pipeline should dump data packets to the console.
32 * If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
33 * generate an element message named <classname>"GstFdSrcTimeout"</classname>
34 * if no data was received in the given timeout.
36 * The message's structure contains one field:
41 * <classname>"timeout"</classname>: the timeout in microseconds that
42 * expired when waiting for data.
48 * <title>Example launch line</title>
50 * echo "Hello GStreamer" | gst-launch-1.0 -v fdsrc ! fakesink dump=true
51 * ]| A simple pipeline to read from the standard input and dump the data
52 * with a fakesink as hex ascii block.
59 #include "gst/gst_private.h"
61 #include <sys/types.h>
64 #include <io.h> /* lseek, open, close, read */
66 #define lseek _lseeki64
70 #ifdef HAVE_SYS_SOCKET_H
71 #include <sys/socket.h>
82 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
89 #ifdef __BIONIC__ /* Android */
96 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
101 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
102 #define GST_CAT_DEFAULT gst_fd_src_debug
105 #define DEFAULT_TIMEOUT 0
117 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
120 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_src_uri_handler_init); \
121 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
122 #define gst_fd_src_parent_class parent_class
123 G_DEFINE_TYPE_WITH_CODE (GstFdSrc, gst_fd_src, GST_TYPE_PUSH_SRC, _do_init);
125 static void gst_fd_src_set_property (GObject * object, guint prop_id,
126 const GValue * value, GParamSpec * pspec);
127 static void gst_fd_src_get_property (GObject * object, guint prop_id,
128 GValue * value, GParamSpec * pspec);
129 static void gst_fd_src_dispose (GObject * obj);
131 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
132 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
133 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
134 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
135 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
136 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
137 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
138 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
140 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
143 gst_fd_src_class_init (GstFdSrcClass * klass)
145 GObjectClass *gobject_class;
146 GstElementClass *gstelement_class;
147 GstBaseSrcClass *gstbasesrc_class;
148 GstPushSrcClass *gstpush_src_class;
150 gobject_class = G_OBJECT_CLASS (klass);
151 gstelement_class = GST_ELEMENT_CLASS (klass);
152 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
153 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
155 gobject_class->set_property = gst_fd_src_set_property;
156 gobject_class->get_property = gst_fd_src_get_property;
157 gobject_class->dispose = gst_fd_src_dispose;
159 g_object_class_install_property (gobject_class, PROP_FD,
160 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
161 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
165 * Post a message after timeout microseconds
167 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
168 g_param_spec_uint64 ("timeout", "Timeout",
169 "Post a message after timeout microseconds (0 = disabled)", 0,
170 G_MAXUINT64, DEFAULT_TIMEOUT,
171 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
173 gst_element_class_set_static_metadata (gstelement_class,
174 "Filedescriptor Source",
176 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
177 gst_element_class_add_pad_template (gstelement_class,
178 gst_static_pad_template_get (&srctemplate));
180 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
181 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
182 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
183 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
184 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
185 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
186 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
187 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
189 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
193 gst_fd_src_init (GstFdSrc * fdsrc)
195 fdsrc->new_fd = DEFAULT_FD;
196 fdsrc->seekable_fd = FALSE;
199 fdsrc->timeout = DEFAULT_TIMEOUT;
200 fdsrc->uri = g_strdup_printf ("fd://0");
201 fdsrc->curoffset = 0;
205 gst_fd_src_dispose (GObject * obj)
207 GstFdSrc *src = GST_FD_SRC (obj);
212 G_OBJECT_CLASS (parent_class)->dispose (obj);
216 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
218 struct stat stat_results;
220 GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
223 /* we need to always update the fdset since it may not have existed when
224 * gst_fd_src_update_fd () was called earlier */
225 if (src->fdset != NULL) {
226 GstPollFD fd = GST_POLL_FD_INIT;
230 /* this will log a harmless warning, if it was never added */
231 gst_poll_remove_fd (src->fdset, &fd);
235 gst_poll_add_fd (src->fdset, &fd);
236 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
240 if (src->fd != src->new_fd) {
241 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
243 src->fd = src->new_fd;
245 GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
249 src->uri = g_strdup_printf ("fd://%d", src->fd);
251 if (fstat (src->fd, &stat_results) < 0)
254 if (!S_ISREG (stat_results.st_mode))
257 /* Try a seek of 0 bytes offset to check for seekability */
258 if (lseek (src->fd, 0, SEEK_CUR) < 0)
261 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
262 src->seekable_fd = TRUE;
264 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), TRUE);
270 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
271 src->seekable_fd = FALSE;
272 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), FALSE);
277 gst_fd_src_start (GstBaseSrc * bsrc)
279 GstFdSrc *src = GST_FD_SRC (bsrc);
283 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
286 gst_fd_src_update_fd (src, -1);
293 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
300 gst_fd_src_stop (GstBaseSrc * bsrc)
302 GstFdSrc *src = GST_FD_SRC (bsrc);
305 gst_poll_free (src->fdset);
313 gst_fd_src_unlock (GstBaseSrc * bsrc)
315 GstFdSrc *src = GST_FD_SRC (bsrc);
317 GST_LOG_OBJECT (src, "Flushing");
318 GST_OBJECT_LOCK (src);
319 gst_poll_set_flushing (src->fdset, TRUE);
320 GST_OBJECT_UNLOCK (src);
326 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
328 GstFdSrc *src = GST_FD_SRC (bsrc);
330 GST_LOG_OBJECT (src, "No longer flushing");
331 GST_OBJECT_LOCK (src);
332 gst_poll_set_flushing (src->fdset, FALSE);
333 GST_OBJECT_UNLOCK (src);
339 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
342 GstFdSrc *src = GST_FD_SRC (object);
346 src->new_fd = g_value_get_int (value);
348 /* If state is ready or below, update the current fd immediately
349 * so it is reflected in get_properties and uri */
350 GST_OBJECT_LOCK (object);
351 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
352 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
353 gst_fd_src_update_fd (src, -1);
355 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
357 GST_OBJECT_UNLOCK (object);
360 src->timeout = g_value_get_uint64 (value);
361 GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
362 GST_TIME_ARGS (src->timeout));
365 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
371 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
374 GstFdSrc *src = GST_FD_SRC (object);
378 g_value_set_int (value, src->fd);
381 g_value_set_uint64 (value, src->timeout);
384 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
390 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
399 GstClockTime timeout;
404 src = GST_FD_SRC (psrc);
407 if (src->timeout > 0) {
408 timeout = src->timeout * GST_USECOND;
410 timeout = GST_CLOCK_TIME_NONE;
416 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
417 GST_TIME_ARGS (src->timeout));
419 retval = gst_poll_wait (src->fdset, timeout);
420 GST_LOG_OBJECT (src, "poll returned %d", retval);
422 if (G_UNLIKELY (retval == -1)) {
423 if (errno == EINTR || errno == EAGAIN) {
424 /* retry if interrupted */
426 } else if (errno == EBUSY) {
431 } else if (G_UNLIKELY (retval == 0)) {
433 /* timeout, post element message */
434 gst_element_post_message (GST_ELEMENT_CAST (src),
435 gst_message_new_element (GST_OBJECT_CAST (src),
436 gst_structure_new ("GstFdSrcTimeout",
437 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
439 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
442 blocksize = GST_BASE_SRC (src)->blocksize;
444 /* create the buffer */
445 buf = gst_buffer_new_allocate (NULL, blocksize, NULL);
446 if (G_UNLIKELY (buf == NULL))
449 if (!gst_buffer_map (buf, &info, GST_MAP_WRITE))
450 goto buffer_read_error;
453 readbytes = read (src->fd, info.data, blocksize);
454 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
455 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
460 gst_buffer_unmap (buf, &info);
461 gst_buffer_resize (buf, 0, readbytes);
466 GST_BUFFER_OFFSET (buf) = src->curoffset;
467 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
468 src->curoffset += readbytes;
470 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
472 /* we're done, return the buffer */
481 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
482 ("poll on file descriptor: %s.", g_strerror (errno)));
483 GST_DEBUG_OBJECT (psrc, "Error during poll");
484 return GST_FLOW_ERROR;
488 GST_DEBUG_OBJECT (psrc, "Poll stopped");
489 return GST_FLOW_FLUSHING;
494 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
495 return GST_FLOW_ERROR;
499 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
500 gst_buffer_unref (buf);
505 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
506 ("read on file descriptor: %s.", g_strerror (errno)));
507 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
508 gst_buffer_unmap (buf, &info);
509 gst_buffer_unref (buf);
510 return GST_FLOW_ERROR;
514 GST_ELEMENT_ERROR (src, RESOURCE, WRITE, (NULL), ("Can't write to buffer"));
515 gst_buffer_unref (buf);
516 return GST_FLOW_ERROR;
521 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
523 gboolean ret = FALSE;
524 GstFdSrc *src = GST_FD_SRC (basesrc);
526 switch (GST_QUERY_TYPE (query)) {
528 gst_query_set_uri (query, src->uri);
537 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
543 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
545 GstFdSrc *src = GST_FD_SRC (bsrc);
547 return src->seekable_fd;
551 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
553 GstFdSrc *src = GST_FD_SRC (bsrc);
554 struct stat stat_results;
556 if (src->size != -1) {
561 if (!src->seekable_fd) {
562 /* If it isn't seekable, we won't know the length (but fstat will still
563 * succeed, and wrongly say our length is zero. */
567 if (fstat (src->fd, &stat_results) < 0)
570 *size = stat_results.st_size;
582 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
586 GstFdSrc *src = GST_FD_SRC (bsrc);
588 offset = segment->start;
590 /* No need to seek to the current position */
591 if (offset == src->curoffset)
594 res = lseek (src->fd, offset, SEEK_SET);
595 if (G_UNLIKELY (res < 0 || res != offset))
598 segment->position = segment->start;
599 segment->time = segment->start;
604 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
608 /*** GSTURIHANDLER INTERFACE *************************************************/
611 gst_fd_src_uri_get_type (GType type)
616 static const gchar *const *
617 gst_fd_src_uri_get_protocols (GType type)
619 static const gchar *protocols[] = { "fd", NULL };
625 gst_fd_src_uri_get_uri (GstURIHandler * handler)
627 GstFdSrc *src = GST_FD_SRC (handler);
629 /* FIXME: make thread-safe */
630 return g_strdup (src->uri);
634 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
638 GstFdSrc *src = GST_FD_SRC (handler);
640 guint64 size = (guint64) - 1;
642 GST_INFO_OBJECT (src, "checking uri %s", uri);
644 protocol = gst_uri_get_protocol (uri);
645 if (strcmp (protocol, "fd") != 0) {
646 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
647 "Wrong protocol for fdsrc in uri: '%s'", uri);
653 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0) {
654 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
655 "Bad file descriptor number in uri: '%s'", uri);
659 if ((q = g_strstr_len (uri, -1, "?"))) {
660 gchar *sp, *end = NULL;
662 GST_INFO_OBJECT (src, "found ?");
664 if ((sp = g_strstr_len (q, -1, "size="))) {
665 sp += strlen ("size=");
666 size = g_ascii_strtoull (sp, &end, 10);
667 if ((size == 0 && errno == EINVAL) || size == G_MAXUINT64 || end == sp) {
668 GST_INFO_OBJECT (src, "parsing size failed");
671 GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
678 GST_OBJECT_LOCK (src);
679 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
680 gst_fd_src_update_fd (src, size);
682 GST_OBJECT_UNLOCK (src);
688 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
690 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
692 iface->get_type = gst_fd_src_uri_get_type;
693 iface->get_protocols = gst_fd_src_uri_get_protocols;
694 iface->get_uri = gst_fd_src_uri_get_uri;
695 iface->set_uri = gst_fd_src_uri_set_uri;