Crate openjpeg_sys

Source

Structs§

opj_codestream_index
Index structure of the codestream (FIXME should be expand and enhance)
opj_codestream_info
Index structure of the codestream
opj_codestream_info_v2
Information structure about the codestream (FIXME should be expand and enhance)
opj_cparameters
Compression parameters
opj_dparameters
Decompression parameters
opj_image
Defines image data and characteristics
opj_image_comp
Defines a single image component
opj_image_comptparm
Component parameters structure used by the opj_image_create function
opj_jp2_index
Index structure of the JP2 file EXPERIMENTAL FOR THE MOMENT
opj_jp2_metadata
Info structure of the JP2 file EXPERIMENTAL FOR THE MOMENT
opj_marker_info
Marker structure
opj_packet_info
Index structure : Information concerning a packet inside tile
opj_poc
Progression order changes
opj_tccp_info
Tile-component coding parameters information
opj_tile_index
Index structure about a tile
opj_tile_info
Index structure : information regarding tiles
opj_tile_v2_info
Tile coding parameters information
opj_tp_index
Index structure about a tile part
opj_tp_info
Index structure : Information concerning tile-parts

Enums§

CINEMA_MODE
DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Digital cinema operation mode
CODEC_FORMAT
Supported codec
COLOR_SPACE
Supported image color spaces
OPJ_CINEMA_MODE
DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Digital cinema operation mode DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Digital cinema operation mode
OPJ_CODEC_FORMAT
Supported codec Supported codec
OPJ_COLOR_SPACE
Supported image color spaces Supported image color spaces
OPJ_PROG_ORDER
Progression order Progression order
OPJ_RSIZ_CAPABILITIES
DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Rsiz Capabilities DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Rsiz Capabilities
PROG_ORDER
Progression order
RSIZ_CAPABILITIES
DEPRECATED: use RSIZ, OPJ_PROFILE_* and OPJ_EXTENSION_* instead Rsiz Capabilities

Constants§

OPJ_CINEMA_24_COMP
OPJ_CINEMA_24_CS
OPJ_CINEMA_48_COMP
OPJ_CINEMA_48_CS
OPJ_DPARAMETERS_DUMP_FLAG
OPJ_DPARAMETERS_IGNORE_PCLR_CMAP_CDEF_FLAG
OPJ_EXTENSION_MCT
OPJ_EXTENSION_NONE
OPJ_FALSE
OPJ_HAVE_STDINT_H
OPJ_IMF_MAINLEVEL_1_MSAMPLESEC
OPJ_IMF_MAINLEVEL_2_MSAMPLESEC
OPJ_IMF_MAINLEVEL_3_MSAMPLESEC
OPJ_IMF_MAINLEVEL_4_MSAMPLESEC
OPJ_IMF_MAINLEVEL_5_MSAMPLESEC
OPJ_IMF_MAINLEVEL_6_MSAMPLESEC
OPJ_IMF_MAINLEVEL_7_MSAMPLESEC
OPJ_IMF_MAINLEVEL_8_MSAMPLESEC
OPJ_IMF_MAINLEVEL_9_MSAMPLESEC
OPJ_IMF_MAINLEVEL_10_MSAMPLESEC
OPJ_IMF_MAINLEVEL_11_MSAMPLESEC
OPJ_IMF_MAINLEVEL_MAX
OPJ_IMF_SUBLEVEL_1_MBITSSEC
OPJ_IMF_SUBLEVEL_2_MBITSSEC
OPJ_IMF_SUBLEVEL_3_MBITSSEC
OPJ_IMF_SUBLEVEL_4_MBITSSEC
OPJ_IMF_SUBLEVEL_5_MBITSSEC
OPJ_IMF_SUBLEVEL_6_MBITSSEC
OPJ_IMF_SUBLEVEL_7_MBITSSEC
OPJ_IMF_SUBLEVEL_8_MBITSSEC
OPJ_IMF_SUBLEVEL_9_MBITSSEC
OPJ_IMG_INFO
OPJ_J2K_DEFAULT_HEADER_SIZE
OPJ_J2K_DEFAULT_NB_SEGS
OPJ_J2K_MAXBANDS
OPJ_J2K_MAXRLVLS
OPJ_J2K_MCC_DEFAULT_NB_RECORDS
OPJ_J2K_MCT_DEFAULT_NB_RECORDS
OPJ_J2K_MH_IND
OPJ_J2K_MH_INFO
OPJ_J2K_STREAM_CHUNK_SIZE
OPJ_J2K_TCH_INFO
OPJ_J2K_TH_IND
OPJ_J2K_TH_INFO
OPJ_JP2_IND
OPJ_JP2_INFO
OPJ_PATH_LEN
OPJ_PROFILE_0
OPJ_PROFILE_1
OPJ_PROFILE_BC_MULTI
OPJ_PROFILE_BC_MULTI_R
OPJ_PROFILE_BC_SINGLE
OPJ_PROFILE_CINEMA_2K
OPJ_PROFILE_CINEMA_4K
OPJ_PROFILE_CINEMA_LTS
OPJ_PROFILE_CINEMA_S2K
OPJ_PROFILE_CINEMA_S4K
OPJ_PROFILE_IMF_2K
OPJ_PROFILE_IMF_2K_R
OPJ_PROFILE_IMF_4K
OPJ_PROFILE_IMF_4K_R
OPJ_PROFILE_IMF_8K
OPJ_PROFILE_IMF_8K_R
OPJ_PROFILE_NONE
OPJ_PROFILE_PART2
OPJ_STREAM_READ
OPJ_STREAM_WRITE
OPJ_TRUE
OPJ_VERSION_BUILD
OPJ_VERSION_MAJOR
OPJ_VERSION_MINOR

