arduino-audio-driver
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 <Driver.h>

Inheritance diagram for AudioDriver:
AudioDriverAC101Class AudioDriverAD1938Class AudioDriverCS42448Class AudioDriverCS43l22Class AudioDriverES7210Class AudioDriverES7243Class AudioDriverES7243eClass AudioDriverES8156Class AudioDriverES8311Class AudioDriverES8374Class AudioDriverES8388Class AudioDriverLyratMiniClass AudioDriverTAS5805MClass AudioDriverWM8960Class AudioDriverWM8978Class AudioDriverWM8994Class NoDriverClass

Public Member Functions

virtual bool begin (CodecConfig codecCfg, DriverPins &pins)
 
virtual bool end (void)
 
virtual int getVolume ()=0
 
virtual bool isInputVolumeSupported ()
 
virtual bool isVolumeSupported ()
 
DriverPins & pins ()
 
virtual bool setConfig (CodecConfig codecCfg)
 
virtual bool setInputVolume (int volume)
 
virtual bool setMute (bool enable)=0
 
virtual bool setMute (bool mute, int line)
 Mute individual lines: only supported for some rare DACs. More...
 
bool setPAPower (bool enable)
 Sets the PA Power pin to active or inactive. More...
 
virtual bool setVolume (int volume)=0
 Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100. More...
 

Protected Member Functions

virtual bool configInterface (codec_mode_t mode, I2SDefinition iface)
 
virtual bool controlState (codec_mode_t mode)
 
virtual bool deinit ()
 
TwoWire * getI2C ()
 Determine the TwoWire object from the I2C config or use Wire. More...
 
int getI2CAddress ()
 
virtual bool init (codec_config_t codec_cfg)
 
int limitValue (int volume, int min=0, int max=100)
 

Protected Attributes

CodecConfig codec_cfg
 
DriverPins * 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,
DriverPins &  pins 
)
inlinevirtual

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8994Class, AudioDriverWM8960Class, AudioDriverCS43l22Class, and NoDriverClass.

◆ configInterface()

virtual bool configInterface ( codec_mode_t  mode,
I2SDefinition  iface 
)
inlineprotectedvirtual

Reimplemented in AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ controlState()

virtual bool controlState ( codec_mode_t  mode)
inlineprotectedvirtual

Reimplemented in AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ deinit()

virtual bool deinit ( )
inlineprotectedvirtual

Reimplemented in AudioDriverWM8994Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, AudioDriverCS43l22Class, and AudioDriverAC101Class.

◆ end()

virtual bool end ( void  )
inlinevirtual

Reimplemented in AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, NoDriverClass, and AudioDriverWM8978Class.

◆ getI2C()

TwoWire* getI2C ( )
inlineprotected

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

◆ getI2CAddress()

int getI2CAddress ( )
inlineprotected

◆ getVolume()

virtual int getVolume ( )
pure virtual

Implemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8994Class, AudioDriverWM8960Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, AudioDriverCS43l22Class, AudioDriverAC101Class, and NoDriverClass.

◆ init()

virtual bool init ( codec_config_t  codec_cfg)
inlineprotectedvirtual

Reimplemented in AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, and AudioDriverAC101Class.

◆ isInputVolumeSupported()

virtual bool isInputVolumeSupported ( )
inlinevirtual

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, AudioDriverES8388Class, and NoDriverClass.

◆ isVolumeSupported()

virtual bool isVolumeSupported ( )
inlinevirtual

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverWM8960Class, and NoDriverClass.

◆ limitValue()

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

make sure that value is in range

Parameters
volume
Returns

◆ pins()

DriverPins& pins ( )
inline

◆ setConfig()

virtual bool setConfig ( CodecConfig  codecCfg)
inlinevirtual

Reimplemented in AudioDriverWM8960Class, AudioDriverCS42448Class, AudioDriverCS43l22Class, and AudioDriverAD1938Class.

◆ setInputVolume()

virtual bool setInputVolume ( int  volume)
inlinevirtual

Reimplemented in AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, AudioDriverES8388Class, and NoDriverClass.

◆ setMute() [1/2]

virtual bool setMute ( bool  enable)
pure virtual

Implemented in AudioDriverWM8978Class, AudioDriverAD1938Class, AudioDriverWM8994Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, AudioDriverCS43l22Class, AudioDriverAC101Class, AudioDriverCS42448Class, AudioDriverLyratMiniClass, AudioDriverWM8960Class, and NoDriverClass.

◆ setMute() [2/2]

virtual bool setMute ( bool  mute,
int  line 
)
inlinevirtual

Mute individual lines: only supported for some rare DACs.

Reimplemented in AudioDriverES8388Class, AudioDriverAD1938Class, and AudioDriverCS42448Class.

◆ setPAPower()

bool setPAPower ( bool  enable)
inline

Sets the PA Power pin to active or inactive.

◆ 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 AudioDriverWM8978Class, AudioDriverCS42448Class, AudioDriverAD1938Class, AudioDriverLyratMiniClass, AudioDriverWM8994Class, AudioDriverWM8960Class, AudioDriverTAS5805MClass, AudioDriverES8388Class, AudioDriverES8374Class, AudioDriverES8311Class, AudioDriverES8156Class, AudioDriverES7243eClass, AudioDriverES7243Class, AudioDriverES7210Class, AudioDriverCS43l22Class, AudioDriverAC101Class, and NoDriverClass.

Member Data Documentation

◆ codec_cfg

CodecConfig codec_cfg
protected

◆ p_pins

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