Rename Pins to DriverPins

Author: pschatzmann

README.md

@@ -16,7 +16,7 @@ Supported audio codec chips are e.g
 - ES7243
 - etc
 
-While you can use this library stand alone, I recommend to use it together with my [AudioTools](https://github.com/pschatzmann/arduino-audio-tools) project which provides a nice integration with it's I2SCodecStream class.
+While you can use this library stand alone, I recommend to use it together with my [AudioTools](https://github.com/pschatzmann/arduino-audio-tools) project which provides a nice integration with it's [I2SCodecStream](https://pschatzmann.github.io/arduino-audio-tools/classaudio__tools_1_1_i2_s_codec_stream.html) class.
 
 ## AudioTools
 
@@ -75,8 +75,8 @@ You can also easily define your custom boards by defining the __driver__ and you
 
 #include "AudioBoard.h"
 
-Pins my_pins;
-AudioBoard board(my_pins, &AudioDriverES8388);
+DriverPins my_pins;
+AudioBoard board(&AudioDriverES8388, my_pins);
 
 void setup() {
   // add i2c codec pins: scl, sda, port

examples/audiotools-custom-max/audiotools-custom-max.ino

@@ -0,0 +1,42 @@
+/**
+ * @brief We define a custom board with the i2c and i2s pins and output a sine
+ * with the help of the AudioTools I2SCodecStream
+ * @author phil schatzmann
+ */
+
+#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
+#include "AudioLibs/I2SCodecStream.h"
+
+AudioInfo info(44100, 2, 16);
+SineWaveGenerator<int16_t> sineWave(32000);
+GeneratedSoundStream<int16_t> sound(sineWave);
+DriverPins my_pins;
+AudioBoard board(&AudioDriverES8388, my_pins);
+I2SCodecStream out(board);
+StreamCopy copier(out, sound);
+
+void setup() {
+  // Setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+  LOGLEVEL_AUDIODRIVER = AudioDriverInfo;
+
+  // setup pins
+  // - add i2c codec pins: scl, sda, port, (I2C object)
+  my_pins.addI2C(CODEC, 32, 22, 0x20, 100000, Wire);
+  // - add i2s pins: mclk, bclk, ws, data_out, data_in
+  my_pins.addI2S(CODEC, 0, 14, 15, 22);
+
+  
+  // start I2S & codec with i2c and i2s configured above
+  Serial.println("starting I2S...");
+  auto config = out.defaultConfig();
+  config.copyFrom(info);
+  out.begin(config);
+
+  // Setup sine wave
+  sineWave.begin(info, N_B4);
+}
+
+// Arduino loop - copy sound to out
+void loop() { copier.copy(); }

examples/audiotools-custom-min/audiotools-custom-min.ino

@@ -0,0 +1,41 @@
+/**
+ * @brief We define a custom board w/o any pins and output a sine tone
+ * with the help of the AudioTools I2SCodecStream
+ * @author phil schatzmann
+ */
+
+#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
+#include "AudioLibs/I2SCodecStream.h"
+
+AudioInfo info(44100, 2, 16);
+SineWaveGenerator<int16_t> sineWave(32000);
+GeneratedSoundStream<int16_t> sound(sineWave);
+AudioBoard board(&AudioDriverES8388);
+I2SCodecStream out(board);
+StreamCopy copier(out, sound);
+
+void setup() {
+  // Setup logging
+  Serial.begin(115200);
+  AudioLogger::instance().begin(Serial, AudioLogger::Info);
+  LOGLEVEL_AUDIODRIVER = AudioDriverInfo;
+
+  // initialize i2c because board has no i2c definition
+  Wire.begin();
+
+  // start I2S & codec
+  Serial.println("starting I2S...");
+  auto config = out.defaultConfig();
+  config.copyFrom(info);
+  // define your i2s pins if you dont want to use the default pins
+  config.pin_bck = 14;
+  config.pin_ws = 15;
+  config.pin_data = 22;
+  out.begin(config);
+
+  // Setup sine wave
+  sineWave.begin(info, N_B4);
+}
+
+// Arduino loop - copy sound to out
+void loop() { copier.copy(); }

examples/audiotools-sine/audiotools-sine.ino

@@ -1,33 +1,38 @@
+/**
+ * @brief We use a predefined AudioKitEs8388V1 board and output a sine wave via i2s
+ * using the AudioTools I2SCodecStream
+ * @author phil schatzmann
+ */
+
 #include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
 #include "AudioLibs/I2SCodecStream.h"
 
-AudioInfo info(32000, 2, 16);
-SineWaveGenerator<int16_t> sineWave(32000);                // subclass of SoundGenerator with max amplitude of 32000
-GeneratedSoundStream<int16_t> sound(sineWave);             // Stream generated from sine wave
+AudioInfo info(44100, 2, 16);
+SineWaveGenerator<int16_t> sineWave(32000); 
+GeneratedSoundStream<int16_t>sound(sineWave); 
 I2SCodecStream out(AudioKitEs8388V1);
-StreamCopy copier(out, sound);                             // copies sound into i2s
+StreamCopy copier(out, sound); 
 
 // Arduino Setup
-void setup(void) {  
-  // Open Serial 
+void setup(void) {
+  // Setup logging
   Serial.begin(115200);
   AudioLogger::instance().begin(Serial, AudioLogger::Info);
-  // logging for driver
-  LOGLEVEL_AUDIODRIVER = AudioDriverInfo; 
-
+  LOGLEVEL_AUDIODRIVER = AudioDriverInfo;
 
-  // start I2S
+  // start I2S & codec
   Serial.println("starting I2S...");
-  auto config = out.defaultConfig(TX_MODE);
-  config.copyFrom(info); 
+  auto config = out.defaultConfig();
+  config.copyFrom(info);
   out.begin(config);
 
+  // set volume
+  out.setVolume(1.0);
+
   // Setup sine wave
   sineWave.begin(info, N_B4);
   Serial.println("started...");
 }
 
-// Arduino loop - copy sound to out 
-void loop() {
-  copier.copy();
-}
+// Arduino loop - copy sound to out
+void loop() { copier.copy(); }

examples/custom-max/custom-max.ino

@@ -0,0 +1,29 @@
+/**
+ * @brief We just set up the codec and the i2c pins, so that the wire is
+ * automatically initialized with the indicated pins.
+ * After this you can set up and use i2s
+ * @author phil schatzmann
+ */
+
+#include "AudioBoard.h"
+
+AudioBoard board(&AudioDriverES8388);
+
+void setup() {
+  // add i2c codec pins: scl, sda, port
+  my_pins.addI2C(CODEC, 32, 22, 0x20);
+  // example add other pins: PA on gpio 21
+  my_pins.addPin(PA, 21);
+
+  // configure codec
+  CodecConfig cfg;
+  cfg.adc_input = ADC_INPUT_LINE1;
+  cfg.dac_output = DAC_OUTPUT_ALL;
+  cfg.i2s.bits = BIT_LENGTH_16BITS;
+  cfg.i2s.rate = RATE_44K;
+  // cfg.i2s.fmt = I2S_NORMAL;
+  // cfg.i2s.mode = MODE_SLAVE;
+  board.begin(cfg);
+}
+
+void loop() {}

examples/custom-min/custom-min.ino

@@ -0,0 +1,25 @@
+/**
+ * @brief We just set up the codec. Because I2C was not defined we need to
+ * initilize it ourself After this you can set up and use i2s
+ * @author phil schatzmann
+ */
+
+#include "AudioBoard.h"
+
+AudioBoard board(&AudioDriverES8388, my_pins);
+
+void setup() {
+  // start I2C for the communication with the codec
+  Wire.begin();
+  // configure codec
+  CodecConfig cfg;
+  cfg.adc_input = ADC_INPUT_LINE1;
+  cfg.dac_output = DAC_OUTPUT_ALL;
+  cfg.i2s.bits = BIT_LENGTH_16BITS;
+  cfg.i2s.rate = RATE_44K;
+  // cfg.i2s.fmt = I2S_NORMAL;
+  // cfg.i2s.mode = MODE_SLAVE;
+  board.begin(cfg);
+}
+
+void loop() {}

src/AudioBoard.h

@@ -4,15 +4,18 @@
 
 namespace audio_driver {
 
+/// @ingroup audio_driver @brief Pins need to be set up in the sketch
+static DriverPins NoPins;
+
 /**
  * @brief Defitintion for audio board pins and an audio driver
  * @ingroup audio_driver
  */
 class AudioBoard {
 public:
-  AudioBoard(Pins pins, AudioDriver *driver) {
+  AudioBoard(AudioDriver *driver, DriverPins pins=NoPins) {
     this->pins = pins;
-    this->driver =driver;
+    this->driver = driver;
   }
 
   bool begin(){
@@ -30,7 +33,7 @@ class AudioBoard {
   bool setMute(bool enable) { return driver->setMute(enable); }
   bool setVolume(int volume) { return driver->setVolume(volume); }
   int getVolume() { return driver->getVolume(); }
-  Pins& getPins() { return pins; }
+  DriverPins& getPins() { return pins; }
   bool setPAPower(bool enable) { return driver->setPAPower(enable); }
   /// set volume for adc: this is only supported on some defined codecs
   bool setInputVolume(int volume) {return driver->setInputVolume(volume);}
@@ -40,51 +43,51 @@ class AudioBoard {
   }
 
 protected:
-  Pins pins;
+  DriverPins pins;
   CodecConfig codec_cfg;
   AudioDriver* driver = nullptr;
 };
 
 // -- Drivers
 /// @ingroup audio_driver
-AudioDriverES8388Class AudioDriverES8388;
+static AudioDriverES8388Class AudioDriverES8388;
 /// @ingroup audio_driver
-AudioDriverAC101Class AudioDriverAC101;
+static AudioDriverAC101Class AudioDriverAC101;
 /// @ingroup audio_driver
-AudioDriverCS43l22Class AudioDriverCS43l22;
+static AudioDriverCS43l22Class AudioDriverCS43l22;
 /// @ingroup audio_driver
-AudioDriverES8311Class AudioDriverES8311;
+static AudioDriverES8311Class AudioDriverES8311;
 /// @ingroup audio_driver
-AudioDriverES7243Class AudioDriverES7243;
+static AudioDriverES7243Class AudioDriverES7243;
 /// @ingroup audio_driver
-AudioDriverLyratMiniClass AudioDriverLyratMini;
+static AudioDriverLyratMiniClass AudioDriverLyratMini;
 
 // -- Pins 
 /// @ingroup audio_driver
-PinsLyrat43Class PinsLyrat43;
+static PinsLyrat43Class PinsLyrat43;
 /// @ingroup audio_driver
-PinsLyrat42Class PinsLyrat42;
+static PinsLyrat42Class PinsLyrat42;
 /// @ingroup audio_driver
-PinsLyratMiniClass PinsLyratMini;
+static PinsLyratMiniClass PinsLyratMini;
 /// @ingroup audio_driver
-PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1;
+static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1;
 /// @ingroup audio_driver
-PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2;
+static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2;
 /// @ingroup audio_driver
-PinsAudioKitAC101Class PinsAudioKitAC101;
+static PinsAudioKitAC101Class PinsAudioKitAC101;
 
 // -- Boards
 /// @ingroup audio_driver
-AudioBoard AudioKitEs8388V1{PinsAudioKitEs8388v1, &AudioDriverES8388};
+static AudioBoard AudioKitEs8388V1{&AudioDriverES8388, PinsAudioKitEs8388v1};
 /// @ingroup audio_driver
-AudioBoard AudioKitEs8388V2{PinsAudioKitEs8388v2, &AudioDriverES8388};
+static AudioBoard AudioKitEs8388V2{&AudioDriverES8388, PinsAudioKitEs8388v2};
 /// @ingroup audio_driver
-AudioBoard AudioKitAC101{PinsAudioKitAC101, &AudioDriverAC101};
+static AudioBoard AudioKitAC101{&AudioDriverAC101, PinsAudioKitAC101};
 /// @ingroup audio_driver
-AudioBoard LyratV43{PinsLyrat43, &AudioDriverES8388};
+static AudioBoard LyratV43{&AudioDriverES8388, PinsLyrat43};
 /// @ingroup audio_driver
-AudioBoard LyratV42{PinsLyrat42, &AudioDriverES8388};
+static AudioBoard LyratV42{&AudioDriverES8388, PinsLyrat42};
 /// @ingroup audio_driver
-AudioBoard LyratMini{PinsLyratMini, &AudioDriverLyratMini};
+static AudioBoard LyratMini{&AudioDriverLyratMini, PinsLyratMini};
 
 }

src/Driver.h

@@ -61,7 +61,7 @@ class CodecConfig : public codec_config_t {
  */
 class AudioDriver {
 public:
-  virtual bool begin(CodecConfig codecCfg, Pins &pins) {
+  virtual bool begin(CodecConfig codecCfg, DriverPins &pins) {
     codec_cfg = codecCfg;
     p_pins = &pins;
     if (!init(codec_cfg)){
@@ -89,7 +89,7 @@ class AudioDriver {
   virtual bool isVolumeSupported() { return true; }
   virtual bool isInputVolumeSupported() { return false; }
 
-  Pins &pins() { return *p_pins; }
+  DriverPins &pins() { return *p_pins; }
 
   /// Sets the PA Power pin to active or inactive
   bool setPAPower(bool enable) {
@@ -103,7 +103,7 @@ class AudioDriver {
 
 protected:
   CodecConfig codec_cfg;
-  Pins *p_pins = nullptr;
+  DriverPins *p_pins = nullptr;
 
   virtual bool init(codec_config_t codec_cfg) { return false; }
   virtual bool deinit() { return false; }
@@ -249,7 +249,7 @@ class AudioDriverES7243Class : public AudioDriver {
  */
 class AudioDriverLyratMiniClass : public AudioDriver {
 public:
-  bool begin(CodecConfig codecCfg, Pins &pins) {
+  bool begin(CodecConfig codecCfg, DriverPins &pins) {
     int rc = 0;
     if (codecCfg.dac_output != DAC_OUTPUT_NONE)
       rc += !dac.begin(codecCfg, pins);
@@ -318,7 +318,7 @@ class AudioDriverCS43l22Class : public AudioDriver {
 
   void setI2CAddress(uint16_t adr) { deviceAddr = adr; }
 
-  virtual bool begin(CodecConfig codecCfg, Pins &pins) {
+  virtual bool begin(CodecConfig codecCfg, DriverPins &pins) {
     codec_cfg = codecCfg;
     // manage reset pin -> acive high
     setPAPower(true);