serialise.h

Go to the documentation of this file.

/*
 * This source file forms part of libsxbp, a library which generates
 * experimental 2D spiral-like shapes based on input binary data.
 */

#ifndef SAXBOPHONE_SAXBOSPIRAL_SERIALISE_H
#define SAXBOPHONE_SAXBOSPIRAL_SERIALISE_H

#include <stddef.h>

#include "saxbospiral.h"


#ifdef __cplusplus
extern "C"{
#endif

typedef enum sxbp_deserialise_diagnostic_t {
    SXBP_DESERIALISE_OK,
    SXBP_DESERIALISE_BAD_HEADER_SIZE,
    SXBP_DESERIALISE_BAD_MAGIC_NUMBER,
    SXBP_DESERIALISE_BAD_VERSION,
    SXBP_DESERIALISE_BAD_DATA_SIZE,
} sxbp_deserialise_diagnostic_t;

typedef struct sxbp_serialise_result_t {
    sxbp_status_t status;
    sxbp_deserialise_diagnostic_t diagnostic;
} sxbp_serialise_result_t;

extern const size_t SXBP_FILE_HEADER_SIZE;
extern const size_t SXBP_LINE_T_PACK_SIZE;

sxbp_serialise_result_t sxbp_load_spiral(
    sxbp_buffer_t buffer, sxbp_spiral_t* spiral
);

sxbp_serialise_result_t sxbp_dump_spiral(
    sxbp_spiral_t spiral, sxbp_buffer_t* buffer
);

#ifdef __cplusplus
} // extern "C"
#endif

// end of header file
#endif