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