ref: 516fc276f112baf0bd4508596598aed49929bde9
dir: /src/audiolib/music.c/
/*
Copyright (C) 1994-1995 Apogee Software, Ltd.
Copyright (C) 2002-2015 icculus.org, GNU/Linux port
Copyright (C) 2017-2018 Steven LeVesque
This program is free software; you can redistribute it and/or
modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 2
of the License, or (at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
*/
/**********************************************************************
module: MUSIC.C
author: James R. Dose
date: March 25, 1994
Device independant music playback routines.
(c) Copyright 1994 James R. Dose. All Rights Reserved.
**********************************************************************/
#include <stdio.h>
#include <stdlib.h>
#include "task_man.h"
#include "sndcards.h"
#include "music.h"
#include "midi.h"
#include "al_midi.h"
#include "pas16.h"
#include "blaster.h"
#include "gusmidi.h"
#include "mpu401.h"
#include "awe32.h"
#include "sndscape.h"
#include "ll_man.h"
#include "user.h"
#define TRUE ( 1 == 1 )
#define FALSE ( !TRUE )
void TextMode( void );
#pragma aux TextMode = \
"mov ax, 0003h", \
"int 10h" \
modify [ ax ];
int MUSIC_SoundDevice = -1;
int MUSIC_ErrorCode = MUSIC_Ok;
static midifuncs MUSIC_MidiFunctions;
static int MUSIC_FadeLength;
static int MUSIC_FadeRate;
static unsigned MUSIC_CurrentFadeVolume;
static unsigned MUSIC_LastFadeVolume;
static int MUSIC_EndingFadeVolume;
static task *MUSIC_FadeTask = NULL;
int MUSIC_InitAWE32( midifuncs *Funcs );
int MUSIC_InitFM( int card, midifuncs *Funcs );
int MUSIC_InitMidi( int card, midifuncs *Funcs, int Address );
int MUSIC_InitGUS( midifuncs *Funcs );
#define MUSIC_SetErrorCode( status ) \
MUSIC_ErrorCode = ( status );
/*---------------------------------------------------------------------
Function: MUSIC_ErrorString
Returns a pointer to the error message associated with an error
number. A -1 returns a pointer the current error.
---------------------------------------------------------------------*/
char *MUSIC_ErrorString
(
int ErrorNumber
)
{
char *ErrorString;
switch( ErrorNumber )
{
case MUSIC_Warning :
case MUSIC_Error :
ErrorString = MUSIC_ErrorString( MUSIC_ErrorCode );
break;
case MUSIC_Ok :
ErrorString = "Music ok.";
break;
case MUSIC_ASSVersion :
ErrorString = "Apogee Sound System Version " ASS_VERSION_STRING " "
"Programmed by Jim Dose\n"
"(c) Copyright 1996 James R. Dose. All Rights Reserved.\n";
break;
case MUSIC_SoundCardError :
switch( MUSIC_SoundDevice )
{
case SoundBlaster :
case WaveBlaster :
ErrorString = BLASTER_ErrorString( BLASTER_Error );
break;
case ProAudioSpectrum :
case SoundMan16 :
ErrorString = PAS_ErrorString( PAS_Error );
break;
case Adlib :
ErrorString = "Adlib error.";
break;
case GenMidi :
case SoundCanvas :
ErrorString = "Could not detect MPU-401.";
break;
case SoundScape :
ErrorString = SOUNDSCAPE_ErrorString( SOUNDSCAPE_Error );
break;
case Awe32 :
ErrorString = AWE32_ErrorString( AWE32_Error );
break;
case UltraSound :
ErrorString = GUS_ErrorString( GUS_Error );
break;
default :
ErrorString = MUSIC_ErrorString( MUSIC_InvalidCard );
break;
}
break;
case MUSIC_MPU401Error :
ErrorString = "Could not detect MPU-401.";
break;
case MUSIC_InvalidCard :
ErrorString = "Invalid Music device.";
break;
case MUSIC_MidiError :
ErrorString = "Error playing MIDI file.";
break;
case MUSIC_TaskManError :
ErrorString = "TaskMan error.";
break;
case MUSIC_FMNotDetected :
ErrorString = "Could not detect FM chip.";
break;
case MUSIC_DPMI_Error :
ErrorString = "DPMI Error in MUSIC.";
break;
default :
ErrorString = "Unknown Music error code.";
break;
}
return( ErrorString );
}
/*---------------------------------------------------------------------
Function: MUSIC_Init
Selects which sound device to use.
---------------------------------------------------------------------*/
int MUSIC_Init
(
int SoundCard,
int Address
)
{
int i;
int status;
if ( USER_CheckParameter( "ASSVER" ) )
{
MUSIC_SetErrorCode( MUSIC_ASSVersion );
return( MUSIC_Error );
}
status = LL_LockMemory();
if ( status != LL_Ok )
{
MUSIC_SetErrorCode( MUSIC_DPMI_Error );
return( MUSIC_Error );
}
for( i = 0; i < 128; i++ )
{
MIDI_PatchMap[ i ] = i;
}
status = MUSIC_Ok;
MUSIC_SoundDevice = SoundCard;
switch( SoundCard )
{
case SoundBlaster :
case Adlib :
case ProAudioSpectrum :
case SoundMan16 :
status = MUSIC_InitFM( SoundCard, &MUSIC_MidiFunctions );
break;
case GenMidi :
case SoundCanvas :
case WaveBlaster :
case SoundScape :
status = MUSIC_InitMidi( SoundCard, &MUSIC_MidiFunctions, Address );
break;
case Awe32 :
status = MUSIC_InitAWE32( &MUSIC_MidiFunctions );
break;
case UltraSound :
status = MUSIC_InitGUS( &MUSIC_MidiFunctions );
break;
case SoundSource :
case PC :
default :
MUSIC_SetErrorCode( MUSIC_InvalidCard );
status = MUSIC_Error;
}
if ( status != MUSIC_Ok )
{
LL_UnlockMemory();
}
return( status );
}
/*---------------------------------------------------------------------
Function: MUSIC_Shutdown
Terminates use of sound device.
---------------------------------------------------------------------*/
int MUSIC_Shutdown
(
void
)
{
int status;
status = MUSIC_Ok;
MIDI_StopSong();
if ( MUSIC_FadeTask != NULL )
{
MUSIC_StopFade();
}
switch ( MUSIC_SoundDevice )
{
case Adlib :
AL_Shutdown();
break;
case SoundBlaster :
AL_Shutdown();
BLASTER_RestoreMidiVolume();
break;
case GenMidi :
case SoundCanvas :
case SoundScape :
MPU_Reset();
break;
case WaveBlaster :
BLASTER_ShutdownWaveBlaster();
MPU_Reset();
BLASTER_RestoreMidiVolume();
break;
case Awe32 :
AWE32_Shutdown();
BLASTER_RestoreMidiVolume();
break;
case ProAudioSpectrum :
case SoundMan16 :
AL_Shutdown();
PAS_RestoreMusicVolume();
break;
case UltraSound :
GUSMIDI_Shutdown();
break;
}
LL_UnlockMemory();
return( status );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetMaxFMMidiChannel
Sets the maximum MIDI channel that FM cards respond to.
---------------------------------------------------------------------*/
void MUSIC_SetMaxFMMidiChannel
(
int channel
)
{
AL_SetMaxMidiChannel( channel );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetVolume
Sets the volume of music playback.
---------------------------------------------------------------------*/
void MUSIC_SetVolume
(
int volume
)
{
volume = max( 0, volume );
volume = min( volume, 255 );
if ( MUSIC_SoundDevice != -1 )
{
MIDI_SetVolume( volume );
}
}
/*---------------------------------------------------------------------
Function: MUSIC_SetMidiChannelVolume
Sets the volume of music playback on the specified MIDI channel.
---------------------------------------------------------------------*/
void MUSIC_SetMidiChannelVolume
(
int channel,
int volume
)
{
MIDI_SetUserChannelVolume( channel, volume );
}
/*---------------------------------------------------------------------
Function: MUSIC_ResetMidiChannelVolumes
Sets the volume of music playback on all MIDI channels to full volume.
---------------------------------------------------------------------*/
void MUSIC_ResetMidiChannelVolumes
(
void
)
{
MIDI_ResetUserChannelVolume();
}
/*---------------------------------------------------------------------
Function: MUSIC_GetVolume
Returns the volume of music playback.
---------------------------------------------------------------------*/
int MUSIC_GetVolume
(
void
)
{
if ( MUSIC_SoundDevice == -1 )
{
return( 0 );
}
return( MIDI_GetVolume() );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetLoopFlag
Set whether the music will loop or end when it reaches the end of
the song.
---------------------------------------------------------------------*/
void MUSIC_SetLoopFlag
(
int loopflag
)
{
MIDI_SetLoopFlag( loopflag );
}
/*---------------------------------------------------------------------
Function: MUSIC_SongPlaying
Returns whether there is a song playing.
---------------------------------------------------------------------*/
int MUSIC_SongPlaying
(
void
)
{
return( MIDI_SongPlaying() );
}
/*---------------------------------------------------------------------
Function: MUSIC_Continue
Continues playback of a paused song.
---------------------------------------------------------------------*/
void MUSIC_Continue
(
void
)
{
MIDI_ContinueSong();
}
/*---------------------------------------------------------------------
Function: MUSIC_Pause
Pauses playback of a song.
---------------------------------------------------------------------*/
void MUSIC_Pause
(
void
)
{
MIDI_PauseSong();
}
/*---------------------------------------------------------------------
Function: MUSIC_StopSong
Stops playback of current song.
---------------------------------------------------------------------*/
int MUSIC_StopSong
(
void
)
{
MUSIC_StopFade();
MIDI_StopSong();
MUSIC_SetErrorCode( MUSIC_Ok );
return( MUSIC_Ok );
}
/*---------------------------------------------------------------------
Function: MUSIC_PlaySong
Begins playback of MIDI song.
---------------------------------------------------------------------*/
int MUSIC_PlaySong
(
unsigned char *song,
int loopflag
)
{
int status;
switch( MUSIC_SoundDevice )
{
case SoundBlaster :
case Adlib :
case ProAudioSpectrum :
case SoundMan16 :
case GenMidi :
case SoundCanvas :
case WaveBlaster :
case SoundScape :
case Awe32 :
case UltraSound :
MIDI_StopSong();
status = MIDI_PlaySong( song, loopflag );
if ( status != MIDI_Ok )
{
MUSIC_SetErrorCode( MUSIC_MidiError );
return( MUSIC_Warning );
}
break;
case SoundSource :
case PC :
default :
MUSIC_SetErrorCode( MUSIC_InvalidCard );
return( MUSIC_Warning );
break;
}
return( MUSIC_Ok );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetContext
Sets the song context.
---------------------------------------------------------------------*/
void MUSIC_SetContext
(
int context
)
{
MIDI_SetContext( context );
}
/*---------------------------------------------------------------------
Function: MUSIC_GetContext
Returns the current song context.
---------------------------------------------------------------------*/
int MUSIC_GetContext
(
void
)
{
return MIDI_GetContext();
}
/*---------------------------------------------------------------------
Function: MUSIC_SetSongTick
Sets the position of the song pointer.
---------------------------------------------------------------------*/
void MUSIC_SetSongTick
(
unsigned long PositionInTicks
)
{
MIDI_SetSongTick( PositionInTicks );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetSongTime
Sets the position of the song pointer.
---------------------------------------------------------------------*/
void MUSIC_SetSongTime
(
unsigned long milliseconds
)
{
MIDI_SetSongTime( milliseconds );
}
/*---------------------------------------------------------------------
Function: MUSIC_SetSongPosition
Sets the position of the song pointer.
---------------------------------------------------------------------*/
void MUSIC_SetSongPosition
(
int measure,
int beat,
int tick
)
{
MIDI_SetSongPosition( measure, beat, tick );
}
/*---------------------------------------------------------------------
Function: MUSIC_GetSongPosition
Returns the position of the song pointer.
---------------------------------------------------------------------*/
void MUSIC_GetSongPosition
(
songposition *pos
)
{
MIDI_GetSongPosition( pos );
}
/*---------------------------------------------------------------------
Function: MUSIC_GetSongLength
Returns the length of the song.
---------------------------------------------------------------------*/
void MUSIC_GetSongLength
(
songposition *pos
)
{
MIDI_GetSongLength( pos );
}
int MUSIC_InitAWE32
(
midifuncs *Funcs
)
{
int status;
status = AWE32_Init();
if ( status != AWE32_Ok )
{
MUSIC_SetErrorCode( MUSIC_SoundCardError );
return( MUSIC_Error );
}
Funcs->NoteOff = AWE32_NoteOff;
Funcs->NoteOn = AWE32_NoteOn;
Funcs->PolyAftertouch = AWE32_PolyAftertouch;
Funcs->ControlChange = AWE32_ControlChange;
Funcs->ProgramChange = AWE32_ProgramChange;
Funcs->ChannelAftertouch = AWE32_ChannelAftertouch;
Funcs->PitchBend = AWE32_PitchBend;
Funcs->ReleasePatches = NULL;
Funcs->LoadPatch = NULL;
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
if ( BLASTER_CardHasMixer() )
{
BLASTER_SaveMidiVolume();
Funcs->SetVolume = BLASTER_SetMidiVolume;
Funcs->GetVolume = BLASTER_GetMidiVolume;
}
status = MUSIC_Ok;
MIDI_SetMidiFuncs( Funcs );
return( status );
}
int MUSIC_InitFM
(
int card,
midifuncs *Funcs
)
{
int status;
int passtatus;
status = MIDI_Ok;
if ( !AL_DetectFM() )
{
MUSIC_SetErrorCode( MUSIC_FMNotDetected );
return( MUSIC_Error );
}
// Init the fm routines
AL_Init( card );
Funcs->NoteOff = AL_NoteOff;
Funcs->NoteOn = AL_NoteOn;
Funcs->PolyAftertouch = NULL;
Funcs->ControlChange = AL_ControlChange;
Funcs->ProgramChange = AL_ProgramChange;
Funcs->ChannelAftertouch = NULL;
Funcs->PitchBend = AL_SetPitchBend;
Funcs->ReleasePatches = NULL;
Funcs->LoadPatch = NULL;
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
switch( card )
{
case SoundBlaster :
if ( BLASTER_CardHasMixer() )
{
BLASTER_SaveMidiVolume();
Funcs->SetVolume = BLASTER_SetMidiVolume;
Funcs->GetVolume = BLASTER_GetMidiVolume;
}
else
{
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
}
break;
case Adlib :
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
break;
case ProAudioSpectrum :
case SoundMan16 :
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
passtatus = PAS_SaveMusicVolume();
if ( passtatus == PAS_Ok )
{
Funcs->SetVolume = PAS_SetFMVolume;
Funcs->GetVolume = PAS_GetFMVolume;
}
break;
}
MIDI_SetMidiFuncs( Funcs );
return( status );
}
int MUSIC_InitMidi
(
int card,
midifuncs *Funcs,
int Address
)
{
int status;
status = MUSIC_Ok;
if ( ( card == WaveBlaster ) || ( card == SoundCanvas ) ||
( card == GenMidi ) )
{
// Setup WaveBlaster Daughterboard clone
// (ie. SoundCanvas DB, TurtleBeach Rio)
BLASTER_SetupWaveBlaster();
}
if ( card == SoundScape )
{
Address = SOUNDSCAPE_GetMIDIPort();
if ( Address < SOUNDSCAPE_Ok )
{
MUSIC_SetErrorCode( MUSIC_SoundCardError );
return( MUSIC_Error );
}
}
if ( MPU_Init( Address ) != MPU_Ok )
{
MUSIC_SetErrorCode( MUSIC_MPU401Error );
return( MUSIC_Error );
}
Funcs->NoteOff = MPU_NoteOff;
Funcs->NoteOn = MPU_NoteOn;
Funcs->PolyAftertouch = MPU_PolyAftertouch;
Funcs->ControlChange = MPU_ControlChange;
Funcs->ProgramChange = MPU_ProgramChange;
Funcs->ChannelAftertouch = MPU_ChannelAftertouch;
Funcs->PitchBend = MPU_PitchBend;
Funcs->ReleasePatches = NULL;
Funcs->LoadPatch = NULL;
Funcs->SetVolume = NULL;
Funcs->GetVolume = NULL;
if ( card == WaveBlaster )
{
if ( BLASTER_CardHasMixer() )
{
BLASTER_SaveMidiVolume();
Funcs->SetVolume = BLASTER_SetMidiVolume;
Funcs->GetVolume = BLASTER_GetMidiVolume;
}
}
MIDI_SetMidiFuncs( Funcs );
return( status );
}
int MUSIC_InitGUS
(
midifuncs *Funcs
)
{
int status;
status = MUSIC_Ok;
if ( GUSMIDI_Init() != GUS_Ok )
{
MUSIC_SetErrorCode( MUSIC_SoundCardError );
return( MUSIC_Error );
}
Funcs->NoteOff = GUSMIDI_NoteOff;
Funcs->NoteOn = GUSMIDI_NoteOn;
Funcs->PolyAftertouch = NULL;
Funcs->ControlChange = GUSMIDI_ControlChange;
Funcs->ProgramChange = GUSMIDI_ProgramChange;
Funcs->ChannelAftertouch = NULL;
Funcs->PitchBend = GUSMIDI_PitchBend;
Funcs->ReleasePatches = NULL;//GUSMIDI_ReleasePatches;
Funcs->LoadPatch = NULL;//GUSMIDI_LoadPatch;
Funcs->SetVolume = GUSMIDI_SetVolume;
Funcs->GetVolume = GUSMIDI_GetVolume;
MIDI_SetMidiFuncs( Funcs );
return( status );
}
/*---------------------------------------------------------------------
Function: MUSIC_FadeRoutine
Fades music volume from current level to another over a specified
period of time.
---------------------------------------------------------------------*/
static void MUSIC_FadeRoutine
(
task *Task
)
{
int volume;
MUSIC_CurrentFadeVolume += MUSIC_FadeRate;
if ( MUSIC_FadeLength == 0 )
{
MIDI_SetVolume( MUSIC_EndingFadeVolume );
TS_Terminate( Task );
MUSIC_FadeTask = NULL;
}
else
{
MUSIC_FadeLength--;
// if ( ( MUSIC_SoundDevice == GenMidi ) &&
// ( ( MUSIC_FadeLength % 12 ) != 0 ) )
// {
// return;
// }
volume = MUSIC_CurrentFadeVolume >> 7;
if ( MUSIC_LastFadeVolume != volume )
{
MUSIC_LastFadeVolume = volume;
MIDI_SetVolume( volume );
}
}
}
/*---------------------------------------------------------------------
Function: MUSIC_FadeVolume
Fades music volume from current level to another over a specified
period of time.
---------------------------------------------------------------------*/
int MUSIC_FadeVolume
(
int tovolume,
int milliseconds
)
{
int fromvolume;
if ( ( MUSIC_SoundDevice == ProAudioSpectrum ) ||
( MUSIC_SoundDevice == SoundMan16 ) ||
( MUSIC_SoundDevice == GenMidi ) ||
( MUSIC_SoundDevice == SoundScape ) ||
( MUSIC_SoundDevice == SoundCanvas ) )
{
MIDI_SetVolume( tovolume );
return( MUSIC_Ok );
}
if ( MUSIC_FadeTask != NULL )
{
MUSIC_StopFade();
}
tovolume = max( 0, tovolume );
tovolume = min( 255, tovolume );
fromvolume = MUSIC_GetVolume();
MUSIC_FadeLength = milliseconds / 25;
MUSIC_FadeRate = ( ( tovolume - fromvolume ) << 7 ) / MUSIC_FadeLength;
MUSIC_LastFadeVolume = fromvolume;
MUSIC_CurrentFadeVolume = fromvolume << 7;
MUSIC_EndingFadeVolume = tovolume;
MUSIC_FadeTask = TS_ScheduleTask( MUSIC_FadeRoutine, 40, 1, NULL );
if ( MUSIC_FadeTask == NULL )
{
MUSIC_SetErrorCode( MUSIC_TaskManError );
return( MUSIC_Warning );
}
TS_Dispatch();
return( MUSIC_Ok );
}
/*---------------------------------------------------------------------
Function: MUSIC_FadeActive
Returns whether the fade routine is active.
---------------------------------------------------------------------*/
int MUSIC_FadeActive
(
void
)
{
return( MUSIC_FadeTask != NULL );
}
/*---------------------------------------------------------------------
Function: MUSIC_StopFade
Stops fading the music.
---------------------------------------------------------------------*/
void MUSIC_StopFade
(
void
)
{
if ( MUSIC_FadeTask != NULL )
{
TS_Terminate( MUSIC_FadeTask );
MUSIC_FadeTask = NULL;
}
}
/*---------------------------------------------------------------------
Function: MUSIC_RerouteMidiChannel
Sets callback function to reroute MIDI commands from specified
function.
---------------------------------------------------------------------*/
void MUSIC_RerouteMidiChannel
(
int channel,
int cdecl ( *function )( int event, int c1, int c2 )
)
{
MIDI_RerouteMidiChannel( channel, function );
}
/*---------------------------------------------------------------------
Function: MUSIC_RegisterTimbreBank
Halts playback of all sounds.
---------------------------------------------------------------------*/
void MUSIC_RegisterTimbreBank
(
unsigned char *timbres
)
{
AL_RegisterTimbreBank( timbres );
}