Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replace (anonymous) union by std::variant in CSound. #655

Merged
merged 1 commit into from
Apr 22, 2024
Merged

Replace (anonymous) union by std::variant in CSound. #655

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 4 additions & 19 deletions src/include/sound.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,34 +107,19 @@ class CSound : public std::enable_shared_from_this<CSound>
explicit CSound(Key){}
~CSound();

CSound(const CSound &) = delete;
CSound &operator=(const CSound &) = delete;

static std::shared_ptr<CSound> make() { return std::make_shared<CSound>(Key{}); }

/**
** Range is a multiplier for ::DistanceSilent.
** 255 means infinite range of the sound.
*/
unsigned char Range = 0; /// Range is a multiplier for DistanceSilent
unsigned char Number = 0; /// single, group, or table of sounds.
union {
Mix_Chunk *OneSound; /// if it's only a simple sound
Mix_Chunk **OneGroup; /// when it's a simple group
struct {
CSound *First; /// first group: selected sound
CSound *Second; /// second group: annoyed sound
} TwoGroups; /// when it's a double group
} Sound{};
std::variant<std::vector<Mix_Chunk *>, std::pair<CSound *, CSound *>> Sound{};
};

/**
** A possible value for Number in the Sound struct: means a simple sound
*/
#define ONE_SOUND 0
/**
** A possible value for Number in the Sound struct: means a double group (for
** selection/annoyed sounds)
*/
#define TWO_GROUPS 1

/**
** the range value that makes a sound volume distance independent
*/
Expand Down
74 changes: 27 additions & 47 deletions src/sound/sound.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,12 +79,11 @@ int DistanceSilent; /// silent distance
*/
static Mix_Chunk *SimpleChooseSample(const CSound &sound)
{
if (sound.Number == ONE_SOUND) {
return sound.Sound.OneSound;
if (auto* chunks = std::get_if<std::vector<Mix_Chunk *>>(&sound.Sound)) {
Assert(!chunks->empty());
return (*chunks)[FrameCounter % chunks->size()];
} else {
//FIXME: check for errors
//FIXME: valid only in shared memory context (FrameCounter)
return sound.Sound.OneGroup[FrameCounter % sound.Number];
return nullptr;
}
}

Expand All @@ -100,39 +99,37 @@ static Mix_Chunk *ChooseSample(CSound &sound, bool selection, Origin &source)
Mix_Chunk *result = nullptr;
static SelectionHandling SelectionHandler{};

if (sound.Number == TWO_GROUPS) {
if (auto* p = std::get_if<std::pair<CSound *, CSound*>>(&sound.Sound)) {
// handle a special sound (selection)
if (SelectionHandler.Sound != nullptr && (SelectionHandler.Source.Base == source.Base && SelectionHandler.Source.Id == source.Id)) {
if (SelectionHandler.Sound == sound.Sound.TwoGroups.First) {
if (SelectionHandler.Sound == p->first) {
result = SimpleChooseSample(*SelectionHandler.Sound);
SelectionHandler.HowMany++;
if (SelectionHandler.HowMany >= 3) {
SelectionHandler.HowMany = 0;
SelectionHandler.Sound = sound.Sound.TwoGroups.Second;
SelectionHandler.Sound = p->second;
}
} else {
//FIXME: checks for error
// check whether the second group is really a group
if (SelectionHandler.Sound->Number > 1) {
result = SelectionHandler.Sound->Sound.OneGroup[SelectionHandler.HowMany];
SelectionHandler.HowMany++;
if (SelectionHandler.HowMany >= SelectionHandler.Sound->Number) {
SelectionHandler.HowMany = 0;
SelectionHandler.Sound = sound.Sound.TwoGroups.First;
}
} else {
result = SelectionHandler.Sound->Sound.OneSound;
auto *chunks =
std::get_if<std::vector<Mix_Chunk *>>(&SelectionHandler.Sound->Sound);
Assert(SelectionHandler.HowMany < chunks->size());
result = (*chunks)[SelectionHandler.HowMany];
SelectionHandler.HowMany++;
if (SelectionHandler.HowMany >= chunks->size()) {
SelectionHandler.HowMany = 0;
SelectionHandler.Sound = sound.Sound.TwoGroups.First;
SelectionHandler.Sound = p->first;
}
}
} else {
SelectionHandler.Source = source;
SelectionHandler.Sound = sound.Sound.TwoGroups.First;
SelectionHandler.Sound = p->first;
result = SimpleChooseSample(*SelectionHandler.Sound);
SelectionHandler.HowMany = 1;
}
} else {
Assert(std::holds_alternative<std::vector<Mix_Chunk *>>(sound.Sound));
// normal sound/sound group handling
result = SimpleChooseSample(sound);
if (SelectionHandler.Source.Base == source.Base && SelectionHandler.Source.Id == source.Id) {
Expand Down Expand Up @@ -429,23 +426,15 @@ std::shared_ptr<CSound> RegisterSound(const std::vector<std::string> &files)
auto id = CSound::make();
size_t number = files.size();

if (number > 1) { // load a sound group
id->Sound.OneGroup = new Mix_Chunk *[number] {};
id->Number = static_cast<unsigned char>(number);
for (unsigned int i = 0; i < number; ++i) {
id->Sound.OneGroup[i] = LoadSample(files[i]);
if (!id->Sound.OneGroup[i]) {
//delete[] id->Sound.OneGroup;
return nullptr;
}
}
} else { // load a unique sound
id->Sound.OneSound = LoadSample(files[0]);
if (!id->Sound.OneSound) {
std::vector<Mix_Chunk *> chunks(number);
for (unsigned int i = 0; i < number; ++i) {
chunks[i] = LoadSample(files[i]);
if (chunks[i] == nullptr) {
//delete[] id->Sound.OneGroup;
return nullptr;
}
id->Number = ONE_SOUND;
}
id->Sound = std::move(chunks);
id->Range = MAX_SOUND_RANGE;
return id;
}
Expand All @@ -464,9 +453,7 @@ std::shared_ptr<CSound> RegisterTwoGroups(CSound *first, CSound *second)
return nullptr;
}
auto id = CSound::make();
id->Number = TWO_GROUPS;
id->Sound.TwoGroups.First = first;
id->Sound.TwoGroups.Second = second;
id->Sound = std::make_pair(first, second);
id->Range = MAX_SOUND_RANGE;

return id;
Expand Down Expand Up @@ -545,19 +532,12 @@ void InitSoundClient()

CSound::~CSound()
{
if (this->Number == ONE_SOUND) {
if (Sound.OneSound) {
FreeSample(Sound.OneSound);
}
} else if (this->Number == TWO_GROUPS) {
} else {
for (int i = 0; i < this->Number; ++i) {
if (this->Sound.OneGroup[i]) {
FreeSample(this->Sound.OneGroup[i]);
if (auto *chunks = std::get_if<std::vector<Mix_Chunk *>>(&this->Sound)) {
for (auto* chunk : *chunks) {
if (chunk) {
FreeSample(chunk);
}
this->Sound.OneGroup[i] = nullptr;
}
delete[] this->Sound.OneGroup;
}
}

Expand Down
Loading