bc-mur 0.1.0

Multipart UR QR code generator — single-frame and animated fountain-coded QR sequences with optional logo overlay.
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

#![doc(html_root_url = "https://docs.rs/bc-mur/0.1.0")]
#![warn(rust_2018_idioms)]

//! # bc-mur
//!
//! Multipart UR QR code generator — single-frame and animated
//! fountain-coded QR sequences with optional logo overlay.
//!
//! This crate provides:
//! - Single-frame QR code rendering from raw bytes or UR strings
//! - Logo overlay with module-aligned compositing
//! - Animated multipart fountain-coded QR sequences (GIF)
//! - ProRes 4444 encoding via optional ffmpeg integration
//! - Frame dump for custom pipelines
//!
//! # Example
//!
//! ```rust
//! use bc_mur::{Color, CorrectionLevel, render_qr};
//!
//! let img = render_qr(
//!     b"UR:BYTES/HDCXDWINVEZM",
//!     CorrectionLevel::Low,
//!     512,
//!     Color::BLACK,
//!     Color::WHITE,
//!     1,    // quiet zone modules
//!     None, // no logo
//! )
//! .unwrap();
//! let png_bytes = img.to_png().unwrap();
//! assert!(!png_bytes.is_empty());
//! ```

mod animate;
mod color;
mod correction;
mod error;
mod logo;
mod prores;
mod qr_matrix;
mod render;

pub use animate::{
    AnimateParams, QrFrame, encode_animated_gif, generate_frames,
    write_frame_pngs,
};
pub use color::Color;
pub use correction::CorrectionLevel;
pub use error::{Error, Result};
pub use logo::{Logo, LogoClearShape};
pub use prores::encode_prores;
pub use qr_matrix::{DEFAULT_MAX_MODULES, check_qr_density, qr_module_count};
pub use render::{RenderedImage, render_qr, render_ur_qr};