jof.h

Go to the documentation of this file.

 
#pragma once
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <stddef.h>
#include <stdint.h>
 
#include "ra8_err.h"

typedef enum : uint8_t {
  k_jof_hdr_bytes      = 32U, 
  k_jof_footer_bytes   = 16U, 
  k_jof_index_entry    = 8U,  
  k_jof_magic_len      = 4U,  
  k_jof_ofs_magic      = 0U,  
  k_jof_ofs_width      = 4U,  
  k_jof_ofs_height     = 6U,  
  k_jof_ofs_tile_w     = 8U,  
  k_jof_ofs_tile_h     = 10U, 
  k_jof_ofs_bpp        = 12U, 
  k_jof_ofs_codec      = 13U, 
  k_jof_ofs_reserved   = 14U, 
  k_jof_ofs_tile_count = 16U, 
  k_jof_ofs_reserved2  = 20U, 
  k_jof_ftr_index_off  = 0U,  
  k_jof_ftr_tile_count = 4U,  
  k_jof_ftr_total_size = 8U,  
  k_jof_ftr_magic      = 12U, 
  k_jof_idx_ofs_offset = 0U,  
  k_jof_idx_ofs_length = 4U,  
} jof_layout_t;

typedef enum : uint32_t {
  k_jof_max_dim   = 32768U, 
  k_jof_max_tiles = 65536U, 
  k_jof_bpp_max   = 4U,     
} jof_limits_t;

typedef enum : uint8_t {
  k_jof_codec_raw     = 0U, 
  k_jof_codec_deflate = 1U, 
} jof_codec_t;

typedef struct {
  uint16_t width;      
  uint16_t height;     
  uint16_t tile_w;     
  uint16_t tile_h;     
  uint16_t tile_cols;  
  uint16_t tile_rows;  
  uint8_t  bpp;        
  uint8_t  codec;      
  uint32_t tile_count; 
  uint32_t index_off;  
  uint32_t total_size; 
} jof_info_t;

typedef ra8_err_t (
  *jof_pread_fn)(void* ctx, uint64_t offset, uint8_t* buf, size_t len, size_t* got);

typedef struct {
  uint8_t* buf; 
  size_t   cap; 
  size_t   len; 
} jof_memstore_t;

[[nodiscard]] ra8_err_t jof_memstore_sink(void* ctx, const uint8_t* buf, size_t len);

[[nodiscard]] ra8_err_t
jof_memstore_pread(void* ctx, uint64_t offset, uint8_t* buf, size_t len, size_t* got);

[[nodiscard]] ra8_err_t
jof_parse(jof_pread_fn pread, void* pread_ctx, uint64_t total_size, jof_info_t* out_info);

[[nodiscard]] ra8_err_t jof_tile_dims(const jof_info_t* info,
                                      uint16_t          tile_x,
                                      uint16_t          tile_y,
                                      uint16_t*         out_w,
                                      uint16_t*         out_h);

[[nodiscard]] uint32_t jof_stored_bound(uint32_t raw_bytes);

[[nodiscard]] ra8_err_t jof_read_tile(jof_pread_fn      pread,
                                      void*             pread_ctx,
                                      const jof_info_t* info,
                                      uint16_t          tile_x,
                                      uint16_t          tile_y,
                                      uint8_t*          scratch,
                                      uint32_t          scratch_cap,
                                      uint8_t*          out_px,
                                      uint32_t          out_cap,
                                      uint16_t*         out_w,
                                      uint16_t*         out_h);
 
#ifdef __cplusplus
}
#endif