Shaka Packager SDK
Public Member Functions | List of all members
shaka::media::BufferReader Class Reference

#include <buffer_reader.h>

Inheritance diagram for shaka::media::BufferReader:
shaka::media::mp4::BoxReader

Public Member Functions

 BufferReader (const uint8_t *buf, size_t size)
 Create a BufferReader from a raw buffer.
 
bool HasBytes (size_t count)
 
bool ReadToVector (std::vector< uint8_t > *t, size_t count) WARN_UNUSED_RESULT
 
bool ReadToString (std::string *str, size_t size) WARN_UNUSED_RESULT
 
bool ReadCString (std::string *str) WARN_UNUSED_RESULT
 Reads a null-terminated string.
 
bool SkipBytes (size_t num_bytes) WARN_UNUSED_RESULT
 
const uint8_t * data () const
 
size_t size () const
 
void set_size (size_t size)
 
size_t pos () const
 
bool Read1 (uint8_t *v) WARN_UNUSED_RESULT
 
bool Read2 (uint16_t *v) WARN_UNUSED_RESULT
 
bool Read2s (int16_t *v) WARN_UNUSED_RESULT
 
bool Read4 (uint32_t *v) WARN_UNUSED_RESULT
 
bool Read4s (int32_t *v) WARN_UNUSED_RESULT
 
bool Read8 (uint64_t *v) WARN_UNUSED_RESULT
 
bool Read8s (int64_t *v) WARN_UNUSED_RESULT
 
bool ReadNBytesInto8 (uint64_t *v, size_t num_bytes) WARN_UNUSED_RESULT
 
bool ReadNBytesInto8s (int64_t *v, size_t num_bytes) WARN_UNUSED_RESULT
 

Detailed Description

A simple buffer reader implementation, which reads data of various types from a fixed byte array.

Definition at line 23 of file buffer_reader.h.

Member Function Documentation

◆ HasBytes()

bool shaka::media::BufferReader::HasBytes ( size_t  count)
inline
Returns
true if there are more than count bytes in the stream, false otherwise.

Definition at line 32 of file buffer_reader.h.

◆ Read1()

bool shaka::media::BufferReader::Read1 ( uint8_t *  v)

Read a value from the stream, performing endian correction, and advance the stream pointer.

Returns
false if there are not enough bytes in the buffer.

Definition at line 14 of file buffer_reader.cc.

◆ ReadNBytesInto8()

bool shaka::media::BufferReader::ReadNBytesInto8 ( uint64_t *  v,
size_t  num_bytes 
)

Read N-byte integer of the corresponding signedness and store it in the 8-byte return type.

Parameters
num_bytesshould not be larger than 8 bytes.
Returns
false if there are not enough bytes in the buffer, true otherwise.

Definition at line 40 of file buffer_reader.cc.

◆ SkipBytes()

bool shaka::media::BufferReader::SkipBytes ( size_t  num_bytes)

Advance the stream by this many bytes.

Returns
false if there are not enough bytes in the buffer, true otherwise.

Definition at line 77 of file buffer_reader.cc.


The documentation for this class was generated from the following files: