itgmania212121/stepmania/src/Course.cpp

#include "stdafx.h"
/*
-----------------------------------------------------------------------------
 Class: Course

 Desc: See header.

 Copyright (c) 2001-2002 by the person(s) listed below.  All rights reserved.
	Chris Danford
-----------------------------------------------------------------------------
*/

#include "Course.h"
#include "PrefsManager.h"
#include "Song.h"
#include "GameManager.h"
#include "SongManager.h"
#include "GameState.h"
#include "RageException.h"
#include "RageLog.h"
#include "MsdFile.h"
#include "PlayerOptions.h"
#include "SongOptions.h"
#include "RageUtil.h"

Course::Course()
{
	m_bRepeat = false;
	m_bRandomize = false;
	m_iLives = -1;
	m_iExtra = 0;
	m_iNumTimesPlayed = 0;

	//
	// Init high scores
	//
	unsigned i, j;
	for( i=0; i<NUM_NOTES_TYPES; i++ )
		for( j=0; j<NUM_RANKING_LINES; j++ )
		{
			m_MachineScores[i][j].iDancePoints = 0;
			m_MachineScores[i][j].fSurviveTime = 0;
			m_MachineScores[i][j].sName = "STEP";
		}

	for( i=0; i<NUM_NOTES_TYPES; i++ )
		for( j=0; j<NUM_PLAYERS; j++ )
		{
			m_MemCardScores[i][j].iDancePoints = 0;
			m_MemCardScores[i][j].fSurviveTime = 0;
		}
}

/*
 * GetSongDir() contains a path to the song, possibly a full path, eg:
 * Songs\Group\SongName                   or 
 * My Other Song Folder\Group\SongName    or
 * c:\Corny J-pop\Group\SongName
 *
 * Most course group names are "Group\SongName", so we want to
 * match against the last two elements. Let's also support
 * "SongName" alone, since the group is only important when it's
 * potentially ambiguous.
 *
 * Let's *not* support "Songs\Group\SongName" in course files.
 * That's probably a common error, but that would result in
 * course files floating around that only work for people who put
 * songs in "Songs"; we don't want that.
 */

Song *Course::FindSong(CString sSongDir)
{
	const vector<Song*> &apSongs = SONGMAN->GetAllSongs();

	CStringArray split_SongDir;
	sSongDir.Replace("\\", "/");
	split( sSongDir, "/", split_SongDir, true );

	if( split_SongDir.size() > 2 )
	{
		LOG->Warn( "Course file \"%s\" path \"%s\" should contain "
					"at most one backslash; ignored.",
				    m_sPath.GetString(), sSongDir.GetString());
		return NULL;
	}

	// foreach song
	for( unsigned i = 0; i < apSongs.size(); i++ )
	{
		CString dir = apSongs[i]->GetSongDir();
		dir.Replace("\\", "/");
		CStringArray splitted; /* splat! */
		split( dir, "/", splitted, true );
		bool matches = true;
		
		int split_no = splitted.size()-1;
		int SongDir_no = split_SongDir.size()-1;

		while( split_no >= 0 && SongDir_no >= 0 ) {
			if( stricmp(splitted[split_no--], split_SongDir[SongDir_no--] ) )
				matches=false;
		}

		if(matches)
			return apSongs[i];
	}

	LOG->Trace( "Course \"%s\": couldn't match song \"%s\"",
			    m_sPath.GetString(), sSongDir.GetString());
	return NULL;
}

void Course::LoadFromCRSFile( CString sPath )
{
	m_sPath = sPath;	// save path

	MsdFile msd;
	if( !msd.ReadFile(sPath) )
		RageException::Throw( "Error opening CRS file '%s'.", sPath.GetString() );

	CString sDir, sFName, sExt;
	splitrelpath( sPath, sDir, sFName, sExt );

	CStringArray arrayPossibleBanners;
	GetDirListing( "Courses\\" + sFName + ".png", arrayPossibleBanners, false, true );
	GetDirListing( "Courses\\" + sFName + ".jpg", arrayPossibleBanners, false, true );
	GetDirListing( "Courses\\" + sFName + ".bmp", arrayPossibleBanners, false, true );
	GetDirListing( "Courses\\" + sFName + ".gif", arrayPossibleBanners, false, true );
	if( !arrayPossibleBanners.empty() )
		m_sBannerPath = arrayPossibleBanners[0];

	for( unsigned i=0; i<msd.GetNumValues(); i++ )
	{
		CString sValueName = msd.GetParam(i, 0);
		const MsdFile::value_t &sParams = msd.GetValue(i);

		// handle the data
		if( 0 == stricmp(sValueName, "COURSE") )
			m_sName = sParams[1];

		else if( 0 == stricmp(sValueName, "REPEAT") )
		{
			CString str = sParams[1];
			str.MakeLower();
			if( str.Find("yes") != -1 )
				m_bRepeat = true;
		}

		else if( 0 == stricmp(sValueName, "LIVES") )
			m_iLives = atoi( sParams[1] );

		else if( 0 == stricmp(sValueName, "EXTRA") )
			m_iExtra = atoi( sParams[1] );

		else if( 0 == stricmp(sValueName, "SONG") )
		{
			CString sSongDir = sParams[1];
			CString sNotesDescription = sParams[2];
			CString sModifiers = sParams[3];

			if(!sSongDir.GetLength()) {
			    /* Err. */
			    LOG->Trace( "Course file '%s' has an empty #SONG.  Ignored.", sPath.GetString(), sSongDir.GetString() );
			    continue;
			}

			Song *pSong = FindSong(sSongDir);

			if( pSong == NULL )	// we didn't find the Song
				continue;	// skip this song
			
			AddStage( pSong, sNotesDescription, sModifiers );
		}

		else
			LOG->Trace( "Unexpected value named '%s'", sValueName.GetString() );
	}
}


