liangsheng8708
/
ruffle
mirror of https://mirror.ghproxy.com/https://github.com/ruffle-rs/ruffle.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

video: Extract software decoders (or glue) into their own modules, add screenvideo feature

This commit is contained in:
TÖRÖK Attila 2021-12-09 01:21:41 +01:00 committed by kmeisthax
parent fdc448533d
commit 95665bdc47
9 changed files with 644 additions and 642 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
core/Cargo.toml
View File

@ -58,6 +58,7 @@ approx = "0.5.0"
default = ["minimp3", "serde"] default = ["minimp3", "serde"]
h263 = ["h263-rs", "h263-rs-yuv"] h263 = ["h263-rs", "h263-rs-yuv"]
vp6 = ["nihav_core", "nihav_codec_support", "nihav_duck", "h263-rs-yuv"] vp6 = ["nihav_core", "nihav_codec_support", "nihav_duck", "h263-rs-yuv"]
screenvideo = []
lzma = ["lzma-rs", "swf/lzma"] lzma = ["lzma-rs", "swf/lzma"]
wasm-bindgen = [ "instant/wasm-bindgen" ] wasm-bindgen = [ "instant/wasm-bindgen" ]
avm_debug = [] avm_debug = []

640
core/src/backend/video/software.rs
View File

