1 /* GStreamer byte reader dummy header for gtk-doc
2 * Copyright (C) 2009 Tim-Philipp Müller <tim centricular net>
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.
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.
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., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
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 gstbytereader.h.
25 #error "This header should never be included in code, it is only for gtk-doc"
28 * gst_byte_reader_skip_unchecked:
29 * @reader: a #GstByteReader instance
30 * @nbytes: the number of bytes to skip
32 * Skips @nbytes bytes of the #GstByteReader instance without checking if
33 * there are enough bytes available in the byte reader.
37 void gst_byte_reader_skip_unchecked (GstByteReader * reader, guint nbytes);
40 * gst_byte_reader_get_uint8_unchecked:
41 * @reader: a #GstByteReader instance
43 * Read an unsigned 8 bit integer without checking if there are enough bytes
44 * available in the byte reader and update the current position.
46 * Returns: unsigned 8 bit integer.
51 * gst_byte_reader_peek_uint8_unchecked:
52 * @reader: a #GstByteReader instance
54 * Read an unsigned 8 bit integer without checking if there are enough bytes
55 * available in the byte reader, but do not advance the current read position.
57 * Returns: unsigned 8 bit integer.
62 * gst_byte_reader_get_int8_unchecked:
63 * @reader: a #GstByteReader instance
65 * Read an signed 8 bit integer without checking if there are enough bytes
66 * available in the byte reader and update the current position.
68 * Returns: signed 8 bit integer.
73 * gst_byte_reader_peek_int8_unchecked:
74 * @reader: a #GstByteReader instance
76 * Read an signed 8 bit integer without checking if there are enough bytes
77 * available in the byte reader, but do not advance the current read position.
79 * Returns: signed 8 bit integer.
83 guint8 gst_byte_reader_get_uint8_unchecked (GstByteReader * reader);
84 guint8 gst_byte_reader_peek_uint8_unchecked (GstByteReader * reader);
85 gint8 gst_byte_reader_get_int8_unchecked (GstByteReader * reader);
86 gint8 gst_byte_reader_peek_int8_unchecked (GstByteReader * reader);
89 * gst_byte_reader_get_uint16_le_unchecked:
90 * @reader: a #GstByteReader instance
92 * Read an unsigned 16 bit integer in little endian format without checking
93 * if there are enough bytes available in the byte reader and update the
96 * Returns: unsigned 16 bit integer.
101 * gst_byte_reader_peek_uint16_le_unchecked:
102 * @reader: a #GstByteReader instance
104 * Read an unsigned 16 bit integer in little endian format without checking
105 * if there are enough bytes available in the byte reader, but do not advance
106 * the current position.
108 * Returns: unsigned 16 bit integer.
113 * gst_byte_reader_get_uint16_be_unchecked:
114 * @reader: a #GstByteReader instance
116 * Read an unsigned 16 bit integer in big endian format without checking
117 * if there are enough bytes available in the byte reader and update the
120 * Returns: unsigned 16 bit integer.
125 * gst_byte_reader_peek_uint16_be_unchecked:
126 * @reader: a #GstByteReader instance
128 * Read an unsigned 16 bit integer in big endian format without checking
129 * if there are enough bytes available in the byte reader, but do not advance
130 * the current position.
132 * Returns: unsigned 16 bit integer.
137 * gst_byte_reader_get_int16_le_unchecked:
138 * @reader: a #GstByteReader instance
140 * Read a signed 16 bit integer in little endian format without checking
141 * if there are enough bytes available in the byte reader and update the
144 * Returns: signed 16 bit integer.
149 * gst_byte_reader_peek_int16_le_unchecked:
150 * @reader: a #GstByteReader instance
152 * Read a signed 16 bit integer in little endian format without checking
153 * if there are enough bytes available in the byte reader, but do not advance
154 * the current position.
156 * Returns: signed 16 bit integer.
161 * gst_byte_reader_get_int16_be_unchecked:
162 * @reader: a #GstByteReader instance
164 * Read a signed 16 bit integer in big endian format without checking
165 * if there are enough bytes available in the byte reader and update the
168 * Returns: signed 16 bit integer.
173 * gst_byte_reader_peek_int16_be_unchecked:
174 * @reader: a #GstByteReader instance
176 * Read a signed 16 bit integer in big endian format without checking
177 * if there are enough bytes available in the byte reader, but do not advance
178 * the current position.
180 * Returns: signed 16 bit integer.
184 guint16 gst_byte_reader_get_uint16_le_unchecked (GstByteReader * reader);
185 guint16 gst_byte_reader_get_uint16_be_unchecked (GstByteReader * reader);
186 guint16 gst_byte_reader_peek_uint16_le_unchecked (GstByteReader * reader);
187 guint16 gst_byte_reader_peek_uint16_be_unchecked (GstByteReader * reader);
188 gint16 gst_byte_reader_get_int16_le_unchecked (GstByteReader * reader);
189 gint16 gst_byte_reader_get_int16_be_unchecked (GstByteReader * reader);
190 gint16 gst_byte_reader_peek_int16_le_unchecked (GstByteReader * reader);
191 gint16 gst_byte_reader_peek_int16_be_unchecked (GstByteReader * reader);
194 * gst_byte_reader_get_uint24_le_unchecked:
195 * @reader: a #GstByteReader instance
197 * Read an unsigned 24 bit integer in little endian format without checking
198 * if there are enough bytes available in the byte reader and update the
201 * Returns: unsigned 24 bit integer (as guint32)
206 * gst_byte_reader_peek_uint24_le_unchecked:
207 * @reader: a #GstByteReader instance
209 * Read an unsigned 24 bit integer in little endian format without checking
210 * if there are enough bytes available in the byte reader, but do not advance
211 * the current position.
213 * Returns: unsigned 24 bit integer (as guint32)
218 * gst_byte_reader_get_uint24_be_unchecked:
219 * @reader: a #GstByteReader instance
221 * Read an unsigned 24 bit integer in big endian format without checking
222 * if there are enough bytes available in the byte reader and update the
225 * Returns: unsigned 24 bit integer (as guint32)
230 * gst_byte_reader_peek_uint24_be_unchecked:
231 * @reader: a #GstByteReader instance
233 * Read an unsigned 24 bit integer in big endian format without checking
234 * if there are enough bytes available in the byte reader, but do not advance
235 * the current position.
237 * Returns: unsigned 24 bit integer (as guint32)
242 * gst_byte_reader_get_int24_le_unchecked:
243 * @reader: a #GstByteReader instance
245 * Read a signed 24 bit integer in little endian format without checking
246 * if there are enough bytes available in the byte reader and update the
249 * Returns: signed 24 bit integer (as gint32)
254 * gst_byte_reader_peek_int24_le_unchecked:
255 * @reader: a #GstByteReader instance
257 * Read a signed 24 bit integer in little endian format without checking
258 * if there are enough bytes available in the byte reader, but do not advance
259 * the current position.
261 * Returns: signed 24 bit integer (as gint32)
266 * gst_byte_reader_get_int24_be_unchecked:
267 * @reader: a #GstByteReader instance
269 * Read a signed 24 bit integer in big endian format without checking
270 * if there are enough bytes available in the byte reader and update the
273 * Returns: signed 24 bit integer (as gint32)
278 * gst_byte_reader_peek_int24_be_unchecked:
279 * @reader: a #GstByteReader instance
281 * Read a signed 24 bit integer in big endian format without checking
282 * if there are enough bytes available in the byte reader, but do not advance
283 * the current position.
285 * Returns: signed 24 bit integer (as gint32)
289 guint32 gst_byte_reader_get_uint24_le_unchecked (GstByteReader * reader);
290 guint32 gst_byte_reader_get_uint24_be_unchecked (GstByteReader * reader);
291 guint32 gst_byte_reader_peek_uint24_le_unchecked (GstByteReader * reader);
292 guint32 gst_byte_reader_peek_uint24_be_unchecked (GstByteReader * reader);
293 gint32 gst_byte_reader_get_int24_le_unchecked (GstByteReader * reader);
294 gint32 gst_byte_reader_get_int24_be_unchecked (GstByteReader * reader);
295 gint32 gst_byte_reader_peek_int24_le_unchecked (GstByteReader * reader);
296 gint32 gst_byte_reader_peek_int24_be_unchecked (GstByteReader * reader);
299 * gst_byte_reader_get_uint32_le_unchecked:
300 * @reader: a #GstByteReader instance
302 * Read an unsigned 32 bit integer in little endian format without checking
303 * if there are enough bytes available in the byte reader and update the
306 * Returns: unsigned 32 bit integer.
311 * gst_byte_reader_peek_uint32_le_unchecked:
312 * @reader: a #GstByteReader instance
314 * Read an unsigned 32 bit integer in little endian format without checking
315 * if there are enough bytes available in the byte reader, but do not advance
316 * the current position.
318 * Returns: unsigned 32 bit integer.
323 * gst_byte_reader_get_uint32_be_unchecked:
324 * @reader: a #GstByteReader instance
326 * Read an unsigned 32 bit integer in big endian format without checking
327 * if there are enough bytes available in the byte reader and update the
330 * Returns: unsigned 32 bit integer.
335 * gst_byte_reader_peek_uint32_be_unchecked:
336 * @reader: a #GstByteReader instance
338 * Read an unsigned 32 bit integer in big endian format without checking
339 * if there are enough bytes available in the byte reader, but do not advance
340 * the current position.
342 * Returns: unsigned 32 bit integer.
347 * gst_byte_reader_get_int32_le_unchecked:
348 * @reader: a #GstByteReader instance
350 * Read a signed 32 bit integer in little endian format without checking
351 * if there are enough bytes available in the byte reader and update the
354 * Returns: signed 32 bit integer.
359 * gst_byte_reader_peek_int32_le_unchecked:
360 * @reader: a #GstByteReader instance
362 * Read a signed 32 bit integer in little endian format without checking
363 * if there are enough bytes available in the byte reader, but do not advance
364 * the current position.
366 * Returns: signed 32 bit integer.
371 * gst_byte_reader_get_int32_be_unchecked:
372 * @reader: a #GstByteReader instance
374 * Read a signed 32 bit integer in big endian format without checking
375 * if there are enough bytes available in the byte reader and update the
378 * Returns: signed 32 bit integer.
383 * gst_byte_reader_peek_int32_be_unchecked:
384 * @reader: a #GstByteReader instance
386 * Read a signed 32 bit integer in big endian format without checking
387 * if there are enough bytes available in the byte reader, but do not advance
388 * the current position.
390 * Returns: signed 32 bit integer.
394 guint32 gst_byte_reader_get_uint32_le_unchecked (GstByteReader * reader);
395 guint32 gst_byte_reader_get_uint32_be_unchecked (GstByteReader * reader);
396 guint32 gst_byte_reader_peek_uint32_le_unchecked (GstByteReader * reader);
397 guint32 gst_byte_reader_peek_uint32_be_unchecked (GstByteReader * reader);
398 gint32 gst_byte_reader_get_int32_le_unchecked (GstByteReader * reader);
399 gint32 gst_byte_reader_get_int32_be_unchecked (GstByteReader * reader);
400 gint32 gst_byte_reader_peek_int32_le_unchecked (GstByteReader * reader);
401 gint32 gst_byte_reader_peek_int32_be_unchecked (GstByteReader * reader);
404 * gst_byte_reader_get_uint64_le_unchecked:
405 * @reader: a #GstByteReader instance
407 * Read an unsigned 64 bit integer in little endian format without checking
408 * if there are enough bytes available in the byte reader and update the
411 * Returns: unsigned 64 bit integer.
416 * gst_byte_reader_peek_uint64_le_unchecked:
417 * @reader: a #GstByteReader instance
419 * Read an unsigned 64 bit integer in little endian format without checking
420 * if there are enough bytes available in the byte reader, but do not advance
421 * the current position.
423 * Returns: unsigned 64 bit integer.
428 * gst_byte_reader_get_uint64_be_unchecked:
429 * @reader: a #GstByteReader instance
431 * Read an unsigned 64 bit integer in big endian format without checking
432 * if there are enough bytes available in the byte reader and update the
435 * Returns: unsigned 64 bit integer.
440 * gst_byte_reader_peek_uint64_be_unchecked:
441 * @reader: a #GstByteReader instance
443 * Read an unsigned 64 bit integer in big endian format without checking
444 * if there are enough bytes available in the byte reader, but do not advance
445 * the current position.
447 * Returns: unsigned 64 bit integer.
452 * gst_byte_reader_get_int64_le_unchecked:
453 * @reader: a #GstByteReader instance
455 * Read a signed 64 bit integer in little endian format without checking
456 * if there are enough bytes available in the byte reader and update the
459 * Returns: signed 64 bit integer.
464 * gst_byte_reader_peek_int64_le_unchecked:
465 * @reader: a #GstByteReader instance
467 * Read a signed 64 bit integer in little endian format without checking
468 * if there are enough bytes available in the byte reader, but do not advance
469 * the current position.
471 * Returns: signed 64 bit integer.
476 * gst_byte_reader_get_int64_be_unchecked:
477 * @reader: a #GstByteReader instance
479 * Read a signed 64 bit integer in big endian format without checking
480 * if there are enough bytes available in the byte reader and update the
483 * Returns: signed 64 bit integer.
488 * gst_byte_reader_peek_int64_be_unchecked:
489 * @reader: a #GstByteReader instance
491 * Read a signed 64 bit integer in big endian format without checking
492 * if there are enough bytes available in the byte reader, but do not advance
493 * the current position.
495 * Returns: signed 64 bit integer.
499 guint64 gst_byte_reader_get_uint64_le_unchecked (GstByteReader * reader);
500 guint64 gst_byte_reader_get_uint64_be_unchecked (GstByteReader * reader);
501 guint64 gst_byte_reader_peek_uint64_le_unchecked (GstByteReader * reader);
502 guint64 gst_byte_reader_peek_uint64_be_unchecked (GstByteReader * reader);
503 gint64 gst_byte_reader_get_int64_le_unchecked (GstByteReader * reader);
504 gint64 gst_byte_reader_get_int64_be_unchecked (GstByteReader * reader);
505 gint64 gst_byte_reader_peek_int64_le_unchecked (GstByteReader * reader);
506 gint64 gst_byte_reader_peek_int64_be_unchecked (GstByteReader * reader);
509 * gst_byte_reader_get_float32_le_unchecked:
510 * @reader: a #GstByteReader instance
512 * Read a 32 bit little endian float without checking if there is enough
513 * data available and update the current position.
515 * Returns: floating point value read
520 * gst_byte_reader_peek_float32_le_unchecked:
521 * @reader: a #GstByteReader instance
523 * Read a 32 bit little endian float without checking if there is enough
524 * data available, but keep the current position.
526 * Returns: floating point value read
531 * gst_byte_reader_get_float32_be_unchecked:
532 * @reader: a #GstByteReader instance
534 * Read a 32 bit big endian float without checking if there is enough
535 * data available and update the current position.
537 * Returns: floating point value read
542 * gst_byte_reader_peek_float32_be_unchecked:
543 * @reader: a #GstByteReader instance
545 * Read a 32 bit big endian float without checking if there is enough
546 * data available, but keep the current position.
548 * Returns: floating point value read
553 * gst_byte_reader_get_float64_le_unchecked:
554 * @reader: a #GstByteReader instance
556 * Read a 64 bit little endian float without checking if there is enough
557 * data available and update the current position.
559 * Returns: double precision floating point value read
564 * gst_byte_reader_peek_float64_le_unchecked:
565 * @reader: a #GstByteReader instance
567 * Read a 64 bit little endian float without checking if there is enough
568 * data available, but keep the current position.
570 * Returns: double precision floating point value read
575 * gst_byte_reader_get_float64_be_unchecked:
576 * @reader: a #GstByteReader instance
578 * Read a 64 bit big endian float without checking if there is enough
579 * data available and update the current position.
581 * Returns: double precision floating point value read
586 * gst_byte_reader_peek_float64_be_unchecked:
587 * @reader: a #GstByteReader instance
589 * Read a 64 bit big endian float without checking if there is enough
590 * data available, but keep the current position.
592 * Returns: double precision floating point value read
597 gfloat gst_byte_reader_get_float32_le_unchecked (GstByteReader * reader);
598 gfloat gst_byte_reader_get_float32_be_unchecked (GstByteReader * reader);
599 gdouble gst_byte_reader_get_float64_le_unchecked (GstByteReader * reader);
600 gdouble gst_byte_reader_get_float64_be_unchecked (GstByteReader * reader);
602 gfloat gst_byte_reader_peek_float32_le_unchecked (GstByteReader * reader);
603 gfloat gst_byte_reader_peek_float32_be_unchecked (GstByteReader * reader);
604 gdouble gst_byte_reader_peek_float64_le_unchecked (GstByteReader * reader);
605 gdouble gst_byte_reader_peek_float64_be_unchecked (GstByteReader * reader);
608 * gst_byte_reader_peek_data_unchecked:
609 * @reader: a #GstByteReader instance
611 * Returns: (transfer none): a constant pointer to the current data position
615 const guint8 * gst_byte_reader_peek_data_unchecked (GstByteReader * reader);
617 * gst_byte_reader_get_data_unchecked:
618 * @reader: a #GstByteReader instance
619 * @size: Size in bytes
621 * Returns a constant pointer to the current data position without checking
622 * if at least @size bytes are left. Advances the current read position by
625 * Returns: (transfer none) (array length=size): a constant pointer to the
626 * current data position.
630 const guint8 * gst_byte_reader_get_data_unchecked (GstByteReader * reader, guint size);
632 * gst_byte_reader_dup_data_unchecked:
633 * @reader: a #GstByteReader instance
634 * @size: Size in bytes
636 * Returns a newly-allocated copy of the data at the current data position
637 * without checking if at least @size bytes are left. Advances the current read
638 * position by @size bytes.
640 * Free-function: g_free
642 * Returns: (transfer full) (array length=size): a newly-allocated copy of the
643 * data @size bytes in size. Free with g_free() when no longer needed.
647 guint8 * gst_byte_reader_dup_data_unchecked (GstByteReader * reader, guint size);