Grok 10.0.5
grk::grk::BufferedStream Struct Reference

#include <TileCache.h>

Public Member Functions

 BufferedStream (uint8_t *buffer, size_t buffer_size, bool l_is_input)
 
grk_streamgetWrapper (void)
 
void setUserData (void *data, grk_stream_free_user_data_fn freeUserDataFun)
 
void * getUserData (void)
 
void setUserDataLength (uint64_t len)
 
uint32_t getStatus (void)
 
void setReadFunction (grk_stream_read_fn fn)
 
void setZeroCopyReadFunction (grk_stream_zero_copy_read_fn fn)
 
void setWriteFunction (grk_stream_write_fn fn)
 
void setSeekFunction (grk_stream_seek_fn fn)
 
size_t read (uint8_t *buffer, size_t p_size)
 Reads some bytes from the stream.
 
bool writeShort (uint16_t value)
 
bool write24 (uint32_t value)
 
bool writeInt (uint32_t value)
 
bool write64 (uint64_t value)
 
bool writeByte (uint8_t value)
 
size_t writeBytes (const uint8_t *buffer, size_t p_size)
 Write bytes to stream (no correction for endian!).
 
bool flush ()
 Flush stream to disk.
 
bool skip (int64_t p_size)
 Skip bytes in stream.
 
uint64_t tell (void)
 Tells byte offset of stream (similar to ftell).
 
uint64_t numBytesLeft (void)
 Get the number of bytes left before end of stream.
 
bool seek (uint64_t offset)
 Seek bytes from the stream (absolute)
 
bool hasSeek ()
 Check if stream is seekable.
 
bool supportsZeroCopy ()
 
uint8_t * getZeroCopyPtr ()
 
void setFormat (GRK_CODEC_FORMAT format)
 
GRK_CODEC_FORMAT getFormat (void)
 
 BufferedStream (uint8_t *buffer, size_t buffer_size, bool l_is_input)
 
grk_streamgetWrapper (void)
 
void setUserData (void *data, grk_stream_free_user_data_fn freeUserDataFun)
 
void * getUserData (void)
 
void setUserDataLength (uint64_t len)
 
uint32_t getStatus (void)
 
void setReadFunction (grk_stream_read_fn fn)
 
void setZeroCopyReadFunction (grk_stream_zero_copy_read_fn fn)
 
void setWriteFunction (grk_stream_write_fn fn)
 
void setSeekFunction (grk_stream_seek_fn fn)
 
size_t read (uint8_t *buffer, size_t p_size)
 Reads some bytes from the stream.
 
bool writeShort (uint16_t value)
 
bool write24 (uint32_t value)
 
bool writeInt (uint32_t value)
 
bool write64 (uint64_t value)
 
bool writeByte (uint8_t value)
 
size_t writeBytes (const uint8_t *buffer, size_t p_size)
 Write bytes to stream (no correction for endian!).
 
bool flush ()
 Flush stream to disk.
 
bool skip (int64_t p_size)
 Skip bytes in stream.
 
uint64_t tell (void)
 Tells byte offset of stream (similar to ftell).
 
uint64_t numBytesLeft (void)
 Get the number of bytes left before end of stream.
 
bool seek (uint64_t offset)
 Seek bytes from the stream (absolute)
 
bool hasSeek ()
 Check if stream is seekable.
 
bool supportsZeroCopy ()
 
uint8_t * getZeroCopyPtr ()
 
void setFormat (GRK_CODEC_FORMAT format)
 
GRK_CODEC_FORMAT getFormat (void)
 
 BufferedStream (uint8_t *buffer, size_t buffer_size, bool l_is_input)
 
grk_streamgetWrapper (void)
 
void setUserData (void *data, grk_stream_free_user_data_fn freeUserDataFun)
 
void * getUserData (void)
 
void setUserDataLength (uint64_t len)
 
uint32_t getStatus (void)
 
void setReadFunction (grk_stream_read_fn fn)
 
