|
arduino-audio-tools
|
New functionality which replaces the AudioKitStream that is based on the legacy AudioKit library. This functionality uses the new arduino-audio-driver library! It is the same as I2SCodecStream extended by some AudioActions and some method calls to determine defined pin values. See https://github.com/pschatzmann/arduino-audio-driver. More...
#include <AudioBoardStream.h>
Public Member Functions | |
| AudioBoardStream (audio_driver::AudioBoard &board) | |
| Default constructor: for available AudioBoard values check the audioboard variables in https://pschatzmann.github.io/arduino-audio-driver/html/group__audio__driver.html Further information can be found in https://github.com/pschatzmann/arduino-audio-driver/wiki. | |
| float | actionVolumeIncrementValue () |
| void | addAction (AudioDriverKey key, void(*action)(bool, int, void *), void *ref=nullptr) |
| Defines a new action that is executed when the Button is pressed. | |
| void | addAction (AudioDriverKey key, void(*actionOn)(bool, int, void *), void(*actionOff)(bool, int, void *), void *ref=nullptr) |
| Defines a new action that is executed when the Button is pressed and released. | |
| void | addAction (int pin, void(*action)(bool, int, void *), AudioActions::ActiveLogic activeLogic, void *ref=nullptr) |
| Defines a new action that is executed when the indicated pin is active. | |
| void | addAction (int pin, void(*action)(bool, int, void *), void *ref=nullptr) |
| Defines a new action that is executed when the indicated pin is active. | |
| void | addDefaultActions () |
| Setup the supported default actions (volume, start/stop, headphone detection) | |
| void | addHeadphoneDetectionAction () |
| Adds headphone determination. | |
| virtual void | addNotifyAudioChange (AudioInfoSupport &bi) |
| Adds target to be notified about audio changes. | |
| void | addStartStopAction () |
| add start/stop on inputMode | |
| void | addVolumeActions () |
| add volume up and volume down action | |
| AudioActions & | audioActions () |
| Provides access to the AudioActions. | |
| virtual AudioInfo | audioInfo () override |
| provides the actual input AudioInfo | |
| virtual AudioInfo | audioInfoOut () |
| virtual int | available () override |
| Provides the available audio data. | |
| virtual int | availableForWrite () override |
| Provides the available audio data. | |
| bool | begin () override |
| bool | begin (I2SCodecConfig cfg) override |
| Starts the I2S interface. | |
| AudioBoard & | board () |
| Provides the board. | |
| virtual void | clearNotifyAudioChange () |
| Deletes all change notify subscriptions. | |
| I2SCodecConfig | defaultConfig (RxTxMode mode=TX_MODE) |
| Provides the default configuration. | |
| bool | digitalRead (int pin) |
| get value of digital pin | |
| void | digitalWrite (int pin, bool value) |
| set value of digital pin | |
| I2SDriver * | driver () |
| Provides the i2s driver. | |
| void | end () |
| Stops the I2S interface. | |
| virtual void | flush () override |
| AudioActions & | getActions () |
| GpioPin | getKey (int pos) |
| Provides the gpio for the indicated key pos. | |
| GpioPin | getPinID (PinFunction function) |
| Provides the gpio for the indicated function. | |
| GpioPin | getPinID (PinFunction function, int pos) |
| Provides the gpio for the indicated function. | |
| DriverPins & | getPins () |
| Provides access to the pin information. | |
| float | getVolume () |
| legacy: same as volume() | |
| bool | hasBoard () |
| checks if a board has been defined | |
| bool | headphoneStatus () |
| Returns true if the headphone was detected. | |
| void | incrementVolume (float inc) |
| Relative volume control. | |
| bool | isKeyPressed (int key) |
| bool | isNotifyActive () |
| Checks if the automatic AudioInfo update is active. | |
| virtual | operator bool () |
| GpioPin | pinAuxin () |
| Get the gpio number for auxin detection. | |
| GpioPin | pinHeadphoneDetect () |
| Get the gpio number for headphone detection. | |
| GpioPin | pinInputMode () |
| Get the number for mode-button. | |
| GpioPin | pinInputPlay () |
| Get number for play function. | |
| GpioPin | pinInputRec () |
| Get the record-button id for adc-button. | |
| GpioPin | pinInputSet () |
| Get number for set function. | |
| GpioPin | pinLed (int idx) |
| Get LED pin. | |
| GpioPin | pinPaEnable () |
| Get the gpio number for PA enable. | |
| GpioPin | pinVolumeDown () |
| Get number for volume down function. | |
| GpioPin | pinVolumeUp () |
| number for volume up function | |
| void | processActions () |
| Process input keys and pins. | |
| virtual size_t | readBytes (uint8_t *data, size_t len) override |
| Reads the audio data. | |
| virtual size_t | readSilence (uint8_t *buffer, size_t length) |
| Source to generate silence: just sets the buffer to 0. | |
| virtual bool | removeNotifyAudioChange (AudioInfoSupport &bi) |
| Removes a target in order not to be notified about audio changes. | |
| void | setActionVolumeIncrementValue (float value) |
| Defines the increment value used by actionVolumeDown/actionVolumeUp. | |
| void | setActive (bool active) |
| The oposite of setMute(): setActive(true) calls setMute(false) | |
| virtual void | setAudioInfo (AudioInfo info) |
| updates the sample rate dynamically | |
| void | setBoard (AudioBoard &board) |
| (re)defines the board | |
| void | setBoard (AudioBoard *board) |
| (re)defines the board | |
| bool | setInputVolume (float vol) |
| Sets the volume of the microphone (if available) | |
| bool | setMute (bool mute) |
| Mute / unmote. | |
| bool | setMute (bool mute, int line) |
| Mute / unmute of an individual line (codec) | |
| void | setNotifyActive (bool flag) |
| Deactivate/Reactivate automatic AudioInfo updates: (default is active) | |
| bool | setPAPower (bool active) |
| Sets the output of the PA Power Pin. | |
| void | setSpeakerActive (bool active) |
| the same as setPAPower() | |
| bool | setVolume (float vol) override |
| sets the volume (range 0.0f - 1.0f) | |
| void | setWriteBufferSize (int size) |
| float | volume () override |
| Provides the actual volume (0.0f - 1.0f) | |
| virtual size_t | write (const uint8_t *data, size_t len) |
| Writes the audio data to I2S. | |
| virtual size_t | write (uint8_t ch) override |
| virtual void | writeSilence (size_t len) |
| Writes len bytes of silence (=0). | |
Static Public Member Functions | |
| static void | actionHeadphoneDetection (bool, int, void *ref) |
| Switch off the PA if the headphone in plugged in and switch it on again if the headphone is unplugged. This method complies with the. | |
| static void | actionStart (bool, int, void *ref) |
| Start. | |
| static void | actionStartStop (bool, int, void *ref) |
| Toggle start stop. | |
| static void | actionStop (bool, int, void *ref) |
| Stop. | |
| static void | actionVolumeDown (bool, int, void *ref) |
| Decrease the volume. | |
| static void | actionVolumeUp (bool, int, void *ref) |
| Increase the volume. | |
Protected Member Functions | |
| bool | begin1 () |
| bool | beginCodec (I2SCodecConfig info) |
| AudioActions::ActiveLogic | getActionLogic (int pin) |
| Determines the action logic (ActiveLow or ActiveTouch) for the pin. | |
| audio_driver_local::Optional< PinsI2S > | getI2SPins () |
| int | getSdCsPin () |
| virtual int | not_supported (int out, const char *msg="") |
| void | notifyAudioChange (AudioInfo info) |
| void | refillReadBuffer () |
| void | setupI2SFunction () |
| if the cfg.i2s_function was not defined we determine the "correct" default value | |
| void | setupI2SPins () |
| We use the board pins if they are available. | |
| sample_bits_t | toCodecBits (int bits) |
| i2s_format_t | toFormat (I2SFormat fmt) |
| samplerate_t | toRate (int rate) |
Protected Attributes | |
| int | _timeout = 10 |
| float | action_increment_value = 0.02 |
| AudioActions | actions |
| bool | active = true |
| I2SCodecConfig | cfg |
| CodecConfig | codec_cfg |
| bool | headphoneIsConnected = false |
| I2SStream | i2s |
| AudioInfo | info |
| bool | is_active = false |
| bool | is_notify_active = true |
| Vector< AudioInfoSupport * > | notify_vector |
| AudioBoard * | p_board = nullptr |
| RingBuffer< uint8_t > | tmp_in {0} |
| RingBuffer< uint8_t > | tmp_out {0} |
| float | volume_value = 1.0f |
| int | write_buffer_size = MAX_SINGLE_CHARS |
New functionality which replaces the AudioKitStream that is based on the legacy AudioKit library. This functionality uses the new arduino-audio-driver library! It is the same as I2SCodecStream extended by some AudioActions and some method calls to determine defined pin values. See https://github.com/pschatzmann/arduino-audio-driver.
|
inline |
Default constructor: for available AudioBoard values check the audioboard variables in https://pschatzmann.github.io/arduino-audio-driver/html/group__audio__driver.html Further information can be found in https://github.com/pschatzmann/arduino-audio-driver/wiki.
Switch off the PA if the headphone in plugged in and switch it on again if the headphone is unplugged. This method complies with the.
|
inline |
|
inline |
Defines a new action that is executed when the Button is pressed.
|
inline |
Defines a new action that is executed when the Button is pressed and released.
|
inline |
Defines a new action that is executed when the indicated pin is active.
| pin | |
| action | |
| activeLogic | |
| ref |
Defines a new action that is executed when the indicated pin is active.
| pin | |
| action | |
| ref |
|
inline |
Setup the supported default actions (volume, start/stop, headphone detection)
|
inline |
Adds headphone determination.
|
inlinevirtualinherited |
Adds target to be notified about audio changes.
Reimplemented in CodecNOP, EncodedAudioOutput, EncodedAudioStream, AACDecoderFDK, DecoderBasic, CodecChain, MP3DecoderHelix, MP3DecoderMAD, OggContainerDecoder, RTSPClient< TcpClient, UdpSocket >, Pipeline, and Pipeline::ModifyingStreamAdapter.
|
inline |
add start/stop on inputMode
|
inline |
add volume up and volume down action
|
inline |
Provides access to the AudioActions.
provides the actual input AudioInfo
Implements AudioInfoSupport.
Reimplemented in JupyterAudioT< T >, MozziStream, TimerCallbackAudioStream, EncodedAudioStream, PureDataStream, AdapterAudioOutputToAudioStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and InputMerge< T >.
provides the actual output AudioInfo: this is usually the same as audioInfo() unless we use a transforming stream
Reimplemented in PureDataStream, PWMAudioOutput, ChannelFormatConverterStreamT< T >, ChannelFormatConverterStream, NumberFormatConverterStreamT< TFrom, TTo >, NumberFormatConverterStream, FormatConverterStream, Pipeline, ResampleStream, and ResampleStreamT< TInterpolator >.
Provides the available audio data.
Reimplemented from BaseStream.
Provides the available audio data.
Reimplemented from BaseStream.
|
inlineoverridevirtual |
Reimplemented from BaseStream.
|
inlineoverridevirtual |
Starts the I2S interface.
Reimplemented from I2SCodecStream.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineinherited |
Provides the board.
Deletes all change notify subscriptions.
Reimplemented in RTSPClient< TcpClient, UdpSocket >.
|
inlineinherited |
Provides the default configuration.
|
inlineinherited |
Provides the i2s driver.
|
inlinevirtualinherited |
Stops the I2S interface.
Reimplemented from BaseStream.
Reimplemented from Print.
Reimplemented in PureDataStream, URLStreamBufferedT< T >, URLStreamBufferedT< ICYStream >, AudioStreamWrapper, ResampleStream, URLStream, BufferedTaskStream, I2SStream, MemoryStream, RingBufferStream, GeneratedSoundStream< T >, GeneratedSoundStream< int16_t >, and BufferedStream.
|
inlineprotected |
Determines the action logic (ActiveLow or ActiveTouch) for the pin.
|
inline |
|
inlineprotectedinherited |
|
inlineinherited |
Provides the gpio for the indicated function.
|
inlineinherited |
Provides the gpio for the indicated function.
|
inlineinherited |
Provides access to the pin information.
|
inlineprotected |
|
inlineinherited |
checks if a board has been defined
|
inline |
Returns true if the headphone was detected.
|
inline |
Get the gpio number for auxin detection.
|
inline |
Get the gpio number for headphone detection.
|
inline |
Get the number for mode-button.
|
inline |
Get number for play function.
|
inline |
Get the record-button id for adc-button.
|
inline |
Get number for set function.
|
inline |
Get the gpio number for PA enable.
|
inline |
Get number for volume down function.
|
inline |
number for volume up function
|
inline |
Process input keys and pins.
Reads the audio data.
Reimplemented from AudioStream.
Source to generate silence: just sets the buffer to 0.
|
inlineprotectedinherited |
|
inlinevirtualinherited |
Removes a target in order not to be notified about audio changes.
Reimplemented in RTSPClient< TcpClient, UdpSocket >.
Defines the increment value used by actionVolumeDown/actionVolumeUp.
updates the sample rate dynamically
Reimplemented from AudioStream.
|
inlineinherited |
(re)defines the board
|
inlineinherited |
(re)defines the board
Deactivate/Reactivate automatic AudioInfo updates: (default is active)
the same as setPAPower()
|
inlineprotectedinherited |
if the cfg.i2s_function was not defined we determine the "correct" default value
|
inlineprotectedinherited |
We use the board pins if they are available.
sets the volume (range 0.0f - 1.0f)
Reimplemented from VolumeSupport.
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineprotectedinherited |
|
inlineoverridevirtualinherited |
Provides the actual volume (0.0f - 1.0f)
Reimplemented from VolumeSupport.
Writes the audio data to I2S.
Reimplemented from AudioStream.
Reimplemented in MemoryStream, AudioStreamWrapper, BufferedTaskStream, RingBufferStream, BufferedStream, and URLStream.
|
protectedinherited |
|
protected |
|
protected |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |
|
protectedinherited |