eger 1.1.0

A high-level, parallel ASCII-art media pipeline built on top of iascii: images, video, GIFs, dithering, animated text/banners, and procedural illusions, all rendered to ANSI.
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
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

//! `eger` — a high-level, parallel ASCII-art media pipeline built on top
//! of [`iascii`].
//!
//! - [`config`] — fluent [`Config`]/[`ConfigBuilder`] describing input,
//!   output, sizing, and parallelism.
//! - [`image`] — single-image and Rayon-parallel batch image → ASCII
//!   rendering. Always available.
//! - `video` *(requires the `video` feature)* — video → ASCII
//!   frame-sequence rendering, streamed through `ffmpeg` with chunked
//!   Rayon-parallel conversion, plus terminal playback.
//! - [`render`] — output targets: stdout, file, `String`, or `Vec<String>`,
//!   plus terminal-size detection ([`render::terminal_size`]) and
//!   cursor-addressed diffed playback ([`render::diff_frame`],
//!   [`render::play_terminal_diffed`]) as a lower-flicker alternative to
//!   clear-and-redraw.
//! - [`text`] — text → ANSI coloring/animation: built-in styles
//!   (`Typewriter`, `Rainbow`, `Wave`, `Blink`, `Marquee`, `Pulse`) plus
//!   custom animations driven by an external program or a Rust closure.
//!   Always available (no `video` feature needed, except for the async
//!   `play_text_async`/`stream_text_frames` variants).
//! - [`banner`] — multi-line "big text" banners: the same animation styles
//!   as [`text`], rendered as block letters instead of a single line.
//! - [`colorize`] — per-*cell* (as opposed to [`text`]/[`banner`]'s
//!   per-character) color animation for *any* block of plain ASCII text —
//!   a converted image, a decoded GIF/video frame, banner text, or
//!   anything else — including [`colorize::PixelAnimation::Custom`] for
//!   fully custom, mathematically-defined coloring functions.
//! - [`segment`] — partitions a single converted image/frame into
//!   numbered/named **structures** ([`segment::SegmentMap`]), so a
//!   particular region can be bolded, colored, or animated
//!   ([`segment::SegmentStyle::Animation`]) on its own while the rest of
//!   the frame renders normally. [`segment::SequenceStyles`] extends this
//!   across a whole sequence of frames, keyed by `(frame, segment id)`.
//! - [`dither`] — Floyd–Steinberg/Atkinson error diffusion and Bayer
//!   ordered dithering, applied in character-grid space via
//!   [`Config::dither`] — mainly useful for reducing banding at
//!   [`iascii::render::ColorDepth::Ansi16`]/`Ansi256`.
//! - [`script`] — ready-made non-Latin character ramps ([`script::Script`]:
//!   Cyrillic, CJK, Devanagari, Braille, block/shade, ...) for
//!   [`ConfigBuilder::script`], alongside `iascii`'s own Latin ramps.
//! - [`illusions`] — procedurally generated optical-illusion source art
//!   (café wall, Hermann grid, twisted cord, and the animated "rotating
//!   rings" motion illusion), rendered through the same pipeline as any
//!   other image.
//! - [`wasm`] *(requires the `wasm` feature, `target_arch = "wasm32"` only)*
//!   — a thin `wasm-bindgen` wrapper around the terminal-independent parts
//!   of the pipeline, for rendering ASCII art in a browser.
//! - [`error`] — unified [`EgerError`] / [`Result`].
//!
//! `video` also gains GIF playback ([`video::play_gif`]), and [`image`]
//! gains synchronous GIF decoding ([`image::gif_to_lines`]) available
//! without the `video` feature.
//!
//! # Feature flags
//!
//! - **`video`** *(off by default)* — pulls in `tokio` and enables the
//!   `video` module (which additionally requires `ffmpeg`/`ffprobe` on
//!   `PATH` at runtime), plus the async (`_async`) variants of the image
//!   API and `render::dispatch_async`/`render::play_terminal`, since
//!   they share the same Tokio runtime dependency.
//! - **`wasm`** *(off by default)* — pulls in `wasm-bindgen` and enables
//!   the [`wasm`] module. Only meaningful when targeting `wasm32`; mutually
//!   exclusive with `video` in practice, since `tokio`/`ffmpeg`/real
//!   terminals don't exist in a browser.
//!
//! # Example
//!
//! ```rust,no_run
//! use eger::prelude::*;
//!
//! # fn run() -> eger::Result<()> {
//! let config = Config::builder(MediaType::Image)
//!     .from_file("cat.png")
//!     .max_width(120)
//!     .color_depth(ColorDepth::TrueColor)
//!     .build()?;
//! let ascii = eger::image::image_to_string(std::path::Path::new("cat.png"), &config)?;
//! println!("{ascii}");
//! # Ok(())
//! # }
//! ```

