2 Copyright (C) 1996-1997 Id Software, Inc.
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.
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.
13 See the GNU General Public License for more details.
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.
20 // Quake is a trademark of Id Software, Inc., (c) 1996 Id Software, Inc. All
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);
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)"};
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;
57 static float saved_vol = 1.0f;
60 qboolean cdValid = false;
61 qboolean cdPlaying = false;
62 qboolean cdPlayLooping = false;
63 unsigned char cdPlayTrack;
67 static void CDAudio_Eject (void)
72 if(cdaudio.integer == 0)
79 static void CDAudio_CloseDoor (void)
84 if(cdaudio.integer == 0)
87 CDAudio_SysCloseDoor();
90 static int CDAudio_GetAudioDiskInfo (void)
96 if(cdaudio.integer == 0)
99 ret = CDAudio_SysGetAudioDiskInfo();
109 qboolean CDAudio_Play_real (int track, qboolean looping, qboolean complain)
114 Con_Print("Could not load BGM track.\n");
120 CDAudio_GetAudioDiskInfo();
124 Con_Print ("No CD in player.\n");
129 if (track > maxTrack)
132 Con_Printf("CDAudio: Bad track number %u.\n", track);
136 if (CDAudio_SysPlay(track) == -1)
139 if(cdaudio.integer != 3 || developer.integer)
140 Con_Printf ("CD track %u playing...\n", track);
145 void CDAudio_Play_byName (const char *trackname, qboolean looping)
149 char filename[MAX_QPATH];
156 if(strspn(trackname, "0123456789") == strlen(trackname))
158 track = (unsigned char) atoi(trackname);
159 if(track > 0 && track < MAXTRACKS)
162 if(strspn(remap[track], "0123456789") == strlen(remap[track]))
164 trackname = remap[track];
168 // ignore remappings to fake tracks if we're going to play a real track
169 switch(cdaudio.integer)
171 case 0: // we never access CD
172 case 1: // we have a replacement
173 trackname = remap[track];
175 case 2: // we only use fake track replacement if CD track is invalid
176 CDAudio_GetAudioDiskInfo();
177 if(!cdValid || track > maxTrack)
178 trackname = remap[track];
180 case 3: // we always play from CD - ignore this remapping then
181 case 4: // we randomize anyway
188 if(strspn(trackname, "0123456789") == strlen(trackname))
190 track = (unsigned char) atoi(trackname);
193 Con_Printf("CDAudio: Bad track number %u.\n", track);
200 // div0: I assume this code was intentionally there. Maybe turn it into a cvar?
201 if (cdPlaying && cdPlayTrack == track && faketrack == -1)
207 if(cdaudio.integer == 3) // only play real CD tracks at all
209 if(CDAudio_Play_real(track, looping, true))
214 if(cdaudio.integer == 2) // prefer real CD track over fake
216 if(CDAudio_Play_real(track, looping, false))
221 if(cdaudio.integer == 4) // only play real CD tracks, EVEN instead of fake tracks!
223 if(CDAudio_Play_real(track, looping, false))
226 if(cdValid && maxTrack > 0)
228 track = 1 + (rand() % maxTrack);
229 if(CDAudio_Play_real(track, looping, true))
234 Con_Print ("No CD in player.\n");
239 // Try playing a fake track (sound file) first
242 dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%03u.wav", track);
243 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%03u.ogg", track);
244 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%02u.wav", track);
245 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/track%02u.ogg", track);
249 dpsnprintf(filename, sizeof(filename), "%s", trackname);
250 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "%s.wav", trackname);
251 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "%s.ogg", trackname);
252 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s", trackname);
253 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s.wav", trackname);
254 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/%s.ogg", trackname);
255 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s", trackname);
256 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s.wav", trackname);
257 if (!FS_FileExists(filename)) dpsnprintf(filename, sizeof(filename), "sound/cdtracks/%s.ogg", trackname);
259 if (FS_FileExists(filename) && (sfx = S_PrecacheSound (filename, false, true)))
261 faketrack = S_StartSound (-1, 0, sfx, vec3_origin, cdvolume, 0);
265 S_SetChannelFlag (faketrack, CHANNELFLAG_FORCELOOP, true);
266 S_SetChannelFlag (faketrack, CHANNELFLAG_FULLVOLUME, true);
267 S_SetChannelFlag (faketrack, CHANNELFLAG_LOCALSOUND, true); // not pausable
270 if(cdaudio.integer != 0 || developer.integer) // we don't need these messages if only fake tracks can be played anyway
271 Con_Printf ("Fake CD track %u playing...\n", track);
274 Con_DPrintf ("BGM track %s playing...\n", trackname);
278 // If we can't play a fake CD track, try the real one
281 if(cdaudio.integer == 0 || track < 1)
283 Con_Print("Could not load BGM track.\n");
288 if(!CDAudio_Play_real(track, looping, true))
294 cdPlayLooping = looping;
298 if (cdvolume == 0.0 || bgmvolume.value == 0)
302 void CDAudio_Play (int track, qboolean looping)
305 dpsnprintf(buf, sizeof(buf), "%d", (int) track);
306 CDAudio_Play_byName(buf, looping);
309 float CDAudio_GetPosition ()
312 return S_GetChannelPosition(faketrack);
316 void CDAudio_Stop (void)
323 S_StopChannel (faketrack, true);
326 else if (cdPlaying && (CDAudio_SysStop() == -1))
330 CDAudio_Resume(); // needed by SDL - can't stop while paused there
331 if (cdPlaying && (CDAudio_SysStop() == -1))
339 void CDAudio_Pause (void)
341 if (!enabled || !cdPlaying)
345 S_SetChannelFlag (faketrack, CHANNELFLAG_PAUSED, true);
346 else if (CDAudio_SysPause() == -1)
349 wasPlaying = cdPlaying;
354 void CDAudio_Resume (void)
356 if (!enabled || cdPlaying || !wasPlaying)
360 S_SetChannelFlag (faketrack, CHANNELFLAG_PAUSED, false);
361 else if (CDAudio_SysResume() == -1)
366 static void CD_f (void)
372 command = (Cmd_Argc() >= 2) ? Cmd_Argv (1) : "";
374 if (strcasecmp(command, "remap") != 0)
377 if (strcasecmp(command, "on") == 0)
383 if (strcasecmp(command, "off") == 0)
390 if (strcasecmp(command, "reset") == 0)
394 for (n = 0; n < MAXTRACKS; n++)
395 *remap[n] = 0; // empty string, that is, unremapped
396 CDAudio_GetAudioDiskInfo();
400 if (strcasecmp(command, "rescan") == 0)
408 if (strcasecmp(command, "remap") == 0)
410 ret = Cmd_Argc() - 2;
413 for (n = 1; n < MAXTRACKS; n++)
415 Con_Printf(" %u -> %s\n", n, remap[n]);
418 for (n = 1; n <= ret; n++)
419 strlcpy(remap[n], Cmd_Argv (n+1), sizeof(*remap));
423 if (strcasecmp(command, "close") == 0)
429 if (strcasecmp(command, "play") == 0)
431 CDAudio_Play_byName(Cmd_Argv (2), false);
435 if (strcasecmp(command, "loop") == 0)
437 CDAudio_Play_byName(Cmd_Argv (2), true);
441 if (strcasecmp(command, "stop") == 0)
447 if (strcasecmp(command, "pause") == 0)
453 if (strcasecmp(command, "resume") == 0)
459 if (strcasecmp(command, "eject") == 0)
461 if (cdPlaying && faketrack == -1)
468 if (strcasecmp(command, "info") == 0)
470 CDAudio_GetAudioDiskInfo ();
472 Con_Printf("%u tracks on CD.\n", maxTrack);
474 Con_Print ("No CD in player.\n");
476 Con_Printf("Currently %s track %u\n", cdPlayLooping ? "looping" : "playing", cdPlayTrack);
478 Con_Printf("Paused %s track %u\n", cdPlayLooping ? "looping" : "playing", cdPlayTrack);
480 Con_Printf("Volume is %f\n", cdvolume);
482 Con_Printf("Can't get CD volume\n");
486 Con_Printf("CD commands:\n");
487 Con_Printf("cd on - enables CD audio system\n");
488 Con_Printf("cd off - stops and disables CD audio system\n");
489 Con_Printf("cd reset - resets CD audio system (clears track remapping and re-reads disc information)");
490 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");
491 Con_Printf("cd close - closes CD tray\n");
492 Con_Printf("cd eject - stops playing music and opens CD tray to allow you to change disc\n");
493 Con_Printf("cd play <tracknumber> - plays selected track in remapping table\n");
494 Con_Printf("cd loop <tracknumber> - plays and repeats selected track in remapping table\n");
495 Con_Printf("cd stop - stops playing current CD track\n");
496 Con_Printf("cd pause - pauses CD playback\n");
497 Con_Printf("cd resume - unpauses CD playback\n");
498 Con_Printf("cd info - prints basic disc information (number of tracks, currently playing track, volume level)\n");
501 void CDAudio_SetVolume (float newvol)
503 // If the volume hasn't changed
504 if (newvol == cdvolume)
507 // If the CD has been muted
512 // If the CD has been unmuted
513 if (cdvolume == 0.0f)
517 S_SetChannelVolume (faketrack, newvol);
519 CDAudio_SysSetVolume (newvol);
525 void CDAudio_Update (void)
530 CDAudio_SetVolume (bgmvolume.value);
532 if (faketrack == -1 && cdaudio.integer != 0 && bgmvolume.value != 0)
536 int CDAudio_Init (void)
540 if (cls.state == ca_dedicated)
543 // COMMANDLINEOPTION: Sound: -nocdaudio disables CD audio support
544 if (COM_CheckParm("-nocdaudio"))
549 for (i = 0; i < MAXTRACKS; i++)
552 Cvar_RegisterVariable(&cdaudio);
553 Cvar_RegisterVariable(&cdaudioinitialized);
554 Cvar_SetValueQuick(&cdaudioinitialized, true);
557 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");
562 int CDAudio_Startup (void)
564 if (COM_CheckParm("-nocdaudio"))
567 CDAudio_SysStartup ();
569 if (CDAudio_GetAudioDiskInfo())
571 Con_Print("CDAudio_Init: No CD in player.\n");
575 saved_vol = CDAudio_SysGetVolume ();
576 if (saved_vol < 0.0f)
578 Con_Print ("Can't get initial CD volume\n");
582 Con_Printf ("Initial CD volume: %g\n", saved_vol);
586 Con_Print("CD Audio Initialized\n");
591 void CDAudio_Shutdown (void)
596 CDAudio_SysSetVolume (saved_vol);
599 CDAudio_SysShutdown();