add spotify plugin

Plugin adding an element to play audio from Spotify.

8 files changed, 556 insertions, 0 deletions

diff --git a/audio/spotify/Cargo.toml b/audio/spotify/Cargo.toml
new file mode 100644
index 000000000..c47675e4b
--- /dev/null
+++ b/audio/spotify/Cargo.toml
@@ -0,0 +1,44 @@
+[package]
+name = "gst-plugin-spotify"
+version = "0.8.0"
+authors = ["Guillaume Desmottes <guillaume@desmottes.be>"]
+repository = "https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs"
+license = "MIT/Apache-2.0"
+description = "Spotify GStreamer Plugin"
+edition = "2021"
+rust-version = "1.56"
+
+[dependencies]
+gst = { package = "gstreamer", git = "https://gitlab.freedesktop.org/gstreamer/gstreamer-rs" }
+gst-base = { package = "gstreamer-base", git = "https://gitlab.freedesktop.org/gstreamer/gstreamer-rs" }
+once_cell = "1.0"
+librespot = { version = "0.3", default-features = false }
+tokio = "1.0"
+futures = "0.3"
+anyhow = "1.0"
+
+[lib]
+name = "gstspotify"
+crate-type = ["cdylib", "rlib"]
+path = "src/lib.rs"
+
+[build-dependencies]
+gst-plugin-version-helper = { path="../../version-helper" }
+
+[features]
+# GStreamer 1.14 is required for static linking
+static = ["gst/v1_14"]
+capi = []
+
+[package.metadata.capi]
+min_version = "0.8.0"
+
+[package.metadata.capi.header]
+enabled = false
+
+[package.metadata.capi.library]
+install_subdir = "gstreamer-1.0"
+versioning = false
+
+[package.metadata.capi.pkg_config]
+requires_private = "gstreamer-1.0, gstreamer-base-1.0, gobject-2.0, glib-2.0, gmodule-2.0"
diff --git a/audio/spotify/LICENSE-APACHE b/audio/spotify/LICENSE-APACHE
new file mode 120000
index 000000000..1cd601d0a
--- /dev/null
+++ b/audio/spotify/LICENSE-APACHE
@@ -0,0 +1 @@
+../../LICENSE-APACHE
\ No newline at end of file
diff --git a/audio/spotify/LICENSE-MIT b/audio/spotify/LICENSE-MIT
new file mode 120000
index 000000000..b2cfbdc7b
--- /dev/null
+++ b/audio/spotify/LICENSE-MIT
@@ -0,0 +1 @@
+../../LICENSE-MIT
\ No newline at end of file
diff --git a/audio/spotify/README.md b/audio/spotify/README.md
new file mode 100644
index 000000000..aa8424dc2
--- /dev/null
+++ b/audio/spotify/README.md
@@ -0,0 +1,24 @@
+# gst-plugins-spotify
+
+This is a [GStreamer](https://gstreamer.freedesktop.org/) plugin to read content from
+[Spotify](https://www.spotify.com/).
+
+Make sure that your application follows [Spotify's design guidelines](https://developer.spotify.com/documentation/general/design-and-branding/)
+to respect their legal/licensing restrictions.
+
+## Spotify Credentials
+
+This plugin requires a [Spotify Premium](https://www.spotify.com/premium/) account configured
+with a [device password](https://www.spotify.com/us/account/set-device-password/).
+
+You can then set the device username and password using the `username` and `password` properties.
+
+You may also want to cache credentials and downloaded files, see the `cache-` properties on the element.
+
+## spotifyaudiosrc
+
+The `spotifyaudiosrc` element can be used to play a song from Spotify using its [Spotify URI](https://community.spotify.com/t5/FAQs/What-s-a-Spotify-URI/ta-p/919201).
+
+```
+gst-launch-1.0 spotifyaudiosrc username=$USERNAME password=$PASSWORD track=spotify:track:3i3P1mGpV9eRlfKccjDjwi ! oggdemux ! vorbisdec ! audioconvert ! autoaudiosink
+```
\ No newline at end of file
diff --git a/audio/spotify/build.rs b/audio/spotify/build.rs
new file mode 100644
index 000000000..cda12e57e
--- /dev/null
+++ b/audio/spotify/build.rs
@@ -0,0 +1,3 @@
+fn main() {
+    gst_plugin_version_helper::info()
+}
diff --git a/audio/spotify/src/lib.rs b/audio/spotify/src/lib.rs
new file mode 100644
index 000000000..fdd6dedb3
--- /dev/null
+++ b/audio/spotify/src/lib.rs
@@ -0,0 +1,28 @@
+// Copyright (C) 2021 Guillaume Desmottes <guillaume@desmottes.be>
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use gst::glib;
+
+mod spotifyaudiosrc;
+
+fn plugin_init(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    spotifyaudiosrc::register(plugin)?;
+    Ok(())
+}
+
+gst::plugin_define!(
+    spotify,
+    env!("CARGO_PKG_DESCRIPTION"),
+    plugin_init,
+    concat!(env!("CARGO_PKG_VERSION"), "-", env!("COMMIT_ID")),
+    "MIT/X11",
+    env!("CARGO_PKG_NAME"),
+    env!("CARGO_PKG_NAME"),
+    env!("CARGO_PKG_REPOSITORY"),
+    env!("BUILD_REL_DATE")
+);
diff --git a/audio/spotify/src/spotifyaudiosrc/imp.rs b/audio/spotify/src/spotifyaudiosrc/imp.rs
new file mode 100644
index 000000000..f8991e54e
--- /dev/null
+++ b/audio/spotify/src/spotifyaudiosrc/imp.rs
@@ -0,0 +1,425 @@
+// Copyright (C) 2021 Guillaume Desmottes <guillaume@desmottes.be>
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use std::sync::{mpsc, Arc, Mutex};
+
+use anyhow::bail;
+use once_cell::sync::Lazy;
+use tokio::{runtime, task::JoinHandle};
+
+use gst::glib;
+use gst::prelude::*;
+use gst::subclass::prelude::*;
+use gst::{gst_debug, gst_error, gst_log};
+use gst_base::subclass::{base_src::CreateSuccess, prelude::*};
+
+use librespot::core::{
+    cache::Cache, config::SessionConfig, session::Session, spotify_id::SpotifyId,
+};
+use librespot::discovery::Credentials;
+use librespot::playback::{
+    audio_backend::{Sink, SinkResult},
+    config::PlayerConfig,
+    convert::Converter,
+    decoder::AudioPacket,
+    player::{Player, PlayerEvent},
+};
+
+static CAT: Lazy<gst::DebugCategory> = Lazy::new(|| {
+    gst::DebugCategory::new(
+        "spotifyaudiosrc",
+        gst::DebugColorFlags::empty(),
+        Some("Spotify audio source"),
+    )
+});
+
+static RUNTIME: Lazy<runtime::Runtime> = Lazy::new(|| {
+    runtime::Builder::new_multi_thread()
+        .enable_all()
+        .worker_threads(1)
+        .build()
+        .unwrap()
+});
+
+/// Messages from the librespot thread
+enum Message {
+    Buffer(gst::Buffer),
+    Eos,
+    Unavailable,
+}
+
+struct State {
+    player: Player,
+
+    /// receiver sending buffer to streaming thread
+    receiver: mpsc::Receiver<Message>,
+    /// thread receiving player events from librespot
+    player_channel_handle: JoinHandle<()>,
+}
+
+#[derive(Default)]
+struct Settings {
+    username: String,
+    password: String,
+    cache_credentials: String,
+    cache_files: String,
+    cache_max_size: u64,
+    track: String,
+}
+
+#[derive(Default)]
+pub struct SpotifyAudioSrc {
+    state: Arc<Mutex<Option<State>>>,
+    settings: Mutex<Settings>,
+}
+
+#[glib::object_subclass]
+impl ObjectSubclass for SpotifyAudioSrc {
+    const NAME: &'static str = "GstSpotifyAudioSrc";
+    type Type = super::SpotifyAudioSrc;
+    type ParentType = gst_base::BaseSrc;
+}
+
+impl ObjectImpl for SpotifyAudioSrc {
+    fn properties() -> &'static [glib::ParamSpec] {
+        static PROPERTIES: Lazy<Vec<glib::ParamSpec>> = Lazy::new(|| {
+            vec![glib::ParamSpecString::new(
+                    "username",
+                    "Username",
+                    "Spotify device username from https://www.spotify.com/us/account/set-device-password/",
+                    Some(""),
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+                glib::ParamSpecString::new(
+                    "password",
+                    "Password",
+                    "Spotify device password from https://www.spotify.com/us/account/set-device-password/",
+                    Some(""),
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+                glib::ParamSpecString::new(
+                    "cache-credentials",
+                    "Credentials cache",
+                    "Directory where to cache Spotify credentials",
+                    Some(""),
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+                glib::ParamSpecString::new(
+                    "cache-files",
+                    "Files cache",
+                    "Directory where to cache downloaded files from Spotify",
+                    Some(""),
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+                glib::ParamSpecUInt64::new(
+                    "cache-max-size",
+                    "Cache max size",
+                    "The max allowed size of the cache, in bytes, or 0 to disable the cache limit",
+                    0, u64::MAX, 0,
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+                glib::ParamSpecString::new(
+                    "track",
+                    "Spotify URI",
+                    "Spotify track URI, in the form 'spotify:track:$SPOTIFY_ID'",
+                    Some(""),
+                    glib::ParamFlags::READWRITE | gst::PARAM_FLAG_MUTABLE_READY,
+                ),
+            ]
+        });
+
+        PROPERTIES.as_ref()
+    }
+
+    fn set_property(
+        &self,
+        _obj: &Self::Type,
+        _id: usize,
+        value: &glib::Value,
+        pspec: &glib::ParamSpec,
+    ) {
+        match pspec.name() {
+            "username" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.username = value.get().expect("type checked upstream");
+            }
+            "password" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.password = value.get().expect("type checked upstream");
+            }
+            "cache-credentials" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.cache_credentials = value.get().expect("type checked upstream");
+            }
+            "cache-files" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.cache_files = value.get().expect("type checked upstream");
+            }
+            "cache-max-size" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.cache_max_size = value.get().expect("type checked upstream");
+            }
+            "track" => {
+                let mut settings = self.settings.lock().unwrap();
+                settings.track = value.get().expect("type checked upstream");
+            }
+            _ => unimplemented!(),
+        }
+    }
+
+    fn property(&self, _obj: &Self::Type, _id: usize, pspec: &glib::ParamSpec) -> glib::Value {
+        match pspec.name() {
+            "username" => {
+                let settings = self.settings.lock().unwrap();
+                settings.username.to_value()
+            }
+            "password" => {
+                let settings = self.settings.lock().unwrap();
+                settings.password.to_value()
+            }
+            "cache-credentials" => {
+                let settings = self.settings.lock().unwrap();
+                settings.cache_credentials.to_value()
+            }
+            "cache-files" => {
+                let settings = self.settings.lock().unwrap();
+                settings.cache_files.to_value()
+            }
+            "cache-max-size" => {
+                let settings = self.settings.lock().unwrap();
+                settings.cache_max_size.to_value()
+            }
+            "track" => {
+                let settings = self.settings.lock().unwrap();
+                settings.track.to_value()
+            }
+            _ => unimplemented!(),
+        }
+    }
+}
+
+impl GstObjectImpl for SpotifyAudioSrc {}
+
+impl ElementImpl for SpotifyAudioSrc {
+    fn metadata() -> Option<&'static gst::subclass::ElementMetadata> {
+        static ELEMENT_METADATA: Lazy<gst::subclass::ElementMetadata> = Lazy::new(|| {
+            gst::subclass::ElementMetadata::new(
+                "Spotify source",
+                "Source/Audio",
+                "Spotify source",
+                "Guillaume Desmottes <guillaume@desmottes.be>",
+            )
+        });
+
+        Some(&*ELEMENT_METADATA)
+    }
+
+    fn pad_templates() -> &'static [gst::PadTemplate] {
+        static PAD_TEMPLATES: Lazy<Vec<gst::PadTemplate>> = Lazy::new(|| {
+            let caps = gst::Caps::builder("application/ogg").build();
+
+            let src_pad_template = gst::PadTemplate::new(
+                "src",
+                gst::PadDirection::Src,
+                gst::PadPresence::Always,
+                &caps,
+            )
+            .unwrap();
+
+            vec![src_pad_template]
+        });
+
+        PAD_TEMPLATES.as_ref()
+    }
+}
+
+impl BaseSrcImpl for SpotifyAudioSrc {
+    fn start(&self, src: &Self::Type) -> Result<(), gst::ErrorMessage> {
+        {
+            let state = self.state.lock().unwrap();
+            if state.is_some() {
+                // already started
+                return Ok(());
+            }
+        }
+
+        if let Err(err) = RUNTIME.block_on(async move { self.setup().await }) {
+            let details = format!("{:?}", err);
+            gst::element_error!(src, gst::ResourceError::Settings, [&details]);
+            return Err(gst::error_msg!(gst::ResourceError::Settings, [&details]));
+        }
+
+        Ok(())
+    }
+
+    fn stop(&self, src: &Self::Type) -> Result<(), gst::ErrorMessage> {
+        if let Some(state) = self.state.lock().unwrap().take() {
+            gst_debug!(CAT, obj: src, "stopping");
+            state.player.stop();
+            state.player_channel_handle.abort();
+            // FIXME: not sure why this is needed to unblock BufferSink::write(), dropping State should drop the receiver
+            drop(state.receiver);
+        }
+
+        Ok(())
+    }
+
+    fn create(
+        &self,
+        src: &Self::Type,
+        _offset: u64,
+        _buffer: Option<&mut gst::BufferRef>,
+        _length: u32,
+    ) -> Result<CreateSuccess, gst::FlowError> {
+        let state = self.state.lock().unwrap();
+        let state = state.as_ref().unwrap();
+
+        match state.receiver.recv().unwrap() {
+            Message::Buffer(buffer) => {
+                gst_log!(CAT, obj: src, "got buffer of size {}", buffer.size());
+                Ok(CreateSuccess::NewBuffer(buffer))
+            }
+            Message::Eos => {
+                gst_debug!(CAT, obj: src, "eos");
+                Err(gst::FlowError::Eos)
+            }
+            Message::Unavailable => {
+                gst_error!(CAT, obj: src, "track is not available");
+                gst::element_error!(
+                    src,
+                    gst::ResourceError::NotFound,
+                    ["track is not available"]
+                );
+                Err(gst::FlowError::Error)
+            }
+        }
+    }
+}
+
+impl SpotifyAudioSrc {
+    async fn setup(&self) -> anyhow::Result<()> {
+        let src = self.instance();
+
+        let (credentials, cache, track) = {
+            let settings = self.settings.lock().unwrap();
+
+            let credentials_cache = if settings.cache_credentials.is_empty() {
+                None
+            } else {
+                Some(&settings.cache_credentials)
+            };
+
+            let files_cache = if settings.cache_files.is_empty() {
+                None
+            } else {
+                Some(&settings.cache_files)
+            };
+
+            let max_size = if settings.cache_max_size != 0 {
+                Some(settings.cache_max_size)
+            } else {
+                None
+            };
+
+            let cache = Cache::new(credentials_cache, files_cache, max_size)?;
+
+            let credentials = match cache.credentials() {
+                Some(cached_cred) => {
+                    gst_debug!(CAT, obj: &src, "reuse credentials from cache",);
+                    cached_cred
+                }
+                None => {
+                    gst_debug!(CAT, obj: &src, "credentials not in cache",);
+
+                    if settings.username.is_empty() {
+                        bail!("username is not set and credentials are not in cache");
+                    }
+                    if settings.password.is_empty() {
+                        bail!("password is not set and credentials are not in cache");
+                    }
+
+                    let cred = Credentials::with_password(&settings.username, &settings.password);
+                    cache.save_credentials(&cred);
+                    cred
+                }
+            };
+
+            if settings.track.is_empty() {
+                bail!("track is not set")
+            }
+
+            (credentials, cache, settings.track.clone())
+        };
+
+        let state = self.state.clone();
+
+        let session = Session::connect(SessionConfig::default(), credentials, Some(cache)).await?;
+
+        let player_config = PlayerConfig {
+            passthrough: true,
+            ..Default::default()
+        };
+
+        // use a sync channel to prevent buffering the whole track inside the channel
+        let (sender, receiver) = mpsc::sync_channel(2);
+        let sender_clone = sender.clone();
+
+        let (mut player, mut player_event_channel) =
+            Player::new(player_config, session, None, || {
+                Box::new(BufferSink { sender })
+            });
+
+        let track = match SpotifyId::from_uri(&track) {
+            Ok(track) => track,
+            Err(_) => bail!("Failed to create Spotify URI from track"),
+        };
+
+        player.load(track, true, 0);
+
+        let player_channel_handle = RUNTIME.spawn(async move {
+            let sender = sender_clone;
+
+            while let Some(event) = player_event_channel.recv().await {
+                match event {
+                    PlayerEvent::EndOfTrack { .. } => {
+                        let _ = sender.send(Message::Eos);
+                    }
+                    PlayerEvent::Unavailable { .. } => {
+                        let _ = sender.send(Message::Unavailable);
+                    }
+                    _ => {}
+                }
+            }
+        });
+
+        let mut state = state.lock().unwrap();
+        state.replace(State {
+            player,
+            receiver,
+            player_channel_handle,
+        });
+
+        Ok(())
+    }
+}
+
+struct BufferSink {
+    sender: mpsc::SyncSender<Message>,
+}
+
+impl Sink for BufferSink {
+    fn write(&mut self, packet: &AudioPacket, _converter: &mut Converter) -> SinkResult<()> {
+        let ogg = packet.oggdata().unwrap();
+        let buffer = gst::Buffer::from_slice(Vec::from(ogg));
+
+        // ignore if sending fails as that means the source element is being shutdown
+        let _ = self.sender.send(Message::Buffer(buffer));
+
+        Ok(())
+    }
+}
diff --git a/audio/spotify/src/spotifyaudiosrc/mod.rs b/audio/spotify/src/spotifyaudiosrc/mod.rs
new file mode 100644
index 000000000..9ad5e3517
--- /dev/null
+++ b/audio/spotify/src/spotifyaudiosrc/mod.rs
@@ -0,0 +1,30 @@
+// Copyright (C) 2021 Guillaume Desmottes <guillaume@desmottes.be>
+//
+// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
+// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
+// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
+// option. This file may not be copied, modified, or distributed
+// except according to those terms.
+
+use gst::glib;
+use gst::prelude::*;
+
+mod imp;
+
+glib::wrapper! {
+    pub struct SpotifyAudioSrc(ObjectSubclass<imp::SpotifyAudioSrc>) @extends gst_base::BaseSrc, gst::Element, gst::Object;
+}
+
+// GStreamer elements need to be thread-safe. For the private implementation this is automatically
+// enforced but for the public wrapper type we need to specify this manually.
+unsafe impl Send for SpotifyAudioSrc {}
+unsafe impl Sync for SpotifyAudioSrc {}
+
+pub fn register(plugin: &gst::Plugin) -> Result<(), glib::BoolError> {
+    gst::Element::register(
+        Some(plugin),
+        "spotifyaudiosrc",
+        gst::Rank::Primary,
+        SpotifyAudioSrc::static_type(),
+    )
+}