tmp
[blender.git] / extern / audaspace / include / fx / Limiter.h
1 /*******************************************************************************
2  * Copyright 2009-2016 Jörg Müller
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  *   http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  ******************************************************************************/
16
17 #pragma once
18
19 /**
20  * @file Limiter.h
21  * @ingroup fx
22  * The Limiter class.
23  */
24
25 #include "fx/Effect.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 /**
30  * This sound limits another sound in start and end time.
31  */
32 class AUD_API Limiter : public Effect
33 {
34 private:
35         /**
36          * The start time.
37          */
38         const float m_start;
39
40         /**
41          * The end time.
42          */
43         const float m_end;
44
45         // delete copy constructor and operator=
46         Limiter(const Limiter&) = delete;
47         Limiter& operator=(const Limiter&) = delete;
48
49 public:
50         /**
51          * Creates a new limiter sound.
52          * \param sound The input sound.
53          * \param start The desired start time.
54          * \param end The desired end time, a negative value signals that it should
55          *            play to the end.
56          */
57         Limiter(std::shared_ptr<ISound> sound,
58                                            float start = 0, float end = -1);
59
60         /**
61          * Returns the start time.
62          */
63         float getStart() const;
64
65         /**
66          * Returns the end time.
67          */
68         float getEnd() const;
69
70         virtual std::shared_ptr<IReader> createReader();
71 };
72
73 AUD_NAMESPACE_END