Struct PgsDisplaySet

pub struct PgsDisplaySet {
    pub pcs: Option<Rc<PgsPcsSegment>>,
    pub wds: Option<Rc<PgsWdsSegment>>,
    pub pds: Option<Rc<PgsPdsSegment>>,
    pub ods: Option<Rc<PgsOdsSegment>>,
}

Struct representing a collection of PGS segments required for rendering a single subtitle frame. The segments include:

• pcs: Presentation Composition Segment.
• wds: Window Definition Segment.
• pds: Palette Definition Segment.
• ods: Object Definition Segment.

Fields

pcs: Option<Rc<PgsPcsSegment>>

wds: Option<Rc<PgsWdsSegment>>

pds: Option<Rc<PgsPdsSegment>>

ods: Option<Rc<PgsOdsSegment>>

Implementations

impl PgsDisplaySet

pub fn new() -> Self

Creates a new, empty PgsDisplaySet with no segments.

Returns

A new PgsDisplaySet instance with all segment options set to None.

pub fn state(&self) -> PgsDisplaySetState

Determines the current state of the display set.

• If PCS and WDS are present, but PDS and ODS are not, the state is EmptyFrame.
• If all segments (PCS, WDS, PDS, ODS) are present, the state is Complete.
• Otherwise, the state is Incomplete.

Returns

The current state of the PgsDisplaySet.

pub fn get_rle_image(&self) -> Result<&Vec<u8>>

Returns a reference to the RLE (Run-Length Encoded) image data contained in the ODS segment.

Errors

Returns Error::IncompleteDisplaySet if the display set is not in the Complete state.

Returns

A reference to the raw RLE image data.

pub fn get_decoded_image(&self, gray: bool) -> Result<Vec<Vec<u32>>>

Decodes the RLE image data and returns the image as a 2D array of pixels.

This function decodes the image contained in the ODS segment using the palette from the PDS segment. It can return the image in either grayscale or color depending on the gray parameter.

Parameters

• gray: A boolean flag indicating whether to decode the image in grayscale (true) or color (false).

Errors

Returns Error::IncompleteDisplaySet if the display set is not in the Complete state.

Returns

A 2D vector containing the decoded pixels, where each pixel is represented as a 32-bit color value.

Trait Implementations

impl Clone for PgsDisplaySet

fn clone(&self) -> PgsDisplaySet

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PgsDisplaySet

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

Formats the value using the given formatter.

impl Default for PgsDisplaySet

fn default() -> PgsDisplaySet

Returns the “default value” for a type.