@ -1,640 +0,0 @@
//! Pure software video decoding backend.
use crate::backend::render::{BitmapHandle, BitmapInfo, RenderBackend};
use crate::backend::video::{
DecodedFrame, EncodedFrame, Error, FrameDependency, VideoBackend, VideoStreamHandle,
};
use generational_arena::Arena;
use swf::{VideoCodec, VideoDeblocking};
/// Software video backend that proxies to CPU-only codec implementations that
/// ship with Ruffle.
pub struct SoftwareVideoBackend {
streams: Arena<VideoStream>,
}
impl Default for SoftwareVideoBackend {
fn default() -> Self {
Self::new()
}
}
impl SoftwareVideoBackend {
pub fn new() -> Self {
Self {
streams: Arena::new(),
}
}
}
impl VideoBackend for SoftwareVideoBackend {
#[allow(unreachable_code, unused_variables)]
fn register_video_stream(
&mut self,
_num_frames: u32,
size: (u16, u16),
codec: VideoCodec,
_filter: VideoDeblocking,
) -> Result<VideoStreamHandle, Error> {
let decoder: Box<dyn VideoDecoder> = match codec {
#[cfg(feature = "h263")]
VideoCodec::H263 => Box::new(h263::H263Decoder::new()),
#[cfg(feature = "vp6")]
VideoCodec::Vp6 => Box::new(vp6::Vp6Decoder::new(false, size)),
#[cfg(feature = "vp6")]
VideoCodec::Vp6WithAlpha => Box::new(vp6::Vp6Decoder::new(true, size)),
VideoCodec::ScreenVideo => Box::new(screen::ScreenVideoDecoder::new()),
_ => return Err(format!("Unsupported video codec type {:?}", codec).into()),
};
let stream = VideoStream::new(decoder);
let stream_handle = self.streams.insert(stream);
Ok(stream_handle)
}
fn preload_video_stream_frame(
&mut self,
stream: VideoStreamHandle,
encoded_frame: EncodedFrame<'_>,
) -> Result<FrameDependency, Error> {
let stream = self
.streams
.get_mut(stream)
.ok_or("Unregistered video stream")?;
stream.decoder.preload_frame(encoded_frame)
}
fn decode_video_stream_frame(
&mut self,
stream: VideoStreamHandle,
encoded_frame: EncodedFrame<'_>,
renderer: &mut dyn RenderBackend,
) -> Result<BitmapInfo, Error> {
let stream = self
.streams
.get_mut(stream)
.ok_or("Unregistered video stream")?;
let frame = stream.decoder.decode_frame(encoded_frame)?;
let handle = if let Some(bitmap) = stream.bitmap {
renderer.update_texture(bitmap, frame.width.into(), frame.height.into(), frame.rgba)?
} else {
renderer.register_bitmap_raw(frame.width.into(), frame.height.into(), frame.rgba)?
};
stream.bitmap = Some(handle);
Ok(BitmapInfo {
handle,
width: frame.width,
height: frame.height,
})
}
}
/// A single preloaded video stream.
struct VideoStream {
bitmap: Option<BitmapHandle>,
decoder: Box<dyn VideoDecoder>,
}
impl VideoStream {
fn new(decoder: Box<dyn VideoDecoder>) -> Self {
Self {
decoder,
bitmap: None,
}
}
}
/// Trait for video decoders.
/// This should be implemented for each video codec.
trait VideoDecoder {
/// Preload a frame.
///
/// No decoding is intended to happen at this point in time. Instead, the
/// video data should be inspected to determine inter-frame dependencies
/// between this and any previous frames in the stream.
///
/// Frames should be preloaded in the order that they are recieved.
///
/// Any dependencies listed here are inherent to the video bitstream. The
/// containing video stream is also permitted to introduce additional
/// interframe dependencies.
fn preload_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<FrameDependency, Error>;
/// Decode a frame of a given video stream.
///
/// This function is provided the external index of the frame, the codec
/// used to decode the data, and what codec to decode it with. The codec
/// provided here must match the one used to register the video stream.
///
/// Frames may be decoded in any order that does not violate the frame
/// dependencies declared by the output of `preload_video_stream_frame`.
///
/// The decoded frame should be returned. An `Error` can be returned if
/// a drawable bitmap can not be produced.
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error>;
}
#[cfg(feature = "h263")]
mod h263 {
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use h263_rs::parser::H263Reader;
use h263_rs::{DecoderOption, H263State, PictureTypeCode};
use h263_rs_yuv::bt601::yuv420_to_rgba;
/// H263 video decoder.
pub struct H263Decoder(H263State);
impl H263Decoder {
pub fn new() -> Self {
Self(H263State::new(DecoderOption::SORENSON_SPARK_BITSTREAM))
}
}
impl VideoDecoder for H263Decoder {
fn preload_frame(
&mut self,
encoded_frame: EncodedFrame<'_>,
) -> Result<FrameDependency, Error> {
let mut reader = H263Reader::from_source(encoded_frame.data());
let picture = self
.0
.parse_picture(&mut reader, None)?
.ok_or("Picture in video stream is not a picture")?;
match picture.picture_type {
PictureTypeCode::IFrame => Ok(FrameDependency::None),
PictureTypeCode::PFrame => Ok(FrameDependency::Past),
PictureTypeCode::DisposablePFrame => Ok(FrameDependency::Past),
_ => Err("Invalid picture type code!".into()),
}
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
let mut reader = H263Reader::from_source(encoded_frame.data());
self.0.decode_next_picture(&mut reader)?;
let picture = self
.0
.get_last_picture()
.expect("Decoding a picture should let us grab that picture");
let (width, height) = picture
.format()
.into_width_and_height()
.ok_or("H.263 decoder error!")?;
let chroma_width = picture.chroma_samples_per_row();
let (y, b, r) = picture.as_yuv();
let rgba = yuv420_to_rgba(y, b, r, width.into(), chroma_width);
Ok(DecodedFrame {
width,
height,
rgba,
})
}
}
impl Default for H263Decoder {
fn default() -> Self {
Self::new()
}
}
}
#[cfg(feature = "vp6")]
mod vp6 {
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use h263_rs_yuv::bt601::yuv420_to_rgba;
use nihav_codec_support::codecs::{NABufferRef, NAVideoBuffer, NAVideoInfo};
use nihav_codec_support::codecs::{NABufferType::Video, YUV420_FORMAT};
use nihav_core::codecs::NADecoderSupport;
use nihav_duck::codecs::vp6::{VP56Decoder, VP56Parser, VP6BR};
use nihav_duck::codecs::vpcommon::{BoolCoder, VP_YUVA420_FORMAT};
/// VP6 video decoder.
pub struct Vp6Decoder {
with_alpha: bool,
bounds: (u16, u16),
decoder: VP56Decoder,
support: NADecoderSupport,
bitreader: VP6BR,
init_called: bool,
last_frame: Option<NABufferRef<NAVideoBuffer<u8>>>,
}
impl Vp6Decoder {
pub fn new(with_alpha: bool, bounds: (u16, u16)) -> Self {
// Unfortunately, `init()` cannot be called on the decoder
// just yet, because `bounds` is only the declared size of
// the video, to which it will be cropped.
// This can be (rarely) even much smaller than the actual
// encoded size of the frames.
// `VP56Decoder::init()` needs the full encoded frame size,
// so it can allocate its internal buffers accordingly.
// The encoded frame size will be parsed from the header of
// the first encoded frame passed to `Self::decode_frame()`.
Self {
with_alpha,
bounds,
decoder: VP56Decoder::new(6, with_alpha, true),
support: NADecoderSupport::new(),
bitreader: VP6BR::new(),
init_called: false,
last_frame: None,
}
}
}
impl VideoDecoder for Vp6Decoder {
fn preload_frame(
&mut self,
encoded_frame: EncodedFrame<'_>,
) -> Result<FrameDependency, Error> {
// Luckily the very first bit of the encoded frames is exactly this flag,
// so we don't have to bother asking any "proper" decoder or parser.
Ok(
if !encoded_frame.data.is_empty() && (encoded_frame.data[0] & 0b_1000_0000) == 0 {
FrameDependency::None
} else {
FrameDependency::Past
},
)
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
// If this is the first frame, the decoder needs to be initialized.
if !self.init_called {
let mut bool_coder = BoolCoder::new(if self.with_alpha {
// The 24 bits alpha offset needs to be skipped first in this case
&encoded_frame.data[3..]
} else {
encoded_frame.data
})
.map_err(|error| {
Error::from(format!("Error constructing VP6 bool coder: {:?}", error))
})?;
let header = self
.bitreader
.parse_header(&mut bool_coder)
.map_err(|error| {
Error::from(format!("Error parsing VP6 frame header: {:?}", error))
})?;
let video_info = NAVideoInfo::new(
header.disp_w as usize * 16,
header.disp_h as usize * 16,
true,
if self.with_alpha {
VP_YUVA420_FORMAT
} else {
YUV420_FORMAT
},
);
self.decoder
.init(&mut self.support, video_info)
.map_err(|error| {
Error::from(format!("Error initializing VP6 decoder: {:?}", error))
})?;
self.init_called = true;
}
let frame = if encoded_frame.data.is_empty()
|| (self.with_alpha && encoded_frame.data.len() <= 3)
{
// This frame is empty, so it's a "skip frame"; reusing the last frame, if there is one.
match &self.last_frame {
Some(frame) => frame.clone(),
None => {
return Err(Error::from(
"No previous frame found when encountering a skip frame",
))
}
}
} else {
// Actually decoding the frame and extracting the buffer it is stored in.
let decoded = self
.decoder
.decode_frame(&mut self.support, encoded_frame.data, &mut self.bitreader)
.map_err(|error| Error::from(format!("VP6 decoder error: {:?}", error)))?;
let frame = match decoded {
(Video(buffer), _) => Ok(buffer),
_ => Err(Error::from(
"Unexpected buffer type after decoding a VP6 frame",
)),
}?;
self.last_frame = Some(frame.clone());
frame
};
// Converting it from YUV420 to RGBA.
let yuv = frame.get_data();
let (mut width, mut height) = frame.get_dimensions(0);
let (chroma_width, chroma_height) = frame.get_dimensions(1);
// We assume that there is no padding between rows
debug_assert!(frame.get_stride(0) == frame.get_dimensions(0).0);
debug_assert!(frame.get_stride(1) == frame.get_dimensions(1).0);
debug_assert!(frame.get_stride(2) == frame.get_dimensions(2).0);
// Where each plane starts in the buffer
let offsets = (
frame.get_offset(0),
frame.get_offset(1),
frame.get_offset(2),
);
let mut rgba = yuv420_to_rgba(
&yuv[offsets.0..offsets.0 + width * height],
&yuv[offsets.1..offsets.1 + chroma_width * chroma_height],
&yuv[offsets.2..offsets.2 + chroma_width * chroma_height],
width,
chroma_width,
);
// Adding in the alpha component, if present.
if self.with_alpha {
debug_assert!(frame.get_stride(3) == frame.get_dimensions(3).0);
let alpha_offset = frame.get_offset(3);
let alpha = &yuv[alpha_offset..alpha_offset + width * height];
for (alpha, rgba) in alpha.iter().zip(rgba.chunks_mut(4)) {
// The SWF spec mandates the `min` to avoid any accidental "invalid"
// premultiplied colors, which would cause strange results after blending.
// And the alpha data is encoded in full range (0-255), unlike the Y
// component of the main color data, so no remapping is needed.
rgba.copy_from_slice(&[
u8::min(rgba[0], *alpha),
u8::min(rgba[1], *alpha),
u8::min(rgba[2], *alpha),
*alpha,
]);
}
}
// Cropping the encoded frame (containing whole macroblocks) to the
// size requested by the the bounds attribute.
let &bounds = &self.bounds;
if width < bounds.0 as usize || height < bounds.1 as usize {
log::warn!("A VP6 video frame is smaller than the bounds of the stream it belongs in. This is not supported.");
// Flash Player just produces a black image in this case!
}
if width > bounds.0 as usize {
// Removing the unwanted pixels on the right edge (most commonly: unused pieces of macroblocks)
// by squishing all the rows tightly next to each other.
// Bitmap at the moment does not allow these gaps, so we need to remove them.
let new_width = bounds.0 as usize;
let new_height = usize::min(height, bounds.1 as usize);
// no need to move the first row, nor any rows on the bottom that will end up being cropped entirely
for row in 1..new_height {
rgba.copy_within(
row * width * 4..(row * width + new_width) * 4,
row * new_width * 4,
);
}
width = new_width;
height = new_height;
}
// Cropping the unwanted rows on the bottom, also dropping any unused space at the end left by the squish above
height = usize::min(height, bounds.1 as usize);
rgba.truncate(width * height * 4);
Ok(DecodedFrame {
width: width as u16,
height: height as u16,
rgba,
})
}
}
impl Default for Vp6Decoder {
fn default() -> Self {
Self::new(false, (0, 0))
}
}
}
mod screen {
// This module is heavily based on flashsv.rs from NihAV,
// written by Kostya Shishkov, with permission.
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use flate2::Decompress;
/// Screen Video (V1 only) decoder.
pub struct ScreenVideoDecoder {
w: usize,
h: usize,
block_w: usize,
block_h: usize,
tile: Vec<u8>, // acts as a scratch buffer
last_frame: Option<Vec<u8>>,
}
struct ByteReader<'a> {
data: &'a [u8],
pos: usize,
}
impl<'a> ByteReader<'a> {
fn new(data: &'a [u8]) -> Self {
Self { data, pos: 0 }
}
fn read_byte(&mut self) -> Result<u8, Error> {
if self.pos >= self.data.len() {
return Err(Error::from("Unexpected end of data"));
}
let byte = self.data[self.pos];
self.pos += 1;
Ok(byte)
}
fn read_u16be(&mut self) -> Result<u16, Error> {
let byte1 = self.read_byte()?;
let byte2 = self.read_byte()?;
Ok((byte1 as u16) << 8 | (byte2 as u16))
}
fn read_buf_ref(&mut self, length: usize) -> Result<&[u8], Error> {
if self.pos + length > self.data.len() {
return Err(Error::from("Unexpected end of data"));
}
let result = &self.data[self.pos..self.pos + length];
self.pos += length;
Ok(result)
}
}
impl ScreenVideoDecoder {
pub fn new() -> Self {
Self {
w: 0,
h: 0,
block_w: 0,
block_h: 0,
tile: vec![],
last_frame: None,
}
}
fn decode_v1(
&mut self,
src: &mut ByteReader,
data: &mut [u8],
stride: usize,
) -> Result<bool, Error> {
let mut is_intra = true;
for (yy, row) in data.chunks_mut(stride * self.block_h).enumerate() {
let cur_h = (self.h - yy * self.block_h).min(self.block_h);
for x in (0..self.w).step_by(self.block_w) {
let cur_w = (self.w - x).min(self.block_w);
let data_size = src.read_u16be()? as usize;
if data_size > 0 {
Decompress::new(true)
.decompress(
src.read_buf_ref(data_size)?,
&mut self.tile[..cur_w * cur_h * 3],
flate2::FlushDecompress::Finish,
)
.map_err(|e| format!("Error while inflating block: {}", e))?;
for (dst, src) in row[x * 3..]
.chunks_mut(stride)
.zip(self.tile.chunks(cur_w * 3))
{
dst[..cur_w * 3].copy_from_slice(src);
}
} else {
is_intra = false;
}
}
}
Ok(is_intra)
}
fn flush(&mut self) {
self.last_frame = None;
}
}
impl VideoDecoder for ScreenVideoDecoder {
fn preload_frame(
&mut self,
encoded_frame: EncodedFrame<'_>,
) -> Result<FrameDependency, Error> {
// There's this extra, undocumented byte between the VideoFrame tag headers and the actual
// SCREENVIDEOPACKET contents, which is the FrameType + CodecID fields of the VIDEODATA tags
// in FLV. This is super helpful, because it encodes whether the frame is a keyframe or not.
// Just a quick sanity check for codec IDs...
debug_assert!(encoded_frame.data[0] & 0xF == 3);
match encoded_frame.data[0] >> 4 {
1 => Ok(FrameDependency::None),
2 => Ok(FrameDependency::Past),
x => Err(Error::from(format!(
"Unexpected Screen Video frame type: {}",
x
))),
}
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
let is_keyframe = encoded_frame.data[0] >> 4 == 1;
if !is_keyframe && self.last_frame.is_none() {
return Err(Error::from("Missing reference frame"));
}
// Need to drop the extra preceding byte
let mut br = ByteReader::new(&encoded_frame.data[1..]);
let hdr0 = br.read_u16be()? as usize;
let blk_w = (hdr0 >> 12) * 16 + 16;
let w = hdr0 & 0xFFF;
let hdr1 = br.read_u16be()? as usize;
let blk_h = (hdr1 >> 12) * 16 + 16;
let h = hdr1 & 0xFFF;
debug_assert!(w != 0 && h != 0 && blk_w != 0 && blk_h != 0);
if self.w != w || self.h != h || self.block_w != blk_w || self.block_h != blk_h {
self.flush();
self.tile.resize(blk_w * blk_h * 3, 0);
self.w = w;
self.h = h;
self.block_w = blk_w;
self.block_h = blk_h;
}
let mut data = self
.last_frame
.clone()
.unwrap_or_else(|| vec![0; w * h * 3]);
let stride = w * 3;
let is_intra = self.decode_v1(&mut br, data.as_mut_slice(), stride)?;
if is_intra != is_keyframe {
return Err(Error::from(
"Not all blocks were updated by a supposed keyframe",
));
}
let mut rgba = vec![0u8; w * h * 4];
// convert from BGR to RGBA and flip Y
for y in 0..h {
let data_row = &data[y * w * 3..(y + 1) * w * 3];
let rgba_row = &mut rgba[(h - y - 1) * w * 4..(h - y) * w * 4];
for (bgr, rgba) in data_row.chunks(3).zip(rgba_row.chunks_mut(4)) {
rgba.copy_from_slice(&[bgr[2], bgr[1], bgr[0], 255]);
}
}
self.last_frame = Some(data);
Ok(DecodedFrame {
width: w as u16,
height: h as u16,
rgba,
})
}
}
impl Default for ScreenVideoDecoder {
fn default() -> Self {
Self::new()
}
}
}

