types.h

Go to the documentation of this file.

/* 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.
 */
 
#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
 
#define JXL_BOOL int
#define JXL_TRUE 1
#define JXL_FALSE 0
 
typedef enum {
  JXL_TYPE_FLOAT = 0,
 
  JXL_TYPE_UINT8 = 2,
 
  JXL_TYPE_UINT16 = 3,
 
  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;
 
typedef enum {
  JXL_NATIVE_ENDIAN = 0,
  JXL_LITTLE_ENDIAN = 1,
  JXL_BIG_ENDIAN = 2,
} JxlEndianness;
 
typedef struct {
  uint32_t num_channels;
 
  JxlDataType data_type;
 
  JxlEndianness endianness;
 
  size_t align;
} JxlPixelFormat;
 
typedef enum {
  JXL_BIT_DEPTH_FROM_PIXEL_FORMAT = 0,
 
  JXL_BIT_DEPTH_FROM_CODESTREAM = 1,
 
  JXL_BIT_DEPTH_CUSTOM = 2,
} JxlBitDepthType;
 
typedef struct {
  JxlBitDepthType type;
 
  uint32_t bits_per_sample;
 
  uint32_t exponent_bits_per_sample;
} JxlBitDepth;
 
typedef char JxlBoxType[4];
 
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_ */