arduino-audio-driver
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AudioDriver Class Referenceabstract
Audio Driver

Abstract Driver API for codec chips. More...

#include <AudioDriver.h>

Inheritance diagram for AudioDriver:
AudioDriverZephyrT< TLV320AIC3104, 0x18 > AudioDriverAC101Class AudioDriverCS42448Class AudioDriverCS42L51Class AudioDriverCS43l22Class AudioDriverCombined AudioDriverES7210Class AudioDriverES7243Class AudioDriverES7243eClass AudioDriverES8156Class AudioDriverES8311Class AudioDriverES8374Class AudioDriverES8388Class AudioDriverLyratMiniClass AudioDriverNAU8325Class AudioDriverPCM3168Class AudioDriverSGTL5000Class AudioDriverTAS5805MClass AudioDriverWM8731Class AudioDriverWM8960Class AudioDriverWM8978Class AudioDriverWM8994Class AudioDriverZephyrT< T, DefaultI2CAddress > NoDriverClass

Public Member Functions

virtual bool begin (CodecConfig codecCfg, DriverDeviceInfo &pins)
 Starts the processing.
 
virtual bool end (void)
 Ends the processing: shut down dac and adc.
 
API_GPIO & getGPIO ()
 
virtual int getI2CAddress ()
 Provides the i2c address.
 
virtual int getVolume ()=0
 Determines the actual volume (range: 0-100)
 
virtual bool isInputVolumeSupported ()
 Determines if setInputVolume() is supported.
 
virtual bool isVolumeSupported ()
 Determines if setVolume() is suppored.
 
 operator bool ()
 
virtual DriverDeviceInfo & pins ()
 Provides the pin information.
 
virtual bool setConfig (CodecConfig codecCfg)
 changes the configuration
 
virtual bool setI2CAddress (uint16_t adr)
 Defines the i2c address.
 
virtual bool setInputVolume (int volume)
 Defines the input volume (range: 0-100) if supported.
 
virtual bool setMute (bool enable)=0
 Mutes all output lines.
 
virtual bool setMute (bool mute, int line)
 Mute individual lines: only supported for some rare DACs.
 
bool setPAPower (bool enable)
 Sets the PA Power pin to active or inactive.
 
void setPins (DriverDeviceInfo &pins)
 
void setupI2CAddress ()
 If no address is defined in the pins we provide it here.
 
virtual bool setVolume (int volume)=0
 Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.
 

Protected Member Functions

virtual bool configInterface (codec_mode_t mode, I2SDefinition iface)
 
virtual bool controlState (codec_mode_t mode)
 
virtual bool deinit ()
 
virtual i2c_bus_handle_t getI2C ()
 Determine the TwoWire object from the I2C config or use Wire.
 
virtual bool init (codec_config_t codec_cfg)
 
int limitValue (int volume, int min=0, int max=100)
 
int mapVolume (int x, int in_min, int in_max, int out_min, int out_max)
 

Protected Attributes

CodecConfig codec_cfg
 
int i2c_default_address = -1
 
DriverDeviceInfo * p_pins = nullptr
 

Detailed Description

Abstract Driver API for codec chips.

Author
Phil Schatzmann
Copyright
GPLv3

Member Function Documentation

◆ begin()

virtual bool begin ( CodecConfig  codecCfg,
DriverDeviceInfo &  pins 
)
inlinevirtual

Starts the processing.

Reimplemented in AudioDriverNAU8325Class, NoDriverClass, AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverWM8960Class, AudioDriverWM8994Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverCS42448Class, and AudioDriverWM8978Class.

◆ configInterface()

virtual bool configInterface ( codec_mode_t  mode,
I2SDefinition  iface 
)
inlineprotectedvirtual

Reimplemented in AudioDriverAC101Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverPCM3168Class, AudioDriverZephyrT< T, DefaultI2CAddress >, AudioDriverZephyrT< TLV320AIC3104, 0x18 >, and AudioDriverTLV320AIC3104Class.

◆ controlState()

virtual bool controlState ( codec_mode_t  mode)
inlineprotectedvirtual

Reimplemented in AudioDriverAC101Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverPCM3168Class, AudioDriverZephyrT< T, DefaultI2CAddress >, and AudioDriverZephyrT< TLV320AIC3104, 0x18 >.

◆ deinit()

virtual bool deinit ( )
inlineprotectedvirtual

Reimplemented in AudioDriverAC101Class, AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverTAS5805MClass, AudioDriverWM8994Class, AudioDriverPCM3168Class, AudioDriverZephyrT< T, DefaultI2CAddress >, and AudioDriverZephyrT< TLV320AIC3104, 0x18 >.

◆ end()

virtual bool end ( void  )
inlinevirtual

Ends the processing: shut down dac and adc.

Reimplemented in AudioDriverWM8978Class, AudioDriverNAU8325Class, NoDriverClass, AudioDriverWM8960Class, AudioDriverLyratMiniClass, AudioDriverCombined, and AudioDriverCS42448Class.

◆ getGPIO()

API_GPIO & getGPIO ( )
inline

◆ getI2C()

virtual i2c_bus_handle_t getI2C ( )
inlineprotectedvirtual

Determine the TwoWire object from the I2C config or use Wire.

◆ getI2CAddress()

virtual int getI2CAddress ( )
inlinevirtual

Provides the i2c address.

◆ getVolume()

virtual int getVolume ( )
pure virtual

