rebased to upstream

Author: eadmaster

README.md

@@ -1,93 +1,7 @@
-# FinalBurn Neo
-Official Forum: https://neo-source.com
+# FinalBurn Neo chvolmod
 
-Discord: https://discord.gg/8EGVd9v
+This fork provides extra core options for per-channel audio volume in the libretro port only.
 
-This is the official repository of FinalBurn Neo, an Emulator for Arcade Games & Select Consoles. It is based on the emulators FinalBurn and old versions of [MAME](https://www.mamedev.org)
+See the [original issue here](https://github.com/libretro/FBNeo/issues/605) and read the [full story here](http://eadmaster.altervista.org/wordpress/archives/90).
 
-Use of this program and its source code is subject to the license conditions provided in the [license.txt](/src/license.txt) file in the src folder.
-
-# Work in Progress builds
-You can download the latest builds by clicking on the badge below. Please note that the downloads might not be available immediately after a new commit. As this build is of the last commit occasionally you might run into incomplete code, crashes or other issues that [official releases](https://github.com/finalburnneo/FBNeo/releases) will not have.
-
-[![nightly-release](https://github.com/finalburnneo/FBNeo/actions/workflows/nightly-release.yml/badge.svg)](https://github.com/finalburnneo/FBNeo/releases/tag/latest)
-
-# Ports
-
-Raspberry Pi [build instructions](README-PI.md).
-
-macOS [build instructions](README-macOS.md) and [releases](https://github.com/fbn-mac/FBNeo/releases).
-
-[LibRetro port](https://github.com/libretro/FBNeo) with builds availble via [RetroArch](https://www.retroarch.com/) for a lot of cool platforms.
-
-For SDL1.2 builds just type `make sdl` (requires SDL1.2 and GCC, make, perl and nasm) [instructions](README-SDL.md)
-
-For SDL2 builds just type `make sdl2` (requires SDL2, SDL2_image, gcc, make, perl and nasm) [instructions](README-SDL.md)
-
-# Reporting Issues
-
-Please raise an issue on the [project GitHub](https://github.com/finalburnneo/FBNeo/issues) or report on the forums at [Neosource](https://neo-source.com)
-
-# What about FB Alpha?
-
-Many of the developers of this project also worked on FB Alpha. Due to a [controversy](https://www.google.com/search?q=capcom+home+arcade+illegal&oq=capcom+home+arcade+illegal), we no longer do, and recommend that everyone use this emulator instead.
-
-# Contributing
-
-We welcome pull requests and other submissions from anyone. We maintain a list of known bugs and features that would be nice to add on the [issue tracker](https://github.com/finalburnneo/FBNeo/issues), some of which would be a good starting point for new contributors. 
-
-One of the focuses of FBNeo is ensuring that the codebase is compilable on older systems. This is for many reasons, not least because older hardware still has a use outside of landfill or being stored in a recycling center, but also it can be a lot of fun porting and running FBNeo to other platforms. Currently, this means we will always aim for [C++03 compliance](https://en.wikipedia.org/wiki/C%2B%2B03) as a minimum. Any pull requests should keep this in mind!
-
-## Notes on Contributions
-
-In the root of the source tree there is an [.editorconfig](https://editorconfig.org/) that mandates:
-
-* tabs for indentation
-* tabs use 4 columns
-
-Please see the following function for some ideas on how naming, brackets and braces should be
-
-
-```
-void FunctionName(UINT8 var1, UINT16 var2)
-{
-	UINT64 result;
-	if (var1 * var2 >= 10) {
-		result = var1 * var2;
-	} else {
-		result = var1;
-	}
-}
-
-```
-## Source tree structure
-
-The source for FBNeo is layed out in a similar way to how things were in the days of the original FinalBurn. It's just that there are now more directories and source files as the emulator has grown significantly.
-```
-src/
---/burn			<-- This is where the emulation code lives
-----/devices		<-- This is where emulated devices (EEPROMS, etc) live
-----/drv		<-- This is where the drivers for Games and Systems live
-----/snd		<-- This is where the emulation for sound chips and other sound generating devices live
---/burner		<-- This is where the frontend code lives
---/cpu			<-- This is where the CPU emulation lives
---/dep			<-- This is where external dependencies live (such as libpng)
---/intf			<-- This is where the platform specific code for each platform that FBNeo supports live (e.g. Video and Sound output)
-```
-## Porting FBNeo to different systems
-
-In the main source tree, you will see in the intf directory various implementations for different platforms. You should look in here when porting to new platforms. We also encourage new ports, and are happy to have them merged in to the main sourcetree. There is probably a project there for someone to re-implement some of the older ports using the intf standard, should they want to.
-
-For portability we define the following types
-```
-unsigned char   UINT8;
-signed char     INT8;
-unsigned short	UINT16;
-signed short	INT16;
-unsigned int	UINT32;
-signed int      INT32;
-signed int64	INT64;
-unsigned int64  UINT64;
-
-```
-It is recommended that you take a look at the other #defines and structs in the header files in Burn and Burner, and don't forget that some of the existing code in the intf directory will come in handy for new ports. 
+UPDATE: added another hack for [hiscores loading in all the datfile supported games](https://github.com/libretro/FBNeo/issues/702).

src/burn/burn.cpp

@@ -66,6 +66,9 @@ INT32 nFMInterpolation = 0;			// Desired interpolation level for FM sound
 
 UINT8 nBurnLayer = 0xFF;	// Can be used externally to select which layers to show
 UINT8 nSpriteEnable = 0xFF;	// Can be used externally to select which layers to show
+int nBurnFMSoundChannelVolumes[256];	// Can be used externally to control FM sound channel volumes
+int nBurnADPCMSoundChannelVolumes[256];	// Can be used externally to control ADPCM sound channel volumes
+int nBurnPSGSoundChannelVolumes[256];	// Can be used externally to control PSG sound channel volumes
 
 INT32 bRunAhead = 0;
 
@@ -96,6 +99,11 @@ extern "C" INT32 BurnLibInit()
 	BurnSoundInit();
 
 	bBurnUseMMX = BurnCheckMMXSupport();
+	
+	int i;
+	for(i=0; i<16; i++) nBurnFMSoundChannelVolumes[i] = 100;  // init as full volume
+	for(i=0; i<16; i++) nBurnADPCMSoundChannelVolumes[i] = 100;
+	for(i=0; i<16; i++) nBurnPSGSoundChannelVolumes[i] = 100;
 
 	return 0;
 }

src/burn/burn.h

@@ -271,6 +271,9 @@ extern INT32 nBurnBpp;						// Bytes per pixel (2, 3, or 4)
 
 extern UINT8 nBurnLayer;			// Can be used externally to select which layers to show
 extern UINT8 nSpriteEnable;			// Can be used externally to select which Sprites to show
+extern int nBurnFMSoundChannelVolumes[];			// Can be used externally to control sound channel volumes
+extern int nBurnADPCMSoundChannelVolumes[];			// Can be used externally to control sound channel volumes
+extern int nBurnPSGSoundChannelVolumes[];			// Can be used externally to control sound channel volumes
 
 extern INT32 bRunAhead;             // "Run Ahead" lag-reduction technique UI option (on/off)
 

src/burn/hiscore.cpp

@@ -154,7 +154,7 @@ static INT32 CheckHiscoreAllowed()
 	INT32 Allowed = 1;
 
 	if (!EnableHiscores) Allowed = 0;
-	if (!(BurnDrvGetFlags() & BDF_HISCORE_SUPPORTED)) Allowed = 0;
+	//if (!(BurnDrvGetFlags() & BDF_HISCORE_SUPPORTED)) Allowed = 0;
 
 	return Allowed;
 }

src/burn/snd/ay8910.c

@@ -24,11 +24,12 @@
 #include "ay8910.h"
 #undef AY8910_CORE
 
+extern UINT8 DebugSnd_AY8910Initted;
+
 #if defined FBNEO_DEBUG
 #ifdef __GNUC__
 	// MSVC doesn't like this - this module only supports debug tracking with GCC only
 	#include <tchar.h>
-	extern UINT8 DebugSnd_AY8910Initted;
 	extern INT32 (__cdecl *bprintf) (INT32 nStatus, TCHAR* szFormat, ...);
 	#define PRINT_ERROR		(3)
 #endif
@@ -78,6 +79,8 @@ extern UINT32 nCurrentFrame;
 extern INT16 *pBurnSoundOut;
 extern INT32 FM_IS_POSTLOADING;
 
+extern int nBurnPSGSoundChannelVolumes[10];
+
 // Streambuffer handling
 static INT32 SyncInternal()
 {
@@ -703,7 +706,11 @@ void AY8910Update(INT32 chip, INT16 **buffer, INT32 length)
 				if (PSG->EnvelopeC) PSG->VolC = PSG->VolE;
 			}
 		}
-
+		
+		if(nBurnPSGSoundChannelVolumes[0] < 100) vola = vola * nBurnPSGSoundChannelVolumes[0] / 100;
+		if(nBurnPSGSoundChannelVolumes[1] < 100) volb = vola * nBurnPSGSoundChannelVolumes[1] / 100;
+		if(nBurnPSGSoundChannelVolumes[2] < 100) volc = vola * nBurnPSGSoundChannelVolumes[2] / 100;
+		
 		*(buf1++) = (vola * PSG->VolA) / STEP;
 		*(buf2++) = (volb * PSG->VolB) / STEP;
 		*(buf3++) = (volc * PSG->VolC) / STEP;
@@ -845,11 +852,7 @@ INT32 AY8910InitCore(INT32 chip, INT32 clock, INT32 sample_rate,
 {
 	struct AY8910 *PSG = &AYPSG[chip];
 
-#if defined FBNEO_DEBUG
-#ifdef __GNUC__ 
 	DebugSnd_AY8910Initted = 1;
-#endif
-#endif
 
 	AYStreamUpdate = dummy_callback;
 

src/burn/snd/es5506.cpp

@@ -899,6 +899,18 @@ void ES5506Update(INT16 *outputs, INT32 samples_len)
 	INT32 *pBufL = chip->scratch + 0    + 5;
 	INT32 *pBufR = chip->scratch + 4096 + 5;
 
+	// TODO: fix noisy audio?
+	double chip_volume0 = chip->volume[0];
+	double chip_volume1 = chip->volume[1];	
+	/*
+	if(nBurnADPCMSoundChannelVolumes[curr_voice_index]<100) {
+		// overrides the volumes
+		//printf("vol0=%f\n", chip->volume[0]);
+		//printf("vol0_scaled=%f\n", chip_volume0 );
+		
+		printf("curr_voice_index=%d\n", curr_voice_index );
+	}*/
+	
 	for (INT32 i = (nFractionalPosition & 0xFFFF0000) >> 15; i < (samples_len << 1); i += 2, nFractionalPosition += nSampleSize) {
 		INT32 nLeftSample[4] = {0, 0, 0, 0};
 		INT32 nRightSample[4] = {0, 0, 0, 0};
@@ -917,8 +929,13 @@ void ES5506Update(INT16 *outputs, INT32 samples_len)
 		nTotalLeftSample  = INTERPOLATE4PS_16BIT((nFractionalPosition >> 4) & 0x0fff, nLeftSample[0], nLeftSample[1], nLeftSample[2], nLeftSample[3]);
 		nTotalRightSample = INTERPOLATE4PS_16BIT((nFractionalPosition >> 4) & 0x0fff, nRightSample[0], nRightSample[1], nRightSample[2], nRightSample[3]);
 
-		outputs[i + 0] = BURN_SND_CLIP(nTotalLeftSample * chip->volume[0]);
-		outputs[i + 1] = BURN_SND_CLIP(nTotalRightSample * chip->volume[1]);
+		//outputs[i + 0] = BURN_SND_CLIP(nTotalLeftSample * chip->volume[0]);
+		//outputs[i + 1] = BURN_SND_CLIP(nTotalRightSample * chip->volume[1]);
+		//UINT8 curr_voice_index = (&chip->voice[chip->current_page & 0x1f])->index;
+		//chip_volume0 = chip->volume[0] * nBurnADPCMSoundChannelVolumes[curr_voice_index] / 100;
+		//chip_volume1 = chip->volume[1] * nBurnADPCMSoundChannelVolumes[curr_voice_index] / 100;
+		outputs[i + 0] = BURN_SND_CLIP(nTotalLeftSample * chip_volume0);
+		outputs[i + 1] = BURN_SND_CLIP(nTotalRightSample * chip_volume1);
 	}
 
 	if (samples_len >= nBurnSoundLen) {

src/burn/snd/fm.c

@@ -119,6 +119,9 @@
 #undef AY8910_CORE
 #include "fm.h"
 
+extern int nBurnFMSoundChannelVolumes[];
+extern int nBurnADPCMSoundChannelVolumes[];
+
 
 #ifndef PI
 #define PI 3.14159265358979323846
@@ -2350,6 +2353,10 @@ void YM2203UpdateOne(int num, INT16 *buffer, int length)
 		/* buffering */
 		{
 			int lt;
+			
+			if (nBurnFMSoundChannelVolumes[0] < 100) out_fm[0] = (out_fm[0] * nBurnFMSoundChannelVolumes[0]) / 100;
+			if (nBurnFMSoundChannelVolumes[1] < 100) out_fm[1] = (out_fm[1] * nBurnFMSoundChannelVolumes[1]) / 100;
+			if (nBurnFMSoundChannelVolumes[2] < 100) out_fm[2] = (out_fm[2] * nBurnFMSoundChannelVolumes[2]) / 100;
 
 			lt = out_fm[0] + out_fm[1] + out_fm[2];
 
@@ -2699,12 +2706,11 @@ static void Init_ADPCMATable(void){
 }
 
 /* ADPCM A (Non control type) : calculate one channel output */
-INLINE void ADPCMA_calc_chan( YM2610 *F2610, ADPCM_CH *ch )
+INLINE void ADPCMA_calc_chan( YM2610 *F2610, ADPCM_CH *ch, int ch_no )
 {
 	UINT32 step;
 	UINT8  data;
 
-
 	ch->now_step += ch->step;
 	if ( ch->now_step >= (1<<ADPCM_SHIFT) )
 	{
@@ -2752,9 +2758,13 @@ INLINE void ADPCMA_calc_chan( YM2610 *F2610, ADPCM_CH *ch )
 		}while(--step);
 
 		/* calc pcm * volume data */
-		ch->adpcm_out = ((ch->adpcm_acc * ch->vol_mul) >> ch->vol_shift) & ~3;	/* multiply, shift and mask out 2 LSB bits */
+		if (nBurnADPCMSoundChannelVolumes[ch_no] == 100) {
+			ch->adpcm_out = ((ch->adpcm_acc * ch->vol_mul) >> ch->vol_shift) & ~3;	/* multiply, shift and mask out 2 LSB bits */
+		} else {
+			ch->adpcm_out = ((ch->adpcm_acc * ch->vol_mul * nBurnADPCMSoundChannelVolumes[ch_no] / 100) >> ch->vol_shift) & ~3;	/* multiply, shift and mask out 2 LSB bits */
+		}
 	}
-
+	
 	/* output for work of output channels (out_adpcm[OPNxxxx])*/
 	*(ch->pan) += ch->adpcm_out;
 }
@@ -3076,7 +3086,7 @@ void YM2608UpdateOne(int num, INT16 **buffer, int length)
 		for( j = 0; j < 6; j++ )
 		{
 			if( F2608->adpcm[j].flag )
-				ADPCMA_calc_chan( F2608, &F2608->adpcm[j]);
+				ADPCMA_calc_chan( F2608, &F2608->adpcm[j], j);
 		}
 
 		/* buffering */
@@ -3087,6 +3097,15 @@ void YM2608UpdateOne(int num, INT16 **buffer, int length)
 			rt =  out_adpcm[OUTD_RIGHT] + out_adpcm[OUTD_CENTER];
 			lt += (out_delta[OUTD_LEFT]  + out_delta[OUTD_CENTER])>>9;
 			rt += (out_delta[OUTD_RIGHT] + out_delta[OUTD_CENTER])>>9;
+
+			/* apply user volume scaling to FM channels*/
+			if (nBurnFMSoundChannelVolumes[0] < 100) out_fm[0] = (out_fm[0] * nBurnFMSoundChannelVolumes[0]) / 100;
+			if (nBurnFMSoundChannelVolumes[1] < 100) out_fm[1] = (out_fm[1] * nBurnFMSoundChannelVolumes[1]) / 100;
+			if (nBurnFMSoundChannelVolumes[2] < 100) out_fm[2] = (out_fm[2] * nBurnFMSoundChannelVolumes[2]) / 100;
+			if (nBurnFMSoundChannelVolumes[3] < 100) out_fm[3] = (out_fm[3] * nBurnFMSoundChannelVolumes[3]) / 100;
+			if (nBurnFMSoundChannelVolumes[4] < 100) out_fm[4] = (out_fm[4] * nBurnFMSoundChannelVolumes[4]) / 100;
+			if (nBurnFMSoundChannelVolumes[5] < 100) out_fm[5] = (out_fm[5] * nBurnFMSoundChannelVolumes[5]) / 100;
+			
 			lt += ((out_fm[0]>>1) & OPN->pan[0]);	/* shift right verified on real YM2608 */
 			rt += ((out_fm[0]>>1) & OPN->pan[1]);
 			lt += ((out_fm[1]>>1) & OPN->pan[2]);
@@ -3674,18 +3693,23 @@ void YM2610UpdateOne(int num, INT16 **buffer, int length)
 		for( j = 0; j < 6; j++ )
 		{
 			if( F2610->adpcm[j].flag )
-				ADPCMA_calc_chan( F2610, &F2610->adpcm[j]);
+				ADPCMA_calc_chan( F2610, &F2610->adpcm[j], j);
 		}
-
+		
 		/* buffering */
 		{
 			int lt,rt;
-
+			
 			lt =  out_adpcm[OUTD_LEFT]  + out_adpcm[OUTD_CENTER];
 			rt =  out_adpcm[OUTD_RIGHT] + out_adpcm[OUTD_CENTER];
 			lt += (out_delta[OUTD_LEFT]  + out_delta[OUTD_CENTER])>>9;
 			rt += (out_delta[OUTD_RIGHT] + out_delta[OUTD_CENTER])>>9;
 
+			/* apply user volume scaling */
+			if (nBurnFMSoundChannelVolumes[0] < 100) out_fm[1] = (out_fm[1] * nBurnFMSoundChannelVolumes[0]) / 100;
+			if (nBurnFMSoundChannelVolumes[1] < 100) out_fm[2] = (out_fm[2] * nBurnFMSoundChannelVolumes[1]) / 100;
+			if (nBurnFMSoundChannelVolumes[2] < 100) out_fm[4] = (out_fm[4] * nBurnFMSoundChannelVolumes[2]) / 100;
+			if (nBurnFMSoundChannelVolumes[3] < 100) out_fm[5] = (out_fm[5] * nBurnFMSoundChannelVolumes[3]) / 100;
 
 			lt += ((out_fm[1]>>1) & OPN->pan[2]);	/* the shift right was verified on real chip */
 			rt += ((out_fm[1]>>1) & OPN->pan[3]);
@@ -3815,13 +3839,21 @@ void YM2610BUpdateOne(int num, INT16 **buffer, int length)
 		for( j = 0; j < 6; j++ )
 		{
 			if( F2610->adpcm[j].flag )
-				ADPCMA_calc_chan( F2610, &F2610->adpcm[j]);
+				ADPCMA_calc_chan( F2610, &F2610->adpcm[j], j);
 		}
 
 		/* buffering */
 		{
 			int lt,rt;
 
+			/* apply user volume scaling */
+			if (nBurnFMSoundChannelVolumes[0] < 100) out_fm[0] = (out_fm[0] * nBurnFMSoundChannelVolumes[0]) / 100;
+			if (nBurnFMSoundChannelVolumes[1] < 100) out_fm[1] = (out_fm[1] * nBurnFMSoundChannelVolumes[1]) / 100;
+			if (nBurnFMSoundChannelVolumes[2] < 100) out_fm[2] = (out_fm[2] * nBurnFMSoundChannelVolumes[2]) / 100;
+			if (nBurnFMSoundChannelVolumes[3] < 100) out_fm[3] = (out_fm[3] * nBurnFMSoundChannelVolumes[3]) / 100;
+			if (nBurnFMSoundChannelVolumes[4] < 100) out_fm[4] = (out_fm[4] * nBurnFMSoundChannelVolumes[4]) / 100;
+			if (nBurnFMSoundChannelVolumes[5] < 100) out_fm[5] = (out_fm[5] * nBurnFMSoundChannelVolumes[5]) / 100;
+			
 			lt =  out_adpcm[OUTD_LEFT]  + out_adpcm[OUTD_CENTER];
 			rt =  out_adpcm[OUTD_RIGHT] + out_adpcm[OUTD_CENTER];
 			lt += (out_delta[OUTD_LEFT]  + out_delta[OUTD_CENTER])>>9;
@@ -4383,6 +4415,14 @@ void YM2612UpdateOne(int num, INT16 **buffer, int length)
 		{
 			int lt,rt;
 
+			/* apply user volume scaling */
+			if (nBurnFMSoundChannelVolumes[0] < 100) out_fm[0] = (out_fm[0] * nBurnFMSoundChannelVolumes[0]) / 100;
+			if (nBurnFMSoundChannelVolumes[1] < 100) out_fm[1] = (out_fm[1] * nBurnFMSoundChannelVolumes[1]) / 100;
+			if (nBurnFMSoundChannelVolumes[2] < 100) out_fm[2] = (out_fm[2] * nBurnFMSoundChannelVolumes[2]) / 100;
+			if (nBurnFMSoundChannelVolumes[3] < 100) out_fm[3] = (out_fm[3] * nBurnFMSoundChannelVolumes[3]) / 100;
+			if (nBurnFMSoundChannelVolumes[4] < 100) out_fm[4] = (out_fm[4] * nBurnFMSoundChannelVolumes[4]) / 100;
+			if (nBurnFMSoundChannelVolumes[5] < 100) out_fm[5] = (out_fm[5] * nBurnFMSoundChannelVolumes[5]) / 100;
+			
 			lt  = ((out_fm[0]>>0) & OPN->pan[0]);
 			rt  = ((out_fm[0]>>0) & OPN->pan[1]);
 			lt += ((out_fm[1]>>0) & OPN->pan[2]);

src/burn/snd/ics2115.cpp

@@ -20,6 +20,8 @@
 
 #include "timer.h"
 
+extern int nBurnADPCMSoundChannelVolumes[];
+
 
 // if defined, comform to hardware limits: wavetable increase at 33.075, use 1024-step linear interpolator
 // otherwise, wavetable increase at final samplerate, allow the use of a more precise cubic interpolator
@@ -1399,7 +1401,7 @@ void ics2115_scan(INT32 nAction, INT32* pnMin)
 			SCAN_VAR(m_voice[i].vol.pan);
 			SCAN_VAR(m_voice[i].vol_ctrl.value);
 			SCAN_VAR(m_voice[i].vol.mode);
-			SCAN_VAR(m_voice[i].ramp);
+			SCAN_VAR(m_voice[i].ramp);  // TODO: reduce volume
 
 			SCAN_VAR(m_voice[i].prev_addr);
 			SCAN_VAR(m_voice[i].int_buf);

src/burn/snd/k054539.cpp

@@ -671,7 +671,7 @@ void K054539Update(INT32 chip, INT16 *outputs, INT32 samples_len)
 
 					if (tap == 0) chan->delay_on = 0;
 				}
-
+				
 				lval += chan->val * chan->lvol;
 				rval += chan->val * chan->rvol;
 			}