base_media_music.h

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
 * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
 * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
 */
 
#ifndef BASE_MEDIA_MUSIC_H
#define BASE_MEDIA_MUSIC_H
 
#include "base_media_base.h"
 
static const uint NUM_SONGS_CLASS     = 10;
static const uint NUM_SONG_CLASSES    = 3;
static const uint NUM_SONGS_AVAILABLE = 1 + NUM_SONG_CLASSES * NUM_SONGS_CLASS;
 
static const uint NUM_SONGS_PLAYLIST  = 32;
 
/* Functions to read DOS music CAT files, similar to but not quite the same as sound effect CAT files */
std::optional<std::string> GetMusicCatEntryName(const std::string &filename, size_t entrynum);
std::optional<std::vector<uint8_t>> GetMusicCatEntryData(const std::string &filename, size_t entrynum);
 
enum MusicTrackType : uint8_t {
  MTT_STANDARDMIDI, 
  MTT_MPSMIDI,      
};
 
struct MusicSongInfo {
  std::string songname;    
  uint8_t tracknr;            
  std::string filename;    
  MusicTrackType filetype; 
  int cat_index;           
  bool loop;               
  int override_start;      
  int override_end;        
};
 
template <> struct BaseSetTraits<struct MusicSet> {
  static constexpr size_t num_files = NUM_SONGS_AVAILABLE;
  static constexpr bool search_in_tars = false;
  static constexpr std::string_view set_type = "music";
};
 
struct MusicSet : BaseSet<MusicSet> {
  MusicSongInfo songinfo[NUM_SONGS_AVAILABLE];
  uint8_t num_available = 0;
 
  bool FillSetDetails(const IniFile &ini, const std::string &path, const std::string &full_filename);
};
 
class BaseMusic : public BaseMedia<MusicSet> {
public:
  static inline std::string ini_set;
};
 
#endif /* BASE_MEDIA_MUSIC_H */