RemoteInputBuffer Class Reference

#include <remoteinputbuffer.h>

Collaboration diagram for RemoteInputBuffer:

Classes
struct	BufferFrame
struct	DecoderSlot

Public Member Functions
	RemoteInputBuffer ()
	~RemoteInputBuffer ()
void	writeData (char *array)
	Write data into buffer. More...
uint8_t *	readData (int32_t length)
	Read data from buffer. More...
const RemoteMetaDataFEC &	getCurrentMeta () const
uint32_t	getTVOutSec () const
uint32_t	getTVOutUsec () const
uint64_t	getTVOutMSec () const
int	getCurNbBlocks () const
int	getCurOriginalBlocks () const
int	getCurNbRecovery () const
float	getAvgNbBlocks () const
float	getAvgOriginalBlocks () const
float	getAvgNbRecovery () const
int	getMinNbBlocks ()
int	getMinOriginalBlocks ()
int	getMaxNbRecovery ()
bool	allFramesDecoded ()
float	getBufferLengthInSecs () const
int32_t	getRWBalanceCorrection () const
int32_t	getBufferGauge () const

Static Public Attributes
static const int	framesSize = REMOTEINPUT_NBDECODERSLOTS * (RemoteNbOrginalBlocks - 1) * RemoteNbBytesPerBlock

Private Member Functions
RemoteProtectedBlock *	storeOriginalBlock (int slotIndex, int blockIndex, const RemoteProtectedBlock &protectedBlock)
RemoteProtectedBlock &	getOriginalBlock (int slotIndex, int blockIndex)
RemoteMetaDataFEC *	getMetaData (int slotIndex)
void	resetOriginalBlocks (int slotIndex)
void	initDecodeAllSlots ()
void	initReadIndex ()
void	rwCorrectionEstimate (int slotIndex)
void	checkSlotData (int slotIndex)
void	initDecodeSlot (int slotIndex)

Static Private Member Functions
static void	printMeta (const QString &header, RemoteMetaDataFEC *metaData)

Private Attributes
RemoteMetaDataFEC	m_currentMeta
	Stored current meta data. More...
CM256::cm256_encoder_params	m_paramsCM256
	CM256 decoder parameters block. More...
DecoderSlot	m_decoderSlots [nbDecoderSlots]
	CM256 decoding control/buffer slots. More...
BufferFrame	m_frames [nbDecoderSlots]
	Samples buffer. More...
int	m_framesNbBytes
	Number of bytes in samples buffer. More...
int	m_decoderIndexHead
	index of the current head frame slot in decoding slots More...
int	m_frameHead
	index of the current head frame sent More...
int	m_curNbBlocks
	(stats) instantaneous number of blocks received More...
int	m_minNbBlocks
	(stats) minimum number of blocks received since last poll More...
int	m_curOriginalBlocks
	(stats) instantanous number of original blocks received More...
int	m_minOriginalBlocks
	(stats) minimum number of original blocks received since last poll More...
int	m_curNbRecovery
	(stats) instantaneous number of recovery blocks used More...
int	m_maxNbRecovery
	(stats) maximum number of recovery blocks used since last poll More...
MovingAverageUtil< int, int, 10 >	m_avgNbBlocks
	(stats) average number of blocks received More...
MovingAverageUtil< int, int, 10 >	m_avgOrigBlocks
	(stats) average number of original blocks received More...
MovingAverageUtil< int, int, 10 >	m_avgNbRecovery
	(stats) average number of recovery blocks used More...
bool	m_framesDecoded
	[stats] true if all frames were decoded since last poll More...
int	m_readIndex
	current byte read index in frames buffer More...
int	m_wrDeltaEstimate
	Sampled estimate of write to read indexes difference. More...
uint32_t	m_tvOut_sec
	Estimated returned samples timestamp (seconds) More...
uint32_t	m_tvOut_usec
	Estimated returned samples timestamp (microseconds) More...
int	m_readNbBytes
	Nominal number of bytes per read (50ms) More...
uint8_t *	m_readBuffer
	Read buffer to hold samples when looping back to beginning of raw buffer. More...
int	m_readSize
	Read buffer size. More...
float	m_bufferLenSec
int	m_nbReads
	Number of buffer reads since start of auto R/W balance correction period. More...
int	m_nbWrites
	Number of buffer writes since start of auto R/W balance correction period. More...
int	m_balCorrection
	R/W balance correction in number of samples. More...
int	m_balCorrLimit
	Correction absolute value limit in number of samples. More...
CM256	m_cm256
	CM256 library. More...
bool	m_cm256_OK
	CM256 library initialized OK. More...

Static Private Attributes
static const int	nbDecoderSlots = REMOTEINPUT_NBDECODERSLOTS

Detailed Description

Definition at line 33 of file remoteinputbuffer.h.

Constructor & Destructor Documentation

RemoteInputBuffer()

RemoteInputBuffer::RemoteInputBuffer

(

)

Definition at line 29 of file remoteinputbuffer.cpp.

