#include <BufferedStream.h>

Inheritance diagram for grk::BufferedStream:

Public Member Functions
	BufferedStream (uint8_t *buffer, size_t buffer_size, bool l_is_input)

grk_stream *	getWrapper (void)

void	setUserData (void *data, grk_stream_free_user_data_fn freeUserDataFun) override

void *	getUserData (void) override

void	setUserDataLength (uint64_t len) override

uint32_t	getStatus (void) override

void	setReadFunction (grk_stream_read_fn fn) override

void	setZeroCopyReadFunction (grk_stream_zero_copy_read_fn fn) override

void	setWriteFunction (grk_stream_write_fn fn) override

void	setSeekFunction (grk_stream_seek_fn fn) override

size_t	read (uint8_t *buffer, size_t p_size)
	Reads some bytes from the stream. More...

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!). More...

bool	flush ()
	Flush stream to disk. More...

bool	skip (int64_t p_size)
	Skip bytes in stream. More...

uint64_t	tell (void)
	Tells byte offset of stream (similar to ftell). More...

uint64_t	numBytesLeft (void)
	Get the number of bytes left before end of stream. More...

bool	seek (uint64_t offset) override
	Seek bytes from the stream (absolute) More...

bool	hasSeek () override
	Check if stream is seekable. More...

bool	supportsZeroCopy () override

uint8_t *	getZeroCopyPtr () override

void	setFormat (GRK_CODEC_FORMAT format) override

GRK_CODEC_FORMAT	getFormat (void) override

Public Member Functions inherited from grk::IBufferedStream
virtual	~IBufferedStream ()=default

virtual uint32_t	getStatus (void)=0

virtual void *	getUserData (void)=0

virtual void	setUserData (void *data, grk_stream_free_user_data_fn freeUserDataFun)=0

virtual void	setUserDataLength (uint64_t len)=0

virtual void	setReadFunction (grk_stream_read_fn fn)=0

virtual void	setZeroCopyReadFunction (grk_stream_zero_copy_read_fn fn)=0

virtual void	setWriteFunction (grk_stream_write_fn fn)=0

virtual void	setSeekFunction (grk_stream_seek_fn fn)=0

virtual bool	supportsZeroCopy ()=0

virtual uint8_t *	getZeroCopyPtr ()=0

virtual size_t	read (uint8_t *buffer, size_t p_size)=0
	Reads some bytes from the stream. More...

virtual bool	writeShort (uint16_t value)=0

virtual bool	write24 (uint32_t value)=0

virtual bool	writeInt (uint32_t value)=0

virtual bool	write64 (uint64_t value)=0

virtual bool	writeByte (uint8_t value)=0

virtual size_t	writeBytes (const uint8_t *buffer, size_t p_size)=0
	Write bytes to the stream. More...

virtual bool	flush ()=0
	Flush write stream to disk. More...

virtual bool	skip (int64_t p_size)=0
	Skip bytes in stream, forward or reverse. More...

virtual uint64_t	tell (void)=0
	Tell byte offset in stream (similar to ftell). More...

virtual uint64_t	numBytesLeft (void)=0
	Get number of bytes left before end of the stream. More...

virtual bool	seek (uint64_t offset)=0
	Seek to absolute offset in stream. More...

virtual bool	hasSeek ()=0
	Check if stream is seekable. More...

virtual void	setFormat (GRK_CODEC_FORMAT format)=0

virtual GRK_CODEC_FORMAT	getFormat (void)=0

Static Public Member Functions
static IBufferedStream *	getImpl (grk_stream *stream)

Public Attributes
friend	GrkObjectWrapperImpl< BufferedStream >

Private Member Functions
	~BufferedStream ()

bool	write_skip (int64_t p_size)
	Skip bytes in write stream. More...

bool	read_skip (int64_t p_size)
	Skip bytes in read stream. More...

bool	read_seek (uint64_t offset)
	Absolute seek in read stream. More...

bool	write_seek (uint64_t offset)
	Absolute seek in write stream. More...

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 More...

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

uint64_t	user_data_length_
	User data length. More...

grk_stream_read_fn	read_fn_
	Pointer to actual read function (nullptr at initialization). More...

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

grk_stream_write_fn	write_fn_
	Pointer to actual write function (nullptr at initialization). More...

