StormByte::Multimedia::FFmpeg::AVBSF Class Reference

RAII bitstream filter context. More...

#include <StormByte/multimedia/ffmpeg/AVBSF.hxx>

Inheritance diagram for StormByte::Multimedia::FFmpeg::AVBSF:

Collaboration diagram for StormByte::Multimedia::FFmpeg::AVBSF:

Public Member Functions
	AVBSF (const AVBSF &)=delete
	Copy constructor (deleted).
	AVBSF (AVBSF &&other) noexcept=default
	Move constructor.
	~AVBSF () noexcept override
	Destructor.
AVBSF &	operator= (const AVBSF &)=delete
	Copy assignment (deleted).
AVBSF &	operator= (AVBSF &&other) noexcept
	Move assignment.
OperationResult	SendPacket (AVPacket &pkt) noexcept
	Sends a packet into the filter.
OperationResult	ReceivePacket (AVPacket &pkt) noexcept
	Receives a filtered packet.
void	Flush () noexcept
	Flushes the filter.
void	SetEof () noexcept
	Signals EOF (null packet).
Public Member Functions inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVBSFContext >
constexpr	AVPointer () noexcept=delete
	Default constructor (deleted).
constexpr	AVPointer (const AVPointer &) noexcept=delete
	Copy constructor (deleted).
constexpr	AVPointer (AVPointer &&other) noexcept
	Move constructor.
virtual	~AVPointer () noexcept=default
	Destructor.
constexpr AVPointer &	operator= (const AVPointer &) noexcept=delete
	Copy assignment (deleted).
constexpr AVPointer &	operator= (AVPointer &&other) noexcept
	Move assignment.

Static Public Member Functions
static ExpectedAVBSF	Create (const std::string &name, const AVCodecParameters &params, AVRational time_base) noexcept
	Creates and initializes a named BSF.

Additional Inherited Members
Protected Member Functions inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVBSFContext >
constexpr	AVPointer (std::decay_t< ::AVBSFContext > *ptr) noexcept
	Adopts ptr.
constexpr const std::decay_t< ::AVBSFContext > *	Get () const noexcept
	Const view of the raw FFmpeg pointer.
constexpr std::decay_t< ::AVBSFContext > *	Get () noexcept
	Mutable view of the raw FFmpeg pointer.
constexpr std::decay_t< ::AVBSFContext > *	Detach () noexcept
	Yields the raw pointer and leaves this wrapper empty.
Protected Attributes inherited from StormByte::Multimedia::FFmpeg::AVPointer<::AVBSFContext >
std::decay_t< ::AVBSFContext > *	m_ptr
	Owned FFmpeg pointer.

Detailed Description

RAII bitstream filter context.

Constructor & Destructor Documentation

AVBSF() [1/2]

StormByte::Multimedia::FFmpeg::AVBSF::AVBSF ( const AVBSF &  )

delete

Copy constructor (deleted).

AVBSF() [2/2]

StormByte::Multimedia::FFmpeg::AVBSF::AVBSF ( AVBSF &&  other )

defaultnoexcept

Move constructor.

Parameters

other

Source filter.

~AVBSF()

StormByte::Multimedia::FFmpeg::AVBSF::~AVBSF ( )

overridenoexcept

Destructor.

Member Function Documentation

Create()

static ExpectedAVBSF StormByte::Multimedia::FFmpeg::AVBSF::Create ( const std::string &  name, const AVCodecParameters &  params, AVRational  time_base  )

staticnoexcept

Creates and initializes a named BSF.

Parameters

name	Filter name (e.g. "h264_mp4toannexb").
params	Input codec parameters.
time_base	Input time base.

Returns

AVBSF or BSFError.

Flush()

void StormByte::Multimedia::FFmpeg::AVBSF::Flush ( )

noexcept

Flushes the filter.

operator=() [1/2]

AVBSF & StormByte::Multimedia::FFmpeg::AVBSF::operator= ( AVBSF &&  other )

noexcept

Move assignment.

Parameters

other

Source filter.

Returns

*this.

operator=() [2/2]

AVBSF & StormByte::Multimedia::FFmpeg::AVBSF::operator= ( const AVBSF &  )

delete

Copy assignment (deleted).

Returns

*this.

ReceivePacket()

OperationResult StormByte::Multimedia::FFmpeg::AVBSF::ReceivePacket ( AVPacket &  pkt )

noexcept

Receives a filtered packet.

Parameters

pkt	Destination packet.

Returns

Operation result.

SendPacket()

OperationResult StormByte::Multimedia::FFmpeg::AVBSF::SendPacket ( AVPacket &  pkt )

noexcept

Sends a packet into the filter.

Parameters

pkt	Packet to send.

Returns

Operation result.

SetEof()

void StormByte::Multimedia::FFmpeg::AVBSF::SetEof ( )

noexcept

Signals EOF (null packet).

---

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

• lib/public/StormByte/multimedia/ffmpeg/AVBSF.hxx