gst/elements/gstfilesrc.c

   1 /* GStreamer
   2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
   3  *                    2000 Wim Taymans <wtay@chello.be>
   4  *
   5  * gstfilesrc.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
  27 #include <gst/gst.h>
  28 #include "gstfilesrc.h"
  29
  30 #include <stdio.h>
  31 #include <sys/stat.h>
  32 #include <fcntl.h>
  33 #include <unistd.h>
  34 #include <sys/mman.h>
  35 #include <errno.h>
  36 #include <string.h>
  37
  38 #include "../gst-i18n-lib.h"
  39
  40
  41 /**********************************************************************
  42  * GStreamer Default File Source
  43  * Theory of Operation
  44  *
  45  * This source uses mmap(2) to efficiently load data from a file.
  46  * To do this without seriously polluting the applications' memory
  47  * space, it must do so in smaller chunks, say 1-4MB at a time.
  48  * Buffers are then subdivided from these mmap'd chunks, to directly
  49  * make use of the mmap.
  50  *
  51  * To handle refcounting so that the mmap can be freed at the appropriate
  52  * time, a buffer will be created for each mmap'd region, and all new
  53  * buffers will be sub-buffers of this top-level buffer.  As they are
  54  * freed, the refcount goes down on the mmap'd buffer and its free()
  55  * function is called, which will call munmap(2) on itself.
  56  *
  57  * If a buffer happens to cross the boundaries of an mmap'd region, we
  58  * have to decide whether it's more efficient to copy the data into a
  59  * new buffer, or mmap() just that buffer.  There will have to be a
  60  * breakpoint size to determine which will be done.  The mmap() size
  61  * has a lot to do with this as well, because you end up in double-
  62  * jeopardy: the larger the outgoing buffer, the more data to copy when
  63  * it overlaps, *and* the more frequently you'll have buffers that *do*
  64  * overlap.
  65  *
  66  * Seeking is another tricky aspect to do efficiently.  The initial
  67  * implementation of this source won't make use of these features, however.
  68  * The issue is that if an application seeks backwards in a file, *and*
  69  * that region of the file is covered by an mmap that hasn't been fully
  70  * deallocated, we really should re-use it.  But keeping track of these
  71  * regions is tricky because we have to lock the structure that holds
  72  * them.  We need to settle on a locking primitive (GMutex seems to be
  73  * a really good option...), then we can do that.
  74  */
  75
  76
  77 GST_DEBUG_CATEGORY_STATIC (gst_filesrc_debug);
  78 #define GST_CAT_DEFAULT gst_filesrc_debug
  79
  80 GstElementDetails gst_filesrc_details = GST_ELEMENT_DETAILS (
  81   "File Source",
  82   "Source/File",
  83   "Read from arbitrary point in a file",
  84   "Erik Walthinsen <omega@cse.ogi.edu>"
  85 );
  86
  87 #define DEFAULT_BLOCKSIZE       4*1024
  88 #define DEFAULT_MMAPSIZE        4*1024*1024
  89
  90 /* FileSrc signals and args */
  91 enum {
  92   /* FILL ME */
  93   LAST_SIGNAL
  94 };
  95
  96 enum {
  97   ARG_0,
  98   ARG_LOCATION,
  99   ARG_FD,
 100   ARG_BLOCKSIZE,
 101   ARG_MMAPSIZE,
 102   ARG_TOUCH
 103 };
 104
 105 GST_PAD_EVENT_MASK_FUNCTION (gst_filesrc_get_event_mask,
 106   { GST_EVENT_SEEK, GST_SEEK_METHOD_CUR |
 107                     GST_SEEK_METHOD_SET |
 108                     GST_SEEK_METHOD_END |
 109                     GST_SEEK_FLAG_FLUSH },
 110   { GST_EVENT_FLUSH, 0 },
 111   { GST_EVENT_SIZE, 0 }
 112 )
 113
 114 GST_PAD_QUERY_TYPE_FUNCTION (gst_filesrc_get_query_types,
 115   GST_QUERY_TOTAL,
 116   GST_QUERY_POSITION
 117 )
 118
 119 GST_PAD_FORMATS_FUNCTION (gst_filesrc_get_formats,
 120   GST_FORMAT_BYTES
 121 )
 122
 123 static void             gst_filesrc_dispose             (GObject *object);
 124
 125 static void             gst_filesrc_set_property        (GObject *object, guint prop_id,
 126                                                          const GValue *value, GParamSpec *pspec);
 127 static void             gst_filesrc_get_property        (GObject *object, guint prop_id,
 128                                                          GValue *value, GParamSpec *pspec);
 129
 130 static gboolean         gst_filesrc_check_filesize      (GstFileSrc *src);
 131 static GstData *        gst_filesrc_get                 (GstPad *pad);
 132 static gboolean         gst_filesrc_srcpad_event        (GstPad *pad, GstEvent *event);
 133 static gboolean         gst_filesrc_srcpad_query        (GstPad *pad, GstQueryType type,
 134                                                          GstFormat *format, gint64 *value);
 135
 136 static GstElementStateReturn    gst_filesrc_change_state        (GstElement *element);
 137
 138 static void             gst_filesrc_uri_handler_init    (gpointer g_iface, gpointer iface_data);
 139
 140 static void
 141 _do_init (GType filesrc_type)
 142 {
 143   static const GInterfaceInfo urihandler_info = {
 144     gst_filesrc_uri_handler_init,
 145     NULL,
 146     NULL
 147   };
 148   g_type_add_interface_static (filesrc_type, GST_TYPE_URI_HANDLER, &urihandler_info);
 149   GST_DEBUG_CATEGORY_INIT (gst_filesrc_debug, "filesrc", 0, "filesrc element");
 150 }
 151
 152 GST_BOILERPLATE_FULL (GstFileSrc, gst_filesrc, GstElement, GST_TYPE_ELEMENT, _do_init);
 153
 154 static void
 155 gst_filesrc_base_init (gpointer g_class)
 156 {
 157   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
 158
 159   gst_element_class_set_details (gstelement_class, &gst_filesrc_details);
 160 }
 161 static void
 162 gst_filesrc_class_init (GstFileSrcClass *klass)
 163 {
 164   GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
 165   GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
 166
 167   gobject_class = (GObjectClass*)klass;
 168
 169
 170   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FD,
 171     g_param_spec_int ("fd", "File-descriptor", "File-descriptor for the file being mmap()d",
 172                       0, G_MAXINT, 0, G_PARAM_READABLE));
 173   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LOCATION,
 174     g_param_spec_string ("location", "File Location", "Location of the file to read",
 175                          NULL, G_PARAM_READWRITE));
 176   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BLOCKSIZE,
 177     g_param_spec_ulong ("blocksize", "Block size", "Size in bytes to read per buffer",
 178                         1, G_MAXULONG, DEFAULT_BLOCKSIZE, G_PARAM_READWRITE));
 179   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MMAPSIZE,
 180     g_param_spec_ulong ("mmapsize", "mmap() Block Size",
 181                         "Size in bytes of mmap()d regions",
 182                         0, G_MAXULONG, DEFAULT_MMAPSIZE, G_PARAM_READWRITE));
 183   g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_TOUCH,
 184     g_param_spec_boolean ("touch", "Touch read data",
 185                           "Touch data to force disk read",
 186                           FALSE, G_PARAM_READWRITE));
 187
 188   gobject_class->dispose        = gst_filesrc_dispose;
 189   gobject_class->set_property   = gst_filesrc_set_property;
 190   gobject_class->get_property   = gst_filesrc_get_property;
 191
 192   gstelement_class->change_state = gst_filesrc_change_state;
 193 }
 194
 195 static void
 196 gst_filesrc_init (GstFileSrc *src)
 197 {
 198   src->srcpad = gst_pad_new ("src", GST_PAD_SRC);
 199   gst_pad_set_get_function (src->srcpad, gst_filesrc_get);
 200   gst_pad_set_event_function (src->srcpad, gst_filesrc_srcpad_event);
 201   gst_pad_set_event_mask_function (src->srcpad, gst_filesrc_get_event_mask);
 202   gst_pad_set_query_function (src->srcpad, gst_filesrc_srcpad_query);
 203   gst_pad_set_query_type_function (src->srcpad, gst_filesrc_get_query_types);
 204   gst_pad_set_formats_function (src->srcpad, gst_filesrc_get_formats);
 205   gst_element_add_pad (GST_ELEMENT (src), src->srcpad);
 206
 207   src->pagesize = getpagesize();
 208
 209   src->filename = NULL;
 210   src->fd = 0;
 211   src->filelen = 0;
 212
 213   src->curoffset = 0;
 214   src->block_size = DEFAULT_BLOCKSIZE;
 215   src->touch = FALSE;
 216
 217   src->mapbuf = NULL;
 218   src->mapsize = DEFAULT_MMAPSIZE;              /* default is 4MB */
 219
 220   src->seek_happened = FALSE;
 221 }
 222
 223 static void
 224 gst_filesrc_dispose (GObject *object)
 225 {
 226   GstFileSrc *src;
 227
 228   src = GST_FILESRC (object);
 229
 230   G_OBJECT_CLASS (parent_class)->dispose (object);
 231
 232   if (src->filename)
 233     g_free (src->filename);
 234   if (src->uri)
 235     g_free (src->uri);
 236 }
 237
 238 static gboolean
 239 gst_filesrc_set_location (GstFileSrc *src, const gchar *location)
 240 {
 241   /* the element must be stopped in order to do this */
 242   if (GST_STATE (src) != GST_STATE_READY &&
 243       GST_STATE (src) != GST_STATE_NULL)
 244     return FALSE;
 245
 246   if (src->filename) g_free (src->filename);
 247   if (src->uri) g_free (src->uri);
 248   /* clear the filename if we get a NULL (is that possible?) */
 249   if (location == NULL) {
 250     src->filename = NULL;
 251     src->uri = NULL;
 252   } else {
 253     src->filename = g_strdup (location);
 254     src->uri = gst_uri_construct ("file", src->filename);
 255   }
 256   g_object_notify (G_OBJECT (src), "location");
 257   gst_uri_handler_new_uri (GST_URI_HANDLER (src), src->uri);
 258
 259   return TRUE;
 260 }
 261
 262 static void
 263 gst_filesrc_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 264 {
 265   GstFileSrc *src;
 266
 267   /* it's not null if we got it, but it might not be ours */
 268   g_return_if_fail (GST_IS_FILESRC (object));
 269
 270   src = GST_FILESRC (object);
 271
 272   switch (prop_id) {
 273     case ARG_LOCATION:
 274       gst_filesrc_set_location (src, g_value_get_string (value));
 275       break;
 276     case ARG_BLOCKSIZE:
 277       src->block_size = g_value_get_ulong (value);
 278       g_object_notify (G_OBJECT (src), "blocksize");
 279       break;
 280     case ARG_MMAPSIZE:
 281       if ((src->mapsize % src->pagesize) == 0) {
 282         src->mapsize = g_value_get_ulong (value);
 283         g_object_notify (G_OBJECT (src), "mmapsize");
 284       } else {
 285         GST_INFO_OBJECT (src, "invalid mapsize, must be a multiple of pagesize, which is %d",
 286                   src->pagesize);
 287       }
 288       break;
 289     case ARG_TOUCH:
 290       src->touch = g_value_get_boolean (value);
 291       g_object_notify (G_OBJECT (src), "touch");
 292       break;
 293     default:
 294       break;
 295   }
 296 }
 297
 298 static void
 299 gst_filesrc_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 300 {
 301   GstFileSrc *src;
 302
 303   /* it's not null if we got it, but it might not be ours */
 304   g_return_if_fail (GST_IS_FILESRC (object));
 305
 306   src = GST_FILESRC (object);
 307
 308   switch (prop_id) {
 309     case ARG_LOCATION:
 310       g_value_set_string (value, src->filename);
 311       break;
 312     case ARG_FD:
 313       g_value_set_int (value, src->fd);
 314       break;
 315     case ARG_BLOCKSIZE:
 316       g_value_set_ulong (value, src->block_size);
 317       break;
 318     case ARG_MMAPSIZE:
 319       g_value_set_ulong (value, src->mapsize);
 320       break;
 321     case ARG_TOUCH:
 322       g_value_set_boolean (value, src->touch);
 323       break;
 324     default:
 325       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 326       break;
 327   }
 328 }
 329
 330 static void
 331 gst_filesrc_free_parent_mmap (GstBuffer *buf)
 332 {
 333   GST_LOG ("freeing mmap()d buffer at %"G_GUINT64_FORMAT"+%u",
 334       GST_BUFFER_OFFSET (buf), GST_BUFFER_SIZE (buf));
 335
 336 #ifdef MADV_DONTNEED
 337   /* madvise to tell the kernel what to do with it */
 338   madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_DONTNEED);
 339 #endif
 340   /* now unmap the memory */
 341   munmap (GST_BUFFER_DATA (buf), GST_BUFFER_MAXSIZE (buf));
 342   /* cast to unsigned long, since there's no gportable way to print
 343    * guint64 as hex */
 344   GST_LOG ("unmapped region %08lx+%08lx at %p",
 345       (unsigned long) GST_BUFFER_OFFSET (buf),
 346       (unsigned long) GST_BUFFER_MAXSIZE (buf),
 347       GST_BUFFER_DATA (buf));
 348
 349   GST_BUFFER_DATA (buf) = NULL;
 350 }
 351
 352 static GstBuffer *
 353 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
 354 {
 355   GstBuffer *buf;
 356   gint retval;
 357   void *mmapregion;
 358
 359   g_return_val_if_fail (offset >= 0, NULL);
 360
 361   GST_LOG_OBJECT (src, "mapping region %08llx+%08lx from file into memory",offset,(unsigned long)size);
 362   mmapregion = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
 363
 364   if (mmapregion == NULL) {
 365     GST_ELEMENT_ERROR (src, RESOURCE, TOO_LAZY, (NULL), ("mmap call failed."));
 366     return NULL;
 367   }
 368   else if (mmapregion == MAP_FAILED) {
 369     GST_WARNING_OBJECT (src, "mmap (0x%08lx, %d, 0x%llx) failed: %s",
 370              (unsigned long)size, src->fd, offset, strerror (errno));
 371     return NULL;
 372   }
 373   GST_LOG_OBJECT (src, "mapped region %08lx+%08lx from file into memory at %p",
 374                   (unsigned long)offset, (unsigned long)size, mmapregion);
 375
 376   /* time to allocate a new mapbuf */
 377   buf = gst_buffer_new ();
 378   /* mmap() the data into this new buffer */
 379   GST_BUFFER_DATA (buf) = mmapregion;
 380
 381 #ifdef MADV_SEQUENTIAL
 382   /* madvise to tell the kernel what to do with it */
 383   retval = madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_SEQUENTIAL);
 384 #endif
 385   /* fill in the rest of the fields */
 386   GST_BUFFER_FLAG_SET (buf, GST_BUFFER_READONLY);
 387   GST_BUFFER_FLAG_SET (buf, GST_BUFFER_ORIGINAL);
 388   GST_BUFFER_SIZE (buf) = size;
 389   GST_BUFFER_MAXSIZE (buf) = size;
 390   GST_BUFFER_OFFSET (buf) = offset;
 391   GST_BUFFER_OFFSET_END (buf) = offset + size;
 392   GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
 393   GST_BUFFER_PRIVATE (buf) = src;
 394   GST_BUFFER_FREE_DATA_FUNC (buf) = gst_filesrc_free_parent_mmap;
 395
 396   return buf;
 397 }
 398
 399 static GstBuffer *
 400 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
 401 {
 402   size_t mapsize;
 403   off_t mod, mapbase;
 404   GstBuffer *map;
 405
 406 /*  printf("attempting to map a small buffer at %d+%d\n",offset,size); */
 407
 408   /* if the offset starts at a non-page boundary, we have to special case */
 409   if ((mod = offset % src->pagesize)) {
 410     GstBuffer *ret;
 411
 412     mapbase = offset - mod;
 413     mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
 414 /*    printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
 415     map = gst_filesrc_map_region(src, mapbase, mapsize);
 416     if (map == NULL)
 417       return NULL;
 418
 419     ret = gst_buffer_create_sub (map, offset - mapbase, size);
 420     GST_BUFFER_OFFSET (ret) = GST_BUFFER_OFFSET (map) + offset - mapbase;
 421
 422     gst_buffer_unref (map);
 423
 424     return ret;
 425   }
 426
 427   return gst_filesrc_map_region(src,offset,size);
 428 }
 429
 430 /**
 431  * gst_filesrc_get_mmap:
 432  * @pad: #GstPad to push a buffer from
 433  *
 434  * Push a new buffer from the filesrc at the current offset.
 435  */
 436 static GstBuffer *
 437 gst_filesrc_get_mmap (GstFileSrc *src)
 438 {
 439   GstBuffer *buf = NULL;
 440   size_t readsize, mapsize;
 441   off_t readend,mapstart,mapend;
 442   int i;
 443
 444   /* calculate end pointers so we don't have to do so repeatedly later */
 445   readsize = src->block_size;
 446   readend = src->curoffset + src->block_size;           /* note this is the byte *after* the read */
 447   mapstart = GST_BUFFER_OFFSET (src->mapbuf);
 448   mapsize = GST_BUFFER_SIZE (src->mapbuf);
 449   mapend = mapstart + mapsize;                  /* note this is the byte *after* the map */
 450
 451   /* check to see if we're going to overflow the end of the file */
 452   if (readend > src->filelen) {
 453     if (!gst_filesrc_check_filesize (src) || readend > src->filelen) {
 454       readsize = src->filelen - src->curoffset;
 455       readend = src->curoffset + readsize;
 456     }
 457   }
 458
 459   GST_LOG ("attempting to read %08lx, %08lx, %08lx, %08lx",
 460            (unsigned long)readsize, (unsigned long)readend,
 461            (unsigned long)mapstart, (unsigned long)mapend);
 462
 463   /* if the start is past the mapstart */
 464   if (src->curoffset >= mapstart) {
 465     /* if the end is before the mapend, the buffer is in current mmap region... */
 466     /* ('cause by definition if readend is in the buffer, so's readstart) */
 467     if (readend <= mapend) {
 468       GST_LOG_OBJECT (src, "read buf %llu+%d lives in current mapbuf %lld+%d, creating subbuffer of mapbuf",
 469              src->curoffset, readsize, mapstart, mapsize);
 470       buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - mapstart,
 471                                    readsize);
 472       GST_BUFFER_OFFSET (buf) = src->curoffset;
 473
 474     /* if the start actually is within the current mmap region, map an overlap buffer */
 475     } else if (src->curoffset < mapend) {
 476       GST_LOG_OBJECT (src, "read buf %llu+%d starts in mapbuf %d+%d but ends outside, creating new mmap",
 477              (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart, (gint) mapsize);
 478       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 479       if (buf == NULL)
 480         return NULL;
 481     }
 482
 483     /* the only other option is that buffer is totally outside, which means we search for it */
 484
 485   /* now we can assume that the start is *before* the current mmap region */
 486   /* if the readend is past mapstart, we have two options */
 487   } else if (readend >= mapstart) {
 488     /* either the read buffer overlaps the start of the mmap region */
 489     /* or the read buffer fully contains the current mmap region    */
 490     /* either way, it's really not relevant, we just create a new region anyway*/
 491     GST_LOG_OBJECT (src, "read buf %llu+%d starts before mapbuf %d+%d, but overlaps it",
 492              (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart, (gint) mapsize);
 493     buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 494     if (buf == NULL)
 495       return NULL;
 496   }
 497
 498   /* then deal with the case where the read buffer is totally outside */
 499   if (buf == NULL) {
 500     /* first check to see if there's a map that covers the right region already */
 501     GST_LOG_OBJECT (src, "searching for mapbuf to cover %llu+%d",src->curoffset,readsize);
 502
 503     /* if the read buffer crosses a mmap region boundary, create a one-off region */
 504     if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
 505       GST_LOG_OBJECT (src, "read buf %llu+%d crosses a %d-byte boundary, creating a one-off",
 506              src->curoffset,readsize,src->mapsize);
 507       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 508       if (buf == NULL)
 509         return NULL;
 510
 511     /* otherwise we will create a new mmap region and set it to the default */
 512     } else {
 513       size_t mapsize;
 514
 515       off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
 516       GST_LOG_OBJECT (src, "read buf %llu+%d in new mapbuf at %llu+%d, mapping and subbuffering",
 517              src->curoffset, readsize, nextmap, src->mapsize);
 518       /* first, we're done with the old mapbuf */
 519       gst_buffer_unref(src->mapbuf);
 520       mapsize = src->mapsize;
 521
 522       /* double the mapsize as long as the readsize is smaller */
 523       while (readsize - (src->curoffset - nextmap) > mapsize) {
 524         GST_LOG_OBJECT (src, "readsize smaller then mapsize %08x %d", readsize, mapsize);
 525         mapsize <<=1;
 526       }
 527       /* create a new one */
 528       src->mapbuf = gst_filesrc_map_region (src, nextmap, mapsize);
 529       if (src->mapbuf == NULL)
 530         return NULL;
 531
 532       /* subbuffer it */
 533       buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - nextmap, readsize);
 534       GST_BUFFER_OFFSET (buf) = GST_BUFFER_OFFSET (src->mapbuf) + src->curoffset - nextmap;
 535     }
 536   }
 537
 538   /* if we need to touch the buffer (to bring it into memory), do so */
 539   if (src->touch) {
 540     volatile guchar *p = GST_BUFFER_DATA (buf), c;
 541
 542     for (i=0; i < GST_BUFFER_SIZE (buf); i += src->pagesize)
 543       c = p[i];
 544   }
 545
 546   /* we're done, return the buffer */
 547   g_assert (src->curoffset == GST_BUFFER_OFFSET (buf));
 548   src->curoffset += GST_BUFFER_SIZE(buf);
 549   return buf;
 550 }
 551
 552 static GstBuffer *
 553 gst_filesrc_get_read (GstFileSrc *src)
 554 {
 555   GstBuffer *buf = NULL;
 556   size_t readsize;
 557   int ret;
 558
 559   readsize = src->block_size;
 560   if (src->curoffset + readsize > src->filelen) {
 561     if (!gst_filesrc_check_filesize (src) || src->curoffset + readsize > src->filelen) {
 562       readsize = src->filelen - src->curoffset;
 563     }
 564   }
 565
 566   buf = gst_buffer_new_and_alloc (readsize);
 567   g_return_val_if_fail (buf != NULL, NULL);
 568
 569   ret = read (src->fd, GST_BUFFER_DATA (buf), readsize);
 570   if (ret < 0){
 571     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
 572     return NULL;
 573   }
 574   if (ret < readsize) {
 575     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), ("unexpected end of file."));
 576     return NULL;
 577   }
 578
 579   GST_BUFFER_SIZE (buf) = readsize;
 580   GST_BUFFER_MAXSIZE (buf) = readsize;
 581   GST_BUFFER_OFFSET (buf) = src->curoffset;
 582   GST_BUFFER_OFFSET_END (buf) = src->curoffset + readsize;
 583   src->curoffset += readsize;
 584
 585   return buf;
 586 }
 587
 588 static GstData *
 589 gst_filesrc_get (GstPad *pad)
 590 {
 591   GstFileSrc *src;
 592
 593   g_return_val_if_fail (pad != NULL, NULL);
 594   src = GST_FILESRC (gst_pad_get_parent (pad));
 595   g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
 596
 597   /* check for flush */
 598   if (src->need_flush) {
 599     src->need_flush = FALSE;
 600     GST_DEBUG_OBJECT (src, "sending flush");
 601     return GST_DATA (gst_event_new_flush ());
 602   }
 603   /* check for seek */
 604   if (src->seek_happened) {
 605     GstEvent *event;
 606
 607     src->seek_happened = FALSE;
 608     GST_DEBUG_OBJECT (src, "sending discont");
 609     event = gst_event_new_discontinuous (FALSE, GST_FORMAT_BYTES, src->curoffset, NULL);
 610     return GST_DATA (event);
 611   }
 612
 613   /* check for EOF */
 614   g_assert (src->curoffset <= src->filelen);
 615   if (src->curoffset == src->filelen) {
 616     if (!gst_filesrc_check_filesize (src) || src->curoffset >= src->filelen) {
 617       GST_DEBUG_OBJECT (src, "eos %" G_GINT64_FORMAT" %" G_GINT64_FORMAT,
 618                 src->curoffset, src->filelen);
 619       gst_element_set_eos (GST_ELEMENT (src));
 620       return GST_DATA (gst_event_new (GST_EVENT_EOS));
 621     }
 622   }
 623
 624   if (src->using_mmap){
 625     return GST_DATA (gst_filesrc_get_mmap (src));
 626   }else{
 627     return GST_DATA (gst_filesrc_get_read (src));
 628   }
 629 }
 630
 631 /* TRUE if the filesize of the file was updated */
 632 static gboolean
 633 gst_filesrc_check_filesize (GstFileSrc *src)
 634 {
 635   struct stat stat_results;
 636
 637   g_return_val_if_fail (GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
 638
 639   fstat(src->fd, &stat_results);
 640   GST_DEBUG_OBJECT (src, "checked filesize on %s (was %"G_GUINT64_FORMAT", is %"G_GUINT64_FORMAT")",
 641           src->filename, src->filelen, (guint64) stat_results.st_size);
 642   if (src->filelen == (guint64) stat_results.st_size)
 643     return FALSE;
 644   src->filelen = stat_results.st_size;
 645   return TRUE;
 646 }
 647 /* open the file and mmap it, necessary to go to READY state */
 648 static gboolean
 649 gst_filesrc_open_file (GstFileSrc *src)
 650 {
 651   g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
 652
 653   if (src->filename == NULL)
 654   {
 655     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 656                          (_("No filename specified.")), (NULL));
 657     return FALSE;
 658   }
 659
 660   if (src->filename == NULL)
 661   {
 662     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 663                          (_("No file specified for reading.")), (NULL));
 664     return FALSE;
 665   }
 666
 667
 668   GST_INFO_OBJECT (src, "opening file %s",src->filename);
 669
 670   /* open the file */
 671   src->fd = open (src->filename, O_RDONLY);
 672   if (src->fd < 0)
 673   {
 674     if (errno == ENOENT)
 675       GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND, (NULL), (NULL));
 676     else
 677       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
 678                          (_("Could not open file \"%s\" for reading."), src->filename),
 679                          GST_ERROR_SYSTEM);
 680     return FALSE;
 681   } else {
 682     /* check if it is a regular file, otherwise bail out */
 683     struct stat stat_results;
 684
 685     fstat(src->fd, &stat_results);
 686
 687     if (!S_ISREG(stat_results.st_mode)) {
 688       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
 689                            (_("File \"%s\" isn't a regular file."), src->filename),
 690                            (NULL));
 691       close(src->fd);
 692       return FALSE;
 693     }
 694
 695     /* find the file length */
 696     src->filelen = stat_results.st_size;
 697
 698     /* allocate the first mmap'd region */
 699     src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
 700     if (src->mapbuf == NULL) {
 701       src->using_mmap = FALSE;
 702     }else{
 703       src->using_mmap = TRUE;
 704     }
 705
 706     src->curoffset = 0;
 707
 708     GST_FLAG_SET (src, GST_FILESRC_OPEN);
 709   }
 710   return TRUE;
 711 }
 712
 713 /* unmap and close the file */
 714 static void
 715 gst_filesrc_close_file (GstFileSrc *src)
 716 {
 717   g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
 718
 719   /* close the file */
 720   close (src->fd);
 721
 722   /* zero out a lot of our state */
 723   src->fd = 0;
 724   src->filelen = 0;
 725   src->curoffset = 0;
 726
 727   if (src->mapbuf) {
 728     gst_buffer_unref (src->mapbuf);
 729     src->mapbuf = NULL;
 730   }
 731
 732   GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
 733 }
 734
 735
 736 static GstElementStateReturn
 737 gst_filesrc_change_state (GstElement *element)
 738 {
 739   GstFileSrc *src = GST_FILESRC(element);
 740
 741   switch (GST_STATE_TRANSITION (element)) {
 742     case GST_STATE_NULL_TO_READY:
 743       break;
 744     case GST_STATE_READY_TO_NULL:
 745       break;
 746     case GST_STATE_READY_TO_PAUSED:
 747       if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
 748         if (!gst_filesrc_open_file (GST_FILESRC (element)))
 749           return GST_STATE_FAILURE;
 750       }
 751       break;
 752     case GST_STATE_PAUSED_TO_READY:
 753       if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
 754         gst_filesrc_close_file (GST_FILESRC (element));
 755       src->seek_happened = TRUE;
 756       break;
 757     default:
 758       break;
 759   }
 760
 761   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 762     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 763
 764   return GST_STATE_SUCCESS;
 765 }
 766
 767 static gboolean
 768 gst_filesrc_srcpad_query (GstPad *pad, GstQueryType type,
 769                           GstFormat *format, gint64 *value)
 770 {
 771   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 772
 773   switch (type) {
 774     case GST_QUERY_TOTAL:
 775       if (*format != GST_FORMAT_BYTES) {
 776         return FALSE;
 777       }
 778       gst_filesrc_check_filesize (src);
 779       *value = src->filelen;
 780       break;
 781     case GST_QUERY_POSITION:
 782       switch (*format) {
 783         case GST_FORMAT_BYTES:
 784           *value = src->curoffset;
 785           break;
 786         case GST_FORMAT_PERCENT:
 787           if (src->filelen == 0)
 788             return FALSE;
 789           *value = src->curoffset * GST_FORMAT_PERCENT_MAX / src->filelen;
 790           break;
 791         default:
 792           return FALSE;
 793       }
 794       break;
 795     default:
 796       return FALSE;
 797       break;
 798   }
 799   return TRUE;
 800 }
 801
 802 static gboolean
 803 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
 804 {
 805   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 806
 807   GST_DEBUG_OBJECT (src, "event %d", GST_EVENT_TYPE (event));
 808
 809   switch (GST_EVENT_TYPE (event)) {
 810     case GST_EVENT_SEEK:
 811     {
 812       gint64 offset;
 813
 814       if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
 815         goto error;
 816       }
 817
 818       offset = GST_EVENT_SEEK_OFFSET (event);
 819
 820       switch (GST_EVENT_SEEK_METHOD (event)) {
 821         case GST_SEEK_METHOD_SET:
 822           if (offset > src->filelen && (!gst_filesrc_check_filesize (src) || offset > src->filelen)) {
 823               goto error;
 824           }
 825           src->curoffset = offset;
 826           GST_DEBUG_OBJECT (src, "seek set pending to %" G_GINT64_FORMAT, src->curoffset);
 827           break;
 828         case GST_SEEK_METHOD_CUR:
 829           if (offset + src->curoffset > src->filelen)
 830             if (!gst_filesrc_check_filesize (src) || offset + src->curoffset > src->filelen)
 831               goto error;
 832           src->curoffset += offset;
 833           GST_DEBUG_OBJECT (src, "seek cur pending to %" G_GINT64_FORMAT, src->curoffset);
 834           break;
 835         case GST_SEEK_METHOD_END:
 836           if (ABS (offset) > src->filelen) {
 837             if (!gst_filesrc_check_filesize (src) || ABS (offset) > src->filelen)
 838               goto error;
 839             goto error;
 840           }
 841           src->curoffset = src->filelen - ABS (offset);
 842           GST_DEBUG_OBJECT (src, "seek end pending to %" G_GINT64_FORMAT, src->curoffset);
 843           break;
 844         default:
 845           goto error;
 846           break;
 847       }
 848       src->seek_happened = TRUE;
 849       src->need_flush = GST_EVENT_SEEK_FLAGS(event) & GST_SEEK_FLAG_FLUSH;
 850       break;
 851     }
 852     case GST_EVENT_SIZE:
 853       if (GST_EVENT_SIZE_FORMAT (event) != GST_FORMAT_BYTES) {
 854         goto error;
 855       }
 856       src->block_size = GST_EVENT_SIZE_VALUE (event);
 857       g_object_notify (G_OBJECT (src), "blocksize");
 858       break;
 859     case GST_EVENT_FLUSH:
 860       src->need_flush = TRUE;
 861       break;
 862     default:
 863       goto error;
 864       break;
 865   }
 866   gst_event_unref (event);
 867   return TRUE;
 868
 869 error:
 870   gst_event_unref (event);
 871   return FALSE;
 872 }
 873
 874 /*** GSTURIHANDLER INTERFACE *************************************************/
 875
 876 static guint
 877 gst_filesrc_uri_get_type (void)
 878 {
 879   return GST_URI_SRC;
 880 }
 881 static gchar **
 882 gst_filesrc_uri_get_protocols(void)
 883 {
 884   static gchar *protocols[] = {"file", NULL};
 885   return protocols;
 886 }
 887 static const gchar *
 888 gst_filesrc_uri_get_uri (GstURIHandler *handler)
 889 {
 890   GstFileSrc *src = GST_FILESRC (handler);
 891
 892   return src->uri;
 893 }
 894 static gboolean
 895 gst_filesrc_uri_set_uri (GstURIHandler *handler, const gchar *uri)
 896 {
 897   gchar *protocol, *location;
 898   gboolean ret;
 899   GstFileSrc *src = GST_FILESRC (handler);
 900
 901   protocol = gst_uri_get_protocol (uri);
 902   if (strcmp (protocol, "file") != 0) {
 903     g_free (protocol);
 904     return FALSE;
 905   }
 906   g_free (protocol);
 907   location = gst_uri_get_location (uri);
 908   ret = gst_filesrc_set_location (src, location);
 909   g_free (location);
 910
 911   return ret;
 912 }
 913
 914 static void
 915 gst_filesrc_uri_handler_init (gpointer g_iface, gpointer iface_data)
 916 {
 917   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 918
 919   iface->get_type = gst_filesrc_uri_get_type;
 920   iface->get_protocols = gst_filesrc_uri_get_protocols;
 921   iface->get_uri = gst_filesrc_uri_get_uri;
 922   iface->set_uri = gst_filesrc_uri_set_uri;
 923 }