void setZeroCopyReadFunction (grk_stream_zero_copy_read_fn fn)
 
void setWriteFunction (grk_stream_write_fn fn)
 
void setSeekFunction (grk_stream_seek_fn fn)
 
size_t read (uint8_t *buffer, size_t p_size)
 Reads some bytes from the stream.
 
bool writeShort (uint16_t value)
 
bool write24 (uint32_t value)
 
bool writeInt (uint32_t value)
 
bool write64 (uint64_t value)
 
bool writeByte (uint8_t value)
 
size_t writeBytes (const uint8_t *buffer, size_t p_size)
 Write bytes to stream (no correction for endian!).
 
bool flush ()
 Flush stream to disk.
 
bool skip (int64_t p_size)
 Skip bytes in stream.
 
uint64_t tell (void)
 Tells byte offset of stream (similar to ftell).
 
uint64_t numBytesLeft (void)
 Get the number of bytes left before end of stream.
 
bool seek (uint64_t offset)
 Seek bytes from the stream (absolute)
 
bool hasSeek ()
 Check if stream is seekable.
 
bool supportsZeroCopy ()
 
uint8_t * getZeroCopyPtr ()
 
void setFormat (GRK_CODEC_FORMAT format)
 
GRK_CODEC_FORMAT getFormat (void)
 

Static Public Member Functions

static BufferedStreamgetImpl (grk_stream *stream)
 
static BufferedStreamgetImpl (grk_stream *stream)
 
static BufferedStreamgetImpl (grk_stream *stream)
 

Public Attributes

friend GrkObjectWrapperImpl< BufferedStream >
 

Private Member Functions

 ~BufferedStream ()
 
bool write_skip (int64_t p_size)
 Skip bytes in write stream.
 
bool read_skip (int64_t p_size)
 Skip bytes in read stream.
 
bool read_seek (uint64_t offset)
 Absolute seek in read stream.
 
bool write_seek (uint64_t offset)
 Absolute seek in write stream.
 
void writeIncrement (size_t p_size)
 
template<typename TYPE >
bool write (TYPE value, uint8_t numBytes)
 
void invalidate_buffer ()
 
bool isMemStream ()
 
 ~BufferedStream ()
 
bool write_skip (int64_t p_size)
 Skip bytes in write stream.
 
bool read_skip (int64_t p_size)
 Skip bytes in read stream.
 
bool read_seek (uint64_t offset)
 Absolute seek in read stream.
 
bool write_seek (uint64_t offset)
 Absolute seek in write stream.
 
void writeIncrement (size_t p_size)
 
template<typename TYPE >
bool write (TYPE value, uint8_t numBytes)
 
void invalidate_buffer ()
 
bool isMemStream ()
 
 ~BufferedStream ()
 
bool write_skip (int64_t p_size)
 Skip bytes in write stream.
 
bool read_skip (int64_t p_size)
 Skip bytes in read stream.
 
bool read_seek (uint64_t offset)
 Absolute seek in read stream.
 
bool write_seek (uint64_t offset)
 Absolute seek in write stream.
 
void writeIncrement (size_t p_size)
 
template<typename TYPE >
bool write (TYPE value, uint8_t numBytes)
 
void invalidate_buffer ()
 
bool isMemStream ()
 

Private Attributes

grk_object obj
 
void * user_data_
 user data
 
grk_stream_free_user_data_fn free_user_data_fn_
 Pointer to function to free user_data_ (nullptr at initialization) when destroying the stream.
 
uint64_t user_data_length_
 User data length.
 
grk_stream_read_fn read_fn_
 Pointer to actual read function (nullptr at initialization).
 
grk_stream_zero_copy_read_fn zero_copy_read_fn_
 Pointer to actual zero copy read function (nullptr at initialization).
 
grk_stream_write_fn write_fn_
 Pointer to actual write function (nullptr at initialization).
 
grk_stream_seek_fn seek_fn_
 Pointer to actual seek function (if available).
 
