AudioDriverAD1938Class Class Reference

Driver API for AD1938 TDS DAC/ADC. More...

#include <Driver.h>

Inheritance diagram for AudioDriverAD1938Class:

Public Member Functions
bool	begin (CodecConfig codecCfg, DriverPins &pins) override
	Starts the processing. More...
AD1938 &	driver ()
bool	end (void) override
	Ends the processing: shut down dac and adc. More...
int	getVolume () override
	Determines the actual volume (range: 0-100) More...
bool	isInputVolumeSupported () override
	Determines if setInputVolume() is supported. More...
bool	isVolumeSupported () override
	Determines if setVolume() is suppored. More...
	operator bool ()
DriverPins &	pins ()
	Provides the pin information. More...
virtual bool	setConfig (CodecConfig codecCfg)
	changes the configuration More...
bool	setInputVolume (int volume) override
	Defines the input volume (range: 0-100) if supported. More...
bool	setMute (bool mute) override
	Mutes all output lines. More...
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...
void	setPins (DriverPins &pins)
bool	setVolume (int volume) override
	Defines the Volume (in %) if volume is 0, mute is enabled,range is 0-100. More...
bool	setVolume (int volume, int line)

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

Protected Attributes
AD1938	ad1938
CodecConfig	codec_cfg
DriverPins *	p_pins = nullptr
int	volume = 100
int	volumes [8] = {100}

Detailed Description

Driver API for AD1938 TDS DAC/ADC.

Author

Phil Schatzmann

Copyright

GPLv3

Member Function Documentation

begin()

bool begin ( CodecConfig  codecCfg, DriverPins &  pins  )

inlineoverridevirtual

Starts the processing.

Reimplemented from AudioDriver.

configInterface()

virtual bool configInterface ( codec_mode_t  mode, I2SDefinition  iface  )

inlineprotectedvirtualinherited

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

controlState()

virtual bool controlState ( codec_mode_t  mode )

inlineprotectedvirtualinherited

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

deinit()

virtual bool deinit ( )

inlineprotectedvirtualinherited

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

driver()

AD1938& driver ( )

inline

end()

bool end ( void  )

inlineoverridevirtual

Ends the processing: shut down dac and adc.

Reimplemented from AudioDriver.

getI2C()

virtual TwoWire* getI2C ( )

inlineprotectedvirtualinherited

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

getI2CAddress()

virtual int getI2CAddress ( )

inlineprotectedvirtualinherited

getVolume()

int getVolume ( )

inlineoverridevirtual

Determines the actual volume (range: 0-100)

Implements AudioDriver.

init()

virtual bool init ( codec_config_t  codec_cfg )

inlineprotectedvirtualinherited

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

isInputVolumeSupported()

bool isInputVolumeSupported ( )

inlineoverridevirtual

Determines if setInputVolume() is supported.

Reimplemented from AudioDriver.

isVolumeSupported()

bool isVolumeSupported ( )

inlineoverridevirtual

Determines if setVolume() is suppored.

Reimplemented from AudioDriver.

limitValue()

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

inlineprotectedinherited

make sure that value is in range

Parameters

volume

Returns

operator bool()

operator bool ( )

inlineinherited

pins()

DriverPins& pins ( )

inlinevirtual

Provides the pin information.

Reimplemented from AudioDriver.

setConfig()

virtual bool setConfig ( CodecConfig  codecCfg )

inlinevirtual

changes the configuration

Reimplemented from AudioDriver.

setInputVolume()

bool setInputVolume ( int  volume )

inlineoverridevirtual

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

Reimplemented from AudioDriver.

setMute() [1/2]

bool setMute ( bool  enable )

inlineoverridevirtual

Mutes all output lines.

Implements AudioDriver.

setMute() [2/2]

bool setMute ( bool  mute, int  line  )

inlinevirtual

Mute individual lines: only supported for some rare DACs.

Reimplemented from AudioDriver.

setPAPower()

bool setPAPower ( bool  enable )

inlineinherited

Sets the PA Power pin to active or inactive.

setPins()

void setPins ( DriverPins &  pins )

inlineinherited

setVolume() [1/2]

bool setVolume ( int  volume )

inlineoverridevirtual

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

Implements AudioDriver.

setVolume() [2/2]

bool setVolume ( int  volume, int  line  )

inline

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

Member Data Documentation

ad1938

AD1938 ad1938

protected

codec_cfg

CodecConfig codec_cfg

protectedinherited

p_pins

DriverPins* p_pins = nullptr

protectedinherited

volume

int volume = 100

protected

volumes

int volumes[8] = {100}

protected

---

The documentation for this class was generated from the following file:

• src/Driver.h