fix: improve device id, cf. #356

Author: b-ma

.pre-commit-config.yaml

@@ -64,7 +64,7 @@ repos:
             --locked,
             --workspace,
             --features,
-            cubeb,
+            cpal,
             --all-targets,
             --,
             -D,
@@ -83,7 +83,7 @@ repos:
             --locked,
             --workspace,
             --features,
-            cubeb,
+            cpal,
             --no-deps,
             --document-private-items,
           ]

src/io/cpal.rs

@@ -8,18 +8,17 @@ use cpal::{
     BuildStreamError, Device, OutputCallbackInfo, SampleFormat, Stream, StreamConfig,
     SupportedBufferSize,
 };
+use crossbeam_channel::Receiver;
 
 use super::{AudioBackendManager, RenderThreadInit};
 
 use crate::buffer::AudioBuffer;
 use crate::context::AudioContextOptions;
 use crate::io::microphone::MicrophoneRender;
-use crate::media_devices::{MediaDeviceInfo, MediaDeviceInfoKind};
+use crate::media_devices::{create_device_id, MediaDeviceInfo, MediaDeviceInfoKind};
 use crate::render::RenderThread;
 use crate::{AtomicF64, MAX_CHANNELS};
 
-use crossbeam_channel::Receiver;
-
 // I doubt this construct is entirely safe. Stream is not Send/Sync (probably for a good reason) so
 // it should be managed from a single thread instead.
 // <https://github.com/orottier/web-audio-api-rs/issues/357>
@@ -403,29 +402,49 @@ impl AudioBackendManager for CpalBackend {
     {
         let host = get_host();
 
-        let input_devices = host
-            .input_devices()
-            .unwrap()
-            .map(|d| (d, MediaDeviceInfoKind::AudioInput));
-
-        let output_devices = host
-            .output_devices()
-            .unwrap()
-            .map(|d| (d, MediaDeviceInfoKind::AudioOutput));
-
-        input_devices
-            .chain(output_devices)
-            .enumerate()
-            .map(|(index, (device, kind))| {
-                MediaDeviceInfo::new(
-                    (index + 1).to_string(),
-                    None,
-                    kind,
+        let input_devices = host.input_devices().unwrap().map(|d| {
+            let num_channels = d.default_input_config().unwrap().channels();
+            (d, MediaDeviceInfoKind::AudioInput, num_channels)
+        });
+
+        let output_devices = host.output_devices().unwrap().map(|d| {
+            let num_channels = d.default_output_config().unwrap().channels();
+            (d, MediaDeviceInfoKind::AudioOutput, num_channels)
+        });
+
+        // cf. https://github.com/orottier/web-audio-api-rs/issues/356
+        let mut list = Vec::<MediaDeviceInfo>::new();
+
+        for (device, kind, num_channels) in input_devices.chain(output_devices) {
+            let mut index = 0;
+
+            loop {
+                let device_id = create_device_id(
+                    kind as u8,
+                    "cpal".to_string(),
                     device.name().unwrap(),
-                    Box::new(device),
-                )
-            })
-            .collect()
+                    num_channels,
+                    index,
+                );
+
+                if !list.iter().any(|d| d.device_id() == device_id) {
+                    let device = MediaDeviceInfo::new(
+                        device_id,
+                        None,
+                        kind,
+                        device.name().unwrap(),
+                        Box::new(device),
+                    );
+
+                    list.push(device);
+                    break;
+                } else {
+                    index += 1;
+                }
+            }
+        }
+
+        list
     }
 }
 

src/io/cubeb.rs

@@ -5,7 +5,7 @@ use super::{AudioBackendManager, RenderThreadInit};
 use crate::buffer::AudioBuffer;
 use crate::context::AudioContextOptions;
 use crate::io::microphone::MicrophoneRender;