61
core/src/backend/video/software/decoders/h263.rs Normal file
View File

@ -0,0 +1,61 @@
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use h263_rs::parser::H263Reader;
use h263_rs::{DecoderOption, H263State, PictureTypeCode};
use h263_rs_yuv::bt601::yuv420_to_rgba;
/// H263 video decoder.
pub struct H263Decoder(H263State);
impl H263Decoder {
pub fn new() -> Self {
Self(H263State::new(DecoderOption::SORENSON_SPARK_BITSTREAM))
}
}
impl VideoDecoder for H263Decoder {
fn preload_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<FrameDependency, Error> {
let mut reader = H263Reader::from_source(encoded_frame.data());
let picture = self
.0
.parse_picture(&mut reader, None)?
.ok_or("Picture in video stream is not a picture")?;
match picture.picture_type {
PictureTypeCode::IFrame => Ok(FrameDependency::None),
PictureTypeCode::PFrame => Ok(FrameDependency::Past),
PictureTypeCode::DisposablePFrame => Ok(FrameDependency::Past),
_ => Err("Invalid picture type code!".into()),
}
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
let mut reader = H263Reader::from_source(encoded_frame.data());
self.0.decode_next_picture(&mut reader)?;
let picture = self
.0
.get_last_picture()
.expect("Decoding a picture should let us grab that picture");
let (width, height) = picture
.format()
.into_width_and_height()
.ok_or("H.263 decoder error!")?;
let chroma_width = picture.chroma_samples_per_row();
let (y, b, r) = picture.as_yuv();
let rgba = yuv420_to_rgba(y, b, r, width.into(), chroma_width);
Ok(DecodedFrame {
width,
height,
rgba,
})
}
}
impl Default for H263Decoder {
fn default() -> Self {
Self::new()
}
}

