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 #include <sys/socket.h>
  75 #include <fcntl.h>
  76 #include <stdio.h>
  77 #ifdef HAVE_UNISTD_H
  78 #include <unistd.h>
  79 #endif
  80 #ifdef _MSC_VER
  81 #include <io.h>
  82 #endif
  83 #include <stdlib.h>
  84 #include <errno.h>
  85
  86 #include "gstfdsrc.h"
  87
  88 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  89     GST_PAD_SRC,
  90     GST_PAD_ALWAYS,
  91     GST_STATIC_CAPS_ANY);
  92
  93 GST_DEBUG_CATEGORY_STATIC (gst_fd_src_debug);
  94 #define GST_CAT_DEFAULT gst_fd_src_debug
  95
  96 #define DEFAULT_FD              0
  97 #define DEFAULT_TIMEOUT         0
  98
  99 enum
 100 {
 101   PROP_0,
 102
 103   PROP_FD,
 104   PROP_TIMEOUT,
 105
 106   PROP_LAST
 107 };
 108
 109 static void gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data);
 110
 111 static void
 112 _do_init (GType fd_src_type)
 113 {
 114   static const GInterfaceInfo urihandler_info = {
 115     gst_fd_src_uri_handler_init,
 116     NULL,
 117     NULL
 118   };
 119
 120   g_type_add_interface_static (fd_src_type, GST_TYPE_URI_HANDLER,
 121       &urihandler_info);
 122
 123   GST_DEBUG_CATEGORY_INIT (gst_fd_src_debug, "fdsrc", 0, "fdsrc element");
 124 }
 125
 126 GST_BOILERPLATE_FULL (GstFdSrc, gst_fd_src, GstPushSrc, GST_TYPE_PUSH_SRC,
 127     _do_init);
 128
 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);
 134
 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);
 143
 144 static GstFlowReturn gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf);
 145
 146 static void
 147 gst_fd_src_base_init (gpointer g_class)
 148 {
 149   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 150
 151   gst_element_class_set_details_simple (gstelement_class,
 152       "Filedescriptor Source",
 153       "Source/File",
 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));
 157 }
 158
 159 static void
 160 gst_fd_src_class_init (GstFdSrcClass * klass)
 161 {
 162   GObjectClass *gobject_class;
 163   GstBaseSrcClass *gstbasesrc_class;
 164   GstPushSrcClass *gstpush_src_class;
 165
 166   gobject_class = G_OBJECT_CLASS (klass);
 167   gstbasesrc_class = GST_BASE_SRC_CLASS (klass);
 168   gstpush_src_class = GST_PUSH_SRC_CLASS (klass);
 169
 170   parent_class = g_type_class_peek_parent (klass);
 171
 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;
 175
 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));
 179   /**
 180    * GstFdSrc:timeout
 181    *
 182    * Post a message after timeout microseconds
 183    *
 184    * Since: 0.10.21
 185    */
 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));
 191
 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);
 200
 201   gstpush_src_class->create = GST_DEBUG_FUNCPTR (gst_fd_src_create);
 202 }
 203
 204 static void
 205 gst_fd_src_init (GstFdSrc * fdsrc, GstFdSrcClass * klass)
 206 {
 207   fdsrc->new_fd = 0;
 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;
 213 }
 214
 215 static void
 216 gst_fd_src_dispose (GObject * obj)
 217 {
 218   GstFdSrc *src = GST_FD_SRC (obj);
 219
 220   g_free (src->uri);
 221   src->uri = NULL;
 222
 223   G_OBJECT_CLASS (parent_class)->dispose (obj);
 224 }
 225
 226 static void
 227 gst_fd_src_update_fd (GstFdSrc * src)
 228 {
 229   struct stat stat_results;
 230
 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;
 235
 236     if (src->fd >= 0) {
 237       fd.fd = src->fd;
 238       gst_poll_remove_fd (src->fdset, &fd);
 239     }
 240
 241     fd.fd = src->new_fd;
 242     gst_poll_add_fd (src->fdset, &fd);
 243     gst_poll_fd_ctl_read (src->fdset, &fd, TRUE);
 244   }
 245
 246   if (src->fd != src->new_fd) {
 247     GST_INFO_OBJECT (src, "Updating to fd %d", src->new_fd);
 248
 249     src->fd = src->new_fd;
 250
 251     g_free (src->uri);
 252     src->uri = g_strdup_printf ("fd://%d", src->fd);
 253
 254     if (fstat (src->fd, &stat_results) < 0)
 255       goto not_seekable;
 256
 257     if (!S_ISREG (stat_results.st_mode))
 258       goto not_seekable;
 259
 260     /* Try a seek of 0 bytes offset to check for seekability */
 261     if (lseek (src->fd, 0, SEEK_CUR) < 0)
 262       goto not_seekable;
 263
 264     GST_INFO_OBJECT (src, "marking fd %d as seekable", src->fd);
 265     src->seekable_fd = TRUE;
 266   }
 267   return;
 268
 269 not_seekable:
 270   {
 271     GST_INFO_OBJECT (src, "marking fd %d as NOT seekable", src->fd);
 272     src->seekable_fd = FALSE;
 273   }
 274 }
 275
 276 static gboolean
 277 gst_fd_src_start (GstBaseSrc * bsrc)
 278 {
 279   GstFdSrc *src = GST_FD_SRC (bsrc);
 280
 281   src->curoffset = 0;
 282
 283   if ((src->fdset = gst_poll_new (TRUE)) == NULL)
 284     goto socket_pair;
 285
 286   gst_fd_src_update_fd (src);
 287
 288   return TRUE;
 289
 290   /* ERRORS */
 291 socket_pair:
 292   {
 293     GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ_WRITE, (NULL),
 294         GST_ERROR_SYSTEM);
 295     return FALSE;
 296   }
 297 }
 298
 299 static gboolean
 300 gst_fd_src_stop (GstBaseSrc * bsrc)
 301 {
 302   GstFdSrc *src = GST_FD_SRC (bsrc);
 303
 304   if (src->fdset) {
 305     gst_poll_free (src->fdset);
 306     src->fdset = NULL;
 307   }
 308
 309   return TRUE;
 310 }
 311
 312 static gboolean
 313 gst_fd_src_unlock (GstBaseSrc * bsrc)
 314 {
 315   GstFdSrc *src = GST_FD_SRC (bsrc);
 316
 317   GST_LOG_OBJECT (src, "Flushing");
 318   GST_OBJECT_LOCK (src);
 319   gst_poll_set_flushing (src->fdset, TRUE);
 320   GST_OBJECT_UNLOCK (src);
 321
 322   return TRUE;
 323 }
 324
 325 static gboolean
 326 gst_fd_src_unlock_stop (GstBaseSrc * bsrc)
 327 {
 328   GstFdSrc *src = GST_FD_SRC (bsrc);
 329
 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);
 334
 335   return TRUE;
 336 }
 337
 338 static void
 339 gst_fd_src_set_property (GObject * object, guint prop_id, const GValue * value,
 340     GParamSpec * pspec)
 341 {
 342   GstFdSrc *src = GST_FD_SRC (object);
 343
 344   switch (prop_id) {
 345     case PROP_FD:
 346       src->new_fd = g_value_get_int (value);
 347
 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);
 354       } else {
 355         GST_DEBUG_OBJECT (src, "state above ready, not updating to new fd yet");
 356       }
 357       GST_OBJECT_UNLOCK (object);
 358       break;
 359     case PROP_TIMEOUT:
 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));
 363       break;
 364     default:
 365       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 366       break;
 367   }
 368 }
 369
 370 static void
 371 gst_fd_src_get_property (GObject * object, guint prop_id, GValue * value,
 372     GParamSpec * pspec)
 373 {
 374   GstFdSrc *src = GST_FD_SRC (object);
 375
 376   switch (prop_id) {
 377     case PROP_FD:
 378       g_value_set_int (value, src->fd);
 379       break;
 380     case PROP_TIMEOUT:
 381       g_value_set_uint64 (value, src->timeout);
 382       break;
 383     default:
 384       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 385       break;
 386   }
 387 }
 388
 389 static GstFlowReturn
 390 gst_fd_src_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 391 {
 392   GstFdSrc *src;
 393   GstBuffer *buf;
 394   gssize readbytes;
 395   guint blocksize;
 396   GstClockTime timeout;
 397
 398 #ifndef HAVE_WIN32
 399   gboolean try_again;
 400   gint retval;
 401 #endif
 402
 403   src = GST_FD_SRC (psrc);
 404
 405   if (src->timeout > 0) {
 406     timeout = src->timeout * GST_USECOND;
 407   } else {
 408     timeout = GST_CLOCK_TIME_NONE;
 409   }
 410
 411 #ifndef HAVE_WIN32
 412   do {
 413     try_again = FALSE;
 414
 415     GST_LOG_OBJECT (src, "doing poll, timeout %" GST_TIME_FORMAT,
 416         GST_TIME_ARGS (src->timeout));
 417
 418     retval = gst_poll_wait (src->fdset, timeout);
 419     GST_LOG_OBJECT (src, "poll returned %d", retval);
 420
 421     if (G_UNLIKELY (retval == -1)) {
 422       if (errno == EINTR || errno == EAGAIN) {
 423         /* retry if interrupted */
 424         try_again = TRUE;
 425       } else if (errno == EBUSY) {
 426         goto stopped;
 427       } else {
 428         goto poll_error;
 429       }
 430     } else if (G_UNLIKELY (retval == 0)) {
 431       try_again = TRUE;
 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)));
 437     }
 438   } while (G_UNLIKELY (try_again));     /* retry if interrupted or timeout */
 439 #endif
 440
 441   blocksize = GST_BASE_SRC (src)->blocksize;
 442
 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;
 448   }
 449
 450   do {
 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 */
 454
 455   if (readbytes < 0)
 456     goto read_error;
 457
 458   if (readbytes == 0)
 459     goto eos;
 460
 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;
 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_WRONG_STATE;
 486   }
 487 #endif
 488 eos:
 489   {
 490     GST_DEBUG_OBJECT (psrc, "Read 0 bytes. EOS.");
 491     gst_buffer_unref (buf);
 492     return GST_FLOW_UNEXPECTED;
 493   }
 494 read_error:
 495   {
 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;
 501   }
 502 }
 503
 504 static gboolean
 505 gst_fd_src_query (GstBaseSrc * basesrc, GstQuery * query)
 506 {
 507   gboolean ret = FALSE;
 508   GstFdSrc *src = GST_FD_SRC (basesrc);
 509
 510   switch (GST_QUERY_TYPE (query)) {
 511     case GST_QUERY_URI:
 512       gst_query_set_uri (query, src->uri);
 513       ret = TRUE;
 514       break;
 515     default:
 516       ret = FALSE;
 517       break;
 518   }
 519
 520   if (!ret)
 521     ret = GST_BASE_SRC_CLASS (parent_class)->query (basesrc, query);
 522
 523   return ret;
 524 }
 525
 526 static gboolean
 527 gst_fd_src_is_seekable (GstBaseSrc * bsrc)
 528 {
 529   GstFdSrc *src = GST_FD_SRC (bsrc);
 530
 531   return src->seekable_fd;
 532 }
 533
 534 static gboolean
 535 gst_fd_src_get_size (GstBaseSrc * bsrc, guint64 * size)
 536 {
 537   GstFdSrc *src = GST_FD_SRC (bsrc);
 538   struct stat stat_results;
 539
 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. */
 543     return FALSE;
 544   }
 545
 546   if (fstat (src->fd, &stat_results) < 0)
 547     goto could_not_stat;
 548
 549   *size = stat_results.st_size;
 550
 551   return TRUE;
 552
 553   /* ERROR */
 554 could_not_stat:
 555   {
 556     return FALSE;
 557   }
 558 }
 559
 560 static gboolean
 561 gst_fd_src_do_seek (GstBaseSrc * bsrc, GstSegment * segment)
 562 {
 563   gint res;
 564   gint64 offset;
 565   GstFdSrc *src = GST_FD_SRC (bsrc);
 566
 567   offset = segment->start;
 568
 569   /* No need to seek to the current position */
 570   if (offset == src->curoffset)
 571     return TRUE;
 572
 573   res = lseek (src->fd, offset, SEEK_SET);
 574   if (G_UNLIKELY (res < 0 || res != offset))
 575     goto seek_failed;
 576
 577   segment->last_stop = segment->start;
 578   segment->time = segment->start;
 579
 580   return TRUE;
 581
 582 seek_failed:
 583   GST_DEBUG_OBJECT (src, "lseek returned %" G_GINT64_FORMAT, offset);
 584   return FALSE;
 585 }
 586
 587 /*** GSTURIHANDLER INTERFACE *************************************************/
 588
 589 static GstURIType
 590 gst_fd_src_uri_get_type (void)
 591 {
 592   return GST_URI_SRC;
 593 }
 594
 595 static gchar **
 596 gst_fd_src_uri_get_protocols (void)
 597 {
 598   static gchar *protocols[] = { "fd", NULL };
 599
 600   return protocols;
 601 }
 602
 603 static const gchar *
 604 gst_fd_src_uri_get_uri (GstURIHandler * handler)
 605 {
 606   GstFdSrc *src = GST_FD_SRC (handler);
 607
 608   return src->uri;
 609 }
 610
 611 static gboolean
 612 gst_fd_src_uri_set_uri (GstURIHandler * handler, const gchar * uri)
 613 {
 614   gchar *protocol;
 615   GstFdSrc *src = GST_FD_SRC (handler);
 616   gint fd;
 617
 618   protocol = gst_uri_get_protocol (uri);
 619   if (strcmp (protocol, "fd") != 0) {
 620     g_free (protocol);
 621     return FALSE;
 622   }
 623   g_free (protocol);
 624
 625   if (sscanf (uri, "fd://%d", &fd) != 1 || fd < 0)
 626     return FALSE;
 627
 628   src->new_fd = fd;
 629
 630   GST_OBJECT_LOCK (src);
 631   if (GST_STATE (GST_ELEMENT (src)) <= GST_STATE_READY) {
 632     gst_fd_src_update_fd (src);
 633   }
 634   GST_OBJECT_UNLOCK (src);
 635
 636   return TRUE;
 637 }
 638
 639 static void
 640 gst_fd_src_uri_handler_init (gpointer g_iface, gpointer iface_data)
 641 {
 642   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 643
 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;
 648 }