plugins/elements/gstfilesrc.c

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