Struct webp_animation::prelude::Encoder [−][src]
pub struct Encoder { /* fields omitted */ }
Expand description
An encoder for creating webp animation
Will take n
frames as an input. WebP binary data is output at the end
(wrapped into WebPData
which acts as a &[u8]
)
Example without special configuration
use webp_animation::prelude::*;
// setup
let dimensions = (64, 32);
let bright_frame = [255, 255, 255, 255].repeat(64 * 32);
let dark_frame = [0, 0, 0, 255].repeat(64 * 32);
// init encoder
let mut encoder = Encoder::new(dimensions).unwrap();
// insert frames to specific (increasing) timestamps
for i in 0..5 {
let rgba_data = if i % 2 == 0 { &bright_frame } else { &dark_frame };
let frame_timestamp = i * 170;
encoder.add_frame(rgba_data, frame_timestamp).unwrap();
}
// get encoded webp data
let final_timestamp = 1_000;
let webp_data = encoder.finalize(final_timestamp).unwrap();
// std::fs::write("my_animation.webp", webp_data);
Example with configuration
See EncodingConfig
and LossyEncodingConfig
for per-field explanations.
use webp_animation::prelude::*;
let mut encoder = Encoder::new_with_options((640, 480), EncoderOptions {
kmin: 3,
kmax: 5,
encoding_config: Some(EncodingConfig {
quality: 75.,
encoding_type: EncodingType::Lossy(LossyEncodingConfig {
segments: 2,
alpha_compression: true,
..Default::default()
}),
..Default::default()
}),
..Default::default()
}).unwrap();
Example with per-frame configuration
use webp_animation::prelude::*;
let mut encoder = Encoder::new_with_options((640, 480), EncoderOptions {
kmin: 3,
kmax: 5,
..Default::default()
}).unwrap();
encoder.add_frame_with_config(&[0u8; 640 * 480 * 4], 0, &EncodingConfig {
quality: 75.,
encoding_type: EncodingType::Lossy(LossyEncodingConfig {
segments: 2,
alpha_compression: true,
..Default::default()
}),
..Default::default()
}).unwrap();
Implementations
Construct a new encoder with default options for dimensions (width
, height
)
pub fn new_with_options(
dimensions: (u32, u32),
options: EncoderOptions
) -> Result<Self, Error>
pub fn new_with_options(
dimensions: (u32, u32),
options: EncoderOptions
) -> Result<Self, Error>
Construct a new encoder with custom options for dimensions (width
, height
)
Add a new frame to be encoded
Inputs
data
is an array of pixels inColorMode
format set byEncoderOptions
(ColorMode::Rgba
by default)timestamp
of this frame in milliseconds. Duration of a frame would be calculated as “timestamp of next frame - timestamp of this frame”. Hence, timestamps should be in non-decreasing order.
pub fn add_frame_with_config(
&mut self,
data: &[u8],
timestamp: i32,
config: &EncodingConfig
) -> Result<(), Error>
pub fn add_frame_with_config(
&mut self,
data: &[u8],
timestamp: i32,
config: &EncodingConfig
) -> Result<(), Error>
Add a new frame to be encoded with special per-frame configuration (EncodingConfig
)
See Encoder::add_frame
for data
and timestamp
explanations
Sets the default encoding config
Usually set in [EncderOptions
] at constructor (Encoder::new_with_options
)