RollingBuffer.h

Go to the documentation of this file.

/*******************************************
RTCP Rolling Buffer include file
*******************************************/
#ifndef __KINESIS_VIDEO_WEBRTC_CLIENT_RTCP_ROLLING_BUFFER_H
#define __KINESIS_VIDEO_WEBRTC_CLIENT_RTCP_ROLLING_BUFFER_H
 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef STATUS (*FreeDataFunc)(PUINT64);
 
typedef struct {
    // Lock guarding the rolling buffer
    MUTEX lock;
    // Max size of data buffer array
    UINT32 capacity;
    // Head index point to next empty slot to put data
    UINT64 headIndex;
    // Tail index point to oldest slot with data inside
    UINT64 tailIndex;
    // Buffer storing pointers, each pointer point to actual data
    PUINT64 dataBuffer;
    // Function being called when data pointer is removed from buffer
    FreeDataFunc freeDataFn;
} RollingBuffer, *PRollingBuffer;
 
#define ROLLING_BUFFER_MAP_INDEX(pRollingBuffer, index) ((index) % (pRollingBuffer)->capacity)
 
STATUS createRollingBuffer(UINT32, FreeDataFunc, PRollingBuffer*);
STATUS freeRollingBuffer(PRollingBuffer*);
STATUS rollingBufferAppendData(PRollingBuffer, UINT64, PUINT64);
STATUS rollingBufferInsertData(PRollingBuffer, UINT64, UINT64);
STATUS rollingBufferExtractData(PRollingBuffer, UINT64, PUINT64);
STATUS rollingBufferGetSize(PRollingBuffer, PUINT32);
STATUS rollingBufferIsEmpty(PRollingBuffer, PBOOL);
 
#ifdef __cplusplus
}
#endif
#endif //__KINESIS_VIDEO_WEBRTC_CLIENT_RTCP_ROLLING_BUFFER_H