1

/* $Id$ */

     2

     3

/** @file music_gui.cpp GUI for the music playback. */

     4

     5

#include "stdafx.h"

     6

#include "openttd.h"

     7

#include "fileio.h"

     8

#include "variables.h"

     9

#include "music.h"

    10

#include "music/music_driver.hpp"

    11

#include "window_gui.h"

    12

#include "strings_func.h"

    13

#include "window_func.h"

    14

#include "sound_func.h"

    15

#include "gfx_func.h"

    16

#include "core/math_func.hpp"

    17

#include "core/random_func.hpp"

    18

    19

#include "table/strings.h"

    20

#include "table/sprites.h"

    21

    22

static byte _music_wnd_cursong;

    23

static bool _song_is_active;

    24

static byte _cur_playlist[NUM_SONGS_PLAYLIST];

    25

    26

    27

    28

static byte _playlist_all[] = {

    29

	1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 0

    30

};

    31

    32

static byte _playlist_old_style[] = {

    33

	1, 8, 2, 9, 14, 15, 19, 13, 0

    34

};

    35

    36

static byte _playlist_new_style[] = {

    37

	6, 11, 10, 17, 21, 18, 5, 0

    38

};

    39

    40

static byte _playlist_ezy_street[] = {

    41

	12, 7, 16, 3, 20, 4, 0

    42

};

    43

    44

static byte * const _playlists[] = {

    45

	_playlist_all,

    46

	_playlist_old_style,

    47

	_playlist_new_style,

    48

	_playlist_ezy_street,

    49

	msf.custom_1,

    50

	msf.custom_2,

    51

};

    52

    53

static void SkipToPrevSong()

    54

{

    55

	byte *b = _cur_playlist;

    56

	byte *p = b;

    57

	byte t;

    58

    59

	if (b[0] == 0) return; // empty playlist

    60

    61

	do p++; while (p[0] != 0); // find the end

    62

    63

	t = *--p; // and copy the bytes

    64

	while (p != b) {

    65

		p--;

    66

		p[1] = p[0];

    67

	}

    68

	*b = t;

    69

    70

	_song_is_active = false;

    71

}

    72

    73

static void SkipToNextSong()

    74

{

    75

	byte* b = _cur_playlist;

    76

	byte t;

    77

    78

	t = b[0];

    79

	if (t != 0) {

    80

		while (b[1] != 0) {

    81

			b[0] = b[1];

    82

			b++;

    83

		}

    84

		b[0] = t;

    85

	}

    86

    87

	_song_is_active = false;

    88

}

    89

    90

static void MusicVolumeChanged(byte new_vol)

    91

{

    92

	_music_driver->SetVolume(new_vol);

    93

}

    94

    95

static void DoPlaySong()

    96

{

    97

	char filename[MAX_PATH];

    98

	FioFindFullPath(filename, lengthof(filename), GM_DIR,

    99

			origin_songs_specs[_music_wnd_cursong - 1].filename);

   100

	_music_driver->PlaySong(filename);

   101

}

   102

   103

static void DoStopMusic()

   104

{

   105

	_music_driver->StopSong();

   106

}

   107

   108

static void SelectSongToPlay()

   109

{

   110

	uint i = 0;

   111

	uint j = 0;

   112

   113

	memset(_cur_playlist, 0, sizeof(_cur_playlist));

   114

	do {

   115

		/* We are now checking for the existence of that file prior

   116

		 * to add it to the list of available songs */

   117

		if (FioCheckFileExists(origin_songs_specs[_playlists[msf.playlist][i]].filename, GM_DIR)) {

   118

			_cur_playlist[j] = _playlists[msf.playlist][i];

   119

			j++;

   120

		}

   121

	} while (_playlists[msf.playlist][i++] != 0 && i < lengthof(_cur_playlist) - 1);

   122

   123

	/* Do not shuffle when on the intro-start window, as the song to play has to be the original TTD Theme*/

   124

	if (msf.shuffle && _game_mode != GM_MENU) {

   125

		i = 500;

   126

		do {

   127

			uint32 r = InteractiveRandom();

   128

			byte *a = &_cur_playlist[GB(r, 0, 5)];

   129

			byte *b = &_cur_playlist[GB(r, 8, 5)];

   130

   131

			if (*a != 0 && *b != 0) {

   132

				byte t = *a;

   133

				*a = *b;

   134

				*b = t;

   135

			}

   136

		} while (--i);

   137

	}

   138

}

   139

   140