References RemoteMetaDataFEC::init(), m_currentMeta, m_framesNbBytes, m_paramsCM256, m_readNbBytes, m_tvOut_sec, m_tvOut_usec, m_wrDeltaEstimate, and nbDecoderSlots.

                                     :
        m_decoderIndexHead(nbDecoderSlots/2),
        m_frameHead(0),
        m_curNbBlocks(0),
        m_minNbBlocks(256),
        m_curOriginalBlocks(0),
        m_minOriginalBlocks(128),
        m_curNbRecovery(0),
        m_maxNbRecovery(0),
        m_framesDecoded(true),
        m_readIndex(0),
        m_readBuffer(0),
        m_readSize(0),
        m_bufferLenSec(0.0f),
        m_nbReads(0),
        m_nbWrites(0),
        m_balCorrection(0),
        m_balCorrLimit(0)
{
    m_currentMeta.init();
    m_framesNbBytes = nbDecoderSlots * sizeof(BufferFrame);
    m_wrDeltaEstimate = m_framesNbBytes / 2;
    m_tvOut_sec = 0;
    m_tvOut_usec = 0;
    m_readNbBytes = 1;
    m_paramsCM256.BlockBytes = sizeof(RemoteProtectedBlock); // never changes
    m_paramsCM256.OriginalCount = RemoteNbOrginalBlocks;  // never changes

    if (!m_cm256.isInitialized()) {
        m_cm256_OK = false;
        qDebug() << "RemoteInputBuffer::RemoteInputBuffer: cannot initialize CM256 library";
    } else {
        m_cm256_OK = true;
    }

    std::fill(m_decoderSlots, m_decoderSlots + nbDecoderSlots, DecoderSlot());
    std::fill(m_frames, m_frames + nbDecoderSlots, BufferFrame());
}

Here is the call graph for this function:

~RemoteInputBuffer()

RemoteInputBuffer::~RemoteInputBuffer

(

)

Definition at line 68 of file remoteinputbuffer.cpp.

References m_readBuffer.

{
    if (m_readBuffer) {
        delete[] m_readBuffer;
    }
}

Member Function Documentation

allFramesDecoded()

bool RemoteInputBuffer::allFramesDecoded ( )

inline

Definition at line 81 of file remoteinputbuffer.h.

References m_framesDecoded.

    {
        bool framesDecoded = m_framesDecoded;
        m_framesDecoded = true;
        return framesDecoded;
    }

checkSlotData()

void RemoteInputBuffer::checkSlotData ( int  slotIndex )

private

Definition at line 170 of file remoteinputbuffer.cpp.

References RemoteInputBuffer::DecoderSlot::m_blockCount, m_currentMeta, m_decoderSlots, m_readIndex, RemoteInputBuffer::DecoderSlot::m_recoveryCount, RemoteMetaDataFEC::m_sampleBytes, RemoteMetaDataFEC::m_sampleRate, RemoteMetaDataFEC::m_tv_sec, RemoteMetaDataFEC::m_tv_usec, m_tvOut_sec, m_tvOut_usec, m_wrDeltaEstimate, and nbDecoderSlots.

Referenced by writeData().

{
    int pseudoWriteIndex = slotIndex * sizeof(BufferFrame);
    m_wrDeltaEstimate = pseudoWriteIndex - m_readIndex;
    int rwDelayBytes = (m_wrDeltaEstimate > 0 ? m_wrDeltaEstimate : sizeof(BufferFrame) * nbDecoderSlots + m_wrDeltaEstimate);
    int sampleRate = m_currentMeta.m_sampleRate;

    if (sampleRate > 0)
    {
        int64_t ts = m_currentMeta.m_tv_sec * 1000000LL + m_currentMeta.m_tv_usec;
        ts -= (rwDelayBytes * 1000000LL) / (sampleRate * 2 * m_currentMeta.m_sampleBytes);
        m_tvOut_sec = ts / 1000000LL;
        m_tvOut_usec = ts - (m_tvOut_sec * 1000000LL);
    }

    if (!m_decoderSlots[slotIndex].m_decoded)
    {
        qDebug() << "RemoteInputBuffer::checkSlotData: incomplete frame:"
                << " slotIndex: " << slotIndex
                << " m_blockCount: " << m_decoderSlots[slotIndex].m_blockCount
                << " m_recoveryCount: " << m_decoderSlots[slotIndex].m_recoveryCount;
    }
}

Here is the caller graph for this function:

getAvgNbBlocks()

float RemoteInputBuffer::getAvgNbBlocks ( ) const

inline

Definition at line 56 of file remoteinputbuffer.h.

References m_avgNbBlocks.

Referenced by RemoteInputUDPHandler::tick().

{ return m_avgNbBlocks; }

Here is the caller graph for this function:

getAvgNbRecovery()

float RemoteInputBuffer::getAvgNbRecovery ( ) const

inline

Definition at line 58 of file remoteinputbuffer.h.

References m_avgNbRecovery.

Referenced by RemoteInputUDPHandler::tick().

{ return m_avgNbRecovery; }

Here is the caller graph for this function:

getAvgOriginalBlocks()

float RemoteInputBuffer::getAvgOriginalBlocks ( ) const

inline

Definition at line 57 of file remoteinputbuffer.h.

References m_avgOrigBlocks.

Referenced by RemoteInputUDPHandler::tick().

{ return m_avgOrigBlocks; }

Here is the caller graph for this function:

getBufferGauge()

int32_t RemoteInputBuffer::getBufferGauge ( ) const

inline

Get buffer gauge value in % of buffer size ([-50:50]) [-50:0] : write leads or read lags [0:50] : read leads or write lags

Definition at line 95 of file remoteinputbuffer.h.

References m_framesNbBytes, and m_wrDeltaEstimate.

