Skip to content

Commit 0b87f4b

Browse files
committed
Update README: Release is ready.
1 parent 7900c77 commit 0b87f4b

File tree

1 file changed

+6
-9
lines changed

1 file changed

+6
-9
lines changed

README.md

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,6 @@
11

22
# Mega PCM 2
33

4-
> [!WARNING]
5-
>
6-
> The development of Mega PCM 2 is 99.999999% complete, but some integrations and cross-platform build system are still pending. For proper support, **please wait until documentation is finalized and release is officially announced.**
7-
84
**Mega PCM 2** is a DAC sound driver for Sega Mega-Drive / Genesis. It offers the highest quality playback possible on the hardware, high sample rate (up to 32 kHz), pitch/volume effects and supports several sample formats (WAVE, raw PCM, compressed DPCM).
95

106
Unlike the majority of DAC drivers on the Mega-Drive with the infamous "scratchy" playback many games are known for, Mega PCM 2 outputs cleanest sounding samples on the hardware thanks to its buffering / DMA protection system.
@@ -21,14 +17,14 @@ Mega PCM runs primarily on the Z80 CPU and is DAC only. To take full advantage o
2117
- Complex inside, user-friendly outside:
2218
- Zero-config DMA protection (no extra flags to set and unset, simply don't stop Z80 on DMA's);
2319
- Native WAVE file support, native PCM format (no custom converters required!);
24-
- Auto-detects issues with WAVE formats or sample configuration on startup;
20+
- Auto-detects issues with sample formats or configuration on startup;
2521
- Several supported sample formats:
26-
- WAVE file with 8-bit unsigned PCM (playback rate can be detected from header);
22+
- WAVE files in 8-bit unsigned PCM format (sample rate can be detected from header);
2723
- Raw 8-bit unsigned PCM (headless);
2824
- Raw 4-bit DPCM (headless);
2925
- Playback control, priority settings and SFX support:
3026
- Pause, Stop and Loop supported for all sample types;
31-
- Differentiates between "normal" samples (usually BGM drums) and SFX samples;
27+
- Differentiates between "normal" (usually BGM drums) and SFX samples;
3228
- SFX samples aren't interrupted by BGM drums, they have separate volume and pan settings;
3329
- Tested to the extreme:
3430
- Z80 portion of Mega PCM is unique in that it's extensively auto-tested in a virtual machine;
@@ -46,7 +42,6 @@ Mega PCM runs primarily on the Z80 CPU and is DAC only. To take full advantage o
4642
- [Sonic 1 Github Disassembly (AS version)](docs/1-installation/Sonic-1-Github-AS.md)
4743
- [Sonic 1 Hivebrain 2005 Disassembly](docs/1-installation/Sonic-1-Hivebrain-2005.md)
4844

49-
5045
### Documentation
5146

5247
- [API Documentation](docs/API.md)
@@ -96,7 +91,9 @@ Almost the same as Linux, however you need to make sure to use GNU version of Ma
9691

9792
## Licensing
9893

99-
**Mega PCM 2's main source code and its dependencies (`src/`, `lib-68k/`, `examples/` directories) are fully free and open source and are provided under MIT license. See `LICENSE` file.**
94+
**Mega PCM 2's main source code and its dependencies (`src/` and `lib-68k/`directories) are fully free and open source and are provided under MIT license. See `LICENSE` file.**
95+
96+
Source code for Mega PCM 2 implementation examples (`examples/` directory) is also MIT-licensed, however, some included assets and disassembled "SMPS" sound driver may be proprietary and provided for educational purposes only.
10097

10198
Also included in this repo, but not distributed with Mega PCM 2 releases:
10299

0 commit comments

Comments
 (0)