static void StopMusic()

   141

{

   142

	_music_wnd_cursong = 0;

   143

	DoStopMusic();

   144

	_song_is_active = false;

   145

	InvalidateWindowWidget(WC_MUSIC_WINDOW, 0, 9);

   146

}

   147

   148

static void PlayPlaylistSong()

   149

{

   150

	if (_cur_playlist[0] == 0) {

   151

		SelectSongToPlay();

   152

		/* if there is not songs in the playlist, it may indicate

   153

		 * no file on the gm folder, or even no gm folder.

   154

		 * Stop the playback, then */

   155

		if (_cur_playlist[0] == 0) {

   156

			_song_is_active = false;

   157

			_music_wnd_cursong = 0;

   158

			msf.playing = false;

   159

			return;

   160

		}

   161

	}

   162

	_music_wnd_cursong = _cur_playlist[0];

   163

	DoPlaySong();

   164

	_song_is_active = true;

   165

   166

	InvalidateWindowWidget(WC_MUSIC_WINDOW, 0, 9);

   167

}

   168

   169

void ResetMusic()

   170

{

   171

	_music_wnd_cursong = 1;

   172

	DoPlaySong();

   173

}

   174

   175

void MusicLoop()

   176

{

   177

	if (!msf.playing && _song_is_active) {

   178

		StopMusic();

   179

	} else if (msf.playing && !_song_is_active) {

   180

		PlayPlaylistSong();

   181

	}

   182

   183

	if (!_song_is_active) return;

   184

   185

	if (!_music_driver->IsSongPlaying()) {

   186

		if (_game_mode != GM_MENU) {

   187

			StopMusic();

   188

			SkipToNextSong();

   189

			PlayPlaylistSong();

   190

		} else {

   191

			ResetMusic();

   192

		}

   193

	}

   194

}

   195

   196

struct MusicTrackSelectionWindow : public Window {

   197

private:

   198

	enum MusicTrackSelectionWidgets {

   199

		MTSW_CLOSE,

   200

		MTSW_CAPTION,

   201

		MTSW_BACKGROUND,

   202

		MTSW_LIST_LEFT,

   203

		MTSW_LIST_RIGHT,

   204

		MTSW_ALL,

   205

		MTSW_OLD,

   206

		MTSW_NEW,

   207

		MTSW_EZY,

   208

		MTSW_CUSTOM1,

   209

		MTSW_CUSTOM2,

   210

		MTSW_CLEAR,

   211

		MTSW_SAVE,

   212

	};

   213

   214

public:

   215

	MusicTrackSelectionWindow(const WindowDesc *desc, WindowNumber number) : Window(desc, number)

   216

	{

   217

		this->FindWindowPlacementAndResize(desc);

   218

	}

   219

   220

	virtual void OnPaint()

   221