Referenced by RemoteInputUDPHandler::getBufferGauge(), and RemoteInputUDPHandler::tick().

    {
        if (m_framesNbBytes)
        {
            int32_t val = (m_wrDeltaEstimate * 100) / (int32_t) m_framesNbBytes;
            int32_t ret = val < 0 ? -val - 50 : 50 -val;
            return ret;
        }
        else
        {
            return 0; // default position
        }
    }

Here is the caller graph for this function:

getBufferLengthInSecs()

float RemoteInputBuffer::getBufferLengthInSecs ( ) const

inline

Definition at line 88 of file remoteinputbuffer.h.

References m_bufferLenSec.

Referenced by RemoteInputUDPHandler::tick().

{ return m_bufferLenSec; }

Here is the caller graph for this function:

getCurNbBlocks()

int RemoteInputBuffer::getCurNbBlocks ( ) const

inline

Definition at line 53 of file remoteinputbuffer.h.

References m_curNbBlocks.

{ return m_curNbBlocks; }

getCurNbRecovery()

int RemoteInputBuffer::getCurNbRecovery ( ) const

inline

Definition at line 55 of file remoteinputbuffer.h.

References m_curNbRecovery.

{ return m_curNbRecovery; }

getCurOriginalBlocks()

int RemoteInputBuffer::getCurOriginalBlocks ( ) const

inline

Definition at line 54 of file remoteinputbuffer.h.

References m_curOriginalBlocks.

{ return m_curOriginalBlocks; }

getCurrentMeta()

const RemoteMetaDataFEC& RemoteInputBuffer::getCurrentMeta ( ) const

inline

Definition at line 44 of file remoteinputbuffer.h.

References m_currentMeta.

Referenced by RemoteInputUDPHandler::processData(), and RemoteInputUDPHandler::tick().

{ return m_currentMeta; }

Here is the caller graph for this function:

getMaxNbRecovery()

int RemoteInputBuffer::getMaxNbRecovery ( )

inline

Definition at line 74 of file remoteinputbuffer.h.

References m_maxNbRecovery.

Referenced by RemoteInputUDPHandler::getMaxNbRecovery(), and RemoteInputUDPHandler::tick().

    {
        int maxNbRecovery = m_maxNbRecovery;
        m_maxNbRecovery = 0;
        return maxNbRecovery;
    }

Here is the caller graph for this function:

getMetaData()

RemoteMetaDataFEC* RemoteInputBuffer::getMetaData ( int  slotIndex )

inlineprivate

Definition at line 195 of file remoteinputbuffer.h.

References RemoteInputBuffer::DecoderSlot::m_blockZero.

    {
        // return (MetaDataFEC *) &m_decoderSlots[slotIndex].m_originalBlocks[0];
        return (RemoteMetaDataFEC *) &m_decoderSlots[slotIndex].m_blockZero;
    }

getMinNbBlocks()

int RemoteInputBuffer::getMinNbBlocks ( )

inline

Definition at line 60 of file remoteinputbuffer.h.

References m_minNbBlocks.

Referenced by RemoteInputUDPHandler::getMinNbBlocks(), and RemoteInputUDPHandler::tick().

    {
        int minNbBlocks = m_minNbBlocks;
        m_minNbBlocks = 256;
        return minNbBlocks;
    }

Here is the caller graph for this function:

getMinOriginalBlocks()

int RemoteInputBuffer::getMinOriginalBlocks ( )

inline

Definition at line 67 of file remoteinputbuffer.h.

References m_minOriginalBlocks.

Referenced by RemoteInputUDPHandler::tick().

    {
        int minOriginalBlocks = m_minOriginalBlocks;
        m_minOriginalBlocks = 128;
        return minOriginalBlocks;
    }

Here is the caller graph for this function:

getOriginalBlock()

RemoteProtectedBlock& RemoteInputBuffer::getOriginalBlock ( int  slotIndex, int  blockIndex  )

inlineprivate

Definition at line 184 of file remoteinputbuffer.h.

References RemoteInputBuffer::BufferFrame::m_blocks, and RemoteInputBuffer::DecoderSlot::m_blockZero.

    {
        if (blockIndex == 0) {
            // return m_decoderSlots[slotIndex].m_originalBlocks[0];
            return m_decoderSlots[slotIndex].m_blockZero;
        } else {
            // return m_decoderSlots[slotIndex].m_originalBlocks[blockIndex];
            return m_frames[slotIndex].m_blocks[blockIndex - 1];
        }
    }

getRWBalanceCorrection()

int32_t RemoteInputBuffer::getRWBalanceCorrection ( ) const

inline

Definition at line 89 of file remoteinputbuffer.h.

References m_balCorrection.

Referenced by RemoteInputUDPHandler::tick().

{ return m_balCorrection; }

Here is the caller graph for this function:

getTVOutMSec()

uint64_t RemoteInputBuffer::getTVOutMSec ( ) const

inline

Definition at line 49 of file remoteinputbuffer.h.

References m_tvOut_sec, and m_tvOut_usec.

Referenced by RemoteInputUDPHandler::processData().

{ return (m_tvOut_sec * 1000LL) + (m_tvOut_usec/ 1000LL); }

Here is the caller graph for this function:

getTVOutSec()

uint32_t RemoteInputBuffer::getTVOutSec ( ) const

inline

Definition at line 47 of file remoteinputbuffer.h.

References m_tvOut_sec.

{ return m_tvOut_sec; }

getTVOutUsec()

uint32_t RemoteInputBuffer::getTVOutUsec ( ) const

inline

Definition at line 48 of file remoteinputbuffer.h.

References m_tvOut_usec.

{ return m_tvOut_usec; }

