X-Git-Url: https://git.nihav.org/?a=blobdiff_plain;f=nihav-core%2Fsrc%2Fio%2Fbitreader.rs;h=b5f8de61cb8db863c0f2b09c00327b93e40507b6;hb=e6aaad5c5273cd814b5748b7faf3751835a37217;hp=11633266068024d02fc339bba23be465033944a4;hpb=26aa3dd30a4b14d566a40d85139076d6fa4e9bb7;p=nihav.git diff --git a/nihav-core/src/io/bitreader.rs b/nihav-core/src/io/bitreader.rs index 1163326..b5f8de6 100644 --- a/nihav-core/src/io/bitreader.rs +++ b/nihav-core/src/io/bitreader.rs @@ -1,6 +1,6 @@ //! Bitstream reader functionality. //! -//! Bitstream reader operates on `&[u8]` and allows to read bits from the slice in different modes. +//! Bitstream reader operates on `&[u8]` and allows to read bits from the slice in different modes. //! //! # Examples //! @@ -9,7 +9,7 @@ //! use nihav_core::io::bitreader::{BitReader,BitReaderMode}; //! //! # use nihav_core::io::bitreader::BitReaderResult; -//! # fn foo() -> BitReaderResult { +//! # fn foo() -> BitReaderResult { //! let bits: [u8; 4] = [ 42, 43, 44, 45 ]; //! let mut br = BitReader::new(&bits, BitReaderMode::BE); //! let value = br.read(17)?; @@ -22,7 +22,7 @@ //! use nihav_core::io::bitreader::{BitReader,BitReaderMode}; //! //! # use nihav_core::io::bitreader::BitReaderResult; -//! # fn foo() -> BitReaderResult<()> { +//! # fn foo() -> BitReaderResult<()> { //! let bits: [u8; 4] = [ 42, 43, 44, 45 ]; //! let mut br = BitReader::new(&bits, BitReaderMode::BE); //! let num_skip_bits = br.read(3)?; @@ -35,7 +35,7 @@ /// Bitstream reading modes. -#[derive(Debug)] +#[derive(Debug,Clone,Copy)] pub enum BitReaderMode { /// The stream is big endian MSB first. BE, @@ -48,7 +48,7 @@ pub enum BitReaderMode { } /// A list specifying general bitstream reading errors. -#[derive(Debug)] +#[derive(Debug,Clone,Copy)] pub enum BitReaderError { /// The reader is at the end of bitstream. BitstreamEnd, @@ -64,7 +64,7 @@ use self::BitReaderError::*; pub type BitReaderResult = Result; /// Bitstream reader. -#[derive(Debug)] +#[derive(Debug,Clone)] pub struct BitReader<'a> { cache: u64, bits: u8, @@ -77,7 +77,7 @@ pub struct BitReader<'a> { impl<'a> BitReader<'a> { /// Constructs a new instance of bitstream reader. - /// + /// /// # Examples /// /// ``` @@ -90,6 +90,9 @@ impl<'a> BitReader<'a> { BitReader{ cache: 0, pos: 0, bits: 0, src, mode } } + /// Returns the data bitstream reader uses. + pub fn get_data(&self) -> &'a [u8] { self.src } + /// Reports the current bit position in the bitstream (usually simply the number of bits read so far). pub fn tell(&self) -> usize { self.pos * 8 - (self.bits as usize) @@ -210,7 +213,7 @@ impl<'a> BitReader<'a> { /// use nihav_core::io::bitreader::{BitReader,BitReaderMode}; /// /// # use nihav_core::io::bitreader::BitReaderResult; - /// # fn foo() -> BitReaderResult { + /// # fn foo() -> BitReaderResult { /// let bits: [u8; 4] = [ 42, 43, 44, 45 ]; /// let mut br = BitReader::new(&bits, BitReaderMode::BE); /// let value = br.read(17)?; @@ -224,7 +227,7 @@ impl<'a> BitReader<'a> { if nbits == 0 { return Ok(0) } if nbits > 32 { return Err(TooManyBitsRequested) } if self.bits < nbits { - if let Err(err) = self.refill() { return Err(err) } + self.refill()?; if self.bits < nbits { return Err(BitstreamEnd) } } let res = self.read_cache(nbits); @@ -240,7 +243,7 @@ impl<'a> BitReader<'a> { pub fn read_s(&mut self, nbits: u8) -> BitReaderResult { if nbits == 0 || nbits > 32 { return Err(TooManyBitsRequested) } if self.bits < nbits { - if let Err(err) = self.refill() { return Err(err) } + self.refill()?; if self.bits < nbits { return Err(BitstreamEnd) } } let res = self.read_cache_s(nbits); @@ -252,7 +255,7 @@ impl<'a> BitReader<'a> { #[inline(always)] pub fn read_bool(&mut self) -> BitReaderResult { if self.bits < 1 { - if let Err(err) = self.refill() { return Err(err) } + self.refill()?; if self.bits < 1 { return Err(BitstreamEnd) } } let res = self.read_cache(1); @@ -270,7 +273,7 @@ impl<'a> BitReader<'a> { /// use nihav_core::io::bitreader::{BitReader,BitReaderMode}; /// /// # use nihav_core::io::bitreader::BitReaderResult; - /// # fn foo() -> BitReaderResult { + /// # fn foo() -> BitReaderResult { /// let bits: [u8; 4] = [ 42, 43, 44, 45 ]; /// let mut br = BitReader::new(&bits, BitReaderMode::BE); /// let peek_value = br.peek(8); // this should return 42 @@ -302,8 +305,11 @@ impl<'a> BitReader<'a> { self.reset_cache(); self.pos += ((skip_bits / 32) * 4) as usize; skip_bits &= 0x1F; - self.refill()?; if skip_bits > 0 { + self.refill()?; + if u32::from(self.bits) < skip_bits { + return Err(BitstreamEnd); + } self.skip_cache(skip_bits as u8); } Ok(()) @@ -318,7 +324,7 @@ impl<'a> BitReader<'a> { /// use nihav_core::io::bitreader::{BitReader,BitReaderMode}; /// /// # use nihav_core::io::bitreader::BitReaderResult; - /// # fn foo() -> BitReaderResult { + /// # fn foo() -> BitReaderResult { /// let bits: [u8; 4] = [ 42, 43, 44, 45 ]; /// let mut br = BitReader::new(&bits, BitReaderMode::BE); /// br.seek(16)?; @@ -343,7 +349,7 @@ impl<'a> BitReader<'a> { /// use nihav_core::io::bitreader::{BitReader,BitReaderMode}; /// /// # use nihav_core::io::bitreader::BitReaderResult; - /// # fn foo() -> BitReaderResult<()> { + /// # fn foo() -> BitReaderResult<()> { /// let bits: [u8; 4] = [ 42, 43, 44, 45 ]; /// let mut br = BitReader::new(&bits, BitReaderMode::BE); /// br.skip(17)?; // now reader is at bit position 17