godotengine
/
godot
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
godot/servers/audio/effects/audio_effect_record.h

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

107 lines
4.0 KiB
C++
Raw Normal View History

Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
/*************************************************************************/
/* audio_effect_record.h */
/*************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/*************************************************************************/
Update copyright statements to 2022 Happy new year to the wonderful Godot community!
2022-01-03 20:27:34 +00:00
/* Copyright (c) 2007-2022 Juan Linietsky, Ariel Manzur. */
/* Copyright (c) 2014-2022 Godot Engine contributors (cf. AUTHORS.md). */
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.*/
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/*************************************************************************/
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#ifndef AUDIO_EFFECT_RECORD_H
#define AUDIO_EFFECT_RECORD_H
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
Core: Move DirAccess and FileAccess to `core/io` File handling APIs are typically considered part of I/O, and we did have most `FileAccess` implementations in `core/io` already.
2021-06-11 12:51:48 +00:00
#include "core/io/file_access.h"
Make core/ includes absolute, remove subfolders from include path This allows more consistency in the manner we include core headers, where previously there would be a mix of absolute, relative and include path-dependent includes.
2018-09-11 16:13:45 +00:00
#include "core/io/marshalls.h"
#include "core/os/os.h"
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
#include "core/os/thread.h"
Rename AudioStreamSample to a more discoverable name
2022-07-23 14:34:36 +00:00
#include "scene/resources/audio_stream_wav.h"
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
#include "servers/audio/audio_effect.h"
#include "servers/audio_server.h"
class AudioEffectRecord;
class AudioEffectRecordInstance : public AudioEffectInstance {
Made use of semicolons more consitent, fixed formatting
2019-03-19 18:35:57 +00:00
GDCLASS(AudioEffectRecordInstance, AudioEffectInstance);
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
friend class AudioEffectRecord;
Ref<AudioEffectRecord> base;
bool is_recording;
Modernize Thread - Based on C++11's `thread` and `thread_local` - No more need to allocate-deallocate or check for null - No pointer anymore, just a member variable - Platform-specific implementations no longer needed (except for the few cases of non-portable functions) - Simpler for `NO_THREADS` - Thread ids are now the same across platforms (main is 1; others follow)
2021-01-19 12:29:41 +00:00
Thread io_thread;
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
Vector<AudioFrame> ring_buffer;
Vector<float> recording_data;
unsigned int ring_buffer_pos;
unsigned int ring_buffer_mask;
unsigned int ring_buffer_read_pos;
void _io_thread_process();
void _io_store_buffer();
static void _thread_callback(void *_instance);
void _init_recording();
Fix AudioEffectRecord not working without thread support
2018-10-10 13:58:29 +00:00
void _update_buffer();
static void _update(void *userdata);
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
public:
void init();
Fix AudioEffectRecord not working without thread support
2018-10-10 13:58:29 +00:00
void finish();
Add override keywords.
2020-07-10 10:34:39 +00:00
virtual void process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) override;
virtual bool process_silence() const override;
Fix warnings on non-static data member initializers (C++11 feature) We're not formally using C++11 yet so those trigger compilation warnings (at least with GCC 5): ./main/input_default.h:122:30: warning: non-static data member initializers only available with -std=c++11 or -std=gnu++11 CursorShape default_shape = CURSOR_ARROW; ^ Note: We may allow those eventually (especially for non-int static const), but most of current occurrences were inconsistent with all other classes. See also http://www.stroustrup.com/C++11FAQ.html#member-init
2018-09-26 09:22:59 +00:00
Port member initialization from constructor to declaration (C++11) Using `clang-tidy`'s `modernize-use-default-member-init` check and manual review of the changes, and some extra manual changes that `clang-tidy` failed to do. Also went manually through all of `core` to find occurrences that `clang-tidy` couldn't handle, especially all initializations done in a constructor without using initializer lists.
2020-05-12 15:01:17 +00:00
AudioEffectRecordInstance() {}
Fix AudioEffectRecord not working without thread support
2018-10-10 13:58:29 +00:00
~AudioEffectRecordInstance();
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
};
class AudioEffectRecord : public AudioEffect {
Made use of semicolons more consitent, fixed formatting
2019-03-19 18:35:57 +00:00
GDCLASS(AudioEffectRecord, AudioEffect);
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
friend class AudioEffectRecordInstance;
enum {
IO_BUFFER_SIZE_MS = 1500
};
Fix of AudioRecordingEffect property For debug purposes the boolean whether the recording is active or not were an editor property. It has been removed to avoid users leaving it on true on close, causing it to be saved in the default_bus_layout It was also renamed to better describe its functionality related to issue: 20487
2018-07-27 07:41:40 +00:00
bool recording_active;
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
Ref<AudioEffectRecordInstance> current_instance;
Rename AudioStreamSample to a more discoverable name
2022-07-23 14:34:36 +00:00
AudioStreamWAV::Format format;
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
void ensure_thread_stopped();
protected:
static void _bind_methods();
public:
Rename `instance()`->`instantiate()` when it's a verb
2021-06-17 22:03:09 +00:00
Ref<AudioEffectInstance> instantiate() override;
Fix of AudioRecordingEffect property For debug purposes the boolean whether the recording is active or not were an editor property. It has been removed to avoid users leaving it on true on close, causing it to be saved in the default_bus_layout It was also renamed to better describe its functionality related to issue: 20487
2018-07-27 07:41:40 +00:00
void set_recording_active(bool p_record);
bool is_recording_active() const;
Rename AudioStreamSample to a more discoverable name
2022-07-23 14:34:36 +00:00
void set_format(AudioStreamWAV::Format p_format);
AudioStreamWAV::Format get_format() const;
Ref<AudioStreamWAV> get_recording() const;
Audio Recording module Implements an Audio bus effect that outputs the audio from the bus into a wav file Now channels audio recording into an AudioStreamSample instead of saving to wav
2018-01-18 15:03:53 +00:00
AudioEffectRecord();
};
Code quality: Fix header guards consistency Adds `header_guards.sh` bash script, used in CI to validate future changes. Can be run locally to fix invalid header guards.
2022-07-23 21:41:51 +00:00
#endif // AUDIO_EFFECT_RECORD_H