blob: f3862557a902c2eaf8f159e49fb36ed1ef034d35 [file] [log] [blame] [raw]
/*
* Library to access OPL2/OPL3 hardware (YM3812 / YMF262)
*
* Copyright (C) 2015-2016 Mateusz Viste
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
*
* 1. Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
#ifndef opl_h_sentinel
#define opl_h_sentinel
struct timbre_t {
unsigned long modulator_E862, carrier_E862;
unsigned char modulator_40, carrier_40;
unsigned char feedconn;
signed char finetune;
};
/* Initialize hardware upon startup - positive on success, negative otherwise
* Returns 0 for OPL2 initialization, or 1 if OPL3 has been detected */
int opl_init(unsigned short port);
/* close OPL device */
void opl_close(unsigned short port);
/* turns off all notes */
void opl_clear(unsigned short port);
/* turn note 'on', on emulated MIDI channel */
void opl_midi_noteon(unsigned short port, int channel, int note, int velocity);
/* turn note 'off', on emulated MIDI channel */
void opl_midi_noteoff(unsigned short port, int channel, int note);
/* adjust the pitch wheel on emulated MIDI channel */
void opl_midi_pitchwheel(unsigned short outport, int channel, int wheelvalue);
/* emulate MIDI 'controller' messages on the OPL */
void opl_midi_controller(unsigned short oplport, int channel, int id, int value);
/* assign a new instrument to emulated MIDI channel */
void opl_midi_changeprog(int channel, int program);
void opl_loadinstrument(unsigned short port, unsigned short voice, struct timbre_t *timbre);
/* loads an IBK bank from file into an array of 128 timbre_t structures.
* returns 0 on success, non-zero otherwise */
int opl_loadbank(char *file);
/* the functions below are not necessarily useful - if you want to play MIDI,
* you will probably prefer to use the opl_midi_* emulation layer instead of
* dealing with OPL's voices directly - in any case, do NOT mix calls to MIDI
* emulation functions (opl_midi_*) with any of the functions below! */
/* turn off note on selected voice */
void opl_noteoff(unsigned short port, unsigned short voice);
/* turn on note on selected voice */
void opl_noteon(unsigned short port, unsigned short voice, unsigned int note, int pitch);
#endif