LIBJXL
Loading...
Searching...
No Matches
encode.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_ENCODE_H_
14#define JXL_ENCODE_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/stats.h>
23#include <jxl/types.h>
24#include <jxl/version.h> // TODO(eustas): remove before v1.0
25#include <stddef.h>
26#include <stdint.h>
27
28#if defined(__cplusplus) || defined(c_plusplus)
29extern "C" {
30#endif
31
39JXL_EXPORT uint32_t JxlEncoderVersion(void);
40
47typedef struct JxlEncoderStruct JxlEncoder;
48
57typedef struct JxlEncoderFrameSettingsStruct JxlEncoderFrameSettings;
58
77
119
126typedef enum {
133
139
147
154
165
172
178
183
188
193
198
204
209
215
221
226
231
237
243
249
255
261
266
271
278
287
291
298
304
312
317
328
335
342
358
367
375
382
390
395
397
410JXL_EXPORT JxlEncoder* JxlEncoderCreate(const JxlMemoryManager* memory_manager);
411
419JXL_EXPORT void JxlEncoderReset(JxlEncoder* enc);
420
426JXL_EXPORT void JxlEncoderDestroy(JxlEncoder* enc);
427
437JXL_EXPORT void JxlEncoderSetCms(JxlEncoder* enc, JxlCmsInterface cms);
438
451JXL_EXPORT JxlEncoderStatus
453 void* parallel_runner_opaque);
454
463
495 uint8_t** next_out,
496 size_t* avail_out);
497
532JXL_EXPORT JxlEncoderStatus
534 const JxlFrameHeader* frame_header);
535
548 JxlEncoderFrameSettings* frame_settings, size_t index,
549 const JxlBlendInfo* blend_info);
550
572 JxlEncoderFrameSettings* frame_settings, const char* frame_name);
573
590 JxlEncoderFrameSettings* frame_settings, const JxlBitDepth* bit_depth);
591
622JXL_EXPORT JxlEncoderStatus
624 const uint8_t* buffer, size_t size);
625
695 const JxlEncoderFrameSettings* frame_settings,
696 const JxlPixelFormat* pixel_format, const void* buffer, size_t size);
697
733 void* opaque;
734
752 void* (*get_buffer)(void* opaque, size_t* size);
753
763 void (*release_buffer)(void* opaque, size_t written_bytes);
764
775 void (*seek)(void* opaque, uint64_t position);
776
788 void (*set_finalized_position)(void* opaque, uint64_t finalized_position);
789};
790
804 JxlEncoder* enc, struct JxlEncoderOutputProcessor output_processor);
805
820
830 void* opaque;
831
845 JxlPixelFormat* pixel_format);
846
870 const void* (*get_color_channel_data_at)(void* opaque, size_t xpos,
871 size_t ypos, size_t xsize,
872 size_t ysize, size_t* row_offset);
873
887 void (*get_extra_channel_pixel_format)(void* opaque, size_t ec_index,
888 JxlPixelFormat* pixel_format);
889
914 const void* (*get_extra_channel_data_at)(void* opaque, size_t ec_index,
915 size_t xpos, size_t ypos,
916 size_t xsize, size_t ysize,
917 size_t* row_offset);
918
929 void (*release_buffer)(void* opaque, const void* buf);
930};
931
953 const JxlEncoderFrameSettings* frame_settings, JXL_BOOL is_last_frame,
954 struct JxlChunkedFrameInputSource chunked_frame_input);
955
980 const JxlEncoderFrameSettings* frame_settings,
981 const JxlPixelFormat* pixel_format, const void* buffer, size_t size,
982 uint32_t index);
983
1053 const JxlBoxType type,
1054 const uint8_t* contents,
1055 size_t size,
1056 JXL_BOOL compress_box);
1057
1070
1086JXL_EXPORT void JxlEncoderCloseBoxes(JxlEncoder* enc);
1087
1100JXL_EXPORT void JxlEncoderCloseFrames(JxlEncoder* enc);
1101
1116JXL_EXPORT void JxlEncoderCloseInput(JxlEncoder* enc);
1117
1131JXL_EXPORT JxlEncoderStatus
1133
1148 const uint8_t* icc_profile,
1149 size_t size);
1150
1161
1172JXL_EXPORT void JxlEncoderInitFrameHeader(JxlFrameHeader* frame_header);
1173
1181JXL_EXPORT void JxlEncoderInitBlendInfo(JxlBlendInfo* blend_info);
1182
1199 const JxlBasicInfo* info);
1200
1218 int64_t factor,
1219 int64_t mode);
1220
1232 JxlExtraChannelInfo* info);
1233
1245 JxlEncoder* enc, size_t index, const JxlExtraChannelInfo* info);
1246
1263 size_t index,
1264 const char* name,
1265 size_t size);
1266
1283 JxlEncoderFrameSettings* frame_settings, JxlEncoderFrameSettingId option,
1284 int64_t value);
1285
1302 JxlEncoderFrameSettings* frame_settings, JxlEncoderFrameSettingId option,
1303 float value);
1304
1324 JXL_BOOL use_container);
1325
1340JXL_EXPORT JxlEncoderStatus
1342
1378 int level);
1379
1401
1421 JxlEncoderFrameSettings* frame_settings, JXL_BOOL lossless);
1422
1438 JxlEncoderFrameSettings* frame_settings, float distance);
1439
1455 JxlEncoderFrameSettings* frame_settings, size_t index, float distance);
1456
1492JXL_EXPORT float JxlEncoderDistanceFromQuality(float quality);
1493
1510 JxlEncoder* enc, const JxlEncoderFrameSettings* source);
1511
1518JXL_EXPORT void JxlColorEncodingSetToSRGB(JxlColorEncoding* color_encoding,
1519 JXL_BOOL is_gray);
1520
1528 JxlColorEncoding* color_encoding, JXL_BOOL is_gray);
1529
1539
1556typedef void (*JxlDebugImageCallback)(void* opaque, const char* label,
1557 size_t xsize, size_t ysize,
1558 const JxlColorEncoding* color,
1559 const uint16_t* pixels);
1560
1574 JxlEncoderFrameSettings* frame_settings, JxlDebugImageCallback callback,
1575 void* opaque);
1576
1588JXL_EXPORT void JxlEncoderCollectStats(JxlEncoderFrameSettings* frame_settings,
1589 JxlEncoderStats* stats);
1590
1591#if defined(__cplusplus) || defined(c_plusplus)
1592}
1593#endif
1594
1595#endif /* JXL_ENCODE_H_ */
1596
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 int JxlEncoderGetRequiredCodestreamLevel(const JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetCodestreamLevel(JxlEncoder *enc, int level)
JXL_EXPORT JxlEncoderStatus JxlEncoderAddJPEGFrame(const JxlEncoderFrameSettings *frame_settings, const uint8_t *buffer, size_t size)
void(* JxlDebugImageCallback)(void *opaque, const char *label, size_t xsize, size_t ysize, const JxlColorEncoding *color, const uint16_t *pixels)
Definition encode.h:1556
JXL_EXPORT void JxlEncoderInitBlendInfo(JxlBlendInfo *blend_info)
JXL_EXPORT void JxlEncoderCloseInput(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetParallelRunner(JxlEncoder *enc, JxlParallelRunner parallel_runner, void *parallel_runner_opaque)
JXL_EXPORT void JxlEncoderCollectStats(JxlEncoderFrameSettings *frame_settings, JxlEncoderStats *stats)
struct JxlEncoderStatsStruct JxlEncoderStats
Definition stats.h:29
JXL_EXPORT JxlEncoderStatus JxlEncoderFrameSettingsSetOption(JxlEncoderFrameSettings *frame_settings, JxlEncoderFrameSettingId option, int64_t value)
struct JxlEncoderStruct JxlEncoder
Definition encode.h:47
JXL_EXPORT JxlEncoder * JxlEncoderCreate(const JxlMemoryManager *memory_manager)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetExtraChannelBuffer(const JxlEncoderFrameSettings *frame_settings, const JxlPixelFormat *pixel_format, const void *buffer, size_t size, uint32_t index)
JXL_EXPORT JxlEncoderStatus JxlEncoderProcessOutput(JxlEncoder *enc, uint8_t **next_out, size_t *avail_out)
JXL_EXPORT JxlEncoderStatus JxlEncoderUseContainer(JxlEncoder *enc, JXL_BOOL use_container)
JXL_EXPORT void JxlColorEncodingSetToSRGB(JxlColorEncoding *color_encoding, JXL_BOOL is_gray)
JXL_EXPORT void JxlEncoderSetCms(JxlEncoder *enc, JxlCmsInterface cms)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetFrameBitDepth(JxlEncoderFrameSettings *frame_settings, const JxlBitDepth *bit_depth)
JXL_EXPORT void JxlEncoderInitFrameHeader(JxlFrameHeader *frame_header)
JXL_EXPORT float JxlEncoderDistanceFromQuality(float quality)
JXL_EXPORT void JxlEncoderReset(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetFrameLossless(JxlEncoderFrameSettings *frame_settings, JXL_BOOL lossless)
JXL_EXPORT JxlEncoderStatus JxlEncoderFrameSettingsSetFloatOption(JxlEncoderFrameSettings *frame_settings, JxlEncoderFrameSettingId option, float value)
JXL_EXPORT JxlEncoderStatus JxlEncoderUseBoxes(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetOutputProcessor(JxlEncoder *enc, struct JxlEncoderOutputProcessor output_processor)
JXL_EXPORT void JxlEncoderInitBasicInfo(JxlBasicInfo *info)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetBasicInfo(JxlEncoder *enc, const JxlBasicInfo *info)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetColorEncoding(JxlEncoder *enc, const JxlColorEncoding *color)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetExtraChannelBlendInfo(JxlEncoderFrameSettings *frame_settings, size_t index, const JxlBlendInfo *blend_info)
JXL_EXPORT void JxlEncoderCloseBoxes(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetFrameDistance(JxlEncoderFrameSettings *frame_settings, float distance)
JxlEncoderStatus
Definition encode.h:62
JXL_EXPORT JxlEncoderStatus JxlEncoderSetUpsamplingMode(JxlEncoder *enc, int64_t factor, int64_t mode)
JXL_EXPORT void JxlEncoderAllowExpertOptions(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetFrameHeader(JxlEncoderFrameSettings *frame_settings, const JxlFrameHeader *frame_header)
JXL_EXPORT void JxlColorEncodingSetToLinearSRGB(JxlColorEncoding *color_encoding, JXL_BOOL is_gray)
JXL_EXPORT void JxlEncoderInitExtraChannelInfo(JxlExtraChannelType type, JxlExtraChannelInfo *info)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetExtraChannelDistance(JxlEncoderFrameSettings *frame_settings, size_t index, float distance)
JXL_EXPORT void JxlEncoderCloseFrames(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderAddImageFrame(const JxlEncoderFrameSettings *frame_settings, const JxlPixelFormat *pixel_format, const void *buffer, size_t size)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetICCProfile(JxlEncoder *enc, const uint8_t *icc_profile, size_t size)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetFrameName(JxlEncoderFrameSettings *frame_settings, const char *frame_name)
JXL_EXPORT void JxlEncoderSetDebugImageCallback(JxlEncoderFrameSettings *frame_settings, JxlDebugImageCallback callback, void *opaque)
JXL_EXPORT uint32_t JxlEncoderVersion(void)
JXL_EXPORT JxlEncoderFrameSettings * JxlEncoderFrameSettingsCreate(JxlEncoder *enc, const JxlEncoderFrameSettings *source)
JXL_EXPORT JxlEncoderError JxlEncoderGetError(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetExtraChannelName(JxlEncoder *enc, size_t index, const char *name, size_t size)
struct JxlEncoderFrameSettingsStruct JxlEncoderFrameSettings
Definition encode.h:57
JXL_EXPORT JxlEncoderStatus JxlEncoderAddBox(JxlEncoder *enc, const JxlBoxType type, const uint8_t *contents, size_t size, JXL_BOOL compress_box)
JXL_EXPORT JxlEncoderStatus JxlEncoderFlushInput(JxlEncoder *enc)
JxlEncoderError
Definition encode.h:83
JxlEncoderFrameSettingId
Definition encode.h:126
JXL_EXPORT void JxlEncoderDestroy(JxlEncoder *enc)
JXL_EXPORT JxlEncoderStatus JxlEncoderSetExtraChannelInfo(JxlEncoder *enc, size_t index, const JxlExtraChannelInfo *info)
JXL_EXPORT JxlEncoderStatus JxlEncoderStoreJPEGMetadata(JxlEncoder *enc, JXL_BOOL store_jpeg_metadata)
JXL_EXPORT JxlEncoderStatus JxlEncoderAddChunkedFrame(const JxlEncoderFrameSettings *frame_settings, JXL_BOOL is_last_frame, struct JxlChunkedFrameInputSource chunked_frame_input)
Adds a frame to the encoder using a chunked input source.
@ JXL_ENC_ERROR
Definition encode.h:70
@ JXL_ENC_NEED_MORE_OUTPUT
Definition encode.h:74
@ JXL_ENC_SUCCESS
Definition encode.h:66
@ JXL_ENC_ERR_NOT_SUPPORTED
Definition encode.h:110
@ JXL_ENC_ERR_JBRD
Definition encode.h:100
@ JXL_ENC_ERR_API_USAGE
Definition encode.h:116
@ JXL_ENC_ERR_OOM
Definition encode.h:95
@ JXL_ENC_ERR_OK
Definition encode.h:86
@ JXL_ENC_ERR_GENERIC
Definition encode.h:90
@ JXL_ENC_ERR_BAD_INPUT
Definition encode.h:104
@ JXL_ENC_FRAME_SETTING_DECODING_SPEED
Definition encode.h:138
@ JXL_ENC_FRAME_SETTING_JPEG_COMPRESS_BOXES
Definition encode.h:341
@ JXL_ENC_FRAME_SETTING_MODULAR_GROUP_SIZE
Definition encode.h:290
@ JXL_ENC_FRAME_SETTING_PROGRESSIVE_DC
Definition encode.h:248
@ JXL_ENC_FRAME_SETTING_EXTRA_CHANNEL_RESAMPLING
Definition encode.h:153
@ JXL_ENC_FRAME_SETTING_GROUP_ORDER_CENTER_X
Definition encode.h:220
@ JXL_ENC_FRAME_SETTING_USE_FULL_IMAGE_HEURISTICS
Definition encode.h:389
@ JXL_ENC_FRAME_SETTING_JPEG_KEEP_XMP
Definition encode.h:374
@ JXL_ENC_FRAME_SETTING_NOISE
Definition encode.h:177
@ JXL_ENC_FRAME_SETTING_ALREADY_DOWNSAMPLED
Definition encode.h:164
@ JXL_ENC_FRAME_SETTING_RESPONSIVE
Definition encode.h:230
@ JXL_ENC_FRAME_SETTING_JPEG_RECON_CFL
Definition encode.h:316
@ JXL_ENC_FRAME_SETTING_PATCHES
Definition encode.h:187
@ JXL_ENC_FRAME_SETTING_JPEG_KEEP_JUMBF
Definition encode.h:381
@ JXL_ENC_FRAME_SETTING_GROUP_ORDER
Definition encode.h:214
@ JXL_ENC_FRAME_SETTING_EPF
Definition encode.h:192
@ JXL_ENC_FRAME_SETTING_CHANNEL_COLORS_GLOBAL_PERCENT
Definition encode.h:254
@ JXL_ENC_FRAME_SETTING_RESAMPLING
Definition encode.h:146
@ JXL_ENC_FRAME_SETTING_DOTS
Definition encode.h:182
@ JXL_ENC_FRAME_SETTING_COLOR_TRANSFORM
Definition encode.h:277
@ JXL_ENC_FRAME_SETTING_EFFORT
Definition encode.h:132
@ JXL_ENC_FRAME_SETTING_MODULAR
Definition encode.h:203
@ JXL_ENC_FRAME_SETTING_MODULAR_COLOR_SPACE
Definition encode.h:286
@ JXL_ENC_FRAME_SETTING_KEEP_INVISIBLE
Definition encode.h:208
@ JXL_ENC_FRAME_SETTING_PHOTON_NOISE
Definition encode.h:171
@ JXL_ENC_FRAME_SETTING_BUFFERING
Definition encode.h:357
@ JXL_ENC_FRAME_SETTING_BROTLI_EFFORT
Definition encode.h:334
@ JXL_ENC_FRAME_SETTING_GROUP_ORDER_CENTER_Y
Definition encode.h:225
@ JXL_ENC_FRAME_SETTING_GABORISH
Definition encode.h:197
@ JXL_ENC_FRAME_SETTING_QPROGRESSIVE_AC
Definition encode.h:242
@ JXL_ENC_FRAME_SETTING_MODULAR_NB_PREV_CHANNELS
Definition encode.h:311
@ JXL_ENC_FRAME_SETTING_JPEG_KEEP_EXIF
Definition encode.h:366
@ JXL_ENC_FRAME_SETTING_FILL_ENUM
Definition encode.h:394
@ JXL_ENC_FRAME_SETTING_PROGRESSIVE_AC
Definition encode.h:236
@ JXL_ENC_FRAME_SETTING_MODULAR_MA_TREE_LEARNING_PERCENT
Definition encode.h:303
@ JXL_ENC_FRAME_SETTING_LOSSY_PALETTE
Definition encode.h:270
@ JXL_ENC_FRAME_SETTING_MODULAR_PREDICTOR
Definition encode.h:297
@ JXL_ENC_FRAME_SETTING_PALETTE_COLORS
Definition encode.h:265
@ JXL_ENC_FRAME_SETTING_CHANNEL_COLORS_GROUP_PERCENT
Definition encode.h:260
@ JXL_ENC_FRAME_INDEX_BOX
Definition encode.h:327
JxlExtraChannelType
Definition codestream_header.h:44
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.
API to collect various statistics from JXL encoder.
Definition codestream_header.h:95
Definition types.h:133
Definition codestream_header.h:330
Definition encode.h:825
void(* release_buffer)(void *opaque, const void *buf)
Definition encode.h:929
void(* get_color_channels_pixel_format)(void *opaque, JxlPixelFormat *pixel_format)
Definition encode.h:844
void(* get_extra_channel_pixel_format)(void *opaque, size_t ec_index, JxlPixelFormat *pixel_format)
Definition encode.h:887
void * opaque
Definition encode.h:830
Definition cms_interface.h:227
Definition color_encoding.h:116
Definition encode.h:727
void * opaque
Definition encode.h:733
void(* seek)(void *opaque, uint64_t position)
Definition encode.h:775
void(* set_finalized_position)(void *opaque, uint64_t finalized_position)
Definition encode.h:788
void(* release_buffer)(void *opaque, size_t written_bytes)
Definition encode.h:763
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.