rockbox/firmware/export/audiohw.h
Frank Gevaerts d343bbe846 Allow e200 to compile without HAVE_RECORDING
git-svn-id: svn://svn.rockbox.org/rockbox/trunk@28104 a1c6a512-1295-4272-9138-f99709370657
2010-09-17 20:42:45 +00:00

569 lines
14 KiB
C

/***************************************************************************
* __________ __ ___.
* Open \______ \ ____ ____ | | _\_ |__ _______ ___
* Source | _// _ \_/ ___\| |/ /| __ \ / _ \ \/ /
* Jukebox | | ( <_> ) \___| < | \_\ ( <_> > < <
* Firmware |____|_ /\____/ \___ >__|_ \|___ /\____/__/\_ \
* \/ \/ \/ \/ \/
* $Id$
*
* Copyright (C) 2007 by Christian Gmeiner
*
* 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
* of the License, or (at your option) any later version.
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY
* KIND, either express or implied.
*
****************************************************************************/
#ifndef _AUDIOHW_H_
#define _AUDIOHW_H_
#include "config.h"
#include <stdbool.h>
/* define some audiohw caps */
#define TREBLE_CAP (1 << 0)
#define BASS_CAP (1 << 1)
#define BALANCE_CAP (1 << 2)
#define CLIPPING_CAP (1 << 3)
#define PRESCALER_CAP (1 << 4)
#define BASS_CUTOFF_CAP (1 << 5)
#define TREBLE_CUTOFF_CAP (1 << 6)
#define EQ_CAP (1 << 7)
#define DEPTH_3D_CAP (1 << 8)
#ifdef HAVE_UDA1380
#include "uda1380.h"
#elif defined(HAVE_UDA1341)
#include "uda1341.h"
#elif defined(HAVE_WM8750) || defined(HAVE_WM8751)
#include "wm8751.h"
#elif defined(HAVE_WM8978)
#include "wm8978.h"
#elif defined(HAVE_WM8975)
#include "wm8975.h"
#elif defined(HAVE_WM8985)
#include "wm8985.h"
#elif defined(HAVE_WM8758)
#include "wm8758.h"
#elif defined(HAVE_WM8711) || defined(HAVE_WM8721) || \
defined(HAVE_WM8731)
#include "wm8731.h"
#elif defined(HAVE_TLV320)
#include "tlv320.h"
#elif defined(HAVE_AS3514)
#include "as3514.h"
#elif defined(HAVE_MAS35XX)
#include "mas35xx.h"
#elif defined(HAVE_TSC2100)
#include "tsc2100.h"
#elif defined(HAVE_JZ4740_CODEC)
#include "jz4740-codec.h"
#elif defined(HAVE_AK4537)
#include "ak4537.h"
#endif
#if (CONFIG_PLATFORM & PLATFORM_HOSTED)
/* #include <SDL_audio.h> gives errors in other code areas,
* we don't really need it here, so don't. but it should maybe be fixed */
#ifndef SIMULATOR /* simulator gets values from the target .h files */
#define VOLUME_MIN -990
#define VOLUME_MAX 0
#endif
#endif
#define ONE_DB 10
#if !defined(VOLUME_MIN) && !defined(VOLUME_MAX)
#warning define for VOLUME_MIN and VOLUME_MAX is missing
#define VOLUME_MIN -700
#define VOLUME_MAX 0
#endif
#ifndef AUDIOHW_NUM_TONE_CONTROLS
#define AUDIOHW_NUM_TONE_CONTROLS 0
#endif
/* volume/balance/treble/bass interdependency main part */
#define VOLUME_RANGE (VOLUME_MAX - VOLUME_MIN)
/* convert caps into defines */
#ifdef AUDIOHW_CAPS
/* Tone controls */
#if (AUDIOHW_CAPS & TREBLE_CAP)
#define AUDIOHW_HAVE_TREBLE
#endif
#if (AUDIOHW_CAPS & BASS_CAP)
#define AUDIOHW_HAVE_BASS
#endif
#if (AUDIOHW_CAPS & BASS_CUTOFF_CAP)
#define AUDIOHW_HAVE_BASS_CUTOFF
#endif
#if (AUDIOHW_CAPS & TREBLE_CUTOFF_CAP)
#define AUDIOHW_HAVE_TREBLE_CUTOFF
#endif
#if (AUDIOHW_CAPS & BALANCE_CAP)
#define AUDIOHW_HAVE_BALANCE
#endif
#if (AUDIOHW_CAPS & CLIPPING_CAP)
#define AUDIOHW_HAVE_CLIPPING
#endif
#if (AUDIOHW_CAPS & PRESCALER_CAP)
#define AUDIOHW_HAVE_PRESCALER
#endif
/* Hardware EQ tone controls */
#if (AUDIOHW_CAPS & EQ_CAP)
/* A hardware equalizer is present (or perhaps some tone control variation
* that is not Bass and/or Treble) */
#define AUDIOHW_HAVE_EQ
/* Defined band indexes for supported bands */
enum
{
/* Band 1 is implied; bands must be contiguous, 1 to N */
AUDIOHW_EQ_BAND1 = 0,
#define AUDIOHW_HAVE_EQ_BAND1
#if (AUDIOHW_EQ_BAND_CAPS & (EQ_CAP << 1))
AUDIOHW_EQ_BAND2,
#define AUDIOHW_HAVE_EQ_BAND2
#if (AUDIOHW_EQ_BAND_CAPS & (EQ_CAP << 2))
AUDIOHW_EQ_BAND3,
#define AUDIOHW_HAVE_EQ_BAND3
#if (AUDIOHW_EQ_BAND_CAPS & (EQ_CAP << 3))
AUDIOHW_EQ_BAND4,
#define AUDIOHW_HAVE_EQ_BAND4
#if (AUDIOHW_EQ_BAND_CAPS & (EQ_CAP << 4))
AUDIOHW_EQ_BAND5,
#define AUDIOHW_HAVE_EQ_BAND5
#endif /* 5 */
#endif /* 4 */
#endif /* 3 */
#endif /* 2 */
AUDIOHW_EQ_BAND_NUM, /* Keep last */
};
#ifdef AUDIOHW_EQ_FREQUENCY_CAPS
/* One or more bands supports frequency cutoff or center adjustment */
#define AUDIOHW_HAVE_EQ_FREQUENCY
enum
{
__AUDIOHW_EQ_BAND_FREQUENCY = -1,
#if defined(AUDIOHW_HAVE_EQ_BAND1) && \
(AUDIOHW_EQ_FREQUENCY_CAPS & (EQ_CAP << 0))
AUDIOHW_EQ_BAND1_FREQUENCY,
#define AUDIOHW_HAVE_EQ_BAND1_FREQUENCY
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND2) && \
(AUDIOHW_EQ_FREQUENCY_CAPS & (EQ_CAP << 1))
AUDIOHW_EQ_BAND2_FREQUENCY,
#define AUDIOHW_HAVE_EQ_BAND2_FREQUENCY
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND3) && \
(AUDIOHW_EQ_FREQUENCY_CAPS & (EQ_CAP << 2))
AUDIOHW_EQ_BAND3_FREQUENCY,
#define AUDIOHW_HAVE_EQ_BAND3_FREQUENCY
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND4) && \
(AUDIOHW_EQ_FREQUENCY_CAPS & (EQ_CAP << 3))
AUDIOHW_EQ_BAND4_FREQUENCY,
#define AUDIOHW_HAVE_EQ_BAND4_FREQUENCY
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND5) && \
(AUDIOHW_EQ_FREQUENCY_CAPS & (EQ_CAP << 4))
AUDIOHW_EQ_BAND5_FREQUENCY,
#define AUDIOHW_HAVE_EQ_BAND5_FREQUENCY
#endif
AUDIOHW_EQ_FREQUENCY_NUM,
};
#endif /* AUDIOHW_EQ_FREQUENCY_CAPS */
#ifdef AUDIOHW_EQ_WIDTH_CAPS
/* One or more bands supports bandwidth adjustment */
#define AUDIOHW_HAVE_EQ_WIDTH
enum
{
__AUDIOHW_EQ_BAND_WIDTH = -1,
#if defined(AUDIOHW_HAVE_EQ_BAND1) && \
(AUDIOHW_EQ_WIDTH_CAPS & (EQ_CAP << 1))
AUDIOHW_EQ_BAND2_WIDTH,
#define AUDIOHW_HAVE_EQ_BAND2_WIDTH
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND2) && \
(AUDIOHW_EQ_WIDTH_CAPS & (EQ_CAP << 2))
AUDIOHW_EQ_BAND3_WIDTH,
#define AUDIOHW_HAVE_EQ_BAND3_WIDTH
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND3) && \
(AUDIOHW_EQ_WIDTH_CAPS & (EQ_CAP << 3))
AUDIOHW_EQ_BAND4_WIDTH,
#define AUDIOHW_HAVE_EQ_BAND4_WIDTH
#endif
AUDIOHW_EQ_WIDTH_NUM, /* Keep last */
};
#endif /* AUDIOHW_EQ_WIDTH_CAPS */
/* Types and number of settings types (gain, frequency, width) */
enum AUDIOHW_EQ_SETTINGS
{
AUDIOHW_EQ_GAIN = 0,
#ifdef AUDIOHW_HAVE_EQ_FREQUENCY
AUDIOHW_EQ_FREQUENCY,
#endif
#ifdef AUDIOHW_HAVE_EQ_WIDTH
AUDIOHW_EQ_WIDTH,
#endif
AUDIOHW_EQ_SETTING_NUM
};
#endif /* (AUDIOHW_CAPS & EQ_CAP) */
#if (AUDIOHW_CAPS & DEPTH_3D_CAP)
#define AUDIOHW_HAVE_DEPTH_3D
#endif
#else
#if defined (HAVE_SW_TONE_CONTROLS)
/* Needed for proper sound support */
#define AUDIOHW_HAVE_BASS
#define AUDIOHW_HAVE_TREBLE
#endif
#endif /* AUDIOHW_CAPS */
enum {
SOUND_VOLUME = 0,
/* Tone control */
#if defined(AUDIOHW_HAVE_BASS)
SOUND_BASS,
#endif
#if defined(AUDIOHW_HAVE_TREBLE)
SOUND_TREBLE,
#endif
SOUND_BALANCE,
SOUND_CHANNELS,
SOUND_STEREO_WIDTH,
#if (CONFIG_CODEC == MAS3587F) || (CONFIG_CODEC == MAS3539F)
SOUND_LOUDNESS,
SOUND_AVC,
SOUND_MDB_STRENGTH,
SOUND_MDB_HARMONICS,
SOUND_MDB_CENTER,
SOUND_MDB_SHAPE,
SOUND_MDB_ENABLE,
SOUND_SUPERBASS,
#endif
#if defined(HAVE_RECORDING)
SOUND_LEFT_GAIN,
SOUND_RIGHT_GAIN,
SOUND_MIC_GAIN,
#endif
/* Bass and treble tone controls */
#if defined(AUDIOHW_HAVE_BASS_CUTOFF)
SOUND_BASS_CUTOFF,
#endif
#if defined(AUDIOHW_HAVE_TREBLE_CUTOFF)
SOUND_TREBLE_CUTOFF,
#endif
/* 3D effect */
#if defined(AUDIOHW_HAVE_DEPTH_3D)
SOUND_DEPTH_3D,
#endif
/* Hardware EQ tone controls */
/* Band gains */
#if defined(AUDIOHW_HAVE_EQ)
/* Band 1 implied */
SOUND_EQ_BAND1_GAIN,
#if defined(AUDIOHW_HAVE_EQ_BAND2)
SOUND_EQ_BAND2_GAIN,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND3)
SOUND_EQ_BAND3_GAIN,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND4)
SOUND_EQ_BAND4_GAIN,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND5)
SOUND_EQ_BAND5_GAIN,
#endif
/* Band frequencies */
#if defined(AUDIOHW_HAVE_EQ_BAND1_FREQUENCY)
SOUND_EQ_BAND1_FREQUENCY,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND2_FREQUENCY)
SOUND_EQ_BAND2_FREQUENCY,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND3_FREQUENCY)
SOUND_EQ_BAND3_FREQUENCY,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND4_FREQUENCY)
SOUND_EQ_BAND4_FREQUENCY,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND5_FREQUENCY)
SOUND_EQ_BAND5_FREQUENCY,
#endif
/* Band widths */
#if defined(AUDIOHW_HAVE_EQ_BAND2_WIDTH)
SOUND_EQ_BAND2_WIDTH,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND3_WIDTH)
SOUND_EQ_BAND3_WIDTH,
#endif
#if defined(AUDIOHW_HAVE_EQ_BAND4_WIDTH)
SOUND_EQ_BAND4_WIDTH,
#endif
#endif /* AUDIOHW_HAVE_EQ */
SOUND_LAST_SETTING, /* Keep this last */
};
enum Channel {
SOUND_CHAN_STEREO,
SOUND_CHAN_MONO,
SOUND_CHAN_CUSTOM,
SOUND_CHAN_MONO_LEFT,
SOUND_CHAN_MONO_RIGHT,
SOUND_CHAN_KARAOKE,
SOUND_CHAN_NUM_MODES,
};
struct sound_settings_info {
const char *unit;
char numdecimals;
char steps;
short minval;
short maxval;
short defaultval;
};
/* This struct is used by every driver to export its min/max/default values for
* its audio settings. Keep in mind that the order must be correct! */
extern const struct sound_settings_info audiohw_settings[];
/* All usable functions implemented by a audio codec drivers. Most of
* the function in sound settings are only called, when in audio codecs
* .h file suitable defines are added.
*/
/**
* Initialize audio codec to a well defined state. Includes SoC-specific
* setup.
*/
void audiohw_init(void);
/**
* Do initial audio codec setup. Usually called from audiohw_init.
*/
void audiohw_preinit(void);
/**
* Do some stuff (codec related) after audiohw_init that needs to be
* delayed such as enabling outputs to prevent popping. This lets
* other inits in the system complete in the meantime.
*/
void audiohw_postinit(void);
/**
* Close audio codec.
*/
void audiohw_close(void);
#if defined(AUDIOHW_HAVE_CLIPPING) || defined(HAVE_SDL_AUDIO) || defined(ANDROID)
/**
* Set new volume value
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* CLIPPING_CAP
*/
void audiohw_set_volume(int val);
#endif
#ifdef AUDIOHW_HAVE_PRESCALER
/**
* Set new prescaler value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* PRESCALER_CAP
*/
void audiohw_set_prescaler(int val);
#endif
#ifdef AUDIOHW_HAVE_BALANCE
/**
* Set new balance value
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* BALANCE_CAP
*/
void audiohw_set_balance(int val);
#endif
#ifdef AUDIOHW_HAVE_TREBLE
/**
* Set new treble value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* TREBLE_CAP
*/
void audiohw_set_treble(int val);
#endif
#ifdef AUDIOHW_HAVE_BASS
/**
* Set new bass value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* BASS_CAP
*/
void audiohw_set_bass(int val);
#endif
#ifdef AUDIOHW_HAVE_BASS_CUTOFF
/**
* Set new bass cut off value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* BASS_CUTOFF_CAP
*/
void audiohw_set_bass_cutoff(int val);
#endif
#ifdef AUDIOHW_HAVE_TREBLE_CUTOFF
/**
* Set new treble cut off value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* TREBLE_CUTOFF_CAP
*/
void audiohw_set_treble_cutoff(int val);
#endif
#ifdef AUDIOHW_HAVE_EQ
/**
* Set new band gain value.
* @param band index to which val is set
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* EQ_CAP
*
* AUDIOHW_EQ_BAND_CAPS must be defined as a bitmask
* of EQ_CAP each shifted by the zero-based band number
* for each band. Bands 1 to N are indexed 0 to N-1.
*/
void audiohw_set_eq_band_gain(unsigned int band, int val);
#endif
#ifdef AUDIOHW_HAVE_EQ_FREQUENCY
/**
* Set new band cutoff or center frequency value.
* @param band index to which val is set
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* EQ_CAP
*
* AUDIOHW_EQ_FREQUENCY_CAPS must be defined as a bitmask
* of EQ_CAP each shifted by the zero-based band number
* for each band that supports frequency adjustment.
* Bands 1 to N are indexed 0 to N-1.
*/
void audiohw_set_eq_band_frequency(unsigned int band, int val);
#endif
#ifdef AUDIOHW_HAVE_EQ_WIDTH
/**
* Set new band cutoff or center frequency value.
* @param band index to which val is set
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* EQ_CAP
*
* AUDIOHW_EQ_WIDTH_CAPS must be defined as a bitmask
* of EQ_CAP each shifted by the zero-based band number
* for each band that supports width adjustment.
* Bands 1 to N are indexed 0 to N-1.
*/
void audiohw_set_eq_band_width(unsigned int band, int val);
#endif
#ifdef AUDIOHW_HAVE_DEPTH_3D
/**
* Set new 3-d enhancement (stereo expansion) effect value.
* @param val to set.
* NOTE: AUDIOHW_CAPS need to contain
* DEPTH_3D_CAP
*/
void audiohw_set_depth_3d(int val);
#endif
void audiohw_set_frequency(int fsel);
#ifdef HAVE_RECORDING
/**
* Enable recording.
* @param source_mic if this is true, we want to record from microphone,
* else we want to record FM/LineIn.
*/
void audiohw_enable_recording(bool source_mic);
/**
* Disable recording.
*/
void audiohw_disable_recording(void);
/**
* Set gain of recording source.
* @param left gain value.
* @param right will not be used if recording from micophone (mono).
* @param type AUDIO_GAIN_MIC, AUDIO_GAIN_LINEIN.
*/
void audiohw_set_recvol(int left, int right, int type);
#endif /* HAVE_RECORDING */
#if defined(HAVE_RECORDING) || defined(HAVE_FMRADIO_IN)
/**
* Enable or disable recording monitor.
* @param enable true or false.
*/
void audiohw_set_monitor(bool enable);
#endif
#if CONFIG_CODEC != SWCODEC
/* functions which are only used by mas35xx codecs, but are also
aviable on SWCODECS through dsp */
/**
* Set channel configuration.
* @param val new channel value (see enum Channel).
*/
void audiohw_set_channel(int val);
/**
* Set stereo width.
* @param val new stereo width value.
*/
void audiohw_set_stereo_width(int val);
#endif /* CONFIG_CODEC != SWCODEC */
#ifdef HAVE_SPEAKER
void audiohw_enable_speaker(bool on);
#endif /* HAVE_SPEAKER */
#endif /* _AUDIOHW_H_ */