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