From 6e6e3c34190e209a5eb248c39085a556ea11fdf2 Mon Sep 17 00:00:00 2001 From: pschatzmann Date: Mon, 23 Oct 2023 04:38:17 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20doxygen=20from=20@=20pschatzma?= =?UTF-8?q?nn/arduino-audio-tools@99b034c636b5b906d0d21e42a755c1977d6aa7ad?= =?UTF-8?q?=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _audio_kit_8h_source.html | 2 +- _audio_s_p_d_i_f_8h_source.html | 2 +- _i2_s_config_e_s_p32_8h_source.html | 10 +++++----- _i2_s_config_e_s_p32_v1_8h_source.html | 2 +- _i2_s_config_std_8h_source.html | 2 +- _i2_s_e_s_p32_8h_source.html | 2 +- _i2_s_e_s_p32_v1_8h_source.html | 2 +- _i2_s_e_s_p8266_8h_source.html | 2 +- _i2_s_nano_sense_b_l_e_8h_source.html | 2 +- _i2_s_s_a_m_d_8h_source.html | 2 +- _i2_s_s_t_m32_8h_source.html | 2 +- _i2_s_stream_8h_source.html | 2 +- _w_m8960_stream_8h_source.html | 2 +- annotated.html | 4 ++-- classaudio__tools_1_1_audio_kit_stream_config.html | 2 +- classaudio__tools_1_1_i2_s_config_e_s_p32.html | 4 ++-- classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html | 4 ++-- classaudio__tools_1_1_i2_s_config_std.html | 4 ++-- classaudio__tools_1_1_w_m8960_config.html | 2 +- group__platform.html | 6 +++--- hierarchy.html | 4 ++-- namespaceaudio__tools.html | 6 +++--- namespaces.html | 4 ++-- structaudio__tools_1_1_audio_info.html | 6 +++--- 24 files changed, 40 insertions(+), 40 deletions(-) diff --git a/_audio_kit_8h_source.html b/_audio_kit_8h_source.html index c37a56babc..9a74ed7e56 100644 --- a/_audio_kit_8h_source.html +++ b/_audio_kit_8h_source.html @@ -578,7 +578,7 @@
size_t readBytes(uint8_t *data, size_t length) override
Reads the audio data.
Definition: AudioKit.h:253
int8_t pinAuxin()
Get the gpio number for auxin detection.
Definition: AudioKit.h:455
Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...
Definition: AudioStreams.h:47
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32.h:69
We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...
Definition: I2SStream.h:33
virtual size_t readBytes(uint8_t *data, size_t length) override
Reads the audio data.
Definition: I2SStream.h:99
diff --git a/_audio_s_p_d_i_f_8h_source.html b/_audio_s_p_d_i_f_8h_source.html index 43c1aad076..adbbb92597 100644 --- a/_audio_s_p_d_i_f_8h_source.html +++ b/_audio_s_p_d_i_f_8h_source.html @@ -298,7 +298,7 @@
262 
263 } // namespace audio_tools
Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...
Definition: AudioStreams.h:47
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
We support the Stream interface for the I2S access. In addition we allow a separate mute pin which mi...
Definition: I2SStream.h:33
virtual size_t write(const uint8_t *buffer, size_t size)
Writes the audio data to I2S.
Definition: I2SStream.h:93
void end()
Stops the I2S interface.
Definition: I2SStream.h:68
diff --git a/_i2_s_config_e_s_p32_8h_source.html b/_i2_s_config_e_s_p32_8h_source.html index 65a3fa6c86..f3abac27ec 100644 --- a/_i2_s_config_e_s_p32_8h_source.html +++ b/_i2_s_config_e_s_p32_8h_source.html @@ -159,13 +159,13 @@
97  if (signal_type==Digital){
98  LOGI("i2s_format: %s", i2s_formats[i2s_format]);
99  }
-
100  //LOGI("auto_clear: %s",auto_clear? "true" : "false");
+
100  LOGI("auto_clear: %s",auto_clear? "true" : "false");
101  if (use_apll) {
102  LOGI("use_apll: %s", use_apll ? "true" : "false");
103  }
-
104  //if (fixed_mclk){
-
105  // LOGI("fixed_mclk: %d", (int) fixed_mclk);
-
106  //}
+
104  if (fixed_mclk){
+
105  LOGI("fixed_mclk: %d", (int) fixed_mclk);
+
106  }
107  LOGI("buffer_count:%d",buffer_count);
108  LOGI("buffer_size:%d",buffer_size);
109 
@@ -188,7 +188,7 @@
126 
127 }
128 
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
I2SConfigESP32(const I2SConfigESP32 &cfg)=default
Default Copy Constructor.
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32.h:69
I2SConfigESP32(RxTxMode mode)
Constructor.
Definition: I2SConfigESP32.h:46
diff --git a/_i2_s_config_e_s_p32_v1_8h_source.html b/_i2_s_config_e_s_p32_v1_8h_source.html index 788830822b..9989f296d2 100644 --- a/_i2_s_config_e_s_p32_v1_8h_source.html +++ b/_i2_s_config_e_s_p32_v1_8h_source.html @@ -173,7 +173,7 @@
111 
112 }
113 
-
configuration for ESP32 i2s for IDF > 5.0
Definition: I2SConfigESP32V1.h:30
+
Configuration for ESP32 i2s for IDF > 5.0.
Definition: I2SConfigESP32V1.h:30
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32V1.h:63
I2SConfigESP32V1(const I2SConfigESP32V1 &cfg)=default
Default Copy Constructor.
I2SConfigESP32V1(RxTxMode mode)
Constructor.
Definition: I2SConfigESP32V1.h:43
diff --git a/_i2_s_config_std_8h_source.html b/_i2_s_config_std_8h_source.html index 8ee56731c4..4ed3936490 100644 --- a/_i2_s_config_std_8h_source.html +++ b/_i2_s_config_std_8h_source.html @@ -156,7 +156,7 @@
94 
95 }
96 
-
configuration for all common i2s settings
Definition: I2SConfigStd.h:17
+
Configuration for i2s.
Definition: I2SConfigStd.h:17
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigStd.h:50
I2SConfigStd(const I2SConfigStd &cfg)=default
Default Copy Constructor.
I2SConfigStd(RxTxMode mode)
Constructor.
Definition: I2SConfigStd.h:30
diff --git a/_i2_s_e_s_p32_8h_source.html b/_i2_s_e_s_p32_8h_source.html index 10c9013840..f2b8aa6878 100644 --- a/_i2_s_e_s_p32_8h_source.html +++ b/_i2_s_e_s_p32_8h_source.html @@ -426,7 +426,7 @@
372 
373 #endif
AudioKit Stream which uses the https://github.com/pschatzmann/arduino-audiokit library.
Definition: AudioKit.h:189
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32.h:69
Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels.
Definition: I2SESP32.h:22
static size_t writeExpandChannel(i2s_port_t i2s_num, const int bits_per_sample, const void *src, size_t size_bytes)
writes the data by making sure that we send 2 channels
Definition: I2SESP32.h:227
diff --git a/_i2_s_e_s_p32_v1_8h_source.html b/_i2_s_e_s_p32_v1_8h_source.html index 0e36b2ba9a..73f7b05ba6 100644 --- a/_i2_s_e_s_p32_v1_8h_source.html +++ b/_i2_s_e_s_p32_v1_8h_source.html @@ -435,7 +435,7 @@
382 } // namespace audio_tools
383 
384 #endif
-
configuration for ESP32 i2s for IDF > 5.0
Definition: I2SConfigESP32V1.h:30
+
Configuration for ESP32 i2s for IDF > 5.0.
Definition: I2SConfigESP32V1.h:30
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32V1.h:63
Basic I2S API for the ESP32 (using the new API). https://docs.espressif.com/projects/esp-idf/en/v5....
Definition: I2SESP32V1.h:21
I2SConfigESP32V1 defaultConfig(RxTxMode mode)
Provides the default configuration.
Definition: I2SESP32V1.h:25
diff --git a/_i2_s_e_s_p8266_8h_source.html b/_i2_s_e_s_p8266_8h_source.html index 9c0f77206b..a8999540c9 100644 --- a/_i2_s_e_s_p8266_8h_source.html +++ b/_i2_s_e_s_p8266_8h_source.html @@ -239,7 +239,7 @@
185 }
186 
187 #endif
-
configuration for all common i2s settings
Definition: I2SConfigStd.h:17
+
Configuration for i2s.
Definition: I2SConfigStd.h:17
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigStd.h:50
Basic I2S API - for the ESP8266 Only 16 bits are supported !
Definition: I2SESP8266.h:18
I2SConfigStd config()
provides the actual configuration
Definition: I2SESP8266.h:61
diff --git a/_i2_s_nano_sense_b_l_e_8h_source.html b/_i2_s_nano_sense_b_l_e_8h_source.html index 1c8574e0ac..1b72aa61b5 100644 --- a/_i2_s_nano_sense_b_l_e_8h_source.html +++ b/_i2_s_nano_sense_b_l_e_8h_source.html @@ -497,7 +497,7 @@
virtual int writeArrayOverwrite(const T data[], int len)
Fills the buffer data and overwrites the oldest data if the buffer is full.
Definition: Buffers.h:78
virtual int availableForWrite()=0
provides the number of entries that are available to write
virtual int available()=0
provides the number of entries that are available to read
-
configuration for all common i2s settings
Definition: I2SConfigStd.h:17
+
Configuration for i2s.
Definition: I2SConfigStd.h:17
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigStd.h:50
Basic I2S API - for the Arduino Nano BLE Sense See https://content.arduino.cc/assets/Nano_BLE_MCU-nRF...
Definition: I2SNanoSenseBLE.h:132
bool setupBuffers()
dynamic buffer management
Definition: I2SNanoSenseBLE.h:413
diff --git a/_i2_s_s_a_m_d_8h_source.html b/_i2_s_s_a_m_d_8h_source.html index 0cdfacd48d..403bef3e8d 100644 --- a/_i2_s_s_a_m_d_8h_source.html +++ b/_i2_s_s_a_m_d_8h_source.html @@ -135,7 +135,7 @@
75 }
76 
77 #endif
-
configuration for all common i2s settings
Definition: I2SConfigStd.h:17
+
Configuration for i2s.
Definition: I2SConfigStd.h:17
Basic I2S API - for the SAMD.
Definition: I2SSAMD.h:16
I2SConfigStd config()
provides the actual configuration
Definition: I2SSAMD.h:48
I2SConfigStd defaultConfig(RxTxMode mode)
Provides the default configuration.
Definition: I2SSAMD.h:22
diff --git a/_i2_s_s_t_m32_8h_source.html b/_i2_s_s_t_m32_8h_source.html index 2121535864..7ce434f9dc 100644 --- a/_i2_s_s_t_m32_8h_source.html +++ b/_i2_s_s_t_m32_8h_source.html @@ -312,7 +312,7 @@
260 #endif
virtual int readArray(T data[], int len)
reads multiple values
Definition: Buffers.h:40
virtual int writeArray(const T data[], int len)
Fills the buffer data.
Definition: Buffers.h:60
-
configuration for all common i2s settings
Definition: I2SConfigStd.h:17
+
Configuration for i2s.
Definition: I2SConfigStd.h:17
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigStd.h:50
Basic I2S API - for the STM32 Depends on https://github.com/pschatzmann/stm32f411-i2s We just add a w...
Definition: I2SSTM32.h:21
I2SConfigStd config()
provides the actual configuration
Definition: I2SSTM32.h:95
diff --git a/_i2_s_stream_8h_source.html b/_i2_s_stream_8h_source.html index 52c7bbda96..758f99ceec 100644 --- a/_i2_s_stream_8h_source.html +++ b/_i2_s_stream_8h_source.html @@ -188,7 +188,7 @@
136 
137 #endif
Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...
Definition: AudioStreams.h:47
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels.
Definition: I2SESP32.h:22
int available()
we assume the data is already available in the buffer
Definition: I2SESP32.h:62
int availableForWrite()
We limit the write size to the buffer size.
Definition: I2SESP32.h:67
diff --git a/_w_m8960_stream_8h_source.html b/_w_m8960_stream_8h_source.html index 2f9d8c2052..5c49a1fdb2 100644 --- a/_w_m8960_stream_8h_source.html +++ b/_w_m8960_stream_8h_source.html @@ -311,7 +311,7 @@
265 
266 }
Base class for all Audio Streams. It support the boolean operator to test if the object is ready with...
Definition: AudioStreams.h:47
-
configuration for USE_ALT_PIN_SUPPORT i2s
Definition: I2SConfigESP32.h:33
+
Configuration for ESP32 legacy i2s.
Definition: I2SConfigESP32.h:33
RxTxMode rx_tx_mode
public settings
Definition: I2SConfigESP32.h:69
virtual size_t readBytes(uint8_t *data, size_t length) override
Reads the audio data.
Definition: I2SStream.h:99
virtual size_t write(const uint8_t *buffer, size_t size)
Writes the audio data to I2S.
Definition: I2SStream.h:93
diff --git a/annotated.html b/annotated.html index 85160070ac..7c5275f978 100644 --- a/annotated.html +++ b/annotated.html @@ -316,9 +316,9 @@  CHttpReplyHeaderReading and Writing of Http Replys  CHttpRequestSimple API to process get, put, post, del http requests I tried to use Arduino HttpClient, but I did not manage to extract the mime type from streaming get requests  CHttpRequestHeaderReading and writing of Http Requests - CI2SConfigESP32Configuration for USE_ALT_PIN_SUPPORT i2s + CI2SConfigESP32Configuration for ESP32 legacy i2s  CI2SConfigESP32V1Configuration for ESP32 i2s for IDF > 5.0 - CI2SConfigStdConfiguration for all common i2s settings + CI2SConfigStdConfiguration for i2s  CI2SDriverESP32Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels  CI2SDriverESP32V1Basic I2S API for the ESP32 (using the new API). https://docs.espressif.com/projects/esp-idf/en/v5.0.1/esp32/api-reference/peripherals/i2s.html#i2s-communication-mode  CDriverCommon diff --git a/classaudio__tools_1_1_audio_kit_stream_config.html b/classaudio__tools_1_1_audio_kit_stream_config.html index 44ca1c57e1..fbf93c465a 100644 --- a/classaudio__tools_1_1_audio_kit_stream_config.html +++ b/classaudio__tools_1_1_audio_kit_stream_config.html @@ -87,7 +87,7 @@
-I2SConfigESP32 +I2SConfigESP32 AudioInfo
diff --git a/classaudio__tools_1_1_i2_s_config_e_s_p32.html b/classaudio__tools_1_1_i2_s_config_e_s_p32.html index 6894d369c4..cbb6665b39 100644 --- a/classaudio__tools_1_1_i2_s_config_e_s_p32.html +++ b/classaudio__tools_1_1_i2_s_config_e_s_p32.html @@ -74,7 +74,7 @@
-

