Merge pull request #141 from alnitak/choose_output

Choose output playback device

Author: filiph

.vscode/launch.json

@@ -8,23 +8,23 @@
             "name": "Flutter debug",
             "type": "dart",
             "request": "launch",
-            "program": "lib/wave_data/wave_data.dart",
+            "program": "lib/output_device/output_device.dart",
             "flutterMode": "debug",
             "cwd": "${workspaceFolder}/example"
         },
         {
             "name": "Flutter profile",
             "type": "dart",
             "request": "launch",
-            "program": "lib/filters/pitchshift.dart",
+            "program": "lib/main.dart",
             "flutterMode": "profile",
             "cwd": "${workspaceFolder}/example"
         },
         {
             "name": "Flutter release",
             "type": "dart",
             "request": "launch",
-            "program": "lib/filters/pitchshift.dart",
+            "program": "lib/main.dart",
             "flutterMode": "release",
             "cwd": "${workspaceFolder}/example"
         },

.vscode/tasks.json

@@ -9,7 +9,7 @@
         },
         {
             "label": "compile linux debug",
-            "command": "cd ${workspaceFolder}/example; flutter build linux -t lib/wave_data/wave_data.dart --debug",
+            "command": "cd ${workspaceFolder}/example; flutter build linux -t lib/output_device/output_device.dart --debug",
             "type": "shell"
         },
         {
@@ -19,17 +19,17 @@
         },
         {
             "label": "compile windows debug verbose",
-            "command": "cd ${workspaceFolder}/example; flutter build windows -t lib/filters/pitchshift.dart --debug --verbose",
+            "command": "cd ${workspaceFolder}/example; flutter build windows -t lib/main.dart --debug --verbose",
             "type": "shell"
         },
         {
             "label": "compile windows debug",
-            "command": "cd ${workspaceFolder}/example; flutter build windows -t lib/filters/pitchshift.dart --debug",
+            "command": "cd ${workspaceFolder}/example; flutter build windows -t lib/main.dart --debug",
             "type": "shell"
         },
         {
             "label": "compile web debug",
-            "command": "cd ${workspaceFolder}/example; flutter run -d chrome --web-renderer canvaskit --web-browser-flag '--disable-web-security' -t lib/wave_data/wave_data.dart --release",
+            "command": "cd ${workspaceFolder}/example; flutter run -d chrome --web-renderer canvaskit --web-browser-flag '--disable-web-security' -t lib/main.dart --release",
             "type": "shell"
         }
     ]

CHANGELOG.md

@@ -1,3 +1,8 @@
+### 2.1.7 ()
+- added `listPlaybackDevices` to get all the OS output devices available.
+- added `deviceId` parameter to the `init()` method. You can choose which device is delegated to output the audio.
+- added `changeDevice` method to change the playback device on-the-fly.
+
 ### 2.1.6 (17 Oct 2024)
 - fixed a bug that caused an error when loading a sound more than twice.
 

example/lib/output_device/output_device.dart

@@ -0,0 +1,117 @@
+import 'dart:developer' as dev;
+
+import 'package:flutter/foundation.dart';
+import 'package:flutter/material.dart';
+import 'package:flutter_soloud/flutter_soloud.dart';
+import 'package:logging/logging.dart';
+
+/// Output device example.
+///
+/// This example uses the default output device and present a dropdown
+/// menu to change from all available output devices.
+/// All this is made simple just using the `listPlaybackDevices` and
+/// `changeDevice` methods.
+///
+/// To get all output devices use `listPlaybackDevices` which returns
+/// a list of `PlaybackDevice`s class. Each items of this class
+/// contains the id, whether it's the default device (the one used by the OS)
+/// and the name.
+/// This method can be called even if the engine has not been initialized.
+///
+/// At any time it is possible to pass to `changeDevice` a `PlaybackDevice`
+/// which will change the output device.
+///
+/// Note: Android, iOS and Web, only support one output device which is
+/// the default.
+
+void main() async {
+  // The `flutter_soloud` package logs everything
+  // (from severe warnings to fine debug messages)
+  // using the standard `package:logging`.
+  // You can listen to the logs as shown below.
+  Logger.root.level = kDebugMode ? Level.FINE : Level.INFO;
+  Logger.root.onRecord.listen((record) {
+    dev.log(
+      record.message,
+      time: record.time,
+      level: record.level.value,
+      name: record.loggerName,
+      zone: record.zone,
+      error: record.error,
+      stackTrace: record.stackTrace,
+    );
+  });
+
+  WidgetsFlutterBinding.ensureInitialized();
+
+  /// Initialize the player.
+  await SoLoud.instance.init();
+
+  runApp(
+    const MaterialApp(
+      home: HelloFlutterSoLoud(),
+    ),
+  );
+}
+
+/// Simple usecase of flutter_soloud plugin
+class HelloFlutterSoLoud extends StatefulWidget {
+  const HelloFlutterSoLoud({super.key});
+
+  @override
+  State<HelloFlutterSoLoud> createState() => _HelloFlutterSoLoudState();
+}
+
+class _HelloFlutterSoLoudState extends State<HelloFlutterSoLoud> {
+  late TextEditingController textEditingController;
+  late final List<PlaybackDevice> devices;
+  late PlaybackDevice currentDevice;
+  AudioSource? currentSound;
+
+  @override
+  void initState() {
+    super.initState();
+    SoLoud.instance.loadAsset('assets/audio/8_bit_mentality.mp3').then((value) {
+      currentSound = value;
+      SoLoud.instance.play(currentSound!, looping: true, volume: 0.5);
+    });
+
+    devices = SoLoud.instance.listPlaybackDevices();
+    assert(devices.isNotEmpty, 'No devices found!');
+
+    currentDevice = devices.firstWhere(
+      (d) => d.isDefault,
+      orElse: () => devices.first,
+    );
+    textEditingController = TextEditingController(text: currentDevice.name);
+  }
+
+  @override
+  void dispose() {
+    SoLoud.instance.deinit();
+    super.dispose();
+  }
+
+  @override
+  Widget build(BuildContext context) {
+    if (!SoLoud.instance.isInitialized) return const SizedBox.shrink();
+
+    return Scaffold(
+      body: Center(
+        child: DropdownMenu(
+          controller: textEditingController,
+          onSelected: (value) {
+            SoLoud.instance.changeDevice(newDevice: devices[value!]);
+          },
+          dropdownMenuEntries: [
+            for (var i = 0; i < devices.length; i++)
+              DropdownMenuEntry(
+                value: i,
+                label: '(${devices[i].id}) - ${devices[i].name}',
+              ),
+          ],
+        ),
+      ),
+    );
+  }
+}

