music_gui.cpp

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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "openttd.h"
#include "base_media_base.h"
#include "base_media_music.h"
#include "music/music_driver.hpp"
#include "window_gui.h"
#include "strings_func.h"
#include "window_func.h"
#include "sound_func.h"
#include "gfx_func.h"
#include "zoom_func.h"
#include "core/random_func.hpp"
#include "error.h"
#include "core/geometry_func.hpp"
#include "string_func.h"
#include "settings_type.h"
#include "settings_gui.h"
#include "dropdown_func.h"
#include "dropdown_type.h"
#include "slider_func.h"
#include "mixer.h"
 
#include "widgets/music_widget.h"
 
#include "table/strings.h"
#include "table/sprites.h"
 
#include "safeguards.h"
 
 
struct MusicSystem {
  struct PlaylistEntry : MusicSongInfo {
    const MusicSet *set; 
    uint set_index; 
 
    PlaylistEntry(const MusicSet *set, uint set_index) : MusicSongInfo(set->songinfo[set_index]), set(set), set_index(set_index) { }
    bool IsValid() const { return !this->songname.empty(); }
  };
  typedef std::vector<PlaylistEntry> Playlist;
 
  Playlist active_playlist{}; 
  Playlist music_set{}; 
 
  PlaylistChoice selected_playlist{};
 
  void BuildPlaylists();
 
  void ChangePlaylist(PlaylistChoice pl);
  void ChangeMusicSet(const std::string &set_name);
  void Shuffle();
  void Unshuffle();
 
  void Play();
  void Stop();
  void Next();
  void Prev();
  void CheckStatus();
 
  bool IsPlaying() const;
  bool IsShuffle() const;
  PlaylistEntry GetCurrentSong() const;
 
  bool IsCustomPlaylist() const;
  void PlaylistAdd(size_t song_index);
  void PlaylistRemove(size_t song_index);
  void PlaylistClear();
 
private:
  uint GetSetIndex();
  void SetPositionBySetIndex(uint set_index);
  void ChangePlaylistPosition(int ofs);
  int playlist_position = 0;
 
  void SaveCustomPlaylist(PlaylistChoice pl);
 
  EnumIndexArray<Playlist, PlaylistChoice, PlaylistChoice::End> standard_playlists{};
};
 
MusicSystem _music;
 

void MusicSystem::BuildPlaylists()
{
  const MusicSet *set = BaseMusic::GetUsedSet();
 
  /* Clear current playlists */
  for (auto &playlist : this->standard_playlists) playlist.clear();
  this->music_set.clear();
 
  /* Build standard playlists, and a list of available music */
  for (uint i = 0; i < NUM_SONGS_AVAILABLE; i++) {
    PlaylistEntry entry(set, i);
    if (!entry.IsValid()) continue;
 
    this->music_set.push_back(entry);
 
    /* Add theme song to theme-only playlist */
    if (i == 0) this->standard_playlists[PlaylistChoice::ThemeOnly].push_back(std::move(entry));
 
    /* Don't add the theme song to standard playlists */
    if (i > 0) {
      this->standard_playlists[PlaylistChoice::All].push_back(entry);
      PlaylistChoice theme = static_cast<PlaylistChoice>(to_underlying(PlaylistChoice::OldStyle) + (i - 1) / NUM_SONGS_CLASS);
      this->standard_playlists[theme].push_back(std::move(entry));
    }
  }
 
  /* Load custom playlists
   * Song index offsets are 1-based, zero indicates invalid/end-of-list value */
  for (uint i = 0; i < NUM_SONGS_PLAYLIST; i++) {
    if (_settings_client.music.custom_1[i] > 0 && _settings_client.music.custom_1[i] <= NUM_SONGS_AVAILABLE) {
      PlaylistEntry entry(set, _settings_client.music.custom_1[i] - 1);
      if (entry.IsValid()) this->standard_playlists[PlaylistChoice::Custom1].push_back(std::move(entry));
    }
    if (_settings_client.music.custom_2[i] > 0 && _settings_client.music.custom_2[i] <= NUM_SONGS_AVAILABLE) {
      PlaylistEntry entry(set, _settings_client.music.custom_2[i] - 1);
      if (entry.IsValid()) this->standard_playlists[PlaylistChoice::Custom2].push_back(std::move(entry));
    }
  }
}

