27#include "grk_config.h"
34#define GRK_CALLCONV __stdcall
39#define GRK_API __declspec(dllexport)
41#define GRK_API __declspec(dllimport)
47#define GRK_API __attribute__((visibility("hidden")))
49#define GRK_API __attribute__((visibility("default")))
108#define GRK_NUM_COMMENTS_SUPPORTED 256
109#define GRK_NUM_ASOC_BOXES_SUPPORTED 256
110#define GRK_MAX_COMMENT_LENGTH (UINT16_MAX - 2)
111#define GRK_MAX_SUPPORTED_IMAGE_PRECISION 16
126#define GRK_BIBO_EXTRA_BITS 7
128#define GRK_MAX_PASSES (3 * (GRK_MAX_SUPPORTED_IMAGE_PRECISION + GRK_BIBO_EXTRA_BITS) - 2)
251#define GRK_PATH_LEN 4096
252#define GRK_MAX_LAYERS 100
258#define GRK_MAX_DECOMP_LVLS \
261#define GRK_MAXRLVLS \
262 (GRK_MAX_DECOMP_LVLS + 1)
263#define GRK_MAXBANDS (3 * GRK_MAXRLVLS - 2)
481 void* io_user_data,
void* reclaim_user_data);
492typedef size_t (*
grk_stream_read_fn)(uint8_t* buffer,
size_t numBytes,
void* user_data);
502typedef size_t (*
grk_stream_write_fn)(
const uint8_t* buffer,
size_t numBytes,
void* user_data);
583#define GRK_DECOMPRESS_COMPRESSION_LEVEL_DEFAULT (UINT_MAX)
795#define GRK_DECODE_HEADER (1 << 0)
796#define GRK_DECODE_T2 (1 << 1)
797#define GRK_DECODE_T1 (1 << 2)
798#define GRK_DECODE_POST_T1 (1 << 3)
799#define GRK_PLUGIN_DECODE_CLEAN (1 << 4)
800#define GRK_DECODE_ALL \
801 (GRK_PLUGIN_DECODE_CLEAN | GRK_DECODE_HEADER | GRK_DECODE_T2 | GRK_DECODE_T1 | \
849 void* error_user_data);
924 uint16_t tile_index);
949 double start_y,
double end_x,
double end_y);
1164 int32_t* dc_shift, uint32_t nbComp);
1166#define GRK_IMG_INFO 1
1167#define GRK_MH_INFO 2
1168#define GRK_TH_INFO 4
1169#define GRK_TCH_INFO 8
1170#define GRK_MH_IND 16
1171#define GRK_TH_IND 32
1173#define GRK_CBLKSTY_LAZY 0x01
1174#define GRK_CBLKSTY_RESET 0x02
1175#define GRK_CBLKSTY_TERMALL 0x04
1176#define GRK_CBLKSTY_VSC 0x08
1177#define GRK_CBLKSTY_PTERM 0x10
1178#define GRK_CBLKSTY_SEGSYM 0x20
1179#define GRK_CBLKSTY_HT 0x40
1180#define GRK_CBLKSTY_HT_MIXED 0xC0
1181#define GRK_JPH_RSIZ_FLAG 0x4000
1203#define GRK_PROFILE_NONE 0x0000
1204#define GRK_PROFILE_0 0x0001
1205#define GRK_PROFILE_1 0x0002
1206#define GRK_PROFILE_CINEMA_2K 0x0003
1207#define GRK_PROFILE_CINEMA_4K 0x0004
1208#define GRK_PROFILE_CINEMA_S2K 0x0005
1209#define GRK_PROFILE_CINEMA_S4K 0x0006
1210#define GRK_PROFILE_CINEMA_LTS \
1212#define GRK_PROFILE_BC_SINGLE 0x0100
1213#define GRK_PROFILE_BC_MULTI 0x0200
1214#define GRK_PROFILE_BC_MULTI_R \
1216#define GRK_PROFILE_BC_MASK 0x030F
1217#define GRK_PROFILE_IMF_2K 0x0400
1218#define GRK_PROFILE_IMF_4K 0x0500
1219#define GRK_PROFILE_IMF_8K 0x0600
1220#define GRK_PROFILE_IMF_2K_R \
1222#define GRK_PROFILE_IMF_4K_R \
1224#define GRK_PROFILE_IMF_8K_R \
1226#define GRK_PROFILE_MASK 0x0FFF
1227#define GRK_PROFILE_PART2 0x8000
1228#define GRK_PROFILE_PART2_EXTENSIONS_MASK 0x3FFF
1233#define GRK_EXTENSION_NONE 0x0000
1234#define GRK_EXTENSION_MCT 0x0100
1235#define GRK_IS_PART2(v) ((v)&GRK_PROFILE_PART2)
1237#define GRK_IS_CINEMA(v) (((v) >= GRK_PROFILE_CINEMA_2K) && ((v) <= GRK_PROFILE_CINEMA_S4K))
1238#define GRK_IS_STORAGE(v) ((v) == GRK_PROFILE_CINEMA_LTS)
1292#define GRK_GET_IMF_OR_BROADCAST_PROFILE(v) \
1295#define GRK_LEVEL_MAX 11U
1296#define GRK_GET_LEVEL(v) ((v)&0xf)
1300#define GRK_IS_BROADCAST(v) \
1301 (((v) >= GRK_PROFILE_BC_SINGLE) && ((v) <= (GRK_PROFILE_BC_MULTI_R | 0x000b)) && \
1305#define GRK_BROADCAST_LEVEL_1_MBITSSEC 200U
1306#define GRK_BROADCAST_LEVEL_2_MBITSSEC 200U
1307#define GRK_BROADCAST_LEVEL_3_MBITSSEC 200U
1308#define GRK_BROADCAST_LEVEL_4_MBITSSEC 400U
1309#define GRK_BROADCAST_LEVEL_5_MBITSSEC 800U
1310#define GRK_BROADCAST_LEVEL_6_MBITSSEC 1600U
1311#define GRK_BROADCAST_LEVEL_7_MBITSSEC 3200U
1312#define GRK_BROADCAST_LEVEL_8_MBITSSEC 6400U
1313#define GRK_BROADCAST_LEVEL_9_MBITSSEC 12800U
1314#define GRK_BROADCAST_LEVEL_10_MBITSSEC 25600U
1315#define GRK_BROADCAST_LEVEL_11_MBITSSEC 51200U
1317#define GRK_BROADCAST_LEVEL_1_MSAMPLESSEC 64U
1318#define GRK_BROADCAST_LEVEL_2_MSAMPLESSEC 130U
1319#define GRK_BROADCAST_LEVEL_3_MSAMPLESSEC 195U
1320#define GRK_BROADCAST_LEVEL_4_MSAMPLESSEC 260U
1321#define GRK_BROADCAST_LEVEL_5_MSAMPLESSEC 520U
1322#define GRK_BROADCAST_LEVEL_6_MSAMPLESSEC 1200U
1323#define GRK_BROADCAST_LEVEL_7_MSAMPLESSEC 2400U
1324#define GRK_BROADCAST_LEVEL_8_MSAMPLESSEC 4800U
1325#define GRK_BROADCAST_LEVEL_9_MSAMPLESSEC 9600U
1326#define GRK_BROADCAST_LEVEL_10_MSAMPLESSEC 19200U
1327#define GRK_BROADCAST_LEVEL_11_MSAMPLESSEC 38400U
1331#define GRK_IS_IMF(v) \
1332 (((v) >= GRK_PROFILE_IMF_2K) && ((v) <= (GRK_PROFILE_IMF_8K_R | 0x009b)) && \
1333 (((v)&0xf) <= 0xb) && (((v)&0xf0) <= 0x90))
1336#define GRK_IMF_MAINLEVEL_1_MSAMPLESSEC 65U
1337#define GRK_IMF_MAINLEVEL_2_MSAMPLESSEC 130U
1338#define GRK_IMF_MAINLEVEL_3_MSAMPLESSEC 195U
1339#define GRK_IMF_MAINLEVEL_4_MSAMPLESSEC 260U
1340#define GRK_IMF_MAINLEVEL_5_MSAMPLESSEC 520U
1341#define GRK_IMF_MAINLEVEL_6_MSAMPLESSEC 1200U
1342#define GRK_IMF_MAINLEVEL_7_MSAMPLESSEC 2400U
1343#define GRK_IMF_MAINLEVEL_8_MSAMPLESSEC 4800U
1344#define GRK_IMF_MAINLEVEL_9_MSAMPLESSEC 9600U
1345#define GRK_IMF_MAINLEVEL_10_MSAMPLESSEC 19200U
1346#define GRK_IMF_MAINLEVEL_11_MSAMPLESSEC 38400U
1348#define GRK_IMF_SUBLEVEL_MAX 9U
1349#define GRK_GET_IMF_SUBLEVEL(v) (((v) >> 4) & 0xf)
1352#define GRK_IMF_SUBLEVEL_1_MBITSSEC 200U
1353#define GRK_IMF_SUBLEVEL_2_MBITSSEC 400U
1354#define GRK_IMF_SUBLEVEL_3_MBITSSEC 800U
1355#define GRK_IMF_SUBLEVEL_4_MBITSSEC 1600U
1356#define GRK_IMF_SUBLEVEL_5_MBITSSEC 3200U
1357#define GRK_IMF_SUBLEVEL_6_MBITSSEC 6400U
1358#define GRK_IMF_SUBLEVEL_7_MBITSSEC 12800U
1359#define GRK_IMF_SUBLEVEL_8_MBITSSEC 25600U
1360#define GRK_IMF_SUBLEVEL_9_MBITSSEC 51200U
1367#define GRK_CINEMA_DCI_MAX_BANDWIDTH 250000000
1369#define GRK_CINEMA_24_CS 1302083
1370#define GRK_CINEMA_24_COMP 1041666
1372#define GRK_CINEMA_48_CS 651041
1373#define GRK_CINEMA_48_COMP 520833
1375#define GRK_CINEMA_4K_DEFAULT_NUM_RESOLUTIONS 7
1381#define GRK_CUSTOM_CIELAB_SPACE 0x0
1382#define GRK_DEFAULT_CIELAB_SPACE 0x44454600
1383#define GRK_CIE_DAY ((((uint32_t)'C') << 24) + (((uint32_t)'T') << 16))
1384#define GRK_CIE_D50 ((uint32_t)0x00443530)
1385#define GRK_CIE_D65 ((uint32_t)0x00443635)
1386#define GRK_CIE_D75 ((uint32_t)0x00443735)
1387#define GRK_CIE_SA ((uint32_t)0x00005341)
1388#define GRK_CIE_SC ((uint32_t)0x00005343)
1389#define GRK_CIE_F2 ((uint32_t)0x00004632)
1390#define GRK_CIE_F7 ((uint32_t)0x00004637)
1391#define GRK_CIE_F11 ((uint32_t)0x00463131)
1396#define GRK_RANDOM_ACCESS_PLT 1
1397#define GRK_RANDOM_ACCESS_TLM 2
1398#define GRK_RANDOM_ACCESS_PLM 4
1427#define GRK_PLUGIN_STATE_NO_DEBUG 0x0
1444#define GRK_PLUGIN_STATE_DEBUG 0x1
1445#define GRK_PLUGIN_STATE_PRE_TR1 0x2
1446#define GRK_PLUGIN_STATE_DWT_QUANTIZATION 0x4
1447#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
_GRK_SUPPORTED_FILE_FMT
All supported file formats.
Definition grok.h:226
@ GRK_FMT_BMP
Definition grok.h:233
@ GRK_FMT_JP2
Definition grok.h:229
@ GRK_FMT_J2K
Definition grok.h:228
@ GRK_FMT_PNG
Definition grok.h:236
@ GRK_FMT_RAWL
Definition grok.h:237
@ GRK_FMT_UNK
Definition grok.h:227
@ GRK_FMT_TIF
Definition grok.h:234
@ GRK_FMT_JPG
Definition grok.h:238
@ GRK_FMT_PXM
Definition grok.h:230
@ GRK_FMT_RAW
Definition grok.h:235
@ GRK_FMT_PAM
Definition grok.h:232
@ GRK_FMT_PGX
Definition grok.h:231
struct _grk_cparameters grk_cparameters
Compress parameters.
GRK_API void GRK_CALLCONV grk_decompress_set_default_params(grk_decompress_parameters *parameters)
Initialize decompress parameters with default values.
Definition grok.cpp:341
struct _grk_progression grk_progression
Progression order change.
enum _grk_precision_mode grk_precision_mode
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)
Definition grok.h:478
GRK_API bool GRK_CALLCONV grk_set_MCT(grk_cparameters *parameters, float *encodingMatrix, int32_t *dc_shift, uint32_t nbComp)
Set the MCT matrix to use.
Definition grok.cpp:441
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_compress(void)
Stop batch compress.
Definition grok.cpp:859
GRK_API grk_object *GRK_CALLCONV grk_object_ref(grk_object *obj)
Increment ref count.
Definition grok.cpp:139
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_decompress(void)
Stop batch decompress.
Definition grok.cpp:956
struct _grk_channel_description grk_channel_description
Channel definition: channel index, type, association.
#define GRK_NUM_COMMENTS_SUPPORTED
Definition grok.h:108
void(* grk_msg_callback)(const char *msg, void *client_data)
Logging callback.
Definition grok.h:136
enum _GRK_CHANNEL_TYPE GRK_CHANNEL_TYPE
bool(* grk_io_pixels_callback)(uint32_t threadId, grk_io_buf buffer, void *user_data)
Definition grok.h:481
struct _grk_stream_params grk_stream_params
JPEG 2000 stream parameters.
GRK_API void GRK_CALLCONV grk_plugin_cleanup(void)
Release plugin resources.
Definition grok.cpp:777
GRK_API bool GRK_CALLCONV grk_plugin_load(grk_plugin_load_info info)
Load plugin.
Definition grok.cpp:735
GRK_API uint64_t GRK_CALLCONV grk_compress(grk_codec *codec, grk_plugin_tile *tile)
Compress an image into a JPEG 2000 code stream using plugin.
Definition grok.cpp:607
GRK_API bool GRK_CALLCONV grk_initialize(const char *pluginPath, uint32_t numthreads, bool verbose)
Initialize library.
Definition grok.cpp:115
struct grk_plugin_compress_batch_info grk_plugin_compress_batch_info
uint64_t(* GRK_PLUGIN_COMPRESS_USER_CALLBACK)(grk_plugin_compress_user_callback_info *info)
Definition grok.h:1482
GRK_API bool GRK_CALLCONV grk_decompress_detect_format(const char *fileName, GRK_CODEC_FORMAT *fmt)
Detect jpeg 2000 format from file Format is either GRK_FMT_J2K or GRK_FMT_JP2.
Definition grok.cpp:262
#define GRK_MAXRLVLS
Definition grok.h:260
enum _GRK_CODEC_FORMAT GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
enum _GRK_ENUM_COLOUR_SPACE GRK_ENUM_COLOUR_SPACE
GRK_API void GRK_CALLCONV grk_set_msg_handlers(grk_msg_callback info_callback, void *info_user_data, grk_msg_callback warn_callback, void *warn_user_data, grk_msg_callback error_callback, void *error_user_data)
Definition grok.cpp:157
GRK_API uint32_t GRK_CALLCONV grk_plugin_get_debug_state()
Get debug state of plugin.
Definition grok.cpp:762
struct _grk_precision grk_precision
Precision.
struct _grk_plugin_decompress_callback_info grk_plugin_decompress_callback_info
#define GRK_MAX_PASSES
Definition grok.h:128
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_decompress(void)
Initiate batch decompress.
Definition grok.cpp:942
enum _GRK_PROG_ORDER GRK_PROG_ORDER
Progression order.
struct _grk_object grk_object
Grok ref-counted object.
struct _grk_raw_cparameters grk_raw_cparameters
RAW image compress parameters.
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)
Compress with plugin.
Definition grok.cpp:811
_GRK_CHANNEL_ASSOC
Definition grok.h:312
@ GRK_CHANNEL_ASSOC_COLOUR_1
Definition grok.h:315
@ GRK_CHANNEL_ASSOC_COLOUR_2
Definition grok.h:316
@ GRK_CHANNEL_ASSOC_COLOUR_3
Definition grok.h:317
@ GRK_CHANNEL_ASSOC_WHOLE_IMAGE
Definition grok.h:314
@ GRK_CHANNEL_ASSOC_UNASSOCIATED
Definition grok.h:318
enum _GRK_RATE_CONTROL_ALGORITHM GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms GRK_RATE_CONTROL_BISECT: bisect with all truncation points GRK_RATE_CONTROL_P...
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:491
struct _grk_image_meta grk_image_meta
struct _grk_asoc grk_asoc
Association box info.
grk_object grk_codec
Definition grok.h:814
enum _GRK_SUPPORTED_FILE_FMT GRK_SUPPORTED_FILE_FMT
All supported file formats.
struct _grk_palette_data grk_palette_data
Palette data.
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_tile_image(grk_codec *codec, uint16_t tile_index)
Get decompressed tile image.
Definition grok.cpp:470
#define GRK_API
Definition grok.h:49
GRK_API bool GRK_CALLCONV grk_decompress_read_header(grk_codec *codec, grk_header_info *header_info)
Decompress JPEG 2000 header.
Definition grok.cpp:381
struct _grk_component_mapping_comp grk_component_mapping_comp
Note: "component" refers to an image component as decompressed from the code stream,...
GRK_API grk_codec *GRK_CALLCONV grk_compress_init(grk_stream_params *stream_params, grk_cparameters *parameters, grk_image *p_image)
Set up the compressor parameters using the current image and user parameters.
Definition grok.cpp:539
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:133
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:148
#define GRK_MAX_LAYERS
Definition grok.h:252
GRK_API grk_codec *GRK_CALLCONV grk_decompress_init(grk_stream_params *stream_params, grk_decompress_core_params *core_params)
Initialize decompressor.
Definition grok.cpp:352
GRK_API void GRK_CALLCONV grk_compress_set_default_params(grk_cparameters *parameters)
Set compressing parameters to default values:
Definition grok.cpp:510
GRK_API void GRK_CALLCONV grk_set_default_stream_params(grk_stream_params *params)
Initialize stream parameters with default values.
Definition grok.cpp:280
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:217
_GRK_COLOR_SPACE
Supported color spaces.
Definition grok.h:71
@ GRK_CLRSPC_SRGB
sRGB
Definition grok.h:73
@ GRK_CLRSPC_EYCC
extended YCC
Definition grok.h:76
@ GRK_CLRSPC_UNKNOWN
unknown
Definition grok.h:72
@ GRK_CLRSPC_SYCC
standard YCC (YUV)
Definition grok.h:75
@ GRK_CLRSPC_DEFAULT_CIE
default CIE LAB
Definition grok.h:78
@ GRK_CLRSPC_ICC
ICC profile.
Definition grok.h:80
@ GRK_CLRSPC_CMYK
CMYK.
Definition grok.h:77
@ GRK_CLRSPC_GRAY
grayscale
Definition grok.h:74
@ GRK_CLRSPC_CUSTOM_CIE
custom CIE LAB
Definition grok.h:79
struct _grk_io_buf grk_io_buf
_grk_precision_mode
Precision mode.
Definition grok.h:369
@ GRK_PREC_MODE_SCALE
Definition grok.h:371
@ GRK_PREC_MODE_CLIP
Definition grok.h:370
GRK_API grk_image_meta *GRK_CALLCONV grk_image_meta_new(void)
Definition grok.cpp:228
enum _GRK_COLOR_SPACE GRK_COLOR_SPACE
Supported color spaces.
#define GRK_PATH_LEN
Definition grok.h:251
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:222
GRK_API int32_t GRK_CALLCONV grk_plugin_decompress(grk_decompress_parameters *decompress_parameters, grk_plugin_decompress_callback callback)
Decompress with plugin.
Definition grok.cpp:907
GRK_API bool GRK_CALLCONV grk_decompress_tile(grk_codec *codec, uint16_t tile_index)
Decompress a specific tile.
Definition grok.cpp:419
bool(* grk_stream_seek_fn)(uint64_t offset, void *user_data)
seek (absolute) callback
Definition grok.h:510
struct _grk_io_init grk_io_init
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_composited_image(grk_codec *codec)
Get decompressed composite image.
Definition grok.cpp:480
GRK_API void GRK_CALLCONV grk_dump_codec(grk_codec *codec, uint32_t info_flag, FILE *output_stream)
Dump codec information to file.
Definition grok.cpp:430
_GRK_ENUM_COLOUR_SPACE
Definition grok.h:85
@ GRK_ENUM_CLRSPC_ESRGB
Definition grok.h:101
@ GRK_ENUM_CLRSPC_CMY
Definition grok.h:92
@ GRK_ENUM_CLRSPC_EYCC
Definition grok.h:105
@ GRK_ENUM_CLRSPC_CIEJAB
Definition grok.h:100
@ GRK_ENUM_CLRSPC_GRAY
Definition grok.h:98
@ GRK_ENUM_CLRSPC_CIE
Definition grok.h:95
@ GRK_ENUM_CLRSPC_UNKNOWN
Definition grok.h:86
@ GRK_ENUM_CLRSPC_YCBCR3
Definition grok.h:90
@ GRK_ENUM_CLRSPC_ROMMRGB
Definition grok.h:102
@ GRK_ENUM_CLRSPC_YPBPR60
Definition grok.h:103
@ GRK_ENUM_CLRSPC_SRGB
Definition grok.h:97
@ GRK_ENUM_CLRSPC_BILEVEL2
Definition grok.h:96
@ GRK_ENUM_CLRSPC_SYCC
Definition grok.h:99
@ GRK_ENUM_CLRSPC_PHOTO_YCC
Definition grok.h:91
@ GRK_ENUM_CLRSPC_YCBCR1
Definition grok.h:88
@ GRK_ENUM_CLRSPC_CMYK
Definition grok.h:93
@ GRK_ENUM_CLRSPC_YCCK
Definition grok.h:94
@ GRK_ENUM_CLRSPC_YPBPR50
Definition grok.h:104
@ GRK_ENUM_CLRSPC_BILEVEL1
Definition grok.h:87
@ GRK_ENUM_CLRSPC_YCBCR2
Definition grok.h:89
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.
Definition grok.cpp:924
GRK_API bool GRK_CALLCONV grk_decompress_set_window(grk_codec *codec, double start_x, double start_y, double end_x, double end_y)
Set the given area to be decompressed.
Definition grok.cpp:395
struct _grk_decompress_params grk_decompress_parameters
Decompression parameters.
_GRK_CHANNEL_TYPE
Definition grok.h:302
@ GRK_CHANNEL_TYPE_OPACITY
Definition grok.h:304
@ GRK_CHANNEL_TYPE_PREMULTIPLIED_OPACITY
Definition grok.h:305
@ GRK_CHANNEL_TYPE_COLOUR
Definition grok.h:303
@ GRK_CHANNEL_TYPE_UNSPECIFIED
Definition grok.h:306
_GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms GRK_RATE_CONTROL_BISECT: bisect with all truncation points GRK_RATE_CONTROL_P...
Definition grok.h:217
@ GRK_RATE_CONTROL_PCRD_OPT
Definition grok.h:219
@ GRK_RATE_CONTROL_BISECT
Definition grok.h:218
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_compress(grk_plugin_compress_batch_info info)
Batch compress with plugin.
Definition grok.cpp:827
struct _grk_channel_definition grk_channel_definition
Channel definitions and number of definitions.
int(* GROK_INIT_DECOMPRESSORS)(grk_header_info *header_info, grk_image *image)
Definition grok.h:1528
struct _grk_plugin_band grk_plugin_band
Plugin band.
_GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
Definition grok.h:245
@ GRK_CODEC_J2K
JPEG 2000 code stream format.
Definition grok.h:247
@ GRK_CODEC_JP2
JP2 file format.
Definition grok.h:248
@ GRK_CODEC_UNK
unknown format
Definition grok.h:246
struct _grk_plugin_tile grk_plugin_tile
Plugin tile.
#define GRK_CALLCONV
Definition grok.h:45
void(* grk_stream_free_user_data_fn)(void *user_data)
free user data callback
Definition grok.h:518
#define GRK_NUM_ASOC_BOXES_SUPPORTED
Definition grok.h:109
_GRK_PROG_ORDER
Progression order.
Definition grok.h:57
@ GRK_RPCL
resolution-precinct-component-layer order
Definition grok.h:61
@ GRK_CPRL
component-precinct-resolution-layer order
Definition grok.h:63
@ GRK_RLCP
resolution-layer-component-precinct order
Definition grok.h:60
@ GRK_PROG_UNKNOWN
place-holder
Definition grok.h:58
@ GRK_LRCP
layer-resolution-component-precinct order
Definition grok.h:59
@ GRK_NUM_PROGRESSION_ORDERS
Definition grok.h:64
@ GRK_PCRL
precinct-component-resolution-layer order
Definition grok.h:62
size_t(* grk_stream_write_fn)(const uint8_t *buffer, size_t numBytes, void *user_data)
write stream callback
Definition grok.h:501
GRK_API void GRK_CALLCONV grk_plugin_wait_for_batch_complete(void)
Wait for batch job to complete.
Definition grok.cpp:845
struct _grk_plugin_pass grk_plugin_pass
Plugin pass.
enum _GRK_CHANNEL_ASSOC GRK_CHANNEL_ASSOC
bool(* grk_io_callback)(uint32_t threadId, grk_io_buf buffer, void *io_user_data)
Definition grok.h:477
struct _grk_header_info grk_header_info
Header info.
int32_t(* grk_plugin_decompress_callback)(grk_plugin_decompress_callback_info *info)
Definition grok.h:1553
_GRK_TILE_CACHE_STRATEGY
Definition grok.h:548
@ GRK_TILE_CACHE_IMAGE
Definition grok.h:550
@ GRK_TILE_CACHE_NONE
Definition grok.h:549
struct _grk_plugin_resolution grk_plugin_resolution
Plugin resolution.
struct _grk_plugin_code_block grk_plugin_code_block
Plugin code block.
GRK_API bool GRK_CALLCONV grk_plugin_init(grk_plugin_init_info initInfo)
Initialize plugin.
Definition grok.cpp:782
GRK_API bool GRK_CALLCONV grk_decompress(grk_codec *codec, grk_plugin_tile *tile)
Decompress image from a JPEG 2000 code stream.
Definition grok.cpp:407
Association box info.
Definition grok.h:358
const char * label
Definition grok.h:360
uint8_t * xml
Definition grok.h:361
uint32_t level
Definition grok.h:359
uint32_t xml_len
Definition grok.h:362
Channel definitions and number of definitions.
Definition grok.h:336
uint16_t num_channel_descriptions
Definition grok.h:338
grk_channel_description * descriptions
Definition grok.h:337
Channel definition: channel index, type, association.
Definition grok.h:326
uint16_t typ
Definition grok.h:328
uint16_t asoc
Definition grok.h:329
uint16_t channel
Definition grok.h:327
ICC profile, palette, channel definition.
Definition grok.h:345
grk_channel_definition * channel_definition
Definition grok.h:349
char * icc_profile_name
Definition grok.h:348
uint32_t icc_profile_len
Definition grok.h:347
uint8_t * icc_profile_buf
Definition grok.h:346
grk_palette_data * palette
Definition grok.h:350
bool has_colour_specification_box
Definition grok.h:351
Note: "component" refers to an image component as decompressed from the code stream,...
Definition grok.h:274
uint8_t palette_column
Definition grok.h:277
uint8_t mapping_type
Definition grok.h:276
uint16_t component_index
Definition grok.h:275
Compress parameters.
Definition grok.h:976
uint32_t cblockw_init
initial code block width (default to 64)
Definition grok.h:1015
uint8_t numgbits
Definition grok.h:1005
grk_progression progression[GRK_MAXRLVLS]
progressions
Definition grok.h:1009
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:1037
GRK_PROG_ORDER prog_order
progression order (default is LRCP)
Definition grok.h:1007
uint16_t comment_len[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:999
uint32_t repeats
Definition grok.h:1094
uint32_t prch_init[GRK_MAXRLVLS]
initial precinct height
Definition grok.h:1033
bool verbose
Definition grok.h:1097
uint32_t image_offset_x0
subimage compressing: origin image offset in x direction
Definition grok.h:1039
uint64_t max_cs_size
Maximum size (in bytes) for the whole code stream.
Definition grok.h:1066
grk_raw_cparameters raw_cp
Definition grok.h:1050
uint8_t numresolution
number of resolutions
Definition grok.h:1013
uint32_t image_offset_y0
subimage compressing: origin image offset in y direction
Definition grok.h:1041
GRK_SUPPORTED_FILE_FMT decod_format
input file format
Definition grok.h:1047
uint32_t cblockh_init
initial code block height (default to 64)
Definition grok.h:1017
uint32_t roi_shift
region of interest: upshift value
Definition grok.h:1027
bool shared_memory_interface
Definition grok.h:1098
uint8_t subsampling_dy
subsampling value for dy
Definition grok.h:1045
uint32_t prcw_init[GRK_MAXRLVLS]
initial precinct width
Definition grok.h:1031
bool tile_size_on
size of tile: tile_size_on = false (not in argument) or = true (in argument)
Definition grok.h:978
uint32_t t_height
YTsiz.
Definition grok.h:986
bool write_capture_resolution_from_file
Definition grok.h:1078
uint32_t res_spec
Definition grok.h:1029
uint64_t max_comp_size
Maximum size (in bytes) for each component.
Definition grok.h:1071
uint32_t num_threads
Definition grok.h:1090
uint8_t mct
MCT (multiple component transform)
Definition grok.h:1056
uint16_t numlayers
number of layers
Definition grok.h:988
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:1049
double capture_resolution_from_file[2]
Definition grok.h:1079
bool irreversible
1 : use the irreversible DWT 9-7, 0 : use lossless compression (default)
Definition grok.h:1022
uint32_t t_width
XTsiz.
Definition grok.h:984
bool write_display_resolution
Definition grok.h:1084
uint8_t cblk_sty
code block style
Definition grok.h:1019
uint8_t csty
csty : coding style
Definition grok.h:1003
uint8_t new_tile_part_progression_divider
new tile part progression divider
Definition grok.h:1054
bool is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:1000
uint16_t rsiz
RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values.
Definition grok.h:1074
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:1035
double layer_distortion[GRK_MAX_LAYERS]
layer PSNR values
Definition grok.h:997
GRK_RATE_CONTROL_ALGORITHM rate_control_algorithm
Definition grok.h:1089
uint32_t kernel_build_options
Definition grok.h:1093
bool write_plt
Definition grok.h:1095
void * mct_data
Naive implementation of MCT restricted to a single reversible array based compressing without offset ...
Definition grok.h:1059
uint32_t tx0
XTOsiz.
Definition grok.h:980
char * comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition grok.h:998
bool write_capture_resolution
Definition grok.h:1081
uint8_t subsampling_dx
subsampling value for dx
Definition grok.h:1043
int32_t device_id
Definition grok.h:1091
size_t num_comments
Definition grok.h:1001
uint16_t framerate
Definition grok.h:1075
bool allocation_by_rate_distortion
rate control allocation by rate/distortion curve
Definition grok.h:990
bool allocation_by_quality
rate control allocation by fixed_PSNR quality
Definition grok.h:995
bool write_tlm
Definition grok.h:1096
double display_resolution[2]
Definition grok.h:1085
int32_t roi_compno
region of interest: affected component in [0..3]; -1 indicates no ROI
Definition grok.h:1025
uint32_t ty0
YTOsiz.
Definition grok.h:982
uint32_t duration
Definition grok.h:1092
bool apply_icc_
Definition grok.h:1087
double layer_rate[GRK_MAX_LAYERS]
layers rates expressed as compression ratios.
Definition grok.h:993
bool enable_tile_part_generation
Tile part generation.
Definition grok.h:1052
uint32_t numpocs
number of progression order changes (POCs), default to 0
Definition grok.h:1011
double capture_resolution[2]
Definition grok.h:1082
Core decompression parameters.
Definition grok.h:557
grk_io_pixels_callback io_buffer_callback
Definition grok.h:577
GRK_TILE_CACHE_STRATEGY tile_cache_strategy
Definition grok.h:573
uint32_t random_access_flags_
Definition grok.h:575
uint16_t layers_to_decompress_
Set the maximum number of quality layers to decompress.
Definition grok.h:572
void * io_user_data
Definition grok.h:578
uint8_t reduce
Set the number of highest resolution levels to be discarded.
Definition grok.h:565
grk_io_register_reclaim_callback io_register_client_callback
Definition grok.h:579
Decompression parameters.
Definition grok.h:588
double dw_x0
Decompress window left boundary.
Definition grok.h:600
bool io_xml
Definition grok.h:619
grk_precision * precision
Definition grok.h:610
uint32_t compression_level
Definition grok.h:625
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition grok.h:598
uint16_t tile_index
tile number of the decompressed tile
Definition grok.h:608
uint32_t num_precision
Definition grok.h:611
char infile[GRK_PATH_LEN]
input file name
Definition grok.h:592
double dw_x1
Decompress window right boundary.
Definition grok.h:602
bool force_rgb
Definition grok.h:613
uint32_t compression
Definition grok.h:620
uint32_t num_threads
Definition grok.h:632
int32_t device_id
Definition grok.h:628
uint32_t kernel_build_options
Definition grok.h:630
void * user_data
Definition grok.h:633
bool single_tile_decompress
Definition grok.h:609
uint32_t repeats
Definition grok.h:631
bool upsample
Definition grok.h:615
grk_decompress_core_params core
core library parameters
Definition grok.h:590
bool verbose_
Verbose mode.
Definition grok.h:627
double dw_y1
Decompress window bottom boundary.
Definition grok.h:606
uint32_t duration
Definition grok.h:629
double dw_y0
Decompress window up boundary.
Definition grok.h:604
bool split_pnm
Definition grok.h:617
GRK_CODEC_FORMAT decod_format
input file format
Definition grok.h:596
char outfile[GRK_PATH_LEN]
output file name
Definition grok.h:594
Image component.
Definition grok.h:640
uint32_t h
data height
Definition grok.h:650
uint8_t dy
YRsiz: vertical separation of a sample of component with respect to the reference grid.
Definition grok.h:656
GRK_CHANNEL_ASSOC association
Definition grok.h:662
GRK_CHANNEL_TYPE type
Definition grok.h:661
uint8_t dx
XRsiz: horizontal separation of a sample of component with respect to the reference grid.
Definition grok.h:653
bool sgnd
Definition grok.h:660
uint32_t w
data width
Definition grok.h:646
uint8_t prec
precision
Definition grok.h:658
uint16_t crg_x
Definition grok.h:664
int32_t * data
image component data
Definition grok.h:666
uint32_t x0
x component offset compared to the whole image
Definition grok.h:642
uint32_t y0
y component offset compared to the whole image
Definition grok.h:644
uint16_t crg_y
Definition grok.h:664
uint32_t stride
data stride
Definition grok.h:648
uint64_t packed_row_bytes
Definition grok.h:717
grk_precision * precision
Definition grok.h:705
bool has_capture_resolution
Definition grok.h:698
uint16_t numcomps
number of components in the image
Definition grok.h:694
bool force_rgb
Definition grok.h:703
uint32_t y0
YOsiz: vertical offset from the origin of the reference grid to the top side of the image area.
Definition grok.h:688
bool split_by_component
Definition grok.h:708
GRK_COLOR_SPACE color_space
Definition grok.h:695
uint32_t rows_per_task
Definition grok.h:716
uint32_t rows_per_strip
Definition grok.h:715
bool upsample
Definition grok.h:704
grk_image_comp * comps
Definition grok.h:719
uint8_t decompress_prec
Definition grok.h:712
bool has_multiple_tiles
Definition grok.h:707
grk_io_buf interleaved_data
Definition grok.h:714
GRK_COLOR_SPACE decompress_colour_space
Definition grok.h:713
uint32_t x0
XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area.
Definition grok.h:685
grk_object obj
Definition grok.h:682
uint32_t num_precision
Definition grok.h:706
uint16_t decompress_num_comps
Definition grok.h:709
bool has_display_resolution
Definition grok.h:700
GRK_SUPPORTED_FILE_FMT decompress_fmt
Definition grok.h:702
double display_resolution[2]
Definition grok.h:701
uint32_t y1
Ysiz: height of the reference grid.
Definition grok.h:692
uint32_t decompress_width
Definition grok.h:710
uint32_t decompress_height
Definition grok.h:711
double capture_resolution[2]
Definition grok.h:699
grk_image_meta * meta
Definition grok.h:718
bool palette_applied_
Definition grok.h:696
uint32_t x1
Xsiz: width of the reference grid.
Definition grok.h:690
bool channel_definition_applied_
Definition grok.h:697
bool pooled_
Definition grok.h:467
size_t offset_
Definition grok.h:464
uint8_t * data_
Definition grok.h:463
size_t len_
Definition grok.h:465
size_t alloc_len_
Definition grok.h:466
uint32_t index_
Definition grok.h:468
uint32_t max_pooled_requests_
Definition grok.h:473
Grok ref-counted object.
Definition grok.h:144
void * wrapper
Definition grok.h:145
Palette data.
Definition grok.h:284
grk_component_mapping_comp * component_mapping
Definition grok.h:287
uint8_t num_channels
Definition grok.h:288
int32_t * lut
Definition grok.h:285
uint16_t num_entries
Definition grok.h:286
bool * channel_sign
Definition grok.h:289
uint8_t * channel_prec
Definition grok.h:290
Plugin band.
Definition grok.h:768
uint64_t num_precincts
Definition grok.h:770
float stepsize
Definition grok.h:772
uint8_t orientation
Definition grok.h:769
grk_plugin_precinct ** precincts
Definition grok.h:771
Plugin code block.
Definition grok.h:739
uint32_t y0
Definition grok.h:743
uint32_t compressed_data_length
Definition grok.h:748
size_t num_passes
Definition grok.h:750
grk_plugin_pass passes[GRK_MAX_PASSES]
Definition grok.h:751
unsigned int sorted_index
Definition grok.h:752
uint32_t x0
Definition grok.h:743
uint8_t * compressed_data
Definition grok.h:747
uint32_t y1
Definition grok.h:743
uint32_t x1
Definition grok.h:743
unsigned int * context_stream
Definition grok.h:744
uint32_t num_pix
Definition grok.h:746
uint8_t num_bit_planes
Definition grok.h:749
grk_codec * codec
Definition grok.h:1540
uint32_t full_image_y0
Definition grok.h:1549
GRK_CODEC_FORMAT decod_format
Definition grok.h:1537
unsigned int error_code
Definition grok.h:1546
grk_decompress_parameters * decompressor_parameters
Definition grok.h:1542
grk_header_info header_info
Definition grok.h:1541
GRK_SUPPORTED_FILE_FMT cod_format
Definition grok.h:1539
grk_plugin_tile * tile
Definition grok.h:1545
size_t device_id
Definition grok.h:1532
uint32_t full_image_x0
Definition grok.h:1548
void * user_data
Definition grok.h:1550
bool plugin_owns_image
Definition grok.h:1544
uint32_t decompress_flags
Definition grok.h:1547
const char * output_file_name
Definition grok.h:1535
GROK_INIT_DECOMPRESSORS init_decompressors_func
Definition grok.h:1533
const char * input_file_name
Definition grok.h:1534
grk_image * image
Definition grok.h:1543
bool verbose
Definition grok.h:1459
const char * server
Definition grok.h:1461
int32_t device_id
Definition grok.h:1458
const char * license
Definition grok.h:1460
const char * pluginPath
Definition grok.h:1409
bool verbose
Definition grok.h:1410
Plugin pass.
Definition grok.h:729
size_t rate
Definition grok.h:731
size_t length
Definition grok.h:732
double distortion_decrease
Definition grok.h:730
Plugin precinct.
Definition grok.h:759
uint64_t num_blocks
Definition grok.h:760
grk_plugin_code_block ** blocks
Definition grok.h:761
Plugin resolution.
Definition grok.h:779
size_t num_bands
Definition grok.h:781
size_t level
Definition grok.h:780
grk_plugin_band ** band
Definition grok.h:782
Plugin tile.
Definition grok.h:807
size_t num_components
Definition grok.h:809
uint32_t decompress_flags
Definition grok.h:808
grk_plugin_tile_component ** tile_components
Definition grok.h:810
Precision.
Definition grok.h:378
grk_precision_mode mode
Definition grok.h:380
uint8_t prec
Definition grok.h:379
Progression order change.
Definition grok.h:153
uint16_t comp_temp
Definition grok.h:184
uint32_t tx1
Definition grok.h:161
uint64_t prec_e
Definition grok.h:169
GRK_PROG_ORDER specified_compression_poc_prog
Definition grok.h:156
uint16_t comp_s
progression order bounds specified by POC
Definition grok.h:164
uint8_t res_temp
Definition grok.h:185
uint32_t tp_ty_e
Definition grok.h:181
uint32_t tp_tx_s
Definition grok.h:178
uint8_t res_s
Definition grok.h:166
uint32_t tx0
tile dimensions
Definition grok.h:159
uint8_t tp_res_s
Definition grok.h:174
uint64_t prec_temp
Definition grok.h:186
uint64_t tp_prec_e
Definition grok.h:176
uint32_t tp_ty_s
Definition grok.h:180
uint8_t tp_res_e
Definition grok.h:175
uint32_t ty0
Definition grok.h:160
uint32_t ty1
Definition grok.h:162
uint32_t ty0_temp
Definition grok.h:189
uint16_t comp_e
Definition grok.h:165
uint32_t dy
Definition grok.h:183
GRK_PROG_ORDER progression
Definition grok.h:154
uint32_t dx
Definition grok.h:182
uint16_t tp_comp_e
Definition grok.h:173
uint64_t prec_s
Definition grok.h:168
uint32_t tp_tx_e
Definition grok.h:179
uint32_t tx0_temp
Definition grok.h:188
uint16_t tp_lay_e
Definition grok.h:177
uint32_t tileno
Definition grok.h:157
uint16_t lay_temp
Definition grok.h:187
uint16_t tp_comp_s
Definition grok.h:172
uint16_t lay_e
Definition grok.h:171
uint16_t lay_s
Definition grok.h:170
char progression_str[5]
Definition grok.h:155
uint8_t res_e
Definition grok.h:167
RAW component compress parameters.
Definition grok.h:194
uint8_t dy
subsampling in X direction
Definition grok.h:196
uint8_t dx
Definition grok.h:195
RAW image compress parameters.
Definition grok.h:202
uint8_t prec
number of components of the raw image
Definition grok.h:206
uint32_t width
Definition grok.h:203
uint16_t numcomps
height of the raw image
Definition grok.h:205
grk_raw_comp_cparameters * comps
signed/unsigned raw image
Definition grok.h:208
bool sgnd
bit depth of the raw image
Definition grok.h:207
uint32_t height
width of the raw image
Definition grok.h:204
JPEG 2000 stream parameters.
Definition grok.h:527
uint8_t * buf
Definition grok.h:532
grk_stream_read_fn read_fn
Definition grok.h:538
size_t buf_len
Definition grok.h:533
grk_stream_free_user_data_fn free_user_data_fn
Definition grok.h:541
size_t double_buffer_len
Definition grok.h:544
size_t stream_len
Definition grok.h:543
grk_stream_write_fn write_fn
Definition grok.h:539
const char * file
Definition grok.h:529
grk_stream_seek_fn seek_fn
Definition grok.h:540
void * user_data
Definition grok.h:542
size_t buf_compressed_len
Definition grok.h:535
grk_cparameters * compress_parameters
Definition grok.h:1488
GRK_PLUGIN_COMPRESS_USER_CALLBACK callback
Definition grok.h:1489
const char * output_dir
Definition grok.h:1487
const char * input_dir
Definition grok.h:1486
bool transfer_exif_tags
Definition grok.h:1479
grk_cparameters * compressor_parameters
Definition grok.h:1474
grk_image * image
Definition grok.h:1475
grk_plugin_tile * tile
Definition grok.h:1476
const char * output_file_name
Definition grok.h:1473
grk_stream_params stream_params
Definition grok.h:1477
unsigned int error_code
Definition grok.h:1478
const char * input_file_name
Definition grok.h:1471
bool output_file_name_is_relative
Definition grok.h:1472
Plugin tile component.
Definition grok.h:789
size_t num_resolutions
Definition grok.h:790
grk_plugin_resolution ** resolutions
Definition grok.h:791