tellur 0.4.0

Declarative video authoring in Rust: vector, raster, and timeline components with GPU rendering
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
59
60
61

//! `tellur` — the single dependency for authoring tellur timelines.
//!
//! Re-exports the engine crates under stable module paths so a project depends
//! on `tellur` alone:
//! - the component model and the `#[component]` / `Keyable` macros via [`core`],
//! - the live/host plugin contract (`TimelineCollection`, `export_timeline!`, …)
//!   at the crate root, and
//! - under the `renderer` feature (on by default) the GPU / encode backend at
//!   [`renderer`].
//! - optional authoring features such as `latex`, forwarded to the engine crates.
//!
//! The `#[component]` and `export_timeline!` macros emit their paths through this
//! facade (resolved at expansion time), so an authored project never needs to
//! depend on `tellur-core` / `tellur-plugin` / `tellur-renderer` directly.

pub use tellur_core as core;

#[cfg(feature = "renderer")]
pub use tellur_renderer as renderer;

// The plugin authoring contract: the collection trait and the `export_*!` macros
// a `cdylib` project uses to expose its timeline(s) to the host.
pub use tellur_plugin::{
    export_timeline, export_timeline_collection, single_timeline, single_timeline_with_canvas,
    EntryFn, SingleTimeline, TimelineCollection, TimelineInfo, ENTRY_SYMBOL,
};

/// Common authoring imports: the component macros plus the most-used value types.
///
/// `use tellur::prelude::*;` brings the `#[component]` / `#[derive(Keyable)]`
/// macros, everyday geometry/color types, and ordered timeline-effect verbs
/// into scope.
pub mod prelude {
    pub use tellur_core::color::Color;
    pub use tellur_core::geometry::{Anchor, Vec2};
    pub use tellur_core::timeline_component::{
        AudioEffects, AudioEffectsBuilder, EnvelopePoint, GainEnvelope, Timed, TimedBuilder, Trim,
        TrimBounds,
    };
    pub use tellur_core::{component, raster_component, vector_component, Keyable};

    pub use crate::{export_timeline, export_timeline_collection};
}

#[cfg(test)]
mod tests {
    use super::prelude::*;
    use tellur_core::timeline_container::AudioFile;

    #[test]
    fn prelude_exposes_ordered_timeline_effect_verbs() {
        let _: Trim<GainEnvelope<AudioFile>> = AudioFile::builder()
            .path("missing.wav")
            .fade_in(1.0)
            .trim(0.5..);
        let _: GainEnvelope<Trim<AudioFile>> = AudioFile::builder()
            .path("missing.wav")
            .trim(0.5..)
            .fade_in(1.0);
    }
}