remove some 1920 tick constants and leave notes for some others.
[ardour.git] / libs / evoral / evoral / types.hpp
1 /* This file is part of Evoral.
2  * Copyright (C) 2008 David 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 #include "evoral/visibility.h"
30
31 namespace Evoral {
32
33 /** ID of an event (note or other). This must be operable on by glib
34     atomic ops
35 */
36 typedef int32_t event_id_t;
37
38 /** Musical time: beats relative to some defined origin */
39 typedef double MusicalTime;
40
41 const MusicalTime MaxMusicalTime = DBL_MAX;
42 const MusicalTime MinMusicalTime = DBL_MIN;
43
44 static inline bool musical_time_equal (MusicalTime a, MusicalTime b) {
45         /* acceptable tolerance is 1 tick. Nice if there was no magic number here
46          * -> Timecode::BBT_Time::ticks_per_beat */
47         return fabs (a - b) <= (1.0/1920.0);
48 }
49
50 static inline bool musical_time_less_than (MusicalTime a, MusicalTime b) {
51         /* acceptable tolerance is 1 tick. Nice if there was no magic number here */
52         if (fabs (a - b) <= (1.0/1920.0)) {
53                 return false; /* effectively identical */
54         } else {
55                 return a < b;
56         }
57 }
58
59 static inline bool musical_time_greater_than (MusicalTime a, MusicalTime b) {
60         /* acceptable tolerance is 1 tick. Nice if there was no magic number here */
61         if (fabs (a - b) <= (1.0/1920.0)) {
62                 return false; /* effectively identical */
63         } else {
64                 return a > b;
65         }
66 }
67
68 static inline bool musical_time_greater_or_equal_to (MusicalTime a, MusicalTime b) {
69         /* acceptable tolerance is 1 tick. Nice if there was no magic number here */
70         if (fabs (a - b) <= (1.0/1920.0)) {
71                 return true; /* effectively identical, note the "or_equal_to" */
72         } else {
73                 return a >= b;
74         }
75 }
76
77 /** Type of an event (opaque, mapped by application) */
78 typedef uint32_t EventType;
79
80 } // namespace Evoral
81
82 namespace PBD {
83         namespace DEBUG {
84                 LIBEVORAL_API extern uint64_t Sequence;
85                 LIBEVORAL_API extern uint64_t Note;
86                 LIBEVORAL_API extern uint64_t ControlList;
87         }
88 }
89
90 #endif // EVORAL_TYPES_HPP