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