void MusicSystem::ChangePlaylist(PlaylistChoice pl)
{
  assert(pl < PlaylistChoice::End && pl >= PlaylistChoice::All);
 
  if (pl != PlaylistChoice::ThemeOnly) _settings_client.music.playlist = pl;
 
  if (_game_mode != GameMode::Menu || pl == PlaylistChoice::ThemeOnly) {
    this->selected_playlist = pl;
    this->active_playlist = this->standard_playlists[this->selected_playlist];
    this->playlist_position = 0;
 
    if (_settings_client.music.shuffle) this->Shuffle();
    if (_settings_client.music.playing) this->Play();
  }
 
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0);
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::ChangeMusicSet(const std::string &set_name)
{
  BaseMusic::SetSetByName(set_name);
  BaseMusic::ini_set = set_name;
 
  this->BuildPlaylists();
  this->ChangePlaylist(this->selected_playlist);
 
  InvalidateWindowData(WindowClass::GameOptions, GameOptionsWindowNumber::GameOptions, 0, true);
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0, 1, true);
  InvalidateWindowData(WindowClass::Music, 0, 1, true);
}

void MusicSystem::SetPositionBySetIndex(uint set_index)
{
  auto it = std::ranges::find(this->active_playlist, set_index, &PlaylistEntry::set_index);
  if (it != std::end(this->active_playlist)) this->playlist_position = std::distance(std::begin(this->active_playlist), it);
}

uint MusicSystem::GetSetIndex()
{
  return static_cast<size_t>(this->playlist_position) < this->active_playlist.size()
    ? this->active_playlist[this->playlist_position].set_index
    : UINT_MAX;
}

