How ic-scm/openrevolution works
Project type and purpose
• This is a C++‐based open‐source command‐line toolkit plus library (“OpenRevolution”) for decoding, encoding, converting and playing Nintendo audio formats (BRSTM, BCSTM, BFSTM, BWAV, etc.). It provides:
• A core library (src/lib/…) exposing encoder/decoder APIs
• CLI tools (src/converter.cpp, src/decoder.cpp, src/encoder.cpp, src/rebuilder.cpp, src/reencoder.cpp)
• A real-time player (src/rt_player/…) using RtAudio
File structure
• Top-level artifacts:
• build.sh – build script
• README.md, LICENSE
• src/:
• converter.cpp, decoder.cpp, encoder.cpp, rebuilder.cpp, reencoder.cpp – command‐line frontends
• lib/ – core library modules:
– audio_decoder.h / audio_encoder.h – public interfaces
– brstm.h, brstm_encode.h – format‐specific headers
– crc/ – CRC utilities
– d_formats/, e_formats/ – modular decode/encode format implementations
– dspadpcm_encoder.c – codec implementation
– utils.h – shared helpers
• rt_player/ – real-time player:
– main.cpp, ui.h, utils.h – CLI UI
– RtAudio.h, rtaudio_c.h – external audio I/O
• No GUI yet; purely CLI + library
README for additional insights
• Describes supported formats, lossless conversion, usage instructions
• Mentions optional dependencies: ffmpeg (for advanced audio ops), librtaudio, POSIX threads
Detail
• Every logical sub‐component: separate decode vs. encode modules, CRC unit, DSPADPCM codec
• Don’t shy away from breaking the library core into its sub‐folders so the engineer sees each extension point