README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100


libADLMIDI
libADLMIDI is a free MIDI to WAV conversion library with OPL3 emulation
Original ADLMIDI code: Copyright (c) 2010-2014 Joel Yliluoma bisqwit@iki.fi
ADLMIDI Library API:   Copyright (c) 2015-2016 Vitaly Novichkov admin@wohlnet.ru
Library is based on the ADLMIDI, a MIDI player for Linux and Windows with OPL3 emulation:
http://iki.fi/bisqwit/source/adlmidi.html
Differences with original tool

Reverb code has been removed.
Doesn't contains platform specific code. Library can be used with various purposes include making of a custom music decoders for a media players and usage with a games.

Tested on platforms

Linux GCC 4.8, 4.9, 5.4 / CLang
Mac OS X CLang (Xcode 7.x)
Windows MinGW 4.9.x, 5.2
Android NDK 12b/13

Key features

OPL3 emulation with four-operator mode support
FM patches from a number of known PC games, copied from files typical to AIL = Miles Sound System / DMX / HMI = Human Machine Interfaces / Creative IBK.
Stereo sound
Number of simulated soundcards can be specified as 1-100 (maximum channels 1800!)
Pan (binary panning, i.e. left/right side on/off)
Pitch-bender with adjustable range
Vibrato that responds to RPN/NRPN parameters
Sustain enable/disable
MIDI and RMI file support
loopStart / loopEnd tag support (Final Fantasy VII)
Use automatic arpeggio with chords to relieve channel pressure
Support for multiple concurrent MIDI synthesizers (per-track device/port select FF 09 message), can be used to overcome 16 channel limit
Support for playing Id-software Music File format (IMF)

How to build
You can build shared version and additional tools on the Linux when you will run a "make" command and you will have libadlmidi.so and additional tools in the "bin" directory.
You also can build library manually:
You need to make in the any IDE a library project and put into it next files
(or include those files into subfolder of your exist project instead if you want to use it statically):


adlmidi.h    - Library API, use it to communicate with library


dbopl.h       - DOSBOX OPL Emulation header

nukedopl3.h   - Nuked OPL3 Emulation header
fraction.h    - Fraction number handling

adldata.hh    - bank structures definition


dbopl.cpp     - DOSBOX OPL Emulation code

nukedopl3.c   - Nuked OPL3 Emulation code
adlmidi.cpp   - code of library
adldata.cpp    - Automatically generated dump of FM banks from "fm_banks" directory
               via "gen_adldata" tool

Example
In the src/midiplay you will found alone CPP file which an example of library usage.
That example is a simple audio player based on SDL Audio usage.
To build that example you will need to have installed SDL2 library.
Working demos

PGE MusPlay for Win32 (also available for other platforms as part of PGE Project) - a little music player which uses SDL Mixer X library (fork of the SDL Mixer 2.0) which has embedded libADLMIDI to play MIDI files independently from operating system's settings and drivers. 
(source code of player can be find here and source code of SDL Mixer X here)
ADLMIDI Player for Android - a little MIDI-player for Android which uses libADLMIDI to play MIDI files and provides flexible GUI with ability to change bank, flags, number of emulated chips, etc.

Todo

Add support of MIDI Format 2 files (FL Studio made MIDI-files are wired and opening of those files making lossy of tempo and some meta-information events)
Time based Seek/Tell support
Support of title and other meta-tags retrieving
Support of real-time listening of incoming MIDI-commands.
  That will allow to use library as software MIDI Output device
  to play any MIDI via this library.

Changelog
1.1.1    2016-12-09

Added a changable volume ranges models (Automatic for some banks, Generic, CMF, DMX, Apogee and 9X)

1.1.0    2016-12-06

Added Nuked OPL3 emulator which is more accurate (but requires more CPU power, therefore kept ability to use DosBox OPL3 via macro)
Fixed warnings of CLang code model plugin
Fixed bend coefficient which makes hi-hats in DOOM banks be incorrectly

1.0.3    2016-08-06

Added handling of 111'th controller as "loopStart" (which used by RPG-Maker)
Fixed infinite loop caused by blank MIDI-files (add extra second of waiting if over 10000 0-waiting loops are been detected)
Fixed damaged playing of IMF files (cased by wrong implementation of getc() function where return type must be int, not unsigned char)

1.0.2    2016-03-16

Fixed infinite loop causes swapped loopEnd and loopStart (when loopEnd goes before loopStart)
Fixed sielent volume tracks (when initial voule is zero, tracks wouldn't be playd even after applying fading in volume events)
More accurate fine tuning for second voice for DMX-based banks (playback now is more like original DOOM than before!)
Library's Output data now in short format (no more need to do extra conversions to make 16-bit audio stream from every 16-bit
   sample stored into each 32-bit integer)

1.0.0    2015-10-10

First release of library