OggPage

veridian_kernel::audio::codecs::vorbis

Struct OggPage

pub struct OggPage {
    pub version: u8,
    pub header_type: OggHeaderType,
    pub granule_position: u64,
    pub serial_number: u32,
    pub page_sequence: u32,
    pub crc_checksum: u32,
    pub num_segments: u8,
    pub segment_table: Vec<u8>,
    pub data_size: usize,
    pub data_offset: usize,
    pub total_size: usize,
}

Expand description

Parsed OGG page header (27 bytes fixed + segment table)

Fields§

§version: u8

Stream structure version (must be 0)

§header_type: OggHeaderType

Header type flags

§granule_position: u64

Absolute granule position

§serial_number: u32

Bitstream serial number

§page_sequence: u32

Page sequence number

§crc_checksum: u32

CRC32 checksum (over entire page with CRC field zeroed)

§num_segments: u8

Number of segments in this page

§segment_table: Vec<u8>

Segment sizes (lacing values)

§data_size: usize

Total data size (sum of segment table entries)

§data_offset: usize

Offset of page data in the source buffer

§total_size: usize

Total page size (header + segment table + data)

Implementations§

impl OggPage

pub fn parse(data: &[u8], offset: usize) -> CodecResult<OggPage>

Parse an OGG page from a byte buffer at the given offset

pub fn verify_crc(&self, data: &[u8], page_offset: usize) -> bool

Verify the CRC32 of this page against the source buffer

pub fn extract_packets(&self, data: &[u8], _page_offset: usize) -> Vec<Vec<u8>>

Extract packets from this page’s segments.

Trait Implementations§

impl Clone for OggPage

fn clone(&self) -> OggPage

Returns a duplicate of the value. Read more

1.0.0§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more

impl Debug for OggPage

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more

Auto Trait Implementations§

impl Freeze for OggPage

impl RefUnwindSafe for OggPage

impl Send for OggPage

impl Sync for OggPage

impl Unpin for OggPage

impl UnwindSafe for OggPage

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.