Merge branch 'master' into 0.11
[platform/upstream/gstreamer.git] / plugins / elements / gstfilesrc.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *                    2005 Wim Taymans <wim@fluendo.com>
5  *
6  * gstfilesrc.h:
7  *
8  * This library is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Library General Public
10  * License as published by the Free Software Foundation; either
11  * version 2 of the License, or (at your option) any later version.
12  *
13  * This library is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Library General Public License for more details.
17  *
18  * You should have received a copy of the GNU Library General Public
19  * License along with this library; if not, write to the
20  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21  * Boston, MA 02111-1307, USA.
22  */
23
24 #ifndef __GST_FILE_SRC_H__
25 #define __GST_FILE_SRC_H__
26
27 #include <sys/types.h>
28
29 #include <gst/gst.h>
30 #include <gst/base/gstbasesrc.h>
31
32 G_BEGIN_DECLS
33
34 #define GST_TYPE_FILE_SRC \
35   (gst_file_src_get_type())
36 #define GST_FILE_SRC(obj) \
37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FILE_SRC,GstFileSrc))
38 #define GST_FILE_SRC_CLASS(klass) \
39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FILE_SRC,GstFileSrcClass))
40 #define GST_IS_FILE_SRC(obj) \
41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FILE_SRC))
42 #define GST_IS_FILE_SRC_CLASS(klass) \
43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FILE_SRC))
44 #define GST_FILE_SRC_CAST(obj) ((GstFileSrc*) obj)
45
46 typedef struct _GstFileSrc GstFileSrc;
47 typedef struct _GstFileSrcClass GstFileSrcClass;
48
49 /**
50  * GstFileSrc:
51  *
52  * Opaque #GstFileSrc structure.
53  */
54 struct _GstFileSrc {
55   GstBaseSrc element;
56
57   /*< private >*/
58   gchar *filename;                      /* filename */
59   gchar *uri;                           /* caching the URI */
60   gint fd;                              /* open file descriptor */
61   guint64 read_position;                /* position of fd */
62
63   gboolean seekable;                    /* whether the file is seekable */
64   gboolean is_regular;                  /* whether it's a (symlink to a)
65                                            regular file */
66 };
67
68 struct _GstFileSrcClass {
69   GstBaseSrcClass parent_class;
70 };
71
72 GType gst_file_src_get_type (void);
73
74 G_END_DECLS
75
76 #endif /* __GST_FILE_SRC_H__ */