3D Audio GSoC:
[blender.git] / intern / audaspace / intern / AUD_SequencerHandle.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/intern/AUD_SequencerHandle.h
28  *  \ingroup audaspaceintern
29  */
30
31
32 #ifndef AUD_SEQUENCERHANDLE
33 #define AUD_SEQUENCERHANDLE
34
35 #include "AUD_SequencerEntry.h"
36 #include "AUD_IHandle.h"
37 #include "AUD_I3DHandle.h"
38
39 class AUD_ReadDevice;
40
41 /**
42  * Represents a playing sequenced entry.
43  */
44 class AUD_SequencerHandle
45 {
46 private:
47         /// The entry this handle belongs to.
48         AUD_Reference<AUD_SequencerEntry> m_entry;
49
50         /// The handle in the read device.
51         AUD_Reference<AUD_IHandle> m_handle;
52
53         /// The 3D handle in the read device.
54         AUD_Reference<AUD_I3DHandle> m_3dhandle;
55
56         /// The last read status from the entry.
57         int m_status;
58
59         /// The last position status from the entry.
60         int m_pos_status;
61
62         /// The last sound status from the entry.
63         int m_sound_status;
64
65         /// The read device this handle is played on.
66         AUD_ReadDevice& m_device;
67
68 public:
69         /**
70          * Creates a new sequenced handle.
71          * \param entry The entry this handle plays.
72          * \param device The read device to play on.
73          */
74         AUD_SequencerHandle(AUD_Reference<AUD_SequencerEntry> entry, AUD_ReadDevice& device);
75
76         /**
77          * Destroys the handle.
78          */
79         ~AUD_SequencerHandle();
80
81         /**
82          * Compares whether this handle is playing the same entry as supplied.
83          * \param entry The entry to compare to.
84          * \return Whether the entries ID is smaller, equal or bigger.
85          */
86         int compare(AUD_Reference<AUD_SequencerEntry> entry) const;
87
88         /**
89          * Stops playing back the handle.
90          */
91         void stop();
92
93         /**
94          * Updates the handle for playback.
95          * \param position The current time during playback.
96          * \param frame The current frame during playback.
97          */
98         void update(float position, float frame);
99
100         /**
101          * Seeks the handle to a specific time position.
102          * \param position The time to seek to.
103          */
104         void seek(float position);
105 };
106
107 #endif //AUD_SEQUENCERHANDLE