textahead: add settings to display previous buffers

I'll use this in Karapulse to keep displaying the few previous lyrics
rather than having them disappear right away.

Part-of: <https://gitlab.freedesktop.org/gstreamer/gst-plugins-rs/-/merge_requests/1006>
This commit is contained in:
Guillaume Desmottes 2022-12-11 17:24:40 +01:00
parent fb42cd8a0f
commit d9de2d3d7b
2 changed files with 108 additions and 10 deletions

View file

@ -6268,6 +6268,32 @@
"type": "guint", "type": "guint",
"writable": true "writable": true
}, },
"n-previous": {
"blurb": "The number of previous text buffers to display before the current one",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "0",
"max": "-1",
"min": "0",
"mutable": "playing",
"readable": true,
"type": "guint",
"writable": true
},
"previous-attributes": {
"blurb": "Pango span attributes to set on the previous text",
"conditionally-available": false,
"construct": false,
"construct-only": false,
"controllable": false,
"default": "size=\"smaller\"",
"mutable": "playing",
"readable": true,
"type": "gchararray",
"writable": true
},
"separator": { "separator": {
"blurb": "Text inserted between each text buffers", "blurb": "Text inserted between each text buffers",
"conditionally-available": false, "conditionally-available": false,

View file

@ -28,6 +28,8 @@ struct Settings {
current_attributes: String, current_attributes: String,
ahead_attributes: String, ahead_attributes: String,
buffer_start_segment: bool, buffer_start_segment: bool,
n_previous: u32,
previous_attributes: String,
} }
impl Default for Settings { impl Default for Settings {
@ -38,6 +40,8 @@ impl Default for Settings {
current_attributes: "size=\"larger\"".to_string(), current_attributes: "size=\"larger\"".to_string(),
ahead_attributes: "size=\"smaller\"".to_string(), ahead_attributes: "size=\"smaller\"".to_string(),
buffer_start_segment: false, buffer_start_segment: false,
n_previous: 0,
previous_attributes: "size=\"smaller\"".to_string(),
} }
} }
} }
@ -50,6 +54,7 @@ struct Input {
#[derive(Default)] #[derive(Default)]
struct State { struct State {
previous: Vec<Input>,
pending: Vec<Input>, pending: Vec<Input>,
done: bool, done: bool,
/// Segment for which we should send a buffer with ahead text. Only set if `Settings.buffer_start_segment` is set. /// Segment for which we should send a buffer with ahead text. Only set if `Settings.buffer_start_segment` is set.
@ -138,6 +143,18 @@ impl ObjectImpl for TextAhead {
.default_value(default.buffer_start_segment) .default_value(default.buffer_start_segment)
.mutable_playing() .mutable_playing()
.build(), .build(),
glib::ParamSpecUInt::builder("n-previous")
.nick("n-previous")
.blurb("The number of previous text buffers to display before the current one")
.default_value(default.n_previous)
.mutable_playing()
.build(),
glib::ParamSpecString::builder("previous-attributes")
.nick("Previous attributes")
.blurb("Pango span attributes to set on the previous text")
.default_value(&*default.previous_attributes)
.mutable_playing()
.build(),
] ]
}); });
@ -163,6 +180,12 @@ impl ObjectImpl for TextAhead {
"buffer-start-segment" => { "buffer-start-segment" => {
settings.buffer_start_segment = value.get().expect("type checked upstream"); settings.buffer_start_segment = value.get().expect("type checked upstream");
} }
"n-previous" => {
settings.n_previous = value.get().expect("type checked upstream");
}
"previous-attributes" => {
settings.previous_attributes = value.get().expect("type checked upstream");
}
_ => unimplemented!(), _ => unimplemented!(),
} }
} }
@ -176,6 +199,8 @@ impl ObjectImpl for TextAhead {
"current-attributes" => settings.current_attributes.to_value(), "current-attributes" => settings.current_attributes.to_value(),
"ahead-attributes" => settings.ahead_attributes.to_value(), "ahead-attributes" => settings.ahead_attributes.to_value(),
"buffer-start-segment" => settings.buffer_start_segment.to_value(), "buffer-start-segment" => settings.buffer_start_segment.to_value(),
"n-previous" => settings.n_previous.to_value(),
"previous-attributes" => settings.previous_attributes.to_value(),
_ => unimplemented!(), _ => unimplemented!(),
} }
} }
@ -351,19 +376,66 @@ impl TextAhead {
("".to_string(), pending_segment.start(), duration) ("".to_string(), pending_segment.start(), duration)
} else { } else {
let first = state.pending.remove(0); let mut text = String::new();
let text = if settings.current_attributes.is_empty() { let mut first_buffer = true;
first.text
} else {
format!(
"<span {}>{}</span>",
settings.current_attributes, first.text
)
};
(text, first.pts, first.duration) // previous buffers
for previous in state.previous.iter() {
if !first_buffer && !settings.separator.is_empty() {
text.push_str(&settings.separator);
}
if settings.ahead_attributes.is_empty() {
text.push_str(&previous.text);
} else {
use std::fmt::Write;
write!(
&mut text,
"<span {}>{}</span>",
settings.previous_attributes, previous.text,
)
.unwrap();
}
first_buffer = false;
}
// current buffer
let current = state.pending.remove(0);
if !first_buffer && !settings.separator.is_empty() {
text.push_str(&settings.separator);
}
if settings.current_attributes.is_empty() {
text.push_str(&current.text);
} else {
use std::fmt::Write;
write!(
&mut text,
"<span {}>{}</span>",
settings.current_attributes, current.text
)
.unwrap();
}
let pts = current.pts;
let duration = current.duration;
if settings.n_previous > 0 {
state.previous.push(current);
if state.previous.len() > settings.n_previous as usize {
state.previous.pop();
}
}
(text, pts, duration)
}; };
// ahead buffers
for input in state.pending.iter() { for input in state.pending.iter() {
if !settings.separator.is_empty() { if !settings.separator.is_empty() {
text.push_str(&settings.separator); text.push_str(&settings.separator);