tapciify 3.3.1

CLI tool that can let you view images in terminal as ASCII art
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

//! > **Tool to convert your images into ASCII art**
//!
//! Useful functions, when using as lib
//! - [`AsciiArtConverter::ascii_art`]
//! - [`CustomRatioResize::resize_custom_ratio`]
//!
//! ## Installation
//!
//! ```bash
//! cargo install tapciify
//! ```
//!
//! ## Converting image
//!
//! 1. Run: `tapciify -i imagePath -w imageWidth` for image.
//!
//! 2. Run: `tapciify -i imagePath -w imageWidth -r` for reversed colors.
//!
//! ## Converting video
//!
//! In this example I set framerate to 24 (but you can use any another)
//!
//! > Requires ffmpeg
//!
//! 1. Make frames from video into dir:
//!
//!    ```bash
//!    mkdir frames; ffmpeg -i bad_apple.mkv frames/%08d.jpeg
//!    ```
//!
//! 2. Run:
//!
//!    ```bash
//!    tapciify -i frames/* -w videoWidth -f 24
//!    ```
//!
//! # Examples
//!
//! Demo:
//!
//! ```
//! use image::imageops::FilterType;
//!
//! # use std::error::Error;
//!
//! use tapciify::{
//!     AsciiArtConverter, AsciiArtConverterOptions, CustomRatioResize, DEFAULT_FONT_RATIO,
//! };
//!
//! # fn main() -> Result<(), Box<dyn Error>> {
//! let img = image::open("./assets/examples/ferris.webp")?;
//!
//! let result = img
//!     .resize_custom_ratio(Some(64), None, DEFAULT_FONT_RATIO, FilterType::Triangle)
//!     .ascii_art(&AsciiArtConverterOptions {
//!         // Put your other options here
//!         ..Default::default()
//! })?;
//!
//! println!("{}", result);
//! # Ok(())
//! # }
//! ```
//!
//! Colored:
//!
//! ```
//! use std::error::Error;
//!
//! # use image::imageops::FilterType;
//!
//! use tapciify::{
//!     AsciiArtConverter, AsciiArtConverterOptions, CustomRatioResize, DEFAULT_FONT_RATIO,
//! };
//!
//! # fn main() -> Result<(), Box<dyn Error>> {
//! let img = image::open("./assets/examples/ferris.webp")?;
//!
//! let result = img
//!     .resize_custom_ratio(Some(64), None, DEFAULT_FONT_RATIO, FilterType::Triangle)
//!     .ascii_art(&AsciiArtConverterOptions {
//!         // Put your other options here
//!         colored: true,
//!         ..Default::default()
//!     })?;
//!
//! println!("{}", result);
//! # Ok(())
//! # }
//! ```

#[allow(deprecated)]
#[doc(inline)]
pub use ascii::{
    ascii_character, AsciiArt, AsciiArtConverter, AsciiArtConverterError, AsciiArtConverterOptions,
    AsciiArtPixel, AsciiStringError, ReverseString, SizeError, ToAsciiArtPixel,
    DEFAULT_ASCII_STRING,
};
#[doc(inline)]
#[cfg(feature = "player")]
pub use player::{AsciiPlayer, AsciiPlayerError, AsciiPlayerOptions};
#[doc(inline)]
pub use resize::{CustomRatioResize, DEFAULT_FONT_RATIO};

pub mod ascii;
pub mod macros;
pub mod resize;

#[cfg(feature = "player")]
pub mod player;

#[cfg(feature = "braille")]
pub mod braille;

#[cfg(feature = "background-string")]
pub mod background_string;

#[cfg(feature = "threshold-utils")]
pub mod threshold_utils;

#[cfg(feature = "player")]
pub mod cli;