AVHWFramesContext (JavaCPP Presets for FFmpeg 4.4-1.5.6 API)

java.lang.Object
- org.bytedeco.javacpp.Pointer
- - org.bytedeco.ffmpeg.avutil.AVHWFramesContext

All Implemented Interfaces:

AutoCloseable
```
@Properties(inherit=avutil.class)
public class AVHWFramesContext
extends Pointer
```
This struct describes a set or pool of "hardware" frames (i.e. those with data not located in normal system memory). All the frames in the pool are assumed to be allocated in the same way and interchangeable. This struct is reference-counted with the AVBuffer mechanism and tied to a given AVHWDeviceContext instance. The av_hwframe_ctx_alloc() constructor yields a reference, whose data field points to the actual AVHWFramesContext struct.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class AVHWFramesContext.Free_AVHWFramesContext
This field may be set by the caller before calling av_hwframe_ctx_init().
- Nested classes/interfaces inherited from class org.bytedeco.javacpp.Pointer
  Pointer.CustomDeallocator, Pointer.Deallocator, Pointer.NativeDeallocator, Pointer.ReferenceCounter

Nested Classes
Modifier and Type	Class and Description
`static class`	`AVHWFramesContext.Free_AVHWFramesContext` This field may be set by the caller before calling av_hwframe_ctx_init().