void MusicSystem::Shuffle()
{
  _settings_client.music.shuffle = true;
 
  uint set_index = this->GetSetIndex();
  this->active_playlist = this->standard_playlists[this->selected_playlist];
  for (size_t i = 0; i < this->active_playlist.size(); i++) {
    size_t shuffle_index = InteractiveRandom() % (this->active_playlist.size() - i);
    std::swap(this->active_playlist[i], this->active_playlist[i + shuffle_index]);
  }
  this->SetPositionBySetIndex(set_index);
 
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0);
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::Unshuffle()
{
  _settings_client.music.shuffle = false;
 
  uint set_index = this->GetSetIndex();
  this->active_playlist = this->standard_playlists[this->selected_playlist];
  this->SetPositionBySetIndex(set_index);
 
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0);
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::Play()
{
  /* Always set the playing flag, even if there is no music */
  _settings_client.music.playing = true;
  MusicDriver::GetInstance()->StopSong();
  /* Make sure playlist_position is a valid index, if playlist has changed etc. */
  this->ChangePlaylistPosition(0);
 
  /* If there is no music, don't try to play it */
  if (this->active_playlist.empty()) return;
 
  MusicSongInfo song = this->active_playlist[this->playlist_position];
  if (_game_mode == GameMode::Menu && this->selected_playlist == PlaylistChoice::ThemeOnly) song.loop = true;
  MusicDriver::GetInstance()->PlaySong(song);
 
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::Stop()
{
  MusicDriver::GetInstance()->StopSong();
  _settings_client.music.playing = false;
 
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::Next()
{
  this->ChangePlaylistPosition(+1);
  if (_settings_client.music.playing) this->Play();
 
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::Prev()
{
  this->ChangePlaylistPosition(-1);
  if (_settings_client.music.playing) this->Play();
 
  InvalidateWindowData(WindowClass::Music, 0);
}

void MusicSystem::CheckStatus()
{
  if ((_game_mode == GameMode::Menu) != (this->selected_playlist == PlaylistChoice::ThemeOnly)) {
    /* Make sure the theme-only playlist is active when on the title screen, and not during gameplay */
    this->ChangePlaylist((_game_mode == GameMode::Menu) ? PlaylistChoice::ThemeOnly : (PlaylistChoice)_settings_client.music.playlist);
  }
  if (this->active_playlist.empty()) return;
  /* If we were supposed to be playing, but music has stopped, move to next song */
  if (this->IsPlaying() && !MusicDriver::GetInstance()->IsSongPlaying()) this->Next();
}

bool MusicSystem::IsPlaying() const
{
  return _settings_client.music.playing && !this->active_playlist.empty();
}

bool MusicSystem::IsShuffle() const
{
  return _settings_client.music.shuffle;
}

MusicSystem::PlaylistEntry MusicSystem::GetCurrentSong() const
{
  if (!this->IsPlaying()) return PlaylistEntry(BaseMusic::GetUsedSet(), 0);
  return this->active_playlist[this->playlist_position];
}

bool MusicSystem::IsCustomPlaylist() const
{
  return (this->selected_playlist == PlaylistChoice::Custom1) || (this->selected_playlist == PlaylistChoice::Custom2);
}

void MusicSystem::PlaylistAdd(size_t song_index)
{
  if (!this->IsCustomPlaylist()) return;
 
  /* Pick out song from the music set */
  if (song_index >= this->music_set.size()) return;
  PlaylistEntry entry = this->music_set[song_index];
 
  /* Check for maximum length */
  if (this->standard_playlists[this->selected_playlist].size() >= NUM_SONGS_PLAYLIST) return;
 
  /* Add it to the appropriate playlist, and the display */
  this->standard_playlists[this->selected_playlist].push_back(entry);
 
  /* Add it to the active playlist, if playback is shuffled select a random position to add at */
  if (this->active_playlist.empty()) {
    this->active_playlist.push_back(std::move(entry));
    if (this->IsPlaying()) this->Play();
  } else if (this->IsShuffle()) {
    /* Generate a random position between 0 and n (inclusive, new length) to insert at */
    size_t maxpos = this->active_playlist.size() + 1;
    size_t newpos = InteractiveRandom() % maxpos;
    this->active_playlist.insert(this->active_playlist.begin() + newpos, entry);
    /* Make sure to shift up the current playback position if the song was inserted before it */
    if ((int)newpos <= this->playlist_position) this->playlist_position++;
  } else {
    this->active_playlist.push_back(std::move(entry));
  }
 
  this->SaveCustomPlaylist(this->selected_playlist);
 
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0);
}

void MusicSystem::PlaylistRemove(size_t song_index)
{
  if (!this->IsCustomPlaylist()) return;
 
  if (song_index >= this->active_playlist.size()) return;
 
  PlaylistEntry song = this->active_playlist[song_index];
  this->active_playlist.erase(std::next(std::begin(this->active_playlist), song_index));
 
  Playlist &playlist = this->standard_playlists[this->selected_playlist];
  auto it = std::end(playlist);
  if (this->IsShuffle()) {
    /* Playlist is shuffled, so remove the first instance. */
    it = std::ranges::find_if(playlist, [&song](const auto &s) { return s.filename == song.filename && s.cat_index == song.cat_index; });
  } else if (song_index < playlist.size()) {
    /* Not shuffled, we can remove the entry directly. */
    it = std::next(std::begin(playlist), song_index);
  }
 
  if (it == std::end(playlist)) return;
  it = playlist.erase(it);
 
  /* If it's the current song restart playback. */
  if (this->IsPlaying() && std::distance(std::begin(playlist), it) == this->playlist_position) this->Play();
 
  this->SaveCustomPlaylist(this->selected_playlist);
 
  InvalidateWindowData(WindowClass::MusicTrackSelection, 0);
}

void MusicSystem::PlaylistClear()
{
  if (!this->IsCustomPlaylist()) return;
 
  this->standard_playlists[this->selected_playlist].clear();
  this->ChangePlaylist(this->selected_playlist);
 
  this->SaveCustomPlaylist(this->selected_playlist);
}

void MusicSystem::ChangePlaylistPosition(int ofs)
{
  if (this->active_playlist.empty()) {
    this->playlist_position = 0;
  } else {
    this->playlist_position += ofs;
    while (this->playlist_position >= (int)this->active_playlist.size()) this->playlist_position -= (int)this->active_playlist.size();
    while (this->playlist_position < 0) this->playlist_position += (int)this->active_playlist.size();
  }
}

void MusicSystem::SaveCustomPlaylist(PlaylistChoice pl)
{
  uint8_t *settings_pl;
  if (pl == PlaylistChoice::Custom1) {
    settings_pl = _settings_client.music.custom_1;
  } else if (pl == PlaylistChoice::Custom2) {
    settings_pl = _settings_client.music.custom_2;
  } else {
    return;
  }
 
  size_t num = 0;
  std::fill_n(settings_pl, NUM_SONGS_PLAYLIST, 0);
 
  for (const auto &song : this->standard_playlists[pl]) {
    /* Music set indices in the settings playlist are 1-based, 0 means unused slot */
    settings_pl[num++] = (uint8_t)song.set_index + 1;
  }
}
 

void MusicLoop()
{
  _music.CheckStatus();
}

void ChangeMusicSet(int index)
{
  if (BaseMusic::GetIndexOfUsedSet() == index) return;
  _music.ChangeMusicSet(BaseMusic::GetSet(index)->name);
}

void InitializeMusic()
{
  _music.BuildPlaylists();
}

static bool IsCustomPlaylist(PlaylistChoice playlist)
{
  return playlist == PlaylistChoice::Custom1 || playlist == PlaylistChoice::Custom2;
}
 
struct MusicTrackSelectionWindow : public Window {
  MusicTrackSelectionWindow(WindowDesc &desc, WindowNumber number) : Window(desc)
  {
    this->InitNested(number);
    this->LowerWidget(WID_MTS_LIST_LEFT);
    this->LowerWidget(WID_MTS_LIST_RIGHT);
    this->SetWidgetDisabledState(WID_MTS_CLEAR, !IsCustomPlaylist(_settings_client.music.playlist));
    this->LowerWidget(WID_MTS_ALL + to_underlying(_settings_client.music.playlist));
  }
 
  std::string GetWidgetString(WidgetID widget, StringID stringid) const override
  {
    switch (widget) {
      case WID_MTS_PLAYLIST:
        return GetString(STR_PLAYLIST_PROGRAM, STR_MUSIC_PLAYLIST_ALL + to_underlying(_settings_client.music.playlist));
 
      case WID_MTS_CAPTION:
        return GetString(STR_PLAYLIST_MUSIC_SELECTION_SETNAME, BaseMusic::GetUsedSet()->name);
 
      default:
        return this->Window::GetWidgetString(widget, stringid);
    }
  }

  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (!gui_scope) return;
    for (PlaylistChoice playlist : EnumRange(PlaylistChoice::ThemeOnly)) {
      this->SetWidgetLoweredState(WID_MTS_ALL + to_underlying(playlist), playlist == _settings_client.music.playlist);
    }
    this->SetWidgetDisabledState(WID_MTS_CLEAR, !IsCustomPlaylist(_settings_client.music.playlist));
 
    if (data == 1) {
      this->ReInit();
    } else {
      this->SetDirty();
    }
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      case WID_MTS_PLAYLIST: {
        Dimension d = {0, 0};
 
        for (int i = 0; i < 6; i++) {
          d = maxdim(d, GetStringBoundingBox(GetString(STR_PLAYLIST_PROGRAM, STR_MUSIC_PLAYLIST_ALL + i)));
        }
        d.width += padding.width;
        d.height += padding.height;
        size = maxdim(size, d);
        break;
      }
 
      case WID_MTS_LIST_LEFT: case WID_MTS_LIST_RIGHT: {
        Dimension d = {0, 0};
 
        for (const auto &song : _music.music_set) {
          d = maxdim(d, GetStringBoundingBox(GetString(STR_PLAYLIST_TRACK_NAME, song.tracknr, 2, song.songname)));
        }
        d.height *= std::max(NUM_SONGS_AVAILABLE, NUM_SONGS_PLAYLIST);
 
        d.width += padding.width;
        d.height += padding.height;
        size = maxdim(size, d);
        break;
      }
    }
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_MTS_LIST_LEFT: {
        GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), PC_BLACK);
 
        Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
        for (const auto &song : _music.music_set) {
          DrawString(tr, GetString(STR_PLAYLIST_TRACK_NAME, song.tracknr, 2, song.songname));
          tr.top += GetCharacterHeight(FontSize::Small);
        }
        break;
      }
 
      case WID_MTS_LIST_RIGHT: {
        GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), PC_BLACK);
 
        Rect tr = r.Shrink(WidgetDimensions::scaled.framerect);
        for (const auto &song : _music.active_playlist) {
          DrawString(tr, GetString(STR_PLAYLIST_TRACK_NAME, song.tracknr, 2, song.songname));
          tr.top += GetCharacterHeight(FontSize::Small);
        }
        break;
      }
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_MTS_LIST_LEFT: { // add to playlist
        int y = this->GetRowFromWidget(pt.y, widget, WidgetDimensions::scaled.framerect.top, GetCharacterHeight(FontSize::Small));
        _music.PlaylistAdd(y);
        break;
      }
 
      case WID_MTS_LIST_RIGHT: { // remove from playlist
        int y = this->GetRowFromWidget(pt.y, widget, WidgetDimensions::scaled.framerect.top, GetCharacterHeight(FontSize::Small));
        _music.PlaylistRemove(y);
        break;
      }
 
      case WID_MTS_MUSICSET: {
        int selected = 0;
        ShowDropDownList(this, BuildSetDropDownList<BaseMusic>(&selected), selected, widget, 0, DropDownOption::Filterable);
        break;
      }
 
      case WID_MTS_CLEAR: // clear
        _music.PlaylistClear();
        break;
 
      case WID_MTS_ALL: case WID_MTS_OLD: case WID_MTS_NEW:
      case WID_MTS_EZY: case WID_MTS_CUSTOM1: case WID_MTS_CUSTOM2: // set playlist
        _music.ChangePlaylist(static_cast<PlaylistChoice>(widget - WID_MTS_ALL));
        break;
    }
  }
 
  void OnDropdownSelect(WidgetID widget, int index, int) override
  {
    switch (widget) {
      case WID_MTS_MUSICSET:
        ChangeMusicSet(index);
        break;
      default:
        NOT_REACHED();
    }
  }
};
 
