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