feat: Skip track on failed sample rate changes

Adjust the error handling for failed changes of sample rate, such that
we skip the track. In addition to skipping the track, if the error is
due to sample rate changes not being supported by the current track,
then mark the track as unavailable as it will not become playable (at
least for the lifetime of the current program run).

Author: SapiensAnatis

playback/src/audio_backend/gstreamer.rs

@@ -173,7 +173,7 @@ impl Sink for GstreamerSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 
     sink_as_bytes!();

playback/src/audio_backend/jackaudio.rs

@@ -82,7 +82,7 @@ impl Sink for JackSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 }
 

playback/src/audio_backend/mod.rs

@@ -15,8 +15,8 @@ pub enum SinkError {
     InvalidParams(String),
     #[error("Audio Sink Error Changing State: {0}")]
     StateChange(String),
-    #[error("Audio Sink Error Updating Sample Rate: {0}")]
-    SampleRateChange(String),
+    #[error("Audio Sink Error Updating Sample Rate: Not Supported")]
+    SampleRateChangeNotSupported,
 }
 
 pub type SinkResult<T> = Result<T, SinkError>;

playback/src/audio_backend/pipe.rs

@@ -93,7 +93,7 @@ impl Sink for StdoutSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 
     sink_as_bytes!();

playback/src/audio_backend/portaudio.rs

@@ -175,7 +175,7 @@ impl Sink for PortAudioSink<'_> {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 }
 

playback/src/audio_backend/pulseaudio.rs

@@ -134,7 +134,7 @@ impl Sink for PulseAudioSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 
     sink_as_bytes!();

playback/src/audio_backend/rodio.rs

@@ -241,7 +241,7 @@ impl Sink for RodioSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 
     fn write(&mut self, packet: AudioPacket, converter: &mut Converter) -> SinkResult<()> {

playback/src/audio_backend/sdl.rs

@@ -116,7 +116,7 @@ impl Sink for SdlSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 }
 

playback/src/audio_backend/subprocess.rs

@@ -136,7 +136,7 @@ impl Sink for SubprocessSink {
     }
 
     fn update_sample_rate(&mut self, _new_sample_rate: u32) -> SinkResult<()> {
-        Err(SinkError::SampleRateChange("not implemented".into()))
+        Err(SinkError::SampleRateChangeNotSupported)
     }
 
     sink_as_bytes!();

playback/src/player.rs

@@ -37,12 +37,12 @@ use futures_util::{
 };
 use librespot_metadata::{audio::UniqueFields, track::Tracks};
 
+use crate::SAMPLES_PER_SECOND;
+use crate::audio_backend::SinkError;
 use symphonia::core::io::MediaSource;
 use symphonia::core::probe::Hint;
 use tokio::sync::{mpsc, oneshot};
 
-use crate::SAMPLES_PER_SECOND;
-
 const PRELOAD_NEXT_TRACK_BEFORE_END_DURATION_MS: u32 = 30000;
 pub const DB_VOLTAGE_RATIO: f64 = 20.0;
 pub const PCM_AT_0DBFS: f64 = 1.0;
@@ -1925,12 +1925,41 @@ impl PlayerInternal {
                     self.sink_sample_rate, loaded_track.sample_rate
                 );
 
-                if let Err(e) = self.sink.update_sample_rate(loaded_track.sample_rate) {
-                    error!(
-                        "Failed to update sink sample rate: {e}. Track playback may be distorted."
-                    );
-                } else {
-                    self.sink_sample_rate = loaded_track.sample_rate;
+                match self.sink.update_sample_rate(loaded_track.sample_rate) {
+                    Ok(()) => {
+                        self.sink_sample_rate = loaded_track.sample_rate;
+                    }
+                    Err(e) => {
+                        error!("{e}");
+
+                        let reaction_event = match e {
+                            SinkError::SampleRateChangeNotSupported => {
+                                // The sink does not support changing its sample rate; this track
+                                // will never be playable.
+                                PlayerEvent::Unavailable {
+                                    track_id: track_id.clone(),
+                                    play_request_id,
+                                }
+                            }
+                            _ => {
+                                // Could be a transient error; try the next track
+                                PlayerEvent::EndOfTrack {
+                                    track_id: track_id.clone(),
+                                    play_request_id,
+                                }
+                            }
+                        };
+
+                        self.send_event(reaction_event);
+
+                        self.state = PlayerState::EndOfTrack {
+                            track_id,
+                            play_request_id,
+                            loaded_track,
+                        };
+
+                        return;
+                    }
                 }
             }