org.bytedeco.ffmpeg.avutil

Class ff_pad_helper_AVBPrint

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ffmpeg.avutil.ff_pad_helper_AVBPrint

All Implemented Interfaces:

AutoCloseable

@Properties(inherit=avutil.class)
public class ff_pad_helper_AVBPrint
extends Pointer

Buffer to print data progressively The string buffer grows as necessary and is always 0-terminated. The content of the string is never accessed, and thus is encoding-agnostic and can even hold binary data. Small buffers are kept in the structure itself, and thus require no memory allocation at all (unless the contents of the buffer is needed after the structure goes out of scope). This is almost as lightweight as declaring a local char buf[512]. The length of the string can go beyond the allocated size: the buffer is then truncated, but the functions still keep account of the actual total length. In other words, AVBPrint.len can be greater than AVBPrint.size and records the total length of what would have been to the buffer if there had been enough memory. Append operations do not need to be tested for failure: if a memory allocation fails, data stop being appended to the buffer, but the length is still updated. This situation can be tested with av_bprint_is_complete(). The AVBPrint.size_max field determines several possible behaviours: - size_max = -1 (= UINT_MAX) or any large value will let the buffer be reallocated as necessary, with an amortized linear cost. - size_max = 0 prevents writing anything to the buffer: only the total length is computed. The write operations can then possibly be repeated in a buffer with exactly the necessary size (using size_init = size_max = len + 1). - size_max = 1 is automatically replaced by the exact size available in the structure itself, thus ensuring no dynamic memory allocation. The internal buffer is large enough to hold a reasonable paragraph of text, such as the current paragraph.

Nested Class Summary

Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer

Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

address, capacity, limit, position

Constructor Summary

Constructors

Constructor and Description
ff_pad_helper_AVBPrint() Default native constructor.
ff_pad_helper_AVBPrint(long size) Native array allocator.
ff_pad_helper_AVBPrint(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
ff_pad_helper_AVBPrint	getPointer(long i)
int	len() length so far
ff_pad_helper_AVBPrint	len(int setter)
ff_pad_helper_AVBPrint	position(long position)
BytePointer	reserved_internal_buffer()
byte	reserved_internal_buffer(int i)
ff_pad_helper_AVBPrint	reserved_internal_buffer(int i, byte setter)
int	size_max() maximum allocated memory
ff_pad_helper_AVBPrint	size_max(int setter)
int	size() allocated memory
ff_pad_helper_AVBPrint	size(int setter)
BytePointer	str() string so far
ff_pad_helper_AVBPrint	str(BytePointer setter)

Methods inherited from class org.bytedeco.javacpp.Pointer

address, asBuffer, asByteBuffer, availablePhysicalBytes, calloc, capacity, capacity, close, deallocate, deallocate, deallocateReferences, deallocator, deallocator, equals, fill, formatBytes, free, getDirectBufferAddress, getPointer, getPointer, getPointer, hashCode, interruptDeallocatorThread, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, physicalBytesInaccurate, position, put, realloc, referenceCount, releaseReference, retainReference, setNull, sizeof, sizeof, toString, totalBytes, totalCount, totalPhysicalBytes, withDeallocator, zero

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ff_pad_helper_AVBPrint

public ff_pad_helper_AVBPrint()

Default native constructor.

ff_pad_helper_AVBPrint

public ff_pad_helper_AVBPrint(long size)

Native array allocator. Access with Pointer.position(long).

ff_pad_helper_AVBPrint

public ff_pad_helper_AVBPrint(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public ff_pad_helper_AVBPrint position(long position)

Overrides:

position in class Pointer

getPointer

public ff_pad_helper_AVBPrint getPointer(long i)

Overrides:

getPointer in class Pointer

str

@Cast(value="char*")
public BytePointer str()

string so far

str

public ff_pad_helper_AVBPrint str(BytePointer setter)

len

@Cast(value="unsigned")
public int len()

length so far

len

public ff_pad_helper_AVBPrint len(int setter)

size

@Cast(value="unsigned")
public int size()

allocated memory

size

public ff_pad_helper_AVBPrint size(int setter)

size_max

@Cast(value="unsigned")
public int size_max()

maximum allocated memory

size_max

public ff_pad_helper_AVBPrint size_max(int setter)

reserved_internal_buffer

@Cast(value="char")
public byte reserved_internal_buffer(int i)

reserved_internal_buffer

public ff_pad_helper_AVBPrint reserved_internal_buffer(int i,
                                                       byte setter)

reserved_internal_buffer

@MemberGetter
 @Cast(value="char*")
public BytePointer reserved_internal_buffer()