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., 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 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.
37 void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
40 * gst_bit_reader_skip_to_byte_unchecked:
41 * @reader: a #GstBitReader instance
43 * Skips until the next byte without checking if there are enough bits
44 * available in the bit reader.
48 void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader);
51 * gst_bit_reader_get_bits_uint8_unchecked:
52 * @reader: a #GstBitReader instance
53 * @nbits: number of bits to read
55 * Read @nbits bits into @val and update the current position without
56 * checking if there are enough bits available in the bit reader.
58 * Returns: unsigned 8 bit integer with the bits.
62 guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits);
65 * gst_bit_reader_peek_bits_uint8_unchecked:
66 * @reader: a #GstBitReader instance
67 * @nbits: number of bits to read
69 * Read @nbits bits into @val but keep the current position without
70 * checking if there are enough bits available in the bit reader
72 * Returns: unsigned 8 bit integer with the bits.
76 guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits);
79 * gst_bit_reader_get_bits_uint16_unchecked:
80 * @reader: a #GstBitReader instance
81 * @nbits: number of bits to read
83 * Read @nbits bits into @val and update the current position without
84 * checking if there are enough bits available in the bit reader.
86 * Returns: unsigned 16 bit integer with the bits.
90 guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits);
93 * gst_bit_reader_peek_bits_uint16_unchecked:
94 * @reader: a #GstBitReader instance
95 * @nbits: number of bits to read
97 * Read @nbits bits into @val but keep the current position without
98 * checking if there are enough bits available in the bit reader
100 * Returns: unsigned 16 bit integer with the bits.
104 guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits);
107 * gst_bit_reader_get_bits_uint32_unchecked:
108 * @reader: a #GstBitReader instance
109 * @nbits: number of bits to read
111 * Read @nbits bits into @val and update 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.
118 guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits);
121 * gst_bit_reader_peek_bits_uint32_unchecked:
122 * @reader: a #GstBitReader instance
123 * @nbits: number of bits to read
125 * Read @nbits bits into @val but keep the current position without
126 * checking if there are enough bits available in the bit reader
128 * Returns: unsigned 32 bit integer with the bits.
132 guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits);
135 * gst_bit_reader_get_bits_uint64_unchecked:
136 * @reader: a #GstBitReader instance
137 * @nbits: number of bits to read
139 * Read @nbits bits into @val and update the current position without
140 * checking if there are enough bits available in the bit reader.
142 * Returns: unsigned 64 bit integer with the bits.
146 guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits);
149 * gst_bit_reader_peek_bits_uint16_unchecked:
150 * @reader: a #GstBitReader instance
151 * @nbits: number of bits to read
153 * Read @nbits bits into @val but keep the current position without
154 * checking if there are enough bits available in the bit reader
156 * Returns: unsigned 64 bit integer with the bits.
160 guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits);