Use DEBUG_TRACE for all of the MIDI clock ticker code.
[ardour.git] / libs / ardour / ticker.cc
1 /*
2     Copyright (C) 2008 Hans Baier
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18     $Id$
19 */
20
21 #include "midi++/port.h"
22 #include "midi++/manager.h"
23 #include "evoral/midi_events.h"
24 #include "ardour/ticker.h"
25 #include "ardour/session.h"
26 #include "ardour/tempo.h"
27 #include "ardour/debug.h"
28
29 using namespace ARDOUR;
30
31 void Ticker::set_session (Session* s)
32 {
33         SessionHandlePtr::set_session (s);
34
35         if (_session) {
36                 _session->tick.connect_same_thread (_session_connections, boost::bind (&Ticker::tick, this, _1, _2, _3));
37         }
38 }
39
40 void MidiClockTicker::set_session (Session* s)
41 {
42          Ticker::set_session (s);
43
44          if (_session) {
45                  _session->TransportStateChange.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_state_changed, this));
46                  _session->PositionChanged.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::position_changed, this, _1));
47                  _session->TransportLooped.connect_same_thread (_session_connections, boost::bind (&MidiClockTicker::transport_looped, this));
48                  update_midi_clock_port();
49          }
50 }
51
52 void
53 MidiClockTicker::session_going_away ()
54 {
55         SessionHandlePtr::session_going_away(); 
56         _midi_port = 0; 
57 }
58
59 void MidiClockTicker::update_midi_clock_port()
60 {
61         _midi_port = MIDI::Manager::instance()->midi_clock_output_port();
62 }
63
64 void MidiClockTicker::transport_state_changed()
65 {
66         if (_session->exporting()) {
67                 /* no midi clock during export, for now */
68                 return;
69         }
70
71         float      speed    = _session->transport_speed();
72         framepos_t position = _session->transport_frame();
73
74         DEBUG_TRACE (PBD::DEBUG::MidiClock,
75                      string_compose ("Transport state change, speed: %1 position: %2 play loop: %3\n", speed, position, _session->get_play_loop())
76                 );
77         
78         if (speed == 1.0f) {
79                 _last_tick = position;
80
81                 if (!Config->get_send_midi_clock())
82                         return;
83
84                 if (_session->get_play_loop()) {
85                         assert(_session->locations()->auto_loop_location());
86                         if (position == _session->locations()->auto_loop_location()->start()) {
87                                 send_start_event(0);
88                         } else {
89                                 send_continue_event(0);
90                         }
91                 } else if (position == 0) {
92                         send_start_event(0);
93                 } else {
94                         send_continue_event(0);
95                 }
96
97                 send_midi_clock_event(0);
98
99         } else if (speed == 0.0f) {
100                 if (!Config->get_send_midi_clock())
101                         return;
102
103                 send_stop_event(0);
104         }
105
106         tick(position, *((ARDOUR::BBT_Time *) 0), *((Timecode::Time *)0));
107 }
108
109 void MidiClockTicker::position_changed (framepos_t position)
110 {
111         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Position change: %1\n", position));
112
113         _last_tick = position;
114 }
115
116 void MidiClockTicker::transport_looped()
117 {
118         Location* loop_location = _session->locations()->auto_loop_location();
119         assert(loop_location);
120
121         DEBUG_TRACE (PBD::DEBUG::MidiClock,
122                      string_compose ("Transport looped, position: %1, loop start: %2, loop end: %3, play loop: %4\n",
123                                      _session->transport_frame(), loop_location->start(), loop_location->end(), _session->get_play_loop())
124                 );
125
126         // adjust _last_tick, so that the next MIDI clock message is sent
127         // in due time (and the tick interval is still constant)
128         framecnt_t elapsed_since_last_tick = loop_location->end() - _last_tick;
129         _last_tick = loop_location->start() - elapsed_since_last_tick;
130 }
131
132 void MidiClockTicker::tick (const framepos_t& transport_frames, const BBT_Time& /*transport_bbt*/, const Timecode::Time& /*transport_smpt*/)
133 {
134         if (!Config->get_send_midi_clock() || _session == 0 || _session->transport_speed() != 1.0f || _midi_port == 0)
135                 return;
136
137         while (true) {
138                 double next_tick = _last_tick + one_ppqn_in_frames(transport_frames);
139                 framecnt_t next_tick_offset = framecnt_t(next_tick) - transport_frames;
140
141                 DEBUG_TRACE (PBD::DEBUG::MidiClock,
142                              string_compose ("Transport: %1, last tick time: %2, next tick time: %3, offset: %4, cycle length: %5\n",
143                                              transport_frames, _last_tick, next_tick, next_tick_offset, _midi_port->nframes_this_cycle()
144                                      )
145                         );
146
147                 if (next_tick_offset >= _midi_port->nframes_this_cycle())
148                         return;
149
150                 send_midi_clock_event(next_tick_offset);
151
152                 _last_tick = next_tick;
153         }
154 }
155
156 double MidiClockTicker::one_ppqn_in_frames (framepos_t transport_position)
157 {
158         const Tempo& current_tempo = _session->tempo_map().tempo_at(transport_position);
159         const Meter& current_meter = _session->tempo_map().meter_at(transport_position);
160         double frames_per_beat =
161                 current_tempo.frames_per_beat(_session->nominal_frame_rate(),
162                                               current_meter);
163
164         double quarter_notes_per_beat = 4.0 / current_tempo.note_type();
165         double frames_per_quarter_note = frames_per_beat / quarter_notes_per_beat;
166
167         return frames_per_quarter_note / double (_ppqn);
168 }
169
170 void MidiClockTicker::send_midi_clock_event (pframes_t offset)
171 {
172         if (!_midi_port) {
173                 return;
174         }
175
176         DEBUG_TRACE (PBD::DEBUG::MidiClock, string_compose ("Tick with offset %1\n", offset));
177
178         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CLOCK };
179         _midi_port->write (_midi_clock_tick, 1, offset);
180 }
181
182 void MidiClockTicker::send_start_event (pframes_t offset)
183 {
184         if (!_midi_port) {
185                 return;
186         }
187         
188         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_START };
189         _midi_port->write (_midi_clock_tick, 1, offset);
190 }
191
192 void MidiClockTicker::send_continue_event (pframes_t offset)
193 {
194         if (!_midi_port) {
195                 return;
196         }
197         
198         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_CONTINUE };
199         _midi_port->write (_midi_clock_tick, 1, offset);
200 }
201
202 void MidiClockTicker::send_stop_event (pframes_t offset)
203 {
204         if (!_midi_port) {
205                 return;
206         }
207         
208         static uint8_t _midi_clock_tick[1] = { MIDI_CMD_COMMON_STOP };
209         _midi_port->write (_midi_clock_tick, 1, offset);
210 }
211
212
213