OpenRTX/openrtx/include/interfaces/audio.h

72 lines
2.1 KiB
C

/***************************************************************************
* Copyright (C) 2021 - 2022 by Federico Amedeo Izzo IU2NUO, *
* Niccolò Izzo IU2KIN *
* Frederik Saraci IU2NRO *
* Silvano Seva IU2KWO *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU General Public License as published by *
* the Free Software Foundation; either version 3 of the License, or *
* (at your option) any later version. *
* *
* This program is distributed in the hope that it will be useful, *
* but WITHOUT ANY WARRANTY; without even the implied warranty of *
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the *
* GNU General Public License for more details. *
* *
* You should have received a copy of the GNU General Public License *
* along with this program; if not, see <http://www.gnu.org/licenses/> *
***************************************************************************/
#ifndef AUDIO_H
#define AUDIO_H
#include <stdbool.h>
#include <stdint.h>
#include <rtx.h>
#ifdef __cplusplus
extern "C" {
#endif
/**
* This file provides a common interface for the platform-dependent low-level
* audio driver, in charge of managing microphone and audio amplifier.
*/
/**
* Initialise low-level audio management module.
*/
void audio_init();
/**
* Shut down low-level audio management module.
*/
void audio_terminate();
/**
* Enable microphone.
*/
void audio_enableMic();
/**
* Disable microphone.
*/
void audio_disableMic();
/**
* Enable audio PA.
*/
void audio_enableAmp();
/**
* Disable audio PA.
*/
void audio_disableAmp();
#ifdef __cplusplus
}
#endif
#endif /* AUDIO_H */