Use fancy macros
[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 #include <gst/gst.h>
24
25 #include "gstfilesrc.h"
26
27 #include <stdio.h>
28 #include <sys/stat.h>
29 #include <fcntl.h>
30 #include <unistd.h>
31 #include <sys/mman.h>
32 #include <errno.h>
33 #include <string.h>
34
35
36 /**********************************************************************
37  * GStreamer Default File Source
38  * Theory of Operation
39  *
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.
45  *
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.
51  *
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*
59  * overlap.
60  *
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.
69  */
70
71
72 GstElementDetails gst_filesrc_details = {
73   "File Source",
74   "Source/File",
75   "Read from arbitrary point in a file",
76   VERSION,
77   "Erik Walthinsen <omega@cse.ogi.edu>",
78   "(C) 1999",
79 };
80
81 /* #define fs_print(format,args...) g_print(format, ## args)  */
82 #define fs_print(format,args...)
83
84 /* FileSrc signals and args */
85 enum {
86   /* FILL ME */
87   LAST_SIGNAL
88 };
89
90 enum {
91   ARG_0,
92   ARG_OFFSET,
93   ARG_LOCATION,
94   ARG_FILESIZE,
95   ARG_FD,
96   ARG_BLOCKSIZE,
97   ARG_MAPSIZE,
98   ARG_TOUCH,
99 };
100
101 GST_EVENT_MASK_FUNCTION (gst_filesrc_get_event_mask,
102   { GST_EVENT_SEEK, GST_SEEK_METHOD_CUR | 
103                     GST_SEEK_METHOD_SET | 
104                     GST_SEEK_METHOD_END | 
105                     GST_SEEK_FLAG_FLUSH },
106   { GST_EVENT_FLUSH, 0 },
107   { GST_EVENT_SIZE, 0 }
108 )
109
110 GST_PAD_QUERY_TYPE_FUNCTION (gst_filesrc_get_query_types,
111   GST_PAD_QUERY_TOTAL,
112   GST_PAD_QUERY_POSITION
113 )
114
115 GST_FORMATS_FUNCTION (gst_filesrc_get_formats,
116   GST_FORMAT_BYTES
117 )
118
119 static void             gst_filesrc_class_init          (GstFileSrcClass *klass);
120 static void             gst_filesrc_init                (GstFileSrc *filesrc);
121 static void             gst_filesrc_dispose             (GObject *object);
122
123 static void             gst_filesrc_set_property        (GObject *object, guint prop_id, 
124                                                          const GValue *value, GParamSpec *pspec);
125 static void             gst_filesrc_get_property        (GObject *object, guint prop_id, 
126                                                          GValue *value, GParamSpec *pspec);
127
128 static GstBuffer *      gst_filesrc_get                 (GstPad *pad);
129 static gboolean         gst_filesrc_srcpad_event        (GstPad *pad, GstEvent *event);
130 static gboolean         gst_filesrc_srcpad_query        (GstPad *pad, GstPadQueryType type,
131                                                          GstFormat *format, gint64 *value);
132
133 static GstElementStateReturn    gst_filesrc_change_state        (GstElement *element);
134
135
136 static GstElementClass *parent_class = NULL;
137 /*static guint gst_filesrc_signals[LAST_SIGNAL] = { 0 };*/
138
139 GType
140 gst_filesrc_get_type(void)
141 {
142   static GType filesrc_type = 0;
143
144   if (!filesrc_type) {
145     static const GTypeInfo filesrc_info = {
146       sizeof(GstFileSrcClass),      NULL,
147       NULL,
148       (GClassInitFunc)gst_filesrc_class_init,
149       NULL,
150       NULL,
151       sizeof(GstFileSrc),
152       0,
153       (GInstanceInitFunc)gst_filesrc_init,
154     };
155     filesrc_type = g_type_register_static (GST_TYPE_ELEMENT, "GstFileSrc", &filesrc_info, 0);
156   }
157   return filesrc_type;
158 }
159
160 static void
161 gst_filesrc_class_init (GstFileSrcClass *klass)
162 {
163   GObjectClass *gobject_class;
164   GstElementClass *gstelement_class;
165
166   gobject_class = (GObjectClass*)klass;
167   gstelement_class = (GstElementClass*)klass;
168
169   parent_class = g_type_class_ref (GST_TYPE_ELEMENT);
170
171   gst_element_class_install_std_props (
172           GST_ELEMENT_CLASS (klass),
173           "fd",           ARG_FD,           G_PARAM_READABLE,
174           "offset",       ARG_OFFSET,       G_PARAM_READWRITE,
175           "filesize",     ARG_FILESIZE,     G_PARAM_READABLE,
176           "location",     ARG_LOCATION,     G_PARAM_READWRITE,
177           "blocksize",    ARG_BLOCKSIZE,    G_PARAM_READWRITE,
178           "mmapsize",     ARG_MAPSIZE,      G_PARAM_READWRITE,
179           "touch",        ARG_TOUCH,        G_PARAM_READWRITE,
180           NULL);
181
182   gobject_class->dispose        = gst_filesrc_dispose;
183   gobject_class->set_property   = gst_filesrc_set_property;
184   gobject_class->get_property   = gst_filesrc_get_property;
185
186   gstelement_class->change_state = gst_filesrc_change_state;
187 }
188
189 static gint
190 gst_filesrc_bufcmp (gconstpointer a, gconstpointer b)
191 {
192 /*  GstBuffer *bufa = (GstBuffer *)a, *bufb = (GstBuffer *)b;*/
193
194   /* sort first by offset, then in reverse by size */
195   if (GST_BUFFER_OFFSET(a) < GST_BUFFER_OFFSET(b)) return -1;
196   else if (GST_BUFFER_OFFSET(a) > GST_BUFFER_OFFSET(b)) return 1;
197   else if (GST_BUFFER_SIZE(a) > GST_BUFFER_SIZE(b)) return -1;
198   else if (GST_BUFFER_SIZE(a) < GST_BUFFER_SIZE(b)) return 1;
199   else return 0;
200 }
201
202 static void
203 gst_filesrc_init (GstFileSrc *src)
204 {
205   src->srcpad = gst_pad_new ("src", GST_PAD_SRC);
206   gst_pad_set_get_function (src->srcpad, gst_filesrc_get);
207   gst_pad_set_event_function (src->srcpad, gst_filesrc_srcpad_event);
208   gst_pad_set_event_mask_function (src->srcpad, gst_filesrc_get_event_mask);
209   gst_pad_set_query_function (src->srcpad, gst_filesrc_srcpad_query);
210   gst_pad_set_query_type_function (src->srcpad, gst_filesrc_get_query_types);
211   gst_pad_set_formats_function (src->srcpad, gst_filesrc_get_formats);
212   gst_element_add_pad (GST_ELEMENT (src), src->srcpad);
213
214   src->pagesize = getpagesize();
215
216   src->filename = NULL;
217   src->fd = 0;
218   src->filelen = 0;
219
220   src->curoffset = 0;
221   src->block_size = 4096;
222   src->touch = TRUE;
223
224   src->mapbuf = NULL;
225   src->mapsize = 4 * 1024 * 1024;               /* default is 4MB */
226
227   src->map_regions = g_tree_new (gst_filesrc_bufcmp);
228   src->map_regions_lock = g_mutex_new();
229
230   src->seek_happened = FALSE;
231 }
232
233 static void
234 gst_filesrc_dispose (GObject *object)
235 {
236   GstFileSrc *src;
237
238   src = GST_FILESRC (object);
239
240   G_OBJECT_CLASS (parent_class)->dispose (object);
241
242   g_tree_destroy (src->map_regions);
243   g_mutex_free (src->map_regions_lock);
244   if (src->filename)
245     g_free (src->filename);
246 }
247
248
249 static void
250 gst_filesrc_set_property (GObject *object, guint prop_id, const GValue *value, GParamSpec *pspec)
251 {
252   GstFileSrc *src;
253
254   /* it's not null if we got it, but it might not be ours */
255   g_return_if_fail (GST_IS_FILESRC (object));
256
257   src = GST_FILESRC (object);
258
259   switch (prop_id) {
260     case ARG_LOCATION:
261       /* the element must be stopped in order to do this */
262       g_return_if_fail (GST_STATE (src) < GST_STATE_PLAYING);
263
264       if (src->filename) g_free (src->filename);
265       /* clear the filename if we get a NULL (is that possible?) */
266       if (g_value_get_string (value) == NULL) {
267         gst_element_set_state (GST_ELEMENT (object), GST_STATE_NULL);
268         src->filename = NULL;
269       /* otherwise set the new filename */
270       } else {
271         src->filename = g_strdup (g_value_get_string (value));
272       }
273       g_object_notify (G_OBJECT (src), "location");
274       break;
275     case ARG_BLOCKSIZE:
276       src->block_size = g_value_get_ulong (value);
277       g_object_notify (G_OBJECT (src), "blocksize");
278       break;
279     case ARG_OFFSET:
280       src->curoffset = g_value_get_int64 (value);
281       g_object_notify (G_OBJECT (src), "offset");
282       break;
283     case ARG_MAPSIZE:
284       if ((src->mapsize % src->pagesize) == 0) {
285         src->mapsize = g_value_get_ulong (value);
286         g_object_notify (G_OBJECT (src), "mmapsize");
287       } else {
288         GST_INFO(0, "invalid mapsize, must a multiple of pagesize, which is %d\n",src->pagesize);
289       }
290       break;
291     case ARG_TOUCH:
292       src->touch = g_value_get_boolean (value);
293       g_object_notify (G_OBJECT (src), "touch");
294       break;
295     default:
296       break;
297   }
298 }
299
300 static void
301 gst_filesrc_get_property (GObject *object, guint prop_id, GValue *value, GParamSpec *pspec)
302 {
303   GstFileSrc *src;
304
305   /* it's not null if we got it, but it might not be ours */
306   g_return_if_fail (GST_IS_FILESRC (object));
307
308   src = GST_FILESRC (object);
309
310   switch (prop_id) {
311     case ARG_LOCATION:
312       g_value_set_string (value, src->filename);
313       break;
314     case ARG_FILESIZE:
315       g_value_set_int64 (value, src->filelen);
316       break;
317     case ARG_FD:
318       g_value_set_int (value, src->fd);
319       break;
320     case ARG_BLOCKSIZE:
321       g_value_set_ulong (value, src->block_size);
322       break;
323     case ARG_OFFSET:
324       g_value_set_int64 (value, src->curoffset);
325       break;
326     case ARG_MAPSIZE:
327       g_value_set_ulong (value, src->mapsize);
328       break;
329     case ARG_TOUCH:
330       g_value_set_boolean (value, src->touch);
331       break;
332     default:
333       G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
334       break;
335   }
336 }
337
338 static void
339 gst_filesrc_free_parent_mmap (GstBuffer *buf)
340 {
341   GstFileSrc *src = GST_FILESRC(GST_BUFFER_POOL_PRIVATE(buf));
342
343   fs_print ("freeing mmap()d buffer at %d+%d\n",GST_BUFFER_OFFSET(buf),GST_BUFFER_SIZE(buf));
344
345   /* remove the buffer from the list of available mmap'd regions */
346   g_mutex_lock(src->map_regions_lock);
347   g_tree_remove(src->map_regions,buf);
348   /* check to see if the tree is empty */
349   if (g_tree_nnodes(src->map_regions) == 0) {
350     /* we have to free the bufferpool we don't have yet */
351   }
352   g_mutex_unlock(src->map_regions_lock);
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
361   GST_BUFFER_DATA (buf) = NULL;
362
363   gst_buffer_default_free (buf);
364 }
365
366 static GstBuffer *
367 gst_filesrc_map_region (GstFileSrc *src, off_t offset, size_t size)
368 {
369   GstBuffer *buf;
370   gint retval;
371
372   g_return_val_if_fail (offset >= 0, NULL);
373
374   fs_print  ("mapping region %08llx+%08x from file into memory\n",offset,size);
375
376   /* time to allocate a new mapbuf */
377   buf = gst_buffer_new();
378   /* mmap() the data into this new buffer */
379   GST_BUFFER_DATA(buf) = mmap (NULL, size, PROT_READ, MAP_SHARED, src->fd, offset);
380   if (GST_BUFFER_DATA(buf) == NULL) {
381     gst_element_error (GST_ELEMENT (src), "couldn't map file");
382   } else if (GST_BUFFER_DATA(buf) == MAP_FAILED) {
383     gst_element_error (GST_ELEMENT (src), "mmap (0x%x, %d, 0x%llx) : %s",
384              size, src->fd, offset, strerror (errno));
385   }
386 #ifdef MADV_SEQUENTIAL
387   /* madvise to tell the kernel what to do with it */
388   retval = madvise(GST_BUFFER_DATA(buf),GST_BUFFER_SIZE(buf),MADV_SEQUENTIAL);
389 #endif
390   /* fill in the rest of the fields */
391   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_READONLY);
392   GST_BUFFER_FLAG_SET(buf, GST_BUFFER_ORIGINAL);
393   GST_BUFFER_SIZE(buf) = size;
394   GST_BUFFER_MAXSIZE(buf) = size;
395   GST_BUFFER_OFFSET(buf) = offset;
396   GST_BUFFER_TIMESTAMP(buf) = -1LL;
397   GST_BUFFER_POOL_PRIVATE(buf) = src;
398   GST_BUFFER_FREE_FUNC(buf) = (GstDataFreeFunction) gst_filesrc_free_parent_mmap;
399
400   g_mutex_lock(src->map_regions_lock);
401   g_tree_insert(src->map_regions,buf,buf);
402   g_mutex_unlock(src->map_regions_lock);
403
404   return buf;
405 }
406
407 static GstBuffer *
408 gst_filesrc_map_small_region (GstFileSrc *src, off_t offset, size_t size)
409 {
410   size_t mapsize;
411   off_t mod, mapbase;
412   GstBuffer *map;
413
414 /*  printf("attempting to map a small buffer at %d+%d\n",offset,size); */
415
416   /* if the offset starts at a non-page boundary, we have to special case */
417   if ((mod = offset % src->pagesize)) {
418     GstBuffer *ret;
419
420     mapbase = offset - mod;
421     mapsize = ((size + mod + src->pagesize - 1) / src->pagesize) * src->pagesize;
422 /*    printf("not on page boundaries, resizing map to %d+%d\n",mapbase,mapsize);*/
423     map = gst_filesrc_map_region(src, mapbase, mapsize);
424     ret = gst_buffer_create_sub (map, offset - mapbase, size);
425
426     gst_buffer_unref (map);
427
428     return ret;
429   }
430
431   return gst_filesrc_map_region(src,offset,size);
432 }
433
434 typedef struct {
435   off_t offset;
436   off_t size;
437 } GstFileSrcRegion;
438
439 /* This allows us to search for a potential mmap region. */
440 static gint
441 gst_filesrc_search_region_match (gpointer a, gpointer b)
442 {
443   GstFileSrcRegion *r = (GstFileSrcRegion *)b;
444
445   /* trying to walk b down the tree, current node is a */
446   if (r->offset < GST_BUFFER_OFFSET(a)) return -1;
447   else if (r->offset >= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 1;
448   else if ((r->offset + r->size) <= (GST_BUFFER_OFFSET(a) + GST_BUFFER_SIZE(a))) return 0;
449
450   return -2;
451 }
452
453 /**
454  * gst_filesrc_get:
455  * @pad: #GstPad to push a buffer from
456  *
457  * Push a new buffer from the filesrc at the current offset.
458  */
459 static GstBuffer *
460 gst_filesrc_get (GstPad *pad)
461 {
462   GstFileSrc *src;
463   GstBuffer *buf = NULL, *map;
464   size_t readsize;
465   off_t readend,mapstart,mapend;
466   GstFileSrcRegion region;
467   int i;
468
469   g_return_val_if_fail (pad != NULL, NULL);
470   src = GST_FILESRC (gst_pad_get_parent (pad));
471   g_return_val_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN), NULL);
472
473   /* check for seek */
474   if (src->seek_happened) {
475     GstEvent *event;
476
477     src->seek_happened = FALSE;
478     GST_DEBUG (GST_CAT_EVENT, "filesrc sending discont\n");
479     event = gst_event_new_discontinuous (FALSE, GST_FORMAT_BYTES, src->curoffset, NULL);
480     GST_EVENT_DISCONT_NEW_MEDIA (event) = FALSE;
481     src->need_flush = FALSE;
482     return GST_BUFFER (event);
483   }
484   /* check for flush */
485   if (src->need_flush) {
486     src->need_flush = FALSE;
487     GST_DEBUG (GST_CAT_EVENT, "filesrc sending flush\n");
488     return GST_BUFFER (gst_event_new_flush ());
489   }
490
491   /* check for EOF */
492   if (src->curoffset == src->filelen) {
493     GST_DEBUG (0, "filesrc eos %lld %lld\n", src->curoffset, src->filelen);
494     gst_element_set_eos (GST_ELEMENT (src));
495     return GST_BUFFER (gst_event_new (GST_EVENT_EOS));
496   }
497
498   /* calculate end pointers so we don't have to do so repeatedly later */
499   readsize = src->block_size;
500   readend = src->curoffset + src->block_size;           /* note this is the byte *after* the read */
501   mapstart = GST_BUFFER_OFFSET(src->mapbuf);
502   mapend = mapstart + GST_BUFFER_SIZE(src->mapbuf);     /* note this is the byte *after* the map */
503
504   /* check to see if we're going to overflow the end of the file */
505   if (readend > src->filelen) {
506     readsize = src->filelen - src->curoffset;
507     readend = src->curoffset + readsize;
508   }
509
510   /* if the start is past the mapstart */
511   if (src->curoffset >= mapstart) {
512     /* if the end is before the mapend, the buffer is in current mmap region... */
513     /* ('cause by definition if readend is in the buffer, so's readstart) */
514     if (readend <= mapend) {
515       fs_print ("read buf %llu+%d lives in current mapbuf %lld+%d, creating subbuffer of mapbuf\n",
516              src->curoffset, readsize, mapstart, GST_BUFFER_SIZE(src->mapbuf));
517       buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - GST_BUFFER_OFFSET(src->mapbuf),
518                                    readsize);
519
520     /* if the start actually is within the current mmap region, map an overlap buffer */
521     } else if (src->curoffset < mapend) {
522       fs_print ("read buf %llu+%d starts in mapbuf %d+%d but ends outside, creating new mmap\n",
523              src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
524       buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
525     }
526
527     /* the only other option is that buffer is totally outside, which means we search for it */
528
529   /* now we can assume that the start is *before* the current mmap region */
530   /* if the readend is past mapstart, we have two options */
531   } else if (readend >= mapstart) {
532     /* either the read buffer overlaps the start of the mmap region */
533     /* or the read buffer fully contains the current mmap region    */
534     /* either way, it's really not relevant, we just create a new region anyway*/
535     fs_print ("read buf %llu+%d starts before mapbuf %d+%d, but overlaps it\n",
536              src->curoffset,readsize,GST_BUFFER_OFFSET(src->mapbuf),GST_BUFFER_SIZE(src->mapbuf));
537     buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
538   }
539
540   /* then deal with the case where the read buffer is totally outside */
541   if (buf == NULL) {
542     /* first check to see if there's a map that covers the right region already */
543     fs_print ("searching for mapbuf to cover %llu+%d\n",src->curoffset,readsize);
544     region.offset = src->curoffset;
545     region.size = readsize;
546     map = g_tree_search (src->map_regions,
547                          (GCompareFunc) gst_filesrc_search_region_match,
548                          (gpointer)&region);
549
550     /* if we found an exact match, subbuffer it */
551     if (map != NULL) {
552       fs_print ("found mapbuf at %d+%d, creating subbuffer\n",GST_BUFFER_OFFSET(map),GST_BUFFER_SIZE(map));
553       buf = gst_buffer_create_sub (map, src->curoffset - GST_BUFFER_OFFSET(map), readsize);
554
555     /* otherwise we need to create something out of thin air */
556     } else {
557       /* if the read buffer crosses a mmap region boundary, create a one-off region */
558       if ((src->curoffset / src->mapsize) != (readend / src->mapsize)) {
559         fs_print ("read buf %llu+%d crosses a %d-byte boundary, creating a one-off\n",
560                src->curoffset,readsize,src->mapsize);
561         buf = gst_filesrc_map_small_region (src, src->curoffset, readsize);
562
563       /* otherwise we will create a new mmap region and set it to the default */
564       } else {
565         size_t mapsize;
566
567         off_t nextmap = src->curoffset - (src->curoffset % src->mapsize);
568         fs_print ("read buf %llu+%d in new mapbuf at %llu+%d, mapping and subbuffering\n",
569                src->curoffset, readsize, nextmap, src->mapsize);
570         /* first, we're done with the old mapbuf */
571         gst_buffer_unref(src->mapbuf);
572         mapsize = src->mapsize;
573
574         /* double the mapsize as long as the readsize is smaller */
575         while (readsize - (src->curoffset - nextmap) > mapsize) {
576           fs_print ("readsize smaller then mapsize %08x %d\n", readsize, mapsize);
577           mapsize <<=1;
578         }
579         /* create a new one */
580         src->mapbuf = gst_filesrc_map_region (src, nextmap, mapsize);
581         /* subbuffer it */
582         buf = gst_buffer_create_sub (src->mapbuf, src->curoffset - nextmap, readsize);
583       }
584     }
585   }
586
587   /* if we need to touch the buffer (to bring it into memory), do so */
588   if (src->touch) {
589     volatile guchar *p = GST_BUFFER_DATA (buf), c;
590     for (i=0;i<GST_BUFFER_SIZE(buf);i+=src->pagesize)
591       c = p[i];
592   }
593
594   /* we're done, return the buffer */
595   src->curoffset += GST_BUFFER_SIZE(buf);
596   g_object_notify (G_OBJECT (src), "offset");
597   return buf;
598 }
599
600 /* open the file and mmap it, necessary to go to READY state */
601 static gboolean 
602 gst_filesrc_open_file (GstFileSrc *src)
603 {
604   g_return_val_if_fail (!GST_FLAG_IS_SET (src ,GST_FILESRC_OPEN), FALSE);
605
606   GST_DEBUG(0, "opening file %s",src->filename);
607
608   /* open the file */
609   src->fd = open (src->filename, O_RDONLY);
610   if (src->fd < 0) {
611     gst_element_error (GST_ELEMENT (src), "opening file \"%s\" (%s)", 
612                        src->filename, strerror (errno), NULL);
613     return FALSE;
614   } else {
615     /* check if it is a regular file, otherwise bail out */
616     struct stat stat_results;
617
618     fstat(src->fd, &stat_results);
619
620     if (!S_ISREG(stat_results.st_mode)) {
621       gst_element_error (GST_ELEMENT (src), "opening file \"%s\" failed. it isn't a regular file", 
622                                         src->filename, NULL);
623       close(src->fd);
624       return FALSE;
625     }
626                 
627     /* find the file length */
628     src->filelen = lseek (src->fd, 0, SEEK_END);
629     lseek (src->fd, 0, SEEK_SET);
630
631     /* allocate the first mmap'd region */
632     src->mapbuf = gst_filesrc_map_region (src, 0, src->mapsize);
633
634     src->curoffset = 0;
635
636     /* now notify of the changes */
637     g_object_freeze_notify (G_OBJECT (src));
638     g_object_notify (G_OBJECT (src), "filesize");
639     g_object_notify (G_OBJECT (src), "offset");
640     g_object_thaw_notify (G_OBJECT (src));
641
642     GST_FLAG_SET (src, GST_FILESRC_OPEN);
643   }
644   return TRUE;
645 }
646
647 /* unmap and close the file */
648 static void
649 gst_filesrc_close_file (GstFileSrc *src)
650 {
651   g_return_if_fail (GST_FLAG_IS_SET (src, GST_FILESRC_OPEN));
652
653   /* close the file */
654   close (src->fd);
655
656   /* zero out a lot of our state */
657   src->fd = 0;
658   src->filelen = 0;
659   src->curoffset = 0;
660   /* and notify that things changed */
661   g_object_freeze_notify (G_OBJECT (src));
662   g_object_notify (G_OBJECT (src), "filesize");
663   g_object_notify (G_OBJECT (src), "offset");
664   g_object_thaw_notify (G_OBJECT (src));
665
666   if (src->mapbuf)
667     gst_buffer_unref (src->mapbuf);
668
669   GST_FLAG_UNSET (src, GST_FILESRC_OPEN);
670 }
671
672
673 static GstElementStateReturn
674 gst_filesrc_change_state (GstElement *element)
675 {
676   GstFileSrc *src = GST_FILESRC(element);
677
678   switch (GST_STATE_TRANSITION (element)) {
679     case GST_STATE_NULL_TO_READY:
680       break;
681     case GST_STATE_READY_TO_NULL:
682       break;
683     case GST_STATE_READY_TO_PAUSED:
684       if (!GST_FLAG_IS_SET (element, GST_FILESRC_OPEN)) {
685         if (!gst_filesrc_open_file (GST_FILESRC (element)))
686           return GST_STATE_FAILURE;
687       }
688       break;
689     case GST_STATE_PAUSED_TO_READY:
690       if (GST_FLAG_IS_SET (element, GST_FILESRC_OPEN))
691         gst_filesrc_close_file (GST_FILESRC (element));
692       src->seek_happened = TRUE;
693       break;
694     default:
695       break;
696   }
697
698   if (GST_ELEMENT_CLASS (parent_class)->change_state)
699     return GST_ELEMENT_CLASS (parent_class)->change_state (element);
700
701   return GST_STATE_SUCCESS;
702 }
703
704 static gboolean
705 gst_filesrc_srcpad_query (GstPad *pad, GstPadQueryType type,
706                           GstFormat *format, gint64 *value)
707 {
708   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
709
710   switch (type) {
711     case GST_PAD_QUERY_TOTAL:
712       if (*format != GST_FORMAT_BYTES) {
713         return FALSE;
714       }
715       *value = src->filelen;
716       break;
717     case GST_PAD_QUERY_POSITION:
718       if (*format != GST_FORMAT_BYTES) {
719         return FALSE;
720       }
721       *value = src->curoffset;
722       break;
723     default:
724       return FALSE;
725       break;
726   }
727   return TRUE;
728 }
729
730 static gboolean
731 gst_filesrc_srcpad_event (GstPad *pad, GstEvent *event)
732 {
733   GstFileSrc *src = GST_FILESRC (GST_PAD_PARENT (pad));
734
735   GST_DEBUG(0, "event %d", GST_EVENT_TYPE (event));
736
737   switch (GST_EVENT_TYPE (event)) {
738     case GST_EVENT_SEEK:
739     {
740       guint64 offset;
741
742       if (GST_EVENT_SEEK_FORMAT (event) != GST_FORMAT_BYTES) {
743         goto error;
744       }
745
746       offset = GST_EVENT_SEEK_OFFSET (event);
747
748       switch (GST_EVENT_SEEK_METHOD (event)) {
749         case GST_SEEK_METHOD_SET:
750           if (offset > src->filelen) 
751             goto error;
752           src->curoffset = offset;
753           GST_DEBUG(0, "seek set pending to %lld", src->curoffset);
754           break;
755         case GST_SEEK_METHOD_CUR:
756           if (offset + src->curoffset > src->filelen) 
757             goto error;
758           src->curoffset += offset;
759           GST_DEBUG(0, "seek cur pending to %lld", src->curoffset);
760           break;
761         case GST_SEEK_METHOD_END:
762           if (ABS (offset) > src->filelen) 
763             goto error;
764           src->curoffset = src->filelen - ABS (offset);
765           GST_DEBUG(0, "seek end pending to %lld", src->curoffset);
766           break;
767         default:
768           goto error;
769           break;
770       }
771       g_object_notify (G_OBJECT (src), "offset");  
772       src->seek_happened = TRUE;
773       src->need_flush = GST_EVENT_SEEK_FLAGS(event) & GST_SEEK_FLAG_FLUSH;
774       break;
775     }
776     case GST_EVENT_SIZE:
777       if (GST_EVENT_SIZE_FORMAT (event) != GST_FORMAT_BYTES) {
778         goto error;
779       }
780       src->block_size = GST_EVENT_SIZE_VALUE (event);
781       g_object_notify (G_OBJECT (src), "blocksize");  
782       break;
783     case GST_EVENT_FLUSH:
784       src->need_flush = TRUE;
785       break;
786     default:
787       goto error;
788       break;
789   }
790   gst_event_unref (event);
791   return TRUE;
792
793 error:
794   gst_event_unref (event);
795   return FALSE;
796 }