Field Summary
- Fields inherited from class org.bytedeco.javacpp.Pointer
  address, capacity, limit, position

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AVHWFramesContext.Free_AVHWFramesContext`	`_free()`
`AVHWFramesContext`	`_free(AVHWFramesContext.Free_AVHWFramesContext setter)`
`AVClass`	`av_class()` A class for logging.
`AVHWFramesContext`	`av_class(AVClass setter)`
`AVHWDeviceContext`	`device_ctx()` The parent AVHWDeviceContext.
`AVHWFramesContext`	`device_ctx(AVHWDeviceContext setter)`
`AVBufferRef`	`device_ref()` A reference to the parent AVHWDeviceContext.
`AVHWFramesContext`	`device_ref(AVBufferRef setter)`
`int`	`format()` The pixel format identifying the underlying HW surface type.
`AVHWFramesContext`	`format(int setter)`
`AVHWFramesContext`	`getPointer(long i)`
`int`	`height()`
`AVHWFramesContext`	`height(int setter)`
`Pointer`	`hwctx()` The format-specific data, allocated and freed automatically along with this context.
`AVHWFramesContext`	`hwctx(Pointer setter)`
`int`	`initial_pool_size()` Initial size of the frame pool.
`AVHWFramesContext`	`initial_pool_size(int setter)`
`AVHWFramesInternal`	`internal()` Private data used internally by libavutil.
`AVHWFramesContext`	`internal(AVHWFramesInternal setter)`
`AVBufferPool`	`pool()` A pool from which the frames are allocated by av_hwframe_get_buffer().
`AVHWFramesContext`	`pool(AVBufferPool setter)`
`AVHWFramesContext`	`position(long position)`
`int`	`sw_format()` The pixel format identifying the actual data layout of the hardware frames.
`AVHWFramesContext`	`sw_format(int setter)`
`Pointer`	`user_opaque()` Arbitrary user data, to be used e.g.
`AVHWFramesContext`	`user_opaque(Pointer setter)`
`int`	`width()` The allocated dimensions of the frames in this pool.
`AVHWFramesContext`	`width(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, getPointer, getPointer, getPointer, hashCode, isNull, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetAddress, offsetof, offsetof, parseBytes, physicalBytes, 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
  - AVHWFramesContext
```
public AVHWFramesContext()
```
    Default native constructor.
  - AVHWFramesContext
```
public AVHWFramesContext(long size)
```
    Native array allocator. Access with Pointer.position(long).
  - AVHWFramesContext
```
public AVHWFramesContext(Pointer p)
```
    Pointer cast constructor. Invokes Pointer(Pointer).
- Method Detail
  - position
```
public AVHWFramesContext position(long position)
```
    Overrides:
    
    position in class Pointer
  - getPointer
```
public AVHWFramesContext getPointer(long i)
```
    Overrides:
    
    getPointer in class Pointer
  - av_class
```
@Const
public AVClass av_class()
```
    A class for logging.
  - av_class
```
public AVHWFramesContext av_class(AVClass setter)
```
  - internal
```
public AVHWFramesInternal internal()
```
    Private data used internally by libavutil. Must not be accessed in any way by the caller.
  - internal
```
public AVHWFramesContext internal(AVHWFramesInternal setter)
```
  - device_ref
```
public AVBufferRef device_ref()
```
    A reference to the parent AVHWDeviceContext. This reference is owned and managed by the enclosing AVHWFramesContext, but the caller may derive additional references from it.
  - device_ref
```
public AVHWFramesContext device_ref(AVBufferRef setter)
```
  - device_ctx
```
public AVHWDeviceContext device_ctx()
```
    The parent AVHWDeviceContext. This is simply a pointer to device_ref->data provided for convenience. Set by libavutil in av_hwframe_ctx_init().
  - device_ctx
```
public AVHWFramesContext device_ctx(AVHWDeviceContext setter)
```
  - hwctx
```
public Pointer hwctx()
```
    The format-specific data, allocated and freed automatically along with this context. Should be cast by the user to the format-specific context defined in the corresponding header (hwframe_*.h) and filled as described in the documentation before calling av_hwframe_ctx_init(). After any frames using this context are created, the contents of this struct should not be modified by the caller.
  - hwctx
```
public AVHWFramesContext hwctx(Pointer setter)
```
  - _free
```
@Name(value="free")
public AVHWFramesContext.Free_AVHWFramesContext _free()
```
  - _free
```
public AVHWFramesContext _free(AVHWFramesContext.Free_AVHWFramesContext setter)
```
  - user_opaque
```
public Pointer user_opaque()
```
    Arbitrary user data, to be used e.g. by the free() callback.
  - user_opaque
```
public AVHWFramesContext user_opaque(Pointer setter)
```
  - pool
```
public AVBufferPool pool()
```
    A pool from which the frames are allocated by av_hwframe_get_buffer(). This field may be set by the caller before calling av_hwframe_ctx_init(). The buffers returned by calling av_buffer_pool_get() on this pool must have the properties described in the documentation in the corresponding hw type's header (hwcontext_*.h). The pool will be freed strictly before this struct's free() callback is invoked. This field may be NULL, then libavutil will attempt to allocate a pool internally. Note that certain device types enforce pools allocated at fixed size (frame count), which cannot be extended dynamically. In such a case, initial_pool_size must be set appropriately.
  - pool
```
public AVHWFramesContext pool(AVBufferPool setter)
```
  - initial_pool_size
```
public int initial_pool_size()
```
    Initial size of the frame pool. If a device type does not support dynamically resizing the pool, then this is also the maximum pool size. May be set by the caller before calling av_hwframe_ctx_init(). Must be set if pool is NULL and the device type does not support dynamic pools.
  - initial_pool_size
```
public AVHWFramesContext initial_pool_size(int setter)
```
  - format
```
@Cast(value="AVPixelFormat")
public int format()
```
    The pixel format identifying the underlying HW surface type. Must be a hwaccel format, i.e. the corresponding descriptor must have the AV_PIX_FMT_FLAG_HWACCEL flag set. Must be set by the user before calling av_hwframe_ctx_init().
  - format
```
public AVHWFramesContext format(int setter)
```
  - sw_format
```
@Cast(value="AVPixelFormat")
public int sw_format()
```
    The pixel format identifying the actual data layout of the hardware frames. Must be set by the caller before calling av_hwframe_ctx_init(). \note when the underlying API does not provide the exact data layout, but only the colorspace/bit depth, this field should be set to the fully planar version of that format (e.g. for 8-bit 420 YUV it should be AV_PIX_FMT_YUV420P, not AV_PIX_FMT_NV12 or anything else).
  - sw_format
```
public AVHWFramesContext sw_format(int setter)
```
  - width
```
public int width()
```
    The allocated dimensions of the frames in this pool. Must be set by the user before calling av_hwframe_ctx_init().
  - width
```
public AVHWFramesContext width(int setter)
```
  - height
```
public int height()
```
  - height
```
public AVHWFramesContext height(int setter)
```

Class AVHWFramesContext

Nested Class Summary

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

Field Summary

Fields inherited from class org.bytedeco.javacpp.Pointer

Constructor Summary

Method Summary

Methods inherited from class org.bytedeco.javacpp.Pointer

Methods inherited from class java.lang.Object

Constructor Detail

AVHWFramesContext

AVHWFramesContext

AVHWFramesContext

Method Detail

position

getPointer

av_class

av_class

internal

internal

device_ref

device_ref

device_ctx

device_ctx

hwctx

hwctx

_free

_free

user_opaque

user_opaque

pool

pool

initial_pool_size

initial_pool_size

format

format

sw_format

sw_format

width

width

height

height