1/**************************************************************************/
2/* audio_effect_capture.h */
3/**************************************************************************/
4/* This file is part of: */
5/* GODOT ENGINE */
6/* https://godotengine.org */
7/**************************************************************************/
8/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
9/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
10/* */
11/* Permission is hereby granted, free of charge, to any person obtaining */
12/* a copy of this software and associated documentation files (the */
13/* "Software"), to deal in the Software without restriction, including */
14/* without limitation the rights to use, copy, modify, merge, publish, */
15/* distribute, sublicense, and/or sell copies of the Software, and to */
16/* permit persons to whom the Software is furnished to do so, subject to */
17/* the following conditions: */
18/* */
19/* The above copyright notice and this permission notice shall be */
20/* included in all copies or substantial portions of the Software. */
21/* */
22/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
23/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
24/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
25/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
26/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
27/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
28/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
29/**************************************************************************/
30
31#ifndef AUDIO_EFFECT_CAPTURE_H
32#define AUDIO_EFFECT_CAPTURE_H
33
34#include "core/config/engine.h"
35#include "core/math/audio_frame.h"
36#include "core/object/ref_counted.h"
37#include "core/templates/ring_buffer.h"
38#include "core/templates/vector.h"
39#include "servers/audio/audio_effect.h"
40#include "servers/audio_server.h"
41
42class AudioEffectCapture;
43
44class AudioEffectCaptureInstance : public AudioEffectInstance {
45 GDCLASS(AudioEffectCaptureInstance, AudioEffectInstance);
46 friend class AudioEffectCapture;
47 Ref<AudioEffectCapture> base;
48
49public:
50 virtual void process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) override;
51 virtual bool process_silence() const override;
52};
53
54class AudioEffectCapture : public AudioEffect {
55 GDCLASS(AudioEffectCapture, AudioEffect)
56 friend class AudioEffectCaptureInstance;
57
58 RingBuffer<AudioFrame> buffer;
59 SafeNumeric<uint64_t> discarded_frames;
60 SafeNumeric<uint64_t> pushed_frames;
61 float buffer_length_seconds = 0.1f;
62 bool buffer_initialized = false;
63
64protected:
65 static void _bind_methods();
66
67public:
68 virtual Ref<AudioEffectInstance> instantiate() override;
69
70 void set_buffer_length(float p_buffer_length_seconds);
71 float get_buffer_length();
72
73 bool can_get_buffer(int p_frames) const;
74 PackedVector2Array get_buffer(int p_len);
75 void clear_buffer();
76
77 int get_frames_available() const;
78 int64_t get_discarded_frames() const;
79 int get_buffer_length_frames() const;
80 int64_t get_pushed_frames() const;
81};
82
83#endif // AUDIO_EFFECT_CAPTURE_H
84