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