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.
28 #include "gstfilesrc.h"
38 #include "../gst-i18n-lib.h"
41 /**********************************************************************
42 * GStreamer Default File Source
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.
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.
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*
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.
77 GST_DEBUG_CATEGORY_STATIC (gst_filesrc_debug);
78 #define GST_CAT_DEFAULT gst_filesrc_debug
80 GstElementDetails gst_filesrc_details = GST_ELEMENT_DETAILS (
83 "Read from arbitrary point in a file",
84 "Erik Walthinsen <omega@cse.ogi.edu>"
87 #define DEFAULT_BLOCKSIZE 4*1024
88 #define DEFAULT_MMAPSIZE 4*1024*1024
90 /* FileSrc signals and args */
105 GST_PAD_EVENT_MASK_FUNCTION (gst_filesrc_get_event_mask,
106 { GST_EVENT_SEEK, GST_SEEK_METHOD_CUR |
107 GST_SEEK_METHOD_SET |
108 GST_SEEK_METHOD_END |
109 GST_SEEK_FLAG_FLUSH },
110 { GST_EVENT_FLUSH, 0 },
111 { GST_EVENT_SIZE, 0 }
114 GST_PAD_QUERY_TYPE_FUNCTION (gst_filesrc_get_query_types,
119 GST_PAD_FORMATS_FUNCTION (gst_filesrc_get_formats,
123 static void gst_filesrc_dispose (GObject *object);
125 static void gst_filesrc_set_property (GObject *object, guint prop_id,
126 const GValue *value, GParamSpec *pspec);
127 static void gst_filesrc_get_property (GObject *object, guint prop_id,
128 GValue *value, GParamSpec *pspec);
130 static gboolean gst_filesrc_check_filesize (GstFileSrc *src);
131 static GstData * gst_filesrc_get (GstPad *pad);
132 static gboolean gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event);
133 static gboolean gst_filesrc_srcpad_query (GstPad *pad, GstQueryType type,
134 GstFormat *format, gint64 *value);
136 static GstElementStateReturn gst_filesrc_change_state (GstElement *element);
138 static void gst_filesrc_uri_handler_init (gpointer g_iface, gpointer iface_data);
141 _do_init (GType filesrc_type)
143 static const GInterfaceInfo urihandler_info = {
144 gst_filesrc_uri_handler_init,
148 g_type_add_interface_static (filesrc_type, GST_TYPE_URI_HANDLER, &urihandler_info);
149 GST_DEBUG_CATEGORY_INIT (gst_filesrc_debug, "filesrc", 0, "filesrc element");
152 GST_BOILERPLATE_FULL (GstFileSrc, gst_filesrc, GstElement, GST_TYPE_ELEMENT, _do_init);
155 gst_filesrc_base_init (gpointer g_class)
157 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (g_class);
159 gst_element_class_set_details (gstelement_class, &gst_filesrc_details);
162 gst_filesrc_class_init (GstFileSrcClass *klass)
164 GObjectClass *gobject_class = G_OBJECT_CLASS (klass);
165 GstElementClass *gstelement_class = GST_ELEMENT_CLASS (klass);
167 gobject_class = (GObjectClass*)klass;
170 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_FD,
171 g_param_spec_int ("fd", "File-descriptor", "File-descriptor for the file being mmap()d",
172 0, G_MAXINT, 0, G_PARAM_READABLE));
173 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_LOCATION,
174 g_param_spec_string ("location", "File Location", "Location of the file to read",
175 NULL, G_PARAM_READWRITE));
176 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_BLOCKSIZE,
177 g_param_spec_ulong ("blocksize", "Block size", "Size in bytes to read per buffer",
178 1, G_MAXULONG, DEFAULT_BLOCKSIZE, G_PARAM_READWRITE));
179 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_MMAPSIZE,
180 g_param_spec_ulong ("mmapsize", "mmap() Block Size",
181 "Size in bytes of mmap()d regions",
182 0, G_MAXULONG, DEFAULT_MMAPSIZE, G_PARAM_READWRITE));
183 g_object_class_install_property (G_OBJECT_CLASS (klass), ARG_TOUCH,
184 g_param_spec_boolean ("touch", "Touch read data",
185 "Touch data to force disk read",
186 FALSE, G_PARAM_READWRITE));
188 gobject_class->dispose = gst_filesrc_dispose;
189 gobject_class->set_property = gst_filesrc_set_property;
190 gobject_class->get_property = gst_filesrc_get_property;
192 gstelement_class->change_state = gst_filesrc_change_state;
196 gst_filesrc_bufcmp (gconstpointer a, gconstpointer b)
198 /* GstBuffer *bufa = (GstBuffer *)a, *bufb = (GstBuffer *)b;*/
200 /* sort first by offset, then in reverse by size */
201 if (GST_BUFFER_OFFSET(a) < GST_BUFFER_OFFSET(b)) return -1;
202 else if (GST_BUFFER_OFFSET(a) > GST_BUFFER_OFFSET(b)) return 1;
203 else if (GST_BUFFER_SIZE(a) > GST_BUFFER_SIZE(b)) return -1;
204 else if (GST_BUFFER_SIZE(a) < GST_BUFFER_SIZE(b)) return 1;
209 gst_filesrc_init (GstFileSrc *src)
211 src->srcpad = gst_pad_new ("src", GST_PAD_SRC);
212 gst_pad_set_get_function (src->srcpad, gst_filesrc_get);
213 gst_pad_set_event_function (src->srcpad, gst_filesrc_srcpad_event);
214 gst_pad_set_event_mask_function (src->srcpad, gst_filesrc_get_event_mask);
215 gst_pad_set_query_function (src->srcpad, gst_filesrc_srcpad_query);
216 gst_pad_set_query_type_function (src->srcpad, gst_filesrc_get_query_types);
217 gst_pad_set_formats_function (src->srcpad, gst_filesrc_get_formats);
218 gst_element_add_pad (GST_ELEMENT (src), src->srcpad);
220 src->pagesize = getpagesize();
222 src->filename = NULL;
227 src->block_size = DEFAULT_BLOCKSIZE;
231 src->mapsize = DEFAULT_MMAPSIZE; /* default is 4MB */
233 src->map_regions = g_tree_new (gst_filesrc_bufcmp);
234 src->map_regions_lock = g_mutex_new();
236 src->seek_happened = FALSE;
240 gst_filesrc_dispose (GObject *object)
244 src = GST_FILESRC (object);
246 G_OBJECT_CLASS (parent_class)->dispose (object);
248 g_tree_destroy (src->map_regions);
249 g_mutex_free (src->map_regions_lock);
251 g_free (src->filename);
257 gst_filesrc_set_location (GstFileSrc *src, const gchar *location)
259 /* the element must be stopped in order to do this */
260 if (GST_STATE (src) != GST_STATE_READY &&
261 GST_STATE (src) != GST_STATE_NULL)
264 if (src->filename) g_free (src->filename);
265 if (src->uri) g_free (src->uri);
266 /* clear the filename if we get a NULL (is that possible?) */
267 if (location == NULL) {
268 src->filename = NULL;
271 src->filename = g_strdup (location);
272 src->uri = gst_uri_construct ("file", src->filename);
274 g_object_notify (G_OBJECT (src), "location");
275 gst_uri_handler_new_uri (GST_URI_HANDLER (src), src->uri);
281 gst_filesrc_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
285 /* it's not null if we got it, but it might not be ours */
286 g_return_if_fail (GST_IS_FILESRC (object));
288 src = GST_FILESRC (object);
292 gst_filesrc_set_location (src, g_value_get_string (value));
295 src->block_size = g_value_get_ulong (value);
296 g_object_notify (G_OBJECT (src), "blocksize");
299 if ((src->mapsize % src->pagesize) == 0) {
300 src->mapsize = g_value_get_ulong (value);
301 g_object_notify (G_OBJECT (src), "mmapsize");
303 GST_INFO_OBJECT (src, "invalid mapsize, must be a multiple of pagesize, which is %d",
308 src->touch = g_value_get_boolean (value);
309 g_object_notify (G_OBJECT (src), "touch");
317 gst_filesrc_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
321 /* it's not null if we got it, but it might not be ours */
322 g_return_if_fail (GST_IS_FILESRC (object));
324 src = GST_FILESRC (object);
328 g_value_set_string (value, src->filename);
331 g_value_set_int (value, src->fd);
334 g_value_set_ulong (value, src->block_size);
337 g_value_set_ulong (value, src->mapsize);
340 g_value_set_boolean (value, src->touch);
343 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
349 gst_filesrc_free_parent_mmap (GstBuffer *buf)
351 GstFileSrc *src = GST_FILESRC (GST_BUFFER_PRIVATE (buf));
353 GST_LOG_OBJECT (src, "freeing mmap()d buffer at %"G_GUINT64_FORMAT"+%u",
354 GST_BUFFER_OFFSET (buf), GST_BUFFER_SIZE (buf));
356 /* remove the buffer from the list of available mmap'd regions */
357 g_mutex_lock (src->map_regions_lock);
358 g_tree_remove (src->map_regions, buf);
359 /* check to see if the tree is empty */
360 if (g_tree_nnodes (src->map_regions) == 0) {
361 /* we have to free the bufferpool we don't have yet */
363 g_mutex_unlock (src->map_regions_lock);
366 /* madvise to tell the kernel what to do with it */
367 madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_DONTNEED);
369 /* now unmap the memory */
370 munmap (GST_BUFFER_DATA (buf), GST_BUFFER_MAXSIZE (buf));
371 /* cast to unsigned long, since there's no gportable way to print
373 GST_LOG_OBJECT (src, "unmapped region %08lx+%08lx at %p",
374 (unsigned long) GST_BUFFER_OFFSET (buf),
375 (unsigned long) GST_BUFFER_MAXSIZE (buf),
376 GST_BUFFER_DATA (buf));
378 GST_BUFFER_DATA (buf) = NULL;
380 g_object_unref (src);
381 gst_buffer_default_free (buf);
385 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
391 g_return_val_if_fail (offset >= 0, NULL);
393 GST_LOG_OBJECT (src, "mapping region %08llx+%08lx from file into memory",offset,(unsigned long)size);
394 mmapregion = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
396 if (mmapregion == NULL) {
397 GST_ELEMENT_ERROR (src, RESOURCE, TOO_LAZY, (NULL), ("mmap call failed."));
400 else if (mmapregion == MAP_FAILED) {
401 GST_WARNING_OBJECT (src, "mmap (0x%08lx, %d, 0x%llx) failed: %s",
402 (unsigned long)size, src->fd, offset, strerror (errno));
405 GST_LOG_OBJECT (src, "mapped region %08lx+%08lx from file into memory at %p",
406 (unsigned long)offset, (unsigned long)size, mmapregion);
408 /* time to allocate a new mapbuf */
409 buf = gst_buffer_new ();
410 /* mmap() the data into this new buffer */
411 GST_BUFFER_DATA (buf) = mmapregion;
413 #ifdef MADV_SEQUENTIAL
414 /* madvise to tell the kernel what to do with it */
415 retval = madvise (GST_BUFFER_DATA (buf), GST_BUFFER_SIZE (buf), MADV_SEQUENTIAL);
417 /* fill in the rest of the fields */
418 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_READONLY);
419 GST_BUFFER_FLAG_SET (buf, GST_BUFFER_ORIGINAL);
420 GST_BUFFER_SIZE (buf) = size;
421 GST_BUFFER_MAXSIZE (buf) = size;
422 GST_BUFFER_OFFSET (buf) = offset;
423 GST_BUFFER_TIMESTAMP (buf) = GST_CLOCK_TIME_NONE;
424 GST_BUFFER_PRIVATE (buf) = src;
426 GST_BUFFER_FREE_FUNC (buf) = (GstDataFreeFunction) gst_filesrc_free_parent_mmap;
428 g_mutex_lock (src->map_regions_lock);
429 g_tree_insert (src->map_regions,buf,buf);
430 g_mutex_unlock (src->map_regions_lock);
436 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
442 /* printf("attempting to map a small buffer at %d+%d\n",offset,size); */
444 /* if the offset starts at a non-page boundary, we have to special case */
445 if ((mod = offset % src->pagesize)) {
448 mapbase = offset - mod;
449 mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
450 /* printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
451 map = gst_filesrc_map_region(src, mapbase, mapsize);
455 ret = gst_buffer_create_sub (map, offset - mapbase, size);
456 GST_BUFFER_OFFSET (ret) = GST_BUFFER_OFFSET (map) + offset - mapbase;
458 gst_buffer_unref (map);
463 return gst_filesrc_map_region(src,offset,size);
471 /* This allows us to search for a potential mmap region. */
473 gst_filesrc_search_region_match (gpointer a, gpointer b)
475 GstFileSrcRegion *r = (GstFileSrcRegion *)b;
477 /* trying to walk b down the tree, current node is a */
478 if (r->offset < GST_BUFFER_OFFSET(a)) return -1;
479 else if (r->offset >= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 1;
480 else if ((r->offset + r->size) <= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 0;
486 * gst_filesrc_get_mmap:
487 * @pad: #GstPad to push a buffer from
489 * Push a new buffer from the filesrc at the current offset.
492 gst_filesrc_get_mmap (GstFileSrc *src)
494 GstBuffer *buf = NULL, *map;
495 size_t readsize, mapsize;
496 off_t readend,mapstart,mapend;
497 GstFileSrcRegion region;
500 /* calculate end pointers so we don't have to do so repeatedly later */
501 readsize = src->block_size;
502 readend = src->curoffset + src->block_size; /* note this is the byte *after* the read */
503 mapstart = GST_BUFFER_OFFSET (src->mapbuf);
504 mapsize = GST_BUFFER_SIZE (src->mapbuf);
505 mapend = mapstart + mapsize; /* note this is the byte *after* the map */
507 /* check to see if we're going to overflow the end of the file */
508 if (readend > src->filelen) {
509 if (!gst_filesrc_check_filesize (src) || readend > src->filelen) {
510 readsize = src->filelen - src->curoffset;
511 readend = src->curoffset + readsize;
515 GST_LOG ("attempting to read %08lx, %08lx, %08lx, %08lx",
516 (unsigned long)readsize, (unsigned long)readend,
517 (unsigned long)mapstart, (unsigned long)mapend);
519 /* if the start is past the mapstart */
520 if (src->curoffset >= mapstart) {
521 /* if the end is before the mapend, the buffer is in current mmap region... */
522 /* ('cause by definition if readend is in the buffer, so's readstart) */
523 if (readend <= mapend) {
524 GST_LOG_OBJECT (src, "read buf %llu+%d lives in current mapbuf %lld+%d, creating subbuffer of mapbuf",
525 src->curoffset, readsize, mapstart, mapsize);
526 buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - mapstart,
528 GST_BUFFER_OFFSET (buf) = src->curoffset;
530 /* if the start actually is within the current mmap region, map an overlap buffer */
531 } else if (src->curoffset < mapend) {
532 GST_LOG_OBJECT (src, "read buf %llu+%d starts in mapbuf %d+%d but ends outside, creating new mmap",
533 (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart, (gint) mapsize);
534 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
539 /* the only other option is that buffer is totally outside, which means we search for it */
541 /* now we can assume that the start is *before* the current mmap region */
542 /* if the readend is past mapstart, we have two options */
543 } else if (readend >= mapstart) {
544 /* either the read buffer overlaps the start of the mmap region */
545 /* or the read buffer fully contains the current mmap region */
546 /* either way, it's really not relevant, we just create a new region anyway*/
547 GST_LOG_OBJECT (src, "read buf %llu+%d starts before mapbuf %d+%d, but overlaps it",
548 (unsigned long long) src->curoffset, (gint) readsize, (gint) mapstart, (gint) mapsize);
549 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
554 /* then deal with the case where the read buffer is totally outside */
556 /* first check to see if there's a map that covers the right region already */
557 GST_LOG_OBJECT (src, "searching for mapbuf to cover %llu+%d",src->curoffset,readsize);
558 region.offset = src->curoffset;
559 region.size = readsize;
560 map = g_tree_search (src->map_regions,
561 (GCompareFunc) gst_filesrc_search_region_match,
564 /* if we found an exact match, subbuffer it */
566 GST_LOG_OBJECT (src, "found mapbuf at %"G_GUINT64_FORMAT"+%u, creating subbuffer",
567 GST_BUFFER_OFFSET (map), GST_BUFFER_SIZE (map));
568 buf = gst_buffer_create_sub (map, src->curoffset - GST_BUFFER_OFFSET(map), readsize);
569 GST_BUFFER_OFFSET (buf) = src->curoffset;
571 /* otherwise we need to create something out of thin air */
573 /* if the read buffer crosses a mmap region boundary, create a one-off region */
574 if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
575 GST_LOG_OBJECT (src, "read buf %llu+%d crosses a %d-byte boundary, creating a one-off",
576 src->curoffset,readsize,src->mapsize);
577 buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
581 /* otherwise we will create a new mmap region and set it to the default */
585 off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
586 GST_LOG_OBJECT (src, "read buf %llu+%d in new mapbuf at %llu+%d, mapping and subbuffering",
587 src->curoffset, readsize, nextmap, src->mapsize);
588 /* first, we're done with the old mapbuf */
589 gst_buffer_unref(src->mapbuf);
590 mapsize = src->mapsize;
592 /* double the mapsize as long as the readsize is smaller */
593 while (readsize - (src->curoffset - nextmap) > mapsize) {
594 GST_LOG_OBJECT (src, "readsize smaller then mapsize %08x %d", readsize, mapsize);
597 /* create a new one */
598 src->mapbuf = gst_filesrc_map_region (src, nextmap, mapsize);
599 if (src->mapbuf == NULL)
603 buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - nextmap, readsize);
604 GST_BUFFER_OFFSET (buf) = GST_BUFFER_OFFSET (src->mapbuf) + src->curoffset - nextmap;
609 /* if we need to touch the buffer (to bring it into memory), do so */
611 volatile guchar *p = GST_BUFFER_DATA (buf), c;
613 for (i=0; i < GST_BUFFER_SIZE (buf); i += src->pagesize)
617 /* we're done, return the buffer */
618 g_assert (src->curoffset == GST_BUFFER_OFFSET (buf));
619 src->curoffset += GST_BUFFER_SIZE(buf);
624 gst_filesrc_get_read (GstFileSrc *src)
626 GstBuffer *buf = NULL;
630 readsize = src->block_size;
631 if (src->curoffset + readsize > src->filelen) {
632 if (!gst_filesrc_check_filesize (src) || src->curoffset + readsize > src->filelen) {
633 readsize = src->filelen - src->curoffset;
637 buf = gst_buffer_new_and_alloc (readsize);
638 g_return_val_if_fail (buf != NULL, NULL);
640 ret = read (src->fd, GST_BUFFER_DATA (buf), readsize);
642 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), GST_ERROR_SYSTEM);
645 if (ret < readsize) {
646 GST_ELEMENT_ERROR (src, RESOURCE, READ, (NULL), ("unexpected end of file."));
650 src->curoffset += readsize;
656 gst_filesrc_get (GstPad *pad)
660 g_return_val_if_fail (pad != NULL, NULL);
661 src = GST_FILESRC (gst_pad_get_parent (pad));
662 g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
664 /* check for flush */
665 if (src->need_flush) {
666 src->need_flush = FALSE;
667 GST_DEBUG_OBJECT (src, "sending flush");
668 return GST_DATA (gst_event_new_flush ());
671 if (src->seek_happened) {
674 src->seek_happened = FALSE;
675 GST_DEBUG_OBJECT (src, "sending discont");
676 event = gst_event_new_discontinuous (FALSE, GST_FORMAT_BYTES, src->curoffset, NULL);
677 return GST_DATA (event);
681 g_assert (src->curoffset <= src->filelen);
682 if (src->curoffset == src->filelen) {
683 if (!gst_filesrc_check_filesize (src) || src->curoffset >= src->filelen) {
684 GST_DEBUG_OBJECT (src, "eos %" G_GINT64_FORMAT" %" G_GINT64_FORMAT,
685 src->curoffset, src->filelen);
686 gst_element_set_eos (GST_ELEMENT (src));
687 return GST_DATA (gst_event_new (GST_EVENT_EOS));
691 if (src->using_mmap){
692 return GST_DATA (gst_filesrc_get_mmap (src));
694 return GST_DATA (gst_filesrc_get_read (src));
698 /* TRUE if the filesize of the file was updated */
700 gst_filesrc_check_filesize (GstFileSrc *src)
702 struct stat stat_results;
704 g_return_val_if_fail (GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
706 fstat(src->fd, &stat_results);
707 GST_DEBUG_OBJECT (src, "checked filesize on %s (was %"G_GUINT64_FORMAT", is %"G_GUINT64_FORMAT")",
708 src->filename, src->filelen, (guint64) stat_results.st_size);
709 if (src->filelen == (guint64) stat_results.st_size)
711 src->filelen = stat_results.st_size;
714 /* open the file and mmap it, necessary to go to READY state */
716 gst_filesrc_open_file (GstFileSrc *src)
718 g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
720 if (src->filename == NULL)
722 GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
723 (_("No filename specified.")), (NULL));
727 if (src->filename == NULL)
729 GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND,
730 (_("No file specified for reading.")), (NULL));
735 GST_INFO_OBJECT (src, "opening file %s",src->filename);
738 src->fd = open (src->filename, O_RDONLY);
742 GST_ELEMENT_ERROR (src, RESOURCE, NOT_FOUND, (NULL), (NULL));
744 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
745 (_("Could not open file \"%s\" for reading."), src->filename),
749 /* check if it is a regular file, otherwise bail out */
750 struct stat stat_results;
752 fstat(src->fd, &stat_results);
754 if (!S_ISREG(stat_results.st_mode)) {
755 GST_ELEMENT_ERROR (src, RESOURCE, OPEN_READ,
756 (_("File \"%s\" isn't a regular file."), src->filename),
762 /* find the file length */
763 src->filelen = stat_results.st_size;
765 /* allocate the first mmap'd region */
766 src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
767 if (src->mapbuf == NULL) {
768 src->using_mmap = FALSE;
770 src->using_mmap = TRUE;
775 GST_FLAG_SET (src, GST_FILESRC_OPEN);
780 /* unmap and close the file */
782 gst_filesrc_close_file (GstFileSrc *src)
784 g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
789 /* zero out a lot of our state */
795 gst_buffer_unref (src->mapbuf);
799 GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
803 static GstElementStateReturn
804 gst_filesrc_change_state (GstElement *element)
806 GstFileSrc *src = GST_FILESRC(element);
808 switch (GST_STATE_TRANSITION (element)) {
809 case GST_STATE_NULL_TO_READY:
811 case GST_STATE_READY_TO_NULL:
813 case GST_STATE_READY_TO_PAUSED:
814 if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
815 if (!gst_filesrc_open_file (GST_FILESRC (element)))
816 return GST_STATE_FAILURE;
819 case GST_STATE_PAUSED_TO_READY:
820 if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
821 gst_filesrc_close_file (GST_FILESRC (element));
822 src->seek_happened = TRUE;
828 if (GST_ELEMENT_CLASS (parent_class)->change_state)
829 return GST_ELEMENT_CLASS (parent_class)->change_state (element);
831 return GST_STATE_SUCCESS;
835 gst_filesrc_srcpad_query (GstPad *pad, GstQueryType type,
836 GstFormat *format, gint64 *value)
838 GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
841 case GST_QUERY_TOTAL:
842 if (*format != GST_FORMAT_BYTES) {
845 gst_filesrc_check_filesize (src);
846 *value = src->filelen;
848 case GST_QUERY_POSITION:
850 case GST_FORMAT_BYTES:
851 *value = src->curoffset;
853 case GST_FORMAT_PERCENT:
854 if (src->filelen == 0)
856 *value = src->curoffset * GST_FORMAT_PERCENT_MAX / src->filelen;
870 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
872 GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
874 GST_DEBUG_OBJECT (src, "event %d", GST_EVENT_TYPE (event));
876 switch (GST_EVENT_TYPE (event)) {
881 if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
885 offset = GST_EVENT_SEEK_OFFSET (event);
887 switch (GST_EVENT_SEEK_METHOD (event)) {
888 case GST_SEEK_METHOD_SET:
889 if (offset > src->filelen && (!gst_filesrc_check_filesize (src) || offset > src->filelen)) {
892 src->curoffset = offset;
893 GST_DEBUG_OBJECT (src, "seek set pending to %" G_GINT64_FORMAT, src->curoffset);
895 case GST_SEEK_METHOD_CUR:
896 if (offset + src->curoffset > src->filelen)
897 if (!gst_filesrc_check_filesize (src) || offset + src->curoffset > src->filelen)
899 src->curoffset += offset;
900 GST_DEBUG_OBJECT (src, "seek cur pending to %" G_GINT64_FORMAT, src->curoffset);
902 case GST_SEEK_METHOD_END:
903 if (ABS (offset) > src->filelen) {
904 if (!gst_filesrc_check_filesize (src) || ABS (offset) > src->filelen)
908 src->curoffset = src->filelen - ABS (offset);
909 GST_DEBUG_OBJECT (src, "seek end pending to %" G_GINT64_FORMAT, src->curoffset);
915 src->seek_happened = TRUE;
916 src->need_flush = GST_EVENT_SEEK_FLAGS(event) & GST_SEEK_FLAG_FLUSH;
920 if (GST_EVENT_SIZE_FORMAT (event) != GST_FORMAT_BYTES) {
923 src->block_size = GST_EVENT_SIZE_VALUE (event);
924 g_object_notify (G_OBJECT (src), "blocksize");
926 case GST_EVENT_FLUSH:
927 src->need_flush = TRUE;
933 gst_event_unref (event);
937 gst_event_unref (event);
941 /*** GSTURIHANDLER INTERFACE *************************************************/
944 gst_filesrc_uri_get_type (void)
949 gst_filesrc_uri_get_protocols(void)
951 static gchar *protocols[] = {"file", NULL};
955 gst_filesrc_uri_get_uri (GstURIHandler *handler)
957 GstFileSrc *src = GST_FILESRC (handler);
962 gst_filesrc_uri_set_uri (GstURIHandler *handler, const gchar *uri)
964 gchar *protocol, *location;
966 GstFileSrc *src = GST_FILESRC (handler);
968 protocol = gst_uri_get_protocol (uri);
969 if (strcmp (protocol, "file") != 0) {
974 location = gst_uri_get_location (uri);
975 ret = gst_filesrc_set_location (src, location);
982 gst_filesrc_uri_handler_init (gpointer g_iface, gpointer iface_data)
984 GstURIHandlerInterface *iface = (GstURIHandlerInterface *) g_iface;
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;