1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
|
/* Copyright (c) the JPEG XL Project Authors. All rights reserved.
*
* Use of this source code is governed by a BSD-style
* license that can be found in the LICENSE file.
*/
/** @addtogroup libjxl_common
* @{
* @file types.h
* @brief Data types for the JPEG XL API, for both encoding and decoding.
*/
#ifndef JXL_TYPES_H_
#define JXL_TYPES_H_
#include <jxl/jxl_export.h>
#include <stddef.h>
#include <stdint.h>
#if defined(__cplusplus) || defined(c_plusplus)
extern "C" {
#endif
/**
* A portable @c bool replacement.
*
* ::JXL_BOOL is a "documentation" type: actually it is @c int, but in API it
* denotes a type, whose only values are ::JXL_TRUE and ::JXL_FALSE.
*/
#define JXL_BOOL int
/** Portable @c true replacement. */
#define JXL_TRUE 1
/** Portable @c false replacement. */
#define JXL_FALSE 0
/** Data type for the sample values per channel per pixel.
*/
typedef enum {
/** Use 32-bit single-precision floating point values, with range 0.0-1.0
* (within gamut, may go outside this range for wide color gamut). Floating
* point output, either JXL_TYPE_FLOAT or JXL_TYPE_FLOAT16, is recommended
* for HDR and wide gamut images when color profile conversion is required. */
JXL_TYPE_FLOAT = 0,
/** Use type uint8_t. May clip wide color gamut data.
*/
JXL_TYPE_UINT8 = 2,
/** Use type uint16_t. May clip wide color gamut data.
*/
JXL_TYPE_UINT16 = 3,
/** Use 16-bit IEEE 754 half-precision floating point values */
JXL_TYPE_FLOAT16 = 5,
} JxlDataType;
/* DEPRECATED: bit-packed 1-bit data type. Use JXL_TYPE_UINT8 instead.
*/
JXL_DEPRECATED static const int JXL_TYPE_BOOLEAN = 1;
/* DEPRECATED: uint32_t data type. Use JXL_TYPE_FLOAT instead.
*/
JXL_DEPRECATED static const int JXL_TYPE_UINT32 = 4;
/** Ordering of multi-byte data.
*/
typedef enum {
/** Use the endianness of the system, either little endian or big endian,
* without forcing either specific endianness. Do not use if pixel data
* should be exported to a well defined format.
*/
JXL_NATIVE_ENDIAN = 0,
/** Force little endian */
JXL_LITTLE_ENDIAN = 1,
/** Force big endian */
JXL_BIG_ENDIAN = 2,
} JxlEndianness;
/** Data type for the sample values per channel per pixel for the output buffer
* for pixels. This is not necessarily the same as the data type encoded in the
* codestream. The channels are interleaved per pixel. The pixels are
* organized row by row, left to right, top to bottom.
* TODO(lode): support different channel orders if needed (RGB, BGR, ...)
*/
typedef struct {
/** Amount of channels available in a pixel buffer.
* 1: single-channel data, e.g. grayscale or a single extra channel
* 2: single-channel + alpha
* 3: trichromatic, e.g. RGB
* 4: trichromatic + alpha
* TODO(lode): this needs finetuning. It is not yet defined how the user
* chooses output color space. CMYK+alpha needs 5 channels.
*/
uint32_t num_channels;
/** Data type of each channel.
*/
JxlDataType data_type;
/** Whether multi-byte data types are represented in big endian or little
* endian format. This applies to JXL_TYPE_UINT16, JXL_TYPE_UINT32
* and JXL_TYPE_FLOAT.
*/
JxlEndianness endianness;
/** Align scanlines to a multiple of align bytes, or 0 to require no
* alignment at all (which has the same effect as value 1)
*/
size_t align;
} JxlPixelFormat;
/** Settings for the interpretation of the input and output buffers.
*/
typedef enum {
/** This is the default setting, where the encoder expects the input pixels
* to use the full range of the pixel format data type (e.g. for UINT16, the
* input range is 0 .. 65535 and the value 65535 is mapped to 1.0 when
* converting to float), and the decoder uses the full range to output
* pixels. If the bit depth in the basic info is different from this, the
* encoder expects the values to be rescaled accordingly (e.g. multiplied by
* 65535/4095 for a 12-bit image using UINT16 input data type). */
JXL_BIT_DEPTH_FROM_PIXEL_FORMAT = 0,
/** If this setting is selected, the encoder expects the input pixels to be
* in the range defined by the bits_per_sample value of the basic info (e.g.
* for 12-bit images using UINT16 input data types, the allowed range is
* 0 .. 4095 and the value 4095 is mapped to 1.0 when converting to float),
* and the decoder outputs pixels in this range. */
JXL_BIT_DEPTH_FROM_CODESTREAM = 1,
/** This setting can only be used in the decoder to select a custom range for
* pixel output */
JXL_BIT_DEPTH_CUSTOM = 2,
} JxlBitDepthType;
/** Data type for describing the interpretation of the input and output buffers
* in terms of the range of allowed input and output pixel values. */
typedef struct {
/** Bit depth setting, see comment on @ref JxlBitDepthType */
JxlBitDepthType type;
/** Custom bits per sample */
uint32_t bits_per_sample;
/** Custom exponent bits per sample */
uint32_t exponent_bits_per_sample;
} JxlBitDepth;
/** Data type holding the 4-character type name of an ISOBMFF box.
*/
typedef char JxlBoxType[4];
/** Types of progressive detail.
* Setting a progressive detail with value N implies all progressive details
* with smaller or equal value. Currently only the following level of
* progressive detail is implemented:
* - kDC (which implies kFrames)
* - kLastPasses (which implies kDC and kFrames)
* - kPasses (which implies kLastPasses, kDC and kFrames)
*/
typedef enum {
// after completed kRegularFrames
kFrames = 0,
// after completed DC (1:8)
kDC = 1,
// after completed AC passes that are the last pass for their resolution
// target.
kLastPasses = 2,
// after completed AC passes that are not the last pass for their resolution
// target.
kPasses = 3,
// during DC frame when lower resolution are completed (1:32, 1:16)
kDCProgressive = 4,
// after completed groups
kDCGroups = 5,
// after completed groups
kGroups = 6,
} JxlProgressiveDetail;
#if defined(__cplusplus) || defined(c_plusplus)
}
#endif
#endif /* JXL_TYPES_H_ */
/** @}*/
|
