| 1 |
/* |
| 2 |
* GStreamer bit writer dummy header for gtk-doc |
| 3 |
* |
| 4 |
* Copyright (C) 2013 Intel Corporation |
| 5 |
* |
| 6 |
* This library is free software; you can redistribute it and/or |
| 7 |
* modify it under the terms of the GNU Lesser General Public License |
| 8 |
* as published by the Free Software Foundation; either version 2.1 |
| 9 |
* of the License, or (at your option) any later version. |
| 10 |
* |
| 11 |
* This library is distributed in the hope that it will be useful, |
| 12 |
* but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 13 |
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU |
| 14 |
* Lesser General Public License for more details. |
| 15 |
* |
| 16 |
* You should have received a copy of the GNU Lesser General Public |
| 17 |
* License along with this library; if not, write to the Free |
| 18 |
* Software Foundation, Inc., 51 Franklin Street, Fifth Floor, |
| 19 |
* Boston, MA 02110-1301 USA |
| 20 |
*/ |
| 21 |
|
| 22 |
/* This header is not installed, it just contains stuff for gtk-doc to parse, |
| 23 |
* in particular docs and some dummy function declarations for the static |
| 24 |
* inline functions we generate via macros in gstbitwriter.h. |
| 25 |
*/ |
| 26 |
|
| 27 |
#error "This header should never be included in code, it is only for gtk-doc" |
| 28 |
|
| 29 |
/** |
| 30 |
* gst_bit_writer_put_bits_uint8_unchecked: |
| 31 |
* @bitwriter: a #GstBitWriter instance |
| 32 |
* @value: value of #guint8 to write |
| 33 |
* @nbits: number of bits to write |
| 34 |
* |
| 35 |
* Write @nbits bits of @value to #GstBitWriter without checking whether |
| 36 |
* there is enough space |
| 37 |
*/ |
| 38 |
void gst_bit_writer_put_bits_uint8_unchecked (GstBitWriter *bitwriter, guint8 value, guint nbits); |
| 39 |
|
| 40 |
/** |
| 41 |
* gst_bit_writer_put_bits_uint16_unchecked: |
| 42 |
* @bitwriter: a #GstBitWriter instance |
| 43 |
* @value: value of #guint16 to write |
| 44 |
* @nbits: number of bits to write |
| 45 |
* |
| 46 |
* Write @nbits bits of @value to #GstBitWriter without checking whether |
| 47 |
* there is enough space |
| 48 |
*/ |
| 49 |
void gst_bit_writer_put_bits_uint16_unchecked (GstBitWriter *bitwriter, guint16 value, guint nbits); |
| 50 |
|
| 51 |
/** |
| 52 |
* gst_bit_writer_put_bits_uint32_unchecked: |
| 53 |
* @bitwriter: a #GstBitWriter instance |
| 54 |
* @value: value of #guint32 to write |
| 55 |
* @nbits: number of bits to write |
| 56 |
* |
| 57 |
* Write @nbits bits of @value to #GstBitWriter without checking whether |
| 58 |
* there is enough space |
| 59 |
*/ |
| 60 |
void gst_bit_writer_put_bits_uint32_unchecked (GstBitWriter *bitwriter, guint32 value, guint nbits); |
| 61 |
|
| 62 |
/** |
| 63 |
* gst_bit_writer_put_bits_uint64_unchecked: |
| 64 |
* @bitwriter: a #GstBitWriter instance |
| 65 |
* @value: value of #guint64 to write |
| 66 |
* @nbits: number of bits to write |
| 67 |
* |
| 68 |
* Write @nbits bits of @value to #GstBitWriter without checking whether |
| 69 |
* there is enough space |
| 70 |
*/ |
| 71 |
void gst_bit_writer_put_bits_uint64_unchecked (GstBitWriter *bitwriter, guint64 value, guint nbits); |
| 72 |
|
| 73 |
/** |
| 74 |
* gst_bit_writer_put_bytes_unchecked: |
| 75 |
* @bitwriter: a #GstBitWriter instance |
| 76 |
* @data: pointer of data to write |
| 77 |
* @nbytes: number of bytes to write |
| 78 |
* |
| 79 |
* Write @nbytes bytes of @data to #GstBitWriter without checking whether |
| 80 |
* there is enough space |
| 81 |
*/ |
| 82 |
void gst_bit_writer_put_bytes_unchecked (GstBitWriter *bitwriter, const guint8 *data, guint nbytes); |
| 83 |
|
| 84 |
/** |
| 85 |
* gst_bit_writer_align_bytes_unchecked: |
| 86 |
* @bitwriter: a #GstBitWriter instance |
| 87 |
* @trailing_bit: trailing bits of last byte, 0 or 1 |
| 88 |
* |
| 89 |
* Write trailing bit to align last byte of @data without checking whether there |
| 90 |
* is enough space |
| 91 |
*/ |
| 92 |
void gst_bit_writer_align_bytes_unchecked (GstBitWriter *bitwriter, guint8 trailing_bit); |