initDecodeAllSlots()

void RemoteInputBuffer::initDecodeAllSlots ( )

private

Definition at line 75 of file remoteinputbuffer.cpp.

References i, RemoteInputBuffer::DecoderSlot::m_blockCount, RemoteInputBuffer::DecoderSlot::m_decoded, m_decoderSlots, RemoteInputBuffer::DecoderSlot::m_metaRetrieved, RemoteInputBuffer::DecoderSlot::m_originalCount, RemoteInputBuffer::DecoderSlot::m_recoveryCount, nbDecoderSlots, and resetOriginalBlocks().

Referenced by writeData().

{
    for (int i = 0; i < nbDecoderSlots; i++)
    {
        m_decoderSlots[i].m_blockCount = 0;
        m_decoderSlots[i].m_originalCount = 0;
        m_decoderSlots[i].m_recoveryCount = 0;
        m_decoderSlots[i].m_decoded = false;
        m_decoderSlots[i].m_metaRetrieved = false;
        resetOriginalBlocks(i);
        memset((void *) m_decoderSlots[i].m_recoveryBlocks, 0, RemoteNbOrginalBlocks * sizeof(RemoteProtectedBlock));
    }
}

Here is the call graph for this function:

Here is the caller graph for this function:

initDecodeSlot()

void RemoteInputBuffer::initDecodeSlot ( int  slotIndex )

private

Definition at line 89 of file remoteinputbuffer.cpp.

References m_avgNbBlocks, m_avgNbRecovery, m_avgOrigBlocks, RemoteInputBuffer::DecoderSlot::m_blockCount, m_curNbBlocks, m_curNbRecovery, m_curOriginalBlocks, RemoteInputBuffer::DecoderSlot::m_decoded, m_decoderSlots, m_framesDecoded, m_maxNbRecovery, RemoteInputBuffer::DecoderSlot::m_metaRetrieved, m_minNbBlocks, m_minOriginalBlocks, RemoteInputBuffer::DecoderSlot::m_originalCount, RemoteInputBuffer::DecoderSlot::m_recoveryCount, and resetOriginalBlocks().

Referenced by writeData().

{
    // collect stats before voiding the slot

    m_curNbBlocks = m_decoderSlots[slotIndex].m_blockCount;
    m_curOriginalBlocks = m_decoderSlots[slotIndex].m_originalCount;
    m_curNbRecovery = m_decoderSlots[slotIndex].m_recoveryCount;
    m_avgNbBlocks(m_curNbBlocks);
    m_avgOrigBlocks(m_curOriginalBlocks);
    m_avgNbRecovery(m_curNbRecovery);
    m_framesDecoded = m_framesDecoded && m_decoderSlots[slotIndex].m_decoded;

    if (m_curNbBlocks < m_minNbBlocks) {
        m_minNbBlocks = m_curNbBlocks;
    }

    if (m_curOriginalBlocks < m_minOriginalBlocks) {
        m_minOriginalBlocks = m_curOriginalBlocks;
    }

    if (m_curNbRecovery > m_maxNbRecovery) {
        m_maxNbRecovery = m_curNbRecovery;
    }

    // void the slot

    m_decoderSlots[slotIndex].m_blockCount = 0;
    m_decoderSlots[slotIndex].m_originalCount = 0;
    m_decoderSlots[slotIndex].m_recoveryCount = 0;
    m_decoderSlots[slotIndex].m_decoded = false;
    m_decoderSlots[slotIndex].m_metaRetrieved = false;

    resetOriginalBlocks(slotIndex);
    memset((void *) m_decoderSlots[slotIndex].m_recoveryBlocks, 0, RemoteNbOrginalBlocks * sizeof(RemoteProtectedBlock));
}

Here is the call graph for this function:

Here is the caller graph for this function:

initReadIndex()

void RemoteInputBuffer::initReadIndex ( )

private

Definition at line 125 of file remoteinputbuffer.cpp.

References m_decoderIndexHead, m_framesNbBytes, m_nbReads, m_nbWrites, m_readIndex, m_wrDeltaEstimate, and nbDecoderSlots.

Referenced by writeData().

{
    m_readIndex = ((m_decoderIndexHead + (nbDecoderSlots/2)) % nbDecoderSlots) * sizeof(BufferFrame);
    m_wrDeltaEstimate = m_framesNbBytes / 2;
    m_nbReads = 0;
    m_nbWrites = 0;
}

Here is the caller graph for this function:

printMeta()

void RemoteInputBuffer::printMeta ( const QString &  header, RemoteMetaDataFEC *  metaData  )

staticprivate

Definition at line 375 of file remoteinputbuffer.cpp.

References RemoteMetaDataFEC::m_centerFrequency, RemoteMetaDataFEC::m_nbFECBlocks, RemoteMetaDataFEC::m_nbOriginalBlocks, RemoteMetaDataFEC::m_sampleBits, RemoteMetaDataFEC::m_sampleBytes, RemoteMetaDataFEC::m_sampleRate, RemoteMetaDataFEC::m_tv_sec, and RemoteMetaDataFEC::m_tv_usec.

{
    qDebug() << header << ": "
            << "|" << metaData->m_centerFrequency
            << ":" << metaData->m_sampleRate
            << ":" << (int) (metaData->m_sampleBytes & 0xF)
            << ":" << (int) metaData->m_sampleBits
            << ":" << (int) metaData->m_nbOriginalBlocks
            << ":" << (int) metaData->m_nbFECBlocks
            << "|" << metaData->m_tv_sec
            << ":" << metaData->m_tv_usec
            << "|";
}

