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