pub mod banner;
pub mod colorize;
pub mod config;
pub mod dither;
pub mod error;
pub mod illusions;
pub mod image;
mod palette;
pub mod render;
pub mod script;
pub mod segment;
pub mod text;
#[cfg(feature = "video")]
pub mod video;
#[cfg(all(target_arch = "wasm32", feature = "wasm"))]
pub mod wasm;

pub use crate::banner::{banner_frames, banner_lines};
pub use crate::colorize::{
    colorize_frames, colorize_grid, colorize_grid_frames, colorize_joined_sequence, colorize_lines,
    colorize_sequence, ColorFn, PixelAnimation,
};
pub use crate::config::{Config, ConfigBuilder, MediaType};
pub use crate::dither::{DitherMethod, DitherOptions};
pub use crate::error::{EgerError, Result};
pub use crate::illusions::{generate as generate_illusion, render_illusion, Illusion};
pub use crate::image::{
    gif_to_lines, image_to_file, image_to_lines, image_to_string, render_batch_parallel,
    render_dynamic_image, render_image_file,
};
#[cfg(feature = "video")]
pub use crate::image::{render_batch_async, render_image_file_async};
#[cfg(feature = "video")]
pub use crate::render::play_terminal_diffed;
pub use crate::render::{
    detect_render_depth, terminal_size, DiffGranularity, RenderOutput, RenderTarget,
};
pub use crate::script::Script;
pub use crate::segment::{
    Rect, Segment, SegmentMap, SegmentOptions, SegmentStyle, SegmentStyles, SequenceStyles,
};
pub use crate::text::{
    play_text, text_frames, CustomAnimation, Rgb, TextAnimOptions, TextAnimation,
};
#[cfg(feature = "video")]
pub use crate::text::{play_text_async, stream_text_frames};
#[cfg(feature = "video")]
pub use crate::video::{
    play_gif, play_video, probe, render_colorized_video_frames, render_video_frames,
    stream_colorized_video_frames, stream_video_frames, video_to_file, video_to_lines,
    video_to_lines_plain, ColorMode, VideoInfo,
};

/// Everything needed to configure and drive `eger` in one `use`.
pub mod prelude {
    pub use crate::banner::{banner_frames, banner_lines};
    pub use crate::colorize::{
        colorize_frames, colorize_grid, colorize_grid_frames, colorize_joined_sequence,
        colorize_lines, colorize_sequence, ColorFn, PixelAnimation,
    };
    pub use crate::config::{Config, ConfigBuilder, InputSource, MediaType};
    pub use crate::dither::{DitherMethod, DitherOptions};
    pub use crate::error::{ConfigError, EgerError, Result};
    pub use crate::illusions::{generate as generate_illusion, render_illusion, Illusion};
    #[cfg(feature = "video")]
    pub use crate::render::play_terminal_diffed;
    pub use crate::render::{
        detect_render_depth, terminal_size, DiffGranularity, RenderOutput, RenderTarget,
    };
    pub use crate::script::Script;
    pub use crate::segment::{
        Rect, Segment, SegmentMap, SegmentOptions, SegmentStyle, SegmentStyles, SequenceStyles,
    };
    pub use crate::text::{
        play_text, text_frames, CustomAnimation, Rgb, TextAnimOptions, TextAnimation,
    };
    #[cfg(feature = "video")]
    pub use crate::text::{play_text_async, stream_text_frames};
    #[cfg(feature = "video")]
    pub use crate::video::{
        play_gif, render_colorized_video_frames, stream_colorized_video_frames,
        video_to_lines_plain, ColorMode, VideoInfo,
    };

    pub use iascii::config::{LuminanceMethod, OutputSizing};
    pub use iascii::ramp::{Ramp, RampType};
    pub use iascii::render::ColorDepth;
}