	{

   222

		const byte* p;

   223

		uint i;

   224

		int y;

   225

   226

		this->SetWidgetDisabledState(MTSW_CLEAR, msf.playlist <= 3);

   227

		this->LowerWidget(MTSW_LIST_LEFT);

   228

		this->LowerWidget(MTSW_LIST_RIGHT);

   229

		this->DrawWidgets();

   230

   231

		GfxFillRect(3, 23, 3 + 177, 23 + 191, 0);

   232

		GfxFillRect(251, 23, 251 + 177, 23 + 191, 0);

   233

   234

		DrawStringCentered(92, 15, STR_01EE_TRACK_INDEX, TC_FROMSTRING);

   235

   236

		SetDParam(0, STR_01D5_ALL + msf.playlist);

   237

		DrawStringCentered(340, 15, STR_01EF_PROGRAM, TC_FROMSTRING);

   238

   239

		for (i = 1; i <= NUM_SONGS_AVAILABLE; i++) {

   240

			SetDParam(0, i);

   241

			SetDParam(2, i);

   242

			SetDParam(1, SPECSTR_SONGNAME);

   243

			DrawString(4, 23 + (i - 1) * 6, (i < 10) ? STR_01EC_0 : STR_01ED, TC_FROMSTRING);

   244

		}

   245

   246

		for (i = 0; i != 6; i++) {

   247

			DrawStringCentered(216, 45 + i * 8, STR_01D5_ALL + i, (i == msf.playlist) ? TC_WHITE : TC_BLACK);

   248

		}

   249

   250

		DrawStringCentered(216, 45 + 8 * 6 + 16, STR_01F0_CLEAR, TC_FROMSTRING);

   251

#if 0

   252

		DrawStringCentered(216, 45 + 8 * 6 + 16 * 2, STR_01F1_SAVE, TC_FROMSTRING);

   253

#endif

   254

   255

		y = 23;

   256

		for (p = _playlists[msf.playlist], i = 0; (i = *p) != 0; p++) {

   257

			SetDParam(0, i);

   258

			SetDParam(1, SPECSTR_SONGNAME);

   259

			SetDParam(2, i);

   260

			DrawString(252, y, (i < 10) ? STR_01EC_0 : STR_01ED, TC_FROMSTRING);

   261

			y += 6;

   262

		}

   263

	}

   264

   265

	virtual void OnClick(Point pt, int widget)

   266

	{

   267

		switch (widget) {

   268

			case MTSW_LIST_LEFT: { // add to playlist

   269

				int y = (pt.y - 23) / 6;

   270

				uint i;

   271

				byte *p;

   272

   273

				if (msf.playlist < 4) return;

   274

				if (!IsInsideMM(y, 0, NUM_SONGS_AVAILABLE)) return;

   275

   276

				p = _playlists[msf.playlist];

   277

				for (i = 0; i != NUM_SONGS_PLAYLIST - 1; i++) {

   278

					if (p[i] == 0) {

   279

						p[i] = y + 1;

   280

						p[i + 1] = 0;

   281

						this->SetDirty();

   282

						SelectSongToPlay();

   283

						break;

   284

					}

   285

				}

   286

			} break;

   287

   288

			case MTSW_LIST_RIGHT: { // remove from playlist

   289

				int y = (pt.y - 23) / 6;

   290

				uint i;

   291

				byte *p;

   292

   293

				if (msf.playlist < 4) return;

   294

				if (!IsInsideMM(y, 0, NUM_SONGS_AVAILABLE)) return;

   295

   296

				p = _playlists[msf.playlist];

   297

				for (i = y; i != NUM_SONGS_PLAYLIST - 1; i++) {

   298

					p[i] = p[i + 1];

   299

				}

   300

   301

				this->SetDirty();

   302

				SelectSongToPlay();

   303

			} break;

   304

   305

			case MTSW_CLEAR: // clear

   306

				_playlists[msf.playlist][0] = 0;

   307

				this->SetDirty();

   308

				StopMusic();

   309

				SelectSongToPlay();

   310

				break;

   311

   312

#if 0

   313

			case MTSW_SAVE: // save

   314

				ShowInfo("MusicTrackSelectionWndProc:save not implemented");

   315

				break;

   316

#endif

   317

   318

			case MTSW_ALL: case MTSW_OLD: case MTSW_NEW:

   319

			case MTSW_EZY: case MTSW_CUSTOM1: case MTSW_CUSTOM2: // set playlist

   320

				msf.playlist = widget - MTSW_ALL;

   321

				this->SetDirty();

   322

				InvalidateWindow(WC_MUSIC_WINDOW, 0);

   323

				StopMusic();

   324

				SelectSongToPlay();

   325

				break;

   326

		}

   327

	}

   328

};

   329

   330