uint32_t status_
 Stream status flags.
 
grk_buf8buf_
 
size_t buffered_bytes_
 
size_t read_bytes_seekable_
 
uint64_t stream_offset_
 
GRK_CODEC_FORMAT format_
 

Constructor & Destructor Documentation

◆ BufferedStream() [1/3]

grk::BufferedStream::BufferedStream ( uint8_t * buffer,
size_t buffer_size,
bool l_is_input )

References buf_, buffer, obj, and _grk_object::wrapper.

◆ ~BufferedStream() [1/3]

grk::BufferedStream::~BufferedStream ( )
private

References buf_, free_user_data_fn_, and user_data_.

◆ BufferedStream() [2/3]

grk::grk::BufferedStream::BufferedStream ( uint8_t * buffer,
size_t buffer_size,
bool l_is_input )

◆ ~BufferedStream() [2/3]

grk::grk::BufferedStream::~BufferedStream ( )
private

◆ BufferedStream() [3/3]

grk::grk::BufferedStream::BufferedStream ( uint8_t * buffer,
size_t buffer_size,
bool l_is_input )

◆ ~BufferedStream() [3/3]

grk::grk::BufferedStream::~BufferedStream ( )
private

Member Function Documentation

◆ flush() [1/3]

bool grk::BufferedStream::flush ( )

Flush stream to disk.

Returns
true if the data could be flushed, otherwise false.

References buf_, buffered_bytes_, grk::GRK_ERROR(), GROK_STREAM_STATUS_ERROR, read_bytes_seekable_, status_, user_data_, and write_fn_.

◆ flush() [2/3]

bool grk::grk::BufferedStream::flush ( )

Flush stream to disk.

Returns
true if the data could be flushed, otherwise false.

◆ flush() [3/3]

bool grk::grk::BufferedStream::flush ( )

Flush stream to disk.

Returns
true if the data could be flushed, otherwise false.

◆ getFormat() [1/3]

GRK_CODEC_FORMAT grk::BufferedStream::getFormat ( void )

References format_.

◆ getFormat() [2/3]

GRK_CODEC_FORMAT grk::grk::BufferedStream::getFormat ( void )

◆ getFormat() [3/3]

GRK_CODEC_FORMAT grk::grk::BufferedStream::getFormat ( void )

◆ getImpl() [1/3]

static BufferedStream * grk::BufferedStream::getImpl ( grk_stream * stream)
static

References stream.

◆ getImpl() [2/3]

static BufferedStream * grk::grk::BufferedStream::getImpl ( grk_stream * stream)
static

◆ getImpl() [3/3]

static BufferedStream * grk::grk::BufferedStream::getImpl ( grk_stream * stream)
static

◆ getStatus() [1/3]

uint32_t grk::BufferedStream::getStatus ( void )

References status_.

◆ getStatus() [2/3]

uint32_t grk::grk::BufferedStream::getStatus ( void )

◆ getStatus() [3/3]

uint32_t grk::grk::BufferedStream::getStatus ( void )

◆ getUserData() [1/3]

void * grk::BufferedStream::getUserData ( void )

References user_data_.

◆ getUserData() [2/3]

void * grk::grk::BufferedStream::getUserData ( void )

◆ getUserData() [3/3]

void * grk::grk::BufferedStream::getUserData ( void )

◆ getWrapper() [1/3]

grk_stream * grk::BufferedStream::getWrapper ( void )

References obj.

◆ getWrapper() [2/3]

grk_stream * grk::grk::BufferedStream::getWrapper ( void )

◆ getWrapper() [3/3]

grk_stream * grk::grk::BufferedStream::getWrapper ( void )

◆ getZeroCopyPtr() [1/3]

uint8_t * grk::BufferedStream::getZeroCopyPtr ( )

References buf_.

◆ getZeroCopyPtr() [2/3]

uint8_t * grk::grk::BufferedStream::getZeroCopyPtr ( )

◆ getZeroCopyPtr() [3/3]

