dolphin/Source/Plugins/Plugin_DSP_HLE/Src/Logging/Logging.cpp

//////////////////////////////////////////////////////////////////////////////////////////
//
// Licensetype: GNU General Public License (GPL)
//
// 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, version 2.0.
//
// 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.  See the
// GNU General Public License 2.0 for more details.
//
// A copy of the GPL 2.0 should have been included with the program.
// If not, see http://www.gnu.org/licenses/
//
// Official SVN repository and contact information can be found at
// http://code.google.com/p/dolphin-emu/
//
//////////////////////////////////////////////////////////////////////////////////////////



// Includes


#include <iostream>
#include <vector>
#include <string> // so that we can test std::string == abc
#ifdef _WIN32
	#include <windows.h>
#endif

#include "../Debugger/Debugger.h"
#include "../Debugger/PBView.h"
#include "Console.h" // open and close console, clear console window

#include "../Globals.h"
#include "../UCodes/UCodes.h"
#include "../UCodes/UCode_AXStructs.h"
#include "../UCodes/UCode_AX.h"


// Externals

float ratioFactor; // a global to get the ratio factor from MixAdd
int gUpdFreq = 5;
int gPreset = 0;
u32 gLastBlock;
extern bool gSSBM;
extern bool gSSBMremedy1;
extern bool gSSBMremedy2;
extern bool gSequenced;
extern bool gReset;
bool gOnlyLooping = false;
extern int gSaveFile;

// Parameter blocks

std::vector<u32> gloopPos(64);
std::vector<u32> gsampleEnd(64);
std::vector<u32> gsamplePos(64);

// PBSampleRateConverter src
	std::vector<u32> gratio(64);
	std::vector<u32> gratiohi(64);
	std::vector<u32> gratiolo(64);
	std::vector<u32> gfrac(64);
	std::vector<u32> gcoef(64);

// PBSampleRateConverter mixer
	std::vector<u16> gvolume_left(64);
	std::vector<u16> gvolume_right(64);
	std::vector<u16> gmixer_control(64);
	std::vector<u16> gcur_volume(64);
	std::vector<u16> gcur_volume_delta(64);

std::vector<u16> gaudioFormat(64);
std::vector<u16> glooping(64);
std::vector<u16> gsrc_type(64);
std::vector<u16> gis_stream(64);

// loop
	std::vector<u16> gloop1(64);
	std::vector<u16> gloop2(64);
	std::vector<u16> gloop3(64);
	std::vector<u16> gadloop1(64);
	std::vector<u16> gadloop2(64);
	std::vector<u16> gadloop3(64);

// updates
	std::vector<u16> gupdates1(64);
	std::vector<u16> gupdates2(64);
	std::vector<u16> gupdates3(64);
	std::vector<u16> gupdates4(64);
	std::vector<u16> gupdates5(64);
	std::vector<u32> gupdates_addr(64);




// Counters

int j = 0;
int k = 0;
long int l = 0;
int iupd = 0;
bool iupdonce = false;
std::vector<u16> viupd(15); // the length of the update frequency bar
int vectorLengthGUI = 8; // length of playback history bar for the GUI version
int vectorLength = 15; // for console version
int vectorLength2 = 100; // for console version


// More stuff

// should we worry about the additonal memory these lists require? bool will allocate
// very little memory
std::vector< std::vector<bool> > vector1(64, std::vector<bool>(vectorLength,0)); 
std::vector< std::vector<bool> > vector2(64, std::vector<bool>(vectorLength2,0));
std::vector<int> numberRunning(64);


// Classes

extern CDebugger* m_frame;
		


