* added a bit of documentation in an effort to understand the code
[ardour.git] / libs / evoral / evoral / types.hpp
1 /* This file is part of Evoral.
2  * Copyright (C) 2008 Dave Robillard <http://drobilla.net>
3  * Copyright (C) 2000-2008 Paul Davis
4  * 
5  * Evoral is free software; you can redistribute it and/or modify it under the
6  * terms of the GNU General Public License as published by the Free Software
7  * Foundation; either version 2 of the License, or (at your option) any later
8  * version.
9  * 
10  * Evoral is distributed in the hope that it will be useful, but WITHOUT ANY
11  * WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
12  * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for details.
13  * 
14  * You should have received a copy of the GNU General Public License along
15  * with this program; if not, write to the Free Software Foundation, Inc.,
16  * 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  */
18
19 #ifndef EVORAL_TYPES_HPP
20 #define EVORAL_TYPES_HPP
21
22 #include <stdint.h>
23 #include <list>
24
25 namespace Evoral {
26
27 /** Frame count (i.e. length of time in audio frames) */
28 typedef uint32_t FrameTime;
29
30 /** Time-stamp of an event */
31 typedef double timestamp_t;
32
33 /** Duration of time in timestamp_t units */
34 typedef timestamp_t timedur_t;
35
36 /** Time stamp of an event */
37 typedef double EventTime;
38
39 /** Time stamp of an event */
40 typedef double EventLength;
41
42 /** Type of an event (opaque, mapped by application) */
43 typedef uint32_t EventType;
44
45 /** Type to describe the movement of a time range */    
46 struct RangeMove {
47         RangeMove (EventTime f, FrameTime l, EventTime t) : from (f), length (l), to (t) {}
48         EventTime from;   ///< start of the range
49         FrameTime length; ///< length of the range
50         EventTime to;     ///< new start of the range
51 };
52
53 typedef std::list<RangeMove> RangeMoveList;
54
55 } // namespace Evoral
56
57 #endif // EVORAL_TYPES_HPP