8
core/src/backend/video/software/decoders/mod.rs Normal file
View File

@ -0,0 +1,8 @@
#[cfg(feature = "h263")]
pub mod h263;
#[cfg(feature = "vp6")]
pub mod vp6;
#[cfg(feature = "screenvideo")]
pub mod screen;

198
core/src/backend/video/software/decoders/screen.rs Normal file
View File

@ -0,0 +1,198 @@
// This module is heavily based on flashsv.rs from NihAV,
// written by Kostya Shishkov, with permission.
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use flate2::Decompress;
/// Screen Video (V1 only) decoder.
pub struct ScreenVideoDecoder {
w: usize,
h: usize,
block_w: usize,
block_h: usize,
tile: Vec<u8>, // acts as a scratch buffer
last_frame: Option<Vec<u8>>,
}
struct ByteReader<'a> {
data: &'a [u8],
pos: usize,
}
impl<'a> ByteReader<'a> {
fn new(data: &'a [u8]) -> Self {
Self { data, pos: 0 }
}
fn read_byte(&mut self) -> Result<u8, Error> {
if self.pos >= self.data.len() {
return Err(Error::from("Unexpected end of data"));
}
let byte = self.data[self.pos];
self.pos += 1;
Ok(byte)
}
fn read_u16be(&mut self) -> Result<u16, Error> {
let byte1 = self.read_byte()?;
let byte2 = self.read_byte()?;
Ok((byte1 as u16) << 8 | (byte2 as u16))
}
fn read_buf_ref(&mut self, length: usize) -> Result<&[u8], Error> {
if self.pos + length > self.data.len() {
return Err(Error::from("Unexpected end of data"));
}
let result = &self.data[self.pos..self.pos + length];
self.pos += length;
Ok(result)
}
}
impl ScreenVideoDecoder {
pub fn new() -> Self {
Self {
w: 0,
h: 0,
block_w: 0,
block_h: 0,
tile: vec![],
last_frame: None,
}
}
fn decode_v1(
&mut self,
src: &mut ByteReader,
data: &mut [u8],
stride: usize,
) -> Result<bool, Error> {
let mut is_intra = true;
for (yy, row) in data.chunks_mut(stride * self.block_h).enumerate() {
let cur_h = (self.h - yy * self.block_h).min(self.block_h);
for x in (0..self.w).step_by(self.block_w) {
let cur_w = (self.w - x).min(self.block_w);
let data_size = src.read_u16be()? as usize;
if data_size > 0 {
Decompress::new(true)
.decompress(
src.read_buf_ref(data_size)?,
&mut self.tile[..cur_w * cur_h * 3],
flate2::FlushDecompress::Finish,
)
.map_err(|e| format!("Error while inflating block: {}", e))?;
for (dst, src) in row[x * 3..]
.chunks_mut(stride)
.zip(self.tile.chunks(cur_w * 3))
{
dst[..cur_w * 3].copy_from_slice(src);
}
} else {
is_intra = false;
}
}
}
Ok(is_intra)
}
fn flush(&mut self) {
self.last_frame = None;
}
}
impl VideoDecoder for ScreenVideoDecoder {
fn preload_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<FrameDependency, Error> {
// There's this extra, undocumented byte between the VideoFrame tag headers and the actual
// SCREENVIDEOPACKET contents, which is the FrameType + CodecID fields of the VIDEODATA tags
// in FLV. This is super helpful, because it encodes whether the frame is a keyframe or not.
// Just a quick sanity check for codec IDs...
debug_assert!(encoded_frame.data[0] & 0xF == 3);
match encoded_frame.data[0] >> 4 {
1 => Ok(FrameDependency::None),
2 => Ok(FrameDependency::Past),
x => Err(Error::from(format!(
"Unexpected Screen Video frame type: {}",
x
))),
}
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
let is_keyframe = encoded_frame.data[0] >> 4 == 1;
if !is_keyframe && self.last_frame.is_none() {
return Err(Error::from("Missing reference frame"));
}
// Need to drop the extra preceding byte
let mut br = ByteReader::new(&encoded_frame.data[1..]);
let hdr0 = br.read_u16be()? as usize;
let blk_w = (hdr0 >> 12) * 16 + 16;
let w = hdr0 & 0xFFF;
let hdr1 = br.read_u16be()? as usize;
let blk_h = (hdr1 >> 12) * 16 + 16;
let h = hdr1 & 0xFFF;
debug_assert!(w != 0 && h != 0 && blk_w != 0 && blk_h != 0);
if self.w != w || self.h != h || self.block_w != blk_w || self.block_h != blk_h {
self.flush();
self.tile.resize(blk_w * blk_h * 3, 0);
self.w = w;
self.h = h;
self.block_w = blk_w;
self.block_h = blk_h;
}
let mut data = self
.last_frame
.clone()
.unwrap_or_else(|| vec![0; w * h * 3]);
let stride = w * 3;
let is_intra = self.decode_v1(&mut br, data.as_mut_slice(), stride)?;
if is_intra != is_keyframe {
return Err(Error::from(
"Not all blocks were updated by a supposed keyframe",
));
}
let mut rgba = vec![0u8; w * h * 4];
// convert from BGR to RGBA and flip Y
for y in 0..h {
let data_row = &data[y * w * 3..(y + 1) * w * 3];
let rgba_row = &mut rgba[(h - y - 1) * w * 4..(h - y) * w * 4];
for (bgr, rgba) in data_row.chunks(3).zip(rgba_row.chunks_mut(4)) {
rgba.copy_from_slice(&[bgr[2], bgr[1], bgr[0], 255]);
}
}
self.last_frame = Some(data);
Ok(DecodedFrame {
width: w as u16,
height: h as u16,
rgba,
})
}
}
impl Default for ScreenVideoDecoder {
fn default() -> Self {
Self::new()
}
}