// I placed this in CUCode_AX because it needs access to private members of that class.
void CUCode_AX::Logging(short* _pBuffer, int _iSize, int a)
{

	AXParamBlock PBs[NUMBER_OF_PBS];
	int numberOfPBs = ReadOutPBs(PBs, NUMBER_OF_PBS);

	
	// Control how often the screen is updated
	j++;
	l++;
	if (j > (200/gUpdFreq))
	{

		// =======================================================================================
		// Move all items back - Vector1 is a vector1[64][100] vector
		// --------------
		/*
		Move all items back like this:		
		1  to  2
		2      3
		3 ...
		*/
		for (int i = 0; i < 64; i++)
		{
			for (int j = 1; j < vectorLength; j++)
			{
				vector1.at(i).at(j-1) = vector1.at(i).at(j);
			}
		}
		
		
		// Save the latest value
		
		for (int i = 0; i < numberOfPBs; i++)
		{
			vector1.at(i).at(vectorLength-1) = PBs[i].running;
		}
		// ==============


		// =======================================================================================
		// Have a separate set for which ones to show
		// --------------
		/*
		Move all items back like this:		
		1  to  2
		2      3
		3 ...
		*/
		for (int i = 0; i < 64; i++)
		{
			for (int j = 1; j < vectorLength2; j++)
			{
				vector2.at(i).at(j-1) = vector2.at(i).at(j);
			}
		}
		
		
		// Save the latest value
		
		for (int i = 0; i < numberOfPBs; i++)
		{
			vector2.at(i).at(vectorLength2-1) = PBs[i].running;
		}
		// ==============

		
		// =======================================================================================
		// Count how many we have running now
		// --------------
		int jj = 0;
		for (int i = 0; i < 64; i++)
		{
			for (int j = 0; j < vectorLength2-1; j++)
			{
				if (vector2.at(i).at(j) == 1)
				{
					jj++;					
				}
				numberRunning.at(i) = jj;
			}
		}
		// ==============

			
		// =======================================================================================
		// Write header
		// --------------
		char buffer [1000] = "";
		std::string sbuff;
		if(gPreset == 0)
		{			
			sbuff = sbuff + "                                                                        adpcm           adpcm_loop\n";
			sbuff = sbuff + "                Nr    pos / end      lpos     | voll  volr  | isl iss | pre yn1   yn2   pre yn1   yn2   | frac  ratio[hi lo]   | 1 2 3 4 5\n";
		}
		else if(gPreset == 1)
		{
			sbuff = sbuff + "                Nr    pos / end      lpos     | voll  volr  curv  vold  | src coef mixc\n";
		}
		else if(gPreset == 2)
		{
			sbuff = sbuff + "                Nr    pos / end      lpos     | voll  volr  | isl iss | e-l    e-s\n";
		}
		
		
		
		// ==============





		// go through all running blocks
		for (int i = 0; i < numberOfPBs; i++)
		{

		// =======================================================================================
		// Prepare conditions
		// --------------
		bool Conditions;
		if (gOnlyLooping)
		{
			Conditions = PBs[i].audio_addr.looping;
		}
		else
		{
			Conditions = (numberRunning.at(i) > 0 || PBs[i].audio_addr.looping);
		}
		// ==============

		if (Conditions)
		{

			
			// Playback history for the GUI debugger --------------------------
			if(m_frame)
			{
				std::string guipr; // gui progress

				for (int j = 0; j < vectorLengthGUI; j++)
				{
					if(vector1.at(i).at(j) == 0)
					{
						guipr = guipr + "0";
					}
					else
					{
						guipr = guipr + "1";
					}
				}

				u32 run = atoi( guipr.c_str());
				m_frame->m_GPRListView->m_CachedRegs[1][i] = run;
				guipr.clear();
			}


			// Playback history for the console debugger --------------------------
			for (int j = 0; j < vectorLength; j++)
			{
				if(vector1.at(i).at(j) == 0)
				{
					//strcat(buffer, " ");
					sbuff = sbuff + " ";
				}
				else
				{
					//sprintf(buffer, "%s%c", buffer, 177); // this will add strange letters if buffer has
					// not been given any string yet

					sprintf(buffer, "%c", 177);
					//strcat(buffer, tmpbuff);

					//strcpy(buffer, "");
					//sprintf(buffer, "%c", 177);
					sbuff = sbuff + buffer; strcpy(buffer, "");
				}
			}
			// ---------	


			// We could chose to update these only if a block is currently running - Later I'll add options
			// to see both the current and the lastets active value.
			//if (PBs[i].running)
			if (true)			
			{
				
			// AXPB base
				gcoef[i] = PBs[i].unknown1;

				gloopPos[i]   = (PBs[i].audio_addr.loop_addr_hi << 16) | PBs[i].audio_addr.loop_addr_lo;
				gsampleEnd[i] = (PBs[i].audio_addr.end_addr_hi << 16) | PBs[i].audio_addr.end_addr_lo;
				gsamplePos[i] = (PBs[i].audio_addr.cur_addr_hi << 16) | PBs[i].audio_addr.cur_addr_lo;

			// PBSampleRateConverter src

				gratio[i] = (u32)(((PBs[i].src.ratio_hi << 16) + PBs[i].src.ratio_lo) * ratioFactor);
				gratiohi[i] = PBs[i].src.ratio_hi;
				gratiolo[i] = PBs[i].src.ratio_lo;
				gfrac[i] = PBs[i].src.cur_addr_frac;

			// adpcm_loop_info
				gadloop1[i] = PBs[i].adpcm.pred_scale;
				gadloop2[i] = PBs[i].adpcm.yn1;
				gadloop3[i] = PBs[i].adpcm.yn2;

				gloop1[i] = PBs[i].adpcm_loop_info.pred_scale;
				gloop2[i] = PBs[i].adpcm_loop_info.yn1;
				gloop3[i] = PBs[i].adpcm_loop_info.yn2;

			// updates
				gupdates1[i] = PBs[i].updates.num_updates[0];
				gupdates2[i] = PBs[i].updates.num_updates[1];
				gupdates3[i] = PBs[i].updates.num_updates[2];
				gupdates4[i] = PBs[i].updates.num_updates[3];
				gupdates5[i] = PBs[i].updates.num_updates[4];

				gupdates_addr[i] = (PBs[i].updates.data_hi << 16) | PBs[i].updates.data_lo;

				gaudioFormat[i] = PBs[i].audio_addr.sample_format;
				glooping[i] = PBs[i].audio_addr.looping;
				gsrc_type[i] = PBs[i].src_type;
				gis_stream[i] = PBs[i].is_stream;

			// mixer
				gvolume_left[i] = PBs[i].mixer.volume_left;
				gvolume_right[i] = PBs[i].mixer.volume_right;

				gmixer_control[i] = PBs[i].mixer_control;
				gcur_volume[i] = PBs[i].vol_env.cur_volume;
				gcur_volume_delta[i] = PBs[i].vol_env.cur_volume_delta;

			}

			// hopefully this is false if we don't have a debugging window and so it doesn't cause a crash
			if(m_frame)
			{
				m_frame->m_GPRListView->m_CachedRegs[2][i] = gsamplePos[i];
				m_frame->m_GPRListView->m_CachedRegs[2][i] = gsampleEnd[i];
				m_frame->m_GPRListView->m_CachedRegs[3][i] = gloopPos[i];

				m_frame->m_GPRListView->m_CachedRegs[4][i] = gvolume_left[i];
				m_frame->m_GPRListView->m_CachedRegs[5][i] = gvolume_right[i];

				m_frame->m_GPRListView->m_CachedRegs[6][i] = glooping[i];
				m_frame->m_GPRListView->m_CachedRegs[7][i] = gloop1[i];
				m_frame->m_GPRListView->m_CachedRegs[8][i] = gloop2[i];
				m_frame->m_GPRListView->m_CachedRegs[9][i] = gloop3[i];

				m_frame->m_GPRListView->m_CachedRegs[10][i] = gis_stream[i];

				m_frame->m_GPRListView->m_CachedRegs[11][i] = gaudioFormat[i];
				m_frame->m_GPRListView->m_CachedRegs[12][i] = gsrc_type[i];
				m_frame->m_GPRListView->m_CachedRegs[13][i] = gcoef[i];

				m_frame->m_GPRListView->m_CachedRegs[14][i] = gfrac[i];

				m_frame->m_GPRListView->m_CachedRegs[15][i] = gratio[i];
				m_frame->m_GPRListView->m_CachedRegs[16][i] = gratiohi[i];
				m_frame->m_GPRListView->m_CachedRegs[17][i] = gratiolo[i];

				m_frame->m_GPRListView->m_CachedRegs[18][i] = gupdates1[i];
				m_frame->m_GPRListView->m_CachedRegs[19][i] = gupdates2[i];
				m_frame->m_GPRListView->m_CachedRegs[20][i] = gupdates3[i];
				m_frame->m_GPRListView->m_CachedRegs[21][i] = gupdates4[i];
				m_frame->m_GPRListView->m_CachedRegs[22][i] = gupdates5[i];
			}


			// =======================================================================================
			// PRESETS
			// ---------------------------------------------------------------------------------------
			/*
			PRESET 0
			"                Nr    pos / end      lpos     | voll  volr  | isl iss | pre yn1   yn2   pre yn1   yn2   | frac  ratio[hi lo]   | 1 2 3 4 5\n";
			"---------------|00 12341234/12341234 12341234 | 00000 00000 | 0   0   | 000 00000 00000 000 00000 00000 | 00000 00000[0 00000] | 
			
			PRESET 1
			"                Nr    pos / end      lpos     | voll  volr  curv  vold  | src coef mixc\n";
			"---------------|00 12341234/12341234 12341234 | 00000 00000 00000 00000 | 0   0    0		

			PRESET 2
			"                Nr    pos / end      lpos     | voll  volr  | isl iss | e-l    e-s\n";
			"---------------|00 12341234/12341234 12341234 | 00000 00000 | 0   0   | 000000 000000
			*/
			if(gPreset == 0)
			{
			sprintf(buffer,"%c%i %08i/%08i %08i | %05i %05i | %i   %i   | %03i %05i %05i %03i %05i %05i | %05i %05i[%i %05i] | %i %i %i %i %i",
				223, i, gsamplePos[i], gsampleEnd[i], gloopPos[i],
				gvolume_left[i], gvolume_right[i],
				glooping[i], gis_stream[i],
				gadloop1[i], gadloop2[i], gadloop3[i], gloop1[i], gloop2[i], gloop3[i],
				gfrac[i], gratio[i], gratiohi[i], gratiolo[i],
				gupdates1[i], gupdates2[i], gupdates3[i], gupdates4[i], gupdates5[i]
				);
			}
			else if(gPreset == 1)
			{
			sprintf(buffer,"%c%i %08i/%08i %08i | %05i %05i %05i %05i | %i   %i    %i",
				223, i, gsamplePos[i], gsampleEnd[i], gloopPos[i],
				gvolume_left[i], gvolume_right[i], gcur_volume[i], gcur_volume_delta[i],				
				gsrc_type[i], gcoef[i], gmixer_control[i]
				);
			}
			else if(gPreset == 2)
			{
			sprintf(buffer,"%c%i %08i/%08i %08i | %05i %05i | %i   %i   | %06i %06i",
				223, i, gsamplePos[i], gsampleEnd[i], gloopPos[i],
				gvolume_left[i], gvolume_right[i],
				glooping[i], gis_stream[i],				
				gsampleEnd[i] - gloopPos[i], gsampleEnd[i] - gsamplePos[i]
				);
			}
			
			// add new line
			sbuff = sbuff + buffer; strcpy(buffer, "");
			sbuff = sbuff + "\n";


		} // end of if (PBs[i].running)		

		} // end of big loop - for (int i = 0; i < numberOfPBs; i++)



		// =======================================================================================
		// Write global values
		// ---------------
		sprintf(buffer, "\nThe parameter blocks span from %08x to %08x | distance %i %i\n", m_addressPBs, gLastBlock, (gLastBlock-m_addressPBs), (gLastBlock-m_addressPBs) / 192);
		sbuff = sbuff + buffer; strcpy(buffer, "");
		// ===============
			
			
		// =======================================================================================
		// Write settings
		// ---------------
		sprintf(buffer, "\nSettings: SSBM fix %i | SSBM rem1 %i | SSBM rem2 %i | Sequenced %i | Reset %i | Only looping %i | Save file %i\n",
			gSSBM, gSSBMremedy1, gSSBMremedy2, gSequenced, gReset, gOnlyLooping, gSaveFile);
		sbuff = sbuff + buffer; strcpy(buffer, "");
		// ===============


		// =======================================================================================
		// Show update frequency
		// ---------------
		sbuff = sbuff + "\n";
		if(!iupdonce)
		{
			/*
			for (int i = 0; i < 10; i++)
			{
				viupd.at(i) == 0;
			}
			*/
			viupd.at(0) = 1;
			viupd.at(1) = 1;
			viupd.at(2) = 1;
			iupdonce = true;
		}

		for (int i = 0; i < viupd.size(); i++) // 0, 1,..., 9
		{
			if (i < viupd.size()-1)
			{
				viupd.at(viupd.size()-i-1) = viupd.at(viupd.size()-i-2);		// move all forward	
			}
			else
			{
				viupd.at(0) = viupd.at(viupd.size()-1);
			}
			
			// Correction
			if (viupd.at(viupd.size()-3) == 1 && viupd.at(viupd.size()-2) == 1 && viupd.at(viupd.size()-1) == 1)
			{
				viupd.at(0) = 0;
			}
			if(viupd.at(0) == 0 && viupd.at(1) == 1 && viupd.at(2) == 1 && viupd.at(3) == 0)
			{
				viupd.at(0) = 1;
			}				
		}

		for (int i = 0; i < viupd.size(); i++)
		{
			if(viupd.at(i) == 0)
				sbuff = sbuff + " ";
			else
				sbuff = sbuff + ".";
		}
		// ================


		// =======================================================================================
		// Print
		// ---------------------------------------------------------------------------------------
		ClearScreen();
		// we'll always have one to many \n at the end, remove it
		//wprintf("%s", sbuff.substr(0, sbuff.length()-1).c_str());
		wprintf("%s", sbuff.c_str());

		sbuff.clear(); strcpy(buffer, "");

		
		// New values are written so update - DISABLED - It flickered a lot, even worse than a
		// console window. I'll add a console window later to show the current status.
		//if(m_frame)
		if(false)
		{
			//m_frame->NotifyUpdate();
		}
			

		k=0;
		j=0;

	} // end of if (j>20)
	
	

} // end of function