kBuffer.h

Go to the documentation of this file.

#ifndef KBUFFER_H
#define KBUFFER_H

#ifdef __cplusplus
extern "C"{
#endif

#include <stdint.h>

#ifndef bufferDatatype
    #define bufferDatatype uint16_t
#endif

#define BUFFER_ENABLE_MEAN

typedef struct{
    uint8_t isInitialized;
    uint16_t writePointer;
    uint16_t readPointer;
    uint16_t length;
    uint8_t elementLength;  
    uint16_t datacount;
    bufferDatatype* data;   
}buffer_t;

typedef enum{
    bufferOK = 0,
    bufferMemoryAllocationFailed,
    bufferEmpty,
    bufferFull,
    bufferNotInitialized,
    bufferError
}bufferStatus_t;


//Function declearations

bufferStatus_t bufferInit(buffer_t* buffer, uint16_t bufferSize);
bufferStatus_t bufferInitStatic(buffer_t* buffer, uint16_t bufferSize, bufferDatatype* bufferArray);
bufferStatus_t bufferWriteToIndex(buffer_t* buffer, uint16_t index, bufferDatatype data);
bufferStatus_t bufferReadFromIndex(buffer_t* buffer, uint16_t index, bufferDatatype* data);
uint8_t bufferIsEmpty(buffer_t* buffer);
uint8_t bufferIsFull(buffer_t* buffer);
bufferStatus_t bufferWrite(buffer_t* buffer, bufferDatatype data);
bufferStatus_t bufferWriteOverwrite(buffer_t* buffer, bufferDatatype data);
bufferStatus_t bufferRead(buffer_t* buffer, bufferDatatype* data);
bufferStatus_t bufferPeek(buffer_t* buffer, bufferDatatype* data);
bufferStatus_t bufferFill(buffer_t* buffer, bufferDatatype data, uint8_t silent);
bufferStatus_t bufferAvailable(buffer_t* buffer, uint16_t* available);

#ifdef BUFFER_ENABLE_MEAN
bufferStatus_t bufferMean(buffer_t* buffer, bufferDatatype* meanOut);
bufferStatus_t bufferMeanRMS(buffer_t* buffer, bufferDatatype* meanOut);
#endif

#ifdef __cplusplus
}
#endif

#endif