aboutsummaryrefslogtreecommitdiff
path: root/libs/gst/base/gstbytewriter-docs.h
blob: 562eeae171e91ac74dffa8e7fd162564db4d19e9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
/* GStreamer byte writer dummy header for gtk-doc
 * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 51 Franklin St, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 */

/* This header is not installed, it just contains stuff for gtk-doc to parse,
 * in particular docs and some dummy function declarations for the static
 * inline functions we generate via macros in gstbitreader.h.
 */

#error "This header should never be included in code, it is only for gtk-doc"

/**
 * gst_byte_writer_put_uint8_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned 8 bit integer to @writer without checking if there
 * is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint8_unchecked (GstByteWriter *writer, guint8 val);

/**
 * gst_byte_writer_put_uint16_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned big endian 16 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint16_be_unchecked (GstByteWriter *writer, guint16 val);

/**
 * gst_byte_writer_put_uint24_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned big endian 24 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint24_be_unchecked (GstByteWriter *writer, guint32 val);

/**
 * gst_byte_writer_put_uint32_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned big endian 32 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint32_be_unchecked (GstByteWriter *writer, guint32 val);

/**
 * gst_byte_writer_put_uint64_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned big endian 64 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint64_be_unchecked (GstByteWriter *writer, guint64 val);

/**
 * gst_byte_writer_put_uint16_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned little endian 16 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint16_le_unchecked (GstByteWriter *writer, guint16 val);

/**
 * gst_byte_writer_put_uint24_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned little endian 24 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint24_le_unchecked (GstByteWriter *writer, guint32 val);

/**
 * gst_byte_writer_put_uint32_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned little endian 32 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint32_le_unchecked (GstByteWriter *writer, guint32 val);

/**
 * gst_byte_writer_put_uint64_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a unsigned little endian 64 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_uint64_le_unchecked (GstByteWriter *writer, guint64 val);

/**
 * gst_byte_writer_put_int8:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed 8 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int8_unchecked (GstByteWriter *writer, gint8 val);

/**
 * gst_byte_writer_put_int16_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed big endian 16 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int16_be_unchecked (GstByteWriter *writer, gint16 val);

/**
 * gst_byte_writer_put_int24_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed big endian 24 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int24_be_unchecked (GstByteWriter *writer, gint32 val);

/**
 * gst_byte_writer_put_int32_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed big endian 32 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int32_be_unchecked (GstByteWriter *writer, gint32 val);

/**
 * gst_byte_writer_put_int64_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed big endian 64 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int64_be_unchecked (GstByteWriter *writer, gint64 val);

/**
 * gst_byte_writer_put_int16_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed little endian 16 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int16_le_unchecked (GstByteWriter *writer, gint16 val);

/**
 * gst_byte_writer_put_int24_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed little endian 24 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int24_le_unchecked (GstByteWriter *writer, gint32 val);

/**
 * gst_byte_writer_put_int32_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed little endian 32 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int32_le_unchecked (GstByteWriter *writer, gint32 val);

/**
 * gst_byte_writer_put_int64_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a signed little endian 64 bit integer to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_int64_le_unchecked (GstByteWriter *writer, gint64 val);

/**
 * gst_byte_writer_put_float32_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a big endian 32 bit float to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_float32_be_unchecked (GstByteWriter *writer, gfloat val);

/**
 * gst_byte_writer_put_float64_be_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a big endian 64 bit float to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_float64_be_unchecked (GstByteWriter *writer, gdouble val);

/**
 * gst_byte_writer_put_float32_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a little endian 32 bit float to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_float32_le_unchecked (GstByteWriter *writer, gfloat val);

/**
 * gst_byte_writer_put_float64_le_unchecked:
 * @writer: #GstByteWriter instance
 * @val: Value to write
 *
 * Writes a little endian 64 bit float to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_float64_le_unchecked (GstByteWriter *writer, gdouble val);

/**
 * gst_byte_writer_put_data_unchecked:
 * @writer: #GstByteWriter instance
 * @data: (in) (transfer none) (array length=size): Data to write
 * @size: Size of @data in bytes
 *
 * Writes @size bytes of @data to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_put_data_unchecked (GstByteWriter *writer, const guint8 *data, guint size);

/**
 * gst_byte_writer_fill_unchecked:
 * @writer: #GstByteWriter instance
 * @value: Value to be writen
 * @size: Number of bytes to be writen
 *
 * Writes @size bytes containing @value to @writer without
 * checking if there is enough free space available in the byte writer.
 */
void gst_byte_writer_fill_unchecked (GstByteWriter *writer, guint8 value, guint size);