diff --git a/.gitignore b/.gitignore index 94d345d..de094a9 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,6 @@ .vscode/ build/ miniaudio.h -arduino-snapclient.code-workspace \ No newline at end of file +arduino-snapclient.code-workspace +_deps/ +CMakeFiles/ \ No newline at end of file diff --git a/CMakeCache.txt b/CMakeCache.txt new file mode 100644 index 0000000..d582c19 --- /dev/null +++ b/CMakeCache.txt @@ -0,0 +1,412 @@ +# This is the CMakeCache file. +# For build in directory: /home/pschatzmann/Development/Arduino/libraries/arduino-snapclient +# It was generated by CMake: /home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/bin/cmake +# You can edit this file to change values found and used by cmake. +# If you do not want to change any of the values, simply exit the editor. +# If you do want to change a value, simply edit, save, and exit the editor. +# The syntax for the file is as follows: +# KEY:TYPE=VALUE +# KEY is the name of a variable in the cache. +# TYPE is a hint to GUIs for the type of VALUE, DO NOT EDIT TYPE!. +# VALUE is the current value for the KEY. + +######################## +# EXTERNAL cache entries +######################## + +//Do not use Portaudio +ADD_PORTAUDIO:BOOL=OFF + +//Build using shared libraries +BUILD_SHARED_LIBS:BOOL=OFF + +//Path to a program. +CMAKE_ADDR2LINE:FILEPATH=/usr/bin/addr2line + +//Path to a program. +CMAKE_AR:FILEPATH=/usr/bin/ar + +//Choose the type of build, options are: None Debug Release RelWithDebInfo +// MinSizeRel ... +CMAKE_BUILD_TYPE:STRING= + +//CXX compiler +CMAKE_CXX_COMPILER:FILEPATH=/usr/bin/c++ + +//A wrapper around 'ar' adding the appropriate '--plugin' option +// for the GCC compiler +CMAKE_CXX_COMPILER_AR:FILEPATH=/usr/bin/gcc-ar-11 + +//A wrapper around 'ranlib' adding the appropriate '--plugin' option +// for the GCC compiler +CMAKE_CXX_COMPILER_RANLIB:FILEPATH=/usr/bin/gcc-ranlib-11 + +//Flags used by the CXX compiler during all build types. +CMAKE_CXX_FLAGS:STRING= + +//Flags used by the CXX compiler during DEBUG builds. +CMAKE_CXX_FLAGS_DEBUG:STRING=-g + +//Flags used by the CXX compiler during MINSIZEREL builds. +CMAKE_CXX_FLAGS_MINSIZEREL:STRING=-Os -DNDEBUG + +//Flags used by the CXX compiler during RELEASE builds. +CMAKE_CXX_FLAGS_RELEASE:STRING=-O3 -DNDEBUG + +//Flags used by the CXX compiler during RELWITHDEBINFO builds. +CMAKE_CXX_FLAGS_RELWITHDEBINFO:STRING=-O2 -g -DNDEBUG + +//C compiler +CMAKE_C_COMPILER:FILEPATH=/usr/bin/cc + +//A wrapper around 'ar' adding the appropriate '--plugin' option +// for the GCC compiler +CMAKE_C_COMPILER_AR:FILEPATH=/usr/bin/gcc-ar-11 + +//A wrapper around 'ranlib' adding the appropriate '--plugin' option +// for the GCC compiler +CMAKE_C_COMPILER_RANLIB:FILEPATH=/usr/bin/gcc-ranlib-11 + +//Flags used by the C compiler during all build types. +CMAKE_C_FLAGS:STRING= + +//Flags used by the C compiler during DEBUG builds. +CMAKE_C_FLAGS_DEBUG:STRING=-g + +//Flags used by the C compiler during MINSIZEREL builds. +CMAKE_C_FLAGS_MINSIZEREL:STRING=-Os -DNDEBUG + +//Flags used by the C compiler during RELEASE builds. +CMAKE_C_FLAGS_RELEASE:STRING=-O3 -DNDEBUG + +//Flags used by the C compiler during RELWITHDEBINFO builds. +CMAKE_C_FLAGS_RELWITHDEBINFO:STRING=-O2 -g -DNDEBUG + +//Path to a program. +CMAKE_DLLTOOL:FILEPATH=CMAKE_DLLTOOL-NOTFOUND + +//Flags used by the linker during all build types. +CMAKE_EXE_LINKER_FLAGS:STRING= + +//Flags used by the linker during DEBUG builds. +CMAKE_EXE_LINKER_FLAGS_DEBUG:STRING= + +//Flags used by the linker during MINSIZEREL builds. +CMAKE_EXE_LINKER_FLAGS_MINSIZEREL:STRING= + +//Flags used by the linker during RELEASE builds. +CMAKE_EXE_LINKER_FLAGS_RELEASE:STRING= + +//Flags used by the linker during RELWITHDEBINFO builds. +CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO:STRING= + +//Enable/Disable output of compile commands during generation. +CMAKE_EXPORT_COMPILE_COMMANDS:BOOL= + +//Value Computed by CMake. +CMAKE_FIND_PACKAGE_REDIRECTS_DIR:STATIC=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient/CMakeFiles/pkgRedirects + +//Install path prefix, prepended onto install directories. +CMAKE_INSTALL_PREFIX:PATH=/usr/local + +//Path to a program. +CMAKE_LINKER:FILEPATH=/usr/bin/ld + +//Program used to build from build.ninja files. +CMAKE_MAKE_PROGRAM:FILEPATH=/home/pschatzmann/st/stm32cubeclt_1.16.0/Ninja/bin/ninja + +//Flags used by the linker during the creation of modules during +// all build types. +CMAKE_MODULE_LINKER_FLAGS:STRING= + +//Flags used by the linker during the creation of modules during +// DEBUG builds. +CMAKE_MODULE_LINKER_FLAGS_DEBUG:STRING= + +//Flags used by the linker during the creation of modules during +// MINSIZEREL builds. +CMAKE_MODULE_LINKER_FLAGS_MINSIZEREL:STRING= + +//Flags used by the linker during the creation of modules during +// RELEASE builds. +CMAKE_MODULE_LINKER_FLAGS_RELEASE:STRING= + +//Flags used by the linker during the creation of modules during +// RELWITHDEBINFO builds. +CMAKE_MODULE_LINKER_FLAGS_RELWITHDEBINFO:STRING= + +//Path to a program. +CMAKE_NM:FILEPATH=/usr/bin/nm + +//Path to a program. +CMAKE_OBJCOPY:FILEPATH=/usr/bin/objcopy + +//Path to a program. +CMAKE_OBJDUMP:FILEPATH=/usr/bin/objdump + +//Value Computed by CMake +CMAKE_PROJECT_DESCRIPTION:STATIC= + +//Value Computed by CMake +CMAKE_PROJECT_HOMEPAGE_URL:STATIC= + +//Value Computed by CMake +CMAKE_PROJECT_NAME:STATIC=snapclient + +//Path to a program. +CMAKE_RANLIB:FILEPATH=/usr/bin/ranlib + +//Path to a program. +CMAKE_READELF:FILEPATH=/usr/bin/readelf + +//Flags used by the linker during the creation of shared libraries +// during all build types. +CMAKE_SHARED_LINKER_FLAGS:STRING= + +//Flags used by the linker during the creation of shared libraries +// during DEBUG builds. +CMAKE_SHARED_LINKER_FLAGS_DEBUG:STRING= + +//Flags used by the linker during the creation of shared libraries +// during MINSIZEREL builds. +CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL:STRING= + +//Flags used by the linker during the creation of shared libraries +// during RELEASE builds. +CMAKE_SHARED_LINKER_FLAGS_RELEASE:STRING= + +//Flags used by the linker during the creation of shared libraries +// during RELWITHDEBINFO builds. +CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO:STRING= + +//If set, runtime paths are not added when installing shared libraries, +// but are added when building. +CMAKE_SKIP_INSTALL_RPATH:BOOL=NO + +//If set, runtime paths are not added when using shared libraries. +CMAKE_SKIP_RPATH:BOOL=NO + +//Flags used by the linker during the creation of static libraries +// during all build types. +CMAKE_STATIC_LINKER_FLAGS:STRING= + +//Flags used by the linker during the creation of static libraries +// during DEBUG builds. +CMAKE_STATIC_LINKER_FLAGS_DEBUG:STRING= + +//Flags used by the linker during the creation of static libraries +// during MINSIZEREL builds. +CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL:STRING= + +//Flags used by the linker during the creation of static libraries +// during RELEASE builds. +CMAKE_STATIC_LINKER_FLAGS_RELEASE:STRING= + +//Flags used by the linker during the creation of static libraries +// during RELWITHDEBINFO builds. +CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO:STRING= + +//Path to a program. +CMAKE_STRIP:FILEPATH=/usr/bin/strip + +//Path to a program. +CMAKE_TAPI:FILEPATH=CMAKE_TAPI-NOTFOUND + +//If this value is on, makefiles will be generated without the +// .SILENT directive, and all commands will be echoed to the console +// during the make. This is useful for debugging only. With Visual +// Studio IDE projects all commands are done without /nologo. +CMAKE_VERBOSE_MAKEFILE:BOOL=FALSE + +//codec selected by the user +CODEC:STRING=opus + +//Directory under which to collect all populated content +FETCHCONTENT_BASE_DIR:PATH=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient/_deps + +//Disables all attempts to download or update content and assumes +// source dirs already exist +FETCHCONTENT_FULLY_DISCONNECTED:BOOL=OFF + +//Enables QUIET option for all content population +FETCHCONTENT_QUIET:BOOL=ON + +//When not empty, overrides where to find pre-populated content +// for arduino-audio-tools +FETCHCONTENT_SOURCE_DIR_ARDUINO-AUDIO-TOOLS:PATH= + +//Enables UPDATE_DISCONNECTED behavior for all content population +FETCHCONTENT_UPDATES_DISCONNECTED:BOOL=OFF + +//Enables UPDATE_DISCONNECTED behavior just for population of arduino-audio-tools +FETCHCONTENT_UPDATES_DISCONNECTED_ARDUINO-AUDIO-TOOLS:BOOL=OFF + +//Git command line client +GIT_EXECUTABLE:FILEPATH=/usr/bin/git + +//Value Computed by CMake +snapclient_BINARY_DIR:STATIC=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient + +//Value Computed by CMake +snapclient_IS_TOP_LEVEL:STATIC=ON + +//Value Computed by CMake +snapclient_SOURCE_DIR:STATIC=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient + + +######################## +# INTERNAL cache entries +######################## + +//ADVANCED property for variable: CMAKE_ADDR2LINE +CMAKE_ADDR2LINE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_AR +CMAKE_AR-ADVANCED:INTERNAL=1 +//This is the directory where this CMakeCache.txt was created +CMAKE_CACHEFILE_DIR:INTERNAL=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient +//Major version of cmake used to create the current loaded cache +CMAKE_CACHE_MAJOR_VERSION:INTERNAL=3 +//Minor version of cmake used to create the current loaded cache +CMAKE_CACHE_MINOR_VERSION:INTERNAL=28 +//Patch version of cmake used to create the current loaded cache +CMAKE_CACHE_PATCH_VERSION:INTERNAL=1 +//Path to CMake executable. +CMAKE_COMMAND:INTERNAL=/home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/bin/cmake +//Path to cpack program executable. +CMAKE_CPACK_COMMAND:INTERNAL=/home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/bin/cpack +//Path to ctest program executable. +CMAKE_CTEST_COMMAND:INTERNAL=/home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/bin/ctest +//ADVANCED property for variable: CMAKE_CXX_COMPILER +CMAKE_CXX_COMPILER-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_COMPILER_AR +CMAKE_CXX_COMPILER_AR-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_COMPILER_RANLIB +CMAKE_CXX_COMPILER_RANLIB-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_FLAGS +CMAKE_CXX_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_FLAGS_DEBUG +CMAKE_CXX_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_FLAGS_MINSIZEREL +CMAKE_CXX_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_FLAGS_RELEASE +CMAKE_CXX_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_CXX_FLAGS_RELWITHDEBINFO +CMAKE_CXX_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_COMPILER +CMAKE_C_COMPILER-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_COMPILER_AR +CMAKE_C_COMPILER_AR-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_COMPILER_RANLIB +CMAKE_C_COMPILER_RANLIB-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_FLAGS +CMAKE_C_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_FLAGS_DEBUG +CMAKE_C_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_FLAGS_MINSIZEREL +CMAKE_C_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_FLAGS_RELEASE +CMAKE_C_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_C_FLAGS_RELWITHDEBINFO +CMAKE_C_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_DLLTOOL +CMAKE_DLLTOOL-ADVANCED:INTERNAL=1 +//Path to cache edit program executable. +CMAKE_EDIT_COMMAND:INTERNAL=/home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/bin/ccmake +//Executable file format +CMAKE_EXECUTABLE_FORMAT:INTERNAL=ELF +//ADVANCED property for variable: CMAKE_EXE_LINKER_FLAGS +CMAKE_EXE_LINKER_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_EXE_LINKER_FLAGS_DEBUG +CMAKE_EXE_LINKER_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_EXE_LINKER_FLAGS_MINSIZEREL +CMAKE_EXE_LINKER_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_EXE_LINKER_FLAGS_RELEASE +CMAKE_EXE_LINKER_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO +CMAKE_EXE_LINKER_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_EXPORT_COMPILE_COMMANDS +CMAKE_EXPORT_COMPILE_COMMANDS-ADVANCED:INTERNAL=1 +//Name of external makefile project generator. +CMAKE_EXTRA_GENERATOR:INTERNAL= +//Name of generator. +CMAKE_GENERATOR:INTERNAL=Ninja +//Generator instance identifier. +CMAKE_GENERATOR_INSTANCE:INTERNAL= +//Name of generator platform. +CMAKE_GENERATOR_PLATFORM:INTERNAL= +//Name of generator toolset. +CMAKE_GENERATOR_TOOLSET:INTERNAL= +//Source directory with the top level CMakeLists.txt file for this +// project +CMAKE_HOME_DIRECTORY:INTERNAL=/home/pschatzmann/Development/Arduino/libraries/arduino-snapclient +//Install .so files without execute permission. +CMAKE_INSTALL_SO_NO_EXE:INTERNAL=1 +//ADVANCED property for variable: CMAKE_LINKER +CMAKE_LINKER-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MAKE_PROGRAM +CMAKE_MAKE_PROGRAM-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MODULE_LINKER_FLAGS +CMAKE_MODULE_LINKER_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MODULE_LINKER_FLAGS_DEBUG +CMAKE_MODULE_LINKER_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MODULE_LINKER_FLAGS_MINSIZEREL +CMAKE_MODULE_LINKER_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MODULE_LINKER_FLAGS_RELEASE +CMAKE_MODULE_LINKER_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_MODULE_LINKER_FLAGS_RELWITHDEBINFO +CMAKE_MODULE_LINKER_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_NM +CMAKE_NM-ADVANCED:INTERNAL=1 +//number of local generators +CMAKE_NUMBER_OF_MAKEFILES:INTERNAL=1 +//ADVANCED property for variable: CMAKE_OBJCOPY +CMAKE_OBJCOPY-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_OBJDUMP +CMAKE_OBJDUMP-ADVANCED:INTERNAL=1 +//Platform information initialized +CMAKE_PLATFORM_INFO_INITIALIZED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_RANLIB +CMAKE_RANLIB-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_READELF +CMAKE_READELF-ADVANCED:INTERNAL=1 +//Path to CMake installation. +CMAKE_ROOT:INTERNAL=/home/pschatzmann/st/stm32cubeclt_1.16.0/CMake/share/cmake-3.28 +//ADVANCED property for variable: CMAKE_SHARED_LINKER_FLAGS +CMAKE_SHARED_LINKER_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SHARED_LINKER_FLAGS_DEBUG +CMAKE_SHARED_LINKER_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL +CMAKE_SHARED_LINKER_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SHARED_LINKER_FLAGS_RELEASE +CMAKE_SHARED_LINKER_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO +CMAKE_SHARED_LINKER_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SKIP_INSTALL_RPATH +CMAKE_SKIP_INSTALL_RPATH-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_SKIP_RPATH +CMAKE_SKIP_RPATH-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STATIC_LINKER_FLAGS +CMAKE_STATIC_LINKER_FLAGS-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STATIC_LINKER_FLAGS_DEBUG +CMAKE_STATIC_LINKER_FLAGS_DEBUG-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL +CMAKE_STATIC_LINKER_FLAGS_MINSIZEREL-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STATIC_LINKER_FLAGS_RELEASE +CMAKE_STATIC_LINKER_FLAGS_RELEASE-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO +CMAKE_STATIC_LINKER_FLAGS_RELWITHDEBINFO-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_STRIP +CMAKE_STRIP-ADVANCED:INTERNAL=1 +//ADVANCED property for variable: CMAKE_TAPI +CMAKE_TAPI-ADVANCED:INTERNAL=1 +//uname command +CMAKE_UNAME:INTERNAL=/usr/bin/uname +//ADVANCED property for variable: CMAKE_VERBOSE_MAKEFILE +CMAKE_VERBOSE_MAKEFILE-ADVANCED:INTERNAL=1 +//STRINGS property for variable: CODEC +CODEC-STRINGS:INTERNAL=flac;ogg;opus;pcm +//ADVANCED property for variable: GIT_EXECUTABLE +GIT_EXECUTABLE-ADVANCED:INTERNAL=1 +//linker supports push/pop state +_CMAKE_LINKER_PUSHPOP_STATE_SUPPORTED:INTERNAL=TRUE + diff --git a/README.md b/README.md index 2c5be75..b249d4b 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ Here is an example Arduino sketch that uses the Wifi as communication API, the W ```C++ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus +#include "AudioTools/AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus //#include "api/SnapProcessorRTOS.h" // install https://github.com/pschatzmann/arduino-freertos-addons OpusAudioDecoder codec; diff --git a/desktop-client/CMakeLists.txt b/desktop-client/CMakeLists.txt deleted file mode 100644 index dda38bf..0000000 --- a/desktop-client/CMakeLists.txt +++ /dev/null @@ -1,38 +0,0 @@ -cmake_minimum_required(VERSION 2.34) - -# set the project name -project(desktop-client) -set (CMAKE_CXX_STANDARD 17) -set (DCMAKE_CXX_FLAGS "-Werror") -# set (FETCHCONTENT_FULLY_DISCONNECTED ON) - -include(FetchContent) - -# Download miniaudio.h -file(DOWNLOAD https://raw.githubusercontent.com/mackron/miniaudio/master/miniaudio.h - ${CMAKE_CURRENT_SOURCE_DIR}/miniaudio.h) - -# Build with snapclient -if(CMAKE_SOURCE_DIR STREQUAL CMAKE_CURRENT_SOURCE_DIR) - add_subdirectory(${CMAKE_CURRENT_SOURCE_DIR}/.. ${CMAKE_CURRENT_BINARY_DIR}/snapclient ) -endif() - -FetchContent_Declare(arduino_libvorbis GIT_REPOSITORY https://github.com/pschatzmann/arduino-libvorbis-tremor.git GIT_TAG main ) -FetchContent_GetProperties(arduino_libvorbis) -if(NOT arduino_libvorbis_POPULATED) - FetchContent_Populate(arduino_libvorbis) - add_subdirectory(${arduino_libvorbis_SOURCE_DIR} ${CMAKE_CURRENT_BINARY_DIR}/arduino_libvorbis) -endif() - - -# build sketch as executable -add_executable (desktop-client SnapClient.cpp) - -# set preprocessor defines -target_compile_definitions(desktop-client PUBLIC -DARDUINO -DEXIT_ON_STOP -DIS_DESKTOP -DCONFIG_USE_PSRAM=0 -DCONFIG_SNAPCLIENT_SNTP_ENABLE=0 -DCONFIG_SNAPCLIENT_USE_MDNS=0) - -# specify libraries -target_link_libraries(desktop-client snapclient arduino-audio-tools arduino_emulator arduino_libopus arduino_libvorbis) - -# to find include for miniaudio -target_include_directories(desktop-client PRIVATE ${CMAKE_CURRENT_SOURCE_DIR}) diff --git a/desktop-client/README.md b/desktop-client/README.md deleted file mode 100644 index cb50cf3..0000000 --- a/desktop-client/README.md +++ /dev/null @@ -1,10 +0,0 @@ - -Snaplient build for the Desktop - -1. goto the desktop-client directory -2. mkdir build -3. cd build -4. cmake .. -5. make - -This builds the desktop-client executable \ No newline at end of file diff --git a/desktop-client/SnapClient.cpp b/desktop-client/SnapClient.cpp deleted file mode 100644 index a7ed91e..0000000 --- a/desktop-client/SnapClient.cpp +++ /dev/null @@ -1,45 +0,0 @@ -/** - * @brief SnapClient with Opus decoder: Output to PortAudio on the desktop - * @author Phil Schatzmann - * @copyright GPLv3 - */ -#include "AudioTools.h" -#include "SnapClient.h" -#include "AudioLibs/MiniAudioStream.h" -//#include "AudioCodecs/CodecOpus.h" -//#include "AudioCodecs/CodecFLAC.h" // https://github.com/pschatzmann/arduino-libflac.git -#include "AudioCodecs/CodecVorbis.h" //https://github.com/pschatzmann/arduino-libvorbis-idec -#include "AudioLibs/StdioStream.h" - -//CsvOutput out; -//StdioStream out; -MiniAudioStream out; -//OpusAudioDecoder opus; -VorbisDecoder ogg; -//FLACDecoder flac; -WiFiClient wifi; -SnapClient client(wifi, out, ogg); - -void setup() { - Serial.begin(115200); - //AudioLogger::instance().begin(Serial, AudioLogger::Info); - // login to wifi - WiFi.begin(CONFIG_WIFI_SSID, CONFIG_WIFI_PASSWORD); - Serial.print("Connecting to WiFi .."); - while (WiFi.status() != WL_CONNECTED) { - Serial.print('.'); - delay(1000); - } - - // print ip address - Serial.println(); - Serial.println(WiFi.localIP()); - - - // start snap client - client.begin(); -} - -void loop() { - client.doLoop(); -} \ No newline at end of file diff --git a/docs/html/_snap_client_8h_source.html b/docs/html/_snap_client_8h_source.html index f8e9898..d1eedde 100644 --- a/docs/html/_snap_client_8h_source.html +++ b/docs/html/_snap_client_8h_source.html @@ -71,230 +71,252 @@
1 #pragma once
7 #include "AudioTools.h"
-
8 #include "SnapConfig.h"
-
9 #include "api/SnapCommon.h"
-
10 #include "api/SnapLogger.h"
-
11 //#include <WiFi.h>
-
12 #include "Client.h"
-
13 
-
14 
-
15 #if CONFIG_NVS_FLASH
-
16 #include "nvs_flash.h"
-
17 #endif
-
18 #if CONFIG_SNAPCLIENT_USE_MDNS && defined(ESP32)
-
19 #include <ESPmDNS.h>
-
20 #endif
-
21 
-
22 #include "api/SnapOutput.h"
-
23 #include "api/SnapProcessor.h"
-
24 
-
32 class SnapClient {
-
33 
-
34 public:
-
35  SnapClient(Client &client, AudioStream &stream, AudioDecoder &decoder) {
-
36  static AdapterAudioStreamToAudioOutput output_adapter;
-
37  output_adapter.setStream(stream);
-
38  p_decoder = &decoder;
-
39  p_output = &output_adapter;
-
40  p_client = &client;
-
41  }
-
42 
-
43  SnapClient(Client &client, AudioStream &stream, StreamingDecoder &decoder,
-
44  int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) {
-
45  static DecoderFromStreaming decoder_adapter(decoder, bufferSize);
-
46  static AdapterAudioStreamToAudioOutput output_adapter;
-
47  p_decoder = &decoder_adapter;
-
48  output_adapter.setStream(stream);
-
49  p_output = &output_adapter;
-
50  p_client = &client;
-
51  }
-
52 
-
53  SnapClient(Client &client, AudioOutput &output, AudioDecoder &decoder) {
-
54  p_decoder = &decoder;
-
55  p_output = &output;
-
56  p_client = &client;
-
57  }
-
58 
-
59  SnapClient(Client &client, AudioOutput &output, StreamingDecoder &decoder,
-
60  int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) {
-
61  p_decoder = new DecoderFromStreaming(decoder, bufferSize);
-
62  p_output = &output;
+
8 #include "Client.h"
+
9 #include "SnapConfig.h"
+
10 #include "api/SnapCommon.h"
+
11 #include "api/SnapLogger.h"
+
12 
+
13 #if CONFIG_NVS_FLASH
+
14 #include "nvs_flash.h"
+
15 #endif
+
16 #if CONFIG_SNAPCLIENT_USE_MDNS && defined(ESP32)
+
17 #include <ESPmDNS.h>
+
18 #endif
+
19 
+
20 #ifdef ESP32
+
21 #include <WiFi.h>
+
22 #endif
+
23 
+
24 #include "api/SnapOutput.h"
+
25 #include "api/SnapProcessor.h"
+
26 
+
27 namespace snap_arduino {
+
28 
+
36 class SnapClient {
+
37  public:
+
38  SnapClient(Client &client, AudioStream &stream, AudioDecoder &decoder) {
+
39  static AdapterAudioStreamToAudioOutput output_adapter;
+
40  output_adapter.setStream(stream);
+
41  p_decoder = &decoder;
+
42  p_output = &output_adapter;
+
43  p_client = &client;
+
44  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
45  }
+
46 
+
47  SnapClient(Client &client, Print &stream, AudioDecoder &decoder) {
+
48  static AdapterPrintToAudioOutput output_adapter;
+
49  output_adapter.setStream(stream);
+
50  p_decoder = &decoder;
+
51  p_output = &output_adapter;
+
52  p_client = &client;
+
53  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
54  }
+
55 
+
56  SnapClient(Client &client, AudioStream &stream, StreamingDecoder &decoder,
+
57  int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) {
+
58  static DecoderFromStreaming decoder_adapter(decoder, bufferSize);
+
59  static AdapterAudioStreamToAudioOutput output_adapter;
+
60  p_decoder = &decoder_adapter;
+
61  output_adapter.setStream(stream);
+
62  p_output = &output_adapter;
63  p_client = &client;
-
64  }
-
65 
-
67  ~SnapClient() {
-
68  end();
-
69  }
-
70 
-
72  void setClient(Client &client) { p_client = &client; }
+
64  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
65  }
+
66 
+
67  SnapClient(Client &client, AudioOutput &output, AudioDecoder &decoder) {
+
68  p_decoder = &decoder;
+
69  p_output = &output;
+
70  p_client = &client;
+
71  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
72  }
73 
-
76  void setServerIP(IPAddress ipAddress) { this->address = ipAddress; }
-
77 
-
79  void setSnapTimeSync(SnapTimeSync &timeSync){
-
80  p_time_sync = &timeSync;
-
81  }
-
82 
-
84  bool begin(SnapTimeSync &timeSync) {
-
85  setSnapTimeSync(timeSync);
-
86  return begin();
-
87  }
-
88 
-
90  bool begin() {
-
91 #if defined(ESP32)
-
92  if (WiFi.status() != WL_CONNECTED) {
-
93  ESP_LOGE(TAG, "WiFi not connected");
-
94  return false;
-
95  }
-
96  // use maximum speed
-
97  WiFi.setSleep(false);
-
98  ESP_LOGI(TAG, "Connected to AP");
-
99 #endif
-
100 
-
101  // Get MAC address for WiFi station
-
102  setupMACAddress();
-
103 
-
104  setupNVS();
-
105 
-
106  setupMDNS();
-
107 
-
108  setupPSRAM();
-
109 
-
110 #if CONFIG_SNAPCLIENT_SNTP_ENABLE
-
111  SnapTime::instance().setupSNTPTime();
+
74  SnapClient(Client &client, AudioOutput &output, StreamingDecoder &decoder,
+
75  int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) {
+
76  p_decoder = new DecoderFromStreaming(decoder, bufferSize);
+
77  p_output = &output;
+
78  p_client = &client;
+
79  }
+
80 
+
82  ~SnapClient() { end(); }
+
83 
+
85  void setClient(Client &client) { p_client = &client; }
+
86 
+
89  void setServerIP(IPAddress ipAddress) { this->server_ip = ipAddress; }
+
90 
+
92  void setSnapTimeSync(SnapTimeSync &timeSync) { p_time_sync = &timeSync; }
+
93 
+
95  bool begin(SnapTimeSync &timeSync) {
+
96  setSnapTimeSync(timeSync);
+
97  return begin();
+
98  }
+
99 
+
101  bool begin() {
+
102 #if defined(ESP32)
+
103  if (is_wifi) {
+
104  if (WiFi.status() != WL_CONNECTED) {
+
105  ESP_LOGE(TAG, "WiFi not connected");
+
106  return false;
+
107  }
+
108  // use maximum speed
+
109  WiFi.setSleep(false);
+
110  ESP_LOGI(TAG, "Connected to AP");
+
111  }
112 #endif
113 
-
114  p_snapprocessor->setServerIP(address);
-
115  p_snapprocessor->setOutput(*p_output);
-
116  p_snapprocessor->snapOutput().setSnapTimeSync(*p_time_sync);
-
117  p_snapprocessor->setDecoder(*p_decoder);
-
118  p_snapprocessor->setClient(*p_client);
-
119 
-
120  // start tasks
-
121  return p_snapprocessor->begin();
-
122  }
-
123 
-
125  void end(void) { p_snapprocessor->end(); }
-
126 
-
128  float volume(void) { return p_snapprocessor->volume(); }
-
129 
-
131  void setVolumeFactor(float fact) { p_snapprocessor->setVolumeFactor(fact); }
-
132 
-
134  void setStartTask(bool flag) { p_snapprocessor->setStartTask(flag); }
+
114  // Get MAC address for WiFi station
+
115  setupMACAddress();
+
116 
+
117  setupNVS();
+
118 
+
119  setupMDNS();
+
120 
+
121 #if CONFIG_SNAPCLIENT_SNTP_ENABLE
+
122  SnapTime::instance().setupSNTPTime();
+
123 #endif
+
124 
+
125  p_snapprocessor->setServerIP(server_ip);
+
126  p_snapprocessor->setServerPort(server_port);
+
127  p_snapprocessor->setOutput(*p_output);
+
128  p_snapprocessor->snapOutput().setSnapTimeSync(*p_time_sync);
+
129  p_snapprocessor->setDecoder(*p_decoder);
+
130  p_snapprocessor->setClient(*p_client);
+
131 
+
132  // start tasks
+
133  return p_snapprocessor->begin();
+
134  }
135 
-
137  void setStartOutput(bool start) { p_snapprocessor->setStartOutput(start); }
+
137  void end(void) { p_snapprocessor->end(); }
138 
-
140  void setSnapProcessor(SnapProcessor &processor) {
-
141  p_snapprocessor = &processor;
-
142  }
-
143 
-
145  void setSnapOutput(SnapOutput &out){
-
146  p_snapprocessor->setSnapOutput(out);
-
147  }
-
148 
-
150  void doLoop() { p_snapprocessor->doLoop(); }
-
151 
-
152 protected:
-
153  const char *TAG = "SnapClient";
-
154  SnapTime &snap_time = SnapTime::instance();
-
155  SnapProcessor default_processor;
-
156  SnapProcessor *p_snapprocessor = &default_processor;
-
157  AudioOutput *p_output = nullptr;
-
158  AudioDecoder *p_decoder = nullptr;
-
159  Client *p_client = nullptr;
-
160  SnapTimeSync *p_time_sync = nullptr;
-
161  IPAddress address;
-
162 
-
163  void setupMDNS() {
-
164 #if CONFIG_SNAPCLIENT_USE_MDNS && defined(ESP32)
-
165  ESP_LOGD(TAG, "start");
-
166  if (!MDNS.begin(CONFIG_SNAPCAST_CLIENT_NAME)) {
-
167  LOGE(TAG, "Error starting mDNS");
-
168  return;
-
169  }
+
140  float volume(void) { return p_snapprocessor->volume(); }
+
141 
+
143  void setVolumeFactor(float fact) { p_snapprocessor->setVolumeFactor(fact); }
+
144 
+
146  void setStartTask(bool flag) { p_snapprocessor->setStartTask(flag); }
+
147 
+
149  void setStartOutput(bool start) { p_snapprocessor->setStartOutput(start); }
+
150 
+
152  void setSnapProcessor(SnapProcessor &processor) {
+
153  p_snapprocessor = &processor;
+
154  }
+
155 
+
157  SnapProcessor &snapProcessor() { return *p_snapprocessor; }
+
158 
+
160  void setSnapOutput(SnapOutput &out) { p_snapprocessor->setSnapOutput(out); }
+
161 
+
163  bool doLoop() { return p_snapprocessor->doLoop(); }
+
164 
+
166  void setWiFi(bool flag){ is_wifi = flag;}
+
167 
+
169  bool isWiFi() {return is_wifi;}
170 
-
171  // we just take the first address
-
172  int nrOfServices = MDNS.queryService("snapcast", "tcp");
-
173  if (nrOfServices > 0) {
-
174  IPAddress server_ip = MDNS.IP(0);
-
175  char str_address[20] = {0};
-
176  sprintf(str_address, "%d.%d.%d.%d", server_ip[0], server_ip[1],
-
177  server_ip[2], server_ip[3]);
-
178  int server_port = MDNS.port(0);
-
179 
-
180  // update addres information
-
181  p_snapprocessor->setServerIP(server_ip);
-
182  p_snapprocessor->setServerPort(server_port);
-
183  ESP_LOGI(TAG, "SNAPCAST ip: %s, port: %d", str_address, server_port);
-
184 
-
185  } else {
-
186  ESP_LOGE(TAG, "SNAPCAST server not found");
-
187  }
+
171  protected:
+
172  const char *TAG = "SnapClient";
+
173  SnapTime &snap_time = SnapTime::instance();
+
174  SnapProcessor default_processor;
+
175  SnapProcessor *p_snapprocessor = &default_processor;
+
176  AudioOutput *p_output = nullptr;
+
177  AudioDecoder *p_decoder = nullptr;
+
178  Client *p_client = nullptr;
+
179  SnapTimeSyncDynamic time_sync_default;
+
180  SnapTimeSync *p_time_sync = &time_sync_default;
+
181  IPAddress server_ip;
+
182  int server_port = CONFIG_SNAPCAST_SERVER_PORT;
+
183 #ifdef ESP32
+
184  bool is_wifi = true;
+
185 #else
+
186  bool is_wifi = false;
+
187 #endif
188 
-
189  MDNS.end();
-
190  checkHeap();
-
191 #endif
-
192  }
-
193 
-
194  void setupNVS() {
-
195 #if CONFIG_NVS_FLASH && defined(ESP32)
-
196  esp_err_t ret = nvs_flash_init();
-
197  if (ret == ESP_ERR_NVS_NO_FREE_PAGES ||
-
198  ret == ESP_ERR_NVS_NEW_VERSION_FOUND) {
-
199  ESP_ERROR_CHECK(nvs_flash_erase());
-
200  ret = nvs_flash_init();
-
201  }
-
202  checkHeap();
-
203  ESP_ERROR_CHECK(ret);
+
189  void setupMDNS() {
+
190 #if CONFIG_SNAPCLIENT_USE_MDNS && defined(ESP32)
+
191  ESP_LOGD(TAG, "start");
+
192  if (!MDNS.begin(CONFIG_SNAPCAST_CLIENT_NAME)) {
+
193  LOGE(TAG, "Error starting mDNS");
+
194  return;
+
195  }
+
196 
+
197  // we just take the first address
+
198  int nrOfServices = MDNS.queryService("snapcast", "tcp");
+
199  if (nrOfServices > 0) {
+
200 #if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0)
+
201  server_ip = MDNS.address(0);
+
202 #else
+
203  server_ip = MDNS.IP(0);
204 #endif
-
205  }
-
206 
-
207  void setupPSRAM() {
-
208 #if CONFIG_USE_PSRAM && defined(ESP32)
-
209  if (ESP.getPsramSize() > 0) {
-
210  heap_caps_malloc_extmem_enable(CONFIG_PSRAM_LIMIT);
-
211  ESP_LOGD(TAG, "PSRAM for allocations > %d bytes", CONFIG_PSRAM_LIMIT);
-
212  } else {
-
213  ESP_LOGW(TAG, "No PSRAM available or PSRAM not activated");
-
214  }
-
215 #endif
-
216  }
-
217 
-
218  void setupMACAddress() {
-
219 #ifdef ESP32
-
220  const char *adr = strdup(WiFi.macAddress().c_str());
-
221  p_snapprocessor->setMacAddress(adr);
-
222  ESP_LOGI(TAG, "mac: %s", adr);
-
223  checkHeap();
-
224 #endif
-
225  }
-
226 };
-
SnapClient
Snap Client for ESP32 Arduino.
Definition: SnapClient.h:32
-
SnapClient::end
void end(void)
ends the processing and releases the resources
Definition: SnapClient.h:125
-
SnapClient::setServerIP
void setServerIP(IPAddress ipAddress)
Defines the Snapcast Server IP address.
Definition: SnapClient.h:76
-
SnapClient::setStartTask
void setStartTask(bool flag)
For testing to deactivate the starting of the http task.
Definition: SnapClient.h:134
-
SnapClient::~SnapClient
~SnapClient()
Destructor.
Definition: SnapClient.h:67
-
SnapClient::doLoop
void doLoop()
Call from Arduino Loop - to receive and process the audio data.
Definition: SnapClient.h:150
-
SnapClient::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the Snap output implementation to be used.
Definition: SnapClient.h:145
-
SnapClient::begin
bool begin()
Starts the processing.
Definition: SnapClient.h:90
-
SnapClient::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapClient.h:131
-
SnapClient::volume
float volume(void)
Provides the actual volume (in the range of 0.0 to 1.0)
Definition: SnapClient.h:128
-
SnapClient::setClient
void setClient(Client &client)
Defines an alternative commnuication client (default is WiFiClient)
Definition: SnapClient.h:72
-
SnapClient::setSnapProcessor
void setSnapProcessor(SnapProcessor &processor)
Defines an alternative Processor.
Definition: SnapClient.h:140
-
SnapClient::begin
bool begin(SnapTimeSync &timeSync)
Starts the processing.
Definition: SnapClient.h:84
-
SnapClient::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapClient.h:79
-
SnapClient::setStartOutput
void setStartOutput(bool start)
For Testing: Used to prevent the starting of the output task.
Definition: SnapClient.h:137
-
SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:26
-
SnapOutput::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapOutput.h:120
-
SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:19
-
SnapProcessor::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the SnapOutput implementation.
Definition: SnapProcessor.h:85
-
SnapProcessor::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapProcessor.h:76
-
SnapProcessor::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapProcessor.h:82
-
SnapProcessor::volume
float volume(void)
Provides the volume (in the range of 0.0 to 1.0)
Definition: SnapProcessor.h:79
-
SnapProcessor::setOutput
void setOutput(AudioOutput &output)
Defines the output class.
Definition: SnapProcessor.h:73
-
SnapProcessor::setClient
void setClient(Client &client)
Defines an alternative client to the WiFiClient.
Definition: SnapProcessor.h:90
-
SnapProcessor::doLoop
virtual void doLoop()
Call via SnapClient in Arduino Loop!
Definition: SnapProcessor.h:70
-
SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:16
-
SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:15
+
205  char str_address[20] = {0};
+
206  sprintf(str_address, "%d.%d.%d.%d", server_ip[0], server_ip[1],
+
207  server_ip[2], server_ip[3]);
+
208  server_port = MDNS.port(0);
+
209 
+
210  ESP_LOGI(TAG, "MDNS: SNAPCAST ip: %s, port: %d", str_address,
+
211  server_port);
+
212 
+
213  } else {
+
214  ESP_LOGE(TAG, "SNAPCAST server not found");
+
215  }
+
216 
+
217  MDNS.end();
+
218  checkHeap();
+
219 #endif
+
220  }
+
221 
+
222  void setupNVS() {
+
223 #if CONFIG_NVS_FLASH && defined(ESP32)
+
224  esp_err_t ret = nvs_flash_init();
+
225  if (ret == ESP_ERR_NVS_NO_FREE_PAGES ||
+
226  ret == ESP_ERR_NVS_NEW_VERSION_FOUND) {
+
227  ESP_ERROR_CHECK(nvs_flash_erase());
+
228  ret = nvs_flash_init();
+
229  }
+
230  checkHeap();
+
231  ESP_ERROR_CHECK(ret);
+
232 #endif
+
233  }
+
234 
+
235  void setupMACAddress() {
+
236 #ifdef ESP32
+
237  const char *adr = strdup(WiFi.macAddress().c_str());
+
238  p_snapprocessor->setMacAddress(adr);
+
239  ESP_LOGI(TAG, "mac: %s", adr);
+
240  checkHeap();
+
241 #endif
+
242  }
+
243 };
+
244 
+
245 } // namespace snap_arduino
+
snap_arduino::SnapClient
Snap Client for ESP32 Arduino.
Definition: SnapClient.h:36
+
snap_arduino::SnapClient::end
void end(void)
ends the processing and releases the resources
Definition: SnapClient.h:137
+
snap_arduino::SnapClient::setServerIP
void setServerIP(IPAddress ipAddress)
Defines the Snapcast Server IP address.
Definition: SnapClient.h:89
+
snap_arduino::SnapClient::setStartTask
void setStartTask(bool flag)
For testing to deactivate the starting of the http task.
Definition: SnapClient.h:146
+
snap_arduino::SnapClient::isWiFi
bool isWiFi()
check if we use the ESP32 WiFi for checking the link status
Definition: SnapClient.h:169
+
snap_arduino::SnapClient::~SnapClient
~SnapClient()
Destructor.
Definition: SnapClient.h:82
+
snap_arduino::SnapClient::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the Snap output implementation to be used.
Definition: SnapClient.h:160
+
snap_arduino::SnapClient::begin
bool begin()
Starts the processing.
Definition: SnapClient.h:101
+
snap_arduino::SnapClient::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapClient.h:143
+
snap_arduino::SnapClient::volume
float volume(void)
Provides the actual volume (in the range of 0.0 to 1.0)
Definition: SnapClient.h:140
+
snap_arduino::SnapClient::setClient
void setClient(Client &client)
Defines an alternative commnuication client (default is WiFiClient)
Definition: SnapClient.h:85
+
snap_arduino::SnapClient::setWiFi
void setWiFi(bool flag)
ESP32: WiFiClient: prevent/activate WiFi link status check.
Definition: SnapClient.h:166
+
snap_arduino::SnapClient::setSnapProcessor
void setSnapProcessor(SnapProcessor &processor)
Defines an alternative Processor.
Definition: SnapClient.h:152
+
snap_arduino::SnapClient::begin
bool begin(SnapTimeSync &timeSync)
Starts the processing.
Definition: SnapClient.h:95
+
snap_arduino::SnapClient::doLoop
bool doLoop()
Call from Arduino Loop - to receive and process the audio data.
Definition: SnapClient.h:163
+
snap_arduino::SnapClient::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapClient.h:92
+
snap_arduino::SnapClient::setStartOutput
void setStartOutput(bool start)
For Testing: Used to prevent the starting of the output task.
Definition: SnapClient.h:149
+
snap_arduino::SnapClient::snapProcessor
SnapProcessor & snapProcessor()
Provides the actual processor.
Definition: SnapClient.h:157
+
snap_arduino::SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:27
+
snap_arduino::SnapOutput::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapOutput.h:123
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapProcessor::begin
virtual bool begin()
Sets up the output and the client.
Definition: SnapProcessor.h:36
+
snap_arduino::SnapProcessor::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the SnapOutput implementation.
Definition: SnapProcessor.h:106
+
snap_arduino::SnapProcessor::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapProcessor.h:97
+
snap_arduino::SnapProcessor::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapProcessor.h:103
+
snap_arduino::SnapProcessor::volume
float volume(void)
Provides the volume (in the range of 0.0 to 1.0)
Definition: SnapProcessor.h:100
+
snap_arduino::SnapProcessor::setOutput
void setOutput(AudioOutput &output)
Defines the output class.
Definition: SnapProcessor.h:94
+
snap_arduino::SnapProcessor::setClient
void setClient(Client &client)
Defines an alternative client to the WiFiClient.
Definition: SnapProcessor.h:111
+
snap_arduino::SnapProcessor::doLoop
bool doLoop()
Call via SnapClient in Arduino Loop!
Definition: SnapProcessor.h:81
+
snap_arduino::SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:22
+
snap_arduino::SnapTimeSyncDynamic
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:91
+
snap_arduino::SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:17
+
snap_arduino
Definition: SnapCommon.h:10
diff --git a/docs/html/_snap_common_8h_source.html b/docs/html/_snap_common_8h_source.html index 1a07a25..18912da 100644 --- a/docs/html/_snap_common_8h_source.html +++ b/docs/html/_snap_common_8h_source.html @@ -75,44 +75,48 @@
7 #include <iomanip>
8 #include <ctime>
9 
-
10 enum codec_type { NO_CODEC, PCM, FLAC, OGG, OPUS };
-
11 static const char *TAG="COMMON";
-
19 struct SnapAudioHeader {
-
20  int32_t sec = 0;
-
21  int32_t usec = 0;
-
22  size_t size = 0;
-
23  codec_type codec = NO_CODEC;
-
24 
-
25  uint64_t operator-(SnapAudioHeader &h1) {
-
26  return (sec - h1.sec) * 1000000 + usec - h1.usec;
-
27  }
-
28 };
-
29 
-
31 struct SnapTimePoints {
-
32  uint32_t local_ms = millis();
-
33  uint32_t server_ms;
-
34  SnapTimePoints() = default;
-
35  SnapTimePoints(uint32_t serverMs){
-
36  server_ms = serverMs;
-
37  }
-
38 };
-
39 
-
40 
-
41 inline void checkHeap() {
-
42 #if CONFIG_CHECK_HEAP && defined(ESP32)
-
43  heap_caps_check_integrity_all(true);
-
44 #endif
-
45 }
-
46 
-
47 inline void logHeap() {
-
48 #ifdef ESP32
-
49  ESP_LOGD(TAG, "Free Heap: %d / Free Heap PSRAM %d", ESP.getFreeHeap(),
-
50  ESP.getFreePsram());
-
51 #endif
-
52 }
-
53 
-
SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:19
-
SnapTimePoints
Recording of local_ms and server_ms.
Definition: SnapCommon.h:31
+
10 namespace snap_arduino {
+
11 
+
12 enum codec_type { NO_CODEC, PCM, FLAC, OGG, OPUS };
+
13 static const char *TAG="COMMON";
+
21 struct SnapAudioHeader {
+
22  int32_t sec = 0;
+
23  int32_t usec = 0;
+
24  size_t size = 0;
+
25  codec_type codec = NO_CODEC;
+
26 
+
27  uint64_t operator-(SnapAudioHeader &h1) {
+
28  return (sec - h1.sec) * 1000000 + usec - h1.usec;
+
29  }
+
30 };
+
31 
+
33 struct SnapTimePoints {
+
34  uint32_t local_ms = millis();
+
35  uint32_t server_ms;
+
36  SnapTimePoints() = default;
+
37  SnapTimePoints(uint32_t serverMs){
+
38  server_ms = serverMs;
+
39  }
+
40 };
+
41 
+
42 
+
43 inline void checkHeap() {
+
44 #if CONFIG_CHECK_HEAP && defined(ESP32)
+
45  heap_caps_check_integrity_all(true);
+
46 #endif
+
47 }
+
48 
+
49 inline void logHeap() {
+
50 #ifdef ESP32
+
51  ESP_LOGD(TAG, "Free Heap: %d / Free Heap PSRAM %d", ESP.getFreeHeap(),
+
52  ESP.getFreePsram());
+
53 #endif
+
54 }
+
55 
+
56 }
+
snap_arduino
Definition: SnapCommon.h:10
+
snap_arduino::SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:21
+
snap_arduino::SnapTimePoints
Recording of local_ms and server_ms.
Definition: SnapCommon.h:33
diff --git a/docs/html/_snap_config_8h_source.html b/docs/html/_snap_config_8h_source.html index afc5a09..ceb7fe8 100644 --- a/docs/html/_snap_config_8h_source.html +++ b/docs/html/_snap_config_8h_source.html @@ -73,58 +73,71 @@
2 
3 // activate extended functionality
4 
-
5 #ifndef CONFIG_USE_PSRAM
-
6 # define CONFIG_USE_PSRAM true
+
5 #ifndef CONFIG_SNAPCLIENT_SNTP_ENABLE
+
6 # define CONFIG_SNAPCLIENT_SNTP_ENABLE false
7 #endif
-
8 #ifndef CONFIG_PSRAM_LIMIT
-
9 # define CONFIG_PSRAM_LIMIT 512
+
8 #ifndef CONFIG_SNAPCLIENT_USE_MDNS
+
9 # define CONFIG_SNAPCLIENT_USE_MDNS true
10 #endif
-
11 #ifndef CONFIG_SNAPCLIENT_SNTP_ENABLE
-
12 # define CONFIG_SNAPCLIENT_SNTP_ENABLE false
+
11 #ifndef CONFIG_NVS_FLASH
+
12 # define CONFIG_NVS_FLASH false
13 #endif
-
14 #ifndef CONFIG_SNAPCLIENT_USE_MDNS
-
15 # define CONFIG_SNAPCLIENT_USE_MDNS true
+
14 #ifndef CONFIG_CHECK_HEAP
+
15 # define CONFIG_CHECK_HEAP false
16 #endif
-
17 #ifndef CONFIG_NVS_FLASH
-
18 # define CONFIG_NVS_FLASH false
-
19 #endif
-
20 #ifndef CONFIG_CHECK_HEAP
-
21 # define CONFIG_CHECK_HEAP false
-
22 #endif
-
23 
-
24 // snapcast parameters;
-
25 #ifndef CONFIG_SNAPCAST_SERVER_HOST
-
26 # define CONFIG_SNAPCAST_SERVER_HOST "192.168.1.38"
+
17 
+
18 // snapcast parameters;
+
19 #ifndef CONFIG_SNAPCAST_SERVER_HOST
+
20 # define CONFIG_SNAPCAST_SERVER_HOST "192.168.1.33"
+
21 #endif
+
22 #ifndef CONFIG_SNAPCAST_SERVER_PORT
+
23 # define CONFIG_SNAPCAST_SERVER_PORT 1704
+
24 #endif
+
25 #ifndef CONFIG_SNAPCAST_BUFF_LEN
+
26 # define CONFIG_SNAPCAST_BUFF_LEN 1024
27 #endif
-
28 #ifndef CONFIG_SNAPCAST_SERVER_PORT
-
29 # define CONFIG_SNAPCAST_SERVER_PORT 1704
+
28 #ifndef CONFIG_SNAPCAST_CLIENT_NAME
+
29 # define CONFIG_SNAPCAST_CLIENT_NAME "arduino-snapclient"
30 #endif
-
31 #ifndef CONFIG_SNAPCAST_BUFF_LEN
-
32 # define CONFIG_SNAPCAST_BUFF_LEN 1024
+
31 #ifndef CONFIG_SNTP_SERVER
+
32 # define CONFIG_SNTP_SERVER "pool.ntp.org"
33 #endif
-
34 #ifndef CONFIG_SNAPCAST_CLIENT_NAME
-
35 # define CONFIG_SNAPCAST_CLIENT_NAME "arduino-snapclient"
+
34 #ifndef CONFIG_CLIENT_TIMEOUT_SEC
+
35 # define CONFIG_CLIENT_TIMEOUT_SEC 5
36 #endif
-
37 #ifndef CONFIG_SNTP_SERVER
-
38 # define CONFIG_SNTP_SERVER "pool.ntp.org"
+
37 #ifndef CONFIG_PROCESSING_TIME_MS
+
38 # define CONFIG_PROCESSING_TIME_MS -172
39 #endif
-
40 #ifndef CONFIG_CLIENT_TIMEOUT_SEC
-
41 # define CONFIG_CLIENT_TIMEOUT_SEC 5
+
40 #ifndef CONFIG_STREAMIN_DECODER_BUFFER
+
41 # define CONFIG_STREAMIN_DECODER_BUFFER (12 * 1024)
42 #endif
-
43 #ifndef CONFIG_PROCESSING_TIME_MS
-
44 # define CONFIG_PROCESSING_TIME_MS 172
-
45 #endif
-
46 #ifndef CONFIG_STREAMIN_DECODER_BUFFER
-
47 # define CONFIG_STREAMIN_DECODER_BUFFER (12 * 1024)
-
48 #endif
-
49 
-
50 // wifi
-
51 #ifndef CONFIG_WIFI_SSID
-
52 # define CONFIG_WIFI_SSID "piratnet"
-
53 #endif
-
54 #ifndef CONFIG_WIFI_PASSWORD
-
55 # define CONFIG_WIFI_PASSWORD "12341234"
-
56 #endif
+
43 
+
44 // wifi
+
45 #ifndef CONFIG_WIFI_SSID
+
46 # define CONFIG_WIFI_SSID "piratnet"
+
47 #endif
+
48 #ifndef CONFIG_WIFI_PASSWORD
+
49 # define CONFIG_WIFI_PASSWORD "12341234"
+
50 #endif
+
51 
+
52 // FreeRTOS - max number of entries in the queue
+
53 #ifndef RTOS_MAX_QUEUE_ENTRY_COUNT
+
54 # define RTOS_MAX_QUEUE_ENTRY_COUNT 200
+
55 #endif
+
56 
+
57 #ifndef RTOS_STACK_SIZE
+
58 # define RTOS_STACK_SIZE 10 * 1024
+
59 #endif
+
60 
+
61 #ifndef RTOS_TASK_PRIORITY
+
62 # define RTOS_TASK_PRIORITY 2
+
63 #endif
+
64 
+
65 #ifndef SNAP_NO_NAMESPACE
+
66 namespace snap_arduino {}
+
67 using namespace snap_arduino;
+
68 #endif
+
snap_arduino
Definition: SnapCommon.h:10
diff --git a/docs/html/_snap_logger_8h_source.html b/docs/html/_snap_logger_8h_source.html index 3847662..4dc04dc 100644 --- a/docs/html/_snap_logger_8h_source.html +++ b/docs/html/_snap_logger_8h_source.html @@ -75,12 +75,13 @@
7 #ifdef ESP32
8 # include "esp_log.h"
9 #else
-
10 # define DEFAULT_LOG(...) fprintf(stderr,"[%s] ", __PRETTY_FUNCTION__);fprintf(stderr, __VA_ARGS__);fputc('\n',stderr)
-
11 # define ESP_LOGE(tag, ...) DEFAULT_LOG(__VA_ARGS__)
-
12 # define ESP_LOGW(tag, ...) DEFAULT_LOG(__VA_ARGS__)
-
13 # define ESP_LOGI(tag, ...) DEFAULT_LOG(__VA_ARGS__)
-
14 # define ESP_LOGD(tag, ...)
-
15 #endif
+
10 static char msg[100] = ": ";
+
11 # define DEFAULT_LOG(...) { Serial.print(__PRETTY_FUNCTION__); snprintf((char*)msg+2, 100, __VA_ARGS__); Serial.println(msg); }
+
12 # define ESP_LOGE(tag, ...) DEFAULT_LOG(__VA_ARGS__)
+
13 # define ESP_LOGW(tag, ...) DEFAULT_LOG(__VA_ARGS__)
+
14 # define ESP_LOGI(tag, ...) //DEFAULT_LOG(__VA_ARGS__)
+
15 # define ESP_LOGD(tag, ...) //DEFAULT_LOG(__VA_ARGS__)
+
16 #endif
diff --git a/docs/html/_snap_output_8h_source.html b/docs/html/_snap_output_8h_source.html index cd6d54f..4521bec 100644 --- a/docs/html/_snap_output_8h_source.html +++ b/docs/html/_snap_output_8h_source.html @@ -82,261 +82,286 @@
11 #include "SnapTime.h"
12 #include "SnapTimeSync.h"
13 
-
14 class SnapProcessor;
-
15 class SnapProcessorRTOS;
-
16 
-
26 class SnapOutput : public AudioInfoSupport {
-
27  friend SnapProcessor;
-
28  friend SnapProcessorRTOS;
-
29 
-
30  public:
-
31  SnapOutput() = default;
-
32 
-
35  virtual bool begin() {
-
36  ESP_LOGI(TAG, "begin");
-
37  is_sync_started = false;
-
38  return audioBegin();
-
39  }
-
40 
-
42  virtual size_t write(const uint8_t *data, size_t size) {
-
43  ESP_LOGD(TAG, "%zu", size);
-
44  // only start to proces data after we received codec header
-
45  if (!is_audio_begin_called) {
-
46  ESP_LOGI(TAG, "not started");
-
47  return 0;
-
48  }
-
49 
-
50  if (!synchronizePlayback()) {
-
51  return size;
-
52  }
-
53 
-
54  return audioWrite(data, size);
-
55  }
-
56 
-
58  virtual bool writeHeader(SnapAudioHeader &header) {
-
59  this->header = header;
-
60  return true;
-
61  }
-
62 
-
64  virtual void end(void) {}
-
65 
-
67  void setVolume(float vol) {
-
68  this->vol = vol / 100.0;
-
69  ESP_LOGI(TAG, "Volume: %f", this->vol);
-
70  vol_stream.setVolume(this->vol * vol_factor);
-
71  }
-
72 
-
74  float volume() { return vol; }
-
75 
-
77  void setMute(bool mute) {
-
78  is_mute = mute;
-
79  vol_stream.setVolume(mute ? 0 : vol);
-
80  audioWriteSilence();
-
81  }
-
82 
-
84  bool isMute() { return is_mute; }
-
85 
-
87  void setVolumeFactor(float fact) { vol_factor = fact; }
-
88 
-
90  void setOutput(AudioOutput &output) {
-
91  this->out = &output; // final output
-
92  resample.setStream(output);
-
93  vol_stream.setStream(resample); // adjust volume
-
94  timed_stream.setStream(vol_stream);
-
95  decoder_stream.setStream(&timed_stream); // decode to pcm
-
96  }
-
97 
-
98  AudioOutput &getOutput() { return *out; }
-
99 
-
101  void setDecoder(AudioDecoder &dec) { decoder_stream.setDecoder(&dec); }
-
102 
-
103  AudioDecoder &getDecoder() { return decoder_stream.decoder(); }
-
104 
-
106  void setAudioInfo(AudioInfo info) {
-
107  ESP_LOGI(TAG, "sample_rate: %d, channels: %d, bits: %d", info.sample_rate,
-
108  info.channels, info.bits_per_sample);
-
109  audio_info = info;
-
110  if (is_audio_begin_called) {
-
111  vol_stream.setAudioInfo(info);
-
112  out->setAudioInfo(info);
-
113  timed_stream.setAudioInfo(info);
-
114  }
-
115  }
-
116 
-
117  AudioInfo audioInfo() { return audio_info; }
-
118 
-
120  void setSnapTimeSync(SnapTimeSync &timeSync) { p_snap_time_sync = &timeSync; }
+
14 namespace snap_arduino {
+
15 
+
16 class SnapProcessor;
+
17 
+
27 class SnapOutput : public AudioInfoSupport {
+
28 
+
29  public:
+
30  SnapOutput() = default;
+
31 
+
34  virtual bool begin() {
+
35  ESP_LOGI(TAG, "begin");
+
36  is_sync_started = false;
+
37  return audioBegin();
+
38  }
+
39 
+
41  virtual size_t write(const uint8_t *data, size_t size) {
+
42  ESP_LOGD(TAG, "%zu", size);
+
43  // only start to proces data after we received codec header
+
44  if (!is_audio_begin_called) {
+
45  ESP_LOGI(TAG, "not started");
+
46  return 0;
+
47  }
+
48 
+
49  if (!synchronizePlayback()) {
+
50  return size;
+
51  }
+
52 
+
53  return audioWrite(data, size);
+
54  }
+
55 
+
57  virtual bool writeHeader(SnapAudioHeader &header) {
+
58  this->header = header;
+
59  return true;
+
60  }
+
61 
+
63  virtual void end(void) {}
+
64 
+
66  void setVolume(float vol) {
+
67  this->vol = vol;
+
68  ESP_LOGI(TAG, "Volume: %f", this->vol);
+
69  vol_stream.setVolume(this->vol * vol_factor);
+
70  }
+
71 
+
73  float volume() { return vol; }
+
74 
+
76  void setMute(bool mute) {
+
77  is_mute = mute;
+
78  setVolume(mute ? 0.0f : vol);
+
79  audioWriteSilence();
+
80  }
+
81 
+
83  bool isMute() { return is_mute; }
+
84 
+
86  void setVolumeFactor(float fact) { vol_factor = fact; }
+
87 
+
89  void setOutput(AudioOutput &output) {
+
90  this->out = &output; // final output
+
91  resample.setOutput(output);
+
92  vol_stream.setStream(resample); // adjust volume
+
93  decoder_stream.setStream(&vol_stream); // decode to pcm
+
94 
+
95  // synchronized audio information
+
96  AudioInfo info = output.audioInfo();
+
97  resample.begin(info, info);
+
98  vol_stream.setAudioInfo(info);
+
99  decoder_stream.setAudioInfo(info);
+
100  }
+
101 
+
102  AudioOutput &getOutput() { return *out; }
+
103 
+
105  void setDecoder(AudioDecoder &dec) { decoder_stream.setDecoder(&dec); }
+
106 
+
107  AudioDecoder &getDecoder() { return decoder_stream.decoder(); }
+
108 
+
110  void setAudioInfo(AudioInfo info) {
+
111  ESP_LOGI(TAG, "sample_rate: %d, channels: %d, bits: %d", info.sample_rate,
+
112  info.channels, info.bits_per_sample);
+
113  audio_info = info;
+
114  if (is_audio_begin_called) {
+
115  vol_stream.setAudioInfo(info);
+
116  out->setAudioInfo(info);
+
117  }
+
118  }
+
119 
+
120  AudioInfo audioInfo() { return audio_info; }
121 
-
122  SnapTimeSync &snapTimeSync() { return *p_snap_time_sync; }
-
123 
-
124  bool isStarted() { return is_audio_begin_called; }
-
125 
-
126  protected:
-
127  const char *TAG = "SnapOutput";
-
128  AudioOutput *out = nullptr;
-
129  AudioInfo audio_info;
-
130  EncodedAudioStream decoder_stream;
-
131  VolumeStream vol_stream;
-
132  ResampleStream resample;
-
133  TimedStream timed_stream;
-
134  float vol = 1.0; // volume in the range 0.0 - 1.0
-
135  float vol_factor = 1.0; //
-
136  bool is_mute = false;
-
137  SnapAudioHeader header;
-
138  SnapTime &snap_time = SnapTime::instance();
-
139  SnapTimeSyncDynamic time_sync_default;
-
140  SnapTimeSync *p_snap_time_sync = &time_sync_default;
-
141  bool is_sync_started = false;
-
142  bool is_audio_begin_called = false;
-
143 
-
145  bool audioBegin() {
-
146  if (out == nullptr) {
-
147  ESP_LOGI(TAG, "out is null");
-
148  return false;
-
149  }
-
150 
-
151  // open volume control: allow amplification
-
152  auto vol_cfg = vol_stream.defaultConfig();
-
153  vol_cfg.copyFrom(audio_info);
-
154  vol_cfg.allow_boost = true;
-
155  vol_stream.begin(vol_cfg);
-
156 
-
157  // open final output
-
158  out->setAudioInfo(audio_info);
-
159  out->begin();
+
123  void setSnapTimeSync(SnapTimeSync &timeSync) { p_snap_time_sync = &timeSync; }
+
124 
+
125  SnapTimeSync &snapTimeSync() { return *p_snap_time_sync; }
+
126 
+
127  bool isStarted() { return is_audio_begin_called; }
+
128 
+
129  // writes the audio data to the decoder
+
130  size_t audioWrite(const void *src, size_t size) {
+
131  ESP_LOGI(TAG, "audioWrite: %zu", size);
+
132  time_last_write = millis();
+
133  size_t result = decoder_stream.write((const uint8_t *)src, size);
+
134  if (result != size){
+
135  ESP_LOGW(TAG, "Could not write all data %zu -> %zu", size, result);
+
136  }
+
137 
+
138  return result;
+
139  }
+
140 
+
143  bool synchronizePlayback() {
+
144  bool result = true;
+
145  assert(p_snap_time_sync!=nullptr);
+
146 
+
147  SnapTimeSync &ts = *p_snap_time_sync;
+
148 
+
149  // calculate how long we need to wait to playback the audio
+
150  auto delay_ms = getDelayMs();
+
151 
+
152  if (!is_sync_started) {
+
153  ts.begin(audio_info.sample_rate);
+
154 
+
155  // start audio when first package in the future becomes valid
+
156  result = synchronizeOnStart(delay_ms);
+
157  } else {
+
158  // provide the actual delay to the synch
+
159  ts.updateActualDelay(delay_ms);
160 
-
161  // open decoder
-
162  auto dec_cfg = decoder_stream.defaultConfig();
-
163  dec_cfg.copyFrom(audio_info);
-
164  decoder_stream.begin(dec_cfg);
-
165  decoder_stream.setNotifyAudioChange(*this);
-
166 
-
167  // open resampler
-
168  auto res_cfg = resample.defaultConfig();
-
169  res_cfg.step_size = 1.009082;
-
170  res_cfg.copyFrom(audio_info);
-
171  resample.begin(res_cfg);
+
161  if (ts.isSync()) {
+
162  // update speed
+
163  float current_factor = playbackFactor();
+
164  float new_factor = p_snap_time_sync->getFactor();
+
165  if (new_factor != current_factor) {
+
166  setPlaybackFactor(new_factor);
+
167  }
+
168  }
+
169  }
+
170  return result;
+
171  }
172 
-
173  // set up timed stream
-
174  timed_stream.begin(audio_info);
-
175 
-
176  ESP_LOGD(TAG, "end");
-
177  is_audio_begin_called = true;
-
178  return true;
-
179  }
-
180 
-
182  void setPlaybackFactor(float fact) { resample.setStepSize(fact); }
-
183 
-
185  float playbackFactor() { return resample.getStepSize(); }
-
186 
-
187  void audioWriteSilence() {
-
188  for (int j = 0; j < 50; j++) {
-
189  out->writeSilence(1024);
-
190  }
-
191  }
-
192 
-
193  void audioEnd() {
-
194  ESP_LOGD(TAG, "start");
-
195  if (out == nullptr) return;
-
196  out->end();
-
197  }
+
173  uint64_t getLastWriteTime() {
+
174  return time_last_write;
+
175  }
+
176 
+
178  bool isActive(uint16_t timeout=1000){
+
179  return (time_last_write + timeout) >= millis();
+
180  }
+
181 
+
182  protected:
+
183  const char *TAG = "SnapOutput";
+
184  AudioOutput *out = nullptr;
+
185  AudioInfo audio_info;
+
186  EncodedAudioStream decoder_stream;
+
187  VolumeStream vol_stream;
+
188  ResampleStream resample;
+
189  float vol = 1.0; // volume in the range 0.0 - 1.0
+
190  float vol_factor = 1.0; //
+
191  bool is_mute = false;
+
192  SnapAudioHeader header;
+
193  SnapTime &snap_time = SnapTime::instance();
+
194  SnapTimeSync *p_snap_time_sync = nullptr;
+
195  bool is_sync_started = false;
+
196  bool is_audio_begin_called = false;
+
197  uint64_t time_last_write = 0;
198 
-
199  // writes the audio data to the decoder
-
200  size_t audioWrite(const void *src, size_t size) {
-
201  ESP_LOGD(TAG, "%zu", size);
-
202  size_t result = decoder_stream.write((const uint8_t *)src, size);
-
203 
-
204  return result;
-
205  }
-
206 
-
209  bool synchronizePlayback() {
-
210  bool result = true;
-
211  SnapTimeSync &ts = *p_snap_time_sync;
+
200  bool audioBegin() {
+
201  if (out == nullptr) {
+
202  ESP_LOGI(TAG, "out is null");
+
203  return false;
+
204  }
+
205  if (p_snap_time_sync==nullptr){
+
206  ESP_LOGI(TAG, "p_snap_time_sync is null");
+
207  return false;
+
208  }
+
209 
+
210  // determine default audio info from output
+
211  audio_info = out->audioInfo();
212 
-
213  // calculate how long we need to wait to playback the audio
-
214  auto delay_ms = getDelayMs();
-
215 
-
216  if (!is_sync_started) {
-
217  ts.begin(audio_info.sample_rate);
-
218 
-
219  // start audio when first package in the future becomes valid
-
220  result = synchronizeOnStart(delay_ms);
-
221  } else {
-
222  // provide the actual delay to the synch
-
223  ts.updateActualDelay(delay_ms);
-
224 
-
225  if (ts.isSync()) {
-
226  // update speed
-
227  float current_factor = playbackFactor();
-
228  float new_factor = p_snap_time_sync->getFactor();
-
229  if (new_factor != current_factor) {
-
230  setPlaybackFactor(new_factor);
-
231  }
-
232  }
-
233  }
-
234  return result;
-
235  }
-
236 
-
237  bool synchronizeOnStart(int delay_ms) {
-
238  bool result = true;
-
239  if (delay_ms < 0) {
-
240  // ignore the data and report it as processed
-
241  ESP_LOGW(TAG, "audio data expired: delay %d", delay_ms);
-
242  result = false;
-
243  } else if (delay_ms > 100000) {
-
244  ESP_LOGW(TAG, "invalid delay: %d ms", delay_ms);
-
245  result = false;
-
246  } else {
-
247  // wait for the audio to become valid
-
248  ESP_LOGI(TAG, "starting after %d ms", delay_ms);
-
249  // replaced delay(delay_ms); with timed_stream
-
250  timed_stream.setStartMs(delay_ms);
-
251  is_sync_started = true;
-
252  result = true;
-
253  }
-
254  return result;
-
255  }
-
256 
-
258  int getDelayMs() {
-
259  auto msg_time = snap_time.toMillis(header.sec, header.usec);
-
260  auto server_time = snap_time.serverMillis();
-
261  // wait for the audio to become valid
-
262  int diff_ms = msg_time - server_time;
-
263  int delay_ms = diff_ms + p_snap_time_sync->getStartDelay();
-
264  return delay_ms;
-
265  }
-
266 };
-
SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:26
-
SnapOutput::getDelayMs
int getDelayMs()
Calculate the delay in ms.
Definition: SnapOutput.h:258
-
SnapOutput::volume
float volume()
provides the actual volume
Definition: SnapOutput.h:74
-
SnapOutput::setMute
void setMute(bool mute)
mute / unmute
Definition: SnapOutput.h:77
-
SnapOutput::setVolume
void setVolume(float vol)
Adjust the volume.
Definition: SnapOutput.h:67
-
SnapOutput::begin
virtual bool begin()
Definition: SnapOutput.h:35
-
SnapOutput::setAudioInfo
void setAudioInfo(AudioInfo info)
setup of all audio objects
Definition: SnapOutput.h:106
-
SnapOutput::write
virtual size_t write(const uint8_t *data, size_t size)
Writes audio data to the queue.
Definition: SnapOutput.h:42
-
SnapOutput::playbackFactor
float playbackFactor()
determine actual playback speed
Definition: SnapOutput.h:185
-
SnapOutput::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapOutput.h:101
-
SnapOutput::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapOutput.h:87
-
SnapOutput::writeHeader
virtual bool writeHeader(SnapAudioHeader &header)
Provides info about the audio data.
Definition: SnapOutput.h:58
-
SnapOutput::setPlaybackFactor
void setPlaybackFactor(float fact)
to speed up or slow down playback
Definition: SnapOutput.h:182
-
SnapOutput::setOutput
void setOutput(AudioOutput &output)
Defines the audio output chain to the final output.
Definition: SnapOutput.h:90
-
SnapOutput::isMute
bool isMute()
checks if volume is mute
Definition: SnapOutput.h:84
-
SnapOutput::synchronizePlayback
bool synchronizePlayback()
Definition: SnapOutput.h:209
-
SnapOutput::audioBegin
bool audioBegin()
setup of all audio objects
Definition: SnapOutput.h:145
-
SnapOutput::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapOutput.h:120
-
SnapOutput::end
virtual void end(void)
Ends the processing and releases the memory.
Definition: SnapOutput.h:64
-
SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:19
-
SnapProcessorRTOS
Definition: SnapProcessorRTOS.h:9
-
SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:16
-
SnapTime::serverMillis
uint32_t serverMillis()
Provides the current server time in ms.
Definition: SnapTime.h:36
-
SnapTimeSyncDynamic
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:86
-
SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:15
-
SnapTimeSync::updateActualDelay
virtual void updateActualDelay(int delay)
Records the actual playback delay (currently not used)
Definition: SnapTimeSync.h:31
-
SnapTimeSync::begin
void begin(int rate)
Starts the processing.
Definition: SnapTimeSync.h:23
-
SnapTimeSync::getFactor
virtual float getFactor()=0
-
SnapTimeSync::getStartDelay
int getStartDelay()
Definition: SnapTimeSync.h:60
-
SnapTimeSync::isSync
bool isSync()
Returns true if a synchronization (update of the sampling rate) is needed.
Definition: SnapTimeSync.h:38
-
SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:19
+
213  // open volume control: allow amplification
+
214  auto vol_cfg = vol_stream.defaultConfig();
+
215  vol_cfg.copyFrom(audio_info);
+
216  vol_cfg.allow_boost = true;
+
217  vol_stream.begin(vol_cfg);
+
218  vol_stream.setVolume(vol * vol_factor);
+
219 
+
220  // open final output
+
221  out->setAudioInfo(audio_info);
+
222  out->begin();
+
223 
+
224  // open decoder
+
225  auto dec_cfg = decoder_stream.defaultConfig();
+
226  dec_cfg.copyFrom(audio_info);
+
227  decoder_stream.begin(dec_cfg);
+
228  decoder_stream.addNotifyAudioChange(*this);
+
229 
+
230  // open resampler
+
231  auto res_cfg = resample.defaultConfig();
+
232  res_cfg.step_size = p_snap_time_sync->getFactor();
+
233  res_cfg.copyFrom(audio_info);
+
234  resample.begin(res_cfg);
+
235 
+
236  ESP_LOGD(TAG, "end");
+
237  is_audio_begin_called = true;
+
238  return true;
+
239  }
+
240 
+
242  void setPlaybackFactor(float fact) { resample.setStepSize(fact); }
+
243 
+
245  float playbackFactor() { return resample.getStepSize(); }
+
246 
+
247  void audioWriteSilence() {
+
248  for (int j = 0; j < 50; j++) {
+
249  out->writeSilence(1024);
+
250  }
+
251  }
+
252 
+
253  void audioEnd() {
+
254  ESP_LOGD(TAG, "audioEnd");
+
255  if (out == nullptr) return;
+
256  out->end();
+
257  }
+
258 
+
259 
+
260  bool synchronizeOnStart(int delay_ms) {
+
261  bool result = true;
+
262  if (delay_ms < 0) {
+
263  // ignore the data and report it as processed
+
264  ESP_LOGW(TAG, "audio data expired: delay %d", delay_ms);
+
265  result = false;
+
266  } else if (delay_ms > 100000) {
+
267  ESP_LOGW(TAG, "invalid delay: %d ms", delay_ms);
+
268  result = false;
+
269  } else {
+
270  // wait for the audio to become valid
+
271  ESP_LOGI(TAG, "starting after %d ms", delay_ms);
+
272  assert(p_snap_time_sync!=nullptr);
+
273  setPlaybackFactor(p_snap_time_sync->getFactor());
+
274  is_sync_started = true;
+
275  result = true;
+
276  }
+
277  return result;
+
278  }
+
279 
+
281  int getDelayMs() {
+
282  assert(p_snap_time_sync!=nullptr);
+
283  auto msg_time = snap_time.toMillis(header.sec, header.usec);
+
284  auto server_time = snap_time.serverMillis();
+
285  // wait for the audio to become valid
+
286  int diff_ms = msg_time - server_time;
+
287  int delay_ms = diff_ms + p_snap_time_sync->getStartDelay();
+
288  return delay_ms;
+
289  }
+
290 };
+
291 
+
292 }
+
snap_arduino::SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:27
+
snap_arduino::SnapOutput::getDelayMs
int getDelayMs()
Calculate the delay in ms.
Definition: SnapOutput.h:281
+
snap_arduino::SnapOutput::volume
float volume()
provides the actual volume
Definition: SnapOutput.h:73
+
snap_arduino::SnapOutput::setMute
void setMute(bool mute)
mute / unmute
Definition: SnapOutput.h:76
+
snap_arduino::SnapOutput::setVolume
void setVolume(float vol)
Adjust the volume.
Definition: SnapOutput.h:66
+
snap_arduino::SnapOutput::begin
virtual bool begin()
Definition: SnapOutput.h:34
+
snap_arduino::SnapOutput::setAudioInfo
void setAudioInfo(AudioInfo info)
setup of all audio objects
Definition: SnapOutput.h:110
+
snap_arduino::SnapOutput::write
virtual size_t write(const uint8_t *data, size_t size)
Writes audio data to the queue.
Definition: SnapOutput.h:41
+
snap_arduino::SnapOutput::playbackFactor
float playbackFactor()
determine actual playback speed
Definition: SnapOutput.h:245
+
snap_arduino::SnapOutput::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapOutput.h:105
+
snap_arduino::SnapOutput::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapOutput.h:86
+
snap_arduino::SnapOutput::writeHeader
virtual bool writeHeader(SnapAudioHeader &header)
Provides info about the audio data.
Definition: SnapOutput.h:57
+
snap_arduino::SnapOutput::setPlaybackFactor
void setPlaybackFactor(float fact)
to speed up or slow down playback
Definition: SnapOutput.h:242
+
snap_arduino::SnapOutput::setOutput
void setOutput(AudioOutput &output)
Defines the audio output chain to the final output.
Definition: SnapOutput.h:89
+
snap_arduino::SnapOutput::isMute
bool isMute()
checks if volume is mute
Definition: SnapOutput.h:83
+
snap_arduino::SnapOutput::synchronizePlayback
bool synchronizePlayback()
Definition: SnapOutput.h:143
+
snap_arduino::SnapOutput::audioBegin
bool audioBegin()
setup of all audio objects
Definition: SnapOutput.h:200
+
snap_arduino::SnapOutput::setSnapTimeSync
void setSnapTimeSync(SnapTimeSync &timeSync)
Defines the time synchronization logic.
Definition: SnapOutput.h:123
+
snap_arduino::SnapOutput::isActive
bool isActive(uint16_t timeout=1000)
checks if the audio is still playing
Definition: SnapOutput.h:178
+
snap_arduino::SnapOutput::end
virtual void end(void)
Ends the processing and releases the memory.
Definition: SnapOutput.h:63
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:22
+
snap_arduino::SnapTime::serverMillis
uint32_t serverMillis()
Provides the current server time in ms.
Definition: SnapTime.h:42
+
snap_arduino::SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:17
+
snap_arduino::SnapTimeSync::updateActualDelay
virtual void updateActualDelay(int delay)
Records the actual playback delay (currently not used)
Definition: SnapTimeSync.h:33
+
snap_arduino::SnapTimeSync::begin
void begin(int rate)
Starts the processing.
Definition: SnapTimeSync.h:25
+
snap_arduino::SnapTimeSync::getFactor
virtual float getFactor()=0
+
snap_arduino::SnapTimeSync::getStartDelay
int getStartDelay()
Definition: SnapTimeSync.h:62
+
snap_arduino::SnapTimeSync::isSync
bool isSync()
Returns true if a synchronization (update of the sampling rate) is needed.
Definition: SnapTimeSync.h:40
+
snap_arduino
Definition: SnapCommon.h:10
+
snap_arduino::SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:21
diff --git a/docs/html/_snap_processor_8h_source.html b/docs/html/_snap_processor_8h_source.html index 50c6a1a..04514b8 100644 --- a/docs/html/_snap_processor_8h_source.html +++ b/docs/html/_snap_processor_8h_source.html @@ -80,554 +80,663 @@
9 #include "SnapTime.h"
10 #include "vector"
11 
-
19 class SnapProcessor {
-
20 public:
-
21  SnapProcessor(SnapOutput &output) {
-
22  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
-
23  p_snap_output = &output;
-
24  }
-
25 
-
26  SnapProcessor() {
-
27  // default setup
-
28  static SnapOutput snap_output;
-
29  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
-
30  p_snap_output = &snap_output;
-
31  }
-
32 
-
33  virtual bool begin() {
-
34  bool result = false;
-
35  if (output_start) {
-
36  result = audioBegin();
-
37  }
-
38 
-
39  if (http_task_start) {
-
40  last_time_sync = 0;
-
41  id_counter = 0;
-
42  resizeData();
-
43  }
-
44  header_received = false;
-
45 
-
46  return result;
-
47  }
-
48 
-
49  virtual void end() {
-
50  ESP_LOGD(TAG, "end");
-
51  audioEnd();
-
52  // ESP_LOGI(TAG, "... done reading from socket");
-
53  p_client->stop();
-
54  send_receive_buffer.resize(0);
-
55  base_message_serialized.resize(0);
-
56  }
-
57 
-
58  void setServerIP(IPAddress address) { server_ip = address; }
-
59 
-
60  void setServerPort(int port) { server_port = port; }
-
61 
-
62  void setMacAddress(const char *adr) { mac_address = adr; }
-
63 
-
64  tv_t getLatency() { return time_message.latency; }
-
65 
-
66  void setStartOutput(bool start) { output_start = start; }
-
67  void setStartTask(bool flag) { http_task_start = flag; }
-
68 
-
70  virtual void doLoop() { processLoopStep(); }
+
12 namespace snap_arduino {
+
13 
+
21 class SnapProcessor {
+
22 public:
+
23  SnapProcessor(SnapOutput &output) {
+
24  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
25  p_snap_output = &output;
+
26  }
+
27 
+
28  SnapProcessor() {
+
29  // default setup
+
30  static SnapOutput snap_output;
+
31  server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST);
+
32  p_snap_output = &snap_output;
+
33  }
+
34 
+
36  virtual bool begin() {
+
37  bool result = true;
+
38  // start output chain
+
39  if (output_start) {
+
40  result = audioBegin();
+
41  }
+
42 
+
43  // connect to snapcast server
+
44  if(!connectClient()){
+
45  result = false;
+
46  }
+
47 
+
48  if (http_task_start) {
+
49  last_time_sync = 0;
+
50  id_counter = 0;
+
51  resizeData();
+
52  }
+
53  header_received = false;
+
54  loop_status = LoopStart;
+
55 
+
56  return result;
+
57  }
+
58 
+
59  virtual void end() {
+
60  ESP_LOGD(TAG, "end");
+
61  audioEnd();
+
62  // ESP_LOGI(TAG, "... done reading from socket");
+
63  p_client->stop();
+
64  send_receive_buffer.resize(0);
+
65  base_message_serialized.resize(0);
+
66  }
+
67 
+
68  void setServerIP(IPAddress address) { server_ip = address; }
+
69 
+
70  void setServerPort(int port) { server_port = port; }
71 
-
73  void setOutput(AudioOutput &output) { p_snap_output->setOutput(output); }
-
74 
-
76  void setDecoder(AudioDecoder &dec) { p_snap_output->setDecoder(dec); }
+
72  void setMacAddress(const char *adr) { mac_address = adr; }
+
73 
+
74  tv_t getLatency() { return time_message.latency; }
+
75 
+
76  void setStartOutput(bool start) { output_start = start; }
77 
-
79  float volume(void) { return p_snap_output->volume(); }
-
80 
-
82  void setVolumeFactor(float fact) { p_snap_output->setVolumeFactor(fact); }
-
83 
-
85  void setSnapOutput(SnapOutput &out) { p_snap_output = &out; }
-
86 
-
87  SnapOutput &snapOutput() { return *p_snap_output; }
-
88 
-
90  void setClient(Client &client) { p_client = &client; }
-
91 
-
92  void setAudioInfo(AudioInfo info) {
-
93  p_snap_output->setAudioInfo(info);
-
94  }
+
78  void setStartTask(bool flag) { http_task_start = flag; }
+
79 
+
81  bool doLoop() {
+
82  if (is_fast_loop)
+
83  return processLoopStepFast();
+
84  else
+
85  return processLoopStep();
+
86  }
+
87 
+
89  virtual bool doLoop1() {
+
90  return false;
+
91  }
+
92 
+
94  void setOutput(AudioOutput &output) { p_snap_output->setOutput(output); }
95 
-
96 protected:
-
97  const char *TAG = "SnapProcessor";
-
98  // WiFiClient default_client;
-
99  Client *p_client = nullptr;
-
100  SnapOutput *p_snap_output = nullptr;
-
101  std::vector<int16_t> audio;
-
102  std::vector<char> send_receive_buffer;
-
103  std::vector<char> base_message_serialized;
-
104  int16_t frame_size = 512;
-
105  uint16_t channels = 2;
-
106  codec_type codec_from_server = NO_CODEC;
-
107  SnapMessageBase base_message;
-
108  SnapMessageTime time_message;
-
109  uint32_t client_state_muted = 0;
-
110  char *start = nullptr;
-
111  int size = 0;
-
112  timeval now;
-
113  uint64_t last_time_sync = 0;
-
114  int id_counter = 0;
-
115  IPAddress server_ip;
-
116  int server_port = CONFIG_SNAPCAST_SERVER_PORT;
-
117  const char *mac_address = "00-00-00-00-00";
-
118  bool output_start = false;
-
119  bool http_task_start = true;
-
120  bool header_received = false;
-
121  bool is_time_set = false;
-
122  SnapTime &snap_time = SnapTime::instance();
-
123 
-
124  bool processLoopStep() {
-
125  if (connectClient()) {
-
126  ESP_LOGI(TAG, "... connected");
-
127  } else {
-
128  delay(10);
-
129  return true;
-
130  }
-
131 
-
132  now = snap_time.time();
-
133 
-
134  if (!writeHallo()){
-
135  ESP_LOGI(TAG, "writeHallo");
-
136  return false;
-
137  }
-
138 
-
139  bool rc = true;
-
140  while (rc) {
-
141  rc = processMessageLoop();
-
142  logHeap();
-
143  checkHeap();
-
144  }
-
145 
-
146  // ESP_LOGI(TAG, "... done reading from socket");
-
147  // p_client->stop();
-
148 
-
149  if (id_counter % 100 == 0) {
-
150  logHeap();
-
151  }
-
152  checkHeap();
-
153  delay(1);
-
154  return true;
-
155  }
-
156 
-
157  bool resizeData() {
-
158  audio.resize(frame_size);
-
159  send_receive_buffer.resize(CONFIG_SNAPCAST_BUFF_LEN);
-
160  base_message_serialized.resize(BASE_MESSAGE_SIZE);
-
161  return true;
-
162  }
-
163 
-
164  bool processMessageLoop() {
-
165  ESP_LOGD(TAG, "processMessageLoop");
-
166 
-
167  if (!readBaseMessage())
-
168  return false;
-
169  delay(1);
-
170 
-
171  if (!readData())
-
172  return false;
-
173  delay(1);
-
174 
-
175  switch (base_message.type) {
-
176  case SNAPCAST_MESSAGE_CODEC_HEADER:
-
177  processMessageCodecHeader();
-
178  header_received = true;
-
179  break;
-
180 
-
181  case SNAPCAST_MESSAGE_WIRE_CHUNK:
-
182  // chunk_cnt++;
-
183  if (!header_received) {
-
184  return true;
-
185  }
-
186  processMessageWireChunk();
-
187  break;
-
188 
-
189  case SNAPCAST_MESSAGE_SERVER_SETTINGS:
-
190  processMessageServerSettings();
-
191  break;
+
97  void setDecoder(AudioDecoder &dec) { p_snap_output->setDecoder(dec); }
+
98 
+
100  float volume(void) { return p_snap_output->volume(); }
+
101 
+
103  void setVolumeFactor(float fact) { p_snap_output->setVolumeFactor(fact); }
+
104 
+
106  void setSnapOutput(SnapOutput &out) { p_snap_output = &out; }
+
107 
+
108  SnapOutput &snapOutput() { return *p_snap_output; }
+
109 
+
111  void setClient(Client &client) { p_client = &client; }
+
112 
+
113  void setAudioInfo(AudioInfo info) {
+
114  p_snap_output->setAudioInfo(info);
+
115  }
+
116 
+
117  // Select loop processing with minimum delays
+
118  void setFastLoop(bool flag){
+
119  is_fast_loop = flag;
+
120  }
+
121 
+
123  void setHostName(const char* name){
+
124  hostname = name;
+
125  }
+
126 
+
127  const char* hostName(){
+
128  return hostname;
+
129  }
+
130 
+
132  void setClientName(const char* name){
+
133  client_name = name;
+
134  }
+
135 
+
136  const char* clientName(){
+
137  return client_name;
+
138  }
+
139 
+
140 protected:
+
141  const char *TAG = "SnapProcessor";
+
142  // WiFiClient default_client;
+
143  Client *p_client = nullptr;
+
144  SnapOutput *p_snap_output = nullptr;
+
145  std::vector<int16_t> audio;
+
146  std::vector<char> send_receive_buffer;
+
147  std::vector<char> base_message_serialized;
+
148  int16_t frame_size = 512;
+
149  uint16_t channels = 2;
+
150  codec_type codec_from_server = NO_CODEC;
+
151  SnapMessageBase base_message;
+
152  SnapMessageTime time_message;
+
153  SnapMessageServerSettings server_settings_message;
+
154  uint32_t client_state_muted = 0;
+
155  char *start = nullptr;
+
156  int size = 0;
+
157  timeval now;
+
158  uint64_t last_time_sync = 0;
+
159  int id_counter = 0;
+
160  IPAddress server_ip;
+
161  int server_port = CONFIG_SNAPCAST_SERVER_PORT;
+
162  const char *mac_address = "00-00-00-00-00";
+
163  bool output_start = false;
+
164  bool http_task_start = true;
+
165  bool header_received = false;
+
166  bool is_time_set = false;
+
167  SnapTime &snap_time = SnapTime::instance();
+
168  bool is_fast_loop = false;
+
169  enum loop_status_enum { LoopStart, LoopStep, LoopEnd };
+
170  loop_status_enum loop_status = LoopStart;
+
171  const char* hostname = CONFIG_SNAPCAST_CLIENT_NAME;
+
172  const char* client_name = "libsnapcast";
+
173 
+
174  bool processLoopStepFast() {
+
175  switch (loop_status) {
+
176  case LoopStart: {
+
177  if (connectClient()) {
+
178  ESP_LOGI(TAG, "... connected");
+
179  } else {
+
180  delay(10);
+
181  return false;
+
182  }
+
183 
+
184  now = snap_time.time();
+
185  if (!writeHallo()) {
+
186  ESP_LOGI(TAG, "writeHallo");
+
187  return false;
+
188  }
+
189  loop_status = LoopStep;
+
190  return true;
+
191  }
192 
-
193  case SNAPCAST_MESSAGE_TIME:
-
194  processMessageTime();
-
195  break;
-
196 
-
197  default:
-
198  ESP_LOGD(TAG, "Invalid Message: %u", base_message.type);
-
199  }
-
200  delay(1);
-
201 
-
202  // If it's been a second or longer since our last time message was
-
203  // sent, do so now
-
204  if (!writeTimedMessage())
-
205  return false;
-
206 
-
207  delay(1);
-
208 
-
209  return true;
-
210  }
-
211 
-
212  bool connectClient() {
-
213  ESP_LOGD(TAG, "start");
-
214  if (p_client->connected()) return true;
-
215  p_client->setTimeout(CONFIG_CLIENT_TIMEOUT_SEC);
-
216  if (!p_client->connect(server_ip, server_port)) {
-
217  ESP_LOGE(TAG, "... socket connect failed errno=%d", errno);
-
218  delay(4000);
-
219  return false;
-
220  }
-
221  return true;
-
222  }
-
223 
-
224  bool writeHallo() {
-
225  ESP_LOGD(TAG, "start");
-
226  // setup base_message
-
227  base_message.type = SNAPCAST_MESSAGE_HELLO;
-
228  base_message.id = 0x0;
-
229  base_message.refersTo = 0x0;
-
230  base_message.sent = {(int32_t)now.tv_sec, (int32_t)now.tv_usec};
-
231  base_message.received = {0x0, 0x0};
-
232  base_message.size = 0x0;
-
233 
-
234  // setup hello_message
-
235  SnapMessageHallo hello_message;
-
236  hello_message.mac = mac_address;
-
237  hello_message.hostname = CONFIG_SNAPCAST_CLIENT_NAME;
-
238  hello_message.version = "0.0.2";
-
239  hello_message.client_name = "libsnapcast";
-
240  hello_message.os = "esp32";
-
241  hello_message.arch = "xtensa";
-
242  hello_message.instance = 1;
-
243  hello_message.id = mac_address;
-
244  hello_message.protocol_version = 2;
-
245 
-
246  char *hello_message_serialized =
-
247  hello_message.serialize((size_t *)&(base_message.size));
-
248  if (hello_message_serialized == nullptr) {
-
249  ESP_LOGE(TAG, "Failed to serialize hello message");
-
250  return false;
-
251  }
-
252 
-
253  int result =
-
254  base_message.serialize(&base_message_serialized[0], BASE_MESSAGE_SIZE);
-
255  if (result) {
-
256  ESP_LOGE(TAG, "Failed to serialize base message");
-
257  return false;
-
258  }
-
259 
-
260  p_client->write((const uint8_t *)&base_message_serialized[0],
-
261  BASE_MESSAGE_SIZE);
-
262  p_client->write((const uint8_t *)hello_message_serialized,
-
263  base_message.size);
-
264 
-
265  return true;
-
266  }
-
267 
-
268  bool readBaseMessage() {
-
269  ESP_LOGD(TAG, "%d", BASE_MESSAGE_SIZE);
-
270  // Wait for timeout
-
271  // uint64_t end = millis() + CONFIG_WEBSOCKET_SERVER_TIMEOUT_SEC * 1000;
-
272  while (p_client->available() < BASE_MESSAGE_SIZE) {
-
273  delay(100);
-
274  }
+
193  case LoopStep: {
+
194  if (!processMessageLoop()) {
+
195  loop_status = LoopEnd;
+
196  }
+
197  // some additional processing while we wait for data
+
198  processExt();
+
199  // logHeap();
+
200  checkHeap();
+
201  return true;
+
202  }
+
203 
+
204  case LoopEnd: {
+
205  loop_status = LoopStart;
+
206  if (id_counter % 100 == 0) {
+
207  logHeap();
+
208  }
+
209  // For rtos, give audio output some space
+
210  delay(1);
+
211  return true;
+
212  }
+
213  }
+
214  // we should not get here
+
215  return false;
+
216  }
+
217 
+
218  bool processLoopStep() {
+
219  if (connectClient()) {
+
220  ESP_LOGI(TAG, "... connected");
+
221  } else {
+
222  delay(10);
+
223  return false;
+
224  }
+
225 
+
226  now = snap_time.time();
+
227 
+
228  if (!writeHallo()){
+
229  ESP_LOGI(TAG, "writeHallo");
+
230  return false;
+
231  }
+
232 
+
233  bool rc = true;
+
234  while (rc) {
+
235  rc = processMessageLoop();
+
236  // some additional processing while we wait for data
+
237  processExt();
+
238  //logHeap();
+
239  checkHeap();
+
240  }
+
241 
+
242  if (id_counter % 100 == 0) {
+
243  logHeap();
+
244  }
+
245  // For rtos, give audio output some space
+
246  delay(1);
+
247  return true;
+
248  }
+
249 
+
251  virtual void processExt() {
+
252  // For rtos, give audio output some space
+
253  delay(5);
+
254  }
+
255 
+
256  bool resizeData() {
+
257  audio.resize(frame_size);
+
258  send_receive_buffer.resize(CONFIG_SNAPCAST_BUFF_LEN);
+
259  base_message_serialized.resize(BASE_MESSAGE_SIZE);
+
260  return true;
+
261  }
+
262 
+
263  bool processMessageLoop() {
+
264  ESP_LOGD(TAG, "processMessageLoop");
+
265  // Wait for data
+
266  if (p_client->available() < BASE_MESSAGE_SIZE) {
+
267  return true;
+
268  }
+
269 
+
270  if (!readBaseMessage())
+
271  return false;
+
272 
+
273  if (!readData())
+
274  return false;
275 
-
276  // Read Header Record with size
-
277  size = p_client->readBytes(&send_receive_buffer[0], BASE_MESSAGE_SIZE);
-
278  ESP_LOGD(TAG, "Bytes read: %d", size);
-
279 
-
280  now = snap_time.time();
+
276  switch (base_message.type) {
+
277  case SNAPCAST_MESSAGE_CODEC_HEADER:
+
278  processMessageCodecHeader();
+
279  header_received = true;
+
280  break;
281 
-
282  int result = base_message.deserialize(&send_receive_buffer[0], size);
-
283  if (result) {
-
284  ESP_LOGW(TAG, "Failed to read base message: %d", result);
-
285  return false;
-
286  }
-
287 
-
288  // ESP_LOGI(TAG,"Rx dif : %d %d", base_message.sent.sec,
-
289  // base_message.sent.usec/1000);
-
290  base_message.received.sec = now.tv_sec;
-
291  base_message.received.usec = now.tv_usec;
-
292  return true;
-
293  }
-
294 
-
295  bool readData() {
-
296  ESP_LOGD(TAG, "%d", base_message.size);
-
297  if (base_message.size > send_receive_buffer.size()) {
-
298  send_receive_buffer.resize(base_message.size);
-
299  }
-
300  start = &send_receive_buffer[0];
-
301  while (p_client->available() < base_message.size)
-
302  delay(10);
-
303  size = p_client->readBytes(&(send_receive_buffer[0]), base_message.size);
-
304  return true;
-
305  }
+
282  case SNAPCAST_MESSAGE_WIRE_CHUNK:
+
283  // chunk_cnt++;
+
284  if (!header_received) {
+
285  return true;
+
286  }
+
287  processMessageWireChunk();
+
288  break;
+
289 
+
290  case SNAPCAST_MESSAGE_SERVER_SETTINGS:
+
291  processMessageServerSettings();
+
292  break;
+
293 
+
294  case SNAPCAST_MESSAGE_TIME:
+
295  processMessageTime();
+
296  break;
+
297 
+
298  default:
+
299  ESP_LOGD(TAG, "Invalid Message: %u", base_message.type);
+
300  }
+
301 
+
302  // If it's been a second or longer since our last time message was
+
303  // sent, do so now
+
304  if (!writeTimedMessage())
+
305  return false;
306 
-
307  bool processMessageCodecHeader() {
-
308  ESP_LOGD(TAG, "start");
-
309  SnapMessageCodecHeader codec_header_message;
-
310  start = &send_receive_buffer[0];
-
311  int result = codec_header_message.deserialize(start, size);
-
312  if (result) {
-
313  ESP_LOGI(TAG, "Failed to read codec header: %d", result);
-
314  return false;
-
315  }
-
316 
-
317  ESP_LOGI(TAG, "Received codec header message");
-
318 
-
319  size = codec_header_message.size;
-
320  start = codec_header_message.payload();
-
321  if (strcmp(codec_header_message.codec(), "opus") == 0) {
-
322  if (!processMessageCodecHeaderOpus(OPUS))
-
323  return false;
-
324  } else if (strcmp(codec_header_message.codec(), "flac") == 0) {
-
325  if (!processMessageCodecHeaderExt(FLAC))
-
326  return false;
-
327  } else if (strcmp(codec_header_message.codec(), "ogg") == 0) {
-
328  if (!processMessageCodecHeaderExt(OGG))
-
329  return false;
-
330  } else if (strcmp(codec_header_message.codec(), "pcm") == 0) {
-
331  if (!processMessageCodecHeaderExt(PCM))
-
332  return false;
-
333  } else {
-
334  ESP_LOGI(TAG, "Codec : %s not supported", codec_header_message.codec());
-
335  ESP_LOGI(TAG, "Change encoder codec to opus in /etc/snapserver.conf on "
-
336  "server");
-
337  return false;
-
338  }
-
339  ESP_LOGI(TAG, "Codec : %s , Size: %d ", codec_header_message.codec(), size);
-
340  // codec_header_message.release();
-
341 
-
342  return true;
-
343  }
-
344 
-
345  bool processMessageCodecHeaderOpus(codec_type codecType) {
-
346  ESP_LOGD(TAG, "start");
-
347  uint32_t rate;
-
348  memcpy(&rate, start + 4, sizeof(rate));
-
349  uint16_t bits;
-
350  memcpy(&bits, start + 8, sizeof(bits));
-
351  memcpy(&channels, start + 10, sizeof(channels));
-
352  // notify output about format
-
353  AudioInfo info(rate, channels, bits);
-
354  setAudioInfo(info);
-
355  audioBegin();
-
356  codec_from_server = codecType;
-
357  return true;
-
358  }
-
359 
-
360  bool processMessageCodecHeaderExt(codec_type codecType) {
-
361  ESP_LOGD(TAG, "start");
-
362  codec_from_server = codecType;
-
363  audioBegin();
-
364  // send the data to the codec
-
365  p_snap_output->audioWrite((const uint8_t*)start, size);
-
366  return true;
-
367  }
+
307  return true;
+
308  }
+
309 
+
311  bool connectClient() {
+
312  ESP_LOGD(TAG, "start");
+
313  if (p_client->connected()) return true;
+
314  p_client->stop(); // for Ethernet.h
+
315  p_client->setTimeout(CONFIG_CLIENT_TIMEOUT_SEC);
+
316  if (p_client->connect(server_ip, server_port)<=0) {
+
317  char str_address[50];
+
318  sprintf(str_address, "%d.%d.%d.%d:%d", server_ip[0], server_ip[1],
+
319  server_ip[2], server_ip[3], server_port);
+
320 
+
321  ESP_LOGE(TAG, "Socket connect to %s failed (errno = %d)", str_address, errno);
+
322  delay(4000);
+
323  return false;
+
324  }
+
325  return true;
+
326  }
+
327 
+
328  bool writeHallo() {
+
329  ESP_LOGD(TAG, "start");
+
330  // setup base_message
+
331  base_message.type = SNAPCAST_MESSAGE_HELLO;
+
332  base_message.id = 0x0;
+
333  base_message.refersTo = 0x0;
+
334  base_message.sent = {(int32_t)now.tv_sec, (int32_t)now.tv_usec};
+
335  base_message.received = {0x0, 0x0};
+
336  base_message.size = 0x0;
+
337 
+
338  // setup hello_message
+
339  SnapMessageHallo hello_message;
+
340  hello_message.mac = mac_address;
+
341  hello_message.hostname = hostname;
+
342  hello_message.version = "0.0.2";
+
343  hello_message.client_name = client_name;
+
344  hello_message.os = "arduino";
+
345  hello_message.arch = "xtensa";
+
346  hello_message.instance = 1;
+
347  hello_message.id = mac_address;
+
348  hello_message.protocol_version = 2;
+
349 
+
350  char *hello_message_serialized =
+
351  hello_message.serialize((size_t *)&(base_message.size));
+
352  if (hello_message_serialized == nullptr) {
+
353  ESP_LOGE(TAG, "Failed to serialize hello message");
+
354  return false;
+
355  }
+
356 
+
357  int result =
+
358  base_message.serialize(&base_message_serialized[0], BASE_MESSAGE_SIZE);
+
359  if (result) {
+
360  ESP_LOGE(TAG, "Failed to serialize base message");
+
361  return false;
+
362  }
+
363 
+
364  p_client->write((const uint8_t *)&base_message_serialized[0],
+
365  BASE_MESSAGE_SIZE);
+
366  p_client->write((const uint8_t *)hello_message_serialized,
+
367  base_message.size);
368 
-
369  bool processMessageWireChunk() {
-
370  ESP_LOGD(TAG, "start");
-
371  start = &send_receive_buffer[0];
-
372  SnapMessageWireChunk wire_chunk_message;
-
373  memset((void*)&wire_chunk_message, 0, sizeof(wire_chunk_message));
-
374  int result = wire_chunk_message.deserialize(start, size);
-
375  if (result) {
-
376  ESP_LOGI(TAG, "Failed to read wire chunk: %d", result);
-
377  return false;
-
378  }
-
379  switch (codec_from_server) {
-
380  case FLAC:
-
381  case OGG:
-
382  case OPUS:
-
383  case PCM:
-
384  wireChunk(wire_chunk_message);
-
385  break;
-
386  case NO_CODEC:
-
387  ESP_LOGE(TAG, "Invalid codedc");
-
388  break;
-
389  }
-
390  // wire_chunk_message_free(&wire_chunk_message);
+
369  return true;
+
370  }
+
371 
+
372  bool readBaseMessage() {
+
373  ESP_LOGD(TAG, "%d", BASE_MESSAGE_SIZE);
+
374 
+
375  // Read Header Record with size
+
376  size = p_client->readBytes(&send_receive_buffer[0], BASE_MESSAGE_SIZE);
+
377  ESP_LOGD(TAG, "Bytes read: %d", size);
+
378 
+
379  now = snap_time.time();
+
380 
+
381  int result = base_message.deserialize(&send_receive_buffer[0], size);
+
382  if (result) {
+
383  ESP_LOGW(TAG, "Failed to read base message: %d", result);
+
384  return false;
+
385  }
+
386 
+
387  // ESP_LOGI(TAG,"Rx dif : %d %d", base_message.sent.sec,
+
388  // base_message.sent.usec/1000);
+
389  base_message.received.sec = now.tv_sec;
+
390  base_message.received.usec = now.tv_usec;
391  return true;
392  }
393 
-
394  bool wireChunk(SnapMessageWireChunk &wire_chunk_message) {
-
395  ESP_LOGD(TAG, "start");
-
396  SnapAudioHeader header;
-
397  header.size = wire_chunk_message.size;
-
398 
-
399  header.sec = wire_chunk_message.timestamp.sec;
-
400  header.usec = wire_chunk_message.timestamp.usec;
-
401  header.codec = codec_from_server;
-
402  writeAudioInfo(header);
-
403 
-
404  size_t chunk_res;
-
405  if ((chunk_res = writeAudio((const uint8_t *)wire_chunk_message.payload,
-
406  wire_chunk_message.size)) !=
-
407  wire_chunk_message.size) {
-
408  ESP_LOGW(TAG, "Error writing audio chunk: %zu -> %zu",(size_t)wire_chunk_message.size, chunk_res);
-
409  }
-
410  return true;
-
411  }
-
412 
-
413  bool processMessageServerSettings() {
-
414  ESP_LOGD(TAG, "start");
-
415  SnapMessageServerSettings server_settings_message;
-
416 
-
417  // The first 4 bytes in the buffer are the size of the string.
-
418  // We don't need this, so we'll shift the entire buffer over 4 bytes
-
419  // and use the extra room to add a null character so cJSON can pares
-
420  // it.
-
421  memmove(start, start + 4, size - 4);
-
422  start[size - 3] = '\0';
-
423  int result = server_settings_message.deserialize(start);
-
424  if (result) {
-
425  ESP_LOGI(TAG, "Failed to read server settings: %d", result);
-
426  return false;
-
427  }
-
428  // log mute state, buffer, latency
-
429  ESP_LOGI(TAG, "Message Buff.ms:%d", server_settings_message.buffer_ms);
-
430  ESP_LOGI(TAG, "Latency: %d", server_settings_message.latency);
-
431  ESP_LOGI(TAG, "Mute: %s", server_settings_message.muted ? "true":"false");
-
432  ESP_LOGI(TAG, "Setting volume: %d", server_settings_message.volume);
-
433 
-
434  // define the start delay from the server settings
-
435  p_snap_output->snapTimeSync().setMessageBufferDelay(
-
436  server_settings_message.buffer_ms + server_settings_message.latency);
-
437 
-
438  // set volume
-
439  if (header_received) {
-
440  setMute(server_settings_message.muted);
-
441  }
-
442  setVolume(server_settings_message.volume);
+
394  bool readData() {
+
395  ESP_LOGD(TAG, "%d", base_message.size);
+
396  if (base_message.size > send_receive_buffer.size()) {
+
397  send_receive_buffer.resize(base_message.size);
+
398  }
+
399  start = &send_receive_buffer[0];
+
400  while (p_client->available() < base_message.size)
+
401  delay(10);
+
402  size = p_client->readBytes(&(send_receive_buffer[0]), base_message.size);
+
403  return true;
+
404  }
+
405 
+
406  bool processMessageCodecHeader() {
+
407  ESP_LOGD(TAG, "start");
+
408  SnapMessageCodecHeader codec_header_message;
+
409  start = &send_receive_buffer[0];
+
410  int result = codec_header_message.deserialize(start, size);
+
411  if (result) {
+
412  ESP_LOGI(TAG, "Failed to read codec header: %d", result);
+
413  return false;
+
414  }
+
415 
+
416  ESP_LOGI(TAG, "Received codec header message");
+
417 
+
418  size = codec_header_message.size;
+
419  start = codec_header_message.payload();
+
420  if (strcmp(codec_header_message.codec(), "opus") == 0) {
+
421  if (!processMessageCodecHeaderOpus(OPUS))
+
422  return false;
+
423  } else if (strcmp(codec_header_message.codec(), "flac") == 0) {
+
424  if (!processMessageCodecHeaderExt(FLAC))
+
425  return false;
+
426  } else if (strcmp(codec_header_message.codec(), "ogg") == 0) {
+
427  if (!processMessageCodecHeaderExt(OGG))
+
428  return false;
+
429  } else if (strcmp(codec_header_message.codec(), "pcm") == 0) {
+
430  if (!processMessageCodecHeaderWav(PCM))
+
431  return false;
+
432  } else {
+
433  ESP_LOGI(TAG, "Codec : %s not supported", codec_header_message.codec());
+
434  ESP_LOGI(TAG, "Change encoder codec to opus in /etc/snapserver.conf on "
+
435  "server");
+
436  return false;
+
437  }
+
438  ESP_LOGI(TAG, "Codec : %s , Size: %d ", codec_header_message.codec(), size);
+
439  // codec_header_message.release();
+
440 
+
441  return true;
+
442  }
443 
-
444  if (server_settings_message.muted != client_state_muted) {
-
445  client_state_muted = server_settings_message.muted;
-
446  }
-
447  return true;
-
448  }
-
449 
-
450  bool processMessageTime() {
-
451  ESP_LOGD(TAG, "start");
-
452  int result = time_message.deserialize(start, size);
-
453  if (result) {
-
454  ESP_LOGI(TAG, "Failed to deserialize time message");
-
455  return false;
-
456  }
-
457 
-
458  // // Calculate TClienctx.tdif : Trx-Tsend-Tnetdelay/2
-
459  struct timeval ttx, trx;
-
460  ttx.tv_sec = base_message.sent.sec;
-
461  ttx.tv_usec = base_message.sent.usec;
-
462  trx.tv_sec = base_message.received.sec;
-
463  trx.tv_usec = base_message.received.usec;
-
464 
-
465  // for time management
-
466  snap_time.updateServerTime(trx);
-
467  // for synchronization
-
468  p_snap_output->snapTimeSync().updateServerTime(snap_time.toMillis(trx));
-
469 
-
470  int64_t time_diff = snap_time.timeDifferenceMs(trx, ttx);
-
471  uint32_t time_diff_int = time_diff;
-
472  assert(time_diff_int == time_diff);
-
473  ESP_LOGD(TAG, "Time Difference to Server: %ld ms", time_diff);
-
474  snap_time.setTimeDifferenceClientServerMs(time_diff);
-
475 
-
476  return true;
-
477  }
-
478 
-
479  bool writeTimedMessage() {
-
480  ESP_LOGD(TAG, "start");
-
481  uint32_t time_ms = millis() - last_time_sync;
-
482  if (time_ms >= 1000) {
-
483  last_time_sync = millis();
-
484  if (!writeMessage()) {
-
485  return false;
-
486  }
-
487  }
-
488  return true;
-
489  }
-
490 
-
491  bool writeMessage() {
-
492  ESP_LOGD(TAG, "start");
-
493 
-
494  now = snap_time.time();
-
495 
-
496  base_message.type = SNAPCAST_MESSAGE_TIME;
-
497  base_message.id = id_counter++;
-
498  base_message.refersTo = 0;
-
499  base_message.received.sec = 0;
-
500  base_message.received.usec = 0;
-
501  base_message.sent.sec = now.tv_sec;
-
502  base_message.sent.usec = now.tv_usec;
-
503  base_message.size = TIME_MESSAGE_SIZE;
-
504 
-
505  int result =
-
506  base_message.serialize(&base_message_serialized[0], BASE_MESSAGE_SIZE);
-
507  if (result) {
-
508  ESP_LOGE(TAG, "Failed to serialize base message for time");
-
509  return true;
-
510  }
+
444  bool processMessageCodecHeaderOpus(codec_type codecType) {
+
445  ESP_LOGD(TAG, "start");
+
446  uint32_t rate;
+
447  memcpy(&rate, start + 4, sizeof(rate));
+
448  uint16_t bits;
+
449  memcpy(&bits, start + 8, sizeof(bits));
+
450  memcpy(&channels, start + 10, sizeof(channels));
+
451  // notify output about format
+
452  AudioInfo info(rate, channels, bits);
+
453  setAudioInfo(info);
+
454  audioBegin();
+
455  codec_from_server = codecType;
+
456  return true;
+
457  }
+
458 
+
459  bool processMessageCodecHeaderWav(codec_type codecType) {
+
460  ESP_LOGD(TAG, "start");
+
461  codec_from_server = codecType;
+
462  audioBegin();
+
463  // send the wav header to the codec
+
464  p_snap_output->audioWrite((const uint8_t*)start, 44);
+
465  return true;
+
466  }
+
467 
+
468  bool processMessageCodecHeaderExt(codec_type codecType) {
+
469  ESP_LOGD(TAG, "start");
+
470  codec_from_server = codecType;
+
471  audioBegin();
+
472  // send the data to the codec
+
473  //p_snap_output->audioWrite((const uint8_t*)start, size);
+
474  return true;
+
475  }
+
476 
+
477  bool processMessageWireChunk() {
+
478  ESP_LOGD(TAG, "start");
+
479  start = &send_receive_buffer[0];
+
480  SnapMessageWireChunk wire_chunk_message;
+
481  memset((void*)&wire_chunk_message, 0, sizeof(wire_chunk_message));
+
482  int result = wire_chunk_message.deserialize(start, size);
+
483  if (result) {
+
484  ESP_LOGI(TAG, "Failed to read wire chunk: %d", result);
+
485  return false;
+
486  }
+
487  switch (codec_from_server) {
+
488  case FLAC:
+
489  case OGG:
+
490  case OPUS:
+
491  case PCM:
+
492  wireChunk(wire_chunk_message);
+
493  break;
+
494  case NO_CODEC:
+
495  ESP_LOGE(TAG, "Invalid codec");
+
496  break;
+
497  }
+
498  // wire_chunk_message_free(&wire_chunk_message);
+
499  return true;
+
500  }
+
501 
+
502  bool wireChunk(SnapMessageWireChunk &wire_chunk_message) {
+
503  ESP_LOGD(TAG, "start");
+
504  SnapAudioHeader header;
+
505  header.size = wire_chunk_message.size;
+
506 
+
507  header.sec = wire_chunk_message.timestamp.sec;
+
508  header.usec = wire_chunk_message.timestamp.usec;
+
509  header.codec = codec_from_server;
+
510  writeAudioInfo(header);
511 
-
512  result = time_message.serialize(&send_receive_buffer[0],
-
513  CONFIG_SNAPCAST_BUFF_LEN);
-
514  if (result) {
-
515  ESP_LOGI(TAG, "Failed to serialize time message\r\b");
-
516  return true;
+
512  size_t chunk_res;
+
513  if ((chunk_res = writeAudio((const uint8_t *)wire_chunk_message.payload,
+
514  wire_chunk_message.size)) !=
+
515  wire_chunk_message.size) {
+
516  ESP_LOGW(TAG, "Error writing audio chunk: %zu -> %zu",(size_t)wire_chunk_message.size, chunk_res);
517  }
-
518  p_client->write((const uint8_t *)&base_message_serialized[0],
-
519  BASE_MESSAGE_SIZE);
-
520  p_client->write((const uint8_t *)&send_receive_buffer[0],
-
521  TIME_MESSAGE_SIZE);
-
522  return true;
-
523  }
-
524 
-
525  void setMute(bool flag) { p_snap_output->setMute(flag); }
-
526 
-
527  void setVolume(float vol) { p_snap_output->setVolume(vol); }
-
528 
-
529  bool audioBegin() { return p_snap_output->begin(); }
-
530 
-
531  void audioEnd() { p_snap_output->end(); }
-
532 
-
533  virtual size_t writeAudio(const uint8_t *data, size_t size) {
-
534  return p_snap_output->write(data, size);
-
535  }
-
536 
-
537  size_t writeAudioInfo(SnapAudioHeader &header) {
-
538  return p_snap_output->writeHeader(header);
-
539  }
-
540 };
-
SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:26
-
SnapOutput::volume
float volume()
provides the actual volume
Definition: SnapOutput.h:74
-
SnapOutput::setMute
void setMute(bool mute)
mute / unmute
Definition: SnapOutput.h:77
-
SnapOutput::setVolume
void setVolume(float vol)
Adjust the volume.
Definition: SnapOutput.h:67
-
SnapOutput::begin
virtual bool begin()
Definition: SnapOutput.h:35
-
SnapOutput::setAudioInfo
void setAudioInfo(AudioInfo info)
setup of all audio objects
Definition: SnapOutput.h:106
-
SnapOutput::write
virtual size_t write(const uint8_t *data, size_t size)
Writes audio data to the queue.
Definition: SnapOutput.h:42
-
SnapOutput::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapOutput.h:101
-
SnapOutput::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapOutput.h:87
-
SnapOutput::writeHeader
virtual bool writeHeader(SnapAudioHeader &header)
Provides info about the audio data.
Definition: SnapOutput.h:58
-
SnapOutput::setOutput
void setOutput(AudioOutput &output)
Defines the audio output chain to the final output.
Definition: SnapOutput.h:90
-
SnapOutput::end
virtual void end(void)
Ends the processing and releases the memory.
Definition: SnapOutput.h:64
-
SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:19
-
SnapProcessor::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the SnapOutput implementation.
Definition: SnapProcessor.h:85
-
SnapProcessor::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapProcessor.h:76
-
SnapProcessor::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapProcessor.h:82
-
SnapProcessor::volume
float volume(void)
Provides the volume (in the range of 0.0 to 1.0)
Definition: SnapProcessor.h:79
-
SnapProcessor::setOutput
void setOutput(AudioOutput &output)
Defines the output class.
Definition: SnapProcessor.h:73
-
SnapProcessor::setClient
void setClient(Client &client)
Defines an alternative client to the WiFiClient.
Definition: SnapProcessor.h:90
-
SnapProcessor::doLoop
virtual void doLoop()
Call via SnapClient in Arduino Loop!
Definition: SnapProcessor.h:70
-
SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:16
-
SnapTime::time
timeval time()
Provides the actual time as timeval.
Definition: SnapTime.h:24
-
SnapTime::setTimeDifferenceClientServerMs
void setTimeDifferenceClientServerMs(uint32_t diff)
Record the last time difference between client and server.
Definition: SnapTime.h:67
-
SnapTimeSync::setMessageBufferDelay
void setMessageBufferDelay(int ms)
Defines the message buffer lag.
Definition: SnapTimeSync.h:45
-
SnapTimeSync::updateServerTime
virtual void updateServerTime(uint32_t serverMillis)=0
Records the actual server time in millisecondes.
-
SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:19
-
SnapMessageBase
Snapcast Base Message.
Definition: SnapProtocol.h:216
-
SnapMessageCodecHeader
Snapcast Codec Header Message.
Definition: SnapProtocol.h:355
-
SnapMessageHallo
Snapcast Hallo Message.
Definition: SnapProtocol.h:263
-
SnapMessageServerSettings
Snapcast Server Settings Message.
Definition: SnapProtocol.h:314
-
SnapMessageTime
Snapcast Time Message.
Definition: SnapProtocol.h:433
-
SnapMessageWireChunk
Snapcast Wire Chunk Message.
Definition: SnapProtocol.h:401
-
tv_t
Time as sec & usec.
Definition: SnapProtocol.h:210
+
518  return true;
+
519  }
+
520 
+
521  bool processMessageServerSettings() {
+
522  ESP_LOGD(TAG, "start");
+
523  // The first 4 bytes in the buffer are the size of the string.
+
524  // We don't need this, so we'll shift the entire buffer over 4 bytes
+
525  // and use the extra room to add a null character so we can pares
+
526  // it.
+
527  memmove(start, start + 4, size - 4);
+
528  start[size - 3] = '\0';
+
529  int result = server_settings_message.deserialize(start);
+
530  if (result) {
+
531  ESP_LOGI(TAG, "Failed to read server settings: %d", result);
+
532  return false;
+
533  }
+
534  // log mute state, buffer, latency
+
535  ESP_LOGI(TAG, "Message Buff.ms:%d", server_settings_message.buffer_ms);
+
536  ESP_LOGI(TAG, "Latency: %d", server_settings_message.latency);
+
537  ESP_LOGI(TAG, "Mute: %s", server_settings_message.muted ? "true":"false");
+
538  ESP_LOGI(TAG, "Setting volume: %d", server_settings_message.volume);
+
539 
+
540  // define the start delay from the server settings
+
541  p_snap_output->snapTimeSync().setMessageBufferDelay(
+
542  server_settings_message.buffer_ms + server_settings_message.latency);
+
543 
+
544  // set volume
+
545  if (header_received) {
+
546  setMute(server_settings_message.muted);
+
547  }
+
548  setVolume(0.01f * server_settings_message.volume);
+
549 
+
550  if (server_settings_message.muted != client_state_muted) {
+
551  client_state_muted = server_settings_message.muted;
+
552  }
+
553  return true;
+
554  }
+
555 
+
556  bool processMessageTime() {
+
557  ESP_LOGD(TAG, "start");
+
558  int result = time_message.deserialize(start, size);
+
559  if (result) {
+
560  ESP_LOGI(TAG, "Failed to deserialize time message");
+
561  return false;
+
562  }
+
563 
+
564  // // Calculate TClienctx.tdif : Trx-Tsend-Tnetdelay/2
+
565  struct timeval ttx, trx;
+
566  ttx.tv_sec = base_message.sent.sec;
+
567  ttx.tv_usec = base_message.sent.usec;
+
568  trx.tv_sec = base_message.received.sec;
+
569  trx.tv_usec = base_message.received.usec;
+
570 
+
571  // for time management
+
572  snap_time.updateServerTime(trx);
+
573  // for synchronization
+
574  p_snap_output->snapTimeSync().updateServerTime(snap_time.toMillis(trx));
+
575 
+
576  int64_t time_diff = snap_time.timeDifferenceMs(trx, ttx);
+
577  uint32_t time_diff_int = time_diff;
+
578  assert(time_diff_int == time_diff);
+
579  ESP_LOGD(TAG, "Time Difference to Server: %ld ms", time_diff);
+
580  snap_time.setTimeDifferenceClientServerMs(time_diff);
+
581 
+
582  return true;
+
583  }
+
584 
+
585  bool writeTimedMessage() {
+
586  ESP_LOGD(TAG, "start");
+
587  uint32_t time_ms = millis() - last_time_sync;
+
588  if (time_ms >= 1000) {
+
589  last_time_sync = millis();
+
590  if (!writeMessage()) {
+
591  return false;
+
592  }
+
593  }
+
594  return true;
+
595  }
+
596 
+
597  bool writeMessage() {
+
598  ESP_LOGD(TAG, "start");
+
599 
+
600  now = snap_time.time();
+
601 
+
602  base_message.type = SNAPCAST_MESSAGE_TIME;
+
603  base_message.id = id_counter++;
+
604  base_message.refersTo = 0;
+
605  base_message.received.sec = 0;
+
606  base_message.received.usec = 0;
+
607  base_message.sent.sec = now.tv_sec;
+
608  base_message.sent.usec = now.tv_usec;
+
609  base_message.size = TIME_MESSAGE_SIZE;
+
610 
+
611  int result =
+
612  base_message.serialize(&base_message_serialized[0], BASE_MESSAGE_SIZE);
+
613  if (result) {
+
614  ESP_LOGE(TAG, "Failed to serialize base message for time");
+
615  return true;
+
616  }
+
617 
+
618  result = time_message.serialize(&send_receive_buffer[0],
+
619  CONFIG_SNAPCAST_BUFF_LEN);
+
620  if (result) {
+
621  ESP_LOGI(TAG, "Failed to serialize time message\r\b");
+
622  return true;
+
623  }
+
624  p_client->write((const uint8_t *)&base_message_serialized[0],
+
625  BASE_MESSAGE_SIZE);
+
626  p_client->write((const uint8_t *)&send_receive_buffer[0],
+
627  TIME_MESSAGE_SIZE);
+
628  return true;
+
629  }
+
630 
+
631  void setMute(bool flag) { p_snap_output->setMute(flag); }
+
632 
+
633  void setVolume(float vol) { p_snap_output->setVolume(vol); }
+
634 
+
635  bool audioBegin() { return p_snap_output->begin(); }
+
636 
+
637  void audioEnd() { p_snap_output->end(); }
+
638 
+
639  virtual size_t writeAudio(const uint8_t *data, size_t size) {
+
640  return p_snap_output->write(data, size);
+
641  }
+
642 
+
643  size_t writeAudioInfo(SnapAudioHeader &header) {
+
644  return p_snap_output->writeHeader(header);
+
645  }
+
646 };
+
647 
+
648 }
+
snap_arduino::SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:27
+
snap_arduino::SnapOutput::volume
float volume()
provides the actual volume
Definition: SnapOutput.h:73
+
snap_arduino::SnapOutput::setMute
void setMute(bool mute)
mute / unmute
Definition: SnapOutput.h:76
+
snap_arduino::SnapOutput::setVolume
void setVolume(float vol)
Adjust the volume.
Definition: SnapOutput.h:66
+
snap_arduino::SnapOutput::begin
virtual bool begin()
Definition: SnapOutput.h:34
+
snap_arduino::SnapOutput::setAudioInfo
void setAudioInfo(AudioInfo info)
setup of all audio objects
Definition: SnapOutput.h:110
+
snap_arduino::SnapOutput::write
virtual size_t write(const uint8_t *data, size_t size)
Writes audio data to the queue.
Definition: SnapOutput.h:41
+
snap_arduino::SnapOutput::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapOutput.h:105
+
snap_arduino::SnapOutput::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapOutput.h:86
+
snap_arduino::SnapOutput::writeHeader
virtual bool writeHeader(SnapAudioHeader &header)
Provides info about the audio data.
Definition: SnapOutput.h:57
+
snap_arduino::SnapOutput::setOutput
void setOutput(AudioOutput &output)
Defines the audio output chain to the final output.
Definition: SnapOutput.h:89
+
snap_arduino::SnapOutput::end
virtual void end(void)
Ends the processing and releases the memory.
Definition: SnapOutput.h:63
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapProcessor::begin
virtual bool begin()
Sets up the output and the client.
Definition: SnapProcessor.h:36
+
snap_arduino::SnapProcessor::setSnapOutput
void setSnapOutput(SnapOutput &out)
Defines the SnapOutput implementation.
Definition: SnapProcessor.h:106
+
snap_arduino::SnapProcessor::connectClient
bool connectClient()
connects to the server: returns true if we are connected
Definition: SnapProcessor.h:311
+
snap_arduino::SnapProcessor::setDecoder
void setDecoder(AudioDecoder &dec)
Defines the decoder class.
Definition: SnapProcessor.h:97
+
snap_arduino::SnapProcessor::setVolumeFactor
void setVolumeFactor(float fact)
Adjust volume by factor e.g. 1.5.
Definition: SnapProcessor.h:103
+
snap_arduino::SnapProcessor::volume
float volume(void)
Provides the volume (in the range of 0.0 to 1.0)
Definition: SnapProcessor.h:100
+
snap_arduino::SnapProcessor::processExt
virtual void processExt()
additional processing
Definition: SnapProcessor.h:251
+
snap_arduino::SnapProcessor::setOutput
void setOutput(AudioOutput &output)
Defines the output class.
Definition: SnapProcessor.h:94
+
snap_arduino::SnapProcessor::setClient
void setClient(Client &client)
Defines an alternative client to the WiFiClient.
Definition: SnapProcessor.h:111
+
snap_arduino::SnapProcessor::setClientName
void setClientName(const char *name)
Defines the client name (default "libsnapcast")
Definition: SnapProcessor.h:132
+
snap_arduino::SnapProcessor::doLoop
bool doLoop()
Call via SnapClient in Arduino Loop!
Definition: SnapProcessor.h:81
+
snap_arduino::SnapProcessor::setHostName
void setHostName(const char *name)
Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME)
Definition: SnapProcessor.h:123
+
snap_arduino::SnapProcessor::doLoop1
virtual bool doLoop1()
Usually not used!
Definition: SnapProcessor.h:89
+
snap_arduino::SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:22
+
snap_arduino::SnapTime::time
timeval time()
Provides the actual time as timeval.
Definition: SnapTime.h:30
+
snap_arduino::SnapTime::setTimeDifferenceClientServerMs
void setTimeDifferenceClientServerMs(uint32_t diff)
Record the last time difference between client and server.
Definition: SnapTime.h:73
+
snap_arduino::SnapTimeSync::setMessageBufferDelay
void setMessageBufferDelay(int ms)
Defines the message buffer lag.
Definition: SnapTimeSync.h:47
+
snap_arduino::SnapTimeSync::updateServerTime
virtual void updateServerTime(uint32_t serverMillis)=0
Records the actual server time in millisecondes.
+
snap_arduino
Definition: SnapCommon.h:10
+
snap_arduino::SnapAudioHeader
Information about the next bucket.
Definition: SnapCommon.h:21
+
snap_arduino::SnapMessageBase
Snapcast Base Message.
Definition: SnapProtocol.h:218
+
snap_arduino::SnapMessageCodecHeader
Snapcast Codec Header Message.
Definition: SnapProtocol.h:357
+
snap_arduino::SnapMessageHallo
Snapcast Hallo Message.
Definition: SnapProtocol.h:265
+
snap_arduino::SnapMessageServerSettings
Snapcast Server Settings Message.
Definition: SnapProtocol.h:316
+
snap_arduino::SnapMessageTime
Snapcast Time Message.
Definition: SnapProtocol.h:435
+
snap_arduino::SnapMessageWireChunk
Snapcast Wire Chunk Message.
Definition: SnapProtocol.h:403
+
snap_arduino::tv_t
Time as sec & usec.
Definition: SnapProtocol.h:212
diff --git a/docs/html/_snap_processor_buffered_8h_source.html b/docs/html/_snap_processor_buffered_8h_source.html new file mode 100644 index 0000000..6094cac --- /dev/null +++ b/docs/html/_snap_processor_buffered_8h_source.html @@ -0,0 +1,163 @@ + + + + + + + +arduino-snapclient: src/api/SnapProcessorBuffered.h Source File + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessorBuffered.h
+
+
+
1 #pragma once
+
2 #include "SnapOutput.h"
+
3 
+
4 namespace snap_arduino {
+
5 
+
14 class SnapProcessorBuffered : public SnapProcessor {
+
15  public:
+
17  SnapProcessorBuffered(int buffer_size, int activationAtPercent = 75)
+
18  : SnapProcessor() {
+
19  buffer.resize(buffer_size);
+
20  active_percent = activationAtPercent;
+
21  }
+
22 
+
23  bool begin() override {
+
24  // regular begin logic
+
25  bool result = SnapProcessor::begin();
+
26  // empty buffer
+
27  buffer.reset();
+
28  sizes.reset();
+
29  is_active = false;
+
30  return result;
+
31  }
+
32 
+
34  size_t writeAudio(const uint8_t *data, size_t size) override {
+
35  if (size > buffer.size()) {
+
36  ESP_LOGE(TAG, "The buffer is too small. Use a multiple of %d", size);
+
37  stop();
+
38  }
+
39  sizes.write(size);
+
40  size_t result = buffer.writeArray(data, size);
+
41  ESP_LOGI(TAG, "size: %zu / buffer %d", size, buffer.available());
+
42 
+
43  if (result != size)
+
44  ESP_LOGE(TAG, "Could not buffer all data %d->%d", size, result);
+
45 
+
46  return result;
+
47  }
+
48 
+
50  virtual void processExt() {
+
51  if (isBufferActive()) {
+
52  int16_t step_size = sizes.read();
+
53  if (step_size > 0) {
+
54  uint8_t tmp[step_size];
+
55  int size_eff = buffer.readArray(tmp, step_size);
+
56  int size_written = SnapProcessor::writeAudio(tmp, size_eff);
+
57  if (size_written != size_eff) {
+
58  ESP_LOGE(TAG, "Could not write all data %d->%d", size_eff,
+
59  size_written);
+
60  }
+
61  }
+
62  }
+
63  delay(1);
+
64  }
+
65 
+
66  protected:
+
67  const char *TAG = "SnapProcessorBuffered";
+
68  RingBuffer<uint8_t> buffer{0};
+
69  RingBuffer<int16_t> sizes{RTOS_MAX_QUEUE_ENTRY_COUNT};
+
70  bool is_active = false;
+
71  int active_percent;
+
72 
+
73  bool isBufferActive() {
+
74  if (!is_active) {
+
75  if (buffer.available() >= bufferTaskActivationLimit()) {
+
76  is_active = true;
+
77  }
+
78  }
+
79  return is_active;
+
80  }
+
81 
+
83  int bufferTaskActivationLimit() {
+
84  return static_cast<float>(active_percent) / 100.0 * buffer.size();
+
85  }
+
86 };
+
87 
+
88 } // namespace snap_arduino
+
snap_arduino::SnapProcessorBuffered
Processor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer und...
Definition: SnapProcessorBuffered.h:14
+
snap_arduino::SnapProcessorBuffered::SnapProcessorBuffered
SnapProcessorBuffered(int buffer_size, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorBuffered.h:17
+
snap_arduino::SnapProcessorBuffered::bufferTaskActivationLimit
int bufferTaskActivationLimit()
Determines the buffer fill limit at which we start to process the data.
Definition: SnapProcessorBuffered.h:83
+
snap_arduino::SnapProcessorBuffered::processExt
virtual void processExt()
Decode from buffer.
Definition: SnapProcessorBuffered.h:50
+
snap_arduino::SnapProcessorBuffered::begin
bool begin() override
Sets up the output and the client.
Definition: SnapProcessorBuffered.h:23
+
snap_arduino::SnapProcessorBuffered::writeAudio
size_t writeAudio(const uint8_t *data, size_t size) override
fill buffer
Definition: SnapProcessorBuffered.h:34
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapProcessor::begin
virtual bool begin()
Sets up the output and the client.
Definition: SnapProcessor.h:36
+
snap_arduino
Definition: SnapCommon.h:10
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/_snap_processor_r_p2040_8h_source.html b/docs/html/_snap_processor_r_p2040_8h_source.html new file mode 100644 index 0000000..cefb49a --- /dev/null +++ b/docs/html/_snap_processor_r_p2040_8h_source.html @@ -0,0 +1,211 @@ + + + + + + + +arduino-snapclient: src/api/SnapProcessorRP2040.h Source File + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessorRP2040.h
+
+
+
1 #pragma once
+
2 #include "AudioTools/Concurrency/RP2040.h"
+
3 #include "SnapOutput.h"
+
4 
+
5 namespace snap_arduino {
+
6 
+
16 class SnapProcessorRP2040 : public SnapProcessor {
+
17  public:
+
19  SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent = 75)
+
20  : SnapProcessor(output) {
+
21  active_percent = activationAtPercent;
+
22  initQueues(bufferSizeBytes);
+
23  }
+
25  SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent = 75)
+
26  : SnapProcessor() {
+
27  active_percent = activationAtPercent;
+
28  initQueues(bufferSizeBytes);
+
29  }
+
30 
+
31  bool begin() override {
+
32  ESP_LOGW(TAG, "begin: %d", buffer_count * 1024);
+
33  // regular begin logic
+
34  bool result = SnapProcessor::begin();
+
35 
+
36  // allocate buffer
+
37  buffer.setBlockingRead(true);
+
38  buffer.setBlockingWrite(true);
+
39  buffer.resize(buffer_count * 1024);
+
40 
+
41  // we need to read back the buffer with the written sizes
+
42  size_queue.resize(RTOS_MAX_QUEUE_ENTRY_COUNT);
+
43 
+
44  is_active = false;
+
45  return result;
+
46  }
+
47 
+
48  void end(void) override {
+
49  size_queue.clear();
+
50  buffer.reset();
+
51  SnapProcessor::end();
+
52  }
+
53 
+
54  bool doLoop1() override {
+
55  ESP_LOGD(TAG, "doLoop1 %d / %d", size_queue.available(), buffer.available());
+
56  if (!isBufferActive()) return true;
+
57 
+
58  size_t size = 0;
+
59  if (size_queue.readArray(&size, 1)) {
+
60  uint8_t data[size];
+
61  int read = buffer.readArray(data, size);
+
62  if (read != size){
+
63  ESP_LOGE(TAG, "readArray failed %d -> %d", size, read);
+
64  }
+
65  int written = p_snap_output->audioWrite(data, size);
+
66  if (written != size) {
+
67  ESP_LOGE(TAG, "write error: %d of %d", written, size);
+
68  }
+
69  }
+
70  return true;
+
71  }
+
72 
+
73  protected:
+
74  const char *TAG = "SnapProcessorRP2040";
+
75  audio_tools::BufferRP2040T<size_t> size_queue{1, 0};
+
76  audio_tools::BufferRP2040T<uint8_t> buffer{1024, 0}; // size defined in begin
+
77  int buffer_count = 0;
+
78  bool is_active = false;
+
79  int active_percent = 0;
+
80 
+
81  bool isBufferActive() {
+
82  if (!is_active && buffer.available()>0) {
+
83 
+
84  int limit = buffer.size() * active_percent / 100;
+
85  if (buffer.available() >= limit) {
+
86  LOGI("Setting buffer active");
+
87  is_active = true;
+
88  }
+
89  delay(10);
+
90  }
+
91  return is_active;
+
92  }
+
93 
+
95  void initQueues(int bufferSizeBytes) {
+
96  buffer_count = bufferSizeBytes / 1024;
+
97  if (buffer_count <= 2){
+
98  buffer_count = 2;
+
99  }
+
100  }
+
101 
+
103  size_t writeAudio(const uint8_t *data, size_t size) override {
+
104 
+
105  if (size > buffer.size()) {
+
106  ESP_LOGE(TAG, "The buffer is too small with %d. Use a multiple of %d", buffer.size(), size);
+
107  stop();
+
108  }
+
109 
+
110  ESP_LOGI(TAG, "size: %zu / buffer %d", size, buffer.available());
+
111  if (!p_snap_output->isStarted() || size == 0) {
+
112  ESP_LOGW(TAG, "not started");
+
113  return 0;
+
114  }
+
115 
+
116  if (!p_snap_output->synchronizePlayback()) {
+
117  return size;
+
118  }
+
119 
+
120  if (!size_queue.writeArray(&size, 1)) {
+
121  ESP_LOGW(TAG, "size_queue full");
+
122  return 0;
+
123  }
+
124 
+
125  size_t size_written = buffer.writeArray(data, size);
+
126  if (size_written != size) {
+
127  ESP_LOGE(TAG, "buffer-overflow");
+
128  }
+
129 
+
130  return size;
+
131  }
+
132 };
+
133 
+
134 } // namespace snap_arduino
+
snap_arduino::SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:27
+
snap_arduino::SnapOutput::synchronizePlayback
bool synchronizePlayback()
Definition: SnapOutput.h:143
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapProcessor::begin
virtual bool begin()
Sets up the output and the client.
Definition: SnapProcessor.h:36
+
snap_arduino::SnapProcessorRP2040
Processor for which the encoded output is buffered in a queue. The decoding and audio output can be d...
Definition: SnapProcessorRP2040.h:16
+
snap_arduino::SnapProcessorRP2040::initQueues
void initQueues(int bufferSizeBytes)
store parameters provided by constructor
Definition: SnapProcessorRP2040.h:95
+
snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040
SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRP2040.h:25
+
snap_arduino::SnapProcessorRP2040::doLoop1
bool doLoop1() override
Usually not used!
Definition: SnapProcessorRP2040.h:54
+
snap_arduino::SnapProcessorRP2040::begin
bool begin() override
Sets up the output and the client.
Definition: SnapProcessorRP2040.h:31
+
snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040
SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRP2040.h:19
+
snap_arduino::SnapProcessorRP2040::writeAudio
size_t writeAudio(const uint8_t *data, size_t size) override
Writes the encoded audio data to a queue.
Definition: SnapProcessorRP2040.h:103
+
snap_arduino
Definition: SnapCommon.h:10
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/_snap_processor_r_t_o_s_8h_source.html b/docs/html/_snap_processor_r_t_o_s_8h_source.html index 74dc2ef..4828972 100644 --- a/docs/html/_snap_processor_r_t_o_s_8h_source.html +++ b/docs/html/_snap_processor_r_t_o_s_8h_source.html @@ -71,117 +71,138 @@
1 #pragma once
2 #include "SnapOutput.h"
-
3 #include "freertos-all.h" // https://github.com/pschatzmann/arduino-freertos-addons
-
4 
-
9 class SnapProcessorRTOS : public SnapProcessor {
-
10  public:
-
12  SnapProcessorRTOS(SnapOutput &output, int buffer_size,
-
13  int activationAtPercent = 75)
-
14  : SnapProcessor(output) {
-
15  init_rtos(buffer_size, activationAtPercent);
-
16  }
-
18  SnapProcessorRTOS(int buffer_size, int activationAtPercent = 75)
-
19  : SnapProcessor() {
-
20  init_rtos(buffer_size, activationAtPercent);
-
21  }
-
22 
-
23  bool begin() override {
-
24  bool result = SnapProcessor::begin();
-
25  size_queue.Flush();
-
26  buffer.reset();
-
27  return result;
-
28  }
-
29 
-
30  void end(void) override {
-
31  task.Suspend();
-
32  task_started = false;
-
33  size_queue.Flush();
-
34  buffer.reset();
-
35  SnapProcessor::end();
-
36  }
-
37 
-
38  protected:
-
39  const char *TAG = "SnapProcessorRTOS";
-
40  const uint16_t TASK_STACK_SIZE = 10 * 1024;
-
41  cpp_freertos::Task task{"output", TASK_STACK_SIZE, 1, task_copy};
-
42  cpp_freertos::Queue size_queue{200, sizeof(size_t)};
-
43  audio_tools::SynchronizedBufferRTOS<uint8_t> buffer{0};
-
44  bool task_started = false;
-
45  int active_percent;
-
46  static SnapProcessorRTOS *self;
-
47 
-
48  void init_rtos(int buffer_size, int activationAtPercent) {
-
49  self = this;
-
50  active_percent = activationAtPercent;
-
51  buffer.resize(buffer_size);
-
52  task.Start(1);
-
53  task.Suspend();
-
54  }
-
55 
-
57  size_t writeAudio(const uint8_t *data, size_t size) override {
-
58  ESP_LOGI(TAG, "%zu", size);
-
59  if (!p_snap_output->isStarted() || size == 0) {
-
60  ESP_LOGW(TAG, "not started");
-
61  return 0;
-
62  }
-
63 
-
64  if (!p_snap_output->synchronizePlayback()) {
-
65  return size;
-
66  }
+
3 #if defined(AUDIOTOOLS_MAJOR_VERSION)
+
4 # include "AudioTools/AudioLibs/Concurrency.h"
+
5 #else
+
6 # include "AudioLibs/Concurrency.h"
+
7 #endif
+
8 
+
9 namespace snap_arduino {
+
10 
+
19 class SnapProcessorRTOS : public SnapProcessor {
+
20  public:
+
22  SnapProcessorRTOS(SnapOutput &output, int buffer_size,
+
23  int activationAtPercent = 75)
+
24  : SnapProcessor(output) {
+
25  init_rtos(buffer_size, activationAtPercent);
+
26  }
+
28  SnapProcessorRTOS(int buffer_size, int activationAtPercent = 75)
+
29  : SnapProcessor() {
+
30  init_rtos(buffer_size, activationAtPercent);
+
31  }
+
32 
+
33  bool begin() override {
+
34  // regular begin logic
+
35  bool result = SnapProcessor::begin();
+
36  // allocate buffer, so that we could use psram
+
37  size_queue.resize(RTOS_MAX_QUEUE_ENTRY_COUNT);
+
38  size_queue.setWriteMaxWait(5);
+
39  buffer.resize(buffer_size);
+
40  return result;
+
41  }
+
42 
+
43  void end(void) override {
+
44  task.suspend();
+
45  task_started = false;
+
46  size_queue.clear();
+
47  buffer.reset();
+
48  SnapProcessor::end();
+
49  }
+
50 
+
51  protected:
+
52  const char *TAG = "SnapProcessorRTOS";
+
53  audio_tools::Task task{"output", RTOS_STACK_SIZE, RTOS_TASK_PRIORITY, 1};
+
54  audio_tools::QueueRTOS<size_t> size_queue{0};
+
55  audio_tools::BufferRTOS<uint8_t> buffer{0}; // size defined in constructor
+
56  bool task_started = false;
+
57  int active_percent;
+
58  int buffer_size;
+
59  static SnapProcessorRTOS *self;
+
60 
+
62  void init_rtos(int bufferSize, int activationAtPercent) {
+
63  self = this;
+
64  active_percent = activationAtPercent;
+
65  buffer_size = bufferSize;
+
66  }
67 
-
68  if (!size_queue.Enqueue(&size, 5)) {
-
69  ESP_LOGW(TAG, "size_queue full");
-
70  return 0;
-
71  }
-
72  size_t size_written = buffer.writeArray(data, size);
-
73  if (size_written != size) {
-
74  ESP_LOGE(TAG, "buffer-overflow");
-
75  }
-
76 
-
77  ESP_LOGD(TAG, "buffer %d - %d vs limit %d", size, buffer.available(),
-
78  bufferTaskActivationLimit());
-
79  if (!task_started && buffer.available() > bufferTaskActivationLimit()) {
-
80  ESP_LOGI(TAG, "===> starting output task");
-
81  task_started = true;
-
82  task.Resume();
-
83  }
-
84  return size_written;
-
85  }
-
86 
-
88  int bufferTaskActivationLimit() {
-
89  return static_cast<float>(active_percent) / 100.0 * buffer.size();
-
90  }
-
91 
-
93  void copy() {
-
94  size_t size = 0;
-
95  if (size_queue.Dequeue(&size)) {
-
96  uint8_t data[size];
-
97  int read = buffer.readArray(data, size);
-
98  assert(read == size);
-
99  int written = p_snap_output->audioWrite(data, size);
-
100  if (written != size) {
-
101  ESP_LOGW(TAG, "write %d of %d", written, size);
-
102  }
-
103  }
-
104  delay(1);
+
69  size_t writeAudio(const uint8_t *data, size_t size) override {
+
70 
+
71  if (size > buffer.size()){
+
72  ESP_LOGE(TAG, "The buffer is too small. Use a multiple of %d", size);
+
73  stop();
+
74  }
+
75 
+
76  ESP_LOGI(TAG, "size: %zu / buffer %d", size, buffer.available());
+
77  if (!p_snap_output->isStarted() || size == 0) {
+
78  ESP_LOGW(TAG, "not started");
+
79  return 0;
+
80  }
+
81 
+
82  if (!p_snap_output->synchronizePlayback()) {
+
83  return size;
+
84  }
+
85 
+
86  if (!size_queue.enqueue(size)) {
+
87  ESP_LOGW(TAG, "size_queue full");
+
88  return 0;
+
89  }
+
90 
+
91  size_t size_written = buffer.writeArray(data, size);
+
92  if (size_written != size) {
+
93  ESP_LOGE(TAG, "buffer-overflow");
+
94  }
+
95 
+
96  ESP_LOGD(TAG, "buffer %d - %d vs limit %d", size, buffer.available(),
+
97  bufferTaskActivationLimit());
+
98  if (!task_started && buffer.available() > bufferTaskActivationLimit()) {
+
99  ESP_LOGI(TAG, "===> starting output task");
+
100  task_started = true;
+
101  task.begin(task_copy);
+
102  }
+
103 
+
104  return size_written;
105  }
106 
-
108  static void task_copy() {
-
109  while (self != nullptr) self->copy();
+
108  int bufferTaskActivationLimit() {
+
109  return static_cast<float>(active_percent) / 100.0 * buffer.size();
110  }
-
111 };
-
112 
-
113 SnapProcessorRTOS *SnapProcessorRTOS::self = nullptr;
-
SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:26
-
SnapOutput::synchronizePlayback
bool synchronizePlayback()
Definition: SnapOutput.h:209
-
SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:19
-
SnapProcessorRTOS
Definition: SnapProcessorRTOS.h:9
-
SnapProcessorRTOS::task_copy
static void task_copy()
static method for rtos task: make sure we constantly output audio
Definition: SnapProcessorRTOS.h:108
-
SnapProcessorRTOS::SnapProcessorRTOS
SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRTOS.h:12
-
SnapProcessorRTOS::bufferTaskActivationLimit
int bufferTaskActivationLimit()
Determines the buffer fill limit at which we start to process the data.
Definition: SnapProcessorRTOS.h:88
-
SnapProcessorRTOS::SnapProcessorRTOS
SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRTOS.h:18
-
SnapProcessorRTOS::copy
void copy()
Copy the buffered data to the output.
Definition: SnapProcessorRTOS.h:93
-
SnapProcessorRTOS::writeAudio
size_t writeAudio(const uint8_t *data, size_t size) override
Writes the encoded audio data to a queue.
Definition: SnapProcessorRTOS.h:57
+
111 
+
113  void copy() {
+
114  size_t size = 0;
+
115  if (size_queue.dequeue(size)) {
+
116  uint8_t data[size];
+
117  int read = buffer.readArray(data, size);
+
118  assert(read == size);
+
119  int written = p_snap_output->audioWrite(data, size);
+
120  if (written != size) {
+
121  ESP_LOGW(TAG, "write %d of %d", written, size);
+
122  }
+
123  }
+
124  delay(1);
+
125  }
+
126 
+
128  static void task_copy() {
+
129  while (self != nullptr) self->copy();
+
130  }
+
131 };
+
132 
+
133 SnapProcessorRTOS *SnapProcessorRTOS::self = nullptr;
+
134 
+
135 }
+
snap_arduino::SnapOutput
Simple Output Class which uses the AudioTools to build an output chain with volume control and a resa...
Definition: SnapOutput.h:27
+
snap_arduino::SnapOutput::synchronizePlayback
bool synchronizePlayback()
Definition: SnapOutput.h:143
+
snap_arduino::SnapProcessor
Snap Processor implementation which does not rely on FreeRTOS.
Definition: SnapProcessor.h:21
+
snap_arduino::SnapProcessor::begin
virtual bool begin()
Sets up the output and the client.
Definition: SnapProcessor.h:36
+
snap_arduino::SnapProcessorRTOS
Processor for which the encoded output is buffered in a queue in order to prevent any buffer underrun...
Definition: SnapProcessorRTOS.h:19
+
snap_arduino::SnapProcessorRTOS::task_copy
static void task_copy()
static method for rtos task: make sure we constantly output audio
Definition: SnapProcessorRTOS.h:128
+
snap_arduino::SnapProcessorRTOS::init_rtos
void init_rtos(int bufferSize, int activationAtPercent)
store parameters provided by constructor
Definition: SnapProcessorRTOS.h:62
+
snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS
SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRTOS.h:22
+
snap_arduino::SnapProcessorRTOS::bufferTaskActivationLimit
int bufferTaskActivationLimit()
Determines the buffer fill limit at which we start to process the data.
Definition: SnapProcessorRTOS.h:108
+
snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS
SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)
Default constructor.
Definition: SnapProcessorRTOS.h:28
+
snap_arduino::SnapProcessorRTOS::copy
void copy()
Copy the buffered data to the output.
Definition: SnapProcessorRTOS.h:113
+
snap_arduino::SnapProcessorRTOS::begin
bool begin() override
Sets up the output and the client.
Definition: SnapProcessorRTOS.h:33
+
snap_arduino::SnapProcessorRTOS::writeAudio
size_t writeAudio(const uint8_t *data, size_t size) override
Writes the encoded audio data to a queue.
Definition: SnapProcessorRTOS.h:69
+
snap_arduino
Definition: SnapCommon.h:10
diff --git a/docs/html/_snap_protocol_8h_source.html b/docs/html/_snap_protocol_8h_source.html index e3e232f..d165c1e 100644 --- a/docs/html/_snap_protocol_8h_source.html +++ b/docs/html/_snap_protocol_8h_source.html @@ -86,445 +86,450 @@
18 #define TIME_MESSAGE_SIZE 8
19 #define MAX_JSON_LEN 256
20 
-
22 struct SnapReadBuffer {
-
23  const char *buffer;
-
24  size_t size, index;
-
25 
-
26  void begin(const char *data, size_t size) {
-
27  this->buffer = data;
-
28  this->size = size;
-
29  this->index = 0;
-
30  }
-
31 
-
32  int read(char *data, size_t size) {
-
33  int i;
-
34 
-
35  if (this->size - this->index < size) {
-
36  return 1;
-
37  }
-
38 
-
39  for (i = 0; i < size; i++) {
-
40  data[i] = this->buffer[this->index++];
-
41  }
-
42 
-
43  return 0;
-
44  }
-
45 
-
46  int read_uint32(uint32_t *data) {
-
47  if (this->size - this->index < sizeof(uint32_t)) {
-
48  return 1;
-
49  }
-
50 
-
51  *data = this->buffer[this->index++] & 0xff;
-
52  *data |= (this->buffer[this->index++] & 0xff) << 8;
-
53  *data |= (this->buffer[this->index++] & 0xff) << 16;
-
54  *data |= (this->buffer[this->index++] & 0xff) << 24;
-
55  return 0;
-
56  }
-
57 
-
58  int read_uint16(uint16_t *data) {
-
59  if (this->size - this->index < sizeof(uint16_t)) {
-
60  return 1;
-
61  }
-
62 
-
63  *data = this->buffer[this->index++] & 0xff;
-
64  *data |= (this->buffer[this->index++] & 0xff) << 8;
-
65  return 0;
-
66  }
-
67 
-
68  int read_uint8(uint8_t *data) {
-
69  if (this->size - this->index < sizeof(uint8_t)) {
-
70  return 1;
-
71  }
-
72 
-
73  *data = this->buffer[this->index++] & 0xff;
-
74  return 0;
-
75  }
-
76 
-
77  int read_int32(int32_t *data) {
-
78  if (this->size - this->index < sizeof(int32_t)) {
-
79  return 1;
-
80  }
-
81 
-
82  *data = this->buffer[this->index++] & 0xff;
-
83  *data |= (this->buffer[this->index++] & 0xff) << 8;
-
84  *data |= (this->buffer[this->index++] & 0xff) << 16;
-
85  *data |= (this->buffer[this->index++] & 0xff) << 24;
-
86  return 0;
-
87  }
-
88 
-
89  int read_int16(int16_t *data) {
-
90  if (this->size - this->index < sizeof(int16_t)) {
-
91  return 1;
-
92  }
-
93 
-
94  *data = this->buffer[this->index++] & 0xff;
-
95  *data |= (this->buffer[this->index++] & 0xff) << 8;
-
96  return 0;
-
97  }
-
98 
-
99  int read_int8(int8_t *data) {
-
100  if (this->size - this->index < sizeof(int8_t)) {
-
101  return 1;
-
102  }
-
103 
-
104  *data = this->buffer[this->index++] & 0xff;
-
105  return 0;
-
106  }
-
107 };
-
108 
-
110 struct SnapWriteBuffer {
-
111  char *buffer;
-
112  size_t size, index;
-
113 
-
114  void begin(char *data, size_t size) {
-
115  this->buffer = data;
-
116  this->size = size;
-
117  this->index = 0;
-
118  }
-
119 
-
120  int write(const char *data, size_t size) {
-
121  int i;
-
122 
-
123  if (this->size - this->index < size) {
-
124  return 1;
-
125  }
-
126 
-
127  for (i = 0; i < size; i++) {
-
128  this->buffer[this->index++] = data[i];
-
129  }
-
130 
-
131  return 0;
-
132  }
-
133 
-
134  int write_uint32(uint32_t data) {
-
135  if (this->size - this->index < sizeof(uint32_t)) {
-
136  return 1;
-
137  }
-
138 
-
139  this->buffer[this->index++] = data & 0xff;
-
140  this->buffer[this->index++] = (data >> 8) & 0xff;
-
141  this->buffer[this->index++] = (data >> 16) & 0xff;
-
142  this->buffer[this->index++] = (data >> 24) & 0xff;
-
143  return 0;
-
144  }
-
145 
-
146  int write_uint16(uint16_t data) {
-
147  if (this->size - this->index < sizeof(uint16_t)) {
-
148  return 1;
-
149  }
-
150 
-
151  this->buffer[this->index++] = data & 0xff;
-
152  this->buffer[this->index++] = (data >> 8) & 0xff;
-
153  return 0;
-
154  }
-
155 
-
156  int write_uint8(uint8_t data) {
-
157  if (this->size - this->index < sizeof(uint8_t)) {
-
158  return 1;
-
159  }
-
160 
-
161  this->buffer[this->index++] = data & 0xff;
-
162  return 0;
-
163  }
-
164 
-
165  int write_int32(int32_t data) {
-
166  if (this->size - this->index < sizeof(int32_t)) {
-
167  return 1;
-
168  }
-
169 
-
170  this->buffer[this->index++] = data & 0xff;
-
171  this->buffer[this->index++] = (data >> 8) & 0xff;
-
172  this->buffer[this->index++] = (data >> 16) & 0xff;
-
173  this->buffer[this->index++] = (data >> 24) & 0xff;
-
174  return 0;
-
175  }
-
176 
-
177  int write_int16(int16_t data) {
-
178  if (this->size - this->index < sizeof(int16_t)) {
-
179  return 1;
-
180  }
-
181 
-
182  this->buffer[this->index++] = data & 0xff;
-
183  this->buffer[this->index++] = (data >> 8) & 0xff;
-
184  return 0;
-
185  }
-
186 
-
187  int write_int8(int8_t data) {
-
188  if (this->size - this->index < sizeof(int8_t)) {
-
189  return 1;
-
190  }
-
191 
-
192  this->buffer[this->index++] = data & 0xff;
-
193  return 0;
-
194  }
-
195 };
-
196 
-
197 enum MessageType {
-
198  SNAPCAST_MESSAGE_BASE = 0,
-
199  SNAPCAST_MESSAGE_CODEC_HEADER = 1,
-
200  SNAPCAST_MESSAGE_WIRE_CHUNK = 2,
-
201  SNAPCAST_MESSAGE_SERVER_SETTINGS = 3,
-
202  SNAPCAST_MESSAGE_TIME = 4,
-
203  SNAPCAST_MESSAGE_HELLO = 5,
-
204  SNAPCAST_MESSAGE_STREAM_TAGS = 6,
-
205  SNAPCAST_MESSAGE_FIRST = SNAPCAST_MESSAGE_BASE,
-
206  SNAPCAST_MESSAGE_LAST = SNAPCAST_MESSAGE_STREAM_TAGS
-
207 };
-
208 
-
210 struct tv_t {
-
211  int32_t sec;
-
212  int32_t usec;
-
213 };
-
214 
-
216 struct SnapMessageBase {
-
217  uint16_t type;
-
218  uint16_t id;
-
219  uint16_t refersTo;
-
220  tv_t sent;
-
221  tv_t received;
-
222  uint32_t size;
-
223 
-
224  int serialize(char *data, uint32_t reqSize) {
-
225  SnapWriteBuffer buffer;
-
226  int result = 0;
-
227 
-
228  buffer.begin(data, reqSize);
+
21 namespace snap_arduino {
+
22 
+
24 struct SnapReadBuffer {
+
25  const char *buffer;
+
26  size_t size, index;
+
27 
+
28  void begin(const char *data, size_t size) {
+
29  this->buffer = data;
+
30  this->size = size;
+
31  this->index = 0;
+
32  }
+
33 
+
34  int read(char *data, size_t size) {
+
35  int i;
+
36 
+
37  if (this->size - this->index < size) {
+
38  return 1;
+
39  }
+
40 
+
41  for (i = 0; i < size; i++) {
+
42  data[i] = this->buffer[this->index++];
+
43  }
+
44 
+
45  return 0;
+
46  }
+
47 
+
48  int read_uint32(uint32_t *data) {
+
49  if (this->size - this->index < sizeof(uint32_t)) {
+
50  return 1;
+
51  }
+
52 
+
53  *data = this->buffer[this->index++] & 0xff;
+
54  *data |= (this->buffer[this->index++] & 0xff) << 8;
+
55  *data |= (this->buffer[this->index++] & 0xff) << 16;
+
56  *data |= (this->buffer[this->index++] & 0xff) << 24;
+
57  return 0;
+
58  }
+
59 
+
60  int read_uint16(uint16_t *data) {
+
61  if (this->size - this->index < sizeof(uint16_t)) {
+
62  return 1;
+
63  }
+
64 
+
65  *data = this->buffer[this->index++] & 0xff;
+
66  *data |= (this->buffer[this->index++] & 0xff) << 8;
+
67  return 0;
+
68  }
+
69 
+
70  int read_uint8(uint8_t *data) {
+
71  if (this->size - this->index < sizeof(uint8_t)) {
+
72  return 1;
+
73  }
+
74 
+
75  *data = this->buffer[this->index++] & 0xff;
+
76  return 0;
+
77  }
+
78 
+
79  int read_int32(int32_t *data) {
+
80  if (this->size - this->index < sizeof(int32_t)) {
+
81  return 1;
+
82  }
+
83 
+
84  *data = this->buffer[this->index++] & 0xff;
+
85  *data |= (this->buffer[this->index++] & 0xff) << 8;
+
86  *data |= (this->buffer[this->index++] & 0xff) << 16;
+
87  *data |= (this->buffer[this->index++] & 0xff) << 24;
+
88  return 0;
+
89  }
+
90 
+
91  int read_int16(int16_t *data) {
+
92  if (this->size - this->index < sizeof(int16_t)) {
+
93  return 1;
+
94  }
+
95 
+
96  *data = this->buffer[this->index++] & 0xff;
+
97  *data |= (this->buffer[this->index++] & 0xff) << 8;
+
98  return 0;
+
99  }
+
100 
+
101  int read_int8(int8_t *data) {
+
102  if (this->size - this->index < sizeof(int8_t)) {
+
103  return 1;
+
104  }
+
105 
+
106  *data = this->buffer[this->index++] & 0xff;
+
107  return 0;
+
108  }
+
109 };
+
110 
+
112 struct SnapWriteBuffer {
+
113  char *buffer;
+
114  size_t size, index;
+
115 
+
116  void begin(char *data, size_t size) {
+
117  this->buffer = data;
+
118  this->size = size;
+
119  this->index = 0;
+
120  }
+
121 
+
122  int write(const char *data, size_t size) {
+
123  int i;
+
124 
+
125  if (this->size - this->index < size) {
+
126  return 1;
+
127  }
+
128 
+
129  for (i = 0; i < size; i++) {
+
130  this->buffer[this->index++] = data[i];
+
131  }
+
132 
+
133  return 0;
+
134  }
+
135 
+
136  int write_uint32(uint32_t data) {
+
137  if (this->size - this->index < sizeof(uint32_t)) {
+
138  return 1;
+
139  }
+
140 
+
141  this->buffer[this->index++] = data & 0xff;
+
142  this->buffer[this->index++] = (data >> 8) & 0xff;
+
143  this->buffer[this->index++] = (data >> 16) & 0xff;
+
144  this->buffer[this->index++] = (data >> 24) & 0xff;
+
145  return 0;
+
146  }
+
147 
+
148  int write_uint16(uint16_t data) {
+
149  if (this->size - this->index < sizeof(uint16_t)) {
+
150  return 1;
+
151  }
+
152 
+
153  this->buffer[this->index++] = data & 0xff;
+
154  this->buffer[this->index++] = (data >> 8) & 0xff;
+
155  return 0;
+
156  }
+
157 
+
158  int write_uint8(uint8_t data) {
+
159  if (this->size - this->index < sizeof(uint8_t)) {
+
160  return 1;
+
161  }
+
162 
+
163  this->buffer[this->index++] = data & 0xff;
+
164  return 0;
+
165  }
+
166 
+
167  int write_int32(int32_t data) {
+
168  if (this->size - this->index < sizeof(int32_t)) {
+
169  return 1;
+
170  }
+
171 
+
172  this->buffer[this->index++] = data & 0xff;
+
173  this->buffer[this->index++] = (data >> 8) & 0xff;
+
174  this->buffer[this->index++] = (data >> 16) & 0xff;
+
175  this->buffer[this->index++] = (data >> 24) & 0xff;
+
176  return 0;
+
177  }
+
178 
+
179  int write_int16(int16_t data) {
+
180  if (this->size - this->index < sizeof(int16_t)) {
+
181  return 1;
+
182  }
+
183 
+
184  this->buffer[this->index++] = data & 0xff;
+
185  this->buffer[this->index++] = (data >> 8) & 0xff;
+
186  return 0;
+
187  }
+
188 
+
189  int write_int8(int8_t data) {
+
190  if (this->size - this->index < sizeof(int8_t)) {
+
191  return 1;
+
192  }
+
193 
+
194  this->buffer[this->index++] = data & 0xff;
+
195  return 0;
+
196  }
+
197 };
+
198 
+
199 enum MessageType {
+
200  SNAPCAST_MESSAGE_BASE = 0,
+
201  SNAPCAST_MESSAGE_CODEC_HEADER = 1,
+
202  SNAPCAST_MESSAGE_WIRE_CHUNK = 2,
+
203  SNAPCAST_MESSAGE_SERVER_SETTINGS = 3,
+
204  SNAPCAST_MESSAGE_TIME = 4,
+
205  SNAPCAST_MESSAGE_HELLO = 5,
+
206  SNAPCAST_MESSAGE_STREAM_TAGS = 6,
+
207  SNAPCAST_MESSAGE_FIRST = SNAPCAST_MESSAGE_BASE,
+
208  SNAPCAST_MESSAGE_LAST = SNAPCAST_MESSAGE_STREAM_TAGS
+
209 };
+
210 
+
212 struct tv_t {
+
213  int32_t sec;
+
214  int32_t usec;
+
215 };
+
216 
+
218 struct SnapMessageBase {
+
219  uint16_t type;
+
220  uint16_t id;
+
221  uint16_t refersTo;
+
222  tv_t sent;
+
223  tv_t received;
+
224  uint32_t size;
+
225 
+
226  int serialize(char *data, uint32_t reqSize) {
+
227  SnapWriteBuffer buffer;
+
228  int result = 0;
229 
-
230  result |= buffer.write_uint16(this->type);
-
231  result |= buffer.write_uint16(this->id);
-
232  result |= buffer.write_uint16(this->refersTo);
-
233  result |= buffer.write_int32(this->sent.sec);
-
234  result |= buffer.write_int32(this->sent.usec);
-
235  result |= buffer.write_int32(this->received.sec);
-
236  result |= buffer.write_int32(this->received.usec);
-
237  result |= buffer.write_uint32(this->size);
-
238 
-
239  return result;
-
240  }
-
241 
-
242  int deserialize(const char *data, uint32_t reqSize) {
-
243  SnapReadBuffer buffer;
-
244  int result = 0;
-
245 
-
246  buffer.begin(data, reqSize);
+
230  buffer.begin(data, reqSize);
+
231 
+
232  result |= buffer.write_uint16(this->type);
+
233  result |= buffer.write_uint16(this->id);
+
234  result |= buffer.write_uint16(this->refersTo);
+
235  result |= buffer.write_int32(this->sent.sec);
+
236  result |= buffer.write_int32(this->sent.usec);
+
237  result |= buffer.write_int32(this->received.sec);
+
238  result |= buffer.write_int32(this->received.usec);
+
239  result |= buffer.write_uint32(this->size);
+
240 
+
241  return result;
+
242  }
+
243 
+
244  int deserialize(const char *data, uint32_t reqSize) {
+
245  SnapReadBuffer buffer;
+
246  int result = 0;
247 
-
248  result |= buffer.read_uint16(&(this->type));
-
249  result |= buffer.read_uint16(&(this->id));
-
250  result |= buffer.read_uint16(&(this->refersTo));
-
251  result |= buffer.read_int32(&(this->sent.sec));
-
252  result |= buffer.read_int32(&(this->sent.usec));
-
253  result |= buffer.read_int32(&(this->received.sec));
-
254  result |= buffer.read_int32(&(this->received.usec));
-
255  result |= buffer.read_uint32(&(this->size));
-
256 
-
257  return result;
-
258  }
-
259 };
-
260 
-
261 
-
263 struct SnapMessageHallo {
-
264  const char *mac;
-
265  const char *hostname;
-
266  const char *version;
-
267  const char *client_name;
-
268  const char *os;
-
269  const char *arch;
-
270  int instance;
-
271  const char *id;
-
272  int protocol_version;
-
273 
-
274 
-
275  char *serialize(size_t *size) {
-
276  int str_length, prefixed_length;
-
277 
-
278  to_json();
-
279  str_length = strlen(json_result);
-
280  // result must end with closing baces
-
281  if (json_result[str_length - 1] != '}'){
-
282  ESP_LOGE(TAG, "invalid json: %s - MAX_JSON_LEN too small?", json_result);
-
283  return nullptr;
-
284  }
-
285 
-
286  prefixed_length = str_length + 4;
-
287  // add header information with length
-
288  result[0] = str_length & 0xff;
-
289  result[1] = (str_length >> 8) & 0xff;
-
290  result[2] = (str_length >> 16) & 0xff;
-
291  result[3] = (str_length >> 24) & 0xff;
-
292  *size = prefixed_length;
-
293 
-
294  return result;
-
295  }
-
296 
-
297 protected:
-
298  char result[MAX_JSON_LEN];
-
299  char* json_result = result + 4;
-
300  const char *TAG = "SnapMessageHallo";
-
301  // Removed dependency to json library because of the overhead: this should be good enough!
-
302  // e.g {"MAC":"A8:48:FA:0B:93:40","HostName":"arduino-snapclient","Version":"0.0.2","ClientName":"libsnapcast","OS":"esp32","Arch":"xtensa","Instance":1,"ID":"A8:48:FA:0B:93:40","SnapStreamProtocolVersion":2}
-
303  void to_json() {
-
304  const char *fmt =
-
305  "{\"MAC\":\"%s\",\"HostName\":\"%s\",\"Version\":\"%s\",\"ClientName\":\"%s\",\"OS\":\"%s\""
-
306  ",\"Arch\":\"%s\",\"Instance\":%d,\"ID\":\"%s\",\"SnapStreamProtocolVersion\":%d}";
-
307  snprintf(json_result, MAX_JSON_LEN - 4, fmt, mac, hostname, version, client_name,
-
308  os, arch, instance, id, protocol_version);
-
309  ESP_LOGD(TAG, "%s", json_result);
-
310  }
-
311 };
-
312 
-
314 struct SnapMessageServerSettings {
-
315  int32_t buffer_ms = 0;
-
316  int32_t latency = 0;
-
317  uint32_t volume = 0;
-
318  bool muted = false;
-
319 
-
320  int deserialize(const char *json) {
-
321  if (json == nullptr)
-
322  return 1;
-
323  ESP_LOGD("SnapMessageServerSettings", "%s", json);
-
324 
-
325  // Removed dependency to json library: this should be good enough!
-
326  audio_tools::Str json_str(json);
-
327  // parse e.g. {"bufferMs":1000,"latency":0,"muted":false,"volume":57}:
-
328  int idx = json_str.indexOf("bufferMs");
-
329  if (idx > 0) {
-
330  buffer_ms = atoi(json + idx + 10);
-
331  ESP_LOGD(TAG, "bufferMs: %d", buffer_ms);
-
332  }
-
333  idx = json_str.indexOf("latency");
-
334  if (idx > 0) {
-
335  latency = atoi(json + idx + 9);
-
336  ESP_LOGD(TAG, "latency: %d", latency);
-
337  }
-
338  idx = json_str.indexOf("volume");
-
339  if (idx > 0) {
-
340  volume = atoi(json + idx + 8);
-
341  ESP_LOGD(TAG, "volume: %d", volume);
-
342  }
-
343  idx = json_str.indexOf("muted");
-
344  if (idx > 0) {
-
345  // set to true if we find a true string
-
346  muted = json_str.indexOf("true") > idx;
-
347  ESP_LOGD(TAG, "muted: %s", muted ? "true" : "false");
-
348  }
-
349 
-
350  return 0;
-
351  }
-
352 };
-
353 
-
355 struct SnapMessageCodecHeader {
-
356  std::vector<char> v_codec;
-
357  uint32_t size;
-
358  std::vector<char> v_payload;
-
359 
-
360  char *payload() { return &v_payload[0]; }
-
361  char *codec() { return &v_codec[0]; }
-
362 
-
363  int deserialize(const char *data, uint32_t reqSize) {
-
364  SnapReadBuffer buffer;
-
365  uint32_t string_size;
-
366  int result = 0;
-
367 
-
368  buffer.begin(data, reqSize);
-
369 
-
370  result |= buffer.read_uint32(&string_size);
-
371  if (result) {
-
372  // Can\"t allocate the proper size string if we didn\"t read the size, so
-
373  // fail early
-
374  return 1;
-
375  }
-
376 
-
377  if (v_codec.size() < string_size + 1)
-
378  v_codec.resize(string_size + 1);
-
379 
-
380  result |= buffer.read(codec(), string_size);
-
381  // Make sure the codec is a proper C string by terminating it with a null
-
382  // character
-
383  this->codec()[string_size] = '\0';
-
384 
-
385  result |= buffer.read_uint32(&(this->size));
-
386  if (result) {
-
387  // Can't allocate the proper size string if we didn't read the size, so
-
388  // fail early
-
389  return 1;
-
390  }
-
391 
-
392  if (v_payload.size() < reqSize)
-
393  v_payload.resize(reqSize);
-
394 
-
395  result |= buffer.read(payload(), this->size);
-
396  return result;
-
397  }
-
398 };
-
399 
-
401 struct SnapMessageWireChunk {
-
402  tv_t timestamp;
-
403  uint32_t size;
-
404  char *payload = nullptr;
-
405 
-
406  int deserialize(const char *data, uint32_t reqSize) {
-
407  SnapReadBuffer buffer;
-
408  int result = 0;
-
409 
-
410  buffer.begin(data, reqSize);
+
248  buffer.begin(data, reqSize);
+
249 
+
250  result |= buffer.read_uint16(&(this->type));
+
251  result |= buffer.read_uint16(&(this->id));
+
252  result |= buffer.read_uint16(&(this->refersTo));
+
253  result |= buffer.read_int32(&(this->sent.sec));
+
254  result |= buffer.read_int32(&(this->sent.usec));
+
255  result |= buffer.read_int32(&(this->received.sec));
+
256  result |= buffer.read_int32(&(this->received.usec));
+
257  result |= buffer.read_uint32(&(this->size));
+
258 
+
259  return result;
+
260  }
+
261 };
+
262 
+
263 
+
265 struct SnapMessageHallo {
+
266  const char *mac;
+
267  const char *hostname;
+
268  const char *version;
+
269  const char *client_name;
+
270  const char *os;
+
271  const char *arch;
+
272  int instance;
+
273  const char *id;
+
274  int protocol_version;
+
275 
+
276 
+
277  char *serialize(size_t *size) {
+
278  int str_length, prefixed_length;
+
279 
+
280  to_json();
+
281  str_length = strlen(json_result);
+
282  // result must end with closing baces
+
283  if (json_result[str_length - 1] != '}'){
+
284  ESP_LOGE(TAG, "invalid json: %s - MAX_JSON_LEN too small?", json_result);
+
285  return nullptr;
+
286  }
+
287 
+
288  prefixed_length = str_length + 4;
+
289  // add header information with length
+
290  result[0] = str_length & 0xff;
+
291  result[1] = (str_length >> 8) & 0xff;
+
292  result[2] = (str_length >> 16) & 0xff;
+
293  result[3] = (str_length >> 24) & 0xff;
+
294  *size = prefixed_length;
+
295 
+
296  return result;
+
297  }
+
298 
+
299 protected:
+
300  char result[MAX_JSON_LEN];
+
301  char* json_result = result + 4;
+
302  const char *TAG = "SnapMessageHallo";
+
303  // Removed dependency to json library because of the overhead: this should be good enough!
+
304  // e.g {"MAC":"A8:48:FA:0B:93:40","HostName":"arduino-snapclient","Version":"0.0.2","ClientName":"libsnapcast","OS":"esp32","Arch":"xtensa","Instance":1,"ID":"A8:48:FA:0B:93:40","SnapStreamProtocolVersion":2}
+
305  void to_json() {
+
306  const char *fmt =
+
307  "{\"MAC\":\"%s\",\"HostName\":\"%s\",\"Version\":\"%s\",\"ClientName\":\"%s\",\"OS\":\"%s\""
+
308  ",\"Arch\":\"%s\",\"Instance\":%d,\"ID\":\"%s\",\"SnapStreamProtocolVersion\":%d}";
+
309  snprintf(json_result, MAX_JSON_LEN - 4, fmt, mac, hostname, version, client_name,
+
310  os, arch, instance, id, protocol_version);
+
311  ESP_LOGD(TAG, "%s", json_result);
+
312  }
+
313 };
+
314 
+
316 struct SnapMessageServerSettings {
+
317  int32_t buffer_ms = 0;
+
318  int32_t latency = 0;
+
319  uint32_t volume = 0;
+
320  bool muted = false;
+
321 
+
322  int deserialize(const char *json) {
+
323  if (json == nullptr)
+
324  return 1;
+
325  ESP_LOGD("SnapMessageServerSettings", "%s", json);
+
326 
+
327  // Removed dependency to json library: this should be good enough!
+
328  audio_tools::Str json_str(json);
+
329  // parse e.g. {"bufferMs":1000,"latency":0,"muted":false,"volume":57}:
+
330  int idx = json_str.indexOf("bufferMs");
+
331  if (idx > 0) {
+
332  buffer_ms = atoi(json + idx + 10);
+
333  ESP_LOGD(TAG, "bufferMs: %d", buffer_ms);
+
334  }
+
335  idx = json_str.indexOf("latency");
+
336  if (idx > 0) {
+
337  latency = atoi(json + idx + 9);
+
338  ESP_LOGD(TAG, "latency: %d", latency);
+
339  }
+
340  idx = json_str.indexOf("volume");
+
341  if (idx > 0) {
+
342  volume = atoi(json + idx + 8);
+
343  ESP_LOGD(TAG, "volume: %d", volume);
+
344  }
+
345  idx = json_str.indexOf("muted");
+
346  if (idx > 0) {
+
347  // set to true if we find a true string
+
348  muted = json_str.indexOf("true") > idx;
+
349  ESP_LOGD(TAG, "muted: %s", muted ? "true" : "false");
+
350  }
+
351 
+
352  return 0;
+
353  }
+
354 };
+
355 
+
357 struct SnapMessageCodecHeader {
+
358  std::vector<char> v_codec;
+
359  uint32_t size;
+
360  std::vector<char> v_payload;
+
361 
+
362  char *payload() { return &v_payload[0]; }
+
363  char *codec() { return &v_codec[0]; }
+
364 
+
365  int deserialize(const char *data, uint32_t reqSize) {
+
366  SnapReadBuffer buffer;
+
367  uint32_t string_size;
+
368  int result = 0;
+
369 
+
370  buffer.begin(data, reqSize);
+
371 
+
372  result |= buffer.read_uint32(&string_size);
+
373  if (result) {
+
374  // Can\"t allocate the proper size string if we didn\"t read the size, so
+
375  // fail early
+
376  return 1;
+
377  }
+
378 
+
379  if (v_codec.size() < string_size + 1)
+
380  v_codec.resize(string_size + 1);
+
381 
+
382  result |= buffer.read(codec(), string_size);
+
383  // Make sure the codec is a proper C string by terminating it with a null
+
384  // character
+
385  this->codec()[string_size] = '\0';
+
386 
+
387  result |= buffer.read_uint32(&(this->size));
+
388  if (result) {
+
389  // Can't allocate the proper size string if we didn't read the size, so
+
390  // fail early
+
391  return 1;
+
392  }
+
393 
+
394  if (v_payload.size() < reqSize)
+
395  v_payload.resize(reqSize);
+
396 
+
397  result |= buffer.read(payload(), this->size);
+
398  return result;
+
399  }
+
400 };
+
401 
+
403 struct SnapMessageWireChunk {
+
404  tv_t timestamp;
+
405  uint32_t size;
+
406  char *payload = nullptr;
+
407 
+
408  int deserialize(const char *data, uint32_t reqSize) {
+
409  SnapReadBuffer buffer;
+
410  int result = 0;
411 
-
412  result |= buffer.read_int32(&(this->timestamp.sec));
-
413  result |= buffer.read_int32(&(this->timestamp.usec));
-
414  result |= buffer.read_uint32(&(this->size));
-
415 
-
416  // If there\"s been an error already (especially for the size bit) return
-
417  // early
-
418  if (result) {
-
419  return result;
-
420  }
-
421 
-
422  // avoid malloc we just provide the pointer to the data in the
-
423  // buffer
-
424  if (buffer.size - buffer.index < this->size) {
-
425  return 1;
-
426  }
-
427  this->payload = (char *)&buffer.buffer[buffer.index];
-
428  return result;
-
429  }
-
430 };
-
431 
-
433 struct SnapMessageTime {
-
434  tv_t latency;
-
435 
-
436  int serialize(char *data, uint32_t size) {
-
437  SnapWriteBuffer buffer;
-
438  int result = 0;
-
439 
-
440  buffer.begin(data, size);
+
412  buffer.begin(data, reqSize);
+
413 
+
414  result |= buffer.read_int32(&(this->timestamp.sec));
+
415  result |= buffer.read_int32(&(this->timestamp.usec));
+
416  result |= buffer.read_uint32(&(this->size));
+
417 
+
418  // If there\"s been an error already (especially for the size bit) return
+
419  // early
+
420  if (result) {
+
421  return result;
+
422  }
+
423 
+
424  // avoid malloc we just provide the pointer to the data in the
+
425  // buffer
+
426  if (buffer.size - buffer.index < this->size) {
+
427  return 1;
+
428  }
+
429  this->payload = (char *)&buffer.buffer[buffer.index];
+
430  return result;
+
431  }
+
432 };
+
433 
+
435 struct SnapMessageTime {
+
436  tv_t latency;
+
437 
+
438  int serialize(char *data, uint32_t size) {
+
439  SnapWriteBuffer buffer;
+
440  int result = 0;
441 
-
442  result |= buffer.write_int32(this->latency.sec);
-
443  result |= buffer.write_int32(this->latency.usec);
-
444 
-
445  return result;
-
446  }
-
447 
-
448  int deserialize(const char *data, uint32_t size) {
-
449  SnapReadBuffer buffer;
-
450  int result = 0;
-
451 
-
452  buffer.begin(data, size);
+
442  buffer.begin(data, size);
+
443 
+
444  result |= buffer.write_int32(this->latency.sec);
+
445  result |= buffer.write_int32(this->latency.usec);
+
446 
+
447  return result;
+
448  }
+
449 
+
450  int deserialize(const char *data, uint32_t size) {
+
451  SnapReadBuffer buffer;
+
452  int result = 0;
453 
-
454  result |= buffer.read_int32(&(this->latency.sec));
-
455  result |= buffer.read_int32(&(this->latency.usec));
-
456 
-
457  return result;
-
458  }
-
459 };
-
SnapMessageBase
Snapcast Base Message.
Definition: SnapProtocol.h:216
-
SnapMessageCodecHeader
Snapcast Codec Header Message.
Definition: SnapProtocol.h:355
-
SnapMessageHallo
Snapcast Hallo Message.
Definition: SnapProtocol.h:263
-
SnapMessageServerSettings
Snapcast Server Settings Message.
Definition: SnapProtocol.h:314
-
SnapMessageTime
Snapcast Time Message.
Definition: SnapProtocol.h:433
-
SnapMessageWireChunk
Snapcast Wire Chunk Message.
Definition: SnapProtocol.h:401
-
SnapReadBuffer
Buffer to read different data types.
Definition: SnapProtocol.h:22
-
SnapWriteBuffer
Buffer to write different data types.
Definition: SnapProtocol.h:110
-
tv_t
Time as sec & usec.
Definition: SnapProtocol.h:210
+
454  buffer.begin(data, size);
+
455 
+
456  result |= buffer.read_int32(&(this->latency.sec));
+
457  result |= buffer.read_int32(&(this->latency.usec));
+
458 
+
459  return result;
+
460  }
+
461 };
+
462 
+
463 }
+
snap_arduino
Definition: SnapCommon.h:10
+
snap_arduino::SnapMessageBase
Snapcast Base Message.
Definition: SnapProtocol.h:218
+
snap_arduino::SnapMessageCodecHeader
Snapcast Codec Header Message.
Definition: SnapProtocol.h:357
+
snap_arduino::SnapMessageHallo
Snapcast Hallo Message.
Definition: SnapProtocol.h:265
+
snap_arduino::SnapMessageServerSettings
Snapcast Server Settings Message.
Definition: SnapProtocol.h:316
+
snap_arduino::SnapMessageTime
Snapcast Time Message.
Definition: SnapProtocol.h:435
+
snap_arduino::SnapMessageWireChunk
Snapcast Wire Chunk Message.
Definition: SnapProtocol.h:403
+
snap_arduino::SnapReadBuffer
Buffer to read different data types.
Definition: SnapProtocol.h:24
+
snap_arduino::SnapWriteBuffer
Buffer to write different data types.
Definition: SnapProtocol.h:112
+
snap_arduino::tv_t
Time as sec & usec.
Definition: SnapProtocol.h:212
diff --git a/docs/html/_snap_time_8h_source.html b/docs/html/_snap_time_8h_source.html index a0dacfe..8cfb583 100644 --- a/docs/html/_snap_time_8h_source.html +++ b/docs/html/_snap_time_8h_source.html @@ -70,117 +70,126 @@
1 #pragma once
-
2 #include "AudioBasic/Collections/Vector.h"
-
3 #include "AudioConfig.h"
-
4 #include <stdint.h>
-
5 #include <sys/time.h>
-
6 
-
16 class SnapTime {
-
17 public:
-
18  static SnapTime &instance() {
-
19  static SnapTime self;
-
20  return self;
-
21  }
-
22 
-
24  timeval time() {
-
25  timeval result;
-
26  int rc = gettimeofday(&result, NULL);
-
27  if (rc) {
-
28  uint32_t ms = millis();
-
29  result.tv_sec = ms / 1000;
-
30  result.tv_usec = (ms - (result.tv_sec * 1000)) * 1000;
-
31  }
-
32  return result;
-
33  }
-
34 
-
36  uint32_t serverMillis() {
-
37  return toMillis(server_time) - server_ms + millis() -
-
38  timeDifferenceClientServerMs();
+
2 #include "AudioConfig.h"
+
3 #if defined(AUDIOTOOLS_MAJOR_VERSION)
+
4 # include "AudioTools/CoreAudio/AudioBasic/Collections/Vector.h"
+
5 #else
+
6 # include "AudioBasic/Collections/Vector.h"
+
7 #endif
+
8 #include <stdint.h>
+
9 #include <sys/time.h>
+
10 
+
11 namespace snap_arduino {
+
12 
+
22 class SnapTime {
+
23 public:
+
24  static SnapTime &instance() {
+
25  static SnapTime self;
+
26  return self;
+
27  }
+
28 
+
30  timeval time() {
+
31  timeval result;
+
32  int rc = gettimeofday(&result, NULL);
+
33  if (rc) {
+
34  uint32_t ms = millis();
+
35  result.tv_sec = ms / 1000;
+
36  result.tv_usec = (ms - (result.tv_sec * 1000)) * 1000;
+
37  }
+
38  return result;
39  }
40 
-
41  uint32_t localMillis() { return toMillis(time()); }
-
42 
-
44  int timeDifferenceClientServerMs() {
-
45  int result = time_diff;
-
46  assert(result == time_diff);
-
47  return result;
-
48  }
-
49 
-
50  uint32_t toMillis(timeval tv) { return toMillis(tv.tv_sec, tv.tv_usec); }
-
51 
-
52  inline uint32_t toMillis(uint32_t sec, uint32_t usec) {
-
53  return sec * 1000 + (usec / 1000);
+
42  uint32_t serverMillis() {
+
43  return toMillis(server_time) - server_ms + millis() -
+
44  timeDifferenceClientServerMs();
+
45  }
+
46 
+
47  uint32_t localMillis() { return toMillis(time()); }
+
48 
+
50  int timeDifferenceClientServerMs() {
+
51  int result = time_diff;
+
52  assert(result == time_diff);
+
53  return result;
54  }
55 
-
56  bool printLocalTime(const char *msg) {
-
57  const timeval val = time();
-
58  auto *tm_result = gmtime(&val.tv_sec);
-
59 
-
60  char str[80];
-
61  strftime(str, 80, "%d-%m-%Y %H-%M-%S", tm_result);
-
62  ESP_LOGI(TAG, "%s: Time is %s", msg, str);
-
63  return true;
-
64  }
+
56  uint32_t toMillis(timeval tv) { return toMillis(tv.tv_sec, tv.tv_usec); }
+
57 
+
58  inline uint32_t toMillis(uint32_t sec, uint32_t usec) {
+
59  return sec * 1000 + (usec / 1000);
+
60  }
+
61 
+
62  bool printLocalTime(const char *msg) {
+
63  const timeval val = time();
+
64  auto *tm_result = gmtime(&val.tv_sec);
65 
-
67  void setTimeDifferenceClientServerMs(uint32_t diff) {
-
68  time_diff = diff;
-
69  time_update_count++;
+
66  char str[80];
+
67  strftime(str, 80, "%d-%m-%Y %H-%M-%S", tm_result);
+
68  ESP_LOGI(TAG, "%s: Time is %s", msg, str);
+
69  return true;
70  }
71 
-
72  // updates the time difference between the local and server time
-
73  void updateServerTime(timeval &server) {
-
74  server_ms = millis();
-
75  server_time = server;
+
73  void setTimeDifferenceClientServerMs(uint32_t diff) {
+
74  time_diff = diff;
+
75  time_update_count++;
76  }
77 
-
78  // Calculat the difference between 2 timeval
-
79  timeval timeDifference(timeval t1, timeval t2) {
-
80  timeval result;
-
81  timersub(&t1, &t2, &result);
-
82  return result;
-
83  }
-
84 
-
85  // Calculat the difference between 2 timeval -> result in ms
-
86  uint32_t timeDifferenceMs(timeval t1, timeval t2) {
-
87  timeval result;
-
88  timersub(&t1, &t2, &result);
-
89  return toMillis(result);
-
90  }
-
91 
-
92 #ifdef ESP32
-
93  void setupSNTPTime() {
-
94  ESP_LOGD(TAG, "start");
-
95  const char *ntpServer = CONFIG_SNTP_SERVER;
-
96  const long gmtOffset_sec = 1 * 60 * 60;
-
97  const int daylightOffset_sec = 1 * 60 * 60;
-
98  for (int retry = 0; retry < 5; retry++) {
-
99  configTime(gmtOffset_sec, daylightOffset_sec, ntpServer);
-
100  tm time;
-
101  if (!getLocalTime(&time)) {
-
102  continue;
-
103  }
-
104  SnapTime::instance().printLocalTime("SNTP");
-
105  has_sntp_time = true;
-
106  break;
-
107  }
-
108  }
-
109 #endif
-
110 
-
111 protected:
-
112  const char *TAG = "SnapTime";
-
113  uint32_t time_diff = 0;
-
114  uint32_t server_ms = 0;
-
115  uint32_t local_ms;
-
116  uint32_t time_update_count = 0;
-
117  timeval server_time;
-
118  bool has_sntp_time = false;
-
119 
-
120 };
-
SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:16
-
SnapTime::time
timeval time()
Provides the actual time as timeval.
Definition: SnapTime.h:24
-
SnapTime::timeDifferenceClientServerMs
int timeDifferenceClientServerMs()
Provides the avg latecy in milliseconds.
Definition: SnapTime.h:44
-
SnapTime::serverMillis
uint32_t serverMillis()
Provides the current server time in ms.
Definition: SnapTime.h:36
-
SnapTime::setTimeDifferenceClientServerMs
void setTimeDifferenceClientServerMs(uint32_t diff)
Record the last time difference between client and server.
Definition: SnapTime.h:67
+
78  // updates the time difference between the local and server time
+
79  void updateServerTime(timeval &server) {
+
80  server_ms = millis();
+
81  server_time = server;
+
82  }
+
83 
+
84  // Calculat the difference between 2 timeval
+
85  timeval timeDifference(timeval t1, timeval t2) {
+
86  timeval result;
+
87  timersub(&t1, &t2, &result);
+
88  return result;
+
89  }
+
90 
+
91  // Calculat the difference between 2 timeval -> result in ms
+
92  uint32_t timeDifferenceMs(timeval t1, timeval t2) {
+
93  timeval result;
+
94  timersub(&t1, &t2, &result);
+
95  return toMillis(result);
+
96  }
+
97 
+
98 #ifdef ESP32
+
99  void setupSNTPTime() {
+
100  ESP_LOGD(TAG, "start");
+
101  const char *ntpServer = CONFIG_SNTP_SERVER;
+
102  const long gmtOffset_sec = 1 * 60 * 60;
+
103  const int daylightOffset_sec = 1 * 60 * 60;
+
104  for (int retry = 0; retry < 5; retry++) {
+
105  configTime(gmtOffset_sec, daylightOffset_sec, ntpServer);
+
106  tm time;
+
107  if (!getLocalTime(&time)) {
+
108  continue;
+
109  }
+
110  SnapTime::instance().printLocalTime("SNTP");
+
111  has_sntp_time = true;
+
112  break;
+
113  }
+
114  }
+
115 #endif
+
116 
+
117 protected:
+
118  const char *TAG = "SnapTime";
+
119  uint32_t time_diff = 0;
+
120  uint32_t server_ms = 0;
+
121  uint32_t local_ms;
+
122  uint32_t time_update_count = 0;
+
123  timeval server_time;
+
124  bool has_sntp_time = false;
+
125 
+
126 };
+
127 
+
128 }
+
snap_arduino::SnapTime
The the sys/time functions are used to represent the server time. The local time will be measured wit...
Definition: SnapTime.h:22
+
snap_arduino::SnapTime::time
timeval time()
Provides the actual time as timeval.
Definition: SnapTime.h:30
+
snap_arduino::SnapTime::timeDifferenceClientServerMs
int timeDifferenceClientServerMs()
Provides the avg latecy in milliseconds.
Definition: SnapTime.h:50
+
snap_arduino::SnapTime::serverMillis
uint32_t serverMillis()
Provides the current server time in ms.
Definition: SnapTime.h:42
+
snap_arduino::SnapTime::setTimeDifferenceClientServerMs
void setTimeDifferenceClientServerMs(uint32_t diff)
Record the last time difference between client and server.
Definition: SnapTime.h:73
+
snap_arduino
Definition: SnapCommon.h:10
diff --git a/docs/html/_snap_time_sync_8h_source.html b/docs/html/_snap_time_sync_8h_source.html index 207d361..ee82993 100644 --- a/docs/html/_snap_time_sync_8h_source.html +++ b/docs/html/_snap_time_sync_8h_source.html @@ -74,159 +74,166 @@
3 #include "SnapLogger.h"
4 #include "SnapTime.h"
5 
-
15 class SnapTimeSync {
-
16 public:
-
17  SnapTimeSync(int processingLag = CONFIG_PROCESSING_TIME_MS, int interval = 10) {
-
18  setInterval(interval);
-
19  setProcessingLag(processingLag);
-
20  }
-
21 
-
23  void begin(int rate) {
-
24  update_count = 0;
-
25  }
-
26 
-
28  virtual void updateServerTime(uint32_t serverMillis) = 0;
-
29 
-
31  virtual void updateActualDelay(int delay) {}
-
32 
-
35  virtual float getFactor() = 0;
-
36 
-
38  bool isSync() {
-
39  bool result = active && update_count > 2 && update_count % interval == 0;
-
40  active = false;
-
41  return result;
-
42  }
-
43 
-
45  void setMessageBufferDelay(int ms) {
-
46  ESP_LOGI(TAG, "delay: %d", ms);
-
47  message_buffer_delay_ms = ms;
-
48  }
-
49 
-
52  void setProcessingLag(int lag) { this->processing_lag = lag; }
-
53 
-
56  void setInterval(int interval) { this->interval = interval; }
-
57 
-
60  int getStartDelay() {
-
61  int delay = std::max(0, message_buffer_delay_ms - processing_lag);
-
62  ESP_LOGD(TAG, "delay: %d", delay);
-
63  return delay;
-
64  }
-
65 
-
66 protected:
-
67  const char *TAG = "SnapTimeSync";
-
68  // resampling speed
-
69  uint64_t update_count = 0;
-
70  int interval = 10;
-
71  bool active = false;
-
72  // start delay
-
73  uint16_t processing_lag = 0;
-
74  uint16_t message_buffer_delay_ms = 0;
-
75 
-
76 };
-
77 
-
86 class SnapTimeSyncDynamic : public SnapTimeSync {
-
87 public:
-
88  SnapTimeSyncDynamic(int processingLag = CONFIG_PROCESSING_TIME_MS,
-
89  int interval = 10)
-
90  : SnapTimeSync(processingLag, interval) {}
-
91 
-
92  void updateServerTime(uint32_t serverMillis) override {
-
93  update_count++;
-
94  active = true;
-
95  SnapTimePoints tp{serverMillis};
-
96  if (time_points.size()>=interval){
-
97  time_points.pop_front();
-
98  }
-
99  time_points.push_back(tp);
-
100  }
-
101 
-
102  float getFactor() {
-
103  int last_idx = time_points.size()-1;
-
104  if (last_idx <=1) return 1.0;
-
105  float timespan_local_ms = time_points[last_idx].local_ms - time_points[0].local_ms;
-
106  float timespan_server_ms = time_points[last_idx].server_ms - time_points[0].server_ms;
-
107  if (timespan_local_ms == 0.0 || timespan_server_ms == 0.0) {
-
108  ESP_LOGE(TAG, "Could not determine clock differences");
-
109  return 1.0;
-
110  }
-
111  // if server time span is smaller then local, local runs faster and needs to be slowed down
-
112  float result_factor = timespan_server_ms / timespan_local_ms;
-
113  ESP_LOGI(TAG, "=> adjusting playback speed by factor: %f", result_factor);
-
114  return result_factor;
-
115  }
-
116 protected:
-
117  Vector<SnapTimePoints> time_points;
-
118 };
-
119 
-
128 class SnapTimeSyncDynamicSinceStart : public SnapTimeSync {
-
129 public:
-
130  SnapTimeSyncDynamicSinceStart(int processingLag = CONFIG_PROCESSING_TIME_MS,
-
131  int interval = 10)
-
132  : SnapTimeSync(processingLag, interval) {}
-
133 
-
134  void updateServerTime(uint32_t serverMillis) override {
-
135  if (update_count == 0){
-
136  start_time = SnapTimePoints(serverMillis);
-
137  }
-
138  current_time = SnapTimePoints(serverMillis);
-
139  update_count++;
-
140  active = true;
-
141  }
-
142 
-
143  float getFactor() {
-
144  float timespan_local_ms = current_time.local_ms - start_time.local_ms;
-
145  float timespan_server_ms = current_time.server_ms - start_time.server_ms;
-
146  if (timespan_local_ms == 0.0 || timespan_server_ms == 0.0) {
-
147  ESP_LOGE(TAG, "Could not determine clock differences");
-
148  return 1.0;
-
149  }
-
150  // if server time span is smaller then local, local runs faster and needs to be slowed down
-
151  float result_factor = timespan_server_ms / timespan_local_ms;
-
152  ESP_LOGI(TAG, "=> adjusting playback speed by factor: %f", result_factor);
-
153  return result_factor;
-
154  }
-
155 protected:
-
156  SnapTimePoints start_time;
-
157  SnapTimePoints current_time;
-
158 };
-
159 
-
160 
-
168 class SnapTimeSyncFixed : public SnapTimeSync {
-
169 public:
-
170  SnapTimeSyncFixed(int processingLag = CONFIG_PROCESSING_TIME_MS, float factor = 1.0,
-
171  int interval = 10)
-
172  : SnapTimeSync(processingLag, interval) {
-
173  resample_factor = factor;
-
174  }
-
175 
-
176  void updateServerTime(uint32_t serverMillis) override {}
-
177 
-
178  float getFactor() { return resample_factor; }
-
179 
-
180 protected:
-
181  float resample_factor;
-
182 };
-
183 
-
SnapTimeSyncDynamic
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:86
-
SnapTimeSyncDynamic::getFactor
float getFactor()
Definition: SnapTimeSync.h:102
-
SnapTimeSyncDynamic::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:92
-
SnapTimeSyncDynamicSinceStart
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:128
-
SnapTimeSyncDynamicSinceStart::getFactor
float getFactor()
Definition: SnapTimeSync.h:143
-
SnapTimeSyncDynamicSinceStart::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:134
-
SnapTimeSyncFixed
Uses predefined fixed factor.
Definition: SnapTimeSync.h:168
-
SnapTimeSyncFixed::getFactor
float getFactor()
Definition: SnapTimeSync.h:178
-
SnapTimeSyncFixed::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:176
-
SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:15
-
SnapTimeSync::updateActualDelay
virtual void updateActualDelay(int delay)
Records the actual playback delay (currently not used)
Definition: SnapTimeSync.h:31
-
SnapTimeSync::setProcessingLag
void setProcessingLag(int lag)
Definition: SnapTimeSync.h:52
-
SnapTimeSync::begin
void begin(int rate)
Starts the processing.
Definition: SnapTimeSync.h:23
-
SnapTimeSync::getFactor
virtual float getFactor()=0
-
SnapTimeSync::getStartDelay
int getStartDelay()
Definition: SnapTimeSync.h:60
-
SnapTimeSync::setMessageBufferDelay
void setMessageBufferDelay(int ms)
Defines the message buffer lag.
Definition: SnapTimeSync.h:45
-
SnapTimeSync::isSync
bool isSync()
Returns true if a synchronization (update of the sampling rate) is needed.
Definition: SnapTimeSync.h:38
-
SnapTimeSync::setInterval
void setInterval(int interval)
Definition: SnapTimeSync.h:56
-
SnapTimeSync::updateServerTime
virtual void updateServerTime(uint32_t serverMillis)=0
Records the actual server time in millisecondes.
-
SnapTimePoints
Recording of local_ms and server_ms.
Definition: SnapCommon.h:31
+
6 namespace snap_arduino {
+
7 
+
17 class SnapTimeSync {
+
18 public:
+
19  SnapTimeSync(int processingLag = CONFIG_PROCESSING_TIME_MS, int interval = 10) {
+
20  setInterval(interval);
+
21  setProcessingLag(processingLag);
+
22  }
+
23 
+
25  void begin(int rate) {
+
26  update_count = 0;
+
27  }
+
28 
+
30  virtual void updateServerTime(uint32_t serverMillis) = 0;
+
31 
+
33  virtual void updateActualDelay(int delay) {}
+
34 
+
37  virtual float getFactor() = 0;
+
38 
+
40  bool isSync() {
+
41  bool result = active && update_count > 2 && update_count % interval == 0;
+
42  active = false;
+
43  return result;
+
44  }
+
45 
+
47  void setMessageBufferDelay(int ms) {
+
48  ESP_LOGI(TAG, "delay: %d", ms);
+
49  message_buffer_delay_ms = ms;
+
50  }
+
51 
+
54  void setProcessingLag(int lag) { this->processing_lag = lag; }
+
55 
+
58  void setInterval(int interval) { this->interval = interval; }
+
59 
+
62  int getStartDelay() {
+
63  int delay = std::max(0, message_buffer_delay_ms + processing_lag);
+
64  if (message_buffer_delay_ms + processing_lag < 0){
+
65  LOGE("The processing lag can not be smaller then -%d", message_buffer_delay_ms);
+
66  }
+
67  ESP_LOGD(TAG, "delay: %d", delay);
+
68  return delay;
+
69  }
+
70 
+
71 protected:
+
72  const char *TAG = "SnapTimeSync";
+
73  // resampling speed
+
74  uint64_t update_count = 0;
+
75  int interval = 10;
+
76  bool active = false;
+
77  // start delay
+
78  int processing_lag = 0;
+
79  uint16_t message_buffer_delay_ms = 0;
+
80 
+
81 };
+
82 
+
91 class SnapTimeSyncDynamic : public SnapTimeSync {
+
92 public:
+
93  SnapTimeSyncDynamic(int processingLag = CONFIG_PROCESSING_TIME_MS,
+
94  int interval = 10)
+
95  : SnapTimeSync(processingLag, interval) {}
+
96 
+
97  void updateServerTime(uint32_t serverMillis) override {
+
98  update_count++;
+
99  active = true;
+
100  SnapTimePoints tp{serverMillis};
+
101  if (time_points.size()>=interval){
+
102  time_points.pop_front();
+
103  }
+
104  time_points.push_back(tp);
+
105  }
+
106 
+
107  float getFactor() {
+
108  int last_idx = time_points.size()-1;
+
109  if (last_idx <=1) return 1.0;
+
110  float timespan_local_ms = time_points[last_idx].local_ms - time_points[0].local_ms;
+
111  float timespan_server_ms = time_points[last_idx].server_ms - time_points[0].server_ms;
+
112  if (timespan_local_ms == 0.0 || timespan_server_ms == 0.0) {
+
113  ESP_LOGE(TAG, "Could not determine clock differences");
+
114  return 1.0;
+
115  }
+
116  // if server time span is smaller then local, local runs faster and needs to be slowed down
+
117  float result_factor = timespan_server_ms / timespan_local_ms;
+
118  ESP_LOGI(TAG, "=> adjusting playback speed by factor: %f", result_factor);
+
119  return result_factor;
+
120  }
+
121 protected:
+
122  Vector<SnapTimePoints> time_points;
+
123 };
+
124 
+
133 class SnapTimeSyncDynamicSinceStart : public SnapTimeSync {
+
134 public:
+
135  SnapTimeSyncDynamicSinceStart(int processingLag = CONFIG_PROCESSING_TIME_MS,
+
136  int interval = 10)
+
137  : SnapTimeSync(processingLag, interval) {}
+
138 
+
139  void updateServerTime(uint32_t serverMillis) override {
+
140  if (update_count == 0){
+
141  start_time = SnapTimePoints(serverMillis);
+
142  }
+
143  current_time = SnapTimePoints(serverMillis);
+
144  update_count++;
+
145  active = true;
+
146  }
+
147 
+
148  float getFactor() {
+
149  float timespan_local_ms = current_time.local_ms - start_time.local_ms;
+
150  float timespan_server_ms = current_time.server_ms - start_time.server_ms;
+
151  if (timespan_local_ms == 0.0 || timespan_server_ms == 0.0) {
+
152  ESP_LOGE(TAG, "Could not determine clock differences");
+
153  return 1.0;
+
154  }
+
155  // if server time span is smaller then local, local runs faster and needs to be slowed down
+
156  float result_factor = timespan_server_ms / timespan_local_ms;
+
157  ESP_LOGI(TAG, "=> adjusting playback speed by factor: %f", result_factor);
+
158  return result_factor;
+
159  }
+
160 protected:
+
161  SnapTimePoints start_time;
+
162  SnapTimePoints current_time;
+
163 };
+
164 
+
165 
+
173 class SnapTimeSyncFixed : public SnapTimeSync {
+
174 public:
+
175  SnapTimeSyncFixed(int processingLag = CONFIG_PROCESSING_TIME_MS, float factor = 1.0,
+
176  int interval = 10)
+
177  : SnapTimeSync(processingLag, interval) {
+
178  resample_factor = factor;
+
179  }
+
180 
+
181  void updateServerTime(uint32_t serverMillis) override {}
+
182 
+
183  float getFactor() { return resample_factor; }
+
184 
+
185 protected:
+
186  float resample_factor;
+
187 };
+
188 
+
189 }
+
snap_arduino::SnapTimeSyncDynamic
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:91
+
snap_arduino::SnapTimeSyncDynamic::getFactor
float getFactor()
Definition: SnapTimeSync.h:107
+
snap_arduino::SnapTimeSyncDynamic::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:97
+
snap_arduino::SnapTimeSyncDynamicSinceStart
Dynamically adjusts the effective playback sample rate based on the differences of the local and serv...
Definition: SnapTimeSync.h:133
+
snap_arduino::SnapTimeSyncDynamicSinceStart::getFactor
float getFactor()
Definition: SnapTimeSync.h:148
+
snap_arduino::SnapTimeSyncDynamicSinceStart::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:139
+
snap_arduino::SnapTimeSyncFixed
Uses predefined fixed factor.
Definition: SnapTimeSync.h:173
+
snap_arduino::SnapTimeSyncFixed::getFactor
float getFactor()
Definition: SnapTimeSync.h:183
+
snap_arduino::SnapTimeSyncFixed::updateServerTime
void updateServerTime(uint32_t serverMillis) override
Records the actual server time in millisecondes.
Definition: SnapTimeSync.h:181
+
snap_arduino::SnapTimeSync
Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the lo...
Definition: SnapTimeSync.h:17
+
snap_arduino::SnapTimeSync::updateActualDelay
virtual void updateActualDelay(int delay)
Records the actual playback delay (currently not used)
Definition: SnapTimeSync.h:33
+
snap_arduino::SnapTimeSync::setProcessingLag
void setProcessingLag(int lag)
Definition: SnapTimeSync.h:54
+
snap_arduino::SnapTimeSync::begin
void begin(int rate)
Starts the processing.
Definition: SnapTimeSync.h:25
+
snap_arduino::SnapTimeSync::getFactor
virtual float getFactor()=0
+
snap_arduino::SnapTimeSync::getStartDelay
int getStartDelay()
Definition: SnapTimeSync.h:62
+
snap_arduino::SnapTimeSync::setMessageBufferDelay
void setMessageBufferDelay(int ms)
Defines the message buffer lag.
Definition: SnapTimeSync.h:47
+
snap_arduino::SnapTimeSync::isSync
bool isSync()
Returns true if a synchronization (update of the sampling rate) is needed.
Definition: SnapTimeSync.h:40
+
snap_arduino::SnapTimeSync::setInterval
void setInterval(int interval)
Definition: SnapTimeSync.h:58
+
snap_arduino::SnapTimeSync::updateServerTime
virtual void updateServerTime(uint32_t serverMillis)=0
Records the actual server time in millisecondes.
+
snap_arduino
Definition: SnapCommon.h:10
+
snap_arduino::SnapTimePoints
Recording of local_ms and server_ms.
Definition: SnapCommon.h:33
diff --git a/docs/html/annotated.html b/docs/html/annotated.html index bf13e33..41ee3ba 100644 --- a/docs/html/annotated.html +++ b/docs/html/annotated.html @@ -66,27 +66,30 @@
Here are the classes, structs, unions and interfaces with brief descriptions:
- - - - - - - - - - - - - - - - - - - - - +
[detail level 12]
 CSnapAudioHeaderInformation about the next bucket
 CSnapClientSnap Client for ESP32 Arduino
 CSnapMessageBaseSnapcast Base Message
 CSnapMessageCodecHeaderSnapcast Codec Header Message
 CSnapMessageHalloSnapcast Hallo Message
 CSnapMessageServerSettingsSnapcast Server Settings Message
 CSnapMessageTimeSnapcast Time Message
 CSnapMessageWireChunkSnapcast Wire Chunk Message
 CSnapOutputSimple Output Class which uses the AudioTools to build an output chain with volume control and a resampler
 CSnapProcessorSnap Processor implementation which does not rely on FreeRTOS
 CSnapProcessorRTOS
 CSnapReadBufferBuffer to read different data types
 CSnapTimeThe the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time
 CSnapTimePointsRecording of local_ms and server_ms
 CSnapTimeSyncAbstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate
 CSnapTimeSyncDynamicDynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals
 CSnapTimeSyncDynamicSinceStartDynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start
 CSnapTimeSyncFixedUses predefined fixed factor
 CSnapWriteBufferBuffer to write different data types
 Ctv_tTime as sec & usec
+ + + + + + + + + + + + + + + + + + + + + + +
 ▼Nsnap_arduino
 CSnapAudioHeaderInformation about the next bucket
 CSnapClientSnap Client for ESP32 Arduino
 CSnapMessageBaseSnapcast Base Message
 CSnapMessageCodecHeaderSnapcast Codec Header Message
 CSnapMessageHalloSnapcast Hallo Message
 CSnapMessageServerSettingsSnapcast Server Settings Message
 CSnapMessageTimeSnapcast Time Message
 CSnapMessageWireChunkSnapcast Wire Chunk Message
 CSnapOutputSimple Output Class which uses the AudioTools to build an output chain with volume control and a resampler
 CSnapProcessorSnap Processor implementation which does not rely on FreeRTOS
 CSnapProcessorBufferedProcessor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns
 CSnapProcessorRP2040Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();
 CSnapProcessorRTOSProcessor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue
 CSnapReadBufferBuffer to read different data types
 CSnapTimeThe the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time
 CSnapTimePointsRecording of local_ms and server_ms
 CSnapTimeSyncAbstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate
 CSnapTimeSyncDynamicDynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals
 CSnapTimeSyncDynamicSinceStartDynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start
 CSnapTimeSyncFixedUses predefined fixed factor
 CSnapWriteBufferBuffer to write different data types
 Ctv_tTime as sec & usec
diff --git a/docs/html/classes.html b/docs/html/classes.html index 6b6e3cc..9562608 100644 --- a/docs/html/classes.html +++ b/docs/html/classes.html @@ -69,10 +69,10 @@
S
-
SnapAudioHeader
SnapClient
SnapMessageBase
SnapMessageCodecHeader
SnapMessageHallo
SnapMessageServerSettings
SnapMessageTime
SnapMessageWireChunk
SnapOutput
SnapProcessor
SnapProcessorRTOS
SnapReadBuffer
SnapTime
SnapTimePoints
SnapTimeSync
SnapTimeSyncDynamic
SnapTimeSyncDynamicSinceStart
SnapTimeSyncFixed
SnapWriteBuffer
+
SnapAudioHeader (snap_arduino)
SnapClient (snap_arduino)
SnapMessageBase (snap_arduino)
SnapMessageCodecHeader (snap_arduino)
SnapMessageHallo (snap_arduino)
SnapMessageServerSettings (snap_arduino)
SnapMessageTime (snap_arduino)
SnapMessageWireChunk (snap_arduino)
SnapOutput (snap_arduino)
SnapProcessor (snap_arduino)
SnapProcessorBuffered (snap_arduino)
SnapProcessorRP2040 (snap_arduino)
SnapProcessorRTOS (snap_arduino)
SnapReadBuffer (snap_arduino)
SnapTime (snap_arduino)
SnapTimePoints (snap_arduino)
SnapTimeSync (snap_arduino)
SnapTimeSyncDynamic (snap_arduino)
SnapTimeSyncDynamicSinceStart (snap_arduino)
SnapTimeSyncFixed (snap_arduino)
SnapWriteBuffer (snap_arduino)
T
-
tv_t
+
tv_t (snap_arduino)
diff --git a/docs/html/classsnap__arduino_1_1_snap_client-members.html b/docs/html/classsnap__arduino_1_1_snap_client-members.html new file mode 100644 index 0000000..019d3e0 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_client-members.html @@ -0,0 +1,118 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapClient Member List
+
+
+ +

This is the complete list of members for SnapClient, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
begin(SnapTimeSync &timeSync)SnapClientinline
begin()SnapClientinline
default_processor (defined in SnapClient)SnapClientprotected
doLoop()SnapClientinline
end(void)SnapClientinline
is_wifi (defined in SnapClient)SnapClientprotected
isWiFi()SnapClientinline
p_client (defined in SnapClient)SnapClientprotected
p_decoder (defined in SnapClient)SnapClientprotected
p_output (defined in SnapClient)SnapClientprotected
p_snapprocessor (defined in SnapClient)SnapClientprotected
p_time_sync (defined in SnapClient)SnapClientprotected
server_ip (defined in SnapClient)SnapClientprotected
server_port (defined in SnapClient)SnapClientprotected
setClient(Client &client)SnapClientinline
setServerIP(IPAddress ipAddress)SnapClientinline
setSnapOutput(SnapOutput &out)SnapClientinline
setSnapProcessor(SnapProcessor &processor)SnapClientinline
setSnapTimeSync(SnapTimeSync &timeSync)SnapClientinline
setStartOutput(bool start)SnapClientinline
setStartTask(bool flag)SnapClientinline
setupMACAddress() (defined in SnapClient)SnapClientinlineprotected
setupMDNS() (defined in SnapClient)SnapClientinlineprotected
setupNVS() (defined in SnapClient)SnapClientinlineprotected
setVolumeFactor(float fact)SnapClientinline
setWiFi(bool flag)SnapClientinline
snap_time (defined in SnapClient)SnapClientprotected
SnapClient(Client &client, AudioStream &stream, AudioDecoder &decoder) (defined in SnapClient)SnapClientinline
SnapClient(Client &client, Print &stream, AudioDecoder &decoder) (defined in SnapClient)SnapClientinline
SnapClient(Client &client, AudioStream &stream, StreamingDecoder &decoder, int bufferSize=(12 *1024)) (defined in SnapClient)SnapClientinline
SnapClient(Client &client, AudioOutput &output, AudioDecoder &decoder) (defined in SnapClient)SnapClientinline
SnapClient(Client &client, AudioOutput &output, StreamingDecoder &decoder, int bufferSize=(12 *1024)) (defined in SnapClient)SnapClientinline
snapProcessor()SnapClientinline
TAG (defined in SnapClient)SnapClientprotected
time_sync_default (defined in SnapClient)SnapClientprotected
volume(void)SnapClientinline
~SnapClient()SnapClientinline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_client.html b/docs/html/classsnap__arduino_1_1_snap_client.html new file mode 100644 index 0000000..ed10cdc --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_client.html @@ -0,0 +1,269 @@ + + + + + + + +arduino-snapclient: SnapClient Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapClient Class Reference
+
+
+ +

Snap Client for ESP32 Arduino. + More...

+ +

#include <SnapClient.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapClient (Client &client, AudioOutput &output, AudioDecoder &decoder)
 
+ SnapClient (Client &client, AudioOutput &output, StreamingDecoder &decoder, int bufferSize=(12 *1024))
 
+ SnapClient (Client &client, AudioStream &stream, AudioDecoder &decoder)
 
+ SnapClient (Client &client, AudioStream &stream, StreamingDecoder &decoder, int bufferSize=(12 *1024))
 
+ SnapClient (Client &client, Print &stream, AudioDecoder &decoder)
 
+ ~SnapClient ()
 Destructor.
 
+bool begin ()
 Starts the processing.
 
+bool begin (SnapTimeSync &timeSync)
 Starts the processing.
 
+bool doLoop ()
 Call from Arduino Loop - to receive and process the audio data.
 
+void end (void)
 ends the processing and releases the resources
 
+bool isWiFi ()
 check if we use the ESP32 WiFi for checking the link status
 
+void setClient (Client &client)
 Defines an alternative commnuication client (default is WiFiClient)
 
void setServerIP (IPAddress ipAddress)
 Defines the Snapcast Server IP address. More...
 
+void setSnapOutput (SnapOutput &out)
 Defines the Snap output implementation to be used.
 
+void setSnapProcessor (SnapProcessor &processor)
 Defines an alternative Processor.
 
+void setSnapTimeSync (SnapTimeSync &timeSync)
 Defines the time synchronization logic.
 
+void setStartOutput (bool start)
 For Testing: Used to prevent the starting of the output task.
 
+void setStartTask (bool flag)
 For testing to deactivate the starting of the http task.
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+void setWiFi (bool flag)
 ESP32: WiFiClient: prevent/activate WiFi link status check.
 
+SnapProcessor & snapProcessor ()
 Provides the actual processor.
 
+float volume (void)
 Provides the actual volume (in the range of 0.0 to 1.0)
 
+ + + + + + + +

+Protected Member Functions

+void setupMACAddress ()
 
+void setupMDNS ()
 
+void setupNVS ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+SnapProcessor default_processor
 
+bool is_wifi = true
 
+Client * p_client = nullptr
 
+AudioDecoder * p_decoder = nullptr
 
+AudioOutput * p_output = nullptr
 
+SnapProcessor * p_snapprocessor = &default_processor
 
+SnapTimeSync * p_time_sync = &time_sync_default
 
+IPAddress server_ip
 
+int server_port = 1704
 
+SnapTime & snap_time = SnapTime::instance()
 
+const char * TAG = "SnapClient"
 
+SnapTimeSyncDynamic time_sync_default
 
+

Detailed Description

+

Snap Client for ESP32 Arduino.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ setServerIP()

+ +
+
+ + + + + +
+ + + + + + + + +
void setServerIP (IPAddress ipAddress)
+ 		+inline
+
+ +

Defines the Snapcast Server IP address.

+
Parameters
+ + +
address
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_output-members.html b/docs/html/classsnap__arduino_1_1_snap_output-members.html new file mode 100644 index 0000000..b1a3c4b --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_output-members.html @@ -0,0 +1,126 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapOutput Member List
+
+
+ +

This is the complete list of members for SnapOutput, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
audio_info (defined in SnapOutput)SnapOutputprotected
audioBegin()SnapOutputinlineprotected
audioEnd() (defined in SnapOutput)SnapOutputinlineprotected
audioInfo() (defined in SnapOutput)SnapOutputinline
audioWrite(const void *src, size_t size) (defined in SnapOutput)SnapOutputinline
audioWriteSilence() (defined in SnapOutput)SnapOutputinlineprotected
begin()SnapOutputinlinevirtual
decoder_stream (defined in SnapOutput)SnapOutputprotected
end(void)SnapOutputinlinevirtual
getDecoder() (defined in SnapOutput)SnapOutputinline
getDelayMs()SnapOutputinlineprotected
getLastWriteTime() (defined in SnapOutput)SnapOutputinline
getOutput() (defined in SnapOutput)SnapOutputinline
header (defined in SnapOutput)SnapOutputprotected
is_audio_begin_called (defined in SnapOutput)SnapOutputprotected
is_mute (defined in SnapOutput)SnapOutputprotected
is_sync_started (defined in SnapOutput)SnapOutputprotected
isActive(uint16_t timeout=1000)SnapOutputinline
isMute()SnapOutputinline
isStarted() (defined in SnapOutput)SnapOutputinline
out (defined in SnapOutput)SnapOutputprotected
p_snap_time_sync (defined in SnapOutput)SnapOutputprotected
playbackFactor()SnapOutputinlineprotected
resample (defined in SnapOutput)SnapOutputprotected
setAudioInfo(AudioInfo info)SnapOutputinline
setDecoder(AudioDecoder &dec)SnapOutputinline
setMute(bool mute)SnapOutputinline
setOutput(AudioOutput &output)SnapOutputinline
setPlaybackFactor(float fact)SnapOutputinlineprotected
setSnapTimeSync(SnapTimeSync &timeSync)SnapOutputinline
setVolume(float vol)SnapOutputinline
setVolumeFactor(float fact)SnapOutputinline
snap_time (defined in SnapOutput)SnapOutputprotected
SnapOutput()=default (defined in SnapOutput)SnapOutput
snapTimeSync() (defined in SnapOutput)SnapOutputinline
synchronizeOnStart(int delay_ms) (defined in SnapOutput)SnapOutputinlineprotected
synchronizePlayback()SnapOutputinline
TAG (defined in SnapOutput)SnapOutputprotected
time_last_write (defined in SnapOutput)SnapOutputprotected
vol (defined in SnapOutput)SnapOutputprotected
vol_factor (defined in SnapOutput)SnapOutputprotected
vol_stream (defined in SnapOutput)SnapOutputprotected
volume()SnapOutputinline
write(const uint8_t *data, size_t size)SnapOutputinlinevirtual
writeHeader(SnapAudioHeader &header)SnapOutputinlinevirtual
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_output.html b/docs/html/classsnap__arduino_1_1_snap_output.html new file mode 100644 index 0000000..3c3e025 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_output.html @@ -0,0 +1,313 @@ + + + + + + + +arduino-snapclient: SnapOutput Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapOutput Class Reference
+
+
+ +

Simple Output Class which uses the AudioTools to build an output chain with volume control and a resampler. + More...

+ +

#include <SnapOutput.h>

+
+Inheritance diagram for SnapOutput:
+
+
+ +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+AudioInfo audioInfo ()
 
+size_t audioWrite (const void *src, size_t size)
 
virtual bool begin ()
 
+virtual void end (void)
 Ends the processing and releases the memory.
 
+AudioDecoder & getDecoder ()
 
+uint64_t getLastWriteTime ()
 
+AudioOutput & getOutput ()
 
+bool isActive (uint16_t timeout=1000)
 checks if the audio is still playing
 
+bool isMute ()
 checks if volume is mute
 
+bool isStarted ()
 
+void setAudioInfo (AudioInfo info)
 setup of all audio objects
 
+void setDecoder (AudioDecoder &dec)
 Defines the decoder class.
 
+void setMute (bool mute)
 mute / unmute
 
+void setOutput (AudioOutput &output)
 Defines the audio output chain to the final output.
 
+void setSnapTimeSync (SnapTimeSync &timeSync)
 Defines the time synchronization logic.
 
+void setVolume (float vol)
 Adjust the volume.
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+SnapTimeSync & snapTimeSync ()
 
bool synchronizePlayback ()
 
+float volume ()
 provides the actual volume
 
+virtual size_t write (const uint8_t *data, size_t size)
 Writes audio data to the queue.
 
+virtual bool writeHeader (SnapAudioHeader &header)
 Provides info about the audio data.
 
+ + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+bool audioBegin ()
 setup of all audio objects
 
+void audioEnd ()
 
+void audioWriteSilence ()
 
+int getDelayMs ()
 Calculate the delay in ms.
 
+float playbackFactor ()
 determine actual playback speed
 
+void setPlaybackFactor (float fact)
 to speed up or slow down playback
 
+bool synchronizeOnStart (int delay_ms)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+AudioInfo audio_info
 
+EncodedAudioStream decoder_stream
 
+SnapAudioHeader header
 
+bool is_audio_begin_called = false
 
+bool is_mute = false
 
+bool is_sync_started = false
 
+AudioOutput * out = nullptr
 
+SnapTimeSync * p_snap_time_sync = nullptr
 
+ResampleStream resample
 
+SnapTime & snap_time = SnapTime::instance()
 
+const char * TAG = "SnapOutput"
 
+uint64_t time_last_write = 0
 
+float vol = 1.0
 
+float vol_factor = 1.0
 
+VolumeStream vol_stream
 
+

Detailed Description

+

Simple Output Class which uses the AudioTools to build an output chain with volume control and a resampler.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ begin()

+ +
+
+ + + + + +
+ + + + + + + +
virtual bool begin ()
+ 		+inlinevirtual
+
+

Starts the processing which is also starting the the dsp_i2s_task_handler task

+ +
+
+ +

◆ synchronizePlayback()

+ +
+
+ + + + + +
+ + + + + + + +
bool synchronizePlayback ()
+ 		+inline
+
+

start to play audio only in valid server time: return false if to be ignored - update playback speed

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_output.png b/docs/html/classsnap__arduino_1_1_snap_output.png new file mode 100644 index 0000000..6abf5fc Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_output.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_processor-members.html b/docs/html/classsnap__arduino_1_1_snap_processor-members.html new file mode 100644 index 0000000..dbb4e0b --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor-members.html @@ -0,0 +1,165 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessor Member List
+
+
+ +

This is the complete list of members for SnapProcessor, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
audio (defined in SnapProcessor)SnapProcessorprotected
audioBegin() (defined in SnapProcessor)SnapProcessorinlineprotected
audioEnd() (defined in SnapProcessor)SnapProcessorinlineprotected
base_message (defined in SnapProcessor)SnapProcessorprotected
base_message_serialized (defined in SnapProcessor)SnapProcessorprotected
begin()SnapProcessorinlinevirtual
channels (defined in SnapProcessor)SnapProcessorprotected
client_name (defined in SnapProcessor)SnapProcessorprotected
client_state_muted (defined in SnapProcessor)SnapProcessorprotected
clientName() (defined in SnapProcessor)SnapProcessorinline
codec_from_server (defined in SnapProcessor)SnapProcessorprotected
connectClient()SnapProcessorinlineprotected
doLoop()SnapProcessorinline
doLoop1()SnapProcessorinlinevirtual
end() (defined in SnapProcessor)SnapProcessorinlinevirtual
frame_size (defined in SnapProcessor)SnapProcessorprotected
getLatency() (defined in SnapProcessor)SnapProcessorinline
header_received (defined in SnapProcessor)SnapProcessorprotected
hostName() (defined in SnapProcessor)SnapProcessorinline
hostname (defined in SnapProcessor)SnapProcessorprotected
http_task_start (defined in SnapProcessor)SnapProcessorprotected
id_counter (defined in SnapProcessor)SnapProcessorprotected
is_fast_loop (defined in SnapProcessor)SnapProcessorprotected
is_time_set (defined in SnapProcessor)SnapProcessorprotected
last_time_sync (defined in SnapProcessor)SnapProcessorprotected
loop_status (defined in SnapProcessor)SnapProcessorprotected
loop_status_enum enum name (defined in SnapProcessor)SnapProcessorprotected
LoopEnd enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStart enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStep enum value (defined in SnapProcessor)SnapProcessorprotected
mac_address (defined in SnapProcessor)SnapProcessorprotected
now (defined in SnapProcessor)SnapProcessorprotected
output_start (defined in SnapProcessor)SnapProcessorprotected
p_client (defined in SnapProcessor)SnapProcessorprotected
p_snap_output (defined in SnapProcessor)SnapProcessorprotected
processExt()SnapProcessorinlineprotectedvirtual
processLoopStep() (defined in SnapProcessor)SnapProcessorinlineprotected
processLoopStepFast() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeader() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderExt(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderOpus(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderWav(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageLoop() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageServerSettings() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageTime() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageWireChunk() (defined in SnapProcessor)SnapProcessorinlineprotected
readBaseMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
readData() (defined in SnapProcessor)SnapProcessorinlineprotected
resizeData() (defined in SnapProcessor)SnapProcessorinlineprotected
send_receive_buffer (defined in SnapProcessor)SnapProcessorprotected
server_ip (defined in SnapProcessor)SnapProcessorprotected
server_port (defined in SnapProcessor)SnapProcessorprotected
server_settings_message (defined in SnapProcessor)SnapProcessorprotected
setAudioInfo(AudioInfo info) (defined in SnapProcessor)SnapProcessorinline
setClient(Client &client)SnapProcessorinline
setClientName(const char *name)SnapProcessorinline
setDecoder(AudioDecoder &dec)SnapProcessorinline
setFastLoop(bool flag) (defined in SnapProcessor)SnapProcessorinline
setHostName(const char *name)SnapProcessorinline
setMacAddress(const char *adr) (defined in SnapProcessor)SnapProcessorinline
setMute(bool flag) (defined in SnapProcessor)SnapProcessorinlineprotected
setOutput(AudioOutput &output)SnapProcessorinline
setServerIP(IPAddress address) (defined in SnapProcessor)SnapProcessorinline
setServerPort(int port) (defined in SnapProcessor)SnapProcessorinline
setSnapOutput(SnapOutput &out)SnapProcessorinline
setStartOutput(bool start) (defined in SnapProcessor)SnapProcessorinline
setStartTask(bool flag) (defined in SnapProcessor)SnapProcessorinline
setVolume(float vol) (defined in SnapProcessor)SnapProcessorinlineprotected
setVolumeFactor(float fact)SnapProcessorinline
size (defined in SnapProcessor)SnapProcessorprotected
snap_time (defined in SnapProcessor)SnapProcessorprotected
snapOutput() (defined in SnapProcessor)SnapProcessorinline
SnapProcessor(SnapOutput &output) (defined in SnapProcessor)SnapProcessorinline
SnapProcessor() (defined in SnapProcessor)SnapProcessorinline
start (defined in SnapProcessor)SnapProcessorprotected
TAG (defined in SnapProcessor)SnapProcessorprotected
time_message (defined in SnapProcessor)SnapProcessorprotected
volume(void)SnapProcessorinline
wireChunk(SnapMessageWireChunk &wire_chunk_message) (defined in SnapProcessor)SnapProcessorinlineprotected
writeAudio(const uint8_t *data, size_t size) (defined in SnapProcessor)SnapProcessorinlineprotectedvirtual
writeAudioInfo(SnapAudioHeader &header) (defined in SnapProcessor)SnapProcessorinlineprotected
writeHallo() (defined in SnapProcessor)SnapProcessorinlineprotected
writeMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
writeTimedMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor.html b/docs/html/classsnap__arduino_1_1_snap_processor.html new file mode 100644 index 0000000..c1efc6b --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor.html @@ -0,0 +1,377 @@ + + + + + + + +arduino-snapclient: SnapProcessor Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Types | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapProcessor Class Reference
+
+
+ +

Snap Processor implementation which does not rely on FreeRTOS. + More...

+ +

#include <SnapProcessor.h>

+
+Inheritance diagram for SnapProcessor:
+
+
+ + +SnapProcessorBuffered +SnapProcessorRP2040 +SnapProcessorRTOS + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapProcessor (SnapOutput &output)
 
+virtual bool begin ()
 Sets up the output and the client.
 
+const char * clientName ()
 
+bool doLoop ()
 Call via SnapClient in Arduino Loop!
 
+virtual bool doLoop1 ()
 Usually not used!
 
+virtual void end ()
 
+tv_t getLatency ()
 
+const char * hostName ()
 
+void setAudioInfo (AudioInfo info)
 
+void setClient (Client &client)
 Defines an alternative client to the WiFiClient.
 
+void setClientName (const char *name)
 Defines the client name (default "libsnapcast")
 
+void setDecoder (AudioDecoder &dec)
 Defines the decoder class.
 
+void setFastLoop (bool flag)
 
+void setHostName (const char *name)
 Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME)
 
+void setMacAddress (const char *adr)
 
+void setOutput (AudioOutput &output)
 Defines the output class.
 
+void setServerIP (IPAddress address)
 
+void setServerPort (int port)
 
+void setSnapOutput (SnapOutput &out)
 Defines the SnapOutput implementation.
 
+void setStartOutput (bool start)
 
+void setStartTask (bool flag)
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+SnapOutput & snapOutput ()
 
+float volume (void)
 Provides the volume (in the range of 0.0 to 1.0)
 
+ + + +

+Protected Types

enum  loop_status_enum { LoopStart +, LoopStep +, LoopEnd + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+bool audioBegin ()
 
+void audioEnd ()
 
+bool connectClient ()
 connects to the server: returns true if we are connected
 
+virtual void processExt ()
 additional processing
 
+bool processLoopStep ()
 
+bool processLoopStepFast ()
 
+bool processMessageCodecHeader ()
 
+bool processMessageCodecHeaderExt (codec_type codecType)
 
+bool processMessageCodecHeaderOpus (codec_type codecType)
 
+bool processMessageCodecHeaderWav (codec_type codecType)
 
+bool processMessageLoop ()
 
+bool processMessageServerSettings ()
 
+bool processMessageTime ()
 
+bool processMessageWireChunk ()
 
+bool readBaseMessage ()
 
+bool readData ()
 
+bool resizeData ()
 
+void setMute (bool flag)
 
+void setVolume (float vol)
 
+bool wireChunk (SnapMessageWireChunk &wire_chunk_message)
 
+virtual size_t writeAudio (const uint8_t *data, size_t size)
 
+size_t writeAudioInfo (SnapAudioHeader &header)
 
+bool writeHallo ()
 
+bool writeMessage ()
 
+bool writeTimedMessage ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+std::vector< int16_t > audio
 
+SnapMessageBase base_message
 
+std::vector< char > base_message_serialized
 
+uint16_t channels = 2
 
+const char * client_name = "libsnapcast"
 
+uint32_t client_state_muted = 0
 
+codec_type codec_from_server = NO_CODEC
 
+int16_t frame_size = 512
 
+bool header_received = false
 
+const char * hostname = CONFIG_SNAPCAST_CLIENT_NAME
 
+bool http_task_start = true
 
+int id_counter = 0
 
+bool is_fast_loop = false
 
+bool is_time_set = false
 
+uint64_t last_time_sync = 0
 
+loop_status_enum loop_status = LoopStart
 
+const char * mac_address = "00-00-00-00-00"
 
+timeval now
 
+bool output_start = false
 
+Client * p_client = nullptr
 
+SnapOutput * p_snap_output = nullptr
 
+std::vector< char > send_receive_buffer
 
+IPAddress server_ip
 
+int server_port = CONFIG_SNAPCAST_SERVER_PORT
 
+SnapMessageServerSettings server_settings_message
 
+int size = 0
 
+SnapTime & snap_time = SnapTime::instance()
 
+char * start = nullptr
 
+const char * TAG = "SnapProcessor"
 
+SnapMessageTime time_message
 
+

Detailed Description

+

Snap Processor implementation which does not rely on FreeRTOS.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor.png b/docs/html/classsnap__arduino_1_1_snap_processor.png new file mode 100644 index 0000000..b819a88 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_processor.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_buffered-members.html b/docs/html/classsnap__arduino_1_1_snap_processor_buffered-members.html new file mode 100644 index 0000000..e3d4226 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_buffered-members.html @@ -0,0 +1,172 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessorBuffered Member List
+
+
+ +

This is the complete list of members for SnapProcessorBuffered, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
active_percent (defined in SnapProcessorBuffered)SnapProcessorBufferedprotected
audio (defined in SnapProcessor)SnapProcessorprotected
audioBegin() (defined in SnapProcessor)SnapProcessorinlineprotected
audioEnd() (defined in SnapProcessor)SnapProcessorinlineprotected
base_message (defined in SnapProcessor)SnapProcessorprotected
base_message_serialized (defined in SnapProcessor)SnapProcessorprotected
begin() overrideSnapProcessorBufferedinlinevirtual
buffer (defined in SnapProcessorBuffered)SnapProcessorBufferedprotected
bufferTaskActivationLimit()SnapProcessorBufferedinlineprotected
channels (defined in SnapProcessor)SnapProcessorprotected
client_name (defined in SnapProcessor)SnapProcessorprotected
client_state_muted (defined in SnapProcessor)SnapProcessorprotected
clientName() (defined in SnapProcessor)SnapProcessorinline
codec_from_server (defined in SnapProcessor)SnapProcessorprotected
connectClient()SnapProcessorinlineprotected
doLoop()SnapProcessorinline
doLoop1()SnapProcessorinlinevirtual
end() (defined in SnapProcessor)SnapProcessorinlinevirtual
frame_size (defined in SnapProcessor)SnapProcessorprotected
getLatency() (defined in SnapProcessor)SnapProcessorinline
header_received (defined in SnapProcessor)SnapProcessorprotected
hostName() (defined in SnapProcessor)SnapProcessorinline
hostname (defined in SnapProcessor)SnapProcessorprotected
http_task_start (defined in SnapProcessor)SnapProcessorprotected
id_counter (defined in SnapProcessor)SnapProcessorprotected
is_active (defined in SnapProcessorBuffered)SnapProcessorBufferedprotected
is_fast_loop (defined in SnapProcessor)SnapProcessorprotected
is_time_set (defined in SnapProcessor)SnapProcessorprotected
isBufferActive() (defined in SnapProcessorBuffered)SnapProcessorBufferedinlineprotected
last_time_sync (defined in SnapProcessor)SnapProcessorprotected
loop_status (defined in SnapProcessor)SnapProcessorprotected
loop_status_enum enum name (defined in SnapProcessor)SnapProcessorprotected
LoopEnd enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStart enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStep enum value (defined in SnapProcessor)SnapProcessorprotected
mac_address (defined in SnapProcessor)SnapProcessorprotected
now (defined in SnapProcessor)SnapProcessorprotected
output_start (defined in SnapProcessor)SnapProcessorprotected
p_client (defined in SnapProcessor)SnapProcessorprotected
p_snap_output (defined in SnapProcessor)SnapProcessorprotected
processExt()SnapProcessorBufferedinlinevirtual
processLoopStep() (defined in SnapProcessor)SnapProcessorinlineprotected
processLoopStepFast() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeader() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderExt(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderOpus(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderWav(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageLoop() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageServerSettings() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageTime() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageWireChunk() (defined in SnapProcessor)SnapProcessorinlineprotected
readBaseMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
readData() (defined in SnapProcessor)SnapProcessorinlineprotected
resizeData() (defined in SnapProcessor)SnapProcessorinlineprotected
send_receive_buffer (defined in SnapProcessor)SnapProcessorprotected
server_ip (defined in SnapProcessor)SnapProcessorprotected
server_port (defined in SnapProcessor)SnapProcessorprotected
server_settings_message (defined in SnapProcessor)SnapProcessorprotected
setAudioInfo(AudioInfo info) (defined in SnapProcessor)SnapProcessorinline
setClient(Client &client)SnapProcessorinline
setClientName(const char *name)SnapProcessorinline
setDecoder(AudioDecoder &dec)SnapProcessorinline
setFastLoop(bool flag) (defined in SnapProcessor)SnapProcessorinline
setHostName(const char *name)SnapProcessorinline
setMacAddress(const char *adr) (defined in SnapProcessor)SnapProcessorinline
setMute(bool flag) (defined in SnapProcessor)SnapProcessorinlineprotected
setOutput(AudioOutput &output)SnapProcessorinline
setServerIP(IPAddress address) (defined in SnapProcessor)SnapProcessorinline
setServerPort(int port) (defined in SnapProcessor)SnapProcessorinline
setSnapOutput(SnapOutput &out)SnapProcessorinline
setStartOutput(bool start) (defined in SnapProcessor)SnapProcessorinline
setStartTask(bool flag) (defined in SnapProcessor)SnapProcessorinline
setVolume(float vol) (defined in SnapProcessor)SnapProcessorinlineprotected
setVolumeFactor(float fact)SnapProcessorinline
size (defined in SnapProcessor)SnapProcessorprotected
sizes (defined in SnapProcessorBuffered)SnapProcessorBufferedprotected
snap_time (defined in SnapProcessor)SnapProcessorprotected
snapOutput() (defined in SnapProcessor)SnapProcessorinline
SnapProcessor(SnapOutput &output) (defined in SnapProcessor)SnapProcessorinline
SnapProcessor() (defined in SnapProcessor)SnapProcessorinline
SnapProcessorBuffered(int buffer_size, int activationAtPercent=75)SnapProcessorBufferedinline
start (defined in SnapProcessor)SnapProcessorprotected
TAG (defined in SnapProcessorBuffered)SnapProcessorBufferedprotected
time_message (defined in SnapProcessor)SnapProcessorprotected
volume(void)SnapProcessorinline
wireChunk(SnapMessageWireChunk &wire_chunk_message) (defined in SnapProcessor)SnapProcessorinlineprotected
writeAudio(const uint8_t *data, size_t size) overrideSnapProcessorBufferedinlinevirtual
writeAudioInfo(SnapAudioHeader &header) (defined in SnapProcessor)SnapProcessorinlineprotected
writeHallo() (defined in SnapProcessor)SnapProcessorinlineprotected
writeMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
writeTimedMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_buffered.html b/docs/html/classsnap__arduino_1_1_snap_processor_buffered.html new file mode 100644 index 0000000..78d4894 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_buffered.html @@ -0,0 +1,396 @@ + + + + + + + +arduino-snapclient: SnapProcessorBuffered Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Types | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapProcessorBuffered Class Reference
+
+
+ +

Processor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns. + More...

+ +

#include <SnapProcessorBuffered.h>

+
+Inheritance diagram for SnapProcessorBuffered:
+
+
+ + +SnapProcessor + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapProcessorBuffered (int buffer_size, int activationAtPercent=75)
 Default constructor.
 
+bool begin () override
 Sets up the output and the client.
 
+const char * clientName ()
 
+bool doLoop ()
 Call via SnapClient in Arduino Loop!
 
+virtual bool doLoop1 ()
 Usually not used!
 
+virtual void end ()
 
+tv_t getLatency ()
 
+const char * hostName ()
 
+virtual void processExt ()
 Decode from buffer.
 
+void setAudioInfo (AudioInfo info)
 
+void setClient (Client &client)
 Defines an alternative client to the WiFiClient.
 
+void setClientName (const char *name)
 Defines the client name (default "libsnapcast")
 
+void setDecoder (AudioDecoder &dec)
 Defines the decoder class.
 
+void setFastLoop (bool flag)
 
+void setHostName (const char *name)
 Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME)
 
+void setMacAddress (const char *adr)
 
+void setOutput (AudioOutput &output)
 Defines the output class.
 
+void setServerIP (IPAddress address)
 
+void setServerPort (int port)
 
+void setSnapOutput (SnapOutput &out)
 Defines the SnapOutput implementation.
 
+void setStartOutput (bool start)
 
+void setStartTask (bool flag)
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+SnapOutput & snapOutput ()
 
+float volume (void)
 Provides the volume (in the range of 0.0 to 1.0)
 
+size_t writeAudio (const uint8_t *data, size_t size) override
 fill buffer
 
+ + + +

+Protected Types

enum  loop_status_enum { LoopStart +, LoopStep +, LoopEnd + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+bool audioBegin ()
 
+void audioEnd ()
 
+int bufferTaskActivationLimit ()
 Determines the buffer fill limit at which we start to process the data.
 
+bool connectClient ()
 connects to the server: returns true if we are connected
 
+bool isBufferActive ()
 
+bool processLoopStep ()
 
+bool processLoopStepFast ()
 
+bool processMessageCodecHeader ()
 
+bool processMessageCodecHeaderExt (codec_type codecType)
 
+bool processMessageCodecHeaderOpus (codec_type codecType)
 
+bool processMessageCodecHeaderWav (codec_type codecType)
 
+bool processMessageLoop ()
 
+bool processMessageServerSettings ()
 
+bool processMessageTime ()
 
+bool processMessageWireChunk ()
 
+bool readBaseMessage ()
 
+bool readData ()
 
+bool resizeData ()
 
+void setMute (bool flag)
 
+void setVolume (float vol)
 
+bool wireChunk (SnapMessageWireChunk &wire_chunk_message)
 
+size_t writeAudioInfo (SnapAudioHeader &header)
 
+bool writeHallo ()
 
+bool writeMessage ()
 
+bool writeTimedMessage ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+int active_percent
 
+std::vector< int16_t > audio
 
+SnapMessageBase base_message
 
+std::vector< char > base_message_serialized
 
+RingBuffer< uint8_t > buffer {0}
 
+uint16_t channels = 2
 
+const char * client_name = "libsnapcast"
 
+uint32_t client_state_muted = 0
 
+codec_type codec_from_server = NO_CODEC
 
+int16_t frame_size = 512
 
+bool header_received = false
 
+const char * hostname = CONFIG_SNAPCAST_CLIENT_NAME
 
+bool http_task_start = true
 
+int id_counter = 0
 
+bool is_active = false
 
+bool is_fast_loop = false
 
+bool is_time_set = false
 
+uint64_t last_time_sync = 0
 
+loop_status_enum loop_status = LoopStart
 
+const char * mac_address = "00-00-00-00-00"
 
+timeval now
 
+bool output_start = false
 
+Client * p_client = nullptr
 
+SnapOutput * p_snap_output = nullptr
 
+std::vector< char > send_receive_buffer
 
+IPAddress server_ip
 
+int server_port = CONFIG_SNAPCAST_SERVER_PORT
 
+SnapMessageServerSettings server_settings_message
 
+int size = 0
 
+RingBuffer< int16_t > sizes {RTOS_MAX_QUEUE_ENTRY_COUNT}
 
+SnapTime & snap_time = SnapTime::instance()
 
+char * start = nullptr
 
+const char * TAG = "SnapProcessorBuffered"
 
+SnapMessageTime time_message
 
+

Detailed Description

+

Processor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2024-03-04
+
Copyright
Copyright (c) 2024
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_buffered.png b/docs/html/classsnap__arduino_1_1_snap_processor_buffered.png new file mode 100644 index 0000000..c1a0abc Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_processor_buffered.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040-members.html b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040-members.html new file mode 100644 index 0000000..e147ce0 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040-members.html @@ -0,0 +1,174 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessorRP2040 Member List
+
+
+ +

This is the complete list of members for SnapProcessorRP2040, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
active_percent (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
audio (defined in SnapProcessor)SnapProcessorprotected
audioBegin() (defined in SnapProcessor)SnapProcessorinlineprotected
audioEnd() (defined in SnapProcessor)SnapProcessorinlineprotected
base_message (defined in SnapProcessor)SnapProcessorprotected
base_message_serialized (defined in SnapProcessor)SnapProcessorprotected
begin() overrideSnapProcessorRP2040inlinevirtual
buffer (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
buffer_count (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
channels (defined in SnapProcessor)SnapProcessorprotected
client_name (defined in SnapProcessor)SnapProcessorprotected
client_state_muted (defined in SnapProcessor)SnapProcessorprotected
clientName() (defined in SnapProcessor)SnapProcessorinline
codec_from_server (defined in SnapProcessor)SnapProcessorprotected
connectClient()SnapProcessorinlineprotected
doLoop()SnapProcessorinline
doLoop1() overrideSnapProcessorRP2040inlinevirtual
end(void) override (defined in SnapProcessorRP2040)SnapProcessorRP2040inlinevirtual
frame_size (defined in SnapProcessor)SnapProcessorprotected
getLatency() (defined in SnapProcessor)SnapProcessorinline
header_received (defined in SnapProcessor)SnapProcessorprotected
hostname (defined in SnapProcessor)SnapProcessorprotected
hostName() (defined in SnapProcessor)SnapProcessorinline
http_task_start (defined in SnapProcessor)SnapProcessorprotected
id_counter (defined in SnapProcessor)SnapProcessorprotected
initQueues(int bufferSizeBytes)SnapProcessorRP2040inlineprotected
is_active (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
is_fast_loop (defined in SnapProcessor)SnapProcessorprotected
is_time_set (defined in SnapProcessor)SnapProcessorprotected
isBufferActive() (defined in SnapProcessorRP2040)SnapProcessorRP2040inlineprotected
last_time_sync (defined in SnapProcessor)SnapProcessorprotected
loop_status (defined in SnapProcessor)SnapProcessorprotected
loop_status_enum enum name (defined in SnapProcessor)SnapProcessorprotected
LoopEnd enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStart enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStep enum value (defined in SnapProcessor)SnapProcessorprotected
mac_address (defined in SnapProcessor)SnapProcessorprotected
now (defined in SnapProcessor)SnapProcessorprotected
output_start (defined in SnapProcessor)SnapProcessorprotected
p_client (defined in SnapProcessor)SnapProcessorprotected
p_snap_output (defined in SnapProcessor)SnapProcessorprotected
processExt()SnapProcessorinlineprotectedvirtual
processLoopStep() (defined in SnapProcessor)SnapProcessorinlineprotected
processLoopStepFast() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeader() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderExt(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderOpus(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderWav(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageLoop() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageServerSettings() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageTime() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageWireChunk() (defined in SnapProcessor)SnapProcessorinlineprotected
readBaseMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
readData() (defined in SnapProcessor)SnapProcessorinlineprotected
resizeData() (defined in SnapProcessor)SnapProcessorinlineprotected
send_receive_buffer (defined in SnapProcessor)SnapProcessorprotected
server_ip (defined in SnapProcessor)SnapProcessorprotected
server_port (defined in SnapProcessor)SnapProcessorprotected
server_settings_message (defined in SnapProcessor)SnapProcessorprotected
setAudioInfo(AudioInfo info) (defined in SnapProcessor)SnapProcessorinline
setClient(Client &client)SnapProcessorinline
setClientName(const char *name)SnapProcessorinline
setDecoder(AudioDecoder &dec)SnapProcessorinline
setFastLoop(bool flag) (defined in SnapProcessor)SnapProcessorinline
setHostName(const char *name)SnapProcessorinline
setMacAddress(const char *adr) (defined in SnapProcessor)SnapProcessorinline
setMute(bool flag) (defined in SnapProcessor)SnapProcessorinlineprotected
setOutput(AudioOutput &output)SnapProcessorinline
setServerIP(IPAddress address) (defined in SnapProcessor)SnapProcessorinline
setServerPort(int port) (defined in SnapProcessor)SnapProcessorinline
setSnapOutput(SnapOutput &out)SnapProcessorinline
setStartOutput(bool start) (defined in SnapProcessor)SnapProcessorinline
setStartTask(bool flag) (defined in SnapProcessor)SnapProcessorinline
setVolume(float vol) (defined in SnapProcessor)SnapProcessorinlineprotected
setVolumeFactor(float fact)SnapProcessorinline
size (defined in SnapProcessor)SnapProcessorprotected
size_queue (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
snap_time (defined in SnapProcessor)SnapProcessorprotected
snapOutput() (defined in SnapProcessor)SnapProcessorinline
SnapProcessor(SnapOutput &output) (defined in SnapProcessor)SnapProcessorinline
SnapProcessor() (defined in SnapProcessor)SnapProcessorinline
SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent=75)SnapProcessorRP2040inline
SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent=75)SnapProcessorRP2040inline
start (defined in SnapProcessor)SnapProcessorprotected
TAG (defined in SnapProcessorRP2040)SnapProcessorRP2040protected
time_message (defined in SnapProcessor)SnapProcessorprotected
volume(void)SnapProcessorinline
wireChunk(SnapMessageWireChunk &wire_chunk_message) (defined in SnapProcessor)SnapProcessorinlineprotected
writeAudio(const uint8_t *data, size_t size) overrideSnapProcessorRP2040inlineprotectedvirtual
writeAudioInfo(SnapAudioHeader &header) (defined in SnapProcessor)SnapProcessorinlineprotected
writeHallo() (defined in SnapProcessor)SnapProcessorinlineprotected
writeMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
writeTimedMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.html b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.html new file mode 100644 index 0000000..7f2dcbd --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.html @@ -0,0 +1,403 @@ + + + + + + + +arduino-snapclient: SnapProcessorRP2040 Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Types | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapProcessorRP2040 Class Reference
+
+
+ +

Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();. + More...

+ +

#include <SnapProcessorRP2040.h>

+
+Inheritance diagram for SnapProcessorRP2040:
+
+
+ + +SnapProcessor + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapProcessorRP2040 (int bufferSizeBytes, int activationAtPercent=75)
 Default constructor.
 
+ SnapProcessorRP2040 (SnapOutput &output, int bufferSizeBytes, int activationAtPercent=75)
 Default constructor.
 
+bool begin () override
 Sets up the output and the client.
 
+const char * clientName ()
 
+bool doLoop ()
 Call via SnapClient in Arduino Loop!
 
+bool doLoop1 () override
 Usually not used!
 
+void end (void) override
 
+tv_t getLatency ()
 
+const char * hostName ()
 
+void setAudioInfo (AudioInfo info)
 
+void setClient (Client &client)
 Defines an alternative client to the WiFiClient.
 
+void setClientName (const char *name)
 Defines the client name (default "libsnapcast")
 
+void setDecoder (AudioDecoder &dec)
 Defines the decoder class.
 
+void setFastLoop (bool flag)
 
+void setHostName (const char *name)
 Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME)
 
+void setMacAddress (const char *adr)
 
+void setOutput (AudioOutput &output)
 Defines the output class.
 
+void setServerIP (IPAddress address)
 
+void setServerPort (int port)
 
+void setSnapOutput (SnapOutput &out)
 Defines the SnapOutput implementation.
 
+void setStartOutput (bool start)
 
+void setStartTask (bool flag)
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+SnapOutput & snapOutput ()
 
+float volume (void)
 Provides the volume (in the range of 0.0 to 1.0)
 
+ + + +

+Protected Types

enum  loop_status_enum { LoopStart +, LoopStep +, LoopEnd + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+bool audioBegin ()
 
+void audioEnd ()
 
+bool connectClient ()
 connects to the server: returns true if we are connected
 
+void initQueues (int bufferSizeBytes)
 store parameters provided by constructor
 
+bool isBufferActive ()
 
+virtual void processExt ()
 additional processing
 
+bool processLoopStep ()
 
+bool processLoopStepFast ()
 
+bool processMessageCodecHeader ()
 
+bool processMessageCodecHeaderExt (codec_type codecType)
 
+bool processMessageCodecHeaderOpus (codec_type codecType)
 
+bool processMessageCodecHeaderWav (codec_type codecType)
 
+bool processMessageLoop ()
 
+bool processMessageServerSettings ()
 
+bool processMessageTime ()
 
+bool processMessageWireChunk ()
 
+bool readBaseMessage ()
 
+bool readData ()
 
+bool resizeData ()
 
+void setMute (bool flag)
 
+void setVolume (float vol)
 
+bool wireChunk (SnapMessageWireChunk &wire_chunk_message)
 
+size_t writeAudio (const uint8_t *data, size_t size) override
 Writes the encoded audio data to a queue.
 
+size_t writeAudioInfo (SnapAudioHeader &header)
 
+bool writeHallo ()
 
+bool writeMessage ()
 
+bool writeTimedMessage ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+int active_percent = 0
 
+std::vector< int16_t > audio
 
+SnapMessageBase base_message
 
+std::vector< char > base_message_serialized
 
+audio_tools::BufferRP2040T< uint8_t > buffer {1024, 0}
 
+int buffer_count = 0
 
+uint16_t channels = 2
 
+const char * client_name = "libsnapcast"
 
+uint32_t client_state_muted = 0
 
+codec_type codec_from_server = NO_CODEC
 
+int16_t frame_size = 512
 
+bool header_received = false
 
+const char * hostname = CONFIG_SNAPCAST_CLIENT_NAME
 
+bool http_task_start = true
 
+int id_counter = 0
 
+bool is_active = false
 
+bool is_fast_loop = false
 
+bool is_time_set = false
 
+uint64_t last_time_sync = 0
 
+loop_status_enum loop_status = LoopStart
 
+const char * mac_address = "00-00-00-00-00"
 
+timeval now
 
+bool output_start = false
 
+Client * p_client = nullptr
 
+SnapOutput * p_snap_output = nullptr
 
+std::vector< char > send_receive_buffer
 
+IPAddress server_ip
 
+int server_port = CONFIG_SNAPCAST_SERVER_PORT
 
+SnapMessageServerSettings server_settings_message
 
+int size = 0
 
+audio_tools::BufferRP2040T< size_t > size_queue {1, 0}
 
+SnapTime & snap_time = SnapTime::instance()
 
+char * start = nullptr
 
+const char * TAG = "SnapProcessorRP2040"
 
+SnapMessageTime time_message
 
+

Detailed Description

+

Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2024-02-26
+
Copyright
Copyright (c) 2023
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.png b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.png new file mode 100644 index 0000000..5983063 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_processor_r_p2040.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s-members.html b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s-members.html new file mode 100644 index 0000000..9ea5968 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s-members.html @@ -0,0 +1,178 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapProcessorRTOS Member List
+
+
+ +

This is the complete list of members for SnapProcessorRTOS, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
active_percent (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
audio (defined in SnapProcessor)SnapProcessorprotected
audioBegin() (defined in SnapProcessor)SnapProcessorinlineprotected
audioEnd() (defined in SnapProcessor)SnapProcessorinlineprotected
base_message (defined in SnapProcessor)SnapProcessorprotected
base_message_serialized (defined in SnapProcessor)SnapProcessorprotected
begin() overrideSnapProcessorRTOSinlinevirtual
buffer (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
buffer_size (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
bufferTaskActivationLimit()SnapProcessorRTOSinlineprotected
channels (defined in SnapProcessor)SnapProcessorprotected
client_name (defined in SnapProcessor)SnapProcessorprotected
client_state_muted (defined in SnapProcessor)SnapProcessorprotected
clientName() (defined in SnapProcessor)SnapProcessorinline
codec_from_server (defined in SnapProcessor)SnapProcessorprotected
connectClient()SnapProcessorinlineprotected
copy()SnapProcessorRTOSinlineprotected
doLoop()SnapProcessorinline
doLoop1()SnapProcessorinlinevirtual
end(void) override (defined in SnapProcessorRTOS)SnapProcessorRTOSinlinevirtual
frame_size (defined in SnapProcessor)SnapProcessorprotected
getLatency() (defined in SnapProcessor)SnapProcessorinline
header_received (defined in SnapProcessor)SnapProcessorprotected
hostName() (defined in SnapProcessor)SnapProcessorinline
hostname (defined in SnapProcessor)SnapProcessorprotected
http_task_start (defined in SnapProcessor)SnapProcessorprotected
id_counter (defined in SnapProcessor)SnapProcessorprotected
init_rtos(int bufferSize, int activationAtPercent)SnapProcessorRTOSinlineprotected
is_fast_loop (defined in SnapProcessor)SnapProcessorprotected
is_time_set (defined in SnapProcessor)SnapProcessorprotected
last_time_sync (defined in SnapProcessor)SnapProcessorprotected
loop_status (defined in SnapProcessor)SnapProcessorprotected
loop_status_enum enum name (defined in SnapProcessor)SnapProcessorprotected
LoopEnd enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStart enum value (defined in SnapProcessor)SnapProcessorprotected
LoopStep enum value (defined in SnapProcessor)SnapProcessorprotected
mac_address (defined in SnapProcessor)SnapProcessorprotected
now (defined in SnapProcessor)SnapProcessorprotected
output_start (defined in SnapProcessor)SnapProcessorprotected
p_client (defined in SnapProcessor)SnapProcessorprotected
p_snap_output (defined in SnapProcessor)SnapProcessorprotected
processExt()SnapProcessorinlineprotectedvirtual
processLoopStep() (defined in SnapProcessor)SnapProcessorinlineprotected
processLoopStepFast() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeader() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderExt(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderOpus(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageCodecHeaderWav(codec_type codecType) (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageLoop() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageServerSettings() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageTime() (defined in SnapProcessor)SnapProcessorinlineprotected
processMessageWireChunk() (defined in SnapProcessor)SnapProcessorinlineprotected
readBaseMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
readData() (defined in SnapProcessor)SnapProcessorinlineprotected
resizeData() (defined in SnapProcessor)SnapProcessorinlineprotected
self (defined in SnapProcessorRTOS)SnapProcessorRTOSprotectedstatic
send_receive_buffer (defined in SnapProcessor)SnapProcessorprotected
server_ip (defined in SnapProcessor)SnapProcessorprotected
server_port (defined in SnapProcessor)SnapProcessorprotected
server_settings_message (defined in SnapProcessor)SnapProcessorprotected
setAudioInfo(AudioInfo info) (defined in SnapProcessor)SnapProcessorinline
setClient(Client &client)SnapProcessorinline
setClientName(const char *name)SnapProcessorinline
setDecoder(AudioDecoder &dec)SnapProcessorinline
setFastLoop(bool flag) (defined in SnapProcessor)SnapProcessorinline
setHostName(const char *name)SnapProcessorinline
setMacAddress(const char *adr) (defined in SnapProcessor)SnapProcessorinline
setMute(bool flag) (defined in SnapProcessor)SnapProcessorinlineprotected
setOutput(AudioOutput &output)SnapProcessorinline
setServerIP(IPAddress address) (defined in SnapProcessor)SnapProcessorinline
setServerPort(int port) (defined in SnapProcessor)SnapProcessorinline
setSnapOutput(SnapOutput &out)SnapProcessorinline
setStartOutput(bool start) (defined in SnapProcessor)SnapProcessorinline
setStartTask(bool flag) (defined in SnapProcessor)SnapProcessorinline
setVolume(float vol) (defined in SnapProcessor)SnapProcessorinlineprotected
setVolumeFactor(float fact)SnapProcessorinline
size (defined in SnapProcessor)SnapProcessorprotected
size_queue (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
snap_time (defined in SnapProcessor)SnapProcessorprotected
snapOutput() (defined in SnapProcessor)SnapProcessorinline
SnapProcessor(SnapOutput &output) (defined in SnapProcessor)SnapProcessorinline
SnapProcessor() (defined in SnapProcessor)SnapProcessorinline
SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)SnapProcessorRTOSinline
SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)SnapProcessorRTOSinline
start (defined in SnapProcessor)SnapProcessorprotected
TAG (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
task (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
task_copy()SnapProcessorRTOSinlineprotectedstatic
task_started (defined in SnapProcessorRTOS)SnapProcessorRTOSprotected
time_message (defined in SnapProcessor)SnapProcessorprotected
volume(void)SnapProcessorinline
wireChunk(SnapMessageWireChunk &wire_chunk_message) (defined in SnapProcessor)SnapProcessorinlineprotected
writeAudio(const uint8_t *data, size_t size) overrideSnapProcessorRTOSinlineprotectedvirtual
writeAudioInfo(SnapAudioHeader &header) (defined in SnapProcessor)SnapProcessorinlineprotected
writeHallo() (defined in SnapProcessor)SnapProcessorinlineprotected
writeMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
writeTimedMessage() (defined in SnapProcessor)SnapProcessorinlineprotected
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.html b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.html new file mode 100644 index 0000000..8480ef7 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.html @@ -0,0 +1,426 @@ + + + + + + + +arduino-snapclient: SnapProcessorRTOS Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Types | +Protected Member Functions | +Static Protected Member Functions | +Protected Attributes | +Static Protected Attributes | +List of all members
+
+
SnapProcessorRTOS Class Reference
+
+
+ +

Processor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue. + More...

+ +

#include <SnapProcessorRTOS.h>

+
+Inheritance diagram for SnapProcessorRTOS:
+
+
+ + +SnapProcessor + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapProcessorRTOS (int buffer_size, int activationAtPercent=75)
 Default constructor.
 
+ SnapProcessorRTOS (SnapOutput &output, int buffer_size, int activationAtPercent=75)
 Default constructor.
 
+bool begin () override
 Sets up the output and the client.
 
+const char * clientName ()
 
+bool doLoop ()
 Call via SnapClient in Arduino Loop!
 
+virtual bool doLoop1 ()
 Usually not used!
 
+void end (void) override
 
+tv_t getLatency ()
 
+const char * hostName ()
 
+void setAudioInfo (AudioInfo info)
 
+void setClient (Client &client)
 Defines an alternative client to the WiFiClient.
 
+void setClientName (const char *name)
 Defines the client name (default "libsnapcast")
 
+void setDecoder (AudioDecoder &dec)
 Defines the decoder class.
 
+void setFastLoop (bool flag)
 
+void setHostName (const char *name)
 Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME)
 
+void setMacAddress (const char *adr)
 
+void setOutput (AudioOutput &output)
 Defines the output class.
 
+void setServerIP (IPAddress address)
 
+void setServerPort (int port)
 
+void setSnapOutput (SnapOutput &out)
 Defines the SnapOutput implementation.
 
+void setStartOutput (bool start)
 
+void setStartTask (bool flag)
 
+void setVolumeFactor (float fact)
 Adjust volume by factor e.g. 1.5.
 
+SnapOutput & snapOutput ()
 
+float volume (void)
 Provides the volume (in the range of 0.0 to 1.0)
 
+ + + +

+Protected Types

enum  loop_status_enum { LoopStart +, LoopStep +, LoopEnd + }
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Member Functions

+bool audioBegin ()
 
+void audioEnd ()
 
+int bufferTaskActivationLimit ()
 Determines the buffer fill limit at which we start to process the data.
 
+bool connectClient ()
 connects to the server: returns true if we are connected
 
+void copy ()
 Copy the buffered data to the output.
 
+void init_rtos (int bufferSize, int activationAtPercent)
 store parameters provided by constructor
 
+virtual void processExt ()
 additional processing
 
+bool processLoopStep ()
 
+bool processLoopStepFast ()
 
+bool processMessageCodecHeader ()
 
+bool processMessageCodecHeaderExt (codec_type codecType)
 
+bool processMessageCodecHeaderOpus (codec_type codecType)
 
+bool processMessageCodecHeaderWav (codec_type codecType)
 
+bool processMessageLoop ()
 
+bool processMessageServerSettings ()
 
+bool processMessageTime ()
 
+bool processMessageWireChunk ()
 
+bool readBaseMessage ()
 
+bool readData ()
 
+bool resizeData ()
 
+void setMute (bool flag)
 
+void setVolume (float vol)
 
+bool wireChunk (SnapMessageWireChunk &wire_chunk_message)
 
+size_t writeAudio (const uint8_t *data, size_t size) override
 Writes the encoded audio data to a queue.
 
+size_t writeAudioInfo (SnapAudioHeader &header)
 
+bool writeHallo ()
 
+bool writeMessage ()
 
+bool writeTimedMessage ()
 
+ + + + +

+Static Protected Member Functions

+static void task_copy ()
 static method for rtos task: make sure we constantly output audio
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Protected Attributes

+int active_percent
 
+std::vector< int16_t > audio
 
+SnapMessageBase base_message
 
+std::vector< char > base_message_serialized
 
+audio_tools::BufferRTOS< uint8_t > buffer {0}
 
+int buffer_size
 
+uint16_t channels = 2
 
+const char * client_name = "libsnapcast"
 
+uint32_t client_state_muted = 0
 
+codec_type codec_from_server = NO_CODEC
 
+int16_t frame_size = 512
 
+bool header_received = false
 
+const char * hostname = CONFIG_SNAPCAST_CLIENT_NAME
 
+bool http_task_start = true
 
+int id_counter = 0
 
+bool is_fast_loop = false
 
+bool is_time_set = false
 
+uint64_t last_time_sync = 0
 
+loop_status_enum loop_status = LoopStart
 
+const char * mac_address = "00-00-00-00-00"
 
+timeval now
 
+bool output_start = false
 
+Client * p_client = nullptr
 
+SnapOutput * p_snap_output = nullptr
 
+std::vector< char > send_receive_buffer
 
+IPAddress server_ip
 
+int server_port = CONFIG_SNAPCAST_SERVER_PORT
 
+SnapMessageServerSettings server_settings_message
 
+int size = 0
 
+audio_tools::QueueRTOS< size_t > size_queue {0}
 
+SnapTime & snap_time = SnapTime::instance()
 
+char * start = nullptr
 
+const char * TAG = "SnapProcessorRTOS"
 
+audio_tools::Task task {"output", RTOS_STACK_SIZE, RTOS_TASK_PRIORITY, 1}
 
+bool task_started = false
 
+SnapMessageTime time_message
 
+ + + +

+Static Protected Attributes

+static SnapProcessorRTOS * self = nullptr
 
+

Detailed Description

+

Processor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2024-02-26
+
Copyright
Copyright (c) 2023
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.png b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.png new file mode 100644 index 0000000..418edab Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_processor_r_t_o_s.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_time-members.html b/docs/html/classsnap__arduino_1_1_snap_time-members.html new file mode 100644 index 0000000..8992d8b --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time-members.html @@ -0,0 +1,101 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTime Member List
+
+
+ +

This is the complete list of members for SnapTime, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + +
has_sntp_time (defined in SnapTime)SnapTimeprotected
instance() (defined in SnapTime)SnapTimeinlinestatic
local_ms (defined in SnapTime)SnapTimeprotected
localMillis() (defined in SnapTime)SnapTimeinline
printLocalTime(const char *msg) (defined in SnapTime)SnapTimeinline
server_ms (defined in SnapTime)SnapTimeprotected
server_time (defined in SnapTime)SnapTimeprotected
serverMillis()SnapTimeinline
setTimeDifferenceClientServerMs(uint32_t diff)SnapTimeinline
setupSNTPTime() (defined in SnapTime)SnapTimeinline
TAG (defined in SnapTime)SnapTimeprotected
time()SnapTimeinline
time_diff (defined in SnapTime)SnapTimeprotected
time_update_count (defined in SnapTime)SnapTimeprotected
timeDifference(timeval t1, timeval t2) (defined in SnapTime)SnapTimeinline
timeDifferenceClientServerMs()SnapTimeinline
timeDifferenceMs(timeval t1, timeval t2) (defined in SnapTime)SnapTimeinline
toMillis(timeval tv) (defined in SnapTime)SnapTimeinline
toMillis(uint32_t sec, uint32_t usec) (defined in SnapTime)SnapTimeinline
updateServerTime(timeval &server) (defined in SnapTime)SnapTimeinline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time.html b/docs/html/classsnap__arduino_1_1_snap_time.html new file mode 100644 index 0000000..8c13301 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time.html @@ -0,0 +1,171 @@ + + + + + + + +arduino-snapclient: SnapTime Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Static Public Member Functions | +Protected Attributes | +List of all members
+
+
SnapTime Class Reference
+
+
+ +

The the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time. + More...

+ +

#include <SnapTime.h>

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+uint32_t localMillis ()
 
+bool printLocalTime (const char *msg)
 
+uint32_t serverMillis ()
 Provides the current server time in ms.
 
+void setTimeDifferenceClientServerMs (uint32_t diff)
 Record the last time difference between client and server.
 
+void setupSNTPTime ()
 
+timeval time ()
 Provides the actual time as timeval.
 
+timeval timeDifference (timeval t1, timeval t2)
 
+int timeDifferenceClientServerMs ()
 Provides the avg latecy in milliseconds.
 
+uint32_t timeDifferenceMs (timeval t1, timeval t2)
 
+uint32_t toMillis (timeval tv)
 
+uint32_t toMillis (uint32_t sec, uint32_t usec)
 
+void updateServerTime (timeval &server)
 
+ + + +

+Static Public Member Functions

+static SnapTime & instance ()
 
+ + + + + + + + + + + + + + + +

+Protected Attributes

+bool has_sntp_time = false
 
+uint32_t local_ms
 
+uint32_t server_ms = 0
 
+timeval server_time
 
+const char * TAG = "SnapTime"
 
+uint32_t time_diff = 0
 
+uint32_t time_update_count = 0
 
+

Detailed Description

+

The the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync-members.html b/docs/html/classsnap__arduino_1_1_snap_time_sync-members.html new file mode 100644 index 0000000..e709c05 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync-members.html @@ -0,0 +1,97 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTimeSync Member List
+
+
+ +

This is the complete list of members for SnapTimeSync, including all inherited members.

+ + + + + + + + + + + + + + + + + +
active (defined in SnapTimeSync)SnapTimeSyncprotected
begin(int rate)SnapTimeSyncinline
getFactor()=0SnapTimeSyncpure virtual
getStartDelay()SnapTimeSyncinline
interval (defined in SnapTimeSync)SnapTimeSyncprotected
isSync()SnapTimeSyncinline
message_buffer_delay_ms (defined in SnapTimeSync)SnapTimeSyncprotected
processing_lag (defined in SnapTimeSync)SnapTimeSyncprotected
setInterval(int interval)SnapTimeSyncinline
setMessageBufferDelay(int ms)SnapTimeSyncinline
setProcessingLag(int lag)SnapTimeSyncinline
SnapTimeSync(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSync)SnapTimeSyncinline
TAG (defined in SnapTimeSync)SnapTimeSyncprotected
update_count (defined in SnapTimeSync)SnapTimeSyncprotected
updateActualDelay(int delay)SnapTimeSyncinlinevirtual
updateServerTime(uint32_t serverMillis)=0SnapTimeSyncpure virtual
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync.html b/docs/html/classsnap__arduino_1_1_snap_time_sync.html new file mode 100644 index 0000000..4e86bde --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync.html @@ -0,0 +1,272 @@ + + + + + + + +arduino-snapclient: SnapTimeSync Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
SnapTimeSync Class Referenceabstract
+
+
+ +

Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate. + More...

+ +

#include <SnapTimeSync.h>

+
+Inheritance diagram for SnapTimeSync:
+
+
+ + +SnapTimeSyncDynamic +SnapTimeSyncDynamicSinceStart +SnapTimeSyncFixed + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapTimeSync (int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10)
 
+void begin (int rate)
 Starts the processing.
 
virtual float getFactor ()=0
 
int getStartDelay ()
 
+bool isSync ()
 Returns true if a synchronization (update of the sampling rate) is needed.
 
void setInterval (int interval)
 
+void setMessageBufferDelay (int ms)
 Defines the message buffer lag.
 
void setProcessingLag (int lag)
 
+virtual void updateActualDelay (int delay)
 Records the actual playback delay (currently not used)
 
+virtual void updateServerTime (uint32_t serverMillis)=0
 Records the actual server time in millisecondes.
 
+ + + + + + + + + + + + + +

+Protected Attributes

+bool active = false
 
+int interval = 10
 
+uint16_t message_buffer_delay_ms = 0
 
+int processing_lag = 0
 
+const char * TAG = "SnapTimeSync"
 
+uint64_t update_count = 0
 
+

Detailed Description

+

Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ getFactor()

+ +
+
+ + + + + +
+ + + + + + + +
virtual float getFactor ()
+ 		+pure virtual
+
+

Calculate the resampling factor: with a positive delay we play too fast and need to slow down

+ +

Implemented in SnapTimeSyncFixed, SnapTimeSyncDynamicSinceStart, and SnapTimeSyncDynamic.

+ +
+
+ +

◆ getStartDelay()

+ +
+
+ + + + + +
+ + + + + + + +
int getStartDelay ()
+ 		+inline
+
+

Provides the effective delay to be used (Message buffer lag - decoding/playback time)

+ +
+
+ +

◆ setInterval()

+ +
+
+ + + + + +
+ + + + + + + + +
void setInterval (int interval)
+ 		+inline
+
+

Defines the interval that is used to adjust the sample rate: 10 means every 10 updates.

+ +
+
+ +

◆ setProcessingLag()

+ +
+
+ + + + + +
+ + + + + + + + +
void setProcessingLag (int lag)
+ 		+inline
+
+

Defines the lag which is substracted from the message_buffer_delay_ms. It conists of the delay added by the decoder and your selected output device

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync.png b/docs/html/classsnap__arduino_1_1_snap_time_sync.png new file mode 100644 index 0000000..062ec08 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_time_sync.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic-members.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic-members.html new file mode 100644 index 0000000..557867e --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic-members.html @@ -0,0 +1,99 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTimeSyncDynamic Member List
+
+
+ +

This is the complete list of members for SnapTimeSyncDynamic, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
active (defined in SnapTimeSync)SnapTimeSyncprotected
begin(int rate)SnapTimeSyncinline
getFactor()SnapTimeSyncDynamicinlinevirtual
getStartDelay()SnapTimeSyncinline
interval (defined in SnapTimeSync)SnapTimeSyncprotected
isSync()SnapTimeSyncinline
message_buffer_delay_ms (defined in SnapTimeSync)SnapTimeSyncprotected
processing_lag (defined in SnapTimeSync)SnapTimeSyncprotected
setInterval(int interval)SnapTimeSyncinline
setMessageBufferDelay(int ms)SnapTimeSyncinline
setProcessingLag(int lag)SnapTimeSyncinline
SnapTimeSync(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSync)SnapTimeSyncinline
SnapTimeSyncDynamic(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSyncDynamic)SnapTimeSyncDynamicinline
TAG (defined in SnapTimeSync)SnapTimeSyncprotected
time_points (defined in SnapTimeSyncDynamic)SnapTimeSyncDynamicprotected
update_count (defined in SnapTimeSync)SnapTimeSyncprotected
updateActualDelay(int delay)SnapTimeSyncinlinevirtual
updateServerTime(uint32_t serverMillis) overrideSnapTimeSyncDynamicinlinevirtual
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.html new file mode 100644 index 0000000..5d6fc78 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.html @@ -0,0 +1,273 @@ + + + + + + + +arduino-snapclient: SnapTimeSyncDynamic Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
SnapTimeSyncDynamic Class Reference
+
+
+ +

Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals. + More...

+ +

#include <SnapTimeSync.h>

+
+Inheritance diagram for SnapTimeSyncDynamic:
+
+
+ + +SnapTimeSync + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapTimeSyncDynamic (int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10)
 
+void begin (int rate)
 Starts the processing.
 
float getFactor ()
 
int getStartDelay ()
 
+bool isSync ()
 Returns true if a synchronization (update of the sampling rate) is needed.
 
void setInterval (int interval)
 
+void setMessageBufferDelay (int ms)
 Defines the message buffer lag.
 
void setProcessingLag (int lag)
 
+virtual void updateActualDelay (int delay)
 Records the actual playback delay (currently not used)
 
+void updateServerTime (uint32_t serverMillis) override
 Records the actual server time in millisecondes.
 
+ + + + + + + + + + + + + + + +

+Protected Attributes

+bool active = false
 
+int interval = 10
 
+uint16_t message_buffer_delay_ms = 0
 
+int processing_lag = 0
 
+const char * TAG = "SnapTimeSync"
 
+Vector< SnapTimePoints > time_points
 
+uint64_t update_count = 0
 
+

Detailed Description

+

Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ getFactor()

+ +
+
+ + + + + +
+ + + + + + + +
float getFactor ()
+ 		+inlinevirtual
+
+

Calculate the resampling factor: with a positive delay we play too fast and need to slow down

+ +

Implements SnapTimeSync.

+ +
+
+ +

◆ getStartDelay()

+ +
+
+ + + + + +
+ + + + + + + +
int getStartDelay ()
+ 		+inlineinherited
+
+

Provides the effective delay to be used (Message buffer lag - decoding/playback time)

+ +
+
+ +

◆ setInterval()

+ +
+
+ + + + + +
+ + + + + + + + +
void setInterval (int interval)
+ 		+inlineinherited
+
+

Defines the interval that is used to adjust the sample rate: 10 means every 10 updates.

+ +
+
+ +

◆ setProcessingLag()

+ +
+
+ + + + + +
+ + + + + + + + +
void setProcessingLag (int lag)
+ 		+inlineinherited
+
+

Defines the lag which is substracted from the message_buffer_delay_ms. It conists of the delay added by the decoder and your selected output device

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.png b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.png new file mode 100644 index 0000000..fb1bae2 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start-members.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start-members.html new file mode 100644 index 0000000..908f936 --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start-members.html @@ -0,0 +1,100 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTimeSyncDynamicSinceStart Member List
+
+
+ +

This is the complete list of members for SnapTimeSyncDynamicSinceStart, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + +
active (defined in SnapTimeSync)SnapTimeSyncprotected
begin(int rate)SnapTimeSyncinline
current_time (defined in SnapTimeSyncDynamicSinceStart)SnapTimeSyncDynamicSinceStartprotected
getFactor()SnapTimeSyncDynamicSinceStartinlinevirtual
getStartDelay()SnapTimeSyncinline
interval (defined in SnapTimeSync)SnapTimeSyncprotected
isSync()SnapTimeSyncinline
message_buffer_delay_ms (defined in SnapTimeSync)SnapTimeSyncprotected
processing_lag (defined in SnapTimeSync)SnapTimeSyncprotected
setInterval(int interval)SnapTimeSyncinline
setMessageBufferDelay(int ms)SnapTimeSyncinline
setProcessingLag(int lag)SnapTimeSyncinline
SnapTimeSync(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSync)SnapTimeSyncinline
SnapTimeSyncDynamicSinceStart(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSyncDynamicSinceStart)SnapTimeSyncDynamicSinceStartinline
start_time (defined in SnapTimeSyncDynamicSinceStart)SnapTimeSyncDynamicSinceStartprotected
TAG (defined in SnapTimeSync)SnapTimeSyncprotected
update_count (defined in SnapTimeSync)SnapTimeSyncprotected
updateActualDelay(int delay)SnapTimeSyncinlinevirtual
updateServerTime(uint32_t serverMillis) overrideSnapTimeSyncDynamicSinceStartinlinevirtual
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html new file mode 100644 index 0000000..f91805f --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html @@ -0,0 +1,276 @@ + + + + + + + +arduino-snapclient: SnapTimeSyncDynamicSinceStart Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
SnapTimeSyncDynamicSinceStart Class Reference
+
+
+ +

Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start. + More...

+ +

#include <SnapTimeSync.h>

+
+Inheritance diagram for SnapTimeSyncDynamicSinceStart:
+
+
+ + +SnapTimeSync + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapTimeSyncDynamicSinceStart (int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10)
 
+void begin (int rate)
 Starts the processing.
 
float getFactor ()
 
int getStartDelay ()
 
+bool isSync ()
 Returns true if a synchronization (update of the sampling rate) is needed.
 
void setInterval (int interval)
 
+void setMessageBufferDelay (int ms)
 Defines the message buffer lag.
 
void setProcessingLag (int lag)
 
+virtual void updateActualDelay (int delay)
 Records the actual playback delay (currently not used)
 
+void updateServerTime (uint32_t serverMillis) override
 Records the actual server time in millisecondes.
 
+ + + + + + + + + + + + + + + + + +

+Protected Attributes

+bool active = false
 
+SnapTimePoints current_time
 
+int interval = 10
 
+uint16_t message_buffer_delay_ms = 0
 
+int processing_lag = 0
 
+SnapTimePoints start_time
 
+const char * TAG = "SnapTimeSync"
 
+uint64_t update_count = 0
 
+

Detailed Description

+

Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ getFactor()

+ +
+
+ + + + + +
+ + + + + + + +
float getFactor ()
+ 		+inlinevirtual
+
+

Calculate the resampling factor: with a positive delay we play too fast and need to slow down

+ +

Implements SnapTimeSync.

+ +
+
+ +

◆ getStartDelay()

+ +
+
+ + + + + +
+ + + + + + + +
int getStartDelay ()
+ 		+inlineinherited
+
+

Provides the effective delay to be used (Message buffer lag - decoding/playback time)

+ +
+
+ +

◆ setInterval()

+ +
+
+ + + + + +
+ + + + + + + + +
void setInterval (int interval)
+ 		+inlineinherited
+
+

Defines the interval that is used to adjust the sample rate: 10 means every 10 updates.

+ +
+
+ +

◆ setProcessingLag()

+ +
+
+ + + + + +
+ + + + + + + + +
void setProcessingLag (int lag)
+ 		+inlineinherited
+
+

Defines the lag which is substracted from the message_buffer_delay_ms. It conists of the delay added by the decoder and your selected output device

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.png b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.png new file mode 100644 index 0000000..cc3cf09 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.png differ diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed-members.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed-members.html new file mode 100644 index 0000000..bc6817f --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed-members.html @@ -0,0 +1,99 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTimeSyncFixed Member List
+
+
+ +

This is the complete list of members for SnapTimeSyncFixed, including all inherited members.

+ + + + + + + + + + + + + + + + + + + +
active (defined in SnapTimeSync)SnapTimeSyncprotected
begin(int rate)SnapTimeSyncinline
getFactor()SnapTimeSyncFixedinlinevirtual
getStartDelay()SnapTimeSyncinline
interval (defined in SnapTimeSync)SnapTimeSyncprotected
isSync()SnapTimeSyncinline
message_buffer_delay_ms (defined in SnapTimeSync)SnapTimeSyncprotected
processing_lag (defined in SnapTimeSync)SnapTimeSyncprotected
resample_factor (defined in SnapTimeSyncFixed)SnapTimeSyncFixedprotected
setInterval(int interval)SnapTimeSyncinline
setMessageBufferDelay(int ms)SnapTimeSyncinline
setProcessingLag(int lag)SnapTimeSyncinline
SnapTimeSync(int processingLag=CONFIG_PROCESSING_TIME_MS, int interval=10) (defined in SnapTimeSync)SnapTimeSyncinline
SnapTimeSyncFixed(int processingLag=CONFIG_PROCESSING_TIME_MS, float factor=1.0, int interval=10) (defined in SnapTimeSyncFixed)SnapTimeSyncFixedinline
TAG (defined in SnapTimeSync)SnapTimeSyncprotected
update_count (defined in SnapTimeSync)SnapTimeSyncprotected
updateActualDelay(int delay)SnapTimeSyncinlinevirtual
updateServerTime(uint32_t serverMillis) overrideSnapTimeSyncFixedinlinevirtual
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.html b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.html new file mode 100644 index 0000000..a5c0f2b --- /dev/null +++ b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.html @@ -0,0 +1,273 @@ + + + + + + + +arduino-snapclient: SnapTimeSyncFixed Class Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
SnapTimeSyncFixed Class Reference
+
+
+ +

Uses predefined fixed factor. + More...

+ +

#include <SnapTimeSync.h>

+
+Inheritance diagram for SnapTimeSyncFixed:
+
+
+ + +SnapTimeSync + +
+ + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

+ SnapTimeSyncFixed (int processingLag=CONFIG_PROCESSING_TIME_MS, float factor=1.0, int interval=10)
 
+void begin (int rate)
 Starts the processing.
 
float getFactor ()
 
int getStartDelay ()
 
+bool isSync ()
 Returns true if a synchronization (update of the sampling rate) is needed.
 
void setInterval (int interval)
 
+void setMessageBufferDelay (int ms)
 Defines the message buffer lag.
 
void setProcessingLag (int lag)
 
+virtual void updateActualDelay (int delay)
 Records the actual playback delay (currently not used)
 
+void updateServerTime (uint32_t serverMillis) override
 Records the actual server time in millisecondes.
 
+ + + + + + + + + + + + + + + +

+Protected Attributes

+bool active = false
 
+int interval = 10
 
+uint16_t message_buffer_delay_ms = 0
 
+int processing_lag = 0
 
+float resample_factor
 
+const char * TAG = "SnapTimeSync"
 
+uint64_t update_count = 0
 
+

Detailed Description

+

Uses predefined fixed factor.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+

Member Function Documentation

+ +

◆ getFactor()

+ +
+
+ + + + + +
+ + + + + + + +
float getFactor ()
+ 		+inlinevirtual
+
+

Calculate the resampling factor: with a positive delay we play too fast and need to slow down

+ +

Implements SnapTimeSync.

+ +
+
+ +

◆ getStartDelay()

+ +
+
+ + + + + +
+ + + + + + + +
int getStartDelay ()
+ 		+inlineinherited
+
+

Provides the effective delay to be used (Message buffer lag - decoding/playback time)

+ +
+
+ +

◆ setInterval()

+ +
+
+ + + + + +
+ + + + + + + + +
void setInterval (int interval)
+ 		+inlineinherited
+
+

Defines the interval that is used to adjust the sample rate: 10 means every 10 updates.

+ +
+
+ +

◆ setProcessingLag()

+ +
+
+ + + + + +
+ + + + + + + + +
void setProcessingLag (int lag)
+ 		+inlineinherited
+
+

Defines the lag which is substracted from the message_buffer_delay_ms. It conists of the delay added by the decoder and your selected output device

+ +
+
+
The documentation for this class was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.png b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.png new file mode 100644 index 0000000..bbc2339 Binary files /dev/null and b/docs/html/classsnap__arduino_1_1_snap_time_sync_fixed.png differ diff --git a/docs/html/files.html b/docs/html/files.html index 8bcf1f6..ee314c3 100644 --- a/docs/html/files.html +++ b/docs/html/files.html @@ -73,10 +73,12 @@  SnapLogger.h  SnapOutput.h  SnapProcessor.h - SnapProcessorRTOS.h - SnapProtocol.h - SnapTime.h - SnapTimeSync.h + SnapProcessorBuffered.h + SnapProcessorRP2040.h + SnapProcessorRTOS.h + SnapProtocol.h + SnapTime.h + SnapTimeSync.h  SnapClient.h  SnapConfig.h diff --git a/docs/html/functions.html b/docs/html/functions.html index f009701..31c45ce 100644 --- a/docs/html/functions.html +++ b/docs/html/functions.html @@ -65,204 +65,252 @@

- a -

- b -

- c -

- d -

- e -

- g -

- i -

- p -

- s -

- t -

- u -

- v -

- w -

- ~ -

diff --git a/docs/html/functions_func.html b/docs/html/functions_func.html index 0adeefe..66c9d42 100644 --- a/docs/html/functions_func.html +++ b/docs/html/functions_func.html @@ -65,204 +65,252 @@

- a -

- b -

- c -

- d -

- e -

- g -

- i -

- p -

- s -

- t -

- u -

- v -

- w -

- ~ -

diff --git a/docs/html/hierarchy.html b/docs/html/hierarchy.html index 33880df..2dfbbe3 100644 --- a/docs/html/hierarchy.html +++ b/docs/html/hierarchy.html @@ -68,26 +68,28 @@
This inheritance list is sorted roughly, but not completely, alphabetically:
[detail level 12]
- - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + +
 ▼CAudioInfoSupport
 CSnapOutputSimple Output Class which uses the AudioTools to build an output chain with volume control and a resampler
 CSnapAudioHeaderInformation about the next bucket
 CSnapClientSnap Client for ESP32 Arduino
 CSnapMessageBaseSnapcast Base Message
 CSnapMessageCodecHeaderSnapcast Codec Header Message
 CSnapMessageHalloSnapcast Hallo Message
 CSnapMessageServerSettingsSnapcast Server Settings Message
 CSnapMessageTimeSnapcast Time Message
 CSnapMessageWireChunkSnapcast Wire Chunk Message
 ▼CSnapProcessorSnap Processor implementation which does not rely on FreeRTOS
 CSnapProcessorRTOS
 CSnapReadBufferBuffer to read different data types
 CSnapTimeThe the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time
 CSnapTimePointsRecording of local_ms and server_ms
 ▼CSnapTimeSyncAbstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate
 CSnapTimeSyncDynamicDynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals
 CSnapTimeSyncDynamicSinceStartDynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start
 CSnapTimeSyncFixedUses predefined fixed factor
 CSnapWriteBufferBuffer to write different data types
 Ctv_tTime as sec & usec
 CSnapOutputSimple Output Class which uses the AudioTools to build an output chain with volume control and a resampler
 CSnapAudioHeaderInformation about the next bucket
 CSnapClientSnap Client for ESP32 Arduino
 CSnapMessageBaseSnapcast Base Message
 CSnapMessageCodecHeaderSnapcast Codec Header Message
 CSnapMessageHalloSnapcast Hallo Message
 CSnapMessageServerSettingsSnapcast Server Settings Message
 CSnapMessageTimeSnapcast Time Message
 CSnapMessageWireChunkSnapcast Wire Chunk Message
 ▼CSnapProcessorSnap Processor implementation which does not rely on FreeRTOS
 CSnapProcessorBufferedProcessor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns
 CSnapProcessorRP2040Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();
 CSnapProcessorRTOSProcessor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue
 CSnapReadBufferBuffer to read different data types
 CSnapTimeThe the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time
 CSnapTimePointsRecording of local_ms and server_ms
 ▼CSnapTimeSyncAbstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate
 CSnapTimeSyncDynamicDynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals
 CSnapTimeSyncDynamicSinceStartDynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start
 CSnapTimeSyncFixedUses predefined fixed factor
 CSnapWriteBufferBuffer to write different data types
 Ctv_tTime as sec & usec
diff --git a/docs/html/index.html b/docs/html/index.html index 1c4ef50..a7246a0 100644 --- a/docs/html/index.html +++ b/docs/html/index.html @@ -73,12 +73,14 @@

Feature list

  • Header only C++ implementation
    • -
  • PCM, Opus, FLAC and Ogg decoding is supported
    • +
  • PCM, Opus decoding is supported
  • Auto connect to snapcast server on network
  • The functionality has been tested on an ESP32
  • Memory efficient implementation, so that PSRAM is not needed
  • Use any output device or DSP chain suppored by the Audio Tools
    • +
  • Flexible design so that you can choose from different processor implementations and synchronizers.
+

The disadvantage of these goals is, that you need to fine tune the solution to have it working as you want.

Description

I have rewritten the snapclient from Jørgen Kragh Jakobsen to an Arduino Library and integrated my AudioTools project to be used to define the output devices.

@@ -88,11 +90,13 @@

{C++}
#include "AudioTools.h"
#include "SnapClient.h"
+
#include "AudioTools/AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus
+
//#include "api/SnapProcessorRTOS.h" // install https://github.com/pschatzmann/arduino-freertos-addons
-
WAVDecoder pcm;
+
OpusAudioDecoder codec;
WiFiClient wifi;
I2SStream out;
-
SnapClient client(wifi, out, pcm);
+
SnapClient client(wifi, out, codec);
void setup() {
Serial.begin(115200);
@@ -114,8 +118,16 @@

config.pin_bck = 14;
config.pin_ws = 15;
config.pin_data = 22;
+
// cfg.buffer_size = 512;
+
// cfg.buffer_count = 40;
out.begin(cfg);
+
// Use FreeRTOS
+
//client.setSnapProcessor(rtos);
+
+
// Define CONFIG_SNAPCAST_SERVER_HOST in SnapConfig.h or here
+
// client.setServerIP(IPAddress(192,168,1,33));
+
// start snap client
client.begin();
}
@@ -123,7 +135,7 @@

void loop() {
client.doLoop();
}
-

Change the snapserver.conf to define codec = pcm and restart the snapserver with sudo service snapserver restart. You can test now your sketch e.g. with ffmpeg -i http://stream.srg-ssr.ch/m/rsj/mp3_128 -f s16le -ar 48000 /tmp/snapfifo

+

Change the snapserver.conf to define codec = opus and restart the snapserver with sudo service snapserver restart. You can test now your sketch e.g. with ffmpeg -i http://stream.srg-ssr.ch/m/rsj/mp3_128 -f s16le -ar 48000 /tmp/snapfifo

For further information on codecs please check the information in the Wiki!

Documentation

diff --git a/docs/html/menudata.js b/docs/html/menudata.js index 145dc72..5ae409e 100644 --- a/docs/html/menudata.js +++ b/docs/html/menudata.js @@ -24,6 +24,8 @@ */ var menudata={children:[ {text:"Main Page",url:"index.html"}, +{text:"Namespaces",url:"namespaces.html",children:[ +{text:"Namespace List",url:"namespaces.html"}]}, {text:"Classes",url:"annotated.html",children:[ {text:"Class List",url:"annotated.html"}, {text:"Class Index",url:"classes.html"}, diff --git a/docs/html/namespaces.html b/docs/html/namespaces.html new file mode 100644 index 0000000..23466ff --- /dev/null +++ b/docs/html/namespaces.html @@ -0,0 +1,101 @@ + + + + + + + +arduino-snapclient: Namespace List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + +
+ +
+
+ + +
+ +
+ +
+
+
Namespace List
+
+
+
Here is a list of all documented namespaces with brief descriptions:
+
[detail level 12]
+ + + + + + + + + + + + + + + + + + + + + + + +
 ▼Nsnap_arduino
 CSnapAudioHeaderInformation about the next bucket
 CSnapClientSnap Client for ESP32 Arduino
 CSnapMessageBaseSnapcast Base Message
 CSnapMessageCodecHeaderSnapcast Codec Header Message
 CSnapMessageHalloSnapcast Hallo Message
 CSnapMessageServerSettingsSnapcast Server Settings Message
 CSnapMessageTimeSnapcast Time Message
 CSnapMessageWireChunkSnapcast Wire Chunk Message
 CSnapOutputSimple Output Class which uses the AudioTools to build an output chain with volume control and a resampler
 CSnapProcessorSnap Processor implementation which does not rely on FreeRTOS
 CSnapProcessorBufferedProcessor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns
 CSnapProcessorRP2040Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();
 CSnapProcessorRTOSProcessor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue
 CSnapReadBufferBuffer to read different data types
 CSnapTimeThe the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time
 CSnapTimePointsRecording of local_ms and server_ms
 CSnapTimeSyncAbstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate
 CSnapTimeSyncDynamicDynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals
 CSnapTimeSyncDynamicSinceStartDynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start
 CSnapTimeSyncFixedUses predefined fixed factor
 CSnapWriteBufferBuffer to write different data types
 Ctv_tTime as sec & usec
+
+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/namespacesnap__arduino.html b/docs/html/namespacesnap__arduino.html new file mode 100644 index 0000000..99cdd76 --- /dev/null +++ b/docs/html/namespacesnap__arduino.html @@ -0,0 +1,195 @@ + + + + + + + +arduino-snapclient: snap_arduino Namespace Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ +
+
+
+Classes | +Enumerations | +Functions | +Variables
+
+
snap_arduino Namespace Reference
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Classes

struct  SnapAudioHeader
 Information about the next bucket. More...
 
class  SnapClient
 Snap Client for ESP32 Arduino. More...
 
struct  SnapMessageBase
 Snapcast Base Message. More...
 
struct  SnapMessageCodecHeader
 Snapcast Codec Header Message. More...
 
struct  SnapMessageHallo
 Snapcast Hallo Message. More...
 
struct  SnapMessageServerSettings
 Snapcast Server Settings Message. More...
 
struct  SnapMessageTime
 Snapcast Time Message. More...
 
struct  SnapMessageWireChunk
 Snapcast Wire Chunk Message. More...
 
class  SnapOutput
 Simple Output Class which uses the AudioTools to build an output chain with volume control and a resampler. More...
 
class  SnapProcessor
 Snap Processor implementation which does not rely on FreeRTOS. More...
 
class  SnapProcessorBuffered
 Processor for which the encoded output is buffered in a ringbuffer in order to prevent any buffer underruns. More...
 
class  SnapProcessorRP2040
 Processor for which the encoded output is buffered in a queue. The decoding and audio output can be done on the second core by calling loop1();. More...
 
class  SnapProcessorRTOS
 Processor for which the encoded output is buffered in a queue in order to prevent any buffer underruns. A RTOS task feeds the output from the queue. More...
 
struct  SnapReadBuffer
 Buffer to read different data types. More...
 
class  SnapTime
 The the sys/time functions are used to represent the server time. The local time will be measured with the help of the Arduino millis() method. This class provides the basic functionality to translate between local and server time. More...
 
struct  SnapTimePoints
 Recording of local_ms and server_ms. More...
 
class  SnapTimeSync
 Abstract (Common) Time Synchronization Logic which consists of the startup synchronization and the local to server clock synchronization which adjusts the sampling rate. More...
 
class  SnapTimeSyncDynamic
 Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock between the different intervals. More...
 
class  SnapTimeSyncDynamicSinceStart
 Dynamically adjusts the effective playback sample rate based on the differences of the local and server clock since the start. More...
 
class  SnapTimeSyncFixed
 Uses predefined fixed factor. More...
 
struct  SnapWriteBuffer
 Buffer to write different data types. More...
 
struct  tv_t
 Time as sec & usec. More...
 
+ + + + + +

+Enumerations

enum  codec_type {
+  NO_CODEC +, PCM +, FLAC +, OGG +,
+  OPUS +
+ }
 
enum  MessageType {
+  SNAPCAST_MESSAGE_BASE = 0 +, SNAPCAST_MESSAGE_CODEC_HEADER = 1 +, SNAPCAST_MESSAGE_WIRE_CHUNK = 2 +, SNAPCAST_MESSAGE_SERVER_SETTINGS = 3 +,
+  SNAPCAST_MESSAGE_TIME = 4 +, SNAPCAST_MESSAGE_HELLO = 5 +, SNAPCAST_MESSAGE_STREAM_TAGS = 6 +, SNAPCAST_MESSAGE_FIRST = SNAPCAST_MESSAGE_BASE +,
+  SNAPCAST_MESSAGE_LAST = SNAPCAST_MESSAGE_STREAM_TAGS +
+ }
 
+ + + + + +

+Functions

+void checkHeap ()
 
+void logHeap ()
 
+ + + +

+Variables

+static const char * TAG ="COMMON"
 
+

Detailed Description

+

Global Shared Objects

+

Snap Client from https://github.com/jorgenkraghjakobsen/snapclient converted to an Arduino Library using the AudioTools as output API

+
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/search/all_0.js b/docs/html/search/all_0.js index 8662c93..99f4a1a 100644 --- a/docs/html/search/all_0.js +++ b/docs/html/search/all_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['audiobegin_0',['audioBegin',['../class_snap_output.html#ab7f75dcf2fef63819309c44bca400074',1,'SnapOutput']]] + ['audiobegin_0',['audioBegin',['../classsnap__arduino_1_1_snap_output.html#ab7f75dcf2fef63819309c44bca400074',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/all_1.js b/docs/html/search/all_1.js index fb1c6e7..f360417 100644 --- a/docs/html/search/all_1.js +++ b/docs/html/search/all_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['begin_1',['begin',['../class_snap_output.html#a50f45551c10ca30a0bc7f447e70188b1',1,'SnapOutput::begin()'],['../class_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e',1,'SnapTimeSync::begin()'],['../class_snap_client.html#abc2c0a4c4160fe59696af412649e43eb',1,'SnapClient::begin(SnapTimeSync &timeSync)'],['../class_snap_client.html#a601fb7cf1fc15db50c71a826f084f934',1,'SnapClient::begin()']]], - ['buffertaskactivationlimit_2',['bufferTaskActivationLimit',['../class_snap_processor_r_t_o_s.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'SnapProcessorRTOS']]] + ['begin_1',['begin',['../classsnap__arduino_1_1_snap_output.html#a50f45551c10ca30a0bc7f447e70188b1',1,'snap_arduino::SnapOutput::begin()'],['../classsnap__arduino_1_1_snap_processor.html#a50f45551c10ca30a0bc7f447e70188b1',1,'snap_arduino::SnapProcessor::begin()'],['../classsnap__arduino_1_1_snap_processor_buffered.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorBuffered::begin()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorRP2040::begin()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorRTOS::begin()'],['../classsnap__arduino_1_1_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e',1,'snap_arduino::SnapTimeSync::begin()'],['../classsnap__arduino_1_1_snap_client.html#abc2c0a4c4160fe59696af412649e43eb',1,'snap_arduino::SnapClient::begin(SnapTimeSync &timeSync)'],['../classsnap__arduino_1_1_snap_client.html#a601fb7cf1fc15db50c71a826f084f934',1,'snap_arduino::SnapClient::begin()']]], + ['buffertaskactivationlimit_2',['bufferTaskActivationLimit',['../classsnap__arduino_1_1_snap_processor_buffered.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'snap_arduino::SnapProcessorBuffered::bufferTaskActivationLimit()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'snap_arduino::SnapProcessorRTOS::bufferTaskActivationLimit()']]] ]; diff --git a/docs/html/search/all_2.js b/docs/html/search/all_2.js index 899a672..3486fee 100644 --- a/docs/html/search/all_2.js +++ b/docs/html/search/all_2.js @@ -1,4 +1,5 @@ var searchData= [ - ['copy_3',['copy',['../class_snap_processor_r_t_o_s.html#aaa6c087511a52e64fc9ad92820c7c0a8',1,'SnapProcessorRTOS']]] + ['connectclient_3',['connectClient',['../classsnap__arduino_1_1_snap_processor.html#a66f87ab2cb4fc7994001ed5dad8af679',1,'snap_arduino::SnapProcessor']]], + ['copy_4',['copy',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#aaa6c087511a52e64fc9ad92820c7c0a8',1,'snap_arduino::SnapProcessorRTOS']]] ]; diff --git a/docs/html/search/all_3.js b/docs/html/search/all_3.js index 1731f39..6998ef6 100644 --- a/docs/html/search/all_3.js +++ b/docs/html/search/all_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['doloop_4',['doLoop',['../class_snap_processor.html#ae0d28a9842dd1a20e72bdf59f8892fb8',1,'SnapProcessor::doLoop()'],['../class_snap_client.html#a4ee9280c3692bb64624dbc933acae273',1,'SnapClient::doLoop()']]] + ['doloop_5',['doLoop',['../classsnap__arduino_1_1_snap_processor.html#abdd99e468f667b748b0c9bfd395163d7',1,'snap_arduino::SnapProcessor::doLoop()'],['../classsnap__arduino_1_1_snap_client.html#abdd99e468f667b748b0c9bfd395163d7',1,'snap_arduino::SnapClient::doLoop()']]], + ['doloop1_6',['doLoop1',['../classsnap__arduino_1_1_snap_processor.html#acd628840f7e43d32563552bda5f90689',1,'snap_arduino::SnapProcessor::doLoop1()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#ac5e4b26fa498b1963ace4509ebf4b86e',1,'snap_arduino::SnapProcessorRP2040::doLoop1()']]] ]; diff --git a/docs/html/search/all_4.js b/docs/html/search/all_4.js index 005df4b..ea373c0 100644 --- a/docs/html/search/all_4.js +++ b/docs/html/search/all_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['end_5',['end',['../class_snap_output.html#af8e0a63ec718201627220299012e654f',1,'SnapOutput::end()'],['../class_snap_client.html#a081b5c662ecee58405a543518f699d31',1,'SnapClient::end()']]] + ['end_7',['end',['../classsnap__arduino_1_1_snap_output.html#af8e0a63ec718201627220299012e654f',1,'snap_arduino::SnapOutput::end()'],['../classsnap__arduino_1_1_snap_client.html#a081b5c662ecee58405a543518f699d31',1,'snap_arduino::SnapClient::end()']]] ]; diff --git a/docs/html/search/all_5.js b/docs/html/search/all_5.js index b21ac84..809367e 100644 --- a/docs/html/search/all_5.js +++ b/docs/html/search/all_5.js @@ -1,6 +1,6 @@ var searchData= [ - ['getdelayms_6',['getDelayMs',['../class_snap_output.html#a10297964d6abd0cffcb68332fff761b5',1,'SnapOutput']]], - ['getfactor_7',['getFactor',['../class_snap_time_sync.html#a47e677c2396350208f1a2499fced812a',1,'SnapTimeSync::getFactor()'],['../class_snap_time_sync_dynamic.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncDynamic::getFactor()'],['../class_snap_time_sync_dynamic_since_start.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncDynamicSinceStart::getFactor()'],['../class_snap_time_sync_fixed.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncFixed::getFactor()']]], - ['getstartdelay_8',['getStartDelay',['../class_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735',1,'SnapTimeSync']]] + ['getdelayms_8',['getDelayMs',['../classsnap__arduino_1_1_snap_output.html#a10297964d6abd0cffcb68332fff761b5',1,'snap_arduino::SnapOutput']]], + ['getfactor_9',['getFactor',['../classsnap__arduino_1_1_snap_time_sync.html#a47e677c2396350208f1a2499fced812a',1,'snap_arduino::SnapTimeSync::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncDynamic::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncDynamicSinceStart::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_fixed.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncFixed::getFactor()']]], + ['getstartdelay_10',['getStartDelay',['../classsnap__arduino_1_1_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735',1,'snap_arduino::SnapTimeSync']]] ]; diff --git a/docs/html/search/all_6.js b/docs/html/search/all_6.js index 6151887..1851205 100644 --- a/docs/html/search/all_6.js +++ b/docs/html/search/all_6.js @@ -1,5 +1,9 @@ var searchData= [ - ['ismute_9',['isMute',['../class_snap_output.html#aa6f1c80ac878b7c454a49f0f16f2bfb0',1,'SnapOutput']]], - ['issync_10',['isSync',['../class_snap_time_sync.html#ae361c9a0939daff16cd8652325124905',1,'SnapTimeSync']]] + ['init_5frtos_11',['init_rtos',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a2ac99dcb18f12f765b2da0f7f77cd17b',1,'snap_arduino::SnapProcessorRTOS']]], + ['initqueues_12',['initQueues',['../classsnap__arduino_1_1_snap_processor_r_p2040.html#a03d18f97e323fb6f4527bc29a28ae92b',1,'snap_arduino::SnapProcessorRP2040']]], + ['isactive_13',['isActive',['../classsnap__arduino_1_1_snap_output.html#aed4f7586f45db6092d8ca7fa56944755',1,'snap_arduino::SnapOutput']]], + ['ismute_14',['isMute',['../classsnap__arduino_1_1_snap_output.html#aa6f1c80ac878b7c454a49f0f16f2bfb0',1,'snap_arduino::SnapOutput']]], + ['issync_15',['isSync',['../classsnap__arduino_1_1_snap_time_sync.html#ae361c9a0939daff16cd8652325124905',1,'snap_arduino::SnapTimeSync']]], + ['iswifi_16',['isWiFi',['../classsnap__arduino_1_1_snap_client.html#a2f71e236c6bfd49b51b2b883116244d8',1,'snap_arduino::SnapClient']]] ]; diff --git a/docs/html/search/all_7.js b/docs/html/search/all_7.js index bf58427..bf26716 100644 --- a/docs/html/search/all_7.js +++ b/docs/html/search/all_7.js @@ -1,4 +1,5 @@ var searchData= [ - ['playbackfactor_11',['playbackFactor',['../class_snap_output.html#a6f02241f9435b0062580626d1894a573',1,'SnapOutput']]] + ['playbackfactor_17',['playbackFactor',['../classsnap__arduino_1_1_snap_output.html#a6f02241f9435b0062580626d1894a573',1,'snap_arduino::SnapOutput']]], + ['processext_18',['processExt',['../classsnap__arduino_1_1_snap_processor.html#a9ace7c86de0ecc5afd903ec1bddbcc70',1,'snap_arduino::SnapProcessor::processExt()'],['../classsnap__arduino_1_1_snap_processor_buffered.html#a9ace7c86de0ecc5afd903ec1bddbcc70',1,'snap_arduino::SnapProcessorBuffered::processExt()']]] ]; diff --git a/docs/html/search/all_8.js b/docs/html/search/all_8.js index 7f6480d..a50c8c6 100644 --- a/docs/html/search/all_8.js +++ b/docs/html/search/all_8.js @@ -1,43 +1,50 @@ var searchData= [ - ['servermillis_12',['serverMillis',['../class_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa',1,'SnapTime']]], - ['setaudioinfo_13',['setAudioInfo',['../class_snap_output.html#a5e283a9495aaf265739336829d45e215',1,'SnapOutput']]], - ['setclient_14',['setClient',['../class_snap_client.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'SnapClient::setClient()'],['../class_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'SnapProcessor::setClient(Client &client)']]], - ['setdecoder_15',['setDecoder',['../class_snap_processor.html#a6f9488e045147706a13387c0c6a634ea',1,'SnapProcessor::setDecoder()'],['../class_snap_output.html#a6f9488e045147706a13387c0c6a634ea',1,'SnapOutput::setDecoder()']]], - ['setinterval_16',['setInterval',['../class_snap_time_sync.html#af8303d863006ab5b759a4e1fa8bb0e39',1,'SnapTimeSync']]], - ['setmessagebufferdelay_17',['setMessageBufferDelay',['../class_snap_time_sync.html#ac43c3135fd435d8006a5d48d2b13625c',1,'SnapTimeSync']]], - ['setmute_18',['setMute',['../class_snap_output.html#a27459cee4bd97a6ac4a09aec45cd3bbd',1,'SnapOutput']]], - ['setoutput_19',['setOutput',['../class_snap_output.html#aa0d3775308edf58cac6e7f763edbb96a',1,'SnapOutput::setOutput()'],['../class_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a',1,'SnapProcessor::setOutput()']]], - ['setplaybackfactor_20',['setPlaybackFactor',['../class_snap_output.html#a87ac62f6f14d8579e2cb3bbc8d705a89',1,'SnapOutput']]], - ['setprocessinglag_21',['setProcessingLag',['../class_snap_time_sync.html#a263ff3a9232682c353a845a6f87fcbf6',1,'SnapTimeSync']]], - ['setserverip_22',['setServerIP',['../class_snap_client.html#a25ac7501d9bf855ea1bd07feb77e9070',1,'SnapClient']]], - ['setsnapoutput_23',['setSnapOutput',['../class_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda',1,'SnapProcessor::setSnapOutput()'],['../class_snap_client.html#a5d9c21ad999d25919c01753e38a86bda',1,'SnapClient::setSnapOutput(SnapOutput &out)']]], - ['setsnapprocessor_24',['setSnapProcessor',['../class_snap_client.html#aa5fb69c578b675cd8239d80832eaf45f',1,'SnapClient']]], - ['setsnaptimesync_25',['setSnapTimeSync',['../class_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'SnapOutput::setSnapTimeSync()'],['../class_snap_client.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'SnapClient::setSnapTimeSync(SnapTimeSync &timeSync)']]], - ['setstartoutput_26',['setStartOutput',['../class_snap_client.html#adfe1e9bc7608e178934c91e42ff1033f',1,'SnapClient']]], - ['setstarttask_27',['setStartTask',['../class_snap_client.html#a26a56ec17a4183c08447e33c80591209',1,'SnapClient']]], - ['settimedifferenceclientserverms_28',['setTimeDifferenceClientServerMs',['../class_snap_time.html#a3e98d81c157bfc9c1b4ef65d3bc6dade',1,'SnapTime']]], - ['setvolume_29',['setVolume',['../class_snap_output.html#a35c7533999826a3706e97f99442d4c7e',1,'SnapOutput']]], - ['setvolumefactor_30',['setVolumeFactor',['../class_snap_output.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapOutput::setVolumeFactor()'],['../class_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapProcessor::setVolumeFactor()'],['../class_snap_client.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapClient::setVolumeFactor()']]], - ['snapaudioheader_31',['SnapAudioHeader',['../struct_snap_audio_header.html',1,'']]], - ['snapcast_20client_20for_20arduino_32',['Snapcast Client for Arduino',['../index.html',1,'']]], - ['snapclient_33',['SnapClient',['../class_snap_client.html',1,'']]], - ['snapmessagebase_34',['SnapMessageBase',['../struct_snap_message_base.html',1,'']]], - ['snapmessagecodecheader_35',['SnapMessageCodecHeader',['../struct_snap_message_codec_header.html',1,'']]], - ['snapmessagehallo_36',['SnapMessageHallo',['../struct_snap_message_hallo.html',1,'']]], - ['snapmessageserversettings_37',['SnapMessageServerSettings',['../struct_snap_message_server_settings.html',1,'']]], - ['snapmessagetime_38',['SnapMessageTime',['../struct_snap_message_time.html',1,'']]], - ['snapmessagewirechunk_39',['SnapMessageWireChunk',['../struct_snap_message_wire_chunk.html',1,'']]], - ['snapoutput_40',['SnapOutput',['../class_snap_output.html',1,'']]], - ['snapprocessor_41',['SnapProcessor',['../class_snap_processor.html',1,'']]], - ['snapprocessorrtos_42',['SnapProcessorRTOS',['../class_snap_processor_r_t_o_s.html',1,'SnapProcessorRTOS'],['../class_snap_processor_r_t_o_s.html#a6a6f5078ba7dd396a62217562f934312',1,'SnapProcessorRTOS::SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)'],['../class_snap_processor_r_t_o_s.html#a99a5d30c01881c1c3ce653efc8ca0a96',1,'SnapProcessorRTOS::SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)']]], - ['snapreadbuffer_43',['SnapReadBuffer',['../struct_snap_read_buffer.html',1,'']]], - ['snaptime_44',['SnapTime',['../class_snap_time.html',1,'']]], - ['snaptimepoints_45',['SnapTimePoints',['../struct_snap_time_points.html',1,'']]], - ['snaptimesync_46',['SnapTimeSync',['../class_snap_time_sync.html',1,'']]], - ['snaptimesyncdynamic_47',['SnapTimeSyncDynamic',['../class_snap_time_sync_dynamic.html',1,'']]], - ['snaptimesyncdynamicsincestart_48',['SnapTimeSyncDynamicSinceStart',['../class_snap_time_sync_dynamic_since_start.html',1,'']]], - ['snaptimesyncfixed_49',['SnapTimeSyncFixed',['../class_snap_time_sync_fixed.html',1,'']]], - ['snapwritebuffer_50',['SnapWriteBuffer',['../struct_snap_write_buffer.html',1,'']]], - ['synchronizeplayback_51',['synchronizePlayback',['../class_snap_output.html#aac98818fc690c70b6413fc52fc6b82f7',1,'SnapOutput']]] + ['servermillis_19',['serverMillis',['../classsnap__arduino_1_1_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa',1,'snap_arduino::SnapTime']]], + ['setaudioinfo_20',['setAudioInfo',['../classsnap__arduino_1_1_snap_output.html#a5e283a9495aaf265739336829d45e215',1,'snap_arduino::SnapOutput']]], + ['setclient_21',['setClient',['../classsnap__arduino_1_1_snap_client.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'snap_arduino::SnapClient::setClient()'],['../classsnap__arduino_1_1_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'snap_arduino::SnapProcessor::setClient(Client &client)']]], + ['setclientname_22',['setClientName',['../classsnap__arduino_1_1_snap_processor.html#ab692edef6597697c8860218e778ddcf8',1,'snap_arduino::SnapProcessor']]], + ['setdecoder_23',['setDecoder',['../classsnap__arduino_1_1_snap_processor.html#a6f9488e045147706a13387c0c6a634ea',1,'snap_arduino::SnapProcessor::setDecoder()'],['../classsnap__arduino_1_1_snap_output.html#a6f9488e045147706a13387c0c6a634ea',1,'snap_arduino::SnapOutput::setDecoder()']]], + ['sethostname_24',['setHostName',['../classsnap__arduino_1_1_snap_processor.html#ac0033c1dccf755a34751855a82a3b128',1,'snap_arduino::SnapProcessor']]], + ['setinterval_25',['setInterval',['../classsnap__arduino_1_1_snap_time_sync.html#af8303d863006ab5b759a4e1fa8bb0e39',1,'snap_arduino::SnapTimeSync']]], + ['setmessagebufferdelay_26',['setMessageBufferDelay',['../classsnap__arduino_1_1_snap_time_sync.html#ac43c3135fd435d8006a5d48d2b13625c',1,'snap_arduino::SnapTimeSync']]], + ['setmute_27',['setMute',['../classsnap__arduino_1_1_snap_output.html#a27459cee4bd97a6ac4a09aec45cd3bbd',1,'snap_arduino::SnapOutput']]], + ['setoutput_28',['setOutput',['../classsnap__arduino_1_1_snap_output.html#aa0d3775308edf58cac6e7f763edbb96a',1,'snap_arduino::SnapOutput::setOutput()'],['../classsnap__arduino_1_1_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a',1,'snap_arduino::SnapProcessor::setOutput()']]], + ['setplaybackfactor_29',['setPlaybackFactor',['../classsnap__arduino_1_1_snap_output.html#a87ac62f6f14d8579e2cb3bbc8d705a89',1,'snap_arduino::SnapOutput']]], + ['setprocessinglag_30',['setProcessingLag',['../classsnap__arduino_1_1_snap_time_sync.html#a263ff3a9232682c353a845a6f87fcbf6',1,'snap_arduino::SnapTimeSync']]], + ['setserverip_31',['setServerIP',['../classsnap__arduino_1_1_snap_client.html#a25ac7501d9bf855ea1bd07feb77e9070',1,'snap_arduino::SnapClient']]], + ['setsnapoutput_32',['setSnapOutput',['../classsnap__arduino_1_1_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda',1,'snap_arduino::SnapProcessor::setSnapOutput()'],['../classsnap__arduino_1_1_snap_client.html#a5d9c21ad999d25919c01753e38a86bda',1,'snap_arduino::SnapClient::setSnapOutput(SnapOutput &out)']]], + ['setsnapprocessor_33',['setSnapProcessor',['../classsnap__arduino_1_1_snap_client.html#aa5fb69c578b675cd8239d80832eaf45f',1,'snap_arduino::SnapClient']]], + ['setsnaptimesync_34',['setSnapTimeSync',['../classsnap__arduino_1_1_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'snap_arduino::SnapOutput::setSnapTimeSync()'],['../classsnap__arduino_1_1_snap_client.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'snap_arduino::SnapClient::setSnapTimeSync(SnapTimeSync &timeSync)']]], + ['setstartoutput_35',['setStartOutput',['../classsnap__arduino_1_1_snap_client.html#adfe1e9bc7608e178934c91e42ff1033f',1,'snap_arduino::SnapClient']]], + ['setstarttask_36',['setStartTask',['../classsnap__arduino_1_1_snap_client.html#a26a56ec17a4183c08447e33c80591209',1,'snap_arduino::SnapClient']]], + ['settimedifferenceclientserverms_37',['setTimeDifferenceClientServerMs',['../classsnap__arduino_1_1_snap_time.html#a3e98d81c157bfc9c1b4ef65d3bc6dade',1,'snap_arduino::SnapTime']]], + ['setvolume_38',['setVolume',['../classsnap__arduino_1_1_snap_output.html#a35c7533999826a3706e97f99442d4c7e',1,'snap_arduino::SnapOutput']]], + ['setvolumefactor_39',['setVolumeFactor',['../classsnap__arduino_1_1_snap_output.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapOutput::setVolumeFactor()'],['../classsnap__arduino_1_1_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapProcessor::setVolumeFactor()'],['../classsnap__arduino_1_1_snap_client.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapClient::setVolumeFactor(float fact)']]], + ['setwifi_40',['setWiFi',['../classsnap__arduino_1_1_snap_client.html#aa5b1356ff52a71650594024a2faf532d',1,'snap_arduino::SnapClient']]], + ['snap_5farduino_41',['snap_arduino',['../namespacesnap__arduino.html',1,'']]], + ['snapaudioheader_42',['SnapAudioHeader',['../structsnap__arduino_1_1_snap_audio_header.html',1,'snap_arduino']]], + ['snapcast_20client_20for_20arduino_43',['Snapcast Client for Arduino',['../index.html',1,'']]], + ['snapclient_44',['SnapClient',['../classsnap__arduino_1_1_snap_client.html',1,'snap_arduino']]], + ['snapmessagebase_45',['SnapMessageBase',['../structsnap__arduino_1_1_snap_message_base.html',1,'snap_arduino']]], + ['snapmessagecodecheader_46',['SnapMessageCodecHeader',['../structsnap__arduino_1_1_snap_message_codec_header.html',1,'snap_arduino']]], + ['snapmessagehallo_47',['SnapMessageHallo',['../structsnap__arduino_1_1_snap_message_hallo.html',1,'snap_arduino']]], + ['snapmessageserversettings_48',['SnapMessageServerSettings',['../structsnap__arduino_1_1_snap_message_server_settings.html',1,'snap_arduino']]], + ['snapmessagetime_49',['SnapMessageTime',['../structsnap__arduino_1_1_snap_message_time.html',1,'snap_arduino']]], + ['snapmessagewirechunk_50',['SnapMessageWireChunk',['../structsnap__arduino_1_1_snap_message_wire_chunk.html',1,'snap_arduino']]], + ['snapoutput_51',['SnapOutput',['../classsnap__arduino_1_1_snap_output.html',1,'snap_arduino']]], + ['snapprocessor_52',['SnapProcessor',['../classsnap__arduino_1_1_snap_processor.html',1,'snap_arduino']]], + ['snapprocessor_53',['snapProcessor',['../classsnap__arduino_1_1_snap_client.html#ae35f4b0efe5efba6e49a900b9feb00f7',1,'snap_arduino::SnapClient']]], + ['snapprocessorbuffered_54',['SnapProcessorBuffered',['../classsnap__arduino_1_1_snap_processor_buffered.html',1,'SnapProcessorBuffered'],['../classsnap__arduino_1_1_snap_processor_buffered.html#a27d769bfee7b909ecb79d825e0532225',1,'snap_arduino::SnapProcessorBuffered::SnapProcessorBuffered()']]], + ['snapprocessorrp2040_55',['SnapProcessorRP2040',['../classsnap__arduino_1_1_snap_processor_r_p2040.html',1,'SnapProcessorRP2040'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#ad43641484ce99005fb3c4c6b9e57400b',1,'snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent=75)'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#a62a3a259a24a1f4a89ce2db19428fac7',1,'snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent=75)']]], + ['snapprocessorrtos_56',['SnapProcessorRTOS',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html',1,'SnapProcessorRTOS'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a99a5d30c01881c1c3ce653efc8ca0a96',1,'snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a6a6f5078ba7dd396a62217562f934312',1,'snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)']]], + ['snapreadbuffer_57',['SnapReadBuffer',['../structsnap__arduino_1_1_snap_read_buffer.html',1,'snap_arduino']]], + ['snaptime_58',['SnapTime',['../classsnap__arduino_1_1_snap_time.html',1,'snap_arduino']]], + ['snaptimepoints_59',['SnapTimePoints',['../structsnap__arduino_1_1_snap_time_points.html',1,'snap_arduino']]], + ['snaptimesync_60',['SnapTimeSync',['../classsnap__arduino_1_1_snap_time_sync.html',1,'snap_arduino']]], + ['snaptimesyncdynamic_61',['SnapTimeSyncDynamic',['../classsnap__arduino_1_1_snap_time_sync_dynamic.html',1,'snap_arduino']]], + ['snaptimesyncdynamicsincestart_62',['SnapTimeSyncDynamicSinceStart',['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html',1,'snap_arduino']]], + ['snaptimesyncfixed_63',['SnapTimeSyncFixed',['../classsnap__arduino_1_1_snap_time_sync_fixed.html',1,'snap_arduino']]], + ['snapwritebuffer_64',['SnapWriteBuffer',['../structsnap__arduino_1_1_snap_write_buffer.html',1,'snap_arduino']]], + ['synchronizeplayback_65',['synchronizePlayback',['../classsnap__arduino_1_1_snap_output.html#aac98818fc690c70b6413fc52fc6b82f7',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/all_9.js b/docs/html/search/all_9.js index f6517d9..2fd952b 100644 --- a/docs/html/search/all_9.js +++ b/docs/html/search/all_9.js @@ -1,7 +1,7 @@ var searchData= [ - ['task_5fcopy_52',['task_copy',['../class_snap_processor_r_t_o_s.html#a2725cad0984c9c469b19fd065371fe69',1,'SnapProcessorRTOS']]], - ['time_53',['time',['../class_snap_time.html#a0371cbc995b3b2f546215d4ebfc11ade',1,'SnapTime']]], - ['timedifferenceclientserverms_54',['timeDifferenceClientServerMs',['../class_snap_time.html#a058d57baeeb43619ca44ee9342b6c70c',1,'SnapTime']]], - ['tv_5ft_55',['tv_t',['../structtv__t.html',1,'']]] + ['task_5fcopy_66',['task_copy',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a2725cad0984c9c469b19fd065371fe69',1,'snap_arduino::SnapProcessorRTOS']]], + ['time_67',['time',['../classsnap__arduino_1_1_snap_time.html#a0371cbc995b3b2f546215d4ebfc11ade',1,'snap_arduino::SnapTime']]], + ['timedifferenceclientserverms_68',['timeDifferenceClientServerMs',['../classsnap__arduino_1_1_snap_time.html#a058d57baeeb43619ca44ee9342b6c70c',1,'snap_arduino::SnapTime']]], + ['tv_5ft_69',['tv_t',['../structsnap__arduino_1_1tv__t.html',1,'snap_arduino']]] ]; diff --git a/docs/html/search/all_a.js b/docs/html/search/all_a.js index 62d28ba..31bc3c8 100644 --- a/docs/html/search/all_a.js +++ b/docs/html/search/all_a.js @@ -1,5 +1,5 @@ var searchData= [ - ['updateactualdelay_56',['updateActualDelay',['../class_snap_time_sync.html#a159ed048ebe13885c54954aa2a78546b',1,'SnapTimeSync']]], - ['updateservertime_57',['updateServerTime',['../class_snap_time_sync.html#af8923b482e191076bb12d2285f39ae09',1,'SnapTimeSync::updateServerTime()'],['../class_snap_time_sync_dynamic.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncDynamic::updateServerTime()'],['../class_snap_time_sync_dynamic_since_start.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncDynamicSinceStart::updateServerTime()'],['../class_snap_time_sync_fixed.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncFixed::updateServerTime()']]] + ['updateactualdelay_70',['updateActualDelay',['../classsnap__arduino_1_1_snap_time_sync.html#a159ed048ebe13885c54954aa2a78546b',1,'snap_arduino::SnapTimeSync']]], + ['updateservertime_71',['updateServerTime',['../classsnap__arduino_1_1_snap_time_sync.html#af8923b482e191076bb12d2285f39ae09',1,'snap_arduino::SnapTimeSync::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncDynamic::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncDynamicSinceStart::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_fixed.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncFixed::updateServerTime()']]] ]; diff --git a/docs/html/search/all_b.js b/docs/html/search/all_b.js index 2673b09..2699f2c 100644 --- a/docs/html/search/all_b.js +++ b/docs/html/search/all_b.js @@ -1,4 +1,4 @@ var searchData= [ - ['volume_58',['volume',['../class_snap_output.html#a1d59a107c6918cdc9a17b92f6cd4e136',1,'SnapOutput::volume()'],['../class_snap_processor.html#a92937495d01c777a843b576f7fd02145',1,'SnapProcessor::volume()'],['../class_snap_client.html#a92937495d01c777a843b576f7fd02145',1,'SnapClient::volume()']]] + ['volume_72',['volume',['../classsnap__arduino_1_1_snap_output.html#a1d59a107c6918cdc9a17b92f6cd4e136',1,'snap_arduino::SnapOutput::volume()'],['../classsnap__arduino_1_1_snap_processor.html#a92937495d01c777a843b576f7fd02145',1,'snap_arduino::SnapProcessor::volume()'],['../classsnap__arduino_1_1_snap_client.html#a92937495d01c777a843b576f7fd02145',1,'snap_arduino::SnapClient::volume()']]] ]; diff --git a/docs/html/search/all_c.js b/docs/html/search/all_c.js index 0e346d3..ee6220e 100644 --- a/docs/html/search/all_c.js +++ b/docs/html/search/all_c.js @@ -1,6 +1,6 @@ var searchData= [ - ['write_59',['write',['../class_snap_output.html#a5f985ca872c6ce5fb8fe126cf9a0a01f',1,'SnapOutput']]], - ['writeaudio_60',['writeAudio',['../class_snap_processor_r_t_o_s.html#af26d304c20113d4184aa61703aef6bc7',1,'SnapProcessorRTOS']]], - ['writeheader_61',['writeHeader',['../class_snap_output.html#a86e635e425cf8781cb707183a1648f35',1,'SnapOutput']]] + ['write_73',['write',['../classsnap__arduino_1_1_snap_output.html#a5f985ca872c6ce5fb8fe126cf9a0a01f',1,'snap_arduino::SnapOutput']]], + ['writeaudio_74',['writeAudio',['../classsnap__arduino_1_1_snap_processor_buffered.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorBuffered::writeAudio()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorRP2040::writeAudio()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorRTOS::writeAudio()']]], + ['writeheader_75',['writeHeader',['../classsnap__arduino_1_1_snap_output.html#a86e635e425cf8781cb707183a1648f35',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/all_d.js b/docs/html/search/all_d.js index 7094ea5..a1428c6 100644 --- a/docs/html/search/all_d.js +++ b/docs/html/search/all_d.js @@ -1,4 +1,4 @@ var searchData= [ - ['_7esnapclient_62',['~SnapClient',['../class_snap_client.html#a33755d7beaca179dfbdb2c7ef7e1943f',1,'SnapClient']]] + ['_7esnapclient_76',['~SnapClient',['../classsnap__arduino_1_1_snap_client.html#a33755d7beaca179dfbdb2c7ef7e1943f',1,'snap_arduino::SnapClient']]] ]; diff --git a/docs/html/search/classes_0.js b/docs/html/search/classes_0.js index 6d3671f..40b448f 100644 --- a/docs/html/search/classes_0.js +++ b/docs/html/search/classes_0.js @@ -1,22 +1,24 @@ var searchData= [ - ['snapaudioheader_63',['SnapAudioHeader',['../struct_snap_audio_header.html',1,'']]], - ['snapclient_64',['SnapClient',['../class_snap_client.html',1,'']]], - ['snapmessagebase_65',['SnapMessageBase',['../struct_snap_message_base.html',1,'']]], - ['snapmessagecodecheader_66',['SnapMessageCodecHeader',['../struct_snap_message_codec_header.html',1,'']]], - ['snapmessagehallo_67',['SnapMessageHallo',['../struct_snap_message_hallo.html',1,'']]], - ['snapmessageserversettings_68',['SnapMessageServerSettings',['../struct_snap_message_server_settings.html',1,'']]], - ['snapmessagetime_69',['SnapMessageTime',['../struct_snap_message_time.html',1,'']]], - ['snapmessagewirechunk_70',['SnapMessageWireChunk',['../struct_snap_message_wire_chunk.html',1,'']]], - ['snapoutput_71',['SnapOutput',['../class_snap_output.html',1,'']]], - ['snapprocessor_72',['SnapProcessor',['../class_snap_processor.html',1,'']]], - ['snapprocessorrtos_73',['SnapProcessorRTOS',['../class_snap_processor_r_t_o_s.html',1,'']]], - ['snapreadbuffer_74',['SnapReadBuffer',['../struct_snap_read_buffer.html',1,'']]], - ['snaptime_75',['SnapTime',['../class_snap_time.html',1,'']]], - ['snaptimepoints_76',['SnapTimePoints',['../struct_snap_time_points.html',1,'']]], - ['snaptimesync_77',['SnapTimeSync',['../class_snap_time_sync.html',1,'']]], - ['snaptimesyncdynamic_78',['SnapTimeSyncDynamic',['../class_snap_time_sync_dynamic.html',1,'']]], - ['snaptimesyncdynamicsincestart_79',['SnapTimeSyncDynamicSinceStart',['../class_snap_time_sync_dynamic_since_start.html',1,'']]], - ['snaptimesyncfixed_80',['SnapTimeSyncFixed',['../class_snap_time_sync_fixed.html',1,'']]], - ['snapwritebuffer_81',['SnapWriteBuffer',['../struct_snap_write_buffer.html',1,'']]] + ['snapaudioheader_77',['SnapAudioHeader',['../structsnap__arduino_1_1_snap_audio_header.html',1,'snap_arduino']]], + ['snapclient_78',['SnapClient',['../classsnap__arduino_1_1_snap_client.html',1,'snap_arduino']]], + ['snapmessagebase_79',['SnapMessageBase',['../structsnap__arduino_1_1_snap_message_base.html',1,'snap_arduino']]], + ['snapmessagecodecheader_80',['SnapMessageCodecHeader',['../structsnap__arduino_1_1_snap_message_codec_header.html',1,'snap_arduino']]], + ['snapmessagehallo_81',['SnapMessageHallo',['../structsnap__arduino_1_1_snap_message_hallo.html',1,'snap_arduino']]], + ['snapmessageserversettings_82',['SnapMessageServerSettings',['../structsnap__arduino_1_1_snap_message_server_settings.html',1,'snap_arduino']]], + ['snapmessagetime_83',['SnapMessageTime',['../structsnap__arduino_1_1_snap_message_time.html',1,'snap_arduino']]], + ['snapmessagewirechunk_84',['SnapMessageWireChunk',['../structsnap__arduino_1_1_snap_message_wire_chunk.html',1,'snap_arduino']]], + ['snapoutput_85',['SnapOutput',['../classsnap__arduino_1_1_snap_output.html',1,'snap_arduino']]], + ['snapprocessor_86',['SnapProcessor',['../classsnap__arduino_1_1_snap_processor.html',1,'snap_arduino']]], + ['snapprocessorbuffered_87',['SnapProcessorBuffered',['../classsnap__arduino_1_1_snap_processor_buffered.html',1,'snap_arduino']]], + ['snapprocessorrp2040_88',['SnapProcessorRP2040',['../classsnap__arduino_1_1_snap_processor_r_p2040.html',1,'snap_arduino']]], + ['snapprocessorrtos_89',['SnapProcessorRTOS',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html',1,'snap_arduino']]], + ['snapreadbuffer_90',['SnapReadBuffer',['../structsnap__arduino_1_1_snap_read_buffer.html',1,'snap_arduino']]], + ['snaptime_91',['SnapTime',['../classsnap__arduino_1_1_snap_time.html',1,'snap_arduino']]], + ['snaptimepoints_92',['SnapTimePoints',['../structsnap__arduino_1_1_snap_time_points.html',1,'snap_arduino']]], + ['snaptimesync_93',['SnapTimeSync',['../classsnap__arduino_1_1_snap_time_sync.html',1,'snap_arduino']]], + ['snaptimesyncdynamic_94',['SnapTimeSyncDynamic',['../classsnap__arduino_1_1_snap_time_sync_dynamic.html',1,'snap_arduino']]], + ['snaptimesyncdynamicsincestart_95',['SnapTimeSyncDynamicSinceStart',['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html',1,'snap_arduino']]], + ['snaptimesyncfixed_96',['SnapTimeSyncFixed',['../classsnap__arduino_1_1_snap_time_sync_fixed.html',1,'snap_arduino']]], + ['snapwritebuffer_97',['SnapWriteBuffer',['../structsnap__arduino_1_1_snap_write_buffer.html',1,'snap_arduino']]] ]; diff --git a/docs/html/search/classes_1.js b/docs/html/search/classes_1.js index 6db811d..3ff0c97 100644 --- a/docs/html/search/classes_1.js +++ b/docs/html/search/classes_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['tv_5ft_82',['tv_t',['../structtv__t.html',1,'']]] + ['tv_5ft_98',['tv_t',['../structsnap__arduino_1_1tv__t.html',1,'snap_arduino']]] ]; diff --git a/docs/html/search/functions_0.js b/docs/html/search/functions_0.js index 789c45c..1d6ecc1 100644 --- a/docs/html/search/functions_0.js +++ b/docs/html/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['audiobegin_83',['audioBegin',['../class_snap_output.html#ab7f75dcf2fef63819309c44bca400074',1,'SnapOutput']]] + ['audiobegin_100',['audioBegin',['../classsnap__arduino_1_1_snap_output.html#ab7f75dcf2fef63819309c44bca400074',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/functions_1.js b/docs/html/search/functions_1.js index 154bfab..904486c 100644 --- a/docs/html/search/functions_1.js +++ b/docs/html/search/functions_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['begin_84',['begin',['../class_snap_output.html#a50f45551c10ca30a0bc7f447e70188b1',1,'SnapOutput::begin()'],['../class_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e',1,'SnapTimeSync::begin()'],['../class_snap_client.html#abc2c0a4c4160fe59696af412649e43eb',1,'SnapClient::begin(SnapTimeSync &timeSync)'],['../class_snap_client.html#a601fb7cf1fc15db50c71a826f084f934',1,'SnapClient::begin()']]], - ['buffertaskactivationlimit_85',['bufferTaskActivationLimit',['../class_snap_processor_r_t_o_s.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'SnapProcessorRTOS']]] + ['begin_101',['begin',['../classsnap__arduino_1_1_snap_output.html#a50f45551c10ca30a0bc7f447e70188b1',1,'snap_arduino::SnapOutput::begin()'],['../classsnap__arduino_1_1_snap_processor.html#a50f45551c10ca30a0bc7f447e70188b1',1,'snap_arduino::SnapProcessor::begin()'],['../classsnap__arduino_1_1_snap_processor_buffered.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorBuffered::begin()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorRP2040::begin()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#acba365cc28eb702040c382646cfb0a7a',1,'snap_arduino::SnapProcessorRTOS::begin()'],['../classsnap__arduino_1_1_snap_time_sync.html#a4574307f85a0f36e8f25910d3361f84e',1,'snap_arduino::SnapTimeSync::begin()'],['../classsnap__arduino_1_1_snap_client.html#abc2c0a4c4160fe59696af412649e43eb',1,'snap_arduino::SnapClient::begin(SnapTimeSync &timeSync)'],['../classsnap__arduino_1_1_snap_client.html#a601fb7cf1fc15db50c71a826f084f934',1,'snap_arduino::SnapClient::begin()']]], + ['buffertaskactivationlimit_102',['bufferTaskActivationLimit',['../classsnap__arduino_1_1_snap_processor_buffered.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'snap_arduino::SnapProcessorBuffered::bufferTaskActivationLimit()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a8cbdf6515e63a9997a9245cf7bc2929c',1,'snap_arduino::SnapProcessorRTOS::bufferTaskActivationLimit()']]] ]; diff --git a/docs/html/search/functions_2.js b/docs/html/search/functions_2.js index 2a19299..8fc0820 100644 --- a/docs/html/search/functions_2.js +++ b/docs/html/search/functions_2.js @@ -1,4 +1,5 @@ var searchData= [ - ['copy_86',['copy',['../class_snap_processor_r_t_o_s.html#aaa6c087511a52e64fc9ad92820c7c0a8',1,'SnapProcessorRTOS']]] + ['connectclient_103',['connectClient',['../classsnap__arduino_1_1_snap_processor.html#a66f87ab2cb4fc7994001ed5dad8af679',1,'snap_arduino::SnapProcessor']]], + ['copy_104',['copy',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#aaa6c087511a52e64fc9ad92820c7c0a8',1,'snap_arduino::SnapProcessorRTOS']]] ]; diff --git a/docs/html/search/functions_3.js b/docs/html/search/functions_3.js index a9c6682..fc0a176 100644 --- a/docs/html/search/functions_3.js +++ b/docs/html/search/functions_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['doloop_87',['doLoop',['../class_snap_processor.html#ae0d28a9842dd1a20e72bdf59f8892fb8',1,'SnapProcessor::doLoop()'],['../class_snap_client.html#a4ee9280c3692bb64624dbc933acae273',1,'SnapClient::doLoop()']]] + ['doloop_105',['doLoop',['../classsnap__arduino_1_1_snap_processor.html#abdd99e468f667b748b0c9bfd395163d7',1,'snap_arduino::SnapProcessor::doLoop()'],['../classsnap__arduino_1_1_snap_client.html#abdd99e468f667b748b0c9bfd395163d7',1,'snap_arduino::SnapClient::doLoop()']]], + ['doloop1_106',['doLoop1',['../classsnap__arduino_1_1_snap_processor.html#acd628840f7e43d32563552bda5f90689',1,'snap_arduino::SnapProcessor::doLoop1()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#ac5e4b26fa498b1963ace4509ebf4b86e',1,'snap_arduino::SnapProcessorRP2040::doLoop1()']]] ]; diff --git a/docs/html/search/functions_4.js b/docs/html/search/functions_4.js index 1b98d20..bd05be5 100644 --- a/docs/html/search/functions_4.js +++ b/docs/html/search/functions_4.js @@ -1,4 +1,4 @@ var searchData= [ - ['end_88',['end',['../class_snap_output.html#af8e0a63ec718201627220299012e654f',1,'SnapOutput::end()'],['../class_snap_client.html#a081b5c662ecee58405a543518f699d31',1,'SnapClient::end()']]] + ['end_107',['end',['../classsnap__arduino_1_1_snap_output.html#af8e0a63ec718201627220299012e654f',1,'snap_arduino::SnapOutput::end()'],['../classsnap__arduino_1_1_snap_client.html#a081b5c662ecee58405a543518f699d31',1,'snap_arduino::SnapClient::end()']]] ]; diff --git a/docs/html/search/functions_5.js b/docs/html/search/functions_5.js index 0b21ec3..c0bac36 100644 --- a/docs/html/search/functions_5.js +++ b/docs/html/search/functions_5.js @@ -1,6 +1,6 @@ var searchData= [ - ['getdelayms_89',['getDelayMs',['../class_snap_output.html#a10297964d6abd0cffcb68332fff761b5',1,'SnapOutput']]], - ['getfactor_90',['getFactor',['../class_snap_time_sync.html#a47e677c2396350208f1a2499fced812a',1,'SnapTimeSync::getFactor()'],['../class_snap_time_sync_dynamic.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncDynamic::getFactor()'],['../class_snap_time_sync_dynamic_since_start.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncDynamicSinceStart::getFactor()'],['../class_snap_time_sync_fixed.html#a266c93347cd6fb48d564c9d12ec26059',1,'SnapTimeSyncFixed::getFactor()']]], - ['getstartdelay_91',['getStartDelay',['../class_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735',1,'SnapTimeSync']]] + ['getdelayms_108',['getDelayMs',['../classsnap__arduino_1_1_snap_output.html#a10297964d6abd0cffcb68332fff761b5',1,'snap_arduino::SnapOutput']]], + ['getfactor_109',['getFactor',['../classsnap__arduino_1_1_snap_time_sync.html#a47e677c2396350208f1a2499fced812a',1,'snap_arduino::SnapTimeSync::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncDynamic::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncDynamicSinceStart::getFactor()'],['../classsnap__arduino_1_1_snap_time_sync_fixed.html#a266c93347cd6fb48d564c9d12ec26059',1,'snap_arduino::SnapTimeSyncFixed::getFactor()']]], + ['getstartdelay_110',['getStartDelay',['../classsnap__arduino_1_1_snap_time_sync.html#a8a84aacea77de2dfdc9827cb7f71c735',1,'snap_arduino::SnapTimeSync']]] ]; diff --git a/docs/html/search/functions_6.js b/docs/html/search/functions_6.js index 2550218..09fb623 100644 --- a/docs/html/search/functions_6.js +++ b/docs/html/search/functions_6.js @@ -1,5 +1,9 @@ var searchData= [ - ['ismute_92',['isMute',['../class_snap_output.html#aa6f1c80ac878b7c454a49f0f16f2bfb0',1,'SnapOutput']]], - ['issync_93',['isSync',['../class_snap_time_sync.html#ae361c9a0939daff16cd8652325124905',1,'SnapTimeSync']]] + ['init_5frtos_111',['init_rtos',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a2ac99dcb18f12f765b2da0f7f77cd17b',1,'snap_arduino::SnapProcessorRTOS']]], + ['initqueues_112',['initQueues',['../classsnap__arduino_1_1_snap_processor_r_p2040.html#a03d18f97e323fb6f4527bc29a28ae92b',1,'snap_arduino::SnapProcessorRP2040']]], + ['isactive_113',['isActive',['../classsnap__arduino_1_1_snap_output.html#aed4f7586f45db6092d8ca7fa56944755',1,'snap_arduino::SnapOutput']]], + ['ismute_114',['isMute',['../classsnap__arduino_1_1_snap_output.html#aa6f1c80ac878b7c454a49f0f16f2bfb0',1,'snap_arduino::SnapOutput']]], + ['issync_115',['isSync',['../classsnap__arduino_1_1_snap_time_sync.html#ae361c9a0939daff16cd8652325124905',1,'snap_arduino::SnapTimeSync']]], + ['iswifi_116',['isWiFi',['../classsnap__arduino_1_1_snap_client.html#a2f71e236c6bfd49b51b2b883116244d8',1,'snap_arduino::SnapClient']]] ]; diff --git a/docs/html/search/functions_7.js b/docs/html/search/functions_7.js index d1f7ad3..5980e70 100644 --- a/docs/html/search/functions_7.js +++ b/docs/html/search/functions_7.js @@ -1,4 +1,5 @@ var searchData= [ - ['playbackfactor_94',['playbackFactor',['../class_snap_output.html#a6f02241f9435b0062580626d1894a573',1,'SnapOutput']]] + ['playbackfactor_117',['playbackFactor',['../classsnap__arduino_1_1_snap_output.html#a6f02241f9435b0062580626d1894a573',1,'snap_arduino::SnapOutput']]], + ['processext_118',['processExt',['../classsnap__arduino_1_1_snap_processor.html#a9ace7c86de0ecc5afd903ec1bddbcc70',1,'snap_arduino::SnapProcessor::processExt()'],['../classsnap__arduino_1_1_snap_processor_buffered.html#a9ace7c86de0ecc5afd903ec1bddbcc70',1,'snap_arduino::SnapProcessorBuffered::processExt()']]] ]; diff --git a/docs/html/search/functions_8.js b/docs/html/search/functions_8.js index f4ad220..875061e 100644 --- a/docs/html/search/functions_8.js +++ b/docs/html/search/functions_8.js @@ -1,24 +1,30 @@ var searchData= [ - ['servermillis_95',['serverMillis',['../class_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa',1,'SnapTime']]], - ['setaudioinfo_96',['setAudioInfo',['../class_snap_output.html#a5e283a9495aaf265739336829d45e215',1,'SnapOutput']]], - ['setclient_97',['setClient',['../class_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'SnapProcessor::setClient()'],['../class_snap_client.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'SnapClient::setClient()']]], - ['setdecoder_98',['setDecoder',['../class_snap_output.html#a6f9488e045147706a13387c0c6a634ea',1,'SnapOutput::setDecoder()'],['../class_snap_processor.html#a6f9488e045147706a13387c0c6a634ea',1,'SnapProcessor::setDecoder()']]], - ['setinterval_99',['setInterval',['../class_snap_time_sync.html#af8303d863006ab5b759a4e1fa8bb0e39',1,'SnapTimeSync']]], - ['setmessagebufferdelay_100',['setMessageBufferDelay',['../class_snap_time_sync.html#ac43c3135fd435d8006a5d48d2b13625c',1,'SnapTimeSync']]], - ['setmute_101',['setMute',['../class_snap_output.html#a27459cee4bd97a6ac4a09aec45cd3bbd',1,'SnapOutput']]], - ['setoutput_102',['setOutput',['../class_snap_output.html#aa0d3775308edf58cac6e7f763edbb96a',1,'SnapOutput::setOutput()'],['../class_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a',1,'SnapProcessor::setOutput()']]], - ['setplaybackfactor_103',['setPlaybackFactor',['../class_snap_output.html#a87ac62f6f14d8579e2cb3bbc8d705a89',1,'SnapOutput']]], - ['setprocessinglag_104',['setProcessingLag',['../class_snap_time_sync.html#a263ff3a9232682c353a845a6f87fcbf6',1,'SnapTimeSync']]], - ['setserverip_105',['setServerIP',['../class_snap_client.html#a25ac7501d9bf855ea1bd07feb77e9070',1,'SnapClient']]], - ['setsnapoutput_106',['setSnapOutput',['../class_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda',1,'SnapProcessor::setSnapOutput()'],['../class_snap_client.html#a5d9c21ad999d25919c01753e38a86bda',1,'SnapClient::setSnapOutput(SnapOutput &out)']]], - ['setsnapprocessor_107',['setSnapProcessor',['../class_snap_client.html#aa5fb69c578b675cd8239d80832eaf45f',1,'SnapClient']]], - ['setsnaptimesync_108',['setSnapTimeSync',['../class_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'SnapOutput::setSnapTimeSync()'],['../class_snap_client.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'SnapClient::setSnapTimeSync(SnapTimeSync &timeSync)']]], - ['setstartoutput_109',['setStartOutput',['../class_snap_client.html#adfe1e9bc7608e178934c91e42ff1033f',1,'SnapClient']]], - ['setstarttask_110',['setStartTask',['../class_snap_client.html#a26a56ec17a4183c08447e33c80591209',1,'SnapClient']]], - ['settimedifferenceclientserverms_111',['setTimeDifferenceClientServerMs',['../class_snap_time.html#a3e98d81c157bfc9c1b4ef65d3bc6dade',1,'SnapTime']]], - ['setvolume_112',['setVolume',['../class_snap_output.html#a35c7533999826a3706e97f99442d4c7e',1,'SnapOutput']]], - ['setvolumefactor_113',['setVolumeFactor',['../class_snap_output.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapOutput::setVolumeFactor()'],['../class_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapProcessor::setVolumeFactor()'],['../class_snap_client.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'SnapClient::setVolumeFactor()']]], - ['snapprocessorrtos_114',['SnapProcessorRTOS',['../class_snap_processor_r_t_o_s.html#a6a6f5078ba7dd396a62217562f934312',1,'SnapProcessorRTOS::SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)'],['../class_snap_processor_r_t_o_s.html#a99a5d30c01881c1c3ce653efc8ca0a96',1,'SnapProcessorRTOS::SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)']]], - ['synchronizeplayback_115',['synchronizePlayback',['../class_snap_output.html#aac98818fc690c70b6413fc52fc6b82f7',1,'SnapOutput']]] + ['servermillis_119',['serverMillis',['../classsnap__arduino_1_1_snap_time.html#a2d46ea8f99a7fe6583f6d72a5f9c9afa',1,'snap_arduino::SnapTime']]], + ['setaudioinfo_120',['setAudioInfo',['../classsnap__arduino_1_1_snap_output.html#a5e283a9495aaf265739336829d45e215',1,'snap_arduino::SnapOutput']]], + ['setclient_121',['setClient',['../classsnap__arduino_1_1_snap_client.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'snap_arduino::SnapClient::setClient()'],['../classsnap__arduino_1_1_snap_processor.html#aa4dbb35cfcc65d0c880983d78edd8ac3',1,'snap_arduino::SnapProcessor::setClient(Client &client)']]], + ['setclientname_122',['setClientName',['../classsnap__arduino_1_1_snap_processor.html#ab692edef6597697c8860218e778ddcf8',1,'snap_arduino::SnapProcessor']]], + ['setdecoder_123',['setDecoder',['../classsnap__arduino_1_1_snap_output.html#a6f9488e045147706a13387c0c6a634ea',1,'snap_arduino::SnapOutput::setDecoder()'],['../classsnap__arduino_1_1_snap_processor.html#a6f9488e045147706a13387c0c6a634ea',1,'snap_arduino::SnapProcessor::setDecoder(AudioDecoder &dec)']]], + ['sethostname_124',['setHostName',['../classsnap__arduino_1_1_snap_processor.html#ac0033c1dccf755a34751855a82a3b128',1,'snap_arduino::SnapProcessor']]], + ['setinterval_125',['setInterval',['../classsnap__arduino_1_1_snap_time_sync.html#af8303d863006ab5b759a4e1fa8bb0e39',1,'snap_arduino::SnapTimeSync']]], + ['setmessagebufferdelay_126',['setMessageBufferDelay',['../classsnap__arduino_1_1_snap_time_sync.html#ac43c3135fd435d8006a5d48d2b13625c',1,'snap_arduino::SnapTimeSync']]], + ['setmute_127',['setMute',['../classsnap__arduino_1_1_snap_output.html#a27459cee4bd97a6ac4a09aec45cd3bbd',1,'snap_arduino::SnapOutput']]], + ['setoutput_128',['setOutput',['../classsnap__arduino_1_1_snap_output.html#aa0d3775308edf58cac6e7f763edbb96a',1,'snap_arduino::SnapOutput::setOutput()'],['../classsnap__arduino_1_1_snap_processor.html#aa0d3775308edf58cac6e7f763edbb96a',1,'snap_arduino::SnapProcessor::setOutput()']]], + ['setplaybackfactor_129',['setPlaybackFactor',['../classsnap__arduino_1_1_snap_output.html#a87ac62f6f14d8579e2cb3bbc8d705a89',1,'snap_arduino::SnapOutput']]], + ['setprocessinglag_130',['setProcessingLag',['../classsnap__arduino_1_1_snap_time_sync.html#a263ff3a9232682c353a845a6f87fcbf6',1,'snap_arduino::SnapTimeSync']]], + ['setserverip_131',['setServerIP',['../classsnap__arduino_1_1_snap_client.html#a25ac7501d9bf855ea1bd07feb77e9070',1,'snap_arduino::SnapClient']]], + ['setsnapoutput_132',['setSnapOutput',['../classsnap__arduino_1_1_snap_processor.html#a5d9c21ad999d25919c01753e38a86bda',1,'snap_arduino::SnapProcessor::setSnapOutput()'],['../classsnap__arduino_1_1_snap_client.html#a5d9c21ad999d25919c01753e38a86bda',1,'snap_arduino::SnapClient::setSnapOutput(SnapOutput &out)']]], + ['setsnapprocessor_133',['setSnapProcessor',['../classsnap__arduino_1_1_snap_client.html#aa5fb69c578b675cd8239d80832eaf45f',1,'snap_arduino::SnapClient']]], + ['setsnaptimesync_134',['setSnapTimeSync',['../classsnap__arduino_1_1_snap_client.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'snap_arduino::SnapClient::setSnapTimeSync()'],['../classsnap__arduino_1_1_snap_output.html#ad703cdbab7c0a7f312178595a1fb2f58',1,'snap_arduino::SnapOutput::setSnapTimeSync()']]], + ['setstartoutput_135',['setStartOutput',['../classsnap__arduino_1_1_snap_client.html#adfe1e9bc7608e178934c91e42ff1033f',1,'snap_arduino::SnapClient']]], + ['setstarttask_136',['setStartTask',['../classsnap__arduino_1_1_snap_client.html#a26a56ec17a4183c08447e33c80591209',1,'snap_arduino::SnapClient']]], + ['settimedifferenceclientserverms_137',['setTimeDifferenceClientServerMs',['../classsnap__arduino_1_1_snap_time.html#a3e98d81c157bfc9c1b4ef65d3bc6dade',1,'snap_arduino::SnapTime']]], + ['setvolume_138',['setVolume',['../classsnap__arduino_1_1_snap_output.html#a35c7533999826a3706e97f99442d4c7e',1,'snap_arduino::SnapOutput']]], + ['setvolumefactor_139',['setVolumeFactor',['../classsnap__arduino_1_1_snap_client.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapClient::setVolumeFactor()'],['../classsnap__arduino_1_1_snap_processor.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapProcessor::setVolumeFactor()'],['../classsnap__arduino_1_1_snap_output.html#a7ffb49aa46d01ea1f30e374e0573cc83',1,'snap_arduino::SnapOutput::setVolumeFactor()']]], + ['setwifi_140',['setWiFi',['../classsnap__arduino_1_1_snap_client.html#aa5b1356ff52a71650594024a2faf532d',1,'snap_arduino::SnapClient']]], + ['snapprocessor_141',['snapProcessor',['../classsnap__arduino_1_1_snap_client.html#ae35f4b0efe5efba6e49a900b9feb00f7',1,'snap_arduino::SnapClient']]], + ['snapprocessorbuffered_142',['SnapProcessorBuffered',['../classsnap__arduino_1_1_snap_processor_buffered.html#a27d769bfee7b909ecb79d825e0532225',1,'snap_arduino::SnapProcessorBuffered']]], + ['snapprocessorrp2040_143',['SnapProcessorRP2040',['../classsnap__arduino_1_1_snap_processor_r_p2040.html#ad43641484ce99005fb3c4c6b9e57400b',1,'snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent=75)'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#a62a3a259a24a1f4a89ce2db19428fac7',1,'snap_arduino::SnapProcessorRP2040::SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent=75)']]], + ['snapprocessorrtos_144',['SnapProcessorRTOS',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a6a6f5078ba7dd396a62217562f934312',1,'snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS(SnapOutput &output, int buffer_size, int activationAtPercent=75)'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a99a5d30c01881c1c3ce653efc8ca0a96',1,'snap_arduino::SnapProcessorRTOS::SnapProcessorRTOS(int buffer_size, int activationAtPercent=75)']]], + ['synchronizeplayback_145',['synchronizePlayback',['../classsnap__arduino_1_1_snap_output.html#aac98818fc690c70b6413fc52fc6b82f7',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/functions_9.js b/docs/html/search/functions_9.js index b1bd822..7008934 100644 --- a/docs/html/search/functions_9.js +++ b/docs/html/search/functions_9.js @@ -1,6 +1,6 @@ var searchData= [ - ['task_5fcopy_116',['task_copy',['../class_snap_processor_r_t_o_s.html#a2725cad0984c9c469b19fd065371fe69',1,'SnapProcessorRTOS']]], - ['time_117',['time',['../class_snap_time.html#a0371cbc995b3b2f546215d4ebfc11ade',1,'SnapTime']]], - ['timedifferenceclientserverms_118',['timeDifferenceClientServerMs',['../class_snap_time.html#a058d57baeeb43619ca44ee9342b6c70c',1,'SnapTime']]] + ['task_5fcopy_146',['task_copy',['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#a2725cad0984c9c469b19fd065371fe69',1,'snap_arduino::SnapProcessorRTOS']]], + ['time_147',['time',['../classsnap__arduino_1_1_snap_time.html#a0371cbc995b3b2f546215d4ebfc11ade',1,'snap_arduino::SnapTime']]], + ['timedifferenceclientserverms_148',['timeDifferenceClientServerMs',['../classsnap__arduino_1_1_snap_time.html#a058d57baeeb43619ca44ee9342b6c70c',1,'snap_arduino::SnapTime']]] ]; diff --git a/docs/html/search/functions_a.js b/docs/html/search/functions_a.js index c3dee49..185ba6f 100644 --- a/docs/html/search/functions_a.js +++ b/docs/html/search/functions_a.js @@ -1,5 +1,5 @@ var searchData= [ - ['updateactualdelay_119',['updateActualDelay',['../class_snap_time_sync.html#a159ed048ebe13885c54954aa2a78546b',1,'SnapTimeSync']]], - ['updateservertime_120',['updateServerTime',['../class_snap_time_sync.html#af8923b482e191076bb12d2285f39ae09',1,'SnapTimeSync::updateServerTime()'],['../class_snap_time_sync_dynamic.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncDynamic::updateServerTime()'],['../class_snap_time_sync_dynamic_since_start.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncDynamicSinceStart::updateServerTime()'],['../class_snap_time_sync_fixed.html#ae8d7b0aa7af23a93851e1a4245939696',1,'SnapTimeSyncFixed::updateServerTime()']]] + ['updateactualdelay_149',['updateActualDelay',['../classsnap__arduino_1_1_snap_time_sync.html#a159ed048ebe13885c54954aa2a78546b',1,'snap_arduino::SnapTimeSync']]], + ['updateservertime_150',['updateServerTime',['../classsnap__arduino_1_1_snap_time_sync.html#af8923b482e191076bb12d2285f39ae09',1,'snap_arduino::SnapTimeSync::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncDynamic::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_dynamic_since_start.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncDynamicSinceStart::updateServerTime()'],['../classsnap__arduino_1_1_snap_time_sync_fixed.html#ae8d7b0aa7af23a93851e1a4245939696',1,'snap_arduino::SnapTimeSyncFixed::updateServerTime()']]] ]; diff --git a/docs/html/search/functions_b.js b/docs/html/search/functions_b.js index b782a03..a8b131f 100644 --- a/docs/html/search/functions_b.js +++ b/docs/html/search/functions_b.js @@ -1,4 +1,4 @@ var searchData= [ - ['volume_121',['volume',['../class_snap_output.html#a1d59a107c6918cdc9a17b92f6cd4e136',1,'SnapOutput::volume()'],['../class_snap_processor.html#a92937495d01c777a843b576f7fd02145',1,'SnapProcessor::volume()'],['../class_snap_client.html#a92937495d01c777a843b576f7fd02145',1,'SnapClient::volume()']]] + ['volume_151',['volume',['../classsnap__arduino_1_1_snap_output.html#a1d59a107c6918cdc9a17b92f6cd4e136',1,'snap_arduino::SnapOutput::volume()'],['../classsnap__arduino_1_1_snap_processor.html#a92937495d01c777a843b576f7fd02145',1,'snap_arduino::SnapProcessor::volume()'],['../classsnap__arduino_1_1_snap_client.html#a92937495d01c777a843b576f7fd02145',1,'snap_arduino::SnapClient::volume()']]] ]; diff --git a/docs/html/search/functions_c.js b/docs/html/search/functions_c.js index a20c640..b007da1 100644 --- a/docs/html/search/functions_c.js +++ b/docs/html/search/functions_c.js @@ -1,6 +1,6 @@ var searchData= [ - ['write_122',['write',['../class_snap_output.html#a5f985ca872c6ce5fb8fe126cf9a0a01f',1,'SnapOutput']]], - ['writeaudio_123',['writeAudio',['../class_snap_processor_r_t_o_s.html#af26d304c20113d4184aa61703aef6bc7',1,'SnapProcessorRTOS']]], - ['writeheader_124',['writeHeader',['../class_snap_output.html#a86e635e425cf8781cb707183a1648f35',1,'SnapOutput']]] + ['write_152',['write',['../classsnap__arduino_1_1_snap_output.html#a5f985ca872c6ce5fb8fe126cf9a0a01f',1,'snap_arduino::SnapOutput']]], + ['writeaudio_153',['writeAudio',['../classsnap__arduino_1_1_snap_processor_buffered.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorBuffered::writeAudio()'],['../classsnap__arduino_1_1_snap_processor_r_p2040.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorRP2040::writeAudio()'],['../classsnap__arduino_1_1_snap_processor_r_t_o_s.html#af26d304c20113d4184aa61703aef6bc7',1,'snap_arduino::SnapProcessorRTOS::writeAudio()']]], + ['writeheader_154',['writeHeader',['../classsnap__arduino_1_1_snap_output.html#a86e635e425cf8781cb707183a1648f35',1,'snap_arduino::SnapOutput']]] ]; diff --git a/docs/html/search/functions_d.js b/docs/html/search/functions_d.js index 069caf3..59844de 100644 --- a/docs/html/search/functions_d.js +++ b/docs/html/search/functions_d.js @@ -1,4 +1,4 @@ var searchData= [ - ['_7esnapclient_125',['~SnapClient',['../class_snap_client.html#a33755d7beaca179dfbdb2c7ef7e1943f',1,'SnapClient']]] + ['_7esnapclient_155',['~SnapClient',['../classsnap__arduino_1_1_snap_client.html#a33755d7beaca179dfbdb2c7ef7e1943f',1,'snap_arduino::SnapClient']]] ]; diff --git a/docs/html/search/namespaces_0.html b/docs/html/search/namespaces_0.html new file mode 100644 index 0000000..21db2c3 --- /dev/null +++ b/docs/html/search/namespaces_0.html @@ -0,0 +1,37 @@ + + + + + + + + + + +
+
Loading...
+
+ +
Searching...
+
No Matches
+ +
+ + diff --git a/docs/html/search/namespaces_0.js b/docs/html/search/namespaces_0.js new file mode 100644 index 0000000..3295264 --- /dev/null +++ b/docs/html/search/namespaces_0.js @@ -0,0 +1,4 @@ +var searchData= +[ + ['snap_5farduino_99',['snap_arduino',['../namespacesnap__arduino.html',1,'']]] +]; diff --git a/docs/html/search/pages_0.js b/docs/html/search/pages_0.js index cebdb79..af6016a 100644 --- a/docs/html/search/pages_0.js +++ b/docs/html/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['snapcast_20client_20for_20arduino_126',['Snapcast Client for Arduino',['../index.html',1,'']]] + ['snapcast_20client_20for_20arduino_156',['Snapcast Client for Arduino',['../index.html',1,'']]] ]; diff --git a/docs/html/search/searchdata.js b/docs/html/search/searchdata.js index c37b223..6fa85dc 100644 --- a/docs/html/search/searchdata.js +++ b/docs/html/search/searchdata.js @@ -2,23 +2,26 @@ var indexSectionsWithContent = { 0: "abcdegipstuvw~", 1: "st", - 2: "abcdegipstuvw~", - 3: "s" + 2: "s", + 3: "abcdegipstuvw~", + 4: "s" }; var indexSectionNames = { 0: "all", 1: "classes", - 2: "functions", - 3: "pages" + 2: "namespaces", + 3: "functions", + 4: "pages" }; var indexSectionLabels = { 0: "All", 1: "Classes", - 2: "Functions", - 3: "Pages" + 2: "Namespaces", + 3: "Functions", + 4: "Pages" }; diff --git a/docs/html/structsnap__arduino_1_1_snap_audio_header-members.html b/docs/html/structsnap__arduino_1_1_snap_audio_header-members.html new file mode 100644 index 0000000..5469e71 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_audio_header-members.html @@ -0,0 +1,86 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapAudioHeader Member List
+
+
+ +

This is the complete list of members for SnapAudioHeader, including all inherited members.

+ + + + + + +
codec (defined in SnapAudioHeader)SnapAudioHeader
operator-(SnapAudioHeader &h1) (defined in SnapAudioHeader)SnapAudioHeaderinline
sec (defined in SnapAudioHeader)SnapAudioHeader
size (defined in SnapAudioHeader)SnapAudioHeader
usec (defined in SnapAudioHeader)SnapAudioHeader
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_audio_header.html b/docs/html/structsnap__arduino_1_1_snap_audio_header.html new file mode 100644 index 0000000..794d842 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_audio_header.html @@ -0,0 +1,118 @@ + + + + + + + +arduino-snapclient: SnapAudioHeader Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapAudioHeader Struct Reference
+
+
+ +

Information about the next bucket. + More...

+ +

#include <SnapCommon.h>

+ + + + +

+Public Member Functions

+uint64_t operator- (SnapAudioHeader &h1)
 
+ + + + + + + + + +

+Public Attributes

+codec_type codec = NO_CODEC
 
+int32_t sec = 0
 
+size_t size = 0
 
+int32_t usec = 0
 
+

Detailed Description

+

Information about the next bucket.

+
Author
Phil Schatzmann
+
Version
0.1
+
Date
2023-10-28
+
Copyright
Copyright (c) 2023
+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_base-members.html b/docs/html/structsnap__arduino_1_1_snap_message_base-members.html new file mode 100644 index 0000000..53362a7 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_base-members.html @@ -0,0 +1,89 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageBase Member List
+
+
+ +

This is the complete list of members for SnapMessageBase, including all inherited members.

+ + + + + + + + + +
deserialize(const char *data, uint32_t reqSize) (defined in SnapMessageBase)SnapMessageBaseinline
id (defined in SnapMessageBase)SnapMessageBase
received (defined in SnapMessageBase)SnapMessageBase
refersTo (defined in SnapMessageBase)SnapMessageBase
sent (defined in SnapMessageBase)SnapMessageBase
serialize(char *data, uint32_t reqSize) (defined in SnapMessageBase)SnapMessageBaseinline
size (defined in SnapMessageBase)SnapMessageBase
type (defined in SnapMessageBase)SnapMessageBase
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_base.html b/docs/html/structsnap__arduino_1_1_snap_message_base.html new file mode 100644 index 0000000..e25dafd --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_base.html @@ -0,0 +1,123 @@ + + + + + + + +arduino-snapclient: SnapMessageBase Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapMessageBase Struct Reference
+
+
+ +

Snapcast Base Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + +

+Public Member Functions

+int deserialize (const char *data, uint32_t reqSize)
 
+int serialize (char *data, uint32_t reqSize)
 
+ + + + + + + + + + + + + +

+Public Attributes

+uint16_t id
 
+tv_t received
 
+uint16_t refersTo
 
+tv_t sent
 
+uint32_t size
 
+uint16_t type
 
+

Detailed Description

+

Snapcast Base Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_codec_header-members.html b/docs/html/structsnap__arduino_1_1_snap_message_codec_header-members.html new file mode 100644 index 0000000..fe69bb0 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_codec_header-members.html @@ -0,0 +1,87 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageCodecHeader Member List
+
+
+ +

This is the complete list of members for SnapMessageCodecHeader, including all inherited members.

+ + + + + + + +
codec() (defined in SnapMessageCodecHeader)SnapMessageCodecHeaderinline
deserialize(const char *data, uint32_t reqSize) (defined in SnapMessageCodecHeader)SnapMessageCodecHeaderinline
payload() (defined in SnapMessageCodecHeader)SnapMessageCodecHeaderinline
size (defined in SnapMessageCodecHeader)SnapMessageCodecHeader
v_codec (defined in SnapMessageCodecHeader)SnapMessageCodecHeader
v_payload (defined in SnapMessageCodecHeader)SnapMessageCodecHeader
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_codec_header.html b/docs/html/structsnap__arduino_1_1_snap_message_codec_header.html new file mode 100644 index 0000000..d0648be --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_codec_header.html @@ -0,0 +1,117 @@ + + + + + + + +arduino-snapclient: SnapMessageCodecHeader Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapMessageCodecHeader Struct Reference
+
+
+ +

Snapcast Codec Header Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + + + +

+Public Member Functions

+char * codec ()
 
+int deserialize (const char *data, uint32_t reqSize)
 
+char * payload ()
 
+ + + + + + + +

+Public Attributes

+uint32_t size
 
+std::vector< char > v_codec
 
+std::vector< char > v_payload
 
+

Detailed Description

+

Snapcast Codec Header Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_hallo-members.html b/docs/html/structsnap__arduino_1_1_snap_message_hallo-members.html new file mode 100644 index 0000000..3364f71 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_hallo-members.html @@ -0,0 +1,95 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageHallo Member List
+
+
+ +

This is the complete list of members for SnapMessageHallo, including all inherited members.

+ + + + + + + + + + + + + + + +
arch (defined in SnapMessageHallo)SnapMessageHallo
client_name (defined in SnapMessageHallo)SnapMessageHallo
hostname (defined in SnapMessageHallo)SnapMessageHallo
id (defined in SnapMessageHallo)SnapMessageHallo
instance (defined in SnapMessageHallo)SnapMessageHallo
json_result (defined in SnapMessageHallo)SnapMessageHalloprotected
mac (defined in SnapMessageHallo)SnapMessageHallo
os (defined in SnapMessageHallo)SnapMessageHallo
protocol_version (defined in SnapMessageHallo)SnapMessageHallo
result (defined in SnapMessageHallo)SnapMessageHalloprotected
serialize(size_t *size) (defined in SnapMessageHallo)SnapMessageHalloinline
TAG (defined in SnapMessageHallo)SnapMessageHalloprotected
to_json() (defined in SnapMessageHallo)SnapMessageHalloinlineprotected
version (defined in SnapMessageHallo)SnapMessageHallo
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_hallo.html b/docs/html/structsnap__arduino_1_1_snap_message_hallo.html new file mode 100644 index 0000000..a08fe63 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_hallo.html @@ -0,0 +1,149 @@ + + + + + + + +arduino-snapclient: SnapMessageHallo Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
SnapMessageHallo Struct Reference
+
+
+ +

Snapcast Hallo Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + +

+Public Member Functions

+char * serialize (size_t *size)
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

+const char * arch
 
+const char * client_name
 
+const char * hostname
 
+const char * id
 
+int instance
 
+const char * mac
 
+const char * os
 
+int protocol_version
 
+const char * version
 
+ + + +

+Protected Member Functions

+void to_json ()
 
+ + + + + + + +

+Protected Attributes

+char * json_result = result + 4
 
+char result [256]
 
+const char * TAG = "SnapMessageHallo"
 
+

Detailed Description

+

Snapcast Hallo Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_server_settings-members.html b/docs/html/structsnap__arduino_1_1_snap_message_server_settings-members.html new file mode 100644 index 0000000..586438a --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_server_settings-members.html @@ -0,0 +1,86 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageServerSettings Member List
+
+
+ +

This is the complete list of members for SnapMessageServerSettings, including all inherited members.

+ + + + + + +
buffer_ms (defined in SnapMessageServerSettings)SnapMessageServerSettings
deserialize(const char *json) (defined in SnapMessageServerSettings)SnapMessageServerSettingsinline
latency (defined in SnapMessageServerSettings)SnapMessageServerSettings
muted (defined in SnapMessageServerSettings)SnapMessageServerSettings
volume (defined in SnapMessageServerSettings)SnapMessageServerSettings
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_server_settings.html b/docs/html/structsnap__arduino_1_1_snap_message_server_settings.html new file mode 100644 index 0000000..e3ecc30 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_server_settings.html @@ -0,0 +1,114 @@ + + + + + + + +arduino-snapclient: SnapMessageServerSettings Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapMessageServerSettings Struct Reference
+
+
+ +

Snapcast Server Settings Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + +

+Public Member Functions

+int deserialize (const char *json)
 
+ + + + + + + + + +

+Public Attributes

+int32_t buffer_ms = 0
 
+int32_t latency = 0
 
+bool muted = false
 
+uint32_t volume = 0
 
+

Detailed Description

+

Snapcast Server Settings Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_time-members.html b/docs/html/structsnap__arduino_1_1_snap_message_time-members.html new file mode 100644 index 0000000..84b3d99 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_time-members.html @@ -0,0 +1,84 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageTime Member List
+
+
+ +

This is the complete list of members for SnapMessageTime, including all inherited members.

+ + + + +
deserialize(const char *data, uint32_t size) (defined in SnapMessageTime)SnapMessageTimeinline
latency (defined in SnapMessageTime)SnapMessageTime
serialize(char *data, uint32_t size) (defined in SnapMessageTime)SnapMessageTimeinline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_time.html b/docs/html/structsnap__arduino_1_1_snap_message_time.html new file mode 100644 index 0000000..8bd1f4c --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_time.html @@ -0,0 +1,108 @@ + + + + + + + +arduino-snapclient: SnapMessageTime Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapMessageTime Struct Reference
+
+
+ +

Snapcast Time Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + +

+Public Member Functions

+int deserialize (const char *data, uint32_t size)
 
+int serialize (char *data, uint32_t size)
 
+ + + +

+Public Attributes

+tv_t latency
 
+

Detailed Description

+

Snapcast Time Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk-members.html b/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk-members.html new file mode 100644 index 0000000..05f9fe6 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk-members.html @@ -0,0 +1,85 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapMessageWireChunk Member List
+
+
+ +

This is the complete list of members for SnapMessageWireChunk, including all inherited members.

+ + + + + +
deserialize(const char *data, uint32_t reqSize) (defined in SnapMessageWireChunk)SnapMessageWireChunkinline
payload (defined in SnapMessageWireChunk)SnapMessageWireChunk
size (defined in SnapMessageWireChunk)SnapMessageWireChunk
timestamp (defined in SnapMessageWireChunk)SnapMessageWireChunk
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk.html b/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk.html new file mode 100644 index 0000000..122c234 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_message_wire_chunk.html @@ -0,0 +1,111 @@ + + + + + + + +arduino-snapclient: SnapMessageWireChunk Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapMessageWireChunk Struct Reference
+
+
+ +

Snapcast Wire Chunk Message. + More...

+ +

#include <SnapProtocol.h>

+ + + + +

+Public Member Functions

+int deserialize (const char *data, uint32_t reqSize)
 
+ + + + + + + +

+Public Attributes

+char * payload = nullptr
 
+uint32_t size
 
+tv_t timestamp
 
+

Detailed Description

+

Snapcast Wire Chunk Message.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_read_buffer-members.html b/docs/html/structsnap__arduino_1_1_snap_read_buffer-members.html new file mode 100644 index 0000000..6e5d965 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_read_buffer-members.html @@ -0,0 +1,92 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapReadBuffer Member List
+
+
+ +

This is the complete list of members for SnapReadBuffer, including all inherited members.

+ + + + + + + + + + + + +
begin(const char *data, size_t size) (defined in SnapReadBuffer)SnapReadBufferinline
buffer (defined in SnapReadBuffer)SnapReadBuffer
index (defined in SnapReadBuffer)SnapReadBuffer
read(char *data, size_t size) (defined in SnapReadBuffer)SnapReadBufferinline
read_int16(int16_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
read_int32(int32_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
read_int8(int8_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
read_uint16(uint16_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
read_uint32(uint32_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
read_uint8(uint8_t *data) (defined in SnapReadBuffer)SnapReadBufferinline
size (defined in SnapReadBuffer)SnapReadBuffer
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_read_buffer.html b/docs/html/structsnap__arduino_1_1_snap_read_buffer.html new file mode 100644 index 0000000..207c3ef --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_read_buffer.html @@ -0,0 +1,132 @@ + + + + + + + +arduino-snapclient: SnapReadBuffer Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapReadBuffer Struct Reference
+
+
+ +

Buffer to read different data types. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

+void begin (const char *data, size_t size)
 
+int read (char *data, size_t size)
 
+int read_int16 (int16_t *data)
 
+int read_int32 (int32_t *data)
 
+int read_int8 (int8_t *data)
 
+int read_uint16 (uint16_t *data)
 
+int read_uint32 (uint32_t *data)
 
+int read_uint8 (uint8_t *data)
 
+ + + + + + + +

+Public Attributes

+const char * buffer
 
+size_t index
 
+size_t size
 
+

Detailed Description

+

Buffer to read different data types.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_time_points-members.html b/docs/html/structsnap__arduino_1_1_snap_time_points-members.html new file mode 100644 index 0000000..ee54c8a --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_time_points-members.html @@ -0,0 +1,85 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapTimePoints Member List
+
+
+ +

This is the complete list of members for SnapTimePoints, including all inherited members.

+ + + + + +
local_ms (defined in SnapTimePoints)SnapTimePoints
server_ms (defined in SnapTimePoints)SnapTimePoints
SnapTimePoints()=default (defined in SnapTimePoints)SnapTimePoints
SnapTimePoints(uint32_t serverMs) (defined in SnapTimePoints)SnapTimePointsinline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_time_points.html b/docs/html/structsnap__arduino_1_1_snap_time_points.html new file mode 100644 index 0000000..39f5d32 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_time_points.html @@ -0,0 +1,108 @@ + + + + + + + +arduino-snapclient: SnapTimePoints Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapTimePoints Struct Reference
+
+
+ +

Recording of local_ms and server_ms. + More...

+ +

#include <SnapCommon.h>

+ + + + +

+Public Member Functions

+ SnapTimePoints (uint32_t serverMs)
 
+ + + + + +

+Public Attributes

+uint32_t local_ms = millis()
 
+uint32_t server_ms
 
+

Detailed Description

+

Recording of local_ms and server_ms.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_write_buffer-members.html b/docs/html/structsnap__arduino_1_1_snap_write_buffer-members.html new file mode 100644 index 0000000..4f6c7aa --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_write_buffer-members.html @@ -0,0 +1,92 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
SnapWriteBuffer Member List
+
+
+ +

This is the complete list of members for SnapWriteBuffer, including all inherited members.

+ + + + + + + + + + + + +
begin(char *data, size_t size) (defined in SnapWriteBuffer)SnapWriteBufferinline
buffer (defined in SnapWriteBuffer)SnapWriteBuffer
index (defined in SnapWriteBuffer)SnapWriteBuffer
size (defined in SnapWriteBuffer)SnapWriteBuffer
write(const char *data, size_t size) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_int16(int16_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_int32(int32_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_int8(int8_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_uint16(uint16_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_uint32(uint32_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
write_uint8(uint8_t data) (defined in SnapWriteBuffer)SnapWriteBufferinline
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1_snap_write_buffer.html b/docs/html/structsnap__arduino_1_1_snap_write_buffer.html new file mode 100644 index 0000000..c7d7233 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1_snap_write_buffer.html @@ -0,0 +1,132 @@ + + + + + + + +arduino-snapclient: SnapWriteBuffer Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
SnapWriteBuffer Struct Reference
+
+
+ +

Buffer to write different data types. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

+void begin (char *data, size_t size)
 
+int write (const char *data, size_t size)
 
+int write_int16 (int16_t data)
 
+int write_int32 (int32_t data)
 
+int write_int8 (int8_t data)
 
+int write_uint16 (uint16_t data)
 
+int write_uint32 (uint32_t data)
 
+int write_uint8 (uint8_t data)
 
+ + + + + + + +

+Public Attributes

+char * buffer
 
+size_t index
 
+size_t size
 
+

Detailed Description

+

Buffer to write different data types.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1tv__t-members.html b/docs/html/structsnap__arduino_1_1tv__t-members.html new file mode 100644 index 0000000..e73e207 --- /dev/null +++ b/docs/html/structsnap__arduino_1_1tv__t-members.html @@ -0,0 +1,83 @@ + + + + + + + +arduino-snapclient: Member List + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+
tv_t Member List
+
+
+ +

This is the complete list of members for tv_t, including all inherited members.

+ + + +
sec (defined in tv_t)tv_t
usec (defined in tv_t)tv_t
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/docs/html/structsnap__arduino_1_1tv__t.html b/docs/html/structsnap__arduino_1_1tv__t.html new file mode 100644 index 0000000..e1ebd2a --- /dev/null +++ b/docs/html/structsnap__arduino_1_1tv__t.html @@ -0,0 +1,101 @@ + + + + + + + +arduino-snapclient: tv_t Struct Reference + + + + + + + + + +
+
+ + + + + + +
+
arduino-snapclient +
+
+
+ + + + + + + + +
+
+ + +
+ +
+ + +
+
+
+Public Attributes | +List of all members
+
+
tv_t Struct Reference
+
+
+ +

Time as sec & usec. + More...

+ +

#include <SnapProtocol.h>

+ + + + + + +

+Public Attributes

+int32_t sec
 
+int32_t usec
 
+

Detailed Description

+

Time as sec & usec.

+
The documentation for this struct was generated from the following file: +
+ +
+Generated by doxygen 1.9.1 +
+ + diff --git a/examples/SnapClientAudioKit/SnapClientAudioKit.ino b/examples/SnapClientAudioKit/SnapClientAudioKit.ino index 71379d5..ad01e65 100644 --- a/examples/SnapClientAudioKit/SnapClientAudioKit.ino +++ b/examples/SnapClientAudioKit/SnapClientAudioKit.ino @@ -5,8 +5,8 @@ */ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioLibs/AudioBoardStream.h" // install https://github.com/pschatzmann/arduino-audio-driver -#include "AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus +#include "AudioTools/AudioLibs/AudioBoardStream.h" // install https://github.com/pschatzmann/arduino-audio-driver +#include "AudioTools/AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus #define ARDUINO_LOOP_STACK_SIZE (10 * 1024) diff --git a/examples/SnapClientEthernet/SnapClientEthernet.ino b/examples/SnapClientEthernet/SnapClientEthernet.ino new file mode 100644 index 0000000..61edb94 --- /dev/null +++ b/examples/SnapClientEthernet/SnapClientEthernet.ino @@ -0,0 +1,67 @@ +// Example for EthernetClient: We just test the output by reporting the received data bytes + +#include +#include +#include "AudioTools.h" +#include "SnapClient.h" + +EthernetClient eth; +MeasuringStream out{10, &Serial}; // log ever 10 writes +CopyDecoder codec; +SnapClient client(eth, out, codec); +byte mac[] = {0xDE, 0xAD, 0xBE, 0xEF, 0xFE, 0xED}; +//IPAddress ip(192, 168, 1, 177); +//IPAddress gateway(192, 168, 1, 1); +//IPAddress dns(8, 8, 8, 8); + + +void setup() { + Serial.begin(115200); + while(!Serial); + Serial.println("setup"); + + // example for rp2040 + SPI.setMISO(16); + SPI.setMOSI(19); + SPI.setSCK(18); + SPI.setCS(17); + SPI.begin(17); // use default pins$ + + // start the Ethernet connection: + Ethernet.init(17); + Ethernet.begin(mac); + //Ethernet.begin(mac, ip, dns, gateway); + + // Check for Ethernet hardware present + if (Ethernet.hardwareStatus() == EthernetNoHardware) { + Serial.println("Ethernet shield was not found. Sorry, can't run without hardware. :("); + while (true); + } + + // Check link status + if (Ethernet.linkStatus() == LinkOFF) { + Serial.println("Ethernet cable is not connected."); + } + Serial.print("local IP: "); + Serial.println(Ethernet.localIP()); + + // wait for link + Serial.println("waiting for link..."); + while(Ethernet.linkStatus()!=LinkON){ + delay(10); + } + + // Define CONFIG_SNAPCAST_SERVER_HOST in SnapConfig.h or here + client.setServerIP(IPAddress(192, 168, 1, 44)); + + // start snap client + if (!client.begin()) { + Serial.print("Could not connect to snap server"); + while (true); + } + + out.setReportBytes(true); + Serial.println("setup success"); +} + +void loop() { client.doLoop(); } \ No newline at end of file diff --git a/examples/SnapClientFreeRTOS/SnapClientFreeRTOS.ino b/examples/SnapClientFreeRTOS/SnapClientFreeRTOS.ino index f36dba0..3db20ee 100644 --- a/examples/SnapClientFreeRTOS/SnapClientFreeRTOS.ino +++ b/examples/SnapClientFreeRTOS/SnapClientFreeRTOS.ino @@ -1,8 +1,8 @@ #include "AudioTools.h" #include "SnapClient.h" #include "api/SnapProcessorRTOS.h" // install https://github.com/pschatzmann/arduino-freertos-addons -#include "AudioLibs/AudioBoardStream.h" // install https://github.com/pschatzmann/arduino-audio-driver -#include "AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus +#include "AudioTools/AudioLibs/AudioBoardStream.h" // install https://github.com/pschatzmann/arduino-audio-driver +#include "AudioTools/AudioCodecs/CodecOpus.h" // https://github.com/pschatzmann/arduino-libopus AudioBoardStream out(AudioKitEs8388V1); // or replace with e.g. I2SStream out; diff --git a/examples/SnapClientI2S/SnapClientI2S.ino b/examples/SnapClientI2S/SnapClientI2S.ino index 99105b8..26f6b88 100644 --- a/examples/SnapClientI2S/SnapClientI2S.ino +++ b/examples/SnapClientI2S/SnapClientI2S.ino @@ -6,7 +6,7 @@ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" #define ARDUINO_LOOP_STACK_SIZE (10 * 1024) diff --git a/examples/SnapClientInternalDAC/SnapClientInternalDAC.ino b/examples/SnapClientInternalDAC/SnapClientInternalDAC.ino index 6914725..b63ac2e 100644 --- a/examples/SnapClientInternalDAC/SnapClientInternalDAC.ino +++ b/examples/SnapClientInternalDAC/SnapClientInternalDAC.ino @@ -6,7 +6,7 @@ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" #define ARDUINO_LOOP_STACK_SIZE (10 * 1024) diff --git a/examples/SnapClientRP2040/SnapClientRP2040.ino b/examples/SnapClientRP2040/SnapClientRP2040.ino new file mode 100644 index 0000000..fd57b04 --- /dev/null +++ b/examples/SnapClientRP2040/SnapClientRP2040.ino @@ -0,0 +1,67 @@ +/** + * @brief SnapClient with Opus decoder: Wifi processing is on core 0, decoding and + * i2s output is on core 1. + * @author Phil Schatzmann + * @copyright GPLv3 + */ + +#include "AudioTools.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" +#include "SnapClient.h" +#include "api/SnapProcessorRP2040.h" + +I2SStream out; +OpusAudioDecoder opus; +WiFiClient wifi; +//SnapTimeSyncDynamic synch(172, 10); // optional configuratioin +SnapClient client(wifi, out, opus); +SnapProcessorRP2040 processor_rp2040(1024*8); // define OPUS queue with 8 kbytes + +void setup() { + Serial.begin(115200); + AudioToolsLogger.begin(Serial, AudioToolsLogLevel::Info); + while(!Serial); + Serial.println("starting..."); + + // login to wifi -> Define values in SnapConfig.h or replace them here + WiFi.begin("ssid", "password"); + Serial.print("Connecting to WiFi .."); + while (WiFi.status() != WL_CONNECTED) { + Serial.print('.'); + delay(1000); + } + + // print ip address + Serial.println(); + Serial.println(WiFi.localIP()); + + // Define CONFIG_SNAPCAST_SERVER_HOST in SnapConfig.h or here + client.setServerIP(IPAddress(192,168,1,44)); + client.setSnapProcessor(processor_rp2040); + + // start snap client + client.begin(); + Serial.println("started"); +} + +void loop() { + // fill queue + client.doLoop(); +} + +void setup1(){ + // setup I2S to define custom pins + auto cfg = out.defaultConfig(); + //cfg.pin_bck = 14; + //cfg.pin_ws = 15; + //cfg.pin_data = 22; + cfg.sample_rate = 48000; + cfg.buffer_size = 1024; + cfg.buffer_count = 4; + out.begin(cfg); +} + +void loop1(){ + // trigger output from queue + processor_rp2040.doLoop1(); +} \ No newline at end of file diff --git a/examples/SnapClientVS1053/SnapClientVS1053.ino b/examples/SnapClientVS1053/SnapClientVS1053.ino index 2434c88..d843f86 100644 --- a/examples/SnapClientVS1053/SnapClientVS1053.ino +++ b/examples/SnapClientVS1053/SnapClientVS1053.ino @@ -8,7 +8,7 @@ */ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioLibs/VS1053Stream.h" +#include "AudioTools/AudioLibs/VS1053Stream.h" VS1053Stream out; // final output diff --git a/examples/Tests/TestGetHttp/TestGetHttp.ino b/examples/Tests/TestGetHttp/TestGetHttp.ino index 2362a7c..65be831 100644 --- a/examples/Tests/TestGetHttp/TestGetHttp.ino +++ b/examples/Tests/TestGetHttp/TestGetHttp.ino @@ -1,7 +1,7 @@ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" OpusAudioDecoder opus; NullStream out; diff --git a/examples/Tests/TestOutput/TestOutput.ino b/examples/Tests/TestOutput/TestOutput.ino index 8665abe..c9b5437 100644 --- a/examples/Tests/TestOutput/TestOutput.ino +++ b/examples/Tests/TestOutput/TestOutput.ino @@ -1,6 +1,6 @@ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" OpusAudioDecoder opus; NullStream out; diff --git a/examples/Tests/TestTime/TestTime.ino b/examples/Tests/TestTime/TestTime.ino index b9f1c85..33da3c2 100644 --- a/examples/Tests/TestTime/TestTime.ino +++ b/examples/Tests/TestTime/TestTime.ino @@ -1,6 +1,6 @@ #include "AudioTools.h" #include "SnapClient.h" -#include "AudioCodecs/CodecOpus.h" +#include "AudioTools/AudioCodecs/CodecOpus.h" OpusAudioDecoder opus; NullStream out; diff --git a/library.properties b/library.properties index f0911ee..9982841 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=snapclient -version=0.0.1 +version=0.1.1 author=https://github.com/jorgenkraghjakobsen maintainer=Phil Schatzmann sentence=snapclient diff --git a/src/SnapClient.h b/src/SnapClient.h index 080c560..5dc150f 100644 --- a/src/SnapClient.h +++ b/src/SnapClient.h @@ -5,12 +5,10 @@ */ #include "AudioTools.h" +#include "Client.h" #include "SnapConfig.h" #include "api/SnapCommon.h" #include "api/SnapLogger.h" -//#include -#include "Client.h" - #if CONFIG_NVS_FLASH #include "nvs_flash.h" @@ -19,6 +17,10 @@ #include #endif +#ifdef ESP32 +#include +#endif + #include "api/SnapOutput.h" #include "api/SnapProcessor.h" @@ -32,8 +34,7 @@ namespace snap_arduino { * @copyright Copyright (c) 2023 */ class SnapClient { - -public: + public: SnapClient(Client &client, AudioStream &stream, AudioDecoder &decoder) { static AdapterAudioStreamToAudioOutput output_adapter; output_adapter.setStream(stream); @@ -43,6 +44,15 @@ class SnapClient { server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST); } + SnapClient(Client &client, Print &stream, AudioDecoder &decoder) { + static AdapterPrintToAudioOutput output_adapter; + output_adapter.setStream(stream); + p_decoder = &decoder; + p_output = &output_adapter; + p_client = &client; + server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST); + } + SnapClient(Client &client, AudioStream &stream, StreamingDecoder &decoder, int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) { static DecoderFromStreaming decoder_adapter(decoder, bufferSize); @@ -59,7 +69,7 @@ class SnapClient { p_output = &output; p_client = &client; server_ip.fromString(CONFIG_SNAPCAST_SERVER_HOST); - } + } SnapClient(Client &client, AudioOutput &output, StreamingDecoder &decoder, int bufferSize = CONFIG_STREAMIN_DECODER_BUFFER) { @@ -69,21 +79,17 @@ class SnapClient { } /// Destructor - ~SnapClient() { - end(); - } + ~SnapClient() { end(); } /// Defines an alternative commnuication client (default is WiFiClient) void setClient(Client &client) { p_client = &client; } /// @brief Defines the Snapcast Server IP address - /// @param address + /// @param address void setServerIP(IPAddress ipAddress) { this->server_ip = ipAddress; } /// Defines the time synchronization logic - void setSnapTimeSync(SnapTimeSync &timeSync){ - p_time_sync = &timeSync; - } + void setSnapTimeSync(SnapTimeSync &timeSync) { p_time_sync = &timeSync; } /// Starts the processing bool begin(SnapTimeSync &timeSync) { @@ -94,13 +100,15 @@ class SnapClient { /// Starts the processing bool begin() { #if defined(ESP32) - if (WiFi.status() != WL_CONNECTED) { - ESP_LOGE(TAG, "WiFi not connected"); - return false; + if (is_wifi) { + if (WiFi.status() != WL_CONNECTED) { + ESP_LOGE(TAG, "WiFi not connected"); + return false; + } + // use maximum speed + WiFi.setSleep(false); + ESP_LOGI(TAG, "Connected to AP"); } - // use maximum speed - WiFi.setSleep(false); - ESP_LOGI(TAG, "Connected to AP"); #endif // Get MAC address for WiFi station @@ -145,15 +153,22 @@ class SnapClient { p_snapprocessor = &processor; } + /// Provides the actual processor + SnapProcessor &snapProcessor() { return *p_snapprocessor; } + /// Defines the Snap output implementation to be used - void setSnapOutput(SnapOutput &out){ - p_snapprocessor->setSnapOutput(out); - } + void setSnapOutput(SnapOutput &out) { p_snapprocessor->setSnapOutput(out); } /// Call from Arduino Loop - to receive and process the audio data - void doLoop() { p_snapprocessor->doLoop(); } + bool doLoop() { return p_snapprocessor->doLoop(); } -protected: + /// ESP32: WiFiClient: prevent/activate WiFi link status check + void setWiFi(bool flag){ is_wifi = flag;} + + /// check if we use the ESP32 WiFi for checking the link status + bool isWiFi() {return is_wifi;} + + protected: const char *TAG = "SnapClient"; SnapTime &snap_time = SnapTime::instance(); SnapProcessor default_processor; @@ -165,6 +180,11 @@ class SnapClient { SnapTimeSync *p_time_sync = &time_sync_default; IPAddress server_ip; int server_port = CONFIG_SNAPCAST_SERVER_PORT; +#ifdef ESP32 + bool is_wifi = true; +#else + bool is_wifi = false; +#endif void setupMDNS() { #if CONFIG_SNAPCLIENT_USE_MDNS && defined(ESP32) @@ -177,13 +197,18 @@ class SnapClient { // we just take the first address int nrOfServices = MDNS.queryService("snapcast", "tcp"); if (nrOfServices > 0) { +#if ESP_ARDUINO_VERSION >= ESP_ARDUINO_VERSION_VAL(3, 0, 0) + server_ip = MDNS.address(0); +#else server_ip = MDNS.IP(0); +#endif char str_address[20] = {0}; sprintf(str_address, "%d.%d.%d.%d", server_ip[0], server_ip[1], server_ip[2], server_ip[3]); server_port = MDNS.port(0); - ESP_LOGI(TAG, "MDNS: SNAPCAST ip: %s, port: %d", str_address, server_port); + ESP_LOGI(TAG, "MDNS: SNAPCAST ip: %s, port: %d", str_address, + server_port); } else { ESP_LOGE(TAG, "SNAPCAST server not found"); @@ -207,7 +232,6 @@ class SnapClient { #endif } - void setupMACAddress() { #ifdef ESP32 const char *adr = strdup(WiFi.macAddress().c_str()); @@ -218,4 +242,4 @@ class SnapClient { } }; -} \ No newline at end of file +} // namespace snap_arduino \ No newline at end of file diff --git a/src/api/SnapLogger.h b/src/api/SnapLogger.h index 59a1cb6..f83a2b1 100644 --- a/src/api/SnapLogger.h +++ b/src/api/SnapLogger.h @@ -7,9 +7,10 @@ #ifdef ESP32 # include "esp_log.h" #else -# define DEFAULT_LOG(...) fprintf(stderr,"[%s] ", __PRETTY_FUNCTION__);fprintf(stderr, __VA_ARGS__);fputc('\n',stderr) -# define ESP_LOGE(tag, ...) DEFAULT_LOG(__VA_ARGS__) -# define ESP_LOGW(tag, ...) DEFAULT_LOG(__VA_ARGS__) -# define ESP_LOGI(tag, ...) DEFAULT_LOG(__VA_ARGS__) -# define ESP_LOGD(tag, ...) +static char msg[100] = ": "; +# define DEFAULT_LOG(...) { Serial.print(__PRETTY_FUNCTION__); snprintf((char*)msg+2, 100, __VA_ARGS__); Serial.println(msg); } +# define ESP_LOGE(tag, ...) DEFAULT_LOG(__VA_ARGS__) +# define ESP_LOGW(tag, ...) DEFAULT_LOG(__VA_ARGS__) +# define ESP_LOGI(tag, ...) //DEFAULT_LOG(__VA_ARGS__) +# define ESP_LOGD(tag, ...) //DEFAULT_LOG(__VA_ARGS__) #endif \ No newline at end of file diff --git a/src/api/SnapOutput.h b/src/api/SnapOutput.h index e5d87b6..583978c 100644 --- a/src/api/SnapOutput.h +++ b/src/api/SnapOutput.h @@ -88,9 +88,15 @@ class SnapOutput : public AudioInfoSupport { /// Defines the audio output chain to the final output void setOutput(AudioOutput &output) { this->out = &output; // final output - resample.setStream(output); + resample.setOutput(output); vol_stream.setStream(resample); // adjust volume decoder_stream.setStream(&vol_stream); // decode to pcm + + // synchronized audio information + AudioInfo info = output.audioInfo(); + resample.begin(info, info); + vol_stream.setAudioInfo(info); + decoder_stream.setAudioInfo(info); } AudioOutput &getOutput() { return *out; } @@ -122,8 +128,12 @@ class SnapOutput : public AudioInfoSupport { // writes the audio data to the decoder size_t audioWrite(const void *src, size_t size) { - ESP_LOGD(TAG, "%zu", size); + ESP_LOGI(TAG, "audioWrite: %zu", size); + time_last_write = millis(); size_t result = decoder_stream.write((const uint8_t *)src, size); + if (result != size){ + ESP_LOGW(TAG, "Could not write all data %zu -> %zu", size, result); + } return result; } @@ -160,6 +170,15 @@ class SnapOutput : public AudioInfoSupport { return result; } + uint64_t getLastWriteTime() { + return time_last_write; + } + + /// checks if the audio is still playing + bool isActive(uint16_t timeout=1000){ + return (time_last_write + timeout) >= millis(); + } + protected: const char *TAG = "SnapOutput"; AudioOutput *out = nullptr; @@ -175,6 +194,7 @@ class SnapOutput : public AudioInfoSupport { SnapTimeSync *p_snap_time_sync = nullptr; bool is_sync_started = false; bool is_audio_begin_called = false; + uint64_t time_last_write = 0; /// setup of all audio objects bool audioBegin() { @@ -187,6 +207,9 @@ class SnapOutput : public AudioInfoSupport { return false; } + // determine default audio info from output + audio_info = out->audioInfo(); + // open volume control: allow amplification auto vol_cfg = vol_stream.defaultConfig(); vol_cfg.copyFrom(audio_info); @@ -228,7 +251,7 @@ class SnapOutput : public AudioInfoSupport { } void audioEnd() { - ESP_LOGD(TAG, "start"); + ESP_LOGD(TAG, "audioEnd"); if (out == nullptr) return; out->end(); } @@ -266,4 +289,4 @@ class SnapOutput : public AudioInfoSupport { } }; -} \ No newline at end of file +} diff --git a/src/api/SnapProcessor.h b/src/api/SnapProcessor.h index 83d48b3..7b0eede 100644 --- a/src/api/SnapProcessor.h +++ b/src/api/SnapProcessor.h @@ -32,18 +32,26 @@ class SnapProcessor { p_snap_output = &snap_output; } + /// Sets up the output and the client virtual bool begin() { - bool result = false; + bool result = true; + // start output chain if (output_start) { result = audioBegin(); } + // connect to snapcast server + if(!connectClient()){ + result = false; + } + if (http_task_start) { last_time_sync = 0; id_counter = 0; resizeData(); } header_received = false; + loop_status = LoopStart; return result; } @@ -70,7 +78,17 @@ class SnapProcessor { void setStartTask(bool flag) { http_task_start = flag; } /// Call via SnapClient in Arduino Loop! - virtual void doLoop() { processLoopStep(); } + bool doLoop() { + if (is_fast_loop) + return processLoopStepFast(); + else + return processLoopStep(); + } + + /// Usually not used! + virtual bool doLoop1() { + return false; + } /// Defines the output class void setOutput(AudioOutput &output) { p_snap_output->setOutput(output); } @@ -96,6 +114,29 @@ class SnapProcessor { p_snap_output->setAudioInfo(info); } + // Select loop processing with minimum delays + void setFastLoop(bool flag){ + is_fast_loop = flag; + } + + /// Defines the host name (default CONFIG_SNAPCAST_CLIENT_NAME) + void setHostName(const char* name){ + hostname = name; + } + + const char* hostName(){ + return hostname; + } + + /// Defines the client name (default "libsnapcast") + void setClientName(const char* name){ + client_name = name; + } + + const char* clientName(){ + return client_name; + } + protected: const char *TAG = "SnapProcessor"; // WiFiClient default_client; @@ -124,13 +165,62 @@ class SnapProcessor { bool header_received = false; bool is_time_set = false; SnapTime &snap_time = SnapTime::instance(); + bool is_fast_loop = false; + enum loop_status_enum { LoopStart, LoopStep, LoopEnd }; + loop_status_enum loop_status = LoopStart; + const char* hostname = CONFIG_SNAPCAST_CLIENT_NAME; + const char* client_name = "libsnapcast"; + + bool processLoopStepFast() { + switch (loop_status) { + case LoopStart: { + if (connectClient()) { + ESP_LOGI(TAG, "... connected"); + } else { + delay(10); + return false; + } + + now = snap_time.time(); + if (!writeHallo()) { + ESP_LOGI(TAG, "writeHallo"); + return false; + } + loop_status = LoopStep; + return true; + } + + case LoopStep: { + if (!processMessageLoop()) { + loop_status = LoopEnd; + } + // some additional processing while we wait for data + processExt(); + // logHeap(); + checkHeap(); + return true; + } + + case LoopEnd: { + loop_status = LoopStart; + if (id_counter % 100 == 0) { + logHeap(); + } + // For rtos, give audio output some space + delay(1); + return true; + } + } + // we should not get here + return false; + } bool processLoopStep() { if (connectClient()) { ESP_LOGI(TAG, "... connected"); } else { delay(10); - return true; + return false; } now = snap_time.time(); @@ -217,12 +307,18 @@ class SnapProcessor { return true; } + /// connects to the server: returns true if we are connected bool connectClient() { ESP_LOGD(TAG, "start"); if (p_client->connected()) return true; + p_client->stop(); // for Ethernet.h p_client->setTimeout(CONFIG_CLIENT_TIMEOUT_SEC); - if (!p_client->connect(server_ip, server_port)) { - ESP_LOGE(TAG, "... socket connect failed errno=%d", errno); + if (p_client->connect(server_ip, server_port)<=0) { + char str_address[50]; + sprintf(str_address, "%d.%d.%d.%d:%d", server_ip[0], server_ip[1], + server_ip[2], server_ip[3], server_port); + + ESP_LOGE(TAG, "Socket connect to %s failed (errno = %d)", str_address, errno); delay(4000); return false; } @@ -242,9 +338,9 @@ class SnapProcessor { // setup hello_message SnapMessageHallo hello_message; hello_message.mac = mac_address; - hello_message.hostname = CONFIG_SNAPCAST_CLIENT_NAME; + hello_message.hostname = hostname; hello_message.version = "0.0.2"; - hello_message.client_name = "libsnapcast"; + hello_message.client_name = client_name; hello_message.os = "arduino"; hello_message.arch = "xtensa"; hello_message.instance = 1; diff --git a/src/api/SnapProcessorRP2040.h b/src/api/SnapProcessorRP2040.h new file mode 100644 index 0000000..b02c614 --- /dev/null +++ b/src/api/SnapProcessorRP2040.h @@ -0,0 +1,134 @@ +#pragma once +#include "AudioTools/Concurrency/RP2040.h" +#include "SnapOutput.h" + +namespace snap_arduino { + +/** + * @brief Processor for which the encoded output is buffered in a queue. The decoding and + * audio output can be done on the second core by calling loop1(); + * + * @author Phil Schatzmann + * @version 0.1 + * @date 2024-02-26 + * @copyright Copyright (c) 2023 + */ +class SnapProcessorRP2040 : public SnapProcessor { + public: + /// Default constructor + SnapProcessorRP2040(SnapOutput &output, int bufferSizeBytes, int activationAtPercent = 75) + : SnapProcessor(output) { + active_percent = activationAtPercent; + initQueues(bufferSizeBytes); + } + /// Default constructor + SnapProcessorRP2040(int bufferSizeBytes, int activationAtPercent = 75) + : SnapProcessor() { + active_percent = activationAtPercent; + initQueues(bufferSizeBytes); + } + + bool begin() override { + ESP_LOGW(TAG, "begin: %d", buffer_count * 1024); + // regular begin logic + bool result = SnapProcessor::begin(); + + // allocate buffer + buffer.setBlockingRead(true); + buffer.setBlockingWrite(true); + buffer.resize(buffer_count * 1024); + + // we need to read back the buffer with the written sizes + size_queue.resize(RTOS_MAX_QUEUE_ENTRY_COUNT); + + is_active = false; + return result; + } + + void end(void) override { + size_queue.clear(); + buffer.reset(); + SnapProcessor::end(); + } + + bool doLoop1() override { + ESP_LOGD(TAG, "doLoop1 %d / %d", size_queue.available(), buffer.available()); + if (!isBufferActive()) return true; + + size_t size = 0; + if (size_queue.readArray(&size, 1)) { + uint8_t data[size]; + int read = buffer.readArray(data, size); + if (read != size){ + ESP_LOGE(TAG, "readArray failed %d -> %d", size, read); + } + int written = p_snap_output->audioWrite(data, size); + if (written != size) { + ESP_LOGE(TAG, "write error: %d of %d", written, size); + } + } + return true; + } + + protected: + const char *TAG = "SnapProcessorRP2040"; + audio_tools::BufferRP2040T size_queue{1, 0}; + audio_tools::BufferRP2040T buffer{1024, 0}; // size defined in begin + int buffer_count = 0; + bool is_active = false; + int active_percent = 0; + + bool isBufferActive() { + if (!is_active && buffer.available()>0) { + + int limit = buffer.size() * active_percent / 100; + if (buffer.available() >= limit) { + LOGI("Setting buffer active"); + is_active = true; + } + delay(10); + } + return is_active; + } + + /// store parameters provided by constructor + void initQueues(int bufferSizeBytes) { + buffer_count = bufferSizeBytes / 1024; + if (buffer_count <= 2){ + buffer_count = 2; + } + } + + /// Writes the encoded audio data to a queue + size_t writeAudio(const uint8_t *data, size_t size) override { + + if (size > buffer.size()) { + ESP_LOGE(TAG, "The buffer is too small with %d. Use a multiple of %d", buffer.size(), size); + stop(); + } + + ESP_LOGI(TAG, "size: %zu / buffer %d", size, buffer.available()); + if (!p_snap_output->isStarted() || size == 0) { + ESP_LOGW(TAG, "not started"); + return 0; + } + + if (!p_snap_output->synchronizePlayback()) { + return size; + } + + if (!size_queue.writeArray(&size, 1)) { + ESP_LOGW(TAG, "size_queue full"); + return 0; + } + + size_t size_written = buffer.writeArray(data, size); + if (size_written != size) { + ESP_LOGE(TAG, "buffer-overflow"); + } + + return size; + } +}; + +} // namespace snap_arduino diff --git a/src/api/SnapProcessorRTOS.h b/src/api/SnapProcessorRTOS.h index f9c3881..06503d3 100644 --- a/src/api/SnapProcessorRTOS.h +++ b/src/api/SnapProcessorRTOS.h @@ -1,6 +1,10 @@ #pragma once #include "SnapOutput.h" -#include "Concurrency/Concurrency.h" +#if defined(AUDIOTOOLS_MAJOR_VERSION) +# include "AudioTools/AudioLibs/Concurrency.h" +#else +# include "AudioLibs/Concurrency.h" +#endif namespace snap_arduino { diff --git a/src/api/SnapTime.h b/src/api/SnapTime.h index 83ba981..e95283f 100644 --- a/src/api/SnapTime.h +++ b/src/api/SnapTime.h @@ -1,6 +1,5 @@ #pragma once -#include "AudioBasic/Collections/Vector.h" -#include "AudioConfig.h" +#include "AudioTools/CoreAudio/AudioBasic/Collections/Vector.h" #include #include