Fixes for -Wwrite-strings
[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., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, 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 folowed 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 recieved 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 static void
117 _do_init (GType fd_src_type)
118 {
119   static const GInterfaceInfo urihandler_info = {
120     gst_fd_src_uri_handler_init,
121     NULL,
122     NULL
123   };
124
125   g_type_add_interface_static (fd_src_type, GST_TYPE_URI_HANDLER,
126       &urihandler_info);
127
128   GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
129 }
130
131 GST_BOILERPLATE_FULL (GstFdSrc, gst_fd_src, GstPushSrc, GST_TYPE_PUSH_SRC,
132     _do_init);
133
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);
139
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);
148
149 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
150
151 static void
152 gst_fd_src_base_init (gpointer g_class)
153 {
154   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
155
156   gst_element_class_set_details_simple (gstelement_class,
157       "Filedescriptor Source",
158       "Source/File",
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));
162 }
163
164 static void
165 gst_fd_src_class_init (GstFdSrcClass * klass)
166 {
167   GObjectClass *gobject_class;
168   GstBaseSrcClass *gstbasesrc_class;
169   GstPushSrcClass *gstpush_src_class;
170
171   gobject_class = G_OBJECT_CLASS (klass);
172   gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
173   gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
174
175   parent_class = g_type_class_peek_parent (klass);
176
177   gobject_class->set_property = gst_fd_src_set_property;
178   gobject_class->get_property = gst_fd_src_get_property;
179   gobject_class->dispose = gst_fd_src_dispose;
180
181   g_object_class_install_property (gobject_class, PROP_FD,
182       g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
183           0, G_MAXINT, DEFAULT_FD, G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
184   /**
185    * GstFdSrc:timeout
186    *
187    * Post a message after timeout microseconds
188    *
189    * Since: 0.10.21
190    */
191   g_object_class_install_property (G_OBJECT_CLASS (klass), PROP_TIMEOUT,
192       g_param_spec_uint64 ("timeout", "Timeout",
193           "Post a message after timeout microseconds (0 = disabled)", 0,
194           G_MAXUINT64, DEFAULT_TIMEOUT,
195           G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS));
196
197   gstbasesrc_class->start = GST_DEBUG_FUNCPTR (gst_fd_src_start);
198   gstbasesrc_class->stop = GST_DEBUG_FUNCPTR (gst_fd_src_stop);
199   gstbasesrc_class->unlock = GST_DEBUG_FUNCPTR (gst_fd_src_unlock);
200   gstbasesrc_class->unlock_stop = GST_DEBUG_FUNCPTR (gst_fd_src_unlock_stop);
201   gstbasesrc_class->is_seekable = GST_DEBUG_FUNCPTR (gst_fd_src_is_seekable);
202   gstbasesrc_class->get_size = GST_DEBUG_FUNCPTR (gst_fd_src_get_size);
203   gstbasesrc_class->do_seek = GST_DEBUG_FUNCPTR (gst_fd_src_do_seek);
204   gstbasesrc_class->query = GST_DEBUG_FUNCPTR (gst_fd_src_query);
205
206   gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
207 }
208
209 static void
210 gst_fd_src_init (GstFdSrc * fdsrc, GstFdSrcClass * klass)
211 {
212   fdsrc->new_fd = DEFAULT_FD;
213   fdsrc->seekable_fd = FALSE;
214   fdsrc->fd = -1;
215   fdsrc->timeout = DEFAULT_TIMEOUT;
216   fdsrc->uri = g_strdup_printf ("fd://0");
217   fdsrc->curoffset = 0;
218 }
219
220 static void
221 gst_fd_src_dispose (GObject * obj)
222 {
223   GstFdSrc *src = GST_FD_SRC (obj);
224
225   g_free (src->uri);
226   src->uri = NULL;
227
228   G_OBJECT_CLASS (parent_class)->dispose (obj);
229 }
230
231 static void
232 gst_fd_src_update_fd (GstFdSrc * src)
233 {
234   struct stat stat_results;
235
236   GST_DEBUG_OBJECT (src, "fdset %p, old_fd %d, new_fd %d", src->fdset, src->fd,
237       src->new_fd);
238
239   /* we need to always update the fdset since it may not have existed when
240    * gst_fd_src_update_fd () was called earlier */
241   if (src->fdset != NULL) {
242     GstPollFD fd = GST_POLL_FD_INIT;
243
244     if (src->fd >= 0) {
245       fd.fd = src->fd;
246       /* this will log a harmless warning, if it was never added */
247       gst_poll_remove_fd (src->fdset, &fd);
248     }
249
250     fd.fd = src->new_fd;
251     gst_poll_add_fd (src->fdset, &fd);
252     gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
253   }
254
255   if (src->fd != src->new_fd) {
256     GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
257
258     src->fd = src->new_fd;
259
260     g_free (src->uri);
261     src->uri = g_strdup_printf ("fd://%d", src->fd);
262
263     if (fstat (src->fd, &stat_results) < 0)
264       goto not_seekable;
265
266     if (!S_ISREG (stat_results.st_mode))
267       goto not_seekable;
268
269     /* Try a seek of 0 bytes offset to check for seekability */
270     if (lseek (src->fd, 0, SEEK_CUR) < 0)
271       goto not_seekable;
272
273     GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
274     src->seekable_fd = TRUE;
275   }
276   return;
277
278 not_seekable:
279   {
280     GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
281     src->seekable_fd = FALSE;
282   }
283 }
284
285 static gboolean
286 gst_fd_src_start (GstBaseSrc * bsrc)
287 {
288   GstFdSrc *src = GST_FD_SRC (bsrc);
289
290   src->curoffset = 0;
291
292   if ((src->fdset = gst_poll_new (TRUE)) == NULL)
293     goto socket_pair;
294
295   gst_fd_src_update_fd (src);
296
297   return TRUE;
298
299   /* ERRORS */
300 socket_pair:
301   {
302     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
303         GST_ERROR_SYSTEM);
304     return FALSE;
305   }
306 }
307
308 static gboolean
309 gst_fd_src_stop (GstBaseSrc * bsrc)
310 {
311   GstFdSrc *src = GST_FD_SRC (bsrc);
312
313   if (src->fdset) {
314     gst_poll_free (src->fdset);
315     src->fdset = NULL;
316   }
317
318   return TRUE;
319 }
320
321 static gboolean
322 gst_fd_src_unlock (GstBaseSrc * bsrc)
323 {
324   GstFdSrc *src = GST_FD_SRC (bsrc);
325
326   GST_LOG_OBJECT (src, "Flushing");
327   GST_OBJECT_LOCK (src);
328   gst_poll_set_flushing (src->fdset, TRUE);
329   GST_OBJECT_UNLOCK (src);
330
331   return TRUE;
332 }
333
334 static gboolean
335 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
336 {
337   GstFdSrc *src = GST_FD_SRC (bsrc);
338
339   GST_LOG_OBJECT (src, "No longer flushing");
340   GST_OBJECT_LOCK (src);
341   gst_poll_set_flushing (src->fdset, FALSE);
342   GST_OBJECT_UNLOCK (src);
343
344   return TRUE;
345 }
346
347 static void
348 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
349     GParamSpec * pspec)
350 {
351   GstFdSrc *src = GST_FD_SRC (object);
352
353   switch (prop_id) {
354     case PROP_FD:
355       src->new_fd = g_value_get_int (value);
356
357       /* If state is ready or below, update the current fd immediately
358        * so it is reflected in get_properties and uri */
359       GST_OBJECT_LOCK (object);
360       if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
361         GST_DEBUG_OBJECT (src, "state ready or lower, updating to use new fd");
362         gst_fd_src_update_fd (src);
363       } else {
364         GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
365       }
366       GST_OBJECT_UNLOCK (object);
367       break;
368     case PROP_TIMEOUT:
369       src->timeout = g_value_get_uint64 (value);
370       GST_DEBUG_OBJECT (src, "poll timeout set to %" GST_TIME_FORMAT,
371           GST_TIME_ARGS (src->timeout));
372       break;
373     default:
374       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
375       break;
376   }
377 }
378
379 static void
380 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
381     GParamSpec * pspec)
382 {
383   GstFdSrc *src = GST_FD_SRC (object);
384
385   switch (prop_id) {
386     case PROP_FD:
387       g_value_set_int (value, src->fd);
388       break;
389     case PROP_TIMEOUT:
390       g_value_set_uint64 (value, src->timeout);
391       break;
392     default:
393       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
394       break;
395   }
396 }
397
398 static GstFlowReturn
399 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
400 {
401   GstFdSrc *src;
402   GstBuffer *buf;
403   gssize readbytes;
404   guint blocksize;
405   GstClockTime timeout;
406
407 #ifndef HAVE_WIN32
408   gboolean try_again;
409   gint retval;
410 #endif
411
412   src = GST_FD_SRC (psrc);
413
414   if (src->timeout > 0) {
415     timeout = src->timeout * GST_USECOND;
416   } else {
417     timeout = GST_CLOCK_TIME_NONE;
418   }
419
420 #ifndef HAVE_WIN32
421   do {
422     try_again = FALSE;
423
424     GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
425         GST_TIME_ARGS (src->timeout));
426
427     retval = gst_poll_wait (src->fdset, timeout);
428     GST_LOG_OBJECT (src, "poll returned %d", retval);
429
430     if (G_UNLIKELY (retval == -1)) {
431       if (errno == EINTR || errno == EAGAIN) {
432         /* retry if interrupted */
433         try_again = TRUE;
434       } else if (errno == EBUSY) {
435         goto stopped;
436       } else {
437         goto poll_error;
438       }
439     } else if (G_UNLIKELY (retval == 0)) {
440       try_again = TRUE;
441       /* timeout, post element message */
442       gst_element_post_message (GST_ELEMENT_CAST (src),
443           gst_message_new_element (GST_OBJECT_CAST (src),
444               gst_structure_new ("GstFdSrcTimeout",
445                   "timeout", G_TYPE_UINT64, src->timeout, NULL)));
446     }
447   } while (G_UNLIKELY (try_again));     /* retry if interrupted or timeout */
448 #endif
449
450   blocksize = GST_BASE_SRC (src)->blocksize;
451
452   /* create the buffer */
453   buf = gst_buffer_try_new_and_alloc (blocksize);
454   if (G_UNLIKELY (buf == NULL)) {
455     GST_ERROR_OBJECT (src, "Failed to allocate %u bytes", blocksize);
456     return GST_FLOW_ERROR;
457   }
458
459   do {
460     readbytes = read (src->fd, GST_BUFFER_DATA (buf), blocksize);
461     GST_LOG_OBJECT (src, "read %" G_GSSIZE_FORMAT, readbytes);
462   } while (readbytes == -1 && errno == EINTR);  /* retry if interrupted */
463
464   if (readbytes < 0)
465     goto read_error;
466
467   if (readbytes == 0)
468     goto eos;
469
470   GST_BUFFER_OFFSET (buf) = src->curoffset;
471   GST_BUFFER_SIZE (buf) = readbytes;
472   GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
473   src->curoffset += readbytes;
474
475   GST_LOG_OBJECT (psrc, "Read buffer of size %" G_GSSIZE_FORMAT, readbytes);
476
477   /* we're done, return the buffer */
478   *outbuf = buf;
479
480   return GST_FLOW_OK;
481
482   /* ERRORS */
483 #ifndef HAVE_WIN32
484 poll_error:
485   {
486     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
487         ("poll on file descriptor: %s.", g_strerror (errno)));
488     GST_DEBUG_OBJECT (psrc, "Error during poll");
489     return GST_FLOW_ERROR;
490   }
491 stopped:
492   {
493     GST_DEBUG_OBJECT (psrc, "Poll stopped");
494     return GST_FLOW_WRONG_STATE;
495   }
496 #endif
497 eos:
498   {
499     GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
500     gst_buffer_unref (buf);
501     return GST_FLOW_UNEXPECTED;
502   }
503 read_error:
504   {
505     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
506         ("read on file descriptor: %s.", g_strerror (errno)));
507     GST_DEBUG_OBJECT (psrc, "Error reading from fd");
508     gst_buffer_unref (buf);
509     return GST_FLOW_ERROR;
510   }
511 }
512
513 static gboolean
514 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
515 {
516   gboolean ret = FALSE;
517   GstFdSrc *src = GST_FD_SRC (basesrc);
518
519   switch (GST_QUERY_TYPE (query)) {
520     case GST_QUERY_URI:
521       gst_query_set_uri (query, src->uri);
522       ret = TRUE;
523       break;
524     default:
525       ret = FALSE;
526       break;
527   }
528
529   if (!ret)
530     ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
531
532   return ret;
533 }
534
535 static gboolean
536 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
537 {
538   GstFdSrc *src = GST_FD_SRC (bsrc);
539
540   return src->seekable_fd;
541 }
542
543 static gboolean
544 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
545 {
546   GstFdSrc *src = GST_FD_SRC (bsrc);
547   struct stat stat_results;
548
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. */
552     return FALSE;
553   }
554
555   if (fstat (src->fd, &stat_results) < 0)
556     goto could_not_stat;
557
558   *size = stat_results.st_size;
559
560   return TRUE;
561
562   /* ERROR */
563 could_not_stat:
564   {
565     return FALSE;
566   }
567 }
568
569 static gboolean
570 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
571 {
572   gint res;
573   gint64 offset;
574   GstFdSrc *src = GST_FD_SRC (bsrc);
575
576   offset = segment->start;
577
578   /* No need to seek to the current position */
579   if (offset == src->curoffset)
580     return TRUE;
581
582   res = lseek (src->fd, offset, SEEK_SET);
583   if (G_UNLIKELY (res < 0 || res != offset))
584     goto seek_failed;
585
586   segment->last_stop = segment->start;
587   segment->time = segment->start;
588
589   return TRUE;
590
591 seek_failed:
592   GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
593   return FALSE;
594 }
595
596 /*** GSTURIHANDLER INTERFACE *************************************************/
597
598 static GstURIType
599 gst_fd_src_uri_get_type (void)
600 {
601   return GST_URI_SRC;
602 }
603
604 static gchar **
605 gst_fd_src_uri_get_protocols (void)
606 {
607   static gchar *protocols[] = { (char *) "fd", NULL };
608
609   return protocols;
610 }
611
612 static const gchar *
613 gst_fd_src_uri_get_uri (GstURIHandler * handler)
614 {
615   GstFdSrc *src = GST_FD_SRC (handler);
616
617   return src->uri;
618 }
619
620 static gboolean
621 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
622 {
623   gchar *protocol;
624   GstFdSrc *src = GST_FD_SRC (handler);
625   gint fd;
626
627   protocol = gst_uri_get_protocol (uri);
628   if (strcmp (protocol, "fd") != 0) {
629     g_free (protocol);
630     return FALSE;
631   }
632   g_free (protocol);
633
634   if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
635     return FALSE;
636
637   src->new_fd = fd;
638
639   GST_OBJECT_LOCK (src);
640   if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
641     gst_fd_src_update_fd (src);
642   }
643   GST_OBJECT_UNLOCK (src);
644
645   return TRUE;
646 }
647
648 static void
649 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
650 {
651   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
652
653   iface->get_type = gst_fd_src_uri_get_type;
654   iface->get_protocols = gst_fd_src_uri_get_protocols;
655   iface->get_uri = gst_fd_src_uri_get_uri;
656   iface->set_uri = gst_fd_src_uri_set_uri;
657 }