Crate grokj2k_sys[][src]

Re-exports

pub use self::_GRK_PROG_ORDER as GRK_PROG_ORDER;
pub use self::_GRK_COLOR_SPACE as GRK_COLOR_SPACE;
pub use self::_GRK_CODEC_FORMAT as GRK_CODEC_FORMAT;
pub use self::grk_prec_mode as grk_precision_mode;

Structs

_grk_channel_definition

Channel definitions and number of definitions

_grk_channel_description

Channel definition: channel index, type, association

_grk_component_mapping_comp

Component mappings: component index, mapping type, palette column

_grk_cparameters

Compress parameters

_grk_decompress_params

Decompress parameters

_grk_dparameters

Core decompress parameters

_grk_header_info

Header info

_grk_image
_grk_image_comp

Image component

_grk_image_comptparm

Image component parameters

_grk_image_meta
_grk_object

Base Grok ref-counted object

_grk_palette_data

Palette data

_grk_plugin_band

Plugin band

_grk_plugin_code_block

Plugin code block

_grk_plugin_decompress_callback_info
_grk_plugin_init_info
_grk_plugin_load_info

Plugin Interface

_grk_plugin_pass

Plugin pass

_grk_plugin_precinct

Plugin precinct

_grk_plugin_resolution

Plugin resolution

_grk_plugin_tile

Plugin tile

_grk_prec

Precision

_grk_progression

Progression order change

_grk_raw_comp_cparameters
_grk_raw_cparameters
grk_asoc
grk_color

ICC profile, palette, channel definition

grk_plugin_compress_user_callback_info
grk_plugin_tile_component

Plugin tile component

Constants

GRK_BMP_FMT
GRK_CLRSPC_CMYK

< CMYK

GRK_CLRSPC_CUSTOM_CIE

< custom CIE LAB

GRK_CLRSPC_DEFAULT_CIE

< default CIE LAB

GRK_CLRSPC_EYCC

< extended YCC

GRK_CLRSPC_GRAY

< grayscale

GRK_CLRSPC_ICC

< ICC profile

GRK_CLRSPC_SRGB

< sRGB

GRK_CLRSPC_SYCC

< standard YCC (YUV)

GRK_CLRSPC_UNKNOWN

< unknown

GRK_CODEC_J2K

< JPEG 2000 code stream : read/write

GRK_CODEC_JP2

< JP2 file format : read/write

GRK_CODEC_UNKNOWN

< place-holder

GRK_COMPONENT_ASSOC_COLOUR_1
GRK_COMPONENT_ASSOC_COLOUR_2
GRK_COMPONENT_ASSOC_COLOUR_3
GRK_COMPONENT_ASSOC_UNASSOCIATED
GRK_COMPONENT_ASSOC_WHOLE_IMAGE
GRK_COMPONENT_TYPE_COLOUR
GRK_COMPONENT_TYPE_OPACITY
GRK_COMPONENT_TYPE_PREMULTIPLIED_OPACITY
GRK_COMPONENT_TYPE_UNSPECIFIED
GRK_CPRL

< component-precinct-resolution-layer order

GRK_J2K_FMT
GRK_JP2_FMT
GRK_JPG_FMT
GRK_LRCP

< layer-resolution-component-precinct order

GRK_NUM_PROGRESSION_ORDERS
GRK_PAM_FMT
GRK_PCRL

< precinct-component-resolution-layer order

GRK_PGX_FMT
GRK_PNG_FMT
GRK_PREC_MODE_CLIP
GRK_PREC_MODE_SCALE
GRK_PROG_UNKNOWN

< place-holder

GRK_PXM_FMT
GRK_RAWL_FMT
GRK_RAW_FMT
GRK_RLCP

< resolution-layer-component-precinct order

GRK_RPCL

< resolution-precinct-component-layer order

GRK_TIF_FMT
GRK_TILE_CACHE_ALL
GRK_TILE_CACHE_NONE
GRK_UNK_FMT

Functions

grk_compress

Encode an image into a JPEG 2000 code stream @param codec compressor handle

grk_compress_create

Creates a J2K/JP2 compression structure @param format Coder to select @param stream the JPEG 2000 stream. @return Returns a handle to a compressor if successful, returns nullptr otherwise

grk_compress_end

End to compress the current image. @param codec Compressor handle

grk_compress_init

Set up the compressor parameters using the current image and user parameters.

grk_compress_set_default_params

Set compressing parameters to default values, that means :

grk_compress_start

Start compressing current image.

grk_compress_tile

Compress uncompressed data stored in a buffer. This method should be called right after grk_compress_start, and before grk_end_compress.

