shaka-packager/packager/media/base/bit_reader.h

84 lines
2.8 KiB
C++

// Copyright (c) 2012 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
#ifndef MEDIA_BASE_BIT_READER_H_
#define MEDIA_BASE_BIT_READER_H_
#include <stdint.h>
#include <sys/types.h>
#include "packager/base/logging.h"
namespace edash_packager {
namespace media {
/// A class to read bit streams.
class BitReader {
public:
/// Initialize the BitReader object to read a data buffer.
/// @param data points to the beginning of the buffer.
/// @param size is the buffer size in bytes.
BitReader(const uint8_t* data, off_t size);
~BitReader();
/// Read a number of bits from stream.
/// @param num_bits specifies the number of bits to read. It cannot be larger
/// than the number of bits the type can hold.
/// @param[out] out stores the output. The type @b T has to be a primitive
/// integer type.
/// @return false if the given number of bits cannot be read (not enough
/// bits in the stream), true otherwise. When false is returned, the
/// stream will enter a state where further ReadBits/SkipBits
/// operations will always return false unless @a num_bits is 0.
template <typename T>
bool ReadBits(int num_bits, T* out) {
DCHECK_LE(num_bits, static_cast<int>(sizeof(T) * 8));
uint64_t temp;
bool ret = ReadBitsInternal(num_bits, &temp);
*out = static_cast<T>(temp);
return ret;
}
/// Skip a number of bits from stream.
/// @param num_bits specifies the number of bits to be skipped.
/// @return false if the given number of bits cannot be skipped (not enough
/// bits in the stream), true otherwise. When false is returned, the
/// stream will enter a state where further ReadBits/SkipBits
/// operations will always return false unless |num_bits| is 0.
bool SkipBits(int num_bits);
/// @return The number of bits available for reading.
int bits_available() const;
private:
// Help function used by ReadBits to avoid inlining the bit reading logic.
bool ReadBitsInternal(int num_bits, uint64_t* out);
// Advance to the next byte, loading it into curr_byte_.
// If the num_remaining_bits_in_curr_byte_ is 0 after this function returns,
// the stream has reached the end.
void UpdateCurrByte();
// Pointer to the next unread (not in curr_byte_) byte in the stream.
const uint8_t* data_;
// Bytes left in the stream (without the curr_byte_).
off_t bytes_left_;
// Contents of the current byte; first unread bit starting at position
// 8 - num_remaining_bits_in_curr_byte_ from MSB.
uint8_t curr_byte_;
// Number of bits remaining in curr_byte_
int num_remaining_bits_in_curr_byte_;
private:
DISALLOW_COPY_AND_ASSIGN(BitReader);
};
} // namespace media
} // namespace edash_packager
#endif // MEDIA_BASE_BIT_READER_H_