ngcw_junk.h

Go to the documentation of this file.

/*
 * This file is part of the Aaru Data Preservation Suite.
 * Copyright (c) 2019-2026 Natalia Portillo.
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 2.1 of the License.
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, see
 * <https://www.gnu.org/licenses/>.
 *
 * Nintendo GameCube/Wii junk map: serialization, deserialization, regeneration.
 */
 
#ifndef LIBAARUFORMAT_NGCW_JUNK_H
#define LIBAARUFORMAT_NGCW_JUNK_H
 
#include <stdbool.h>
#include <stdint.h>
 
#include "lfg.h"
 
/* Forward declaration — guard against redefinition when aaruformat.h is also included */
#ifndef AARUFORMAT_CONTEXT_DECLARED
#define AARUFORMAT_CONTEXT_DECLARED
typedef struct aaruformat_context aaruformat_context;
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#define NGCW_JUNK_MAP_VERSION 1 

    typedef struct NgcwJunkEntry
    {
        uint64_t offset;                  
        uint64_t length;                  
        uint16_t partition_index;         
        uint32_t seed[NGC_LFG_SEED_SIZE]; 
    } NgcwJunkEntry;

    int32_t ngcw_serialize_junk_map(const NgcwJunkEntry *entries, uint32_t count, uint8_t **out_data,
                                    uint32_t *out_len);

    int32_t ngcw_deserialize_junk_map(const uint8_t *data, uint32_t data_len, NgcwJunkEntry **entries, uint32_t *count,
                                      uint16_t *seed_size);

    int ngcw_regenerate_junk_sector(const NgcwJunkEntry *entries, uint32_t entry_count, uint64_t disc_offset,
                                    uint8_t *output, uint32_t length);

    void ngcw_junk_lazy_init(aaruformat_context *ctx);
 
#ifdef __cplusplus
}
#endif
 
#endif /* LIBAARUFORMAT_NGCW_JUNK_H */