uint8_t * grk::grk::BufferedStream::getZeroCopyPtr ( )

◆ hasSeek() [1/3]

bool grk::BufferedStream::hasSeek ( )

Check if stream is seekable.

References seek_fn_.

◆ hasSeek() [2/3]

bool grk::grk::BufferedStream::hasSeek ( )

Check if stream is seekable.

◆ hasSeek() [3/3]

bool grk::grk::BufferedStream::hasSeek ( )

Check if stream is seekable.

◆ invalidate_buffer() [1/3]

void grk::BufferedStream::invalidate_buffer ( )
private

◆ invalidate_buffer() [2/3]

void grk::grk::BufferedStream::invalidate_buffer ( )
private

◆ invalidate_buffer() [3/3]

void grk::grk::BufferedStream::invalidate_buffer ( )
private

◆ isMemStream() [1/3]

bool grk::BufferedStream::isMemStream ( )
private

References buf_.

◆ isMemStream() [2/3]

bool grk::grk::BufferedStream::isMemStream ( )
private

◆ isMemStream() [3/3]

bool grk::grk::BufferedStream::isMemStream ( )
private

◆ numBytesLeft() [1/3]

uint64_t grk::BufferedStream::numBytesLeft ( void )

Get the number of bytes left before end of stream.

Returns
Number of bytes left before the end of the stream.

References stream_offset_, and user_data_length_.

◆ numBytesLeft() [2/3]

uint64_t grk::grk::BufferedStream::numBytesLeft ( void )

Get the number of bytes left before end of stream.

Returns
Number of bytes left before the end of the stream.

◆ numBytesLeft() [3/3]

uint64_t grk::grk::BufferedStream::numBytesLeft ( void )

Get the number of bytes left before end of stream.

Returns
Number of bytes left before the end of the stream.

◆ read() [1/3]

size_t grk::BufferedStream::read ( uint8_t * buffer,
size_t p_size )

Reads some bytes from the stream.

Parameters
bufferpointer to the data buffer that will receive the data.
p_sizenumber of bytes to read.
Returns
the number of bytes read

References buf_, buffer, buffered_bytes_, grk::GRK_ERROR(), GROK_STREAM_STATUS_END, read_bytes_seekable_, read_fn_, status_, stream_offset_, user_data_, and user_data_length_.

◆ read() [2/3]

size_t grk::grk::BufferedStream::read ( uint8_t * buffer,
size_t p_size )

Reads some bytes from the stream.

Parameters
bufferpointer to the data buffer that will receive the data.
p_sizenumber of bytes to read.
Returns
the number of bytes read

◆ read() [3/3]

size_t grk::grk::BufferedStream::read ( uint8_t * buffer,
size_t p_size )

Reads some bytes from the stream.

Parameters
bufferpointer to the data buffer that will receive the data.
p_sizenumber of bytes to read.
Returns
the number of bytes read

◆ read_seek() [1/3]

bool grk::BufferedStream::read_seek ( uint64_t offset)
private

Absolute seek in read stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

References buf_, buffered_bytes_, GROK_STREAM_STATUS_END, GROK_STREAM_STATUS_ERROR, offset, read_bytes_seekable_, seek_fn_, status_, stream_offset_, user_data_, and user_data_length_.

◆ read_seek() [2/3]

bool grk::grk::BufferedStream::read_seek ( uint64_t offset)
private

Absolute seek in read stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

◆ read_seek() [3/3]

bool grk::grk::BufferedStream::read_seek ( uint64_t offset)
private

Absolute seek in read stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

◆ read_skip() [1/3]

bool grk::BufferedStream::read_skip ( int64_t p_size)
private

Skip bytes in read stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

References offset, and stream_offset_.

◆ read_skip() [2/3]

bool grk::grk::BufferedStream::read_skip ( int64_t p_size)
private

Skip bytes in read stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ read_skip() [3/3]

bool grk::grk::BufferedStream::read_skip ( int64_t p_size)
private

