phonto 0.5.0

GPU-accelerated video wallpaper program for wayland compositors & MacOS
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

use gst::MessageView::*;
use std::str::FromStr;
use std::sync::mpsc::SyncSender;

use anyhow::{Context, anyhow};
use gstreamer as gst;
use gstreamer::prelude::*;
use gstreamer_app as gst_app;
use gstreamer_gl as gst_gl;
use gstreamer_gl::prelude::*;
use gstreamer_gl_egl as gst_gl_egl;
use gstreamer_video as gst_video;

pub struct Frame {
    pub texture_id: u32,
    pub width: u32,
    pub height: u32,
}

pub fn run(
    source: &str,
    gl_display: gst_gl::GLDisplay,
    gl_context: gst_gl::GLContext,
    tx: SyncSender<gst::Sample>,
) -> anyhow::Result<()> {
    let source = source.to_string();

    loop {
        let pipeline = build_pipeline(&source).context("build decoder pipeline")?;

        let mut display_ctx = gst::Context::new("gst.gl.GLDisplay", true);
        display_ctx
            .get_mut()
            .expect("freshly created Context has a unique reference")
            .set_gl_display(&gl_display);

        pipeline.set_context(&display_ctx);

        let mut app_ctx = gst::Context::new("gst.gl.app_context", true);
        app_ctx
            .get_mut()
            .expect("freshly created Context has a unique reference")
            .structure_mut()
            .set("context", &gl_context);

        pipeline.set_context(&app_ctx);

        let appsink = pipeline
            .by_name("sink")
            .context("appsink not found in pipeline")?
            .downcast::<gst_app::AppSink>()
            .map_err(|_| anyhow!("`sink` is not an AppSink"))?;

        let tx_cb = tx.clone();
        appsink.set_callbacks(
            gst_app::AppSinkCallbacks::builder()
                .new_sample(move |sink| {
                    let sample = sink.pull_sample().map_err(|_| gst::FlowError::Eos)?;
                    tx_cb.send(sample).map_err(|_| gst::FlowError::Eos)?;
                    Ok(gst::FlowSuccess::Ok)
                })
                .build(),
        );

        pipeline
            .set_state(gst::State::Playing)
            .context("set pipeline state to Playing")?;

        let bus = pipeline.bus().context("pipeline has no bus")?;
        let mut restart = false;
        for msg in bus.iter_timed(gst::ClockTime::NONE) {
            match msg.view() {
                Eos(_) => {
                    if pipeline
                        .seek_simple(
                            gst::SeekFlags::FLUSH | gst::SeekFlags::KEY_UNIT,
                            gst::ClockTime::ZERO,
                        )
                        .is_ok()
                    {
                        continue;
                    }
                    restart = true;
                    break;
                }
                Error(err) => {
                    pipeline.set_state(gst::State::Null).ok();
                    return Err(anyhow!(
                        "pipeline error from {:?}: {} ({:?})",
                        err.src().map(|s| s.path_string()),
                        err.error(),
                        err.debug()
                    ));
                }
                _ => {}
            }
        }

        pipeline.set_state(gst::State::Null).ok();

        if !restart {
            return Ok(());
        }
    }
}

