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

Decoder implementation using OpenFEC library. More...

#include <of_decoder.h>

Inheritance diagram for roc::fec::OFDecoder:
Collaboration diagram for roc::fec::OFDecoder:

Public Member Functions

 OFDecoder (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 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 source or repair packet buffer for current block. More...
 
virtual core::Slice< uint8_t > repair (size_t index)
 Repair source packet buffer. More...
 
virtual void end ()
 Finish block. More...
 

Detailed Description

Decoder implementation using OpenFEC library.

Definition at line 40 of file of_decoder.h.

Constructor & Destructor Documentation

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

Initialize.

Member Function Documentation

virtual bool roc::fec::OFDecoder::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::IBlockDecoder.

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

Finish block.

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

Implements roc::fec::IBlockDecoder.

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

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

Implements roc::fec::IBlockDecoder.

virtual core::Slice<uint8_t> roc::fec::OFDecoder::repair ( size_t  index)
virtual

Repair source packet buffer.

Implements roc::fec::IBlockDecoder.

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

Store source or repair packet buffer for current block.

Implements roc::fec::IBlockDecoder.

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

Check if object is successfully constructed.


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