Files
Dreierpack-Manager/src/audio/original.hpp
T
ClaudeandClaude Sonnet 5.5 287b5a9251 Add header comments to the source files
Every source file in ui, app, game, formats, cli, audio and launch that had none
now starts with a short English comment: what it implements, what state it owns
and how it relates to its neighbours (request/acknowledge flow, pairs of files,
random generator use). Comment lines only; the full build and the runnable
tests are unchanged.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
2026-11-06 09:15:23 +01:00

74 lines
3.1 KiB
C++

// SPDX-License-Identifier: GPL-3.0-only
// Emulation of the original game's sound system (MIDI-style sequencer, OPL FM instruments
// and one Sound Blaster PCM channel) as OriginalSynth. The application reads the sound
// containers (S/2000..2003) and the frequency/operator tables from the user's executable
// and hands them in as OriginalAssets; this module knows nothing about game state, file
// layout, the simulation clock or random generators. command() takes the original sound ids
// (0 title, 1 desk, 2 intro, 3 crowd, 8 stop, 10..22 effects); render() fills PCM blocks
// without allocating. Implemented in original.cpp, driven by Playback and the audio tools.
#pragma once
#include <array>
#include <cstdint>
#include <functional>
#include <memory>
#include <span>
#include <string>
#include <vector>
namespace openbmh::audio {
// Read from the user's executable by the application. Audio does not know the
// game state, filesystem layout, simulation clock, or random generators.
struct OriginalTables {
std::array<std::uint16_t, 96> frequencies{}; // Audio_OriginalAudioAssets_RuntimeField2, including key-on bits
std::array<std::uint8_t, 9> operators{}; // Audio_OriginalAudioAssets_RuntimeField, stride16
};
struct OriginalAssets {
std::array<std::vector<std::uint8_t>, 4> containers; // S/2000..2003
OriginalTables tables;
};
struct OriginalAudioOptions {
bool music = true;
bool effects = true;
bool clicks = true;
};
struct OriginalAudioStats {
std::uint64_t ticks{}, register_writes{}, sample_starts{}, frames{};
std::uint32_t bar{}, step{}, song = 255;
bool playing{}, ambient{}, failed{};
};
// The Original MIDILINK sequencer and one Sound Blaster PCM channel. IRQ0 uses
// PIT divisor0x199a. SONG/TRCK/PART, OPL instruments, SFX priorities/lifetimes,
// note durations, sample interruption and the looping crowd are Source-derived.
// Loading owns/validates its inputs. render() allocates nothing and never blocks.
class OriginalSynth {
public:
OriginalSynth();
~OriginalSynth();
OriginalSynth(const OriginalSynth&) = delete;
OriginalSynth& operator=(const OriginalSynth&) = delete;
bool load(OriginalAssets assets, std::uint32_t output_rate, std::string& error);
bool ready() const noexcept;
void set_options(OriginalAudioOptions options) noexcept;
// Source dispatch IDs:0 title,1 desk,2 intro,3 crowd,8 stop,10..22 effects.
bool command(std::uint8_t id) noexcept;
// Direct SFX entry, also used by the standalone driver/oracle.
bool effect(std::uint8_t id) noexcept;
void stop() noexcept;
void render(std::span<std::int16_t> output, float volume = 1.0F) noexcept;
OriginalAudioStats stats() const noexcept;
// Deterministic hardware-independent probe: one Original IRQ0, not one game
// tick. Optional observers are installed only by offline validation tools.
void tick() noexcept;
void set_register_observer(std::function<void(std::uint8_t, std::uint8_t)> observer);
void set_sample_observer(std::function<void(std::uint8_t)> observer);
private:
struct State;
std::unique_ptr<State> state_;
};
} // namespace openbmh::audio