otf-pixels-codec-raw 0.2.0

Raw (uncompressed) pixel codec for otf-pixels.
Documentation
  • Coverage
  • 100%
    17 out of 17 items documented1 out of 15 items with examples
  • Size
  • Source code size: 36.2 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 280.5 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 3s Average build duration of successful builds.
  • all releases: 3s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Open-Tech-Foundation/Pixels
    0 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • Thanga-Ganapathy

otf-pixels-codec-raw

Raw pixels for Pixels

crates.io | Docs | Pixels

An Open Tech Foundation project

Uncompressed pixels with no header: the caller states width, height, pixel format and stride. A short input is an error, never a panic.

[!TIP] Building an app or a server? Use otf-pixels instead: it picks this codec from the file's bytes with its raw feature.

Use it

Transcode row by row, without holding the frame:

use otf_pixels_codec_raw::{RawDecoder, RawEncoder};
use otf_pixels_core::{Decoder, Encoder, Limits};
use otf_pixels_codec_raw::RawFormat;
use otf_pixels_core::{ImageDescriptor, PixelFormat};

let layout = RawFormat::packed(ImageDescriptor::new(640, 480, PixelFormat::Rgb8)?);
let mut decoder = RawDecoder::new(layout, std::fs::File::open("frame.rgb")?)?;
let descriptor = decoder.descriptor();
let mut encoder = RawEncoder::new();
let mut out = Vec::new();
encoder.write_header(&descriptor, &mut out)?;
let mut row = vec![0; descriptor.row_bytes()];
for _ in 0..descriptor.height {
    decoder.read_row(&mut row)?;
    encoder.write_row(&row, &mut out)?;
}
encoder.finish(&mut out)?;

Capabilities

Area Support
Decode Any PixelFormat, packed or with a row stride
Encode Packed rows

API

Item What it does
RawFormat The layout: packed, with_stride, from_dimensions
RawDecoder, RawEncoder Decoder and encoder
RawCodec Registry entry (raw has no magic bytes)

Part of Pixels

Crate Role
otf-pixels The chainable Image API most users want
otf-pixels-core Graph, tiles, scheduler, codec and op traits
otf-pixels-ops Image operations
otf-pixels-compress DEFLATE, zlib, LZW, checksums
otf-pixels-codec-* One crate per format

License

Apache-2.0 — see LICENSE.