JBBPBitOutputStream.java

/*
 * Copyright 2017 Igor Maznitsa.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package com.igormaznitsa.jbbp.io;

import static java.util.Objects.requireNonNull;

import com.igormaznitsa.jbbp.utils.JBBPUtils;
import java.io.FilterOutputStream;
import java.io.IOException;
import java.io.OutputStream;

/**
 * The Filter allows to write bit by bit into an output stream and count the written byte number. The Class is not a thread-safe one.
 *
 * @since 1.0
 */
public class JBBPBitOutputStream extends FilterOutputStream implements JBBPCountableBitStream {
  /**
   * Contains bit mode for bit operations.
   */
  private final JBBPBitOrder bitOrderMode;
  /**
   * Internal bit buffer.
   */
  private int bitBuffer;
  /**
   * Number of bits buffered by the bit buffer.
   */
  private int bitBufferCount;
  /**
   * The byte counter of written bytes.
   */
  private long byteCounter;

  /**
   * A Constructor. The Default LSB0 bit mode will be used for a bit writing operations.
   *
   * @param out the output stream to be filtered.
   */
  public JBBPBitOutputStream(final OutputStream out) {
    this(out, JBBPBitOrder.LSB0);
  }

  /**
   * A Constructor.
   *
   * @param out          an output stream to be filtered.
   * @param bitOrderMode a bit writing mode to used for writing operations.
   * @see JBBPBitOrder#LSB0
   * @see JBBPBitOrder#MSB0
   */
  public JBBPBitOutputStream(final OutputStream out, final JBBPBitOrder bitOrderMode) {
    super(out);
    this.bitOrderMode = requireNonNull(bitOrderMode, "Bit order mode must not be null");
  }

  /**
   * Get the bit mode for writing operations.
   *
   * @return the bit order for reading operations.
   * @see JBBPBitOrder#LSB0
   * @see JBBPBitOrder#MSB0
   */
  @Override
  public JBBPBitOrder getBitOrder() {
    return this.bitOrderMode;
  }