readData()

uint8_t * RemoteInputBuffer::readData

(

int32_t

length

)

Read data from buffer.

Definition at line 333 of file remoteinputbuffer.cpp.

References framesSize, m_frames, m_framesNbBytes, m_nbReads, m_readBuffer, m_readIndex, and m_readSize.

Referenced by RemoteInputUDPHandler::tick().

{
    uint8_t *buffer = (uint8_t *) m_frames;
    uint32_t readIndex = m_readIndex;

    m_nbReads++;

    // SEGFAULT FIX: arbitratily truncate so that it does not exceed buffer length
    if (length > framesSize) {
        length = framesSize;
    }

    if (m_readIndex + length < m_framesNbBytes) // ends before buffer bound
    {
        m_readIndex += length;
        return &buffer[readIndex];
    }
    else if (m_readIndex + length == m_framesNbBytes) // ends at buffer bound
    {
        m_readIndex = 0;
        return &buffer[readIndex];
    }
    else // ends after buffer bound
    {
        if (length > m_readSize) // reallocate composition buffer if necessary
        {
            if (m_readBuffer) {
                delete[] m_readBuffer;
            }

            m_readBuffer = new uint8_t[length];
            m_readSize = length;
        }

        std::memcpy((void *) m_readBuffer, (const void *) &buffer[m_readIndex], m_framesNbBytes - m_readIndex); // copy end of buffer
        length -= m_framesNbBytes - m_readIndex;
        std::memcpy((void *) &m_readBuffer[m_framesNbBytes - m_readIndex], (const void *) buffer, length); // copy start of buffer
        m_readIndex = length;
        return m_readBuffer;
    }
}

Here is the caller graph for this function:

resetOriginalBlocks()

void RemoteInputBuffer::resetOriginalBlocks ( int  slotIndex )

inlineprivate

Definition at line 201 of file remoteinputbuffer.h.

References RemoteInputBuffer::BufferFrame::m_blocks.

Referenced by initDecodeAllSlots(), and initDecodeSlot().

    {
        // memset((void *) m_decoderSlots[slotIndex].m_originalBlocks, 0, m_nbOriginalBlocks * sizeof(ProtectedBlock));
        memset((void *) &m_decoderSlots[slotIndex].m_blockZero, 0, sizeof(RemoteProtectedBlock));
        memset((void *) m_frames[slotIndex].m_blocks, 0, (RemoteNbOrginalBlocks - 1) * sizeof(RemoteProtectedBlock));
    }

Here is the caller graph for this function:

rwCorrectionEstimate()

void RemoteInputBuffer::rwCorrectionEstimate ( int  slotIndex )

private

Definition at line 133 of file remoteinputbuffer.cpp.

References m_balCorrection, m_balCorrLimit, m_currentMeta, m_nbReads, m_nbWrites, m_readIndex, m_readNbBytes, RemoteMetaDataFEC::m_sampleBytes, and nbDecoderSlots.

Referenced by writeData().

{
    if (m_nbReads >= 40) // check every ~1s as tick is ~50ms
    {
        int targetPivotSlot = (slotIndex + (nbDecoderSlots/2))  % nbDecoderSlots; // slot at half buffer opposite of current write slot
        int targetPivotIndex = targetPivotSlot * sizeof(BufferFrame);             // buffer index corresponding to start of above slot
        int normalizedReadIndex = (m_readIndex < targetPivotIndex ? m_readIndex + nbDecoderSlots * sizeof(BufferFrame) :  m_readIndex)
                - (targetPivotSlot * sizeof(BufferFrame)); // normalize read index so it is positive and zero at start of pivot slot
        int dBytes;
        int rwDelta = (m_nbReads * m_readNbBytes) - (m_nbWrites * sizeof(BufferFrame));

        if (normalizedReadIndex < (nbDecoderSlots/ 2) * (int) sizeof(BufferFrame)) // read leads
        {
            dBytes = - normalizedReadIndex - rwDelta;
        }
        else // read lags
        {
            int bufSize = (nbDecoderSlots * sizeof(BufferFrame));
            dBytes = bufSize - normalizedReadIndex - rwDelta;
        }

         // calculate exponential moving average on floating point for better accuracy (was int)
        double newCorrection = ((double) dBytes) / (((int) m_currentMeta.m_sampleBytes) * 2 * m_nbReads);
        m_balCorrection = 0.25*m_balCorrection + 0.75*newCorrection; // exponential average with alpha = 0.75 (original is wrong)
        //m_balCorrection = (m_balCorrection / 4) + (dBytes / (int) (m_currentMeta.m_sampleBytes * 2 * m_nbReads)); // correction is in number of samples. Alpha = 0.25

        if (m_balCorrection < -m_balCorrLimit) {
            m_balCorrection = -m_balCorrLimit;
        } else if (m_balCorrection > m_balCorrLimit) {
            m_balCorrection = m_balCorrLimit;
        }

        m_nbReads = 0;
        m_nbWrites = 0;
    }
}

Here is the caller graph for this function:

storeOriginalBlock()

RemoteProtectedBlock* RemoteInputBuffer::storeOriginalBlock ( int  slotIndex, int  blockIndex, const RemoteProtectedBlock &  protectedBlock  )

inlineprivate

Definition at line 169 of file remoteinputbuffer.h.

