Refactor vp8 functionality into lossy module (#172)

Author: fintelia

src/decoder.rs

@@ -9,7 +9,7 @@ use std::ops::Range;
 use crate::extended::{self, get_alpha_predictor, read_alpha_chunk, WebPExtendedInfo};
 
 use super::lossless::LosslessDecoder;
-use super::vp8::Vp8Decoder;
+use super::lossy::Vp8Decoder;
 
 quick_error! {
     /// Errors that can occur when attempting to decode a WebP image

src/encoder.rs

@@ -5,7 +5,7 @@ use std::slice::ChunksExact;
 
 use quick_error::quick_error;
 
-use crate::vp8_encoder::encode_frame_lossy;
+use crate::lossy::encoder::encode_frame_lossy;
 
 /// Color type of the image.
 ///

src/lib.rs

@@ -19,15 +19,21 @@ mod decoder;
 mod encoder;
 mod extended;
 mod huffman;
-mod loop_filter;
 mod lossless;
 mod lossless_transform;
-mod transform;
-mod vp8_arithmetic_decoder;
-mod vp8_arithmetic_encoder;
-mod vp8_common;
-mod vp8_encoder;
-mod vp8_prediction;
-mod yuv;
+mod lossy;
 
-pub mod vp8;
+/// An implementation of the VP8 Video Codec
+///
+/// This module contains a partial implementation of the
+/// VP8 video format as defined in RFC-6386.
+///
+/// It decodes Keyframes only.
+/// VP8 is the underpinning of the WebP image format
+///
+/// # Related Links
+/// * [rfc-6386](http://tools.ietf.org/html/rfc6386) - The VP8 Data Format and Decoding Guide
+/// * [VP8.pdf](http://static.googleusercontent.com/media/research.google.com/en//pubs/archive/37073.pdf) - An overview of of the VP8 format
+pub mod vp8 {
+    pub use crate::lossy::{Frame, Vp8Decoder};
+}

src/vp8_arithmetic_decoder.rs src/lossy/arithmetic_decoder.rssrc/vp8_arithmetic_decoder.rs renamed to src/lossy/arithmetic_decoder.rs

@@ -1,6 +1,6 @@
 use crate::decoder::DecodingError;
 
-use super::vp8::TreeNode;
+use super::TreeNode;
 
 #[must_use]
 #[repr(transparent)]

src/vp8_arithmetic_encoder.rs src/lossy/arithmetic_encoder.rssrc/vp8_arithmetic_encoder.rs renamed to src/lossy/arithmetic_encoder.rs

@@ -163,8 +163,8 @@ impl ArithmeticEncoder {
 
 #[cfg(test)]
 mod tests {
-    use crate::vp8_arithmetic_decoder::ArithmeticDecoder;
-    use crate::vp8_common::*;
+    use crate::lossy::arithmetic_decoder::ArithmeticDecoder;
+    use crate::lossy::common::*;
 
     use super::*;
 

src/vp8_common.rs src/lossy/common.rssrc/vp8_common.rs renamed to src/lossy/common.rs

@@ -2,13 +2,13 @@ use std::io::Write;
 
 use byteorder_lite::{LittleEndian, WriteBytesExt};
 
-use crate::transform;
-use crate::vp8::Frame;
-use crate::vp8_arithmetic_encoder::ArithmeticEncoder;
-use crate::vp8_common::*;
-use crate::vp8_prediction::*;
-use crate::yuv::convert_image_y;
-use crate::yuv::convert_image_yuv;
+use super::arithmetic_encoder::ArithmeticEncoder;
+use super::common::*;
+use super::prediction::*;
+use super::transform;
+use super::yuv::convert_image_y;
+use super::yuv::convert_image_yuv;
+use super::Frame;
 use crate::ColorType;
 use crate::EncodingError;
 

src/vp8_encoder.rs src/lossy/encoder.rssrc/vp8_encoder.rs renamed to src/lossy/encoder.rs

@@ -1,26 +1,21 @@
-//! An implementation of the VP8 Video Codec
-//!
-//! This module contains a partial implementation of the
-//! VP8 video format as defined in RFC-6386.
-//!
-//! It decodes Keyframes only.
-//! VP8 is the underpinning of the WebP image format
-//!
-//! # Related Links
-//! * [rfc-6386](http://tools.ietf.org/html/rfc6386) - The VP8 Data Format and Decoding Guide
-//! * [VP8.pdf](http://static.googleusercontent.com/media/research.google.com/en//pubs/archive/37073.pdf) - An overview of of the VP8 format
-
 use byteorder_lite::{LittleEndian, ReadBytesExt};
 use std::default::Default;
 use std::io::Read;
 
 use crate::decoder::{DecodingError, UpsamplingMethod};
-use crate::vp8_common::*;
-use crate::vp8_prediction::*;
-use crate::yuv;
-
-use super::vp8_arithmetic_decoder::ArithmeticDecoder;
-use super::{loop_filter, transform};
+use common::*;
+use prediction::*;
+
+use arithmetic_decoder::ArithmeticDecoder;
+
+mod arithmetic_decoder;
+mod arithmetic_encoder;
+mod common;
+pub(crate) mod encoder;
+mod loop_filter;
+mod prediction;
+mod transform;
+mod yuv;
 
 #[derive(Clone, Copy)]
 pub(crate) struct TreeNode {

src/loop_filter.rs src/lossy/loop_filter.rssrc/loop_filter.rs renamed to src/lossy/loop_filter.rs

@@ -2,7 +2,7 @@
 //!
 //! Functions for doing prediction and for setting up buffers for prediction
 
-use crate::vp8_common::IntraMode;
+use super::common::IntraMode;
 
 /// Luma prediction block includes the 1 pixel border to the left and on top
 /// as well as 4 pixels to the top right of the block