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 _do_init (GType fd_src_type)
119 static const GInterfaceInfo urihandler_info = {
120 gst_fd_src_uri_handler_init,
125 g_type_add_interface_static (fd_src_type, GST_TYPE_URI_HANDLER,
128 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
131 GST_BOILERPLATE_FULL (GstFdSrc, gst_fd_src, GstPushSrc, GST_TYPE_PUSH_SRC,
134 static void gst_fd_src_set_property (GObject * object, guint prop_id,
135 const GValue * value, GParamSpec * pspec);
136 static void gst_fd_src_get_property (GObject * object, guint prop_id,
137 GValue * value, GParamSpec * pspec);
138 static void gst_fd_src_dispose (GObject * obj);
140 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
141 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
142 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
143 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
144 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
145 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
146 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
147 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
149 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
152 gst_fd_src_base_init (gpointer g_class)
154 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
156 gst_element_class_set_details_simple (gstelement_class,
157 "Filedescriptor Source",
159 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
160 gst_element_class_add_pad_template (gstelement_class,
161 gst_static_pad_template_get (&srctemplate));
165 gst_fd_src_class_init (GstFdSrcClass * klass)
167 GObjectClass *gobject_class;
168 GstBaseSrcClass *gstbasesrc_class;
169 GstPushSrcClass *gstpush_src_class;
171 gobject_class = G_OBJECT_CLASS (klass);
172 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
173 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
175 gobject_class->set_property = gst_fd_src_set_property;
176 gobject_class->get_property = gst_fd_src_get_property;
177 gobject_class->dispose = gst_fd_src_dispose;
179 g_object_class_install_property (gobject_class, PROP_FD,
180 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
181 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
185 * Post a message after timeout microseconds
189 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
190 g_param_spec_uint64 ("timeout", "Timeout",
191 "Post a message after timeout microseconds (0 = disabled)", 0,
192 G_MAXUINT64, DEFAULT_TIMEOUT,
193 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
195 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
196 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
197 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
198 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
199 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
200 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
201 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
202 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
204 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
208 gst_fd_src_init (GstFdSrc * fdsrc, GstFdSrcClass * klass)
210 fdsrc->new_fd = DEFAULT_FD;
211 fdsrc->seekable_fd = FALSE;
214 fdsrc->timeout = DEFAULT_TIMEOUT;
215 fdsrc->uri = g_strdup_printf ("fd://0");
216 fdsrc->curoffset = 0;
220 gst_fd_src_dispose (GObject * obj)
222 GstFdSrc *src = GST_FD_SRC (obj);
227 G_OBJECT_CLASS (parent_class)->dispose (obj);
231 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
233 struct stat stat_results;
235 GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
238 /* we need to always update the fdset since it may not have existed when
239 * gst_fd_src_update_fd () was called earlier */
240 if (src->fdset != NULL) {
241 GstPollFD fd = GST_POLL_FD_INIT;
245 /* this will log a harmless warning, if it was never added */
246 gst_poll_remove_fd (src->fdset, &fd);
250 gst_poll_add_fd (src->fdset, &fd);
251 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
255 if (src->fd != src->new_fd) {
256 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
258 src->fd = src->new_fd;
260 GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
264 src->uri = g_strdup_printf ("fd://%d", src->fd);
266 if (fstat (src->fd, &stat_results) < 0)
269 if (!S_ISREG (stat_results.st_mode))
272 /* Try a seek of 0 bytes offset to check for seekability */
273 if (lseek (src->fd, 0, SEEK_CUR) < 0)
276 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
277 src->seekable_fd = TRUE;
283 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
284 src->seekable_fd = FALSE;
289 gst_fd_src_start (GstBaseSrc * bsrc)
291 GstFdSrc *src = GST_FD_SRC (bsrc);
295 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
298 gst_fd_src_update_fd (src, -1);
305 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
312 gst_fd_src_stop (GstBaseSrc * bsrc)
314 GstFdSrc *src = GST_FD_SRC (bsrc);
317 gst_poll_free (src->fdset);
325 gst_fd_src_unlock (GstBaseSrc * bsrc)
327 GstFdSrc *src = GST_FD_SRC (bsrc);
329 GST_LOG_OBJECT (src, "Flushing");
330 GST_OBJECT_LOCK (src);
331 gst_poll_set_flushing (src->fdset, TRUE);
332 GST_OBJECT_UNLOCK (src);
338 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
340 GstFdSrc *src = GST_FD_SRC (bsrc);
342 GST_LOG_OBJECT (src, "No longer flushing");
343 GST_OBJECT_LOCK (src);
344 gst_poll_set_flushing (src->fdset, FALSE);
345 GST_OBJECT_UNLOCK (src);
351 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
354 GstFdSrc *src = GST_FD_SRC (object);
358 src->new_fd = g_value_get_int (value);
360 /* If state is ready or below, update the current fd immediately
361 * so it is reflected in get_properties and uri */
362 GST_OBJECT_LOCK (object);
363 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
364 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
365 gst_fd_src_update_fd (src, -1);
367 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
369 GST_OBJECT_UNLOCK (object);
372 src->timeout = g_value_get_uint64 (value);
373 GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
374 GST_TIME_ARGS (src->timeout));
377 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
383 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
386 GstFdSrc *src = GST_FD_SRC (object);
390 g_value_set_int (value, src->fd);
393 g_value_set_uint64 (value, src->timeout);
396 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
402 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
408 GstClockTime timeout;
415 src = GST_FD_SRC (psrc);
417 if (src->timeout > 0) {
418 timeout = src->timeout * GST_USECOND;
420 timeout = GST_CLOCK_TIME_NONE;
427 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
428 GST_TIME_ARGS (src->timeout));
430 retval = gst_poll_wait (src->fdset, timeout);
431 GST_LOG_OBJECT (src, "poll returned %d", retval);
433 if (G_UNLIKELY (retval == -1)) {
434 if (errno == EINTR || errno == EAGAIN) {
435 /* retry if interrupted */
437 } else if (errno == EBUSY) {
442 } else if (G_UNLIKELY (retval == 0)) {
444 /* timeout, post element message */
445 gst_element_post_message (GST_ELEMENT_CAST (src),
446 gst_message_new_element (GST_OBJECT_CAST (src),
447 gst_structure_new ("GstFdSrcTimeout",
448 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
450 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
453 blocksize = GST_BASE_SRC (src)->blocksize;
455 /* create the buffer */
456 buf = gst_buffer_try_new_and_alloc (blocksize);
457 if (G_UNLIKELY (buf == NULL)) {
458 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
459 return GST_FLOW_ERROR;
463 readbytes = read (src->fd, GST_BUFFER_DATA (buf), blocksize);
464 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
465 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
473 GST_BUFFER_OFFSET (buf) = src->curoffset;
474 GST_BUFFER_SIZE (buf) = readbytes;
475 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
476 src->curoffset += readbytes;
478 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
480 /* we're done, return the buffer */
489 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
490 ("poll on file descriptor: %s.", g_strerror (errno)));
491 GST_DEBUG_OBJECT (psrc, "Error during poll");
492 return GST_FLOW_ERROR;
496 GST_DEBUG_OBJECT (psrc, "Poll stopped");
497 return GST_FLOW_WRONG_STATE;
502 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
503 gst_buffer_unref (buf);
504 return GST_FLOW_UNEXPECTED;
508 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
509 ("read on file descriptor: %s.", g_strerror (errno)));
510 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
511 gst_buffer_unref (buf);
512 return GST_FLOW_ERROR;
517 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
519 gboolean ret = FALSE;
520 GstFdSrc *src = GST_FD_SRC (basesrc);
522 switch (GST_QUERY_TYPE (query)) {
524 gst_query_set_uri (query, src->uri);
533 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
539 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
541 GstFdSrc *src = GST_FD_SRC (bsrc);
543 return src->seekable_fd;
547 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
549 GstFdSrc *src = GST_FD_SRC (bsrc);
550 struct stat stat_results;
552 if (src->size != -1) {
557 if (!src->seekable_fd) {
558 /* If it isn't seekable, we won't know the length (but fstat will still
559 * succeed, and wrongly say our length is zero. */
563 if (fstat (src->fd, &stat_results) < 0)
566 *size = stat_results.st_size;
578 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
582 GstFdSrc *src = GST_FD_SRC (bsrc);
584 offset = segment->start;
586 /* No need to seek to the current position */
587 if (offset == src->curoffset)
590 res = lseek (src->fd, offset, SEEK_SET);
591 if (G_UNLIKELY (res < 0 || res != offset))
594 segment->last_stop = segment->start;
595 segment->time = segment->start;
600 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
604 /*** GSTURIHANDLER INTERFACE *************************************************/
607 gst_fd_src_uri_get_type (void)
613 gst_fd_src_uri_get_protocols (void)
615 static gchar *protocols[] = { (char *) "fd", NULL };
621 gst_fd_src_uri_get_uri (GstURIHandler * handler)
623 GstFdSrc *src = GST_FD_SRC (handler);
629 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
632 GstFdSrc *src = GST_FD_SRC (handler);
636 GST_INFO_OBJECT (src, "checking uri %s", uri);
638 protocol = gst_uri_get_protocol (uri);
639 if (strcmp (protocol, "fd") != 0) {
645 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
648 if ((q = g_strstr_len (uri, -1, "?"))) {
651 GST_INFO_OBJECT (src, "found ?");
653 if ((sp = g_strstr_len (q, -1, "size="))) {
654 if (sscanf (sp, "size=%" G_GUINT64_FORMAT, &size) != 1) {
655 GST_INFO_OBJECT (src, "parsing size failed");
658 GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
665 GST_OBJECT_LOCK (src);
666 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
667 gst_fd_src_update_fd (src, size);
669 GST_OBJECT_UNLOCK (src);
675 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
677 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
679 iface->get_type = gst_fd_src_uri_get_type;
680 iface->get_protocols = gst_fd_src_uri_get_protocols;
681 iface->get_uri = gst_fd_src_uri_get_uri;
682 iface->set_uri = gst_fd_src_uri_set_uri;