References RemoteInputBuffer::BufferFrame::m_blocks, and RemoteInputBuffer::DecoderSlot::m_blockZero.

    {
        if (blockIndex == 0) {
            // m_decoderSlots[slotIndex].m_originalBlocks[0] = protectedBlock;
            // return &m_decoderSlots[slotIndex].m_originalBlocks[0];
            m_decoderSlots[slotIndex].m_blockZero = protectedBlock;
            return &m_decoderSlots[slotIndex].m_blockZero;
        } else {
            // m_decoderSlots[slotIndex].m_originalBlocks[blockIndex] = protectedBlock;
            // return &m_decoderSlots[slotIndex].m_originalBlocks[blockIndex];
            m_frames[slotIndex].m_blocks[blockIndex - 1] = protectedBlock;
            return &m_frames[slotIndex].m_blocks[blockIndex - 1];
        }
    }

writeData()

void RemoteInputBuffer::writeData

(

char *

array

)

Write data into buffer.

Definition at line 194 of file remoteinputbuffer.cpp.

References checkSlotData(), initDecodeAllSlots(), initDecodeSlot(), initReadIndex(), m_decoderIndexHead, m_decoderSlots, m_frameHead, RemoteHeader::m_frameIndex, RemoteSuperBlock::m_header, m_nbWrites, nbDecoderSlots, and rwCorrectionEstimate().

Referenced by RemoteInputUDPHandler::processData().

{
    RemoteSuperBlock *superBlock = (RemoteSuperBlock *) array;
    int frameIndex = superBlock->m_header.m_frameIndex;
    int decoderIndex = frameIndex % nbDecoderSlots;

    // frame break

    if (m_frameHead == -1) // initial state
    {
        m_decoderIndexHead = decoderIndex; // new decoder slot head
        m_frameHead = frameIndex;
        initReadIndex(); // reset read index
        initDecodeAllSlots(); // initialize all slots
    }
    else if (m_frameHead != frameIndex) // frame break => new frame starts
    {
        m_decoderIndexHead = decoderIndex; // new decoder slot head
        m_frameHead = frameIndex;          // new frame head
        checkSlotData(decoderIndex);       // check slot before re-init
        rwCorrectionEstimate(decoderIndex);
        m_nbWrites++;
        initDecodeSlot(decoderIndex);      // collect stats and re-initialize current slot
    }

    // Block processing

    if (m_decoderSlots[decoderIndex].m_blockCount < RemoteNbOrginalBlocks) // not enough blocks to decode -> store data
    {
        int blockIndex = superBlock->m_header.m_blockIndex;
        int blockCount = m_decoderSlots[decoderIndex].m_blockCount;
        int recoveryCount = m_decoderSlots[decoderIndex].m_recoveryCount;
        m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks[blockCount].Index = blockIndex;

        if (blockIndex == 0) // first block with meta
        {
            m_decoderSlots[decoderIndex].m_metaRetrieved = true;
        }

        if (blockIndex < RemoteNbOrginalBlocks) // original data
        {
            m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks[blockCount].Block = (void *) storeOriginalBlock(decoderIndex, blockIndex, superBlock->m_protectedBlock);
            m_decoderSlots[decoderIndex].m_originalCount++;
        }
        else // recovery data
        {
            m_decoderSlots[decoderIndex].m_recoveryBlocks[recoveryCount] = superBlock->m_protectedBlock;
            m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks[blockCount].Block = (void *) &m_decoderSlots[decoderIndex].m_recoveryBlocks[recoveryCount];
            m_decoderSlots[decoderIndex].m_recoveryCount++;
        }
    }

    m_decoderSlots[decoderIndex].m_blockCount++;

    if (m_decoderSlots[decoderIndex].m_blockCount == RemoteNbOrginalBlocks) // ready to decode
    {
        m_decoderSlots[decoderIndex].m_decoded = true;

        if (m_cm256_OK && (m_decoderSlots[decoderIndex].m_recoveryCount > 0)) // recovery data used => need to decode FEC
        {
            m_paramsCM256.BlockBytes = sizeof(RemoteProtectedBlock); // never changes
            m_paramsCM256.OriginalCount = RemoteNbOrginalBlocks;  // never changes

            if (m_decoderSlots[decoderIndex].m_metaRetrieved) {
                m_paramsCM256.RecoveryCount = m_currentMeta.m_nbFECBlocks;
            } else {
                m_paramsCM256.RecoveryCount = m_decoderSlots[decoderIndex].m_recoveryCount;
            }

            if (m_cm256.cm256_decode(m_paramsCM256, m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks)) // CM256 decode
            {
                qDebug() << "RemoteInputBuffer::writeData: decode CM256 error:"
                        << " decoderIndex: " << decoderIndex
                        << " m_blockCount: " << m_decoderSlots[decoderIndex].m_blockCount
                        << " m_originalCount: " << m_decoderSlots[decoderIndex].m_originalCount
                        << " m_recoveryCount: " << m_decoderSlots[decoderIndex].m_recoveryCount;
            }
            else
            {
                qDebug() << "RemoteInputBuffer::writeData: decode CM256 success:"
                        << " decoderIndex: " << decoderIndex
                        << " m_blockCount: " << m_decoderSlots[decoderIndex].m_blockCount
                        << " m_originalCount: " << m_decoderSlots[decoderIndex].m_originalCount
                        << " m_recoveryCount: " << m_decoderSlots[decoderIndex].m_recoveryCount;

                for (int ir = 0; ir < m_decoderSlots[decoderIndex].m_recoveryCount; ir++) // restore missing blocks
                {
                    int recoveryIndex = RemoteNbOrginalBlocks - m_decoderSlots[decoderIndex].m_recoveryCount + ir;
                    int blockIndex = m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks[recoveryIndex].Index;
                    RemoteProtectedBlock *recoveredBlock = (RemoteProtectedBlock *) m_decoderSlots[decoderIndex].m_cm256DescriptorBlocks[recoveryIndex].Block;

                    if (blockIndex == 0) // first block with meta
                    {
                        RemoteMetaDataFEC *metaData = (RemoteMetaDataFEC *) recoveredBlock;

                        boost::crc_32_type crc32;
                        crc32.process_bytes(metaData, sizeof(RemoteMetaDataFEC)-4);

                        if (crc32.checksum() == metaData->m_crc32)
                        {
                            m_decoderSlots[decoderIndex].m_metaRetrieved = true;
                            printMeta("RemoteInputBuffer::writeData: recovered meta", metaData);
                        }
                        else
                        {
                            qDebug() << "RemoteInputBuffer::writeData: recovered meta: invalid CRC32";
                        }
                    }

                    storeOriginalBlock(decoderIndex, blockIndex, *recoveredBlock);

                    qDebug() << "RemoteInputBuffer::writeData: recovered block #" << blockIndex;
                } // restore missing blocks
            } // CM256 decode
        } // recovery

        if (m_decoderSlots[decoderIndex].m_metaRetrieved) // block zero with its meta data has been received
        {
            RemoteMetaDataFEC *metaData = getMetaData(decoderIndex);

            if (!(*metaData == m_currentMeta))
            {
                uint32_t sampleRate =  metaData->m_sampleRate;

                if (sampleRate != 0)
                {
                    m_bufferLenSec = (float) m_framesNbBytes / (float) (sampleRate * metaData->m_sampleBytes * 2);
                    m_balCorrLimit = sampleRate / 400; // +/- 5% correction max per read
                    m_readNbBytes = (sampleRate * metaData->m_sampleBytes * 2) / 20;
                }

                printMeta("RemoteInputBuffer::writeData: new meta", metaData); // print for change other than timestamp
            }

            m_currentMeta = *metaData; // renew current meta
        } // check block 0
    } // decode
}

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

