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., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, 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 folowed 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
34 * <classname>"GstFdSrcTimeout"</classname>
35 * if no data was recieved 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 -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.
55 * Last reviewed on 2008-06-20 (0.10.21)
61 #include "gst/gst_private.h"
63 #include <sys/types.h>
66 #include <io.h> /* lseek, open, close, read */
68 #define lseek _lseeki64
74 #ifdef HAVE_SYS_SOCKET_H
75 #include <sys/socket.h>
86 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
93 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
98 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
99 #define GST_CAT_DEFAULT gst_fd_src_debug
102 #define DEFAULT_TIMEOUT 0
114 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
117 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_src_uri_handler_init); \
118 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
119 #define gst_fd_src_parent_class parent_class
120 G_DEFINE_TYPE_WITH_CODE (GstFdSrc, gst_fd_src, GST_TYPE_PUSH_SRC, _do_init);
122 static void gst_fd_src_set_property (GObject * object, guint prop_id,
123 const GValue * value, GParamSpec * pspec);
124 static void gst_fd_src_get_property (GObject * object, guint prop_id,
125 GValue * value, GParamSpec * pspec);
126 static void gst_fd_src_dispose (GObject * obj);
128 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
129 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
130 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
131 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
132 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
133 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
134 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
135 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
137 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
140 gst_fd_src_class_init (GstFdSrcClass * klass)
142 GObjectClass *gobject_class;
143 GstElementClass *gstelement_class;
144 GstBaseSrcClass *gstbasesrc_class;
145 GstPushSrcClass *gstpush_src_class;
147 gobject_class = G_OBJECT_CLASS (klass);
148 gstelement_class = GST_ELEMENT_CLASS (klass);
149 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
150 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
152 gobject_class->set_property = gst_fd_src_set_property;
153 gobject_class->get_property = gst_fd_src_get_property;
154 gobject_class->dispose = gst_fd_src_dispose;
156 g_object_class_install_property (gobject_class, PROP_FD,
157 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
158 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
162 * Post a message after timeout microseconds
166 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
167 g_param_spec_uint64 ("timeout", "Timeout",
168 "Post a message after timeout microseconds (0 = disabled)", 0,
169 G_MAXUINT64, DEFAULT_TIMEOUT,
170 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
172 gst_element_class_set_details_simple (gstelement_class,
173 "Filedescriptor Source",
175 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
176 gst_element_class_add_pad_template (gstelement_class,
177 gst_static_pad_template_get (&srctemplate));
179 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
180 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
181 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
182 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
183 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
184 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
185 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
186 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
188 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
192 gst_fd_src_init (GstFdSrc * fdsrc)
194 fdsrc->new_fd = DEFAULT_FD;
195 fdsrc->seekable_fd = FALSE;
198 fdsrc->timeout = DEFAULT_TIMEOUT;
199 fdsrc->uri = g_strdup_printf ("fd://0");
200 fdsrc->curoffset = 0;
204 gst_fd_src_dispose (GObject * obj)
206 GstFdSrc *src = GST_FD_SRC (obj);
211 G_OBJECT_CLASS (parent_class)->dispose (obj);
215 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
217 struct stat stat_results;
219 GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
222 /* we need to always update the fdset since it may not have existed when
223 * gst_fd_src_update_fd () was called earlier */
224 if (src->fdset != NULL) {
225 GstPollFD fd = GST_POLL_FD_INIT;
229 /* this will log a harmless warning, if it was never added */
230 gst_poll_remove_fd (src->fdset, &fd);
234 gst_poll_add_fd (src->fdset, &fd);
235 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
239 if (src->fd != src->new_fd) {
240 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
242 src->fd = src->new_fd;
244 GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
248 src->uri = g_strdup_printf ("fd://%d", src->fd);
250 if (fstat (src->fd, &stat_results) < 0)
253 if (!S_ISREG (stat_results.st_mode))
256 /* Try a seek of 0 bytes offset to check for seekability */
257 if (lseek (src->fd, 0, SEEK_CUR) < 0)
260 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
261 src->seekable_fd = TRUE;
267 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
268 src->seekable_fd = FALSE;
273 gst_fd_src_start (GstBaseSrc * bsrc)
275 GstFdSrc *src = GST_FD_SRC (bsrc);
279 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
282 gst_fd_src_update_fd (src, -1);
289 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
296 gst_fd_src_stop (GstBaseSrc * bsrc)
298 GstFdSrc *src = GST_FD_SRC (bsrc);
301 gst_poll_free (src->fdset);
309 gst_fd_src_unlock (GstBaseSrc * bsrc)
311 GstFdSrc *src = GST_FD_SRC (bsrc);
313 GST_LOG_OBJECT (src, "Flushing");
314 GST_OBJECT_LOCK (src);
315 gst_poll_set_flushing (src->fdset, TRUE);
316 GST_OBJECT_UNLOCK (src);
322 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
324 GstFdSrc *src = GST_FD_SRC (bsrc);
326 GST_LOG_OBJECT (src, "No longer flushing");
327 GST_OBJECT_LOCK (src);
328 gst_poll_set_flushing (src->fdset, FALSE);
329 GST_OBJECT_UNLOCK (src);
335 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
338 GstFdSrc *src = GST_FD_SRC (object);
342 src->new_fd = g_value_get_int (value);
344 /* If state is ready or below, update the current fd immediately
345 * so it is reflected in get_properties and uri */
346 GST_OBJECT_LOCK (object);
347 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
348 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
349 gst_fd_src_update_fd (src, -1);
351 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
353 GST_OBJECT_UNLOCK (object);
356 src->timeout = g_value_get_uint64 (value);
357 GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
358 GST_TIME_ARGS (src->timeout));
361 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
367 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
370 GstFdSrc *src = GST_FD_SRC (object);
374 g_value_set_int (value, src->fd);
377 g_value_set_uint64 (value, src->timeout);
380 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
386 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
392 GstClockTime timeout;
401 src = GST_FD_SRC (psrc);
403 if (src->timeout > 0) {
404 timeout = src->timeout * GST_USECOND;
406 timeout = GST_CLOCK_TIME_NONE;
413 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
414 GST_TIME_ARGS (src->timeout));
416 retval = gst_poll_wait (src->fdset, timeout);
417 GST_LOG_OBJECT (src, "poll returned %d", retval);
419 if (G_UNLIKELY (retval == -1)) {
420 if (errno == EINTR || errno == EAGAIN) {
421 /* retry if interrupted */
423 } else if (errno == EBUSY) {
428 } else if (G_UNLIKELY (retval == 0)) {
430 /* timeout, post element message */
431 gst_element_post_message (GST_ELEMENT_CAST (src),
432 gst_message_new_element (GST_OBJECT_CAST (src),
433 gst_structure_new ("GstFdSrcTimeout",
434 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
436 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
439 blocksize = GST_BASE_SRC (src)->blocksize;
441 /* create the buffer */
442 buf = gst_buffer_new_and_alloc (blocksize);
443 if (G_UNLIKELY (buf == NULL))
446 data = gst_buffer_map (buf, NULL, &maxsize, GST_MAP_WRITE);
449 readbytes = read (src->fd, data, blocksize);
450 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
451 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
456 gst_buffer_unmap (buf, data, readbytes);
461 GST_BUFFER_OFFSET (buf) = src->curoffset;
462 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
463 src->curoffset += readbytes;
465 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
467 /* we're done, return the buffer */
476 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
477 ("poll on file descriptor: %s.", g_strerror (errno)));
478 GST_DEBUG_OBJECT (psrc, "Error during poll");
479 return GST_FLOW_ERROR;
483 GST_DEBUG_OBJECT (psrc, "Poll stopped");
484 return GST_FLOW_WRONG_STATE;
489 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
490 return GST_FLOW_ERROR;
494 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
495 gst_buffer_unref (buf);
496 return GST_FLOW_UNEXPECTED;
500 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
501 ("read on file descriptor: %s.", g_strerror (errno)));
502 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
503 gst_buffer_unmap (buf, data, 0);
504 gst_buffer_unref (buf);
505 return GST_FLOW_ERROR;
510 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
512 gboolean ret = FALSE;
513 GstFdSrc *src = GST_FD_SRC (basesrc);
515 switch (GST_QUERY_TYPE (query)) {
517 gst_query_set_uri (query, src->uri);
526 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
532 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
534 GstFdSrc *src = GST_FD_SRC (bsrc);
536 return src->seekable_fd;
540 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
542 GstFdSrc *src = GST_FD_SRC (bsrc);
543 struct stat stat_results;
545 if (src->size != -1) {
550 if (!src->seekable_fd) {
551 /* If it isn't seekable, we won't know the length (but fstat will still
552 * succeed, and wrongly say our length is zero. */
556 if (fstat (src->fd, &stat_results) < 0)
559 *size = stat_results.st_size;
571 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
575 GstFdSrc *src = GST_FD_SRC (bsrc);
577 offset = segment->start;
579 /* No need to seek to the current position */
580 if (offset == src->curoffset)
583 res = lseek (src->fd, offset, SEEK_SET);
584 if (G_UNLIKELY (res < 0 || res != offset))
587 segment->position = segment->start;
588 segment->time = segment->start;
593 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
597 /*** GSTURIHANDLER INTERFACE *************************************************/
600 gst_fd_src_uri_get_type (void)
606 gst_fd_src_uri_get_protocols (void)
608 static gchar *protocols[] = { (char *) "fd", NULL };
614 gst_fd_src_uri_get_uri (GstURIHandler * handler)
616 GstFdSrc *src = GST_FD_SRC (handler);
622 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
625 GstFdSrc *src = GST_FD_SRC (handler);
629 GST_INFO_OBJECT (src, "checking uri %s", uri);
631 protocol = gst_uri_get_protocol (uri);
632 if (strcmp (protocol, "fd") != 0) {
638 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
641 if ((q = g_strstr_len (uri, -1, "?"))) {
644 GST_INFO_OBJECT (src, "found ?");
646 if ((sp = g_strstr_len (q, -1, "size="))) {
647 if (sscanf (sp, "size=%" G_GUINT64_FORMAT, &size) != 1) {
648 GST_INFO_OBJECT (src, "parsing size failed");
651 GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
658 GST_OBJECT_LOCK (src);
659 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
660 gst_fd_src_update_fd (src, size);
662 GST_OBJECT_UNLOCK (src);
668 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
670 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
672 iface->get_type = gst_fd_src_uri_get_type;
673 iface->get_protocols = gst_fd_src_uri_get_protocols;
674 iface->get_uri = gst_fd_src_uri_get_uri;
675 iface->set_uri = gst_fd_src_uri_set_uri;