1

/*

     2

 * qtmidi.c - MIDI Player for OpenTTD using QuickTime (MacOS X).

     3

 */

     4

     5

/**

     6

 * @file qtmidi.c

     7

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

     8

 *

     9

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

    10

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

    11

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

    12

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

    13

 *

    14

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

    15

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

    16

 * without the need of dealing with the individual QuickTime components

    17

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

    18

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

    19

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

    20

 * file's resource fork).

    21

 */

    22

    23

    24

/*

    25

 * OpenTTD includes.

    26

 */

    27

#include "../stdafx.h"

    28

#include "../openttd.h"

    29

#include "../debug.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  bool        OSX_bool

    37

#define  Rect        OSX_Rect

    38

#define  Point       OSX_Point

    39

#define  SL_ERROR    OSX_SL_ERROR

    40

#define  WindowClass OSX_WindowClass

    41

#define  OTTD_Random OSX_OTTD_Random

    42

#include <CoreServices/CoreServices.h>

    43

#include <QuickTime/QuickTime.h>

    44

#undef   OTTD_Random

    45

#undef   WindowClass

    46

#undef   SL_ERROR

    47

#undef   Point

    48

#undef   Rect

    49

#undef   bool

    50

    51

#include <assert.h>

    52

#include <unistd.h>

    53

#include <fcntl.h>

    54

    55

    56

    57

enum {

    58

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

    59

};

    60

    61

    62

/**

    63

 * Converts a Unix-like pathname to a @c FSSpec structure which may be

    64

 * used with functions from several MacOS X frameworks (Carbon, QuickTime,

    65

 * etc). The pointed file or directory must exist.

    66

 *

    67

 * @param *path A string containing a Unix-like path.

    68

 * @param *spec Pointer to a @c FSSpec structure where the result will be

    69

 *              stored.

    70

 * @return Wether the conversion was successful.

    71

 */

    72

static bool PathToFSSpec(const char *path, FSSpec *spec)

    73

{

    74

	FSRef ref;

    75

	assert(spec);

    76

	assert(path);

    77

    78

	if (noErr != FSPathMakeRef((UInt8*) path, &ref, NULL))

    79

		return false;

    80

    81

	return (noErr ==

    82

			FSGetCatalogInfo(&ref, kFSCatInfoNone, NULL, NULL, spec, NULL));

    83

}

    84

    85

    86

/**

    87

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

    88

 * already set.

    89

 *

    90

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

    91

 */

    92

static void SetMIDITypeIfNeeded(const FSSpec *spec)

    93

{

    94

	FInfo info;

    95

	assert(spec);

    96

    97

	if (noErr != FSpGetFInfo(spec, &info)) return;

    98

    99

	/* Set file type to 'Midi' if the file is _not_ an alias. */

   100

	if ((info.fdType != midiType) && !(info.fdFlags & kIsAlias)) {

   101

		info.fdType = midiType;

   102

		FSpSetFInfo(spec, &info);

   103

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

   104

	}

   105

}

   106

   107

   108

/**

   109

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

   110

 *

   111

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

   112

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

   113

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

   114

 */

   115

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

   116

{

   117

	int fd;

   118

	int ret;

   119

	char magic[4];

   120

	FSSpec fsspec;

   121

	short refnum = 0;

   122

	short resid  = 0;

   123

   124

	assert(path);

   125

	assert(moov);

   126

   127

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

   128

   129

	/*

   130

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

   131

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

   132

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

   133

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

   134

	 */

   135

	if ((fd = open(path, O_RDONLY, 0)) == -1)

   136

		return false;

   137

	ret = read(fd, magic, 4);

   138

	close(fd);

   139

	if (ret < 4) return false;

   140

   141

	DEBUG(driver, 3) ("qtmidi: header is '%c%c%c%c'",

   142

			magic[0], magic[1], magic[2], magic[3]);

   143

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

   144

		return false;

   145

   146

	if (!PathToFSSpec(path, &fsspec))

   147

		return false;

   148

	SetMIDITypeIfNeeded(&fsspec);

   149

   150

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

   151

		return false;

   152

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

   153

   154

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

   155

				newMovieActive | newMovieDontAskUnresolvedDataRefs, NULL))

   156

	{

   157

		CloseMovieFile(refnum);

   158

		return false;

   159

	}

   160

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

   161

   162

	CloseMovieFile(refnum);

   163

	return true;

   164

}

   165

   166

   167

/**

   168

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

   169

 * initialized.

   170

 */

   171

static bool _quicktime_started = false;

   172

   173

   174

/**

   175

 * Initialize QuickTime if needed. This function sets the

   176

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

   177

 * and it was initialized properly.

   178

 */

   179

static void InitQuickTimeIfNeeded(void)

   180

{

   181

	OSStatus dummy;

   182

   183

	if (_quicktime_started) return;

   184

   185

	DEBUG(driver, 2) ("qtmidi: trying to initialize Quicktime");

   186

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

   187

	_quicktime_started =

   188

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

   189

		(noErr == EnterMovies());

   190

	DEBUG(driver, 1) ("qtmidi: Quicktime was %s initialized",

   191

			_quicktime_started ? "successfully" : "NOT");

   192

}

   193

   194

   195

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

   196