framesSize

const int RemoteInputBuffer::framesSize = REMOTEINPUT_NBDECODERSLOTS * (RemoteNbOrginalBlocks - 1) * RemoteNbBytesPerBlock

static

Definition at line 109 of file remoteinputbuffer.h.

Referenced by readData().

m_avgNbBlocks

MovingAverageUtil<int, int, 10> RemoteInputBuffer::m_avgNbBlocks

private

(stats) average number of blocks received

Definition at line 147 of file remoteinputbuffer.h.

Referenced by getAvgNbBlocks(), and initDecodeSlot().

m_avgNbRecovery

MovingAverageUtil<int, int, 10> RemoteInputBuffer::m_avgNbRecovery

private

(stats) average number of recovery blocks used

Definition at line 149 of file remoteinputbuffer.h.

Referenced by getAvgNbRecovery(), and initDecodeSlot().

m_avgOrigBlocks

MovingAverageUtil<int, int, 10> RemoteInputBuffer::m_avgOrigBlocks

private

(stats) average number of original blocks received

Definition at line 148 of file remoteinputbuffer.h.

Referenced by getAvgOriginalBlocks(), and initDecodeSlot().

m_balCorrection

int RemoteInputBuffer::m_balCorrection

private

R/W balance correction in number of samples.

Definition at line 164 of file remoteinputbuffer.h.

Referenced by getRWBalanceCorrection(), and rwCorrectionEstimate().

m_balCorrLimit

int RemoteInputBuffer::m_balCorrLimit

private

Correction absolute value limit in number of samples.

Definition at line 165 of file remoteinputbuffer.h.

Referenced by rwCorrectionEstimate().

m_bufferLenSec

float RemoteInputBuffer::m_bufferLenSec

private

Definition at line 160 of file remoteinputbuffer.h.

Referenced by getBufferLengthInSecs().

m_cm256

CM256 RemoteInputBuffer::m_cm256

private

CM256 library.

Definition at line 166 of file remoteinputbuffer.h.

m_cm256_OK

bool RemoteInputBuffer::m_cm256_OK

private

CM256 library initialized OK.

Definition at line 167 of file remoteinputbuffer.h.

m_curNbBlocks

int RemoteInputBuffer::m_curNbBlocks

private

(stats) instantaneous number of blocks received

Definition at line 141 of file remoteinputbuffer.h.

Referenced by getCurNbBlocks(), and initDecodeSlot().

m_curNbRecovery

int RemoteInputBuffer::m_curNbRecovery

private

(stats) instantaneous number of recovery blocks used

Definition at line 145 of file remoteinputbuffer.h.

Referenced by getCurNbRecovery(), and initDecodeSlot().

m_curOriginalBlocks

int RemoteInputBuffer::m_curOriginalBlocks

private

(stats) instantanous number of original blocks received

Definition at line 143 of file remoteinputbuffer.h.

Referenced by getCurOriginalBlocks(), and initDecodeSlot().

m_currentMeta

RemoteMetaDataFEC RemoteInputBuffer::m_currentMeta

private

Stored current meta data.

Definition at line 134 of file remoteinputbuffer.h.

Referenced by checkSlotData(), getCurrentMeta(), RemoteInputBuffer(), and rwCorrectionEstimate().