static constexpr std::initializer_list<NWidgetPart> _nested_music_track_selection_widgets = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::Grey),
    NWidget(WWT_CAPTION, Colours::Grey, WID_MTS_CAPTION),
    NWidget(WWT_DROPDOWN, Colours::Grey, WID_MTS_MUSICSET), SetStringTip(STR_PLAYLIST_CHANGE_SET, STR_PLAYLIST_TOOLTIP_CHANGE_SET),
  EndContainer(),
  NWidget(WWT_PANEL, Colours::Grey),
    NWidget(NWID_HORIZONTAL), SetPIP(2, 4, 2),
      /* Left panel. */
      NWidget(NWID_VERTICAL),
        NWidget(WWT_LABEL, Colours::Invalid), SetFill(1, 0), SetStringTip(STR_PLAYLIST_TRACK_INDEX),
        NWidget(WWT_PANEL, Colours::Grey, WID_MTS_LIST_LEFT), SetFill(1, 1), SetMinimalSize(180, 194), SetToolTip(STR_PLAYLIST_TOOLTIP_CLICK_TO_ADD_TRACK), EndContainer(),
        NWidget(NWID_SPACER), SetFill(1, 0), SetMinimalSize(0, 2),
      EndContainer(),
      /* Middle buttons. */
      NWidget(NWID_VERTICAL),
        NWidget(NWID_SPACER), SetMinimalSize(60, 30), // Space above the first button from the title bar.
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_ALL), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_ALL, STR_MUSIC_TOOLTIP_SELECT_ALL_TRACKS_PROGRAM),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_OLD), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_OLD_STYLE, STR_MUSIC_TOOLTIP_SELECT_OLD_STYLE_MUSIC),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_NEW), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_NEW_STYLE, STR_MUSIC_TOOLTIP_SELECT_NEW_STYLE_MUSIC),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_EZY), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_EZY_STREET, STR_MUSIC_TOOLTIP_SELECT_EZY_STREET_STYLE),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_CUSTOM1), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_CUSTOM_1, STR_MUSIC_TOOLTIP_SELECT_CUSTOM_1_USER_DEFINED),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_MTS_CUSTOM2), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_CUSTOM_2, STR_MUSIC_TOOLTIP_SELECT_CUSTOM_2_USER_DEFINED),
        NWidget(NWID_SPACER), SetMinimalSize(0, 16), // Space above 'clear' button
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_MTS_CLEAR), SetFill(1, 0), SetStringTip(STR_PLAYLIST_CLEAR, STR_PLAYLIST_TOOLTIP_CLEAR_CURRENT_PROGRAM_CUSTOM1),
        NWidget(NWID_SPACER), SetFill(0, 1),
      EndContainer(),
      /* Right panel. */
      NWidget(NWID_VERTICAL),
        NWidget(WWT_LABEL, Colours::Invalid, WID_MTS_PLAYLIST), SetFill(1, 0),
        NWidget(WWT_PANEL, Colours::Grey, WID_MTS_LIST_RIGHT), SetFill(1, 1), SetMinimalSize(180, 194), SetToolTip(STR_PLAYLIST_TOOLTIP_CLICK_TO_REMOVE_TRACK), EndContainer(),
        NWidget(NWID_SPACER), SetFill(1, 0), SetMinimalSize(0, 2),
      EndContainer(),
    EndContainer(),
  EndContainer(),
};

