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 #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 #ifdef HAVE_MMAP
 234   src->pagesize = getpagesize ();
 235 #endif
 236
 237   src->filename = NULL;
 238   src->fd = 0;
 239   src->filelen = 0;
 240   src->uri = NULL;
 241
 242   src->curoffset = 0;
 243   src->block_size = DEFAULT_BLOCKSIZE;
 244   src->touch = FALSE;
 245
 246   src->mapbuf = NULL;
 247   src->mapsize = DEFAULT_MMAPSIZE;      /* default is 4MB */
 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       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 326       break;
 327   }
 328 }
 329
 330 static void
 331 gst_filesrc_get_property (GObject * object, guint prop_id, GValue * value,
 332     GParamSpec * pspec)
 333 {
 334   GstFileSrc *src;
 335
 336   /* it's not null if we got it, but it might not be ours */
 337   g_return_if_fail (GST_IS_FILESRC (object));
 338
 339   src = GST_FILESRC (object);
 340
 341   switch (prop_id) {
 342     case ARG_LOCATION:
 343       g_value_set_string (value, src->filename);
 344       break;
 345     case ARG_FD:
 346       g_value_set_int (value, src->fd);
 347       break;
 348     case ARG_BLOCKSIZE:
 349       g_value_set_ulong (value, src->block_size);
 350       break;
 351     case ARG_MMAPSIZE:
 352       g_value_set_ulong (value, src->mapsize);
 353       break;
 354     case ARG_TOUCH:
 355       g_value_set_boolean (value, src->touch);
 356       break;
 357     default:
 358       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
 359       break;
 360   }
 361 }
 362
 363 #ifdef HAVE_MMAP
 364 static void
 365 gst_filesrc_free_parent_mmap (GstBuffer * buf)
 366 {
 367   GST_LOG ("freeing mmap()d buffer at %" G_GUINT64_FORMAT "+%u",
 368       GST_BUFFER_OFFSET (buf), GST_BUFFER_SIZE (buf));
 369
 370 #ifdef MADV_DONTNEED
 371   /* madvise to tell the kernel what to do with it */
 372   madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_DONTNEED);
 373 #endif
 374   /* now unmap the memory */
 375   munmap (GST_BUFFER_DATA (buf), GST_BUFFER_MAXSIZE (buf));
 376   /* cast to unsigned long, since there's no gportable way to print
 377    * guint64 as hex */
 378   GST_LOG ("unmapped region %08lx+%08lx at %p",
 379       (unsigned long) GST_BUFFER_OFFSET (buf),
 380       (unsigned long) GST_BUFFER_MAXSIZE (buf), GST_BUFFER_DATA (buf));
 381
 382   GST_BUFFER_DATA (buf) = NULL;
 383 }
 384 #endif
 385
 386 #ifdef HAVE_MMAP
 387 static GstBuffer *
 388 gst_filesrc_map_region (GstFileSrc * src, off_t offset, size_t size)
 389 {
 390   GstBuffer *buf;
 391   gint retval;
 392   void *mmapregion;
 393
 394   g_return_val_if_fail (offset >= 0, NULL);
 395
 396   GST_LOG_OBJECT (src, "mapping region %08llx+%08lx from file into memory",
 397       offset, (unsigned long) size);
 398   mmapregion = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
 399
 400   if (mmapregion == NULL) {
 401     GST_ELEMENT_ERROR (src, RESOURCE, TOO_LAZY, (NULL), ("mmap call failed."));
 402     return NULL;
 403   } else if (mmapregion == MAP_FAILED) {
 404     GST_WARNING_OBJECT (src, "mmap (0x%08lx, %d, 0x%llx) failed: %s",
 405         (unsigned long) size, src->fd, offset, strerror (errno));
 406     return NULL;
 407   }
 408   GST_LOG_OBJECT (src, "mapped region %08lx+%08lx from file into memory at %p",
 409       (unsigned long) offset, (unsigned long) size, mmapregion);
 410
 411   /* time to allocate a new mapbuf */
 412   buf = gst_buffer_new ();
 413   /* mmap() the data into this new buffer */
 414   GST_BUFFER_DATA (buf) = mmapregion;
 415
 416 #ifdef MADV_SEQUENTIAL
 417   /* madvise to tell the kernel what to do with it */
 418   retval =
 419       madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_SEQUENTIAL);
 420 #endif
 421   /* fill in the rest of the fields */
 422   GST_BUFFER_FLAG_SET (buf, GST_BUFFER_READONLY);
 423   GST_BUFFER_FLAG_SET (buf, GST_BUFFER_ORIGINAL);
 424   GST_BUFFER_SIZE (buf) = size;
 425   GST_BUFFER_MAXSIZE (buf) = size;
 426   GST_BUFFER_OFFSET (buf) = offset;
 427   GST_BUFFER_OFFSET_END (buf) = offset + size;
 428   GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
 429   GST_BUFFER_PRIVATE (buf) = src;
 430   GST_BUFFER_FREE_DATA_FUNC (buf) = gst_filesrc_free_parent_mmap;
 431
 432   return buf;
 433 }
 434 #endif
 435
 436 #ifdef HAVE_MMAP
 437 static GstBuffer *
 438 gst_filesrc_map_small_region (GstFileSrc * src, off_t offset, size_t size)
 439 {
 440   size_t mapsize;
 441   off_t mod, mapbase;
 442   GstBuffer *map;
 443
 444 /*  printf("attempting to map a small buffer at %d+%d\n",offset,size); */
 445
 446   /* if the offset starts at a non-page boundary, we have to special case */
 447   if ((mod = offset % src->pagesize)) {
 448     GstBuffer *ret;
 449
 450     mapbase = offset - mod;
 451     mapsize =
 452         ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
 453 /*    printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
 454     map = gst_filesrc_map_region (src, mapbase, mapsize);
 455     if (map == NULL)
 456       return NULL;
 457
 458     ret = gst_buffer_create_sub (map, offset - mapbase, size);
 459     GST_BUFFER_OFFSET (ret) = GST_BUFFER_OFFSET (map) + offset - mapbase;
 460
 461     gst_buffer_unref (map);
 462
 463     return ret;
 464   }
 465
 466   return gst_filesrc_map_region (src, offset, size);
 467 }
 468 #endif
 469
 470 #ifdef HAVE_MMAP
 471 /**
 472  * gst_filesrc_get_mmap:
 473  * @pad: #GstPad to push a buffer from
 474  *
 475  * Push a new buffer from the filesrc at the current offset.
 476  */
 477 static GstBuffer *
 478 gst_filesrc_get_mmap (GstFileSrc * src)
 479 {
 480   GstBuffer *buf = NULL;
 481   size_t readsize, mapsize;
 482   off_t readend, mapstart, mapend;
 483   int i;
 484
 485   /* calculate end pointers so we don't have to do so repeatedly later */
 486   readsize = src->block_size;
 487   readend = src->curoffset + src->block_size;   /* note this is the byte *after* the read */
 488   mapstart = GST_BUFFER_OFFSET (src->mapbuf);
 489   mapsize = GST_BUFFER_SIZE (src->mapbuf);
 490   mapend = mapstart + mapsize;  /* note this is the byte *after* the map */
 491
 492   /* check to see if we're going to overflow the end of the file */
 493   if (readend > src->filelen) {
 494     if (!gst_filesrc_check_filesize (src) || readend > src->filelen) {
 495       readsize = src->filelen - src->curoffset;
 496       readend = src->curoffset + readsize;
 497     }
 498   }
 499
 500   GST_LOG ("attempting to read %08lx, %08lx, %08lx, %08lx",
 501       (unsigned long) readsize, (unsigned long) readend,
 502       (unsigned long) mapstart, (unsigned long) mapend);
 503
 504   /* if the start is past the mapstart */
 505   if (src->curoffset >= mapstart) {
 506     /* if the end is before the mapend, the buffer is in current mmap region... */
 507     /* ('cause by definition if readend is in the buffer, so's readstart) */
 508     if (readend <= mapend) {
 509       GST_LOG_OBJECT (src,
 510           "read buf %llu+%d lives in current mapbuf %lld+%d, creating subbuffer of mapbuf",
 511           src->curoffset, (int) readsize, mapstart, mapsize);
 512       buf =
 513           gst_buffer_create_sub (src->mapbuf, src->curoffset - mapstart,
 514           readsize);
 515       GST_BUFFER_OFFSET (buf) = src->curoffset;
 516
 517       /* if the start actually is within the current mmap region, map an overlap buffer */
 518     } else if (src->curoffset < mapend) {
 519       GST_LOG_OBJECT (src,
 520           "read buf %llu+%d starts in mapbuf %d+%d but ends outside, creating new mmap",
 521           (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart,
 522           (gint) mapsize);
 523       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 524       if (buf == NULL)
 525         return NULL;
 526     }
 527
 528     /* the only other option is that buffer is totally outside, which means we search for it */
 529
 530     /* now we can assume that the start is *before* the current mmap region */
 531     /* if the readend is past mapstart, we have two options */
 532   } else if (readend >= mapstart) {
 533     /* either the read buffer overlaps the start of the mmap region */
 534     /* or the read buffer fully contains the current mmap region    */
 535     /* either way, it's really not relevant, we just create a new region anyway */
 536     GST_LOG_OBJECT (src,
 537         "read buf %llu+%d starts before mapbuf %d+%d, but overlaps it",
 538         (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart,
 539         (gint) mapsize);
 540     buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 541     if (buf == NULL)
 542       return NULL;
 543   }
 544
 545   /* then deal with the case where the read buffer is totally outside */
 546   if (buf == NULL) {
 547     /* first check to see if there's a map that covers the right region already */
 548     GST_LOG_OBJECT (src, "searching for mapbuf to cover %llu+%d",
 549         src->curoffset, (int) readsize);
 550
 551     /* if the read buffer crosses a mmap region boundary, create a one-off region */
 552     if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
 553       GST_LOG_OBJECT (src,
 554           "read buf %llu+%d crosses a %d-byte boundary, creating a one-off",
 555           src->curoffset, (int) readsize, (int) src->mapsize);
 556       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
 557       if (buf == NULL)
 558         return NULL;
 559
 560       /* otherwise we will create a new mmap region and set it to the default */
 561     } else {
 562       size_t mapsize;
 563
 564       off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
 565
 566       GST_LOG_OBJECT (src,
 567           "read buf %llu+%d in new mapbuf at %llu+%d, mapping and subbuffering",
 568           src->curoffset, readsize, nextmap, src->mapsize);
 569       /* first, we're done with the old mapbuf */
 570       gst_buffer_unref (src->mapbuf);
 571       mapsize = src->mapsize;
 572
 573       /* double the mapsize as long as the readsize is smaller */
 574       while (readsize - (src->curoffset - nextmap) > mapsize) {
 575         GST_LOG_OBJECT (src, "readsize smaller then mapsize %08x %d",
 576             readsize, (int) mapsize);
 577         mapsize <<= 1;
 578       }
 579       /* create a new one */
 580       src->mapbuf = gst_filesrc_map_region (src, nextmap, mapsize);
 581       if (src->mapbuf == NULL)
 582         return NULL;
 583
 584       /* subbuffer it */
 585       buf =
 586           gst_buffer_create_sub (src->mapbuf, src->curoffset - nextmap,
 587           readsize);
 588       GST_BUFFER_OFFSET (buf) =
 589           GST_BUFFER_OFFSET (src->mapbuf) + src->curoffset - nextmap;
 590     }
 591   }
 592
 593   /* if we need to touch the buffer (to bring it into memory), do so */
 594   if (src->touch) {
 595     volatile guchar *p = GST_BUFFER_DATA (buf), c;
 596
 597     for (i = 0; i < GST_BUFFER_SIZE (buf); i += src->pagesize)
 598       c = p[i];
 599   }
 600
 601   /* we're done, return the buffer */
 602   g_assert (src->curoffset == GST_BUFFER_OFFSET (buf));
 603   src->curoffset += GST_BUFFER_SIZE (buf);
 604   return buf;
 605 }
 606 #endif
 607
 608 static GstBuffer *
 609 gst_filesrc_get_read (GstFileSrc * src)
 610 {
 611   GstBuffer *buf = NULL;
 612   size_t readsize;
 613   int ret;
 614
 615   readsize = src->block_size;
 616   if (src->curoffset + readsize > src->filelen) {
 617     if (!gst_filesrc_check_filesize (src)
 618         || src->curoffset + readsize > src->filelen) {
 619       readsize = src->filelen - src->curoffset;
 620     }
 621   }
 622
 623   buf = gst_buffer_new_and_alloc (readsize);
 624   g_return_val_if_fail (buf != NULL, NULL);
 625
 626   ret = read (src->fd, GST_BUFFER_DATA (buf), readsize);
 627   if (ret < 0) {
 628     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
 629     return NULL;
 630   }
 631   if (ret < readsize) {
 632     GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL),
 633         ("unexpected end of file."));
 634     return NULL;
 635   }
 636
 637   GST_BUFFER_SIZE (buf) = readsize;
 638   GST_BUFFER_MAXSIZE (buf) = readsize;
 639   GST_BUFFER_OFFSET (buf) = src->curoffset;
 640   GST_BUFFER_OFFSET_END (buf) = src->curoffset + readsize;
 641   src->curoffset += readsize;
 642
 643   return buf;
 644 }
 645
 646 static GstData *
 647 gst_filesrc_get (GstPad * pad)
 648 {
 649   GstFileSrc *src;
 650
 651   g_return_val_if_fail (pad != NULL, NULL);
 652   src = GST_FILESRC (gst_pad_get_parent (pad));
 653   g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
 654
 655   /* check for flush */
 656   if (src->need_flush) {
 657     src->need_flush = FALSE;
 658     GST_DEBUG_OBJECT (src, "sending flush");
 659     return GST_DATA (gst_event_new_flush ());
 660   }
 661   /* check for seek */
 662   if (src->need_discont) {
 663     GstEvent *event;
 664
 665     src->need_discont = FALSE;
 666     GST_DEBUG_OBJECT (src, "sending discont");
 667     event =
 668         gst_event_new_discontinuous (FALSE, GST_FORMAT_BYTES, src->curoffset,
 669         NULL);
 670     return GST_DATA (event);
 671   }
 672
 673   /* check for EOF */
 674   g_assert (src->curoffset <= src->filelen);
 675   if (src->curoffset == src->filelen) {
 676     if (!gst_filesrc_check_filesize (src) || src->curoffset >= src->filelen) {
 677       GST_DEBUG_OBJECT (src, "eos %" G_GINT64_FORMAT " %" G_GINT64_FORMAT,
 678           src->curoffset, src->filelen);
 679       gst_element_set_eos (GST_ELEMENT (src));
 680       return GST_DATA (gst_event_new (GST_EVENT_EOS));
 681     }
 682   }
 683 #ifdef HAVE_MMAP
 684   if (src->using_mmap) {
 685     return GST_DATA (gst_filesrc_get_mmap (src));
 686   } else {
 687     return GST_DATA (gst_filesrc_get_read (src));
 688   }
 689 #else
 690   return GST_DATA (gst_filesrc_get_read (src));
 691 #endif
 692 }
 693
 694 /* TRUE if the filesize of the file was updated */
 695 static gboolean
 696 gst_filesrc_check_filesize (GstFileSrc * src)
 697 {
 698   struct stat stat_results;
 699
 700   g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), FALSE);
 701
 702   fstat (src->fd, &stat_results);
 703   GST_DEBUG_OBJECT (src,
 704       "checked filesize on %s (was %" G_GUINT64_FORMAT ", is %" G_GUINT64_FORMAT
 705       ")", src->filename, src->filelen, (guint64) stat_results.st_size);
 706   if (src->filelen == (guint64) stat_results.st_size)
 707     return FALSE;
 708   src->filelen = stat_results.st_size;
 709   return TRUE;
 710 }
 711
 712 /* open the file and mmap it, necessary to go to READY state */
 713 static gboolean
 714 gst_filesrc_open_file (GstFileSrc * src)
 715 {
 716   g_return_val_if_fail (!GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), FALSE);
 717
 718   if (src->filename == NULL || src->filename[0] == '\0') {
 719     GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
 720         (_("No file name specified for reading.")), (NULL));
 721     return FALSE;
 722   }
 723
 724
 725   GST_INFO_OBJECT (src, "opening file %s", src->filename);
 726
 727   /* open the file */
 728   src->fd = open (src->filename, O_RDONLY);
 729   if (src->fd < 0) {
 730     if (errno == ENOENT)
 731       GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND, (NULL), (NULL));
 732     else
 733       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
 734           (_("Could not open file \"%s\" for reading."), src->filename),
 735           GST_ERROR_SYSTEM);
 736     return FALSE;
 737   } else {
 738     /* check if it is a regular file, otherwise bail out */
 739     struct stat stat_results;
 740
 741     fstat (src->fd, &stat_results);
 742
 743     if (!S_ISREG (stat_results.st_mode)) {
 744       GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
 745           (_("File \"%s\" isn't a regular file."), src->filename), (NULL));
 746       close (src->fd);
 747       return FALSE;
 748     }
 749
 750     /* find the file length */
 751     src->filelen = stat_results.st_size;
 752
 753     src->using_mmap = FALSE;
 754 #ifdef HAVE_MMAP
 755     /* allocate the first mmap'd region */
 756     src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
 757     if (src->mapbuf != NULL) {
 758       src->using_mmap = TRUE;
 759     }
 760 #endif
 761
 762
 763     src->curoffset = 0;
 764
 765     GST_FLAG_SET (src, GST_FILESRC_OPEN);
 766   }
 767   return TRUE;
 768 }
 769
 770 /* unmap and close the file */
 771 static void
 772 gst_filesrc_close_file (GstFileSrc * src)
 773 {
 774   g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
 775
 776   /* close the file */
 777   close (src->fd);
 778
 779   /* zero out a lot of our state */
 780   src->fd = 0;
 781   src->filelen = 0;
 782   src->curoffset = 0;
 783
 784   if (src->mapbuf) {
 785     gst_buffer_unref (src->mapbuf);
 786     src->mapbuf = NULL;
 787   }
 788
 789   GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
 790 }
 791
 792
 793 static GstElementStateReturn
 794 gst_filesrc_change_state (GstElement * element)
 795 {
 796   GstFileSrc *src = GST_FILESRC (element);
 797
 798   switch (GST_STATE_TRANSITION (element)) {
 799     case GST_STATE_NULL_TO_READY:
 800       break;
 801     case GST_STATE_READY_TO_NULL:
 802       break;
 803     case GST_STATE_READY_TO_PAUSED:
 804       if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
 805         if (!gst_filesrc_open_file (GST_FILESRC (element)))
 806           return GST_STATE_FAILURE;
 807       }
 808       src->need_discont = TRUE;
 809       break;
 810     case GST_STATE_PAUSED_TO_READY:
 811       if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
 812         gst_filesrc_close_file (GST_FILESRC (element));
 813       src->need_discont = TRUE;
 814       break;
 815     default:
 816       break;
 817   }
 818
 819   if (GST_ELEMENT_CLASS (parent_class)->change_state)
 820     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
 821
 822   return GST_STATE_SUCCESS;
 823 }
 824
 825 static gboolean
 826 gst_filesrc_srcpad_query (GstPad * pad, GstQueryType type,
 827     GstFormat * format, gint64 * value)
 828 {
 829   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 830
 831   switch (type) {
 832     case GST_QUERY_TOTAL:
 833       if (*format != GST_FORMAT_BYTES) {
 834         return FALSE;
 835       }
 836       gst_filesrc_check_filesize (src);
 837       *value = src->filelen;
 838       break;
 839     case GST_QUERY_POSITION:
 840       switch (*format) {
 841         case GST_FORMAT_BYTES:
 842           *value = src->curoffset;
 843           break;
 844         case GST_FORMAT_PERCENT:
 845           if (src->filelen == 0)
 846             return FALSE;
 847           *value = src->curoffset * GST_FORMAT_PERCENT_MAX / src->filelen;
 848           break;
 849         default:
 850           return FALSE;
 851       }
 852       break;
 853     default:
 854       return FALSE;
 855       break;
 856   }
 857   return TRUE;
 858 }
 859
 860 static gboolean
 861 gst_filesrc_srcpad_event (GstPad * pad, GstEvent * event)
 862 {
 863   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
 864
 865   GST_DEBUG_OBJECT (src, "event %d", GST_EVENT_TYPE (event));
 866
 867   switch (GST_EVENT_TYPE (event)) {
 868     case GST_EVENT_SEEK:
 869     {
 870       gint64 offset;
 871
 872       if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
 873         goto error;
 874       }
 875
 876       offset = GST_EVENT_SEEK_OFFSET (event);
 877
 878       switch (GST_EVENT_SEEK_METHOD (event)) {
 879         case GST_SEEK_METHOD_SET:
 880           if (offset < 0 ||
 881               (offset > src->filelen && (!gst_filesrc_check_filesize (src)
 882                       || offset > src->filelen))) {
 883             goto error;
 884           }
 885           src->curoffset = offset;
 886           GST_DEBUG_OBJECT (src, "seek set pending to %" G_GINT64_FORMAT,
 887               src->curoffset);
 888           break;
 889         case GST_SEEK_METHOD_CUR:
 890           if (offset + src->curoffset > src->filelen)
 891             if (!gst_filesrc_check_filesize (src)
 892                 || offset + src->curoffset > src->filelen)
 893               goto error;
 894           src->curoffset += offset;
 895           GST_DEBUG_OBJECT (src, "seek cur pending to %" G_GINT64_FORMAT,
 896               src->curoffset);
 897           break;
 898         case GST_SEEK_METHOD_END:
 899           if (ABS (offset) > src->filelen) {
 900             if (!gst_filesrc_check_filesize (src)
 901                 || ABS (offset) > src->filelen)
 902               goto error;
 903             goto error;
 904           }
 905           src->curoffset = src->filelen - ABS (offset);
 906           GST_DEBUG_OBJECT (src, "seek end pending to %" G_GINT64_FORMAT,
 907               src->curoffset);
 908           break;
 909         default:
 910           goto error;
 911           break;
 912       }
 913       src->need_discont = TRUE;
 914       src->need_flush = GST_EVENT_SEEK_FLAGS (event) & GST_SEEK_FLAG_FLUSH;
 915       break;
 916     }
 917     case GST_EVENT_SIZE:
 918       if (GST_EVENT_SIZE_FORMAT (event) != GST_FORMAT_BYTES) {
 919         goto error;
 920       }
 921       src->block_size = GST_EVENT_SIZE_VALUE (event);
 922       g_object_notify (G_OBJECT (src), "blocksize");
 923       break;
 924     case GST_EVENT_FLUSH:
 925       src->need_flush = TRUE;
 926       break;
 927     default:
 928       goto error;
 929       break;
 930   }
 931   gst_event_unref (event);
 932   return TRUE;
 933
 934 error:
 935   gst_event_unref (event);
 936   return FALSE;
 937 }
 938
 939 /*** GSTURIHANDLER INTERFACE *************************************************/
 940
 941 static guint
 942 gst_filesrc_uri_get_type (void)
 943 {
 944   return GST_URI_SRC;
 945 }
 946 static gchar **
 947 gst_filesrc_uri_get_protocols (void)
 948 {
 949   static gchar *protocols[] = { "file", NULL };
 950
 951   return protocols;
 952 }
 953 static const gchar *
 954 gst_filesrc_uri_get_uri (GstURIHandler * handler)
 955 {
 956   GstFileSrc *src = GST_FILESRC (handler);
 957
 958   return src->uri;
 959 }
 960
 961 static gboolean
 962 gst_filesrc_uri_set_uri (GstURIHandler * handler, const gchar * uri)
 963 {
 964   gchar *protocol, *location;
 965   gboolean ret;
 966   GstFileSrc *src = GST_FILESRC (handler);
 967
 968   protocol = gst_uri_get_protocol (uri);
 969   if (strcmp (protocol, "file") != 0) {
 970     g_free (protocol);
 971     return FALSE;
 972   }
 973   g_free (protocol);
 974   location = gst_uri_get_location (uri);
 975   ret = gst_filesrc_set_location (src, location);
 976   g_free (location);
 977
 978   return ret;
 979 }
 980
 981 static void
 982 gst_filesrc_uri_handler_init (gpointer g_iface, gpointer iface_data)
 983 {
 984   GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
 985
 986   iface->get_type = gst_filesrc_uri_get_type;
 987   iface->get_protocols = gst_filesrc_uri_get_protocols;
 988   iface->get_uri = gst_filesrc_uri_get_uri;
 989   iface->set_uri = gst_filesrc_uri_set_uri;
 990 }