portapack-mayhem/firmware/application/audio.hpp

/*
 * Copyright (C) 2014 Jared Boone, ShareBrained Technology, Inc.
 * Copyright (C) 2016 Furrtek
 *
 * This file is part of PortaPack.
 *
 * 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 2, 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; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street,
 * Boston, MA 02110-1301, USA.
 */

#ifndef __AUDIO_H__
#define __AUDIO_H__

#include "volume.hpp"

#include <cstdint>
#include <cstddef>

#include <string>

namespace audio {

class Codec {
   public:
    virtual ~Codec() {}

    virtual std::string name() const = 0;

    virtual bool reset() = 0;
    virtual void init() = 0;

    virtual void speaker_enable() = 0;
    virtual void speaker_disable() = 0;
    virtual bool speaker_disable_supported() const = 0;

    virtual void headphone_enable() = 0;
    virtual void headphone_disable() = 0;
    virtual volume_range_t headphone_gain_range() const = 0;
    virtual void set_headphone_volume(const volume_t volume) = 0;

    virtual void microphone_enable(int8_t alc_mode, bool mic_to_HP_enabled) = 0;  // added user-GUI  AK4951 ,selected ALC mode.
    virtual void microphone_disable() = 0;

    virtual void microphone_to_HP_enable() = 0;
    virtual void microphone_to_HP_disable() = 0;

    virtual size_t reg_count() const = 0;
    virtual size_t reg_bits() const = 0;
    virtual uint32_t reg_read(const size_t register_number) = 0;
    virtual void reg_write(const size_t register_number, const uint32_t value) = 0;
};

namespace output {

void start();  // this  other start(),no changed. ,in namespace output , used to config audio playback mode,
void stop();

void mute();
void unmute();

void speaker_disable();
void speaker_enable();
void speaker_mute();
void speaker_unmute();
void update_audio_mute();

} /* namespace output */

namespace input {

void start(int8_t alc_mode, bool mic_to_HP_enabled);  // added parameters -GUI select AK4951-ALC mode for config mic path,(recording mode),and the check box "Hear Mic"
void stop();

void loopback_mic_to_hp_enable();
void loopback_mic_to_hp_disable();

} /* namespace input */

namespace headphone {

volume_range_t volume_range();

void set_volume(const volume_t volume);

} /* namespace headphone */

namespace speaker {

volume_range_t volume_range();

void set_volume(const volume_t volume);

} /* namespace speaker */

namespace debug {

size_t reg_count();
uint32_t reg_read(const size_t register_number);
void reg_write(const size_t register_number, uint32_t value);
std::string codec_name();
size_t reg_bits();

} /* namespace debug */

void init(audio::Codec* const codec);
void shutdown();
bool speaker_disable_supported();

enum class Rate {
    Hz_12000 = 4,
    Hz_24000 = 2,
    Hz_48000 = 1,
};

void set_rate(const Rate rate);

} /* namespace audio */

#endif /*__AUDIO_H__*/