static WindowDesc _music_track_selection_desc(
  WindowPosition::Automatic, {}, 0, 0,
  WindowClass::MusicTrackSelection, WindowClass::None,
  {},
  _nested_music_track_selection_widgets
);
 
static void ShowMusicTrackSelection()
{
  AllocateWindowDescFront<MusicTrackSelectionWindow>(_music_track_selection_desc, 0);
}
 
struct MusicWindow : public Window {
  MusicWindow(WindowDesc &desc, WindowNumber number) : Window(desc)
  {
    this->InitNested(number);
    this->LowerWidget(WID_M_ALL + to_underlying(_settings_client.music.playlist));
    this->SetWidgetLoweredState(WID_M_SHUFFLE, _settings_client.music.shuffle);
 
    UpdateDisabledButtons();
  }
 
  void UpdateDisabledButtons()
  {
    /* Disable stop and play if there is no music. */
    this->SetWidgetsDisabledState(BaseMusic::GetUsedSet()->num_available == 0, WID_M_STOP, WID_M_PLAY);
    /* Disable most music control widgets if there is no music, or we are in the intro menu. */
    this->SetWidgetsDisabledState(
      BaseMusic::GetUsedSet()->num_available == 0 || _game_mode == GameMode::Menu,
      WID_M_PREV, WID_M_NEXT, WID_M_SHUFFLE,
      WID_M_ALL, WID_M_OLD, WID_M_NEW, WID_M_EZY, WID_M_CUSTOM1, WID_M_CUSTOM2
      );
    /* Also disable programme button in the intro menu (not in game; it is desirable to allow change of music set.) */
    this->SetWidgetsDisabledState(_game_mode == GameMode::Menu, WID_M_PROGRAMME);
  }
 
