34#include "grk_config.h"
38#define GRK_CALLCONV __stdcall
43#define GRK_API __declspec(dllexport)
45#define GRK_API __declspec(dllimport)
51#define GRK_API __attribute__((visibility("hidden")))
53#define GRK_API __attribute__((visibility("default")))
124#define GRK_NUM_COMMENTS_SUPPORTED 256
129#define GRK_NUM_ASOC_BOXES_SUPPORTED 256
134#define GRK_MAX_COMMENT_LENGTH (UINT16_MAX - 2)
139#define GRK_MAX_SUPPORTED_IMAGE_PRECISION 16
157#define GRK_BIBO_EXTRA_BITS 7
162#define GRK_MAX_PASSES (3 * (GRK_MAX_SUPPORTED_IMAGE_PRECISION + GRK_BIBO_EXTRA_BITS) - 2)
317#define GRK_PATH_LEN 4096
318#define GRK_MAX_LAYERS 256
324#define GRK_MAX_DECOMP_LVLS \
327#define GRK_MAXRLVLS \
328 (GRK_MAX_DECOMP_LVLS + 1)
329#define GRK_MAXBANDS (3 * GRK_MAXRLVLS - 2)
502 void* io_user_data,
void* reclaim_user_data);
521typedef size_t (*
grk_stream_read_fn)(uint8_t* buffer,
size_t numBytes,
void* user_data);
531typedef size_t (*
grk_stream_write_fn)(
const uint8_t* buffer,
size_t numBytes,
void* user_data);
625#define GRK_DECOMPRESS_COMPRESSION_LEVEL_DEFAULT (UINT_MAX)
946#define GRK_DECODE_HEADER (1 << 0)
947#define GRK_DECODE_T2 (1 << 1)
948#define GRK_DECODE_T1 (1 << 2)
949#define GRK_DECODE_POST_T1 (1 << 3)
950#define GRK_PLUGIN_DECODE_CLEAN (1 << 4)
951#define GRK_DECODE_ALL \
952 (GRK_PLUGIN_DECODE_CLEAN | GRK_DECODE_HEADER | GRK_DECODE_T2 | GRK_DECODE_T1 | \
1114 uint16_t tile_index);
1141 double start_y,
double end_x,
double end_y);
1360 FILE* output_stream);
1373 int32_t* dc_shift, uint32_t nb_comp);
1375#define GRK_IMG_INFO 1
1376#define GRK_MH_INFO 2
1377#define GRK_TH_INFO 4
1378#define GRK_TCH_INFO 8
1379#define GRK_MH_IND 16
1380#define GRK_TH_IND 32
1382#define GRK_CBLKSTY_LAZY 0x01
1383#define GRK_CBLKSTY_RESET 0x02
1384#define GRK_CBLKSTY_TERMALL 0x04
1385#define GRK_CBLKSTY_VSC 0x08
1386#define GRK_CBLKSTY_PTERM 0x10
1387#define GRK_CBLKSTY_SEGSYM 0x20
1388#define GRK_CBLKSTY_HT_ONLY 0x40
1389#define GRK_CBLKSTY_HT_MIXED 0xC0
1390#define GRK_JPH_RSIZ_FLAG 0x4000
1412#define GRK_PROFILE_NONE 0x0000
1413#define GRK_PROFILE_0 0x0001
1414#define GRK_PROFILE_1 0x0002
1415#define GRK_PROFILE_CINEMA_2K 0x0003
1416#define GRK_PROFILE_CINEMA_4K 0x0004
1417#define GRK_PROFILE_CINEMA_S2K 0x0005
1418#define GRK_PROFILE_CINEMA_S4K 0x0006
1419#define GRK_PROFILE_CINEMA_LTS \
1421#define GRK_PROFILE_BC_SINGLE 0x0100
1422#define GRK_PROFILE_BC_MULTI 0x0200
1423#define GRK_PROFILE_BC_MULTI_R \
1425#define GRK_PROFILE_BC_MASK 0x030F
1426#define GRK_PROFILE_IMF_2K 0x0400
1427#define GRK_PROFILE_IMF_4K 0x0500
1428#define GRK_PROFILE_IMF_8K 0x0600
1429#define GRK_PROFILE_IMF_2K_R \
1431#define GRK_PROFILE_IMF_4K_R \
1433#define GRK_PROFILE_IMF_8K_R \
1435#define GRK_PROFILE_MASK 0x0FFF
1436#define GRK_PROFILE_PART2 0x8000
1437#define GRK_PROFILE_PART2_EXTENSIONS_MASK 0x3FFF
1442#define GRK_EXTENSION_NONE 0x0000
1443#define GRK_EXTENSION_MCT 0x0100
1444#define GRK_IS_PART2(v) ((v) & GRK_PROFILE_PART2)
1446#define GRK_IS_CINEMA(v) (((v) >= GRK_PROFILE_CINEMA_2K) && ((v) <= GRK_PROFILE_CINEMA_S4K))
1447#define GRK_IS_STORAGE(v) ((v) == GRK_PROFILE_CINEMA_LTS)
1501#define GRK_GET_IMF_OR_BROADCAST_PROFILE(v) \
1504#define GRK_LEVEL_MAX 11U
1505#define GRK_GET_LEVEL(v) ((v) & 0xf)
1509#define GRK_IS_BROADCAST(v) \
1510 (((v) >= GRK_PROFILE_BC_SINGLE) && ((v) <= (GRK_PROFILE_BC_MULTI_R | 0x000b)) && \
1511 (((v) & 0xf) <= 0xb))
1514#define GRK_BROADCAST_LEVEL_1_MBITSSEC 200U
1515#define GRK_BROADCAST_LEVEL_2_MBITSSEC 200U
1516#define GRK_BROADCAST_LEVEL_3_MBITSSEC 200U
1517#define GRK_BROADCAST_LEVEL_4_MBITSSEC 400U
1518#define GRK_BROADCAST_LEVEL_5_MBITSSEC 800U
1519#define GRK_BROADCAST_LEVEL_6_MBITSSEC 1600U
1520#define GRK_BROADCAST_LEVEL_7_MBITSSEC 3200U
1521#define GRK_BROADCAST_LEVEL_8_MBITSSEC 6400U
1522#define GRK_BROADCAST_LEVEL_9_MBITSSEC 12800U
1523#define GRK_BROADCAST_LEVEL_10_MBITSSEC 25600U
1524#define GRK_BROADCAST_LEVEL_11_MBITSSEC 51200U
1526#define GRK_BROADCAST_LEVEL_1_MSAMPLESSEC 64U
1527#define GRK_BROADCAST_LEVEL_2_MSAMPLESSEC 130U
1528#define GRK_BROADCAST_LEVEL_3_MSAMPLESSEC 195U
1529#define GRK_BROADCAST_LEVEL_4_MSAMPLESSEC 260U
1530#define GRK_BROADCAST_LEVEL_5_MSAMPLESSEC 520U
1531#define GRK_BROADCAST_LEVEL_6_MSAMPLESSEC 1200U
1532#define GRK_BROADCAST_LEVEL_7_MSAMPLESSEC 2400U
1533#define GRK_BROADCAST_LEVEL_8_MSAMPLESSEC 4800U
1534#define GRK_BROADCAST_LEVEL_9_MSAMPLESSEC 9600U
1535#define GRK_BROADCAST_LEVEL_10_MSAMPLESSEC 19200U
1536#define GRK_BROADCAST_LEVEL_11_MSAMPLESSEC 38400U
1540#define GRK_IS_IMF(v) \
1541 (((v) >= GRK_PROFILE_IMF_2K) && ((v) <= (GRK_PROFILE_IMF_8K_R | 0x009b)) && \
1542 (((v) & 0xf) <= 0xb) && (((v) & 0xf0) <= 0x90))
1545#define GRK_IMF_MAINLEVEL_1_MSAMPLESSEC 65U
1546#define GRK_IMF_MAINLEVEL_2_MSAMPLESSEC 130U
1547#define GRK_IMF_MAINLEVEL_3_MSAMPLESSEC 195U
1548#define GRK_IMF_MAINLEVEL_4_MSAMPLESSEC 260U
1549#define GRK_IMF_MAINLEVEL_5_MSAMPLESSEC 520U
1550#define GRK_IMF_MAINLEVEL_6_MSAMPLESSEC 1200U
1551#define GRK_IMF_MAINLEVEL_7_MSAMPLESSEC 2400U
1552#define GRK_IMF_MAINLEVEL_8_MSAMPLESSEC 4800U
1553#define GRK_IMF_MAINLEVEL_9_MSAMPLESSEC 9600U
1554#define GRK_IMF_MAINLEVEL_10_MSAMPLESSEC 19200U
1555#define GRK_IMF_MAINLEVEL_11_MSAMPLESSEC 38400U
1557#define GRK_IMF_SUBLEVEL_MAX 9U
1558#define GRK_GET_IMF_SUBLEVEL(v) (((v) >> 4) & 0xf)
1561#define GRK_IMF_SUBLEVEL_1_MBITSSEC 200U
1562#define GRK_IMF_SUBLEVEL_2_MBITSSEC 400U
1563#define GRK_IMF_SUBLEVEL_3_MBITSSEC 800U
1564#define GRK_IMF_SUBLEVEL_4_MBITSSEC 1600U
1565#define GRK_IMF_SUBLEVEL_5_MBITSSEC 3200U
1566#define GRK_IMF_SUBLEVEL_6_MBITSSEC 6400U
1567#define GRK_IMF_SUBLEVEL_7_MBITSSEC 12800U
1568#define GRK_IMF_SUBLEVEL_8_MBITSSEC 25600U
1569#define GRK_IMF_SUBLEVEL_9_MBITSSEC 51200U
1576#define GRK_CINEMA_DCI_MAX_BANDWIDTH 250000000
1578#define GRK_CINEMA_24_CS 1302083
1579#define GRK_CINEMA_24_COMP 1041666
1581#define GRK_CINEMA_48_CS 651041
1582#define GRK_CINEMA_48_COMP 520833
1584#define GRK_CINEMA_4K_DEFAULT_NUM_RESOLUTIONS 7
1589#define GRK_CUSTOM_CIELAB_SPACE 0x0
1590#define GRK_DEFAULT_CIELAB_SPACE 0x44454600
1595#define GRK_RANDOM_ACCESS_PLT 1
1596#define GRK_RANDOM_ACCESS_TLM 2
1597#define GRK_RANDOM_ACCESS_PLM 4
1629#define GRK_PLUGIN_STATE_NO_DEBUG 0x0
1646#define GRK_PLUGIN_STATE_DEBUG 0x1
1647#define GRK_PLUGIN_STATE_PRE_TR1 0x2
1648#define GRK_PLUGIN_STATE_DWT_QUANTIZATION 0x4
1649#define GRK_PLUGIN_STATE_MCT_ONLY 0x8
struct _grk_plugin_init_info grk_plugin_init_info
enum _GRK_TILE_CACHE_STRATEGY GRK_TILE_CACHE_STRATEGY
Grok tile cache strategy.
_GRK_SUPPORTED_FILE_FMT
All supported file formats.
Definition grok.h:290
@ GRK_FMT_BMP
Definition grok.h:297
@ GRK_FMT_JP2
Definition grok.h:293
@ GRK_FMT_J2K
Definition grok.h:292
@ GRK_FMT_PNG
Definition grok.h:300
@ GRK_FMT_YUV
Definition grok.h:303
@ GRK_FMT_RAWL
Definition grok.h:301
@ GRK_FMT_UNK
Definition grok.h:291
@ GRK_FMT_TIF
Definition grok.h:298
@ GRK_FMT_JPG
Definition grok.h:302
@ GRK_FMT_PXM
Definition grok.h:294
@ GRK_FMT_RAW
Definition grok.h:299
@ GRK_FMT_PAM
Definition grok.h:296
@ GRK_FMT_PGX
Definition grok.h:295
GRK_API bool GRK_CALLCONV grk_decompress_set_window(grk_object *codec, double start_x, double start_y, double end_x, double end_y)
Specifies area to be decompressed.
Definition grok.cpp:415
struct _grk_cparameters grk_cparameters
GRK_API void GRK_CALLCONV grk_decompress_set_default_params(grk_decompress_parameters *parameters)
Initializes decompress parameters with default values.
Definition grok.cpp:353
struct _grk_progression grk_progression
enum _grk_precision_mode grk_precision_mode
struct _grk_image grk_image
void(* grk_io_register_reclaim_callback)(grk_io_init io_init, grk_io_callback reclaim_callback, void *io_user_data, void *reclaim_user_data)
Grok IO register reclaim callback.
Definition grok.h:499
GRK_API bool GRK_CALLCONV grk_initialize(const char *pluginPath, uint32_t num_threads, bool verbose)
Initializes library.
Definition grok.cpp:131
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_compress(void)
Stops batch compress.
Definition grok.cpp:904
GRK_API bool GRK_CALLCONV grk_set_MCT(grk_cparameters *parameters, float *encoding_matrix, int32_t *dc_shift, uint32_t nb_comp)
Sets MCT matrix.
Definition grok.cpp:461
GRK_API grk_object *GRK_CALLCONV grk_object_ref(grk_object *obj)
Increments ref count.
Definition grok.cpp:160
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_decompress(void)
Stops batch decompress.
Definition grok.cpp:1001
struct _grk_channel_description grk_channel_description
#define GRK_NUM_COMMENTS_SUPPORTED
maximum Grok supported number of comments
Definition grok.h:124
void(* grk_msg_callback)(const char *msg, void *client_data)
Logging callback.
Definition grok.h:170
enum _GRK_CHANNEL_TYPE GRK_CHANNEL_TYPE
struct _grk_stream_params grk_stream_params
GRK_API bool GRK_CALLCONV grk_decompress_set_progression_state(grk_object *codec, grk_progression_state state)
Sets grk_progression_state for a tile.
Definition grok.cpp:509
GRK_API void GRK_CALLCONV grk_plugin_cleanup(void)
Cleans up plugin resources.
Definition grok.cpp:822
GRK_API void GRK_CALLCONV grk_set_msg_handlers(grk_msg_handlers msg_handlers)
Sets log message handlers.
Definition grok.cpp:178
GRK_API bool GRK_CALLCONV grk_plugin_load(grk_plugin_load_info info)
Loads plugin.
Definition grok.cpp:780
struct _grk_progression_state grk_progression_state
struct grk_plugin_compress_batch_info grk_plugin_compress_batch_info
Plugin batch compress info.
uint64_t(* GRK_PLUGIN_COMPRESS_USER_CALLBACK)(grk_plugin_compress_user_callback_info *info)
Plugin compress user callback.
Definition grok.h:1697
#define GRK_MAXRLVLS
Definition grok.h:326
enum _GRK_CODEC_FORMAT GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
enum _GRK_ENUM_COLOUR_SPACE GRK_ENUM_COLOUR_SPACE
JPEG 2000 standard color spaces.
GRK_API void GRK_CALLCONV grk_dump_codec(grk_object *codec, uint32_t info_flag, FILE *output_stream)
Dumps codec information to file.
Definition grok.cpp:450
GRK_API uint32_t GRK_CALLCONV grk_plugin_get_debug_state()
Gets debug state of plugin.
Definition grok.cpp:807
struct _grk_precision grk_precision
struct _grk_plugin_decompress_callback_info grk_plugin_decompress_callback_info
#define GRK_MAX_PASSES
Grok maximum number of passes.
Definition grok.h:162
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_decompress(void)
Initiates batch decompress.
Definition grok.cpp:987
enum _GRK_PROG_ORDER GRK_PROG_ORDER
Progression order.
struct _grk_object grk_object
bool(* grk_io_pixels_callback)(uint32_t thread_id, grk_io_buf buffer, void *user_data)
Grok IO pixels callback.
Definition grok.h:510
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_image(grk_object *codec)
Gets decompressed image.
Definition grok.cpp:516
struct _grk_raw_cparameters grk_raw_cparameters
GRK_API bool GRK_CALLCONV grk_decompress_read_header(grk_object *codec, grk_header_info *header_info)
Decompresses JPEG 2000 header.
Definition grok.cpp:401
struct _grk_plugin_load_info grk_plugin_load_info
GRK_API int32_t GRK_CALLCONV grk_plugin_compress(grk_cparameters *compress_parameters, GRK_PLUGIN_COMPRESS_USER_CALLBACK callback)
Compresses with plugin.
Definition grok.cpp:856
_GRK_CHANNEL_ASSOC
Channel association.
Definition grok.h:381
@ GRK_CHANNEL_ASSOC_COLOUR_1
Definition grok.h:384
@ GRK_CHANNEL_ASSOC_COLOUR_2
Definition grok.h:385
@ GRK_CHANNEL_ASSOC_COLOUR_3
Definition grok.h:386
@ GRK_CHANNEL_ASSOC_WHOLE_IMAGE
Definition grok.h:383
@ GRK_CHANNEL_ASSOC_UNASSOCIATED
Definition grok.h:387
struct _grk_msg_handlers grk_msg_handlers
enum _GRK_RATE_CONTROL_ALGORITHM GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms.
struct _grk_decompress_core_params grk_decompress_core_params
size_t(* grk_stream_read_fn)(uint8_t *buffer, size_t numBytes, void *user_data)
Read stream callback.
Definition grok.h:520
struct _grk_image_meta grk_image_meta
struct _grk_asoc grk_asoc
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_tile_image(grk_object *codec, uint16_t tile_index)
Gets decompressed tile image.
Definition grok.cpp:490
enum _GRK_SUPPORTED_FILE_FMT GRK_SUPPORTED_FILE_FMT
All supported file formats.
GRK_API grk_progression_state GRK_CALLCONV grk_decompress_get_progression_state(grk_object *codec, uint16_t tile_index)
Gets grk_progression_state for a tile.
Definition grok.cpp:501
struct _grk_palette_data grk_palette_data
GRK_API bool GRK_CALLCONV grk_decompress_detect_format(const char *file_name, GRK_CODEC_FORMAT *fmt)
Detects JPEG 2000 format from file.
Definition grok.cpp:279
GRK_API bool GRK_CALLCONV grk_decompress_tile(grk_object *codec, uint16_t tile_index)
Decompresses a specific tile.
Definition grok.cpp:439
#define GRK_API
Definition grok.h:53
struct _grk_component_mapping_comp grk_component_mapping_comp
struct _grk_image_comp grk_image_comp
struct _grk_raw_comp_cparameters grk_raw_comp_cparameters
GRK_API void GRK_CALLCONV grk_deinitialize()
De-initializes library.
Definition grok.cpp:154
struct grk_plugin_tile_component grk_plugin_tile_component
GRK_API void GRK_CALLCONV grk_object_unref(grk_object *obj)
Definition grok.cpp:169
#define GRK_MAX_LAYERS
Definition grok.h:318
GRK_API void GRK_CALLCONV grk_compress_set_default_params(grk_cparameters *parameters)
Sets compression parameters to default values:
Definition grok.cpp:546
struct _grk_plugin_precinct grk_plugin_precinct
grk_plugin_precinct
struct grk_plugin_compress_user_callback_info grk_plugin_compress_user_callback_info
GRK_API const char *GRK_CALLCONV grk_version(void)
Gets library version.
Definition grok.cpp:234
_GRK_COLOR_SPACE
Grok supported color spaces.
Definition grok.h:81
@ GRK_CLRSPC_SRGB
unknown
Definition grok.h:83
@ GRK_CLRSPC_EYCC
standard YCC (YUV)
Definition grok.h:86
@ GRK_CLRSPC_UNKNOWN
Definition grok.h:82
@ GRK_CLRSPC_SYCC
grayscale
Definition grok.h:85
@ GRK_CLRSPC_DEFAULT_CIE
CMYK.
Definition grok.h:88
@ GRK_CLRSPC_ICC
custom CIE LAB
Definition grok.h:90
@ GRK_CLRSPC_CMYK
extended YCC
Definition grok.h:87
@ GRK_CLRSPC_GRAY
sRGB
Definition grok.h:84
@ GRK_CLRSPC_CUSTOM_CIE
default CIE LAB
Definition grok.h:89
GRK_API bool GRK_CALLCONV grk_plugin_init(grk_plugin_init_info init_info)
Initializes plugin.
Definition grok.cpp:827
GRK_API bool GRK_CALLCONV grk_decompress(grk_object *codec, grk_plugin_tile *tile)
Decompresses image from a JPEG 2000 code stream.
Definition grok.cpp:427
struct _grk_io_buf grk_io_buf
_grk_precision_mode
Definition grok.h:429
@ GRK_PREC_MODE_SCALE
Definition grok.h:431
@ GRK_PREC_MODE_CLIP
Definition grok.h:430
GRK_API grk_image_meta *GRK_CALLCONV grk_image_meta_new(void)
Creates meta.
Definition grok.cpp:245
enum _GRK_COLOR_SPACE GRK_COLOR_SPACE
Grok supported color spaces.
#define GRK_PATH_LEN
Definition grok.h:317
bool(* grk_io_callback)(uint32_t thread_id, grk_io_buf buffer, void *io_user_data)
Grok IO callback.
Definition grok.h:489
GRK_API grk_image *GRK_CALLCONV grk_image_new(uint16_t numcmpts, grk_image_comp *cmptparms, GRK_COLOR_SPACE clrspc, bool alloc_data)
Creates image.
Definition grok.cpp:239
GRK_API int32_t GRK_CALLCONV grk_plugin_decompress(grk_decompress_parameters *decompress_parameters, grk_plugin_decompress_callback callback)
Decompresses single image with plugin.
Definition grok.cpp:952
bool(* grk_stream_seek_fn)(uint64_t offset, void *user_data)
Seek (absolute) callback.
Definition grok.h:539
struct _grk_io_init grk_io_init
GRK_API grk_object *GRK_CALLCONV grk_decompress_init(grk_stream_params *stream_params, grk_decompress_parameters *params)
Initializes decompressor.
Definition grok.cpp:364
_GRK_ENUM_COLOUR_SPACE
JPEG 2000 standard color spaces.
Definition grok.h:98
@ GRK_ENUM_CLRSPC_ESRGB
Definition grok.h:114
@ GRK_ENUM_CLRSPC_CMY
Definition grok.h:105
@ GRK_ENUM_CLRSPC_EYCC
Definition grok.h:118
@ GRK_ENUM_CLRSPC_CIEJAB
Definition grok.h:113
@ GRK_ENUM_CLRSPC_GRAY
Definition grok.h:111
@ GRK_ENUM_CLRSPC_CIE
Definition grok.h:108
@ GRK_ENUM_CLRSPC_UNKNOWN
Definition grok.h:99
@ GRK_ENUM_CLRSPC_YCBCR3
Definition grok.h:103
@ GRK_ENUM_CLRSPC_ROMMRGB
Definition grok.h:115
@ GRK_ENUM_CLRSPC_YPBPR60
Definition grok.h:116
@ GRK_ENUM_CLRSPC_SRGB
Definition grok.h:110
@ GRK_ENUM_CLRSPC_BILEVEL2
Definition grok.h:109
@ GRK_ENUM_CLRSPC_SYCC
Definition grok.h:112
@ GRK_ENUM_CLRSPC_PHOTO_YCC
Definition grok.h:104
@ GRK_ENUM_CLRSPC_YCBCR1
Definition grok.h:101
@ GRK_ENUM_CLRSPC_CMYK
Definition grok.h:106
@ GRK_ENUM_CLRSPC_YCCK
Definition grok.h:107
@ GRK_ENUM_CLRSPC_YPBPR50
Definition grok.h:117
@ GRK_ENUM_CLRSPC_BILEVEL1
Definition grok.h:100
@ GRK_ENUM_CLRSPC_YCBCR2
Definition grok.h:102
struct _grk_color grk_color
GRK_API int32_t GRK_CALLCONV grk_plugin_init_batch_decompress(const char *input_dir, const char *output_dir, grk_decompress_parameters *decompress_parameters, grk_plugin_decompress_callback callback)
Initializes batch decompress with plugin.
Definition grok.cpp:969
struct _grk_synthesis grk_synthesis
struct _grk_decompress_params grk_decompress_parameters
_GRK_CHANNEL_TYPE
Definition grok.h:369
@ GRK_CHANNEL_TYPE_OPACITY
Definition grok.h:371
@ GRK_CHANNEL_TYPE_PREMULTIPLIED_OPACITY
Definition grok.h:372
@ GRK_CHANNEL_TYPE_COLOUR
Definition grok.h:370
@ GRK_CHANNEL_TYPE_UNSPECIFIED
Definition grok.h:373
_GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms.
Definition grok.h:281
@ GRK_RATE_CONTROL_PCRD_OPT
Definition grok.h:283
@ GRK_RATE_CONTROL_BISECT
Definition grok.h:282
GRK_API bool GRK_CALLCONV grk_decompress_update(grk_decompress_parameters *params, grk_object *codec)
Updates decompressor.
Definition grok.cpp:635
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_compress(grk_plugin_compress_batch_info info)
Batch-compresses with plugin.
Definition grok.cpp:872
struct _grk_channel_definition grk_channel_definition
int(* GROK_INIT_DECOMPRESSORS)(grk_header_info *header_info, grk_image *image)
Plugin init decompressors.
Definition grok.h:1742
struct _grk_plugin_band grk_plugin_band
_GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
Definition grok.h:310
@ GRK_CODEC_J2K
unknown format
Definition grok.h:312
@ GRK_CODEC_MJ2
JPEG 2000 JP2 file format.
Definition grok.h:314
@ GRK_CODEC_JP2
JPEG 2000 code-stream.
Definition grok.h:313
@ GRK_CODEC_UNK
Definition grok.h:311
struct _grk_plugin_tile grk_plugin_tile
#define GRK_CALLCONV
Definition grok.h:49
GRK_API uint64_t GRK_CALLCONV grk_compress(grk_object *codec, grk_plugin_tile *tile)
Compresses an image into a JPEG 2000 code stream using plugin.
Definition grok.cpp:652
void(* grk_stream_free_user_data_fn)(void *user_data)
Free user data callback.
Definition grok.h:547
#define GRK_NUM_ASOC_BOXES_SUPPORTED
maximum Grok supported number of asoc boxes
Definition grok.h:129
_GRK_PROG_ORDER
Progression order.
Definition grok.h:66
@ GRK_RPCL
resolution-layer-component-precinct order
Definition grok.h:70
@ GRK_CPRL
precinct-component-resolution-layer order
Definition grok.h:72
@ GRK_RLCP
layer-resolution-component-precinct order
Definition grok.h:69
@ GRK_PROG_UNKNOWN
Definition grok.h:67
@ GRK_LRCP
unknown progression order
Definition grok.h:68
@ GRK_NUM_PROGRESSION_ORDERS
component-precinct-resolution-layer order
Definition grok.h:73
@ GRK_PCRL
resolution-precinct-component-layer order
Definition grok.h:71
size_t(* grk_stream_write_fn)(const uint8_t *buffer, size_t numBytes, void *user_data)
Write stream callback.
Definition grok.h:530
GRK_API void GRK_CALLCONV grk_plugin_wait_for_batch_complete(void)
Waits for batch job to complete.
Definition grok.cpp:890
struct _grk_plugin_pass grk_plugin_pass
enum _GRK_CHANNEL_ASSOC GRK_CHANNEL_ASSOC
Channel association.
GRK_API grk_object *GRK_CALLCONV grk_compress_init(grk_stream_params *stream_params, grk_cparameters *parameters, grk_image *image)
Initializes compression process.
Definition grok.cpp:575
struct _grk_header_info grk_header_info
int32_t(* grk_plugin_decompress_callback)(grk_plugin_decompress_callback_info *info)
Plugin decompress callback.
Definition grok.h:1779
_GRK_TILE_CACHE_STRATEGY
Grok tile cache strategy.
Definition grok.h:583
@ GRK_TILE_CACHE_ALL
Definition grok.h:586
@ GRK_TILE_CACHE_IMAGE
Definition grok.h:585
@ GRK_TILE_CACHE_NONE
Definition grok.h:584
struct _grk_plugin_resolution grk_plugin_resolution
struct _grk_plugin_code_block grk_plugin_code_block
const char * label
Definition grok.h:419
uint8_t * xml
Definition grok.h:420
uint32_t level
Definition grok.h:418
uint32_t xml_len
Definition grok.h:421
uint16_t num_channel_descriptions
Definition grok.h:409
grk_channel_description * descriptions
Definition grok.h:408
uint16_t typ
Definition grok.h:398
uint16_t asoc
Definition grok.h:399
uint16_t channel
Definition grok.h:397
grk_channel_definition * channel_definition
Definition grok.h:722
char * icc_profile_name
Definition grok.h:721
uint32_t icc_profile_len
Definition grok.h:720
uint8_t * icc_profile_buf
Definition grok.h:719
grk_palette_data * palette
Definition grok.h:723
bool has_colour_specification_box
Definition grok.h:724
uint16_t component
Definition grok.h:341
uint8_t palette_column
Definition grok.h:343
uint8_t mapping_type
Definition grok.h:342
uint32_t cblockw_init
initial code block width (default to 64)
Definition grok.h:1221
uint8_t numgbits
Definition grok.h:1211
grk_progression progression[GRK_MAXRLVLS]
progressions
Definition grok.h:1215
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:1243
bool apply_icc
Definition grok.h:1293
GRK_PROG_ORDER prog_order
progression order (default is LRCP)
Definition grok.h:1213
uint16_t comment_len[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1205
uint32_t repeats
Definition grok.h:1300
uint32_t prch_init[GRK_MAXRLVLS]
initial precinct height
Definition grok.h:1239
bool verbose
Definition grok.h:1303
uint32_t image_offset_x0
subimage compressing: origin image offset in x direction
Definition grok.h:1245
uint64_t max_cs_size
Maximum size (in bytes) for the whole code stream.
Definition grok.h:1272
grk_synthesis synth
Definition grok.h:1305
grk_raw_cparameters raw_cp
Definition grok.h:1256
uint8_t numresolution
number of resolutions
Definition grok.h:1219
uint32_t image_offset_y0
subimage compressing: origin image offset in y direction
Definition grok.h:1247
GRK_SUPPORTED_FILE_FMT decod_format
input file format
Definition grok.h:1253
uint32_t cblockh_init
initial code block height (default to 64)
Definition grok.h:1223
uint32_t roi_shift
region of interest: upshift value
Definition grok.h:1233
bool shared_memory_interface
Definition grok.h:1304
uint8_t subsampling_dy
subsampling value for dy
Definition grok.h:1251
uint32_t prcw_init[GRK_MAXRLVLS]
initial precinct width
Definition grok.h:1237
bool tile_size_on
Definition grok.h:1184
uint32_t t_height
YTsiz.
Definition grok.h:1192
bool write_capture_resolution_from_file
Definition grok.h:1284
uint32_t res_spec
Definition grok.h:1235
uint64_t max_comp_size
Maximum size (in bytes) for each component.
Definition grok.h:1277
uint32_t num_threads
Definition grok.h:1296
uint8_t mct
MCT (multiple component transform)
Definition grok.h:1262
uint16_t numlayers
number of layers
Definition grok.h:1194
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:1255
double capture_resolution_from_file[2]
Definition grok.h:1285
bool irreversible
1 : use the irreversible DWT 9-7, 0 : use lossless compression (default)
Definition grok.h:1228
uint32_t t_width
XTsiz.
Definition grok.h:1190
bool write_display_resolution
Definition grok.h:1290
uint8_t cblk_sty
code block style
Definition grok.h:1225
uint8_t csty
csty : coding style
Definition grok.h:1209
uint8_t new_tile_part_progression_divider
new tile part progression divider
Definition grok.h:1260
bool is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1206
uint16_t rsiz
RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values.
Definition grok.h:1280
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:1241
double layer_distortion[GRK_MAX_LAYERS]
layer PSNR values
Definition grok.h:1203
GRK_RATE_CONTROL_ALGORITHM rate_control_algorithm
Definition grok.h:1295
uint32_t kernel_build_options
Definition grok.h:1299
bool write_plt
Definition grok.h:1301
void * mct_data
Naive implementation of MCT restricted to a single reversible array based compressing without offset ...
Definition grok.h:1265
uint32_t tx0
XTOsiz.
Definition grok.h:1186
char * comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1204
bool write_capture_resolution
Definition grok.h:1287
uint8_t subsampling_dx
subsampling value for dx
Definition grok.h:1249
int32_t device_id
Definition grok.h:1297
size_t num_comments
Definition grok.h:1207
uint16_t framerate
Definition grok.h:1281
bool allocation_by_rate_distortion
rate control allocation by rate/distortion curve
Definition grok.h:1196
bool allocation_by_quality
rate control allocation by fixed_PSNR quality
Definition grok.h:1201
bool write_tlm
Definition grok.h:1302
double display_resolution[2]
Definition grok.h:1291
int32_t roi_compno
region of interest: affected component in [0..3]; -1 indicates no ROI
Definition grok.h:1231
uint32_t ty0
YTOsiz.
Definition grok.h:1188
uint32_t duration
Definition grok.h:1298
double layer_rate[GRK_MAX_LAYERS]
layers rates expressed as compression ratios.
Definition grok.h:1199
bool enable_tile_part_generation
Tile part generation.
Definition grok.h:1258
uint32_t numpocs
number of progression order changes (POCs), default to 0
Definition grok.h:1217
double capture_resolution[2]
Definition grok.h:1288
grk_io_pixels_callback io_buffer_callback
Definition grok.h:614
GRK_TILE_CACHE_STRATEGY tile_cache_strategy
Definition grok.h:610
uint32_t random_access_flags
Definition grok.h:612
uint16_t layers_to_decompress
Set the maximum number of quality layers to decompress.
Definition grok.h:609
void * io_user_data
Definition grok.h:615
uint8_t reduce
Set the number of highest resolution levels to be discarded.
Definition grok.h:602
grk_io_register_reclaim_callback io_register_client_callback
Definition grok.h:616
double dw_x0
Decompress window left boundary.
Definition grok.h:643
bool io_xml
Definition grok.h:662
grk_precision * precision
Definition grok.h:653
uint32_t compression_level
Definition grok.h:668
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:641
uint16_t tile_index
tile number of the decompressed tile
Definition grok.h:651
uint32_t num_precision
Definition grok.h:654
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:635
double dw_x1
Decompress window right boundary.
Definition grok.h:645
bool force_rgb
Definition grok.h:656
uint32_t compression
Definition grok.h:663
uint32_t num_threads
Definition grok.h:675
int32_t device_id
Definition grok.h:671
uint32_t kernel_build_options
Definition grok.h:673
void * user_data
Definition grok.h:676
bool single_tile_decompress
Definition grok.h:652
uint32_t repeats
Definition grok.h:674
bool upsample
Definition grok.h:658
grk_decompress_core_params core
core library parameters
Definition grok.h:633
double dw_y1
Decompress window bottom boundary.
Definition grok.h:649
uint32_t duration
Definition grok.h:672
double dw_y0
Decompress window up boundary.
Definition grok.h:647
bool split_pnm
Definition grok.h:660
bool verbose
Verbose mode.
Definition grok.h:670
GRK_CODEC_FORMAT decod_format
input file format
Definition grok.h:639
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:637
uint32_t h
data height
Definition grok.h:694
uint8_t dy
YRsiz: vertical separation of a sample of component with respect to the reference grid.
Definition grok.h:700
GRK_CHANNEL_ASSOC association
Definition grok.h:706
GRK_CHANNEL_TYPE type
Definition grok.h:705
uint8_t dx
XRsiz: horizontal separation of a sample of component with respect to the reference grid.
Definition grok.h:697
bool sgnd
Definition grok.h:704
uint32_t w
data width
Definition grok.h:690
uint8_t prec
precision
Definition grok.h:702
uint16_t crg_x
Definition grok.h:708
int32_t * data
image component data
Definition grok.h:710
uint32_t x0
x component offset compared to the whole image
Definition grok.h:686
uint32_t y0
y component offset compared to the whole image
Definition grok.h:688
uint16_t crg_y
Definition grok.h:708
uint32_t stride
data stride
Definition grok.h:692
uint64_t packed_row_bytes
Definition grok.h:785
grk_precision * precision
Definition grok.h:773
bool has_capture_resolution
Definition grok.h:766
uint16_t numcomps
number of components in the image
Definition grok.h:762
bool force_rgb
Definition grok.h:771
uint32_t y0
YOsiz: vertical offset from the origin of the reference grid to the top side of the image area.
Definition grok.h:756
bool split_by_component
Definition grok.h:776
GRK_COLOR_SPACE color_space
Definition grok.h:763
uint32_t rows_per_task
Definition grok.h:784
uint32_t rows_per_strip
Definition grok.h:783
bool upsample
Definition grok.h:772
grk_image_comp * comps
Definition grok.h:787
uint8_t decompress_prec
Definition grok.h:780
bool has_multiple_tiles
Definition grok.h:775
grk_io_buf interleaved_data
Definition grok.h:782
GRK_COLOR_SPACE decompress_colour_space
Definition grok.h:781
uint32_t x0
XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area.
Definition grok.h:753
grk_object obj
Definition grok.h:750
uint32_t num_precision
Definition grok.h:774
uint16_t decompress_num_comps
Definition grok.h:777
bool has_display_resolution
Definition grok.h:768
GRK_SUPPORTED_FILE_FMT decompress_fmt
Definition grok.h:770
double display_resolution[2]
Definition grok.h:769
uint32_t y1
Ysiz: height of the reference grid.
Definition grok.h:760
uint32_t decompress_width
Definition grok.h:778
uint32_t decompress_height
Definition grok.h:779
double capture_resolution[2]
Definition grok.h:767
grk_image_meta * meta
Definition grok.h:786
uint32_t x1
Xsiz: width of the reference grid.
Definition grok.h:758
bool palette_applied
Definition grok.h:764
bool channel_definition_applied
Definition grok.h:765
size_t alloc_len
Definition grok.h:467
bool pooled
Definition grok.h:468
size_t len
Definition grok.h:466
size_t offset
Definition grok.h:465
uint8_t * data
Definition grok.h:464
uint32_t index
Definition grok.h:469
uint32_t max_pooled_requests
Definition grok.h:478
grk_msg_callback info_callback
Definition grok.h:185
void * warn_data
Definition grok.h:188
grk_msg_callback warn_callback
Definition grok.h:187
grk_msg_callback error_callback
Definition grok.h:189
void * error_data
Definition grok.h:190
void * info_data
Definition grok.h:186
void * wrapper
Definition grok.h:200
grk_component_mapping_comp * component_mapping
Definition grok.h:354
uint8_t num_channels
Definition grok.h:355
int32_t * lut
Definition grok.h:352
uint16_t num_entries
Definition grok.h:353
bool * channel_sign
Definition grok.h:356
uint8_t * channel_prec
Definition grok.h:357
uint64_t num_precincts
Definition grok.h:919
float stepsize
Definition grok.h:921
uint8_t orientation
Definition grok.h:918
grk_plugin_precinct ** precincts
Definition grok.h:920
uint32_t y0
Definition grok.h:890
uint8_t num_passes
Definition grok.h:897
uint32_t compressed_data_length
Definition grok.h:895
grk_plugin_pass passes[GRK_MAX_PASSES]
Definition grok.h:898
unsigned int sorted_index
Definition grok.h:899
uint32_t x0
Definition grok.h:890
uint8_t * compressed_data
Definition grok.h:894
uint32_t y1
Definition grok.h:890
uint32_t x1
Definition grok.h:890
unsigned int * context_stream
Definition grok.h:891
uint32_t num_pix
Definition grok.h:893
uint8_t num_bit_planes
Definition grok.h:896
uint32_t full_image_y0
Definition grok.h:1768
GRK_CODEC_FORMAT decod_format
Definition grok.h:1756
unsigned int error_code
Definition grok.h:1765
grk_decompress_parameters * decompressor_parameters
Definition grok.h:1761
grk_header_info header_info
Definition grok.h:1760
GRK_SUPPORTED_FILE_FMT cod_format
Definition grok.h:1758
grk_plugin_tile * tile
Definition grok.h:1764
size_t device_id
Definition grok.h:1751
uint32_t full_image_x0
Definition grok.h:1767
grk_object * codec
Definition grok.h:1759
void * user_data
Definition grok.h:1769
bool plugin_owns_image
Definition grok.h:1763
uint32_t decompress_flags
Definition grok.h:1766
const char * output_file_name
Definition grok.h:1754
GROK_INIT_DECOMPRESSORS init_decompressors_func
Definition grok.h:1752
const char * input_file_name
Definition grok.h:1753
grk_image * image
Definition grok.h:1762
bool verbose
Definition grok.h:1662
const char * server
Definition grok.h:1664
int32_t device_id
Definition grok.h:1661
const char * license
Definition grok.h:1663
const char * pluginPath
Definition grok.h:1609
bool verbose
Definition grok.h:1610
size_t rate
Definition grok.h:877
size_t length
Definition grok.h:878
double distortion_decrease
Definition grok.h:876
grk_plugin_precinct
Definition grok.h:907
uint64_t num_blocks
Definition grok.h:908
grk_plugin_code_block ** blocks
Definition grok.h:909
uint8_t num_bands
Definition grok.h:931
uint8_t level
Definition grok.h:930
grk_plugin_band ** band
Definition grok.h:932
uint16_t num_components
Definition grok.h:961
uint32_t decompress_flags
Definition grok.h:960
grk_plugin_tile_component ** tile_components
Definition grok.h:962
grk_precision_mode mode
Definition grok.h:441
uint8_t prec
Definition grok.h:440
uint16_t comp[256]
Definition grok.h:453
bool single_tile
Definition grok.h:454
uint8_t num_resolutions
Definition grok.h:450
uint16_t tile_index
Definition grok.h:455
uint16_t numcomps
Definition grok.h:452
uint16_t layers_per_resolution[33]
Definition grok.h:451
uint16_t comp_temp
Definition grok.h:242
uint32_t tx1
Definition grok.h:218
uint64_t prec_e
Definition grok.h:227
GRK_PROG_ORDER specified_compression_poc_prog
Definition grok.h:212
uint16_t comp_s
progression order bounds specified by POC
Definition grok.h:222
uint8_t res_temp
Definition grok.h:243
uint32_t tp_ty_e
Definition grok.h:239
uint32_t tp_tx_s
Definition grok.h:236
uint8_t res_s
Definition grok.h:224
uint32_t tx0
tile dimensions
Definition grok.h:216
uint8_t tp_res_s
Definition grok.h:232
uint64_t prec_temp
Definition grok.h:244
uint64_t tp_prec_e
Definition grok.h:234
uint32_t tp_ty_s
Definition grok.h:238
uint8_t tp_res_e
Definition grok.h:233
uint32_t ty0
Definition grok.h:217
uint32_t ty1
Definition grok.h:219
uint32_t ty0_temp
Definition grok.h:247
uint16_t comp_e
Definition grok.h:223
uint32_t dy
Definition grok.h:241
GRK_PROG_ORDER progression
Definition grok.h:210
uint32_t dx
Definition grok.h:240
uint16_t tp_comp_e
Definition grok.h:231
uint64_t prec_s
Definition grok.h:226
uint32_t tp_tx_e
Definition grok.h:237
uint32_t tx0_temp
Definition grok.h:246
uint16_t tp_lay_e
Definition grok.h:235
uint32_t tileno
Definition grok.h:213
uint16_t lay_temp
Definition grok.h:245
uint16_t tp_comp_s
Definition grok.h:230
uint16_t lay_e
Definition grok.h:229
uint16_t lay_s
Definition grok.h:228
char progression_str[5]
Definition grok.h:211
uint8_t res_e
Definition grok.h:225
uint8_t dy
subsampling in X direction
Definition grok.h:257
uint8_t dx
Definition grok.h:256
uint8_t prec
number of components of the raw image
Definition grok.h:269
uint32_t width
Definition grok.h:266
uint16_t numcomps
height of the raw image
Definition grok.h:268
grk_raw_comp_cparameters * comps
signed/unsigned raw image
Definition grok.h:271
bool sgnd
bit depth of the raw image
Definition grok.h:270
uint32_t height
width of the raw image
Definition grok.h:267
uint8_t * buf
Definition grok.h:564
grk_stream_read_fn read_fn
Definition grok.h:570
size_t buf_len
Definition grok.h:565
grk_stream_free_user_data_fn free_user_data_fn
Definition grok.h:573
size_t double_buffer_len
Definition grok.h:576
size_t stream_len
Definition grok.h:575
grk_stream_write_fn write_fn
Definition grok.h:571
const char * file
Definition grok.h:561
grk_stream_seek_fn seek_fn
Definition grok.h:572
void * user_data
Definition grok.h:574
size_t buf_compressed_len
Definition grok.h:567
uint32_t width
Definition grok.h:1171
uint32_t height
Definition grok.h:1172
bool do_synthesis
Definition grok.h:1170
uint8_t precision
Definition grok.h:1173
uint16_t numcomps
Definition grok.h:1174
Core decompression parameters.
Decompression parameters.
Opaque reference-counted object.
Plugin batch compress info.
Definition grok.h:1703
grk_cparameters * compress_parameters
Definition grok.h:1706
GRK_PLUGIN_COMPRESS_USER_CALLBACK callback
Definition grok.h:1707
const char * output_dir
Definition grok.h:1705
const char * input_dir
Definition grok.h:1704
Plugin compress user callback info.
Definition grok.h:1680
bool transfer_exif_tags
Definition grok.h:1689
grk_cparameters * compressor_parameters
Definition grok.h:1684
grk_image * image
Definition grok.h:1685
grk_plugin_tile * tile
Definition grok.h:1686
const char * output_file_name
Definition grok.h:1683
grk_stream_params stream_params
Definition grok.h:1687
unsigned int error_code
Definition grok.h:1688
const char * input_file_name
Definition grok.h:1681
bool output_file_name_is_relative
Definition grok.h:1682
Plugin decompress callback info.
Plugin tile component.
Definition grok.h:940
uint8_t numresolutions
Definition grok.h:941
grk_plugin_resolution ** resolutions
Definition grok.h:942
Stores progression state information.
JPEG 2000 stream parameters.