tmp
[blender.git] / extern / audaspace / include / fx / MutableReader.h
1 /*******************************************************************************
2 * Copyright 2015-2016 Juan Francisco Crespo Gal├ín
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 MutableReader.h
21 * @ingroup fx
22 * The MutableReader class.
23 */
24
25 #include "IReader.h"
26 #include "ISound.h"
27
28 #include <memory>
29
30 AUD_NAMESPACE_BEGIN
31
32 /**
33 * This class represents a reader for a sound that can change with each playback. The change will occur when trying to seek backwards
34 * If the sound doesn't support that, it will be restarted.
35 * \warning Notice that if a SoundList object is assigned to several MutableReaders, sequential playback won't work correctly.
36 *          To prevent this the SoundList must be copied.
37 */
38 class AUD_API MutableReader : public IReader
39 {
40 private:
41         /**
42         * The current reader.
43         */
44         std::shared_ptr<IReader> m_reader;
45
46         /**
47         * A sound from which to get the reader.
48         */
49         std::shared_ptr<ISound> m_sound;
50
51
52         // delete copy constructor and operator=
53         MutableReader(const MutableReader&) = delete;
54         MutableReader& operator=(const MutableReader&) = delete;
55
56 public:
57         /**
58         * Creates a new mutable reader.
59         * \param sound A of sound you want to assign to this reader.
60         */
61         MutableReader(std::shared_ptr<ISound> sound);
62
63         virtual bool isSeekable() const;
64         virtual void seek(int position);
65         virtual int getLength() const;
66         virtual int getPosition() const;
67         virtual Specs getSpecs() const;
68         virtual void read(int& length, bool& eos, sample_t* buffer);
69 };
70
71 AUD_NAMESPACE_END