avutil.AVHWFramesContext (JavaCPP Presets for FFmpeg 4.1-1.4.4 API)

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

All Implemented Interfaces:

AutoCloseable

Enclosing class:

avutil
```
public static class avutil.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 avutil.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

Nested Classes
Modifier and Type	Class and Description
`static class`	`avutil.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
`avutil.AVClass`	`av_class()` A class for logging.
`avutil.AVHWDeviceContext`	`device_ctx()` The parent AVHWDeviceContext.
`avutil.AVHWFramesContext`	`device_ctx(avutil.AVHWDeviceContext device_ctx)`
`avutil.AVBufferRef`	`device_ref()` A reference to the parent AVHWDeviceContext.
`avutil.AVHWFramesContext`	`device_ref(avutil.AVBufferRef device_ref)`
`int`	`format()` The pixel format identifying the underlying HW surface type.
`avutil.AVHWFramesContext`	`format(int format)`
`avutil.AVHWFramesContext.Free_AVHWFramesContext`	`free()`
`avutil.AVHWFramesContext`	`free(avutil.AVHWFramesContext.Free_AVHWFramesContext free)`
`int`	`height()`
`avutil.AVHWFramesContext`	`height(int height)`
`Pointer`	`hwctx()` The format-specific data, allocated and freed automatically along with this context.
`avutil.AVHWFramesContext`	`hwctx(Pointer hwctx)`
`int`	`initial_pool_size()` Initial size of the frame pool.
`avutil.AVHWFramesContext`	`initial_pool_size(int initial_pool_size)`
`avutil.AVHWFramesInternal`	`internal()` Private data used internally by libavutil.
`avutil.AVHWFramesContext`	`internal(avutil.AVHWFramesInternal internal)`
`avutil.AVBufferPool`	`pool()` A pool from which the frames are allocated by av_hwframe_get_buffer().
`avutil.AVHWFramesContext`	`pool(avutil.AVBufferPool pool)`
`avutil.AVHWFramesContext`	`position(long position)`
`int`	`sw_format()` The pixel format identifying the actual data layout of the hardware frames.
`avutil.AVHWFramesContext`	`sw_format(int sw_format)`
`Pointer`	`user_opaque()` Arbitrary user data, to be used e.g.
`avutil.AVHWFramesContext`	`user_opaque(Pointer user_opaque)`
`int`	`width()` The allocated dimensions of the frames in this pool.
`avutil.AVHWFramesContext`	`width(int width)`

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, hashCode, isNull, limit, limit, malloc, maxBytes, maxPhysicalBytes, memchr, memcmp, memcpy, memmove, memset, offsetof, parseBytes, physicalBytes, position, put, realloc, setNull, sizeof, toString, totalBytes, 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(Pointer).
- Method Detail
  - position
```
public avutil.AVHWFramesContext position(long position)
```
    Overrides:
    
    position in class Pointer
  - av_class
```
@MemberGetter
 @Const
public avutil.AVClass av_class()
```
    A class for logging.
  - internal
```
public avutil.AVHWFramesInternal internal()
```
    Private data used internally by libavutil. Must not be accessed in any way by the caller.
  - internal
```
public avutil.AVHWFramesContext internal(avutil.AVHWFramesInternal internal)
```
  - device_ref
```
public avutil.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 avutil.AVHWFramesContext device_ref(avutil.AVBufferRef device_ref)
```
  - device_ctx
```
public avutil.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 avutil.AVHWFramesContext device_ctx(avutil.AVHWDeviceContext device_ctx)
```
  - 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 avutil.AVHWFramesContext hwctx(Pointer hwctx)
```
  - free
```
public avutil.AVHWFramesContext.Free_AVHWFramesContext free()
```
  - free
```
public avutil.AVHWFramesContext free(avutil.AVHWFramesContext.Free_AVHWFramesContext free)
```
  - user_opaque
```
public Pointer user_opaque()
```
    Arbitrary user data, to be used e.g. by the free() callback.
  - user_opaque
```
public avutil.AVHWFramesContext user_opaque(Pointer user_opaque)
```
  - pool
```
public avutil.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 avutil.AVHWFramesContext pool(avutil.AVBufferPool pool)
```
  - 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 avutil.AVHWFramesContext initial_pool_size(int initial_pool_size)
```
  - 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 avutil.AVHWFramesContext format(int format)
```
  - 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 avutil.AVHWFramesContext sw_format(int sw_format)
```
  - 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 avutil.AVHWFramesContext width(int width)
```
  - height
```
public int height()
```
  - height
```
public avutil.AVHWFramesContext height(int height)
```

Class avutil.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

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