TAVCoder | Unreal Engine 5.7 Documentation

API > API/Plugins > API/Plugins/AVCodecsCore

HOW TO USE

Terms:

Domain: A specialized area of coding, such as 'video encoding', 'video decoding', 'audio decoding', 'subtitle encoding', etc.
Configuration: An external collection of parameters that determine how the coder's underlying architecture is created and operates.
Instance: The shared data cache of a coder. Contains all current state and configuration applied to a coder.
Resource: An abstract wrapper to device memory used by a coder (can be on the CPU/GPU or an external device).
Device: The physical hardware or software device that a coder operates on. Provides access to coder resources.
Packet: A segment of a raw bitstream that contains any amount of frame data. Encoders create these and decoders consume them.

TAVCoder uses an 'interleaved' inheritance model between itself and a 'domain', to support inheritance of select functionality (full, config-less, resource+config-less).

1) TVideoDecoder // Domain configuration (typed packets) 2) : TAVCoder // Common configuration (pending/apply/applied) 3) : TVideoDecoder // Domain resources (resolvable decode for decoders, encode/flush packets for encoders) 4) : TAVCoder // Common resources (unused for now) 5) : TVideoDecoder<> // Domain base (packets, flush packets for decoders) 6) : TAVCoder // Common base (factory for domain) 7) : IAVCoder // Interface base Pre-declaration of template parameters to ensure void fallback in nearly all cases, which is then specialized for use with interleaving

Common coder base with a factory, that supports typesafe resource handling and configuration.

Usage: To be inherited by a domain implementation, see top of file.


Name	TAVCoder
Type	class
Header File	/Engine/Plugins/Experimental/AVCodecs/AVCodecsCore/Source/AVCodecsCore/Public/AVCoder.h
Include Path	#include "AVCoder.h"

Syntax

template<template< typename TResource=void, typename TConfig=void > typename TDomain, typename TResource, typename TConfig>  
class TAVCoder : public TDomain< TResource >

Inheritance Hierarchy

TDomain< TResource > → TAVCoder

Derived Classes

TAVCoder derived class hierarchy

Classes

Name	Remarks
TWrapper	Wrapper coder that transforms resource/config types for use with a differently typed child coder.

Class Specializations

Name	Remarks
TAVCoder< TDomain, TResource, void >	Common coder base with a factory, that supports typesafe resource handling.
TAVCoder< TDomain, void, void >	Common coder base with a factory.

Typedefs

Name	Type	Remarks	Include Path
ConfigType	TConfig		AVCoder.h

Functions

Public

Name	Remarks	Include Path
virtual FAVResult ApplyConfig ()	Force any pending configuration to apply.	AVCoder.h
TConfig & EditPendingConfig()		AVCoder.h
TConfig const & GetAppliedConfig()		AVCoder.h
TConfig const & GetPendingConfig()		AVCoder.h
void SetPendingConfig ( TConfig const& NewPendingConfig ) const	Set the pending configuration, to be applied on the next call to ApplyConfig.	AVCoder.h

Navigation