Expand description
Commonly used types and traits.
Modules§
Structs§
- Chromaticity
Point - Chromaticity coordinates as defined by CIE 1931, expressed as 0.16 fixed-point values.
- Color
Description - Signal the content color description
- Config
- Contains the encoder configuration.
- Content
Light - High dynamic range content light level
- Context
- The encoder context.
- Diff
Generator - Encoder
Config - Encoder settings which impact the produced bitstream.
- Frame
- Represents a raw video frame
- Frame
Parameters - Optional per-frame encoder parameters
- Grain
Table Segment - Specifies parameters for enabling decoder-side grain synthesis for
a segment of video from
start_time
toend_time
. - Mastering
Display - High dynamic range mastering display color volume
- Motion
Speed Settings - Speed settings related to motion estimation and motion vector selection
- Noise
GenArgs - Settings and video data defining how to generate the film grain params.
- Opaque
- Opaque type to be passed from Frame to Packet
- Packet
- Represents a packet.
- Partition
Range - Range of block sizes to use.
- Partition
Speed Settings - Speed settings related to partition decision
- Plane
- One data plane of a frame.
- Plane
Config - Plane-specific configuration.
- Prediction
Speed Settings - Speed settings related to intra prediction mode selection
- Rate
Control Config - Rate control configuration
- Rate
Control Summary - Rate control pass summary
- Rational
- A rational number.
- Sequence
- Speed
Settings - Contains the speed settings.
- T35
- A single T.35 metadata packet.
- Tiling
Info - Tiling information
- Transform
Speed Settings - Speed settings related to transform size and type decision
Enums§
- Block
Size - Chroma
Sample Position - Sample position for subsampled chroma
- Chroma
Sampling - Chroma subsampling format
- Color
Primaries - Supported Color Primaries
- Encoder
Status - Status that can be returned by
Context
functions. - Frame
Type - Possible types of a frame.
- Frame
Type Override - Override the frame type decision
- Invalid
Config - Enumeration of possible invalid configuration errors.
- Matrix
Coefficients - Matrix coefficients
- Pixel
Range - Allowed pixel value range
- Pixel
Type - Types that can be used as pixel types.
- Prediction
Mode - Prediction
Modes Setting - Prediction modes to search.
- Rate
Control Error - Rate control errors
- RcData
- Rate Control Data
- SGRComplexity
Level - Search level for self guided restoration
- Scene
Detection Speed - Prediction modes to search.
- Segmentation
Level - Search level for segmentation
- Transfer
Characteristics - Supported Transfer Characteristics
- Transfer
Function - Tune
- TxType
Constants§
- DEFAULT_
GRAIN_ SEED - A randomly generated u16 to be used as a starting random seed for grain synthesis. The idea behind using a constant random seed is so that encodes are deterministic and reproducible.
- NUM_
UV_ COEFFS - The max number of coefficients per chroma plane for grain synthesis
- NUM_
UV_ POINTS - The max number of scaling points per chroma plane for grain synthesis
- NUM_
Y_ COEFFS - The max number of luma coefficients for grain synthesis
- NUM_
Y_ POINTS - The max number of luma scaling points for grain synthesis
Traits§
- Cast
From Primitive - Trait for casting between primitive types.
- Into
Frame - Types which can be converted into frames.
- Pixel
- A type that can be used as a pixel type.
Functions§
- generate_
photon_ noise_ params - Generates a set of photon noise parameters for a segment of video
given a set of
args
. - parse_
grain_ table - This file has the implementation details of the grain table.
- write_
grain_ table - Write a set of generated film grain params to a table file, using the standard film grain table format supported by aomenc, rav1e, and svt-av1.