configuration for USE_ALT_PIN_SUPPORT i2s +

Configuration for ESP32 legacy i2s. More...

#include <I2SConfigESP32.h>

@@ -185,7 +185,7 @@  

Detailed Description

-

configuration for USE_ALT_PIN_SUPPORT i2s

+

Configuration for ESP32 legacy i2s.

Author
Phil Schatzmann

The documentation for this class was generated from the following file:
    diff --git a/classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html b/classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html index 186db90cd2..aed3243d1a 100644 --- a/classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html +++ b/classaudio__tools_1_1_i2_s_config_e_s_p32_v1.html @@ -74,7 +74,7 @@
-

configuration for ESP32 i2s for IDF > 5.0 +

Configuration for ESP32 i2s for IDF > 5.0. More...

#include <I2SConfigESP32V1.h>

@@ -177,7 +177,7 @@  

Detailed Description

-

configuration for ESP32 i2s for IDF > 5.0

+

Configuration for ESP32 i2s for IDF > 5.0.

Author
Phil Schatzmann

The documentation for this class was generated from the following file:
    diff --git a/classaudio__tools_1_1_i2_s_config_std.html b/classaudio__tools_1_1_i2_s_config_std.html index a1cb7e7f3d..e64e133e69 100644 --- a/classaudio__tools_1_1_i2_s_config_std.html +++ b/classaudio__tools_1_1_i2_s_config_std.html @@ -74,7 +74,7 @@
