Rename sound to audio

pschatzmann · pschatzmann · commit 261772d7f3ca · 2021-04-29T22:50:28.000+02:00
diff --git a/Doxyfile b/Doxyfile
@@ -33,7 +33,7 @@ DOXYFILE_ENCODING      = UTF-8
 # title of most generated pages and in a few other places.
 # The default value is: My Project.
 
-PROJECT_NAME           = "arduino-sound-tools"
+PROJECT_NAME           = "arduino-audio-tools"
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number. This
 # could be handy for archiving the generated documentation or if some version
diff --git a/README.md b/README.md
@@ -8,11 +8,11 @@ Some basic C++ classes that can be used for Audio Processing privided as Arduino
 - Converters
 - Musical Notes (with Frequencies of notes)
 - SineWaveGenerator (to generate some sine tone)
-- NBuffer (Multi buffer for writing and reading of (sound) data)
-- TimerAlarmRepeating (e.g. for sampling sound data using exact times) [ESP32 only]
+- NBuffer (Multi buffer for writing and reading of (audio) data)
+- TimerAlarmRepeating (e.g. for sampling audio data using exact times) [ESP32 only]
 - A Wav Encoder and Decoder
 
-This functionality provides the glue which makes different sound processing components and libraries work together.
+This functionality provides the glue which makes different audio processing components and libraries work together.
 We also provide plenty of examples that demonstrate how to implement the different scenarios.
 
 ## Optional Libraries
@@ -24,7 +24,7 @@ We also provide plenty of examples that demonstrate how to implement the differe
 
 ## Examples
 
