gtk2_ardour/tempo_dialog.cc

   1 /*
   2     Copyright (C) 2000-2007 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 #include <cstdio> // for snprintf, grrr
  21
  22 #include <gtkmm/stock.h>
  23
  24 #include "gtkmm2ext/utils.h"
  25
  26 #include "tempo_dialog.h"
  27 #include "ui_config.h"
  28
  29 #include "i18n.h"
  30
  31 using namespace std;
  32 using namespace Gtk;
  33 using namespace Gtkmm2ext;
  34 using namespace ARDOUR;
  35 using namespace PBD;
  36
  37 TempoDialog::TempoDialog (TempoMap& map, framepos_t frame, const string&)
  38         : ArdourDialog (_("New Tempo"))
  39         , bpm_adjustment (60.0, 1.0, 999.9, 0.1, 1.0)
  40         , bpm_spinner (bpm_adjustment)
  41         , when_bar_label (_("bar:"), ALIGN_LEFT, ALIGN_CENTER)
  42         , when_beat_label (_("beat:"), ALIGN_LEFT, ALIGN_CENTER)
  43         , pulse_selector_label (_("Pulse note"), ALIGN_LEFT, ALIGN_CENTER)
  44         , tap_tempo_button (_("Tap tempo"))
  45 {
  46         Timecode::BBT_Time when;
  47         Tempo tempo (map.tempo_at (frame));
  48         map.bbt_time (frame, when);
  49
  50         init (when, tempo.beats_per_minute(), tempo.note_type(), true);
  51 }
  52
  53 TempoDialog::TempoDialog (TempoSection& section, const string&)
  54         : ArdourDialog (_("Edit Tempo"))
  55         , bpm_adjustment (60.0, 1.0, 999.9, 0.1, 1.0)
  56         , bpm_spinner (bpm_adjustment)
  57         , when_bar_label (_("bar:"), ALIGN_LEFT, ALIGN_CENTER)
  58         , when_beat_label (_("beat:"), ALIGN_LEFT, ALIGN_CENTER)
  59         , pulse_selector_label (_("Pulse note"), ALIGN_LEFT, ALIGN_CENTER)
  60         , tap_tempo_button (_("Tap tempo"))
  61 {
  62         init (section.start(), section.beats_per_minute(), section.note_type(), section.movable());
  63 }
  64
  65 void
  66 TempoDialog::init (const Timecode::BBT_Time& when, double bpm, double note_type, bool movable)
  67 {
  68         vector<string> strings;
  69         NoteTypes::iterator x;
  70
  71         bpm_spinner.set_numeric (true);
  72         bpm_spinner.set_digits (2);
  73         bpm_spinner.set_wrap (true);
  74         bpm_spinner.set_value (bpm);
  75         bpm_spinner.set_alignment (1.0);
  76
  77         note_types.insert (make_pair (_("whole"), 1.0));
  78         strings.push_back (_("whole"));
  79         note_types.insert (make_pair (_("second"), 2.0));
  80         strings.push_back (_("second"));
  81         note_types.insert (make_pair (_("third"), 3.0));
  82         strings.push_back (_("third"));
  83         note_types.insert (make_pair (_("quarter"), 4.0));
  84         strings.push_back (_("quarter"));
  85         note_types.insert (make_pair (_("eighth"), 8.0));
  86         strings.push_back (_("eighth"));
  87         note_types.insert (make_pair (_("sixteenth"), 16.0));
  88         strings.push_back (_("sixteenth"));
  89         note_types.insert (make_pair (_("thirty-second"), 32.0));
  90         strings.push_back (_("thirty-second"));
  91         note_types.insert (make_pair (_("sixty-fourth"), 64.0));
  92         strings.push_back (_("sixty-fourth"));
  93         note_types.insert (make_pair (_("one-hundred-twenty-eighth"), 128.0));
  94         strings.push_back (_("one-hundred-twenty-eighth"));
  95
  96         set_popdown_strings (pulse_selector, strings);
  97
  98         for (x = note_types.begin(); x != note_types.end(); ++x) {
  99                 if (x->second == note_type) {
 100                         pulse_selector.set_active_text (x->first);
 101                         break;
 102                 }
 103         }
 104
 105         if (x == note_types.end()) {
 106                 pulse_selector.set_active_text (strings[3]); // "quarter"
 107         }
 108
 109         strings.clear();
 110
 111         tempo_types.insert (make_pair (_("ramped"), TempoSection::TempoSectionType::Ramp));
 112         strings.push_back (_("ramped"));
 113         tempo_types.insert (make_pair (_("constant"), TempoSection::TempoSectionType::Constant));
 114         strings.push_back (_("constant"));
 115         set_popdown_strings (tempo_type, strings);
 116         tempo_type.set_active_text (strings[0]); // "ramped"
 117
 118         Table* table;
 119
 120         if (UIConfiguration::instance().get_allow_non_quarter_pulse()) {
 121                 table = manage (new Table (5, 6));
 122         } else {
 123                 table = manage (new Table (5, 5));
 124         }
 125
 126         table->set_spacings (6);
 127         table->set_homogeneous (false);
 128
 129         int row;
 130         Label* bpm_label = manage (new Label(_("Beats per minute:"), ALIGN_LEFT, ALIGN_CENTER));
 131         table->attach (*bpm_label, 0, 1, 0, 1);
 132         table->attach (bpm_spinner, 1, 5, 0, 1);
 133
 134         if (UIConfiguration::instance().get_allow_non_quarter_pulse()) {
 135                 table->attach (pulse_selector_label, 0, 1, 1, 2);
 136                 table->attach (pulse_selector, 1, 5, 1, 2);
 137                 row = 2;
 138         } else {
 139                 row = 1;
 140         }
 141
 142         char buf[64];
 143
 144         snprintf (buf, sizeof (buf), "%" PRIu32, when.bars);
 145         when_bar_entry.set_text (buf);
 146         snprintf (buf, sizeof (buf), "%" PRIu32, when.beats);
 147         when_beat_entry.set_text (buf);
 148
 149         if (movable) {
 150                 when_bar_entry.set_width_chars(4);
 151                 when_beat_entry.set_width_chars (4);
 152                 when_bar_entry.set_alignment (1.0);
 153                 when_beat_entry.set_alignment (1.0);
 154
 155                 when_bar_label.set_name ("MetricLabel");
 156                 when_beat_label.set_name ("MetricLabel");
 157
 158                 table->attach (when_bar_label, 1, 2, row, row+1, Gtk::AttachOptions(0), Gtk::AttachOptions(0));
 159                 table->attach (when_bar_entry, 2, 3, row, row+1, Gtk::AttachOptions(0), Gtk::AttachOptions(0));
 160
 161                 table->attach (when_beat_label, 3, 4, row, row+1, Gtk::AttachOptions(0), Gtk::AttachOptions(0));
 162                 table->attach (when_beat_entry, 4, 5, row, row+1, Gtk::AttachOptions(0), Gtk::AttachOptions(0));
 163
 164                 Label* when_label = manage (new Label(_("Tempo begins at"), ALIGN_LEFT, ALIGN_CENTER));
 165                 table->attach (*when_label, 0, 1, row, row+1);
 166         }
 167
 168         Label* tempo_type_label = manage (new Label(_("Tempo Type:"), ALIGN_LEFT, ALIGN_CENTER));
 169         table->attach (*tempo_type_label, 0, 1, row+1, row+2);
 170         table->attach (tempo_type, 1, 2, row+1, row + 2);
 171         get_vbox()->set_border_width (12);
 172         get_vbox()->pack_end (*table);
 173
 174         table->show_all ();
 175
 176         add_button (Stock::CANCEL, RESPONSE_CANCEL);
 177         add_button (Stock::APPLY, RESPONSE_ACCEPT);
 178         set_response_sensitive (RESPONSE_ACCEPT, true);
 179         set_default_response (RESPONSE_ACCEPT);
 180
 181         bpm_spinner.show ();
 182         tap_tempo_button.show ();
 183         get_vbox()->pack_end (tap_tempo_button);
 184         bpm_spinner.grab_focus ();
 185
 186         set_name ("MetricDialog");
 187
 188         bpm_spinner.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &TempoDialog::response), RESPONSE_ACCEPT));
 189         bpm_spinner.signal_button_press_event().connect (sigc::mem_fun (*this, &TempoDialog::bpm_button_press), false);
 190         bpm_spinner.signal_button_release_event().connect (sigc::mem_fun (*this, &TempoDialog::bpm_button_release), false);
 191         bpm_spinner.signal_changed().connect (sigc::mem_fun (*this, &TempoDialog::bpm_changed));
 192         when_bar_entry.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &TempoDialog::response), RESPONSE_ACCEPT));
 193         when_bar_entry.signal_key_release_event().connect (sigc::mem_fun (*this, &TempoDialog::entry_key_release), false);
 194         when_beat_entry.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &TempoDialog::response), RESPONSE_ACCEPT));
 195         when_beat_entry.signal_key_release_event().connect (sigc::mem_fun (*this, &TempoDialog::entry_key_release), false);
 196         pulse_selector.signal_changed().connect (sigc::mem_fun (*this, &TempoDialog::pulse_change));
 197         tap_tempo_button.signal_button_press_event().connect (sigc::mem_fun (*this, &TempoDialog::tap_tempo_button_press), false);
 198         tap_tempo_button.signal_focus_out_event().connect (sigc::mem_fun (*this, &TempoDialog::tap_tempo_focus_out));
 199
 200         tapped = false;
 201 }
 202
 203 bool
 204 TempoDialog::is_user_input_valid() const
 205 {
 206         return (when_beat_entry.get_text() != "")
 207                 && (when_bar_entry.get_text() != "")
 208                 && (when_bar_entry.get_text() != "0");
 209 }
 210
 211 void
 212 TempoDialog::bpm_changed ()
 213 {
 214         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 215 }
 216
 217 bool
 218 TempoDialog::bpm_button_press (GdkEventButton*)
 219 {
 220         return false;
 221 }
 222
 223 bool
 224 TempoDialog::bpm_button_release (GdkEventButton*)
 225 {
 226         /* the value has been modified, accept should work now */
 227
 228         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 229         return false;
 230 }
 231
 232 bool
 233 TempoDialog::entry_key_release (GdkEventKey*)
 234 {
 235         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 236         return false;
 237 }
 238
 239 double
 240 TempoDialog::get_bpm ()
 241 {
 242         return bpm_spinner.get_value ();
 243 }
 244
 245 bool
 246 TempoDialog::get_bbt_time (Timecode::BBT_Time& requested)
 247 {
 248         if (sscanf (when_bar_entry.get_text().c_str(), "%" PRIu32, &requested.bars) != 1) {
 249                 return false;
 250         }
 251
 252         if (sscanf (when_beat_entry.get_text().c_str(), "%" PRIu32, &requested.beats) != 1) {
 253                 return false;
 254         }
 255
 256         requested.ticks = 0;
 257
 258         return true;
 259 }
 260
 261 double
 262 TempoDialog::get_note_type ()
 263 {
 264         NoteTypes::iterator x = note_types.find (pulse_selector.get_active_text());
 265
 266         if (x == note_types.end()) {
 267                 error << string_compose(_("incomprehensible pulse note type (%1)"), pulse_selector.get_active_text()) << endmsg;
 268                 return 0;
 269         }
 270
 271         return x->second;
 272 }
 273
 274 TempoSection::TempoSectionType
 275 TempoDialog::get_tempo_type ()
 276 {
 277         TempoTypes::iterator x = tempo_types.find (tempo_type.get_active_text());
 278
 279         if (x == tempo_types.end()) {
 280                 error << string_compose(_("incomprehensible pulse note type (%1)"), tempo_type.get_active_text()) << endmsg;
 281                 return TempoSection::TempoSectionType::Constant;
 282         }
 283
 284         return x->second;
 285 }
 286
 287 void
 288 TempoDialog::pulse_change ()
 289 {
 290         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 291 }
 292
 293 bool
 294 TempoDialog::tap_tempo_button_press (GdkEventButton *ev)
 295 {
 296         double t;
 297
 298         // Linear least-squares regression
 299         if (tapped) {
 300                 t = 1e-6 * (g_get_monotonic_time () - first_t); // Subtract first_t to avoid precision problems
 301
 302                 double n = tap_count;
 303                 sum_y += t;
 304                 sum_x += n;
 305                 sum_xy += n * t;
 306                 sum_xx += n * n;
 307                 double T = (sum_xy/n - sum_x/n * sum_y/n) / (sum_xx/n - sum_x/n * sum_x/n);
 308
 309                 if (t - last_t < T / 1.2 || t - last_t > T * 1.2) {
 310                         tapped = false;
 311                 } else {
 312                         bpm_spinner.set_value (60.0 / T);
 313                 }
 314         }
 315         if (!tapped) {
 316                 first_t = g_get_monotonic_time ();
 317                 t = 0.0;
 318                 sum_y = 0.0;
 319                 sum_x = 1.0;
 320                 sum_xy = 0.0;
 321                 sum_xx = 1.0;
 322                 tap_count = 1.0;
 323
 324                 tapped = true;
 325         }
 326         tap_count++;
 327         last_t = t;
 328
 329         return true;
 330 }
 331
 332 bool
 333 TempoDialog::tap_tempo_focus_out (GdkEventFocus* )
 334 {
 335         tapped = false;
 336         return false;
 337 }
 338
 339 MeterDialog::MeterDialog (TempoMap& map, framepos_t frame, const string&)
 340         : ArdourDialog (_("New Meter"))
 341 {
 342         Timecode::BBT_Time when;
 343         frame = map.round_to_bar(frame, RoundNearest);
 344         Meter meter (map.meter_at(frame));
 345
 346         map.bbt_time (frame, when);
 347         init (when, meter.divisions_per_bar(), meter.note_divisor(), true);
 348 }
 349
 350 MeterDialog::MeterDialog (MeterSection& section, const string&)
 351         : ArdourDialog (_("Edit Meter"))
 352 {
 353         init (section.start(), section.divisions_per_bar(), section.note_divisor(), section.movable());
 354 }
 355
 356 void
 357 MeterDialog::init (const Timecode::BBT_Time& when, double bpb, double divisor, bool movable)
 358 {
 359         char buf[64];
 360         vector<string> strings;
 361         NoteTypes::iterator x;
 362
 363         snprintf (buf, sizeof (buf), "%.2f", bpb);
 364         bpb_entry.set_text (buf);
 365         bpb_entry.select_region (0, -1);
 366         bpb_entry.set_alignment (1.0);
 367
 368         note_types.insert (make_pair (_("whole"), 1.0));
 369         strings.push_back (_("whole"));
 370         note_types.insert (make_pair (_("second"), 2.0));
 371         strings.push_back (_("second"));
 372         note_types.insert (make_pair (_("third"), 3.0));
 373         strings.push_back (_("third"));
 374         note_types.insert (make_pair (_("quarter"), 4.0));
 375         strings.push_back (_("quarter"));
 376         note_types.insert (make_pair (_("eighth"), 8.0));
 377         strings.push_back (_("eighth"));
 378         note_types.insert (make_pair (_("sixteenth"), 16.0));
 379         strings.push_back (_("sixteenth"));
 380         note_types.insert (make_pair (_("thirty-second"), 32.0));
 381         strings.push_back (_("thirty-second"));
 382         note_types.insert (make_pair (_("sixty-fourth"), 64.0));
 383         strings.push_back (_("sixty-fourth"));
 384         note_types.insert (make_pair (_("one-hundred-twenty-eighth"), 128.0));
 385         strings.push_back (_("one-hundred-twenty-eighth"));
 386
 387         set_popdown_strings (note_type, strings);
 388
 389         for (x = note_types.begin(); x != note_types.end(); ++x) {
 390                 if (x->second == divisor) {
 391                         note_type.set_active_text (x->first);
 392                         break;
 393                 }
 394         }
 395
 396         if (x == note_types.end()) {
 397                 note_type.set_active_text (strings[3]); // "quarter"
 398         }
 399
 400         Label* note_label = manage (new Label (_("Note value:"), ALIGN_LEFT, ALIGN_CENTER));
 401         Label* bpb_label = manage (new Label (_("Beats per bar:"), ALIGN_LEFT, ALIGN_CENTER));
 402         Table* table = manage (new Table (3, 2));
 403         table->set_spacings (6);
 404
 405         table->attach (*bpb_label, 0, 1, 0, 1, FILL|EXPAND, FILL|EXPAND);
 406         table->attach (bpb_entry, 1, 2, 0, 1, FILL|EXPAND, FILL|EXPAND);
 407         table->attach (*note_label, 0, 1, 1, 2, FILL|EXPAND, FILL|EXPAND);
 408         table->attach (note_type, 1, 2, 1, 2, FILL|EXPAND, SHRINK);
 409
 410         snprintf (buf, sizeof (buf), "%" PRIu32, when.bars);
 411         when_bar_entry.set_text (buf);
 412         when_bar_entry.set_alignment (1.0);
 413
 414         if (movable) {
 415                 Label* when_label = manage (new Label(_("Meter begins at bar:"), ALIGN_LEFT, ALIGN_CENTER));
 416
 417                 table->attach (*when_label, 0, 1, 2, 3, FILL | EXPAND, FILL | EXPAND);
 418                 table->attach (when_bar_entry, 1, 2, 2, 3, FILL | EXPAND, FILL | EXPAND);
 419         }
 420
 421         get_vbox()->set_border_width (12);
 422         get_vbox()->pack_start (*table, false, false);
 423
 424         add_button (Stock::CANCEL, RESPONSE_CANCEL);
 425         add_button (Stock::APPLY, RESPONSE_ACCEPT);
 426         set_response_sensitive (RESPONSE_ACCEPT, true);
 427         set_default_response (RESPONSE_ACCEPT);
 428
 429         get_vbox()->show_all ();
 430
 431         set_name ("MetricDialog");
 432         bpb_entry.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &MeterDialog::response), RESPONSE_ACCEPT));
 433         bpb_entry.signal_key_press_event().connect (sigc::mem_fun (*this, &MeterDialog::entry_key_press), false);
 434         bpb_entry.signal_key_release_event().connect (sigc::mem_fun (*this, &MeterDialog::entry_key_release));
 435         when_bar_entry.signal_activate().connect (sigc::bind (sigc::mem_fun (*this, &MeterDialog::response), RESPONSE_ACCEPT));
 436         when_bar_entry.signal_key_press_event().connect (sigc::mem_fun (*this, &MeterDialog::entry_key_press), false);
 437         when_bar_entry.signal_key_release_event().connect (sigc::mem_fun (*this, &MeterDialog::entry_key_release));
 438         note_type.signal_changed().connect (sigc::mem_fun (*this, &MeterDialog::note_type_change));
 439 }
 440
 441 bool
 442 MeterDialog::is_user_input_valid() const
 443 {
 444         return (when_bar_entry.get_text() != "")
 445                 && (when_bar_entry.get_text() != "0")
 446                 && (bpb_entry.get_text() != "");
 447 }
 448
 449 bool
 450 MeterDialog::entry_key_press (GdkEventKey* ev)
 451 {
 452
 453         switch (ev->keyval) {
 454
 455         case GDK_0:
 456         case GDK_1:
 457         case GDK_2:
 458         case GDK_3:
 459         case GDK_4:
 460         case GDK_5:
 461         case GDK_6:
 462         case GDK_7:
 463         case GDK_8:
 464         case GDK_9:
 465         case GDK_KP_0:
 466         case GDK_KP_1:
 467         case GDK_KP_2:
 468         case GDK_KP_3:
 469         case GDK_KP_4:
 470         case GDK_KP_5:
 471         case GDK_KP_6:
 472         case GDK_KP_7:
 473         case GDK_KP_8:
 474         case GDK_KP_9:
 475         case GDK_period:
 476         case GDK_comma:
 477         case  GDK_KP_Delete:
 478         case  GDK_KP_Enter:
 479         case  GDK_Delete:
 480         case  GDK_BackSpace:
 481         case  GDK_Escape:
 482         case  GDK_Return:
 483         case  GDK_Home:
 484         case  GDK_End:
 485         case  GDK_Left:
 486         case  GDK_Right:
 487         case  GDK_Num_Lock:
 488         case  GDK_Tab:
 489                 return FALSE;
 490         default:
 491                 break;
 492         }
 493
 494         return TRUE;
 495 }
 496
 497 bool
 498 MeterDialog::entry_key_release (GdkEventKey*)
 499 {
 500         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 501         return false;
 502 }
 503
 504 void
 505 MeterDialog::note_type_change ()
 506 {
 507         set_response_sensitive (RESPONSE_ACCEPT, is_user_input_valid());
 508 }
 509
 510 double
 511 MeterDialog::get_bpb ()
 512 {
 513         double bpb = 0;
 514
 515         if (sscanf (bpb_entry.get_text().c_str(), "%lf", &bpb) != 1) {
 516                 return 0;
 517         }
 518
 519         return bpb;
 520 }
 521
 522 double
 523 MeterDialog::get_note_type ()
 524 {
 525         NoteTypes::iterator x = note_types.find (note_type.get_active_text());
 526
 527         if (x == note_types.end()) {
 528                 error << string_compose(_("incomprehensible meter note type (%1)"), note_type.get_active_text()) << endmsg;
 529                 return 0;
 530         }
 531
 532         return x->second;
 533 }
 534
 535 bool
 536 MeterDialog::get_bbt_time (Timecode::BBT_Time& requested)
 537 {
 538         if (sscanf (when_bar_entry.get_text().c_str(), "%" PRIu32, &requested.bars) != 1) {
 539                 return false;
 540         }
 541
 542         requested.beats = 1;
 543         requested.ticks = 0;
 544
 545         return true;
 546 }