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)
223#define GRK_PATH_LEN 4096
224#define GRK_MAX_LAYERS 100
230#define GRK_J2K_MAX_DECOMP_LVLS \
233#define GRK_J2K_MAXRLVLS \
234 (GRK_J2K_MAX_DECOMP_LVLS + 1)
235#define GRK_J2K_MAXBANDS \
236 (3 * GRK_J2K_MAXRLVLS - 2)
455 void* io_user_data,
void* reclaim_user_data);
506#define GRK_DECOMPRESS_COMPRESSION_LEVEL_DEFAULT (UINT_MAX)
727#define GRK_DECODE_HEADER (1 << 0)
728#define GRK_DECODE_T2 (1 << 1)
729#define GRK_DECODE_T1 (1 << 2)
730#define GRK_DECODE_POST_T1 (1 << 3)
731#define GRK_PLUGIN_DECODE_CLEAN (1 << 4)
732#define GRK_DECODE_ALL \
733 (GRK_PLUGIN_DECODE_CLEAN | GRK_DECODE_HEADER | GRK_DECODE_T2 | GRK_DECODE_T1 | \
781 void* error_user_data);
885 float end_x,
float end_y);
1097 int32_t* dc_shift, uint32_t nbComp);
1099#define GRK_MAX_SUPPORTED_IMAGE_PRECISION 16
1101#define GRK_IMG_INFO 1
1102#define GRK_J2K_MH_INFO 2
1103#define GRK_J2K_TH_INFO 4
1104#define GRK_J2K_TCH_INFO 8
1105#define GRK_J2K_MH_IND 16
1106#define GRK_J2K_TH_IND 32
1107#define GRK_JP2_INFO 128
1108#define GRK_JP2_IND 256
1110#define GRK_CBLKSTY_LAZY 0x001
1111#define GRK_CBLKSTY_RESET 0x002
1112#define GRK_CBLKSTY_TERMALL 0x004
1113#define GRK_CBLKSTY_VSC 0x008
1114#define GRK_CBLKSTY_PTERM 0x010
1115#define GRK_CBLKSTY_SEGSYM 0x020
1116#define GRK_CBLKSTY_HT 0x040
1117#define GRK_CBLKSTY_HT_MIXED 0x080
1118#define GRK_CBLKSTY_HT_PHLD 0x100
1119#define GRK_JPH_RSIZ_FLAG 0x4000
1141#define GRK_PROFILE_NONE 0x0000
1142#define GRK_PROFILE_0 0x0001
1143#define GRK_PROFILE_1 0x0002
1144#define GRK_PROFILE_CINEMA_2K 0x0003
1145#define GRK_PROFILE_CINEMA_4K 0x0004
1146#define GRK_PROFILE_CINEMA_S2K 0x0005
1147#define GRK_PROFILE_CINEMA_S4K 0x0006
1148#define GRK_PROFILE_CINEMA_LTS \
1150#define GRK_PROFILE_BC_SINGLE 0x0100
1151#define GRK_PROFILE_BC_MULTI 0x0200
1152#define GRK_PROFILE_BC_MULTI_R \
1154#define GRK_PROFILE_BC_MASK 0x030F
1155#define GRK_PROFILE_IMF_2K 0x0400
1156#define GRK_PROFILE_IMF_4K 0x0500
1157#define GRK_PROFILE_IMF_8K 0x0600
1158#define GRK_PROFILE_IMF_2K_R \
1160#define GRK_PROFILE_IMF_4K_R \
1162#define GRK_PROFILE_IMF_8K_R \
1164#define GRK_PROFILE_MASK 0x0FFF
1165#define GRK_PROFILE_PART2 0x8000
1166#define GRK_PROFILE_PART2_EXTENSIONS_MASK 0x3FFF
1171#define GRK_EXTENSION_NONE 0x0000
1172#define GRK_EXTENSION_MCT 0x0100
1173#define GRK_IS_PART2(v) ((v)&GRK_PROFILE_PART2)
1175#define GRK_IS_CINEMA(v) (((v) >= GRK_PROFILE_CINEMA_2K) && ((v) <= GRK_PROFILE_CINEMA_S4K))
1176#define GRK_IS_STORAGE(v) ((v) == GRK_PROFILE_CINEMA_LTS)
1230#define GRK_GET_IMF_OR_BROADCAST_PROFILE(v) \
1233#define GRK_LEVEL_MAX 11U
1234#define GRK_GET_LEVEL(v) ((v)&0xf)
1238#define GRK_IS_BROADCAST(v) \
1239 (((v) >= GRK_PROFILE_BC_SINGLE) && ((v) <= (GRK_PROFILE_BC_MULTI_R | 0x000b)) && \
1243#define GRK_BROADCAST_LEVEL_1_MBITSSEC 200U
1244#define GRK_BROADCAST_LEVEL_2_MBITSSEC 200U
1245#define GRK_BROADCAST_LEVEL_3_MBITSSEC 200U
1246#define GRK_BROADCAST_LEVEL_4_MBITSSEC 400U
1247#define GRK_BROADCAST_LEVEL_5_MBITSSEC 800U
1248#define GRK_BROADCAST_LEVEL_6_MBITSSEC 1600U
1249#define GRK_BROADCAST_LEVEL_7_MBITSSEC 3200U
1250#define GRK_BROADCAST_LEVEL_8_MBITSSEC 6400U
1251#define GRK_BROADCAST_LEVEL_9_MBITSSEC 12800U
1252#define GRK_BROADCAST_LEVEL_10_MBITSSEC 25600U
1253#define GRK_BROADCAST_LEVEL_11_MBITSSEC 51200U
1255#define GRK_BROADCAST_LEVEL_1_MSAMPLESSEC 64U
1256#define GRK_BROADCAST_LEVEL_2_MSAMPLESSEC 130U
1257#define GRK_BROADCAST_LEVEL_3_MSAMPLESSEC 195U
1258#define GRK_BROADCAST_LEVEL_4_MSAMPLESSEC 260U
1259#define GRK_BROADCAST_LEVEL_5_MSAMPLESSEC 520U
1260#define GRK_BROADCAST_LEVEL_6_MSAMPLESSEC 1200U
1261#define GRK_BROADCAST_LEVEL_7_MSAMPLESSEC 2400U
1262#define GRK_BROADCAST_LEVEL_8_MSAMPLESSEC 4800U
1263#define GRK_BROADCAST_LEVEL_9_MSAMPLESSEC 9600U
1264#define GRK_BROADCAST_LEVEL_10_MSAMPLESSEC 19200U
1265#define GRK_BROADCAST_LEVEL_11_MSAMPLESSEC 38400U
1269#define GRK_IS_IMF(v) \
1270 (((v) >= GRK_PROFILE_IMF_2K) && ((v) <= (GRK_PROFILE_IMF_8K_R | 0x009b)) && \
1271 (((v)&0xf) <= 0xb) && (((v)&0xf0) <= 0x90))
1274#define GRK_IMF_MAINLEVEL_1_MSAMPLESSEC 65U
1275#define GRK_IMF_MAINLEVEL_2_MSAMPLESSEC 130U
1276#define GRK_IMF_MAINLEVEL_3_MSAMPLESSEC 195U
1277#define GRK_IMF_MAINLEVEL_4_MSAMPLESSEC 260U
1278#define GRK_IMF_MAINLEVEL_5_MSAMPLESSEC 520U
1279#define GRK_IMF_MAINLEVEL_6_MSAMPLESSEC 1200U
1280#define GRK_IMF_MAINLEVEL_7_MSAMPLESSEC 2400U
1281#define GRK_IMF_MAINLEVEL_8_MSAMPLESSEC 4800U
1282#define GRK_IMF_MAINLEVEL_9_MSAMPLESSEC 9600U
1283#define GRK_IMF_MAINLEVEL_10_MSAMPLESSEC 19200U
1284#define GRK_IMF_MAINLEVEL_11_MSAMPLESSEC 38400U
1286#define GRK_IMF_SUBLEVEL_MAX 9U
1287#define GRK_GET_IMF_SUBLEVEL(v) (((v) >> 4) & 0xf)
1290#define GRK_IMF_SUBLEVEL_1_MBITSSEC 200U
1291#define GRK_IMF_SUBLEVEL_2_MBITSSEC 400U
1292#define GRK_IMF_SUBLEVEL_3_MBITSSEC 800U
1293#define GRK_IMF_SUBLEVEL_4_MBITSSEC 1600U
1294#define GRK_IMF_SUBLEVEL_5_MBITSSEC 3200U
1295#define GRK_IMF_SUBLEVEL_6_MBITSSEC 6400U
1296#define GRK_IMF_SUBLEVEL_7_MBITSSEC 12800U
1297#define GRK_IMF_SUBLEVEL_8_MBITSSEC 25600U
1298#define GRK_IMF_SUBLEVEL_9_MBITSSEC 51200U
1304#define GRK_CINEMA_24_CS 1302083U
1305#define GRK_CINEMA_48_CS 651041U
1306#define GRK_CINEMA_24_COMP 1041666U
1307#define GRK_CINEMA_48_COMP 520833U
1313#define GRK_CUSTOM_CIELAB_SPACE 0x0
1314#define GRK_DEFAULT_CIELAB_SPACE 0x44454600
1315#define GRK_CIE_DAY ((((uint32_t)'C') << 24) + (((uint32_t)'T') << 16))
1316#define GRK_CIE_D50 ((uint32_t)0x00443530)
1317#define GRK_CIE_D65 ((uint32_t)0x00443635)
1318#define GRK_CIE_D75 ((uint32_t)0x00443735)
1319#define GRK_CIE_SA ((uint32_t)0x00005341)
1320#define GRK_CIE_SC ((uint32_t)0x00005343)
1321#define GRK_CIE_F2 ((uint32_t)0x00004632)
1322#define GRK_CIE_F7 ((uint32_t)0x00004637)
1323#define GRK_CIE_F11 ((uint32_t)0x00463131)
1328#define GRK_RANDOM_ACCESS_PLT 1
1329#define GRK_RANDOM_ACCESS_TLM 2
1330#define GRK_RANDOM_ACCESS_PLM 4
1358#define GRK_PLUGIN_STATE_NO_DEBUG 0x0
1375#define GRK_PLUGIN_STATE_DEBUG 0x1
1376#define GRK_PLUGIN_STATE_PRE_TR1 0x2
1377#define GRK_PLUGIN_STATE_DWT_QUANTIZATION 0x4
1378#define GRK_PLUGIN_STATE_MCT_ONLY 0x8
1435 const char* output_dir,
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:208
@ GRK_FMT_BMP
Definition: grok.h:215
@ GRK_FMT_JP2
Definition: grok.h:211
@ GRK_FMT_J2K
Definition: grok.h:210
@ GRK_FMT_PNG
Definition: grok.h:218
@ GRK_FMT_RAWL
Definition: grok.h:219
@ GRK_FMT_UNK
Definition: grok.h:209
@ GRK_FMT_TIF
Definition: grok.h:216
@ GRK_FMT_JPG
Definition: grok.h:220
@ GRK_FMT_PXM
Definition: grok.h:212
@ GRK_FMT_RAW
Definition: grok.h:217
@ GRK_FMT_PAM
Definition: grok.h:214
@ GRK_FMT_PGX
Definition: grok.h:213
struct _grk_cparameters grk_cparameters
Compress parameters.
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:452
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:382
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_compress(void)
Stop batch compress.
Definition: grok.cpp:786
GRK_API grk_object *GRK_CALLCONV grk_object_ref(grk_object *obj)
Increment ref count.
Definition: grok.cpp:115
GRK_API grk_image *GRK_CALLCONV grk_image_new(uint16_t numcmpts, grk_image_comp *cmptparms, GRK_COLOR_SPACE clrspc)
Create image.
Definition: grok.cpp:192
GRK_API void GRK_CALLCONV grk_plugin_stop_batch_decompress(void)
Stop batch decompress.
Definition: grok.cpp:882
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:118
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:455
struct _grk_stream_params grk_stream_params
JPEG 2000 stream parameters - either file or buffer.
GRK_API void GRK_CALLCONV grk_plugin_cleanup(void)
Release plugin resources.
Definition: grok.cpp:692
GRK_API bool GRK_CALLCONV grk_plugin_load(grk_plugin_load_info info)
Load plugin.
Definition: grok.cpp:650
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:233
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:133
GRK_API uint32_t GRK_CALLCONV grk_plugin_get_debug_state()
Get debug state of plugin.
Definition: grok.cpp:677
struct _grk_precision grk_precision
Precision.
struct _grk_plugin_decompress_callback_info grk_plugin_decompress_callback_info
GRK_API void GRK_CALLCONV grk_decompress_set_default_params(grk_decompress_core_params *parameters)
Initialize decompress parameters with default values.
Definition: grok.cpp:287
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_decompress(void)
Initiate batch decompress.
Definition: grok.cpp:868
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:733
_GRK_CHANNEL_ASSOC
Definition: grok.h:286
@ GRK_CHANNEL_ASSOC_COLOUR_1
Definition: grok.h:289
@ GRK_CHANNEL_ASSOC_COLOUR_2
Definition: grok.h:290
@ GRK_CHANNEL_ASSOC_COLOUR_3
Definition: grok.h:291
@ GRK_CHANNEL_ASSOC_WHOLE_IMAGE
Definition: grok.h:288
@ GRK_CHANNEL_ASSOC_UNASSOCIATED
Definition: grok.h:292
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.
struct _grk_image_meta grk_image_meta
struct _grk_asoc grk_asoc
Association box info.
grk_object grk_codec
Definition: grok.h:746
enum _GRK_SUPPORTED_FILE_FMT GRK_SUPPORTED_FILE_FMT
All supported file formats.
#define GRK_J2K_MAXRLVLS
Definition: grok.h:232
struct _grk_palette_data grk_palette_data
Palette data.
GRK_API bool 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:544
#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:322
struct _grk_component_mapping_comp grk_component_mapping_comp
Note: "component" refers to an image component as decompressed from the code stream,...
GRK_API bool GRK_CALLCONV grk_decompress_buffer_detect_format(uint8_t *buffer, size_t len, GRK_CODEC_FORMAT *fmt)
Detect jpeg 2000 format from buffer Format is either GRK_FMT_J2K or GRK_FMT_JP2.
Definition: grok.cpp:207
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:480
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:109
struct grk_plugin_tile_component grk_plugin_tile_component
Plugin tile component.
GRK_API int32_t GRK_CALLCONV grk_plugin_batch_compress(const char *input_dir, const char *output_dir, grk_cparameters *compress_parameters, GRK_PLUGIN_COMPRESS_USER_CALLBACK callback)
Batch compress with plugin.
Definition: grok.cpp:749
GRK_API void GRK_CALLCONV grk_object_unref(grk_object *obj)
Definition: grok.cpp:124
#define GRK_MAX_LAYERS
Definition: grok.h:224
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:297
GRK_API void GRK_CALLCONV grk_compress_set_default_params(grk_cparameters *parameters)
Set compressing parameters to default values:
Definition: grok.cpp:451
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:187
_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:343
@ GRK_PREC_MODE_SCALE
Definition: grok.h:345
@ GRK_PREC_MODE_CLIP
Definition: grok.h:344
GRK_API grk_image_meta *GRK_CALLCONV grk_image_meta_new(void)
Definition: grok.cpp:198
bool(* GRK_PLUGIN_COMPRESS_USER_CALLBACK)(grk_plugin_compress_user_callback_info *info)
Definition: grok.h:1411
GRK_API bool GRK_CALLCONV grk_plugin_is_batch_complete(void)
Check if batch job is complete.
Definition: grok.cpp:771
enum _GRK_COLOR_SPACE GRK_COLOR_SPACE
Supported color spaces.
#define GRK_PATH_LEN
Definition: grok.h:223
GRK_API bool GRK_CALLCONV grk_decompress_set_window(grk_codec *codec, float start_x, float start_y, float end_x, float end_y)
Set the given area to be decompressed.
Definition: grok.cpp:336
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:833
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:421
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:371
_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:850
struct _grk_decompress_params grk_decompress_parameters
Decompression parameters.
_GRK_CHANNEL_TYPE
Definition: grok.h:275
@ GRK_CHANNEL_TYPE_OPACITY
Definition: grok.h:278
@ GRK_CHANNEL_TYPE_PREMULTIPLIED_OPACITY
Definition: grok.h:279
@ GRK_CHANNEL_TYPE_COLOUR
Definition: grok.h:277
@ GRK_CHANNEL_TYPE_UNSPECIFIED
Definition: grok.h:280
_GRK_RATE_CONTROL_ALGORITHM
Rate control algorithms GRK_RATE_CONTROL_BISECT: bisect with all truncation points GRK_RATE_CONTROL_P...
Definition: grok.h:199
@ GRK_RATE_CONTROL_PCRD_OPT
Definition: grok.h:201
@ GRK_RATE_CONTROL_BISECT
Definition: grok.h:200
GRK_API bool GRK_CALLCONV grk_decompress_tile(grk_codec *codec, uint16_t tileIndex)
Decompress a specific tile.
Definition: grok.cpp:360
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:1452
struct _grk_plugin_band grk_plugin_band
Plugin band.
_GRK_CODEC_FORMAT
Supported JPEG 2000 formats.
Definition: grok.h:511
@ GRK_CODEC_J2K
JPEG 2000 code stream : read/write.
Definition: grok.h:513
@ GRK_CODEC_JP2
JP2 file format : read/write.
Definition: grok.h:514
@ GRK_CODEC_UNK
place-holder
Definition: grok.h:512
struct _grk_plugin_tile grk_plugin_tile
Plugin tile.
#define GRK_CALLCONV
Definition: grok.h:45
GRK_API grk_image *GRK_CALLCONV grk_decompress_get_tile_image(grk_codec *codec, uint16_t tileIndex)
Get decompressed tile image.
Definition: grok.cpp:411
#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
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:451
struct _grk_header_info grk_header_info
Header info.
int32_t(* grk_plugin_decompress_callback)(grk_plugin_decompress_callback_info *info)
Definition: grok.h:1477
_GRK_TILE_CACHE_STRATEGY
Definition: grok.h:471
@ GRK_TILE_CACHE_IMAGE
Definition: grok.h:473
@ GRK_TILE_CACHE_NONE
Definition: grok.h:472
GRK_API bool GRK_CALLCONV grk_initialize(const char *pluginPath, uint32_t numthreads)
Initialize library.
Definition: grok.cpp:96
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:697
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:348
Association box info.
Definition: grok.h:332
const char * label
Definition: grok.h:334
uint8_t * xml
Definition: grok.h:335
uint32_t level
Definition: grok.h:333
uint32_t xml_len
Definition: grok.h:336
Channel definitions and number of definitions.
Definition: grok.h:310
uint16_t num_channel_descriptions
Definition: grok.h:312
grk_channel_description * descriptions
Definition: grok.h:311
Channel definition: channel index, type, association.
Definition: grok.h:300
uint16_t typ
Definition: grok.h:302
uint16_t asoc
Definition: grok.h:303
uint16_t channel
Definition: grok.h:301
ICC profile, palette, channel definition.
Definition: grok.h:319
grk_channel_definition * channel_definition
Definition: grok.h:323
char * icc_profile_name
Definition: grok.h:322
uint32_t icc_profile_len
Definition: grok.h:321
uint8_t * icc_profile_buf
Definition: grok.h:320
grk_palette_data * palette
Definition: grok.h:324
bool has_colour_specification_box
Definition: grok.h:325
Note: "component" refers to an image component as decompressed from the code stream,...
Definition: grok.h:247
uint8_t palette_column
Definition: grok.h:250
uint8_t mapping_type
Definition: grok.h:249
uint16_t component_index
Definition: grok.h:248
Compress parameters.
Definition: grok.h:912
uint32_t cblockw_init
initial code block width (default to 64)
Definition: grok.h:951
uint8_t numgbits
Definition: grok.h:941
char outfile[GRK_PATH_LEN]
output file name
Definition: grok.h:973
bool allocationByRateDistoration
rate control allocation by rate/distortion curve
Definition: grok.h:926
GRK_PROG_ORDER prog_order
progression order (default is LRCP)
Definition: grok.h:943
uint16_t comment_len[GRK_NUM_COMMENTS_SUPPORTED]
Definition: grok.h:935
uint32_t repeats
Definition: grok.h:1028
uint32_t numThreads
Definition: grok.h:1024
bool verbose
Definition: grok.h:1031
uint32_t image_offset_x0
subimage compressing: origin image offset in x direction
Definition: grok.h:975
uint64_t max_cs_size
Maximum size (in bytes) for the whole code stream.
Definition: grok.h:1007
grk_raw_cparameters raw_cp
Definition: grok.h:986
uint8_t numresolution
number of resolutions
Definition: grok.h:949
uint32_t image_offset_y0
subimage compressing: origin image offset in y direction
Definition: grok.h:977
GRK_SUPPORTED_FILE_FMT decod_format
input file format
Definition: grok.h:983
uint8_t newTilePartProgressionDivider
new tile part progression divider
Definition: grok.h:995
uint32_t cblockh_init
initial code block height (default to 64)
Definition: grok.h:953
GRK_RATE_CONTROL_ALGORITHM rateControlAlgorithm
Definition: grok.h:1023
bool allocationByQuality
rate control allocation by fixed_PSNR quality
Definition: grok.h:931
uint32_t roi_shift
region of interest: upshift value
Definition: grok.h:963
uint8_t subsampling_dy
subsampling value for dy
Definition: grok.h:981
bool tile_size_on
size of tile: tile_size_on = false (not in argument) or = true (in argument)
Definition: grok.h:914
uint32_t t_height
YTsiz.
Definition: grok.h:922
bool write_capture_resolution_from_file
Definition: grok.h:1014
bool enableTilePartGeneration
Tile part generation.
Definition: grok.h:993
uint32_t res_spec
Definition: grok.h:965
uint8_t mct
MCT (multiple component transform)
Definition: grok.h:997
uint16_t numlayers
number of layers
Definition: grok.h:924
int32_t deviceId
Definition: grok.h:1025
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition: grok.h:985
double capture_resolution_from_file[2]
Definition: grok.h:1015
uint32_t max_comp_size
Maximum size (in bytes) for each component.
Definition: grok.h:991
bool irreversible
1 : use the irreversible DWT 9-7, 0 : use lossless compression (default)
Definition: grok.h:958
uint32_t t_width
XTsiz.
Definition: grok.h:920
bool write_display_resolution
Definition: grok.h:1020
uint8_t cblk_sty
code block style
Definition: grok.h:955
uint8_t csty
csty : coding style
Definition: grok.h:939
uint32_t prch_init[GRK_J2K_MAXRLVLS]
initial precinct height
Definition: grok.h:969
bool is_binary_comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition: grok.h:936
uint16_t rsiz
RSIZ value To be used to combine GRK_PROFILE_*, GRK_EXTENSION_* and (sub)levels values.
Definition: grok.h:1010
char infile[GRK_PATH_LEN]
input file name
Definition: grok.h:971
double layer_distortion[GRK_MAX_LAYERS]
layer PSNR values
Definition: grok.h:933
void * mct_data
Naive implementation of MCT restricted to a single reversible array based compressing without offset ...
Definition: grok.h:1000
uint32_t tx0
XTOsiz.
Definition: grok.h:916
char * comment[GRK_NUM_COMMENTS_SUPPORTED]
Definition: grok.h:934
bool write_capture_resolution
Definition: grok.h:1017
uint8_t subsampling_dx
subsampling value for dx
Definition: grok.h:979
bool writeTLM
Definition: grok.h:1030
uint32_t prcw_init[GRK_J2K_MAXRLVLS]
initial precinct width
Definition: grok.h:967
size_t num_comments
Definition: grok.h:937
uint16_t framerate
Definition: grok.h:1011
double display_resolution[2]
Definition: grok.h:1021
bool writePLT
Definition: grok.h:1029
int32_t roi_compno
region of interest: affected component in [0..3]; -1 indicates no ROI
Definition: grok.h:961
uint32_t ty0
YTOsiz.
Definition: grok.h:918
uint32_t duration
Definition: grok.h:1026
double layer_rate[GRK_MAX_LAYERS]
layers rates expressed as compression ratios.
Definition: grok.h:929
uint32_t kernelBuildOptions
Definition: grok.h:1027
grk_progression progression[GRK_J2K_MAXRLVLS]
progressions
Definition: grok.h:945
uint32_t numpocs
number of progression order changes (POCs), default to 0
Definition: grok.h:947
double capture_resolution[2]
Definition: grok.h:1018
Core decompression parameters.
Definition: grok.h:480
uint32_t randomAccessFlags_
Definition: grok.h:498
grk_io_pixels_callback io_buffer_callback
Definition: grok.h:500
GRK_TILE_CACHE_STRATEGY tileCacheStrategy
Definition: grok.h:496
void * io_user_data
Definition: grok.h:501
uint8_t reduce
Set the number of highest resolution levels to be discarded.
Definition: grok.h:488
uint16_t max_layers
Set the maximum number of quality layers to decompress.
Definition: grok.h:495
grk_io_register_reclaim_callback io_register_client_callback
Definition: grok.h:502
Decompression parameters.
Definition: grok.h:521
float dw_y1
Decompress window bottom boundary.
Definition: grok.h:539
int32_t deviceId
Definition: grok.h:561
float dw_x0
Decompress window left boundary.
Definition: grok.h:533
bool io_xml
Definition: grok.h:552
grk_precision * precision
Definition: grok.h:543
uint32_t numThreads
Definition: grok.h:565
GRK_SUPPORTED_FILE_FMT cod_format
output file format
Definition: grok.h:531
uint32_t kernelBuildOptions
Definition: grok.h:563
char infile[GRK_PATH_LEN]
input file name
Definition: grok.h:525
uint32_t compressionLevel
Definition: grok.h:558
bool force_rgb
Definition: grok.h:546
uint32_t compression
Definition: grok.h:553
bool singleTileDecompress
Definition: grok.h:542
uint32_t repeats
Definition: grok.h:564
bool upsample
Definition: grok.h:548
grk_decompress_core_params core
core library parameters
Definition: grok.h:523
uint16_t tileIndex
tile number of the decompressed tile
Definition: grok.h:541
bool verbose_
Verbose mode.
Definition: grok.h:560
uint32_t duration
Definition: grok.h:562
float dw_y0
Decompress window up boundary.
Definition: grok.h:537
uint32_t numPrecision
Definition: grok.h:544
bool split_pnm
Definition: grok.h:550
GRK_CODEC_FORMAT decod_format
input file format
Definition: grok.h:529
float dw_x1
Decompress window right boundary.
Definition: grok.h:535
char outfile[GRK_PATH_LEN]
output file name
Definition: grok.h:527
Image component.
Definition: grok.h:572
uint32_t h
data height
Definition: grok.h:582
uint8_t dy
YRsiz: vertical separation of a sample of component with respect to the reference grid.
Definition: grok.h:588
GRK_CHANNEL_ASSOC association
Definition: grok.h:594
GRK_CHANNEL_TYPE type
Definition: grok.h:593
uint8_t dx
XRsiz: horizontal separation of a sample of component with respect to the reference grid.
Definition: grok.h:585
bool sgnd
Definition: grok.h:592
uint32_t w
data width
Definition: grok.h:578
uint8_t prec
precision
Definition: grok.h:590
uint16_t Ycrg
Definition: grok.h:596
int32_t * data
image component data
Definition: grok.h:598
uint32_t x0
x component offset compared to the whole image
Definition: grok.h:574
uint16_t Xcrg
Definition: grok.h:596
uint32_t y0
y component offset compared to the whole image
Definition: grok.h:576
uint32_t stride
data stride
Definition: grok.h:580
uint16_t decompressNumComps
Definition: grok.h:641
grk_precision * precision
Definition: grok.h:637
bool has_capture_resolution
Definition: grok.h:630
uint16_t numcomps
number of components in the image
Definition: grok.h:626
uint64_t packedRowBytes
Definition: grok.h:649
uint32_t y0
YOsiz: vertical offset from the origin of the reference grid to the top side of the image area.
Definition: grok.h:620
GRK_COLOR_SPACE color_space
Definition: grok.h:627
bool upsample
Definition: grok.h:636
grk_image_comp * comps
Definition: grok.h:651
bool splitByComponent
Definition: grok.h:640
bool channelDefinitionApplied_
Definition: grok.h:629
uint32_t decompressWidth
Definition: grok.h:642
grk_io_buf interleavedData
Definition: grok.h:646
GRK_COLOR_SPACE decompressColourSpace
Definition: grok.h:645
bool hasMultipleTiles
Definition: grok.h:639
uint32_t x0
XOsiz: horizontal offset from the origin of the reference grid to the left side of the image area.
Definition: grok.h:617
uint8_t decompressPrec
Definition: grok.h:644
grk_object obj
Definition: grok.h:614
uint32_t numPrecision
Definition: grok.h:638
bool has_display_resolution
Definition: grok.h:632
double display_resolution[2]
Definition: grok.h:633
uint32_t y1
Ysiz: height of the reference grid.
Definition: grok.h:624
double capture_resolution[2]
Definition: grok.h:631
grk_image_meta * meta
Definition: grok.h:650
uint32_t x1
Xsiz: width of the reference grid.
Definition: grok.h:622
GRK_SUPPORTED_FILE_FMT decompressFormat
Definition: grok.h:634
bool forceRGB
Definition: grok.h:635
uint32_t rowsPerTask
Definition: grok.h:648
uint32_t rowsPerStrip
Definition: grok.h:647
uint32_t decompressHeight
Definition: grok.h:643
bool paletteApplied_
Definition: grok.h:628
uint64_t offset_
Definition: grok.h:438
uint64_t allocLen_
Definition: grok.h:440
uint64_t len_
Definition: grok.h:439
bool pooled_
Definition: grok.h:441
uint8_t * data_
Definition: grok.h:437
uint32_t index_
Definition: grok.h:442
uint32_t maxPooledRequests_
Definition: grok.h:447
Grok ref-counted object.
Definition: grok.h:126
void * wrapper
Definition: grok.h:127
Palette data.
Definition: grok.h:257
grk_component_mapping_comp * component_mapping
Definition: grok.h:260
uint8_t num_channels
Definition: grok.h:261
int32_t * lut
Definition: grok.h:258
uint16_t num_entries
Definition: grok.h:259
bool * channel_sign
Definition: grok.h:262
uint8_t * channel_prec
Definition: grok.h:263
Plugin band.
Definition: grok.h:700
float stepsize
Definition: grok.h:704
uint8_t orientation
Definition: grok.h:701
uint64_t numPrecincts
Definition: grok.h:702
grk_plugin_precinct ** precincts
Definition: grok.h:703
Plugin code block.
Definition: grok.h:671
uint8_t * compressedData
Definition: grok.h:679
uint32_t y0
Definition: grok.h:675
size_t numPasses
Definition: grok.h:682
unsigned int sortedIndex
Definition: grok.h:684
uint8_t numBitPlanes
Definition: grok.h:681
grk_plugin_pass passes[67]
Definition: grok.h:683
uint32_t x0
Definition: grok.h:675
unsigned int * contextStream
Definition: grok.h:676
uint32_t y1
Definition: grok.h:675
uint32_t numPix
Definition: grok.h:678
uint32_t x1
Definition: grok.h:675
uint32_t compressedDataLength
Definition: grok.h:680
grk_codec * codec
Definition: grok.h:1464
uint32_t full_image_y0
Definition: grok.h:1473
GRK_CODEC_FORMAT decod_format
Definition: grok.h:1461
unsigned int error_code
Definition: grok.h:1470
grk_decompress_parameters * decompressor_parameters
Definition: grok.h:1466
grk_header_info header_info
Definition: grok.h:1465
GRK_SUPPORTED_FILE_FMT cod_format
Definition: grok.h:1463
size_t deviceId
Definition: grok.h:1456
grk_plugin_tile * tile
Definition: grok.h:1469
uint32_t full_image_x0
Definition: grok.h:1472
void * user_data
Definition: grok.h:1474
bool plugin_owns_image
Definition: grok.h:1468
uint32_t decompress_flags
Definition: grok.h:1471
const char * output_file_name
Definition: grok.h:1459
GROK_INIT_DECOMPRESSORS init_decompressors_func
Definition: grok.h:1457
const char * input_file_name
Definition: grok.h:1458
grk_image * image
Definition: grok.h:1467
bool verbose
Definition: grok.h:1390
int32_t deviceId
Definition: grok.h:1389
const char * pluginPath
Definition: grok.h:1341
Plugin pass.
Definition: grok.h:661
size_t rate
Definition: grok.h:663
size_t length
Definition: grok.h:664
double distortionDecrease
Definition: grok.h:662
Plugin precinct.
Definition: grok.h:691
grk_plugin_code_block ** blocks
Definition: grok.h:693
uint64_t numBlocks
Definition: grok.h:692
Plugin resolution.
Definition: grok.h:711
size_t numBands
Definition: grok.h:713
size_t level
Definition: grok.h:712
grk_plugin_band ** band
Definition: grok.h:714
Plugin tile.
Definition: grok.h:739
uint32_t decompress_flags
Definition: grok.h:740
grk_plugin_tile_component ** tileComponents
Definition: grok.h:742
size_t numComponents
Definition: grok.h:741
Precision.
Definition: grok.h:352
grk_precision_mode mode
Definition: grok.h:354
uint8_t prec
Definition: grok.h:353
Progression order change.
Definition: grok.h:135
uint16_t comp_temp
Definition: grok.h:166
uint32_t tx1
Definition: grok.h:143
uint32_t tp_txE
Definition: grok.h:161
uint8_t res_temp
Definition: grok.h:167
GRK_PROG_ORDER specifiedCompressionPocProg
Definition: grok.h:138
uint32_t tx0
tile dimensions
Definition: grok.h:141
uint16_t compE
Definition: grok.h:147
uint8_t resS
Definition: grok.h:148
uint64_t prec_temp
Definition: grok.h:168
uint32_t tp_tyE
Definition: grok.h:163
uint64_t precE
Definition: grok.h:151
uint64_t precS
Definition: grok.h:150
uint32_t ty0
Definition: grok.h:142
uint32_t ty1
Definition: grok.h:144
uint32_t ty0_temp
Definition: grok.h:171
uint16_t tpCompE
Definition: grok.h:155
uint32_t tp_tyS
Definition: grok.h:162
uint32_t dy
Definition: grok.h:165
GRK_PROG_ORDER progression
Definition: grok.h:136
uint32_t dx
Definition: grok.h:164
uint16_t layE
Definition: grok.h:153
uint16_t layS
Definition: grok.h:152
char progressionString[5]
Definition: grok.h:137
uint8_t tpResE
Definition: grok.h:157
uint32_t tx0_temp
Definition: grok.h:170
uint32_t tileno
Definition: grok.h:139
uint16_t lay_temp
Definition: grok.h:169
uint16_t tpLayE
Definition: grok.h:159
uint64_t tpPrecE
Definition: grok.h:158
uint16_t tpCompS
Definition: grok.h:154
uint16_t compS
progression order bounds specified by POC
Definition: grok.h:146
uint32_t tp_txS
Definition: grok.h:160
uint8_t resE
Definition: grok.h:149
uint8_t tpResS
Definition: grok.h:156
RAW component compress parameters.
Definition: grok.h:176
uint8_t dy
subsampling in X direction
Definition: grok.h:178
uint8_t dx
Definition: grok.h:177
RAW image compress parameters.
Definition: grok.h:184
uint8_t prec
number of components of the raw image
Definition: grok.h:188
uint32_t width
Definition: grok.h:185
uint16_t numcomps
height of the raw image
Definition: grok.h:187
grk_raw_comp_cparameters * comps
signed/unsigned raw image
Definition: grok.h:190
bool sgnd
bit depth of the raw image
Definition: grok.h:189
uint32_t height
width of the raw image
Definition: grok.h:186
JPEG 2000 stream parameters - either file or buffer.
Definition: grok.h:461
uint8_t * buf
Definition: grok.h:466
size_t len
Definition: grok.h:467
const char * file
Definition: grok.h:463
bool outputFileNameIsRelative
Definition: grok.h:1401
grk_cparameters * compressor_parameters
Definition: grok.h:1403
grk_image * image
Definition: grok.h:1404
grk_plugin_tile * tile
Definition: grok.h:1405
const char * output_file_name
Definition: grok.h:1402
bool transferExifTags
Definition: grok.h:1408
grk_stream_params stream_params
Definition: grok.h:1406
unsigned int error_code
Definition: grok.h:1407
const char * input_file_name
Definition: grok.h:1400
Plugin tile component.
Definition: grok.h:721
grk_plugin_resolution ** resolutions
Definition: grok.h:723
size_t numResolutions
Definition: grok.h:722