static const Widget _music_track_selection_widgets[] = {

   331

{   WWT_CLOSEBOX,   RESIZE_NONE,    14,     0,    10,     0,    13, STR_00C5,                         STR_018B_CLOSE_WINDOW},                  // MTSW_CLOSE

   332

{    WWT_CAPTION,   RESIZE_NONE,    14,    11,   431,     0,    13, STR_01EB_MUSIC_PROGRAM_SELECTION, STR_018C_WINDOW_TITLE_DRAG_THIS},        // MTSW_CAPTION

   333

{      WWT_PANEL,   RESIZE_NONE,    14,     0,   431,    14,   217, 0x0,                              STR_NULL},                               // MTSW_BACKGROUND

   334

{      WWT_PANEL,   RESIZE_NONE,    14,     2,   181,    22,   215, 0x0,                              STR_01FA_CLICK_ON_MUSIC_TRACK_TO},       // MTSW_LIST_LEFT

   335

{      WWT_PANEL,   RESIZE_NONE,    14,   250,   429,    22,   215, 0x0,                              STR_CLICK_ON_TRACK_TO_REMOVE},           // MTSW_LIST_RIGHT

   336

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    44,    51, 0x0,                              STR_01F3_SELECT_ALL_TRACKS_PROGRAM},     // MTSW_ALL

   337

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    52,    59, 0x0,                              STR_01F4_SELECT_OLD_STYLE_MUSIC},        // MTSW_OLD

   338

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    60,    67, 0x0,                              STR_01F5_SELECT_NEW_STYLE_MUSIC},        // MTSW_NEW

   339

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    68,    75, 0x0,                              STR_0330_SELECT_EZY_STREET_STYLE},       // MTSW_EZY

   340

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    76,    83, 0x0,                              STR_01F6_SELECT_CUSTOM_1_USER_DEFINED},  // MTSW_CUSTOM1

   341

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,    84,    91, 0x0,                              STR_01F7_SELECT_CUSTOM_2_USER_DEFINED},  // MTSW_CUSTOM2

   342

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,   108,   115, 0x0,                              STR_01F8_CLEAR_CURRENT_PROGRAM_CUSTOM1}, // MTSW_CLEAR

   343

#if 0

   344

{    WWT_PUSHBTN,   RESIZE_NONE,    14,   186,   245,   124,   131, 0x0,                              STR_01F9_SAVE_MUSIC_SETTINGS},           // MTSW_SAVE

   345

#endif

   346

{   WIDGETS_END},

   347

};

   348

   349

static const WindowDesc _music_track_selection_desc = {

   350

	104, 131, 432, 218, 432, 218,

   351

	WC_MUSIC_TRACK_SELECTION, WC_NONE,

   352

	WDF_STD_TOOLTIPS | WDF_STD_BTN | WDF_DEF_WIDGET | WDF_UNCLICK_BUTTONS,

   353

	_music_track_selection_widgets,

   354

};

   355

   356

static void ShowMusicTrackSelection()

   357

{

   358

	AllocateWindowDescFront<MusicTrackSelectionWindow>(&_music_track_selection_desc, 0);

   359

}

   360

   361

struct MusicWindow : public Window {

   362

private:

   363

	enum MusicWidgets {

   364

		MW_CLOSE,

   365

		MW_CAPTION,

   366

		MW_PREV,

   367

		MW_NEXT,

   368

		MW_STOP,

   369

		MW_PLAY,

   370

		MW_SLIDERS,

   371

		MW_GAUGE,

   372

		MW_BACKGROUND,

   373

		MW_INFO,

   374

		MW_SHUFFLE,

   375

		MW_PROGRAMME,

   376

		MW_ALL,

   377

		MW_OLD,

   378

		MW_NEW,

   379

		MW_EZY,

   380

		MW_CUSTOM1,

   381

		MW_CUSTOM2,

   382

	};

   383

   384

public:

   385

	MusicWindow(const WindowDesc *desc, WindowNumber number) : Window(desc, number)

   386

	{

   387

		this->FindWindowPlacementAndResize(desc);

   388

	}

   389

   390

	virtual void OnPaint()

   391

