| 1 |
/* GStreamer bit reader dummy header for gtk-doc |
| 2 |
* Copyright (C) 2010 Sebastian Dröge <[email protected]> |
| 3 |
* |
| 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. |
| 8 |
* |
| 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. |
| 13 |
* |
| 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. |
| 18 |
*/ |
| 19 |
|
| 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. |
| 23 |
*/ |
| 24 |
|
| 25 |
#error "This header should never be included in code, it is only for gtk-doc" |
| 26 |
|
| 27 |
/** |
| 28 |
* gst_bit_reader_skip_unchecked: |
| 29 |
* @reader: a #GstBitReader instance |
| 30 |
* @nbits: the number of bits to skip |
| 31 |
* |
| 32 |
* Skips @nbits bits of the #GstBitReader instance without checking if there |
| 33 |
* are enough bits available in the bit reader. |
| 34 |
*/ |
| 35 |
void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits); |
| 36 |
|
| 37 |
/** |
| 38 |
* gst_bit_reader_skip_to_byte_unchecked: |
| 39 |
* @reader: a #GstBitReader instance |
| 40 |
* |
| 41 |
* Skips until the next byte without checking if there are enough bits |
| 42 |
* available in the bit reader. |
| 43 |
*/ |
| 44 |
void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader); |
| 45 |
|
| 46 |
/** |
| 47 |
* gst_bit_reader_get_bits_uint8_unchecked: |
| 48 |
* @reader: a #GstBitReader instance |
| 49 |
* @nbits: number of bits to read |
| 50 |
* |
| 51 |
* Read @nbits bits into @val and update the current position without |
| 52 |
* checking if there are enough bits available in the bit reader. |
| 53 |
* |
| 54 |
* Returns: unsigned 8 bit integer with the bits. |
| 55 |
*/ |
| 56 |
guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits); |
| 57 |
|
| 58 |
/** |
| 59 |
* gst_bit_reader_peek_bits_uint8_unchecked: |
| 60 |
* @reader: a #GstBitReader instance |
| 61 |
* @nbits: number of bits to read |
| 62 |
* |
| 63 |
* Read @nbits bits into @val but keep the current position without |
| 64 |
* checking if there are enough bits available in the bit reader |
| 65 |
* |
| 66 |
* Returns: unsigned 8 bit integer with the bits. |
| 67 |
*/ |
| 68 |
guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits); |
| 69 |
|
| 70 |
/** |
| 71 |
* gst_bit_reader_get_bits_uint16_unchecked: |
| 72 |
* @reader: a #GstBitReader instance |
| 73 |
* @nbits: number of bits to read |
| 74 |
* |
| 75 |
* Read @nbits bits into @val and update the current position without |
| 76 |
* checking if there are enough bits available in the bit reader. |
| 77 |
* |
| 78 |
* Returns: unsigned 16 bit integer with the bits. |
| 79 |
*/ |
| 80 |
guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits); |
| 81 |
|
| 82 |
/** |
| 83 |
* gst_bit_reader_peek_bits_uint16_unchecked: |
| 84 |
* @reader: a #GstBitReader instance |
| 85 |
* @nbits: number of bits to read |
| 86 |
* |
| 87 |
* Read @nbits bits into @val but keep the current position without |
| 88 |
* checking if there are enough bits available in the bit reader |
| 89 |
* |
| 90 |
* Returns: unsigned 16 bit integer with the bits. |
| 91 |
*/ |
| 92 |
guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits); |
| 93 |
|
| 94 |
/** |
| 95 |
* gst_bit_reader_get_bits_uint32_unchecked: |
| 96 |
* @reader: a #GstBitReader instance |
| 97 |
* @nbits: number of bits to read |
| 98 |
* |
| 99 |
* Read @nbits bits into @val and update the current position without |
| 100 |
* checking if there are enough bits available in the bit reader. |
| 101 |
* |
| 102 |
* Returns: unsigned 32 bit integer with the bits. |
| 103 |
*/ |
| 104 |
guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits); |
| 105 |
|
| 106 |
/** |
| 107 |
* gst_bit_reader_peek_bits_uint32_unchecked: |
| 108 |
* @reader: a #GstBitReader instance |
| 109 |
* @nbits: number of bits to read |
| 110 |
* |
| 111 |
* Read @nbits bits into @val but keep the current position without |
| 112 |
* checking if there are enough bits available in the bit reader |
| 113 |
* |
| 114 |
* Returns: unsigned 32 bit integer with the bits. |
| 115 |
*/ |
| 116 |
guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits); |
| 117 |
|
| 118 |
/** |
| 119 |
* gst_bit_reader_get_bits_uint64_unchecked: |
| 120 |
* @reader: a #GstBitReader instance |
| 121 |
* @nbits: number of bits to read |
| 122 |
* |
| 123 |
* Read @nbits bits into @val and update the current position without |
| 124 |
* checking if there are enough bits available in the bit reader. |
| 125 |
* |
| 126 |
* Returns: unsigned 64 bit integer with the bits. |
| 127 |
*/ |
| 128 |
guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits); |
| 129 |
|
| 130 |
/** |
| 131 |
* gst_bit_reader_peek_bits_uint64_unchecked: |
| 132 |
* @reader: a #GstBitReader instance |
| 133 |
* @nbits: number of bits to read |
| 134 |
* |
| 135 |
* Read @nbits bits into @val but keep the current position without |
| 136 |
* checking if there are enough bits available in the bit reader |
| 137 |
* |
| 138 |
* Returns: unsigned 64 bit integer with the bits. |
| 139 |
*/ |
| 140 |
guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits); |
| 141 |
|