Skip bytes in read stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ seek() [1/3]

bool grk::BufferedStream::seek ( uint64_t offset)

Seek bytes from the stream (absolute)

Parameters
offsetthe number of bytes to skip.
Returns
true if successful, otherwise false

References GROK_STREAM_STATUS_INPUT, offset, and status_.

◆ seek() [2/3]

bool grk::grk::BufferedStream::seek ( uint64_t offset)

Seek bytes from the stream (absolute)

Parameters
offsetthe number of bytes to skip.
Returns
true if successful, otherwise false

◆ seek() [3/3]

bool grk::grk::BufferedStream::seek ( uint64_t offset)

Seek bytes from the stream (absolute)

Parameters
offsetthe number of bytes to skip.
Returns
true if successful, otherwise false

◆ setFormat() [1/3]

void grk::BufferedStream::setFormat ( GRK_CODEC_FORMAT format)

References format_.

◆ setFormat() [2/3]

void grk::grk::BufferedStream::setFormat ( GRK_CODEC_FORMAT format)

◆ setFormat() [3/3]

void grk::grk::BufferedStream::setFormat ( GRK_CODEC_FORMAT format)

◆ setReadFunction() [1/3]

void grk::BufferedStream::setReadFunction ( grk_stream_read_fn fn)

References read_fn_.

◆ setReadFunction() [2/3]

void grk::grk::BufferedStream::setReadFunction ( grk_stream_read_fn fn)

◆ setReadFunction() [3/3]

void grk::grk::BufferedStream::setReadFunction ( grk_stream_read_fn fn)

◆ setSeekFunction() [1/3]

void grk::BufferedStream::setSeekFunction ( grk_stream_seek_fn fn)

References seek_fn_.

◆ setSeekFunction() [2/3]

void grk::grk::BufferedStream::setSeekFunction ( grk_stream_seek_fn fn)

◆ setSeekFunction() [3/3]

void grk::grk::BufferedStream::setSeekFunction ( grk_stream_seek_fn fn)

◆ setUserData() [1/3]

void grk::BufferedStream::setUserData ( void * data,
grk_stream_free_user_data_fn freeUserDataFun )

References data, free_user_data_fn_, and user_data_.

◆ setUserData() [2/3]

void grk::grk::BufferedStream::setUserData ( void * data,
grk_stream_free_user_data_fn freeUserDataFun )

◆ setUserData() [3/3]

void grk::grk::BufferedStream::setUserData ( void * data,
grk_stream_free_user_data_fn freeUserDataFun )

◆ setUserDataLength() [1/3]

void grk::BufferedStream::setUserDataLength ( uint64_t len)

References len, and user_data_length_.

◆ setUserDataLength() [2/3]

void grk::grk::BufferedStream::setUserDataLength ( uint64_t len)

◆ setUserDataLength() [3/3]

void grk::grk::BufferedStream::setUserDataLength ( uint64_t len)

◆ setWriteFunction() [1/3]

void grk::BufferedStream::setWriteFunction ( grk_stream_write_fn fn)

References write_fn_.

◆ setWriteFunction() [2/3]

void grk::grk::BufferedStream::setWriteFunction ( grk_stream_write_fn fn)

◆ setWriteFunction() [3/3]

void grk::grk::BufferedStream::setWriteFunction ( grk_stream_write_fn fn)

◆ setZeroCopyReadFunction() [1/3]

void grk::BufferedStream::setZeroCopyReadFunction ( grk_stream_zero_copy_read_fn fn)

References zero_copy_read_fn_.

◆ setZeroCopyReadFunction() [2/3]

void grk::grk::BufferedStream::setZeroCopyReadFunction ( grk_stream_zero_copy_read_fn fn)

◆ setZeroCopyReadFunction() [3/3]

void grk::grk::BufferedStream::setZeroCopyReadFunction ( grk_stream_zero_copy_read_fn fn)

◆ skip() [1/3]

bool grk::BufferedStream::skip ( int64_t p_size)

