2024-11-28 22:31:01 +00:00
|
|
|
Prog8 ZSMKIT (v1) music player library integration
|
|
|
|
|
--------------------------------------------------
|
2024-11-01 22:13:43 +00:00
|
|
|
|
2024-11-28 22:31:01 +00:00
|
|
|
ZSMKIT V1: https://github.com/mooinglemur/zsmkit/tree/v1
|
2024-11-01 22:13:43 +00:00
|
|
|
(evolution of Zerobyte's ZSOUND, by MooingLemur). Read the README there!
|
2024-11-28 22:31:01 +00:00
|
|
|
Note: the current version of Zsmkit is V2. See below.
|
2024-11-01 22:13:43 +00:00
|
|
|
|
|
|
|
|
|
|
|
|
|
DEMO1: LOW-RAM ZSMKIT + STREAMING
|
|
|
|
|
----------------------------------
|
|
|
|
|
demo1.p8 shows a way to embed the zsmkit blob into the program itself (at $0830).
|
|
|
|
|
It then uses the streaming support in zsmkit to load the song from disk as it is played.
|
|
|
|
|
It shows some other features such as callbacks and pausing as well.
|
|
|
|
|
The way the zsmkit blob is embedded into the program is done by telling prog8 that
|
|
|
|
|
the 'main' block of the program has to start at $0830, and the very first command
|
2024-11-24 15:13:13 +00:00
|
|
|
in that block is not the usual 'start' subroutine but an %asmbinary command to load
|
2024-11-01 22:13:43 +00:00
|
|
|
and embed the zsmkit blob right there and then.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
DEMO2: HI-RAM ZSMKIT + PRELOADING
|
|
|
|
|
----------------------------------
|
|
|
|
|
demo2.p8 shows a simpler program that loads a zsmkit blob into upper memory at $8c00
|
|
|
|
|
and then also preloads the whole music file into hi-ram. No streaming is used to
|
|
|
|
|
play it, it plays everything from ram.
|
|
|
|
|
Note that the zsmkit blob used for this is a smaller build as the $0830 one because
|
|
|
|
|
this one was configured without streaming support enabled.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
CUSTOMIZING ZSMKIT
|
|
|
|
|
------------------
|
|
|
|
|
|
2024-11-24 15:13:13 +00:00
|
|
|
Read the README on the zsmkit GitHub repo. It contains a lot of important information,
|
2024-11-01 22:13:43 +00:00
|
|
|
about how zsmkit works, but also about the various things you have to configure to build a
|
|
|
|
|
new library blob to your liking. The example here includes two recently built variants of the blob,
|
|
|
|
|
so you don't immediately have to build something yourself, but if you want to enable or disable
|
|
|
|
|
streaming support or change the load address you'll have to build one yourself.
|
|
|
|
|
See the "alternative builds" chapter.
|
|
|
|
|
|
|
|
|
|
|
2024-11-28 22:31:01 +00:00
|
|
|
ZSMKIT V2
|
|
|
|
|
---------
|
|
|
|
|
Zsmkit v2 is current and has some important changes that will make it much easier
|
|
|
|
|
to integrate it into prog8 programs. Less RAM usage and a fixed jump table location,
|
|
|
|
|
among other changes. However, it requires the ZSM to be loaded in Ram completely
|
|
|
|
|
because it has no streaming support anymore. So Zsmkit v1 might still have some uses.
|
|
|
|
|
|