-

configuration for all common i2s settings +

Configuration for i2s. More...

#include <I2SConfigStd.h>

@@ -168,7 +168,7 @@  

Detailed Description

-

configuration for all common i2s settings

+

Configuration for i2s.

Author
Phil Schatzmann

The documentation for this class was generated from the following file:
    diff --git a/classaudio__tools_1_1_w_m8960_config.html b/classaudio__tools_1_1_w_m8960_config.html index 0ca7198531..2ccaf5ff43 100644 --- a/classaudio__tools_1_1_w_m8960_config.html +++ b/classaudio__tools_1_1_w_m8960_config.html @@ -84,7 +84,7 @@
    -I2SConfigESP32 +I2SConfigESP32 AudioInfo
diff --git a/group__platform.html b/group__platform.html index 54e6754efb..79d65b6dda 100644 --- a/group__platform.html +++ b/group__platform.html @@ -95,13 +95,13 @@  Please use AnalogAudioStream: A ADC and DAC API for the Arduino Giga. More...
  class  I2SConfigESP32 - configuration for USE_ALT_PIN_SUPPORT i2s More...
+ Configuration for ESP32 legacy i2s. More...
  class  I2SConfigESP32V1 - configuration for ESP32 i2s for IDF > 5.0 More...
+ Configuration for ESP32 i2s for IDF > 5.0. More...
  class  I2SConfigStd - configuration for all common i2s settings More...