grk_stream_seek_fn	seek_fn_
	Pointer to actual seek function (if available). More...

uint32_t	status_
	Stream status flags. More...

grk_buf8 *	buf_

size_t	buffered_bytes_

size_t	read_bytes_seekable_

uint64_t	stream_offset_

GRK_CODEC_FORMAT	format_

Constructor & Destructor Documentation

◆ BufferedStream()

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

References buf_, obj, and _grk_object::wrapper.

◆ ~BufferedStream()

grk::BufferedStream::~BufferedStream ( )

private

References buf_, free_user_data_fn_, and user_data_.

Member Function Documentation

◆ flush()

bool grk::BufferedStream::flush ( void )

virtual

Flush stream to disk.

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

Implements grk::IBufferedStream.

References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), grk::GRK_ERROR(), GROK_STREAM_STATUS_ERROR, grk::grk_buf< T, A >::incrementOffset(), isMemStream(), grk::grk_buf< T, A >::offset, read_bytes_seekable_, status_, user_data_, and write_fn_.

Referenced by write(), write_seek(), and writeBytes().

◆ getFormat()

GRK_CODEC_FORMAT grk::BufferedStream::getFormat ( void )

overridevirtual

Implements grk::IBufferedStream.

References format_.

◆ getImpl()

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

static

References _grk_object::wrapper.

Referenced by grk::get_mem_stream_offset(), and grk::grk_stream_set_zero_copy_read_function().

◆ getStatus()

uint32_t grk::BufferedStream::getStatus ( void )

overridevirtual

Implements grk::IBufferedStream.

References status_.

◆ getUserData()

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

overridevirtual

Implements grk::IBufferedStream.

References user_data_.

◆ getWrapper()

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

References obj.

◆ getZeroCopyPtr()

uint8_t * grk::BufferedStream::getZeroCopyPtr ( )

overridevirtual

Implements grk::IBufferedStream.

References buf_, and grk::grk_buf< T, A >::currPtr().

◆ hasSeek()

bool grk::BufferedStream::hasSeek ( void )

overridevirtual

Check if stream is seekable.

Implements grk::IBufferedStream.

References seek_fn_.

◆ invalidate_buffer()

void grk::BufferedStream::invalidate_buffer ( )

private

References buf_, buffered_bytes_, GROK_STREAM_STATUS_INPUT, grk::grk_buf< T, A >::offset, read_bytes_seekable_, and status_.

Referenced by read(), read_seek(), and write_seek().

◆ isMemStream()

bool grk::BufferedStream::isMemStream ( )

private

References buf_, and grk::grk_buf< T, A >::owns_data.

Referenced by flush(), supportsZeroCopy(), write(), write_seek(), writeBytes(), and writeIncrement().

◆ numBytesLeft()

uint64_t grk::BufferedStream::numBytesLeft ( void )

virtual

Get the number of bytes left before end of stream.

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

Implements grk::IBufferedStream.

References stream_offset_, and user_data_length_.

◆ read()

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

virtual

Reads some bytes from the stream.

Parameters

buffer	pointer to the data buffer that will receive the data.
p_size	number of bytes to read.

Returns: the number of bytes read

Implements grk::IBufferedStream.

References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), grk::GRK_ERROR(), GROK_STREAM_STATUS_END, grk::grk_buf< T, A >::incrementOffset(), invalidate_buffer(), grk::grk_buf< T, A >::len, read_bytes_seekable_, read_fn_, status_, stream_offset_, supportsZeroCopy(), user_data_, and user_data_length_.

◆ read_seek()

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

private

Absolute seek in read stream.

Parameters

offset absolute offset

Returns: true if successful, otherwise false

References grk::grk_buf< T, A >::buf, buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), GROK_STREAM_STATUS_END, GROK_STREAM_STATUS_ERROR, grk::grk_buf< T, A >::incrementOffset(), invalidate_buffer(), read_bytes_seekable_, seek_fn_, status_, stream_offset_, user_data_, and user_data_length_.

Referenced by read_skip(), and seek().

◆ read_skip()

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

private

Skip bytes in read stream.

Parameters

p_size the number of bytes to skip.

Returns: true if successful, otherwise false

