Port matroska muxer to 0.9 (#318847).
[platform/upstream/gst-plugins-good.git] / gst / matroska / ebml-write.h
1 /* GStreamer EBML I/O
2  * (c) 2003 Ronald Bultje <rbultje@ronald.bitfreak.net>
3  * (c) 2005 Michal Benes <michal.benes@xeris.cz>
4  *
5  * ebml-write.c: write EBML data to file/stream
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 #ifndef __GST_EBML_WRITE_H__
24 #define __GST_EBML_WRITE_H__
25
26 #include <glib.h>
27 #include <gst/gst.h>
28
29 G_BEGIN_DECLS
30
31 #define GST_TYPE_EBML_WRITE \
32   (gst_ebml_write_get_type ())
33 #define GST_EBML_WRITE(obj) \
34   (G_TYPE_CHECK_INSTANCE_CAST ((obj), GST_TYPE_EBML_WRITE, GstEbmlWrite))
35 #define GST_EBML_WRITE_CLASS(klass) \
36   (G_TYPE_CHECK_CLASS_CAST ((klass), GST_TYPE_EBML_WRITE, GstEbmlWriteClass))
37 #define GST_IS_EBML_WRITE(obj) \
38   (G_TYPE_CHECK_INSTANCE_TYPE ((obj), GST_TYPE_EBML_WRITE))
39 #define GST_IS_EBML_WRITE_CLASS(obj) \
40   (G_TYPE_CHECK_CLASS_TYPE ((klass), GST_TYPE_EBML_WRITE))
41 #define GST_EBML_WRITE_GET_CLASS(obj) \
42   (G_TYPE_INSTANCE_GET_CLASS ((obj), GST_TYPE_EBML_WRITE, GstEbmlWriteClass))
43
44 typedef struct _GstEbmlWrite {
45   GstObject object;
46
47   GstPad *srcpad;
48   guint64 pos;
49
50   GstBuffer *cache;
51   guint cache_size;
52   guint handled;
53
54   GstFlowReturn last_write_result;
55
56   /*< private >*/
57   gpointer _gst_reserved[GST_PADDING];
58 } GstEbmlWrite;
59
60 typedef struct _GstEbmlWriteClass {
61   GstObjectClass parent;
62
63   /*< private >*/
64   gpointer _gst_reserved[GST_PADDING];
65 } GstEbmlWriteClass;
66
67 GType   gst_ebml_write_get_type      (void);
68
69 GstEbmlWrite *gst_ebml_write_new     (GstPad *srcpad);
70 void    gst_ebml_write_reset         (GstEbmlWrite *ebml);
71
72 GstFlowReturn gst_ebml_last_write_result (GstEbmlWrite *ebml);
73
74 /*
75  * Caching means that we do not push one buffer for
76  * each element, but fill this one until a flush.
77  */
78 void    gst_ebml_write_set_cache     (GstEbmlWrite *ebml,
79                                       guint         size);
80 void    gst_ebml_write_flush_cache   (GstEbmlWrite *ebml);
81
82 /*
83  * Seeking.
84  */
85 void    gst_ebml_write_seek          (GstEbmlWrite *ebml,
86                                       guint64       pos);
87
88 /*
89  * Data writing. 
90  */
91 void    gst_ebml_write_uint          (GstEbmlWrite *ebml,
92                                       guint32       id,
93                                       guint64       num);
94 void    gst_ebml_write_sint          (GstEbmlWrite *ebml,
95                                       guint32       id,
96                                       gint64        num);
97 void    gst_ebml_write_float         (GstEbmlWrite *ebml,
98                                       guint32       id,
99                                       gdouble       num);
100 void    gst_ebml_write_ascii         (GstEbmlWrite *ebml,
101                                       guint32       id,
102                                       const gchar  *str);
103 void    gst_ebml_write_utf8          (GstEbmlWrite *ebml,
104                                       guint32       id,
105                                       const gchar  *str);
106 void    gst_ebml_write_date          (GstEbmlWrite *ebml,
107                                       guint32       id,
108                                       gint64        date);
109 guint64 gst_ebml_write_master_start  (GstEbmlWrite *ebml,
110                                       guint32       id);
111 void    gst_ebml_write_master_finish (GstEbmlWrite *ebml,
112                                       guint64       startpos);
113 void    gst_ebml_write_binary        (GstEbmlWrite *ebml,
114                                       guint32       id,
115                                       guchar       *binary,
116                                       guint64       length);
117 void    gst_ebml_write_header        (GstEbmlWrite *ebml,
118                                       gchar        *doctype,
119                                       guint         version);
120
121 /*
122  * Note: this is supposed to be used only for media data.
123  */
124 void    gst_ebml_write_buffer_header (GstEbmlWrite *ebml,
125                                       guint32       id,
126                                       guint64       length);
127 void    gst_ebml_write_buffer        (GstEbmlWrite *ebml,
128                                       GstBuffer    *data);
129
130 /*
131  * A hack, basically... See matroska-mux.c. I should actually
132  * make a nice _replace_element_with_size() or so, but this
133  * works for now.
134  */
135 void    gst_ebml_replace_uint        (GstEbmlWrite *ebml,
136                                       guint64       pos,
137                                       guint64       num);
138
139 G_END_DECLS
140
141 #endif /* __GST_EBML_WRITE_H__ */