1/**************************************************************************/
2/* audio_effect_distortion.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_DISTORTION_H
32#define AUDIO_EFFECT_DISTORTION_H
33
34#include "servers/audio/audio_effect.h"
35
36class AudioEffectDistortion;
37
38class AudioEffectDistortionInstance : public AudioEffectInstance {
39 GDCLASS(AudioEffectDistortionInstance, AudioEffectInstance);
40 friend class AudioEffectDistortion;
41 Ref<AudioEffectDistortion> base;
42 float h[2];
43
44public:
45 virtual void process(const AudioFrame *p_src_frames, AudioFrame *p_dst_frames, int p_frame_count) override;
46};
47
48class AudioEffectDistortion : public AudioEffect {
49 GDCLASS(AudioEffectDistortion, AudioEffect);
50
51public:
52 enum Mode {
53 MODE_CLIP,
54 MODE_ATAN,
55 MODE_LOFI,
56 MODE_OVERDRIVE,
57 MODE_WAVESHAPE,
58 };
59
60 friend class AudioEffectDistortionInstance;
61 Mode mode;
62 float pre_gain;
63 float post_gain;
64 float keep_hf_hz;
65 float drive;
66
67protected:
68 static void _bind_methods();
69
70public:
71 Ref<AudioEffectInstance> instantiate() override;
72
73 void set_mode(Mode p_mode);
74 Mode get_mode() const;
75
76 void set_pre_gain(float p_pre_gain);
77 float get_pre_gain() const;
78
79 void set_keep_hf_hz(float p_keep_hf_hz);
80 float get_keep_hf_hz() const;
81
82 void set_drive(float p_drive);
83 float get_drive() const;
84
85 void set_post_gain(float p_post_gain);
86 float get_post_gain() const;
87
88 AudioEffectDistortion();
89};
90
91VARIANT_ENUM_CAST(AudioEffectDistortion::Mode)
92
93#endif // AUDIO_EFFECT_DISTORTION_H
94