  void UpdateWidgetSize(WidgetID widget, Dimension &size, [[maybe_unused]] const Dimension &padding, [[maybe_unused]] Dimension &fill, [[maybe_unused]] Dimension &resize) override
  {
    switch (widget) {
      /* Make sure that WID_M_SHUFFLE and WID_M_PROGRAMME have the same size.
       * This can't be done by using NWidContainerFlag::EqualSize as the WID_M_INFO is
       * between those widgets and of different size. */
      case WID_M_SHUFFLE: case WID_M_PROGRAMME: {
        Dimension d = maxdim(GetStringBoundingBox(STR_MUSIC_PROGRAM), GetStringBoundingBox(STR_MUSIC_SHUFFLE));
        d.width += padding.width;
        d.height += padding.height;
        size = maxdim(size, d);
        break;
      }
 
      case WID_M_TRACK_NR: {
        Dimension d = GetStringBoundingBox(STR_MUSIC_TRACK_NONE);
        d = maxdim(d, GetStringBoundingBox(GetString(STR_MUSIC_TRACK_DIGIT, GetParamMaxDigits(2, FontSize::Small), 2)));
        d.width += padding.width;
        d.height += padding.height + WidgetDimensions::scaled.fullbevel.bottom;
        size = maxdim(size, d);
        break;
      }
 
      case WID_M_TRACK_NAME: {
        Dimension d = GetStringBoundingBox(STR_MUSIC_TITLE_NONE);
        for (const auto &song : _music.music_set) {
          d = maxdim(d, GetStringBoundingBox(GetString(STR_MUSIC_TITLE_NAME, song.songname)));
        }
        d.width += padding.width;
        d.height += padding.height + WidgetDimensions::scaled.fullbevel.bottom;
        size = maxdim(size, d);
        break;
      }
 
      /* Hack-ish: set the proper widget data; only needs to be done once
       * per (Re)Init as that's the only time the language changes. */
      case WID_M_PREV: this->GetWidget<NWidgetCore>(WID_M_PREV)->SetSprite(_current_text_dir == TD_RTL ? SPR_IMG_SKIP_TO_NEXT : SPR_IMG_SKIP_TO_PREV); break;
      case WID_M_NEXT: this->GetWidget<NWidgetCore>(WID_M_NEXT)->SetSprite(_current_text_dir == TD_RTL ? SPR_IMG_SKIP_TO_PREV : SPR_IMG_SKIP_TO_NEXT); break;
      case WID_M_PLAY: this->GetWidget<NWidgetCore>(WID_M_PLAY)->SetSprite(_current_text_dir == TD_RTL ? SPR_IMG_PLAY_MUSIC_RTL : SPR_IMG_PLAY_MUSIC); break;
    }
  }
 
  void DrawWidget(const Rect &r, WidgetID widget) const override
  {
    switch (widget) {
      case WID_M_TRACK_NR: {
        GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), PC_BLACK);
        if (BaseMusic::GetUsedSet()->num_available == 0) {
          break;
        }
        Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
        if (_music.IsPlaying()) {
          DrawString(ir, GetString(STR_MUSIC_TRACK_DIGIT, _music.GetCurrentSong().tracknr, 2), TextColour::FromString, AlignmentH::Centre);
        } else {
          DrawString(ir, STR_MUSIC_TRACK_NONE, TextColour::FromString, AlignmentH::Centre);
        }
        break;
      }
 
      case WID_M_TRACK_NAME: {
        GfxFillRect(r.Shrink(WidgetDimensions::scaled.bevel), PC_BLACK);
        Rect ir = r.Shrink(WidgetDimensions::scaled.framerect);
 
        MusicSystem::PlaylistEntry entry(_music.GetCurrentSong());
        if (BaseMusic::GetUsedSet()->num_available == 0) {
          DrawString(ir, STR_MUSIC_TITLE_NOMUSIC, TextColour::FromString, AlignmentH::Centre);
        } else if (_music.IsPlaying()) {
          DrawString(ir, GetString(STR_MUSIC_TITLE_NAME, entry.songname), TextColour::FromString, AlignmentH::Centre);
        } else {
          DrawString(ir, STR_MUSIC_TITLE_NONE, TextColour::FromString, AlignmentH::Centre);
        }
 
        break;
      }
 
      case WID_M_MUSIC_VOL:
        DrawSliderWidget(r, Colours::Grey, Colours::Grey, TextColour::Black, 0, INT8_MAX, 0, _settings_client.music.music_vol, nullptr);
        break;
 
