libs/gst/base/gstbitreader-docs.h

   1 /* GStreamer bit reader dummy header for gtk-doc
   2  * Copyright (C) 2010 Sebastian Dröge <sebastian.droege@collabora.co.uk>
   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., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, 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  * Returns: %TRUE if @nbits bits could be skipped, %FALSE otherwise.
  36  *
  37  * Since: 0.10.31
  38  */
  39 void gst_bit_reader_skip_unchecked (GstBitReader * reader, guint nbits);
  40
  41 /**
  42  * gst_bit_reader_skip_to_byte_unchecked:
  43  * @reader: a #GstBitReader instance
  44  *
  45  * Skips until the next byte without checking if there are enough bits
  46  * available in the bit reader.
  47  *
  48  * Returns: %TRUE if successful, %FALSE otherwise.
  49  *
  50  * Since: 0.10.31
  51  */
  52 void gst_bit_reader_skip_to_byte_unchecked (GstBitReader * reader);
  53
  54 /**
  55  * gst_bit_reader_get_bits_uint8_unchecked:
  56  * @reader: a #GstBitReader instance
  57  * @nbits: number of bits to read
  58  *
  59  * Read @nbits bits into @val and update the current position without
  60  * checking if there are enough bits available in the bit reader.
  61  *
  62  * Returns: unsigned 8 bit integer with the bits.
  63  *
  64  * Since: 0.10.31
  65  */
  66 guint8 gst_bit_reader_peek_bits_uint8_unchecked (const GstBitReader *reader, guint nbits);
  67
  68 /**
  69  * gst_bit_reader_peek_bits_uint8_unchecked:
  70  * @reader: a #GstBitReader instance
  71  * @nbits: number of bits to read
  72  *
  73  * Read @nbits bits into @val but keep the current position without
  74  * checking if there are enough bits available in the bit reader
  75  *
  76  * Returns: unsigned 8 bit integer with the bits.
  77  *
  78  * Since: 0.10.31
  79  */
  80 guint8 gst_bit_reader_get_bits_uint8_unchecked (GstBitReader *reader, guint nbits);
  81
  82 /**
  83  * gst_bit_reader_get_bits_uint16_unchecked:
  84  * @reader: a #GstBitReader instance
  85  * @nbits: number of bits to read
  86  *
  87  * Read @nbits bits into @val and update 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  * Since: 0.10.31
  93  */
  94 guint16 gst_bit_reader_peek_bits_uint16_unchecked (const GstBitReader *reader, guint nbits);
  95
  96 /**
  97  * gst_bit_reader_peek_bits_uint16_unchecked:
  98  * @reader: a #GstBitReader instance
  99  * @nbits: number of bits to read
 100  *
 101  * Read @nbits bits into @val but keep the current position without
 102  * checking if there are enough bits available in the bit reader
 103  *
 104  * Returns: unsigned 16 bit integer with the bits.
 105  *
 106  * Since: 0.10.31
 107  */
 108 guint16 gst_bit_reader_get_bits_uint16_unchecked (GstBitReader *reader, guint nbits);
 109
 110 /**
 111  * gst_bit_reader_get_bits_uint32_unchecked:
 112  * @reader: a #GstBitReader instance
 113  * @nbits: number of bits to read
 114  *
 115  * Read @nbits bits into @val and update the current position without
 116  * checking if there are enough bits available in the bit reader.
 117  *
 118  * Returns: unsigned 32 bit integer with the bits.
 119  *
 120  * Since: 0.10.31
 121  */
 122 guint32 gst_bit_reader_peek_bits_uint32_unchecked (const GstBitReader *reader, guint nbits);
 123
 124 /**
 125  * gst_bit_reader_peek_bits_uint32_unchecked:
 126  * @reader: a #GstBitReader instance
 127  * @nbits: number of bits to read
 128  *
 129  * Read @nbits bits into @val but keep the current position without
 130  * checking if there are enough bits available in the bit reader
 131  *
 132  * Returns: unsigned 32 bit integer with the bits.
 133  *
 134  * Since: 0.10.31
 135  */
 136 guint32 gst_bit_reader_get_bits_uint32_unchecked (GstBitReader *reader, guint nbits);
 137
 138 /**
 139  * gst_bit_reader_get_bits_uint64_unchecked:
 140  * @reader: a #GstBitReader instance
 141  * @nbits: number of bits to read
 142  *
 143  * Read @nbits bits into @val and update the current position without
 144  * checking if there are enough bits available in the bit reader.
 145  *
 146  * Returns: unsigned 64 bit integer with the bits.
 147  *
 148  * Since: 0.10.31
 149  */
 150 guint64 gst_bit_reader_peek_bits_uint64_unchecked (const GstBitReader *reader, guint nbits);
 151
 152 /**
 153  * gst_bit_reader_peek_bits_uint16_unchecked:
 154  * @reader: a #GstBitReader instance
 155  * @nbits: number of bits to read
 156  *
 157  * Read @nbits bits into @val but keep the current position without
 158  * checking if there are enough bits available in the bit reader
 159  *
 160  * Returns: unsigned 64 bit integer with the bits.
 161  *
 162  * Since: 0.10.31
 163  */
 164 guint64 gst_bit_reader_get_bits_uint64_unchecked (GstBitReader *reader, guint nbits);
 165