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
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
use anyhow::Context;
use std::{
    ffi::OsString,
    sync::Arc,
};
use tokio::sync::oneshot;
use tokio_stream::{
    wrappers::ReceiverStream,
    Stream,
    StreamExt,
};
use tracing::info;

/// A message for the encoder task
enum Message {
    /// Get encoders available to the application
    GetEncoders {
        /// Whether to validate the encoder.
        ///
        /// If this is false, false positives will show up in the output.
        validate: bool,

        /// The response
        tx: oneshot::Sender<anyhow::Result<Vec<tokio_ffmpeg_cli::Encoder>>>,
    },

    /// Request an encode
    Encode {
        /// The options for the encode
        builder: Box<tokio_ffmpeg_cli::Builder>,
        /// The notification for when the task is processed, as well as a handle to the download event stream
        tx: oneshot::Sender<
            anyhow::Result<
                tokio::sync::mpsc::Receiver<
                    Result<tokio_ffmpeg_cli::Event, tokio_ffmpeg_cli::Error>,
                >,
            >,
        >,
    },

    /// Request a shutdown.
    ///
    /// the task will drain the channel until it is empty after recieving this.
    /// the task will still accept new messages until it processes this one.
    Close {
        /// The notification for when the task processes this message
        tx: oneshot::Sender<()>,
    },
}

/// A task to re-encode things
#[derive(Debug, Clone)]
pub struct EncoderTask {
    handle: Arc<parking_lot::Mutex<Option<tokio::task::JoinHandle<()>>>>,
    tx: tokio::sync::mpsc::Sender<Message>,
}

impl EncoderTask {
    /// Make a new encoder task
    pub fn new() -> Self {
        let (tx, rx) = tokio::sync::mpsc::channel(1);
        let handle = tokio::spawn(encoder_task_impl(rx));

        Self {
            handle: Arc::new(parking_lot::Mutex::new(Some(handle))),
            tx,
        }
    }

    /// Get encoders
    pub async fn get_encoders(
        &self,
        validate: bool,
    ) -> anyhow::Result<Vec<tokio_ffmpeg_cli::Encoder>> {
        let (tx, rx) = oneshot::channel();
        self.tx
            .try_send(Message::GetEncoders { validate, tx })
            .ok()
            .context("failed to send message")?;

        rx.await.context("task crashed")?
    }

    /// Create a builder for an encode request
    pub fn encode(&self) -> EncoderTaskEncodeBuilder<'_> {
        EncoderTaskEncodeBuilder::new(self)
    }

    /// Request this task to close
    pub async fn close(&self) -> anyhow::Result<()> {
        let (tx, rx) = oneshot::channel();

        self.tx
            .send(Message::Close { tx })
            .await
            .ok()
            .context("task is gone")?;

        rx.await.context("task crashed")
    }

    /// Join this task, waiting for it to exit.
    ///
    /// This will NOT send a shutdown request, that must be done beforehand.
    /// Also, this function can only be called once. Future calls will return an error.
    pub async fn join(&self) -> anyhow::Result<()> {
        let handle = self.handle.lock().take().context("missing handle")?;
        handle.await.context("task panicked")
    }

    /// Shutdown the task, sending a close request can joining the task.
    ///
    /// This calls `join` under the hood, so it has the same restrictions as close:
    /// Either shutdown or close can only be called once.
    pub async fn shutdown(&self) -> anyhow::Result<()> {
        self.close().await.context("failed to send close request")?;
        self.join().await.context("failed to join task")?;
        Ok(())
    }
}

