chdlady 0.3.0

High-level facade API for reading and creating CHD files
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

//! Rust library for reading, writing, and manipulating MAME CHD (Compressed Hunks of Data) containers.
//!
//! CHD is a compressed container format created by the MAME project for storing disc and hard drive
//! images. Each container splits the source media into fixed-size hunks and compresses them
//! independently, allowing random access without full decompression.
//!
//! This crate supports:
//!
//! - **Reading** CHD v3, v4, and v5 containers (including differential/parent-child chains)
//! - **Writing** CHD v5 containers with parallel compression
//! - **Media types**: CD-ROM (CUE/GDI/TOC/CCD/MDS/NRG), DVD ISO, hard disk (with CHS geometry), laserdisc (AVI), and raw binary
//! - **Codecs**: zlib, LZMA, zstd, Huffman, FLAC, CD-optimized variants (cdzl, cdlz, cdzs, cdfl), and A/V Huffman (avhu)
//! - **Integrity**: SHA-1 verification of raw data and metadata
//!
//! ## Feature Flags
//!
//! All features are enabled by default via the `full` feature. Disable `default-features` and
//! pick only what you need to reduce compile times and binary size.
//!
//! | Feature | Description |
//! |---------|-------------|
//! | `cd` | CD-ROM creation and extraction (.cue, .toc, .ccd, .mds, .nrg) |
//! | `dvd` | DVD ISO creation and extraction |
//! | `gdrom` | GD-ROM support (implies `cd`) |
//! | `hd` | Hard disk image creation and extraction |
//! | `ld` | Laserdisc creation and extraction |
//! | `physical` | Direct optical disc conversion (CD/DVD) via SCSI/MMC pass-through |
//! | `zlib` | Deflate codec |
//! | `lzma` | LZMA codec |
//! | `zstd` | Zstandard codec |
//! | `flac` | FLAC codec for CD hunks |
//! | `rayon` | Parallel compression and decompression |
//!
//! This crate enforces `#![deny(unsafe_code)]`. Low-level SCSI pass-through transports in `chdlady-physical` isolate required OS ioctl FFI into platform-specific modules.
#![deny(missing_docs)]
#![deny(unsafe_code)]
#![cfg_attr(docsrs, feature(doc_auto_cfg))]

/// A/V container and A/V Huffman codec for Laserdisc media.
#[cfg(feature = "ld")]
pub use chdlady_av as av;
/// Core CHD container reader, decompression codecs, and verification.
pub use chdlady_core as core;
/// Disc media formats, TOC parsing, and extraction logic.
pub use chdlady_disc as disc;
/// Canonical Huffman compression codec.
pub use chdlady_huffman as huffman;

pub use chdlady_core::{
    delete_metadata_entry, read_all_metadata, write_metadata_entry, ChdError, ChdFile, ChdHeader,
    ChdInfo, ChdParentReader, ChdWriteConfig, ChdWriter, CreateResult, HunkType, MetadataEntry,
    MetadataItem, OperationPhase, ProgressStatus, VerifyResult, CHD_MDFLAGS_CHECKSUM,
};
pub use chdlady_disc::{
    codec_name, create_cd, create_dvd, create_hd, create_raw, extract_cd, extract_cd_with_progress,
    extract_hd, extract_hd_with_progress, extract_raw, extract_raw_with_progress, format_codecs,
    format_with_commas, guess_chs, inspect_create_cd, inspect_create_dvd, inspect_create_hd,
    inspect_create_raw, msf_string_from_frames, parse_compression_codecs, CcdEntry, CcdSession,
    CcdSheet, CcdTrackInfo, CdCreateInfo, CdStreamReader, CdSubcodeType, CdToc, CdTrack,
    CdTrackType, CdrdaoToc, CreateCdOptions, CreateDvdOptions, CreateHdOptions, CreateRawOptions,
    CueSheet, DiscError, DiscType, DvdCreateInfo, GdiSheet, HardDiskGeo, HdCreateInfo, HdTemplate,
    MdsDisc, MdsHeader, MdsSession, MdsTrack, Msf, NrgDisc, NrgTrack, RawCreateInfo,
    SubChannelQ, SubFrame, SubIndexEvent, SubScanSummary, SubScanner, DEFAULT_CD_CODECS, DEFAULT_HD_CODECS,
    DEFAULT_RAW_CODECS, DVD_METADATA_TAG, HARD_DISK_IDENT_METADATA_TAG, HARD_DISK_METADATA_TAG,
    HD_TEMPLATES, SUBCODE_FRAME_SIZE,
};
#[cfg(feature = "ld")]
pub use chdlady_disc::{
    create_ld, extract_ld, inspect_create_ld, CreateLdOptions, ExtractLdOptions, LdCreateInfo,
    LdError, AV_LD_METADATA_TAG, AV_METADATA_TAG, DEFAULT_LD_CODECS,
};

/// Physical optical media ingestion (CD/DVD) via SCSI/MMC.
#[cfg(feature = "physical")]
pub use chdlady_physical as physical;

#[cfg(feature = "physical")]
pub use chdlady_physical::{
    create_chd_from_drive, inspect_disc, is_optical_device_path, open_optical_transport,
    CreateDriveOptions, DiscCanonicalMap, MediaCategory, OpticalReadError, PhysicalStreamReader,
    ScsiTransport, TrackDescriptorMap,
};

#[cfg(all(feature = "physical", target_os = "linux"))]
pub use chdlady_physical::SgIoTransport;

#[cfg(all(feature = "physical", target_os = "windows"))]
pub use chdlady_physical::{is_optical_drive_letter, normalize_device_path, SptiTransport};