fframes 1.0.2

A video generation framework
Documentation 
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

use std::{error::Error, fmt};

#[derive(Debug)]
pub enum FFramesError {
    /// Your custom error will go here if you return the Err(YourError) from your Video's render_frame.
    UserError(String),

    // All the other core fframes errors will go here:
    CanNotProcessAudioDuration(String),
    /// Means that you didn't implement neither `duration` nor `define_scenes`, nor `audio` methods.
    /// One of them is required to calculate the output duration of the video.
    ///
    /// If you see this error likely you need to implement `duration` method and define the duration..
    MissingDurationOrScenes,
    /// Something is overflowing bounds. Contain info about what is overflowed and how much.
    /// e.g. The duration of scene is overflowed by 1000 frames.
    Overflow(String, usize),
    /// Svg parser error
    ParserError(usvgr::Error),
    /// This error means that audio that were required to calculate the duration was not found
    RequiredAudioNotFound(String),
    PoisonedLock,
    MediaError(crate::media::FFramesMediaError),
}

impl Error for FFramesError {}

impl fmt::Display for FFramesError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(
            f,
            "{}",
            match self {
                FFramesError::CanNotProcessAudioDuration(file) => format!("Can not get the duration based on the AudioTimestamp::Eof. The file {file} is not a valid audio file."),
                FFramesError::MissingDurationOrScenes => "The Video trait implementation does not have  neither `duration` nor `define_scenes`, nor `audio` method implemented. One of them is required to to calculate the output duration of the video.".to_owned(),
                FFramesError::Overflow(what, overflow_by) => format!("The {what} is overflowed by {overflow_by}"),
                FFramesError::UserError(err) => format!("Custom error:\n{err}"),
                FFramesError::ParserError(err) => format!("SVG parsing error: {err:?}"),
                FFramesError::MediaError(err) => format!("Media parsing error: {err:?}"),
                FFramesError::RequiredAudioNotFound(audio) => format!("The required audio for resolving video duration {audio} was not found."),
                FFramesError::PoisonedLock => "Some lock was poisoned".to_owned(),
            }
        )
    }
}

impl From<crate::media::FFramesMediaError> for FFramesError {
    fn from(err: crate::media::FFramesMediaError) -> Self {
        FFramesError::MediaError(err)
    }
}
impl<T> From<std::sync::PoisonError<T>> for FFramesError {
    fn from(_: std::sync::PoisonError<T>) -> Self {
        FFramesError::PoisonedLock
    }
}

pub type Result<T> = std::result::Result<T, FFramesError>;