org.bytedeco.ffmpeg.avutil

Class AVRegionOfInterest

java.lang.Object

org.bytedeco.javacpp.Pointer

org.bytedeco.ffmpeg.avutil.AVRegionOfInterest

All Implemented Interfaces:

AutoCloseable

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

Structure describing a single Region Of Interest. When multiple regions are defined in a single side-data block, they should be ordered from most to least important - some encoders are only capable of supporting a limited number of distinct regions, so will have to truncate the list. When overlapping regions are defined, the first region containing a given area of the frame applies.

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
AVRegionOfInterest() Default native constructor.
AVRegionOfInterest(long size) Native array allocator.
AVRegionOfInterest(Pointer p) Pointer cast constructor.

Method Summary

Modifier and Type	Method and Description
int	bottom()
AVRegionOfInterest	bottom(int setter)
AVRegionOfInterest	getPointer(long i)
int	left()
AVRegionOfInterest	left(int setter)
AVRegionOfInterest	position(long position)
AVRational	qoffset() Quantisation offset.
AVRegionOfInterest	qoffset(AVRational setter)
int	right()
AVRegionOfInterest	right(int setter)
int	self_size() Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).
AVRegionOfInterest	self_size(int setter)
int	top() Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge of the frame to the left and right edges of the rectangle defining this region of interest.
AVRegionOfInterest	top(int 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

AVRegionOfInterest

public AVRegionOfInterest()

Default native constructor.

AVRegionOfInterest

public AVRegionOfInterest(long size)

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

AVRegionOfInterest

public AVRegionOfInterest(Pointer p)

Pointer cast constructor. Invokes Pointer(Pointer).

Method Detail

position

public AVRegionOfInterest position(long position)

Overrides:

position in class Pointer

getPointer

public AVRegionOfInterest getPointer(long i)

Overrides:

getPointer in class Pointer

self_size

@Cast(value="uint32_t")
public int self_size()

Must be set to the size of this data structure (that is, sizeof(AVRegionOfInterest)).

self_size

public AVRegionOfInterest self_size(int setter)

top

public int top()

Distance in pixels from the top edge of the frame to the top and bottom edges and from the left edge of the frame to the left and right edges of the rectangle defining this region of interest. The constraints on a region are encoder dependent, so the region actually affected may be slightly larger for alignment or other reasons.

top

public AVRegionOfInterest top(int setter)

bottom

public int bottom()

bottom

public AVRegionOfInterest bottom(int setter)

left

public int left()

left

public AVRegionOfInterest left(int setter)

right

public int right()

right

public AVRegionOfInterest right(int setter)

qoffset

@ByRef
public AVRational qoffset()

Quantisation offset. Must be in the range -1 to +1. A value of zero indicates no quality change. A negative value asks for better quality (less quantisation), while a positive value asks for worse quality (greater quantisation). The range is calibrated so that the extreme values indicate the largest possible offset - if the rest of the frame is encoded with the worst possible quality, an offset of -1 indicates that this region should be encoded with the best possible quality anyway. Intermediate values are then interpolated in some codec-dependent way. For example, in 10-bit H.264 the quantisation parameter varies between -12 and 51. A typical qoffset value of -1/10 therefore indicates that this region should be encoded with a QP around one-tenth of the full range better than the rest of the frame. So, if most of the frame were to be encoded with a QP of around 30, this region would get a QP of around 24 (an offset of approximately -1/10 * (51 - -12) = -6.3). An extreme value of -1 would indicate that this region should be encoded with the best possible quality regardless of the treatment of the rest of the frame - that is, should be encoded at a QP of -12.

qoffset

public AVRegionOfInterest qoffset(AVRational setter)