#include <ffmpeg_subtitle.h>

Inheritance diagram for FFmpeg_Subtitle:

Collaboration diagram for FFmpeg_Subtitle:

Public Member Functions
	FFmpeg_Subtitle (int stream_index=INVALID_STREAM)
	Construct FFmpeg_Subtitle object. More...

virtual	~FFmpeg_Subtitle ()=default
	Destruct FFmpeg_Subtitle object.

int	res () const
	Get result of last operation. More...

void	unref () noexcept
	Unreference underlying frame. Synonym for shared_ptr::reset(). More...

	operator AVSubtitle * ()
	operator AVSubtitle *: Do as if we were a pointer to AVSubtitle More...

	operator const AVSubtitle * () const
	operator const AVSubtitle *: Do as if we were a const pointer to AVSubtitle More...

AVSubtitle *	operator-> ()
	operator ->: Do as if we were a pointer to AVSubtitle More...

Public Attributes
int	m_stream_idx
	Stream index frame belongs to, or -1 (INVALID_STREAM) More...

Protected Member Functions
AVSubtitle *	alloc_subtitle ()
	Allocate a subtitle. More...

Static Protected Member Functions
static void	delete_subtitle (AVSubtitle *subtitle)
	Delete a subtitle. More...

Protected Attributes
int	m_res
	0 if last operation was successful, or negative AVERROR value More...

Detailed Description

The FFmpeg_Subtitle class.

Definition at line 46 of file ffmpeg_subtitle.h.

Constructor & Destructor Documentation

◆ FFmpeg_Subtitle()

FFmpeg_Subtitle::FFmpeg_Subtitle ( int stream_index = INVALID_STREAM )

explicit

Construct FFmpeg_Subtitle object.

Parameters

[in] stream_index - Index of stream

Definition at line 47 of file ffmpeg_subtitle.cc.

References m_res.

Member Function Documentation

◆ alloc_subtitle()

AVSubtitle * FFmpeg_Subtitle::alloc_subtitle ( )

protected

Allocate a subtitle.

Returns: Returns a newly allocated AVSubtitle field, or nullptr if out of memory.

Definition at line 80 of file ffmpeg_subtitle.cc.

◆ delete_subtitle()

void FFmpeg_Subtitle::delete_subtitle ( AVSubtitle * subtitle )

staticprotected

Delete a subtitle.

Parameters

[in] subtitle - AVSubtitle structure to delete/free.

Definition at line 85 of file ffmpeg_subtitle.cc.

◆ operator AVSubtitle *()

FFmpeg_Subtitle::operator AVSubtitle * ( )

operator AVSubtitle *: Do as if we were a pointer to AVSubtitle

Definition at line 65 of file ffmpeg_subtitle.cc.

◆ operator const AVSubtitle *()

FFmpeg_Subtitle::operator const AVSubtitle * ( ) const

operator const AVSubtitle *: Do as if we were a const pointer to AVSubtitle

Definition at line 70 of file ffmpeg_subtitle.cc.

◆ operator->()

AVSubtitle * FFmpeg_Subtitle::operator-> ( )

operator ->: Do as if we were a pointer to AVSubtitle

Returns: Pointer to AVSubtitle struct.

Definition at line 75 of file ffmpeg_subtitle.cc.

◆ res()

int FFmpeg_Subtitle::res ( ) const

Get result of last operation.

Returns: Returns 0 if last operation was successful, or negative AVERROR value.

Definition at line 60 of file ffmpeg_subtitle.cc.

References m_res.

Referenced by FFmpeg_Transcoder::decode_subtitle().

◆ unref()

void FFmpeg_Subtitle::unref ( )

noexcept

Unreference underlying frame. Synonym for shared_ptr::reset().

Definition at line 55 of file ffmpeg_subtitle.cc.

Member Data Documentation

◆ m_res

int FFmpeg_Subtitle::m_res

protected

0 if last operation was successful, or negative AVERROR value

Definition at line 95 of file ffmpeg_subtitle.h.

Referenced by FFmpeg_Subtitle(), and res().

◆ m_stream_idx

int FFmpeg_Subtitle::m_stream_idx

Stream index frame belongs to, or -1 (INVALID_STREAM)

Definition at line 98 of file ffmpeg_subtitle.h.

Referenced by FFmpeg_Transcoder::process_single_fr().

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

src/ffmpeg_subtitle.h
src/ffmpeg_subtitle.cc

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Protected Attributes