Merging with trunk up to r38631.
[blender.git] / intern / audaspace / FX / AUD_SuperposeReader.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * Copyright 2009-2011 Jörg Hermann Müller
7  *
8  * This file is part of AudaSpace.
9  *
10  * Audaspace is free software; you can redistribute it and/or modify
11  * it under the terms of the GNU General Public License as published by
12  * the Free Software Foundation; either version 2 of the License, or
13  * (at your option) any later version.
14  *
15  * AudaSpace is distributed in the hope that it will be useful,
16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18  * GNU General Public License for more details.
19  *
20  * You should have received a copy of the GNU General Public License
21  * along with Audaspace; if not, write to the Free Software Foundation,
22  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23  *
24  * ***** END GPL LICENSE BLOCK *****
25  */
26
27 /** \file audaspace/FX/AUD_SuperposeReader.h
28  *  \ingroup audfx
29  */
30
31
32 #ifndef AUD_SUPERPOSEREADER
33 #define AUD_SUPERPOSEREADER
34
35 #include "AUD_IReader.h"
36 #include "AUD_Buffer.h"
37 #include "AUD_Reference.h"
38
39 /**
40  * This reader plays two readers with the same specs sequently.
41  */
42 class AUD_SuperposeReader : public AUD_IReader
43 {
44 private:
45         /**
46          * The first reader.
47          */
48         AUD_Reference<AUD_IReader> m_reader1;
49
50         /**
51          * The second reader.
52          */
53         AUD_Reference<AUD_IReader> m_reader2;
54
55         /**
56          * The playback buffer for the intersecting part.
57          */
58         AUD_Buffer m_buffer;
59
60         // hide copy constructor and operator=
61         AUD_SuperposeReader(const AUD_SuperposeReader&);
62         AUD_SuperposeReader& operator=(const AUD_SuperposeReader&);
63
64 public:
65         /**
66          * Creates a new superpose reader.
67          * \param reader1 The first reader to read from.
68          * \param reader2 The second reader to read from.
69          * \exception AUD_Exception Thrown if the specs from the readers differ.
70          */
71         AUD_SuperposeReader(AUD_Reference<AUD_IReader> reader1, AUD_Reference<AUD_IReader> reader2);
72
73         /**
74          * Destroys the reader.
75          */
76         virtual ~AUD_SuperposeReader();
77
78         virtual bool isSeekable() const;
79         virtual void seek(int position);
80         virtual int getLength() const;
81         virtual int getPosition() const;
82         virtual AUD_Specs getSpecs() const;
83         virtual void read(int& length, bool& eos, sample_t* buffer);
84 };
85
86 #endif //AUD_SUPERPOSEREADER