Tempo ramps - add method to handle beat-based tempo reordering. clean code.
[ardour.git] / gtk2_ardour / editor_tempodisplay.cc
1 /*
2     Copyright (C) 2002 Paul Davis
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 */
19
20 #ifdef WAF_BUILD
21 #include "gtk2ardour-config.h"
22 #endif
23
24 #include <cstdio> // for sprintf, grrr
25 #include <cstdlib>
26 #include <cmath>
27 #include <string>
28 #include <climits>
29
30 #include "pbd/error.h"
31 #include "pbd/memento_command.h"
32
33 #include <gtkmm2ext/utils.h>
34 #include <gtkmm2ext/gtk_ui.h>
35
36 #include "ardour/session.h"
37 #include "ardour/tempo.h"
38 #include <gtkmm2ext/doi.h>
39 #include <gtkmm2ext/utils.h>
40
41 #include "canvas/canvas.h"
42 #include "canvas/item.h"
43 #include "canvas/line_set.h"
44
45 #include "editor.h"
46 #include "marker.h"
47 #include "tempo_dialog.h"
48 #include "rgb_macros.h"
49 #include "gui_thread.h"
50 #include "time_axis_view.h"
51 #include "tempo_lines.h"
52 #include "ui_config.h"
53
54 #include "i18n.h"
55
56 using namespace std;
57 using namespace ARDOUR;
58 using namespace PBD;
59 using namespace Gtk;
60 using namespace Gtkmm2ext;
61 using namespace Editing;
62
63 void
64 Editor::remove_metric_marks ()
65 {
66         /* don't delete these while handling events, just punt till the GUI is idle */
67
68         for (Marks::iterator x = metric_marks.begin(); x != metric_marks.end(); ++x) {
69                 delete_when_idle (*x);
70         }
71         metric_marks.clear ();
72 }
73
74 void
75 Editor::draw_metric_marks (const Metrics& metrics)
76 {
77
78         const MeterSection *ms;
79         const TempoSection *ts;
80         char buf[64];
81
82         remove_metric_marks ();
83
84         for (Metrics::const_iterator i = metrics.begin(); i != metrics.end(); ++i) {
85
86                 if ((ms = dynamic_cast<const MeterSection*>(*i)) != 0) {
87                         snprintf (buf, sizeof(buf), "%g/%g", ms->divisions_per_bar(), ms->note_divisor ());
88                         metric_marks.push_back (new MeterMarker (*this, *meter_group, UIConfiguration::instance().color ("meter marker"), buf,
89                                                                  *(const_cast<MeterSection*>(ms))));
90                 } else if ((ts = dynamic_cast<const TempoSection*>(*i)) != 0) {
91                         if (UIConfiguration::instance().get_allow_non_quarter_pulse()) {
92                                 snprintf (buf, sizeof (buf), "%.2f/%.0f", ts->beats_per_minute(), ts->note_type());
93                         } else {
94                                 snprintf (buf, sizeof (buf), "%.2f", ts->beats_per_minute());
95                         }
96                         metric_marks.push_back (new TempoMarker (*this, *tempo_group, UIConfiguration::instance().color ("tempo marker"), buf,
97                                                                  *(const_cast<TempoSection*>(ts))));
98                 }
99
100         }
101
102 }
103
104
105 void
106 Editor::tempo_map_changed (const PropertyChange& /*ignored*/)
107 {
108         if (!_session) {
109                 return;
110         }
111
112         ENSURE_GUI_THREAD (*this, &Editor::tempo_map_changed, ignored);
113
114         if (tempo_lines) {
115                 tempo_lines->tempo_map_changed();
116         }
117
118         std::vector<TempoMap::BBTPoint> grid;
119
120         compute_current_bbt_points (grid, leftmost_frame, leftmost_frame + current_page_samples());
121         _session->tempo_map().apply_with_metrics (*this, &Editor::draw_metric_marks); // redraw metric markers
122         draw_measures (grid);
123         update_tempo_based_rulers (grid);
124 }
125
126 void
127 Editor::marker_position_changed ()
128 {
129         if (!_session) {
130                 return;
131         }
132
133         ENSURE_GUI_THREAD (*this, &Editor::tempo_map_changed);
134
135         if (tempo_lines) {
136                 tempo_lines->tempo_map_changed();
137         }
138         TempoMarker* tempo_marker;
139         MeterMarker* meter_marker;
140         const TempoSection *ts;
141         const MeterSection *ms;
142
143         for (Marks::iterator x = metric_marks.begin(); x != metric_marks.end(); ++x) {
144                 if ((tempo_marker = dynamic_cast<TempoMarker*> (*x)) != 0) {
145                         if ((ts = &tempo_marker->tempo()) != 0) {
146                                 tempo_marker->set_position (ts->frame ());
147                         }
148                 }
149                 if ((meter_marker = dynamic_cast<MeterMarker*> (*x)) != 0) {
150                         if ((ms = &meter_marker->meter()) != 0) {
151                                 meter_marker->set_position (ms->frame ());
152                         }
153                 }
154         }
155         std::vector<TempoMap::BBTPoint> grid;
156         compute_current_bbt_points (grid, leftmost_frame, leftmost_frame + current_page_samples());
157         draw_measures (grid);
158         update_tempo_based_rulers (grid);
159 }
160
161 void
162 Editor::redisplay_tempo (bool immediate_redraw)
163 {
164         if (!_session) {
165                 return;
166         }
167
168         if (immediate_redraw) {
169                 std::vector<TempoMap::BBTPoint> grid;
170
171                 compute_current_bbt_points (grid, leftmost_frame, leftmost_frame + current_page_samples());
172                 draw_measures (grid);
173                 update_tempo_based_rulers (grid); // redraw rulers and measure lines
174
175         } else {
176                 Glib::signal_idle().connect (sigc::bind_return (sigc::bind (sigc::mem_fun (*this, &Editor::redisplay_tempo), true), false));
177         }
178 }
179
180 /* computes a grid starting a beat before and ending a beat after leftmost and rightmost respectively */
181 void
182 Editor::compute_current_bbt_points (std::vector<TempoMap::BBTPoint>& grid, framepos_t leftmost, framepos_t rightmost)
183 {
184         if (!_session) {
185                 return;
186         }
187
188         framecnt_t beat_before_lower_pos = _session->tempo_map().frame_at_beat (floor(_session->tempo_map().beat_at_frame (leftmost)));
189         framecnt_t beat_after_upper_pos = _session->tempo_map().frame_at_beat (floor (_session->tempo_map().beat_at_frame (rightmost)) + 1.0);
190
191         /* prevent negative values of leftmost from creeping into tempomap
192          */
193         _session->tempo_map().get_grid (grid, max (beat_before_lower_pos, (framepos_t) 0), beat_after_upper_pos);
194 }
195
196 void
197 Editor::hide_measures ()
198 {
199         if (tempo_lines) {
200                 tempo_lines->hide();
201         }
202 }
203
204 void
205 Editor::draw_measures (std::vector<ARDOUR::TempoMap::BBTPoint>& grid)
206 {
207         if (_session == 0 || _show_measures == false || distance (grid.begin(), grid.end()) == 0) {
208                 return;
209         }
210
211         if (tempo_lines == 0) {
212                 tempo_lines = new TempoLines (time_line_group, ArdourCanvas::LineSet::Vertical);
213         }
214
215         const unsigned divisions = get_grid_beat_divisions(leftmost_frame);
216         tempo_lines->draw (grid, divisions, leftmost_frame, _session->frame_rate());
217 }
218
219 void
220 Editor::mouse_add_new_tempo_event (framepos_t frame)
221 {
222         if (_session == 0) {
223                 return;
224         }
225
226         TempoMap& map(_session->tempo_map());
227         TempoDialog tempo_dialog (map, frame, _("add"));
228
229         //this causes compiz to display no border.
230         //tempo_dialog.signal_realize().connect (sigc::bind (sigc::ptr_fun (set_decoration), &tempo_dialog, Gdk::WMDecoration (Gdk::DECOR_BORDER|Gdk::DECOR_RESIZEH)));
231
232         switch (tempo_dialog.run()) {
233         case RESPONSE_ACCEPT:
234                 break;
235         default:
236                 return;
237         }
238
239         double bpm = 0;
240         Timecode::BBT_Time requested;
241         bpm = tempo_dialog.get_bpm ();
242         double nt = tempo_dialog.get_note_type();
243         bpm = max (0.01, bpm);
244
245         tempo_dialog.get_bbt_time (requested);
246         begin_reversible_command (_("add tempo mark"));
247         XMLNode &before = map.get_state();
248         if (tempo_dialog.get_lock_style() == MusicTime) {
249                 map.add_tempo (Tempo (bpm,nt), map.bbt_to_beats (requested), tempo_dialog.get_tempo_type());
250         } else {
251                 map.add_tempo (Tempo (bpm,nt), frame, tempo_dialog.get_tempo_type());
252         }
253         XMLNode &after = map.get_state();
254         _session->add_command(new MementoCommand<TempoMap>(map, &before, &after));
255         commit_reversible_command ();
256
257         //map.dump (cerr);
258 }
259
260 void
261 Editor::mouse_add_new_meter_event (framepos_t frame)
262 {
263         if (_session == 0) {
264                 return;
265         }
266
267
268         TempoMap& map(_session->tempo_map());
269         MeterDialog meter_dialog (map, frame, _("add"));
270
271         //this causes compiz to display no border..
272         //meter_dialog.signal_realize().connect (sigc::bind (sigc::ptr_fun (set_decoration), &meter_dialog, Gdk::WMDecoration (Gdk::DECOR_BORDER|Gdk::DECOR_RESIZEH)));
273
274         switch (meter_dialog.run ()) {
275         case RESPONSE_ACCEPT:
276                 break;
277         default:
278                 return;
279         }
280
281         double bpb = meter_dialog.get_bpb ();
282         bpb = max (1.0, bpb); // XXX is this a reasonable limit?
283
284         double note_type = meter_dialog.get_note_type ();
285         Timecode::BBT_Time requested;
286
287         meter_dialog.get_bbt_time (requested);
288
289         begin_reversible_command (_("add meter mark"));
290         XMLNode &before = map.get_state();
291         if (meter_dialog.get_lock_style() == MusicTime) {
292                 map.add_meter (Meter (bpb, note_type), map.bbt_to_beats (requested), requested);
293         } else {
294                 map.add_meter (Meter (bpb, note_type), frame, meter_dialog.get_lock_style());
295         }
296         _session->add_command(new MementoCommand<TempoMap>(map, &before, &map.get_state()));
297         commit_reversible_command ();
298
299         //map.dump (cerr);
300 }
301
302 void
303 Editor::remove_tempo_marker (ArdourCanvas::Item* item)
304 {
305         ArdourMarker* marker;
306         TempoMarker* tempo_marker;
307
308         if ((marker = reinterpret_cast<ArdourMarker *> (item->get_data ("marker"))) == 0) {
309                 fatal << _("programming error: tempo marker canvas item has no marker object pointer!") << endmsg;
310                 abort(); /*NOTREACHED*/
311         }
312
313         if ((tempo_marker = dynamic_cast<TempoMarker*> (marker)) == 0) {
314                 fatal << _("programming error: marker for tempo is not a tempo marker!") << endmsg;
315                 abort(); /*NOTREACHED*/
316         }
317
318         if (tempo_marker->tempo().movable()) {
319                 Glib::signal_idle().connect (sigc::bind (sigc::mem_fun(*this, &Editor::real_remove_tempo_marker), &tempo_marker->tempo()));
320         }
321 }
322
323 void
324 Editor::edit_meter_section (MeterSection* section)
325 {
326         MeterDialog meter_dialog (_session->tempo_map(), *section, _("done"));
327
328         switch (meter_dialog.run()) {
329         case RESPONSE_ACCEPT:
330                 break;
331         default:
332                 return;
333         }
334
335         double bpb = meter_dialog.get_bpb ();
336         bpb = max (1.0, bpb); // XXX is this a reasonable limit?
337
338         double const note_type = meter_dialog.get_note_type ();
339         Timecode::BBT_Time when;
340         meter_dialog.get_bbt_time(when);
341         framepos_t const frame = _session->tempo_map().frame_at_beat (_session->tempo_map().bbt_to_beats (when));
342
343         begin_reversible_command (_("replace tempo mark"));
344         XMLNode &before = _session->tempo_map().get_state();
345         if (meter_dialog.get_lock_style() == MusicTime) {
346                 _session->tempo_map().replace_meter (*section, Meter (bpb, note_type), when);
347         } else {
348                 _session->tempo_map().replace_meter (*section, Meter (bpb, note_type), frame);
349         }
350         XMLNode &after = _session->tempo_map().get_state();
351         _session->add_command(new MementoCommand<TempoMap>(_session->tempo_map(), &before, &after));
352         commit_reversible_command ();
353 }
354
355 void
356 Editor::edit_tempo_section (TempoSection* section)
357 {
358         TempoDialog tempo_dialog (_session->tempo_map(), *section, _("done"));
359
360         switch (tempo_dialog.run ()) {
361         case RESPONSE_ACCEPT:
362                 break;
363         default:
364                 return;
365         }
366
367         double bpm = tempo_dialog.get_bpm ();
368         double nt = tempo_dialog.get_note_type ();
369         Timecode::BBT_Time when;
370
371         tempo_dialog.get_bbt_time(when);
372         double const beat = _session->tempo_map().bbt_to_beats (when);
373
374         bpm = max (0.01, bpm);
375
376         begin_reversible_command (_("replace tempo mark"));
377         XMLNode &before = _session->tempo_map().get_state();
378         if (tempo_dialog.get_lock_style() == MusicTime) {
379                 _session->tempo_map().replace_tempo (*section, Tempo (bpm, nt), beat, tempo_dialog.get_tempo_type());
380         } else {
381                 framepos_t const f = _session->tempo_map().compute_new_tempo_frame (section, Tempo (bpm, nt), beat);
382                 _session->tempo_map().replace_tempo (*section, Tempo (bpm, nt), f, tempo_dialog.get_tempo_type());
383         }
384         XMLNode &after = _session->tempo_map().get_state();
385         _session->add_command (new MementoCommand<TempoMap>(_session->tempo_map(), &before, &after));
386         commit_reversible_command ();
387 }
388
389 void
390 Editor::edit_tempo_marker (TempoMarker& tm)
391 {
392         edit_tempo_section (&tm.tempo());
393 }
394
395 void
396 Editor::edit_meter_marker (MeterMarker& mm)
397 {
398         edit_meter_section (&mm.meter());
399 }
400
401 gint
402 Editor::real_remove_tempo_marker (TempoSection *section)
403 {
404         begin_reversible_command (_("remove tempo mark"));
405         XMLNode &before = _session->tempo_map().get_state();
406         _session->tempo_map().remove_tempo (*section, true);
407         XMLNode &after = _session->tempo_map().get_state();
408         _session->add_command(new MementoCommand<TempoMap>(_session->tempo_map(), &before, &after));
409         commit_reversible_command ();
410
411         return FALSE;
412 }
413
414 void
415 Editor::remove_meter_marker (ArdourCanvas::Item* item)
416 {
417         ArdourMarker* marker;
418         MeterMarker* meter_marker;
419
420         if ((marker = reinterpret_cast<ArdourMarker *> (item->get_data ("marker"))) == 0) {
421                 fatal << _("programming error: meter marker canvas item has no marker object pointer!") << endmsg;
422                 abort(); /*NOTREACHED*/
423         }
424
425         if ((meter_marker = dynamic_cast<MeterMarker*> (marker)) == 0) {
426                 fatal << _("programming error: marker for meter is not a meter marker!") << endmsg;
427                 abort(); /*NOTREACHED*/
428         }
429
430         if (meter_marker->meter().movable()) {
431           Glib::signal_idle().connect (sigc::bind (sigc::mem_fun(*this, &Editor::real_remove_meter_marker), &meter_marker->meter()));
432         }
433 }
434
435 gint
436 Editor::real_remove_meter_marker (MeterSection *section)
437 {
438         begin_reversible_command (_("remove tempo mark"));
439         XMLNode &before = _session->tempo_map().get_state();
440         _session->tempo_map().remove_meter (*section, true);
441         XMLNode &after = _session->tempo_map().get_state();
442         _session->add_command(new MementoCommand<TempoMap>(_session->tempo_map(), &before, &after));
443         commit_reversible_command ();
444
445         return FALSE;
446 }