X-Git-Url: https://git.nihav.org/?a=blobdiff_plain;f=nihav-core%2Fsrc%2Fcodecs%2Fmod.rs;h=341894447f69c4cbf9f35fd0083871d2c411fe08;hb=377400a10afc6ec2c545bcd1a8293895fd6c4a5f;hp=76c683d0a9adae6cb7d0fd97fe9a2e37b7e42961;hpb=38953fb529efad1b0b609eec77f7839e62ad2719;p=nihav.git

diff --git a/nihav-core/src/codecs/mod.rs b/nihav-core/src/codecs/mod.rs
dissimilarity index 76%
index 76c683d..3418944 100644
--- a/nihav-core/src/codecs/mod.rs
+++ b/nihav-core/src/codecs/mod.rs
@@ -1,263 +1,131 @@
-use std::fmt;
-use std::ops::{Add, AddAssign, Sub, SubAssign};
-
-use crate::frame::*;
-use std::rc::Rc;
-use std::cell::RefCell;
-use std::mem;
-use crate::io::byteio::ByteIOError;
-use crate::io::bitreader::BitReaderError;
-use crate::io::codebook::CodebookError;
-
-#[derive(Debug,Clone,Copy,PartialEq)]
-#[allow(dead_code)]
-pub enum DecoderError {
-    NoFrame,
-    AllocError,
-    TryAgain,
-    InvalidData,
-    ShortData,
-    MissingReference,
-    NotImplemented,
-    Bug,
-}
-
-pub type DecoderResult<T> = Result<T, DecoderError>;
-
-impl From<ByteIOError> for DecoderError {
-    fn from(_: ByteIOError) -> Self { DecoderError::ShortData }
-}
-
-impl From<BitReaderError> for DecoderError {
-    fn from(e: BitReaderError) -> Self {
-        match e {
-            BitReaderError::BitstreamEnd => DecoderError::ShortData,
-            _ => DecoderError::InvalidData,
-        }
-    }
-}
-
-impl From<CodebookError> for DecoderError {
-    fn from(_: CodebookError) -> Self { DecoderError::InvalidData }
-}
-
-impl From<AllocatorError> for DecoderError {
-    fn from(_: AllocatorError) -> Self { DecoderError::AllocError }
-}
-
-macro_rules! validate {
-    ($a:expr) => { if !$a { println!("check failed at {}:{}", file!(), line!()); return Err(DecoderError::InvalidData); } };
-}
-
-#[allow(dead_code)]
-pub struct HAMShuffler {
-    lastframe: Option<NAVideoBuffer<u8>>,
-}
-
-impl HAMShuffler {
-    #[allow(dead_code)]
-    pub fn new() -> Self { HAMShuffler { lastframe: None } }
-    #[allow(dead_code)]
-    pub fn clear(&mut self) { self.lastframe = None; }
-    #[allow(dead_code)]
-    pub fn add_frame(&mut self, buf: NAVideoBuffer<u8>) {
-        self.lastframe = Some(buf);
-    }
-    #[allow(dead_code)]
-    pub fn clone_ref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref mut frm) = self.lastframe {
-            let newfrm = frm.copy_buffer();
-            *frm = newfrm.clone();
-            Some(newfrm)
-        } else {
-            None
-        }
-    }
-    #[allow(dead_code)]
-    pub fn get_output_frame(&mut self) -> Option<NAVideoBuffer<u8>> {
-        match self.lastframe {
-            Some(ref frm) => Some(frm.clone()),
-            None => None,
-        }
-    }
-}
-
-#[allow(dead_code)]
-pub struct IPShuffler {
-    lastframe: Option<NAVideoBuffer<u8>>,
-}
-
-impl IPShuffler {
-    #[allow(dead_code)]
-    pub fn new() -> Self { IPShuffler { lastframe: None } }
-    #[allow(dead_code)]
-    pub fn clear(&mut self) { self.lastframe = None; }
-    #[allow(dead_code)]
-    pub fn add_frame(&mut self, buf: NAVideoBuffer<u8>) {
-        self.lastframe = Some(buf);
-    }
-    #[allow(dead_code)]
-    pub fn get_ref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref frm) = self.lastframe {
-            Some(frm.clone())
-        } else {
-            None
-        }
-    }
-}
-
-#[allow(dead_code)]
-pub struct IPBShuffler {
-    lastframe: Option<NAVideoBuffer<u8>>,
-    nextframe: Option<NAVideoBuffer<u8>>,
-}
-
-impl IPBShuffler {
-    #[allow(dead_code)]
-    pub fn new() -> Self { IPBShuffler { lastframe: None, nextframe: None } }
-    #[allow(dead_code)]
-    pub fn clear(&mut self) { self.lastframe = None; self.nextframe = None; }
-    #[allow(dead_code)]
-    pub fn add_frame(&mut self, buf: NAVideoBuffer<u8>) {
-        mem::swap(&mut self.lastframe, &mut self.nextframe);
-        self.lastframe = Some(buf);
-    }
-    #[allow(dead_code)]
-    pub fn get_lastref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref frm) = self.lastframe {
-            Some(frm.clone())
-        } else {
-            None
-        }
-    }
-    #[allow(dead_code)]
-    pub fn get_nextref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref frm) = self.nextframe {
-            Some(frm.clone())
-        } else {
-            None
-        }
-    }
-    #[allow(dead_code)]
-    pub fn get_b_fwdref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref frm) = self.nextframe {
-            Some(frm.clone())
-        } else {
-            None
-        }
-    }
-    #[allow(dead_code)]
-    pub fn get_b_bwdref(&mut self) -> Option<NAVideoBuffer<u8>> {
-        if let Some(ref frm) = self.lastframe {
-            Some(frm.clone())
-        } else {
-            None
-        }
-    }
-}
-
-#[derive(Debug,Clone,Copy,PartialEq)]
-pub struct MV {
-    pub x: i16,
-    pub y: i16,
-}
-
-impl MV {
-    pub fn new(x: i16, y: i16) -> Self { MV{ x: x, y: y } }
-    pub fn pred(a: MV, b: MV, c: MV) -> Self {
-        let x;
-        if a.x < b.x {
-            if b.x < c.x {
-                x = b.x;
-            } else {
-                if a.x < c.x { x = c.x; } else { x = a.x; }
-            }
-        } else {
-            if b.x < c.x {
-                if a.x < c.x { x = a.x; } else { x = c.x; }
-            } else {
-                x = b.x;
-            }
-        }
-        let y;
-        if a.y < b.y {
-            if b.y < c.y {
-                y = b.y;
-            } else {
-                if a.y < c.y { y = c.y; } else { y = a.y; }
-            }
-        } else {
-            if b.y < c.y {
-                if a.y < c.y { y = a.y; } else { y = c.y; }
-            } else {
-                y = b.y;
-            }
-        }
-        MV { x: x, y: y }
-    }
-}
-
-pub const ZERO_MV: MV = MV { x: 0, y: 0 };
-
-impl Add for MV {
-    type Output = MV;
-    fn add(self, other: MV) -> MV { MV { x: self.x + other.x, y: self.y + other.y } }
-}
-
-impl AddAssign for MV {
-    fn add_assign(&mut self, other: MV) { self.x += other.x; self.y += other.y; }
-}
-
-impl Sub for MV {
-    type Output = MV;
-    fn sub(self, other: MV) -> MV { MV { x: self.x - other.x, y: self.y - other.y } }
-}
-
-impl SubAssign for MV {
-    fn sub_assign(&mut self, other: MV) { self.x -= other.x; self.y -= other.y; }
-}
-
-impl fmt::Display for MV {
-    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
-        write!(f, "{},{}", self.x, self.y)
-    }
-}
-
-
-pub trait NADecoder {
-    fn init(&mut self, info: Rc<NACodecInfo>) -> DecoderResult<()>;
-    fn decode(&mut self, pkt: &NAPacket) -> DecoderResult<NAFrameRef>;
-}
-
-#[derive(Clone,Copy)]
-pub struct DecoderInfo {
-    pub name: &'static str,
-    pub get_decoder: fn () -> Box<NADecoder>,
-}
-
-#[cfg(any(feature="h263"))]
-pub mod blockdsp;
-
-#[cfg(feature="h263")]
-pub mod h263;
-
-pub struct RegisteredDecoders {
-    decs:   Vec<DecoderInfo>,
-}
-
-impl RegisteredDecoders {
-    pub fn new() -> Self {
-        Self { decs: Vec::new() }
-    }
-    pub fn add_decoder(&mut self, dec: DecoderInfo) {
-        self.decs.push(dec);
-    }
-    pub fn find_decoder(&self, name: &str) -> Option<fn () -> Box<NADecoder>> {
-        for &dec in self.decs.iter() {
-            if dec.name == name {
-                return Some(dec.get_decoder);
-            }
-        }
-        None
-    }
-}
+//! Decoder interface definitions.
+pub use crate::frame::*;
+use crate::io::byteio::ByteIOError;
+use crate::io::bitreader::BitReaderError;
+use crate::io::codebook::CodebookError;
+
+/// A list specifying general decoding errors.
+#[derive(Debug,Clone,Copy,PartialEq)]
+#[allow(dead_code)]
+pub enum DecoderError {
+    /// No frame was provided.
+    NoFrame,
+    /// Allocation failed.
+    AllocError,
+    /// Operation requires repeating.
+    TryAgain,
+    /// Invalid input data was provided.
+    InvalidData,
+    /// Provided input turned out to be incomplete.
+    ShortData,
+    /// Decoder could not decode provided frame because it references some missing previous frame.
+    MissingReference,
+    /// Feature is not implemented.
+    NotImplemented,
+    /// Some bug in decoder. It should not happen yet it might.
+    Bug,
+}
+
+/// A specialised `Result` type for decoding operations.
+pub type DecoderResult<T> = Result<T, DecoderError>;
+
+impl From<ByteIOError> for DecoderError {
+    fn from(_: ByteIOError) -> Self { DecoderError::ShortData }
+}
+
+impl From<BitReaderError> for DecoderError {
+    fn from(e: BitReaderError) -> Self {
+        match e {
+            BitReaderError::BitstreamEnd => DecoderError::ShortData,
+            _ => DecoderError::InvalidData,
+        }
+    }
+}
+
+impl From<CodebookError> for DecoderError {
+    fn from(_: CodebookError) -> Self { DecoderError::InvalidData }
+}
+
+impl From<AllocatorError> for DecoderError {
+    fn from(_: AllocatorError) -> Self { DecoderError::AllocError }
+}
+
+/// Auxiliary structure for storing data used by decoder but also controlled by the caller.
+pub struct NADecoderSupport {
+    /// Frame buffer pool for 8-bit or packed video frames.
+    pub pool_u8:        NAVideoBufferPool<u8>,
+    /// Frame buffer pool for 16-bit video frames.
+    pub pool_u16:       NAVideoBufferPool<u16>,
+    /// Frame buffer pool for 32-bit video frames.
+    pub pool_u32:       NAVideoBufferPool<u32>,
+}
+
+impl NADecoderSupport {
+    /// Constructs a new instance of `NADecoderSupport`.
+    pub fn new() -> Self {
+        Self {
+            pool_u8:        NAVideoBufferPool::new(0),
+            pool_u16:       NAVideoBufferPool::new(0),
+            pool_u32:       NAVideoBufferPool::new(0),
+        }
+    }
+}
+
+impl Default for NADecoderSupport {
+    fn default() -> Self { Self::new() }
+}
+
+/// Decoder trait.
+pub trait NADecoder {
+    /// Initialises the decoder.
+    ///
+    /// It takes [`NADecoderSupport`] allocated by the caller and `NACodecInfoRef` provided by demuxer.
+    ///
+    /// [`NADecoderSupport`]: ./struct.NADecoderSupport.html
+    fn init(&mut self, supp: &mut NADecoderSupport, info: NACodecInfoRef) -> DecoderResult<()>;
+    /// Decodes a single frame.
+    fn decode(&mut self, supp: &mut NADecoderSupport, pkt: &NAPacket) -> DecoderResult<NAFrameRef>;
+    /// Tells decoder to clear internal state (e.g. after error or seeking).
+    fn flush(&mut self);
+}
+
+/// Decoder information used during creating a decoder for requested codec.
+#[derive(Clone,Copy)]
+pub struct DecoderInfo {
+    /// Short decoder name.
+    pub name: &'static str,
+    /// The function that creates a decoder instance.
+    pub get_decoder: fn () -> Box<dyn NADecoder + Send>,
+}
+
+/// Structure for registering known decoders.
+///
+/// It is supposed to be filled using `register_all_codecs()` from some decoders crate and then it can be used to create decoders for the requested codecs.
+#[derive(Default)]
+pub struct RegisteredDecoders {
+    decs:   Vec<DecoderInfo>,
+}
+
+impl RegisteredDecoders {
+    /// Constructs a new instance of `RegisteredDecoders`.
+    pub fn new() -> Self {
+        Self { decs: Vec::new() }
+    }
+    /// Adds another decoder to the registry.
+    pub fn add_decoder(&mut self, dec: DecoderInfo) {
+        self.decs.push(dec);
+    }
+    /// Searches for the decoder for the provided name and returns a function for creating it on success.
+    pub fn find_decoder(&self, name: &str) -> Option<fn () -> Box<dyn NADecoder + Send>> {
+        for &dec in self.decs.iter() {
+            if dec.name == name {
+                return Some(dec.get_decoder);
+            }
+        }
+        None
+    }
+    /// Provides an iterator over currently registered decoders.
+    pub fn iter(&self) -> std::slice::Iter<DecoderInfo> {
+        self.decs.iter()
+    }
+}