// Copyright (C) 2021 OneStream Live // // This Source Code Form is subject to the terms of the Mozilla Public License, v2.0. // If a copy of the MPL was not distributed with this file, You can obtain one at // . // // SPDX-License-Identifier: MPL-2.0 use std::{ collections::{HashMap, VecDeque}, sync::{Arc, Mutex, MutexGuard}, }; use gst::glib; use gst::prelude::*; use gst::subclass::prelude::*; use once_cell::sync::Lazy; static CAT: Lazy = Lazy::new(|| { gst::DebugCategory::new( "uriplaylistbin", gst::DebugColorFlags::empty(), Some("Uri Playlist Bin"), ) }); #[derive(Debug, thiserror::Error)] enum PlaylistError { #[error("plugin missing: {error}")] PluginMissing { error: anyhow::Error }, } #[derive(Debug, Clone)] struct Settings { uris: Vec, iterations: u32, } impl Default for Settings { fn default() -> Self { Self { uris: vec![], iterations: 1, } } } #[derive(Debug)] struct State { uridecodebin: gst::Element, playlist: Playlist, /// next current items, updated when uridecodebin updates its current-uri property pending_current_items: VecDeque>, current_item: Option, /// key are src pads from uridecodebin pads: HashMap, // read-only properties current_iteration: u32, current_uri_index: u64, } #[derive(Debug)] struct Pads { /// requested streamsynchronizer sink pad ss_sink: gst::Pad, /// ghost pad of the associated src pad ghost_src: gst::GhostPad, } impl State { fn new(uris: Vec, iterations: u32, uridecodebin: gst::Element) -> Self { Self { uridecodebin, playlist: Playlist::new(uris, iterations), pending_current_items: VecDeque::new(), current_item: None, pads: HashMap::new(), current_iteration: 0, current_uri_index: 0, } } } #[derive(Default)] pub struct UriPlaylistBin { settings: Mutex, state: Mutex>, } #[derive(Debug, Clone)] struct Item { inner: Arc>, } impl Item { fn new(uri: String, index: usize) -> Self { let inner = ItemInner { uri, index }; Self { inner: Arc::new(Mutex::new(inner)), } } fn uri(&self) -> String { let inner = self.inner.lock().unwrap(); inner.uri.clone() } fn index(&self) -> usize { let inner = self.inner.lock().unwrap(); inner.index } } #[derive(Debug, Clone)] struct ItemInner { uri: String, index: usize, } struct Playlist { items: Box + Send>, uris: Vec, } impl Playlist { fn new(uris: Vec, iterations: u32) -> Self { Self { items: Self::create_items(uris.clone(), iterations), uris, } } fn create_items( uris: Vec, iterations: u32, ) -> Box + Send + Sync> { fn infinite_iter(uris: Vec) -> Box + Send + Sync> { Box::new( uris.into_iter() .cycle() .enumerate() .map(|(index, uri)| Item::new(uri, index)), ) } fn finite_iter( uris: Vec, iterations: u32, ) -> Box + Send + Sync> { let n = (iterations as usize) .checked_mul(uris.len()) .unwrap_or(usize::MAX); Box::new( uris.into_iter() .cycle() .take(n) .enumerate() .map(|(index, uri)| Item::new(uri, index)), ) } if iterations == 0 { infinite_iter(uris) } else { finite_iter(uris, iterations) } } fn next(&mut self) -> Option { let item = match self.items.next() { None => return None, Some(item) => item, }; if item.index() == usize::MAX { // prevent overflow with infinite playlist self.items = Self::create_items(self.uris.clone(), 0); } Some(item) } } impl std::fmt::Debug for Playlist { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { f.debug_struct("Playlist") .field("uris", &self.uris) .finish() } } #[glib::object_subclass] impl ObjectSubclass for UriPlaylistBin { const NAME: &'static str = "GstUriPlaylistBin"; type Type = super::UriPlaylistBin; type ParentType = gst::Bin; } impl ObjectImpl for UriPlaylistBin { fn properties() -> &'static [glib::ParamSpec] { static PROPERTIES: Lazy> = Lazy::new(|| { vec![ glib::ParamSpecBoxed::builder::>("uris") .nick("URIs") .blurb("URIs of the medias to play") .mutable_ready() .build(), glib::ParamSpecUInt::builder("iterations") .nick("Iterations") .blurb("Number of time the playlist items should be played each (0 = unlimited)") .default_value(1) .mutable_ready() .build(), glib::ParamSpecUInt::builder("current-iteration") .nick("Current iteration") .blurb("The index of the current playlist iteration, or 0 if the iterations property is 0 (unlimited playlist)") .read_only() .build(), glib::ParamSpecUInt64::builder("current-uri-index") .nick("Current URI") .blurb("The index from the uris property of the current URI being played") .read_only() .build(), ] }); PROPERTIES.as_ref() } fn set_property(&self, _id: usize, value: &glib::Value, pspec: &glib::ParamSpec) { match pspec.name() { "uris" => { let mut settings = self.settings.lock().unwrap(); let new_value = value.get().expect("type checked upstream"); gst::info!( CAT, imp: self, "Changing uris from {:?} to {:?}", settings.uris, new_value, ); settings.uris = new_value; } "iterations" => { let mut settings = self.settings.lock().unwrap(); let new_value = value.get().expect("type checked upstream"); gst::info!( CAT, imp: self, "Changing iterations from {:?} to {:?}", settings.iterations, new_value, ); settings.iterations = new_value; } _ => unimplemented!(), } } fn property(&self, _id: usize, pspec: &glib::ParamSpec) -> glib::Value { match pspec.name() { "uris" => { let settings = self.settings.lock().unwrap(); settings.uris.to_value() } "iterations" => { let settings = self.settings.lock().unwrap(); settings.iterations.to_value() } "current-iteration" => { let state = self.state.lock().unwrap(); state .as_ref() .map(|state| state.current_iteration) .unwrap_or(0) .to_value() } "current-uri-index" => { let state = self.state.lock().unwrap(); state .as_ref() .map(|state| state.current_uri_index) .unwrap_or(0) .to_value() } _ => unimplemented!(), } } fn constructed(&self) { self.parent_constructed(); let obj = self.obj(); obj.set_suppressed_flags(gst::ElementFlags::SOURCE | gst::ElementFlags::SINK); obj.set_element_flags(gst::ElementFlags::SOURCE); } } impl GstObjectImpl for UriPlaylistBin {} impl BinImpl for UriPlaylistBin { fn handle_message(&self, msg: gst::Message) { match msg.view() { gst::MessageView::Error(err) => { let item = { let state_guard = self.state.lock().unwrap(); let state = state_guard.as_ref().unwrap(); // uridecodebin likely failed because of the last URI we set match state.pending_current_items.iter().last() { Some(Some(item)) => Some(item.clone()), _ => state.current_item.clone(), } }; if let Some(item) = item { // add the URI of the failed item let txt = format!( "Error when processing item #{} ({}): {}", item.index(), item.uri(), err.error() ); let mut details = err .details() .map_or(gst::Structure::new_empty("details"), |s| s.to_owned()); details.set("uri", item.uri()); let msg = gst::message::Error::builder(gst::LibraryError::Failed, &txt) .details(details) .build(); self.parent_handle_message(msg) } else { self.parent_handle_message(msg) } } _ => self.parent_handle_message(msg), } } } impl ElementImpl for UriPlaylistBin { fn metadata() -> Option<&'static gst::subclass::ElementMetadata> { static ELEMENT_METADATA: Lazy = Lazy::new(|| { gst::subclass::ElementMetadata::new( "Playlist Source", "Generic/Source", "Sequentially play uri streams", "Guillaume Desmottes ", ) }); Some(&*ELEMENT_METADATA) } fn pad_templates() -> &'static [gst::PadTemplate] { static PAD_TEMPLATES: Lazy> = Lazy::new(|| { let audio_src_pad_template = gst::PadTemplate::new( "audio_%u", gst::PadDirection::Src, gst::PadPresence::Sometimes, &gst::Caps::new_any(), ) .unwrap(); let video_src_pad_template = gst::PadTemplate::new( "video_%u", gst::PadDirection::Src, gst::PadPresence::Sometimes, &gst::Caps::new_any(), ) .unwrap(); let text_src_pad_template = gst::PadTemplate::new( "text_%u", gst::PadDirection::Src, gst::PadPresence::Sometimes, &gst::Caps::new_any(), ) .unwrap(); vec![ audio_src_pad_template, video_src_pad_template, text_src_pad_template, ] }); PAD_TEMPLATES.as_ref() } fn change_state( &self, transition: gst::StateChange, ) -> Result { if transition == gst::StateChange::NullToReady { if let Err(e) = self.start() { self.failed(e); return Err(gst::StateChangeError); } } let res = self.parent_change_state(transition); if transition == gst::StateChange::ReadyToNull { self.stop(); } res } } impl UriPlaylistBin { fn start(&self) -> Result<(), PlaylistError> { gst::debug!(CAT, imp: self, "Starting"); { let mut state_guard = self.state.lock().unwrap(); assert!(state_guard.is_none()); let uridecodebin = gst::ElementFactory::make("uridecodebin3") .name("playlist-uridecodebin") .build() .map_err(|e| PlaylistError::PluginMissing { error: e.into() })?; let streamsynchronizer = gst::ElementFactory::make("streamsynchronizer") .name("playlist-streamsynchronizer") .build() .map_err(|e| PlaylistError::PluginMissing { error: e.into() })?; self.obj().add(&uridecodebin).unwrap(); self.obj().add(&streamsynchronizer).unwrap(); let bin_weak = self.obj().downgrade(); let streamsynchronizer_clone = streamsynchronizer.clone(); uridecodebin.connect_pad_added(move |_uridecodebin, src_pad| { let Some(bin) = bin_weak.upgrade() else { return; }; gst::debug!( CAT, obj: bin, "uridecodebin src pad added: {}", src_pad.name() ); // connect the pad to streamsynchronizer let ss_sink = streamsynchronizer_clone .request_pad_simple("sink_%u") .unwrap(); src_pad.link(&ss_sink).unwrap(); let src_pad_name = ss_sink.name().to_string().replace("sink", "src"); // ghost the associated streamsynchronizer src pad let ss_src = streamsynchronizer_clone.static_pad(&src_pad_name).unwrap(); let ghost_src = gst::GhostPad::builder_with_target(&ss_src) .unwrap() .name(src_pad.name().as_str()) .build(); ghost_src.set_active(true).unwrap(); bin.add_pad(&ghost_src).unwrap(); { let mut state_guard = bin.imp().state.lock().unwrap(); let state = state_guard.as_mut().unwrap(); state .pads .insert(src_pad.clone(), Pads { ss_sink, ghost_src }); } }); let bin_weak = self.obj().downgrade(); uridecodebin.connect_pad_removed(move |_uridecodebin, src_pad| { let Some(bin) = bin_weak.upgrade() else { return; }; gst::debug!( CAT, obj: bin, "uridecodebin src pad removed: {}", src_pad.name() ); { let mut state_guard = bin.imp().state.lock().unwrap(); let state = state_guard.as_mut().unwrap(); if let Some(pads) = state.pads.remove(src_pad) { streamsynchronizer.release_request_pad(&pads.ss_sink); pads.ghost_src.set_active(false).unwrap(); let _ = pads.ghost_src.set_target(None::<&gst::Pad>); let _ = bin.remove_pad(&pads.ghost_src); } } }); let bin_weak = self.obj().downgrade(); uridecodebin.connect("about-to-finish", false, move |_args| { let bin = bin_weak.upgrade()?; let self_ = bin.imp(); gst::debug!(CAT, obj: bin, "current URI about to finish"); let _ = self_.start_next_item(); None }); let bin_weak = self.obj().downgrade(); uridecodebin.connect_notify(Some("current-uri"), move |_uridecodebin, _param| { // new current URI, update pending current item if needed let Some(bin) = bin_weak.upgrade() else { return; }; let self_ = bin.imp(); let mut state_guard = self_.state.lock().unwrap(); let state = state_guard.as_mut().unwrap(); if let Some(new_current_item) = state.pending_current_items.pop_front() { self_.update_current(state_guard, new_current_item); } }); let settings = self.settings.lock().unwrap(); *state_guard = Some(State::new( settings.uris.clone(), settings.iterations, uridecodebin, )); } self.start_next_item()?; Ok(()) } fn start_next_item(&self) -> Result<(), PlaylistError> { let mut state_guard = self.state.lock().unwrap(); let state = state_guard.as_mut().unwrap(); let item = match state.playlist.next() { Some(item) => item, None => { gst::debug!(CAT, imp: self, "no more item to queue",); state.pending_current_items.push_back(None); return Ok(()); } }; gst::debug!( CAT, imp: self, "start next item #{}: {}", item.index(), item.uri() ); // don't hold the mutex when updating `uri` to prevent deadlocks. let uridecodebin = state.uridecodebin.clone(); let uri = item.uri(); state.pending_current_items.push_back(Some(item)); drop(state_guard); uridecodebin.set_property("uri", uri); Ok(()) } fn update_current(&self, mut state_guard: MutexGuard>, current: Option) { let (uris_len, infinite) = { let settings = self.settings.lock().unwrap(); (settings.uris.len(), settings.iterations == 0) }; if let Some(state) = state_guard.as_mut() { state.current_item = current; if let Some(current) = state.current_item.as_ref() { let (mut current_iteration, current_uri_index) = ( (current.index() / uris_len) as u32, (current.index() % uris_len) as u64, ); if infinite { current_iteration = 0; } let element = self.obj(); let mut notify_iteration = false; let mut notify_index = false; if current_iteration != state.current_iteration { state.current_iteration = current_iteration; notify_iteration = true; } if current_uri_index != state.current_uri_index { state.current_uri_index = current_uri_index; notify_index = true; } // drop mutex before notifying changes as the callback will likely try to fetch the updated values // which would deadlock. drop(state_guard); if notify_iteration { element.notify("current-iteration"); } if notify_index { element.notify("current-uri-index"); } } } } fn failed(&self, error: PlaylistError) { let error_msg = error.to_string(); gst::error!(CAT, imp: self, "{}", error_msg); match error { PlaylistError::PluginMissing { .. } => { gst::element_imp_error!(self, gst::CoreError::MissingPlugin, ["{}", &error_msg]); } } self.update_current(self.state.lock().unwrap(), None); } fn stop(&self) { // remove all children and pads let children = self.obj().children(); let children_ref = children.iter().collect::>(); self.obj().remove_many(children_ref).unwrap(); for pad in self.obj().src_pads() { self.obj().remove_pad(&pad).unwrap(); } let mut state_guard = self.state.lock().unwrap(); *state_guard = None; } }