ra8_fmt_stream.h

Go to the documentation of this file.

 
#pragma once
 
#include <stddef.h>
#include <stdint.h>
 
#include "jof.h"
#include "jof_audit.h"
#include "ra8_err.h"

typedef ra8_err_t (*ra8_fmt_source_validate_fn)(void* ctx, uint64_t expected_size);

typedef struct {
  jof_pread_fn               read_at;  
  ra8_fmt_source_validate_fn validate; 
  void*                      ctx;      
  uint64_t                   size;     
} ra8_fmt_source_t;

typedef ra8_err_t (*ra8_fmt_sink_write_fn)(void* ctx, const uint8_t* bytes, size_t len);

typedef struct {
  ra8_fmt_sink_write_fn write; 
  void*                 ctx;   
} ra8_fmt_sink_t;

typedef ra8_err_t (*ra8_fmt_spool_seal_fn)(void* ctx, uint64_t expected_size);

typedef struct {
  jof_pread_fn          read_at; 
  ra8_fmt_sink_write_fn append;  
  ra8_fmt_spool_seal_fn seal;    
  void*                 ctx;     
} ra8_fmt_spool_t;

typedef struct {
  ra8_fmt_sink_write_fn append;   
  ra8_err_t (*commit)(void* ctx); 
  void (*abort)(void* ctx);       
} ra8_fmt_transaction_ops_t;

typedef struct {
  const ra8_fmt_transaction_ops_t* ops; 
  void*                            ctx; 
} ra8_fmt_transaction_t;

typedef struct {
  uint16_t width;           
  uint16_t height;          
  uint16_t tile_width;      
  uint16_t tile_height;     
  uint32_t work_bytes;      
  uint32_t webp_work_bytes; 
} ra8_fmt_jof_convert_requirements_t;

typedef struct {
  uint8_t* work;          
  uint32_t work_cap;      
  uint8_t* webp_work;     
  uint32_t webp_work_cap; 
} ra8_fmt_jof_convert_workspace_t;

typedef struct {
  uint16_t width;                
  uint16_t height;               
  uint8_t  bpp;                  
  uint16_t band_height;          
  uint32_t reference_work_bytes; 
  uint32_t banded_work_bytes;    
  uint32_t webp_work_bytes;      
  uint32_t band_tile_bytes;      
  uint32_t scratch_bytes;        
  uint32_t row_bytes;            
} ra8_fmt_jof_verify_requirements_t;

typedef struct {
  uint8_t* work;          
  uint32_t work_cap;      
  uint8_t* webp_work;     
  uint32_t webp_work_cap; 
  uint8_t* band_tile;     
  uint32_t band_tile_cap; 
  uint8_t* scratch;       
  uint32_t scratch_cap;   
  uint8_t* row;           
  uint32_t row_cap;       
} ra8_fmt_jof_verify_workspace_t;

typedef struct {
  jof_audit_record_t* records;     
  uint32_t            record_cap;  
  uint8_t*            tile;        
  uint32_t            tile_cap;    
  uint8_t*            scratch;     
  uint32_t            scratch_cap; 
} ra8_fmt_jof_inspect_workspace_t;

typedef struct {
  uint64_t* table;          
  uint32_t  table_cap;      
  uint8_t*  compressed;     
  uint32_t  compressed_cap; 
  uint8_t*  chunk;          
  uint32_t  chunk_cap;      
  uint8_t*  scratch;        
  uint32_t  scratch_cap;    
} ra8_fmt_rabook_inspect_workspace_t;

[[nodiscard]] ra8_err_t ra8_fmt_jof_inspect_stream(const ra8_fmt_source_t*                source,
                                                   bool                                   verbose,
                                                   const ra8_fmt_jof_inspect_workspace_t* workspace,
                                                   const ra8_fmt_sink_t*                  report);

[[nodiscard]] ra8_err_t ra8_fmt_rabook_inspect_stream(const ra8_fmt_source_t*             source,
                                                      bool                                verbose,
                                                      ra8_fmt_rabook_inspect_workspace_t* workspace,
                                                      const ra8_fmt_sink_t*               report);

[[nodiscard]] ra8_err_t ra8_fmt_jof_convert_requirements(const ra8_fmt_source_t*             source,
                                                         ra8_fmt_jof_convert_requirements_t* out);

[[nodiscard]] ra8_err_t
ra8_fmt_jof_convert_stream(const ra8_fmt_source_t*                   source,
                           const ra8_fmt_jof_convert_requirements_t* requirements,
                           const ra8_fmt_jof_convert_workspace_t*    workspace,
                           ra8_fmt_transaction_t*                    transaction,
                           const ra8_fmt_sink_t*                     report,
                           const char*                               output_name);

[[nodiscard]] ra8_err_t ra8_fmt_jof_verify_requirements(const ra8_fmt_source_t*            source,
                                                        ra8_fmt_jof_verify_requirements_t* out);

[[nodiscard]] ra8_err_t
ra8_fmt_jof_verify_stream(const ra8_fmt_source_t*                  reference_source,
                          const ra8_fmt_source_t*                  banded_source,
                          const ra8_fmt_jof_verify_requirements_t* requirements,
                          ra8_fmt_jof_verify_workspace_t*          workspace,
                          ra8_fmt_spool_t*                         reference_spool,
                          ra8_fmt_spool_t*                         banded_spool,
                          ra8_fmt_transaction_t*                   dump,
                          const char*                              dump_name,
                          const ra8_fmt_sink_t*                    report);