NotesLoaderSM.h

#ifndef NotesLoaderSM_H
#define NotesLoaderSM_H
 
#include "Etterna/Models/Misc/BackgroundUtil.h"
#include "Etterna/Models/Misc/GameConstantsAndTypes.h"
 
#include "Etterna/FileTypes/MsdFile.h" // we require the struct from here.
 
class Song;
class Steps;
class TimingData;
 
const float FAST_BPM_WARP = 9999999.f;
 
const int MAX_EDIT_STEPS_SIZE_BYTES = 60 * 1024; // 60KB
 
struct SMLoader
{
    SMLoader()
      : fileExt(".sm")
    {
    }
 
    SMLoader(std::string ext)
      : fileExt(ext)
    {
    }
 
    virtual ~SMLoader() = default;
 
    virtual bool LoadFromDir(const std::string& sPath, Song& out);
    static void TidyUpData(Song& song, bool bFromCache);
 
    virtual bool LoadNoteDataFromSimfile(const std::string& path, Steps& out);
 
    virtual bool LoadFromSimfile(const std::string& sPath,
                                 Song& out,
                                 bool bFromCache = false);
    virtual void GetApplicableFiles(const std::string& sPath,
                                    std::vector<std::string>& out);
    virtual bool LoadFromBGChangesString(
      BackgroundChange& change,
      const std::string& sBGChangeExpression);
 
    void ParseBPMs(std::vector<std::pair<float, float>>& out,
                   const std::string& line,
                   const int rowsPerBeat = -1);
    void ProcessBPMs(TimingData& out,
                     const std::vector<std::pair<float, float>>& vBPMChanges);
    void ParseStops(std::vector<std::pair<float, float>>& out,
                    const std::string& line,
                    const int rowsPerBeat = -1);
    void ProcessStops(TimingData& out,
                      const std::vector<std::pair<float, float>>& vStops);
    void ProcessBPMsAndStops(TimingData& out,
                             std::vector<std::pair<float, float>>& vBPMs,
                             std::vector<std::pair<float, float>>& vStops);
    void ProcessDelays(TimingData& out,
                       const std::string& line,
                       const int rowsPerBeat = -1);
    static void ProcessDelays(TimingData& out,
                              const std::string& line,
                              const std::string& songname,
                              const int rowsPerBeat = -1);
    void ProcessTimeSignatures(TimingData& out,
                               const std::string& line,
                               const int rowsPerBeat = -1);
    static void ProcessTimeSignatures(TimingData& out,
                                      const std::string& line,
                                      const std::string& songname,
                                      const int rowsPerBeat = -1);
    void ProcessTickcounts(TimingData& out,
                           const std::string& line,
                           const int rowsPerBeat = -1);
    static void ProcessTickcounts(TimingData& out,
                                  const std::string& line,
                                  const std::string& songname,
                                  const int rowsPerBeat = -1);
 
    virtual void ProcessSpeeds(TimingData& out,
                               const std::string& line,
                               const int rowsPerBeat = -1);
    static void ProcessSpeeds(TimingData& out,
                              const std::string& line,
                              const std::string& songname,
                              const int rowsPerBeat = -1);
 
    virtual void ProcessCombos(TimingData& /* out */,
                               const std::string& line,
                               const int /* rowsPerBeat */ = -1)
    {
    }
 
    virtual void ProcessFakes(TimingData& out,
                              const std::string& line,
                              const int rowsPerBeat = -1);
    static void ProcessFakes(TimingData& out,
                             const std::string& line,
                             const std::string& songname,
                             const int rowsPerBeat = -1);
 
    virtual void ProcessBGChanges(Song& out,
                                  const std::string& sValueName,
                                  const std::string& sPath,
                                  const std::string& sParam);
 
    void ProcessInstrumentTracks(Song& out, const std::string& sParam);
 
    static float RowToBeat(const std::string& line, const int rowsPerBeat);
 
  protected:
    virtual void LoadFromTokens(std::string sStepsType,
                                std::string sDescription,
                                std::string sDifficulty,
                                std::string sMeter,
                                std::string sNoteData,
                                Steps& out);
 
    std::string GetFileExtension() const { return fileExt; }
 
    std::string GetChartPath() const { return chartPath; }
 
  public:
    // SetSongTitle and GetSongTitle changed to public to allow the functions
    // used by the parser helper to access them. -Kyz
    virtual void SetSongTitle(const std::string& title);
 
    virtual std::string GetSongTitle() const;
 
  private:
    const std::string fileExt;
    std::string songTitle;
    std::string chartPath;
};
 
#endif