Struct AVStreamGroupTileGrid

Source
#[repr(C)]
pub struct AVStreamGroupTileGrid { pub av_class: *const AVClass, pub nb_tiles: u32, pub coded_width: i32, pub coded_height: i32, pub offsets: *mut AVStreamGroupTileGrid__bindgen_ty_1, pub background: [u8; 4], pub horizontal_offset: i32, pub vertical_offset: i32, pub width: i32, pub height: i32, }
Expand description

AVStreamGroupTileGrid holds information on how to combine several independent images on a single canvas for presentation.

The output should be a @ref AVStreamGroupTileGrid.background “background” colored @ref AVStreamGroupTileGrid.coded_width “coded_width” x @ref AVStreamGroupTileGrid.coded_height “coded_height” canvas where a @ref AVStreamGroupTileGrid.nb_tiles “nb_tiles” amount of tiles are placed in the order they appear in the @ref AVStreamGroupTileGrid.offsets “offsets” array, at the exact offset described for them. In particular, if two or more tiles overlap, the image with higher index in the @ref AVStreamGroupTileGrid.offsets “offsets” array takes priority. Note that a single image may be used multiple times, i.e. multiple entries in @ref AVStreamGroupTileGrid.offsets “offsets” may have the same value of idx.

The following is an example of a simple grid with 3 rows and 4 columns:

+—+—+—+—+ | 0 | 1 | 2 | 3 | +—+—+—+—+ | 4 | 5 | 6 | 7 | +—+—+—+—+ | 8 | 9 |10 |11 | +—+—+—+—+

Assuming all tiles have a dimension of 512x512, the @ref AVStreamGroupTileGrid.offsets “offset” of the topleft pixel of the first @ref AVStreamGroup.streams “stream” in the group is “0,0”, the @ref AVStreamGroupTileGrid.offsets “offset” of the topleft pixel of the second @ref AVStreamGroup.streams “stream” in the group is “512,0”, the @ref AVStreamGroupTileGrid.offsets “offset” of the topleft pixel of the fifth @ref AVStreamGroup.streams “stream” in the group is “0,512”, the @ref AVStreamGroupTileGrid.offsets “offset”, of the topleft pixel of the sixth @ref AVStreamGroup.streams “stream” in the group is “512,512”, etc.

The following is an example of a canvas with overlaping tiles:

+———–+ | %%%%% | |**%%3%%@@@| |0%%%%%2@@| |##1@@@@@| | ##### | +———–+

Assuming a canvas with size 1024x1024 and all tiles with a dimension of 512x512, a possible @ref AVStreamGroupTileGrid.offsets “offset” for the topleft pixel of the first @ref AVStreamGroup.streams “stream” in the group would be 0x256, the @ref AVStreamGroupTileGrid.offsets “offset” for the topleft pixel of the second @ref AVStreamGroup.streams “stream” in the group would be 256x512, the @ref AVStreamGroupTileGrid.offsets “offset” for the topleft pixel of the third @ref AVStreamGroup.streams “stream” in the group would be 512x256, and the @ref AVStreamGroupTileGrid.offsets “offset” for the topleft pixel of the fourth @ref AVStreamGroup.streams “stream” in the group would be 256x0.

sizeof(AVStreamGroupTileGrid) is not a part of the ABI and may only be allocated by avformat_stream_group_create().

Fields§

§av_class: *const AVClass§nb_tiles: u32

Amount of tiles in the grid.

Must be > 0.

§coded_width: i32

Width of the canvas.

Must be > 0.

§coded_height: i32

Width of the canvas.

Must be > 0.

§offsets: *mut AVStreamGroupTileGrid__bindgen_ty_1§background: [u8; 4]

The pixel value per channel in RGBA format used if no pixel of any tile is located at a particular pixel location.

@see av_image_fill_color(). @see av_parse_color().

§horizontal_offset: i32

Offset in pixels from the left edge of the canvas where the actual image meant for presentation starts.

This field must be >= 0 and < @ref coded_width.

§vertical_offset: i32

Offset in pixels from the top edge of the canvas where the actual image meant for presentation starts.

This field must be >= 0 and < @ref coded_height.

§width: i32

Width of the final image for presentation.

Must be > 0 and <= (@ref coded_width - @ref horizontal_offset). When it’s not equal to (@ref coded_width - @ref horizontal_offset), the result of (@ref coded_width - width - @ref horizontal_offset) is the amount amount of pixels to be cropped from the right edge of the final image before presentation.

§height: i32

Height of the final image for presentation.

Must be > 0 and <= (@ref coded_height - @ref vertical_offset). When it’s not equal to (@ref coded_height - @ref vertical_offset), the result of (@ref coded_height - height - @ref vertical_offset) is the amount amount of pixels to be cropped from the bottom edge of the final image before presentation.

Trait Implementations§

Source§

impl Clone for AVStreamGroupTileGrid

Source§

fn clone(&self) -> AVStreamGroupTileGrid

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for AVStreamGroupTileGrid

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Copy for AVStreamGroupTileGrid

Auto Trait Implementations§

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more