gstreamer/docs/libs/tmpl/gstputbits.sgml
Wim Taymans 894215eb29 Documentation updates documented the libraries
Original commit message from CVS:
Documentation updates
documented the libraries
2000-10-22 16:27:21 +00:00

293 lines
3.5 KiB
Plaintext

<!-- ##### SECTION Title ##### -->
GstPutbits
<!-- ##### SECTION Short_Description ##### -->
Write bits into a memory buffer
<!-- ##### SECTION Long_Description ##### -->
<para>
The putbits library can be used to write out a bit stream.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### STRUCT gst_putbits_t ##### -->
<para>
</para>
@outbfr:
@outbase:
@temp:
@outcnt:
@bytecnt:
@len:
@newlen:
<!-- ##### FUNCTION gst_putbits_init ##### -->
<para>
Initialize the bit writer
</para>
@pb: the putbits structure
<!-- ##### FUNCTION gst_putbits_new_empty_buffer ##### -->
<para>
Prepare the putbits structure for writing len bytes. A new buffer
with the given length will be allocated which you must free.
</para>
@pb: the putbits structure
@len: the bytes that are going to be written
<!-- ##### FUNCTION gst_putbits_new_buffer ##### -->
<para>
Prepare the putbits structure for writing len bytes. The bits
will be written in the supplied buffer.
</para>
@pb: the putbits structure
@buffer: the buffer to write the bits in
@len: the length of the buffer
<!-- ##### FUNCTION gst_putbits_align ##### -->
<para>
Align the bits to the next byte. The buffer will be filled with zeroes.
</para>
@pb: the putbits structure
<!-- ##### FUNCTION gst_putbits_bitcount ##### -->
<para>
Get the number of bits written to the buffer
</para>
@pb: the putbits structure
@Returns: the number of bits written
<!-- ##### MACRO gst_putbits1 ##### -->
<para>
Put one bit in the buffer
</para>
@gb: the putbits structure
@val: the value of the bit to put in the buffer
<!-- ##### MACRO gst_putbits2 ##### -->
<para>
Put 2 bits into the buffer
</para>
@gb: the putbits structure
@val: the value of the bits to put in the buffer
<!-- ##### MACRO gst_putbits3 ##### -->
<para>
</para>
@gb: the putbits structure
@val:
<!-- ##### MACRO gst_putbits4 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits5 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits6 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits7 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits8 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits9 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits10 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits11 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits12 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits13 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits14 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits15 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits16 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits17 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits18 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits19 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits20 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits21 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits22 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbits32 ##### -->
<para>
</para>
@gb:
@val:
<!-- ##### MACRO gst_putbitsn ##### -->
<para>
Put a variable number of bits into the buffer
</para>
@gb: the putbits structure
@val: the value of the bits to put into the buffer
@n: the number of bits to put into the buffer