Roc Toolkit internal modules
Roc Toolkit: real-time audio streaming
roc::fec::OFEncoder Class Reference

Encoder implementation using OpenFEC library. More...

#include <of_encoder.h>

Inheritance diagram for roc::fec::OFEncoder:
Collaboration diagram for roc::fec::OFEncoder:

Public Member Functions

 OFEncoder (const CodecConfig &config, core::BufferPool< uint8_t > &buffer_pool, core::IAllocator &allocator)
 Initialize. More...
 
bool valid () const
 Check if object is successfully constructed. More...
 
virtual size_t alignment () const
 Get buffer alignment requirement. More...
 
virtual size_t max_block_length () const
 Get the maximum number of encoding symbols for the scheme being used. More...
 
virtual bool begin (size_t sblen, size_t rblen, size_t payload_size)
 Start block. More...
 
virtual void set (size_t index, const core::Slice< uint8_t > &buffer)
 Store packet data for current block. More...
 
virtual void fill ()
 Fill repair packets. More...
 
virtual void end ()
 Finish block. More...
 

Detailed Description

Encoder implementation using OpenFEC library.

Definition at line 40 of file of_encoder.h.

Constructor & Destructor Documentation

roc::fec::OFEncoder::OFEncoder ( const CodecConfig config,
core::BufferPool< uint8_t > &  buffer_pool,
core::IAllocator allocator 
)
explicit

Initialize.

Member Function Documentation

virtual size_t roc::fec::OFEncoder::alignment ( ) const
virtual

Get buffer alignment requirement.

Implements roc::fec::IBlockEncoder.

virtual bool roc::fec::OFEncoder::begin ( size_t  sblen,
size_t  rblen,
size_t  payload_size 
)
virtual

Start block.

Remarks
Performs an initial setup for a block. Should be called before any operations for the block.

Implements roc::fec::IBlockEncoder.

virtual void roc::fec::OFEncoder::end ( )
virtual

Finish block.

Remarks
Cleanups the resources allocated for the block. Should be called after all operations for the block.

Implements roc::fec::IBlockEncoder.

virtual void roc::fec::OFEncoder::fill ( )
virtual

Fill repair packets.

Implements roc::fec::IBlockEncoder.

virtual size_t roc::fec::OFEncoder::max_block_length ( ) const
virtual

Get the maximum number of encoding symbols for the scheme being used.

Implements roc::fec::IBlockEncoder.

virtual void roc::fec::OFEncoder::set ( size_t  index,
const core::Slice< uint8_t > &  buffer 
)
virtual

Store packet data for current block.

Implements roc::fec::IBlockEncoder.

bool roc::fec::OFEncoder::valid ( ) const

Check if object is successfully constructed.


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