Small updates to various docs.
[platform/upstream/gstreamer.git] / plugins / elements / gstfdsrc.h
1 /* GStreamer
2  * Copyright (C) 1999,2000 Erik Walthinsen <omega@cse.ogi.edu>
3  *                    2000 Wim Taymans <wtay@chello.be>
4  *                    2005 Philippe Khalaf <burger@speedy.org>
5  *
6  * gstfdsrc.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
25 #ifndef __GST_FD_SRC_H__
26 #define __GST_FD_SRC_H__
27
28 #include <gst/gst.h>
29 #include <gst/base/gstpushsrc.h>
30
31 G_BEGIN_DECLS
32
33
34 #define GST_TYPE_FD_SRC \
35   (gst_fd_src_get_type())
36 #define GST_FD_SRC(obj) \
37   (G_TYPE_CHECK_INSTANCE_CAST((obj),GST_TYPE_FD_SRC,GstFdSrc))
38 #define GST_FD_SRC_CLASS(klass) \
39   (G_TYPE_CHECK_CLASS_CAST((klass),GST_TYPE_FD_SRC,GstFdSrcClass))
40 #define GST_IS_FD_SRC(obj) \
41   (G_TYPE_CHECK_INSTANCE_TYPE((obj),GST_TYPE_FD_SRC))
42 #define GST_IS_FD_SRC_CLASS(obj) \
43   (G_TYPE_CHECK_CLASS_TYPE((klass),GST_TYPE_FD_SRC))
44
45
46 typedef struct _GstFdSrc GstFdSrc;
47 typedef struct _GstFdSrcClass GstFdSrcClass;
48
49 /**
50  * GstFdSrc:
51  *
52  * Opaque #GstFdSrc data structure
53  */
54 struct _GstFdSrc {
55   GstPushSrc element;
56
57   /*< private >*/
58   /* new_fd is copied to fd on READY->PAUSED */
59   gint new_fd;
60
61   /* fd and flag indicating whether fd is seekable */
62   gint fd;
63   gboolean seekable_fd;
64
65   gchar *uri;
66
67   gint control_sock[2];
68
69   gulong curoffset; /* current offset in file */
70 };
71
72 struct _GstFdSrcClass {
73   GstPushSrcClass parent_class;
74
75   /* signals */
76   void (*timeout) (GstElement *element);
77 };
78
79 GType gst_fd_src_get_type(void);
80
81 G_END_DECLS
82
83 #endif /* __GST_FD_SRC_H__ */