grk_compress_with_plugin

Encode an image into a JPEG 2000 code stream using plugin @param codec compressor handle @param tile plugin tile

grk_decompress

Decompress image from a JPEG 2000 code stream

grk_decompress_create

Create J2K/JP2 decompression structure

grk_decompress_end

End decompression

grk_decompress_get_composited_image

Get decompressed composite image

grk_decompress_get_tile_image

Get decompressed tile image

grk_decompress_init

Set up the decompressor with decompress parameters

grk_decompress_read_header

Decompress JPEG 2000 header

grk_decompress_set_default_params

Initialize decompress parameters with default values

grk_decompress_set_window

Set the given area to be decompressed. This function should be called right after grk_decompress_read_header is called, and before any tile header is read.

grk_decompress_tile

Decompress a specific tile

grk_deinitialize

De-initialize library

grk_dump_codec

Dump codec information to file

grk_image_all_components_data_free

Deallocate all component data for an image

grk_image_meta_new
grk_image_new

Create image

grk_image_single_component_data_free

Deallocate data for single image component

grk_initialize

Initialize library

grk_object_ref

Increment ref count

grk_object_unref
grk_plugin_batch_compress

Batch compress with plugin

grk_plugin_batch_decompress

Batch decompress

grk_plugin_cleanup

Release plugin resources

grk_plugin_compress

Compress with plugin

grk_plugin_decompress

Decompress with plugin

grk_plugin_get_debug_state

Get debug state of plugin

grk_plugin_init

Initialize plugin

grk_plugin_init_batch_decompress

Initialize batch decompress

grk_plugin_is_batch_complete

Check if batch job is complete

grk_plugin_load

Load plugin

grk_plugin_stop_batch_compress

Stop batch compress

grk_plugin_stop_batch_decompress

Stop batch decompress

grk_set_MCT

Set the MCT matrix to use.

grk_set_error_handler

Set error handler

grk_set_info_handler

Set info handler

grk_set_warning_handler

Set warning handler

grk_stream_create_file_stream

Create stream from a file identified with its filename with a specific buffer size

grk_stream_create_mapped_file_stream

Create mapped file stream

grk_stream_create_mem_stream

Create stream from buffer

grk_stream_get_write_mem_stream_length

Get length of memory stream

grk_stream_new

Create an abstract stream. This function does nothing except allocate memory and initialize abstract stream.

grk_stream_set_read_function

Set the given function to be used as a read function.

grk_stream_set_seek_function

Set the given function to be used as a seek function, the stream is then seekable.

grk_stream_set_user_data

Set the given data to be used as a user data for the stream.

grk_stream_set_user_data_length

Set the length of the user data for the stream.

grk_stream_set_write_function

Set the given function to be used as a write function.

grk_version

library version

Type Definitions

GRK_COMPONENT_ASSOC
GRK_COMPONENT_TYPE
GRK_PLUGIN_COMPRESS_USER_CALLBACK
GRK_SUPPORTED_FILE_FMT
GRK_TILE_CACHE_STRATEGY
GROK_INIT_DECOMPRESSORS
_GRK_CODEC_FORMAT

Supported codecs

_GRK_COLOR_SPACE

Supported image color spaces

_GRK_PROG_ORDER

Progression order

grk_channel_definition

Channel definitions and number of definitions

grk_channel_description

Channel definition: channel index, type, association

grk_codec
grk_component_mapping_comp

Component mappings: component index, mapping type, palette column

grk_cparameters

Compress parameters

grk_decompress_parameters

Decompress parameters

grk_dparameters

Core decompress parameters

grk_header_info

Header info

grk_image
grk_image_cmptparm

Image component parameters

grk_image_comp

Image component

grk_image_meta
grk_msg_callback

Callback function prototype for logging

grk_object

Base Grok ref-counted object

grk_palette_data

Palette data

grk_plugin_band

Plugin band

grk_plugin_code_block

Plugin code block

grk_plugin_decompress_callback
grk_plugin_decompress_callback_info
grk_plugin_init_info
grk_plugin_load_info

Plugin Interface

grk_plugin_pass

Plugin pass

grk_plugin_precinct

Plugin precinct

grk_plugin_resolution

Plugin resolution

grk_plugin_tile

Plugin tile

grk_prec_mode

Precision mode

grk_precision

Precision

grk_progression

Progression order change

grk_raw_comp_cparameters
grk_raw_cparameters
grk_stream
grk_stream_free_user_data_fn
grk_stream_read_fn
grk_stream_seek_fn
grk_stream_write_fn