1 /* GStreamer bit reader dummy header for gtk-doc
2 * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
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., 51 Franklin St, Fifth Floor,
17 * Boston, MA 02110-1301, 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 gstbitreader.h.
25 #error "This header should never be included in code, it is only for gtk-doc"
28 * gst_bit_reader_skip_unchecked:
29 * @reader: a #GstBitReader instance
30 * @nbits: the number of bits to skip
32 * Skips @nbits bits of the #GstBitReader instance without checking if there
33 * are enough bits available in the bit reader.
35 void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
38 * gst_bit_reader_skip_to_byte_unchecked:
39 * @reader: a #GstBitReader instance
41 * Skips until the next byte without checking if there are enough bits
42 * available in the bit reader.
44 void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader);
47 * gst_bit_reader_get_bits_uint8_unchecked:
48 * @reader: a #GstBitReader instance
49 * @nbits: number of bits to read
51 * Read @nbits bits into @val and update the current position without
52 * checking if there are enough bits available in the bit reader.
54 * Returns: unsigned 8 bit integer with the bits.
56 guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits);
59 * gst_bit_reader_peek_bits_uint8_unchecked:
60 * @reader: a #GstBitReader instance
61 * @nbits: number of bits to read
63 * Read @nbits bits into @val but keep the current position without
64 * checking if there are enough bits available in the bit reader
66 * Returns: unsigned 8 bit integer with the bits.
68 guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits);
71 * gst_bit_reader_get_bits_uint16_unchecked:
72 * @reader: a #GstBitReader instance
73 * @nbits: number of bits to read
75 * Read @nbits bits into @val and update the current position without
76 * checking if there are enough bits available in the bit reader.
78 * Returns: unsigned 16 bit integer with the bits.
80 guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits);
83 * gst_bit_reader_peek_bits_uint16_unchecked:
84 * @reader: a #GstBitReader instance
85 * @nbits: number of bits to read
87 * Read @nbits bits into @val but keep the current position without
88 * checking if there are enough bits available in the bit reader
90 * Returns: unsigned 16 bit integer with the bits.
92 guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits);
95 * gst_bit_reader_get_bits_uint32_unchecked:
96 * @reader: a #GstBitReader instance
97 * @nbits: number of bits to read
99 * Read @nbits bits into @val and update the current position without
100 * checking if there are enough bits available in the bit reader.
102 * Returns: unsigned 32 bit integer with the bits.
104 guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits);
107 * gst_bit_reader_peek_bits_uint32_unchecked:
108 * @reader: a #GstBitReader instance
109 * @nbits: number of bits to read
111 * Read @nbits bits into @val but keep the current position without
112 * checking if there are enough bits available in the bit reader
114 * Returns: unsigned 32 bit integer with the bits.
116 guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits);
119 * gst_bit_reader_get_bits_uint64_unchecked:
120 * @reader: a #GstBitReader instance
121 * @nbits: number of bits to read
123 * Read @nbits bits into @val and update the current position without
124 * checking if there are enough bits available in the bit reader.
126 * Returns: unsigned 64 bit integer with the bits.
128 guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits);
131 * gst_bit_reader_peek_bits_uint64_unchecked:
132 * @reader: a #GstBitReader instance
133 * @nbits: number of bits to read
135 * Read @nbits bits into @val but keep the current position without
136 * checking if there are enough bits available in the bit reader
138 * Returns: unsigned 64 bit integer with the bits.
140 guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits);