Driver API for the wm8978 codec chip. More...

#include <Driver.h>

Inheritance diagram for AudioDriverWM8978Class:

Public Member Functions
	AudioDriverWM8978Class ()=default

bool	begin (CodecConfig codecCfg, DriverPins &pins) override
	Starts the processing. More...

WM8978 &	driver ()

bool	end () 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 ()

virtual DriverPins &	pins ()
	Provides the pin information. More...

bool	setConfig (CodecConfig codecCfg) override
	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) override
	Mute line 0 = speaker, line 1 = headphones. 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...

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)

int	toBits (sample_bits_t bits)

int	toI2S (i2s_format_t fmt)

Protected Attributes
CodecConfig	codec_cfg

DriverPins *	p_pins = nullptr

int	volume = 0

WM8978	wm8078

Detailed Description

Driver API for the wm8978 codec chip.

Author: Phil Schatzmann

Copyright: GPLv3

Constructor & Destructor Documentation

◆ AudioDriverWM8978Class()

AudioDriverWM8978Class ( )

default

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()

WM8978& 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()

virtual DriverPins& pins ( )

inlinevirtualinherited

Provides the pin information.

Reimplemented in AudioDriverCS42448Class, and AudioDriverAD1938Class.

◆ setConfig()

bool setConfig ( CodecConfig codecCfg )

inlineoverridevirtual

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
	)

inlineoverridevirtual

Mute line 0 = speaker, line 1 = headphones.

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()

bool setVolume ( int volume )

inlineoverridevirtual

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

Implements AudioDriver.

◆ toBits()

int toBits ( sample_bits_t bits )

inlineprotected

◆ toI2S()

int toI2S ( i2s_format_t fmt )

inlineprotected

fmt:0,LSB(right-aligned);1,MSB(left-aligned);2,Philips standard, I2S;3,PCM/DSP;

Member Data Documentation

◆ codec_cfg

CodecConfig codec_cfg

protectedinherited

◆ p_pins

DriverPins* p_pins = nullptr

protectedinherited

◆ volume

int volume = 0

protected

◆ wm8078

WM8978 wm8078

protected

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

src/Driver.h

Public Member Functions

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ AudioDriverWM8978Class()

Member Function Documentation

◆ begin()

◆ configInterface()

◆ controlState()

◆ deinit()

◆ driver()

◆ end()

◆ getI2C()

◆ getI2CAddress()

◆ getVolume()

◆ init()

◆ isInputVolumeSupported()

◆ isVolumeSupported()

◆ limitValue()

◆ operator bool()

◆ pins()

◆ setConfig()

◆ setInputVolume()

◆ setMute() [1/2]

◆ setMute() [2/2]

◆ setPAPower()

◆ setPins()

◆ setVolume()

◆ toBits()

◆ toI2S()

Member Data Documentation

◆ codec_cfg

◆ p_pins

◆ volume

◆ wm8078