Functions§

opj_codec_set_threads
Allocates worker threads for the compressor/decompressor. By default, only the main thread is used. If this function is not used, but the OPJ_NUM_THREADS environment variable is set, its value will be used to initialize the number of threads. The value can be either an integer number, or “ALL_CPUS”. If OPJ_NUM_THREADS is set and this function is called, this function will override the behaviour of the environment variable. This function must be called after opj_setup_decoder() and before opj_read_header() for the decoding side, or after opj_setup_encoder() and before opj_start_compress() for the encoding side.
opj_create_compress
Creates a J2K/JP2 compression structure
opj_create_decompress
Creates a J2K/JP2 decompression structure
opj_decode
Decode an image from a JPEG-2000 codestream
opj_decode_tile_data
Reads a tile data. This function is compulsory and allows one to decode tile data. opj_read_tile_header should be called before. The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile. Note: opj_decode_tile_data() should not be used together with opj_set_decoded_components().
opj_decoder_set_strict_mode
Set strict decoding parameter for this decoder. If strict decoding is enabled, partial bit streams will fail to decode, and the check for invalid TPSOT values added in https://github.com/uclouvain/openjpeg/pull/514 will be disabled. If strict decoding is disabled, the decoder will decode partial bitstreams as much as possible without erroring, and the TPSOT fixing logic will be enabled.
opj_destroy_codec
Destroy a decompressor handle
opj_destroy_cstr_index
opj_destroy_cstr_info
Destroy Codestream information after compression or decompression
opj_dump_codec
Dump the codec information into the output stream
opj_encode
Encode an image into a JPEG-2000 codestream
opj_encoder_set_extra_options
Specify extra options for the encoder. This may be called after opj_setup_encoder() and before opj_start_compress() This is the way to add new options in a fully ABI compatible way, without extending the opj_cparameters_t structure. Currently supported options are:
opj_end_compress
End to compress the current image.
opj_end_decompress
Read after the codestream if necessary
opj_get_cstr_index
Get the codestream index from the codec
opj_get_cstr_info
Get the codestream information from the codec
opj_get_decoded_tile
Get the decoded tile from the codec
opj_get_jp2_index
Get the JP2 file index from the codec FIXME
opj_get_jp2_metadata
Get the JP2 file information from the codec FIXME
opj_get_num_cpus
Return the number of virtual CPUs
opj_has_thread_support
Returns if the library is built with thread support. OPJ_TRUE if mutex, condition, thread, thread pool are available.
opj_image_create
Create an image
opj_image_data_alloc
Allocator for opj_image_t->comps[].data To be paired with opj_image_data_free.
opj_image_data_free
Destructor for opj_image_t->comps[].data To be paired with opj_image_data_alloc.
opj_image_destroy
Deallocate any resources associated with an image
opj_image_tile_create
Creates an image without allocating memory for the image (used in the new version of the library).
opj_read_header
Decodes an image header.
opj_read_tile_header
Reads a tile header. This function is compulsory and allows one to know the size of the tile that will be decoded. The user may need to refer to the image got by opj_read_header to understand the size being taken by the tile.
opj_set_MCT
Sets the MCT matrix to use.
opj_set_decode_area
Sets the given area to be decoded. This function should be called right after opj_read_header and before any tile header reading. The coordinates passed to this function should be expressed in the reference grid, that is to say at the highest resolution level, even if requesting the image at lower resolution levels. Generally opj_set_decode_area() should be followed by opj_decode(), and the codec cannot be re-used. In the particular case of an image made of a single tile, several sequences of calls to opoj_set_decode_area() and opj_decode() are allowed, and will bring performance improvements when reading an image by chunks.
opj_set_decoded_components
Restrict the number of components to decode. This function should be called after opj_read_header(). This function enables to restrict the set of decoded components to the specified indices. Note that the current implementation (apply_color_transforms == OPJ_FALSE) is such that neither the multi-component transform at codestream level, nor JP2 channel transformations will be applied. Consequently the indices are relative to the codestream. Note: opj_decode_tile_data() should not be used together with opj_set_decoded_components().
opj_set_decoded_resolution_factor
Set the resolution factor of the decoded image
opj_set_default_decoder_parameters
Set decoding parameters to default values
opj_set_default_encoder_parameters
Set encoding parameters to default values, that means :
opj_set_error_handler
Set the error handler use by openjpeg.
opj_set_info_handler
Set the info handler use by openjpeg.
opj_set_warning_handler
Set the warning handler use by openjpeg.
opj_setup_decoder
Setup the decoder with decompression parameters provided by the user and with the message handler provided by the user.
opj_setup_encoder
Setup the encoder parameters using the current image and using user parameters.
opj_start_compress
Start to compress the current image.
opj_stream_create
Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
opj_stream_create_default_file_stream
Create a stream from a file identified with its filename with default parameters (helper function)
opj_stream_create_file_stream
Create a stream from a file identified with its filename with a specific buffer size
opj_stream_default_create
Creates an abstract stream. This function does nothing except allocating memory and initializing the abstract stream.
opj_stream_destroy
Destroys a stream created by opj_create_stream. This function does NOT close the abstract stream. If needed the user must close its own implementation of the stream.
opj_stream_set_read_function
Sets the given function to be used as a read function.
opj_stream_set_seek_function
Sets the given function to be used as a seek function, the stream is then seekable, using SEEK_SET behavior.
opj_stream_set_skip_function
Sets the given function to be used as a skip function.
opj_stream_set_user_data
Sets the given data to be used as a user data for the stream.
opj_stream_set_user_data_length
Sets the length of the user data for the stream.
opj_stream_set_write_function
Sets the given function to be used as a write function.
opj_version
opj_write_tile
Writes a tile with the given data.

