#include "global.h" #include "NotesLoaderSSC.h" #include "BackgroundUtil.h" #include "GameManager.h" #include "MsdFile.h" // No JSON here. #include "NoteTypes.h" #include "NotesLoaderSM.h" // For programming shortcuts. #include "RageFileManager.h" #include "RageLog.h" #include "RageUtil.h" #include "Song.h" #include "SongManager.h" #include "Steps.h" #include "Attack.h" #include "PrefsManager.h" /** * @brief A custom .edit file can only be so big before we have to reject it. */ const int MAX_EDIT_STEPS_SIZE_BYTES = 60*1024; // 60 KB /** * @brief Attempt to load any background changes in use by this song. * @param change a reference to the background change. * @param sBGChangeExpression a reference to the list of changes to be made. * @return its success or failure. */ bool LoadFromBGSSCChangesString( BackgroundChange &change, const RString &sBGChangeExpression ) { return SMLoader::LoadFromBGChangesString( change, sBGChangeExpression ); } bool SSCLoader::LoadFromDir( const RString &sPath, Song &out ) { vector aFileNames; GetApplicableFiles( sPath, aFileNames ); if( aFileNames.size() > 1 ) { LOG->UserLog( "Song", sPath, "has more than one SSC file. Only one SSC file is allowed per song." ); return false; } ASSERT( aFileNames.size() == 1 ); // Ensure one was found entirely. return LoadFromSSCFile( sPath + aFileNames[0], out ); } void SSCLoader::ProcessWarps( TimingData &out, const RString sParam, const float fVersion ) { vector arrayWarpExpressions; split( sParam, ",", arrayWarpExpressions ); for( unsigned b=0; b arrayWarpValues; split( arrayWarpExpressions[b], "=", arrayWarpValues ); // XXX: Hard to tell which file caused this. if( arrayWarpValues.size() != 2 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid #WARPS value \"%s\" (must have exactly one '='), ignored.", arrayWarpExpressions[b].c_str() ); continue; } const float fBeat = StringToFloat( arrayWarpValues[0] ); const float fNewBeat = StringToFloat( arrayWarpValues[1] ); // Early versions were absolute in beats. They should be relative. if( ( fVersion < VERSION_SPLIT_TIMING && fNewBeat > fBeat ) || fNewBeat > 0 ) out.AddWarpSegment( WarpSegment(fBeat, fNewBeat) ); else { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid Warp at beat %f, BPM %f.", fBeat, fNewBeat ); } } } void SSCLoader::ProcessLabels( TimingData &out, const RString sParam ) { vector arrayLabelExpressions; split( sParam, ",", arrayLabelExpressions ); for( unsigned b=0; b arrayLabelValues; split( arrayLabelExpressions[b], "=", arrayLabelValues ); if( arrayLabelValues.size() != 2 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid #LABELS value \"%s\" (must have exactly one '='), ignored.", arrayLabelExpressions[b].c_str() ); continue; } const float fBeat = StringToFloat( arrayLabelValues[0] ); RString sLabel = arrayLabelValues[1]; TrimRight(sLabel); if( fBeat >= 0.0f ) out.AddLabelSegment( LabelSegment(fBeat, sLabel) ); else { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid Label at beat %f called %s.", fBeat, sLabel.c_str() ); } } } void SSCLoader::ProcessCombos( TimingData &out, const RString sParam ) { vector arrayComboExpressions; split( sParam, ",", arrayComboExpressions ); for( unsigned f=0; f arrayComboValues; split( arrayComboExpressions[f], "=", arrayComboValues ); if( arrayComboValues.size() != 2 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid #COMBOS value \"%s\" (must have exactly one '='), ignored.", arrayComboExpressions[f].c_str() ); continue; } const float fComboBeat = StringToFloat( arrayComboValues[0] ); const int iCombos = StringToInt( arrayComboValues[1] ); ComboSegment new_seg( BeatToNoteRow( fComboBeat ), iCombos ); out.AddComboSegment( new_seg ); } } void SSCLoader::ProcessSpeeds( TimingData &out, const RString sParam ) { vector vs1; split( sParam, ",", vs1 ); FOREACH_CONST( RString, vs1, s1 ) { vector vs2; split( *s1, "=", vs2 ); if( vs2[0] == 0 ) // First one always seems to have 2. { vs2.push_back("0"); } if( vs2.size() == 3 ) { vs2.push_back("0"); } if( vs2.size() < 4 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an speed change with %i values.", (int)vs2.size() ); continue; } const float fBeat = StringToFloat( vs2[0] ); SpeedSegment seg( fBeat, StringToFloat( vs2[1] ), StringToFloat( vs2[2] ), static_cast(StringToInt(vs2[3]))); if( fBeat < 0 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an speed change with beat %f.", fBeat ); continue; } if( seg.m_fWait < 0 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an speed change with beat %f, fWait %f.", fBeat, seg.m_fWait ); continue; } out.AddSpeedSegment( seg ); } } void SSCLoader::ProcessFakes( TimingData &out, const RString sParam ) { vector arrayFakeExpressions; split( sParam, ",", arrayFakeExpressions ); for( unsigned b=0; b arrayFakeValues; split( arrayFakeExpressions[b], "=", arrayFakeValues ); // XXX: Hard to tell which file caused this. if( arrayFakeValues.size() != 2 ) { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid #FAKES value \"%s\" (must have exactly one '='), ignored.", arrayFakeExpressions[b].c_str() ); continue; } const float fBeat = StringToFloat( arrayFakeValues[0] ); const float fNewBeat = StringToFloat( arrayFakeValues[1] ); if(fNewBeat > 0) out.AddFakeSegment( FakeSegment(fBeat, fNewBeat) ); else { LOG->UserLog( "Song file", "(UNKNOWN)", "has an invalid Fake at beat %f, BPM %f.", fBeat, fNewBeat ); } } } bool SSCLoader::LoadFromSSCFile( const RString &sPath, Song &out, bool bFromCache ) { LOG->Trace( "Song::LoadFromSSCFile(%s)", sPath.c_str() ); MsdFile msd; if( !msd.ReadFile( sPath, true ) ) { LOG->UserLog( "Song file", sPath, "couldn't be opened: %s", msd.GetError().c_str() ); return false; } out.m_SongTiming.m_sFile = sPath; // songs still have their fallback timing. int state = GETTING_SONG_INFO; const unsigned values = msd.GetNumValues(); Steps* pNewNotes = NULL; TimingData stepsTiming; bool bHasOwnTiming = false; for( unsigned i = 0; i < values; i++ ) { const MsdFile::value_t &sParams = msd.GetValue(i); RString sValueName = sParams[0]; sValueName.MakeUpper(); switch (state) { case GETTING_SONG_INFO: { if( sValueName=="VERSION" ) { out.m_fVersion = StringToFloat( sParams[1] ); } else if( sValueName=="TITLE" ) { out.m_sMainTitle = sParams[1]; } else if( sValueName=="SUBTITLE" ) { out.m_sSubTitle = sParams[1]; } else if( sValueName=="ARTIST" ) { out.m_sArtist = sParams[1]; } else if( sValueName=="TITLETRANSLIT" ) { out.m_sMainTitleTranslit = sParams[1]; } else if( sValueName=="SUBTITLETRANSLIT" ) { out.m_sSubTitleTranslit = sParams[1]; } else if( sValueName=="ARTISTTRANSLIT" ) { out.m_sArtistTranslit = sParams[1]; } else if( sValueName=="GENRE" ) { out.m_sGenre = sParams[1]; } else if( sValueName=="ORIGIN" ) { out.m_sOrigin = sParams[1]; } else if( sValueName=="CREDIT" ) { out.m_sCredit = sParams[1]; } else if( sValueName=="BANNER" ) { out.m_sBannerFile = sParams[1]; } else if( sValueName=="BACKGROUND" ) { out.m_sBackgroundFile = sParams[1]; } else if( sValueName=="LYRICSPATH" ) { out.m_sLyricsFile = sParams[1]; } else if( sValueName=="CDTITLE" ) { out.m_sCDTitleFile = sParams[1]; } else if( sValueName=="MUSIC" ) { out.m_sMusicFile = sParams[1]; } else if( sValueName=="INSTRUMENTTRACK" ) { SMLoader::ProcessInstrumentTracks( out, sParams[1] ); } else if( sValueName=="MUSICLENGTH" ) { if( !bFromCache ) continue; out.m_fMusicLengthSeconds = StringToFloat( sParams[1] ); } else if( sValueName=="LASTBEATHINT" ) { out.m_fSpecifiedLastBeat = StringToFloat( sParams[1] ); } else if( sValueName=="MUSICBYTES" ) { ; // ignore } else if( sValueName=="SAMPLESTART" ) { out.m_fMusicSampleStartSeconds = HHMMSSToSeconds( sParams[1] ); } else if( sValueName=="SAMPLELENGTH" ) { out.m_fMusicSampleLengthSeconds = HHMMSSToSeconds( sParams[1] ); } else if( sValueName=="DISPLAYBPM" ) { // #DISPLAYBPM:[xxx][xxx:xxx]|[*]; if( sParams[1] == "*" ) out.m_DisplayBPMType = DISPLAY_BPM_RANDOM; else { out.m_DisplayBPMType = DISPLAY_BPM_SPECIFIED; out.m_fSpecifiedBPMMin = StringToFloat( sParams[1] ); if( sParams[2].empty() ) out.m_fSpecifiedBPMMax = out.m_fSpecifiedBPMMin; else out.m_fSpecifiedBPMMax = StringToFloat( sParams[2] ); } } else if( sValueName=="SELECTABLE" ) { if(sParams[1].EqualsNoCase("YES")) out.m_SelectionDisplay = out.SHOW_ALWAYS; else if(sParams[1].EqualsNoCase("NO")) out.m_SelectionDisplay = out.SHOW_NEVER; // ROULETTE from 3.9 is no longer in use. else if(sParams[1].EqualsNoCase("ROULETTE")) out.m_SelectionDisplay = out.SHOW_ALWAYS; /* The following two cases are just fixes to make sure simfiles that * used 3.9+ features are not excluded here */ else if(sParams[1].EqualsNoCase("ES") || sParams[1].EqualsNoCase("OMES")) out.m_SelectionDisplay = out.SHOW_ALWAYS; else if( StringToInt(sParams[1]) > 0 ) out.m_SelectionDisplay = out.SHOW_ALWAYS; else LOG->UserLog( "Song file", sPath, "has an unknown #SELECTABLE value, \"%s\"; ignored.", sParams[1].c_str() ); } else if( sValueName.Left(strlen("BGCHANGES"))=="BGCHANGES" || sValueName=="ANIMATIONS" ) { SMLoader::ProcessBGChanges( out, sValueName, sPath, sParams[1]); } else if( sValueName=="FGCHANGES" ) { vector aFGChangeExpressions; split( sParams[1], ",", aFGChangeExpressions ); for( unsigned b=0; bm_StepsType = GAMEMAN->StringToStepsType( sParams[1] ); } else if( sValueName=="CHARTSTYLE" ) { pNewNotes->SetChartStyle( sParams[1] ); } else if( sValueName=="DESCRIPTION" ) { pNewNotes->SetDescription( sParams[1] ); } else if( sValueName=="DIFFICULTY" ) { pNewNotes->SetDifficulty( StringToDifficulty( sParams[1] ) ); } else if( sValueName=="METER" ) { pNewNotes->SetMeter( StringToInt( sParams[1] ) ); } else if( sValueName=="RADARVALUES" ) { vector saValues; split( sParams[1], ",", saValues, true ); int categories = NUM_RadarCategory; if( out.m_fVersion < VERSION_RADAR_FAKE ) categories -= 1; if( saValues.size() == (unsigned)categories * NUM_PLAYERS ) { RadarValues v[NUM_PLAYERS]; FOREACH_PlayerNumber( pn ) { // Can't use the foreach anymore due to flexible radar lines. for( RadarCategory rc = (RadarCategory)0; rc < categories; enum_add( rc, +1 ) ) { v[pn][rc] = StringToFloat( saValues[pn*categories + rc] ); } } pNewNotes->SetCachedRadarValues( v ); } } else if( sValueName=="CREDIT" ) { pNewNotes->SetCredit( sParams[1] ); } else if( sValueName=="NOTES" || sValueName=="NOTES2" ) { state = GETTING_SONG_INFO; if( bHasOwnTiming ) pNewNotes->m_Timing = stepsTiming; pNewNotes->SetSMNoteData( sParams[1] ); pNewNotes->TidyUpData(); out.AddSteps( pNewNotes ); } else if( sValueName=="BPMS" ) { if( SMLoader::ProcessBPMs(stepsTiming, sParams[1]) ) bHasOwnTiming = true; } else if( sValueName=="STOPS" ) { SMLoader::ProcessStops(stepsTiming, sParams[1]); } else if( sValueName=="DELAYS" ) { SMLoader::ProcessDelays(stepsTiming, sParams[1]); } else if( sValueName=="TIMESIGNATURES" ) { SMLoader::ProcessTimeSignatures(stepsTiming, sParams[1]); } else if( sValueName=="TICKCOUNTS" ) { SMLoader::ProcessTickcounts(stepsTiming, sParams[1]); } else if( sValueName=="COMBOS" ) { ProcessCombos(stepsTiming, sParams[1]); } else if( sValueName=="WARPS" ) { ProcessWarps(stepsTiming, sParams[1], out.m_fVersion); } else if( sValueName=="SPEEDS" ) { ProcessSpeeds( stepsTiming, sParams[1] ); } else if( sValueName=="FAKES" ) { ProcessFakes( stepsTiming, sParams[1] ); } else if( sValueName=="LABELS" ) { ProcessLabels(stepsTiming, sParams[1]); } else if( sValueName=="ATTACKS" ) { // Step Attacks aren't in yet. } else if( sValueName=="OFFSET" ) { stepsTiming.m_fBeat0OffsetInSeconds = StringToFloat( sParams[1] ); } break; } } } out.m_fVersion = STEPFILE_VERSION_NUMBER; return true; } void SSCLoader::GetApplicableFiles( const RString &sPath, vector &out ) { GetDirListing( sPath + RString("*.ssc"), out ); } bool SSCLoader::LoadEditFromFile( RString sEditFilePath, ProfileSlot slot, bool bAddStepsToSong ) { LOG->Trace( "SSCLoader::LoadEditFromFile(%s)", sEditFilePath.c_str() ); int iBytes = FILEMAN->GetFileSizeInBytes( sEditFilePath ); if( iBytes > MAX_EDIT_STEPS_SIZE_BYTES ) { LOG->UserLog( "Edit file", sEditFilePath, "is unreasonably large. It won't be loaded." ); return false; } MsdFile msd; if( !msd.ReadFile( sEditFilePath, true ) ) // unescape { LOG->UserLog( "Edit file", sEditFilePath, "couldn't be opened: %s", msd.GetError().c_str() ); return false; } return LoadEditFromMsd( msd, sEditFilePath, slot, bAddStepsToSong ); } bool SSCLoader::LoadEditFromMsd( const MsdFile &msd, const RString &sEditFilePath, ProfileSlot slot, bool bAddStepsToSong ) { Song* pSong = NULL; Steps* pNewNotes = NULL; bool bSSCFormat = false; bool bHasOwnTiming = false; TimingData stepsTiming; for( unsigned i=0; im_fVersion = StringToFloat( sParams[1] ); } else if( sValueName=="SONG" ) { if( pSong ) { LOG->UserLog( "Edit file", sEditFilePath, "has more than one #SONG tag." ); return false; } RString sSongFullTitle = sParams[1]; sSongFullTitle.Replace( '\\', '/' ); pSong = SONGMAN->FindSong( sSongFullTitle ); if( pSong == NULL ) { LOG->UserLog( "Edit file", sEditFilePath, "requires a song \"%s\" that isn't present.", sSongFullTitle.c_str() ); return false; } if( pSong->GetNumStepsLoadedFromProfile(slot) >= MAX_EDITS_PER_SONG_PER_PROFILE ) { LOG->UserLog( "Song file", sSongFullTitle, "already has the maximum number of edits allowed for ProfileSlotP%d.", slot+1 ); return false; } } else if( sValueName=="NOTEDATA" ) { pNewNotes = pSong->CreateSteps(); bSSCFormat = true; } if( sValueName=="STEPSTYPE" ) { pNewNotes->m_StepsType = GAMEMAN->StringToStepsType( sParams[1] ); bSSCFormat = true; } else if( sValueName=="CHARTSTYLE" ) { pNewNotes->SetChartStyle( sParams[1] ); bSSCFormat = true; } else if( sValueName=="DESCRIPTION" ) { pNewNotes->SetDescription( sParams[1] ); bSSCFormat = true; } else if( sValueName=="DIFFICULTY" ) { pNewNotes->SetDifficulty( StringToDifficulty( sParams[1] ) ); bSSCFormat = true; } else if( sValueName=="METER" ) { pNewNotes->SetMeter( StringToInt( sParams[1] ) ); bSSCFormat = true; } else if( sValueName=="RADARVALUES" ) { vector saValues; split( sParams[1], ",", saValues, true ); if( saValues.size() == NUM_RadarCategory * NUM_PLAYERS ) { RadarValues v[NUM_PLAYERS]; FOREACH_PlayerNumber( pn ) FOREACH_ENUM( RadarCategory, rc ) v[pn][rc] = StringToFloat( saValues[pn*NUM_RadarCategory + rc] ); pNewNotes->SetCachedRadarValues( v ); } bSSCFormat = true; } else if( sValueName=="CREDIT" ) { pNewNotes->SetCredit( sParams[1] ); bSSCFormat = true; } else if( sValueName=="BPMS" ) { if( SMLoader::ProcessBPMs(stepsTiming, sParams[1]) ) bHasOwnTiming = true; bSSCFormat = true; } else if( sValueName=="STOPS" ) { SMLoader::ProcessStops(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="DELAYS" ) { SMLoader::ProcessDelays(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="TIMESIGNATURES" ) { SMLoader::ProcessTimeSignatures(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="TICKCOUNTS" ) { SMLoader::ProcessTickcounts(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="COMBOS" ) { ProcessCombos(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="WARPS" ) { ProcessWarps(stepsTiming, sParams[1], pSong->m_fVersion); bSSCFormat = true; } else if( sValueName=="SPEEDS" ) { ProcessSpeeds( stepsTiming, sParams[1] ); bSSCFormat = true; } else if( sValueName=="FAKES" ) { ProcessFakes( stepsTiming, sParams[1] ); bSSCFormat = true; } else if( sValueName=="LABELS" ) { ProcessLabels(stepsTiming, sParams[1]); bSSCFormat = true; } else if( sValueName=="NOTES" ) { if( pSong == NULL ) { LOG->UserLog( "Edit file", sEditFilePath, "doesn't have a #SONG tag preceeding the first #NOTES tag." ); return false; } if ( !bSSCFormat && iNumParams < 7 ) { LOG->UserLog( "Edit file", sEditFilePath, "has %d fields in a #NOTES tag, but should have at least 7.", iNumParams ); continue; } if( !bAddStepsToSong ) return true; if( bSSCFormat ) { if ( bHasOwnTiming ) { pNewNotes->m_Timing = stepsTiming; } pNewNotes->SetSMNoteData( sParams[1] ); pNewNotes->TidyUpData(); pSong->AddSteps( pNewNotes ); } else { pNewNotes = pSong->CreateSteps(); SMLoader::LoadFromSMTokens( sParams[1], sParams[2], sParams[3], sParams[4], sParams[5], sParams[6], *pNewNotes); } pNewNotes->SetLoadedFromProfile( slot ); pNewNotes->SetDifficulty( Difficulty_Edit ); pNewNotes->SetFilename( sEditFilePath ); if( pSong->IsEditAlreadyLoaded(pNewNotes) ) { LOG->UserLog( "Edit file", sEditFilePath, "is a duplicate of another edit that was already loaded." ); SAFE_DELETE( pNewNotes ); return false; } pSong->AddSteps( pNewNotes ); return true; // Only allow one Steps per edit file! } else { LOG->UserLog( "Edit file", sEditFilePath, "has an unexpected value \"%s\".", sValueName.c_str() ); } } //return true; // only load a SSC edit if it passes the checks. -aj return bSSCFormat; } void SSCLoader::TidyUpData( Song &song, bool bFromCache ) { SMLoader::TidyUpData(song, bFromCache); } /* * (c) 2011 Jason Felds * 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. */