IEncoder

#include <icy/av/iencoder.h>

Inherits: Stateful< EncoderState > Subclassed by: MultiplexEncoder

This is the abstract class for all encoders.

Public Methods

Return	Name	Description
`void`	`init`	Initialise the encoder, open codec contexts, and transition to Ready or Encoding state.
`void`	`uninit`	Flush remaining packets, close codec contexts, and release all encoder resources.
`void`	`cleanup` `virtual` `inline`	Perform any additional cleanup after uninit(). Default is a no-op.
`const EncoderOptions &`	`options` `const`	#### Returns
`void`	`createVideo` `virtual` `inline`	Initialise the video codec context and stream.
`void`	`freeVideo` `virtual` `inline`	Free the video codec context and stream.
`bool`	`encodeVideo` `virtual` `inline`	Encode a single AVFrame of video.
`void`	`createAudio` `virtual` `inline`	Initialise the audio codec context and stream.
`void`	`freeAudio` `virtual` `inline`	Free the audio codec context and stream.
`void`	`flush` `virtual` `inline`	Flush any internally buffered packets to the output.
`bool`	`isNone` `const` `inline`	#### Returns
`bool`	`isReady` `const` `inline`	#### Returns
`bool`	`isEncoding` `virtual` `const` `inline`	#### Returns
`bool`	`isActive` `virtual` `const` `inline`	#### Returns
`bool`	`isStopped` `virtual` `const` `inline`	#### Returns
`bool`	`isError` `virtual` `const` `inline`	#### Returns

init

void init()

Initialise the encoder, open codec contexts, and transition to Ready or Encoding state.

uninit

void uninit()

Flush remaining packets, close codec contexts, and release all encoder resources.

cleanup

virtual inline

virtual inline void cleanup()

Perform any additional cleanup after uninit(). Default is a no-op.

options

const

const EncoderOptions & options() const

Returns

A read-only view of the encoder's configuration options.

createVideo

virtual inline

virtual inline void createVideo()

Initialise the video codec context and stream.

freeVideo

virtual inline

virtual inline void freeVideo()

Free the video codec context and stream.

encodeVideo

virtual inline

virtual inline bool encodeVideo(AVFrame * frame)

Encode a single AVFrame of video.

Parameters

frame The source video frame; all fields (format, width, height, pts) must be set.

Returns

True if a packet was successfully encoded and written.

createAudio

virtual inline

virtual inline void createAudio()

Initialise the audio codec context and stream.

freeAudio

virtual inline

virtual inline void freeAudio()

Free the audio codec context and stream.

flush

virtual inline

virtual inline void flush()

Flush any internally buffered packets to the output.

isNone

const inline

inline bool isNone() const

Returns

True if the encoder is in the None state.

isReady

const inline

inline bool isReady() const

Returns

True if the encoder is ready but not yet encoding.

isEncoding

virtual const inline

virtual inline bool isEncoding() const

Returns

True if the encoder is actively encoding.

isActive

virtual const inline

virtual inline bool isActive() const

Returns

True if the encoder is in the Ready or Encoding state.

isStopped

virtual const inline

virtual inline bool isStopped() const

Returns

True if the encoder has stopped.

isError

virtual const inline

virtual inline bool isError() const

Returns

True if the encoder is in an error state.

Public Types

Name	Description
`Type`

Type

enum Type

Value	Description
`None`	huh?
`Video`	video only
`Audio`	audio only
`Multiplex`	both video & audio