1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558
// Copyright 2017 Brian Langenberger // // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your // option. This file may not be copied, modified, or distributed // except according to those terms. //! Traits and implementations for writing bits to a stream. //! //! ## Example //! //! Writing the initial STREAMINFO block to a FLAC file, //! as documented in its //! [specification](https://xiph.org/flac/format.html#stream). //! //! ``` //! use std::io::Write; //! use bitstream_io::{BigEndian, BitWriter}; //! //! let mut flac: Vec<u8> = Vec::new(); //! { //! let mut writer = BitWriter::endian(&mut flac, BigEndian); //! //! // stream marker //! writer.write_bytes(b"fLaC").unwrap(); //! //! // metadata block header //! let last_block: bool = false; //! let block_type: u8 = 0; //! let block_size: u32 = 34; //! writer.write_bit(last_block).unwrap(); //! writer.write(7, block_type).unwrap(); //! writer.write(24, block_size).unwrap(); //! //! // STREAMINFO block //! let minimum_block_size: u16 = 4096; //! let maximum_block_size: u16 = 4096; //! let minimum_frame_size: u32 = 1542; //! let maximum_frame_size: u32 = 8546; //! let sample_rate: u32 = 44100; //! let channels: u8 = 2; //! let bits_per_sample: u8 = 16; //! let total_samples: u64 = 304844; //! writer.write(16, minimum_block_size).unwrap(); //! writer.write(16, maximum_block_size).unwrap(); //! writer.write(24, minimum_frame_size).unwrap(); //! writer.write(24, maximum_frame_size).unwrap(); //! writer.write(20, sample_rate).unwrap(); //! writer.write(3, channels - 1).unwrap(); //! writer.write(5, bits_per_sample - 1).unwrap(); //! writer.write(36, total_samples).unwrap(); //! } //! //! // STREAMINFO's MD5 sum //! //! // Note that the wrapped writer can be used once bitstream writing //! // is finished at exactly the position one would expect. //! //! flac.write_all( //! b"\xFA\xF2\x69\x2F\xFD\xEC\x2D\x5B\x30\x01\x76\xB4\x62\x88\x7D\x92") //! .unwrap(); //! //! assert_eq!(flac, vec![0x66,0x4C,0x61,0x43,0x00,0x00,0x00,0x22, //! 0x10,0x00,0x10,0x00,0x00,0x06,0x06,0x00, //! 0x21,0x62,0x0A,0xC4,0x42,0xF0,0x00,0x04, //! 0xA6,0xCC,0xFA,0xF2,0x69,0x2F,0xFD,0xEC, //! 0x2D,0x5B,0x30,0x01,0x76,0xB4,0x62,0x88, //! 0x7D,0x92]); //! ``` #![warn(missing_docs)] use std::io; use super::{BitQueue, Endianness, Numeric, SignedNumeric}; use huffman::WriteHuffmanTree; /// For writing bit values to an underlying stream in a given endianness. /// /// Because this only writes whole bytes to the underlying stream, /// it is important that output is byte-aligned before the bitstream /// writer's lifetime ends. /// **Partial bytes will be lost** if the writer is disposed of /// before they can be written. pub struct BitWriter<W: io::Write, E: Endianness> { writer: W, bitqueue: BitQueue<E, u8>, } impl<W: io::Write, E: Endianness> BitWriter<W, E> { /// Wraps a BitWriter around something that implements `Write` pub fn new(writer: W) -> BitWriter<W, E> { BitWriter { writer, bitqueue: BitQueue::new(), } } /// Wraps a BitWriter around something that implements `Write` /// with the given endianness. pub fn endian(writer: W, _endian: E) -> BitWriter<W, E> { BitWriter { writer, bitqueue: BitQueue::new(), } } /// Unwraps internal writer and disposes of BitWriter. /// Any unwritten partial bits are discarded. #[inline] pub fn into_writer(self) -> W { self.writer } /// Writes a single bit to the stream. /// `true` indicates 1, `false` indicates 0 /// /// # Errors /// /// Passes along any I/O error from the underlying stream. /// /// # Examples /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write_bit(true).unwrap(); /// writer.write_bit(false).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(false).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{LittleEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), LittleEndian); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(false).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(true).unwrap(); /// writer.write_bit(false).unwrap(); /// writer.write_bit(true).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` pub fn write_bit(&mut self, bit: bool) -> io::Result<()> { self.bitqueue.push(1, if bit { 1 } else { 0 }); if self.bitqueue.is_full() { write_byte(&mut self.writer, self.bitqueue.pop(8)) } else { Ok(()) } } /// Writes an unsigned value to the stream using the given /// number of bits. /// /// # Errors /// /// Passes along any I/O error from the underlying stream. /// Returns an error if the input type is too small /// to hold the given number of bits. /// Returns an error if the value is too large /// to fit the given number of bits. /// /// # Examples /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write(1, 0b1).unwrap(); /// writer.write(2, 0b01).unwrap(); /// writer.write(5, 0b10111).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{LittleEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), LittleEndian); /// writer.write(1, 0b1).unwrap(); /// writer.write(2, 0b11).unwrap(); /// writer.write(5, 0b10110).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` /// /// ``` /// use std::io::{Write, sink}; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut w = BitWriter::endian(sink(), BigEndian); /// assert!(w.write(9, 0u8).is_err()); // can't write u8 in 9 bits /// assert!(w.write(17, 0u16).is_err()); // can't write u16 in 17 bits /// assert!(w.write(33, 0u32).is_err()); // can't write u32 in 33 bits /// assert!(w.write(65, 0u64).is_err()); // can't write u64 in 65 bits /// assert!(w.write(1, 2).is_err()); // can't write 2 in 1 bit /// assert!(w.write(2, 4).is_err()); // can't write 4 in 2 bits /// assert!(w.write(3, 8).is_err()); // can't write 8 in 3 bits /// assert!(w.write(4, 16).is_err()); // can't write 16 in 4 bits /// ``` pub fn write<U>(&mut self, bits: u32, value: U) -> io::Result<()> where U: Numeric, { if bits > U::bits_size() { Err(io::Error::new( io::ErrorKind::InvalidInput, "excessive bits for type written", )) } else if (bits < U::bits_size()) && (value >= (U::one() << bits)) { Err(io::Error::new( io::ErrorKind::InvalidInput, "excessive value for bits written", )) } else if bits < self.bitqueue.remaining_len() { self.bitqueue.push(bits, value.to_u8()); Ok(()) } else { let mut acc = BitQueue::from_value(value, bits); write_unaligned(&mut self.writer, &mut acc, &mut self.bitqueue)?; write_aligned(&mut self.writer, &mut acc)?; self.bitqueue.push(acc.len(), acc.value().to_u8()); Ok(()) } } /// Writes a twos-complement signed value to the stream /// with the given number of bits. /// /// # Errors /// /// Passes along any I/O error from the underlying stream. /// Returns an error if the input type is too small /// to hold the given number of bits. /// Returns an error if the value is too large /// to fit the given number of bits. /// /// # Examples /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write_signed(4, -5).unwrap(); /// writer.write_signed(4, 7).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{LittleEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), LittleEndian); /// writer.write_signed(4, 7).unwrap(); /// writer.write_signed(4, -5).unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` #[inline] pub fn write_signed<S>(&mut self, bits: u32, value: S) -> io::Result<()> where S: SignedNumeric, { E::write_signed(self, bits, value) } /// Writes the entirety of a byte buffer to the stream. /// If the stream is already byte-aligned, it will /// map to a faster `write_all` call. Otherwise it will /// write bytes individually in 8-bit increments. /// /// # Errors /// /// Passes along any I/O error from the underlying stream. /// /// # Example /// /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write(8, 0x66).unwrap(); /// writer.write(8, 0x6F).unwrap(); /// writer.write(8, 0x6F).unwrap(); /// writer.write_bytes(b"bar").unwrap(); /// assert_eq!(writer.into_writer(), b"foobar"); /// ``` pub fn write_bytes(&mut self, buf: &[u8]) -> io::Result<()> { if self.byte_aligned() { self.writer.write_all(buf) } else { for b in buf { self.write(8, *b)?; } Ok(()) } } /// Writes Huffman code for the given symbol to the stream. /// /// # Errors /// /// Passes along any I/O error from the underlying stream. /// /// # Example /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// use bitstream_io::huffman::compile_write_tree; /// let tree = compile_write_tree( /// vec![('a', vec![0]), /// ('b', vec![1, 0]), /// ('c', vec![1, 1, 0]), /// ('d', vec![1, 1, 1])]).unwrap(); /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write_huffman(&tree, 'b').unwrap(); /// writer.write_huffman(&tree, 'c').unwrap(); /// writer.write_huffman(&tree, 'd').unwrap(); /// assert_eq!(writer.into_writer(), [0b10110111]); /// ``` pub fn write_huffman<T>(&mut self, tree: &WriteHuffmanTree<E, T>, symbol: T) -> io::Result<()> where T: Ord + Copy, { for &(bits, value) in tree.get(&symbol) { self.write(bits, value)?; } Ok(()) } /// Writes `value` number of 1 bits to the stream /// and then writes a 0 bit. This field is variably-sized. /// /// # Errors /// /// Passes along any I/O error from the underyling stream. /// /// # Examples /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write_unary0(0).unwrap(); /// writer.write_unary0(3).unwrap(); /// writer.write_unary0(10).unwrap(); /// assert_eq!(writer.into_writer(), [0b01110111, 0b11111110]); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{LittleEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), LittleEndian); /// writer.write_unary0(0).unwrap(); /// writer.write_unary0(3).unwrap(); /// writer.write_unary0(10).unwrap(); /// assert_eq!(writer.into_writer(), [0b11101110, 0b01111111]); /// ``` pub fn write_unary0(&mut self, value: u32) -> io::Result<()> { match value { 0 => self.write_bit(false), bits @ 1...31 => self .write(value, (1u32 << bits) - 1) .and_then(|()| self.write_bit(false)), 32 => self .write(value, 0xFFFF_FFFFu32) .and_then(|()| self.write_bit(false)), bits @ 32...63 => self .write(value, (1u64 << bits) - 1) .and_then(|()| self.write_bit(false)), 64 => self .write(value, 0xFFFF_FFFF_FFFF_FFFFu64) .and_then(|()| self.write_bit(false)), mut bits => { while bits > 64 { self.write(64, 0xFFFF_FFFF_FFFF_FFFFu64)?; bits -= 64; } self.write_unary0(bits) } } } /// Writes `value` number of 0 bits to the stream /// and then writes a 1 bit. This field is variably-sized. /// /// # Errors /// /// Passes along any I/O error from the underyling stream. /// /// # Example /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write_unary1(0).unwrap(); /// writer.write_unary1(3).unwrap(); /// writer.write_unary1(10).unwrap(); /// assert_eq!(writer.into_writer(), [0b10001000, 0b00000001]); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{LittleEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), LittleEndian); /// writer.write_unary1(0).unwrap(); /// writer.write_unary1(3).unwrap(); /// writer.write_unary1(10).unwrap(); /// assert_eq!(writer.into_writer(), [0b00010001, 0b10000000]); /// ``` pub fn write_unary1(&mut self, value: u32) -> io::Result<()> { match value { 0 => self.write_bit(true), 1...32 => self.write(value, 0u32).and_then(|()| self.write_bit(true)), 33...64 => self.write(value, 0u64).and_then(|()| self.write_bit(true)), mut bits => { while bits > 64 { self.write(64, 0u64)?; bits -= 64; } self.write_unary1(bits) } } } /// Returns true if the stream is aligned at a whole byte. /// /// # Example /// ``` /// use std::io::{Write, sink}; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(sink(), BigEndian); /// assert_eq!(writer.byte_aligned(), true); /// writer.write(1, 0).unwrap(); /// assert_eq!(writer.byte_aligned(), false); /// writer.write(7, 0).unwrap(); /// assert_eq!(writer.byte_aligned(), true); /// ``` #[inline(always)] pub fn byte_aligned(&self) -> bool { self.bitqueue.is_empty() } /// Pads the stream with 0 bits until it is aligned at a whole byte. /// Does nothing if the stream is already aligned. /// /// # Errors /// /// Passes along any I/O error from the underyling stream. /// /// # Example /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut writer = BitWriter::endian(Vec::new(), BigEndian); /// writer.write(1, 0).unwrap(); /// writer.byte_align().unwrap(); /// writer.write(8, 0xFF).unwrap(); /// assert_eq!(writer.into_writer(), [0x00, 0xFF]); /// ``` pub fn byte_align(&mut self) -> io::Result<()> { while !self.byte_aligned() { self.write_bit(false)?; } Ok(()) } /// Consumes writer and returns any un-written partial byte /// as a `(bits, value)` tuple. /// /// # Examples /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut data = Vec::new(); /// let (bits, value) = { /// let mut writer = BitWriter::endian(&mut data, BigEndian); /// writer.write(15, 0b1010_0101_0101_101).unwrap(); /// writer.into_unwritten() /// }; /// assert_eq!(data, [0b1010_0101]); /// assert_eq!(bits, 7); /// assert_eq!(value, 0b0101_101); /// ``` /// /// ``` /// use std::io::Write; /// use bitstream_io::{BigEndian, BitWriter}; /// let mut data = Vec::new(); /// let (bits, value) = { /// let mut writer = BitWriter::endian(&mut data, BigEndian); /// writer.write(8, 0b1010_0101).unwrap(); /// writer.into_unwritten() /// }; /// assert_eq!(data, [0b1010_0101]); /// assert_eq!(bits, 0); /// assert_eq!(value, 0); /// ``` #[inline(always)] pub fn into_unwritten(self) -> (u32, u8) { (self.bitqueue.len(), self.bitqueue.value()) } } #[inline] fn write_byte<W>(mut writer: W, byte: u8) -> io::Result<()> where W: io::Write, { let buf = [byte]; writer.write_all(&buf) } fn write_unaligned<W, E, N>( writer: W, acc: &mut BitQueue<E, N>, rem: &mut BitQueue<E, u8>, ) -> io::Result<()> where W: io::Write, E: Endianness, N: Numeric, { if rem.is_empty() { Ok(()) } else { use std::cmp::min; let bits_to_transfer = min(8 - rem.len(), acc.len()); rem.push(bits_to_transfer, acc.pop(bits_to_transfer).to_u8()); if rem.len() == 8 { write_byte(writer, rem.pop(8)) } else { Ok(()) } } } fn write_aligned<W, E, N>(mut writer: W, acc: &mut BitQueue<E, N>) -> io::Result<()> where W: io::Write, E: Endianness, N: Numeric, { let to_write = (acc.len() / 8) as usize; if to_write > 0 { // 128-bit types are the maximum supported debug_assert!(to_write <= 16); let mut buf = [0; 16]; for b in buf[0..to_write].iter_mut() { *b = acc.pop(8).to_u8(); } writer.write_all(&buf[0..to_write]) } else { Ok(()) } }