https://github.com/a740g/bin2data
Binary to DATA converter and library for QB64-PE
https://github.com/a740g/bin2data
base64 base64-decoding base64-encoding command-line commandline-tool deflate deflate-compression library qb64 qb64-pe qbasic quickbasic retro zopfli zopfli-compression
Last synced: about 1 month ago
JSON representation
Binary to DATA converter and library for QB64-PE
- Host: GitHub
- URL: https://github.com/a740g/bin2data
- Owner: a740g
- License: mit
- Created: 2023-02-04T12:18:41.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-12-21T06:32:40.000Z (5 months ago)
- Last Synced: 2024-12-21T07:25:18.984Z (5 months ago)
- Topics: base64, base64-decoding, base64-encoding, command-line, commandline-tool, deflate, deflate-compression, library, qb64, qb64-pe, qbasic, quickbasic, retro, zopfli, zopfli-compression
- Language: QuickBASIC
- Homepage: https://qb64phoenix.com/forum/showthread.php?tid=2228
- Size: 762 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# BIN2DATA
Bin2Data and it's companion library is written in [QB64-PE](https://github.com/QB64-Phoenix-Edition/QB64pe), that allows for the conversion of binary files to Base64 encoded [DATA](https://qb64phoenix.com/qb64wiki/index.php/DATA) statements. This library not only encodes binary data into Base64, but also allows for the decoding of Base64 encoded data back into its binary form. The data is optionally compressed using Google's [Zopfli](https://github.com/google/zopfli) compression library if it sees any goodness. This means that files that are already compressed, may not go through one more compression and decompression step. The compressed data is compatible with QB64-PE's [_DEFLATE$](https://qb64phoenix.com/qb64wiki/index.php/DEFLATE$).
With this library, you can easily store binary data within your QB64 programs, making it easier to distribute and maintain the files required for your program to run. The library provides a simple API that you can use to perform encoding and decoding operations with just a few lines of code.
## FEATURES
* Encode binary files to Base64 encoded DATA or CONST statements.
* Export compressed binary files to C arrays or raw file dumps.
* Decode Base64 encoded data back into binary form.
* Simple API that makes it easy to use.
* Easy sharing of code and data in forums.
## USAGE
* Clone the repository to a directory of your choice
* Open Terminal and change to the directory using an appropriate OS command
* Run `git submodule update --init --recursive` to initialize, fetch and checkout git submodules
* Open *Bin2Data.bas* in the QB64-PE IDE and press `F5` to compile and run
* To use the library in your project add the [Toolbox64](https://github.com/a740g/Toolbox64) repository as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules)
* Then, simply include the library files in your QB64 program and call the relevant functions to perform encoding and decoding operations.
Assuming the a file has been encoded using Bin2Data, here's an example of how you can use the library to to decode Base64 encoded data.
```vb
' In this example we used Bin2Data on my_music.mp3 and it created a file called my_music.mp3.bi
' It assumes that you have cloned the Toolbox64 repo in the include subdirectory under your project directory
' First include the Base64 header file
'$INCLUDE:'include/Base64.bi'
' This label is from my_music_mp3.bi
RESTORE data_my_music_mp3_8192
' This loads the encoded & compressed data from the DATA statements after the label above
DIM buffer AS STRING: buffer = Base64_LoadResourceData
' Now do something with buffer
...
' Include the my_music.mp3.bi before your FUNCTIONs and SUBs
'$INCLUDE:'my_music_mp3.bi'
' OR
' Place contents of my_music_mp3.bi before your FUNCTIONs and SUBs
data_my_music_mp3_8192:
DATA 8192,9877,0
DATA ...
' Finally, don't forget to include the Base64 module file
'$INCLUDE:'include/Base64.bas'
```
## API
```vb
FUNCTION Base64_Encode$ (s AS STRING)
FUNCTION Base64_Decode$ (s AS STRING)
FUNCTION Base64_LoadResourceString$ (src AS STRING, ogSize AS _UNSIGNED LONG, isComp AS _BYTE)
FUNCTION Base64_LoadResourceData$
```
## NOTES
* This requires the latest version of [QB64-PE](https://github.com/QB64-Phoenix-Edition/QB64pe)
* When you clone a repository that contains submodules, the submodules are not automatically cloned by default
* You will need to use the `git submodule update --init --recursive` to initialize, fetch and checkout git submodules
* Get `Base64.bas` lite from [here](https://github.com/a740g/InForm-PE/blob/master/InForm/extensions/Base64.bas)
## ASSETS
* [Icon](https://www.iconarchive.com/artist/umut-pulat.html) by [Umut Pulat](http://12m3.deviantart.com/)