Merge pull request #195 from alnitak/opusOgg

Embedding of opus and ogg libs on all platforms with a choice of doing this

Author: alnitak

.gitignore

@@ -45,6 +45,6 @@ web/worker.dart.js.map
 **/android/daemon
 **/android/android
 
-# Ignore ogg and opus directories in xiph
-xiph/ogg
-xiph/opus
+# Ignore all the content of xiph folder, but not the scripts
+xiph/*
+!xiph/build_*

.metadata

@@ -4,7 +4,7 @@
 # This file should be version controlled and should not be manually edited.
 
 version:
-  revision: "8495dee1fd4aacbe9de707e7581203232f591b2f"
+  revision: "35c388afb57ef061d06a39b537336c87e0e3d1b1"
   channel: "stable"
 
 project_type: plugin_ffi
@@ -13,26 +13,26 @@ project_type: plugin_ffi
 migration:
   platforms:
     - platform: root
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: android
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: ios
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: linux
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: macos
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: web
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
     - platform: windows
-      create_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
-      base_revision: 8495dee1fd4aacbe9de707e7581203232f591b2f
+      create_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
+      base_revision: 35c388afb57ef061d06a39b537336c87e0e3d1b1
 
   # User provided section
 

.vscode/c_cpp_properties.json

@@ -48,6 +48,36 @@
             "cppStandard": "c++17",
             "intelliSenseMode": "windows-msvc-x64",
             "configurationProvider": "ms-vscode.cmake-tools"
+        },
+        {
+            "name": "MacOS",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "${workspaceFolder}/flutter_soloud_ios/ios/Classes/src",
+                "${workspaceFolder}/flutter_soloud_ios/ios/Classes/src/soloud/include",
+                "${workspaceFolder}/src"
+            ],
+            "defines": ["WITH_MINIAUDIO", "DR_MP3_IMPLEMENTATION"],
+            "compilerPath": "/usr/bin/clang",
+            "cStandard": "c17",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "macos-clang-x64",
+            "configurationProvider": "ms-vscode.cmake-tools"
+        },
+        {
+            "name": "iOS",
+            "includePath": [
+                "${workspaceFolder}/**",
+                "${workspaceFolder}/flutter_soloud_ios/ios/Classes/src",
+                "${workspaceFolder}/flutter_soloud_ios/ios/Classes/src/soloud/include",
+                "${workspaceFolder}/src"
+            ],
+            "defines": ["WITH_MINIAUDIO", "DR_MP3_IMPLEMENTATION"],
+            "compilerPath": "/usr/bin/clang",
+            "cStandard": "c17",
+            "cppStandard": "c++17",
+            "intelliSenseMode": "ios-clang-arm64",
+            "configurationProvider": "ms-vscode.cmake-tools"
         }
     ],
     "version": 4

.vscode/launch.json

@@ -10,6 +10,9 @@
             "request": "launch",
             "program": "lib/main.dart",
             "flutterMode": "debug",
+            // "env": {
+            //     "NO_OPUS_OGG_LIBS": "1"
+            // },
             "cwd": "${workspaceFolder}/example"
         },
         {
@@ -18,14 +21,20 @@
             "request": "launch",
             "program": "lib/main.dart",
             "flutterMode": "profile",
+            // "env": {
+            //     "NO_OPUS_OGG_LIBS": "1"
+            // },
             "cwd": "${workspaceFolder}/example"
         },
         {
             "name": "Flutter release",
             "type": "dart",
             "request": "launch",
-            "program": "lib/buffer_stream/websocket.dart",
+            "program": "lib/main.dart",
             "flutterMode": "release",
+            // "env": {
+            //     "NO_OPUS_OGG_LIBS": "1"
+            // },
             "cwd": "${workspaceFolder}/example"
         },
         {

.vscode/settings.json

@@ -109,5 +109,5 @@
         "text_encoding": "cpp",
         "coroutine": "cpp"
     },
-    "java.configuration.updateBuildConfiguration": "interactive"
+    "java.configuration.updateBuildConfiguration": "automatic"
 }

CHANGELOG.md

@@ -1,3 +1,6 @@
+### 3.0.3 (7 Mar 2025)
+- it's now possible to choose to not link opus and ogg libraries (see `NO_OPUS_OGG_LIBS.md`). Fix for #191 and #192.
+
 ### 3.0.2 (25 Feb 2025)
 - fixed crash when trying to play a sound after deactivating its active filter #189
 

NO_OPUS_OGG_LIBS.md

@@ -0,0 +1,72 @@
+Opus and Ogg libraries are currently only used by the BufferStream to receive and fill audio data with Opus format and they are enabled by default.
+
+These libs are prebuilt for all platforms and stored in the plugin folder. This means that even if they are not needed, the plugin still requires them to work, and the size of the app will grow slightly. To address this, a new environment variable has been introduced that can be used to prevent the prebuilt libs from being linked to the final app.
+
+If trying to use, for example the `SoLoud.setBufferStream()` function, an exception will be thrown if the environment variable has been set.
+
+---
+
+### How to set the environment variable:
+
+**Linux - Android - Windows**
+
+If using **VS Code**, add `NO_OPUS_OGG_LIBS` set to an empty string in the `env` key to the *.vscode/launch.json* configuration, for example:
+
+```
+{
+    "name": "Flutter debug",
+    "type": "dart",
+    "request": "launch",
+    "program": "lib/buffer_stream/websocket.dart",
+    "flutterMode": "debug",
+    "env": {
+        "NO_OPUS_OGG_LIBS": "1"
+    },
+    "cwd": "${workspaceFolder}/example"
+}
+```
+
+If using **Android Studio**, add `NO_OPUS_OGG_LIBS="1"` in the *Run/Debug Configurations* configuration under **Environment Variables** text field.
+
+Alternatively, you can set the variable in the terminal and build the app, for example:
+
+```
+flutter clean
+flutter pub get
+NO_OPUS_OGG_LIBS="1" && flutter run
+```
+
+**MacOS - iOS**
+
+To set the environment variable on MacOS and iOS, you can add the following line to the `app/ios/Podfile` or `app/macos/Podfile` at the top of the file:
+
+```
+ENV['NO_OPUS_OGG_LIBS'] = '1'
+```
+
+Alternatively, you can set the variable in the terminal and build the app, for example:
+
+```
+flutter clean
+flutter pub get
+NO_OPUS_OGG_LIBS="1" && flutter run
+```
+if the environment variable was already been used before for testing purposes, you can use the following command:
+```
+flutter clean
+flutter pub get
+NO_OPUS_OGG_LIBS= && flutter run <-- this will unset the environment variable
+```
+
+> [!NOTE]  
+> The environment variable set in VS Code or in Android Studio will be ignored.
+
+**Web**
+
+To set the environment variable on Web, open `web/compile_wasm.sh` and change the line `NO_OPUS_OGG_LIBS="0"` to `NO_OPUS_OGG_LIBS="1"`.
+You should then run the script to build the WASM and JS files. You must have `emscripten` installed.
+
+The script works on Linux and probably on MacOS. Windows users should run the script in WSL or wait until a *.bat* script is available.
+
+> [!NOTE]  
+> The environment variable set in VS Code or in Android Studio will be ignored.

README.md

@@ -47,13 +47,7 @@ In other words, it is calling the C/C++ methods of the underlying audio engine d
 #### Opus format for streaming
 When using an `AudioSource` as an audio stream to play custom audio data (ie using setBufferStream/addAudioDataStream/setDataIsEnded), it is possible to add PCM RAW audio data in *s8*, *s16le*, *s32le*, *f32le* and since it supports also the *opus* format with the Ogg codec (ie to work with OpenAI APIs), the [Opus](https://www.opus-codec.org/) and [Ogg](https://xiph.org/ogg/) libraries from [Xiph.org](https://www.xiph.org/) are needed.
 
-On Linux and MacOS theese libraries must be installed if you want to use this kind of `AudioSource`:
-- **Linux**
-  - install them depending on the package manager used by you distribution
-- **MacOS**
-  - `brew install opus libogg`
-
-if the libraries are not found the plugin will throw an exception when calling `setBufferStream` using Opus format.
+These libraries are embedded and enabled by default for all platforms. This leads to an increased binary size by 600~1500 kb depending on platform. If you don't need to use audio streaming, hence you don't need the Opus and Ogg libraries, you can read the [NO_OPUS_OGG_LIBS.md](https://github.com/alnitak/flutter_soloud/blob/main/NO_OPUS_OGG_LIBS.md) for details.
 
 The `SoLoud.setBufferStream` supports also `BufferingType.preserved` which behaves the same as a normal `AudioSource`, and `BufferingType.released` which will free the memory of the already played audio for longer playback. The latter will accept to play only one instance of the audio stream at the same time.
 |BufferingType.preserved|BufferingType.released|

android/CMakeLists.txt

@@ -11,7 +11,7 @@ set(SRC_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../src")
 ## Add SoLoud custom cmake files
 message("**************** SOLOUD CONFIGURE.CMAKE")
 include (Configure.cmake)
-message("**************** SOLOUD SRC.CMAKE 1")
+message("**************** SOLOUD SRC.CMAKE START")
 if (UNIX AND NOT WIN32 AND NOT APPLE)
 	if (CMAKE_SIZEOF_VOID_P MATCHES "8")
 		set (LIB_POSTFIX "64" CACHE STRING "suffix for 32/64 dir placement")
@@ -29,7 +29,7 @@ include_directories(${SRC_DIR}/soloud/include)
 include_directories(${SRC_DIR}/soloud/src)
 include_directories(${SRC_DIR})
 include (src.cmake)
-message("**************** SOLOUD SRC.CMAKE 2  ${TARGET_NAME}")
+message("**************** SOLOUD SRC.CMAKE END  ${TARGET_NAME}")
 
 
 
@@ -70,22 +70,23 @@ target_include_directories(${PLUGIN_NAME} INTERFACE "${CMAKE_CURRENT_SOURCE_DIR}
 target_link_libraries(${PLUGIN_NAME} PRIVATE ${log-lib} android)
 
 
-# Add opus library
-set(OPUS_LIBRARY ${CMAKE_CURRENT_SOURCE_DIR}/libs/${ANDROID_ABI}/libopus.so)
-target_link_libraries(${PLUGIN_NAME} PRIVATE ${OPUS_LIBRARY})
-set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib")
-
-# Add ogg library
-set(OGG_LIBRARY ${CMAKE_CURRENT_SOURCE_DIR}/libs/${ANDROID_ABI}/libogg.so)
-target_link_libraries(${PLUGIN_NAME} PRIVATE ${OGG_LIBRARY})
-set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib")
-
-# include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include/ogg)
-# include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include/opus)
-include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
-add_compile_definitions(LIBOPUS_OGG_AVAILABLE)
+if(NOT DEFINED ENV{NO_OPUS_OGG_LIBS})
+    message("NO_OPUS_OGG_LIBS has not been set. Linking Opus and Ogg libraries!")
+    # Add opus library
+    set(OPUS_LIBRARY ${CMAKE_CURRENT_SOURCE_DIR}/libs/${ANDROID_ABI}/libopus.so)
+    target_link_libraries(${PLUGIN_NAME} PRIVATE ${OPUS_LIBRARY})
+    set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib")
 
+    # Add ogg library
+    set(OGG_LIBRARY ${CMAKE_CURRENT_SOURCE_DIR}/libs/${ANDROID_ABI}/libogg.so)
+    target_link_libraries(${PLUGIN_NAME} PRIVATE ${OGG_LIBRARY})
+    set(INSTALL_BUNDLE_LIB_DIR "${CMAKE_INSTALL_PREFIX}/lib")
 
+    include_directories(${CMAKE_CURRENT_SOURCE_DIR}/include)
+else()
+    message("NO_OPUS_OGG_LIBS has been set. Not linking Opus and Ogg libraries!")
+    add_definitions(-DNO_OPUS_OGG_LIBS)
+endif()
 
 # target_compile_definitions(flutter_soloud PUBLIC DART_SHARED_LIB)
 

android/build.gradle

@@ -4,17 +4,14 @@ group = "flutter.soloud.flutter_soloud"
 version = "1.0"
 
 buildscript {
-    // ext.kotlin_version = '1.7.10'
     repositories {
         google()
         mavenCentral()
     }
 
     dependencies {
         // The Android Gradle Plugin knows how to build native code with the NDK.
-        classpath 'com.android.tools.build:gradle:7.3.1'
-        // classpath("com.android.tools.build:gradle:8.1.0")
-        // classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+        classpath("com.android.tools.build:gradle:8.7.0")
     }
 }
 
@@ -32,7 +29,7 @@ android {
 
     // Bumping the plugin compileSdk version requires all clients of this plugin
     // to bump the version in their app.
-    compileSdk = 33
+    compileSdk = 35
 
     // Use the NDK version
     // declared in /android/app/build.gradle file of the Flutter project.
@@ -55,12 +52,34 @@ android {
         }
     }
 
+    defaultConfig {
+        minSdk = 21
+
+        // Add this inside defaultConfig to affect all variants
+        externalNativeBuild {
+            cmake {
+                // Pass environment variable to CMake
+                arguments "-DNO_OPUS_OGG_LIBS=${System.getenv('NO_OPUS_OGG_LIBS') ?: 'false'}"
+                
+                // Specify the correct target name
+                targets "flutter_soloud_plugin"
+            }
+        }
+    }
+
+    // Task to check if NO_OPUS_OGG_LIBS has changed. If yes the cmake task will be re-run
+    tasks.whenTaskAdded { task ->
+        if (task.name.contains("externalNativeBuild")) {
+            // println "=== Flutter SoLoud Plugin ==="
+            // println "NO_OPUS_OGG_LIBS=${System.getenv('NO_OPUS_OGG_LIBS') ?: 'false'}"
+            
+            // Always run CMake configuration
+            task.outputs.upToDateWhen { false }
+        }
+    }
+
     compileOptions {
         sourceCompatibility = JavaVersion.VERSION_11
         targetCompatibility = JavaVersion.VERSION_11
     }
-
-    defaultConfig {
-        minSdk = 21
-    }
 }