Skip bytes in stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

References GROK_STREAM_STATUS_INPUT, and status_.

◆ skip() [2/3]

bool grk::grk::BufferedStream::skip ( int64_t p_size)

Skip bytes in stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ skip() [3/3]

bool grk::grk::BufferedStream::skip ( int64_t p_size)

Skip bytes in stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ supportsZeroCopy() [1/3]

bool grk::BufferedStream::supportsZeroCopy ( )

◆ supportsZeroCopy() [2/3]

bool grk::grk::BufferedStream::supportsZeroCopy ( )

◆ supportsZeroCopy() [3/3]

bool grk::grk::BufferedStream::supportsZeroCopy ( )

◆ tell() [1/3]

uint64_t grk::BufferedStream::tell ( void )

Tells byte offset of stream (similar to ftell).

Returns
the current position of the stream.

References stream_offset_.

◆ tell() [2/3]

uint64_t grk::grk::BufferedStream::tell ( void )

Tells byte offset of stream (similar to ftell).

Returns
the current position of the stream.

◆ tell() [3/3]

uint64_t grk::grk::BufferedStream::tell ( void )

Tells byte offset of stream (similar to ftell).

Returns
the current position of the stream.

◆ write() [1/3]

template<typename TYPE >
bool grk::BufferedStream::write ( TYPE value,
uint8_t numBytes )
private

◆ write() [2/3]

template<typename TYPE >
bool grk::grk::BufferedStream::write ( TYPE value,
uint8_t numBytes )
private

◆ write() [3/3]

template<typename TYPE >
bool grk::grk::BufferedStream::write ( TYPE value,
uint8_t numBytes )
private

◆ write24() [1/3]

bool grk::BufferedStream::write24 ( uint32_t value)

References value.

◆ write24() [2/3]

bool grk::grk::BufferedStream::write24 ( uint32_t value)

◆ write24() [3/3]

bool grk::grk::BufferedStream::write24 ( uint32_t value)

◆ write64() [1/3]

bool grk::BufferedStream::write64 ( uint64_t value)

References value.

◆ write64() [2/3]

bool grk::grk::BufferedStream::write64 ( uint64_t value)

◆ write64() [3/3]

bool grk::grk::BufferedStream::write64 ( uint64_t value)

◆ write_seek() [1/3]

bool grk::BufferedStream::write_seek ( uint64_t offset)
private

Absolute seek in write stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

References buf_, GROK_STREAM_STATUS_ERROR, offset, seek_fn_, status_, stream_offset_, and user_data_.

◆ write_seek() [2/3]

bool grk::grk::BufferedStream::write_seek ( uint64_t offset)
private

Absolute seek in write stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

◆ write_seek() [3/3]

bool grk::grk::BufferedStream::write_seek ( uint64_t offset)
private

Absolute seek in write stream.

Parameters
offsetabsolute offset
Returns
true if successful, otherwise false

◆ write_skip() [1/3]

bool grk::BufferedStream::write_skip ( int64_t p_size)
private

Skip bytes in write stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

References offset, and stream_offset_.

◆ write_skip() [2/3]

bool grk::grk::BufferedStream::write_skip ( int64_t p_size)
private

Skip bytes in write stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ write_skip() [3/3]

bool grk::grk::BufferedStream::write_skip ( int64_t p_size)
private

Skip bytes in write stream.

Parameters
p_sizethe number of bytes to skip.
Returns
true if successful, otherwise false

◆ writeByte() [1/3]

bool grk::BufferedStream::writeByte ( uint8_t value)

References value.

◆ writeByte() [2/3]

bool grk::grk::BufferedStream::writeByte ( uint8_t value)

◆ writeByte() [3/3]

bool grk::grk::BufferedStream::writeByte ( uint8_t value)

◆ writeBytes() [1/3]

size_t grk::BufferedStream::writeBytes ( const uint8_t * buffer,
size_t p_size )

Write bytes to stream (no correction for endian!).

