1

/* $Id$ */

     2

     3

/**

     4

 * @file qtmidi.cpp

     5

 * @brief MIDI music player for MacOS X using QuickTime.

     6

 *

     7

 * This music player should work in all MacOS X releases starting from 10.0,

     8

 * as QuickTime is an integral part of the system since the old days of the

     9

 * Motorola 68k-based Macintoshes. The only extra dependency apart from

    10

 * QuickTime itself is Carbon, which is included since 10.0 as well.

    11

 *

    12

 * QuickTime gets fooled with the MIDI files from Transport Tycoon Deluxe

    13

 * because of the @c .gm suffix. To force QuickTime to load the MIDI files

    14

 * without the need of dealing with the individual QuickTime components

    15

 * needed to play music (data source, MIDI parser, note allocators,

    16

 * synthesizers and the like) some Carbon functions are used to set the file

    17

 * type as seen by QuickTime, using @c FSpSetFInfo() (which modifies the

    18

 * file's resource fork).

    19

 */

    20

    21

    22

/*

    23

 * OpenTTD includes.

    24

 */

    25

#define  WindowClass OSX_WindowClass

    26

#include <QuickTime/QuickTime.h>

    27

#undef   WindowClass

    28

    29

#include "../stdafx.h"

    30

#include "qtmidi.h"

    31

    32

/*

    33

 * System includes. We need to workaround with some defines because there's

    34

 * stuff already defined in QuickTime headers.

    35

 */

    36

#define  OTTD_Random OSX_OTTD_Random

    37

#undef   OTTD_Random

    38

#undef   WindowClass

    39

#undef   SL_ERROR

    40

#undef   bool

    41

    42

#include <assert.h>

    43

#include <unistd.h>

    44

#include <fcntl.h>

    45

    46

// we need to include debug.h after CoreServices because defining DEBUG will break CoreServices in OSX 10.2

    47

#include "../debug.h"

    48

    49

static FMusicDriver_QtMidi iFMusicDriver_QtMidi;

    50

    51

    52

enum {

    53

	midiType = 'Midi' /**< OSType code for MIDI songs. */

    54

};

    55

    56

    57

/**

    58

 * Sets the @c OSType of a given file to @c 'Midi', but only if it's not

    59

 * already set.

    60

 *

    61

 * @param *spec A @c FSSpec structure referencing a file.

    62

 */

    64

{

    65

	FSCatalogInfo catalogInfo;

    66

    68

    70

	if (!(catalogInfo.nodeFlags & kFSNodeIsDirectoryMask)) {

    71

		FileInfo * const info = (FileInfo *) catalogInfo.finderInfo;

    72

		if (info->fileType != midiType && !(info->finderFlags & kIsAlias)) {

    73

			OSErr e;

    74

			info->fileType = midiType;

    76

			if (e == noErr) {

    77

				DEBUG(driver, 3, "qtmidi: changed filetype to 'Midi'");

    78

			} else {

    79

				DEBUG(driver, 0, "qtmidi: changing filetype to 'Midi' failed - error %d", e);

    80

			}

    81

		}

    82

	}

    83

}

    84

    85

    86

/**

    87

 * Loads a MIDI file and returns it as a QuickTime Movie structure.

    88

 *

    89

 * @param *path String with the path of an existing MIDI file.

    90

 * @param *moov Pointer to a @c Movie where the result will be stored.

    91

 * @return Wether the file was loaded and the @c Movie successfully created.

    92

 */

    93

static bool LoadMovieForMIDIFile(const char *path, Movie *moov)

    94