m_decoderIndexHead

int RemoteInputBuffer::m_decoderIndexHead

private

index of the current head frame slot in decoding slots

Definition at line 139 of file remoteinputbuffer.h.

Referenced by initReadIndex(), and writeData().

m_decoderSlots

DecoderSlot RemoteInputBuffer::m_decoderSlots[nbDecoderSlots]

private

CM256 decoding control/buffer slots.

Definition at line 136 of file remoteinputbuffer.h.

Referenced by checkSlotData(), initDecodeAllSlots(), initDecodeSlot(), and writeData().

m_frameHead

int RemoteInputBuffer::m_frameHead

private

index of the current head frame sent

Definition at line 140 of file remoteinputbuffer.h.

Referenced by writeData().

m_frames

BufferFrame RemoteInputBuffer::m_frames[nbDecoderSlots]

private

Samples buffer.

Definition at line 137 of file remoteinputbuffer.h.

Referenced by readData().

m_framesDecoded

bool RemoteInputBuffer::m_framesDecoded

private

[stats] true if all frames were decoded since last poll

Definition at line 150 of file remoteinputbuffer.h.

Referenced by allFramesDecoded(), and initDecodeSlot().

m_framesNbBytes

int RemoteInputBuffer::m_framesNbBytes

private

Number of bytes in samples buffer.

Definition at line 138 of file remoteinputbuffer.h.

Referenced by getBufferGauge(), initReadIndex(), readData(), and RemoteInputBuffer().

m_maxNbRecovery

int RemoteInputBuffer::m_maxNbRecovery

private

(stats) maximum number of recovery blocks used since last poll

Definition at line 146 of file remoteinputbuffer.h.

Referenced by getMaxNbRecovery(), and initDecodeSlot().

m_minNbBlocks

int RemoteInputBuffer::m_minNbBlocks

private

(stats) minimum number of blocks received since last poll

Definition at line 142 of file remoteinputbuffer.h.

Referenced by getMinNbBlocks(), and initDecodeSlot().

m_minOriginalBlocks

int RemoteInputBuffer::m_minOriginalBlocks

private

(stats) minimum number of original blocks received since last poll

Definition at line 144 of file remoteinputbuffer.h.

Referenced by getMinOriginalBlocks(), and initDecodeSlot().

m_nbReads

int RemoteInputBuffer::m_nbReads

private

Number of buffer reads since start of auto R/W balance correction period.

Definition at line 162 of file remoteinputbuffer.h.

Referenced by initReadIndex(), readData(), and rwCorrectionEstimate().

m_nbWrites

int RemoteInputBuffer::m_nbWrites

private

Number of buffer writes since start of auto R/W balance correction period.

Definition at line 163 of file remoteinputbuffer.h.

Referenced by initReadIndex(), rwCorrectionEstimate(), and writeData().

m_paramsCM256

CM256::cm256_encoder_params RemoteInputBuffer::m_paramsCM256

private

CM256 decoder parameters block.

Definition at line 135 of file remoteinputbuffer.h.

Referenced by RemoteInputBuffer().

m_readBuffer

uint8_t* RemoteInputBuffer::m_readBuffer

private

Read buffer to hold samples when looping back to beginning of raw buffer.

Definition at line 157 of file remoteinputbuffer.h.

Referenced by readData(), and ~RemoteInputBuffer().

m_readIndex

int RemoteInputBuffer::m_readIndex

private

current byte read index in frames buffer

Definition at line 151 of file remoteinputbuffer.h.

Referenced by checkSlotData(), initReadIndex(), readData(), and rwCorrectionEstimate().

m_readNbBytes

int RemoteInputBuffer::m_readNbBytes

private

Nominal number of bytes per read (50ms)

Definition at line 155 of file remoteinputbuffer.h.

Referenced by RemoteInputBuffer(), and rwCorrectionEstimate().

m_readSize

int RemoteInputBuffer::m_readSize

private

Read buffer size.

Definition at line 158 of file remoteinputbuffer.h.

Referenced by readData().

m_tvOut_sec

uint32_t RemoteInputBuffer::m_tvOut_sec

private

Estimated returned samples timestamp (seconds)

Definition at line 153 of file remoteinputbuffer.h.

Referenced by checkSlotData(), getTVOutMSec(), getTVOutSec(), and RemoteInputBuffer().

m_tvOut_usec

uint32_t RemoteInputBuffer::m_tvOut_usec

private

Estimated returned samples timestamp (microseconds)

Definition at line 154 of file remoteinputbuffer.h.

Referenced by checkSlotData(), getTVOutMSec(), getTVOutUsec(), and RemoteInputBuffer().

m_wrDeltaEstimate

int RemoteInputBuffer::m_wrDeltaEstimate

private

Sampled estimate of write to read indexes difference.

Definition at line 152 of file remoteinputbuffer.h.

Referenced by checkSlotData(), getBufferGauge(), initReadIndex(), and RemoteInputBuffer().

nbDecoderSlots

const int RemoteInputBuffer::nbDecoderSlots = REMOTEINPUT_NBDECODERSLOTS

staticprivate

Definition at line 112 of file remoteinputbuffer.h.

Referenced by checkSlotData(), initDecodeAllSlots(), initReadIndex(), RemoteInputBuffer(), rwCorrectionEstimate(), and writeData().

---

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

• plugins/samplesource/remoteinput/remoteinputbuffer.h
• plugins/samplesource/remoteinput/remoteinputbuffer.cpp