void Course::CreateEndlessCourseFromGroupAndDifficulty( CString sGroupName, Difficulty dc, vector<Song*> &apSongsInGroup )
{
	m_bRepeat = true;
	m_bRandomize = true;
	m_iLives = -1;

	CStringArray asPossibleBannerPaths;
	GetDirListing( "Songs\\" + sGroupName + "\\banner.png", asPossibleBannerPaths, false, true );
	GetDirListing( "Songs\\" + sGroupName + "\\banner.jpg", asPossibleBannerPaths, false, true );
	GetDirListing( "Songs\\" + sGroupName + "\\banner.gif", asPossibleBannerPaths, false, true );
	GetDirListing( "Songs\\" + sGroupName + "\\banner.bmp", asPossibleBannerPaths, false, true );
	if( !asPossibleBannerPaths.empty() )
		m_sBannerPath = asPossibleBannerPaths[0];

	CString sShortGroupName = SONGMAN->ShortenGroupName( sGroupName );	

	m_sName = sShortGroupName + " ";
	switch( dc )
	{
	case DIFFICULTY_EASY:	m_sName += "Easy";		break;
	case DIFFICULTY_MEDIUM:	m_sName += "Medium";	break;
	case DIFFICULTY_HARD:	m_sName += "Hard";		break;
	default:
		ASSERT(0);
	}

	for( unsigned s=0; s<apSongsInGroup.size(); s++ )
	{
		Song* pSong = apSongsInGroup[s];
		AddStage( pSong, DifficultyToString(dc), "" );
	}
	Shuffle();
}

void Course::Shuffle()
{
	/* Shuffle the list. */
	for( int i = 0; i < GetNumStages(); ++i)
		swap(order[i], order[rand() % GetNumStages()]);
}

Notes* Course::GetNotesForStage( int iStage )
{
	Song* pSong = GetSong(iStage);
	CString sDescription = entries[iStage].description;
	
	/* First, search for an exact description match. */
	unsigned i;
	for( i=0; i<pSong->m_apNotes.size(); i++ )
	{
		Notes* pNotes = pSong->m_apNotes[i];

		if( !GAMESTATE->GetCurrentStyleDef()->MatchesNotesType(pNotes->m_NotesType) )
			continue;

		if( !pNotes->GetDescription().CompareNoCase(sDescription) )
			return pNotes;
	}

	/* If that failed, try to do a difficulty match. */
	Difficulty dc = StringToDifficulty(sDescription);
	for( i=0; i < pSong->m_apNotes.size(); i++ )
	{
		Notes* pNotes = pSong->m_apNotes[i];

		if( !GAMESTATE->GetCurrentStyleDef()->MatchesNotesType(pNotes->m_NotesType) )
			continue;

		if(dc == pNotes->GetDifficulty())
			return pNotes;
	}

	return NULL;
}

Song *Course::GetSong( int iStage ) const
{
	return entries[iStage].song;
}

CString Course::GetDescription( int iStage ) const
{
	return entries[iStage].description;
}


void Course::AddStage( Song* pSong, CString sDescription, CString sModifiers )
{
	course_entry e;
	e.song = pSong;
	e.description = sDescription;
	e.modifiers = sModifiers;
	entries.push_back(e);

	order.push_back(order.size());
}

