aboutsummaryrefslogtreecommitdiff
path: root/include/ap.h
blob: a42e16d6be2c4f38aacf6d99fa9d5c73386933f3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
#ifndef _AP_H
#define _AP_H

#include <stdint.h>

// @aPLib compression
//
// The `ap.lib` library allows decompressing data compressed by
// [aPLib](https://ibsensoftware.com/products_aPLib.html).
//
// [apultra](https://github.com/emmanuel-marty/apultra) is an optimal
// compressor for the aPLib format and it is included in tools for convenience.
//
// It will be compiled as part of the tools, but you can compile it
// independently with:
//
// ```bash
// make bin/apultra
// ```
//
// The resulting binary will be placed in the `bin` directory.

/**
 * Uncompress the data pointed by `src` into the memory pointed by `dst`.
 *
 * The compressed data is expected to be in aPLib raw format.
 */
void ap_uncompress(const uint8_t *dst, const uint8_t *src);

#endif // _AP_H