aboutsummaryrefslogtreecommitdiff
path: root/libs/gst/base/gstbitreader-docs.h
blob: ee1a04fd5479a3e813c56cf2382bf3669eecbb92 (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
/* GStreamer bit reader 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., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, 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_bit_reader_skip_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: the number of bits to skip
 *
 * Skips @nbits bits of the #GstBitReader instance without checking if there
 * are enough bits available in the bit reader.
 *
 * Since: 0.10.31
 */
void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);

/**
 * gst_bit_reader_skip_to_byte_unchecked:
 * @reader: a #GstBitReader instance
 *
 * Skips until the next byte without checking if there are enough bits
 * available in the bit reader.
 * 
 * Since: 0.10.31
 */
void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader);

/**
 * gst_bit_reader_get_bits_uint8_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val and update the current position without
 * checking if there are enough bits available in the bit reader.
 *
 * Returns: unsigned 8 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_peek_bits_uint8_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val but keep the current position without
 * checking if there are enough bits available in the bit reader
 *
 * Returns: unsigned 8 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_get_bits_uint16_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val and update the current position without
 * checking if there are enough bits available in the bit reader.
 *
 * Returns: unsigned 16 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_peek_bits_uint16_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val but keep the current position without
 * checking if there are enough bits available in the bit reader
 *
 * Returns: unsigned 16 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_get_bits_uint32_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val and update the current position without
 * checking if there are enough bits available in the bit reader.
 *
 * Returns: unsigned 32 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_peek_bits_uint32_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val but keep the current position without
 * checking if there are enough bits available in the bit reader
 *
 * Returns: unsigned 32 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_get_bits_uint64_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val and update the current position without
 * checking if there are enough bits available in the bit reader.
 *
 * Returns: unsigned 64 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits);

/**
 * gst_bit_reader_peek_bits_uint16_unchecked:
 * @reader: a #GstBitReader instance
 * @nbits: number of bits to read
 *
 * Read @nbits bits into @val but keep the current position without
 * checking if there are enough bits available in the bit reader
 *
 * Returns: unsigned 64 bit integer with the bits.
 * 
 * Since: 0.10.31
 */
guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits);