Fix for [#37362] Audio strips sometimes are evaluated incorrectly.
[blender.git] / intern / audaspace / intern / AUD_AnimateableProperty.h
1 /*
2  * ***** BEGIN GPL LICENSE BLOCK *****
3  *
4  * Copyright 2009-2011 Jörg Hermann Müller
5  *
6  * This file is part of AudaSpace.
7  *
8  * Audaspace is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 2 of the License, or
11  * (at your option) any later version.
12  *
13  * AudaSpace is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with Audaspace; if not, write to the Free Software Foundation,
20  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21  *
22  * ***** END GPL LICENSE BLOCK *****
23  */
24
25 /** \file audaspace/intern/AUD_AnimateableProperty.h
26  *  \ingroup audaspaceintern
27  */
28
29
30 #ifndef __AUD_ANIMATEABLEPROPERTY_H__
31 #define __AUD_ANIMATEABLEPROPERTY_H__
32
33 #include "AUD_Buffer.h"
34 #include "AUD_ILockable.h"
35
36 #include <pthread.h>
37 #include <list>
38
39 /**
40  * This class saves animation data for float properties.
41  */
42 class AUD_AnimateableProperty : private AUD_Buffer, public AUD_ILockable
43 {
44 private:
45         struct Unknown {
46                 int start;
47                 int end;
48
49                 Unknown(int start, int end) :
50                         start(start), end(end) {}
51         };
52
53         /// The count of floats for a single property.
54         const int m_count;
55
56         /// Whether the property is animated or not.
57         bool m_isAnimated;
58
59         /// The mutex for locking.
60         pthread_mutex_t m_mutex;
61
62         /// The list of unknown buffer areas.
63         std::list<Unknown> m_unknown;
64
65         // hide copy constructor and operator=
66         AUD_AnimateableProperty(const AUD_AnimateableProperty&);
67         AUD_AnimateableProperty& operator=(const AUD_AnimateableProperty&);
68
69         void updateUnknownCache(int start, int end);
70
71 public:
72         /**
73          * Creates a new animateable property.
74          * \param count The count of floats for a single property.
75          */
76         AUD_AnimateableProperty(int count = 1);
77
78         /**
79          * Destroys the animateable property.
80          */
81         ~AUD_AnimateableProperty();
82
83         /**
84          * Locks the property.
85          */
86         virtual void lock();
87
88         /**
89          * Unlocks the previously locked property.
90          */
91         virtual void unlock();
92
93         /**
94          * Writes the properties value and marks it non-animated.
95          * \param data The new value.
96          */
97         void write(const float* data);
98
99         /**
100          * Writes the properties value and marks it animated.
101          * \param data The new value.
102          * \param position The position in the animation in frames.
103          * \param count The count of frames to write.
104          */
105         void write(const float* data, int position, int count);
106
107         /**
108          * Reads the properties value.
109          * \param position The position in the animation in frames.
110          * \param[out] out Where to write the value to.
111          */
112         void read(float position, float* out);
113
114         /**
115          * Returns whether the property is animated.
116          * \return Whether the property is animated.
117          */
118         bool isAnimated() const;
119 };
120
121 #endif //__AUD_ANIMATEABLEPROPERTY_H__