LIBJXL
Loading...
Searching...
No Matches
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> // TODO(eustas): remove before v1.0
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
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
322
363
387JXL_EXPORT void JxlDecoderRewind(JxlDecoder* dec);
388
407JXL_EXPORT void JxlDecoderSkipFrames(JxlDecoder* dec, size_t amount);
408
422
435JXL_EXPORT JxlDecoderStatus
437 void* parallel_runner_opaque);
438
454JXL_EXPORT size_t JxlDecoderSizeHintBasicInfo(const JxlDecoder* dec);
455
469 int events_wanted);
470
502JXL_EXPORT JxlDecoderStatus
504
521JXL_EXPORT JxlDecoderStatus
523
534JXL_EXPORT JxlDecoderStatus
536
551 JXL_BOOL coalescing);
552
594
610 const uint8_t* data,
611 size_t size);
612
632JXL_EXPORT size_t JxlDecoderReleaseInput(JxlDecoder* dec);
633
652JXL_EXPORT void JxlDecoderCloseInput(JxlDecoder* dec);
653
666 JxlBasicInfo* info);
667
681 const JxlDecoder* dec, size_t index, JxlExtraChannelInfo* info);
682
698 size_t index,
699 char* name,
700 size_t size);
701
715
765 const JxlDecoder* dec, JxlColorProfileTarget target,
766 JxlColorEncoding* color_encoding);
767
791 const JxlDecoder* dec, JxlColorProfileTarget target, size_t* size);
792
809 const JxlDecoder* dec, JxlColorProfileTarget target, uint8_t* icc_profile,
810 size_t size);
811
823 JxlDecoder* dec, const JxlColorEncoding* color_encoding);
824
836 JxlDecoder* dec, float desired_intensity_target);
837
880 JxlDecoder* dec, const JxlColorEncoding* color_encoding,
881 const uint8_t* icc_data, size_t icc_size);
882
896 JxlCmsInterface cms);
897// TODO(firsching): add a function JxlDecoderSetDefaultCms() for setting a
898// default in case libjxl is build with a CMS.
899
913 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size);
914
931 JxlDecoder* dec, const JxlPixelFormat* format, void* buffer, size_t size);
932
946 JxlFrameHeader* header);
947
961 char* name, size_t size);
962
976 const JxlDecoder* dec, size_t index, JxlBlendInfo* blend_info);
977
994 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size);
995
1013 JxlDecoder* dec, const JxlPixelFormat* format, void* buffer, size_t size);
1014
1031typedef void (*JxlImageOutCallback)(void* opaque, size_t x, size_t y,
1032 size_t num_pixels, const void* pixels);
1033
1046typedef void* (*JxlImageOutInitCallback)(void* init_opaque, size_t num_threads,
1047 size_t num_pixels_per_thread);
1048
1065typedef void (*JxlImageOutRunCallback)(void* run_opaque, size_t thread_id,
1066 size_t x, size_t y, size_t num_pixels,
1067 const void* pixels);
1068
1076typedef void (*JxlImageOutDestroyCallback)(void* run_opaque);
1077
1120JXL_EXPORT JxlDecoderStatus
1122 JxlImageOutCallback callback, void* opaque);
1123
1144 JxlDecoder* dec, const JxlPixelFormat* format,
1145 JxlImageOutInitCallback init_callback, JxlImageOutRunCallback run_callback,
1146 JxlImageOutDestroyCallback destroy_callback, void* init_opaque);
1147
1164 const JxlDecoder* dec, const JxlPixelFormat* format, size_t* size,
1165 uint32_t index);
1166
1197JXL_EXPORT JxlDecoderStatus
1199 void* buffer, size_t size, uint32_t index);
1200
1220 uint8_t* data, size_t size);
1221
1239
1263 uint8_t* data, size_t size);
1264
1282
1304 JXL_BOOL decompress);
1305
1372 JxlBoxType type,
1373 JXL_BOOL decompressed);
1374
1385 uint64_t* size);
1386
1401 uint64_t* size);
1402
1414JXL_EXPORT JxlDecoderStatus
1416
1426
1444
1457JXL_EXPORT JxlDecoderStatus
1459
1460#if defined(__cplusplus) || defined(c_plusplus)
1461}
1462#endif
1463
1464#endif /* JXL_DECODE_H_ */
1465
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...
char JxlBoxType[4]
Definition types.h:146
#define JXL_BOOL
Definition types.h:29
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 JxlDecoderSetCms(JxlDecoder *dec, JxlCmsInterface cms)
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:707
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 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)
JXL_EXPORT JxlDecoderStatus JxlDecoderGetBoxSizeContents(const JxlDecoder *dec, uint64_t *size)
void *(* JxlImageOutInitCallback)(void *init_opaque, size_t num_threads, size_t num_pixels_per_thread)
Definition decode.h:1046
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:1065
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:1031
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:1076
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
JxlProgressiveDetail
Definition decode.h:331
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:713
@ JXL_COLOR_PROFILE_TARGET_ORIGINAL
Definition decode.h:710
@ 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
@ kDCGroups
Definition decode.h:357
@ kDCProgressive
Definition decode.h:353
@ kFrames
Definition decode.h:335
@ kPasses
Definition decode.h:349
@ kDC
Definition decode.h:339
@ kGroups
Definition decode.h:361
@ kLastPasses
Definition decode.h:344
JxlParallelRetCode(* JxlParallelRunner)(void *runner_opaque, void *jpegxl_opaque, JxlParallelRunInit init, JxlParallelRunFunction func, uint32_t start_range, uint32_t end_range)
Definition parallel_runner.h:122
Abstraction functions used by JPEG XL to allocate memory.
Definition codestream_header.h:95
Definition types.h:133
Definition codestream_header.h:330
Definition cms_interface.h:227
Definition color_encoding.h:116
Definition codestream_header.h:265
Definition codestream_header.h:391
Definition memory_manager.h:51
Definition types.h:80
Data types for the JPEG XL API, for both encoding and decoding.