Struct OggPacket

pub struct OggPacket {
    pub version: u8,
    pub packet_type: OggPacketType,
    pub granule_position: u64,
    pub stream_id: u32,
    pub packet_index: u32,
    pub checksum: u32,
    pub segment_table: Vec<u8>,
    pub data: Vec<u8>,
}

• An ogg packet as a stream container

Fields

version: u8

Ogg Version must be zero

packet_type: OggPacketType

• The first packet should be OggPacketType::BeginOfStream
• The last packet should be OggPacketType::EndOfStream
• The others should be OggPacketType::Continuation

granule_position: u64

• For vorbis, this field indicates when you had decoded from the first packet to this packet, and you had finished decoding this packet, how many of the audio frames you should get.

stream_id: u32

• The identifier for the streams. Every Ogg packet belonging to a stream should have the same stream_id.

packet_index: u32

• The index of the packet, beginning from zero.

checksum: u32

• The checksum of the packet.

segment_table: Vec<u8>

• A table indicates each segment’s size, the max is 255. And the size of the table also couldn’t exceed 255.

data: Vec<u8>

• The data encapsulated in the Ogg Stream

Implementations

impl OggPacket

pub fn new( stream_id: u32, packet_type: OggPacketType, packet_index: u32, ) -> Self

Create a new Ogg packet

pub fn write(&mut self, data: &[u8]) -> usize

Write some data to the packet, returns the actual written bytes.

pub fn clear(&mut self)

Clear all data inside the packet

pub fn get_segments(&self) -> Vec<Vec<u8>>

Read all of the data as segments from the packet

pub fn get_inner_data_size(&self) -> usize

Get inner data size

pub fn get_inner_data(&self) -> Vec<u8>

Read all of the data as a flattened Vec<u8>

pub fn into_inner(self) -> Vec<u8>

Read all of the data as a flattened Vec<u8> and consume self

pub fn crc(crc: u32, data: &[u8]) -> u32

Calculate the checksum

pub fn get_checksum(ogg_packet: &[u8]) -> Result<u32>

pub fn fill_checksum_field(ogg_packet: &mut [u8]) -> Result<()>

Set the checksum for the Ogg packet

pub fn into_bytes(self) -> Vec<u8>

Serialize the packet to bytes. Only in the bytes form can calculate the checksum.

pub fn get_length(ogg_packet: &[u8]) -> Result<usize>

Retrieve the packet length in bytes

pub fn from_bytes(ogg_packet: &[u8], packet_length: &mut usize) -> Result<Self>

Deserialize the packet

pub fn from_cursor(cursor: &mut Cursor<Vec<u8>>) -> Vec<OggPacket>

Deserialize to multiple packets

Trait Implementations

impl Clone for OggPacket

fn clone(&self) -> OggPacket

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OggPacket

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

Formats the value using the given formatter.

impl Default for OggPacket

fn default() -> Self

Returns the “default value” for a type.