xref: /aosp_15_r20/external/oboe/src/flowgraph/ClipToRange.h (revision 05767d913155b055644481607e6fa1e35e2fe72c)
1*05767d91SRobert Wu /*
2*05767d91SRobert Wu  * Copyright 2015 The Android Open Source Project
3*05767d91SRobert Wu  *
4*05767d91SRobert Wu  * Licensed under the Apache License, Version 2.0 (the "License");
5*05767d91SRobert Wu  * you may not use this file except in compliance with the License.
6*05767d91SRobert Wu  * You may obtain a copy of the License at
7*05767d91SRobert Wu  *
8*05767d91SRobert Wu  *      http://www.apache.org/licenses/LICENSE-2.0
9*05767d91SRobert Wu  *
10*05767d91SRobert Wu  * Unless required by applicable law or agreed to in writing, software
11*05767d91SRobert Wu  * distributed under the License is distributed on an "AS IS" BASIS,
12*05767d91SRobert Wu  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13*05767d91SRobert Wu  * See the License for the specific language governing permissions and
14*05767d91SRobert Wu  * limitations under the License.
15*05767d91SRobert Wu  */
16*05767d91SRobert Wu 
17*05767d91SRobert Wu #ifndef FLOWGRAPH_CLIP_TO_RANGE_H
18*05767d91SRobert Wu #define FLOWGRAPH_CLIP_TO_RANGE_H
19*05767d91SRobert Wu 
20*05767d91SRobert Wu #include <atomic>
21*05767d91SRobert Wu #include <unistd.h>
22*05767d91SRobert Wu #include <sys/types.h>
23*05767d91SRobert Wu 
24*05767d91SRobert Wu #include "FlowGraphNode.h"
25*05767d91SRobert Wu 
26*05767d91SRobert Wu namespace FLOWGRAPH_OUTER_NAMESPACE::flowgraph {
27*05767d91SRobert Wu 
28*05767d91SRobert Wu // This is 3 dB, (10^(3/20)), to match the maximum headroom in AudioTrack for float data.
29*05767d91SRobert Wu // It is designed to allow occasional transient peaks.
30*05767d91SRobert Wu constexpr float kDefaultMaxHeadroom = 1.41253754f;
31*05767d91SRobert Wu constexpr float kDefaultMinHeadroom = -kDefaultMaxHeadroom;
32*05767d91SRobert Wu 
33*05767d91SRobert Wu class ClipToRange : public FlowGraphFilter {
34*05767d91SRobert Wu public:
35*05767d91SRobert Wu     explicit ClipToRange(int32_t channelCount);
36*05767d91SRobert Wu 
37*05767d91SRobert Wu     virtual ~ClipToRange() = default;
38*05767d91SRobert Wu 
39*05767d91SRobert Wu     int32_t onProcess(int32_t numFrames) override;
40*05767d91SRobert Wu 
setMinimum(float min)41*05767d91SRobert Wu     void setMinimum(float min) {
42*05767d91SRobert Wu         mMinimum = min;
43*05767d91SRobert Wu     }
44*05767d91SRobert Wu 
getMinimum()45*05767d91SRobert Wu     float getMinimum() const {
46*05767d91SRobert Wu         return mMinimum;
47*05767d91SRobert Wu     }
48*05767d91SRobert Wu 
setMaximum(float min)49*05767d91SRobert Wu     void setMaximum(float min) {
50*05767d91SRobert Wu         mMaximum = min;
51*05767d91SRobert Wu     }
52*05767d91SRobert Wu 
getMaximum()53*05767d91SRobert Wu     float getMaximum() const {
54*05767d91SRobert Wu         return mMaximum;
55*05767d91SRobert Wu     }
56*05767d91SRobert Wu 
getName()57*05767d91SRobert Wu     const char *getName() override {
58*05767d91SRobert Wu         return "ClipToRange";
59*05767d91SRobert Wu     }
60*05767d91SRobert Wu 
61*05767d91SRobert Wu private:
62*05767d91SRobert Wu     float mMinimum = kDefaultMinHeadroom;
63*05767d91SRobert Wu     float mMaximum = kDefaultMaxHeadroom;
64*05767d91SRobert Wu };
65*05767d91SRobert Wu 
66*05767d91SRobert Wu } /* namespace FLOWGRAPH_OUTER_NAMESPACE::flowgraph */
67*05767d91SRobert Wu 
68*05767d91SRobert Wu #endif //FLOWGRAPH_CLIP_TO_RANGE_H
69