226 lines
6.3 KiB
C++
226 lines
6.3 KiB
C++
#ifndef SONG_H
|
|
#define SONG_H
|
|
/*
|
|
-----------------------------------------------------------------------------
|
|
Class: Song
|
|
|
|
Desc: See header.
|
|
|
|
Copyright (c) 2001-2002 by the person(s) listed below. All rights reserved.
|
|
Chris Danford
|
|
-----------------------------------------------------------------------------
|
|
*/
|
|
|
|
#include "GameConstantsAndTypes.h"
|
|
#include "Grade.h"
|
|
|
|
struct Notes;
|
|
class StyleDef;
|
|
class NotesLoader;
|
|
|
|
extern const int FILE_CACHE_VERSION;
|
|
|
|
struct BPMSegment
|
|
{
|
|
BPMSegment() { m_fStartBeat = m_fBPM = -1; };
|
|
BPMSegment( float s, float b ) { m_fStartBeat = s; m_fBPM = b; };
|
|
float m_fStartBeat;
|
|
float m_fBPM;
|
|
};
|
|
|
|
struct StopSegment
|
|
{
|
|
StopSegment() { m_fStartBeat = m_fStopSeconds = -1; };
|
|
StopSegment( float s, float f ) { m_fStartBeat = s; m_fStopSeconds = f; };
|
|
float m_fStartBeat;
|
|
float m_fStopSeconds;
|
|
};
|
|
|
|
struct BackgroundChange
|
|
{
|
|
BackgroundChange() { m_fStartBeat = -1; };
|
|
BackgroundChange( float s, CString sBGName ) { m_fStartBeat = s; m_sBGName = sBGName; };
|
|
float m_fStartBeat;
|
|
CString m_sBGName;
|
|
};
|
|
|
|
|
|
class Song
|
|
{
|
|
CString m_sSongDir;
|
|
|
|
public:
|
|
/* Set when this song should be displayed in the music wheel: */
|
|
enum { SHOW_ALWAYS, /* all the time */
|
|
SHOW_ROULETTE, /* only when rouletting */
|
|
SHOW_NEVER } /* never (unless song hiding is turned off) */
|
|
m_SelectionDisplay;
|
|
|
|
Song();
|
|
~Song();
|
|
|
|
bool LoadWithoutCache( CString sDir );
|
|
NotesLoader *MakeLoader( CString sDir ) const;
|
|
|
|
bool LoadFromSongDir( CString sDir );
|
|
|
|
void TidyUpData(); // call after loading to clean up invalid data
|
|
void ReCalulateRadarValuesAndLastBeat(); // called by TidyUpData, and after saving
|
|
|
|
void SaveToSMFile( CString sPath, bool bSavingCache );
|
|
void Save(); // saves SM and DWI
|
|
void SaveToCacheFile();
|
|
void SaveToDWIFile();
|
|
|
|
const CString &GetSongFilePath() const;
|
|
CString GetCacheFilePath() const;
|
|
|
|
void AddAutoGenNotes();
|
|
void AutoGen( NotesType ntTo, NotesType ntFrom ); // create Notes of type ntTo from Notes of type ntFrom
|
|
|
|
/* Directory this song data came from: */
|
|
const CString &GetSongDir() const { return m_sSongDir; }
|
|
|
|
/* Filename associated with this file. This will always have
|
|
* an .SM extension. If we loaded an .SM, this will point to
|
|
* it, but if we loaded any other type, this will point to a
|
|
* generated .SM filename. */
|
|
CString m_sSongFileName;
|
|
|
|
CString m_sGroupName;
|
|
|
|
|
|
bool m_bChangedSinceSave;
|
|
|
|
CString m_sMainTitle;
|
|
CString m_sSubTitle;
|
|
CString m_sArtist;
|
|
CString m_sMainTitleTranslit;
|
|
CString m_sSubTitleTranslit;
|
|
CString m_sArtistTranslit;
|
|
CString m_sCredit;
|
|
|
|
CString GetFullTitle() const { return m_sMainTitle + (m_sSubTitle.GetLength()? (" " + m_sSubTitle):""); }
|
|
CString GetSortTitle() const { return
|
|
(m_sMainTitleTranslit.IsEmpty()?
|
|
m_sMainTitle:
|
|
m_sMainTitleTranslit)
|
|
+
|
|
(m_sSubTitleTranslit.IsEmpty()?
|
|
(m_sSubTitle.IsEmpty()?
|
|
"":
|
|
" " + m_sSubTitle):
|
|
" " + m_sSubTitleTranslit);
|
|
}
|
|
|
|
CString m_sMusicFile;
|
|
unsigned m_iMusicBytes;
|
|
float m_fBeat0OffsetInSeconds;
|
|
float m_fMusicLengthSeconds;
|
|
float m_fFirstBeat;
|
|
float m_fLastBeat;
|
|
float GetFirstBeat() const;
|
|
float GetLastBeat() const;
|
|
float m_fMusicSampleStartSeconds;
|
|
float m_fMusicSampleLengthSeconds;
|
|
|
|
float GetMusicStartBeat() const;
|
|
|
|
CString m_sBannerFile;
|
|
CString m_sBackgroundFile;
|
|
CString m_sCDTitleFile;
|
|
|
|
CString GetMusicPath() const;
|
|
CString GetBannerPath() const;
|
|
CString GetBackgroundPath() const;
|
|
CString GetCDTitlePath() const;
|
|
|
|
|
|
bool HasMusic() const;
|
|
bool HasBanner() const;
|
|
bool HasBackground() const;
|
|
bool HasCDTitle() const;
|
|
bool HasMovieBackground() const;
|
|
bool HasBGChanges() const;
|
|
|
|
CArray<BPMSegment, BPMSegment&> m_BPMSegments; // this must be sorted before gameplay
|
|
CArray<StopSegment, StopSegment&> m_StopSegments; // this must be sorted before gameplay
|
|
CArray<BackgroundChange, BackgroundChange&> m_BackgroundChanges; // this must be sorted before gameplay
|
|
|
|
void AddBPMSegment( BPMSegment seg );
|
|
void AddStopSegment( StopSegment seg );
|
|
void AddBackgroundChange( BackgroundChange seg );
|
|
|
|
void GetMinMaxBPM( float &fMinBPM, float &fMaxBPM ) const
|
|
{
|
|
fMaxBPM = 0;
|
|
fMinBPM = 100000; // inf
|
|
for( unsigned i=0; i<m_BPMSegments.size(); i++ )
|
|
{
|
|
const BPMSegment &seg = m_BPMSegments[i];
|
|
fMaxBPM = max( seg.m_fBPM, fMaxBPM );
|
|
fMinBPM = min( seg.m_fBPM, fMinBPM );
|
|
}
|
|
};
|
|
float GetBPMAtBeat( float fBeat ) const
|
|
{
|
|
unsigned i;
|
|
for( i=0; i<m_BPMSegments.size()-1; i++ )
|
|
if( m_BPMSegments[i+1].m_fStartBeat > fBeat )
|
|
break;
|
|
return m_BPMSegments[i].m_fBPM;
|
|
};
|
|
BPMSegment& GetBPMSegmentAtBeat( float fBeat )
|
|
{
|
|
unsigned i;
|
|
for( i=0; i<m_BPMSegments.size()-1; i++ )
|
|
if( m_BPMSegments[i+1].m_fStartBeat > fBeat )
|
|
break;
|
|
return m_BPMSegments[i];
|
|
};
|
|
CString GetBackgroundAtBeat( float fBeat )
|
|
{
|
|
unsigned i;
|
|
for( i=0; i<m_BackgroundChanges.size()-1; i++ )
|
|
if( m_BackgroundChanges[i+1].m_fStartBeat > fBeat )
|
|
break;
|
|
return m_BackgroundChanges[i].m_sBGName;
|
|
};
|
|
void GetBeatAndBPSFromElapsedTime( float fElapsedTime, float &fBeatOut, float &fBPSOut, bool &bFreezeOut ) const;
|
|
float GetBeatFromElapsedTime( float fElapsedTime ) const // shortcut for places that care only about the beat
|
|
{
|
|
float fBeat, fThrowAway;
|
|
bool bThrowAway;
|
|
GetBeatAndBPSFromElapsedTime( fElapsedTime, fBeat, fThrowAway, bThrowAway );
|
|
return fBeat;
|
|
}
|
|
float GetElapsedTimeFromBeat( float fBeat ) const;
|
|
|
|
|
|
|
|
CArray<Notes*, Notes*> m_apNotes;
|
|
|
|
bool SongCompleteForStyle( const StyleDef *st ) const;
|
|
bool SongHasNotesType( NotesType nt ) const;
|
|
bool SongHasNotesTypeAndDifficulty( NotesType nt, Difficulty dc ) const;
|
|
void GetNotesThatMatch( NotesType nt, CArray<Notes*, Notes*>& arrayAddTo ) const;
|
|
int GetNumTimesPlayed() const;
|
|
bool IsNew() const;
|
|
bool IsEasy( NotesType nt ) const;
|
|
Grade GetGradeForDifficulty( const StyleDef *s, int p, Difficulty dc ) const;
|
|
bool NormallyDisplayed() const;
|
|
bool RouletteDisplayed() const;
|
|
};
|
|
|
|
|
|
void SortSongPointerArrayByDifficulty( CArray<Song*, Song*> &arraySongPointers );
|
|
void SortSongPointerArrayByTitle( CArray<Song*, Song*> &arraySongPointers );
|
|
void SortSongPointerArrayByBPM( CArray<Song*, Song*> &arraySongPointers );
|
|
void SortSongPointerArrayByArtist( CArray<Song*, Song*> &arraySongPointers );
|
|
void SortSongPointerArrayByGroup( CArray<Song*, Song*> &arraySongPointers );
|
|
void SortSongPointerArrayByMostPlayed( CArray<Song*, Song*> &arraySongPointers );
|
|
|
|
|
|
|
|
#endif
|