1/**************************************************************************/
2/* audio_effect_limiter.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_LIMITER_H
32#define AUDIO_EFFECT_LIMITER_H
33
34#include "servers/audio/audio_effect.h"
35
36class AudioEffectLimiter;
37
38class AudioEffectLimiterInstance : public AudioEffectInstance {
39 GDCLASS(AudioEffectLimiterInstance, AudioEffectInstance);
40 friend class AudioEffectLimiter;
41 Ref<AudioEffectLimiter> base;
42
43 float mix_volume_db;
44
45public:
46 virtual void process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) override;
47};
48
49class AudioEffectLimiter : public AudioEffect {
50 GDCLASS(AudioEffectLimiter, AudioEffect);
51
52 friend class AudioEffectLimiterInstance;
53 float threshold;
54 float ceiling;
55 float soft_clip;
56 float soft_clip_ratio;
57
58protected:
59 static void _bind_methods();
60
61public:
62 void set_threshold_db(float p_threshold);
63 float get_threshold_db() const;
64
65 void set_ceiling_db(float p_ceiling);
66 float get_ceiling_db() const;
67
68 void set_soft_clip_db(float p_soft_clip);
69 float get_soft_clip_db() const;
70
71 void set_soft_clip_ratio(float p_soft_clip);
72 float get_soft_clip_ratio() const;
73
74 Ref<AudioEffectInstance> instantiate() override;
75
76 AudioEffectLimiter();
77};
78
79#endif // AUDIO_EFFECT_LIMITER_H
80