example/lib/wave_data/wave_data.dart

@@ -7,6 +7,9 @@ import 'package:flutter/material.dart';
 import 'package:flutter_soloud/flutter_soloud.dart';
 import 'package:logging/logging.dart';
 
+/// Waveform example.
+///
+/// This example demonstrates how read audio samples from a wave file.
 void main() async {
   // The `flutter_soloud` package logs everything
   // (from severe warnings to fine debug messages)
@@ -68,7 +71,7 @@ class _HelloFlutterSoLoudState extends State<HelloFlutterSoLoud> {
           children: [
             const SizedBox(height: 16),
             const Text(
-              'Read N audio samples (here N = width) from audio file.',
+              'Read N audio samples (here N = width*4) from audio file.',
             ),
             OutlinedButton(
               onPressed: () async {

example/lib/waveform/waveform.dart

@@ -7,6 +7,8 @@ import 'package:logging/logging.dart';
 
 /// Waveform example.
 ///
+/// This example demonstrates how to generate a waveform, play it, and change
+/// it's frequency on the fly.
 void main() {
   // The `flutter_soloud` package logs everything
   // (from severe warnings to fine debug messages)

example/pubspec.lock

@@ -100,7 +100,7 @@ packages:
       path: ".."
       relative: true
     source: path
-    version: "2.1.5"
+    version: "2.1.7"
   flutter_test:
     dependency: "direct dev"
     description: flutter

lib/flutter_soloud.dart

@@ -8,6 +8,7 @@ export 'src/enums.dart' hide PlayerErrors, PlayerStateNotification;
 export 'src/exceptions/exceptions.dart';
 export 'src/filter_params.dart';
 export 'src/filters/filters.dart' show FilterType;
+export 'src/helpers/playback_device.dart';
 export 'src/soloud.dart';
 export 'src/sound_handle.dart';
 export 'src/sound_hash.dart';

lib/src/bindings/bindings_player.dart

@@ -4,6 +4,7 @@ import 'dart:typed_data';
 import 'package:flutter_soloud/src/bindings/audio_data.dart';
 import 'package:flutter_soloud/src/enums.dart';
 import 'package:flutter_soloud/src/filters/filters.dart';
+import 'package:flutter_soloud/src/helpers/playback_device.dart';
 import 'package:flutter_soloud/src/sound_handle.dart';
 import 'package:flutter_soloud/src/sound_hash.dart';
 import 'package:meta/meta.dart';
@@ -52,6 +53,7 @@ abstract class FlutterSoLoud {
 
   /// Initialize the player. Must be called before any other player functions.
   ///
+  /// [deviceId] the device ID. -1 for default OS output device.
   /// [sampleRate] the sample rate. Usually is 22050, 44100 (CD quality)
   /// or 48000.
   /// [bufferSize] the audio buffer size. Usually is 2048, but can be also be
@@ -61,11 +63,21 @@ abstract class FlutterSoLoud {
   /// Returns [PlayerErrors.noError] if success.
   @mustBeOverridden
   PlayerErrors initEngine(
+    int deviceId,
     int sampleRate,
     int bufferSize,
     Channels channels,
   );
 
+  /// Change the playback device.
+  ///
+  /// [deviceId] the device ID. -1 for default OS output device.
+  @mustBeOverridden
+  PlayerErrors changeDevice(int deviceId);
+
+  /// List available playback devices.
+  List<PlaybackDevice> listPlaybackDevices();
+
   /// Must be called when the player is no more needed or when closing the app.
   @mustBeOverridden
   void deinit();