grk::StreamGenerator Class Reference

#include <StreamGenerator.h>

Public Member Functions
	StreamGenerator (grk_stream_params *src)
IStream *	create (void)

Private Member Functions
size_t	getDoubleBufferLength (size_t configuredLength)
size_t	getInitialDoubleBufferLength (size_t configuredLength)
IStream *	createCurlFetchStream (void)
IStream *	createFileStream (void)
IStream *	createCallbackStream (void)
IStream *	createBufferStream (bool isReadStream)
bool	validateStream (IStream *stream)
template<size_t N>
void	safe_strcpy (char(&dest)[N], const char *src)

Static Private Member Functions
static size_t	grkReadFromFile (uint8_t *buffer, size_t numBytes, void *p_file)
static uint64_t	getDataLengthFromFile (void *filePtr)
static size_t	grkWriteToFile (const uint8_t *buffer, size_t numBytes, void *p_file)
static bool	grkSeekInFile (uint64_t numBytes, void *p_user_data)
static void	grkFreeFile (void *p_user_data)

Private Attributes
grk_stream_params	streamParams_ {}

Static Private Attributes
static constexpr size_t	DEFAULT_BUFFER_LEN = 4096
static constexpr size_t	DEFAULT_INITIAL_BUFFER_LEN = 512 * 1024
static constexpr bool	useCallbacks = false

Constructor & Destructor Documentation

StreamGenerator()

grk::StreamGenerator::StreamGenerator ( grk_stream_params * src )

inline

References safe_strcpy(), and streamParams_.

Member Function Documentation

create()

IStream * grk::StreamGenerator::create ( void )

inline

References createBufferStream(), createCallbackStream(), createCurlFetchStream(), createFileStream(), grk::grklog, and streamParams_.

Referenced by grk_compress_init(), grk_decompress_init(), and grk_transcode().

createBufferStream()

IStream * grk::StreamGenerator::createBufferStream ( bool isReadStream )

inlineprivate

References grk::grklog, grk::memStreamCreate(), and streamParams_.

Referenced by create().

createCallbackStream()

IStream * grk::StreamGenerator::createCallbackStream ( void )

private

References getDoubleBufferLength(), getInitialDoubleBufferLength(), streamParams_, and validateStream().

Referenced by create().

createCurlFetchStream()

IStream * grk::StreamGenerator::createCurlFetchStream ( void )

private

References grk::FetchAuth::connect_timeout_, grk::FetchAuth::cookie_, grk::FetchAuth::cookie_file_, grk::FetchAuth::cookie_jar_, grk::FetchAuth::custom_headers_, getDoubleBufferLength(), getInitialDoubleBufferLength(), grk::grklog, grk::FetchAuth::max_retry_, grk::FetchAuth::netrc_, grk::FetchAuth::netrc_file_, grk::FetchAuth::password_, grk::FetchAuth::proxy_, grk::FetchAuth::proxy_userpwd_, grk::FetchAuth::region_, grk::FetchAuth::request_payer_, grk::FetchAuth::retry_delay_, grk::FetchAuth::s3_allow_insecure_, grk::FetchAuth::s3_endpoint_, grk::FetchAuth::s3_no_sign_request_, grk::FetchAuth::s3_use_https_, grk::FetchAuth::s3_use_virtual_hosting_, grk::FetchAuth::session_token_, streamParams_, grk::FetchAuth::timeout_, grk::FetchAuth::user_agent_, grk::FetchAuth::username_, and validateStream().

Referenced by create().

createFileStream()

IStream * grk::StreamGenerator::createFileStream ( void )

private

References grk::createMappedFileReadStream(), getDataLengthFromFile(), getDoubleBufferLength(), getInitialDoubleBufferLength(), grkFreeFile(), grk::grklog, grkReadFromFile(), grkSeekInFile(), grkWriteToFile(), streamParams_, and validateStream().

Referenced by create().

getDataLengthFromFile()

uint64_t grk::StreamGenerator::getDataLengthFromFile ( void * filePtr )

inlinestaticprivate

References GRK_FSEEK, and GRK_FTELL.

Referenced by createFileStream().

getDoubleBufferLength()

size_t grk::StreamGenerator::getDoubleBufferLength ( size_t configuredLength )

inlineprivate

References DEFAULT_BUFFER_LEN.

Referenced by createCallbackStream(), createCurlFetchStream(), and createFileStream().

getInitialDoubleBufferLength()

size_t grk::StreamGenerator::getInitialDoubleBufferLength ( size_t configuredLength )

inlineprivate

References DEFAULT_INITIAL_BUFFER_LEN.

Referenced by createCallbackStream(), createCurlFetchStream(), and createFileStream().

grkFreeFile()

void grk::StreamGenerator::grkFreeFile ( void * p_user_data )

inlinestaticprivate

Referenced by createFileStream().

grkReadFromFile()

size_t grk::StreamGenerator::grkReadFromFile ( uint8_t * buffer, size_t numBytes, void * p_file )

inlinestaticprivate

Referenced by createFileStream().

grkSeekInFile()

bool grk::StreamGenerator::grkSeekInFile ( uint64_t numBytes, void * p_user_data )

inlinestaticprivate

References GRK_FSEEK.

Referenced by createFileStream().

grkWriteToFile()

size_t grk::StreamGenerator::grkWriteToFile ( const uint8_t * buffer, size_t numBytes, void * p_file )

inlinestaticprivate

Referenced by createFileStream().

safe_strcpy()

template<size_t N>

void grk::StreamGenerator::safe_strcpy ( char(&) dest[N], const char * src )

inlineprivate

Referenced by StreamGenerator().

validateStream()

bool grk::StreamGenerator::validateStream ( IStream * stream )

inlineprivate

References grk::detectFormat(), GRK_JPEG_2000_NUM_IDENTIFIER_BYTES, grk::grklog, grk::IStream::read(), grk::IStream::seek(), and grk::IStream::setFormat().

Referenced by createCallbackStream(), createCurlFetchStream(), and createFileStream().

Member Data Documentation

DEFAULT_BUFFER_LEN

size_t grk::StreamGenerator::DEFAULT_BUFFER_LEN = 4096

staticconstexprprivate

Referenced by getDoubleBufferLength().

DEFAULT_INITIAL_BUFFER_LEN

size_t grk::StreamGenerator::DEFAULT_INITIAL_BUFFER_LEN = 512 * 1024

staticconstexprprivate

Referenced by getInitialDoubleBufferLength().

streamParams_

grk_stream_params grk::StreamGenerator::streamParams_ {}

private

Referenced by create(), createBufferStream(), createCallbackStream(), createCurlFetchStream(), createFileStream(), and StreamGenerator().

useCallbacks

bool grk::StreamGenerator::useCallbacks = false

staticconstexprprivate

---

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

• StreamGenerator.h
• StreamGenerator.cpp