Enum gstreamer_video::VideoAFDValue

#[non_exhaustive]
pub enum VideoAFDValue {
    Unavailable,
    _169TopAligned,
    _149TopAligned,
    GreaterThan169,
    _43Full169Full,
    _43Full43Pillar,
    _169Letter169Full,
    _149Letter149Pillar,
    _43Full149Center,
    _169Letter149Center,
    _169Letter43Center,
}

Enumeration of the various values for Active Format Description (AFD)

AFD should be included in video user data whenever the rectangular picture area containing useful information does not extend to the full height or width of the coded frame. AFD data may also be included in user data when the rectangular picture area containing useful information extends to the full height and width of the coded frame.

For details, see Table 6.14 Active Format in:

ATSC Digital Television Standard: Part 4 – MPEG-2 Video System Characteristics

https://www.atsc.org/wp-content/uploads/2015/03/a_53-Part-4-2009.pdf

and Active Format Description in Complete list of AFD codes

https://en.wikipedia.org/wiki/Active_Format_DescriptionComplete_list_of_AFD_codes

and SMPTE ST2016-1

Notes:

1. AFD 0 is undefined for ATSC and SMPTE ST2016-1, indicating that AFD data is not available: If Bar Data is not present, AFD ‘0000’ indicates that exact information is not available and the active image should be assumed to be the same as the coded frame. AFD ‘0000’. AFD ‘0000’ accompanied by Bar Data signals that the active image’s aspect ratio is narrower than 16:9, but is not 4:3 or 14:9. As the exact aspect ratio cannot be conveyed by AFD alone, wherever possible, AFD ‘0000’ should be accompanied by Bar Data to define the exact vertical or horizontal extent of the active image.
2. AFD 0 is reserved for DVB/ETSI
3. values 1, 5, 6, 7, and 12 are reserved for both ATSC and DVB/ETSI
4. values 2 and 3 are not recommended for ATSC, but are valid for DVB/ETSI

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Unavailable

Unavailable (see note 0 below).

_169TopAligned

For 4:3 coded frame, letterbox 16:9 image, at top of the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

_149TopAligned

For 4:3 coded frame, letterbox 14:9 image, at top of the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

GreaterThan169

For 4:3 coded frame, letterbox image with an aspect ratio greater than 16:9, vertically centered in the coded frame. For 16:9 coded frame, letterbox image with an aspect ratio greater than 16:9.

_43Full169Full

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, full frame 16:9 image, the same as the coded frame.

_43Full43Pillar

For 4:3 coded frame, full frame 4:3 image, the same as the coded frame. For 16:9 coded frame, pillarbox 4:3 image, horizontally centered in the coded frame.

_169Letter169Full

For 4:3 coded frame, letterbox 16:9 image, vertically centered in the coded frame with all image areas protected. For 16:9 coded frame, full frame 16:9 image, with all image areas protected.

_149Letter149Pillar

For 4:3 coded frame, letterbox 14:9 image, vertically centered in the coded frame. For 16:9 coded frame, pillarbox 14:9 image, horizontally centered in the coded frame.

_43Full149Center

For 4:3 coded frame, full frame 4:3 image, with alternative 14:9 center. For 16:9 coded frame, pillarbox 4:3 image, with alternative 14:9 center.

_169Letter149Center

For 4:3 coded frame, letterbox 16:9 image, with alternative 14:9 center. For 16:9 coded frame, full frame 16:9 image, with alternative 14:9 center.

_169Letter43Center

For 4:3 coded frame, letterbox 16:9 image, with alternative 4:3 center. For 16:9 coded frame, full frame 16:9 image, with alternative 4:3 center.

Trait Implementations

impl Clone for VideoAFDValue

fn clone(&self) -> VideoAFDValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VideoAFDValue

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

Formats the value using the given formatter.

impl From<VideoAFDValue> for Value

fn from(v: VideoAFDValue) -> Self

Converts to this type from the input type.

impl<'a> FromValue<'a> for VideoAFDValue

type Checker = GenericValueTypeChecker<VideoAFDValue>

Value type checker.

unsafe fn from_value(value: &'a Value) -> Self

Get the contained value from a Value.

impl HasParamSpec for VideoAFDValue

type ParamSpec = ParamSpecEnum

type SetValue = VideoAFDValue

Preferred value to be used as setter for the associated ParamSpec.

type BuilderFn = fn(_: &str, _: VideoAFDValue) -> ParamSpecEnumBuilder<'_, VideoAFDValue>

fn param_spec_builder() -> Self::BuilderFn

impl Hash for VideoAFDValue

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for VideoAFDValue

fn cmp(&self, other: &VideoAFDValue) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for VideoAFDValue

fn eq(&self, other: &VideoAFDValue) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for VideoAFDValue

fn partial_cmp(&self, other: &VideoAFDValue) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StaticType for VideoAFDValue

fn static_type() -> Type

Returns the type identifier of Self.

impl ToValue for VideoAFDValue

fn to_value(&self) -> Value

Convert a value to a Value.

fn value_type(&self) -> Type

Returns the type identifier of self.

impl ValueType for VideoAFDValue

type Type = VideoAFDValue

Type to get the Type from.

impl Copy for VideoAFDValue

impl Eq for VideoAFDValue

impl StructuralPartialEq for VideoAFDValue