FrontEnd.h

Go to the documentation of this file.

/*
 *  FrontEnd.h - Audio include file for the Spresense SDK
 *  Copyright 2019, 2021 Sony Semiconductor Solutions Corporation
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library 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
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */
 
#ifndef FrontEnd_h
#define FrontEnd_h
 
#ifdef SUBCORE
#error "Audio library is NOT supported by SubCore."
#endif
 
#include <audio/audio_capture_api.h>
#include <audio/audio_frontend_api.h>
#include <audio/audio_message_types.h>
#include <audio/utilities/frame_samples.h>
#include <audio/utilities/wav_containerformat.h>
#include <memutils/simple_fifo/CMN_SimpleFifo.h>
 
/*--------------------------------------------------------------------------*/
 
#define FRONTEND_LOG_DEBUG
 
#define print_err printf
 
#ifdef FRONTEND_LOG_DEBUG
#define print_dbg(...) printf(__VA_ARGS__)
#else
#define print_dbg(x...)
#endif
 
#define FRONTEND_ECODE_OK            0
#define FRONTEND_ECODE_COMMAND_ERROR 1
#define FRONTEND_ECODE_BASEBAND_ERROR 2 
 
#define FRONTEND_CAPCLK_NORMAL (0)
#define FRONTEND_CAPCLK_HIRESO (1)
 
/*--------------------------------------------------------------------------*/
 
class FrontEnd
{
public:
 
  static FrontEnd* getInstance()
    {
      static FrontEnd instance;
      return &instance;
    }
 
  err_t begin(void);
 
  err_t begin(AudioAttentionCb attcb);
 
  err_t end(void);
 
  err_t activate(void);
 
  err_t activate(
      MicFrontendCallback fedcb
  );
  err_t activate(
      MicFrontendCallback fedcb,
      bool                is_digital
  );
 
  err_t init(
      uint8_t channel_number,     
      uint8_t bit_length,         
      uint32_t samples_per_frame, 
      uint8_t data_path,          
      AsDataDest dest             
  );
 
  err_t start(void);
 
  err_t stop(void);
 
  err_t initpreproc(
      AsInitPreProcParam *param 
  );
 
  err_t setpreproc(
      AsSetPreProcParam *param 
  );
 
  err_t setMicGain(
      int16_t mic_gain 
  );
 
  err_t setCapturingClkMode(
      uint8_t clk_mode 
  );
 
  err_t deactivate(void);
 
private:
 
  FrontEnd()
    : m_fed_callback(NULL)
  {}
  FrontEnd(const FrontEnd&);
  FrontEnd& operator=(const FrontEnd&);
  ~FrontEnd() {}
 
  MicFrontendCallback m_fed_callback;
 
  err_t activateBaseband(void);
  err_t deactivateBaseband(void);
 
};
 
#endif // FrontEnd_h