ra8_rabook_comic.h

Go to the documentation of this file.

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

typedef enum : uint16_t {
  k_ra8_rabook_comic_string_max = 512U, 
} ra8_rabook_comic_limit_t;

typedef ra8_err_t (*ra8_rabook_comic_write_at_fn)(void*          ctx,
                                                  uint32_t       offset,
                                                  const uint8_t* source,
                                                  uint32_t       requested,
                                                  uint32_t*      out_written);

typedef struct {
  const char* title;      
  const char* author;     
  const char* language;   
  const char* identifier; 
} ra8_rabook_comic_metadata_t;

typedef struct {
  ra8_rabook_buffers_t          builder;            
  ra8_rabook_raster_workspace_t raster;             
  uint8_t*                      normalized;         
  size_t                        normalized_cap;     
  uint8_t*                      stream_scratch;     
  uint32_t                      stream_scratch_cap; 
} ra8_rabook_comic_workspace_t;

typedef struct {
  ra8_rabook_ctx_t              builder;            
  ra8_rabook_raster_workspace_t raster;             
  ra8_rabook_image_read_fn      image_read;         
  ra8_rabook_comic_write_at_fn  image_write;        
  void*                         image_ctx;          
  uint8_t*                      normalized;         
  uint8_t*                      stream_scratch;     
  size_t                        normalized_cap;     
  uint32_t                      stream_scratch_cap; 
  uint32_t                      page_count;         
  uint16_t                      max_image_edge;     
  uint8_t                       pixel_format;       
  bool                          active;             
} ra8_rabook_comic_t;

[[nodiscard]] ra8_err_t ra8_rabook_comic_init(ra8_rabook_comic_t*                 comic,
                                              const ra8_rabook_comic_workspace_t* workspace,
                                              ra8_rabook_image_read_fn            image_read,
                                              ra8_rabook_comic_write_at_fn        image_write,
                                              void*                               image_ctx,
                                              uint16_t                            max_image_edge,
                                              uint8_t                             pixel_format);

[[nodiscard]] ra8_err_t ra8_rabook_comic_add_page(ra8_rabook_comic_t* comic,
                                                  const char*         page_id,
                                                  const uint8_t*      source,
                                                  size_t              source_size);

[[nodiscard]] ra8_err_t ra8_rabook_comic_finish(ra8_rabook_comic_t*                comic,
                                                const ra8_rabook_comic_metadata_t* metadata,
                                                ra8_rabook_write_fn                write,
                                                void*                              write_ctx,
                                                uint32_t*                          out_len);
 
#ifdef __cplusplus
} /* extern "C" */
#endif