Type Aliases§

OPJ_BOOL
OPJ_BYTE
OPJ_CHAR
OPJ_FLOAT32
OPJ_INT32
OPJ_OFF_T
OPJ_SIZE_T
OPJ_UINT16
OPJ_UINT32
OPJ_UINT64
opj_codec_t
JPEG2000 codec V2.
opj_codestream_index_t
Index structure of the codestream (FIXME should be expand and enhance)
opj_codestream_info_t
Index structure of the codestream
opj_codestream_info_v2_t
Information structure about the codestream (FIXME should be expand and enhance)
opj_cparameters_t
Compression parameters
opj_dparameters_t
Decompression parameters
opj_image_cmptparm_t
Component parameters structure used by the opj_image_create function
opj_image_comp_t
Defines a single image component
opj_image_t
Defines image data and characteristics
opj_jp2_index_t
Index structure of the JP2 file EXPERIMENTAL FOR THE MOMENT
opj_jp2_metadata_t
Info structure of the JP2 file EXPERIMENTAL FOR THE MOMENT
opj_marker_info_t
Marker structure
opj_msg_callback
Callback function prototype for events
opj_packet_info_t
Index structure : Information concerning a packet inside tile
opj_poc_t
Progression order changes
opj_stream_free_user_data_fn
opj_stream_read_fn
opj_stream_seek_fn
opj_stream_skip_fn
opj_stream_t
opj_stream_write_fn
opj_tccp_info_t
Tile-component coding parameters information
opj_tile_index_t
Index structure about a tile
opj_tile_info_t
Index structure : information regarding tiles
opj_tile_info_v2_t
Tile coding parameters information
opj_tp_index_t
Index structure about a tile part
opj_tp_info_t
Index structure : Information concerning tile-parts