aboutsummaryrefslogtreecommitdiff
path: root/include
diff options
context:
space:
mode:
authorJuan J. Martinez <jjm@usebox.net>2021-01-09 09:01:05 +0000
committerJuan J. Martinez <jjm@usebox.net>2021-01-09 09:01:05 +0000
commit9bcf1e97960c0da7322a868efdbc07e2650716fe (patch)
treede6d32ad5b0e567991bd3eb262902c15a77074d9 /include
parent3b31adf01305e522f7e28c1435fb47418ce43267 (diff)
downloadubox-msx-lib-9bcf1e97960c0da7322a868efdbc07e2650716fe.tar.gz
ubox-msx-lib-9bcf1e97960c0da7322a868efdbc07e2650716fe.zip
Extra libs: ap.lib
aPLib support with apultra.
Diffstat (limited to 'include')
-rw-r--r--include/ap.h30
1 files changed, 30 insertions, 0 deletions
diff --git a/include/ap.h b/include/ap.h
new file mode 100644
index 0000000..4875f88
--- /dev/null
+++ b/include/ap.h
@@ -0,0 +1,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:
+//
+// ```
+// 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