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 #ifdef HAVE_CONFIG_H
  25 #  include "config.h"
  26 #endif
  27 #include "gst/gst_private.h"
  28
  29 #include <sys/types.h>
  30 #include <sys/stat.h>
  31 #include <fcntl.h>
  32 #include <stdio.h>
  33 #ifdef HAVE_UNISTD_H
  34 #include <unistd.h>
  35 #endif
  36 #include <stdlib.h>
  37 #include <errno.h>
  38
  39 #include "gstfdsrc.h"
  40
  41 #define DEFAULT_BLOCKSIZE       4096
  42
  43 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  44     GST_PAD_SRC,
  45     GST_PAD_ALWAYS,
  46     GST_STATIC_CAPS_ANY);
  47
  48 GST_DEBUG_CATEGORY_STATIC (gst_fdsrc_debug);
  49 #define GST_CAT_DEFAULT gst_fdsrc_debug
  50
  51 GstElementDetails gst_fdsrc_details = GST_ELEMENT_DETAILS ("Disk Source",
  52     "Source/File",
  53     "Synchronous read from a file",
  54     "Erik Walthinsen <omega@cse.ogi.edu>");
  55
  56
  57 /* FdSrc signals and args */
  58 enum
  59 {
  60   SIGNAL_TIMEOUT,
  61   LAST_SIGNAL
  62 };
  63
  64 enum
  65 {
  66   ARG_0,
  67   ARG_FD,
  68   ARG_BLOCKSIZE,
  69   ARG_TIMEOUT
  70 };
  71
  72 static guint gst_fdsrc_signals[LAST_SIGNAL] = { 0 };
  73
  74 #define _do_init(bla) \
  75     GST_DEBUG_CATEGORY_INIT (gst_fdsrc_debug, "fdsrc", 0, "fdsrc element");
  76
  77 GST_BOILERPLATE_FULL (GstFdSrc, gst_fdsrc, GstElement, GST_TYPE_PUSH_SRC,
  78     _do_init);
  79
  80 static void gst_fdsrc_set_property (GObject * object, guint prop_id,
  81     const GValue * value, GParamSpec * pspec);
  82 static void gst_fdsrc_get_property (GObject * object, guint prop_id,
  83     GValue * value, GParamSpec * pspec);
  84
  85 static GstElementStateReturn gst_fdsrc_change_state (GstElement * element);
  86
  87 static GstFlowReturn gst_fdsrc_create (GstPushSrc * psrc, GstBuffer ** outbuf);
  88
  89 static void
  90 gst_fdsrc_base_init (gpointer g_class)
  91 {
  92   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
  93
  94   gst_element_class_add_pad_template (gstelement_class,
  95       gst_static_pad_template_get (&srctemplate));
  96   gst_element_class_set_details (gstelement_class, &gst_fdsrc_details);
  97 }
  98 static void
  99 gst_fdsrc_class_init (GstFdSrcClass * klass)
 100 {
 101   GObjectClass *gobject_class;
 102   GstBaseSrcClass *gstbasesrc_class;
 103   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 104   GstPushSrcClass *gstpush_src_class;
 105
 106   gobject_class = G_OBJECT_CLASS (klass);
 107   gstbasesrc_class = (GstBaseSrcClass *) klass;
 108   gstpush_src_class = (GstPushSrcClass *) klass;
 109
 110   parent_class = g_type_class_ref (GST_TYPE_PUSH_SRC);
 111
 112   gobject_class->set_property = gst_fdsrc_set_property;
 113   gobject_class->get_property = gst_fdsrc_get_property;
 114
 115   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FD,
 116       g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
 117           0, G_MAXINT, 0, G_PARAM_READWRITE));
 118   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BLOCKSIZE,
 119       g_param_spec_ulong ("blocksize", "Block size",
 120           "Size in bytes to read per buffer", 1, G_MAXULONG, DEFAULT_BLOCKSIZE,
 121           G_PARAM_READWRITE));
 122   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_TIMEOUT,
 123       g_param_spec_uint64 ("timeout", "Timeout", "Read timeout in nanoseconds",
 124           0, G_MAXUINT64, 0, G_PARAM_READWRITE));
 125
 126   gst_fdsrc_signals[SIGNAL_TIMEOUT] =
 127       g_signal_new ("timeout", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 128       G_STRUCT_OFFSET (GstFdSrcClass, timeout), NULL, NULL,
 129       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 130
 131   gstelement_class->change_state = gst_fdsrc_change_state;
 132
 133   gstpush_src_class->create = gst_fdsrc_create;
 134
 135 }
 136
 137 static void
 138 gst_fdsrc_init (GstFdSrc * fdsrc)
 139 {
 140   // TODO set live only if it's actually a live source
 141   gst_base_src_set_live (GST_BASE_SRC (fdsrc), TRUE);
 142
 143   fdsrc->fd = 0;
 144   fdsrc->curoffset = 0;
 145   fdsrc->blocksize = DEFAULT_BLOCKSIZE;
 146   fdsrc->timeout = 0;
 147   fdsrc->seq = 0;
 148 }
 149
 150 static GstElementStateReturn
 151 gst_fdsrc_change_state (GstElement * element)
 152 {
 153   GstFdSrc *src = GST_FDSRC (element);
 154
 155   switch (GST_STATE_TRANSITION (element)) {
 156     case GST_STATE_NULL_TO_READY:
 157       break;
 158     case GST_STATE_READY_TO_NULL:
 159       break;
 160     case GST_STATE_READY_TO_PAUSED:
 161       src->curoffset = 0;
 162       break;
 163     case GST_STATE_PAUSED_TO_READY:
 164       break;
 165     default:
 166       break;
 167   }
 168
 169   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 170     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 171
 172   return GST_STATE_SUCCESS;
 173 }
 174
 175
 176 static void
 177 gst_fdsrc_set_property (GObject * object, guint prop_id, const GValue * value,
 178     GParamSpec * pspec)
 179 {
 180   GstFdSrc *src;
 181
 182   g_return_if_fail (GST_IS_FDSRC (object));
 183
 184   src = GST_FDSRC (object);
 185
 186   switch (prop_id) {
 187     case ARG_FD:
 188       src->fd = g_value_get_int (value);
 189       break;
 190     case ARG_BLOCKSIZE:
 191       src->blocksize = g_value_get_ulong (value);
 192       break;
 193     case ARG_TIMEOUT:
 194       src->timeout = g_value_get_uint64 (value);
 195       break;
 196     default:
 197       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 198       break;
 199   }
 200 }
 201
 202 static void
 203 gst_fdsrc_get_property (GObject * object, guint prop_id, GValue * value,
 204     GParamSpec * pspec)
 205 {
 206   GstFdSrc *src;
 207
 208   g_return_if_fail (GST_IS_FDSRC (object));
 209
 210   src = GST_FDSRC (object);
 211
 212   switch (prop_id) {
 213     case ARG_BLOCKSIZE:
 214       g_value_set_ulong (value, src->blocksize);
 215       break;
 216     case ARG_FD:
 217       g_value_set_int (value, src->fd);
 218       break;
 219     case ARG_TIMEOUT:
 220       g_value_set_uint64 (value, src->timeout);
 221       break;
 222     default:
 223       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 224       break;
 225   }
 226 }
 227
 228 static GstFlowReturn
 229 gst_fdsrc_create (GstPushSrc * psrc, GstBuffer ** outbuf)
 230 {
 231   GstFdSrc *src;
 232   GstBuffer *buf;
 233   glong readbytes;
 234
 235 #ifndef HAVE_WIN32
 236   fd_set readfds;
 237   struct timeval t, *tp = &t;
 238   gint retval;
 239 #endif
 240
 241   src = GST_FDSRC (psrc);
 242
 243   /* create the buffer */
 244   buf = gst_buffer_new_and_alloc (src->blocksize);
 245
 246 #ifndef HAVE_WIN32
 247   FD_ZERO (&readfds);
 248   FD_SET (src->fd, &readfds);
 249
 250   if (src->timeout != 0) {
 251     GST_TIME_TO_TIMEVAL (src->timeout, t);
 252   } else
 253     tp = NULL;
 254
 255   do {
 256     retval = select (src->fd + 1, &readfds, NULL, NULL, tp);
 257   } while (retval == -1 && errno == EINTR);     /* retry if interrupted */
 258
 259   if (retval == -1) {
 260     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 261         ("select on file descriptor: %s.", g_strerror (errno)));
 262     return GST_FLOW_ERROR;
 263   } else if (retval == 0) {
 264     g_signal_emit (G_OBJECT (src), gst_fdsrc_signals[SIGNAL_TIMEOUT], 0);
 265     return GST_FLOW_ERROR;
 266   }
 267 #endif
 268
 269   do {
 270     readbytes = read (src->fd, GST_BUFFER_DATA (buf), src->blocksize);
 271   } while (readbytes == -1 && errno == EINTR);  /* retry if interrupted */
 272
 273   if (readbytes > 0) {
 274     GST_BUFFER_OFFSET (buf) = src->curoffset;
 275     GST_BUFFER_SIZE (buf) = readbytes;
 276     GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
 277     src->curoffset += readbytes;
 278
 279     /* we're done, return the buffer */
 280     *outbuf = buf;
 281     return GST_FLOW_OK;
 282   } else if (readbytes == 0) {
 283     return GST_FLOW_ERROR;
 284   } else {
 285     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 286         ("read on file descriptor: %s.", g_strerror (errno)));
 287     return GST_FLOW_ERROR;
 288   }
 289 }