ra8_viewer_reader.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_ra8_viewer_fb_width  = 720U,  
  k_ra8_viewer_fb_height = 1080U, 
} ra8_viewer_geom_t;

typedef struct ra8_viewer_reader ra8_viewer_reader_t;

typedef enum : uint32_t {
  k_ra8_viewer_engine_jof   = 1U, 
  k_ra8_viewer_engine_comic = 2U, 
} ra8_viewer_reader_engine_t;

typedef struct {
  size_t   required_bytes;     
  size_t   required_alignment; 
  size_t   framebuffer_bytes;  
  size_t   dimensions_bytes;   
  size_t   cell_bytes;         
  size_t   scratch_bytes;      
  size_t   comic_pages_bytes;  
  size_t   comic_names_bytes;  
  size_t   comic_page_bytes;   
  size_t   comic_arena_bytes;  
  uint32_t tile_count;         
  uint32_t engine;             
  uint32_t layout_version;     
} ra8_viewer_reader_requirements_t;

typedef struct {
  size_t required_bytes; 
  size_t supplied_bytes; 
} ra8_viewer_workspace_report_t;

[[nodiscard]] ra8_err_t ra8_viewer_reader_requirements(const char*                       path,
                                                       ra8_viewer_reader_requirements_t* out);

[[nodiscard]] ra8_err_t ra8_viewer_reader_bind(ra8_viewer_reader_t** out,
                                               void*                 workspace,
                                               size_t                workspace_bytes,
                                               const ra8_viewer_reader_requirements_t* requirements,
                                               ra8_viewer_workspace_report_t*          report);

[[nodiscard]] ra8_err_t ra8_viewer_open(ra8_viewer_reader_t* reader, const char* path);

[[nodiscard]] uint32_t ra8_viewer_page_count(const ra8_viewer_reader_t* reader);

[[nodiscard]] ra8_err_t ra8_viewer_render_page(ra8_viewer_reader_t* reader, uint32_t page);

[[nodiscard]] uint32_t ra8_viewer_tile_count(const ra8_viewer_reader_t* reader);

[[nodiscard]] ra8_err_t ra8_viewer_tile_size(const ra8_viewer_reader_t* reader,
                                             uint32_t                   index,
                                             uint32_t*                  width,
                                             uint32_t*                  height);

[[nodiscard]] ra8_err_t ra8_viewer_tile_requirements(const ra8_viewer_reader_t* reader,
                                                     uint32_t                   index,
                                                     size_t*                    out_bytes,
                                                     size_t*                    out_alignment);

[[nodiscard]] ra8_err_t ra8_viewer_render_tile565(ra8_viewer_reader_t*           reader,
                                                  uint32_t                       index,
                                                  void*                          workspace,
                                                  size_t                         workspace_bytes,
                                                  uint32_t*                      width,
                                                  uint32_t*                      height,
                                                  uint16_t**                     out_pixels,
                                                  ra8_viewer_workspace_report_t* report);

[[nodiscard]] ra8_err_t ra8_viewer_dump_ppm(const ra8_viewer_reader_t* reader, const char* path);

[[nodiscard]] ra8_err_t
ra8_viewer_write_ppm565(const uint16_t* px, uint32_t w, uint32_t h, const char* path);

[[nodiscard]] uint16_t ra8_viewer_pack565(uint8_t rr, uint8_t gg, uint8_t bb);

[[nodiscard]] uint16_t ra8_viewer_pack565_le_pair(uint8_t low, uint8_t high);

void ra8_viewer_close(ra8_viewer_reader_t* reader);
 
#ifdef __cplusplus
}
#endif