RagePhotoTypedefs.h

/*****************************************************************************
* libragephoto RAGE Photo Parser
* Copyright (C) 2021-2024 Syping
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* This software is provided as-is, no warranties are given to you, we are not
* responsible for anything with use of the software, you are self responsible.
*****************************************************************************/
 
#ifndef RAGEPHOTOTYPEDEFS_H
#define RAGEPHOTOTYPEDEFS_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus
 
typedef struct RagePhotoData {
    char* jpeg; 
    char* description; 
    char* json; 
    char* header; 
    char* title; 
    int32_t error; 
    uint32_t descBuffer; 
    uint32_t descOffset; 
    uint32_t endOfFile; 
    uint32_t headerSum; 
    uint32_t headerSum2; 
    uint32_t jpegBuffer; 
    uint32_t jpegSize; 
    uint32_t jsonBuffer; 
    uint32_t jsonOffset; 
    uint32_t photoFormat; 
    uint32_t titlBuffer; 
    uint32_t titlOffset; 
} RagePhotoData;
 
typedef bool (*ragephoto_loadfunc_t)(RagePhotoData*, const char*, size_t);
 
typedef bool (*ragephoto_savefunc_t)(RagePhotoData*, char*, uint32_t);
 
typedef bool (*ragephoto_savepfunc_t)(RagePhotoData*, char**, uint32_t);
 
typedef size_t (*ragephoto_saveszfunc_t)(RagePhotoData*, uint32_t);
 
typedef struct RagePhotoFormatParser {
    uint32_t photoFormat; 
    ragephoto_loadfunc_t funcLoad; 
    ragephoto_savefunc_t funcSave; 
    ragephoto_savepfunc_t funcSavep; 
    ragephoto_saveszfunc_t funcSaveSz; 
} RagePhotoFormatParser;
 
typedef struct RagePhotoInstance {
    RagePhotoData *data; 
    RagePhotoFormatParser *parser; 
} RagePhotoInstance;
 
typedef enum RagePhotoLibraryFlag {
    RAGEPHOTO_FLAG_LEGACY_NULL_RETURN = 1 << 0 
} RagePhotoLibraryFlag;
 
/* RagePhoto default sizes */
#define RAGEPHOTO_DEFAULT_GTA5_PHOTOBUFFER UINT32_C(524288) 
#define RAGEPHOTO_DEFAULT_RDR2_PHOTOBUFFER UINT32_C(1048576) 
#define RAGEPHOTO_DEFAULT_DESCBUFFER UINT32_C(256) 
#define RAGEPHOTO_DEFAULT_JSONBUFFER UINT32_C(3072) 
#define RAGEPHOTO_DEFAULT_TITLBUFFER UINT32_C(256) 
#define RAGEPHOTO_GTA5_HEADERSIZE UINT32_C(264) 
#define RAGEPHOTO_RDR2_HEADERSIZE UINT32_C(272) 
/* RagePhoto error codes */
#define RAGEPHOTO_ERROR_DESCBUFFERTIGHT INT32_C(39) 
#define RAGEPHOTO_ERROR_DESCMALLOCERROR INT32_C(31) 
#define RAGEPHOTO_ERROR_DESCREADERROR INT32_C(32) 
#define RAGEPHOTO_ERROR_HEADERBUFFERTIGHT INT32_C(35) 
#define RAGEPHOTO_ERROR_HEADERMALLOCERROR INT32_C(4) 
#define RAGEPHOTO_ERROR_INCOMPATIBLEFORMAT INT32_C(2) 
#define RAGEPHOTO_ERROR_INCOMPLETECHECKSUM INT32_C(7) 
#define RAGEPHOTO_ERROR_INCOMPLETEDESCBUFFER INT32_C(30) 
#define RAGEPHOTO_ERROR_INCOMPLETEDESCMARKER INT32_C(28) 
#define RAGEPHOTO_ERROR_INCOMPLETEDESCOFFSET INT32_C(11) 
#define RAGEPHOTO_ERROR_INCOMPLETEEOF INT32_C(8) 
#define RAGEPHOTO_ERROR_INCOMPLETEHEADER INT32_C(3) 
#define RAGEPHOTO_ERROR_INCOMPLETEJENDMARKER INT32_C(33) 
#define RAGEPHOTO_ERROR_INCOMPLETEJPEGMARKER INT32_C(12) 
#define RAGEPHOTO_ERROR_INCOMPLETEJSONBUFFER INT32_C(20) 
#define RAGEPHOTO_ERROR_INCOMPLETEJSONMARKER INT32_C(18) 
#define RAGEPHOTO_ERROR_INCOMPLETEJSONOFFSET INT32_C(9) 
#define RAGEPHOTO_ERROR_INCOMPLETEPHOTOBUFFER INT32_C(14) 
#define RAGEPHOTO_ERROR_INCOMPLETEPHOTOSIZE INT32_C(15) 
#define RAGEPHOTO_ERROR_INCOMPLETETITLEBUFFER INT32_C(25) 
#define RAGEPHOTO_ERROR_INCOMPLETETITLEMARKER INT32_C(23) 
#define RAGEPHOTO_ERROR_INCOMPLETETITLEOFFSET INT32_C(10) 
#define RAGEPHOTO_ERROR_INCORRECTDESCMARKER INT32_C(29) 
#define RAGEPHOTO_ERROR_INCORRECTJENDMARKER INT32_C(34) 
#define RAGEPHOTO_ERROR_INCORRECTJPEGMARKER INT32_C(13) 
#define RAGEPHOTO_ERROR_INCORRECTJSONMARKER INT32_C(19) 
#define RAGEPHOTO_ERROR_INCORRECTTITLEMARKER INT32_C(24) 
#define RAGEPHOTO_ERROR_JSONBUFFERTIGHT INT32_C(37) 
#define RAGEPHOTO_ERROR_JSONMALLOCERROR INT32_C(21) 
#define RAGEPHOTO_ERROR_JSONREADERROR INT32_C(22) 
#define RAGEPHOTO_ERROR_NOERROR INT32_C(255) 
#define RAGEPHOTO_ERROR_NOFORMATIDENTIFIER INT32_C(1) 
#define RAGEPHOTO_ERROR_PHOTOBUFFERTIGHT INT32_C(36) 
#define RAGEPHOTO_ERROR_PHOTOMALLOCERROR INT32_C(16) 
#define RAGEPHOTO_ERROR_PHOTOREADERROR INT32_C(17) 
#define RAGEPHOTO_ERROR_TITLEBUFFERTIGHT INT32_C(38) 
#define RAGEPHOTO_ERROR_TITLEMALLOCERROR INT32_C(26) 
#define RAGEPHOTO_ERROR_TITLEREADERROR INT32_C(27) 
#define RAGEPHOTO_ERROR_UNICODEINITERROR INT32_C(5) 
#define RAGEPHOTO_ERROR_UNICODEHEADERERROR INT32_C(6) 
#define RAGEPHOTO_ERROR_UNINITIALISED INT32_C(0) 
/* RagePhoto formats */
#define RAGEPHOTO_FORMAT_GTA5 UINT32_C(0x01000000) 
#define RAGEPHOTO_FORMAT_RDR2 UINT32_C(0x04000000) 
/* RagePhoto sign initials */
#define RAGEPHOTO_SIGNINITIAL_GTA5 UINT32_C(0xE47AB81C) 
#define RAGEPHOTO_SIGNINITIAL_RDR2 UINT32_C(0x00FEEB1E) 
#ifdef __cplusplus
}
#endif // __cplusplus
 
#endif // RAGEPHOTOTYPEDEFS_H