+ Configuration for i2s. More...
  class  I2SDriverESP32  Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels. More...
diff --git a/hierarchy.html b/hierarchy.html index eaa4cea1df..348d35bbfb 100644 --- a/hierarchy.html +++ b/hierarchy.html @@ -131,11 +131,11 @@  CAudioMP34DT05ConfigConfig for MP34DT05 Microphone. Supported sample rates 16000, 41667, Supported bits_per_sample only 16  CAudioServerExConfigConfig information for AudioServerEx  CConfigEquilizer3BandsConfiguration for 3 Band Equilizer: Set channels,bits_per_sample,sample_rate. Set and update gain_low, gain_medium and gain_high to value between 0 and 1.0 - CI2SConfigESP32Configuration for USE_ALT_PIN_SUPPORT i2s + CI2SConfigESP32Configuration for ESP32 legacy i2s  CAudioKitStreamConfigConfiguration for AudioKitStream: we use as subclass of I2SConfig  CWM8960ConfigConfiguration for WM8960  CI2SConfigESP32V1Configuration for ESP32 i2s for IDF > 5.0 - CI2SConfigStdConfiguration for all common i2s settings + CI2SConfigStdConfiguration for i2s  CMiniAudioConfigConfiguration for MiniAudio  CMozziConfigMozzi Configuration for input or output stream  COpusSettingsSetting for Opus Decoder diff --git a/namespaceaudio__tools.html b/namespaceaudio__tools.html index 8fea692a2f..4320266c1b 100644 --- a/namespaceaudio__tools.html +++ b/namespaceaudio__tools.html @@ -789,13 +789,13 @@  Reading and writing of Http Requests. More...
  class  I2SConfigESP32 - configuration for USE_ALT_PIN_SUPPORT i2s More...