References read_seek(), and stream_offset_.

Referenced by skip().

◆ seek()

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

overridevirtual

Seek bytes from the stream (absolute)

Parameters

offset the number of bytes to skip.

Returns: true if successful, otherwise false

Implements grk::IBufferedStream.

References GROK_STREAM_STATUS_INPUT, read_seek(), status_, and write_seek().

◆ setFormat()

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

overridevirtual

Implements grk::IBufferedStream.

References hwy::format, and format_.

◆ setReadFunction()

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

overridevirtual

Implements grk::IBufferedStream.

References read_fn_.

◆ setSeekFunction()

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

overridevirtual

Implements grk::IBufferedStream.

References seek_fn_.

◆ setUserData()

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

overridevirtual

Implements grk::IBufferedStream.

References free_user_data_fn_, and user_data_.

◆ setUserDataLength()

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

overridevirtual

Implements grk::IBufferedStream.

References user_data_length_.

◆ setWriteFunction()

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

overridevirtual

Implements grk::IBufferedStream.

References write_fn_.

◆ setZeroCopyReadFunction()

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

overridevirtual

Implements grk::IBufferedStream.

References zero_copy_read_fn_.

◆ skip()

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

virtual

Skip bytes in stream.

Parameters

p_size the number of bytes to skip.

Returns: true if successful, otherwise false

Implements grk::IBufferedStream.

References GROK_STREAM_STATUS_INPUT, read_skip(), status_, and write_skip().

◆ supportsZeroCopy()

bool grk::BufferedStream::supportsZeroCopy ( )

overridevirtual

Implements grk::IBufferedStream.

References GROK_STREAM_STATUS_INPUT, isMemStream(), and status_.

Referenced by read().

◆ tell()

uint64_t grk::BufferedStream::tell ( void )

virtual

Tells byte offset of stream (similar to ftell).

Returns: the current position of the stream.

Implements grk::IBufferedStream.

References stream_offset_.

◆ write()

template<typename TYPE >

bool grk::BufferedStream::write	(	TYPE	value,
		uint8_t	numBytes
	)

private

References buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), flush(), grk::grk_write(), GROK_STREAM_STATUS_ERROR, isMemStream(), grk::grk_buf< T, A >::len, seek_fn_, status_, stream_offset_, user_data_, and writeIncrement().

◆ write24()

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

virtual

Implements grk::IBufferedStream.

◆ write64()

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

virtual

Implements grk::IBufferedStream.

◆ write_seek()

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

private

Absolute seek in write stream.

Parameters

offset absolute offset

Returns: true if successful, otherwise false

References buf_, flush(), GROK_STREAM_STATUS_ERROR, invalidate_buffer(), isMemStream(), grk::grk_buf< T, A >::offset, seek_fn_, status_, stream_offset_, and user_data_.

Referenced by seek(), and write_skip().

◆ write_skip()

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

private

Skip bytes in write stream.

Parameters

p_size the number of bytes to skip.

Returns: true if successful, otherwise false

References stream_offset_, and write_seek().

Referenced by skip().

◆ writeByte()

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

virtual

Implements grk::IBufferedStream.

References writeBytes().

◆ writeBytes()

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

virtual

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

Parameters

buffer	pointer to the data buffer holds the data to be written.
p_size	number of bytes to write.

Returns: the number of bytes written

Implements grk::IBufferedStream.

References buf_, buffered_bytes_, grk::grk_buf< T, A >::currPtr(), flush(), GROK_STREAM_STATUS_ERROR, isMemStream(), grk::grk_buf< T, A >::len, grk::grk_buf< T, A >::offset, status_, stream_offset_, user_data_, write_fn_, and writeIncrement().

Referenced by writeByte().

◆ writeIncrement()

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

private

References buf_, buffered_bytes_, grk::grk_buf< T, A >::incrementOffset(), isMemStream(), and stream_offset_.

Referenced by write(), and writeBytes().

◆ writeInt()

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

virtual

Implements grk::IBufferedStream.

◆ writeShort()

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

virtual

Implements grk::IBufferedStream.

Member Data Documentation

◆ buf_

grk_buf8* grk::BufferedStream::buf_

private

