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