LIBJXL
decode.h
Go to the documentation of this file.
1/* Copyright (c) the JPEG XL Project Authors. All rights reserved.
2 *
3 * Use of this source code is governed by a BSD-style
4 * license that can be found in the LICENSE file.
5 */
6
13#ifndef JXL_DECODE_H_
14#define JXL_DECODE_H_
15
16#include <jxl/cms_interface.h>
18#include <jxl/color_encoding.h>
19#include <jxl/jxl_export.h>
20#include <jxl/memory_manager.h>
21#include <jxl/parallel_runner.h>
22#include <jxl/types.h>
23#include <jxl/version.h>
24#include <stddef.h>
25#include <stdint.h>
26
27#if defined(__cplusplus) || defined(c_plusplus)
28extern "C" {
29#endif
30
38JXL_EXPORT uint32_t JxlDecoderVersion(void);
39
42typedef enum {
46
49
54
60
76JXL_EXPORT JxlSignature JxlSignatureCheck(const uint8_t* buf, size_t len);
77
84typedef struct JxlDecoderStruct JxlDecoder;
85
98JXL_EXPORT JxlDecoder* JxlDecoderCreate(const JxlMemoryManager* memory_manager);
99
107JXL_EXPORT void JxlDecoderReset(JxlDecoder* dec);
108
114JXL_EXPORT void JxlDecoderDestroy(JxlDecoder* dec);
115
122typedef enum {
137
142
158
169
178
185
191
200
210
220
241
254
267
303 JXL_DEC_BOX = 0x4000,
304
322
346JXL_EXPORT void JxlDecoderRewind(JxlDecoder* dec);
347
366JXL_EXPORT void JxlDecoderSkipFrames(JxlDecoder* dec, size_t amount);
367
381
394JXL_EXPORT JxlDecoderStatus
396 void* parallel_runner_opaque);
397
413JXL_EXPORT size_t JxlDecoderSizeHintBasicInfo(const JxlDecoder* dec);
414
428 int events_wanted);
429
461JXL_EXPORT JxlDecoderStatus
463
479JXL_EXPORT JxlDecoderStatus
481
492JXL_EXPORT JxlDecoderStatus
494
509 JXL_BOOL coalescing);
510
552
568 const uint8_t* data,
569 size_t size);
570
590JXL_EXPORT size_t JxlDecoderReleaseInput(JxlDecoder* dec);
591
610JXL_EXPORT void JxlDecoderCloseInput(JxlDecoder* dec);
611
624 JxlBasicInfo* info);
625
639 const JxlDecoder* dec, size_t index, JxlExtraChannelInfo* info);
640
656 size_t index,
657 char* name,
658 size_t size);
659
665typedef enum {
669
673
723 const JxlDecoder* dec, JxlColorProfileTarget target,
724 JxlColorEncoding* color_encoding);
725
749 const JxlDecoder* dec, JxlColorProfileTarget target, size_t* size);
750
767 const JxlDecoder* dec, JxlColorProfileTarget target, uint8_t* icc_profile,
768 size_t size);
769
781 JxlDecoder* dec, const JxlColorEncoding* color_encoding);
782
794 JxlDecoder* dec, float desired_intensity_target);
795
838 JxlDecoder* dec, const JxlColorEncoding* color_encoding,
839 const uint8_t* icc_data, size_t icc_size);
840
853JXL_EXPORT void JxlDecoderSetCms(JxlDecoder* dec, JxlCmsInterface cms);
854// TODO(firsching): add a function JxlDecoderSetDefaultCms() for setting a
855// default in case libjxl is build with a CMS.
856
870 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size);
871
888 JxlDecoder* dec, const JxlPixelFormat* format, void* buffer, size_t size);
889
903 JxlFrameHeader* header);
904
918 char* name, size_t size);
919
933 const JxlDecoder* dec, size_t index, JxlBlendInfo* blend_info);
934
951 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size);
952
970 JxlDecoder* dec, const JxlPixelFormat* format, void* buffer, size_t size);
971
988typedef void (*JxlImageOutCallback)(void* opaque, size_t x, size_t y,
989 size_t num_pixels, const void* pixels);
990
1003typedef void* (*JxlImageOutInitCallback)(void* init_opaque, size_t num_threads,
1004 size_t num_pixels_per_thread);
1005
1022typedef void (*JxlImageOutRunCallback)(void* run_opaque, size_t thread_id,
1023 size_t x, size_t y, size_t num_pixels,
1024 const void* pixels);
1025
1033typedef void (*JxlImageOutDestroyCallback)(void* run_opaque);
1034
1077JXL_EXPORT JxlDecoderStatus
1079 JxlImageOutCallback callback, void* opaque);
1080
1101 JxlDecoder* dec, const JxlPixelFormat* format,
1102 JxlImageOutInitCallback init_callback, JxlImageOutRunCallback run_callback,
1103 JxlImageOutDestroyCallback destroy_callback, void* init_opaque);
1104
1121 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size,
1122 uint32_t index);
1123
1154JXL_EXPORT JxlDecoderStatus
1156 void* buffer, size_t size, uint32_t index);
1157
1177 uint8_t* data, size_t size);
1178
1196
1220 uint8_t* data, size_t size);
1221
1239
1261 JXL_BOOL decompress);
1262
1329 JxlBoxType type,
1330 JXL_BOOL decompressed);
1331
1350 uint64_t* size);
1351
1363JXL_EXPORT JxlDecoderStatus
1365
1375
1393
1406JXL_EXPORT JxlDecoderStatus
1408
1409#if defined(__cplusplus) || defined(c_plusplus)
1410}
1411#endif
1412
1413#endif /* JXL_DECODE_H_ */
1414
Interface to allow the injection of different color management systems (CMSes, also called color mana...
Definitions of structs and enums for the metadata from the JPEG XL codestream headers (signature,...
Color Encoding definitions used by JPEG XL. All CIE units are for the standard 1931 2 degree observer...
JxlParallelRetCode(* JxlParallelRunner)(void *runner_opaque, void *jpegxl_opaque, JxlParallelRunInit init, JxlParallelRunFunction func, uint32_t start_range, uint32_t end_range)
Definition: parallel_runner.h:119
char JxlBoxType[4]
Definition: types.h:143
#define JXL_BOOL
Definition: types.h:30
JxlProgressiveDetail
Definition: types.h:153
JXL_EXPORT size_t JxlDecoderReleaseBoxBuffer(JxlDecoder *dec)
JXL_EXPORT void JxlDecoderSkipFrames(JxlDecoder *dec, size_t amount)
JXL_EXPORT uint32_t JxlDecoderVersion(void)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetOutputColorProfile(JxlDecoder *dec, const JxlColorEncoding *color_encoding, const uint8_t *icc_data, size_t icc_size)
JXL_EXPORT size_t JxlDecoderReleaseInput(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderPreviewOutBufferSize(const JxlDecoder *dec, const JxlPixelFormat *format, size_t *size)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetImageOutBitDepth(JxlDecoder *dec, const JxlBitDepth *bit_depth)
JXL_EXPORT void JxlDecoderRewind(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetMultithreadedImageOutCallback(JxlDecoder *dec, const JxlPixelFormat *format, JxlImageOutInitCallback init_callback, JxlImageOutRunCallback run_callback, JxlImageOutDestroyCallback destroy_callback, void *init_opaque)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetColorAsEncodedProfile(const JxlDecoder *dec, JxlColorProfileTarget target, JxlColorEncoding *color_encoding)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetDesiredIntensityTarget(JxlDecoder *dec, float desired_intensity_target)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetPreviewOutBuffer(JxlDecoder *dec, const JxlPixelFormat *format, void *buffer, size_t size)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetFrameName(const JxlDecoder *dec, char *name, size_t size)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetExtraChannelName(const JxlDecoder *dec, size_t index, char *name, size_t size)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetCoalescing(JxlDecoder *dec, JXL_BOOL coalescing)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetInput(JxlDecoder *dec, const uint8_t *data, size_t size)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetBoxSizeRaw(const JxlDecoder *dec, uint64_t *size)
JXL_EXPORT void JxlDecoderCloseInput(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetFrameHeader(const JxlDecoder *dec, JxlFrameHeader *header)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetICCProfileSize(const JxlDecoder *dec, JxlColorProfileTarget target, size_t *size)
JXL_EXPORT size_t JxlDecoderSizeHintBasicInfo(const JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetImageOutBuffer(JxlDecoder *dec, const JxlPixelFormat *format, void *buffer, size_t size)
JXL_EXPORT size_t JxlDecoderGetIntendedDownsamplingRatio(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderImageOutBufferSize(const JxlDecoder *dec, const JxlPixelFormat *format, size_t *size)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetExtraChannelInfo(const JxlDecoder *dec, size_t index, JxlExtraChannelInfo *info)
JXL_EXPORT JxlDecoderStatus JxlDecoderSkipCurrentFrame(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetDecompressBoxes(JxlDecoder *dec, JXL_BOOL decompress)
JXL_EXPORT JxlDecoder * JxlDecoderCreate(const JxlMemoryManager *memory_manager)
JXL_EXPORT size_t JxlDecoderReleaseJPEGBuffer(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetColorAsICCProfile(const JxlDecoder *dec, JxlColorProfileTarget target, uint8_t *icc_profile, size_t size)
JxlColorProfileTarget
Definition: decode.h:665
JXL_EXPORT JxlDecoderStatus JxlDecoderExtraChannelBufferSize(const JxlDecoder *dec, const JxlPixelFormat *format, size_t *size, uint32_t index)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetBoxBuffer(JxlDecoder *dec, uint8_t *data, size_t size)
JxlSignature
Definition: decode.h:42
JXL_EXPORT void JxlDecoderSetCms(JxlDecoder *dec, JxlCmsInterface cms)
JXL_EXPORT JxlDecoderStatus JxlDecoderSubscribeEvents(JxlDecoder *dec, int events_wanted)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetParallelRunner(JxlDecoder *dec, JxlParallelRunner parallel_runner, void *parallel_runner_opaque)
JXL_EXPORT JxlDecoderStatus JxlDecoderProcessInput(JxlDecoder *dec)
void *(* JxlImageOutInitCallback)(void *init_opaque, size_t num_threads, size_t num_pixels_per_thread)
Definition: decode.h:1003
void(* JxlImageOutRunCallback)(void *run_opaque, size_t thread_id, size_t x, size_t y, size_t num_pixels, const void *pixels)
Definition: decode.h:1022
JXL_EXPORT JxlDecoderStatus JxlDecoderSetPreferredColorProfile(JxlDecoder *dec, const JxlColorEncoding *color_encoding)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetImageOutCallback(JxlDecoder *dec, const JxlPixelFormat *format, JxlImageOutCallback callback, void *opaque)
void(* JxlImageOutCallback)(void *opaque, size_t x, size_t y, size_t num_pixels, const void *pixels)
Definition: decode.h:988
JXL_EXPORT JxlDecoderStatus JxlDecoderGetBoxType(JxlDecoder *dec, JxlBoxType type, JXL_BOOL decompressed)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetBasicInfo(const JxlDecoder *dec, JxlBasicInfo *info)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetUnpremultiplyAlpha(JxlDecoder *dec, JXL_BOOL unpremul_alpha)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetKeepOrientation(JxlDecoder *dec, JXL_BOOL skip_reorientation)
void(* JxlImageOutDestroyCallback)(void *run_opaque)
Definition: decode.h:1033
JXL_EXPORT JxlDecoderStatus JxlDecoderFlushImage(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetExtraChannelBlendInfo(const JxlDecoder *dec, size_t index, JxlBlendInfo *blend_info)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetJPEGBuffer(JxlDecoder *dec, uint8_t *data, size_t size)
JXL_EXPORT void JxlDecoderDestroy(JxlDecoder *dec)
JXL_EXPORT JxlSignature JxlSignatureCheck(const uint8_t *buf, size_t len)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetProgressiveDetail(JxlDecoder *dec, JxlProgressiveDetail detail)
JxlDecoderStatus
Definition: decode.h:122
struct JxlDecoderStruct JxlDecoder
Definition: decode.h:84
JXL_EXPORT JxlDecoderStatus JxlDecoderSetRenderSpotcolors(JxlDecoder *dec, JXL_BOOL render_spotcolors)
JXL_EXPORT void JxlDecoderReset(JxlDecoder *dec)
JXL_EXPORT JxlDecoderStatus JxlDecoderSetExtraChannelBuffer(JxlDecoder *dec, const JxlPixelFormat *format, void *buffer, size_t size, uint32_t index)
@ JXL_COLOR_PROFILE_TARGET_DATA
Definition: decode.h:671
@ JXL_COLOR_PROFILE_TARGET_ORIGINAL
Definition: decode.h:668
@ JXL_SIG_NOT_ENOUGH_BYTES
Definition: decode.h:45
@ JXL_SIG_INVALID
Definition: decode.h:48
@ JXL_SIG_CONTAINER
Definition: decode.h:58
@ JXL_SIG_CODESTREAM
Definition: decode.h:53
@ JXL_DEC_JPEG_RECONSTRUCTION
Definition: decode.h:266
@ JXL_DEC_JPEG_NEED_MORE_OUTPUT
Definition: decode.h:184
@ JXL_DEC_BASIC_INFO
Definition: decode.h:199
@ JXL_DEC_FRAME_PROGRESSION
Definition: decode.h:320
@ JXL_DEC_ERROR
Definition: decode.h:141
@ JXL_DEC_NEED_IMAGE_OUT_BUFFER
Definition: decode.h:177
@ JXL_DEC_FULL_IMAGE
Definition: decode.h:253
@ JXL_DEC_COLOR_ENCODING
Definition: decode.h:209
@ JXL_DEC_SUCCESS
Definition: decode.h:136
@ JXL_DEC_PREVIEW_IMAGE
Definition: decode.h:219
@ JXL_DEC_BOX_NEED_MORE_OUTPUT
Definition: decode.h:190
@ JXL_DEC_BOX
Definition: decode.h:303
@ JXL_DEC_NEED_MORE_INPUT
Definition: decode.h:157
@ JXL_DEC_NEED_PREVIEW_OUT_BUFFER
Definition: decode.h:168
@ JXL_DEC_FRAME
Definition: decode.h:240
Abstraction functions used by JPEG XL to allocate memory.
Definition: codestream_header.h:95
Definition: types.h:130
Definition: codestream_header.h:328
Definition: cms_interface.h:209
Definition: color_encoding.h:116
Definition: codestream_header.h:263
Definition: codestream_header.h:389
Definition: memory_manager.h:51
Definition: types.h:77
Data types for the JPEG XL API, for both encoding and decoding.