  /**
   * Write a signed short value into the output stream.
   *
   * @param value     a value to be written. Only two bytes will be written.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   */
  public void writeShort(final int value, final JBBPByteOrder byteOrder) throws IOException {
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.write(value >>> 8);
      this.write(value);
    } else {
      this.write(value);
      this.write(value >>> 8);
    }
  }

  /**
   * Write an integer value into the output stream.
   *
   * @param value     a value to be written into the output stream.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   */
  public void writeInt(final int value, final JBBPByteOrder byteOrder) throws IOException {
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.writeShort(value >>> 16, byteOrder);
      this.writeShort(value, byteOrder);
    } else {
      this.writeShort(value, byteOrder);
      this.writeShort(value >>> 16, byteOrder);
    }
  }

  /**
   * Write an unsigned integer value into the output stream.
   *
   * @param value     a value to be written into the output stream.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   * @since 2.0.4
   */
  public void writeUInt(final long value, final JBBPByteOrder byteOrder) throws IOException {
    final int v = (int) value;
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.writeShort(v >>> 16, byteOrder);
      this.writeShort(v, byteOrder);
    } else {
      this.writeShort(v, byteOrder);
      this.writeShort(v >>> 16, byteOrder);
    }
  }

  /**
   * Write a float value into the output stream.
   *
   * @param value     a value to be written into the output stream.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   * @since 1.4.0
   */
  public void writeFloat(final float value, final JBBPByteOrder byteOrder) throws IOException {
    final int intValue = Float.floatToIntBits(value);
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.writeShort(intValue >>> 16, byteOrder);
      this.writeShort(intValue, byteOrder);
    } else {
      this.writeShort(intValue, byteOrder);
      this.writeShort(intValue >>> 16, byteOrder);
    }
  }

  /**
   * Write a long value into the output stream.
   *
   * @param value     a value to be written into the output stream.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   */
  public void writeLong(final long value, final JBBPByteOrder byteOrder) throws IOException {
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.writeInt((int) (value >>> 32), byteOrder);
      this.writeInt((int) value, byteOrder);
    } else {
      this.writeInt((int) value, byteOrder);
      this.writeInt((int) (value >>> 32), byteOrder);
    }
  }

  /**
   * Write a double value into the output stream.
   *
   * @param value     a value to be written into the output stream.
   * @param byteOrder the byte order of the value bytes to be used for writing.
   * @throws IOException it will be thrown for transport errors
   * @see JBBPByteOrder#BIG_ENDIAN
   * @see JBBPByteOrder#LITTLE_ENDIAN
   * @since 1.4.0
   */
  public void writeDouble(final double value, final JBBPByteOrder byteOrder) throws IOException {
    final long longValue = Double.doubleToLongBits(value);
    if (byteOrder == JBBPByteOrder.BIG_ENDIAN) {
      this.writeInt((int) (longValue >>> 32), byteOrder);
      this.writeInt((int) longValue, byteOrder);
    } else {
      this.writeInt((int) longValue, byteOrder);
      this.writeInt((int) (longValue >>> 32), byteOrder);
    }
  }

  /**
   * Get number of bytes written into the output stream.
   *
   * @return the long value contains number of bytes written into the stream
   */
  @Override
  public long getCounter() {
    return this.byteCounter;
  }

  /**
   * Get the internal bit buffer value.
   *
   * @return the internal bit buffer value
   */
  @Override
  public int getBitBuffer() {
    return this.bitBuffer;
  }

  /**
   * Get the number of bits cached in the internal bit buffer.
   *
   * @return the number of cached bits in the bit buffer
   */
  @Override
  public int getBufferedBitsNumber() {
    return this.bitBufferCount;
  }

  /**
   * Flush the bit buffer into the output stream
   *
   * @throws IOException it will be thrown for transport errors
   */
  private void flushBitBuffer() throws IOException {
    if (this.bitBufferCount > 0) {
      this.bitBufferCount = 0;
      writeByte(this.bitBuffer);
    }
  }

  @Override
  public void flush() throws IOException {
    flushBitBuffer();
    this.out.flush();
  }

  @Override
  public void write(final byte[] b, final int off, final int len) throws IOException {
    if (this.bitOrderMode == JBBPBitOrder.MSB0 || this.bitBufferCount != 0) {
      int i = off;
      int cnt = len;
      while (cnt > 0) {
        this.write(b[i++]);
        cnt--;
      }
    } else {
      out.write(b, off, len);
      this.byteCounter += len;
    }
  }

  @Override
  public void write(final byte[] b) throws IOException {
    this.write(b, 0, b.length);
  }

  /**
   * Write bits into the output stream.
   *
   * @param value     the value which bits will be written in the output stream
   * @param bitNumber number of bits from the value to be written, must be in 1..8
   * @throws IOException              it will be thrown for transport errors
   * @throws IllegalArgumentException it will be thrown for wrong bit number
   */
  public void writeBits(final int value, final JBBPBitNumber bitNumber) throws IOException {
    if (this.bitBufferCount == 0 && bitNumber == JBBPBitNumber.BITS_8) {
      this.write(value);
    } else {
      int mask;
      int accumulator = value;
      int i = bitNumber.getBitNumber();

      if (this.bitOrderMode == JBBPBitOrder.MSB0_DIRECT) {
        final int initialMask = 0x80;
        mask = initialMask >> this.bitBufferCount;
        final int accumulatorMask = 1 << (bitNumber.getBitNumber() - 1);
        while (i > 0) {
          this.bitBuffer = this.bitBuffer | ((accumulator & accumulatorMask) == 0 ? 0 : mask);
          accumulator <<= 1;
          mask >>= 1;

          i--;
          this.bitBufferCount++;
          if (this.bitBufferCount == 8) {
            this.bitBufferCount = 0;
            writeByte(this.bitBuffer);
            mask = initialMask;
            this.bitBuffer = 0;
          }
        }
      } else {
        final int initialMask = 1;
        mask = initialMask << this.bitBufferCount;
        while (i > 0) {
          this.bitBuffer = this.bitBuffer | ((accumulator & 1) == 0 ? 0 : mask);

          accumulator >>= 1;
          mask = mask << 1;

          i--;
          this.bitBufferCount++;
          if (this.bitBufferCount == 8) {
            this.bitBufferCount = 0;
            writeByte(this.bitBuffer);
            mask = initialMask;
            this.bitBuffer = 0;
          }
        }
      }
    }
  }

  /**
   * Write padding bytes to align the stream counter for the border.
   *
   * @param alignByteNumber the alignment border
   * @throws IOException it will be thrown for transport errors
   */
  public void align(final long alignByteNumber) throws IOException {
    if (this.bitBufferCount > 0) {
      this.writeBits(0, JBBPBitNumber.decode(8 - this.bitBufferCount));
    }

    if (alignByteNumber > 0) {
      long padding = (alignByteNumber - (this.byteCounter % alignByteNumber)) % alignByteNumber;
      while (padding > 0) {
        this.out.write(0);
        this.byteCounter++;
        padding--;
      }
    }
  }

  /**
   * Internal method to write a byte into wrapped stream.
   *
   * @param value a byte value to be written
   * @throws IOException it will be thrown for transport problems
   */
  private void writeByte(int value) throws IOException {
    if (this.bitOrderMode == JBBPBitOrder.MSB0) {
      value = JBBPUtils.reverseBitsInByte((byte) value) & 0xFF;
    }
    this.out.write(value);
    this.byteCounter++;
  }

  @Override
  public void close() throws IOException {
    this.flush();
    this.out.close();
  }

  @Override
  public void write(final int value) throws IOException {
    if (this.bitBufferCount == 0) {
      this.writeByte(value);
    } else {
      this.writeBits(value, JBBPBitNumber.BITS_8);
    }
  }

  /**
   * Write number of items from byte array into stream
   *
   * @param array     array, must not be null
   * @param length    number of items to be written, if -1 then whole array
   * @param byteOrder order of bytes, if LITTLE_ENDIAN then array will be reversed
   * @throws IOException it will be thrown if any transport error
   * @see JBBPByteOrder#LITTLE_ENDIAN
   * @since 1.3.0
   */
  public void writeBytes(final byte[] array, final int length, final JBBPByteOrder byteOrder)
      throws IOException {
    if (byteOrder == JBBPByteOrder.LITTLE_ENDIAN) {
      int i = length < 0 ? array.length - 1 : length - 1;
      while (i >= 0) {
        this.write(array[i--]);
      }
    } else {
      this.write(array, 0, length < 0 ? array.length : length);
    }
  }

  /**
   * Reset the byte counter for the stream. The internal bit buffer will be reset also.
   */
  @Override
  public void resetCounter() {
    this.bitBuffer = 0;
    this.bitBufferCount = 0;
    this.byteCounter = 0L;
  }

  /**
   * Write string in UTF8 format into stream.
   * <b>the byte order in saved char data will be BIG_ENDIAN</b>
   * Format: PREFIX(FF=null | 0=empty | 0x8packedLength) LENGTH[packedLength] DATA_ARRAY[LENGTH]
   *
   * @param value string to be written, can be null
   * @param order order of bytes in written data (it doesn't affect encoded UTF8 array)
   * @throws IOException i twill be thrown if transport error
   * @since 1.4.0
   */
  public void writeString(final String value, final JBBPByteOrder order) throws IOException {
    if (value == null) {
      this.write(0xFF);
    } else if (value.isEmpty()) {
      this.write(0);
    } else {
      final byte[] array = JBBPUtils.strToUtf8(value);
      final int len = array.length;
      if (len < 0x80) {
        this.write(len);
      } else if ((len & 0xFFFFFF00) == 0) {
        this.write(0x81);
        this.write(len);
      } else if ((len & 0xFFFF0000) == 0) {
        this.write(0x82);
        this.writeShort(len, order);
      } else if ((len & 0xFF000000) == 0) {
        this.write(0x83);
        if (order == JBBPByteOrder.BIG_ENDIAN) {
          this.write(len >>> 16);
          this.write(len >>> 8);
          this.write(len);
        } else {
          this.write(len);
          this.write(len >>> 8);
          this.write(len >>> 16);
        }
      } else {
        this.write(0x84);
        this.writeInt(len, order);
      }
      this.write(array);
    }
  }

  /**
   * Write array of strings in stream in UTF8 format
   * <b>the byte order in saved char data will be BIG_ENDIAN</b>
   *
   * @param value array to be written, must not be null but can contain null values
   * @param order byte order to write char data, must not be null
   * @throws IOException it will be thrown for transport errors
   * @see #writeString(String, JBBPByteOrder)
   * @since 1.4.0
   */
  public void writeStringArray(final String[] value, final JBBPByteOrder order) throws IOException {
    for (final String s : value) {
      this.writeString(s, order);
    }
  }

}