-All examples can be found in the [examples folder](https://github.com/pschatzmann/arduino-sound-tools/tree/main/examples)
+All examples can be found in the [examples folder](https://github.com/pschatzmann/arduino-audio-tools/tree/main/examples)
 
 
 ## Installation
@@ -33,13 +33,13 @@ You can download the library as zip and call include Library -> zip library. Or
 
 ```
 cd  ~/Documents/Arduino/libraries
-git clone pschatzmann/arduino-sound-tools.git
+git clone pschatzmann/arduino-audio-tools.git
 
 ```
 
 ## Documentation
 
-Here is the generated [Class documentation](https://pschatzmann.github.io/arduino-sound-tools/html/annotated.html). You might find further information in [one of my blogs](https://www.pschatzmann.ch/home/category/machine-sound/)
+Here is the generated [Class documentation](https://pschatzmann.github.io/arduino-audio-tools/html/annotated.html). You might find further information in [one of my blogs](https://www.pschatzmann.ch/home/category/machine-sound/)
 
 ## Project Status
 
diff --git a/examples/adc-a2dp/README.md b/examples/adc-a2dp/README.md
@@ -2,8 +2,8 @@
 
 We can read an analog signal from a microphone and and send it to a Bluetooth A2DP device. To test the functionality I am using a MCP6022 microphone module.
 
-![MCP6022](https://pschatzmann.github.io/arduino-sound-tools/resources/mcp6022.jpeg)
-![MCP6022](https://pschatzmann.github.io/arduino-sound-tools/resources/mcp6022-1.jpeg)
+![MCP6022](https://pschatzmann.github.io/arduino-audio-tools/resources/mcp6022.jpeg)
+![MCP6022](https://pschatzmann.github.io/arduino-audio-tools/resources/mcp6022-1.jpeg)
 
 The MCP6022 is a anlog microphone which operates at 3.3 V
 We sample the sound signal with the help of the ESP32 I2S ADC input functionality.
diff --git a/examples/adc-a2dp/adc-a2dp.ino b/examples/adc-a2dp/adc-a2dp.ino
@@ -1,8 +1,8 @@
 #include "Arduino.h"
 #include "BluetoothA2DPSource.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-using namespace sound_tools;  
+using namespace audio_tools;  
 
 /**
  * @brief We use a mcp6022 analog microphone as input and send the data to A2DP
diff --git a/examples/adc-serial/README.md b/examples/adc-serial/README.md
@@ -2,8 +2,8 @@
 
 We can read an analog signal from a microphone and and write it out to Serial so that we can check the result in the __Arduino Serial Plotter__. To test the functionality I am using a MCP6022 microphone module.
 
-![MCP6022](https://pschatzmann.github.io/arduino-sound-tools/resources/mcp6022.jpeg)
-![MCP6022](https://pschatzmann.github.io/arduino-sound-tools/resources/mcp6022-1.jpeg)
+![MCP6022](https://pschatzmann.github.io/arduino-audio-tools/resources/mcp6022.jpeg)
+![MCP6022](https://pschatzmann.github.io/arduino-audio-tools/resources/mcp6022-1.jpeg)
 
 The MCP6022 is a anlog microphone which operates at 3.3 V
 We sample the sound signal with the help of the ESP32 I2S ADC input functionality.
@@ -19,7 +19,7 @@ We sample the sound signal with the help of the ESP32 I2S ADC input functionalit
 
 ## Serial Plotter
 
-![Serial](https://pschatzmann.github.io/arduino-sound-tools/resources/serial_plotter.png)
+![Serial](https://pschatzmann.github.io/arduino-audio-tools/resources/serial_plotter.png)
 
 
 
diff --git a/examples/adc-serial/adc-serial.ino b/examples/adc-serial/adc-serial.ino
@@ -1,8 +1,8 @@
 #include "Arduino.h"
 #include "BluetoothA2DPSource.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-using namespace sound_tools;  
+using namespace audio_tools;  
 
 /**
  * @brief We use a mcp6022 analog microphone on GPIO34 and write it to Serial
diff --git a/examples/file_mp3-a2dp/README.md b/examples/file_mp3-a2dp/README.md
@@ -3,4 +3,4 @@
 
 The processing of files with the help of the [ESP8266Audio](https://github.com/earlephilhower/ESP8266Audio) is a little bit more involved. Howver it allows to process different file types from different sources. Please consult the project for further details.
 
-In this Sketch we use the ESP8266Audio library to read the [audio.mp3](https://pschatzmann.github.io/arduino-sound-tools/resources/audio.mp3) file from a SD drive. The output is pushed into a temporary buffer. The A2DP Callback then just consumes this buffered data... 
+In this Sketch we use the ESP8266Audio library to read the [audio.mp3](https://pschatzmann.github.io/arduino-audio-tools/resources/audio.mp3) file from a SD drive. The output is pushed into a temporary buffer. The A2DP Callback then just consumes this buffered data... 
diff --git a/examples/file_mp3-a2dp/file_mp3-a2dp.ino b/examples/file_mp3-a2dp/file_mp3-a2dp.ino
@@ -4,9 +4,9 @@
 #include "AudioGeneratorMP3.h"
 #include "AudioOutputWithCallback.h"
 #include "BluetoothA2DPSource.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-using namespace sound_tools;  
+using namespace audio_tools;  
 
 const int sd_ss_pin = 5;
 const char* fileName = "/audio.mp3";
diff --git a/examples/file_raw-a2dp/README.md b/examples/file_raw-a2dp/README.md
@@ -2,9 +2,9 @@
 
 We are reading a raw audio file from the SD card and send it to a Bluetooth A2DP device. The audio file must be available using 16 bit integers with 2 channels. 
 
-[Audacity](https://www.audacityteam.org/) might help you out here: export with the file name audio.raw as RAW signed 16 bit PCM and copy it to the SD card. In my example I was using the file [audio.raw](https://pschatzmann.github.io/arduino-sound-tools/resources/audio.raw). 
+[Audacity](https://www.audacityteam.org/) might help you out here: export with the file name audio.raw as RAW signed 16 bit PCM and copy it to the SD card. In my example I was using the file [audio.raw](https://pschatzmann.github.io/arduino-audio-tools/resources/audio.raw). 
 
-![sd](https://pschatzmann.github.io/arduino-sound-tools/resources/sd-module.jpeg)
+![sd](https://pschatzmann.github.io/arduino-audio-tools/resources/sd-module.jpeg)
 
 The SD module is connected with the help of the SPI bus
 
diff --git a/examples/file_raw-serial/README.md b/examples/file_raw-serial/README.md
@@ -2,9 +2,9 @@
 
 We are reading a raw audio file from the SD card and send it to a Bluetooth A2DP device. The audio file must be available using 16 bit integers with 2 channels.
 
-[Audacity](https://www.audacityteam.org/) might help you out here: export with the file name audio.raw as RAW signed 16 bit PCM and copy it to the SD card. In my example I was using the file [audio.raw](https://pschatzmann.github.io/arduino-sound-tools/resources/audio.raw). 
+[Audacity](https://www.audacityteam.org/) might help you out here: export with the file name audio.raw as RAW signed 16 bit PCM and copy it to the SD card. In my example I was using the file [audio.raw](https://pschatzmann.github.io/arduino-audio-tools/resources/audio.raw). 
 
-![sd](https://pschatzmann.github.io/arduino-sound-tools/resources/sd-module.jpeg)
+![sd](https://pschatzmann.github.io/arduino-audio-tools/resources/sd-module.jpeg)
 
 The SD module is connected with the help of the SPI bus
 
diff --git a/examples/i2s-a2dp/README.md b/examples/i2s-a2dp/README.md
@@ -4,7 +4,7 @@
 ## General Description:
 We implement a A2DP source: We stream the sound input which we read in from the I2S interface to a A2DP sink. We can use any device which provides the sound data via I2S. In order to test the functionality we use the INMP441 microphone.
 
-![INMP441](https://pschatzmann.github.io/arduino-sound-tools/resources/inmp441.jpeg)
+![INMP441](https://pschatzmann.github.io/arduino-audio-tools/resources/inmp441.jpeg)
 
 The INMP441 is a high-performance, low power, digital-output, omnidirectional MEMS microphone with a bottom port. The complete INMP441 solution consists of a MEMS sensor, signal conditioning, an analog-to-digital converter, anti-aliasing filters, power management, and an industry-standard 24-bit I²S interface. The I²S interface allows the INMP441 to connect directly to digital processors, such as DSPs and microcontrollers, without the need for an audio codec in the system.
 
diff --git a/examples/i2s-a2dp/i2s-a2dp.ino b/examples/i2s-a2dp/i2s-a2dp.ino
@@ -1,7 +1,7 @@
 #include "Arduino.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-using namespace sound_tools;  
+using namespace audio_tools;  
 
 /**
  * @brief We use a ADS1015 I2S microphone as input and send the data to A2DP
diff --git a/examples/i2s-serial/README.md b/examples/i2s-serial/README.md
@@ -4,7 +4,7 @@
 ## General Description:
 We implement a A2DP source: We stream the sound input which we read in from the I2S interface to a A2DP sink. We can use any device which provides the sound data via I2S. In order to test the functionality we use the INMP441 microphone.
 
-![INMP441](https://pschatzmann.github.io/arduino-sound-tools/resources/inmp441.jpeg)
+![INMP441](https://pschatzmann.github.io/arduino-audio-tools/resources/inmp441.jpeg)
 
 The INMP441 is a high-performance, low power, digital-output, omnidirectional MEMS microphone with a bottom port. The complete INMP441 solution consists of a MEMS sensor, signal conditioning, an analog-to-digital converter, anti-aliasing filters, power management, and an industry-standard 24-bit I²S interface. The I²S interface allows the INMP441 to connect directly to digital processors, such as DSPs and microcontrollers, without the need for an audio codec in the system.
 
diff --git a/examples/i2s-serial/i2s-serial.ino b/examples/i2s-serial/i2s-serial.ino
@@ -1,8 +1,8 @@
 #include "Arduino.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 #include "BluetoothA2DPSource.h"
 
-using namespace sound_tools;  
+using namespace audio_tools;  
 
 /**
  * @brief We use I2S as input and send the data to A2DP
diff --git a/library.properties b/library.properties
@@ -1,9 +1,9 @@
-name=sound-tools
+name=audio-tools
 version=0.0.1
 author=Phil Schatzmann
 maintainer=Phil Schatzmann <phil.schatzmann@gmail.com>
-sentence=Some useful sound processing classes
+sentence=Some useful audio processing classes
 paragraph=Timer, RingBuffer, I2S
 category=Device Control
-url=https://github.com/pschatzmann/arduino-sound-tools
+url=https://github.com/pschatzmann/arduino-audio-tools
 architectures=esp32
diff --git a/sandbox/ads1015-i2s/README.md b/sandbox/ads1015-i2s/README.md
@@ -1,8 +1,8 @@
 # ADS1015
 
-![ADS1015](https://pschatzmann.github.io/arduino-sound-tools/doc/resources/ads1015.jpeg)
+![ADS1015](https://pschatzmann.github.io/arduino-audio-tools/doc/resources/ads1015.jpeg)
 
-The ADS1015 is a 12 bit ADC which is connected via I2C.
+The ADS1015 is a 12 bit ADC which is connected via I2C. I am using it as a cheap option to sample the sound of an electric guitar.
 
 ### Pins:
  
diff --git a/sandbox/ads1015-i2s/ads1015-i2s.ino b/sandbox/ads1015-i2s/ads1015-i2s.ino
@@ -5,12 +5,12 @@
 
 #include "Wire.h"
 #include "Adafruit_ADS1015.h"
-#include "BluetoothA2DPSource.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
 const int buffer_size = 512;  
 const int buffer_count = 10;
-const int sampling_rate = 44100;
+const int sampling_rate = 3300;  // max supported Sample Rate	
+int16_t array[100][2];
 
 Adafruit_ADS1015 ads1015(0x48);   
 TimerAlarmRepeating sound_timer;
@@ -38,17 +38,11 @@ void setup(void) {
   sound_timer.start(write_sample, waitUs, TimerAlarmRepeating::US);
 }
 
-void writeI2S(){
-  static sound_t array[50][2];
+// Arduino loop - repeated processing
+void loop() {
   // copy sound data from samples to I2S
   size_t len = buffer.readFrames(array);
   if (len>0){
     i2s.write(array, len);
   }  
-  
-}
-
-// Arduino loop - repeated processing
-void loop() {
-  writeI2S();
 }
diff --git a/sandbox/ads1015-serial/README.md b/sandbox/ads1015-serial/README.md
@@ -1,6 +1,6 @@
 # ADS1015
 
-![ADS1015](https://pschatzmann.github.io/arduino-sound-tools/doc/resources/ads1015.jpeg)
+![ADS1015](https://pschatzmann.github.io/arduino-audio-tools/doc/resources/ads1015.jpeg)
 
 The ADS1015 is a 12 bit ADC which is connected via I2C.
 
diff --git a/sandbox/ads1015-serial/ads1015-serial.ino b/sandbox/ads1015-serial/ads1015-serial.ino
@@ -5,9 +5,9 @@
 
 #include "Wire.h"
 #include "Adafruit_ADS1015.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-const int sample_rate = 500;
+const int sample_rate = 3300;
 const int buffer_size = 50;
 
 Adafruit_ADS1015 ads1015(0x48);   
diff --git a/sandbox/file_aac-a2dp/README.md b/sandbox/file_aac-a2dp/README.md
@@ -1,6 +1,6 @@
 # SD Module 
 
-![sd](https://pschatzmann.github.io/arduino-sound-tools/doc/resources/sd-module.jpeg)
+![sd](https://pschatzmann.github.io/arduino-audio-tools/doc/resources/sd-module.jpeg)
 
 We are reading a raw audio file from the SD card and send it to a Bluetooth A2DP device. The audio file must be available using 16 bit integers with 2 channels.
 
diff --git a/sandbox/file_aac-a2dp/file_raw-a2dp.ino b/sandbox/file_aac-a2dp/file_raw-a2dp.ino
@@ -1,18 +1,15 @@
 
-#include "SoundTools.h"
-#include "BluetoothA2DPSource.h"
+#include "AudioTools.h"
 #include <SPI.h>
 #include <SD.h>
 
-BluetoothA2DPSource a2dp_source;
+I2S i2s; // I2S output destination
 File sound_file;
+AACDecoder decoder(i2s);
 const int sd_ss_pin = 4;
+const char* file_name = "audio.aac"
+uint8_t buffer[512];
 
-// callback used by A2DP to provide the sound data
-int32_t get_sound_data(int16_t data[][2], int32_t len) {
-  // the data in the file must be in int16 with 2 channels 
-  return sound_file.read((uint_8t*)data, len * sizeof(int16_t) * 2 );
-}
 
 // Arduino Setup
 void setup(void) {
@@ -22,11 +19,16 @@ void setup(void) {
   SD.begin(sd_ss_pin);
   sound_file = SD.open(file_name, FILE_READ);
 
-  // start the bluetooth
-  Serial.println("starting A2DP...");
-  a2dp_source.start("RadioPlayer", get_sound_data);  
+  i2s.begin();
+  decoder.begin();
 }
 
+
 // Arduino loop - repeated processing 
 void loop() {
+    if (sound_file.available()>0){
+        int len = sound_file.readBytes(buffer, 512);
+        decoder.write(buffer, len);
+    }
+
 }
diff --git a/sandbox/i2s-sd/i2s-sd.ino b/sandbox/i2s-sd/i2s-sd.ino
@@ -1,7 +1,7 @@
 #include "Arduino.h"
 #include <SPI.h>
 #include <SD.h>
-#include "SoundTools.h"
+#include "AudioTools.h"
 
 // configuration
 const int minutes = 5;
diff --git a/sandbox/test-sampling-rate/test-sampling-rate.ino b/sandbox/test-sampling-rate/test-sampling-rate.ino
@@ -2,7 +2,7 @@
  *  Test sampling rate
  */
 
-#include "SoundTools.h"
+#include "AudioTools.h"
 
 unsigned long count;
 unsigned long start;
diff --git a/sandbox/test-sin/test-sin.ino b/sandbox/test-sin/test-sin.ino
@@ -2,7 +2,7 @@
  *  Generate a sine wave to test the TimerAlarmRepeating and UpSampler
  */
 
-#include "SoundTools.h"
+#include "AudioTools.h"
 
 const int sample_rate = 44100;  
 const int buffer_size = 512;  
diff --git a/sandbox/wav_decode/wav_decode.ino b/sandbox/wav_decode/wav_decode.ino
@@ -1,5 +1,5 @@
 #include "AudioWAV.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
 I2S i2s; // I2S output destination
 WAVDecoder decoder(i2s);  
diff --git a/src/AudioOutputWithCallback.h b/src/AudioOutputWithCallback.h
@@ -3,9 +3,9 @@
 
 #include "AudioOutput.h"
 #include "SoundData.h"
-#include "SoundTools.h"
+#include "AudioTools.h"
 
-namespace sound_tools {
+namespace audio_tools {
 
 /**
  * @brief ESP8266Audio AudioOutput class which stores the data in a temporary buffer. 
diff --git a/src/AudioTools.h b/src/AudioTools.h
@@ -0,0 +1,18 @@
+#pragma once
+
+/**
+ * @brief Includes all classes
+ * @file AudioTools.h
+ * @author Phil Schatzmann
+ * @copyright GPLv3
+ *
+ */
+#include "AudioTools/SoundTypes.h"
+#include "AudioTools/Buffers.h"
+#include "AudioTools/Converter.h"
+#include "AudioTools/MusicalNotes.h"
+#include "AudioTools/SoundGenerator.h"
+#include "AudioTools/I2S.h"
+#include "AudioTools/ADC.h"
+#include "AudioTools/AudioLogger.h"
+#include "AudioTools/Buffers.h"
diff --git a/src/AudioTools/ADC.h b/src/AudioTools/ADC.h
@@ -11,7 +11,7 @@
 #define DEFAUT_ADC_PIN 34
 #endif
 
-namespace sound_tools {
+namespace audio_tools {
 
 typedef int16_t arrayOf2int16_t[2];
 
diff --git a/src/AudioTools/AudioLogger.h b/src/AudioTools/AudioLogger.h
diff --git a/src/AudioTools/Buffers.h b/src/AudioTools/Buffers.h
diff --git a/src/AudioTools/Converter.h b/src/AudioTools/Converter.h
diff --git a/src/AudioTools/I2S.h b/src/AudioTools/I2S.h
diff --git a/src/AudioTools/MusicalNotes.h b/src/AudioTools/MusicalNotes.h
diff --git a/src/AudioTools/SoundGenerator.h b/src/AudioTools/SoundGenerator.h
diff --git a/src/AudioTools/SoundTypes.h b/src/AudioTools/SoundTypes.h
diff --git a/src/AudioTools/Streams.h b/src/AudioTools/Streams.h
diff --git a/src/AudioTools/TimerAlarmRepeating.h b/src/AudioTools/TimerAlarmRepeating.h
diff --git a/src/SoundTools.h b/src/SoundTools.h

Original file line number	Diff line number	Diff line change
`@@ -3,4 +3,4 @@`
`3`	`3`
`4`	`4`	`The processing of files with the help of the [ESP8266Audio](https://github.com/earlephilhower/ESP8266Audio) is a little bit more involved. Howver it allows to process different file types from different sources. Please consult the project for further details.`
`5`	`5`
`6`		`-In this Sketch we use the ESP8266Audio library to read the [audio.mp3](https://pschatzmann.github.io/arduino-sound-tools/resources/audio.mp3) file from a SD drive. The output is pushed into a temporary buffer. The A2DP Callback then just consumes this buffered data...`
	`6`	`+In this Sketch we use the ESP8266Audio library to read the [audio.mp3](https://pschatzmann.github.io/arduino-audio-tools/resources/audio.mp3) file from a SD drive. The output is pushed into a temporary buffer. The A2DP Callback then just consumes this buffered data...`