2 * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3 * 2000 Wim Taymans <wtay@chello.be>
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.
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.
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.
25 #include "gstfilesrc.h"
36 /**********************************************************************
37 * GStreamer Default File Source
40 * This source uses mmap(2) to efficiently load data from a file.
41 * To do this without seriously polluting the applications' memory
42 * space, it must do so in smaller chunks, say 1-4MB at a time.
43 * Buffers are then subdivided from these mmap'd chunks, to directly
44 * make use of the mmap.
46 * To handle refcounting so that the mmap can be freed at the appropriate
47 * time, a buffer will be created for each mmap'd region, and all new
48 * buffers will be sub-buffers of this top-level buffer. As they are
49 * freed, the refcount goes down on the mmap'd buffer and its free()
50 * function is called, which will call munmap(2) on itself.
52 * If a buffer happens to cross the boundaries of an mmap'd region, we
53 * have to decide whether it's more efficient to copy the data into a
54 * new buffer, or mmap() just that buffer. There will have to be a
55 * breakpoint size to determine which will be done. The mmap() size
56 * has a lot to do with this as well, because you end up in double-
57 * jeopardy: the larger the outgoing buffer, the more data to copy when
58 * it overlaps, *and* the more frequently you'll have buffers that *do*
61 * Seeking is another tricky aspect to do efficiently. The initial
62 * implementation of this source won't make use of these features, however.
63 * The issue is that if an application seeks backwards in a file, *and*
64 * that region of the file is covered by an mmap that hasn't been fully
65 * deallocated, we really should re-use it. But keeping track of these
66 * regions is tricky because we have to lock the structure that holds
67 * them. We need to settle on a locking primitive (GMutex seems to be
68 * a really good option...), then we can do that.
72 GstElementDetails gst_filesrc_details = {
75 "Read from arbitrary point in a file",
77 "Erik Walthinsen <omega@cse.ogi.edu>",
81 /*#define fs_print(format,args...) g_print(format, ## args) */
82 #define fs_print(format,args...)
84 /* FileSrc signals and args */
102 static void gst_filesrc_class_init (GstFileSrcClass *klass);
103 static void gst_filesrc_init (GstFileSrc *filesrc);
104 static void gst_filesrc_dispose (GObject *object);
106 static void gst_filesrc_set_property (GObject *object, guint prop_id,
107 const GValue *value, GParamSpec *pspec);
108 static void gst_filesrc_get_property (GObject *object, guint prop_id,
109 GValue *value, GParamSpec *pspec);
111 static GstBuffer * gst_filesrc_get (GstPad *pad);
112 static gboolean gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event);
114 static GstElementStateReturn gst_filesrc_change_state (GstElement *element);
117 static GstElementClass *parent_class = NULL;
118 /*static guint gst_filesrc_signals[LAST_SIGNAL] = { 0 };*/
121 gst_filesrc_get_type(void)
123 static GType filesrc_type = 0;
126 static const GTypeInfo filesrc_info = {
127 sizeof(GstFileSrcClass), NULL,
129 (GClassInitFunc)gst_filesrc_class_init,
134 (GInstanceInitFunc)gst_filesrc_init,
136 filesrc_type = g_type_register_static (GST_TYPE_ELEMENT, "GstFileSrc", &filesrc_info, 0);
142 gst_filesrc_class_init (GstFileSrcClass *klass)
144 GObjectClass *gobject_class;
145 GstElementClass *gstelement_class;
147 gobject_class = (GObjectClass*)klass;
148 gstelement_class = (GstElementClass*)klass;
150 parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
152 gst_element_class_install_std_props (
153 GST_ELEMENT_CLASS (klass),
154 "fd", ARG_FD, G_PARAM_READABLE,
155 "offset", ARG_OFFSET, G_PARAM_READWRITE,
156 "filesize", ARG_FILESIZE, G_PARAM_READABLE,
157 "location", ARG_LOCATION, G_PARAM_READWRITE,
158 "blocksize", ARG_BLOCKSIZE, G_PARAM_READWRITE,
159 "mmapsize", ARG_MAPSIZE, G_PARAM_READWRITE,
160 "touch", ARG_TOUCH, G_PARAM_READWRITE,
163 gobject_class->dispose = gst_filesrc_dispose;
164 gobject_class->set_property = gst_filesrc_set_property;
165 gobject_class->get_property = gst_filesrc_get_property;
167 gstelement_class->change_state = gst_filesrc_change_state;
171 gst_filesrc_bufcmp (gconstpointer a, gconstpointer b)
173 /* GstBuffer *bufa = (GstBuffer *)a, *bufb = (GstBuffer *)b;*/
175 /* sort first by offset, then in reverse by size */
176 if (GST_BUFFER_OFFSET(a) < GST_BUFFER_OFFSET(b)) return -1;
177 else if (GST_BUFFER_OFFSET(a) > GST_BUFFER_OFFSET(b)) return 1;
178 else if (GST_BUFFER_SIZE(a) > GST_BUFFER_SIZE(b)) return -1;
179 else if (GST_BUFFER_SIZE(a) < GST_BUFFER_SIZE(b)) return 1;
184 gst_filesrc_init (GstFileSrc *src)
186 src->srcpad = gst_pad_new ("src", GST_PAD_SRC);
187 gst_pad_set_get_function (src->srcpad,gst_filesrc_get);
188 gst_pad_set_event_function (src->srcpad,gst_filesrc_srcpad_event);
189 gst_element_add_pad (GST_ELEMENT (src), src->srcpad);
191 src->pagesize = getpagesize();
193 src->filename = NULL;
198 src->block_size = 4096;
202 src->mapsize = 4 * 1024 * 1024; /* default is 4MB */
204 src->map_regions = g_tree_new(gst_filesrc_bufcmp);
205 src->map_regions_lock = g_mutex_new();
207 src->seek_happened = FALSE;
211 gst_filesrc_dispose (GObject *object)
215 src = GST_FILESRC (object);
217 G_OBJECT_CLASS (parent_class)->dispose (object);
219 g_tree_destroy (src->map_regions);
220 g_mutex_free (src->map_regions_lock);
222 g_free (src->filename);
227 gst_filesrc_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
231 /* it's not null if we got it, but it might not be ours */
232 g_return_if_fail (GST_IS_FILESRC (object));
234 src = GST_FILESRC (object);
238 /* the element must be stopped in order to do this */
239 g_return_if_fail (GST_STATE (src) < GST_STATE_PLAYING);
241 if (src->filename) g_free (src->filename);
242 /* clear the filename if we get a NULL (is that possible?) */
243 if (g_value_get_string (value) == NULL) {
244 gst_element_set_state (GST_ELEMENT (object), GST_STATE_NULL);
245 src->filename = NULL;
246 /* otherwise set the new filename */
248 src->filename = g_strdup (g_value_get_string (value));
250 g_object_notify (G_OBJECT (src), "location");
253 src->block_size = g_value_get_ulong (value);
254 g_object_notify (G_OBJECT (src), "blocksize");
257 src->curoffset = g_value_get_int64 (value);
258 g_object_notify (G_OBJECT (src), "offset");
261 if ((src->mapsize % src->pagesize) == 0)
263 src->mapsize = g_value_get_ulong (value);
264 g_object_notify (G_OBJECT (src), "mmapsize");
267 GST_INFO(0, "invalid mapsize, must a multiple of pagesize, which is %d\n",src->pagesize);
270 src->touch = g_value_get_boolean (value);
271 g_object_notify (G_OBJECT (src), "touch");
279 gst_filesrc_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
283 /* it's not null if we got it, but it might not be ours */
284 g_return_if_fail (GST_IS_FILESRC (object));
286 src = GST_FILESRC (object);
290 g_value_set_string (value, src->filename);
293 g_value_set_int64 (value, src->filelen);
296 g_value_set_int (value, src->fd);
299 g_value_set_ulong (value, src->block_size);
302 g_value_set_int64 (value, src->curoffset);
305 g_value_set_ulong (value, src->mapsize);
308 g_value_set_boolean (value, src->touch);
311 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
317 gst_filesrc_free_parent_mmap (GstBuffer *buf)
319 GstFileSrc *src = GST_FILESRC(GST_BUFFER_POOL_PRIVATE(buf));
321 fs_print ("freeing mmap()d buffer at %d+%d\n",GST_BUFFER_OFFSET(buf),GST_BUFFER_SIZE(buf));
323 /* remove the buffer from the list of available mmap'd regions */
324 g_mutex_lock(src->map_regions_lock);
325 g_tree_remove(src->map_regions,buf);
326 /* check to see if the tree is empty */
327 if (g_tree_nnodes(src->map_regions) == 0) {
328 /* we have to free the bufferpool we don't have yet */
330 g_mutex_unlock(src->map_regions_lock);
333 /* madvise to tell the kernel what to do with it */
334 madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_DONTNEED);
336 /* now unmap the memory */
337 munmap(GST_BUFFER_DATA(buf),GST_BUFFER_MAXSIZE(buf));
341 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
346 g_return_val_if_fail (offset >= 0, NULL);
348 fs_print ("mapping region %08lx+%08lx from file into memory\n",offset,size);
350 /* time to allocate a new mapbuf */
351 buf = gst_buffer_new();
352 /* mmap() the data into this new buffer */
353 GST_BUFFER_DATA(buf) = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
354 if (GST_BUFFER_DATA(buf) == NULL) {
355 gst_element_error (GST_ELEMENT (src), "couldn't map file");
356 } else if (GST_BUFFER_DATA(buf) == MAP_FAILED) {
357 gst_element_error (GST_ELEMENT (src), "mmap (0x%x, %d, 0x%llx) : %s",
358 size, src->fd, offset, strerror (errno));
360 #ifdef MADV_SEQUENTIAL
361 /* madvise to tell the kernel what to do with it */
362 retval = madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_SEQUENTIAL);
364 /* fill in the rest of the fields */
365 GST_BUFFER_FLAG_SET(buf) = GST_BUFFER_READONLY;
366 GST_BUFFER_FLAG_SET(buf) = GST_BUFFER_ORIGINAL;
367 GST_BUFFER_SIZE(buf) = size;
368 GST_BUFFER_MAXSIZE(buf) = size;
369 GST_BUFFER_OFFSET(buf) = offset;
370 GST_BUFFER_TIMESTAMP(buf) = -1LL;
371 GST_BUFFER_POOL_PRIVATE(buf) = src;
372 GST_BUFFER_FREE_FUNC(buf) = gst_filesrc_free_parent_mmap;
374 g_mutex_lock(src->map_regions_lock);
375 g_tree_insert(src->map_regions,buf,buf);
376 g_mutex_unlock(src->map_regions_lock);
382 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
388 /* printf("attempting to map a small buffer at %d+%d\n",offset,size); */
390 /* if the offset starts at a non-page boundary, we have to special case */
391 if ((mod = offset % src->pagesize)) {
394 mapbase = offset - mod;
395 mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
396 /* printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
397 map = gst_filesrc_map_region(src, mapbase, mapsize);
398 ret = gst_buffer_create_sub (map, offset - mapbase, size);
400 gst_buffer_unref (map);
405 return gst_filesrc_map_region(src,offset,size);
413 /* This allows us to search for a potential mmap region. */
415 gst_filesrc_search_region_match (gpointer a, gpointer b)
417 GstFileSrcRegion *r = (GstFileSrcRegion *)b;
419 /* trying to walk b down the tree, current node is a */
420 if (r->offset < GST_BUFFER_OFFSET(a)) return -1;
421 else if (r->offset >= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 1;
422 else if ((r->offset + r->size) <= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 0;
429 * @pad: #GstPad to push a buffer from
431 * Push a new buffer from the filesrc at the current offset.
434 gst_filesrc_get (GstPad *pad)
437 GstBuffer *buf = NULL, *map;
439 off_t readend,mapstart,mapend;
440 GstFileSrcRegion region;
443 g_return_val_if_fail (pad != NULL, NULL);
444 src = GST_FILESRC (gst_pad_get_parent (pad));
445 g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
448 if (src->seek_happened) {
449 src->seek_happened = FALSE;
450 return GST_BUFFER (gst_event_new (GST_EVENT_DISCONTINUOUS));
452 /* check for flush */
453 if (src->need_flush) {
454 src->need_flush = FALSE;
455 return GST_BUFFER (gst_event_new_flush ());
459 if (src->curoffset == src->filelen) {
460 gst_element_set_eos (GST_ELEMENT (src));
461 return GST_BUFFER (gst_event_new (GST_EVENT_EOS));
464 /* calculate end pointers so we don't have to do so repeatedly later */
465 readsize = src->block_size;
466 readend = src->curoffset + src->block_size; /* note this is the byte *after* the read */
467 mapstart = GST_BUFFER_OFFSET(src->mapbuf);
468 mapend = mapstart + GST_BUFFER_SIZE(src->mapbuf); /* note this is the byte *after* the map */
470 /* check to see if we're going to overflow the end of the file */
471 if (readend > src->filelen) {
472 readsize = src->filelen - src->curoffset;
473 readend = src->curoffset;
476 /* if the start is past the mapstart */
477 if (src->curoffset >= mapstart) {
478 /* if the end is before the mapend, the buffer is in current mmap region... */
479 /* ('cause by definition if readend is in the buffer, so's readstart) */
480 if (readend <= mapend) {
481 fs_print ("read buf %d+%d lives in current mapbuf %d+%d, creating subbuffer of mapbuf\n",
482 src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
483 buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - GST_BUFFER_OFFSET(src->mapbuf),
486 /* if the start actually is within the current mmap region, map an overlap buffer */
487 } else if (src->curoffset < mapend) {
488 fs_print ("read buf %d+%d starts in mapbuf %d+%d but ends outside, creating new mmap\n",
489 src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
490 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
493 /* the only other option is that buffer is totally outside, which means we search for it */
495 /* now we can assume that the start is *before* the current mmap region */
496 /* if the readend is past mapstart, we have two options */
497 } else if (readend >= mapstart) {
498 /* either the read buffer overlaps the start of the mmap region */
499 /* or the read buffer fully contains the current mmap region */
500 /* either way, it's really not relevant, we just create a new region anyway*/
501 fs_print ("read buf %d+%d starts before mapbuf %d+%d, but overlaps it\n",
502 src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
503 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
506 /* then deal with the case where the read buffer is totally outside */
508 /* first check to see if there's a map that covers the right region already */
509 fs_print ("searching for mapbuf to cover %d+%d\n",src->curoffset,readsize);
510 region.offset = src->curoffset;
511 region.size = readsize;
512 map = g_tree_search (src->map_regions,
513 (GCompareFunc) gst_filesrc_search_region_match,
516 /* if we found an exact match, subbuffer it */
518 fs_print ("found mapbuf at %d+%d, creating subbuffer\n",GST_BUFFER_OFFSET(map),GST_BUFFER_SIZE(map));
519 buf = gst_buffer_create_sub (map, src->curoffset - GST_BUFFER_OFFSET(map), readsize);
521 /* otherwise we need to create something out of thin air */
523 /* if the read buffer crosses a mmap region boundary, create a one-off region */
524 if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
525 fs_print ("read buf %d+%d crosses a %d-byte boundary, creating a one-off\n",
526 src->curoffset,readsize,src->mapsize);
527 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
529 /* otherwise we will create a new mmap region and set it to the default */
531 off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
532 fs_print ("read buf %d+%d in new mapbuf at %d+%d, mapping and subbuffering\n",
533 src->curoffset,readsize,nextmap,src->mapsize);
534 /* first, we're done with the old mapbuf */
535 gst_buffer_unref(src->mapbuf);
536 /* create a new one */
537 src->mapbuf = gst_filesrc_map_region (src, nextmap, src->mapsize);
539 buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - GST_BUFFER_OFFSET(src->mapbuf), readsize);
544 /* if we need to touch the buffer (to bring it into memory), do so */
546 volatile guchar *p = GST_BUFFER_DATA (buf), c;
547 for (i=0;i<GST_BUFFER_SIZE(buf);i+=src->pagesize)
551 /* we're done, return the buffer */
552 src->curoffset += GST_BUFFER_SIZE(buf);
553 g_object_notify (G_OBJECT (src), "offset");
557 /* open the file and mmap it, necessary to go to READY state */
559 gst_filesrc_open_file (GstFileSrc *src)
561 g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
563 GST_DEBUG(0, "opening file %s",src->filename);
566 src->fd = open (src->filename, O_RDONLY);
568 gst_element_error (GST_ELEMENT (src), "opening file \"%s\" (%s)",
569 src->filename, strerror (errno), NULL);
572 /* check if it is a regular file, otherwise bail out */
573 struct stat stat_results;
574 fstat(src->fd, &stat_results);
575 if (!S_ISREG(stat_results.st_mode)) {
576 gst_element_error (GST_ELEMENT (src), "opening file \"%s\" failed. it isn't a regular file",
577 src->filename, NULL);
582 /* find the file length */
583 src->filelen = lseek (src->fd, 0, SEEK_END);
584 lseek (src->fd, 0, SEEK_SET);
586 /* allocate the first mmap'd region */
587 src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
591 /* now notify of the changes */
592 g_object_freeze_notify (G_OBJECT (src));
593 g_object_notify (G_OBJECT (src), "filesize");
594 g_object_notify (G_OBJECT (src), "offset");
595 g_object_thaw_notify (G_OBJECT (src));
597 GST_FLAG_SET (src, GST_FILESRC_OPEN);
602 /* unmap and close the file */
604 gst_filesrc_close_file (GstFileSrc *src)
606 g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
611 /* zero out a lot of our state */
615 /* and notify that things changed */
616 g_object_freeze_notify (G_OBJECT (src));
617 g_object_notify (G_OBJECT (src), "filesize");
618 g_object_notify (G_OBJECT (src), "offset");
619 g_object_thaw_notify (G_OBJECT (src));
622 gst_buffer_unref (src->mapbuf);
624 GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
628 static GstElementStateReturn
629 gst_filesrc_change_state (GstElement *element)
631 GstFileSrc *src = GST_FILESRC(element);
633 switch (GST_STATE_TRANSITION (element)) {
634 case GST_STATE_NULL_TO_READY:
635 if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
636 if (!gst_filesrc_open_file (GST_FILESRC (element)))
637 return GST_STATE_FAILURE;
640 case GST_STATE_READY_TO_NULL:
641 if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
642 gst_filesrc_close_file (GST_FILESRC (element));
644 case GST_STATE_READY_TO_PAUSED:
645 case GST_STATE_PAUSED_TO_READY:
651 if (GST_ELEMENT_CLASS (parent_class)->change_state)
652 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
654 return GST_STATE_SUCCESS;
658 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
660 GstFileSrc *src = GST_FILESRC(GST_PAD_PARENT(pad));
662 switch (GST_EVENT_TYPE (event)) {
664 switch (GST_EVENT_SEEK_TYPE (event)) {
665 case GST_SEEK_BYTEOFFSET_SET:
666 src->curoffset = (guint64) GST_EVENT_SEEK_OFFSET (event);
668 case GST_SEEK_BYTEOFFSET_CUR:
669 src->curoffset += GST_EVENT_SEEK_OFFSET (event);
671 case GST_SEEK_BYTEOFFSET_END:
672 src->curoffset = src->filelen - ABS (GST_EVENT_SEEK_OFFSET (event));
678 g_object_notify (G_OBJECT (src), "offset");
679 src->seek_happened = TRUE;
680 src->need_flush = GST_EVENT_SEEK_FLUSH(event);
681 gst_event_free (event);
682 /* push a discontinuous event? */
684 case GST_EVENT_FLUSH:
685 src->need_flush = TRUE;