enum

   197

{

   198

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

   199

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

   200

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

   201

};

   202

   203

   204

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

   205

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

   206

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

   207

   208

   209

/**

   210

 * Maps OpenTTD volume to QuickTime notion of volume.

   211

 */

   212

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

   213

   214

   215

static void StopSong(void);

   216

   217

   218

/**

   219

 * Initialized the MIDI player, including QuickTime initialization.

   220

 *

   221

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

   222

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

   223

 * #InitQuickTimeIfNeeded.

   224

 */

   225

static const char* StartDriver(const char * const *parm)

   226

{

   227

	InitQuickTimeIfNeeded();

   228

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

   229

}

   230

   231

   232

/**

   233

 * Checks wether the player is active.

   234

 *

   235

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

   236

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

   237

 */

   238

static bool SongIsPlaying(void)

   239

{

   240

	if (!_quicktime_started) return true;

   241

   242

	switch (_quicktime_state) {

   243

		case QT_STATE_IDLE:

   244

		case QT_STATE_STOP:

   245

			/* Do nothing. */

   246

			break;

   247

		case QT_STATE_PLAY:

   248

			MoviesTask(_quicktime_movie, 0);

   249

			/* Check wether movie ended. */

   250

			if (IsMovieDone(_quicktime_movie) ||

   251

					(GetMovieTime(_quicktime_movie, NULL) >=

   252

					 GetMovieDuration(_quicktime_movie)))

   253

				_quicktime_state = QT_STATE_STOP;

   254

	}

   255

   256

	return (_quicktime_state == QT_STATE_PLAY);

   257

}

   258

   259

   260

/**

   261

 * Stops the MIDI player.

   262

 *

   263

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

   264

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

   265

 */

   266

static void StopDriver(void)

   267

{

   268

	if (!_quicktime_started) return;

   269

   270

	DEBUG(driver, 2) ("qtmidi: trying to stop driver...");

   271

	switch (_quicktime_state) {

   272

		case QT_STATE_IDLE:

   273

			DEBUG(driver, 3) ("qtmidi: nothing to do (already idle)");

   274

			/* Do nothing. */

   275

			break;

   276

		case QT_STATE_PLAY:

   277

			StopSong();

   278

		case QT_STATE_STOP:

   279

			DisposeMovie(_quicktime_movie);

   280

	}

   281

   282

	ExitMovies();

   283

	_quicktime_started = false;

   284

	DEBUG(driver, 1) ("qtmidi: driver successfully stopped");

   285

}

   286

   287

   288

/**

   289

 * Starts playing a new song.

   290

 *

   291

 * @param filename Path to a MIDI file.

   292

 */

   293

static void PlaySong(const char *filename)

   294

{

   295

	if (!_quicktime_started) return;

   296

   297

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

   298

	switch (_quicktime_state) {

   299

		case QT_STATE_PLAY:

   300

			StopSong();

   301

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

   302

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

   303

		case QT_STATE_STOP:

   304

			DisposeMovie(_quicktime_movie);

   305

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

   306

			_quicktime_state = QT_STATE_IDLE;

   307

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

   308

		case QT_STATE_IDLE:

   309

			LoadMovieForMIDIFile(filename, &_quicktime_movie);

   310

			SetMovieVolume(_quicktime_movie, VOLUME);

   311

			StartMovie(_quicktime_movie);

   312

			_quicktime_state = QT_STATE_PLAY;

   313

	}

   314

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

   315

}

   316

   317

   318

/**

   319

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

   320

 */

   321

static void StopSong(void)

   322

{

   323

	if (!_quicktime_started) return;

   324

   325

	switch (_quicktime_state) {

   326

		case QT_STATE_IDLE:

   327

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

   328

		case QT_STATE_STOP:

   329

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

   330

			/* Do nothing. */

   331

			break;

   332

		case QT_STATE_PLAY:

   333

			StopMovie(_quicktime_movie);

   334

			_quicktime_state = QT_STATE_STOP;

   335

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

   336

	}

   337

}

   338

   339

   340

/**

   341

 * Changes the playing volume of the MIDI player.

   342

 *

   343

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

   344

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

   345

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

   346

 *

   347

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

   348

 */

   349

static void SetVolume(byte vol)

   350

{

   351

	if (!_quicktime_started) return;

   352

   353

	_quicktime_volume = vol;

   354

   355

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

   356

	switch (_quicktime_state) {

   357

		case QT_STATE_IDLE:

   358

			/* Do nothing. */

   359

			break;

   360

		case QT_STATE_PLAY:

   361

		case QT_STATE_STOP:

   362

			SetMovieVolume(_quicktime_movie, VOLUME);

   363

	}

   364

}

   365

   366

   367

/**

   368

 * Table of callbacks that implement the QuickTime MIDI player.

   369

 */

   370

const HalMusicDriver _qtime_music_driver = {

   371

	StartDriver,

   372

	StopDriver,

   373

	PlaySong,

   374

	StopSong,

   375

	SongIsPlaying,

   376

	SetVolume,

   377

};