32#include "grk_config.h"
36#define GRK_CALLCONV __stdcall
41#define GRK_API __declspec(dllexport)
43#define GRK_API __declspec(dllimport)
49#define GRK_API __attribute__((visibility("hidden")))
51#define GRK_API __attribute__((visibility("default")))
123#define GRK_NUM_COMMENTS_SUPPORTED 256
128#define GRK_NUM_ASOC_BOXES_SUPPORTED 256
133#define GRK_MAX_COMMENT_LENGTH (UINT16_MAX - 2)
138#define GRK_MAX_SUPPORTED_IMAGE_PRECISION 16
156#define GRK_BIBO_EXTRA_BITS 7
161#define GRK_MAX_PASSES (3 * (GRK_MAX_SUPPORTED_IMAGE_PRECISION + GRK_BIBO_EXTRA_BITS) - 2)
312#define GRK_PATH_LEN 4096
313#define GRK_MAX_LAYERS 256
319#define GRK_MAX_DECOMP_LVLS \
322#define GRK_MAXRLVLS \
323 (GRK_MAX_DECOMP_LVLS + 1)
324#define GRK_MAXBANDS (3 * GRK_MAXRLVLS - 2)
552 void* io_user_data,
void* reclaim_user_data);
571typedef size_t (*
grk_stream_read_fn)(uint8_t* buffer,
size_t numBytes,
void* user_data);
581typedef size_t (*
grk_stream_write_fn)(
const uint8_t* buffer,
size_t numBytes,
void* user_data);
673#define GRK_DECOMPRESS_COMPRESSION_LEVEL_DEFAULT (UINT_MAX)
903#define GRK_DECODE_HEADER (1 << 0)
904#define GRK_DECODE_T2 (1 << 1)
905#define GRK_DECODE_T1 (1 << 2)
906#define GRK_DECODE_POST_T1 (1 << 3)
907#define GRK_PLUGIN_DECODE_CLEAN (1 << 4)
908#define GRK_DECODE_ALL \
909 (GRK_PLUGIN_DECODE_CLEAN | GRK_DECODE_HEADER | GRK_DECODE_T2 | GRK_DECODE_T1 | \
1049 uint16_t tile_index);
1076 double start_y,
double end_x,
double end_y);
1293 FILE* output_stream);
1306 int32_t* dc_shift, uint32_t nb_comp);
1308#define GRK_IMG_INFO 1
1309#define GRK_MH_INFO 2
1310#define GRK_TH_INFO 4
1311#define GRK_TCH_INFO 8
1312#define GRK_MH_IND 16
1313#define GRK_TH_IND 32
1315#define GRK_CBLKSTY_LAZY 0x01
1316#define GRK_CBLKSTY_RESET 0x02
1317#define GRK_CBLKSTY_TERMALL 0x04
1318#define GRK_CBLKSTY_VSC 0x08
1319#define GRK_CBLKSTY_PTERM 0x10
1320#define GRK_CBLKSTY_SEGSYM 0x20
1321#define GRK_CBLKSTY_HT_ONLY 0x40
1322#define GRK_CBLKSTY_HT_MIXED 0xC0
1323#define GRK_JPH_RSIZ_FLAG 0x4000
1345#define GRK_PROFILE_NONE 0x0000
1346#define GRK_PROFILE_0 0x0001
1347#define GRK_PROFILE_1 0x0002
1348#define GRK_PROFILE_CINEMA_2K 0x0003
1349#define GRK_PROFILE_CINEMA_4K 0x0004
1350#define GRK_PROFILE_CINEMA_S2K 0x0005
1351#define GRK_PROFILE_CINEMA_S4K 0x0006
1352#define GRK_PROFILE_CINEMA_LTS \
1354#define GRK_PROFILE_BC_SINGLE 0x0100
1355#define GRK_PROFILE_BC_MULTI 0x0200
1356#define GRK_PROFILE_BC_MULTI_R \
1358#define GRK_PROFILE_BC_MASK 0x030F
1359#define GRK_PROFILE_IMF_2K 0x0400
1360#define GRK_PROFILE_IMF_4K 0x0500
1361#define GRK_PROFILE_IMF_8K 0x0600
1362#define GRK_PROFILE_IMF_2K_R \
1364#define GRK_PROFILE_IMF_4K_R \
1366#define GRK_PROFILE_IMF_8K_R \
1368#define GRK_PROFILE_MASK 0x0FFF
1369#define GRK_PROFILE_PART2 0x8000
1370#define GRK_PROFILE_PART2_EXTENSIONS_MASK 0x3FFF
1375#define GRK_EXTENSION_NONE 0x0000
1376#define GRK_EXTENSION_MCT 0x0100
1377#define GRK_IS_PART2(v) ((v) & GRK_PROFILE_PART2)
1379#define GRK_IS_CINEMA(v) (((v) >= GRK_PROFILE_CINEMA_2K) && ((v) <= GRK_PROFILE_CINEMA_S4K))
1380#define GRK_IS_STORAGE(v) ((v) == GRK_PROFILE_CINEMA_LTS)
1434#define GRK_GET_IMF_OR_BROADCAST_PROFILE(v) \
1437#define GRK_LEVEL_MAX 11U
1438#define GRK_GET_LEVEL(v) ((v) & 0xf)
1442#define GRK_IS_BROADCAST(v) \
1443 (((v) >= GRK_PROFILE_BC_SINGLE) && ((v) <= (GRK_PROFILE_BC_MULTI_R | 0x000b)) && \
1444 (((v) & 0xf) <= 0xb))
1447#define GRK_BROADCAST_LEVEL_1_MBITSSEC 200U
1448#define GRK_BROADCAST_LEVEL_2_MBITSSEC 200U
1449#define GRK_BROADCAST_LEVEL_3_MBITSSEC 200U
1450#define GRK_BROADCAST_LEVEL_4_MBITSSEC 400U
1451#define GRK_BROADCAST_LEVEL_5_MBITSSEC 800U
1452#define GRK_BROADCAST_LEVEL_6_MBITSSEC 1600U
1453#define GRK_BROADCAST_LEVEL_7_MBITSSEC 3200U
1454#define GRK_BROADCAST_LEVEL_8_MBITSSEC 6400U
1455#define GRK_BROADCAST_LEVEL_9_MBITSSEC 12800U
1456#define GRK_BROADCAST_LEVEL_10_MBITSSEC 25600U
1457#define GRK_BROADCAST_LEVEL_11_MBITSSEC 51200U
1459#define GRK_BROADCAST_LEVEL_1_MSAMPLESSEC 64U
1460#define GRK_BROADCAST_LEVEL_2_MSAMPLESSEC 130U
1461#define GRK_BROADCAST_LEVEL_3_MSAMPLESSEC 195U
1462#define GRK_BROADCAST_LEVEL_4_MSAMPLESSEC 260U
1463#define GRK_BROADCAST_LEVEL_5_MSAMPLESSEC 520U
1464#define GRK_BROADCAST_LEVEL_6_MSAMPLESSEC 1200U
1465#define GRK_BROADCAST_LEVEL_7_MSAMPLESSEC 2400U
1466#define GRK_BROADCAST_LEVEL_8_MSAMPLESSEC 4800U
1467#define GRK_BROADCAST_LEVEL_9_MSAMPLESSEC 9600U
1468#define GRK_BROADCAST_LEVEL_10_MSAMPLESSEC 19200U
1469#define GRK_BROADCAST_LEVEL_11_MSAMPLESSEC 38400U
1473#define GRK_IS_IMF(v) \
1474 (((v) >= GRK_PROFILE_IMF_2K) && ((v) <= (GRK_PROFILE_IMF_8K_R | 0x009b)) && \
1475 (((v) & 0xf) <= 0xb) && (((v) & 0xf0) <= 0x90))
1478#define GRK_IMF_MAINLEVEL_1_MSAMPLESSEC 65U
1479#define GRK_IMF_MAINLEVEL_2_MSAMPLESSEC 130U
1480#define GRK_IMF_MAINLEVEL_3_MSAMPLESSEC 195U
1481#define GRK_IMF_MAINLEVEL_4_MSAMPLESSEC 260U
1482#define GRK_IMF_MAINLEVEL_5_MSAMPLESSEC 520U
1483#define GRK_IMF_MAINLEVEL_6_MSAMPLESSEC 1200U
1484#define GRK_IMF_MAINLEVEL_7_MSAMPLESSEC 2400U
1485#define GRK_IMF_MAINLEVEL_8_MSAMPLESSEC 4800U
1486#define GRK_IMF_MAINLEVEL_9_MSAMPLESSEC 9600U
1487#define GRK_IMF_MAINLEVEL_10_MSAMPLESSEC 19200U
1488#define GRK_IMF_MAINLEVEL_11_MSAMPLESSEC 38400U
1490#define GRK_IMF_SUBLEVEL_MAX 9U
1491#define GRK_GET_IMF_SUBLEVEL(v) (((v) >> 4) & 0xf)
1494#define GRK_IMF_SUBLEVEL_1_MBITSSEC 200U
1495#define GRK_IMF_SUBLEVEL_2_MBITSSEC 400U
1496#define GRK_IMF_SUBLEVEL_3_MBITSSEC 800U
1497#define GRK_IMF_SUBLEVEL_4_MBITSSEC 1600U
1498#define GRK_IMF_SUBLEVEL_5_MBITSSEC 3200U
1499#define GRK_IMF_SUBLEVEL_6_MBITSSEC 6400U
1500#define GRK_IMF_SUBLEVEL_7_MBITSSEC 12800U
1501#define GRK_IMF_SUBLEVEL_8_MBITSSEC 25600U
1502#define GRK_IMF_SUBLEVEL_9_MBITSSEC 51200U
1509#define GRK_CINEMA_DCI_MAX_BANDWIDTH 250000000
1511#define GRK_CINEMA_24_CS 1302083
1512#define GRK_CINEMA_24_COMP 1041666
1514#define GRK_CINEMA_48_CS 651041
1515#define GRK_CINEMA_48_COMP 520833
1517#define GRK_CINEMA_4K_DEFAULT_NUM_RESOLUTIONS 7
1522#define GRK_CUSTOM_CIELAB_SPACE 0x0
1523#define GRK_DEFAULT_CIELAB_SPACE 0x44454600
1528#define GRK_RANDOM_ACCESS_PLT 1
1529#define GRK_RANDOM_ACCESS_TLM 2
1530#define GRK_RANDOM_ACCESS_PLM 4
1561#define GRK_PLUGIN_STATE_NO_DEBUG 0x0
1578#define GRK_PLUGIN_STATE_DEBUG 0x1
1579#define GRK_PLUGIN_STATE_PRE_TR1 0x2
1580#define GRK_PLUGIN_STATE_DWT_QUANTIZATION 0x4
1581#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:285
@ GRK_FMT_BMP
Definition grok.h:292
@ GRK_FMT_JP2
Definition grok.h:288
@ GRK_FMT_J2K
Definition grok.h:287
@ GRK_FMT_PNG
Definition grok.h:295
@ GRK_FMT_YUV
Definition grok.h:298
@ GRK_FMT_RAWL
Definition grok.h:296
@ GRK_FMT_UNK
Definition grok.h:286
@ GRK_FMT_TIF
Definition grok.h:293
@ GRK_FMT_JPG
Definition grok.h:297
@ GRK_FMT_PXM
Definition grok.h:289
@ GRK_FMT_RAW
Definition grok.h:294
@ GRK_FMT_PAM
Definition grok.h:291
@ GRK_FMT_PGX
Definition grok.h:290
GRK_API bool GRK_CALLCONV grk_decompress_set_window(grk_object *codec, double start_x, double start_y, double end_x, double end_y)
Specifiy area to be decompressed.
Definition grok.cpp:415
struct _grk_cparameters grk_cparameters
Compression parameters.
GRK_API void GRK_CALLCONV grk_decompress_set_default_params(grk_decompress_parameters *parameters)
Initialize decompress parameters with default values.
Definition grok.cpp:353
struct _grk_progression grk_progression
Progression order change.
enum _grk_precision_mode grk_precision_mode
Precision mode.
struct _grk_image grk_image
Grok 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:549
GRK_API bool GRK_CALLCONV grk_initialize(const char *pluginPath, uint32_t num_threads, bool verbose)
Initialize library.
Definition grok.cpp:131
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_compress(void)
Stop batch compress.
Definition grok.cpp:885
GRK_API bool GRK_CALLCONV grk_set_MCT(grk_cparameters *parameters, float *encoding_matrix, int32_t *dc_shift, uint32_t nb_comp)
Set MCT matrix.
Definition grok.cpp:461
GRK_API grk_object *GRK_CALLCONV grk_object_ref(grk_object *obj)
Increment ref count.
Definition grok.cpp:160
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_decompress(void)
Stop batch decompress.
Definition grok.cpp:982
struct _grk_channel_description grk_channel_description
Channel definition: channel index, type, association.
#define GRK_NUM_COMMENTS_SUPPORTED
maximum Grok supported number of comments
Definition grok.h:123
void(* grk_msg_callback)(const char *msg, void *client_data)
Logging callback.
Definition grok.h:169
enum _GRK_CHANNEL_TYPE GRK_CHANNEL_TYPE
struct _grk_stream_params grk_stream_params
JPEG 2000 stream parameters.
GRK_API void GRK_CALLCONV grk_plugin_cleanup(void)
Clean up plugin resources.
Definition grok.cpp:803
GRK_API void GRK_CALLCONV grk_set_msg_handlers(grk_msg_handlers msg_handlers)
Set log message handlers.
Definition grok.cpp:178
GRK_API bool GRK_CALLCONV grk_plugin_load(grk_plugin_load_info info)
Load plugin.
Definition grok.cpp:761
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:1623
#define GRK_MAXRLVLS
Definition grok.h:321
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)
Dump codec information to file.
Definition grok.cpp:450
GRK_API uint32_t GRK_CALLCONV grk_plugin_get_debug_state()
Get debug state of plugin.
Definition grok.cpp:788
struct _grk_precision grk_precision
Precision.
struct _grk_plugin_decompress_callback_info grk_plugin_decompress_callback_info
Plugin decompress callback info.
#define GRK_MAX_PASSES
Grok maximum number of passes.
Definition grok.h:161
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_decompress(void)
Initiate batch decompress.
Definition grok.cpp:968
enum _GRK_PROG_ORDER GRK_PROG_ORDER
Progression order.
struct _grk_object grk_object
Reference counted object.
bool(* grk_io_pixels_callback)(uint32_t thread_id, grk_io_buf buffer, void *user_data)
Grok IO pixels callback.
Definition grok.h:560
struct _grk_raw_cparameters grk_raw_cparameters
RAW image compress parameters.
GRK_API bool GRK_CALLCONV grk_decompress_read_header(grk_object *codec, grk_header_info *header_info)
Decompress JPEG 2000 header.
Definition grok.cpp:401
struct _grk_plugin_load_info grk_plugin_load_info
Plugin load info.
GRK_API int32_t GRK_CALLCONV grk_plugin_compress(grk_cparameters *compress_parameters, GRK_PLUGIN_COMPRESS_USER_CALLBACK callback)
Compress with plugin.
Definition grok.cpp:837
_GRK_CHANNEL_ASSOC
Channel association.
Definition grok.h:374
@ GRK_CHANNEL_ASSOC_COLOUR_1
Definition grok.h:377
@ GRK_CHANNEL_ASSOC_COLOUR_2
Definition grok.h:378
@ GRK_CHANNEL_ASSOC_COLOUR_3
Definition grok.h:379
@ GRK_CHANNEL_ASSOC_WHOLE_IMAGE
Definition grok.h:376
@ GRK_CHANNEL_ASSOC_UNASSOCIATED
Definition grok.h:380
struct _grk_msg_handlers grk_msg_handlers
Logging handlers.
enum _GRK_RATE_CONTROL_ALGORITHM GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms.
struct _grk_decompress_core_params grk_decompress_core_params
Core decompression parameters.
size_t(* grk_stream_read_fn)(uint8_t *buffer, size_t numBytes, void *user_data)
Read stream callback.
Definition grok.h:570
struct _grk_image_meta grk_image_meta
Image meta data: colour, IPTC and XMP.
struct _grk_asoc grk_asoc
Association box info.
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_tile_image(grk_object *codec, uint16_t tile_index)
Get decompressed tile image.
Definition grok.cpp:490
enum _GRK_SUPPORTED_FILE_FMT GRK_SUPPORTED_FILE_FMT
All supported file formats.
struct _grk_palette_data grk_palette_data
Palette data.
GRK_API bool GRK_CALLCONV grk_decompress_detect_format(const char *file_name, GRK_CODEC_FORMAT *fmt)
Detect JPEG 2000 format from file.
Definition grok.cpp:279
GRK_API bool GRK_CALLCONV grk_decompress_tile(grk_object *codec, uint16_t tile_index)
Decompress a specific tile.
Definition grok.cpp:439
#define GRK_API
Definition grok.h:51
struct _grk_component_mapping_comp grk_component_mapping_comp
Component mappings: component index, mapping type, palette column.
struct _grk_image_comp grk_image_comp
Image component.
struct _grk_raw_comp_cparameters grk_raw_comp_cparameters
RAW component compress parameters.
GRK_API void GRK_CALLCONV grk_deinitialize()
De-initialize library.
Definition grok.cpp:154
struct grk_plugin_tile_component grk_plugin_tile_component
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:313
GRK_API void GRK_CALLCONV grk_compress_set_default_params(grk_cparameters *parameters)
Set compression parameters to default values:
Definition grok.cpp:530
struct _grk_plugin_precinct grk_plugin_precinct
Plugin precinct.
struct grk_plugin_compress_user_callback_info grk_plugin_compress_user_callback_info
GRK_API const char *GRK_CALLCONV grk_version(void)
Library version.
Definition grok.cpp:234
_GRK_COLOR_SPACE
Grok supported color spaces.
Definition grok.h:80
@ GRK_CLRSPC_SRGB
unknown
Definition grok.h:82
@ GRK_CLRSPC_EYCC
standard YCC (YUV)
Definition grok.h:85
@ GRK_CLRSPC_UNKNOWN
Definition grok.h:81
@ GRK_CLRSPC_SYCC
grayscale
Definition grok.h:84
@ GRK_CLRSPC_DEFAULT_CIE
CMYK.
Definition grok.h:87
@ GRK_CLRSPC_ICC
custom CIE LAB
Definition grok.h:89
@ GRK_CLRSPC_CMYK
extended YCC
Definition grok.h:86
@ GRK_CLRSPC_GRAY
sRGB
Definition grok.h:83
@ GRK_CLRSPC_CUSTOM_CIE
default CIE LAB
Definition grok.h:88
GRK_API bool GRK_CALLCONV grk_plugin_init(grk_plugin_init_info init_info)
Initialize plugin.
Definition grok.cpp:808
GRK_API bool GRK_CALLCONV grk_decompress(grk_object *codec, grk_plugin_tile *tile)
Decompress image from a JPEG 2000 code stream.
Definition grok.cpp:427
struct _grk_io_buf grk_io_buf
Grok IO buffer.
_grk_precision_mode
Precision mode.
Definition grok.h:418
@ GRK_PREC_MODE_SCALE
Definition grok.h:420
@ GRK_PREC_MODE_CLIP
Definition grok.h:419
GRK_API grk_image_meta *GRK_CALLCONV grk_image_meta_new(void)
Create meta.
Definition grok.cpp:245
enum _GRK_COLOR_SPACE GRK_COLOR_SPACE
Grok supported color spaces.
#define GRK_PATH_LEN
Definition grok.h:312
bool(* grk_io_callback)(uint32_t thread_id, grk_io_buf buffer, void *io_user_data)
Grok IO callback.
Definition grok.h:539
GRK_API grk_image *GRK_CALLCONV grk_image_new(uint16_t numcmpts, grk_image_comp *cmptparms, GRK_COLOR_SPACE clrspc, bool alloc_data)
Create image.
Definition grok.cpp:239
GRK_API int32_t GRK_CALLCONV grk_plugin_decompress(grk_decompress_parameters *decompress_parameters, grk_plugin_decompress_callback callback)
Decompress single image with plugin.
Definition grok.cpp:933
bool(* grk_stream_seek_fn)(uint64_t offset, void *user_data)
Seek (absolute) callback.
Definition grok.h:589
struct _grk_io_init grk_io_init
Grok IO initialization.
GRK_API grk_object *GRK_CALLCONV grk_decompress_init(grk_stream_params *stream_params, grk_decompress_parameters *params)
Initialize decompressor.
Definition grok.cpp:364
_GRK_ENUM_COLOUR_SPACE
JPEG 2000 standard color spaces.
Definition grok.h:97
@ GRK_ENUM_CLRSPC_ESRGB
Definition grok.h:113
@ GRK_ENUM_CLRSPC_CMY
Definition grok.h:104
@ GRK_ENUM_CLRSPC_EYCC
Definition grok.h:117
@ GRK_ENUM_CLRSPC_CIEJAB
Definition grok.h:112
@ GRK_ENUM_CLRSPC_GRAY
Definition grok.h:110
@ GRK_ENUM_CLRSPC_CIE
Definition grok.h:107
@ GRK_ENUM_CLRSPC_UNKNOWN
Definition grok.h:98
@ GRK_ENUM_CLRSPC_YCBCR3
Definition grok.h:102
@ GRK_ENUM_CLRSPC_ROMMRGB
Definition grok.h:114
@ GRK_ENUM_CLRSPC_YPBPR60
Definition grok.h:115
@ GRK_ENUM_CLRSPC_SRGB
Definition grok.h:109
@ GRK_ENUM_CLRSPC_BILEVEL2
Definition grok.h:108
@ GRK_ENUM_CLRSPC_SYCC
Definition grok.h:111
@ GRK_ENUM_CLRSPC_PHOTO_YCC
Definition grok.h:103
@ GRK_ENUM_CLRSPC_YCBCR1
Definition grok.h:100
@ GRK_ENUM_CLRSPC_CMYK
Definition grok.h:105
@ GRK_ENUM_CLRSPC_YCCK
Definition grok.h:106
@ GRK_ENUM_CLRSPC_YPBPR50
Definition grok.h:116
@ GRK_ENUM_CLRSPC_BILEVEL1
Definition grok.h:99
@ GRK_ENUM_CLRSPC_YCBCR2
Definition grok.h:101
struct _grk_color grk_color
ICC profile, palette, channel definition.
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)
Initialize batch decompress with plugin.
Definition grok.cpp:950
struct _grk_synthesis grk_synthesis
struct _grk_decompress_params grk_decompress_parameters
Decompression parameters.
_GRK_CHANNEL_TYPE
Definition grok.h:362
@ GRK_CHANNEL_TYPE_OPACITY
Definition grok.h:364
@ GRK_CHANNEL_TYPE_PREMULTIPLIED_OPACITY
Definition grok.h:365
@ GRK_CHANNEL_TYPE_COLOUR
Definition grok.h:363
@ GRK_CHANNEL_TYPE_UNSPECIFIED
Definition grok.h:366
_GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms.
Definition grok.h:276
@ GRK_RATE_CONTROL_PCRD_OPT
Definition grok.h:278
@ GRK_RATE_CONTROL_BISECT
Definition grok.h:277
GRK_API bool GRK_CALLCONV grk_decompress_update(grk_decompress_parameters *params, grk_object *codec)
Update decompressor.
Definition grok.cpp:618
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_compress(grk_plugin_compress_batch_info info)
Batch compress with plugin.
Definition grok.cpp:853
struct _grk_channel_definition grk_channel_definition
Channel definition.
int(* GROK_INIT_DECOMPRESSORS)(grk_header_info *header_info, grk_image *image)
Plugin init decompressors.
Definition grok.h:1668
struct _grk_plugin_band grk_plugin_band
Plugin band.
_GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
Definition grok.h:305
@ GRK_CODEC_J2K
unknown format
Definition grok.h:307
@ GRK_CODEC_MJ2
JPEG 2000 JP2 file format.
Definition grok.h:309
@ GRK_CODEC_JP2
JPEG 2000 code-stream.
Definition grok.h:308
@ GRK_CODEC_UNK
Definition grok.h:306
struct _grk_plugin_tile grk_plugin_tile
Plugin tile.
#define GRK_CALLCONV
Definition grok.h:47
GRK_API uint64_t GRK_CALLCONV grk_compress(grk_object *codec, grk_plugin_tile *tile)
Compress an image into a JPEG 2000 code stream using plugin.
Definition grok.cpp:633
void(* grk_stream_free_user_data_fn)(void *user_data)
Free user data callback.
Definition grok.h:597
#define GRK_NUM_ASOC_BOXES_SUPPORTED
maximum Grok supported number of asoc boxes
Definition grok.h:128
_GRK_PROG_ORDER
Progression order.
Definition grok.h:65
@ GRK_RPCL
resolution-layer-component-precinct order
Definition grok.h:69
@ GRK_CPRL
precinct-component-resolution-layer order
Definition grok.h:71
@ GRK_RLCP
layer-resolution-component-precinct order
Definition grok.h:68
@ GRK_PROG_UNKNOWN
Definition grok.h:66
@ GRK_LRCP
unknown progression order
Definition grok.h:67
@ GRK_NUM_PROGRESSION_ORDERS
component-precinct-resolution-layer order
Definition grok.h:72
@ GRK_PCRL
resolution-precinct-component-layer order
Definition grok.h:70
size_t(* grk_stream_write_fn)(const uint8_t *buffer, size_t numBytes, void *user_data)
Write stream callback.
Definition grok.h:580
GRK_API void GRK_CALLCONV grk_plugin_wait_for_batch_complete(void)
Wait for batch job to complete.
Definition grok.cpp:871
struct _grk_plugin_pass grk_plugin_pass
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)
Initialize compression process.
Definition grok.cpp:559
struct _grk_header_info grk_header_info
JPEG 2000 header info.
int32_t(* grk_plugin_decompress_callback)(grk_plugin_decompress_callback_info *info)
Plugin decompress callback.
Definition grok.h:1704
_GRK_TILE_CACHE_STRATEGY
Grok tile cache strategy.
Definition grok.h:632
@ GRK_TILE_CACHE_ALL
Definition grok.h:635
@ GRK_TILE_CACHE_IMAGE
Definition grok.h:634
@ GRK_TILE_CACHE_NONE
Definition grok.h:633
struct _grk_plugin_resolution grk_plugin_resolution
Plugin resolution.
struct _grk_plugin_code_block grk_plugin_code_block
Plugin code block.
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_composited_image(grk_object *codec)
Get decompressed composite image.
Definition grok.cpp:500
Association box info.
Definition grok.h:407
const char * label
Definition grok.h:409
uint8_t * xml
Definition grok.h:410
uint32_t level
Definition grok.h:408
uint32_t xml_len
Definition grok.h:411
Channel definition.
Definition grok.h:398
uint16_t num_channel_descriptions
Definition grok.h:400
grk_channel_description * descriptions
Definition grok.h:399
Channel definition: channel index, type, association.
Definition grok.h:388
uint16_t typ
Definition grok.h:390
uint16_t asoc
Definition grok.h:391
uint16_t channel
Definition grok.h:389
ICC profile, palette, channel definition.
Definition grok.h:763
grk_channel_definition * channel_definition
Definition grok.h:767
char * icc_profile_name
Definition grok.h:766
uint32_t icc_profile_len
Definition grok.h:765
uint8_t * icc_profile_buf
Definition grok.h:764
grk_palette_data * palette
Definition grok.h:768
bool has_colour_specification_box
Definition grok.h:769
Component mappings: component index, mapping type, palette column.
Definition grok.h:334
uint16_t component
Definition grok.h:335
uint8_t palette_column
Definition grok.h:337
uint8_t mapping_type
Definition grok.h:336
Compression parameters.
Definition grok.h:1116
uint32_t cblockw_init
initial code block width (default to 64)
Definition grok.h:1154
uint8_t numgbits
Definition grok.h:1144
grk_progression progression[GRK_MAXRLVLS]
progressions
Definition grok.h:1148
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:1176
GRK_PROG_ORDER prog_order
progression order (default is LRCP)
Definition grok.h:1146
uint16_t comment_len[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1138
uint32_t repeats
Definition grok.h:1233
uint32_t prch_init[GRK_MAXRLVLS]
initial precinct height
Definition grok.h:1172
bool verbose
Definition grok.h:1236
uint32_t image_offset_x0
subimage compressing: origin image offset in x direction
Definition grok.h:1178
uint64_t max_cs_size
Maximum size (in bytes) for the whole code stream.
Definition grok.h:1205
grk_raw_cparameters raw_cp
Definition grok.h:1189
uint8_t numresolution
number of resolutions
Definition grok.h:1152
uint32_t image_offset_y0
subimage compressing: origin image offset in y direction
Definition grok.h:1180
GRK_SUPPORTED_FILE_FMT decod_format
input file format
Definition grok.h:1186
uint32_t cblockh_init
initial code block height (default to 64)
Definition grok.h:1156
uint32_t roi_shift
region of interest: upshift value
Definition grok.h:1166
bool shared_memory_interface
Definition grok.h:1237
uint8_t subsampling_dy
subsampling value for dy
Definition grok.h:1184
uint32_t prcw_init[GRK_MAXRLVLS]
initial precinct width
Definition grok.h:1170
bool tile_size_on
Definition grok.h:1117
grk_synthesis synth_
Definition grok.h:1238
uint32_t t_height
YTsiz.
Definition grok.h:1125
bool write_capture_resolution_from_file
Definition grok.h:1217
uint32_t res_spec
Definition grok.h:1168
uint64_t max_comp_size
Maximum size (in bytes) for each component.
Definition grok.h:1210
uint32_t num_threads
Definition grok.h:1229
uint8_t mct
MCT (multiple component transform)
Definition grok.h:1195
uint16_t numlayers
number of layers
Definition grok.h:1127
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:1188
double capture_resolution_from_file[2]
Definition grok.h:1218
bool irreversible
1 : use the irreversible DWT 9-7, 0 : use lossless compression (default)
Definition grok.h:1161
uint32_t t_width
XTsiz.
Definition grok.h:1123
bool write_display_resolution
Definition grok.h:1223
uint8_t cblk_sty
code block style
Definition grok.h:1158
uint8_t csty
csty : coding style
Definition grok.h:1142
uint8_t new_tile_part_progression_divider
new tile part progression divider
Definition grok.h:1193
bool is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1139
uint16_t rsiz
RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values.
Definition grok.h:1213
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:1174
double layer_distortion[GRK_MAX_LAYERS]
layer PSNR values
Definition grok.h:1136
GRK_RATE_CONTROL_ALGORITHM rate_control_algorithm
Definition grok.h:1228
uint32_t kernel_build_options
Definition grok.h:1232
bool write_plt
Definition grok.h:1234
void * mct_data
Naive implementation of MCT restricted to a single reversible array based compressing without offset ...
Definition grok.h:1198
uint32_t tx0
XTOsiz.
Definition grok.h:1119
char * comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1137
bool write_capture_resolution
Definition grok.h:1220
uint8_t subsampling_dx
subsampling value for dx
Definition grok.h:1182
int32_t device_id
Definition grok.h:1230
size_t num_comments
Definition grok.h:1140
uint16_t framerate
Definition grok.h:1214
bool allocation_by_rate_distortion
rate control allocation by rate/distortion curve
Definition grok.h:1129
bool allocation_by_quality
rate control allocation by fixed_PSNR quality
Definition grok.h:1134
bool write_tlm
Definition grok.h:1235
double display_resolution[2]
Definition grok.h:1224
int32_t roi_compno
region of interest: affected component in [0..3]; -1 indicates no ROI
Definition grok.h:1164
uint32_t ty0
YTOsiz.
Definition grok.h:1121
uint32_t duration
Definition grok.h:1231
bool apply_icc_
Definition grok.h:1226
double layer_rate[GRK_MAX_LAYERS]
layers rates expressed as compression ratios.
Definition grok.h:1132
bool enable_tile_part_generation
Tile part generation.
Definition grok.h:1191
uint32_t numpocs
number of progression order changes (POCs), default to 0
Definition grok.h:1150
double capture_resolution[2]
Definition grok.h:1221
Core decompression parameters.
Definition grok.h:642
grk_io_pixels_callback io_buffer_callback
Definition grok.h:662
GRK_TILE_CACHE_STRATEGY tile_cache_strategy
Definition grok.h:658
uint32_t random_access_flags_
Definition grok.h:660
uint16_t layers_to_decompress_
Set the maximum number of quality layers to decompress.
Definition grok.h:657
void * io_user_data
Definition grok.h:663
uint8_t reduce
Set the number of highest resolution levels to be discarded.
Definition grok.h:650
grk_io_register_reclaim_callback io_register_client_callback
Definition grok.h:664
Decompression parameters.
Definition grok.h:678
double dw_x0
Decompress window left boundary.
Definition grok.h:690
bool io_xml
Definition grok.h:709
grk_precision * precision
Definition grok.h:700
uint32_t compression_level
Definition grok.h:715
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:688
uint16_t tile_index
tile number of the decompressed tile
Definition grok.h:698
uint32_t num_precision
Definition grok.h:701
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:682
double dw_x1
Decompress window right boundary.
Definition grok.h:692
bool force_rgb
Definition grok.h:703
uint32_t compression
Definition grok.h:710
uint32_t num_threads
Definition grok.h:722
int32_t device_id
Definition grok.h:718
uint32_t kernel_build_options
Definition grok.h:720
void * user_data
Definition grok.h:723
bool single_tile_decompress
Definition grok.h:699
uint32_t repeats
Definition grok.h:721
bool upsample
Definition grok.h:705
grk_decompress_core_params core
core library parameters
Definition grok.h:680
bool verbose_
Verbose mode.
Definition grok.h:717
double dw_y1
Decompress window bottom boundary.
Definition grok.h:696
uint32_t duration
Definition grok.h:719
double dw_y0
Decompress window up boundary.
Definition grok.h:694
bool split_pnm
Definition grok.h:707
GRK_CODEC_FORMAT decod_format
input file format
Definition grok.h:686
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:684
Image component.
Definition grok.h:730
uint32_t h
data height
Definition grok.h:740
uint8_t dy
YRsiz: vertical separation of a sample of component with respect to the reference grid.
Definition grok.h:746
GRK_CHANNEL_ASSOC association
Definition grok.h:752
GRK_CHANNEL_TYPE type
Definition grok.h:751
uint8_t dx
XRsiz: horizontal separation of a sample of component with respect to the reference grid.
Definition grok.h:743
bool sgnd
Definition grok.h:750
uint32_t w
data width
Definition grok.h:736
uint8_t prec
precision
Definition grok.h:748
uint16_t crg_x
Definition grok.h:754
int32_t * data
image component data
Definition grok.h:756
uint32_t x0
x component offset compared to the whole image
Definition grok.h:732
uint32_t y0
y component offset compared to the whole image
Definition grok.h:734
uint16_t crg_y
Definition grok.h:754
uint32_t stride
data stride
Definition grok.h:738
Grok image.
Definition grok.h:792
uint64_t packed_row_bytes
Definition grok.h:828
grk_precision * precision
Definition grok.h:816
bool has_capture_resolution
Definition grok.h:809
uint16_t numcomps
number of components in the image
Definition grok.h:805
bool force_rgb
Definition grok.h:814
uint32_t y0
YOsiz: vertical offset from the origin of the reference grid to the top side of the image area.
Definition grok.h:799
bool split_by_component
Definition grok.h:819
GRK_COLOR_SPACE color_space
Definition grok.h:806
uint32_t rows_per_task
Definition grok.h:827
uint32_t rows_per_strip
Definition grok.h:826
bool upsample
Definition grok.h:815
grk_image_comp * comps
Definition grok.h:830
uint8_t decompress_prec
Definition grok.h:823
bool has_multiple_tiles
Definition grok.h:818
grk_io_buf interleaved_data
Definition grok.h:825
GRK_COLOR_SPACE decompress_colour_space
Definition grok.h:824
uint32_t x0
XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area.
Definition grok.h:796
grk_object obj
Definition grok.h:793
uint32_t num_precision
Definition grok.h:817
uint16_t decompress_num_comps
Definition grok.h:820
bool has_display_resolution
Definition grok.h:811
GRK_SUPPORTED_FILE_FMT decompress_fmt
Definition grok.h:813
double display_resolution[2]
Definition grok.h:812
uint32_t y1
Ysiz: height of the reference grid.
Definition grok.h:803
uint32_t decompress_width
Definition grok.h:821
uint32_t decompress_height
Definition grok.h:822
double capture_resolution[2]
Definition grok.h:810
grk_image_meta * meta
Definition grok.h:829
bool palette_applied_
Definition grok.h:807
uint32_t x1
Xsiz: width of the reference grid.
Definition grok.h:801
bool channel_definition_applied_
Definition grok.h:808
Grok IO buffer.
Definition grok.h:514
bool pooled_
Definition grok.h:519
size_t offset_
Definition grok.h:516
uint8_t * data_
Definition grok.h:515
size_t len_
Definition grok.h:517
size_t alloc_len_
Definition grok.h:518
uint32_t index_
Definition grok.h:520
Grok IO initialization.
Definition grok.h:527
uint32_t max_pooled_requests_
Definition grok.h:528
Logging handlers.
Definition grok.h:182
grk_msg_callback info_callback
Definition grok.h:183
void * warn_data
Definition grok.h:186
grk_msg_callback warn_callback
Definition grok.h:185
grk_msg_callback error_callback
Definition grok.h:187
void * error_data
Definition grok.h:188
void * info_data
Definition grok.h:184
Reference counted object.
Definition grok.h:197
void * wrapper
Definition grok.h:198
Palette data.
Definition grok.h:344
grk_component_mapping_comp * component_mapping
Definition grok.h:347
uint8_t num_channels
Definition grok.h:348
int32_t * lut
Definition grok.h:345
uint16_t num_entries
Definition grok.h:346
bool * channel_sign
Definition grok.h:349
uint8_t * channel_prec
Definition grok.h:350
Plugin band.
Definition grok.h:876
uint64_t num_precincts
Definition grok.h:878
float stepsize
Definition grok.h:880
uint8_t orientation
Definition grok.h:877
grk_plugin_precinct ** precincts
Definition grok.h:879
Plugin code block.
Definition grok.h:847
uint32_t y0
Definition grok.h:851
uint8_t num_passes
Definition grok.h:858
uint32_t compressed_data_length
Definition grok.h:856
grk_plugin_pass passes[GRK_MAX_PASSES]
Definition grok.h:859
unsigned int sorted_index
Definition grok.h:860
uint32_t x0
Definition grok.h:851
uint8_t * compressed_data
Definition grok.h:855
uint32_t y1
Definition grok.h:851
uint32_t x1
Definition grok.h:851
unsigned int * context_stream
Definition grok.h:852
uint32_t num_pix
Definition grok.h:854
uint8_t num_bit_planes
Definition grok.h:857
Plugin decompress callback info.
Definition grok.h:1675
uint32_t full_image_y0
Definition grok.h:1693
GRK_CODEC_FORMAT decod_format
Definition grok.h:1681
unsigned int error_code
Definition grok.h:1690
grk_decompress_parameters * decompressor_parameters
Definition grok.h:1686
grk_header_info header_info
Definition grok.h:1685
GRK_SUPPORTED_FILE_FMT cod_format
Definition grok.h:1683
grk_plugin_tile * tile
Definition grok.h:1689
size_t device_id
Definition grok.h:1676
uint32_t full_image_x0
Definition grok.h:1692
grk_object * codec
Definition grok.h:1684
void * user_data
Definition grok.h:1694
bool plugin_owns_image
Definition grok.h:1688
uint32_t decompress_flags
Definition grok.h:1691
const char * output_file_name
Definition grok.h:1679
GROK_INIT_DECOMPRESSORS init_decompressors_func
Definition grok.h:1677
const char * input_file_name
Definition grok.h:1678
grk_image * image
Definition grok.h:1687
bool verbose
Definition grok.h:1593
const char * server
Definition grok.h:1595
int32_t device_id
Definition grok.h:1592
const char * license
Definition grok.h:1594
Plugin load info.
Definition grok.h:1540
const char * pluginPath
Definition grok.h:1541
bool verbose
Definition grok.h:1542
Plugin pass.
Definition grok.h:837
size_t rate
Definition grok.h:839
size_t length
Definition grok.h:840
double distortion_decrease
Definition grok.h:838
Plugin precinct.
Definition grok.h:867
uint64_t num_blocks
Definition grok.h:868
grk_plugin_code_block ** blocks
Definition grok.h:869
Plugin resolution.
Definition grok.h:887
uint8_t num_bands
Definition grok.h:889
uint8_t level
Definition grok.h:888
grk_plugin_band ** band
Definition grok.h:890
Plugin tile.
Definition grok.h:915
uint16_t num_components
Definition grok.h:917
uint32_t decompress_flags
Definition grok.h:916
grk_plugin_tile_component ** tile_components
Definition grok.h:918
Precision.
Definition grok.h:427
grk_precision_mode mode
Definition grok.h:429
uint8_t prec
Definition grok.h:428
Progression order change.
Definition grok.h:206
uint16_t comp_temp
Definition grok.h:239
uint32_t tx1
Definition grok.h:215
uint64_t prec_e
Definition grok.h:224
GRK_PROG_ORDER specified_compression_poc_prog
Definition grok.h:209
uint16_t comp_s
progression order bounds specified by POC
Definition grok.h:219
uint8_t res_temp
Definition grok.h:240
uint32_t tp_ty_e
Definition grok.h:236
uint32_t tp_tx_s
Definition grok.h:233
uint8_t res_s
Definition grok.h:221
uint32_t tx0
tile dimensions
Definition grok.h:213
uint8_t tp_res_s
Definition grok.h:229
uint64_t prec_temp
Definition grok.h:241
uint64_t tp_prec_e
Definition grok.h:231
uint32_t tp_ty_s
Definition grok.h:235
uint8_t tp_res_e
Definition grok.h:230
uint32_t ty0
Definition grok.h:214
uint32_t ty1
Definition grok.h:216
uint32_t ty0_temp
Definition grok.h:244
uint16_t comp_e
Definition grok.h:220
uint32_t dy
Definition grok.h:238
GRK_PROG_ORDER progression
Definition grok.h:207
uint32_t dx
Definition grok.h:237
uint16_t tp_comp_e
Definition grok.h:228
uint64_t prec_s
Definition grok.h:223
uint32_t tp_tx_e
Definition grok.h:234
uint32_t tx0_temp
Definition grok.h:243
uint16_t tp_lay_e
Definition grok.h:232
uint32_t tileno
Definition grok.h:210
uint16_t lay_temp
Definition grok.h:242
uint16_t tp_comp_s
Definition grok.h:227
uint16_t lay_e
Definition grok.h:226
uint16_t lay_s
Definition grok.h:225
char progression_str[5]
Definition grok.h:208
uint8_t res_e
Definition grok.h:222
RAW component compress parameters.
Definition grok.h:251
uint8_t dy
subsampling in X direction
Definition grok.h:253
uint8_t dx
Definition grok.h:252
RAW image compress parameters.
Definition grok.h:260
uint8_t prec
number of components of the raw image
Definition grok.h:264
uint32_t width
Definition grok.h:261
uint16_t numcomps
height of the raw image
Definition grok.h:263
grk_raw_comp_cparameters * comps
signed/unsigned raw image
Definition grok.h:266
bool sgnd
bit depth of the raw image
Definition grok.h:265
uint32_t height
width of the raw image
Definition grok.h:262
JPEG 2000 stream parameters.
Definition grok.h:608
uint8_t * buf
Definition grok.h:613
grk_stream_read_fn read_fn
Definition grok.h:619
size_t buf_len
Definition grok.h:614
grk_stream_free_user_data_fn free_user_data_fn
Definition grok.h:622
size_t double_buffer_len
Definition grok.h:625
size_t stream_len
Definition grok.h:624
grk_stream_write_fn write_fn
Definition grok.h:620
const char * file
Definition grok.h:610
grk_stream_seek_fn seek_fn
Definition grok.h:621
void * user_data
Definition grok.h:623
size_t buf_compressed_len
Definition grok.h:616
uint8_t precision_
Definition grok.h:1107
uint32_t height_
Definition grok.h:1106
uint32_t width_
Definition grok.h:1105
uint16_t numcomps_
Definition grok.h:1108
bool do_synthesis_
Definition grok.h:1104
Plugin batch compress info.
Definition grok.h:1629
grk_cparameters * compress_parameters
Definition grok.h:1632
GRK_PLUGIN_COMPRESS_USER_CALLBACK callback
Definition grok.h:1633
const char * output_dir
Definition grok.h:1631
const char * input_dir
Definition grok.h:1630
bool transfer_exif_tags
Definition grok.h:1615
grk_cparameters * compressor_parameters
Definition grok.h:1610
grk_image * image
Definition grok.h:1611
grk_plugin_tile * tile
Definition grok.h:1612
const char * output_file_name
Definition grok.h:1609
grk_stream_params stream_params
Definition grok.h:1613
unsigned int error_code
Definition grok.h:1614
const char * input_file_name
Definition grok.h:1607
bool output_file_name_is_relative
Definition grok.h:1608
Plugin tile component.
Definition grok.h:897
uint8_t numresolutions
Definition grok.h:898
grk_plugin_resolution ** resolutions
Definition grok.h:899