Parameters
bufferpointer to the data buffer holds the data to be written.
p_sizenumber of bytes to write.
Returns
the number of bytes written

References buf_, buffer, buffered_bytes_, GROK_STREAM_STATUS_ERROR, status_, stream_offset_, user_data_, and write_fn_.

◆ writeBytes() [2/3]

size_t grk::grk::BufferedStream::writeBytes ( const uint8_t * buffer,
size_t p_size )

Write bytes to stream (no correction for endian!).

Parameters
bufferpointer to the data buffer holds the data to be written.
p_sizenumber of bytes to write.
Returns
the number of bytes written

◆ writeBytes() [3/3]

size_t grk::grk::BufferedStream::writeBytes ( const uint8_t * buffer,
size_t p_size )

Write bytes to stream (no correction for endian!).

Parameters
bufferpointer to the data buffer holds the data to be written.
p_sizenumber of bytes to write.
Returns
the number of bytes written

◆ writeIncrement() [1/3]

void grk::BufferedStream::writeIncrement ( size_t p_size)
private

References buf_, buffered_bytes_, and stream_offset_.

◆ writeIncrement() [2/3]

void grk::grk::BufferedStream::writeIncrement ( size_t p_size)
private

◆ writeIncrement() [3/3]

void grk::grk::BufferedStream::writeIncrement ( size_t p_size)
private

◆ writeInt() [1/3]

bool grk::BufferedStream::writeInt ( uint32_t value)

References value.

◆ writeInt() [2/3]

bool grk::grk::BufferedStream::writeInt ( uint32_t value)

◆ writeInt() [3/3]

bool grk::grk::BufferedStream::writeInt ( uint32_t value)

◆ writeShort() [1/3]

bool grk::BufferedStream::writeShort ( uint16_t value)

References value.

◆ writeShort() [2/3]

bool grk::grk::BufferedStream::writeShort ( uint16_t value)

◆ writeShort() [3/3]

bool grk::grk::BufferedStream::writeShort ( uint16_t value)

Member Data Documentation

◆ buf_

grk_buf8 * grk::grk::BufferedStream::buf_
private

◆ buffered_bytes_

size_t grk::grk::BufferedStream::buffered_bytes_
private

◆ format_

GRK_CODEC_FORMAT grk::grk::BufferedStream::format_
private

◆ free_user_data_fn_

grk_stream_free_user_data_fn grk::grk::BufferedStream::free_user_data_fn_
private

Pointer to function to free user_data_ (nullptr at initialization) when destroying the stream.

If pointer is nullptr the function is not called and the user_data_ is not freed (even if it isn't nullptr).

◆ GrkObjectWrapperImpl< BufferedStream >

◆ obj

grk_object grk::grk::BufferedStream::obj
private

◆ read_bytes_seekable_

size_t grk::grk::BufferedStream::read_bytes_seekable_
private

◆ read_fn_

grk_stream_read_fn grk::grk::BufferedStream::read_fn_
private

Pointer to actual read function (nullptr at initialization).

◆ seek_fn_

grk_stream_seek_fn grk::grk::BufferedStream::seek_fn_
private

Pointer to actual seek function (if available).

◆ status_

uint32_t grk::grk::BufferedStream::status_
private

Stream status flags.

◆ stream_offset_

uint64_t grk::grk::BufferedStream::stream_offset_
private

◆ user_data_

void * grk::grk::BufferedStream::user_data_
private

user data

◆ user_data_length_

uint64_t grk::grk::BufferedStream::user_data_length_
private

User data length.

Currently set to size of file for file read stream, and size of buffer for buffer read/write stream

◆ write_fn_

grk_stream_write_fn grk::grk::BufferedStream::write_fn_
private

Pointer to actual write function (nullptr at initialization).

◆ zero_copy_read_fn_

grk_stream_zero_copy_read_fn grk::grk::BufferedStream::zero_copy_read_fn_
private

Pointer to actual zero copy read function (nullptr at initialization).


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