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  *
   5  * gstfdsrc.c:
   6  *
   7  * This library is free software; you can redistribute it and/or
   8  * modify it under the terms of the GNU Library General Public
   9  * License as published by the Free Software Foundation; either
  10  * version 2 of the License, or (at your option) any later version.
  11  *
  12  * This library is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  15  * Library General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU Library General Public
  18  * License along with this library; if not, write to the
  19  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  20  * Boston, MA 02111-1307, USA.
  21  */
  22
  23 #ifdef HAVE_CONFIG_H
  24 #  include "config.h"
  25 #endif
  26 #include "gst/gst_private.h"
  27
  28 #include <sys/types.h>
  29 #include <sys/stat.h>
  30 #include <fcntl.h>
  31 #include <stdio.h>
  32 #ifdef HAVE_UNISTD_H
  33 #include <unistd.h>
  34 #endif
  35 #include <stdlib.h>
  36 #include <errno.h>
  37
  38 #include "gstfdsrc.h"
  39
  40 #define DEFAULT_BLOCKSIZE       4096
  41
  42 static GstStaticPadTemplate srctemplate = GST_STATIC_PAD_TEMPLATE ("src",
  43     GST_PAD_SRC,
  44     GST_PAD_ALWAYS,
  45     GST_STATIC_CAPS_ANY);
  46
  47 GST_DEBUG_CATEGORY_STATIC (gst_fdsrc_debug);
  48 #define GST_CAT_DEFAULT gst_fdsrc_debug
  49
  50 GstElementDetails gst_fdsrc_details = GST_ELEMENT_DETAILS ("Disk Source",
  51     "Source/File",
  52     "Synchronous read from a file",
  53     "Erik Walthinsen <omega@cse.ogi.edu>");
  54
  55
  56 /* FdSrc signals and args */
  57 enum
  58 {
  59   SIGNAL_TIMEOUT,
  60   LAST_SIGNAL
  61 };
  62
  63 enum
  64 {
  65   ARG_0,
  66   ARG_FD,
  67   ARG_BLOCKSIZE,
  68   ARG_TIMEOUT
  69 };
  70
  71 static guint gst_fdsrc_signals[LAST_SIGNAL] = { 0 };
  72
  73 #define _do_init(bla) \
  74     GST_DEBUG_CATEGORY_INIT (gst_fdsrc_debug, "fdsrc", 0, "fdsrc element");
  75
  76 GST_BOILERPLATE_FULL (GstFdSrc, gst_fdsrc, GstElement, GST_TYPE_ELEMENT,
  77     _do_init);
  78
  79 static void gst_fdsrc_set_property (GObject * object, guint prop_id,
  80     const GValue * value, GParamSpec * pspec);
  81 static void gst_fdsrc_get_property (GObject * object, guint prop_id,
  82     GValue * value, GParamSpec * pspec);
  83
  84 static GstElementStateReturn gst_fdsrc_change_state (GstElement * element);
  85
  86 static GstData *gst_fdsrc_get (GstPad * pad);
  87
  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   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 103
 104   gobject_class = G_OBJECT_CLASS (klass);
 105
 106   gobject_class->set_property = gst_fdsrc_set_property;
 107   gobject_class->get_property = gst_fdsrc_get_property;
 108
 109   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FD,
 110       g_param_spec_int ("fd", "fd", "An open file descriptor to read from",
 111           0, G_MAXINT, 0, G_PARAM_READWRITE));
 112   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BLOCKSIZE,
 113       g_param_spec_ulong ("blocksize", "Block size",
 114           "Size in bytes to read per buffer", 1, G_MAXULONG, DEFAULT_BLOCKSIZE,
 115           G_PARAM_READWRITE));
 116   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_TIMEOUT,
 117       g_param_spec_uint64 ("timeout", "Timeout", "Read timeout in nanoseconds",
 118           0, G_MAXUINT64, 0, G_PARAM_READWRITE));
 119
 120   gst_fdsrc_signals[SIGNAL_TIMEOUT] =
 121       g_signal_new ("timeout", G_TYPE_FROM_CLASS (klass), G_SIGNAL_RUN_LAST,
 122       G_STRUCT_OFFSET (GstFdSrcClass, timeout), NULL, NULL,
 123       g_cclosure_marshal_VOID__VOID, G_TYPE_NONE, 0);
 124
 125   gstelement_class->change_state = gst_fdsrc_change_state;
 126 }
 127
 128 static void
 129 gst_fdsrc_init (GstFdSrc * fdsrc)
 130 {
 131   fdsrc->srcpad =
 132       gst_pad_new_from_template (gst_static_pad_template_get (&srctemplate),
 133       "src");
 134
 135   gst_pad_set_get_function (fdsrc->srcpad, gst_fdsrc_get);
 136   gst_element_add_pad (GST_ELEMENT (fdsrc), fdsrc->srcpad);
 137
 138   fdsrc->fd = 0;
 139   fdsrc->curoffset = 0;
 140   fdsrc->blocksize = DEFAULT_BLOCKSIZE;
 141   fdsrc->timeout = 0;
 142   fdsrc->seq = 0;
 143 }
 144
 145 static GstElementStateReturn
 146 gst_fdsrc_change_state (GstElement * element)
 147 {
 148   GstFdSrc *src = GST_FDSRC (element);
 149
 150   switch (GST_STATE_TRANSITION (element)) {
 151     case GST_STATE_NULL_TO_READY:
 152       break;
 153     case GST_STATE_READY_TO_NULL:
 154       break;
 155     case GST_STATE_READY_TO_PAUSED:
 156       src->curoffset = 0;
 157       break;
 158     case GST_STATE_PAUSED_TO_READY:
 159       break;
 160     default:
 161       break;
 162   }
 163
 164   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 165     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 166
 167   return GST_STATE_SUCCESS;
 168 }
 169
 170
 171 static void
 172 gst_fdsrc_set_property (GObject * object, guint prop_id, const GValue * value,
 173     GParamSpec * pspec)
 174 {
 175   GstFdSrc *src;
 176
 177   /* it's not null if we got it, but it might not be ours */
 178   g_return_if_fail (GST_IS_FDSRC (object));
 179
 180   src = GST_FDSRC (object);
 181
 182   switch (prop_id) {
 183     case ARG_FD:
 184       src->fd = g_value_get_int (value);
 185       break;
 186     case ARG_BLOCKSIZE:
 187       src->blocksize = g_value_get_ulong (value);
 188       break;
 189     case ARG_TIMEOUT:
 190       src->timeout = g_value_get_uint64 (value);
 191       break;
 192     default:
 193       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 194       break;
 195   }
 196 }
 197
 198 static void
 199 gst_fdsrc_get_property (GObject * object, guint prop_id, GValue * value,
 200     GParamSpec * pspec)
 201 {
 202   GstFdSrc *src;
 203
 204   /* it's not null if we got it, but it might not be ours */
 205   g_return_if_fail (GST_IS_FDSRC (object));
 206
 207   src = GST_FDSRC (object);
 208
 209   switch (prop_id) {
 210     case ARG_BLOCKSIZE:
 211       g_value_set_ulong (value, src->blocksize);
 212       break;
 213     case ARG_FD:
 214       g_value_set_int (value, src->fd);
 215       break;
 216     case ARG_TIMEOUT:
 217       g_value_set_uint64 (value, src->timeout);
 218       break;
 219     default:
 220       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 221       break;
 222   }
 223 }
 224
 225 static GstData *
 226 gst_fdsrc_get (GstPad * pad)
 227 {
 228   GstFdSrc *src;
 229   GstBuffer *buf;
 230   glong readbytes;
 231
 232 #ifndef HAVE_WIN32
 233   fd_set readfds;
 234   struct timeval t, *tp = &t;
 235   gint retval;
 236 #endif
 237
 238   src = GST_FDSRC (gst_pad_get_parent (pad));
 239
 240   /* create the buffer */
 241   buf = gst_buffer_new_and_alloc (src->blocksize);
 242
 243 #ifndef HAVE_WIN32
 244   FD_ZERO (&readfds);
 245   FD_SET (src->fd, &readfds);
 246
 247   if (src->timeout != 0) {
 248     GST_TIME_TO_TIMEVAL (src->timeout, t);
 249   } else
 250     tp = NULL;
 251
 252   do {
 253     retval = select (src->fd + 1, &readfds, NULL, NULL, tp);
 254   } while (retval == -1 && errno == EINTR);     /* retry if interrupted */
 255
 256   if (retval == -1) {
 257     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 258         ("select on file descriptor: %s.", g_strerror (errno)));
 259     gst_element_set_eos (GST_ELEMENT (src));
 260     return GST_DATA (gst_event_new (GST_EVENT_EOS));
 261   } else if (retval == 0) {
 262     g_signal_emit (G_OBJECT (src), gst_fdsrc_signals[SIGNAL_TIMEOUT], 0);
 263     gst_element_set_eos (GST_ELEMENT (src));
 264     return GST_DATA (gst_event_new (GST_EVENT_EOS));
 265   }
 266 #endif
 267
 268   do {
 269     readbytes = read (src->fd, GST_BUFFER_DATA (buf), src->blocksize);
 270   } while (readbytes == -1 && errno == EINTR);  /* retry if interrupted */
 271
 272   if (readbytes > 0) {
 273     GST_BUFFER_OFFSET (buf) = src->curoffset;
 274     GST_BUFFER_SIZE (buf) = readbytes;
 275     GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
 276     src->curoffset += readbytes;
 277
 278     /* we're done, return the buffer */
 279     return GST_DATA (buf);
 280   } else if (readbytes == 0) {
 281     gst_element_set_eos (GST_ELEMENT (src));
 282     return GST_DATA (gst_event_new (GST_EVENT_EOS));
 283   } else {
 284     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 285         ("read on file descriptor: %s.", g_strerror (errno)));
 286     gst_element_set_eos (GST_ELEMENT (src));
 287     return GST_DATA (gst_event_new (GST_EVENT_EOS));
 288   }
 289 }