224
core/src/backend/video/software/decoders/vp6.rs Normal file
View File

@ -0,0 +1,224 @@
use crate::backend::video::software::VideoDecoder;
use crate::backend::video::{DecodedFrame, EncodedFrame, Error, FrameDependency};
use h263_rs_yuv::bt601::yuv420_to_rgba;
use nihav_codec_support::codecs::{NABufferRef, NAVideoBuffer, NAVideoInfo};
use nihav_codec_support::codecs::{NABufferType::Video, YUV420_FORMAT};
use nihav_core::codecs::NADecoderSupport;
use nihav_duck::codecs::vp6::{VP56Decoder, VP56Parser, VP6BR};
use nihav_duck::codecs::vpcommon::{BoolCoder, VP_YUVA420_FORMAT};
/// VP6 video decoder.
pub struct Vp6Decoder {
with_alpha: bool,
bounds: (u16, u16),
decoder: VP56Decoder,
support: NADecoderSupport,
bitreader: VP6BR,
init_called: bool,
last_frame: Option<NABufferRef<NAVideoBuffer<u8>>>,
}
impl Vp6Decoder {
pub fn new(with_alpha: bool, bounds: (u16, u16)) -> Self {
// Unfortunately, `init()` cannot be called on the decoder
// just yet, because `bounds` is only the declared size of
// the video, to which it will be cropped.
// This can be (rarely) even much smaller than the actual
// encoded size of the frames.
// `VP56Decoder::init()` needs the full encoded frame size,
// so it can allocate its internal buffers accordingly.
// The encoded frame size will be parsed from the header of
// the first encoded frame passed to `Self::decode_frame()`.
Self {
with_alpha,
bounds,
decoder: VP56Decoder::new(6, with_alpha, true),
support: NADecoderSupport::new(),
bitreader: VP6BR::new(),
init_called: false,
last_frame: None,
}
}
}
impl VideoDecoder for Vp6Decoder {
fn preload_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<FrameDependency, Error> {
// Luckily the very first bit of the encoded frames is exactly this flag,
// so we don't have to bother asking any "proper" decoder or parser.
Ok(
if !encoded_frame.data.is_empty() && (encoded_frame.data[0] & 0b_1000_0000) == 0 {
FrameDependency::None
} else {
FrameDependency::Past
},
)
}
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error> {
// If this is the first frame, the decoder needs to be initialized.
if !self.init_called {
let mut bool_coder = BoolCoder::new(if self.with_alpha {
// The 24 bits alpha offset needs to be skipped first in this case
&encoded_frame.data[3..]
} else {
encoded_frame.data
})
.map_err(|error| {
Error::from(format!("Error constructing VP6 bool coder: {:?}", error))
})?;
let header = self
.bitreader
.parse_header(&mut bool_coder)
.map_err(|error| {
Error::from(format!("Error parsing VP6 frame header: {:?}", error))
})?;
let video_info = NAVideoInfo::new(
header.disp_w as usize * 16,
header.disp_h as usize * 16,
true,
if self.with_alpha {
VP_YUVA420_FORMAT
} else {
YUV420_FORMAT
},
);
self.decoder
.init(&mut self.support, video_info)
.map_err(|error| {
Error::from(format!("Error initializing VP6 decoder: {:?}", error))
})?;
self.init_called = true;
}
let frame = if encoded_frame.data.is_empty()
|| (self.with_alpha && encoded_frame.data.len() <= 3)
{
// This frame is empty, so it's a "skip frame"; reusing the last frame, if there is one.
match &self.last_frame {
Some(frame) => frame.clone(),
None => {
return Err(Error::from(
"No previous frame found when encountering a skip frame",
))
}
}
} else {
// Actually decoding the frame and extracting the buffer it is stored in.
let decoded = self
.decoder
.decode_frame(&mut self.support, encoded_frame.data, &mut self.bitreader)
.map_err(|error| Error::from(format!("VP6 decoder error: {:?}", error)))?;
let frame = match decoded {
(Video(buffer), _) => Ok(buffer),
_ => Err(Error::from(
"Unexpected buffer type after decoding a VP6 frame",
)),
}?;
self.last_frame = Some(frame.clone());
frame
};
// Converting it from YUV420 to RGBA.
let yuv = frame.get_data();
let (mut width, mut height) = frame.get_dimensions(0);
let (chroma_width, chroma_height) = frame.get_dimensions(1);
// We assume that there is no padding between rows
debug_assert!(frame.get_stride(0) == frame.get_dimensions(0).0);
debug_assert!(frame.get_stride(1) == frame.get_dimensions(1).0);
debug_assert!(frame.get_stride(2) == frame.get_dimensions(2).0);
// Where each plane starts in the buffer
let offsets = (
frame.get_offset(0),
frame.get_offset(1),
frame.get_offset(2),
);
let mut rgba = yuv420_to_rgba(
&yuv[offsets.0..offsets.0 + width * height],
&yuv[offsets.1..offsets.1 + chroma_width * chroma_height],
&yuv[offsets.2..offsets.2 + chroma_width * chroma_height],
width,
chroma_width,
);
// Adding in the alpha component, if present.
if self.with_alpha {
debug_assert!(frame.get_stride(3) == frame.get_dimensions(3).0);
let alpha_offset = frame.get_offset(3);
let alpha = &yuv[alpha_offset..alpha_offset + width * height];
for (alpha, rgba) in alpha.iter().zip(rgba.chunks_mut(4)) {
// The SWF spec mandates the `min` to avoid any accidental "invalid"
// premultiplied colors, which would cause strange results after blending.
// And the alpha data is encoded in full range (0-255), unlike the Y
// component of the main color data, so no remapping is needed.
rgba.copy_from_slice(&[
u8::min(rgba[0], *alpha),
u8::min(rgba[1], *alpha),
u8::min(rgba[2], *alpha),
*alpha,
]);
}
}
// Cropping the encoded frame (containing whole macroblocks) to the
// size requested by the the bounds attribute.
let &bounds = &self.bounds;
if width < bounds.0 as usize || height < bounds.1 as usize {
log::warn!("A VP6 video frame is smaller than the bounds of the stream it belongs in. This is not supported.");
// Flash Player just produces a black image in this case!
}
if width > bounds.0 as usize {
// Removing the unwanted pixels on the right edge (most commonly: unused pieces of macroblocks)
// by squishing all the rows tightly next to each other.
// Bitmap at the moment does not allow these gaps, so we need to remove them.
let new_width = bounds.0 as usize;
let new_height = usize::min(height, bounds.1 as usize);
// no need to move the first row, nor any rows on the bottom that will end up being cropped entirely
for row in 1..new_height {
rgba.copy_within(
row * width * 4..(row * width + new_width) * 4,
row * new_width * 4,
);
}
width = new_width;
height = new_height;
}
// Cropping the unwanted rows on the bottom, also dropping any unused space at the end left by the squish above
height = usize::min(height, bounds.1 as usize);
rgba.truncate(width * height * 4);
Ok(DecodedFrame {
width: width as u16,
height: height as u16,
rgba,
})
}
}
impl Default for Vp6Decoder {
fn default() -> Self {
Self::new(false, (0, 0))
}
}

