BackgroundUtil.h

#ifndef BackgroundUtil_H
#define BackgroundUtil_H
 
#include <string>
#include <vector>
 
class Song;
class XNode;
 
extern const std::string RANDOM_BACKGROUND_FILE;
extern const std::string NO_SONG_BG_FILE;
extern const std::string SONG_BACKGROUND_FILE;
 
extern const std::string SBE_UpperLeft;
extern const std::string SBE_Centered;
extern const std::string SBE_StretchNormal;
extern const std::string SBE_StretchNoLoop;
extern const std::string SBE_StretchRewind;
extern const std::string SBT_CrossFade;
 
struct BackgroundDef
{
    bool operator<(const BackgroundDef& other) const;
    bool operator==(const BackgroundDef& other) const;
    [[nodiscard]] bool IsEmpty() const { return m_sFile1.empty() && m_sFile2.empty(); }
    std::string m_sEffect; // "" == automatically choose
    std::string m_sFile1;  // must not be ""
    std::string m_sFile2;  // may be ""
    std::string m_sColor1; // "" == use default
    std::string m_sColor2; // "" == use default
 
    [[nodiscard]] XNode* CreateNode() const;
 
    BackgroundDef()
      : m_sEffect("")
      , m_sFile1("")
      , m_sFile2("")
      , m_sColor1("")
      , m_sColor2("")
    {
    }
 
    BackgroundDef(const std::string& effect,
                  const std::string& f1,
                  const std::string& f2)
      : m_sEffect(effect)
      , m_sFile1(f1)
      , m_sFile2(f2)
      , m_sColor1("")
      , m_sColor2("")
    {
    }
};
 
struct BackgroundChange
{
    BackgroundChange()
      : m_def()
      , m_sTransition("")
    {
    }
 
    BackgroundChange(float s,
                     std::string f1,
                     std::string f2 = std::string(),
                     float r = 1.f,
                     std::string e = SBE_Centered,
                     std::string t = std::string())
      : m_def(e, f1, f2)
      , m_fStartBeat(s)
      , m_fRate(r)
      , m_sTransition(t)
    {
    }
 
    BackgroundDef m_def;
    float m_fStartBeat{ -1 };
    float m_fRate{ 1 };
    std::string m_sTransition;
 
    [[nodiscard]] std::string GetTextDescription() const;
 
    [[nodiscard]] std::string ToString() const;
};
namespace BackgroundUtil {
void
AddBackgroundChange(std::vector<BackgroundChange>& vBackgroundChanges,
                    const BackgroundChange& seg);
void
SortBackgroundChangesArray(std::vector<BackgroundChange>& vBackgroundChanges);
 
void
GetBackgroundEffects(const std::string& sName,
                     std::vector<std::string>& vsPathsOut,
                     std::vector<std::string>& vsNamesOut);
void
GetBackgroundTransitions(const std::string& sName,
                         std::vector<std::string>& vsPathsOut,
                         std::vector<std::string>& vsNamesOut);
 
void
GetSongBGAnimations(const Song* pSong,
                    const std::string& sMatch,
                    std::vector<std::string>& vsPathsOut,
                    std::vector<std::string>& vsNamesOut);
void
GetSongMovies(const Song* pSong,
              const std::string& sMatch,
              std::vector<std::string>& vsPathsOut,
              std::vector<std::string>& vsNamesOut);
void
GetSongBitmaps(const Song* pSong,
               const std::string& sMatch,
               std::vector<std::string>& vsPathsOut,
               std::vector<std::string>& vsNamesOut);
void
GetGlobalBGAnimations(const Song* pSong,
                      const std::string& sMatch,
                      std::vector<std::string>& vsPathsOut,
                      std::vector<std::string>& vsNamesOut);
void
BakeAllBackgroundChanges(Song* pSong);
};
 
#endif