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 #include <sys/socket.h>
88 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
93 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
94 #define GST_CAT_DEFAULT gst_fd_src_debug
97 #define DEFAULT_TIMEOUT 0
109 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
112 _do_init (GType fd_src_type)
114 static const GInterfaceInfo urihandler_info = {
115 gst_fd_src_uri_handler_init,
120 g_type_add_interface_static (fd_src_type, GST_TYPE_URI_HANDLER,
123 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
126 GST_BOILERPLATE_FULL (GstFdSrc, gst_fd_src, GstPushSrc, GST_TYPE_PUSH_SRC,
129 static void gst_fd_src_set_property (GObject * object, guint prop_id,
130 const GValue * value, GParamSpec * pspec);
131 static void gst_fd_src_get_property (GObject * object, guint prop_id,
132 GValue * value, GParamSpec * pspec);
133 static void gst_fd_src_dispose (GObject * obj);
135 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
136 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
137 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
138 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
139 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
140 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
141 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
142 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
144 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
147 gst_fd_src_base_init (gpointer g_class)
149 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
151 gst_element_class_set_details_simple (gstelement_class,
152 "Filedescriptor Source",
154 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
155 gst_element_class_add_pad_template (gstelement_class,
156 gst_static_pad_template_get (&srctemplate));
160 gst_fd_src_class_init (GstFdSrcClass * klass)
162 GObjectClass *gobject_class;
163 GstBaseSrcClass *gstbasesrc_class;
164 GstPushSrcClass *gstpush_src_class;
166 gobject_class = G_OBJECT_CLASS (klass);
167 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
168 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
170 parent_class = g_type_class_peek_parent (klass);
172 gobject_class->set_property = gst_fd_src_set_property;
173 gobject_class->get_property = gst_fd_src_get_property;
174 gobject_class->dispose = gst_fd_src_dispose;
176 g_object_class_install_property (gobject_class, PROP_FD,
177 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
178 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
182 * Post a message after timeout microseconds
186 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
187 g_param_spec_uint64 ("timeout", "Timeout",
188 "Post a message after timeout microseconds (0 = disabled)", 0,
189 G_MAXUINT64, DEFAULT_TIMEOUT,
190 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
192 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
193 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
194 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
195 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
196 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
197 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
198 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
199 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
201 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
205 gst_fd_src_init (GstFdSrc * fdsrc, GstFdSrcClass * klass)
208 fdsrc->seekable_fd = FALSE;
209 fdsrc->fd = DEFAULT_FD;
210 fdsrc->timeout = DEFAULT_TIMEOUT;
211 fdsrc->uri = g_strdup_printf ("fd://0");
212 fdsrc->curoffset = 0;
216 gst_fd_src_dispose (GObject * obj)
218 GstFdSrc *src = GST_FD_SRC (obj);
223 G_OBJECT_CLASS (parent_class)->dispose (obj);
227 gst_fd_src_update_fd (GstFdSrc * src)
229 struct stat stat_results;
231 /* we need to always update the fdset since it may not have existed when
232 * gst_fd_src_update_fd () was called earlier */
233 if (src->fdset != NULL) {
234 GstPollFD fd = GST_POLL_FD_INIT;
238 gst_poll_remove_fd (src->fdset, &fd);
242 gst_poll_add_fd (src->fdset, &fd);
243 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
246 if (src->fd != src->new_fd) {
247 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
249 src->fd = src->new_fd;
252 src->uri = g_strdup_printf ("fd://%d", src->fd);
254 if (fstat (src->fd, &stat_results) < 0)
257 if (!S_ISREG (stat_results.st_mode))
260 /* Try a seek of 0 bytes offset to check for seekability */
261 if (lseek (src->fd, 0, SEEK_CUR) < 0)
264 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
265 src->seekable_fd = TRUE;
271 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
272 src->seekable_fd = 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);
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);
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)
396 GstClockTime timeout;
403 src = GST_FD_SRC (psrc);
405 if (src->timeout > 0) {
406 timeout = src->timeout * GST_USECOND;
408 timeout = GST_CLOCK_TIME_NONE;
415 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
416 GST_TIME_ARGS (src->timeout));
418 retval = gst_poll_wait (src->fdset, timeout);
419 GST_LOG_OBJECT (src, "poll returned %d", retval);
421 if (G_UNLIKELY (retval == -1)) {
422 if (errno == EINTR || errno == EAGAIN) {
423 /* retry if interrupted */
425 } else if (errno == EBUSY) {
430 } else if (G_UNLIKELY (retval == 0)) {
432 /* timeout, post element message */
433 gst_element_post_message (GST_ELEMENT_CAST (src),
434 gst_message_new_element (GST_OBJECT_CAST (src),
435 gst_structure_new ("GstFdSrcTimeout",
436 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
438 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
441 blocksize = GST_BASE_SRC (src)->blocksize;
443 /* create the buffer */
444 buf = gst_buffer_try_new_and_alloc (blocksize);
445 if (G_UNLIKELY (buf == NULL)) {
446 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
447 return GST_FLOW_ERROR;
451 readbytes = read (src->fd, GST_BUFFER_DATA (buf), blocksize);
452 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
453 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
461 GST_BUFFER_OFFSET (buf) = src->curoffset;
462 GST_BUFFER_SIZE (buf) = readbytes;
463 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
464 src->curoffset += readbytes;
466 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
468 /* we're done, return the buffer */
477 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
478 ("poll on file descriptor: %s.", g_strerror (errno)));
479 GST_DEBUG_OBJECT (psrc, "Error during poll");
480 return GST_FLOW_ERROR;
484 GST_DEBUG_OBJECT (psrc, "Poll stopped");
485 return GST_FLOW_WRONG_STATE;
490 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
491 gst_buffer_unref (buf);
492 return GST_FLOW_UNEXPECTED;
496 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
497 ("read on file descriptor: %s.", g_strerror (errno)));
498 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
499 gst_buffer_unref (buf);
500 return GST_FLOW_ERROR;
505 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
507 gboolean ret = FALSE;
508 GstFdSrc *src = GST_FD_SRC (basesrc);
510 switch (GST_QUERY_TYPE (query)) {
512 gst_query_set_uri (query, src->uri);
521 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
527 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
529 GstFdSrc *src = GST_FD_SRC (bsrc);
531 return src->seekable_fd;
535 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
537 GstFdSrc *src = GST_FD_SRC (bsrc);
538 struct stat stat_results;
540 if (!src->seekable_fd) {
541 /* If it isn't seekable, we won't know the length (but fstat will still
542 * succeed, and wrongly say our length is zero. */
546 if (fstat (src->fd, &stat_results) < 0)
549 *size = stat_results.st_size;
561 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
565 GstFdSrc *src = GST_FD_SRC (bsrc);
567 offset = segment->start;
569 /* No need to seek to the current position */
570 if (offset == src->curoffset)
573 res = lseek (src->fd, offset, SEEK_SET);
574 if (G_UNLIKELY (res < 0 || res != offset))
577 segment->last_stop = segment->start;
578 segment->time = segment->start;
583 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
587 /*** GSTURIHANDLER INTERFACE *************************************************/
590 gst_fd_src_uri_get_type (void)
596 gst_fd_src_uri_get_protocols (void)
598 static gchar *protocols[] = { "fd", NULL };
604 gst_fd_src_uri_get_uri (GstURIHandler * handler)
606 GstFdSrc *src = GST_FD_SRC (handler);
612 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
615 GstFdSrc *src = GST_FD_SRC (handler);
618 protocol = gst_uri_get_protocol (uri);
619 if (strcmp (protocol, "fd") != 0) {
625 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
630 GST_OBJECT_LOCK (src);
631 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
632 gst_fd_src_update_fd (src);
634 GST_OBJECT_UNLOCK (src);
640 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
642 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
644 iface->get_type = gst_fd_src_uri_get_type;
645 iface->get_protocols = gst_fd_src_uri_get_protocols;
646 iface->get_uri = gst_fd_src_uri_get_uri;
647 iface->set_uri = gst_fd_src_uri_set_uri;