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