LC3API.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018-2021 T2 Software, Inc. All rights reserved.
 *
 * SPDX-License-Identifier: LicenseRef-T2-LC3
 */
 
#ifndef _LC3APIH_
#define _LC3APIH_
 
#ifdef __cplusplus
extern "C" {
#endif
 
/******************************************************************************
* Includes
******************************************************************************/
#include "osal.h"
 
/******************************************************************************
* Definitions
******************************************************************************/
 
#define LC3_ERROR_OFFSET (-5000) 
#define LC3_RESULT_NO_ERROR (0) 
#define LC3_RESULT_INVALID_PARAMETER ((LC3_ERROR_OFFSET)-1) 
#define LC3_RESULT_INSUFFICIENT_RESOURCES ((LC3_ERROR_OFFSET)-2) 
#define LC3_RESULT_NOT_INITIALIZED ((LC3_ERROR_OFFSET)-3) 
#define LC3_RESULT_UNKNOWN_ERROR ((LC3_ERROR_OFFSET)-4) 
#define LC3_RESULT_INVALID_BITRATE ((LC3_ERROR_OFFSET)-5) 
#define LC3_RESULT_INPUT_BUFFER_TOO_SMALL ((LC3_ERROR_OFFSET)-6) 
#define LC3_RESULT_OUTPUT_BUFFER_TOO_SMALL ((LC3_ERROR_OFFSET)-7) 
#define LC3_RESULT_INVALID_BITSPERSAMPLE ((LC3_ERROR_OFFSET)-8) 
#define LC3_RESULT_INVALID_SAMPLERATE ((LC3_ERROR_OFFSET)-9) 
#define LC3_RESULT_BITERRORCONDITION ((LC3_ERROR_OFFSET)-10) 
#define LC3_RESULT_FEATURE_NOT_SUPPORTED ((LC3_ERROR_OFFSET)-11) 
#define LC3_RESULT_STILL_IN_USE ((LC3_ERROR_OFFSET)-12) 
#define LC3_RESULT_ALREADY_INITIALIZED ((LC3_ERROR_OFFSET)-13) 
#define LC3_SAMPLE_RATE_NONE (0x00) 
#define LC3_SAMPLE_RATE_8_KHZ (0x01) 
#define LC3_SAMPLE_RATE_16_KHZ (0x02) 
#define LC3_SAMPLE_RATE_24_KHZ (0x04) 
#define LC3_SAMPLE_RATE_32_KHZ (0x08) 
#define LC3_SAMPLE_RATE_441_KHZ (0x10) 
#define LC3_SAMPLE_RATE_48_KHZ (0x20) 
#define LC3_SAMPLE_RATE_ALL (0x1F) 
/******************************************************************************
* Module Typedefs
******************************************************************************/
 
typedef void * LC3EncoderHandle_t;
 
typedef void * LC3DecoderHandle_t;
 
typedef enum
{
 LC3FrameSize10MsConfig, 
 LC3FrameSize7_5MsConfig, 
 LC3FrameSizeBothConfig 
} LC3FrameSizeConfig_t;
 
typedef enum
{
 LC3FrameSize10Ms, 
 LC3FrameSize7_5Ms 
} LC3FrameSize_t;
 
typedef struct
{
 const void *PCMData; 
 uint16_t PCMDataLength; 
 uint32_t encodeBitrate; 
 uint16_t bytesRead; 
} LC3EncodeInput_t;
 
typedef struct
{
 uint8_t *outputData; 
 uint16_t outputDataLength; 
 uint16_t bytesWritten; 
} LC3EncodeOutput_t;
 
typedef enum
{
 GoodFrame,
 BadFrame
} LC3BFI_t;
 
typedef struct
{
 const uint8_t *inputData; 
 uint16_t inputDataLength; 
 LC3BFI_t badFrameIndicator; 
} LC3DecodeInput_t;
 
typedef struct
{
 void *PCMData; 
 uint16_t PCMDataLength; 
 uint16_t bytesWritten; 
 uint16_t PLCCounter; 
} LC3DecodeOutput_t;
 
 
/******************************************************************************
* Function Prototypes
******************************************************************************/
int32_t OSALCALL LC3Initialize(uint8_t encoderSampleRates, uint8_t decoderSampleRates, LC3FrameSizeConfig_t frameSizeConfig, uint8_t uniqueSessions, uint8_t *buffer, uint32_t *bufferSize);
 
 
int32_t OSALCALL LC3Deinitialize(void);
 
 
LC3EncoderHandle_t OSALCALL LC3EncodeSessionOpen(uint16_t sampleRate, uint8_t bitsPerSample, LC3FrameSize_t frameSize, uint8_t *buffer, uint16_t *bufferSize, int32_t *result);
 
 
int32_t OSALCALL LC3EncodeSessionData(LC3EncoderHandle_t encodeHandle, LC3EncodeInput_t *encodeInput, LC3EncodeOutput_t *encodeOutput);
 
 
void OSALCALL LC3EncodeSessionClose(LC3EncoderHandle_t encodeHandle);
 
 
LC3DecoderHandle_t OSALCALL LC3DecodeSessionOpen(uint16_t sampleRate, uint8_t bitsPerSample, LC3FrameSize_t frameSize, uint8_t *buffer, uint16_t *bufferSize, int32_t *result);
 
 
int32_t OSALCALL LC3DecodeSessionData(LC3DecoderHandle_t decodeHandle, LC3DecodeInput_t *decodeInput, LC3DecodeOutput_t *decodeOutput);
 
 
void OSALCALL LC3DecodeSessionClose(LC3DecoderHandle_t decodeHandle);
 
 
uint16_t OSALCALL LC3BitstreamBuffersize(uint16_t sampleRate, uint32_t maxBitRate, LC3FrameSize_t frameSize, int32_t *result);
 
 
uint16_t OSALCALL LC3PCMBuffersize(uint16_t sampleRate, uint8_t bitDepth, LC3FrameSize_t frameSize, int32_t *result);
 /* LC3 */
 
#ifdef __cplusplus
};
#endif
 
#endif /* _LC3APIH_ */