-use crate::media_devices::{MediaDeviceInfo, MediaDeviceInfoKind};
+use crate::media_devices::{create_device_id, MediaDeviceInfo, MediaDeviceInfoKind};
 use crate::render::RenderThread;
 use crate::{MAX_CHANNELS, RENDER_QUANTUM_SIZE};
 
@@ -394,46 +394,47 @@ impl AudioBackendManager for CubebBackend {
     where
         Self: Sized,
     {
-        let mut index = 0;
+        let context = Context::init(None, None).unwrap();
 
-        let mut inputs: Vec<MediaDeviceInfo> = Context::init(None, None)
-            .unwrap()
-            .enumerate_devices(DeviceType::INPUT)
-            .unwrap()
-            .iter()
-            .map(|d| {
-                index += 1;
-
-                MediaDeviceInfo::new(
-                    format!("{}", index),
-                    d.group_id().map(str::to_string),
-                    MediaDeviceInfoKind::AudioInput,
-                    d.friendly_name().unwrap().into(),
-                    Box::new(d.devid()),
-                )
-            })
-            .collect();
+        let inputs = context.enumerate_devices(DeviceType::INPUT).unwrap();
+        let input_devices = inputs.iter().map(|d| (d, MediaDeviceInfoKind::AudioInput));
 
-        let mut outputs: Vec<MediaDeviceInfo> = Context::init(None, None)
-            .unwrap()
-            .enumerate_devices(DeviceType::OUTPUT)
-            .unwrap()
+        let outputs = context.enumerate_devices(DeviceType::OUTPUT).unwrap();
+        let output_devices = outputs
             .iter()
-            .map(|d| {
-                index += 1;
-
-                MediaDeviceInfo::new(
-                    format!("{}", index),
-                    d.group_id().map(str::to_string),
-                    MediaDeviceInfoKind::AudioOutput,
-                    d.friendly_name().unwrap().into(),
-                    Box::new(d.devid()),
-                )
-            })
-            .collect();
-
-        inputs.append(&mut outputs);
+            .map(|d| (d, MediaDeviceInfoKind::AudioOutput));
+
+        let mut list = Vec::<MediaDeviceInfo>::new();
+
+        for (device, kind) in input_devices.chain(output_devices) {
+            let mut index = 0;
+
+            loop {
+                let device_id = create_device_id(
+                    kind as u8,
+                    "cubeb".to_string(),
+                    device.friendly_name().unwrap().into(),
+                    device.max_channels().try_into().unwrap(),
+                    index,
+                );
+
+                if !list.iter().any(|d| d.device_id() == device_id) {
+                    let device = MediaDeviceInfo::new(
+                        device_id,
+                        device.group_id().map(str::to_string),
+                        kind,
+                        device.friendly_name().unwrap().into(),
+                        Box::new(device.devid()),
+                    );
+
+                    list.push(device);
+                    break;
+                } else {
+                    index += 1;
+                }
+            }
+        }
 
-        inputs
+        list
     }
 }

src/media_devices/mod.rs

@@ -4,6 +4,10 @@
 //!
 //! <https://developer.mozilla.org/en-US/docs/Web/API/MediaDevices>
 
+use std::hash::Hasher;
+
+use rustc_hash::FxHasher;
+
 use crate::context::{AudioContextLatencyCategory, AudioContextOptions};
 use crate::media_streams::MediaStream;
 
@@ -32,6 +36,19 @@ pub enum MediaDeviceInfoKind {
     AudioOutput,
 }
 
+pub(crate) fn create_device_id(
+    kind: u8,
+    host: String,
+    device_name: String,
+    num_channels: u16,
+    index: u8,
+) -> String {
+    let mut hasher = FxHasher::default();
+    let id_string = format!("{}{}{}{}{}", kind, host, device_name, num_channels, index);
+    hasher.write(id_string.as_bytes());
+    format!("{}", hasher.finish())
+}
+
 /// Describes a single media input or output device
 ///
 /// Call [`enumerate_devices_sync`] to obtain a list of devices for your hardware.