/* When bShuffled is true, returns courses in the song ordering list. */
void Course::GetSongAndNotesForCurrentStyle( 
	vector<Song*>& apSongsOut,
	vector<Notes*>& apNotesOut, 
	CStringArray& asModifiersOut,
	bool bShuffled )
{
	for( int i=0; i<GetNumStages(); i++ )
	{
		int num = bShuffled? order[i]:i;

		Song* pSong = GetSong(num);
		Notes* pNotes = GetNotesForStage( num );
		CString sModifiers = entries[num].modifiers;

		if( !pSong->HasMusic() )
			continue;	// skip
		if( pNotes == NULL )
			continue;	// skip

		apSongsOut.push_back( pSong );
		apNotesOut.push_back( pNotes );
		asModifiersOut.push_back( sModifiers );
	}
}

RageColor Course::GetColor()
{
	// This could be made smarter
	if( GetNumStages() >= 7 )
		return RageColor(1,0,0,1);	// red
	else if( GetNumStages() >= 4 )
		return RageColor(1,0.5f,0,1);	// orange
	else
		return RageColor(0,1,0,1);	// green
}

void Course::GetPlayerOptions( int iStage, PlayerOptions* pPO_out ) const
{
	pPO_out->FromString( entries[iStage].modifiers );
}

void Course::GetSongOptions( SongOptions* pSO_out ) const
{
	*pSO_out = SongOptions();
	//hack: The lifebar modifiers were not showing up (in the extra stages) - had to add it here.
	if( entries.size() > 0 )
		pSO_out->FromString( entries[0].modifiers ); 
	pSO_out->m_LifeType = (m_iLives==-1) ? SongOptions::LIFE_BAR : SongOptions::LIFE_BATTERY;
	if( m_iLives != -1 )
		pSO_out->m_iBatteryLives = m_iLives;
}

int Course::GetNumStages() const
{
	return entries.size();
}


struct CourseScoreToInsert
{
	PlayerNumber pn;
	int iDancePoints;
	float fSurviveTime;

	static int CompareDescending( const CourseScoreToInsert &hs1, const CourseScoreToInsert &hs2 )
	{
		if( hs1.iDancePoints > hs2.iDancePoints )		return -1;
		else if( hs1.iDancePoints == hs2.iDancePoints )	return 0;
		else											return +1;
	}
	static void SortDescending( vector<CourseScoreToInsert>& vHSout )
	{ 
		sort( vHSout.begin(), vHSout.end(), CompareDescending ); 
	}
};

void Course::AddMachineRecords( NotesType nt, int iDancePoints[NUM_PLAYERS], float fSurviveTime[NUM_PLAYERS], int iRankingIndexOut[NUM_PLAYERS] )	// set iNewRecordIndex = -1 if not a new record
{
	vector<CourseScoreToInsert> vHS;
	for( int p=0; p<NUM_PLAYERS; p++ )
	{
		iRankingIndexOut[p] = -1;

		if( !GAMESTATE->IsPlayerEnabled(p) )
			continue;	// skip

		CourseScoreToInsert hs;
		hs.iDancePoints = iDancePoints[p];
		hs.fSurviveTime = fSurviveTime[p];
		hs.pn = (PlayerNumber)p;
		vHS.push_back( hs );
	}

	// Sort descending before inserting.
	// This guarantees that a high score will not switch poitions on us when we later insert scores for the other player
	CourseScoreToInsert::SortDescending( vHS );

	for( unsigned i=0; i<vHS.size(); i++ )
	{
		CourseScoreToInsert& newHS = vHS[i];
		MachineScore* machineScores = m_MachineScores[nt];
		for( int i=0; i<NUM_RANKING_LINES; i++ )
		{
			if( newHS.iDancePoints > machineScores[i].iDancePoints )
			{
				// We found the insert point.  Shift down.
				for( int j=i+1; j<NUM_RANKING_LINES; j++ )
					machineScores[j] = machineScores[j-1];
				// insert
				machineScores[i].fSurviveTime = newHS.fSurviveTime;
				machineScores[i].iDancePoints = newHS.iDancePoints;
				machineScores[i].sName = "STEP";
				iRankingIndexOut[newHS.pn] = i;
			}
		}
	}
}

bool Course::AddMemCardRecord( PlayerNumber pn, NotesType nt, int iDancePoints, float fSurviveTime )	// return true if new record
{
	MemCardScore& hs = m_MemCardScores[nt][pn];
	if( iDancePoints > hs.iDancePoints )
	{
		hs.iDancePoints = iDancePoints;
		hs.fSurviveTime = fSurviveTime;
		return true;
	}
	return false;
}


//
// Sorting stuff
//
static int CompareCoursePointersByDifficulty(const Course* pCourse1, const Course* pCourse2)
{
	return pCourse1->GetNumStages() < pCourse2->GetNumStages();
}

void SortCoursePointerArrayByDifficulty( vector<Course*> &apCourses )
{
	sort( apCourses.begin(), apCourses.end(), CompareCoursePointersByDifficulty );
}