/// Impl for the encoder task
async fn encoder_task_impl(mut rx: tokio::sync::mpsc::Receiver<Message>) {
    while let Some(msg) = rx.recv().await {
        match msg {
            Message::Close { tx } => {
                rx.close();

                // We don't care if the user doesn't care about the result.
                let _ = tx.send(()).is_ok();
            }
            Message::Encode { mut builder, tx } => {
                let maybe_stream = builder.spawn().context("failed to spawn FFMpeg");

                match maybe_stream {
                    Ok(mut stream) => {
                        let (event_tx, event_rx) = tokio::sync::mpsc::channel(128);

                        // TODO: Consider stopping download if the user does not care anymore.
                        let _ = tx.send(Ok(event_rx)).is_ok();

                        // We manage the stream here so that downloads are not cancelable.
                        // Also, it gives us a concrete stream type.
                        while let Some(event) = stream.next().await {
                            // TODO: Consider cancelling download if user stopped caring
                            let _ = event_tx.send(event).await.is_ok();
                        }
                    }
                    Err(e) => {
                        // If the stopped caring, we don't care since it was an error anyways
                        let _ = tx.send(Err(e)).is_ok();
                    }
                }
            }
            Message::GetEncoders { validate, tx } => {
                let result = async {
                    // Get all encoders
                    let raw_encoders = tokio_ffmpeg_cli::get_encoders()
                        .await
                        .context("failed to get ffmpeg encoders")?;

                    if validate {
                        // If we are validating, allocate a new buffer and move valid entries to it was we validate it.
                        let mut encoders = Vec::with_capacity(raw_encoders.len());

                        // TODO: We only support sanity checks for video output, so the output will only be video
                        // In the future, we should edit the sanity check based on encoder type
                        // TODO: We filter out anything that isn't 264 as thats all we need right now.
                        // In the future, we should expose an api to configure this filter.
                        // TODO: Maybe this should be run in parallel.
                        for encoder in raw_encoders
                            .into_iter()
                            .filter(|encoder| encoder.is_video())
                            .filter(|encoder| encoder.name.contains("264"))
                        {
                            // Run a basic transcoding sanity check
                            let status = tokio_ffmpeg_cli::Builder::new()
                                .input("nullsrc")
                                .input_format("lavfi")
                                .output("-")
                                .output_format("null")
                                .video_codec(&*encoder.name)
                                .video_frames(1_u64)
                                .ffmpeg_status()
                                .await?;

                            // If it passed, add it to the output
                            if status.success() {
                                encoders.push(encoder);
                            } else {
                                info!("skipping '{}' as it failed a sanity check", encoder.name);
                            }
                        }

                        Ok(encoders)
                    } else {
                        // If we are not validating, just return
                        Ok(raw_encoders)
                    }
                }
                .await;

                // Don't care if the user hung up,
                // but it is a bit sad they asked for expensive data they didn't want
                let _ = tx.send(result).is_ok();
            }
        }
    }
}

impl Default for EncoderTask {
    fn default() -> Self {
        Self::new()
    }
}

/// A builder for encoding messages
#[derive(Debug)]
pub struct EncoderTaskEncodeBuilder<'a> {
    builder: Box<tokio_ffmpeg_cli::Builder>,

    task: &'a EncoderTask,
}

impl<'a> EncoderTaskEncodeBuilder<'a> {
    /// Make a new [`EncoderTaskEncodeBuilder`]
    pub fn new(task: &'a EncoderTask) -> Self {
        Self {
            builder: Box::new(tokio_ffmpeg_cli::Builder::new()),
            task,
        }
    }

    /// Set the file input
    pub fn input(&mut self, input: impl Into<OsString>) -> &mut Self {
        self.builder.input(input);
        self
    }

    /// Set the file output
    pub fn output(&mut self, output: impl Into<OsString>) -> &mut Self {
        self.builder.output(output);
        self
    }

    /// Set the audio codec
    pub fn audio_codec(&mut self, audio_codec: impl Into<String>) -> &mut Self {
        self.builder.audio_codec(audio_codec);
        self
    }

    /// Set the video codec
    pub fn video_codec(&mut self, video_codec: impl Into<String>) -> &mut Self {
        self.builder.video_codec(video_codec);
        self
    }

    /// Set the video bitrate
    pub fn video_bitrate(&mut self, video_bitrate: impl Into<String>) -> &mut Self {
        self.builder.video_bitrate(video_bitrate);
        self
    }

    /// Set the input format
    pub fn input_format(&mut self, input_format: impl Into<String>) -> &mut Self {
        self.builder.input_format(input_format);
        self
    }

    /// Set the output format
    pub fn output_format(&mut self, output_format: impl Into<String>) -> &mut Self {
        self.builder.output_format(output_format);
        self
    }

    /// Set the # of video frames from the input
    pub fn video_frames(&mut self, video_frames: impl Into<u64>) -> &mut Self {
        self.builder.video_frames(video_frames);
        self
    }

    /// Set the video profile
    pub fn video_profile(&mut self, video_profile: impl Into<String>) -> &mut Self {
        self.builder.video_profile(video_profile);
        self
    }

    /// Set the preset
    pub fn preset(&mut self, preset: impl Into<String>) -> &mut Self {
        self.builder.preset(preset);
        self
    }

    /// Try to send the message, exiting it it is at capacity
    pub async fn try_send(
        &self,
    ) -> anyhow::Result<impl Stream<Item = Result<tokio_ffmpeg_cli::Event, tokio_ffmpeg_cli::Error>>>
    {
        let (tx, rx) = oneshot::channel();
        self.task
            .tx
            .try_send(Message::Encode {
                builder: self.builder.clone(),
                tx,
            })
            .ok()
            .context("failed to send message")?;

        rx.await
            .context("encode task crashed")?
            .map(ReceiverStream::new)
    }
}