3d98d23e22cc606baa53168e299c4784fe78a215
[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 #include <cmath>
25 #include <cfloat>
26
27 #include "pbd/debug.h"
28
29 namespace Evoral {
30
31 /** ID of an event (note or other). This must be operable on by glib
32     atomic ops
33 */
34
35 typedef int32_t event_id_t;
36
37 /** Musical time: beats relative to some defined origin */
38 typedef double MusicalTime;
39 const MusicalTime MaxMusicalTime = DBL_MAX;
40 const MusicalTime MinMusicalTime = DBL_MIN;
41
42 static inline bool musical_time_equal (MusicalTime a, MusicalTime b) {
43         /* acceptable tolerance is 1 tick. Nice if there was no magic number here */
44         return fabs (a - b) <= (1.0/1920.0);
45 }
46
47 /** Type of an event (opaque, mapped by application) */
48 typedef uint32_t EventType;
49
50 /** Type to describe a time range */
51 template<typename T>
52 struct Range {
53         Range (T f, T t) : from (f), to (t) {}
54         T from; ///< start of the range
55         T to;   ///< end of the range
56 };
57
58 /** Type to describe the movement of a time range */
59 template<typename T>
60 struct RangeMove {
61         RangeMove (T f, double l, T t) : from (f), length (l), to (t) {}
62         T         from;   ///< start of the range
63         double    length; ///< length of the range
64         T         to;     ///< new start of the range
65 };
66
67 } // namespace Evoral
68
69 namespace PBD {
70         namespace DEBUG {
71                 extern uint64_t Sequence;
72                 extern uint64_t Note;
73         }
74 }
75
76 #endif // EVORAL_TYPES_HPP