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
26 * @see_also: #GstFdSink
28 * Read data from a unix file descriptor.
30 * To generate data, enter some data on the console followed by enter.
31 * The above mentioned pipeline should dump data packets to the console.
33 * If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
34 * generate an element message named <classname>"GstFdSrcTimeout"</classname>
35 * if no data was received in the given timeout.
37 * The message's structure contains one field:
39 * * #guint64 `timeout`: the timeout in microseconds that
40 * expired when waiting for data.
42 * ## Example launch line
44 * echo "Hello GStreamer" | gst-launch-1.0 -v fdsrc ! fakesink dump=true
45 * ]| A simple pipeline to read from the standard input and dump the data
46 * with a fakesink as hex ascii block.
53 #include "gst/gst_private.h"
55 #include <sys/types.h>
58 #include <io.h> /* lseek, open, close, read */
60 #define lseek _lseeki64
64 #ifdef HAVE_SYS_SOCKET_H
65 #include <sys/socket.h>
76 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
83 #ifdef __BIONIC__ /* Android */
84 #if defined(__ANDROID_API__) && __ANDROID_API__ >= 21
90 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
95 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
96 #define GST_CAT_DEFAULT gst_fd_src_debug
99 #define DEFAULT_TIMEOUT 0
111 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
114 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_src_uri_handler_init); \
115 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
116 #define gst_fd_src_parent_class parent_class
117 G_DEFINE_TYPE_WITH_CODE (GstFdSrc, gst_fd_src, GST_TYPE_PUSH_SRC, _do_init);
119 static void gst_fd_src_set_property (GObject * object, guint prop_id,
120 const GValue * value, GParamSpec * pspec);
121 static void gst_fd_src_get_property (GObject * object, guint prop_id,
122 GValue * value, GParamSpec * pspec);
123 static void gst_fd_src_dispose (GObject * obj);
125 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
126 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
127 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
128 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
129 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
130 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
131 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
132 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
134 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
137 gst_fd_src_class_init (GstFdSrcClass * klass)
139 GObjectClass *gobject_class;
140 GstElementClass *gstelement_class;
141 GstBaseSrcClass *gstbasesrc_class;
142 GstPushSrcClass *gstpush_src_class;
144 gobject_class = G_OBJECT_CLASS (klass);
145 gstelement_class = GST_ELEMENT_CLASS (klass);
146 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
147 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
149 gobject_class->set_property = gst_fd_src_set_property;
150 gobject_class->get_property = gst_fd_src_get_property;
151 gobject_class->dispose = gst_fd_src_dispose;
153 g_object_class_install_property (gobject_class, PROP_FD,
154 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
155 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
159 * Post a message after timeout microseconds
161 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
162 g_param_spec_uint64 ("timeout", "Timeout",
163 "Post a message after timeout microseconds (0 = disabled)", 0,
164 G_MAXUINT64, DEFAULT_TIMEOUT,
165 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
167 gst_element_class_set_static_metadata (gstelement_class,
168 "Filedescriptor Source",
170 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
171 gst_element_class_add_static_pad_template (gstelement_class, &srctemplate);
173 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
174 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
175 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
176 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
177 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
178 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
179 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
180 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
182 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
186 gst_fd_src_init (GstFdSrc * fdsrc)
188 fdsrc->new_fd = DEFAULT_FD;
189 fdsrc->seekable_fd = FALSE;
192 fdsrc->timeout = DEFAULT_TIMEOUT;
193 fdsrc->uri = g_strdup_printf ("fd://0");
194 fdsrc->curoffset = 0;
198 gst_fd_src_dispose (GObject * obj)
200 GstFdSrc *src = GST_FD_SRC (obj);
205 G_OBJECT_CLASS (parent_class)->dispose (obj);
209 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
211 struct stat stat_results;
213 GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
216 /* we need to always update the fdset since it may not have existed when
217 * gst_fd_src_update_fd () was called earlier */
218 if (src->fdset != NULL) {
219 GstPollFD fd = GST_POLL_FD_INIT;
223 /* this will log a harmless warning, if it was never added */
224 gst_poll_remove_fd (src->fdset, &fd);
228 gst_poll_add_fd (src->fdset, &fd);
229 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
233 if (src->fd != src->new_fd) {
234 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
236 src->fd = src->new_fd;
238 GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
242 src->uri = g_strdup_printf ("fd://%d", src->fd);
244 if (fstat (src->fd, &stat_results) < 0)
247 if (!S_ISREG (stat_results.st_mode))
250 /* Try a seek of 0 bytes offset to check for seekability */
251 if (lseek (src->fd, 0, SEEK_CUR) < 0)
254 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
255 src->seekable_fd = TRUE;
257 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), TRUE);
263 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
264 src->seekable_fd = FALSE;
265 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), FALSE);
270 gst_fd_src_start (GstBaseSrc * bsrc)
272 GstFdSrc *src = GST_FD_SRC (bsrc);
276 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
279 gst_fd_src_update_fd (src, -1);
286 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
293 gst_fd_src_stop (GstBaseSrc * bsrc)
295 GstFdSrc *src = GST_FD_SRC (bsrc);
298 gst_poll_free (src->fdset);
306 gst_fd_src_unlock (GstBaseSrc * bsrc)
308 GstFdSrc *src = GST_FD_SRC (bsrc);
310 GST_LOG_OBJECT (src, "Flushing");
311 GST_OBJECT_LOCK (src);
312 gst_poll_set_flushing (src->fdset, TRUE);
313 GST_OBJECT_UNLOCK (src);
319 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
321 GstFdSrc *src = GST_FD_SRC (bsrc);
323 GST_LOG_OBJECT (src, "No longer flushing");
324 GST_OBJECT_LOCK (src);
325 gst_poll_set_flushing (src->fdset, FALSE);
326 GST_OBJECT_UNLOCK (src);
332 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
335 GstFdSrc *src = GST_FD_SRC (object);
339 src->new_fd = g_value_get_int (value);
341 /* If state is ready or below, update the current fd immediately
342 * so it is reflected in get_properties and uri */
343 GST_OBJECT_LOCK (object);
344 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
345 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
346 gst_fd_src_update_fd (src, -1);
348 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
350 GST_OBJECT_UNLOCK (object);
353 src->timeout = g_value_get_uint64 (value);
354 GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
355 GST_TIME_ARGS (src->timeout));
358 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
364 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
367 GstFdSrc *src = GST_FD_SRC (object);
371 g_value_set_int (value, src->fd);
374 g_value_set_uint64 (value, src->timeout);
377 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
383 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
392 GstClockTime timeout;
397 src = GST_FD_SRC (psrc);
400 if (src->timeout > 0) {
401 timeout = src->timeout * GST_USECOND;
403 timeout = GST_CLOCK_TIME_NONE;
409 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
410 GST_TIME_ARGS (src->timeout));
412 retval = gst_poll_wait (src->fdset, timeout);
413 GST_LOG_OBJECT (src, "poll returned %d", retval);
415 if (G_UNLIKELY (retval == -1)) {
416 if (errno == EINTR || errno == EAGAIN) {
417 /* retry if interrupted */
419 } else if (errno == EBUSY) {
424 } else if (G_UNLIKELY (retval == 0)) {
426 /* timeout, post element message */
427 gst_element_post_message (GST_ELEMENT_CAST (src),
428 gst_message_new_element (GST_OBJECT_CAST (src),
429 gst_structure_new ("GstFdSrcTimeout",
430 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
432 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
435 blocksize = GST_BASE_SRC (src)->blocksize;
437 /* create the buffer */
438 buf = gst_buffer_new_allocate (NULL, blocksize, NULL);
439 if (G_UNLIKELY (buf == NULL))
442 if (!gst_buffer_map (buf, &info, GST_MAP_WRITE))
443 goto buffer_read_error;
446 readbytes = read (src->fd, info.data, blocksize);
447 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
448 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
453 gst_buffer_unmap (buf, &info);
454 gst_buffer_resize (buf, 0, readbytes);
459 GST_BUFFER_OFFSET (buf) = src->curoffset;
460 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
461 src->curoffset += readbytes;
463 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
465 /* we're done, return the buffer */
474 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
475 ("poll on file descriptor: %s.", g_strerror (errno)));
476 GST_DEBUG_OBJECT (psrc, "Error during poll");
477 return GST_FLOW_ERROR;
481 GST_DEBUG_OBJECT (psrc, "Poll stopped");
482 return GST_FLOW_FLUSHING;
487 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
488 return GST_FLOW_ERROR;
492 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
493 gst_buffer_unref (buf);
498 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
499 ("read on file descriptor: %s.", g_strerror (errno)));
500 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
501 gst_buffer_unmap (buf, &info);
502 gst_buffer_unref (buf);
503 return GST_FLOW_ERROR;
507 GST_ELEMENT_ERROR (src, RESOURCE, WRITE, (NULL), ("Can't write to buffer"));
508 gst_buffer_unref (buf);
509 return GST_FLOW_ERROR;
514 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
516 gboolean ret = FALSE;
517 GstFdSrc *src = GST_FD_SRC (basesrc);
519 switch (GST_QUERY_TYPE (query)) {
521 gst_query_set_uri (query, src->uri);
530 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
536 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
538 GstFdSrc *src = GST_FD_SRC (bsrc);
540 return src->seekable_fd;
544 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
546 GstFdSrc *src = GST_FD_SRC (bsrc);
547 struct stat stat_results;
549 if (src->size != -1) {
554 if (!src->seekable_fd) {
555 /* If it isn't seekable, we won't know the length (but fstat will still
556 * succeed, and wrongly say our length is zero. */
560 if (fstat (src->fd, &stat_results) < 0)
563 *size = stat_results.st_size;
575 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
579 GstFdSrc *src = GST_FD_SRC (bsrc);
581 offset = segment->start;
583 /* No need to seek to the current position */
584 if (offset == src->curoffset)
587 res = lseek (src->fd, offset, SEEK_SET);
588 if (G_UNLIKELY (res < 0 || res != offset))
591 segment->position = segment->start;
592 segment->time = segment->start;
597 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
601 /*** GSTURIHANDLER INTERFACE *************************************************/
604 gst_fd_src_uri_get_type (GType type)
609 static const gchar *const *
610 gst_fd_src_uri_get_protocols (GType type)
612 static const gchar *protocols[] = { "fd", NULL };
618 gst_fd_src_uri_get_uri (GstURIHandler * handler)
620 GstFdSrc *src = GST_FD_SRC (handler);
622 /* FIXME: make thread-safe */
623 return g_strdup (src->uri);
627 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
631 GstFdSrc *src = GST_FD_SRC (handler);
633 guint64 size = (guint64) - 1;
635 GST_INFO_OBJECT (src, "checking uri %s", uri);
637 protocol = gst_uri_get_protocol (uri);
638 if (strcmp (protocol, "fd") != 0) {
639 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
640 "Wrong protocol for fdsrc in uri: '%s'", uri);
646 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0) {
647 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
648 "Bad file descriptor number in uri: '%s'", uri);
652 if ((q = g_strstr_len (uri, -1, "?"))) {
653 gchar *sp, *end = NULL;
655 GST_INFO_OBJECT (src, "found ?");
657 if ((sp = g_strstr_len (q, -1, "size="))) {
658 sp += strlen ("size=");
659 size = g_ascii_strtoull (sp, &end, 10);
660 if ((size == 0 && errno == EINVAL) || size == G_MAXUINT64 || end == sp) {
661 GST_INFO_OBJECT (src, "parsing size failed");
664 GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
671 GST_OBJECT_LOCK (src);
672 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
673 gst_fd_src_update_fd (src, size);
675 GST_OBJECT_UNLOCK (src);
681 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
683 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
685 iface->get_type = gst_fd_src_uri_get_type;
686 iface->get_protocols = gst_fd_src_uri_get_protocols;
687 iface->get_uri = gst_fd_src_uri_get_uri;
688 iface->set_uri = gst_fd_src_uri_set_uri;