Debian Codegraph @

libs/gst/base/gstbytewriter-docs.h

raw
1 /* GStreamer byte writer dummy header for gtk-doc
2 * Copyright (C) 2010 Sebastian Dröge <[email protected]>
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
13 *
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, USA.
18 */
19
20 /* This header is not installed, it just contains stuff for gtk-doc to parse,
21 * in particular docs and some dummy function declarations for the static
22 * inline functions we generate via macros in gstbitreader.h.
23 */
24
25 #error "This header should never be included in code, it is only for gtk-doc"
26
27 /**
28 * gst_byte_writer_put_uint8_unchecked:
29 * @writer: #GstByteWriter instance
30 * @val: Value to write
31 *
32 * Writes a unsigned 8 bit integer to @writer without checking if there
33 * is enough free space available in the byte writer.
34 */
35 void gst_byte_writer_put_uint8_unchecked (GstByteWriter *writer, guint8 val);
36
37 /**
38 * gst_byte_writer_put_uint16_be_unchecked:
39 * @writer: #GstByteWriter instance
40 * @val: Value to write
41 *
42 * Writes a unsigned big endian 16 bit integer to @writer without
43 * checking if there is enough free space available in the byte writer.
44 */
45 void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val);
46
47 /**
48 * gst_byte_writer_put_uint24_be_unchecked:
49 * @writer: #GstByteWriter instance
50 * @val: Value to write
51 *
52 * Writes a unsigned big endian 24 bit integer to @writer without
53 * checking if there is enough free space available in the byte writer.
54 */
55 void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val);
56
57 /**
58 * gst_byte_writer_put_uint32_be_unchecked:
59 * @writer: #GstByteWriter instance
60 * @val: Value to write
61 *
62 * Writes a unsigned big endian 32 bit integer to @writer without
63 * checking if there is enough free space available in the byte writer.
64 */
65 void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val);
66
67 /**
68 * gst_byte_writer_put_uint64_be_unchecked:
69 * @writer: #GstByteWriter instance
70 * @val: Value to write
71 *
72 * Writes a unsigned big endian 64 bit integer to @writer without
73 * checking if there is enough free space available in the byte writer.
74 */
75 void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val);
76
77 /**
78 * gst_byte_writer_put_uint16_le_unchecked:
79 * @writer: #GstByteWriter instance
80 * @val: Value to write
81 *
82 * Writes a unsigned little endian 16 bit integer to @writer without
83 * checking if there is enough free space available in the byte writer.
84 */
85 void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val);
86
87 /**
88 * gst_byte_writer_put_uint24_le_unchecked:
89 * @writer: #GstByteWriter instance
90 * @val: Value to write
91 *
92 * Writes a unsigned little endian 24 bit integer to @writer without
93 * checking if there is enough free space available in the byte writer.
94 */
95 void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val);
96
97 /**
98 * gst_byte_writer_put_uint32_le_unchecked:
99 * @writer: #GstByteWriter instance
100 * @val: Value to write
101 *
102 * Writes a unsigned little endian 32 bit integer to @writer without
103 * checking if there is enough free space available in the byte writer.
104 */
105 void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val);
106
107 /**
108 * gst_byte_writer_put_uint64_le_unchecked:
109 * @writer: #GstByteWriter instance
110 * @val: Value to write
111 *
112 * Writes a unsigned little endian 64 bit integer to @writer without
113 * checking if there is enough free space available in the byte writer.
114 */
115 void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val);
116
117 /**
118 * gst_byte_writer_put_int8:
119 * @writer: #GstByteWriter instance
120 * @val: Value to write
121 *
122 * Writes a signed 8 bit integer to @writer without
123 * checking if there is enough free space available in the byte writer.
124 */
125 void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);
126
127 /**
128 * gst_byte_writer_put_int16_be_unchecked:
129 * @writer: #GstByteWriter instance
130 * @val: Value to write
131 *
132 * Writes a signed big endian 16 bit integer to @writer without
133 * checking if there is enough free space available in the byte writer.
134 */
135 void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);
136
137 /**
138 * gst_byte_writer_put_int24_be_unchecked:
139 * @writer: #GstByteWriter instance
140 * @val: Value to write
141 *
142 * Writes a signed big endian 24 bit integer to @writer without
143 * checking if there is enough free space available in the byte writer.
144 */
145 void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);
146
147 /**
148 * gst_byte_writer_put_int32_be_unchecked:
149 * @writer: #GstByteWriter instance
150 * @val: Value to write
151 *
152 * Writes a signed big endian 32 bit integer to @writer without
153 * checking if there is enough free space available in the byte writer.
154 */
155 void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);
156
157 /**
158 * gst_byte_writer_put_int64_be_unchecked:
159 * @writer: #GstByteWriter instance
160 * @val: Value to write
161 *
162 * Writes a signed big endian 64 bit integer to @writer without
163 * checking if there is enough free space available in the byte writer.
164 */
165 void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);
166
167 /**
168 * gst_byte_writer_put_int16_le_unchecked:
169 * @writer: #GstByteWriter instance
170 * @val: Value to write
171 *
172 * Writes a signed little endian 16 bit integer to @writer without
173 * checking if there is enough free space available in the byte writer.
174 */
175 void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);
176
177 /**
178 * gst_byte_writer_put_int24_le_unchecked:
179 * @writer: #GstByteWriter instance
180 * @val: Value to write
181 *
182 * Writes a signed little endian 24 bit integer to @writer without
183 * checking if there is enough free space available in the byte writer.
184 */
185 void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);
186
187 /**
188 * gst_byte_writer_put_int32_le_unchecked:
189 * @writer: #GstByteWriter instance
190 * @val: Value to write
191 *
192 * Writes a signed little endian 32 bit integer to @writer without
193 * checking if there is enough free space available in the byte writer.
194 */
195 void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);
196
197 /**
198 * gst_byte_writer_put_int64_le_unchecked:
199 * @writer: #GstByteWriter instance
200 * @val: Value to write
201 *
202 * Writes a signed little endian 64 bit integer to @writer without
203 * checking if there is enough free space available in the byte writer.
204 */
205 void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);
206
207 /**
208 * gst_byte_writer_put_float32_be_unchecked:
209 * @writer: #GstByteWriter instance
210 * @val: Value to write
211 *
212 * Writes a big endian 32 bit float to @writer without
213 * checking if there is enough free space available in the byte writer.
214 */
215 void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val);
216
217 /**
218 * gst_byte_writer_put_float64_be_unchecked:
219 * @writer: #GstByteWriter instance
220 * @val: Value to write
221 *
222 * Writes a big endian 64 bit float to @writer without
223 * checking if there is enough free space available in the byte writer.
224 */
225 void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble val);
226
227 /**
228 * gst_byte_writer_put_float32_le_unchecked:
229 * @writer: #GstByteWriter instance
230 * @val: Value to write
231 *
232 * Writes a little endian 32 bit float to @writer without
233 * checking if there is enough free space available in the byte writer.
234 */
235 void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val);
236
237 /**
238 * gst_byte_writer_put_float64_le_unchecked:
239 * @writer: #GstByteWriter instance
240 * @val: Value to write
241 *
242 * Writes a little endian 64 bit float to @writer without
243 * checking if there is enough free space available in the byte writer.
244 */
245 void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble val);
246
247 /**
248 * gst_byte_writer_put_data_unchecked:
249 * @writer: #GstByteWriter instance
250 * @data: (in) (transfer none) (array length=size): Data to write
251 * @size: Size of @data in bytes
252 *
253 * Writes @size bytes of @data to @writer without
254 * checking if there is enough free space available in the byte writer.
255 */
256 void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *data, guint size);
257
258 /**
259 * gst_byte_writer_fill_unchecked:
260 * @writer: #GstByteWriter instance
261 * @value: Value to be written
262 * @size: Number of bytes to be written
263
264 *
265 * Writes @size bytes containing @value to @writer without
266 * checking if there is enough free space available in the byte writer.
267 */
268 void gst_byte_writer_fill_unchecked (GstByteWriter *writer, guint8 value, guint size);
269