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
 342 static GstBuffer *
 343 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
 344 {
 345   GstBuffer *buf;
 346   gint retval;
 347
 348   g_return_val_if_fail (offset >= 0, NULL);
 349
 350   fs_print  ("mapping region %08lx+%08lx from file into memory\n",offset,size);
 351
 352   /* time to allocate a new mapbuf */
 353   buf = gst_buffer_new();
 354   /* mmap() the data into this new buffer */
 355   GST_BUFFER_DATA(buf) = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
 356   if (GST_BUFFER_DATA(buf) == NULL) {
 357     gst_element_error (GST_ELEMENT (src), "couldn't map file");
 358   } else if (GST_BUFFER_DATA(buf) == MAP_FAILED) {
 359     gst_element_error (GST_ELEMENT (src), "mmap (0x%x, %d, 0x%llx) : %s",
 360              size, src->fd, offset, strerror (errno));
 361   }
 362 #ifdef MADV_SEQUENTIAL
 363   /* madvise to tell the kernel what to do with it */
 364   retval = madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_SEQUENTIAL);
 365 #endif
 366   /* fill in the rest of the fields */
 367   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_READONLY);
 368   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_ORIGINAL);
 369   GST_BUFFER_SIZE(buf) = size;
 370   GST_BUFFER_MAXSIZE(buf) = size;
 371   GST_BUFFER_OFFSET(buf) = offset;
 372   GST_BUFFER_TIMESTAMP(buf) = -1LL;
 373   GST_BUFFER_POOL_PRIVATE(buf) = src;
 374   GST_BUFFER_FREE_FUNC(buf) = gst_filesrc_free_parent_mmap;
 375
 376   g_mutex_lock(src->map_regions_lock);
 377   g_tree_insert(src->map_regions,buf,buf);
 378   g_mutex_unlock(src->map_regions_lock);
 379
 380   return buf;
 381 }
 382
 383 static GstBuffer *
 384 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
 385 {
 386   size_t mapsize;
 387   off_t mod, mapbase;
 388   GstBuffer *map;
 389
 390 /*  printf("attempting to map a small buffer at %d+%d\n",offset,size); */
 391
 392   /* if the offset starts at a non-page boundary, we have to special case */
 393   if ((mod = offset % src->pagesize)) {
 394     GstBuffer *ret;
 395
 396     mapbase = offset - mod;
 397     mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
 398 /*    printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
 399     map = gst_filesrc_map_region(src, mapbase, mapsize);
 400     ret = gst_buffer_create_sub (map, offset - mapbase, size);
 401
 402     gst_buffer_unref (map);
 403
 404     return ret;
 405   }
 406
 407   return gst_filesrc_map_region(src,offset,size);
 408 }
 409
 410 typedef struct {
 411   off_t offset;
 412   off_t size;
 413 } GstFileSrcRegion;
 414
 415 /* This allows us to search for a potential mmap region. */
 416 static gint
 417 gst_filesrc_search_region_match (gpointer a, gpointer b)
 418 {
 419   GstFileSrcRegion *r = (GstFileSrcRegion *)b;
 420
 421   /* trying to walk b down the tree, current node is a */
 422   if (r->offset < GST_BUFFER_OFFSET(a)) return -1;
 423   else if (r->offset >= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 1;
 424   else if ((r->offset + r->size) <= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 0;
 425
 426   return -2;
 427 }
 428
 429 /**
 430  * gst_filesrc_get:
 431  * @pad: #GstPad to push a buffer from
 432  *
 433  * Push a new buffer from the filesrc at the current offset.
 434  */
 435 static GstBuffer *
 436 gst_filesrc_get (GstPad *pad)
 437 {
 438   GstFileSrc *src;
 439   GstBuffer *buf = NULL, *map;
 440   size_t readsize;
 441   off_t readend,mapstart,mapend;
 442   GstFileSrcRegion region;
 443   int i;
 444
 445   g_return_val_if_fail (pad != NULL, NULL);
 446   src = GST_FILESRC (gst_pad_get_parent (pad));
 447   g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
 448
 449   /* check for seek */
 450   if (src->seek_happened) {
 451     GstEvent *event;
 452
 453     src->seek_happened = FALSE;
 454     GST_DEBUG (GST_CAT_EVENT, "filesrc sending discont\n");
 455     event = gst_event_new_discontinuous (FALSE, GST_FORMAT_BYTES, src->curoffset, NULL);
 456     GST_EVENT_DISCONT_FLUSH (event) = src->need_flush;
 457     src->need_flush = FALSE;
 458     return GST_BUFFER (event);
 459   }
 460   /* check for flush */
 461   if (src->need_flush) {
 462     src->need_flush = FALSE;
 463     GST_DEBUG (GST_CAT_EVENT, "filesrc sending flush\n");
 464     return GST_BUFFER (gst_event_new_flush ());
 465   }
 466
 467   /* check for EOF */
 468   if (src->curoffset == src->filelen) {
 469     GST_DEBUG (0, "filesrc eos %lld %lld\n", src->curoffset, src->filelen);
 470     gst_element_set_eos (GST_ELEMENT (src));
 471     return GST_BUFFER (gst_event_new (GST_EVENT_EOS));
 472   }
 473
 474   /* calculate end pointers so we don't have to do so repeatedly later */
 475   readsize = src->block_size;
 476   readend = src->curoffset + src->block_size;           /* note this is the byte *after* the read */
 477   mapstart = GST_BUFFER_OFFSET(src->mapbuf);
 478   mapend = mapstart + GST_BUFFER_SIZE(src->mapbuf);     /* note this is the byte *after* the map */
 479
 480   /* check to see if we're going to overflow the end of the file */
 481   if (readend > src->filelen) {
 482     readsize = src->filelen - src->curoffset;
 483     readend = src->curoffset;
 484   }
 485
 486   /* if the start is past the mapstart */
 487   if (src->curoffset >= mapstart) {
 488     /* if the end is before the mapend, the buffer is in current mmap region... */
 489     /* ('cause by definition if readend is in the buffer, so's readstart) */
 490     if (readend <= mapend) {
 491       fs_print ("read buf %d+%d lives in current mapbuf %d+%d, creating subbuffer of mapbuf\n",
 492              src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
 493       buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - GST_BUFFER_OFFSET(src->mapbuf),
 494                                    readsize);
 495
 496     /* if the start actually is within the current mmap region, map an overlap buffer */
 497     } else if (src->curoffset < mapend) {
 498       fs_print ("read buf %d+%d starts in mapbuf %d+%d but ends outside, creating new mmap\n",
 499              src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
 500       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 501     }
 502
 503     /* the only other option is that buffer is totally outside, which means we search for it */
 504
 505   /* now we can assume that the start is *before* the current mmap region */
 506   /* if the readend is past mapstart, we have two options */
 507   } else if (readend >= mapstart) {
 508     /* either the read buffer overlaps the start of the mmap region */
 509     /* or the read buffer fully contains the current mmap region    */
 510     /* either way, it's really not relevant, we just create a new region anyway*/
 511     fs_print ("read buf %d+%d starts before mapbuf %d+%d, but overlaps it\n",
 512              src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
 513     buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 514   }
 515
 516   /* then deal with the case where the read buffer is totally outside */
 517   if (buf == NULL) {
 518     /* first check to see if there's a map that covers the right region already */
 519     fs_print ("searching for mapbuf to cover %d+%d\n",src->curoffset,readsize);
 520     region.offset = src->curoffset;
 521     region.size = readsize;
 522     map = g_tree_search (src->map_regions,
 523                          (GCompareFunc) gst_filesrc_search_region_match,
 524                          (gpointer)&region);
 525
 526     /* if we found an exact match, subbuffer it */
 527     if (map != NULL) {
 528       fs_print ("found mapbuf at %d+%d, creating subbuffer\n",GST_BUFFER_OFFSET(map),GST_BUFFER_SIZE(map));
 529       buf = gst_buffer_create_sub (map, src->curoffset - GST_BUFFER_OFFSET(map), readsize);
 530
 531     /* otherwise we need to create something out of thin air */
 532     } else {
 533       /* if the read buffer crosses a mmap region boundary, create a one-off region */
 534       if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
 535         fs_print ("read buf %d+%d crosses a %d-byte boundary, creating a one-off\n",
 536                src->curoffset,readsize,src->mapsize);
 537         buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 538
 539       /* otherwise we will create a new mmap region and set it to the default */
 540       } else {
 541         off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
 542         fs_print ("read buf %d+%d in new mapbuf at %d+%d, mapping and subbuffering\n",
 543                src->curoffset,readsize,nextmap,src->mapsize);
 544         /* first, we're done with the old mapbuf */
 545         gst_buffer_unref(src->mapbuf);
 546         /* create a new one */
 547         src->mapbuf = gst_filesrc_map_region (src, nextmap, src->mapsize);
 548         /* subbuffer it */
 549         buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - GST_BUFFER_OFFSET(src->mapbuf), readsize);
 550       }
 551     }
 552   }
 553
 554   /* if we need to touch the buffer (to bring it into memory), do so */
 555   if (src->touch) {
 556     volatile guchar *p = GST_BUFFER_DATA (buf), c;
 557     for (i=0;i<GST_BUFFER_SIZE(buf);i+=src->pagesize)
 558       c = p[i];
 559   }
 560
 561   /* we're done, return the buffer */
 562   src->curoffset += GST_BUFFER_SIZE(buf);
 563   g_object_notify (G_OBJECT (src), "offset");
 564   return buf;
 565 }
 566
 567 /* open the file and mmap it, necessary to go to READY state */
 568 static gboolean
 569 gst_filesrc_open_file (GstFileSrc *src)
 570 {
 571   g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
 572
 573   GST_DEBUG(0, "opening file %s",src->filename);
 574
 575   /* open the file */
 576   src->fd = open (src->filename, O_RDONLY);
 577   if (src->fd < 0) {
 578     gst_element_error (GST_ELEMENT (src), "opening file \"%s\" (%s)",
 579                        src->filename, strerror (errno), NULL);
 580     return FALSE;
 581   } else {
 582     /* check if it is a regular file, otherwise bail out */
 583     struct stat stat_results;
 584
 585     fstat(src->fd, &stat_results);
 586
 587     if (!S_ISREG(stat_results.st_mode)) {
 588       gst_element_error (GST_ELEMENT (src), "opening file \"%s\" failed. it isn't a regular file",
 589                                         src->filename, NULL);
 590       close(src->fd);
 591       return FALSE;
 592     }
 593
 594     /* find the file length */
 595     src->filelen = lseek (src->fd, 0, SEEK_END);
 596     lseek (src->fd, 0, SEEK_SET);
 597
 598     /* allocate the first mmap'd region */
 599     src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
 600
 601     src->curoffset = 0;
 602
 603     /* now notify of the changes */
 604     g_object_freeze_notify (G_OBJECT (src));
 605     g_object_notify (G_OBJECT (src), "filesize");
 606     g_object_notify (G_OBJECT (src), "offset");
 607     g_object_thaw_notify (G_OBJECT (src));
 608
 609     GST_FLAG_SET (src, GST_FILESRC_OPEN);
 610   }
 611   return TRUE;
 612 }
 613
 614 /* unmap and close the file */
 615 static void
 616 gst_filesrc_close_file (GstFileSrc *src)
 617 {
 618   g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
 619
 620   /* close the file */
 621   close (src->fd);
 622
 623   /* zero out a lot of our state */
 624   src->fd = 0;
 625   src->filelen = 0;
 626   src->curoffset = 0;
 627   /* and notify that things changed */
 628   g_object_freeze_notify (G_OBJECT (src));
 629   g_object_notify (G_OBJECT (src), "filesize");
 630   g_object_notify (G_OBJECT (src), "offset");
 631   g_object_thaw_notify (G_OBJECT (src));
 632
 633   if (src->mapbuf)
 634     gst_buffer_unref (src->mapbuf);
 635
 636   GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
 637 }
 638
 639
 640 static GstElementStateReturn
 641 gst_filesrc_change_state (GstElement *element)
 642 {
 643   GstFileSrc *src = GST_FILESRC(element);
 644
 645   switch (GST_STATE_TRANSITION (element)) {
 646     case GST_STATE_NULL_TO_READY:
 647       if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
 648         if (!gst_filesrc_open_file (GST_FILESRC (element)))
 649           return GST_STATE_FAILURE;
 650       }
 651       break;
 652     case GST_STATE_READY_TO_NULL:
 653       if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
 654         gst_filesrc_close_file (GST_FILESRC (element));
 655       break;
 656     case GST_STATE_READY_TO_PAUSED:
 657     case GST_STATE_PAUSED_TO_READY:
 658       src->curoffset = 0;
 659       src->seek_happened = TRUE;
 660     default:
 661       break;
 662   }
 663
 664   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 665     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 666
 667   return GST_STATE_SUCCESS;
 668 }
 669
 670 static gboolean
 671 gst_filesrc_srcpad_query (GstPad *pad, GstPadQueryType type,
 672                           GstFormat *format, gint64 *value)
 673 {
 674   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 675
 676   switch (type) {
 677     case GST_PAD_QUERY_TOTAL:
 678       if (*format != GST_FORMAT_BYTES) {
 679         return FALSE;
 680       }
 681       *value = src->filelen;
 682       break;
 683     case GST_PAD_QUERY_POSITION:
 684       if (*format != GST_FORMAT_BYTES) {
 685         return FALSE;
 686       }
 687       *value = src->curoffset;
 688       break;
 689     default:
 690       return FALSE;
 691       break;
 692   }
 693   return TRUE;
 694 }
 695
 696 static gboolean
 697 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
 698 {
 699   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 700
 701   GST_DEBUG(0, "event %d", GST_EVENT_TYPE (event));
 702
 703   switch (GST_EVENT_TYPE (event)) {
 704     case GST_EVENT_SEEK:
 705       if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
 706         return FALSE;
 707       }
 708       switch (GST_EVENT_SEEK_METHOD (event)) {
 709         case GST_SEEK_METHOD_SET:
 710           src->curoffset = (guint64) GST_EVENT_SEEK_OFFSET (event);
 711           GST_DEBUG(0, "seek set pending to %lld", src->curoffset);
 712           break;
 713         case GST_SEEK_METHOD_CUR:
 714           src->curoffset += GST_EVENT_SEEK_OFFSET (event);
 715           GST_DEBUG(0, "seek cur pending to %lld", src->curoffset);
 716           break;
 717         case GST_SEEK_METHOD_END:
 718           src->curoffset = src->filelen - ABS (GST_EVENT_SEEK_OFFSET (event));
 719           GST_DEBUG(0, "seek end pending to %lld", src->curoffset);
 720           break;
 721         default:
 722           return FALSE;
 723           break;
 724       }
 725       g_object_notify (G_OBJECT (src), "offset");
 726       src->seek_happened = TRUE;
 727       src->need_flush = GST_EVENT_SEEK_FLAGS(event) & GST_SEEK_FLAG_FLUSH;
 728       break;
 729     case GST_EVENT_FLUSH:
 730       src->need_flush = TRUE;
 731       break;
 732     default:
 733       return FALSE;
 734       break;
 735   }
 736
 737   return TRUE;
 738 }