Referenced by BufferedStream(), flush(), getZeroCopyPtr(), invalidate_buffer(), isMemStream(), read(), read_seek(), write(), write_seek(), writeBytes(), writeIncrement(), and ~BufferedStream().

◆ buffered_bytes_

size_t grk::BufferedStream::buffered_bytes_

private

Referenced by flush(), invalidate_buffer(), read(), read_seek(), write(), writeBytes(), and writeIncrement().

◆ format_

GRK_CODEC_FORMAT grk::BufferedStream::format_

private

Referenced by getFormat(), and setFormat().

◆ free_user_data_fn_

grk_stream_free_user_data_fn 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).

Referenced by setUserData(), and ~BufferedStream().

◆ GrkObjectWrapperImpl< BufferedStream >

friend grk::BufferedStream::GrkObjectWrapperImpl< BufferedStream >

◆ obj

grk_object grk::BufferedStream::obj

private

Referenced by BufferedStream(), and getWrapper().

◆ read_bytes_seekable_

size_t grk::BufferedStream::read_bytes_seekable_

private

Referenced by flush(), invalidate_buffer(), read(), and read_seek().

◆ read_fn_

grk_stream_read_fn grk::BufferedStream::read_fn_

private

Pointer to actual read function (nullptr at initialization).

Referenced by read(), and setReadFunction().

◆ seek_fn_

grk_stream_seek_fn grk::BufferedStream::seek_fn_

private

Pointer to actual seek function (if available).

Referenced by hasSeek(), read_seek(), setSeekFunction(), write(), and write_seek().

◆ status_

uint32_t grk::BufferedStream::status_

private

Stream status flags.

Referenced by flush(), getStatus(), invalidate_buffer(), read(), read_seek(), seek(), skip(), supportsZeroCopy(), write(), write_seek(), and writeBytes().

◆ stream_offset_

uint64_t grk::BufferedStream::stream_offset_

private

Referenced by numBytesLeft(), read(), read_seek(), read_skip(), tell(), write(), write_seek(), write_skip(), writeBytes(), and writeIncrement().

◆ user_data_

void* grk::BufferedStream::user_data_

private

user data

Referenced by flush(), getUserData(), read(), read_seek(), setUserData(), write(), write_seek(), writeBytes(), and ~BufferedStream().

◆ user_data_length_

uint64_t 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

Referenced by numBytesLeft(), read(), read_seek(), and setUserDataLength().

◆ write_fn_

grk_stream_write_fn grk::BufferedStream::write_fn_

private

Pointer to actual write function (nullptr at initialization).

Referenced by flush(), setWriteFunction(), and writeBytes().

◆ zero_copy_read_fn_

grk_stream_zero_copy_read_fn grk::BufferedStream::zero_copy_read_fn_

private

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

Referenced by setZeroCopyReadFunction().

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

Public Member Functions

Static Public Member Functions

Public Attributes

Private Member Functions

Private Attributes

Constructor & Destructor Documentation

◆ BufferedStream()

◆ ~BufferedStream()

Member Function Documentation

◆ flush()

◆ getFormat()

◆ getImpl()

◆ getStatus()

◆ getUserData()

◆ getWrapper()

◆ getZeroCopyPtr()

◆ hasSeek()

◆ invalidate_buffer()

◆ isMemStream()

◆ numBytesLeft()

◆ read()

◆ read_seek()

◆ read_skip()

◆ seek()

◆ setFormat()

◆ setReadFunction()

◆ setSeekFunction()

◆ setUserData()

◆ setUserDataLength()

◆ setWriteFunction()

◆ setZeroCopyReadFunction()

◆ skip()

◆ supportsZeroCopy()

◆ tell()

◆ write()

◆ write24()

◆ write64()

◆ write_seek()

◆ write_skip()

◆ writeByte()

◆ writeBytes()

◆ writeIncrement()

◆ writeInt()

◆ writeShort()

Member Data Documentation

◆ buf_

◆ buffered_bytes_

◆ format_

◆ free_user_data_fn_

◆ GrkObjectWrapperImpl< BufferedStream >

◆ obj

◆ read_bytes_seekable_

◆ read_fn_

◆ seek_fn_

◆ status_

◆ stream_offset_

◆ user_data_

◆ user_data_length_

◆ write_fn_

◆ zero_copy_read_fn_