// Copyright (C) 2020 Mathieu Duponchelle // Copyright (C) 2023 Matthew Waters // // 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 gst::glib; use gst::prelude::*; use gst::subclass::prelude::*; use once_cell::sync::Lazy; use crate::cea608utils::Cea608Mode; use crate::tttocea708::translate::DEFAULT_FPS_D; use crate::tttocea708::translate::DEFAULT_FPS_N; use std::sync::Mutex; use crate::cea608utils::TextStyle; use crate::cea708utils::Cea708Mode; use crate::ttutils::{Chunk, Line, Lines}; use super::translate::TextToCea708; const DEFAULT_MODE: Cea708Mode = Cea708Mode::RollUp; const DEFAULT_ORIGIN_ROW: i32 = -1; const DEFAULT_ORIGIN_COLUMN: u32 = 0; const DEFAULT_ROLL_UP_ROWS: u8 = 2; const DEFAULT_SERVICE_NO: u8 = 1; const DEFAULT_CEA608_CHANNEL: u8 = 0; #[derive(Debug, Clone)] struct Settings { mode: Cea708Mode, service_no: u8, cea608_channel: u8, roll_up_rows: u8, origin_column: u32, origin_row: i32, roll_up_timeout: Option, } impl Default for Settings { fn default() -> Self { Settings { mode: DEFAULT_MODE, origin_row: DEFAULT_ORIGIN_ROW, roll_up_rows: DEFAULT_ROLL_UP_ROWS, roll_up_timeout: gst::ClockTime::NONE, service_no: DEFAULT_SERVICE_NO, cea608_channel: DEFAULT_CEA608_CHANNEL, origin_column: DEFAULT_ORIGIN_COLUMN, } } } #[derive(Debug)] struct State { translator: TextToCea708, framerate: gst::Fraction, last_frame_no: u64, max_frame_no: u64, force_clear: bool, } impl Default for State { fn default() -> Self { Self { translator: TextToCea708::default(), framerate: gst::Fraction::new(DEFAULT_FPS_N, DEFAULT_FPS_D), last_frame_no: 0, max_frame_no: 0, force_clear: false, } } } static CAT: Lazy = Lazy::new(|| { gst::DebugCategory::new( "tttocea708", gst::DebugColorFlags::empty(), Some("TT CEA 708 Element"), ) }); fn cc_data_buffer(data: &[u8], pts: gst::ClockTime, duration: gst::ClockTime) -> gst::Buffer { let mut ret = gst::Buffer::with_size(data.len()).unwrap(); let buf_mut = ret.get_mut().unwrap(); buf_mut.copy_from_slice(0, data).unwrap(); buf_mut.set_pts(pts); buf_mut.set_duration(duration); ret } pub struct TtToCea708 { srcpad: gst::Pad, sinkpad: gst::Pad, // Ordered by locking order state: Mutex, settings: Mutex, } impl TtToCea708 { fn generate( &self, state: &mut State, pts: gst::ClockTime, duration: gst::ClockTime, lines: Lines, ) { let (fps_n, fps_d) = { let f = state.translator.framerate(); (f.numer() as u64, f.denom() as u64) }; let frame_no = pts.mul_div_round(fps_n, fps_d).unwrap().seconds(); let max_frame_no = (pts + duration) .mul_div_round(fps_n, fps_d) .unwrap() .seconds(); state.translator.generate(frame_no, max_frame_no, lines); } fn pop_bufferlist(&self, state: &mut State) -> gst::BufferList { let (fps_n, fps_d) = { let f = state.translator.framerate(); (f.numer() as u64, f.denom() as u64) }; let mut bufferlist = gst::BufferList::new(); let mut_list = bufferlist.get_mut().unwrap(); while let Some(cea708) = state.translator.pop_output() { // TODO: handle framerate changes let pts = cea708 .frame_no .mul_div_round(fps_d * gst::ClockTime::SECOND.nseconds(), fps_n) .unwrap() .nseconds(); let duration = 1 .mul_div_round(fps_d * gst::ClockTime::SECOND.nseconds(), fps_n) .unwrap() .nseconds(); mut_list.add(cc_data_buffer(&cea708.packet, pts, duration)); } bufferlist } fn sink_chain( &self, pad: &gst::Pad, buffer: gst::Buffer, ) -> Result { gst::log!(CAT, imp: self, "Handling {:?}", buffer); let pts = buffer.pts().ok_or_else(|| { gst::element_imp_error!( self, gst::StreamError::Format, ["Stream with timestamped buffers required"] ); gst::FlowError::Error })?; let duration = buffer.duration().ok_or_else(|| { gst::element_imp_error!( self, gst::StreamError::Format, ["Buffers of stream need to have a duration"] ); gst::FlowError::Error })?; let data = buffer.map_readable().map_err(|_| { gst::error!(CAT, obj: pad, "Can't map buffer readable"); gst::FlowError::Error })?; let mut state = self.state.lock().unwrap(); let settings = self.settings.lock().unwrap(); let cea608_mode = match settings.mode { Cea708Mode::PaintOn => Cea608Mode::PaintOn, Cea708Mode::PopOn => Cea608Mode::PopOn, Cea708Mode::RollUp => match settings.roll_up_rows { 0..=2 => Cea608Mode::RollUp2, 3 => Cea608Mode::RollUp3, _ => Cea608Mode::RollUp4, }, }; let mut lines = Lines { lines: Vec::new(), mode: Some(cea608_mode), clear: Some(state.force_clear), }; state.force_clear = false; let data = std::str::from_utf8(&data).map_err(|err| { gst::error!(CAT, obj: pad, "Can't decode utf8: {}", err); gst::FlowError::Error })?; let phrases: Vec<&str> = data.split('\n').collect(); let mut row = match settings.origin_row { -1 => match settings.mode { Cea708Mode::PopOn | Cea708Mode::PaintOn => { 15u32.saturating_sub(phrases.len() as u32) } Cea708Mode::RollUp => 14, }, _ => settings.origin_row as u32, }; for phrase in &phrases { lines.lines.push(Line { carriage_return: None, column: None, row: Some(row), chunks: vec![Chunk { style: TextStyle::White, underline: false, text: phrase.to_string(), }], }); if settings.mode == Cea708Mode::PopOn || settings.mode == Cea708Mode::PaintOn { row += 1; } } drop(settings); self.generate(&mut state, pts, duration, lines); let bufferlist = self.pop_bufferlist(&mut state); drop(state); self.srcpad.push_list(bufferlist) } fn sink_event(&self, pad: &gst::Pad, event: gst::Event) -> bool { gst::log!(CAT, obj: pad, "Handling event {:?}", event); use gst::EventView; match event.view() { EventView::Caps(_e) => { let mut downstream_caps = match self.srcpad.allowed_caps() { None => self.srcpad.pad_template_caps(), Some(caps) => caps, }; if downstream_caps.is_empty() { gst::error!(CAT, obj: pad, "Empty downstream caps"); return false; } let caps = downstream_caps.make_mut(); let s = caps.structure_mut(0).unwrap(); s.fixate_field_nearest_fraction( "framerate", gst::Fraction::new(DEFAULT_FPS_N, DEFAULT_FPS_D), ); s.fixate(); let caps = gst::Caps::builder_full().structure(s.to_owned()).build(); let mut state = self.state.lock().unwrap(); let framerate = s.get::("framerate").unwrap(); state.framerate = framerate; state.translator.set_framerate(framerate); gst::debug!(CAT, obj: pad, "Pushing caps {}", caps); let new_event = gst::event::Caps::new(&caps); drop(state); self.srcpad.push_event(new_event) } EventView::Gap(e) => { let mut state = self.state.lock().unwrap(); let (fps_n, fps_d) = ( state.framerate.numer() as u64, state.framerate.denom() as u64, ); let (timestamp, duration) = e.get(); if state.last_frame_no == 0 { state.last_frame_no = timestamp.mul_div_floor(fps_n, fps_d).unwrap().seconds(); gst::debug!( CAT, imp: self, "Initial skip to frame no {}", state.last_frame_no ); } let frame_no = (timestamp + duration.unwrap_or(gst::ClockTime::ZERO)) .mul_div_round(fps_n, fps_d) .unwrap() .seconds(); state.max_frame_no = frame_no; let last_frame_no = state.last_frame_no; state .translator .generate(last_frame_no, frame_no, Lines::new_empty()); let bufferlist = self.pop_bufferlist(&mut state); drop(state); let _ = self.srcpad.push_list(bufferlist); true } EventView::Eos(_) => { let mut state = self.state.lock().unwrap(); if let Some(erase_display_frame_no) = state.translator.erase_display_frame_no() { state.max_frame_no = erase_display_frame_no; let last_frame_no = state.translator.last_frame_no(); state.translator.generate( last_frame_no, erase_display_frame_no, Lines::new_empty(), ); let bufferlist = self.pop_bufferlist(&mut state); drop(state); let _ = self.srcpad.push_list(bufferlist); } else { drop(state); } gst::Pad::event_default(pad, Some(&*self.obj()), event) } EventView::FlushStop(_) => { let mut state = self.state.lock().unwrap(); let settings = self.settings.lock().unwrap(); let framerate = state.framerate; *state = State::default(); state.framerate = framerate; state.translator.set_mode(settings.mode); state.translator.set_origin_column(settings.origin_column); state.translator.set_framerate(framerate); state .translator .set_roll_up_timeout(settings.roll_up_timeout); state.translator.set_roll_up_count(settings.roll_up_rows); state .translator .set_cea608_channel(if settings.cea608_channel < 1 { None } else { Some(cea608_types::Id::from_value(settings.cea608_channel as i8)) }); state.translator.set_service_no(settings.service_no); state.translator.flush(); drop(settings); drop(state); gst::Pad::event_default(pad, Some(&*self.obj()), event) } _ => gst::Pad::event_default(pad, Some(&*self.obj()), event), } } } #[glib::object_subclass] impl ObjectSubclass for TtToCea708 { const NAME: &'static str = "GstTtToCea708"; type Type = super::TtToCea708; type ParentType = gst::Element; fn with_class(klass: &Self::Class) -> Self { let templ = klass.pad_template("sink").unwrap(); let sinkpad = gst::Pad::builder_from_template(&templ) .chain_function(|pad, parent, buffer| { TtToCea708::catch_panic_pad_function( parent, || Err(gst::FlowError::Error), |this| this.sink_chain(pad, buffer), ) }) .event_function(|pad, parent, event| { TtToCea708::catch_panic_pad_function( parent, || false, |this| this.sink_event(pad, event), ) }) .flags(gst::PadFlags::FIXED_CAPS) .build(); let templ = klass.pad_template("src").unwrap(); let srcpad = gst::Pad::builder_from_template(&templ) .flags(gst::PadFlags::FIXED_CAPS) .build(); Self { srcpad, sinkpad, state: Mutex::new(State::default()), settings: Mutex::new(Settings::default()), } } } impl ObjectImpl for TtToCea708 { fn properties() -> &'static [glib::ParamSpec] { static PROPERTIES: Lazy> = Lazy::new(|| { vec![ glib::ParamSpecEnum::builder_with_default("mode", DEFAULT_MODE) .nick("Mode") .blurb("Which mode to operate in") .mutable_playing() .build(), glib::ParamSpecInt::builder("origin-row") .nick("Origin row") .blurb("Origin row, (-1=automatic)") .minimum(-1) .maximum(14) .default_value(DEFAULT_ORIGIN_ROW) .mutable_playing() .build(), glib::ParamSpecUInt::builder("origin-column") .nick("Origin column") .blurb("Origin column") .maximum(31) .default_value(DEFAULT_ORIGIN_COLUMN) .mutable_playing() .build(), glib::ParamSpecUInt64::builder("roll-up-timeout") .nick("Roll-Up Timeout") .blurb("Duration after which to erase display memory in roll-up mode") .default_value(u64::MAX) .mutable_playing() .build(), glib::ParamSpecUInt::builder("service-number") .nick("Service Number") .blurb("Write DTVCC packets using this service") .default_value(DEFAULT_SERVICE_NO as u32) .minimum(1) .maximum(63) .build(), glib::ParamSpecUInt::builder("cea608-channel") .nick("CEA-608 channel") .blurb("Write CEA 608 compatibility bytes with this channel, 0 = disabled (only 1 and 3 currently supported)") .default_value(DEFAULT_CEA608_CHANNEL as u32) .minimum(0) .maximum(4) .build(), glib::ParamSpecUInt::builder("roll-up-rows") .nick("Roll Up Rows") .blurb("Number of rows to use in roll up mode") .maximum(31) .default_value(DEFAULT_ORIGIN_COLUMN) .mutable_playing() .build(), ] }); PROPERTIES.as_ref() } fn constructed(&self) { self.parent_constructed(); let obj = self.obj(); obj.add_pad(&self.sinkpad).unwrap(); obj.add_pad(&self.srcpad).unwrap(); } fn set_property(&self, _id: usize, value: &glib::Value, pspec: &glib::ParamSpec) { match pspec.name() { "mode" => { // XXX: Ideally we'd like to not lock the state here let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); settings.mode = value.get::().expect("type checked upstream"); state.force_clear = true; } "origin-row" => { // XXX: Ideally we'd like to not lock the state here let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); settings.origin_row = value.get().expect("type checked upstream"); state.force_clear = true; } "origin-column" => { // XXX: Ideally we'd like to not lock the state here let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); settings.origin_column = value.get().expect("type checked upstream"); state.force_clear = true; state.translator.set_origin_column(settings.origin_column); state.translator.set_column(settings.origin_column as u8); } "roll-up-timeout" => { let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); let timeout = match value.get().expect("type checked upstream") { u64::MAX => gst::ClockTime::NONE, timeout => Some(timeout.nseconds()), }; settings.roll_up_timeout = timeout; state.translator.set_roll_up_timeout(timeout); } "service-number" => { let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); settings.service_no = value.get::().expect("type checked upstream") as u8; state.translator.set_service_no(settings.service_no); } "cea608-channel" => { let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); let channel = value.get::().expect("type checked upstream") as u8; settings.cea608_channel = channel; state .translator .set_cea608_channel(if settings.cea608_channel < 1 { None } else { Some(cea608_types::Id::from_value(settings.cea608_channel as i8)) }); } "roll-up-rows" => { let mut state = self.state.lock().unwrap(); let mut settings = self.settings.lock().unwrap(); settings.roll_up_rows = value.get::().expect("type checked upstream") as u8; state.translator.set_roll_up_count(settings.roll_up_rows); } _ => unimplemented!(), } } fn property(&self, _id: usize, pspec: &glib::ParamSpec) -> glib::Value { match pspec.name() { "mode" => { let settings = self.settings.lock().unwrap(); settings.mode.to_value() } "origin-row" => { let settings = self.settings.lock().unwrap(); settings.origin_row.to_value() } "origin-column" => { let settings = self.settings.lock().unwrap(); settings.origin_column.to_value() } "roll-up-timeout" => { let settings = self.settings.lock().unwrap(); if let Some(timeout) = settings.roll_up_timeout { timeout.nseconds().to_value() } else { u64::MAX.to_value() } } "service-number" => { let settings = self.settings.lock().unwrap(); (settings.service_no as u32).to_value() } "cea608-channel" => { let settings = self.settings.lock().unwrap(); (settings.cea608_channel as u32).to_value() } "roll-up-rows" => { let settings = self.settings.lock().unwrap(); (settings.roll_up_rows as u32).to_value() } _ => unimplemented!(), } } } impl GstObjectImpl for TtToCea708 {} impl ElementImpl for TtToCea708 { fn metadata() -> Option<&'static gst::subclass::ElementMetadata> { static ELEMENT_METADATA: Lazy = Lazy::new(|| { gst::subclass::ElementMetadata::new( "TT to CEA-708", "Generic", "Converts timed text to CEA-708 Closed Captions", "Matthew Waters ", ) }); Some(&*ELEMENT_METADATA) } fn pad_templates() -> &'static [gst::PadTemplate] { static PAD_TEMPLATES: Lazy> = Lazy::new(|| { let mut caps = gst::Caps::new_empty(); { let caps = caps.get_mut().unwrap(); let s = gst::Structure::builder("text/x-raw").build(); caps.append_structure(s); } let sink_pad_template = gst::PadTemplate::new( "sink", gst::PadDirection::Sink, gst::PadPresence::Always, &caps, ) .unwrap(); let framerate = gst::FractionRange::new( gst::Fraction::new(1, std::i32::MAX), gst::Fraction::new(std::i32::MAX, 1), ); let caps = gst::Caps::builder("closedcaption/x-cea-708") .field("format", "cc_data") .field("framerate", framerate) .build(); let src_pad_template = gst::PadTemplate::new( "src", gst::PadDirection::Src, gst::PadPresence::Always, &caps, ) .unwrap(); vec![src_pad_template, sink_pad_template] }); PAD_TEMPLATES.as_ref() } #[allow(clippy::single_match)] fn change_state( &self, transition: gst::StateChange, ) -> Result { gst::trace!(CAT, imp: self, "Changing state {:?}", transition); match transition { gst::StateChange::ReadyToPaused => { let mut state = self.state.lock().unwrap(); let settings = self.settings.lock().unwrap(); let framerate = state.framerate; *state = State::default(); state.force_clear = false; state.translator.set_mode(settings.mode); state.translator.set_origin_column(settings.origin_column); state.translator.set_framerate(framerate); state .translator .set_roll_up_timeout(settings.roll_up_timeout); state.translator.set_column(settings.origin_column as u8); state .translator .set_cea608_channel(if settings.cea608_channel < 1 { None } else { Some(cea608_types::Id::from_value(settings.cea608_channel as i8)) }); state.translator.set_service_no(settings.service_no); state.translator.flush(); } _ => (), } let ret = self.parent_change_state(transition)?; match transition { gst::StateChange::PausedToReady => { let mut state = self.state.lock().unwrap(); *state = State::default(); } _ => (), } Ok(ret) } }