Skip to content
/ viuer Public
forked from atanunq/viuer

Rust library for displaying images in the terminal.

0 stars 48 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

code-relay-io/viuer

BranchesTags
 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

95 Commits
.github/workflows
.github/workflows
 
 
src
src
 
 
.gitignore
.gitignore
 
 
CHANGELOG.md
CHANGELOG.md
 
 
Cargo.toml
Cargo.toml
 
 
README.md
README.md
 
 

Repository files navigation

Code Relay:

Task #18:

Task #17:

Task #16:

  • Need to check for sixel support on windows.
  • Check if sixel is supported by looking at TERM enviornemnt variable and see if it matches a known supporting terminal.

Task #15:

Found the origin of the escape code. It's an xterm specific settingsS https://invisible-island.net/xterm/ctlseqs/ctlseqs.html#h3-Functions-using-CSI-_-ordered-by-the-final-character_s_

  • Check the TERM variable to see if it is a supported term.
  • If it is xterm. Check the device attributes

CSI Ps c Send Device Attributes (Primary DA). Ps = 0 or omitted ⇒ request attributes from terminal. The response depends on the decTerminalID resource setting. ⇒ CSI ? 1 ; 2 c ("VT100 with Advanced Video Option") ⇒ CSI ? 1 ; 0 c ("VT101 with No Options") ⇒ CSI ? 4 ; 6 c ("VT132 with Advanced Video and Graphics") ⇒ CSI ? 6 c ("VT102") ⇒ CSI ? 7 c ("VT131") ⇒ CSI ? 1 2 ; Ps c ("VT125") ⇒ CSI ? 6 2 ; Ps c ("VT220") ⇒ CSI ? 6 3 ; Ps c ("VT320") ⇒ CSI ? 6 4 ; Ps c ("VT420")

The VT100-style response parameters do not mean anything by themselves. VT220 (and higher) parameters do, telling the host what features the terminal supports: Ps = 1 ⇒ 132-columns. Ps = 2 ⇒ Printer. Ps = 3 ⇒ ReGIS graphics. Ps = 4 ⇒ Sixel graphics. Ps = 6 ⇒ Selective erase. Ps = 8 ⇒ User-defined keys. Ps = 9 ⇒ National Replacement Character sets. Ps = 1 5 ⇒ Technical characters. Ps = 1 6 ⇒ Locator port. Ps = 1 7 ⇒ Terminal state interrogation. Ps = 1 8 ⇒ User windows. Ps = 2 1 ⇒ Horizontal scrolling. Ps = 2 2 ⇒ ANSI color, e.g., VT525. Ps = 2 8 ⇒ Rectangular editing. Ps = 2 9 ⇒ ANSI text locator (i.e., DEC Locator mode).

Task #14: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

"\033[0c" for querying the terminal capabilities - we need a 4 for sixel.

We also need to know what the size of a character box is in pixels this differs from terminal to terminal:

"\033[14t" gives us the terminal size in pixels

"\033[18t" gives us the terminal size in cells

from that we can calculate the cell size in pixels.

We set the position with "\033[%d;%dH" before printing the sixel string. the position string is simply prepended.

The first %d is the Y position (in cells) and the second the X position.\

  • Find a way to read value in from terminal after running escape code to check if it is 4
  • Find a way to test the escape code without writing the value to the current console.

Task #13: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

"\033[0c" for querying the terminal capabilities - we need a 4 for sixel.

We also need to know what the size of a character box is in pixels this differs from terminal to terminal:

"\033[14t" gives us the terminal size in pixels

"\033[18t" gives us the terminal size in cells

from that we can calculate the cell size in pixels.

We set the position with "\033[%d;%dH" before printing the sixel string. the position string is simply prepended.

The first %d is the Y position (in cells) and the second the X position.\

  • Find a way to read value in from terminal after running escape code to check if it is 4

Task #12: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

"\033[0c" for querying the terminal capabilities - we need a 4 for sixel.

We also need to know what the size of a character box is in pixels this differs from terminal to terminal:

"\033[14t" gives us the terminal size in pixels

"\033[18t" gives us the terminal size in cells

from that we can calculate the cell size in pixels.

We set the position with "\033[%d;%dH" before printing the sixel string. the position string is simply prepended.

The first %d is the Y position (in cells) and the second the X position.

Task #11: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

Task #10: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

Task #9: Complete sixel::check_sixel_support Check for sixel compatibility in the main print method. If that is the case, call SixelPrinter, which lives in sixel.rs and implements the Printer trait.

Task #8:

Add SixelError to impl std::fmt::Display for ViuError .

Task #7: Remove MResult from printer sixel. Make it all ViuResult

Task #6:

Make SixlPrinter print return a ViuResult instead of an MResult

Task #5;

Make a SixlPrinter struct and implement printer using sixel_print. (in printer/sixel)

Task #4:

Added print_sixel to printer::mod.rs

Task #3: Task 2 was not completed as mentioned by author, so I actually added sixel to cargo.

Still need to complete sixel.rs, looking at example in issue. Right now sixel.rs is just a copy of kitty.rs

Task #2: Implement this atanunq#4 (comment)

  • already added sixel to cargo
  • Complete sixel.rs, look at example in issue

Task #1: Implement this atanunq#4 (comment)

viuer

Display images in the terminal with ease.

ci

viuer is a Rust library that makes it easy to show images in the terminal. It has a straightforward interface and is configured through a single struct. The default printing method is through lower half blocks (▄ or \u2585). However some custom graphics protocols are supported. They result in full resolution images being displayed in specific environments:

For a demo of the library's usage and example screenshots, see viu.

Examples

# in Cargo.toml, under [dependencies]
viuer = "0.3"
// in src/main.rs
use viuer::{print_from_file, Config};

fn main() {
    let conf = Config {
        // set offset
        x: 20,
        y: 4,
        // set dimensions
        width: Some(80),
        height: Some(25),
        ..Default::default()
    };

    // starting from row 4 and column 20,
    // display `img.jpg` with dimensions 80x25 (in terminal cells)
    // note that the actual resolution in the terminal will be 80x50
    print_from_file("img.jpg", &conf).expect("Image printing failed.");
}

Or if you have a DynamicImage, you can use it directly:

// ..Config setup

let img = image::DynamicImage::ImageRgba8(image::RgbaImage::new(20, 10));
viuer::print(&img, &conf).expect("Image printing failed.");

Docs

Check the full documentation for examples and all the configuration options.

About

Rust library for displaying images in the terminal.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

0 watching

Forks

2 forks
Report repository

Releases

4 tags

Packages

No packages published

Languages

  • Rust 100.0%