Crash Cringleandteejusb
becd375544
Songs are already sorted by title so no need to do so again (otherwise big boi lag)
302 lines
12 KiB
C++
302 lines
12 KiB
C++
#ifndef SONGMANAGER_H
|
|
#define SONGMANAGER_H
|
|
|
|
class LoadingWindow;
|
|
class Song;
|
|
class Style;
|
|
class Steps;
|
|
class PlayerOptions;
|
|
struct lua_State;
|
|
|
|
#include "RageTypes.h"
|
|
#include "GameConstantsAndTypes.h"
|
|
#include "SongOptions.h"
|
|
#include "PlayerOptions.h"
|
|
#include "PlayerNumber.h"
|
|
#include "Difficulty.h"
|
|
#include "Course.h"
|
|
#include "ThemeMetric.h"
|
|
#include "RageTexturePreloader.h"
|
|
#include "RageUtil.h"
|
|
|
|
#include <cstddef>
|
|
#include <vector>
|
|
|
|
|
|
RString SONG_GROUP_COLOR_NAME( std::size_t i );
|
|
RString COURSE_GROUP_COLOR_NAME( std::size_t i );
|
|
bool CompareNotesPointersForExtra(const Steps *n1, const Steps *n2);
|
|
|
|
/** @brief The max number of edit steps a profile can have. */
|
|
const int MAX_EDIT_STEPS_PER_PROFILE = 200;
|
|
/** @brief The max number of edit courses a profile can have. */
|
|
const int MAX_EDIT_COURSES_PER_PROFILE = 20;
|
|
|
|
/** @brief The holder for the Songs and its Steps. */
|
|
class SongManager
|
|
{
|
|
public:
|
|
SongManager();
|
|
~SongManager();
|
|
|
|
/**
|
|
* @brief Initialize all songs from disk
|
|
* @param ld the loading window to be updated, or nullptr
|
|
* @param onlyAdditions only load songs added after the last
|
|
* invocation of this function
|
|
*/
|
|
void InitSongsFromDisk( LoadingWindow *ld, bool onlyAdditions );
|
|
void FreeSongs();
|
|
void UnlistSong(Song *song);
|
|
void Cleanup();
|
|
|
|
void Invalidate( const Song *pStaleSong );
|
|
|
|
void RegenerateNonFixedCourses();
|
|
void SetPreferences();
|
|
void SaveEnabledSongsToPref();
|
|
void LoadEnabledSongsFromPref();
|
|
|
|
void LoadStepEditsFromProfileDir( const RString &sProfileDir, ProfileSlot slot );
|
|
void LoadCourseEditsFromProfileDir( const RString &sProfileDir, ProfileSlot slot );
|
|
int GetNumStepsLoadedFromProfile();
|
|
void FreeAllLoadedFromProfile( ProfileSlot slot = ProfileSlot_Invalid );
|
|
|
|
void LoadGroupSymLinks( RString sDir, RString sGroupFolder );
|
|
|
|
/**
|
|
* @brief Initialize all courses from disk
|
|
* @param ld the loading window to be updated, or nullptr
|
|
* @param onlyAdditions only load courses added after the last
|
|
* invocation of this function
|
|
*/
|
|
void InitCoursesFromDisk( LoadingWindow *ld, bool onlyAdditions );
|
|
void InitAutogenCourses();
|
|
void InitRandomAttacks();
|
|
void FreeCourses();
|
|
void AddCourse( Course *pCourse ); // transfers ownership of pCourse
|
|
void DeleteCourse( Course *pCourse ); // transfers ownership of pCourse
|
|
/** @brief Remove all of the auto generated courses. */
|
|
void DeleteAutogenCourses();
|
|
void InvalidateCachedTrails();
|
|
|
|
/**
|
|
* @brief Initialize all songs and courses from disk, and update
|
|
* autogenerated courses afterwards
|
|
* @param ld the loading window to be updated, or nullptr
|
|
* @param onlyAdditions only load songs and courses added after the
|
|
* last invocation of this function
|
|
*/
|
|
void InitAll( LoadingWindow *ld, bool onlyAdditions );
|
|
void Reload( bool bAllowFastLoad, LoadingWindow *ld=nullptr );
|
|
void LoadAdditions( LoadingWindow *ld=nullptr );
|
|
void PreloadSongImages();
|
|
|
|
bool IsGroupNeverCached(const RString& group) const;
|
|
|
|
RString GetSongGroupBannerPath( RString sSongGroup ) const;
|
|
//RString GetSongGroupBackgroundPath( RString sSongGroup ) const;
|
|
void GetSongGroupNames( std::vector<RString> &AddTo ) const;
|
|
bool DoesSongGroupExist( RString sSongGroup ) const;
|
|
RageColor GetSongGroupColor( const RString &sSongGroupName ) const;
|
|
RageColor GetSongColor( const Song* pSong ) const;
|
|
|
|
RString GetCourseGroupBannerPath( const RString &sCourseGroup ) const;
|
|
//RString GetCourseGroupBackgroundPath( const RString &sCourseGroup ) const;
|
|
void GetCourseGroupNames( std::vector<RString> &AddTo ) const;
|
|
bool DoesCourseGroupExist( const RString &sCourseGroup ) const;
|
|
RageColor GetCourseGroupColor( const RString &sCourseGroupName ) const;
|
|
RageColor GetCourseColor( const Course* pCourse ) const;
|
|
|
|
void ResetGroupColors();
|
|
|
|
static RString ShortenGroupName( RString sLongGroupName );
|
|
|
|
// Lookup
|
|
/**
|
|
* @brief Retrieve all of the songs that belong to a particular group.
|
|
* @param sGroupName the name of the group.
|
|
* @return the songs that belong in the group. */
|
|
const std::vector<Song*> &GetSongs( const RString &sGroupName ) const;
|
|
/**
|
|
* @brief Retrieve all of the songs in the game.
|
|
* @return all of the songs. */
|
|
const std::vector<Song*> &GetAllSongs() const { return GetSongs(GROUP_ALL); }
|
|
/**
|
|
* @brief Retrieve all of the popular songs.
|
|
*
|
|
* Popularity is determined specifically by the number of times
|
|
* a song is chosen.
|
|
* @return all of the popular songs. */
|
|
const std::vector<Song*> &GetPopularSongs() const { return m_pPopularSongs; }
|
|
|
|
/**
|
|
* @brief Retrieve all of the songs in a group that have at least one
|
|
* valid step for the current gametype.
|
|
* @param sGroupName the name of the group.
|
|
* @return the songs within the group that have at least one valid Step. */
|
|
const std::vector<Song *> &GetSongsOfCurrentGame( const RString &sGroupName ) const;
|
|
/**
|
|
* @brief Retrieve all of the songs in the game that have at least one
|
|
* valid step for the current gametype.
|
|
* @return the songs within the game that have at least one valid Step. */
|
|
const std::vector<Song *> &GetAllSongsOfCurrentGame() const;
|
|
|
|
std::map<int, std::vector<Song*>> GetMeterToSongsMap() const { return m_mapSongsByDifficulty; }
|
|
void GetPreferredSortSongs( std::vector<Song*> &AddTo ) const;
|
|
std::map<RString, std::vector<Song*>> GetPreferredSortSongsMap() const { return m_mapPreferredSectionToSongs;};
|
|
RString SongToPreferredSortSectionName( const Song *pSong ) const;
|
|
std::vector<RString> GetPreferredSortSectionNames() const;
|
|
std::vector<Song*> GetPreferredSortSongsBySectionName( const RString &sSectionName ) const;
|
|
void GetPreferredSortSongsBySectionName( const RString &sSectionName, std::vector<Song*> &AddTo ) const;
|
|
std::vector<Song*> GetSongsByMeter( int iMeter ) const;
|
|
const std::vector<Course*> &GetPopularCourses( CourseType ct ) const { return m_pPopularCourses[ct]; }
|
|
Song *FindSong( RString sPath ) const;
|
|
Song *FindSong( RString sGroup, RString sSong ) const;
|
|
Course *FindCourse( RString sPath ) const;
|
|
Course *FindCourse( RString sGroup, RString sName ) const;
|
|
/**
|
|
* @brief Retrieve the number of songs in the game.
|
|
* @return the number of songs. */
|
|
int GetNumSongs() const;
|
|
int GetNumLockedSongs() const;
|
|
int GetNumUnlockedSongs() const;
|
|
int GetNumSelectableAndUnlockedSongs() const;
|
|
int GetNumSongGroups() const;
|
|
/**
|
|
* @brief Retrieve the number of courses in the game.
|
|
* @return the number of courses. */
|
|
int GetNumCourses() const;
|
|
int GetNumCourseGroups() const;
|
|
Song* GetRandomSong();
|
|
Course* GetRandomCourse();
|
|
// sm-ssc addition:
|
|
RString GetSongGroupByIndex(unsigned index) { return m_sSongGroupNames[index]; }
|
|
int GetSongRank(Song* pSong);
|
|
|
|
void GetStepsLoadedFromProfile( std::vector<Steps*> &AddTo, ProfileSlot slot ) const;
|
|
void DeleteSteps( Steps *pSteps ); // transfers ownership of pSteps
|
|
|
|
void GetAllCourses( std::vector<Course*> &AddTo, bool bIncludeAutogen ) const;
|
|
void GetCourses( CourseType ct, std::vector<Course*> &AddTo, bool bIncludeAutogen ) const;
|
|
void GetCoursesInGroup( std::vector<Course*> &AddTo, const RString &sCourseGroup, bool bIncludeAutogen ) const;
|
|
void GetPreferredSortCourses( CourseType ct, std::vector<Course*> &AddTo, bool bIncludeAutogen ) const;
|
|
|
|
void GetExtraStageInfo( bool bExtra2, const Style *s, Song*& pSongOut, Steps*& pStepsOut );
|
|
Song* GetSongFromDir( RString sDir ) const;
|
|
Course* GetCourseFromPath( RString sPath ) const; // path to .crs file, or path to song group dir
|
|
Course* GetCourseFromName( RString sName ) const;
|
|
|
|
void UpdatePopular();
|
|
void UpdateShuffled(); // re-shuffle songs and courses
|
|
std::map<int, std::vector<Song*>> UpdateMeterSort( std::vector<Song*> songs);
|
|
void SetPreferredSongs(RString sPreferredSongs, bool bIsAbsolute = false);
|
|
void SetPreferredCourses(RString sPreferredCourses, bool bIsAbsolute = false);
|
|
void UpdatePreferredSort(RString sPreferredSongs = "PreferredSongs.txt", RString sPreferredCourses = "PreferredCourses.txt");
|
|
void SortSongs(); // sort m_pSongs by CompareSongPointersByTitle
|
|
|
|
void UpdateRankingCourses(); // courses shown on the ranking screen
|
|
void RefreshCourseGroupInfo();
|
|
|
|
// Lua
|
|
void PushSelf( lua_State *L );
|
|
|
|
protected:
|
|
/**
|
|
* @brief Load all songs from a directory
|
|
* @param sDir the directory to be loaded
|
|
* @param ld the loading window to be updated, or nullptr
|
|
* @param onlyAdditions only load songs added after the last
|
|
* invocation of this function
|
|
*/
|
|
void LoadSongDir( RString sDir, LoadingWindow *ld, bool onlyAdditions );
|
|
bool GetExtraStageInfoFromCourse( bool bExtra2, RString sPreferredGroup, Song*& pSongOut, Steps*& pStepsOut, StepsType stype );
|
|
void SanityCheckGroupDir( RString sDir ) const;
|
|
void AddGroup( RString sDir, RString sGroupDirName );
|
|
int GetNumEditsLoadedFromProfile( ProfileSlot slot ) const;
|
|
|
|
void AddSongToList(Song* new_song);
|
|
/** @brief All of the songs that can be played. */
|
|
std::vector<Song*> m_pSongs;
|
|
std::map<RString, Song*> m_SongsByDir;
|
|
std::set<RString> m_GroupsToNeverCache;
|
|
|
|
/** @brief Hold pointers to all the songs that have been deleted from disk but must at least be kept temporarily alive for smooth audio transitions. */
|
|
std::vector<Song*> m_pDeletedSongs;
|
|
|
|
/** @brief The most popular songs ranked by number of plays. */
|
|
std::vector<Song*> m_pPopularSongs;
|
|
std::vector<Song*> m_pShuffledSongs; // used by GetRandomSong
|
|
|
|
/** @brief Meter numbers and the songs with Steps that are within.*/
|
|
std::map<int, std::vector<Song*>> m_mapSongsByDifficulty;
|
|
|
|
struct PreferredSortSection
|
|
{
|
|
RString sName;
|
|
std::vector<Song*> vpSongs;
|
|
};
|
|
/** @brief All preferred songs, keyed by section */
|
|
std::map<RString, std::vector<Song*>> m_mapPreferredSectionToSongs;
|
|
std::vector<PreferredSortSection> m_vPreferredSongSort;
|
|
std::vector<RString> m_sSongGroupNames;
|
|
std::vector<RString> m_sSongGroupBannerPaths; // each song group may have a banner associated with it
|
|
//vector<RString> m_sSongGroupBackgroundPaths; // each song group may have a background associated with it (very rarely)
|
|
|
|
struct Comp { bool operator()(const RString& s, const RString &t) const { return CompareRStringsAsc(s,t); } };
|
|
typedef std::vector<Song*> SongPointerVector;
|
|
std::map<RString,SongPointerVector,Comp> m_mapSongGroupIndex;
|
|
|
|
std::vector<Course*> m_pCourses;
|
|
std::vector<Course*> m_pPopularCourses[NUM_CourseType];
|
|
std::vector<Course*> m_pShuffledCourses; // used by GetRandomCourse
|
|
struct CourseGroupInfo
|
|
{
|
|
RString m_sBannerPath;
|
|
//RString m_sBackgroundPath;
|
|
};
|
|
std::map<RString,CourseGroupInfo> m_mapCourseGroupToInfo;
|
|
typedef std::vector<Course*> CoursePointerVector;
|
|
std::vector<CoursePointerVector> m_vPreferredCourseSort;
|
|
|
|
RageTexturePreloader m_TexturePreload;
|
|
|
|
ThemeMetric<int> NUM_SONG_GROUP_COLORS;
|
|
ThemeMetric1D<RageColor> SONG_GROUP_COLOR;
|
|
ThemeMetric<int> NUM_COURSE_GROUP_COLORS;
|
|
ThemeMetric1D<RageColor> COURSE_GROUP_COLOR;
|
|
ThemeMetric<int> num_profile_song_group_colors;
|
|
ThemeMetric1D<RageColor> profile_song_group_colors;
|
|
};
|
|
|
|
extern SongManager* SONGMAN; // global and accessible from anywhere in our program
|
|
|
|
#endif
|
|
|
|
/**
|
|
* @file
|
|
* @author Chris Danford, Glenn Maynard (c) 2001-2004
|
|
* @section LICENSE
|
|
* All rights reserved.
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a
|
|
* copy of this software and associated documentation files (the
|
|
* "Software"), to deal in the Software without restriction, including
|
|
* without limitation the rights to use, copy, modify, merge, publish,
|
|
* distribute, and/or sell copies of the Software, and to permit persons to
|
|
* whom the Software is furnished to do so, provided that the above
|
|
* copyright notice(s) and this permission notice appear in all copies of
|
|
* the Software and that both the above copyright notice(s) and this
|
|
* permission notice appear in supporting documentation.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF
|
|
* THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS
|
|
* INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT
|
|
* OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
|
|
* OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
|
|
* OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
|
|
* PERFORMANCE OF THIS SOFTWARE.
|
|
*/
|