audio_stm32.h

/************************************************************************//**
 * \file heivs/AudioSTM32_stm32.h
 * \brief ARMEBS4 audio for stm32
 * \author marc dot pignat at hevs dot ch & Pascal Sartoretti (sap at hevs dot ch)
 * \addtogroup libheivs_stm32_audio Audio
 * \ingroup libheivs_stm32
 * @{
 ***************************************************************************/

#ifndef HEIVS_AUDIO_STM32_H
#define HEIVS_AUDIO_STM32_H

#include "heivs/error.h"

#ifdef __cplusplus
    extern "C" {
#endif

status_e AudioSTM32_Init(uint32_t fs, uint32_t sample_size);
status_e AudioSTM32_Record(int16_t * dataBuf, uint32_t length);

/************************************************************************//**
 *  \brief Play a sound (polling mode)
 *  \param dataBuf Data buffer of sound to record
 *  \param length byte length of the buffer
 *  \return NO_ERROR for no problem
 ***************************************************************************/
status_e AudioSTM32_Play(const int16_t *dataBuf, uint32_t length);

/************************************************************************//**
 *  \brief Audio stream initialization
 *  \param length byte length of each buffer
 *  \param buffer0 the first buffer to be played
 *  \param buffer1 the second buffer to be played
 *  \return NO_ERROR for no problem
 *
 *  \warning buffer0 and buffer1 are expected to exist until \see AudioSTM32_Stream_Stop
 *
 *  The DMA will play alternatively buffer0 and buffer1. \see AudioSTM32_Stream_Play
 *  will be used to replace the next buffer.
 ***************************************************************************/
status_e AudioSTM32_Stream_Play_Init(uint32_t length, void *buffer0, void *buffer1, void (*done)(const void *));

/************************************************************************//**
 *  \brief Audio stream play buffer
 *  \param data buffer to be played
 *  \return NO_ERROR for no problem
 *
 *  \see AudioSTM32_Stream_Status
 *
 *  \warning This function is blocking unless AudioSTM32_Stream_Status has returned NO_ERROR
 ***************************************************************************/
status_e AudioSTM32_Stream_Play(const void *data);
status_e AudioSTM32_Stream_Play_Pause(void);

/************************************************************************//**
 *  \brief Audio stream stop
 *  \return NO_ERROR for no problem
 ***************************************************************************/
status_e AudioSTM32_Stream_Play_Stop(void);

/************************************************************************//**
 *  \brief Is AudioSTM32_Stream_Play ready for the next buffer?
 *  \return ERROR_AGAIN if not ready, NO_ERROR when ready
 *  \see AudioSTM32_DMA_Play
 ***************************************************************************/
status_e AudioSTM32_Stream_Play_Status(void);

status_e AudioSTM32_Stream_Record_Init(uint32_t length, void *buffer0, void *buffer1, void (*done)(const void*));
status_e AudioSTM32_Stream_Record_Stop(void);

#ifdef __cplusplus
    }
#endif

/**
 * @}
 */
#endif /* HEIVS_AUDIO_STM32_H */