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