// Build the GStreamer pipeline programmatically so the source is set via the
// `uri` GObject property instead of being interpolated into a pipeline
// description string. `gst::parse::launch` treats `"` as a string delimiter and
// `!` as an element separator, so a source containing those characters could
// otherwise inject additional elements into the pipeline.
fn build_pipeline(source: &str) -> anyhow::Result<gst::Pipeline> {
    let pipeline = gst::Pipeline::default();

    // `uridecodebin3` takes a URI for both local files and remote URLs, so local
    // paths are converted to an absolute `file://` URI. Unlike a bare
    // `filesrc ! decodebin3`, routing local files through `uridecodebin3` lets
    // its internal `urisourcebin` set up source negotiation correctly, which
    // some containers (e.g. `hvc1`-tagged HEVC in MP4) need to auto-plug a
    // decoder at all.
    let uri = if crate::config::is_url(source) {
        source.to_string()
    } else {
        let abs_path =
            std::fs::canonicalize(source).with_context(|| format!("resolve path {source}"))?;
        gst::glib::filename_to_uri(&abs_path, None)
            .context("convert path to file:// URI")?
            .to_string()
    };

    let decodebin = gst::ElementFactory::make("uridecodebin3")
        .property("uri", &uri)
        .build()
        .context("create uridecodebin3")?;

    decodebin.connect("source-setup", false, |values| {
        let elem = values[1].get::<gst::Element>().expect("source-setup arg");
        // YouTube's CDN (googlevideo.com) rejects requests without a
        // browser-like User-Agent with 403 Forbidden. GStreamer's default
        // souphttpsrc User-Agent is blocked. Setting this on local-file sources
        // is harmless (the property is simply absent).
        if elem.has_property("user-agent") {
            elem.set_property(
                "user-agent",
                "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/131.0.0.0 Safari/537.36",
            );
        }
        None
    });

    let glupload = gst::ElementFactory::make("glupload")
        .build()
        .context("create glupload")?;
    let glcolorconvert = gst::ElementFactory::make("glcolorconvert")
        .build()
        .context("create glcolorconvert")?;

    let sink_caps =
        gst::Caps::from_str("video/x-raw(memory:GLMemory),format=RGBA,texture-target=2D")
            .context("parse appsink caps")?;
    let appsink = gst_app::AppSink::builder()
        .name("sink")
        .caps(&sink_caps)
        .sync(true)
        .max_buffers(1)
        .build();

    pipeline
        .add_many([&decodebin, &glupload, &glcolorconvert, appsink.upcast_ref()])
        .context("add elements to pipeline")?;

    gst::Element::link_many([&glupload, &glcolorconvert, appsink.upcast_ref()])
        .context("link glupload → glcolorconvert → appsink")?;

    // uridecodebin3 exposes source pads as streams are discovered. glupload's
    // sink pad only accepts video caps, so non-video pads (audio, subtitles)
    // fail to link and are silently ignored.
    let glupload_weak = glupload.downgrade();
    decodebin.connect_pad_added(move |_, src_pad| {
        let Some(glupload) = glupload_weak.upgrade() else {
            return;
        };
        let Some(sink_pad) = glupload.static_pad("sink") else {
            return;
        };
        if sink_pad.is_linked() {
            return;
        }
        if let Err(err) = src_pad.link(&sink_pad) {
            log::warn!("link uridecodebin3 video pad → glupload: {err:?}");
        }
    });

    Ok(pipeline)
}

pub fn sample_to_frame(
    sample: gst::Sample,
    gl_context: &gst_gl::GLContext,
) -> anyhow::Result<Frame> {
    let buffer = sample.buffer_owned().context("sample has no buffer")?;
    let caps = sample.caps().context("sample has no caps")?;
    let info = gst_video::VideoInfo::from_caps(caps).context("VideoInfo from caps")?;

    if let Some(sync_meta) = buffer.meta::<gst_gl::GLSyncMeta>() {
        sync_meta.wait(gl_context);
    }

    let gl_frame = gst_gl::GLVideoFrame::from_buffer_readable(buffer, &info)
        .map_err(|_| anyhow!("GLVideoFrame::from_buffer_readable failed"))?;

    let texture_id = gl_frame
        .texture_id(0)
        .context("GLVideoFrame texture id missing")?;

    Ok(Frame {
        texture_id,
        width: info.width(),
        height: info.height(),
    })
}

pub fn wrap_gl(
    egl_display: usize,
    egl_context: usize,
) -> anyhow::Result<(gst_gl::GLDisplay, gst_gl::GLContext)> {
    gst::init().context("gst::init")?;

    let gl_display = unsafe { gst_gl_egl::GLDisplayEGL::with_egl_display(egl_display) }
        .context("wrap EGL display for GStreamer")?;

    let gl_display = gl_display.upcast::<gst_gl::GLDisplay>();

    let gl_context = unsafe {
        gst_gl::GLContext::new_wrapped(
            &gl_display,
            egl_context,
            gst_gl::GLPlatform::EGL,
            gst_gl::GLAPI::GLES2,
        )
    }
    .context("wrap EGL context for GStreamer")?;

    gl_context
        .activate(true)
        .map_err(|_| anyhow!("GLContext::activate failed"))?;

    gl_context
        .fill_info()
        .map_err(|e| anyhow!("GLContext::fill_info: {e}"))?;

    Ok((gl_display, gl_context))
}