core: Fix various documentation errors in video

This commit is contained in:
David Wendt 2021-02-11 18:56:26 -05:00 committed by Mike Welsh
parent c5fa9eb4a8
commit d9541e1ea6
3 changed files with 7 additions and 9 deletions

View File

@ -111,10 +111,10 @@ pub struct NullVideoBackend {
///
/// Specifically:
///
/// * Registering a video stream fails silently
/// * Registering a video stream succeeds but does nothing
/// * All video frames are silently marked as keyframes
/// * Video stream decoding fails (since we can't pump arbitrary bitmaps into
/// arbitrary renderers)
/// * Video stream decoding fails with an error that video decoding is
/// unimplemented
impl NullVideoBackend {
pub fn new() -> Self {
Self {

View File

@ -10,11 +10,8 @@ use swf::{VideoCodec, VideoDeblocking};
/// A single preloaded video stream.
pub enum VideoStream {}
/// Desktop video backend.
///
/// TODO: Currently, this just proxies out to `ruffle_h263`, in the future it
/// should support desktop media playback APIs so we can take advantage of
/// hardware-accelerated video decoding.
/// Software video backend that proxies to CPU-only codec implementations that
/// ship with Ruffle.
pub struct SoftwareVideoBackend {
streams: Arena<VideoStream>,
}

View File

@ -57,6 +57,7 @@ pub struct VideoData<'gc> {
#[derive(Clone, Debug, Collect)]
#[collect(require_static)]
pub enum VideoSource {
/// A video bitstream embedded inside of a SWF movie.
SWF {
/// The movie that defined this video stream.
movie: Arc<SwfMovie>,
@ -64,7 +65,7 @@ pub enum VideoSource {
/// The video stream definition.
streamdef: DefineVideoStream,
/// The H.263 bitstream indexed by video frame ID.
/// The locations of each embedded sub-bitstream for each video frame.
///
/// Each frame consists of a start and end parameter which can be used
/// to reconstruct a reference to the embedded bitstream.