ts-analyzer 0.3.0

A simple library for analyzing packets in MPEG/Transport Stream files.
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

#![forbid(unsafe_code)]
// Use these checks when closer to complete. They're a bit too strict for early
// development. #![deny(future_incompatible, missing_docs, rust_2018_idioms,
// unused, warnings)]
#![deny(future_incompatible, rust_2018_idioms)]

//! This crate is used to read the payload data from a given transport stream.

use std::error::Error;
use std::fmt::Display;

// TODO: Add this back when you figure out a way to not have to set an
// environment variable. Pulling a test file down is an idea. Not a great idea,
// but an idea nonetheless.
//
// Include the README in the doc-tests.
// #[doc = include_str!("../README.md")]
pub mod reader;

pub mod packet;

mod helpers {
    pub mod tracked_payload;
}

#[derive(Debug, thiserror::Error)]
pub enum ErrorKind {
    /// Error that is thrown when trying to parse a byte array as a transport
    /// stream packet, but it doesn't start with a `SYNC_BYTE`.
    #[error("Invalid first byte for transport stream packet `{byte}`")]
    InvalidFirstByte {
        /// Invalid first byte.
        byte: u8,
    },

    /// Error that is thrown when the payload pointer is larger than possible
    /// could possibly fit in the remainder of the packet.
    #[error(
        "Invalid payload pointer `{pointer}` for payload with `{remainder}` bytes remaining"
    )]
    InvalidPayloadPointer { pointer: u8, remainder: u8 },

    /// Error that is thrown when trying read a payload from a packet without a
    /// payload.
    #[error("Cannot read payload from packet that has none")]
    NoPayload,

    /// Error that is thrown when trying to read a transport stream file and no
    /// SYNC byte can be found.
    #[error("Stream contains no SYNC byte")]
    NoSyncByteFound,

    /// Error that is thrown when trying to read the start of a new payload and
    /// no new payload is present in a packet.
    #[error("Continuation payload cannot be used as a starting payload")]
    PayloadIsNotStart,

    #[error(transparent)]
    Unknown(#[from] std::io::Error),
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum TransportScramblingControl {
    NoScrambling = 0,
    Reserved     = 1,
    EvenKey      = 2,
    OddKey       = 3,
}
#[derive(Clone, Copy, Debug, PartialEq)]
pub enum AdaptationFieldControl {
    Reserved             = 0,
    Payload              = 1,
    AdaptationField      = 2,
    AdaptationAndPayload = 3,
}

#[derive(Clone, Copy, Debug, PartialEq)]
pub enum Errors {
    InvalidFirstByte(u8),
}

impl Error for Errors {}

impl Display for Errors {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Errors::InvalidFirstByte(invalid_byte) => {
                write!(f, "invalid first byte for packet: [{}]", invalid_byte)
            }
        }
    }
}