cd_shared.c

   1 /*
   2 Copyright (C) 1996-1997 Id Software, Inc.
   3
   4 This program is free software; you can redistribute it and/or
   5 modify it under the terms of the GNU General Public License
   6 as published by the Free Software Foundation; either version 2
   7 of the License, or (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
  12
  13 See the GNU General Public License for more details.
  14
  15 You should have received a copy of the GNU General Public License
  16 along with this program; if not, write to the Free Software
  17 Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  18
  19 */
  20 // Quake is a trademark of Id Software, Inc., (c) 1996 Id Software, Inc. All
  21 // rights reserved.
  22
  23 #include "quakedef.h"
  24 #include "cdaudio.h"
  25 #include "sound.h"
  26
  27 #define MAXTRACKS       256
  28
  29 // Prototypes of the system dependent functions
  30 extern void CDAudio_SysEject (void);
  31 extern void CDAudio_SysCloseDoor (void);
  32 extern int CDAudio_SysGetAudioDiskInfo (void);
  33 extern float CDAudio_SysGetVolume (void);
  34 extern void CDAudio_SysSetVolume (float volume);
  35 extern int CDAudio_SysPlay (int track);
  36 extern int CDAudio_SysStop (void);
  37 extern int CDAudio_SysPause (void);
  38 extern int CDAudio_SysResume (void);
  39 extern int CDAudio_SysUpdate (void);
  40 extern void CDAudio_SysInit (void);
  41 extern int CDAudio_SysStartup (void);
  42 extern void CDAudio_SysShutdown (void);
  43
  44 // used by menu to ghost CD audio slider
  45 cvar_t cdaudioinitialized = {CVAR_READONLY,"cdaudioinitialized","0","indicates if CD Audio system is active"};
  46 cvar_t cdaudio = {CVAR_SAVE,"cdaudio","1","CD playing mode (0 = never access CD drive, 1 = play CD tracks if no replacement available, 2 = play fake tracks if no CD track available, 3 = play only real CD tracks, 4 = play real CD tracks even instead of named fake tracks)"};
  47
  48 static qboolean wasPlaying = false;
  49 static qboolean initialized = false;
  50 static qboolean enabled = false;
  51 static float cdvolume;
  52 typedef char filename_t[MAX_QPATH];
  53 static filename_t remap[MAXTRACKS];
  54 static unsigned char maxTrack;
  55 static int faketrack = -1;
  56
  57 static float saved_vol = 1.0f;
  58
  59 // exported variables
  60 qboolean cdValid = false;
  61 qboolean cdPlaying = false;
  62 qboolean cdPlayLooping = false;
  63 unsigned char cdPlayTrack;
  64
  65 cl_cdstate_t cd;
  66
  67 static void CDAudio_Eject (void)
  68 {
  69         if (!enabled)
  70                 return;
  71
  72         if(cdaudio.integer == 0)
  73                 return;
  74
  75         CDAudio_SysEject();
  76 }
  77
  78
  79 static void CDAudio_CloseDoor (void)
  80 {
  81         if (!enabled)
  82                 return;
  83
  84         if(cdaudio.integer == 0)
  85                 return;
  86
  87         CDAudio_SysCloseDoor();
  88 }
  89
  90 static int CDAudio_GetAudioDiskInfo (void)
  91 {
  92         int ret;
  93
  94         cdValid = false;
  95
  96         if(cdaudio.integer == 0)
  97                 return -1;
  98
  99         ret = CDAudio_SysGetAudioDiskInfo();
 100         if (ret < 1)
 101                 return -1;
 102
 103         cdValid = true;
 104         maxTrack = ret;
 105
 106         return 0;
 107 }
 108
 109 qboolean CDAudio_Play_real (int track, qboolean looping, qboolean complain)
 110 {
 111         if(track < 1)
 112         {
 113                 if(complain)
 114                         Con_Print("Could not load BGM track.\n");
 115                 return false;
 116         }
 117
 118         if (!cdValid)
 119         {
 120                 CDAudio_GetAudioDiskInfo();
 121                 if (!cdValid)
 122                 {
 123                         if(complain)
 124                                 Con_Print ("No CD in player.\n");
 125                         return false;
 126                 }
 127         }
 128
 129         if (track > maxTrack)
 130         {
 131                 if(complain)
 132                         Con_Printf("CDAudio: Bad track number %u.\n", track);
 133                 return false;
 134         }
 135
 136         if (CDAudio_SysPlay(track) == -1)
 137                 return false;
 138
 139         if(cdaudio.integer != 3 || developer.integer)
 140                 Con_Printf ("CD track %u playing...\n", track);
 141
 142         return true;
 143 }
 144
 145 void CDAudio_Play_byName (const char *trackname, qboolean looping)
 146 {
 147         unsigned int track;
 148         sfx_t* sfx;
 149         char filename[MAX_QPATH];
 150
 151         Host_StartVideo();
 152
 153         if (!enabled)
 154                 return;
 155
 156         if(strspn(trackname, "0123456789") == strlen(trackname))
 157         {
 158                 track = (unsigned char) atoi(trackname);
 159                 if(track > 0 && track < MAXTRACKS)
 160                                 if(*remap[track])
 161                                         trackname = remap[track];
 162         }
 163
 164         if(strspn(trackname, "0123456789") == strlen(trackname))
 165         {
 166                 track = (unsigned char) atoi(trackname);
 167                 if (track < 1)
 168                 {
 169                         Con_Printf("CDAudio: Bad track number %u.\n", track);
 170                         return;
 171                 }
 172         }
 173         else
 174                 track = 0;
 175
 176         if (cdPlaying && cdPlayTrack == track && faketrack == -1)
 177                 return;
 178         CDAudio_Stop ();
 179
 180         if(track >= 1)
 181         {
 182                 if(cdaudio.integer == 3) // only play real CD tracks at all
 183                 {
 184                         if(CDAudio_Play_real(track, looping, true))
 185                                 goto success;
 186                         return;
 187                 }
 188
 189                 if(cdaudio.integer == 2) // prefer real CD track over fake
 190                 {
 191                         if(CDAudio_Play_real(track, looping, false))
 192                                 goto success;
 193                 }
 194         }
 195
 196         if(cdaudio.integer == 4) // only play real CD tracks, EVEN instead of fake tracks!
 197         {
 198                 if(CDAudio_Play_real(track, looping, false))
 199                         goto success;
 200
 201                 if(cdValid && maxTrack > 0)
 202                 {
 203                         track = 1 + (rand() % maxTrack);
 204                         if(CDAudio_Play_real(track, looping, true))
 205                                 goto success;
 206                 }
 207                 else
 208                 {
 209                         Con_Print ("No CD in player.\n");
 210                 }
 211                 return;
 212         }
 213
 214         // Try playing a fake track (sound file) first
 215         if(track >= 1)
 216         {
 217                                               dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%03u.wav", track);
 218                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%03u.ogg", track);
 219                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%02u.wav", track);
 220                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%02u.ogg", track);
 221         }
 222         else
 223         {
 224                                               dpsnprintf(filename, sizeof(filename), "%s", trackname);
 225                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "%s.wav", trackname);
 226                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "%s.ogg", trackname);
 227                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s", trackname);
 228                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s.wav", trackname);
 229                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s.ogg", trackname);
 230                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s", trackname);
 231                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s.wav", trackname);
 232                 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s.ogg", trackname);
 233         }
 234         if (FS_FileExists(filename) && (sfx = S_PrecacheSound (filename, false, true)))
 235         {
 236                 faketrack = S_StartSound (-1, 0, sfx, vec3_origin, cdvolume, 0);
 237                 if (faketrack != -1)
 238                 {
 239                         if (looping)
 240                                 S_SetChannelFlag (faketrack, CHANNELFLAG_FORCELOOP, true);
 241                         S_SetChannelFlag (faketrack, CHANNELFLAG_FULLVOLUME, true);
 242                         S_SetChannelFlag (faketrack, CHANNELFLAG_LOCALSOUND, true); // not pausable
 243                         if(track >= 1)
 244                         {
 245                                 if(cdaudio.integer != 0 || developer.integer) // we don't need these messages if only fake tracks can be played anyway
 246                                         Con_Printf ("Fake CD track %u playing...\n", track);
 247                         }
 248                         else
 249                                 Con_DPrintf ("BGM track %s playing...\n", trackname);
 250                 }
 251         }
 252
 253         // If we can't play a fake CD track, try the real one
 254         if (faketrack == -1)
 255         {
 256                 if(cdaudio.integer == 0 || track < 1)
 257                 {
 258                         Con_Print("Could not load BGM track.\n");
 259                         return;
 260                 }
 261                 else
 262                 {
 263                         if(!CDAudio_Play_real(track, looping, true))
 264                                 return;
 265                 }
 266         }
 267
 268 success:
 269         cdPlayLooping = looping;
 270         cdPlayTrack = track;
 271         cdPlaying = true;
 272
 273         if (cdvolume == 0.0)
 274                 CDAudio_Pause ();
 275 }
 276
 277 void CDAudio_Play (int track, qboolean looping)
 278 {
 279         char buf[20];
 280         dpsnprintf(buf, sizeof(buf), "%d", (int) track);
 281         CDAudio_Play_byName(buf, looping);
 282 }
 283
 284 void CDAudio_Stop (void)
 285 {
 286         if (!enabled)
 287                 return;
 288
 289         if (faketrack != -1)
 290         {
 291                 S_StopChannel (faketrack, true);
 292                 faketrack = -1;
 293         }
 294         else if (cdPlaying && (CDAudio_SysStop() == -1))
 295                 return;
 296
 297         wasPlaying = false;
 298         cdPlaying = false;
 299 }
 300
 301 void CDAudio_Pause (void)
 302 {
 303         if (!enabled || !cdPlaying)
 304                 return;
 305
 306         if (faketrack != -1)
 307                 S_SetChannelFlag (faketrack, CHANNELFLAG_PAUSED, true);
 308         else if (CDAudio_SysPause() == -1)
 309                 return;
 310
 311         wasPlaying = cdPlaying;
 312         cdPlaying = false;
 313 }
 314
 315
 316 void CDAudio_Resume (void)
 317 {
 318         if (!enabled || cdPlaying || !wasPlaying)
 319                 return;
 320
 321         if (faketrack != -1)
 322                 S_SetChannelFlag (faketrack, CHANNELFLAG_PAUSED, false);
 323         else if (CDAudio_SysResume() == -1)
 324                 return;
 325         cdPlaying = true;
 326 }
 327
 328 static void CD_f (void)
 329 {
 330         const char *command;
 331         int ret;
 332         int n;
 333
 334         if (Cmd_Argc() < 2)
 335                 return;
 336
 337         command = Cmd_Argv (1);
 338
 339         if (strcasecmp(command, "remap") != 0)
 340                 Host_StartVideo();
 341
 342         if (strcasecmp(command, "on") == 0)
 343         {
 344                 enabled = true;
 345                 return;
 346         }
 347
 348         if (strcasecmp(command, "off") == 0)
 349         {
 350                 if (cdPlaying)
 351                         CDAudio_Stop();
 352                 enabled = false;
 353                 return;
 354         }
 355
 356         if (strcasecmp(command, "reset") == 0)
 357         {
 358                 enabled = true;
 359                 if (cdPlaying)
 360                         CDAudio_Stop();
 361                 for (n = 0; n < MAXTRACKS; n++)
 362                         *remap[n] = 0; // empty string, that is, unremapped
 363                 CDAudio_GetAudioDiskInfo();
 364                 return;
 365         }
 366
 367         if (strcasecmp(command, "remap") == 0)
 368         {
 369                 ret = Cmd_Argc() - 2;
 370                 if (ret <= 0)
 371                 {
 372                         for (n = 1; n < MAXTRACKS; n++)
 373                                 if (*remap[n])
 374                                         Con_Printf("  %u -> %s\n", n, remap[n]);
 375                         return;
 376                 }
 377                 for (n = 1; n <= ret; n++)
 378                         strlcpy(remap[n], Cmd_Argv (n+1), sizeof(*remap));
 379                 return;
 380         }
 381
 382         if (strcasecmp(command, "close") == 0)
 383         {
 384                 CDAudio_CloseDoor();
 385                 return;
 386         }
 387
 388         if (strcasecmp(command, "play") == 0)
 389         {
 390                 CDAudio_Play_byName(Cmd_Argv (2), false);
 391                 return;
 392         }
 393
 394         if (strcasecmp(command, "loop") == 0)
 395         {
 396                 CDAudio_Play_byName(Cmd_Argv (2), true);
 397                 return;
 398         }
 399
 400         if (strcasecmp(command, "stop") == 0)
 401         {
 402                 CDAudio_Stop();
 403                 return;
 404         }
 405
 406         if (strcasecmp(command, "pause") == 0)
 407         {
 408                 CDAudio_Pause();
 409                 return;
 410         }
 411
 412         if (strcasecmp(command, "resume") == 0)
 413         {
 414                 CDAudio_Resume();
 415                 return;
 416         }
 417
 418         if (strcasecmp(command, "eject") == 0)
 419         {
 420                 if (cdPlaying && faketrack == -1)
 421                         CDAudio_Stop();
 422                 CDAudio_Eject();
 423                 cdValid = false;
 424                 return;
 425         }
 426
 427         if (strcasecmp(command, "info") == 0)
 428         {
 429                 CDAudio_GetAudioDiskInfo ();
 430                 if (cdValid)
 431                         Con_Printf("%u tracks on CD.\n", maxTrack);
 432                 else
 433                         Con_Print ("No CD in player.\n");
 434                 if (cdPlaying)
 435                         Con_Printf("Currently %s track %u\n", cdPlayLooping ? "looping" : "playing", cdPlayTrack);
 436                 else if (wasPlaying)
 437                         Con_Printf("Paused %s track %u\n", cdPlayLooping ? "looping" : "playing", cdPlayTrack);
 438                 Con_Printf("Volume is %f\n", cdvolume);
 439                 return;
 440         }
 441
 442         Con_Printf("CD commands:\n");
 443         Con_Printf("cd on - enables CD audio system\n");
 444         Con_Printf("cd off - stops and disables CD audio system\n");
 445         Con_Printf("cd reset - resets CD audio system (clears track remapping and re-reads disc information)");
 446         Con_Printf("cd remap <remap1> [remap2] [remap3] [...] - chooses (possibly emulated) CD tracks to play when a map asks for a particular track, this has many uses\n");
 447         Con_Printf("cd close - closes CD tray\n");
 448         Con_Printf("cd eject - stops playing music and opens CD tray to allow you to change disc\n");
 449         Con_Printf("cd play <tracknumber> - plays selected track in remapping table\n");
 450         Con_Printf("cd loop <tracknumber> - plays and repeats selected track in remapping table\n");
 451         Con_Printf("cd stop - stops playing current CD track\n");
 452         Con_Printf("cd pause - pauses CD playback\n");
 453         Con_Printf("cd resume - unpauses CD playback\n");
 454         Con_Printf("cd info - prints basic disc information (number of tracks, currently playing track, volume level)\n");
 455 }
 456
 457 void CDAudio_SetVolume (float newvol)
 458 {
 459         // If the volume hasn't changed
 460         if (newvol == cdvolume)
 461                 return;
 462
 463         // If the CD has been muted
 464         if (newvol == 0.0f)
 465                 CDAudio_Pause ();
 466         else
 467         {
 468                 // If the CD has been unmuted
 469                 if (cdvolume == 0.0f)
 470                         CDAudio_Resume ();
 471
 472                 if (faketrack != -1)
 473                         S_SetChannelVolume (faketrack, newvol);
 474                 else
 475                         CDAudio_SysSetVolume (newvol);
 476         }
 477
 478         cdvolume = newvol;
 479 }
 480
 481 void CDAudio_Update (void)
 482 {
 483         if (!enabled)
 484                 return;
 485
 486         CDAudio_SetVolume (bgmvolume.value);
 487
 488         if (faketrack == -1 && cdaudio.integer != 0)
 489                 CDAudio_SysUpdate();
 490 }
 491
 492 int CDAudio_Init (void)
 493 {
 494         int i;
 495
 496         if (cls.state == ca_dedicated)
 497                 return -1;
 498
 499 // COMMANDLINEOPTION: Sound: -nocdaudio disables CD audio support
 500         if (COM_CheckParm("-nocdaudio"))
 501                 return -1;
 502
 503         CDAudio_SysInit();
 504
 505         for (i = 0; i < MAXTRACKS; i++)
 506                 *remap[i] = 0;
 507
 508         Cvar_RegisterVariable(&cdaudio);
 509         Cvar_RegisterVariable(&cdaudioinitialized);
 510         Cvar_SetValueQuick(&cdaudioinitialized, true);
 511         enabled = true;
 512
 513         Cmd_AddCommand("cd", CD_f, "execute a CD drive command (cd on/off/reset/remap/close/play/loop/stop/pause/resume/eject/info) - use cd by itself for usage");
 514
 515         return 0;
 516 }
 517
 518 int CDAudio_Startup (void)
 519 {
 520         if (COM_CheckParm("-nocdaudio"))
 521                 return -1;
 522
 523         CDAudio_SysStartup ();
 524
 525         if (CDAudio_GetAudioDiskInfo())
 526         {
 527                 Con_Print("CDAudio_Init: No CD in player.\n");
 528                 cdValid = false;
 529         }
 530
 531         saved_vol = CDAudio_SysGetVolume ();
 532         if (saved_vol < 0.0f)
 533         {
 534                 Con_Print ("Can't get initial CD volume\n");
 535                 saved_vol = 1.0f;
 536         }
 537         else
 538                 Con_Printf ("Initial CD volume: %g\n", saved_vol);
 539
 540         initialized = true;
 541
 542         Con_Print("CD Audio Initialized\n");
 543
 544         return 0;
 545 }
 546
 547 void CDAudio_Shutdown (void)
 548 {
 549         if (!initialized)
 550                 return;
 551
 552         CDAudio_SysSetVolume (saved_vol);
 553
 554         CDAudio_Stop();
 555         CDAudio_SysShutdown();
 556         initialized = false;
 557 }