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
34 * <classname>"GstFdSrcTimeout"</classname>
35 * 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 -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
72 #ifdef HAVE_SYS_SOCKET_H
73 #include <sys/socket.h>
84 #define S_ISREG(m) (((m)&S_IFREG)==S_IFREG)
91 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
96 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
97 #define GST_CAT_DEFAULT gst_fd_src_debug
100 #define DEFAULT_TIMEOUT 0
112 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
115 G_IMPLEMENT_INTERFACE (GST_TYPE_URI_HANDLER, gst_fd_src_uri_handler_init); \
116 GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
117 #define gst_fd_src_parent_class parent_class
118 G_DEFINE_TYPE_WITH_CODE (GstFdSrc, gst_fd_src, GST_TYPE_PUSH_SRC, _do_init);
120 static void gst_fd_src_set_property (GObject * object, guint prop_id,
121 const GValue * value, GParamSpec * pspec);
122 static void gst_fd_src_get_property (GObject * object, guint prop_id,
123 GValue * value, GParamSpec * pspec);
124 static void gst_fd_src_dispose (GObject * obj);
126 static gboolean gst_fd_src_start (GstBaseSrc * bsrc);
127 static gboolean gst_fd_src_stop (GstBaseSrc * bsrc);
128 static gboolean gst_fd_src_unlock (GstBaseSrc * bsrc);
129 static gboolean gst_fd_src_unlock_stop (GstBaseSrc * bsrc);
130 static gboolean gst_fd_src_is_seekable (GstBaseSrc * bsrc);
131 static gboolean gst_fd_src_get_size (GstBaseSrc * src, guint64 * size);
132 static gboolean gst_fd_src_do_seek (GstBaseSrc * src, GstSegment * segment);
133 static gboolean gst_fd_src_query (GstBaseSrc * src, GstQuery * query);
135 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
138 gst_fd_src_class_init (GstFdSrcClass * klass)
140 GObjectClass *gobject_class;
141 GstElementClass *gstelement_class;
142 GstBaseSrcClass *gstbasesrc_class;
143 GstPushSrcClass *gstpush_src_class;
145 gobject_class = G_OBJECT_CLASS (klass);
146 gstelement_class = GST_ELEMENT_CLASS (klass);
147 gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
148 gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
150 gobject_class->set_property = gst_fd_src_set_property;
151 gobject_class->get_property = gst_fd_src_get_property;
152 gobject_class->dispose = gst_fd_src_dispose;
154 g_object_class_install_property (gobject_class, PROP_FD,
155 g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
156 0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
160 * Post a message after timeout microseconds
162 g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
163 g_param_spec_uint64 ("timeout", "Timeout",
164 "Post a message after timeout microseconds (0 = disabled)", 0,
165 G_MAXUINT64, DEFAULT_TIMEOUT,
166 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
168 gst_element_class_set_static_metadata (gstelement_class,
169 "Filedescriptor Source",
171 "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
172 gst_element_class_add_pad_template (gstelement_class,
173 gst_static_pad_template_get (&srctemplate));
175 gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
176 gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
177 gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
178 gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
179 gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
180 gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
181 gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
182 gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
184 gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
188 gst_fd_src_init (GstFdSrc * fdsrc)
190 fdsrc->new_fd = DEFAULT_FD;
191 fdsrc->seekable_fd = FALSE;
194 fdsrc->timeout = DEFAULT_TIMEOUT;
195 fdsrc->uri = g_strdup_printf ("fd://0");
196 fdsrc->curoffset = 0;
200 gst_fd_src_dispose (GObject * obj)
202 GstFdSrc *src = GST_FD_SRC (obj);
207 G_OBJECT_CLASS (parent_class)->dispose (obj);
211 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
213 struct stat stat_results;
215 GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
218 /* we need to always update the fdset since it may not have existed when
219 * gst_fd_src_update_fd () was called earlier */
220 if (src->fdset != NULL) {
221 GstPollFD fd = GST_POLL_FD_INIT;
225 /* this will log a harmless warning, if it was never added */
226 gst_poll_remove_fd (src->fdset, &fd);
230 gst_poll_add_fd (src->fdset, &fd);
231 gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
235 if (src->fd != src->new_fd) {
236 GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
238 src->fd = src->new_fd;
240 GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
244 src->uri = g_strdup_printf ("fd://%d", src->fd);
246 if (fstat (src->fd, &stat_results) < 0)
249 if (!S_ISREG (stat_results.st_mode))
252 /* Try a seek of 0 bytes offset to check for seekability */
253 if (lseek (src->fd, 0, SEEK_CUR) < 0)
256 GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
257 src->seekable_fd = TRUE;
259 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), TRUE);
265 GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
266 src->seekable_fd = FALSE;
267 gst_base_src_set_dynamic_size (GST_BASE_SRC (src), FALSE);
272 gst_fd_src_start (GstBaseSrc * bsrc)
274 GstFdSrc *src = GST_FD_SRC (bsrc);
278 if ((src->fdset = gst_poll_new (TRUE)) == NULL)
281 gst_fd_src_update_fd (src, -1);
288 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
295 gst_fd_src_stop (GstBaseSrc * bsrc)
297 GstFdSrc *src = GST_FD_SRC (bsrc);
300 gst_poll_free (src->fdset);
308 gst_fd_src_unlock (GstBaseSrc * bsrc)
310 GstFdSrc *src = GST_FD_SRC (bsrc);
312 GST_LOG_OBJECT (src, "Flushing");
313 GST_OBJECT_LOCK (src);
314 gst_poll_set_flushing (src->fdset, TRUE);
315 GST_OBJECT_UNLOCK (src);
321 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
323 GstFdSrc *src = GST_FD_SRC (bsrc);
325 GST_LOG_OBJECT (src, "No longer flushing");
326 GST_OBJECT_LOCK (src);
327 gst_poll_set_flushing (src->fdset, FALSE);
328 GST_OBJECT_UNLOCK (src);
334 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
337 GstFdSrc *src = GST_FD_SRC (object);
341 src->new_fd = g_value_get_int (value);
343 /* If state is ready or below, update the current fd immediately
344 * so it is reflected in get_properties and uri */
345 GST_OBJECT_LOCK (object);
346 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
347 GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
348 gst_fd_src_update_fd (src, -1);
350 GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
352 GST_OBJECT_UNLOCK (object);
355 src->timeout = g_value_get_uint64 (value);
356 GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
357 GST_TIME_ARGS (src->timeout));
360 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
366 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
369 GstFdSrc *src = GST_FD_SRC (object);
373 g_value_set_int (value, src->fd);
376 g_value_set_uint64 (value, src->timeout);
379 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
385 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
394 GstClockTime timeout;
399 src = GST_FD_SRC (psrc);
402 if (src->timeout > 0) {
403 timeout = src->timeout * GST_USECOND;
405 timeout = GST_CLOCK_TIME_NONE;
411 GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
412 GST_TIME_ARGS (src->timeout));
414 retval = gst_poll_wait (src->fdset, timeout);
415 GST_LOG_OBJECT (src, "poll returned %d", retval);
417 if (G_UNLIKELY (retval == -1)) {
418 if (errno == EINTR || errno == EAGAIN) {
419 /* retry if interrupted */
421 } else if (errno == EBUSY) {
426 } else if (G_UNLIKELY (retval == 0)) {
428 /* timeout, post element message */
429 gst_element_post_message (GST_ELEMENT_CAST (src),
430 gst_message_new_element (GST_OBJECT_CAST (src),
431 gst_structure_new ("GstFdSrcTimeout",
432 "timeout", G_TYPE_UINT64, src->timeout, NULL)));
434 } while (G_UNLIKELY (try_again)); /* retry if interrupted or timeout */
437 blocksize = GST_BASE_SRC (src)->blocksize;
439 /* create the buffer */
440 buf = gst_buffer_new_allocate (NULL, blocksize, NULL);
441 if (G_UNLIKELY (buf == NULL))
444 gst_buffer_map (buf, &info, GST_MAP_WRITE);
447 readbytes = read (src->fd, info.data, blocksize);
448 GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
449 } while (readbytes == -1 && errno == EINTR); /* retry if interrupted */
454 gst_buffer_unmap (buf, &info);
455 gst_buffer_resize (buf, 0, readbytes);
460 GST_BUFFER_OFFSET (buf) = src->curoffset;
461 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
462 src->curoffset += readbytes;
464 GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
466 /* we're done, return the buffer */
475 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
476 ("poll on file descriptor: %s.", g_strerror (errno)));
477 GST_DEBUG_OBJECT (psrc, "Error during poll");
478 return GST_FLOW_ERROR;
482 GST_DEBUG_OBJECT (psrc, "Poll stopped");
483 return GST_FLOW_FLUSHING;
488 GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
489 return GST_FLOW_ERROR;
493 GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
494 gst_buffer_unref (buf);
499 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
500 ("read on file descriptor: %s.", g_strerror (errno)));
501 GST_DEBUG_OBJECT (psrc, "Error reading from fd");
502 gst_buffer_unmap (buf, &info);
503 gst_buffer_unref (buf);
504 return GST_FLOW_ERROR;
509 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
511 gboolean ret = FALSE;
512 GstFdSrc *src = GST_FD_SRC (basesrc);
514 switch (GST_QUERY_TYPE (query)) {
516 gst_query_set_uri (query, src->uri);
525 ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
531 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
533 GstFdSrc *src = GST_FD_SRC (bsrc);
535 return src->seekable_fd;
539 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
541 GstFdSrc *src = GST_FD_SRC (bsrc);
542 struct stat stat_results;
544 if (src->size != -1) {
549 if (!src->seekable_fd) {
550 /* If it isn't seekable, we won't know the length (but fstat will still
551 * succeed, and wrongly say our length is zero. */
555 if (fstat (src->fd, &stat_results) < 0)
558 *size = stat_results.st_size;
570 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
574 GstFdSrc *src = GST_FD_SRC (bsrc);
576 offset = segment->start;
578 /* No need to seek to the current position */
579 if (offset == src->curoffset)
582 res = lseek (src->fd, offset, SEEK_SET);
583 if (G_UNLIKELY (res < 0 || res != offset))
586 segment->position = segment->start;
587 segment->time = segment->start;
592 GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
596 /*** GSTURIHANDLER INTERFACE *************************************************/
599 gst_fd_src_uri_get_type (GType type)
604 static const gchar *const *
605 gst_fd_src_uri_get_protocols (GType type)
607 static const gchar *protocols[] = { "fd", NULL };
613 gst_fd_src_uri_get_uri (GstURIHandler * handler)
615 GstFdSrc *src = GST_FD_SRC (handler);
617 /* FIXME: make thread-safe */
618 return g_strdup (src->uri);
622 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
626 GstFdSrc *src = GST_FD_SRC (handler);
628 guint64 size = (guint64) - 1;
630 GST_INFO_OBJECT (src, "checking uri %s", uri);
632 protocol = gst_uri_get_protocol (uri);
633 if (strcmp (protocol, "fd") != 0) {
634 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
635 "Wrong protocol for fdsrc in uri: '%s'", uri);
641 if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0) {
642 g_set_error (err, GST_URI_ERROR, GST_URI_ERROR_BAD_URI,
643 "Bad file descriptor number in uri: '%s'", uri);
647 if ((q = g_strstr_len (uri, -1, "?"))) {
650 GST_INFO_OBJECT (src, "found ?");
652 if ((sp = g_strstr_len (q, -1, "size="))) {
653 if (sscanf (sp, "size=%" G_GUINT64_FORMAT, &size) != 1) {
654 GST_INFO_OBJECT (src, "parsing size failed");
657 GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
664 GST_OBJECT_LOCK (src);
665 if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
666 gst_fd_src_update_fd (src, size);
668 GST_OBJECT_UNLOCK (src);
674 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
676 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
678 iface->get_type = gst_fd_src_uri_get_type;
679 iface->get_protocols = gst_fd_src_uri_get_protocols;
680 iface->get_uri = gst_fd_src_uri_get_uri;
681 iface->set_uri = gst_fd_src_uri_set_uri;