mpo/VVVVVV
1
0
Fork 0
mirror of https://github.com/TerryCavanagh/VVVVVV.git synced 2024-06-17 01:58:29 +02:00
Code Issues Releases Wiki Activity
master
VVVVVV/desktop_version/src/Music.h

131 lines
2.7 KiB
C
Raw Permalink Normal View History

Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
#ifndef MUSIC_H
#define MUSIC_H
Separate includes into sections and alphabetize them Okay, so basically here's the include layout that this game now consistently uses: [The "main" header file, if any (e.g. Graphics.h for Graphics.cpp)] [blank line] [All system includes, such as tinyxml2/physfs/utfcpp/SDL] [blank line] [All project includes, such as Game.h/Entity.h/etc.] And if applicable, another blank line, and then some special-case include screwy stuff (take a look at editor.cpp or FileSystemUtils.cpp, for example, they have ifdefs and defines with their includes).
2020-07-19 21:43:29 +02:00
#include "BinaryBlob.h"
Consolidate SoundSystem into Music. It's just some small wrappers, and SoundSystem can be inlined trivially.
2021-12-26 14:38:16 +01:00
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
#define musicroom(rx, ry) ((rx) + ((ry) * 20))
Add music and sound volume config options This adds <musicvolume> and <soundvolume> tags to unlock.vvv and settings.vvv, so users' volume preferences will be persistent across game sessions. This does not add the user interface to change them from in-game; the next commit will do that.
2021-04-12 02:41:46 +02:00
/* The amount of "space" for the scale of the user-set volume. */
#define USER_VOLUME_MAX 256
Implement music and sound volume sliders This adds music and volume sliders to the audio options. To use the sliders, you navigate to the given option, then press ACTION, and your selection will be transferred to the slider. Pressing left or right will move the slider accordingly. Then you can press ACTION to confirm the volume is what you want and deselect it, or you can press Esc to cancel the volume change, and it will revert to the previous volume; both actions will write your settings to disk. Most of this commit is just adding infrastructure to support having sliders in menus (without copy-pasting code), which is a totally completely new user interface that has never been used before in this game. If we're going to be adding something new, I want to make sure that it at least is done the RIGHT way. Closes #706.
2021-04-12 02:43:17 +02:00
/* It is advised that USER_VOLUME_MAX be divisible by this. */
#define USER_VOLUME_STEP 32
Use enums for music tracks This adds an anonymous enum for music tracks and replaces all calls to music.play and music.niceplay that use integer literals. Additionally, this is also done for integer literals for cl.levmusic (except 0) and music.currentsong where appropriate, but _not_ the music areamap because that would not make it look very aesthetically pleasing in the code. This is not a named enum (that can be used for strict typechecking) because music track IDs are essentially part of the API of the game - almost every custom level uses these numbers. This is just to make the source code more readable without needing a comment to denote what number is what track.
2023-05-24 03:37:32 +02:00
enum
{
Music_PATHCOMPLETE = 0,
Music_PUSHINGONWARDS = 1,
Music_POSITIVEFORCE = 2,
Music_POTENTIALFORANYTHING = 3,
Music_PASSIONFOREXPLORING = 4,
Music_PAUSE = 5,
Music_PRESENTINGVVVVVV = 6,
Music_PLENARY = 7,
Music_PREDESTINEDFATE = 8,
Music_POSITIVEFORCEREVERSED = 9,
Music_POPULARPOTPOURRI = 10,
Music_PIPEDREAM = 11,
Music_PRESSURECOOKER = 12,
Music_PACEDENERGY = 13,
Music_PIERCINGTHESKY = 14,
Music_PREDESTINEDFATEREMIX = 15
};
Use enums for sound effects This adds an anonymous enum for sound effects and replaces all calls to music.playef that use integer literals. This is not a named enum (that can be used for strict typechecking) because sound effect IDs are essentially part of the API of the game - many custom levels use these numbers. This is just to make the source code more readable without needing a comment to denote what number is what sound.
2023-06-04 00:29:02 +02:00
enum
{
Sound_FLIP = 0,
Sound_UNFLIP = 1,
Sound_CRY = 2,
Sound_TRINKET = 3,
Sound_COIN = 4,
Sound_CHECKPOINT = 5,
Sound_CRUMBLE = 6,
Sound_DISAPPEAR = 7,
Sound_GRAVITYLINE = 8,
Sound_FLASH = 9,
Sound_TELEPORT = 10,
Sound_VIRIDIAN = 11,
Sound_VERDIGRIS = 12,
Sound_VICTORIA = 13,
Sound_VITELLARY = 14,
Sound_VIOLET = 15,
Sound_VERMILION = 16,
Sound_TERMINALTOUCH = 17,
Sound_GAMESAVED = 18,
Sound_ALARM = 19,
Sound_TERMINALTEXT = 20,
Sound_COUNTDOWN = 21,
Sound_GO = 22,
Sound_DESTROY = 23,
Sound_COMBINE = 24,
Sound_NEWRECORD = 25,
Sound_TROPHY = 26,
Sound_RESCUE = 27
};
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
class musicclass
{
public:
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
musicclass(void);
void init(void);
void destroy(void);
void play(int t);
Style: Fixup instances of `void` arguments The style we have here is that functions with no arguments are to have explicit `void` arguments, even though this doesn't apply in C++, because it does apply in C. Unfortunately, some have slipped through the cracks. This commit fixes them.
2023-03-18 23:24:14 +01:00
void resume(void);
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
void resumefade(const int fadein_ms);
void pause(void);
void haltdasmusik(void);
Fix regression with music fade transitions not working Unfortunately, 1de459d9b414180d5049cbf153266a8d6e00c227 caused a regression where musicclass::niceplay() didn't work, because fading out the music would cause haltdasmusik() to be called, which would reset the fade variables. To fix this, haltdasmusik() will now only reset the fade variables if it's not called from a fade, which is signaled with a function parameter.
2023-04-06 04:32:42 +02:00
void haltdasmusik(bool from_fade);
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
void silencedasmusik(void);
void fadeMusicVolumeIn(int ms);
void fadeMusicVolumeOut(const int fadeout_ms);
void fadeout(const bool quick_fade_ = true);
void fadein(void);
void processmusicfadein(void);
void processmusicfadeout(void);
void processmusic(void);
void niceplay(int t);
void changemusicarea(int x, int y);
int currentsong;
Implement haltedsong This fixes a bug where if a track was resumed, pausing it by unfocusing the window (if enabled, of course) would not resume it after refocusing the window. This happens because resuming the music doesn't change currentsong back from -1, and the window refocusing code checks that currentsong isn't -1 before resuming music. haltedsong is only used when resuming music. It is set back to -1 when resuming music or when playing a new track.
2023-06-09 00:38:26 +02:00
int haltedsong;
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
void playef(int t);
void pauseef(void);
void resumeef(void);
Move `Mix_PausedMusic()` call into wrapper function This wrapper function is for (a) future-proofing (b) proactive prevention of future copy-pasting (c) to clarify that we never actually halt music in the SDL_mixer sense, we only pause it, so to check if the music is halted we actually check if the music is paused instead. This is important because Mix_PlayingMusic() does not check if the music is paused and Mix_PausedMusic() does not check if the music is halted.
2021-09-11 04:35:29 +02:00
bool halted(void);
Move the mute logic to musicclass. This moves the last of the SDL_mixer calls to Music.cpp.
2021-12-26 14:48:23 +01:00
void updatemutestate(void);
Move `Mix_PausedMusic()` call into wrapper function This wrapper function is for (a) future-proofing (b) proactive prevention of future copy-pasting (c) to clarify that we never actually halt music in the SDL_mixer sense, we only pause it, so to check if the music is halted we actually check if the music is paused instead. This is important because Mix_PlayingMusic() does not check if the music is paused and Mix_PausedMusic() does not check if the music is halted.
2021-09-11 04:35:29 +02:00
Untabify every single file YOLO. This is a repeat of #642. As before, I just did rg -l '\t' | xargs -n 1 sed -i -e 's/\t/ /g' inside the desktop_version/ folder.
2021-09-07 03:56:39 +02:00
bool safeToProcessMusic;
int nicechange; // -1 if no song queued
bool nicefade;
bool m_doFadeInVol;
bool m_doFadeOutVol;
int musicVolume;
/* 0..USER_VOLUME_MAX */
int user_music_volume;
int user_sound_volume;
bool quick_fade;
// MMMMMM mod settings
bool mmmmmm;
bool usingmmmmmm;
binaryBlob pppppp_blob;
binaryBlob mmmmmm_blob;
int num_pppppp_tracks;
int num_mmmmmm_tracks;
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
};
Clean up and prevent unnecessary qualifiers to self By "unnecessary qualifiers to self", I mean something like using the 'game.' qualifier for a variable on the Game class when you're inside a function on the Game class itself. This patch is to enforce consistency as most of the code doesn't have these unnecessary qualifiers. To prevent further unnecessary qualifiers to self, I made it so the extern in each header file can be omitted by using a define. That way, if someone writes something referring to 'game.' on a Game function, there will be a compile error. However, if you really need to have a reference to the global name, and you're within the same .cpp file as the implementation of that object, you can just do the extern at the function-level. A good example of this is editorinput()/editorrender()/editorlogic() in editor.cpp. In my opinion, they should probably be split off into their own separate file because editor.cpp is getting way too big, but this will do for now.
2020-09-28 04:15:06 +02:00
#ifndef MUSIC_DEFINITION
Allow using help/graphics/music/game/key/map/obj everywhere This commit makes `help`, `graphics`, `music`, `game`, `key`, `map`, and `obj` essentially static global objects that can be used everywhere. This is useful in case we ever need to add a new function in the future, so we don't have to bother with passing a new argument in which means we have to pass a new argument in to the function that calls that function which means having to pass a new argument into the function that calls THAT function, etc. which is a real headache when working on fan mods of the source code. Note that this changes NONE of the existing function signatures, it merely just makes those variables accessible everywhere in the same way `script` and `ed` are. Also note that some classes had to be initialized after the filesystem was initialized, but C++ would keep initializing them before the filesystem got initialized, because I *had* to put them at the top of `main.cpp`, or else they wouldn't be global variables. The only way to work around this was to use entityclass's initialization style (which I'm pretty sure entityclass of all things doesn't need to be initialized this way), where you actually initialize the class in an `init()` function, and so then you do `graphics.init()` after the filesystem initialization, AFTER doing `Graphics graphics` up at the top. I've had to do this for `graphics` (but only because its child GraphicsResources `grphx` needs to be initialized this way), `music`, and `game`. I don't think this will affect anything. Other than that, `help`, `key`, and `map` are still using the C++-intended method of having ClassName::ClassName() functions.
2020-01-29 08:35:03 +01:00
extern musicclass music;
Clean up and prevent unnecessary qualifiers to self By "unnecessary qualifiers to self", I mean something like using the 'game.' qualifier for a variable on the Game class when you're inside a function on the Game class itself. This patch is to enforce consistency as most of the code doesn't have these unnecessary qualifiers. To prevent further unnecessary qualifiers to self, I made it so the extern in each header file can be omitted by using a define. That way, if someone writes something referring to 'game.' on a Game function, there will be a compile error. However, if you really need to have a reference to the global name, and you're within the same .cpp file as the implementation of that object, you can just do the extern at the function-level. A good example of this is editorinput()/editorrender()/editorlogic() in editor.cpp. In my opinion, they should probably be split off into their own separate file because editor.cpp is getting way too big, but this will do for now.
2020-09-28 04:15:06 +02:00
#endif
Hello WWWWWWorld!
2020-01-01 21:29:24 +01:00
#endif /* MUSIC_H */
Reference in New Issue Copy Permalink