BitWriter

gst.BitWriter.BitWriter provides a bit writer that can write any number of bits into a memory buffer. It provides functions for writing any number of bits into 8, 16, 32 and 64 bit variables.

class BitWriter {

protected

GstBitWriter* gstBitWriter;

protected

bool ownedRef;

GstBitWriter* getBitWriterStruct(bool transferOwnership);

void* getStruct();

this(GstBitWriter* gstBitWriter, bool ownedRef);

bool alignBytes(ubyte trailingBit);

void free();

Buffer freeAndGetBuffer();

ubyte[] freeAndGetData();

ubyte* getData();

uint getRemaining();

uint getSize();

void init();

void initWithData(ubyte[] data, bool initialized);

void initWithSize(uint size, bool fixed);

bool putBitsUint16(ushort value, uint nbits);

bool putBitsUint32(uint value, uint nbits);

bool putBitsUint64(ulong value, uint nbits);

bool putBitsUint8(ubyte value, uint nbits);

bool putBytes(ubyte* data, uint nbytes);

void reset();

Buffer resetAndGetBuffer();

ubyte[] resetAndGetData();

bool setPos(uint pos);

this();

this(ubyte* data, uint size, bool initialized);

this(uint size, bool fixed);

}

Constructors

this this(GstBitWriter* gstBitWriter, bool ownedRef): Sets our main struct and passes it to the parent class.
this this(): Creates a new, empty gst.BitWriter.BitWriter instance.
this this(ubyte* data, uint size, bool initialized): Creates a new gst.BitWriter.BitWriter instance with the given memory area. If initialized is TRUE it is possible to read size bits from the gst.BitWriter.BitWriter from the beginnig.
this this(uint size, bool fixed): Creates a gst.BitWriter.BitWriter instance with the given initial data size.

Destructor

A destructor is present on this object, but not explicitly documented in the source.

Members

Functions

alignBytes bool alignBytes(ubyte trailingBit): Write trailing bit to align last byte of data. trailing_bit can only be 1 or 0.
free void free(): Frees bitwriter and the allocated data inside.
freeAndGetBuffer Buffer freeAndGetBuffer(): Frees bitwriter without destroying the internal data, which is returned as gstreamer.Buffer
freeAndGetData ubyte[] freeAndGetData(): Frees bitwriter without destroying the internal data, which is returned.
getBitWriterStruct GstBitWriter* getBitWriterStruct(bool transferOwnership): Get the main Gtk struct
getData ubyte* getData(): Get written data pointer
getRemaining uint getRemaining()
getSize uint getSize(): Get size of written data
getStruct void* getStruct(): the main Gtk struct as a void*
init void init(): Initializes bitwriter to an empty instance.
initWithData void initWithData(ubyte[] data, bool initialized): Initializes bitwriter with the given memory area data. IF initialized is TRUE it is possible to read size bits from the gst.BitWriter.BitWriter from the beginning.
initWithSize void initWithSize(uint size, bool fixed): Initializes a gst.BitWriter.BitWriter instance and allocates the given data size.
putBitsUint16 bool putBitsUint16(ushort value, uint nbits): Write nbits bits of value to gst.BitWriter.BitWriter
putBitsUint32 bool putBitsUint32(uint value, uint nbits): Write nbits bits of value to gst.BitWriter.BitWriter
putBitsUint64 bool putBitsUint64(ulong value, uint nbits): Write nbits bits of value to gst.BitWriter.BitWriter
putBitsUint8 bool putBitsUint8(ubyte value, uint nbits): Write nbits bits of value to gst.BitWriter.BitWriter
putBytes bool putBytes(ubyte* data, uint nbytes): Write nbytes bytes of data to gst.BitWriter.BitWriter
reset void reset(): Resets bitwriter and frees the data if it's owned by bitwriter.
resetAndGetBuffer Buffer resetAndGetBuffer(): Resets bitwriter and returns the current data as gstreamer.Buffer
resetAndGetData ubyte[] resetAndGetData(): Resets bitwriter and returns the current data.
setPos bool setPos(uint pos)

Variables

gstBitWriter GstBitWriter* gstBitWriter;: the main Gtk struct

gst base BitWriter classes

BitWriter