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