	{

   392

		uint i;

   393

		StringID str;

   394

   395

		this->RaiseWidget(MW_GAUGE);

   396

		this->RaiseWidget(MW_INFO);

   397

		this->DrawWidgets();

   398

   399

		GfxFillRect(187, 16, 200, 33, 0);

   400

   401

		for (i = 0; i != 8; i++) {

   402

			int color = 0xD0;

   403

			if (i > 4) {

   404

				color = 0xBF;

   405

				if (i > 6) {

   406

					color = 0xB8;

   407

				}

   408

			}

   409

			GfxFillRect(187, NUM_SONGS_PLAYLIST - i * 2, 200, NUM_SONGS_PLAYLIST - i * 2, color);

   410

		}

   411

   412

		GfxFillRect(60, 46, 239, 52, 0);

   413

   414

		if (_song_is_active == 0 || _music_wnd_cursong == 0) {

   415

			str = STR_01E3;

   416

		} else {

   417

			SetDParam(0, _music_wnd_cursong);

   418

			str = (_music_wnd_cursong < 10) ? STR_01E4_0 : STR_01E5;

   419

		}

   420

		DrawString(62, 46, str, TC_FROMSTRING);

   421

   422

		str = STR_01E6;

   423

		if (_song_is_active != 0 && _music_wnd_cursong != 0) {

   424

			str = STR_01E7;

   425

			SetDParam(0, SPECSTR_SONGNAME);

   426

			SetDParam(1, _music_wnd_cursong);

   427

		}

   428

		DrawStringCentered(155, 46, str, TC_FROMSTRING);

   429

   430

   431

		DrawString(60, 38, STR_01E8_TRACK_XTITLE, TC_FROMSTRING);

   432

   433

		for (i = 0; i != 6; i++) {

   434

			DrawStringCentered(25 + i * 50, 59, STR_01D5_ALL + i, msf.playlist == i ? TC_WHITE : TC_BLACK);

   435

		}

   436

   437

		DrawStringCentered(31, 43, STR_01E9_SHUFFLE, (msf.shuffle ? TC_WHITE : TC_BLACK));

   438

		DrawStringCentered(269, 43, STR_01EA_PROGRAM, TC_FROMSTRING);

   439

		DrawStringCentered(141, 15, STR_01DB_MUSIC_VOLUME, TC_FROMSTRING);

   440

		DrawStringCentered(141, 29, STR_01DD_MIN_MAX, TC_FROMSTRING);

   441

		DrawStringCentered(247, 15, STR_01DC_EFFECTS_VOLUME, TC_FROMSTRING);

   442

		DrawStringCentered(247, 29, STR_01DD_MIN_MAX, TC_FROMSTRING);

   443

   444

		DrawFrameRect(108, 23, 174, 26, 14, FR_LOWERED);

   445

		DrawFrameRect(214, 23, 280, 26, 14, FR_LOWERED);

   446

   447

		DrawFrameRect(

   448

			108 + msf.music_vol / 2, 22, 111 + msf.music_vol / 2, 28, 14, FR_NONE

   449

		);

   450

   451

		DrawFrameRect(

   452

			214 + msf.effect_vol / 2, 22, 217 + msf.effect_vol / 2, 28, 14, FR_NONE

   453

		);

   454

	}

   455

   456

	virtual void OnClick(Point pt, int widget)

   457

	{

   458

		switch (widget) {

   459

			case MW_PREV: // skip to prev

   460

				if (!_song_is_active) return;

   461

				SkipToPrevSong();

   462

				break;

   463

   464

			case MW_NEXT: // skip to next

   465

				if (!_song_is_active) return;

   466

				SkipToNextSong();

   467

				break;

   468

   469

			case MW_STOP: // stop playing

   470

				msf.playing = false;

   471

				break;

   472

   473

			case MW_PLAY: // start playing

   474

				msf.playing = true;

   475

				break;

   476

   477

			case MW_SLIDERS: { // volume sliders

   478

				byte *vol, new_vol;

   479

				int x = pt.x - 88;

   480

   481

				if (x < 0) return;

   482

   483

				vol = &msf.music_vol;

   484

				if (x >= 106) {

   485

					vol = &msf.effect_vol;

   486

					x -= 106;

   487

				}

   488

   489

				new_vol = min(max(x - 21, 0) * 2, 127);

   490

				if (new_vol != *vol) {

   491

					*vol = new_vol;

   492

					if (vol == &msf.music_vol) MusicVolumeChanged(new_vol);

   493

					this->SetDirty();

   494

				}

   495