      case WID_M_EFFECT_VOL:
        DrawSliderWidget(r, Colours::Grey, Colours::Grey, TextColour::Black, 0, INT8_MAX, 0, _settings_client.music.effect_vol, nullptr);
        break;
    }
  }

  void OnInvalidateData([[maybe_unused]] int data = 0, [[maybe_unused]] bool gui_scope = true) override
  {
    if (!gui_scope) return;
    for (PlaylistChoice playlist : EnumRange(PlaylistChoice::ThemeOnly)) {
      this->SetWidgetLoweredState(WID_M_ALL + to_underlying(playlist), playlist == _settings_client.music.playlist);
    }
 
    UpdateDisabledButtons();
 
    if (data == 1) {
      this->ReInit();
    } else {
      this->SetDirty();
    }
  }
 
  void OnClick([[maybe_unused]] Point pt, WidgetID widget, [[maybe_unused]] int click_count) override
  {
    switch (widget) {
      case WID_M_PREV: // skip to prev
        _music.Prev();
        break;
 
      case WID_M_NEXT: // skip to next
        _music.Next();
        break;
 
      case WID_M_STOP: // stop playing
        _music.Stop();
        break;
 
      case WID_M_PLAY: // start playing
        _music.Play();
        break;
 
      case WID_M_MUSIC_VOL: case WID_M_EFFECT_VOL: { // volume sliders
        uint8_t &vol = (widget == WID_M_MUSIC_VOL) ? _settings_client.music.music_vol : _settings_client.music.effect_vol;
        if (ClickSliderWidget(this->GetWidget<NWidgetBase>(widget)->GetCurrentRect(), pt, 0, INT8_MAX, 0, vol)) {
          if (widget == WID_M_MUSIC_VOL) {
            MusicDriver::GetInstance()->SetVolume(vol);
          } else {
            SetEffectVolume(vol);
          }
          this->SetWidgetDirty(widget);
          SetWindowClassesDirty(WindowClass::GameOptions);
        }
 
        if (click_count > 0) this->mouse_capture_widget = widget;
        break;
      }
 
      case WID_M_SHUFFLE: // toggle shuffle
        if (_music.IsShuffle()) {
          _music.Unshuffle();
        } else {
          _music.Shuffle();
        }
        this->SetWidgetLoweredState(WID_M_SHUFFLE, _music.IsShuffle());
        this->SetWidgetDirty(WID_M_SHUFFLE);
        break;
 
      case WID_M_PROGRAMME: // show track selection
        ShowMusicTrackSelection();
        break;
 
      case WID_M_ALL: case WID_M_OLD: case WID_M_NEW:
      case WID_M_EZY: case WID_M_CUSTOM1: case WID_M_CUSTOM2: // playlist
        _music.ChangePlaylist(static_cast<PlaylistChoice>(widget - WID_M_ALL));
        break;
    }
  }
};
 