{

    95

	int fd;

    96

	int ret;

    97

	char magic[4];

    99

	FSSpec fsspec;

   100

	short refnum = 0;

   101

	short resid  = 0;

   102

   103

	assert(path != NULL);

   104

	assert(moov != NULL);

   105

   106

	DEBUG(driver, 2, "qtmidi: start loading '%s'...", path);

   107

   108

	/*

   109

	 * XXX Manual check for MIDI header ('MThd'), as I don't know how to make

   110

	 * QuickTime load MIDI files without a .mid suffix without knowing it's

   111

	 * a MIDI file and setting the OSType of the file to the 'Midi' value.

   112

	 * Perhahaps ugly, but it seems that it does the Right Thing(tm).

   113

	 */

   114

	fd = open(path, O_RDONLY, 0);

   115

	if (fd == -1) return false;

   116

	ret = read(fd, magic, 4);

   117

	close(fd);

   118

	if (ret < 4) return false;

   119

   120

	DEBUG(driver, 3, "qtmidi: header is '%.4s'", magic);

   121

	if (magic[0] != 'M' || magic[1] != 'T' || magic[2] != 'h' || magic[3] != 'd')

   122

		return false;

   123

   126

   128

	if (OpenMovieFile(&fsspec, &refnum, fsRdPerm) != noErr) return false;

   129

	DEBUG(driver, 3, "qtmidi: '%s' successfully opened", path);

   130

   131

	if (noErr != NewMovieFromFile(moov, refnum, &resid, NULL,

   132

				newMovieActive | newMovieDontAskUnresolvedDataRefs, NULL)) {

   133

		CloseMovieFile(refnum);

   134

		return false;

   135

	}

   136

	DEBUG(driver, 3, "qtmidi: movie container created");

   137

   138

	CloseMovieFile(refnum);

   139

	return true;

   140

}

   141

   142

   143

/**

   144

 * Flag which has the @c true value when QuickTime is available and

   145

 * initialized.

   146

 */

   147

static bool _quicktime_started = false;

   148

   149

   150

/**

   151

 * Initialize QuickTime if needed. This function sets the

   152

 * #_quicktime_started flag to @c true if QuickTime is present in the system

   153

 * and it was initialized properly.

   154

 */

   155

static void InitQuickTimeIfNeeded()

   156

{

   157

	OSStatus dummy;

   158

   159

	if (_quicktime_started) return;

   160

   161

	DEBUG(driver, 2, "qtmidi: initializing Quicktime");

   162

	/* Be polite: check wether QuickTime is available and initialize it. */

   163

	_quicktime_started =

   164

		(noErr == Gestalt(gestaltQuickTime, &dummy)) &&

   165

		(noErr == EnterMovies());

   166

	if (!_quicktime_started) DEBUG(driver, 0, "qtmidi: Quicktime initialization failed!");

   167

}

   168

   169

   170

/** Possible states of the QuickTime music driver. */

   171

enum {

   172

	QT_STATE_IDLE, /**< No file loaded. */

   173

	QT_STATE_PLAY, /**< File loaded, playing. */

   174

	QT_STATE_STOP, /**< File loaded, stopped. */

   175

};

   176

   177

   178

static Movie _quicktime_movie;                  /**< Current QuickTime @c Movie. */

   179

static byte  _quicktime_volume = 127;           /**< Current volume. */

   180

static int   _quicktime_state  = QT_STATE_IDLE; /**< Current player state. */

   181

   182

   183

/**

   184

 * Maps OpenTTD volume to QuickTime notion of volume.

   185

 */

   186

#define VOLUME  ((short)((0x00FF & _quicktime_volume) << 1))

   187

   188

   189

/**

   190

 * Initialized the MIDI player, including QuickTime initialization.

   191

 *

   192

 * @todo Give better error messages by inspecting error codes returned by

   193

 * @c Gestalt() and @c EnterMovies(). Needs changes in

   194

 * #InitQuickTimeIfNeeded.

   195

 */

   196

const char *MusicDriver_QtMidi::Start(const char * const *parm)

   197

{

   198

	InitQuickTimeIfNeeded();

   199

	return (_quicktime_started) ? NULL : "can't initialize QuickTime";

   200

}

   201

   202

   203

/**

   204

 * Checks wether the player is active.

   205

 *

   206

 * This function is called at regular intervals from OpenTTD's main loop, so

   207

 * we call @c MoviesTask() from here to let QuickTime do its work.

   208

 */

   209

bool MusicDriver_QtMidi::IsSongPlaying()

   210

{

   211

	if (!_quicktime_started) return true;

   212

   213

	switch (_quicktime_state) {

   214

		case QT_STATE_IDLE:

   215

		case QT_STATE_STOP:

   216

			/* Do nothing. */

   217

			break;

   218

		case QT_STATE_PLAY:

   219

			MoviesTask(_quicktime_movie, 0);

   220

			/* Check wether movie ended. */

   221

			if (IsMovieDone(_quicktime_movie) ||

   222

					(GetMovieTime(_quicktime_movie, NULL) >=

   223

					 GetMovieDuration(_quicktime_movie)))

   224

				_quicktime_state = QT_STATE_STOP;

   225

	}

   226

   227

	return _quicktime_state == QT_STATE_PLAY;

   228

}

   229

   230

   231

