scte35 0.2.0

A Rust library for creating and parsing SCTE-35 (Society of Cable Telecommunications Engineers) messages with zero-dependency.
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

#![doc = include_str!(concat!(env!("CARGO_MANIFEST_DIR"), "/README.md"))]
#![warn(missing_docs)]

use std::io;

// Internal modules
mod bit_reader;
mod commands;

// Public modules
/// Builder pattern API for creating SCTE-35 messages from scratch.
pub mod builders;
pub mod descriptors;
/// Binary encoding support for SCTE-35 messages.
pub mod encoding;
pub mod parser;
pub mod time;
pub mod types;
pub mod upid;

// CRC validation module - only included when feature is enabled
#[cfg(feature = "crc-validation")]
pub mod crc;

// Serde support module - only included when feature is enabled
#[cfg(feature = "serde")]
pub mod serde;

// Re-export commonly used CRC functions for convenience - only when available
#[cfg(feature = "crc-validation")]
pub use crc::{CrcValidatable, validate_message_crc};

// Re-export main types and functions for ease of use
pub use parser::parse_splice_info_section;

// Re-export main types
pub use types::{
    BandwidthReservation, ComponentSplice, PrivateCommand, SegmentationType, SpliceCommand,
    SpliceInfoSection, SpliceInsert, SpliceInsertComponent, SpliceNull, SpliceSchedule, TimeSignal,
};

// Re-export time types
pub use time::{BreakDuration, SpliceTime};

// Re-export UPID types
pub use upid::SegmentationUpidType;

// Re-export descriptor types
pub use descriptors::{SegmentationDescriptor, SpliceDescriptor};

/// Validates the CRC-32 checksum of an SCTE-35 message.
///
/// This is a convenience function that wraps [`crc::validate_message_crc`].
/// For more CRC functionality, use the [`crc`] module directly.
///
/// # Arguments
///
/// * `buffer` - The complete SCTE-35 message bytes
///
/// # Returns
///
/// * `Ok(true)` - CRC validation passed
/// * `Ok(false)` - CRC validation not available (feature disabled)
/// * `Err(io::Error)` - Parse error or validation error
///
/// # Example
///
/// ```rust
/// use scte35::validate_scte35_crc;
/// use data_encoding::BASE64;
///
/// let base64_message = "/DAWAAAAAAAAAP/wBQb+Qjo1vQAAuwxz9A==";
/// let buffer = BASE64.decode(base64_message.as_bytes()).unwrap();
///
/// match validate_scte35_crc(&buffer) {
///     Ok(true) => println!("CRC validation passed"),
///     Ok(false) => println!("CRC validation not available"),
///     Err(e) => eprintln!("Error: {}", e),
/// }
/// ```
#[cfg(feature = "crc-validation")]
pub fn validate_scte35_crc(buffer: &[u8]) -> Result<bool, io::Error> {
    crate::crc::validate_message_crc(buffer)
}

/// Fallback function when CRC validation is not available.
#[cfg(not(feature = "crc-validation"))]
pub fn validate_scte35_crc(_buffer: &[u8]) -> Result<bool, io::Error> {
    Ok(false)
}

// Add CRC validation methods to SpliceInfoSection when CRC feature is available
#[cfg(feature = "crc-validation")]
impl crc::CrcValidatable for types::SpliceInfoSection {
    fn validate_crc(&self, buffer: &[u8]) -> Result<bool, io::Error> {
        crate::crc::validate_message_crc(buffer)
    }

    fn get_crc(&self) -> u32 {
        self.crc_32
    }
}

// Import the test module from the old lib.rs
#[cfg(test)]
mod tests;