Grok 12.0.1
Typedefs | Functions
grok_private.h File Reference
#include "grok.h"

Go to the source code of this file.

Typedefs

typedef grk_object grk_stream
 

Functions

void grk_stream_set_read_function (grk_stream *stream, grk_stream_read_fn func)
 Set read function.
 
void grk_stream_set_write_function (grk_stream *stream, grk_stream_write_fn func)
 Set write function.
 
void grk_stream_set_seek_function (grk_stream *stream, grk_stream_seek_fn func)
 Set (absolute) seek function (stream must be seekable)
 
void grk_stream_set_user_data (grk_stream *stream, void *data, grk_stream_free_user_data_fn func)
 Set user data for JPEG 2000 stream.
 
void grk_stream_set_user_data_length (grk_stream *stream, uint64_t data_length)
 Set the length of the user data for the stream.
 
bool grk_decompress_buffer_detect_format (uint8_t *buffer, size_t len, GRK_CODEC_FORMAT *fmt)
 Detect jpeg 2000 format from buffer Format is either GRK_FMT_J2K or GRK_FMT_JP2.
 

Typedef Documentation

◆ grk_stream

Function Documentation

◆ grk_decompress_buffer_detect_format()

bool grk_decompress_buffer_detect_format ( uint8_t * buffer,
size_t len,
GRK_CODEC_FORMAT * fmt )

Detect jpeg 2000 format from buffer Format is either GRK_FMT_J2K or GRK_FMT_JP2.

Parameters
bufferbuffer
lenbuffer length
fmtpointer to detected format
Returns
true if format was detected, otherwise false

References grk::Logger::error(), GRK_CODEC_J2K, GRK_CODEC_JP2, GRK_CODEC_UNK, grk::grk_read(), J2K_CODESTREAM_MAGIC, JP2_RFC3745_MAGIC, and grk::Logger::logger_.

Referenced by grk::create_mem_stream(), grk_decompress_detect_format(), grk_stream_create_file_stream(), and grk_stream_create_stream().

◆ grk_stream_set_read_function()

void grk_stream_set_read_function ( grk_stream * stream,
grk_stream_read_fn func )

Set read function.

Parameters
streamJPEG 2000 stream
funcread function

References grk::BufferedStream::getImpl(), grk::grk_read(), and GROK_STREAM_STATUS_INPUT.

Referenced by grk_stream_create_file_stream(), grk_stream_create_stream(), and grk::set_up_mem_stream().

◆ grk_stream_set_seek_function()

void grk_stream_set_seek_function ( grk_stream * stream,
grk_stream_seek_fn func )

Set (absolute) seek function (stream must be seekable)

Parameters
streamJPEG 2000 stream
func(absolute) seek function.

References grk::BufferedStream::getImpl(), and grk::grk_read().

Referenced by grk_stream_create_file_stream(), grk_stream_create_stream(), and grk::set_up_mem_stream().

◆ grk_stream_set_user_data()

void grk_stream_set_user_data ( grk_stream * stream,
void * data,
grk_stream_free_user_data_fn func )

Set user data for JPEG 2000 stream.

Parameters
streamJPEG 2000 stream
datauser data
funcfunction to free data when grk_object_unref() is called.

References grk::BufferedStream::getImpl(), and grk::grk_read().

Referenced by grk::create_mem_stream(), grk_stream_create_file_stream(), and grk_stream_create_stream().

◆ grk_stream_set_user_data_length()

void grk_stream_set_user_data_length ( grk_stream * stream,
uint64_t data_length )

Set the length of the user data for the stream.

Parameters
streamJPEG 2000 stream
data_lengthlength of data.

References grk::BufferedStream::getImpl(), and grk::grk_read().

Referenced by grk_stream_create_file_stream(), grk_stream_create_stream(), and grk::set_up_mem_stream().

◆ grk_stream_set_write_function()

void grk_stream_set_write_function ( grk_stream * stream,
grk_stream_write_fn func )

Set write function.

Parameters
streamJPEG 2000 stream
funcwrite function

References grk::BufferedStream::getImpl(), grk::grk_read(), and GROK_STREAM_STATUS_OUTPUT.

Referenced by grk_stream_create_file_stream(), grk_stream_create_stream(), and grk::set_up_mem_stream().