+ Configuration for ESP32 legacy i2s. More...
  class  I2SConfigESP32V1 - configuration for ESP32 i2s for IDF > 5.0 More...
+ Configuration for ESP32 i2s for IDF > 5.0. More...
  class  I2SConfigStd - configuration for all common i2s settings More...
+ Configuration for i2s. More...
  class  I2SDriverESP32  Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels. More...
diff --git a/namespaces.html b/namespaces.html index cf597d0817..f20d208db2 100644 --- a/namespaces.html +++ b/namespaces.html @@ -316,9 +316,9 @@  CHttpReplyHeaderReading and Writing of Http Replys  CHttpRequestSimple API to process get, put, post, del http requests I tried to use Arduino HttpClient, but I did not manage to extract the mime type from streaming get requests  CHttpRequestHeaderReading and writing of Http Requests - CI2SConfigESP32Configuration for USE_ALT_PIN_SUPPORT i2s + CI2SConfigESP32Configuration for ESP32 legacy i2s  CI2SConfigESP32V1Configuration for ESP32 i2s for IDF > 5.0 - CI2SConfigStdConfiguration for all common i2s settings + CI2SConfigStdConfiguration for i2s  CI2SDriverESP32Basic I2S API - for the ESP32. If we receive 1 channel, we expand the result to 2 channels  CI2SDriverESP32V1Basic I2S API for the ESP32 (using the new API). https://docs.espressif.com/projects/esp-idf/en/v5.0.1/esp32/api-reference/peripherals/i2s.html#i2s-communication-mode  CDriverCommon diff --git a/structaudio__tools_1_1_audio_info.html b/structaudio__tools_1_1_audio_info.html index d8a5c6560e..164fd38b8e 100644 --- a/structaudio__tools_1_1_audio_info.html +++ b/structaudio__tools_1_1_audio_info.html @@ -91,9 +91,9 @@ AudioMP34DT05Config AudioServerExConfig ConfigEquilizer3Bands -I2SConfigESP32 -I2SConfigESP32V1 -I2SConfigStd +I2SConfigESP32 +I2SConfigESP32V1 +I2SConfigStd MiniAudioConfig MozziConfig OpusSettings