Determines the actual volume (range: 0-100)

Implemented in NoDriverClass, AudioDriverAC101Class, AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverTAS5805MClass, AudioDriverWM8960Class, AudioDriverWM8994Class, AudioDriverPCM3168Class, AudioDriverCS42448Class, AudioDriverWM8978Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverZephyrT< T, DefaultI2CAddress >, AudioDriverZephyrT< TLV320AIC3104, 0x18 >, and AudioDriverNAU8325Class.

◆ init()

virtual bool init ( codec_config_t  codec_cfg)
inlineprotectedvirtual

Reimplemented in AudioDriverAC101Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverTAS5805MClass, AudioDriverPCM3168Class, AudioDriverZephyrT< T, DefaultI2CAddress >, and AudioDriverZephyrT< TLV320AIC3104, 0x18 >.

◆ isInputVolumeSupported()

virtual bool isInputVolumeSupported ( )
inlinevirtual

Determines if setInputVolume() is supported.

Reimplemented in NoDriverClass, AudioDriverES7210Class, AudioDriverES8311Class, AudioDriverES8388Class, AudioDriverWM8960Class, AudioDriverCS42448Class, AudioDriverWM8978Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverZephyrT< T, DefaultI2CAddress >, and AudioDriverZephyrT< TLV320AIC3104, 0x18 >.

◆ isVolumeSupported()

virtual bool isVolumeSupported ( )
inlinevirtual

Determines if setVolume() is suppored.

Reimplemented in NoDriverClass, AudioDriverWM8960Class, AudioDriverCS42448Class, and AudioDriverWM8978Class.

◆ limitValue()

int limitValue ( int  volume,
int  min = 0,
int  max = 100 
)
inlineprotected

make sure that value is in range

Parameters
volume
Returns

◆ mapVolume()

int mapVolume ( int  x,
int  in_min,
int  in_max,
int  out_min,
int  out_max 
)
inlineprotected

◆ operator bool()

operator bool ( )
inline

◆ pins()

virtual DriverDeviceInfo & pins ( )
inlinevirtual

Provides the pin information.

Reimplemented in AudioDriverCS42448Class.

◆ setConfig()

virtual bool setConfig ( CodecConfig  codecCfg)
inlinevirtual

changes the configuration

Reimplemented in AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverCS42448Class, AudioDriverWM8960Class, and AudioDriverWM8978Class.

◆ setI2CAddress()

virtual bool setI2CAddress ( uint16_t  adr)
inlinevirtual

Defines the i2c address.

◆ setInputVolume()

virtual bool setInputVolume ( int  volume)
inlinevirtual

Defines the input volume (range: 0-100) if supported.

Reimplemented in NoDriverClass, AudioDriverES7210Class, AudioDriverES8388Class, AudioDriverWM8960Class, AudioDriverCS42448Class, AudioDriverES8311Class, AudioDriverWM8978Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverZephyrT< T, DefaultI2CAddress >, and AudioDriverZephyrT< TLV320AIC3104, 0x18 >.

◆ setMute() [1/2]

virtual bool setMute ( bool  enable)
pure virtual

Mutes all output lines.

Implemented in NoDriverClass, AudioDriverWM8960Class, AudioDriverCS42448Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverZephyrT< T, DefaultI2CAddress >, AudioDriverZephyrT< TLV320AIC3104, 0x18 >, AudioDriverNAU8325Class, AudioDriverAC101Class, AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverTAS5805MClass, AudioDriverWM8994Class, AudioDriverPCM3168Class, and AudioDriverWM8978Class.

◆ setMute() [2/2]

virtual bool setMute ( bool  mute,
int  line 
)
inlinevirtual

Mute individual lines: only supported for some rare DACs.

Reimplemented in AudioDriverCS42448Class, AudioDriverES8388Class, AudioDriverPCM3168Class, and AudioDriverWM8978Class.

◆ setPAPower()

bool setPAPower ( bool  enable)
inline

Sets the PA Power pin to active or inactive.

◆ setPins()

void setPins ( DriverDeviceInfo &  pins)
inline

◆ setupI2CAddress()

void setupI2CAddress ( )
inline

If no address is defined in the pins we provide it here.

◆ setVolume()

virtual bool setVolume ( int  volume)
pure virtual

Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100.

Implemented in AudioDriverPCM3168Class, NoDriverClass, AudioDriverAC101Class, AudioDriverCS43l22Class, AudioDriverCS42L51Class, AudioDriverES7210Class, AudioDriverES7243Class, AudioDriverES7243eClass, AudioDriverES8156Class, AudioDriverWM8731Class, AudioDriverSGTL5000Class, AudioDriverES8311Class, AudioDriverES8374Class, AudioDriverES8388Class, AudioDriverTAS5805MClass, AudioDriverWM8960Class, AudioDriverWM8994Class, AudioDriverCS42448Class, AudioDriverWM8978Class, AudioDriverLyratMiniClass, AudioDriverCombined, AudioDriverZephyrT< T, DefaultI2CAddress >, AudioDriverZephyrT< TLV320AIC3104, 0x18 >, and AudioDriverNAU8325Class.

Member Data Documentation

◆ codec_cfg

CodecConfig codec_cfg
protected

◆ i2c_default_address

int i2c_default_address = -1
protected

◆ p_pins

DriverDeviceInfo* p_pins = nullptr
protected
The documentation for this class was generated from the following file:
Generated by doxygen 1.9.8