/**

   232

 * Stops the MIDI player.

   233

 *

   234

 * Stops playing and frees any used resources before returning. As it

   235

 * deinitilizes QuickTime, the #_quicktime_started flag is set to @c false.

   236

 */

   237

void MusicDriver_QtMidi::Stop()

   238

{

   239

	if (!_quicktime_started) return;

   240

   241

	DEBUG(driver, 2, "qtmidi: stopping driver...");

   242

	switch (_quicktime_state) {

   243

		case QT_STATE_IDLE:

   244

			DEBUG(driver, 3, "qtmidi: stopping not needed, already idle");

   245

			/* Do nothing. */

   246

			break;

   247

		case QT_STATE_PLAY:

   248

			StopSong();

   249

		case QT_STATE_STOP:

   250

			DisposeMovie(_quicktime_movie);

   251

	}

   252

   253

	ExitMovies();

   254

	_quicktime_started = false;

   255

}

   256

   257

   258

/**

   259

 * Starts playing a new song.

   260

 *

   261

 * @param filename Path to a MIDI file.

   262

 */

   263

void MusicDriver_QtMidi::PlaySong(const char *filename)

   264

{

   265

	if (!_quicktime_started) return;

   266

   267

	DEBUG(driver, 2, "qtmidi: trying to play '%s'", filename);

   268

	switch (_quicktime_state) {

   269

		case QT_STATE_PLAY:

   270

			StopSong();

   271

			DEBUG(driver, 3, "qtmidi: previous tune stopped");

   272

			/* XXX Fall-through -- no break needed. */

   273

		case QT_STATE_STOP:

   274

			DisposeMovie(_quicktime_movie);

   275

			DEBUG(driver, 3, "qtmidi: previous tune disposed");

   276

			_quicktime_state = QT_STATE_IDLE;

   277

			/* XXX Fall-through -- no break needed. */

   278

		case QT_STATE_IDLE:

   279

			LoadMovieForMIDIFile(filename, &_quicktime_movie);

   280

			SetMovieVolume(_quicktime_movie, VOLUME);

   281

			StartMovie(_quicktime_movie);

   282

			_quicktime_state = QT_STATE_PLAY;

   283

	}

   284

	DEBUG(driver, 3, "qtmidi: playing '%s'", filename);

   285

}

   286

   287

   288

/**

   289

 * Stops playing the current song, if the player is active.

   290

 */

   291

void MusicDriver_QtMidi::StopSong()

   292

{

   293

	if (!_quicktime_started) return;

   294

   295

	switch (_quicktime_state) {

   296

		case QT_STATE_IDLE:

   297

			/* XXX Fall-through -- no break needed. */

   298

		case QT_STATE_STOP:

   299

			DEBUG(driver, 3, "qtmidi: stop requested, but already idle");

   300

			/* Do nothing. */

   301

			break;

   302

		case QT_STATE_PLAY:

   303

			StopMovie(_quicktime_movie);

   304

			_quicktime_state = QT_STATE_STOP;

   305

			DEBUG(driver, 3, "qtmidi: player stopped");

   306

	}

   307

}

   308

   309

   310

/**

   311

 * Changes the playing volume of the MIDI player.

   312

 *

   313

 * As QuickTime controls volume in a per-movie basis, the desired volume is

   314

 * stored in #_quicktime_volume, and the volume is set here using the

   315

 * #VOLUME macro, @b and when loading new song in #PlaySong.

   316

 *

   317

 * @param vol The desired volume, range of the value is @c 0-127

   318

 */

   319

void MusicDriver_QtMidi::SetVolume(byte vol)

   320

{

   321

	if (!_quicktime_started) return;

   322

   323

	_quicktime_volume = vol;

   324

   325

	DEBUG(driver, 2, "qtmidi: set volume to %u (%hi)", vol, VOLUME);

   326

	switch (_quicktime_state) {

   327

		case QT_STATE_IDLE:

   328

			/* Do nothing. */

   329

			break;

   330

		case QT_STATE_PLAY:

   331

		case QT_STATE_STOP:

   332

			SetMovieVolume(_quicktime_movie, VOLUME);

   333

	}

   334

}

   335