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

Jump to bottom

Fix AudioEffectRecord circular reference #74985

Merged
merged 1 commit into from
Jun 20, 2023
+20 −26
Merged

Fix AudioEffectRecord circular reference #74985

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
39 changes: 19 additions & 20 deletions servers/audio/effects/audio_effect_record.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,13 +72,7 @@ bool AudioEffectRecordInstance::process_silence() const {

void AudioEffectRecordInstance::_io_thread_process() {
while (is_recording) {
//Check: The current recording has been requested to stop
if (!base->recording_active) {
is_recording = false;
}

_update_buffer();

if (is_recording) {
//Wait to avoid too much busy-wait
OS::get_singleton()->delay_usec(500);
Expand Down Expand Up @@ -120,19 +114,15 @@ void AudioEffectRecordInstance::init() {
}

void AudioEffectRecordInstance::finish() {
is_recording = false;
if (io_thread.is_started()) {
io_thread.wait_to_finish();
}
}

AudioEffectRecordInstance::~AudioEffectRecordInstance() {
finish();
}

Ref<AudioEffectInstance> AudioEffectRecord::instantiate() {
Ref<AudioEffectRecordInstance> ins;
ins.instantiate();
ins->base = Ref<AudioEffectRecord>(this);
ins->is_recording = false;

//Re-using the buffer size calculations from audio_effect_delay.cpp
Expand All @@ -158,16 +148,19 @@ Ref<AudioEffectInstance> AudioEffectRecord::instantiate() {
ins->ring_buffer_read_pos = 0;

ensure_thread_stopped();
current_instance = ins;
if (recording_active) {
bool is_currently_recording = false;
if (current_instance != nullptr) {
is_currently_recording = current_instance->is_recording;
}
if (is_currently_recording) {
ins->init();
}
current_instance = ins;

return ins;
}

void AudioEffectRecord::ensure_thread_stopped() {
recording_active = false;
if (current_instance != nullptr) {
current_instance->finish();
}
Expand All @@ -177,20 +170,23 @@ void AudioEffectRecord::set_recording_active(bool p_record) {
if (p_record) {
if (current_instance == nullptr) {
WARN_PRINT("Recording should not be set as active before Godot has initialized.");
recording_active = false;
return;
}

ensure_thread_stopped();
recording_active = true;
current_instance->init();
} else {
recording_active = false;
if (current_instance != nullptr) {
current_instance->is_recording = false;
}
}
}

bool AudioEffectRecord::is_recording_active() const {
return recording_active;
if (current_instance == nullptr) {
return false;
} else {
return current_instance->is_recording;
}
}

void AudioEffectRecord::set_format(AudioStreamWAV::Format p_format) {
Expand Down Expand Up @@ -292,5 +288,8 @@ void AudioEffectRecord::_bind_methods() {

AudioEffectRecord::AudioEffectRecord() {
format = AudioStreamWAV::FORMAT_16_BITS;
recording_active = false;
}

AudioEffectRecord::~AudioEffectRecord() {
ensure_thread_stopped();
}
7 changes: 1 addition & 6 deletions servers/audio/effects/audio_effect_record.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,6 @@ class AudioEffectRecord;
class AudioEffectRecordInstance : public AudioEffectInstance {
GDCLASS(AudioEffectRecordInstance, AudioEffectInstance);
friend class AudioEffectRecord;
Ref<AudioEffectRecord> base;

bool is_recording;
Thread io_thread;
Expand All @@ -68,9 +67,6 @@ class AudioEffectRecordInstance : public AudioEffectInstance {
void finish();
virtual void process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) override;
virtual bool process_silence() const override;

AudioEffectRecordInstance() {}
~AudioEffectRecordInstance();
};

class AudioEffectRecord : public AudioEffect {
Expand All @@ -82,7 +78,6 @@ class AudioEffectRecord : public AudioEffect {
IO_BUFFER_SIZE_MS = 1500
};

bool recording_active;
Ref<AudioEffectRecordInstance> current_instance;

AudioStreamWAV::Format format;
Expand All @@ -99,8 +94,8 @@ class AudioEffectRecord : public AudioEffect {
void set_format(AudioStreamWAV::Format p_format);
AudioStreamWAV::Format get_format() const;
Ref<AudioStreamWAV> get_recording() const;

AudioEffectRecord();
~AudioEffectRecord();
};

#endif // AUDIO_EFFECT_RECORD_H