docs: Fix typos in function/object descriptions
[platform/upstream/gstreamer.git] / plugins / elements / gstfdsrc.c
1 /* GStreamer
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>
5  *
6  * gstfdsrc.c:
7  *
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.
12  *
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.
17  *
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.
22  */
23 /**
24  * SECTION:element-fdsrc
25  * @see_also: #GstFdSink
26  *
27  * Read data from a unix file descriptor.
28  *
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.
31  *
32  * If the #GstFdSrc:timeout property is set to a value bigger than 0, fdsrc will
33  * generate an element message named
34  * <classname>&quot;GstFdSrcTimeout&quot;</classname>
35  * if no data was received in the given timeout.
36  * The message's structure contains one field:
37  * <itemizedlist>
38  * <listitem>
39  *   <para>
40  *   #guint64
41  *   <classname>&quot;timeout&quot;</classname>: the timeout in microseconds that
42  *   expired when waiting for data.
43  *   </para>
44  * </listitem>
45  * </itemizedlist>
46  *
47  * <refsect2>
48  * <title>Example launch line</title>
49  * |[
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.
53  * </refsect2>
54  *
55  * Last reviewed on 2008-06-20 (0.10.21)
56  */
57
58 #ifdef HAVE_CONFIG_H
59 #  include "config.h"
60 #endif
61 #include "gst/gst_private.h"
62
63 #include <sys/types.h>
64
65 #ifdef G_OS_WIN32
66 #include <io.h>                 /* lseek, open, close, read */
67 #undef lseek
68 #define lseek _lseeki64
69 #undef off_t
70 #define off_t guint64
71 #endif
72
73 #include <sys/stat.h>
74 #ifdef HAVE_SYS_SOCKET_H
75 #include <sys/socket.h>
76 #endif
77 #include <fcntl.h>
78 #include <stdio.h>
79 #ifdef HAVE_UNISTD_H
80 #include <unistd.h>
81 #endif
82 #ifdef _MSC_VER
83 #undef stat
84 #define stat _stat
85 #define fstat _fstat
86 #define S_ISREG(m)      (((m)&S_IFREG)==S_IFREG)
87 #endif
88 #include <stdlib.h>
89 #include <errno.h>
90
91 #include "gstfdsrc.h"
92
93 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
94     GST_PAD_SRC,
95     GST_PAD_ALWAYS,
96     GST_STATIC_CAPS_ANY);
97
98 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
99 #define GST_CAT_DEFAULT gst_fd_src_debug
100
101 #define DEFAULT_FD              0
102 #define DEFAULT_TIMEOUT         0
103
104 enum
105 {
106   PROP_0,
107
108   PROP_FD,
109   PROP_TIMEOUT,
110
111   PROP_LAST
112 };
113
114 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
115
116 #define _do_init \
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);
121
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);
127
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);
136
137 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
138
139 static void
140 gst_fd_src_class_init (GstFdSrcClass * klass)
141 {
142   GObjectClass *gobject_class;
143   GstElementClass *gstelement_class;
144   GstBaseSrcClass *gstbasesrc_class;
145   GstPushSrcClass *gstpush_src_class;
146
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);
151
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;
155
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));
159   /**
160    * GstFdSrc:timeout
161    *
162    * Post a message after timeout microseconds
163    */
164   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
165       g_param_spec_uint64 ("timeout", "Timeout",
166           "Post a message after timeout microseconds (0 = disabled)", 0,
167           G_MAXUINT64, DEFAULT_TIMEOUT,
168           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
169
170   gst_element_class_set_static_metadata (gstelement_class,
171       "Filedescriptor Source",
172       "Source/File",
173       "Read from a file descriptor", "Erik Walthinsen <omega@cse.ogi.edu>");
174   gst_element_class_add_pad_template (gstelement_class,
175       gst_static_pad_template_get (&srctemplate));
176
177   gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
178   gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
179   gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
180   gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
181   gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
182   gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
183   gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
184   gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
185
186   gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
187 }
188
189 static void
190 gst_fd_src_init (GstFdSrc * fdsrc)
191 {
192   fdsrc->new_fd = DEFAULT_FD;
193   fdsrc->seekable_fd = FALSE;
194   fdsrc->fd = -1;
195   fdsrc->size = -1;
196   fdsrc->timeout = DEFAULT_TIMEOUT;
197   fdsrc->uri = g_strdup_printf ("fd://0");
198   fdsrc->curoffset = 0;
199 }
200
201 static void
202 gst_fd_src_dispose (GObject * obj)
203 {
204   GstFdSrc *src = GST_FD_SRC (obj);
205
206   g_free (src->uri);
207   src->uri = NULL;
208
209   G_OBJECT_CLASS (parent_class)->dispose (obj);
210 }
211
212 static void
213 gst_fd_src_update_fd (GstFdSrc * src, guint64 size)
214 {
215   struct stat stat_results;
216
217   GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
218       src->new_fd);
219
220   /* we need to always update the fdset since it may not have existed when
221    * gst_fd_src_update_fd () was called earlier */
222   if (src->fdset != NULL) {
223     GstPollFD fd = GST_POLL_FD_INIT;
224
225     if (src->fd >= 0) {
226       fd.fd = src->fd;
227       /* this will log a harmless warning, if it was never added */
228       gst_poll_remove_fd (src->fdset, &fd);
229     }
230
231     fd.fd = src->new_fd;
232     gst_poll_add_fd (src->fdset, &fd);
233     gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
234   }
235
236
237   if (src->fd != src->new_fd) {
238     GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
239
240     src->fd = src->new_fd;
241
242     GST_INFO_OBJECT (src, "Setting size to fd %" G_GUINT64_FORMAT, size);
243     src->size = size;
244
245     g_free (src->uri);
246     src->uri = g_strdup_printf ("fd://%d", src->fd);
247
248     if (fstat (src->fd, &stat_results) < 0)
249       goto not_seekable;
250
251     if (!S_ISREG (stat_results.st_mode))
252       goto not_seekable;
253
254     /* Try a seek of 0 bytes offset to check for seekability */
255     if (lseek (src->fd, 0, SEEK_CUR) < 0)
256       goto not_seekable;
257
258     GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
259     src->seekable_fd = TRUE;
260
261     gst_base_src_set_dynamic_size (GST_BASE_SRC (src), TRUE);
262   }
263   return;
264
265 not_seekable:
266   {
267     GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
268     src->seekable_fd = FALSE;
269     gst_base_src_set_dynamic_size (GST_BASE_SRC (src), FALSE);
270   }
271 }
272
273 static gboolean
274 gst_fd_src_start (GstBaseSrc * bsrc)
275 {
276   GstFdSrc *src = GST_FD_SRC (bsrc);
277
278   src->curoffset = 0;
279
280   if ((src->fdset = gst_poll_new (TRUE)) == NULL)
281     goto socket_pair;
282
283   gst_fd_src_update_fd (src, -1);
284
285   return TRUE;
286
287   /* ERRORS */
288 socket_pair:
289   {
290     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
291         GST_ERROR_SYSTEM);
292     return FALSE;
293   }
294 }
295
296 static gboolean
297 gst_fd_src_stop (GstBaseSrc * bsrc)
298 {
299   GstFdSrc *src = GST_FD_SRC (bsrc);
300
301   if (src->fdset) {
302     gst_poll_free (src->fdset);
303     src->fdset = NULL;
304   }
305
306   return TRUE;
307 }
308
309 static gboolean
310 gst_fd_src_unlock (GstBaseSrc * bsrc)
311 {
312   GstFdSrc *src = GST_FD_SRC (bsrc);
313
314   GST_LOG_OBJECT (src, "Flushing");
315   GST_OBJECT_LOCK (src);
316   gst_poll_set_flushing (src->fdset, TRUE);
317   GST_OBJECT_UNLOCK (src);
318
319   return TRUE;
320 }
321
322 static gboolean
323 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
324 {
325   GstFdSrc *src = GST_FD_SRC (bsrc);
326
327   GST_LOG_OBJECT (src, "No longer flushing");
328   GST_OBJECT_LOCK (src);
329   gst_poll_set_flushing (src->fdset, FALSE);
330   GST_OBJECT_UNLOCK (src);
331
332   return TRUE;
333 }
334
335 static void
336 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
337     GParamSpec * pspec)
338 {
339   GstFdSrc *src = GST_FD_SRC (object);
340
341   switch (prop_id) {
342     case PROP_FD:
343       src->new_fd = g_value_get_int (value);
344
345       /* If state is ready or below, update the current fd immediately
346        * so it is reflected in get_properties and uri */
347       GST_OBJECT_LOCK (object);
348       if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
349         GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
350         gst_fd_src_update_fd (src, -1);
351       } else {
352         GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
353       }
354       GST_OBJECT_UNLOCK (object);
355       break;
356     case PROP_TIMEOUT:
357       src->timeout = g_value_get_uint64 (value);
358       GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
359           GST_TIME_ARGS (src->timeout));
360       break;
361     default:
362       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
363       break;
364   }
365 }
366
367 static void
368 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
369     GParamSpec * pspec)
370 {
371   GstFdSrc *src = GST_FD_SRC (object);
372
373   switch (prop_id) {
374     case PROP_FD:
375       g_value_set_int (value, src->fd);
376       break;
377     case PROP_TIMEOUT:
378       g_value_set_uint64 (value, src->timeout);
379       break;
380     default:
381       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
382       break;
383   }
384 }
385
386 static GstFlowReturn
387 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
388 {
389   GstFdSrc *src;
390   GstBuffer *buf;
391   gssize readbytes;
392   guint blocksize;
393   GstMapInfo info;
394
395 #ifndef HAVE_WIN32
396   GstClockTime timeout;
397   gboolean try_again;
398   gint retval;
399 #endif
400
401   src = GST_FD_SRC (psrc);
402
403 #ifndef HAVE_WIN32
404   if (src->timeout > 0) {
405     timeout = src->timeout * GST_USECOND;
406   } else {
407     timeout = GST_CLOCK_TIME_NONE;
408   }
409
410   do {
411     try_again = FALSE;
412
413     GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
414         GST_TIME_ARGS (src->timeout));
415
416     retval = gst_poll_wait (src->fdset, timeout);
417     GST_LOG_OBJECT (src, "poll returned %d", retval);
418
419     if (G_UNLIKELY (retval == -1)) {
420       if (errno == EINTR || errno == EAGAIN) {
421         /* retry if interrupted */
422         try_again = TRUE;
423       } else if (errno == EBUSY) {
424         goto stopped;
425       } else {
426         goto poll_error;
427       }
428     } else if (G_UNLIKELY (retval == 0)) {
429       try_again = TRUE;
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)));
435     }
436   } while (G_UNLIKELY (try_again));     /* retry if interrupted or timeout */
437 #endif
438
439   blocksize = GST_BASE_SRC (src)->blocksize;
440
441   /* create the buffer */
442   buf = gst_buffer_new_allocate (NULL, blocksize, NULL);
443   if (G_UNLIKELY (buf == NULL))
444     goto alloc_failed;
445
446   gst_buffer_map (buf, &info, GST_MAP_WRITE);
447
448   do {
449     readbytes = read (src->fd, info.data, blocksize);
450     GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
451   } while (readbytes == -1 && errno == EINTR);  /* retry if interrupted */
452
453   if (readbytes < 0)
454     goto read_error;
455
456   gst_buffer_unmap (buf, &info);
457   gst_buffer_resize (buf, 0, readbytes);
458
459   if (readbytes == 0)
460     goto eos;
461
462   GST_BUFFER_OFFSET (buf) = src->curoffset;
463   GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
464   src->curoffset += readbytes;
465
466   GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
467
468   /* we're done, return the buffer */
469   *outbuf = buf;
470
471   return GST_FLOW_OK;
472
473   /* ERRORS */
474 #ifndef HAVE_WIN32
475 poll_error:
476   {
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;
481   }
482 stopped:
483   {
484     GST_DEBUG_OBJECT (psrc, "Poll stopped");
485     return GST_FLOW_FLUSHING;
486   }
487 #endif
488 alloc_failed:
489   {
490     GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
491     return GST_FLOW_ERROR;
492   }
493 eos:
494   {
495     GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
496     gst_buffer_unref (buf);
497     return GST_FLOW_EOS;
498   }
499 read_error:
500   {
501     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
502         ("read on file descriptor: %s.", g_strerror (errno)));
503     GST_DEBUG_OBJECT (psrc, "Error reading from fd");
504     gst_buffer_unmap (buf, &info);
505     gst_buffer_unref (buf);
506     return GST_FLOW_ERROR;
507   }
508 }
509
510 static gboolean
511 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
512 {
513   gboolean ret = FALSE;
514   GstFdSrc *src = GST_FD_SRC (basesrc);
515
516   switch (GST_QUERY_TYPE (query)) {
517     case GST_QUERY_URI:
518       gst_query_set_uri (query, src->uri);
519       ret = TRUE;
520       break;
521     default:
522       ret = FALSE;
523       break;
524   }
525
526   if (!ret)
527     ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
528
529   return ret;
530 }
531
532 static gboolean
533 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
534 {
535   GstFdSrc *src = GST_FD_SRC (bsrc);
536
537   return src->seekable_fd;
538 }
539
540 static gboolean
541 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
542 {
543   GstFdSrc *src = GST_FD_SRC (bsrc);
544   struct stat stat_results;
545
546   if (src->size != -1) {
547     *size = src->size;
548     return TRUE;
549   }
550
551   if (!src->seekable_fd) {
552     /* If it isn't seekable, we won't know the length (but fstat will still
553      * succeed, and wrongly say our length is zero. */
554     return FALSE;
555   }
556
557   if (fstat (src->fd, &stat_results) < 0)
558     goto could_not_stat;
559
560   *size = stat_results.st_size;
561
562   return TRUE;
563
564   /* ERROR */
565 could_not_stat:
566   {
567     return FALSE;
568   }
569 }
570
571 static gboolean
572 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
573 {
574   gint res;
575   gint64 offset;
576   GstFdSrc *src = GST_FD_SRC (bsrc);
577
578   offset = segment->start;
579
580   /* No need to seek to the current position */
581   if (offset == src->curoffset)
582     return TRUE;
583
584   res = lseek (src->fd, offset, SEEK_SET);
585   if (G_UNLIKELY (res < 0 || res != offset))
586     goto seek_failed;
587
588   segment->position = segment->start;
589   segment->time = segment->start;
590
591   return TRUE;
592
593 seek_failed:
594   GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
595   return FALSE;
596 }
597
598 /*** GSTURIHANDLER INTERFACE *************************************************/
599
600 static GstURIType
601 gst_fd_src_uri_get_type (GType type)
602 {
603   return GST_URI_SRC;
604 }
605
606 static const gchar *const *
607 gst_fd_src_uri_get_protocols (GType type)
608 {
609   static const gchar *protocols[] = { "fd", NULL };
610
611   return protocols;
612 }
613
614 static gchar *
615 gst_fd_src_uri_get_uri (GstURIHandler * handler)
616 {
617   GstFdSrc *src = GST_FD_SRC (handler);
618
619   /* FIXME: make thread-safe */
620   return g_strdup (src->uri);
621 }
622
623 static gboolean
624 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri,
625     GError ** err)
626 {
627   gchar *protocol, *q;
628   GstFdSrc *src = GST_FD_SRC (handler);
629   gint fd;
630   guint64 size = (guint64) - 1;
631
632   GST_INFO_OBJECT (src, "checking uri %s", uri);
633
634   protocol = gst_uri_get_protocol (uri);
635   if (strcmp (protocol, "fd") != 0) {
636     g_free (protocol);
637     return FALSE;
638   }
639   g_free (protocol);
640
641   if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
642     return FALSE;
643
644   if ((q = g_strstr_len (uri, -1, "?"))) {
645     gchar *sp;
646
647     GST_INFO_OBJECT (src, "found ?");
648
649     if ((sp = g_strstr_len (q, -1, "size="))) {
650       if (sscanf (sp, "size=%" G_GUINT64_FORMAT, &size) != 1) {
651         GST_INFO_OBJECT (src, "parsing size failed");
652         size = -1;
653       } else {
654         GST_INFO_OBJECT (src, "found size %" G_GUINT64_FORMAT, size);
655       }
656     }
657   }
658
659   src->new_fd = fd;
660
661   GST_OBJECT_LOCK (src);
662   if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
663     gst_fd_src_update_fd (src, size);
664   }
665   GST_OBJECT_UNLOCK (src);
666
667   return TRUE;
668 }
669
670 static void
671 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
672 {
673   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
674
675   iface->get_type = gst_fd_src_uri_get_type;
676   iface->get_protocols = gst_fd_src_uri_get_protocols;
677   iface->get_uri = gst_fd_src_uri_get_uri;
678   iface->set_uri = gst_fd_src_uri_set_uri;
679 }