static constexpr std::initializer_list<NWidgetPart> _nested_music_window_widgets = {
  NWidget(NWID_HORIZONTAL),
    NWidget(WWT_CLOSEBOX, Colours::Grey),
    NWidget(WWT_CAPTION, Colours::Grey), SetStringTip(STR_MUSIC_JAZZ_JUKEBOX_CAPTION, STR_TOOLTIP_WINDOW_TITLE_DRAG_THIS),
    NWidget(WWT_SHADEBOX, Colours::Grey),
    NWidget(WWT_STICKYBOX, Colours::Grey),
  EndContainer(),
 
  NWidget(NWID_HORIZONTAL),
    NWidget(NWID_VERTICAL),
      NWidget(WWT_PANEL, Colours::Grey), SetFill(1, 1), EndContainer(),
      NWidget(NWID_HORIZONTAL),
        NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_M_PREV), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_SKIP_TO_PREV, STR_MUSIC_TOOLTIP_SKIP_TO_PREVIOUS_TRACK),
        NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_M_NEXT), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_SKIP_TO_NEXT, STR_MUSIC_TOOLTIP_SKIP_TO_NEXT_TRACK_IN_SELECTION),
        NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_M_STOP), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_STOP_MUSIC, STR_MUSIC_TOOLTIP_STOP_PLAYING_MUSIC),
        NWidget(WWT_PUSHIMGBTN, Colours::Grey, WID_M_PLAY), SetToolbarMinimalSize(1), SetSpriteTip(SPR_IMG_PLAY_MUSIC, STR_MUSIC_TOOLTIP_START_PLAYING_MUSIC),
      EndContainer(),
      NWidget(WWT_PANEL, Colours::Grey), SetFill(1, 1), EndContainer(),
    EndContainer(),
    NWidget(WWT_PANEL, Colours::Grey, WID_M_SLIDERS),
      NWidget(NWID_HORIZONTAL), SetPIP(WidgetDimensions::unscaled.hsep_wide, WidgetDimensions::unscaled.hsep_wide, WidgetDimensions::unscaled.hsep_wide),
        NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal), SetPIPRatio(1, 0, 1),
          NWidget(WWT_LABEL, Colours::Invalid), SetFill(1, 0), SetStringTip(STR_MUSIC_MUSIC_VOLUME),
          NWidget(WWT_EMPTY, Colours::Invalid, WID_M_MUSIC_VOL), SetMinimalSize(67, 0), SetMinimalTextLines(1, 0), SetFill(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
        EndContainer(),
        NWidget(NWID_VERTICAL), SetPIP(0, WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal), SetPIPRatio(1, 0, 1),
          NWidget(WWT_LABEL, Colours::Invalid), SetFill(1, 0), SetStringTip(STR_MUSIC_EFFECTS_VOLUME),
          NWidget(WWT_EMPTY, Colours::Invalid, WID_M_EFFECT_VOL), SetMinimalSize(67, 0), SetMinimalTextLines(1, 0), SetFill(1, 0), SetToolTip(STR_MUSIC_TOOLTIP_DRAG_SLIDERS_TO_SET_MUSIC),
        EndContainer(),
      EndContainer(),
    EndContainer(),
  EndContainer(),
  NWidget(WWT_PANEL, Colours::Grey, WID_M_BACKGROUND),
    NWidget(NWID_HORIZONTAL),
      NWidget(NWID_VERTICAL), SetPIPRatio(1, 0, 1), SetPadding(WidgetDimensions::unscaled.frametext),
        NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_SHUFFLE), SetMinimalSize(50, 0), SetStringTip(STR_MUSIC_SHUFFLE, STR_MUSIC_TOOLTIP_TOGGLE_PROGRAM_SHUFFLE),
      EndContainer(),
      NWidget(NWID_VERTICAL), SetPIP(WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal), SetPIPRatio(1, 0, 1),
        NWidget(WWT_LABEL, Colours::Invalid, WID_M_TRACK), SetFill(0, 0), SetStringTip(STR_MUSIC_TRACK),
        NWidget(WWT_INSET, Colours::Grey, WID_M_TRACK_NR), SetFill(0, 0), EndContainer(),
      EndContainer(),
      NWidget(NWID_VERTICAL), SetPIP(WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal, WidgetDimensions::unscaled.vsep_normal), SetPIPRatio(1, 0, 1),
        NWidget(WWT_LABEL, Colours::Invalid, WID_M_TRACK_TITLE), SetFill(1, 0), SetStringTip(STR_MUSIC_XTITLE),
        NWidget(WWT_INSET, Colours::Grey, WID_M_TRACK_NAME), SetFill(1, 0), EndContainer(),
      EndContainer(),
      NWidget(NWID_VERTICAL), SetPIPRatio(1, 0, 1), SetPadding(WidgetDimensions::unscaled.frametext),
        NWidget(WWT_PUSHTXTBTN, Colours::Grey, WID_M_PROGRAMME), SetMinimalSize(50, 0), SetStringTip(STR_MUSIC_PROGRAM, STR_MUSIC_TOOLTIP_SHOW_MUSIC_TRACK_SELECTION),
      EndContainer(),
    EndContainer(),
  EndContainer(),
  NWidget(NWID_HORIZONTAL, NWidContainerFlag::EqualSize),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_ALL), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_ALL, STR_MUSIC_TOOLTIP_SELECT_ALL_TRACKS_PROGRAM),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_OLD), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_OLD_STYLE, STR_MUSIC_TOOLTIP_SELECT_OLD_STYLE_MUSIC),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_NEW), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_NEW_STYLE, STR_MUSIC_TOOLTIP_SELECT_NEW_STYLE_MUSIC),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_EZY), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_EZY_STREET, STR_MUSIC_TOOLTIP_SELECT_EZY_STREET_STYLE),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_CUSTOM1), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_CUSTOM_1, STR_MUSIC_TOOLTIP_SELECT_CUSTOM_1_USER_DEFINED),
    NWidget(WWT_TEXTBTN, Colours::Grey, WID_M_CUSTOM2), SetFill(1, 0), SetStringTip(STR_MUSIC_PLAYLIST_CUSTOM_2, STR_MUSIC_TOOLTIP_SELECT_CUSTOM_2_USER_DEFINED),
  EndContainer(),
};

static WindowDesc _music_window_desc(
  WindowPosition::Automatic, "music", 0, 0,
  WindowClass::Music, WindowClass::None,
  {},
  _nested_music_window_widgets
);
 
void ShowMusicWindow()
{
  AllocateWindowDescFront<MusicWindow>(_music_window_desc, 0);
}