149
core/src/backend/video/software/mod.rs Normal file
View File

@ -0,0 +1,149 @@
//! Pure software video decoding backend.
use crate::backend::render::{BitmapHandle, BitmapInfo, RenderBackend};
use crate::backend::video::{
DecodedFrame, EncodedFrame, Error, FrameDependency, VideoBackend, VideoStreamHandle,
};
use generational_arena::Arena;
use swf::{VideoCodec, VideoDeblocking};
mod decoders;
#[cfg(feature = "h263")]
use self::decoders::h263;
#[cfg(feature = "vp6")]
use self::decoders::vp6;
#[cfg(feature = "screenvideo")]
use self::decoders::screen;
/// Software video backend that proxies to CPU-only codec implementations that
/// ship with Ruffle.
pub struct SoftwareVideoBackend {
streams: Arena<VideoStream>,
}
impl Default for SoftwareVideoBackend {
fn default() -> Self {
Self::new()
}
}
impl SoftwareVideoBackend {
pub fn new() -> Self {
Self {
streams: Arena::new(),
}
}
}
impl VideoBackend for SoftwareVideoBackend {
#[allow(unreachable_code, unused_variables)]
fn register_video_stream(
&mut self,
_num_frames: u32,
size: (u16, u16),
codec: VideoCodec,
_filter: VideoDeblocking,
) -> Result<VideoStreamHandle, Error> {
let decoder: Box<dyn VideoDecoder> = match codec {
#[cfg(feature = "h263")]
VideoCodec::H263 => Box::new(h263::H263Decoder::new()),
#[cfg(feature = "vp6")]
VideoCodec::Vp6 => Box::new(vp6::Vp6Decoder::new(false, size)),
#[cfg(feature = "vp6")]
VideoCodec::Vp6WithAlpha => Box::new(vp6::Vp6Decoder::new(true, size)),
#[cfg(feature = "screenvideo")]
VideoCodec::ScreenVideo => Box::new(screen::ScreenVideoDecoder::new()),
_ => return Err(format!("Unsupported video codec type {:?}", codec).into()),
};
let stream = VideoStream::new(decoder);
let stream_handle = self.streams.insert(stream);
Ok(stream_handle)
}
fn preload_video_stream_frame(
&mut self,
stream: VideoStreamHandle,
encoded_frame: EncodedFrame<'_>,
) -> Result<FrameDependency, Error> {
let stream = self
.streams
.get_mut(stream)
.ok_or("Unregistered video stream")?;
stream.decoder.preload_frame(encoded_frame)
}
fn decode_video_stream_frame(
&mut self,
stream: VideoStreamHandle,
encoded_frame: EncodedFrame<'_>,
renderer: &mut dyn RenderBackend,
) -> Result<BitmapInfo, Error> {
let stream = self
.streams
.get_mut(stream)
.ok_or("Unregistered video stream")?;
let frame = stream.decoder.decode_frame(encoded_frame)?;
let handle = if let Some(bitmap) = stream.bitmap {
renderer.update_texture(bitmap, frame.width.into(), frame.height.into(), frame.rgba)?
} else {
renderer.register_bitmap_raw(frame.width.into(), frame.height.into(), frame.rgba)?
};
stream.bitmap = Some(handle);
Ok(BitmapInfo {
handle,
width: frame.width,
height: frame.height,
})
}
}
/// A single preloaded video stream.
struct VideoStream {
bitmap: Option<BitmapHandle>,
decoder: Box<dyn VideoDecoder>,
}
impl VideoStream {
fn new(decoder: Box<dyn VideoDecoder>) -> Self {
Self {
decoder,
bitmap: None,
}
}
}
/// Trait for video decoders.
/// This should be implemented for each video codec.
trait VideoDecoder {
/// Preload a frame.
///
/// No decoding is intended to happen at this point in time. Instead, the
/// video data should be inspected to determine inter-frame dependencies
/// between this and any previous frames in the stream.
///
/// Frames should be preloaded in the order that they are recieved.
///
/// Any dependencies listed here are inherent to the video bitstream. The
/// containing video stream is also permitted to introduce additional
/// interframe dependencies.
fn preload_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<FrameDependency, Error>;
/// Decode a frame of a given video stream.
///
/// This function is provided the external index of the frame, the codec
/// used to decode the data, and what codec to decode it with. The codec
/// provided here must match the one used to register the video stream.
///
/// Frames may be decoded in any order that does not violate the frame
/// dependencies declared by the output of `preload_video_stream_frame`.
///
/// The decoded frame should be returned. An `Error` can be returned if
/// a drawable bitmap can not be produced.
fn decode_frame(&mut self, encoded_frame: EncodedFrame<'_>) -> Result<DecodedFrame, Error>;
}

3
desktop/Cargo.toml
View File

@ -29,13 +29,14 @@ winapi = "0.3.9"
embed-resource = "1" embed-resource = "1"
[features] [features]
default = ["h263", "vp6"] default = ["h263", "vp6", "screenvideo"]
# core features # core features
avm_debug = ["ruffle_core/avm_debug"] avm_debug = ["ruffle_core/avm_debug"]
h263 = ["ruffle_core/h263"] h263 = ["ruffle_core/h263"]
lzma = ["ruffle_core/lzma"] lzma = ["ruffle_core/lzma"]
vp6 = ["ruffle_core/vp6"] vp6 = ["ruffle_core/vp6"]
screenvideo = ["ruffle_core/screenvideo"]
# wgpu features # wgpu features
render_debug_labels = ["ruffle_render_wgpu/render_debug_labels"] render_debug_labels = ["ruffle_render_wgpu/render_debug_labels"]

2
web/Cargo.toml
View File

@ -50,7 +50,7 @@ base64 = "0.13.0"
[dependencies.ruffle_core] [dependencies.ruffle_core]
path = "../core" path = "../core"
default-features = false default-features = false
features = ["h263", "vp6", "serde", "wasm-bindgen"] features = ["h263", "vp6", "screenvideo", "serde", "wasm-bindgen"]
[dependencies.web-sys] [dependencies.web-sys]
version = "0.3.50" version = "0.3.50"