Source repositoryvk::vk_vram_t Class Reference

Vulkan encode device that keeps converted frames in GPU memory. More...

Inheritance diagram for vk::vk_vram_t:

Collaboration diagram for vk::vk_vram_t:

Public Member Functions
void	apply_colorspace () override
	Apply the configured colorspace metadata to the active frame.
int	convert (platf::img_t &img) override
	Convert a captured frame into a Vulkan hardware frame.
int	init (int in_width, int in_height, int in_offset_x=0, int in_offset_y=0)
	Initialize Vulkan encode device and conversion resources.
void	init_codec_options (AVCodecContext *ctx, AVDictionary **options) override
	Initialize codec options.
void	init_hwframes (AVHWFramesContext *frames) override
	Configure FFmpeg Vulkan hardware frames for video encode input.
int	set_frame (AVFrame *new_frame, AVBufferRef *hw_frames_ctx_buf) override
	Attach frame resources used by the next conversion or encode operation.
Public Member Functions inherited from platf::avcodec_encode_device_t
virtual int	prepare_to_derive_context (int hw_device_type)
	Prepare to derive a context.

Additional Inherited Members
Public Types inherited from platf::avcodec_encode_device_t
using	init_hw_device_fn_t = int (*)(avcodec_encode_device_t *encode_device, AVBufferRef **hw_device_buf)
	Callback signature for backend-specific FFmpeg hardware device initialization.
Public Attributes inherited from platf::avcodec_encode_device_t
ID3D11Device *	d3d11_device = nullptr
	Native D3D11 device borrowed while the encode device is alive.
AVFrame *	frame {}
	FFmpeg frame currently owned by the encode device.
bool	hardware = false
	Whether this device supplies hardware frames instead of software conversion.
init_hw_device_fn_t	init_hw_device = nullptr
	Optional backend-specific hardware device initializer.
Public Attributes inherited from platf::encode_device_t
video::sunshine_colorspace_t	colorspace
	Colorspace metadata expected by the encoder.

Detailed Description

Vulkan encode device that keeps converted frames in GPU memory.

Member Function Documentation

apply_colorspace()

void vk::vk_vram_t::apply_colorspace ( )

inlineoverridevirtual

Apply the configured colorspace metadata to the active frame.

Reimplemented from platf::avcodec_encode_device_t.

convert()

int vk::vk_vram_t::convert ( platf::img_t & img )

inlineoverridevirtual

Convert a captured frame into a Vulkan hardware frame.

Parameters

img	Image or frame object to read from or populate.

Returns

Conversion status.

Reimplemented from platf::avcodec_encode_device_t.

init()

int vk::vk_vram_t::init ( int in_width, int in_height, int in_offset_x = 0, int in_offset_y = 0 )

inline

Initialize Vulkan encode device and conversion resources.

Parameters

in_width	In width.
in_height	In height.
in_offset_x	In offset x.
in_offset_y	In offset y.

Returns

0 on success; nonzero or negative platform status on failure.

init_codec_options()

void vk::vk_vram_t::init_codec_options ( AVCodecContext * ctx, AVDictionary ** options )

inlineoverridevirtual

Initialize codec options.

Parameters

ctx	Native context object used by the operation or callback.
options	Request options or socket options to apply.

Reimplemented from platf::avcodec_encode_device_t.

init_hwframes()

void vk::vk_vram_t::init_hwframes ( AVHWFramesContext * frames )

inlineoverridevirtual

Configure FFmpeg Vulkan hardware frames for video encode input.

Parameters

frames

FFmpeg hardware frames context to initialize.

Reimplemented from platf::avcodec_encode_device_t.

set_frame()

int vk::vk_vram_t::set_frame ( AVFrame * new_frame, AVBufferRef * hw_frames_ctx_buf )

inlineoverridevirtual

Attach frame resources used by the next conversion or encode operation.

Parameters

new_frame	Frame to attach.
hw_frames_ctx_buf	Hardware frames context buffer.

Returns

Status from updating frame.

Reimplemented from platf::avcodec_encode_device_t.

---

The documentation for this class was generated from the following file:

• src/platform/linux/vulkan_encode.cpp