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   "Read from arbitrary point in a file",
  76   VERSION,
  77   "Erik Walthinsen <omega@cse.ogi.edu>",
  78   "(C) 1999",
  79 };
  80
  81 /* #define fs_print(format,args...) g_print(format, ## args)  */
  82 #define fs_print(format,args...)
  83
  84 /* FileSrc signals and args */
  85 enum {
  86   /* FILL ME */
  87   LAST_SIGNAL
  88 };
  89
  90 enum {
  91   ARG_0,
  92   ARG_OFFSET,
  93   ARG_LOCATION,
  94   ARG_FILESIZE,
  95   ARG_FD,
  96   ARG_BLOCKSIZE,
  97   ARG_MAPSIZE,
  98   ARG_TOUCH,
  99 };
 100
 101 static void             gst_filesrc_class_init          (GstFileSrcClass *klass);
 102 static void             gst_filesrc_init                (GstFileSrc *filesrc);
 103 static void             gst_filesrc_dispose             (GObject *object);
 104
 105 static void             gst_filesrc_set_property        (GObject *object, guint prop_id,
 106                                                          const GValue *value, GParamSpec *pspec);
 107 static void             gst_filesrc_get_property        (GObject *object, guint prop_id,
 108                                                          GValue *value, GParamSpec *pspec);
 109
 110 static GstBuffer *      gst_filesrc_get                 (GstPad *pad);
 111 static const GstFormat* gst_filesrc_get_formats         (GstPad *pad);
 112 static gboolean         gst_filesrc_srcpad_event        (GstPad *pad, GstEvent *event);
 113 static gboolean         gst_filesrc_srcpad_query        (GstPad *pad, GstPadQueryType type,
 114                                                          GstFormat *format, gint64 *value);
 115
 116 static GstElementStateReturn    gst_filesrc_change_state        (GstElement *element);
 117
 118
 119 static GstElementClass *parent_class = NULL;
 120 /*static guint gst_filesrc_signals[LAST_SIGNAL] = { 0 };*/
 121
 122 GType
 123 gst_filesrc_get_type(void)
 124 {
 125   static GType filesrc_type = 0;
 126
 127   if (!filesrc_type) {
 128     static const GTypeInfo filesrc_info = {
 129       sizeof(GstFileSrcClass),      NULL,
 130       NULL,
 131       (GClassInitFunc)gst_filesrc_class_init,
 132       NULL,
 133       NULL,
 134       sizeof(GstFileSrc),
 135       0,
 136       (GInstanceInitFunc)gst_filesrc_init,
 137     };
 138     filesrc_type = g_type_register_static (GST_TYPE_ELEMENT, "GstFileSrc", &filesrc_info, 0);
 139   }
 140   return filesrc_type;
 141 }
 142
 143 static void
 144 gst_filesrc_class_init (GstFileSrcClass *klass)
 145 {
 146   GObjectClass *gobject_class;
 147   GstElementClass *gstelement_class;
 148
 149   gobject_class = (GObjectClass*)klass;
 150   gstelement_class = (GstElementClass*)klass;
 151
 152   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
 153
 154   gst_element_class_install_std_props (
 155           GST_ELEMENT_CLASS (klass),
 156           "fd",           ARG_FD,           G_PARAM_READABLE,
 157           "offset",       ARG_OFFSET,       G_PARAM_READWRITE,
 158           "filesize",     ARG_FILESIZE,     G_PARAM_READABLE,
 159           "location",     ARG_LOCATION,     G_PARAM_READWRITE,
 160           "blocksize",    ARG_BLOCKSIZE,    G_PARAM_READWRITE,
 161           "mmapsize",     ARG_MAPSIZE,      G_PARAM_READWRITE,
 162           "touch",        ARG_TOUCH,        G_PARAM_READWRITE,
 163           NULL);
 164
 165   gobject_class->dispose        = gst_filesrc_dispose;
 166   gobject_class->set_property   = gst_filesrc_set_property;
 167   gobject_class->get_property   = gst_filesrc_get_property;
 168
 169   gstelement_class->change_state = gst_filesrc_change_state;
 170 }
 171
 172 static gint
 173 gst_filesrc_bufcmp (gconstpointer a, gconstpointer b)
 174 {
 175 /*  GstBuffer *bufa = (GstBuffer *)a, *bufb = (GstBuffer *)b;*/
 176
 177   /* sort first by offset, then in reverse by size */
 178   if (GST_BUFFER_OFFSET(a) < GST_BUFFER_OFFSET(b)) return -1;
 179   else if (GST_BUFFER_OFFSET(a) > GST_BUFFER_OFFSET(b)) return 1;
 180   else if (GST_BUFFER_SIZE(a) > GST_BUFFER_SIZE(b)) return -1;
 181   else if (GST_BUFFER_SIZE(a) < GST_BUFFER_SIZE(b)) return 1;
 182   else return 0;
 183 }
 184
 185 static const GstEventMask*
 186 gst_filesrc_get_event_mask (GstPad *pad)
 187 {
 188   static GstEventMask gst_filesrc_event_mask[] = {
 189     { GST_EVENT_SEEK, GST_SEEK_METHOD_CUR |
 190                       GST_SEEK_METHOD_SET |
 191                       GST_SEEK_METHOD_END |
 192                       GST_SEEK_FLAG_FLUSH },
 193     { GST_EVENT_FLUSH, 0 },
 194     { GST_EVENT_SIZE, 0 },
 195     { 0, }
 196   };
 197
 198   return gst_filesrc_event_mask;
 199 }
 200
 201 static const GstPadQueryType*
 202 gst_filesrc_get_query_types (GstPad *pad)
 203 {
 204   static GstPadQueryType gst_filesrc_query_types[] = {
 205     GST_PAD_QUERY_TOTAL,
 206     GST_PAD_QUERY_POSITION,
 207     0
 208   };
 209
 210   return gst_filesrc_query_types;
 211 }
 212
 213 static void
 214 gst_filesrc_init (GstFileSrc *src)
 215 {
 216   src->srcpad = gst_pad_new ("src", GST_PAD_SRC);
 217   gst_pad_set_get_function (src->srcpad, gst_filesrc_get);
 218   gst_pad_set_event_function (src->srcpad, gst_filesrc_srcpad_event);
 219   gst_pad_set_event_mask_function (src->srcpad, gst_filesrc_get_event_mask);
 220   gst_pad_set_query_function (src->srcpad, gst_filesrc_srcpad_query);
 221   gst_pad_set_query_type_function (src->srcpad, gst_filesrc_get_query_types);
 222   gst_pad_set_formats_function (src->srcpad, gst_filesrc_get_formats);
 223   gst_element_add_pad (GST_ELEMENT (src), src->srcpad);
 224
 225   src->pagesize = getpagesize();
 226
 227   src->filename = NULL;
 228   src->fd = 0;
 229   src->filelen = 0;
 230
 231   src->curoffset = 0;
 232   src->block_size = 4096;
 233   src->touch = TRUE;
 234
 235   src->mapbuf = NULL;
 236   src->mapsize = 4 * 1024 * 1024;               /* default is 4MB */
 237
 238   src->map_regions = g_tree_new (gst_filesrc_bufcmp);
 239   src->map_regions_lock = g_mutex_new();
 240
 241   src->seek_happened = FALSE;
 242 }
 243
 244 static void
 245 gst_filesrc_dispose (GObject *object)
 246 {
 247   GstFileSrc *src;
 248
 249   src = GST_FILESRC (object);
 250
 251   G_OBJECT_CLASS (parent_class)->dispose (object);
 252
 253   g_tree_destroy (src->map_regions);
 254   g_mutex_free (src->map_regions_lock);
 255   if (src->filename)
 256     g_free (src->filename);
 257 }
 258
 259
 260 static void
 261 gst_filesrc_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
 262 {
 263   GstFileSrc *src;
 264
 265   /* it's not null if we got it, but it might not be ours */
 266   g_return_if_fail (GST_IS_FILESRC (object));
 267
 268   src = GST_FILESRC (object);
 269
 270   switch (prop_id) {
 271     case ARG_LOCATION:
 272       /* the element must be stopped in order to do this */
 273       g_return_if_fail (GST_STATE (src) < GST_STATE_PLAYING);
 274
 275       if (src->filename) g_free (src->filename);
 276       /* clear the filename if we get a NULL (is that possible?) */
 277       if (g_value_get_string (value) == NULL) {
 278         gst_element_set_state (GST_ELEMENT (object), GST_STATE_NULL);
 279         src->filename = NULL;
 280       /* otherwise set the new filename */
 281       } else {
 282         src->filename = g_strdup (g_value_get_string (value));
 283       }
 284       g_object_notify (G_OBJECT (src), "location");
 285       break;
 286     case ARG_BLOCKSIZE:
 287       src->block_size = g_value_get_ulong (value);
 288       g_object_notify (G_OBJECT (src), "blocksize");
 289       break;
 290     case ARG_OFFSET:
 291       src->curoffset = g_value_get_int64 (value);
 292       g_object_notify (G_OBJECT (src), "offset");
 293       break;
 294     case ARG_MAPSIZE:
 295       if ((src->mapsize % src->pagesize) == 0) {
 296         src->mapsize = g_value_get_ulong (value);
 297         g_object_notify (G_OBJECT (src), "mmapsize");
 298       } else {
 299         GST_INFO(0, "invalid mapsize, must a multiple of pagesize, which is %d\n",src->pagesize);
 300       }
 301       break;
 302     case ARG_TOUCH:
 303       src->touch = g_value_get_boolean (value);
 304       g_object_notify (G_OBJECT (src), "touch");
 305       break;
 306     default:
 307       break;
 308   }
 309 }
 310
 311 static void
 312 gst_filesrc_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
 313 {
 314   GstFileSrc *src;
 315
 316   /* it's not null if we got it, but it might not be ours */
 317   g_return_if_fail (GST_IS_FILESRC (object));
 318
 319   src = GST_FILESRC (object);
 320
 321   switch (prop_id) {
 322     case ARG_LOCATION:
 323       g_value_set_string (value, src->filename);
 324       break;
 325     case ARG_FILESIZE:
 326       g_value_set_int64 (value, src->filelen);
 327       break;
 328     case ARG_FD:
 329       g_value_set_int (value, src->fd);
 330       break;
 331     case ARG_BLOCKSIZE:
 332       g_value_set_ulong (value, src->block_size);
 333       break;
 334     case ARG_OFFSET:
 335       g_value_set_int64 (value, src->curoffset);
 336       break;
 337     case ARG_MAPSIZE:
 338       g_value_set_ulong (value, src->mapsize);
 339       break;
 340     case ARG_TOUCH:
 341       g_value_set_boolean (value, src->touch);
 342       break;
 343     default:
 344       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 345       break;
 346   }
 347 }
 348
 349 static void
 350 gst_filesrc_free_parent_mmap (GstBuffer *buf)
 351 {
 352   GstFileSrc *src = GST_FILESRC(GST_BUFFER_POOL_PRIVATE(buf));
 353
 354   fs_print ("freeing mmap()d buffer at %d+%d\n",GST_BUFFER_OFFSET(buf),GST_BUFFER_SIZE(buf));
 355
 356   /* remove the buffer from the list of available mmap'd regions */
 357   g_mutex_lock(src->map_regions_lock);
 358   g_tree_remove(src->map_regions,buf);
 359   /* check to see if the tree is empty */
 360   if (g_tree_nnodes(src->map_regions) == 0) {
 361     /* we have to free the bufferpool we don't have yet */
 362   }
 363   g_mutex_unlock(src->map_regions_lock);
 364
 365 #ifdef MADV_DONTNEED
 366   /* madvise to tell the kernel what to do with it */
 367   madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_DONTNEED);
 368 #endif
 369   /* now unmap the memory */
 370   munmap(GST_BUFFER_DATA(buf),GST_BUFFER_MAXSIZE(buf));
 371
 372   GST_BUFFER_DATA (buf) = NULL;
 373
 374   gst_buffer_default_free (buf);
 375 }
 376
 377 static GstBuffer *
 378 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
 379 {
 380   GstBuffer *buf;
 381   gint retval;
 382
 383   g_return_val_if_fail (offset >= 0, NULL);
 384
 385   fs_print  ("mapping region %08llx+%08x from file into memory\n",offset,size);
 386
 387   /* time to allocate a new mapbuf */
 388   buf = gst_buffer_new();
 389   /* mmap() the data into this new buffer */
 390   GST_BUFFER_DATA(buf) = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
 391   if (GST_BUFFER_DATA(buf) == NULL) {
 392     gst_element_error (GST_ELEMENT (src), "couldn't map file");
 393   } else if (GST_BUFFER_DATA(buf) == MAP_FAILED) {
 394     gst_element_error (GST_ELEMENT (src), "mmap (0x%x, %d, 0x%llx) : %s",
 395              size, src->fd, offset, strerror (errno));
 396   }
 397 #ifdef MADV_SEQUENTIAL
 398   /* madvise to tell the kernel what to do with it */
 399   retval = madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_SEQUENTIAL);
 400 #endif
 401   /* fill in the rest of the fields */
 402   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_READONLY);
 403   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_ORIGINAL);
 404   GST_BUFFER_SIZE(buf) = size;
 405   GST_BUFFER_MAXSIZE(buf) = size;
 406   GST_BUFFER_OFFSET(buf) = offset;
 407   GST_BUFFER_TIMESTAMP(buf) = -1LL;
 408   GST_BUFFER_POOL_PRIVATE(buf) = src;
 409   GST_BUFFER_FREE_FUNC(buf) = (GstDataFreeFunction) gst_filesrc_free_parent_mmap;
 410
 411   g_mutex_lock(src->map_regions_lock);
 412   g_tree_insert(src->map_regions,buf,buf);
 413   g_mutex_unlock(src->map_regions_lock);
 414
 415   return buf;
 416 }
 417
 418 static GstBuffer *
 419 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
 420 {
 421   size_t mapsize;
 422   off_t mod, mapbase;
 423   GstBuffer *map;
 424
 425 /*  printf("attempting to map a small buffer at %d+%d\n",offset,size); */
 426
 427   /* if the offset starts at a non-page boundary, we have to special case */
 428   if ((mod = offset % src->pagesize)) {
 429     GstBuffer *ret;
 430
 431     mapbase = offset - mod;
 432     mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
 433 /*    printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
 434     map = gst_filesrc_map_region(src, mapbase, mapsize);
 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         /* subbuffer it */
 593         buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - nextmap, readsize);
 594       }
 595     }
 596   }
 597
 598   /* if we need to touch the buffer (to bring it into memory), do so */
 599   if (src->touch) {
 600     volatile guchar *p = GST_BUFFER_DATA (buf), c;
 601     for (i=0;i<GST_BUFFER_SIZE(buf);i+=src->pagesize)
 602       c = p[i];
 603   }
 604
 605   /* we're done, return the buffer */
 606   src->curoffset += GST_BUFFER_SIZE(buf);
 607   g_object_notify (G_OBJECT (src), "offset");
 608   return buf;
 609 }
 610
 611 /* open the file and mmap it, necessary to go to READY state */
 612 static gboolean
 613 gst_filesrc_open_file (GstFileSrc *src)
 614 {
 615   g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
 616
 617   GST_DEBUG(0, "opening file %s",src->filename);
 618
 619   /* open the file */
 620   src->fd = open (src->filename, O_RDONLY);
 621   if (src->fd < 0) {
 622     gst_element_error (GST_ELEMENT (src), "opening file \"%s\" (%s)",
 623                        src->filename, strerror (errno), NULL);
 624     return FALSE;
 625   } else {
 626     /* check if it is a regular file, otherwise bail out */
 627     struct stat stat_results;
 628
 629     fstat(src->fd, &stat_results);
 630
 631     if (!S_ISREG(stat_results.st_mode)) {
 632       gst_element_error (GST_ELEMENT (src), "opening file \"%s\" failed. it isn't a regular file",
 633                                         src->filename, NULL);
 634       close(src->fd);
 635       return FALSE;
 636     }
 637
 638     /* find the file length */
 639     src->filelen = lseek (src->fd, 0, SEEK_END);
 640     lseek (src->fd, 0, SEEK_SET);
 641
 642     /* allocate the first mmap'd region */
 643     src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
 644
 645     src->curoffset = 0;
 646
 647     /* now notify of the changes */
 648     g_object_freeze_notify (G_OBJECT (src));
 649     g_object_notify (G_OBJECT (src), "filesize");
 650     g_object_notify (G_OBJECT (src), "offset");
 651     g_object_thaw_notify (G_OBJECT (src));
 652
 653     GST_FLAG_SET (src, GST_FILESRC_OPEN);
 654   }
 655   return TRUE;
 656 }
 657
 658 /* unmap and close the file */
 659 static void
 660 gst_filesrc_close_file (GstFileSrc *src)
 661 {
 662   g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
 663
 664   /* close the file */
 665   close (src->fd);
 666
 667   /* zero out a lot of our state */
 668   src->fd = 0;
 669   src->filelen = 0;
 670   src->curoffset = 0;
 671   /* and notify that things changed */
 672   g_object_freeze_notify (G_OBJECT (src));
 673   g_object_notify (G_OBJECT (src), "filesize");
 674   g_object_notify (G_OBJECT (src), "offset");
 675   g_object_thaw_notify (G_OBJECT (src));
 676
 677   if (src->mapbuf)
 678     gst_buffer_unref (src->mapbuf);
 679
 680   GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
 681 }
 682
 683
 684 static GstElementStateReturn
 685 gst_filesrc_change_state (GstElement *element)
 686 {
 687   GstFileSrc *src = GST_FILESRC(element);
 688
 689   switch (GST_STATE_TRANSITION (element)) {
 690     case GST_STATE_NULL_TO_READY:
 691       break;
 692     case GST_STATE_READY_TO_NULL:
 693       break;
 694     case GST_STATE_READY_TO_PAUSED:
 695       if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
 696         if (!gst_filesrc_open_file (GST_FILESRC (element)))
 697           return GST_STATE_FAILURE;
 698       }
 699       break;
 700     case GST_STATE_PAUSED_TO_READY:
 701       if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
 702         gst_filesrc_close_file (GST_FILESRC (element));
 703       src->seek_happened = TRUE;
 704       break;
 705     default:
 706       break;
 707   }
 708
 709   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 710     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 711
 712   return GST_STATE_SUCCESS;
 713 }
 714
 715 static const GstFormat*
 716 gst_filesrc_get_formats (GstPad *pad)
 717 {
 718   static const GstFormat gst_filesrc_formats[] = {
 719     GST_FORMAT_BYTES,
 720     0
 721   };
 722
 723   return gst_filesrc_formats;
 724 }
 725
 726 static gboolean
 727 gst_filesrc_srcpad_query (GstPad *pad, GstPadQueryType type,
 728                           GstFormat *format, gint64 *value)
 729 {
 730   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 731
 732   switch (type) {
 733     case GST_PAD_QUERY_TOTAL:
 734       if (*format != GST_FORMAT_BYTES) {
 735         return FALSE;
 736       }
 737       *value = src->filelen;
 738       break;
 739     case GST_PAD_QUERY_POSITION:
 740       if (*format != GST_FORMAT_BYTES) {
 741         return FALSE;
 742       }
 743       *value = src->curoffset;
 744       break;
 745     default:
 746       return FALSE;
 747       break;
 748   }
 749   return TRUE;
 750 }
 751
 752 static gboolean
 753 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
 754 {
 755   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 756
 757   GST_DEBUG(0, "event %d", GST_EVENT_TYPE (event));
 758
 759   switch (GST_EVENT_TYPE (event)) {
 760     case GST_EVENT_SEEK:
 761     {
 762       guint64 offset;
 763
 764       if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
 765         goto error;
 766       }
 767
 768       offset = GST_EVENT_SEEK_OFFSET (event);
 769
 770       switch (GST_EVENT_SEEK_METHOD (event)) {
 771         case GST_SEEK_METHOD_SET:
 772           if (offset > src->filelen)
 773             goto error;
 774           src->curoffset = offset;
 775           GST_DEBUG(0, "seek set pending to %lld", src->curoffset);
 776           break;
 777         case GST_SEEK_METHOD_CUR:
 778           if (offset + src->curoffset > src->filelen)
 779             goto error;
 780           src->curoffset += offset;
 781           GST_DEBUG(0, "seek cur pending to %lld", src->curoffset);
 782           break;
 783         case GST_SEEK_METHOD_END:
 784           if (ABS (offset) > src->filelen)
 785             goto error;
 786           src->curoffset = src->filelen - ABS (offset);
 787           GST_DEBUG(0, "seek end pending to %lld", src->curoffset);
 788           break;
 789         default:
 790           goto error;
 791           break;
 792       }
 793       g_object_notify (G_OBJECT (src), "offset");
 794       src->seek_happened = TRUE;
 795       src->need_flush = GST_EVENT_SEEK_FLAGS(event) & GST_SEEK_FLAG_FLUSH;
 796       break;
 797     }
 798     case GST_EVENT_SIZE:
 799       if (GST_EVENT_SIZE_FORMAT (event) != GST_FORMAT_BYTES) {
 800         goto error;
 801       }
 802       src->block_size = GST_EVENT_SIZE_VALUE (event);
 803       g_object_notify (G_OBJECT (src), "blocksize");
 804       break;
 805     case GST_EVENT_FLUSH:
 806       src->need_flush = TRUE;
 807       break;
 808     default:
 809       goto error;
 810       break;
 811   }
 812   gst_event_unref (event);
 813   return TRUE;
 814
 815 error:
 816   gst_event_unref (event);
 817   return FALSE;
 818 }