Struct vp9_parser::Frame
source · [−]pub struct Frame { /* private fields */ }
Expand description
A VP9 frame.
Implementations
sourceimpl Frame
impl Frame
sourcepub fn compressed_header_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
pub fn compressed_header_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
Returns a slice into the data of the compressed header.
sourcepub fn compressed_header_and_tile_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
pub fn compressed_header_and_tile_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
Returns a slice into the data of the compressed header and tile data.
sourcepub fn tile_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
pub fn tile_data(&self) -> &[u8]ⓘNotable traits for &mut [u8]impl Write for &mut [u8]impl Read for &[u8]
Returns a slice into the data of the tile data.
sourcepub fn show_existing_frame(&self) -> bool
pub fn show_existing_frame(&self) -> bool
Indicates that the frame indexed by frame_to_show_map_idx
is to be displayed.
The frame contains no actual frame data.
sourcepub fn frame_to_show_map_idx(&self) -> Option<u8>
pub fn frame_to_show_map_idx(&self) -> Option<u8>
Specifies the frame to be displayed. It is only available if show_existing_frame
is true.
sourcepub fn last_frame_type(&self) -> FrameType
pub fn last_frame_type(&self) -> FrameType
The frame type of the previous frame.
sourcepub fn frame_type(&self) -> FrameType
pub fn frame_type(&self) -> FrameType
The frame type of this frame.
sourcepub fn show_frame(&self) -> bool
pub fn show_frame(&self) -> bool
Indicates that the frame is to be displayed.
sourcepub fn error_resilient_mode(&self) -> bool
pub fn error_resilient_mode(&self) -> bool
Indicates that error resilient mode is enabled.
Error resilient mode allows the syntax of a frame to be decoded independently of previous frames.
sourcepub fn intra_only(&self) -> bool
pub fn intra_only(&self) -> bool
Indicates that a frame is an intra-only
frame.
A key frame is different to an intra-only
frame even though both only use
intra prediction. The difference is that a key frame fully resets the decoding process.
sourcepub fn reset_frame_context(&self) -> ResetFrameContext
pub fn reset_frame_context(&self) -> ResetFrameContext
Specifies whether the frame context should be reset to default values.
sourcepub fn ref_frame_indices(&self) -> &[u8; 3]
pub fn ref_frame_indices(&self) -> &[u8; 3]
The indices of the used reference frames.
sourcepub fn last_ref_frame_index(&self) -> u8
pub fn last_ref_frame_index(&self) -> u8
Last reference frame index.
sourcepub fn golden_ref_frame_index(&self) -> u8
pub fn golden_ref_frame_index(&self) -> u8
Golden reference frame index.
sourcepub fn alt_ref_frame_index(&self) -> u8
pub fn alt_ref_frame_index(&self) -> u8
Alternate reference frame index.
sourcepub fn ref_frame_sign_bias(&self) -> &[bool; 4]
pub fn ref_frame_sign_bias(&self) -> &[bool; 4]
Specifies the intended direction of the motion vector in time for each reference frame.
sourcepub fn allow_high_precision_mv(&self) -> bool
pub fn allow_high_precision_mv(&self) -> bool
Specifies the precision of the motion vectors.
False = quarter precision, True = eighth precision.
sourcepub fn refresh_frame_context(&self) -> bool
pub fn refresh_frame_context(&self) -> bool
Specifies that the probabilities computed for this frame should be stored for reference by future frames.
sourcepub fn refresh_frame_flags(&self) -> u8
pub fn refresh_frame_flags(&self) -> u8
Contains a bitmask that specifies which reference frame slots will be updated with the current frame after it is decoded.
First bit = first frame (1). Last bit = last frame (8).
sourcepub fn frame_parallel_decoding_mode(&self) -> bool
pub fn frame_parallel_decoding_mode(&self) -> bool
Specifies if parallel decoding mode is activated.
sourcepub fn frame_context_idx(&self) -> u8
pub fn frame_context_idx(&self) -> u8
Specifies which frame context to use.
sourcepub fn uncompressed_header_size(&self) -> usize
pub fn uncompressed_header_size(&self) -> usize
The size of the uncompressed header.
sourcepub fn compressed_header_size(&self) -> usize
pub fn compressed_header_size(&self) -> usize
The size of the uncompressed header.
sourcepub fn color_depth(&self) -> ColorDepth
pub fn color_depth(&self) -> ColorDepth
The color depth of the frame.
sourcepub fn color_space(&self) -> ColorSpace
pub fn color_space(&self) -> ColorSpace
The color space of the frame.
sourcepub fn color_range(&self) -> ColorRange
pub fn color_range(&self) -> ColorRange
The color range of the frame.
sourcepub fn subsampling(&self) -> Subsampling
pub fn subsampling(&self) -> Subsampling
The subsampling the frame is using.
sourcepub fn subsampling_x(&self) -> bool
pub fn subsampling_x(&self) -> bool
Indicates if sub sampling is used along the x axis.
sourcepub fn subsampling_y(&self) -> bool
pub fn subsampling_y(&self) -> bool
Indicates if sub sampling is used along the y axis.
sourcepub fn render_width(&self) -> u16
pub fn render_width(&self) -> u16
A hint for the application for the desired width to render.
sourcepub fn render_height(&self) -> u16
pub fn render_height(&self) -> u16
A hint for the application for the desired height to render.
sourcepub fn mi_cols(&self) -> u16
pub fn mi_cols(&self) -> u16
A variable holding the vertical location of the block in units of 8x8 pixels.
sourcepub fn mi_rows(&self) -> u16
pub fn mi_rows(&self) -> u16
A variable holding the horizontal location of the block in units of 8x8 pixels.
sourcepub fn tile_rows_log2(&self) -> u8
pub fn tile_rows_log2(&self) -> u8
The base 2 logarithm of the height of each tile (where the height is measured in units of 8x8 blocks)
sourcepub fn tile_cols_log2(&self) -> u8
pub fn tile_cols_log2(&self) -> u8
The base 2 logarithm of the width of each tile (where the width is measured in units of 8x8 blocks)
sourcepub fn interpolation_filter(&self) -> InterpolationFilter
pub fn interpolation_filter(&self) -> InterpolationFilter
The type of filter used in inter prediction.
sourcepub fn loop_filter_level(&self) -> u8
pub fn loop_filter_level(&self) -> u8
The loop filter strength.
sourcepub fn loop_filter_sharpness(&self) -> u8
pub fn loop_filter_sharpness(&self) -> u8
The loop filter sharpness.
sourcepub fn loop_filter_delta_enabled(&self) -> bool
pub fn loop_filter_delta_enabled(&self) -> bool
Indicates that the filter level depends on the mode and reference frame used to predict a block.
sourcepub fn update_ref_delta(&self) -> bool
pub fn update_ref_delta(&self) -> bool
Indicates that the the bitstream contains the syntax element loop_filter_ref_delta.
sourcepub fn loop_filter_ref_deltas(&self) -> &[i8; 4]
pub fn loop_filter_ref_deltas(&self) -> &[i8; 4]
Contains the adjustment needed for the filter level based on the chosen reference frame.
sourcepub fn update_mode_delta(&self) -> bool
pub fn update_mode_delta(&self) -> bool
Indicates that the the bitstream contains the syntax element loop_filter_mode_deltas.
sourcepub fn loop_filter_mode_deltas(&self) -> &[i8; 2]
pub fn loop_filter_mode_deltas(&self) -> &[i8; 2]
Contains the adjustment needed for the filter level based on the chosen mode.
sourcepub fn base_q_idx(&self) -> i32
pub fn base_q_idx(&self) -> i32
The base frame qindex. This is used for Y AC coefficients and as the base value for the other quantizers.
sourcepub fn delta_q_y_dc(&self) -> i32
pub fn delta_q_y_dc(&self) -> i32
The Y DC quantizer relative to base_q_idx.
sourcepub fn delta_q_uv_dc(&self) -> i32
pub fn delta_q_uv_dc(&self) -> i32
The UV DC quantizer relative to base_q_idx.
sourcepub fn delta_q_uv_ac(&self) -> i32
pub fn delta_q_uv_ac(&self) -> i32
The UV AC quantizer relative to base_q_idx.
sourcepub fn lossless(&self) -> bool
pub fn lossless(&self) -> bool
Indicates that the frame is coded using a special 4x4 transform designed for encoding frames that are bit-identical with the original frames.
sourcepub fn segmentation_enabled(&self) -> bool
pub fn segmentation_enabled(&self) -> bool
Specifies that this frame makes use of the segmentation tool.
sourcepub fn segmentation_update_map(&self) -> bool
pub fn segmentation_update_map(&self) -> bool
Specifies that the segmentation map should be updated during the decoding of this frame.
sourcepub fn segment_tree_probs(&self) -> &[u8; 7]
pub fn segment_tree_probs(&self) -> &[u8; 7]
The probability values to be used when decoding segment_id.
sourcepub fn segment_pred_probs(&self) -> &[u8; 3]
pub fn segment_pred_probs(&self) -> &[u8; 3]
The probability values to be used when decoding seg_id_predicted.
sourcepub fn segmentation_temporal_update(&self) -> bool
pub fn segmentation_temporal_update(&self) -> bool
Indicates that the updates to the segmentation map are coded relative to the existing segmentation map.
sourcepub fn segmentation_update_data(&self) -> bool
pub fn segmentation_update_data(&self) -> bool
Indicates that new parameters are about to be specified for each segment.
sourcepub fn segmentation_abs_or_delta_update(&self) -> bool
pub fn segmentation_abs_or_delta_update(&self) -> bool
Indicates that the segmentation parameters represent the actual values to be used, otherwise the segmentation parameters represent adjustments relative to the standard values.
sourcepub fn segment_feature_enabled(&self) -> &[[bool; 4]; 8]
pub fn segment_feature_enabled(&self) -> &[[bool; 4]; 8]
Indicates that the corresponding feature is used in a segment.
Trait Implementations
Auto Trait Implementations
impl RefUnwindSafe for Frame
impl Send for Frame
impl Sync for Frame
impl Unpin for Frame
impl UnwindSafe for Frame
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more