tmp
[blender.git] / extern / audaspace / include / fx / Loop.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 Loop.h
21  * @ingroup fx
22  * The Loop class.
23  */
24
25 #include "fx/Effect.h"
26
27 AUD_NAMESPACE_BEGIN
28
29 /**
30  * This sound loops another sound.
31  * \note The reader has to be seekable.
32  */
33 class AUD_API Loop : public Effect
34 {
35 private:
36         /**
37          * The loop count.
38          */
39         const int m_loop;
40
41         // delete copy constructor and operator=
42         Loop(const Loop&) = delete;
43         Loop& operator=(const Loop&) = delete;
44
45 public:
46         /**
47          * Creates a new loop sound.
48          * \param sound The input sound.
49          * \param loop The desired loop count, negative values result in endless
50          *        looping.
51          */
52         Loop(std::shared_ptr<ISound> sound, int loop = -1);
53
54         /**
55          * Returns the loop count.
56          */
57         int getLoop() const;
58
59         virtual std::shared_ptr<IReader> createReader();
60 };
61
62 AUD_NAMESPACE_END