gtk2_ardour/step_editor.cc

   1 /*
   2     Copyright (C) 2012 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 "ardour/midi_track.h"
  21 #include "ardour/midi_region.h"
  22 #include "ardour/tempo.h"
  23 #include "ardour/types.h"
  24
  25 #include "gui_thread.h"
  26 #include "midi_region_view.h"
  27 #include "public_editor.h"
  28 #include "step_editor.h"
  29 #include "step_entry.h"
  30
  31 using namespace ARDOUR;
  32 using namespace Gtk;
  33 using namespace std;
  34
  35 StepEditor::StepEditor (PublicEditor& e, boost::shared_ptr<MidiTrack> t, MidiTimeAxisView& mtv)
  36         : _editor (e)
  37         , _track (t)
  38         , step_editor (0)
  39         , _mtv (mtv)
  40 {
  41         step_edit_insert_position = 0;
  42         _step_edit_triplet_countdown = 0;
  43         _step_edit_within_chord = 0;
  44         _step_edit_chord_duration = Evoral::Beats();
  45         step_edit_region_view = 0;
  46
  47         _track->PlaylistChanged.connect (*this, invalidator (*this),
  48                                          boost::bind (&StepEditor::playlist_changed, this),
  49                                          gui_context());
  50         playlist_changed ();
  51 }
  52
  53 StepEditor::~StepEditor()
  54 {
  55         delete step_editor;
  56 }
  57
  58 void
  59 StepEditor::start_step_editing ()
  60 {
  61         _step_edit_triplet_countdown = 0;
  62         _step_edit_within_chord = 0;
  63         _step_edit_chord_duration = Evoral::Beats();
  64         step_edit_region.reset ();
  65         step_edit_region_view = 0;
  66         last_added_pitch = -1;
  67         last_added_end = Evoral::Beats();
  68
  69         resync_step_edit_position ();
  70         prepare_step_edit_region ();
  71         reset_step_edit_beat_pos ();
  72
  73         assert (step_edit_region);
  74         assert (step_edit_region_view);
  75
  76         if (step_editor == 0) {
  77                 step_editor = new StepEntry (*this);
  78                 step_editor->signal_delete_event().connect (sigc::mem_fun (*this, &StepEditor::step_editor_hidden));
  79                 step_editor->signal_hide().connect (sigc::mem_fun (*this, &StepEditor::step_editor_hide));
  80         }
  81
  82         step_edit_region_view->show_step_edit_cursor (step_edit_beat_pos);
  83         step_edit_region_view->set_step_edit_cursor_width (step_editor->note_length());
  84
  85         step_editor->present ();
  86 }
  87
  88 void
  89 StepEditor::resync_step_edit_position ()
  90 {
  91         step_edit_insert_position = _editor.get_preferred_edit_position (Editing::EDIT_IGNORE_NONE, false, true);
  92 }
  93
  94 void
  95 StepEditor::resync_step_edit_to_edit_point ()
  96 {
  97         resync_step_edit_position ();
  98         if (step_edit_region) {
  99                 reset_step_edit_beat_pos ();
 100         }
 101 }
 102
 103 void
 104 StepEditor::prepare_step_edit_region ()
 105 {
 106         boost::shared_ptr<Region> r = _track->playlist()->top_region_at (step_edit_insert_position);
 107
 108         if (r) {
 109                 step_edit_region = boost::dynamic_pointer_cast<MidiRegion>(r);
 110         }
 111
 112         if (step_edit_region) {
 113                 RegionView* rv = _mtv.midi_view()->find_view (step_edit_region);
 114                 step_edit_region_view = dynamic_cast<MidiRegionView*> (rv);
 115
 116         } else {
 117
 118                 const Meter& m = _mtv.session()->tempo_map().meter_at_frame (step_edit_insert_position);
 119                 const Tempo& t = _mtv.session()->tempo_map().tempo_at_frame (step_edit_insert_position);
 120
 121                 double baf = _mtv.session()->tempo_map().beat_at_frame (step_edit_insert_position);
 122                 double next_bar_in_beats =  baf + m.divisions_per_bar();
 123                 framecnt_t next_bar_pos = _mtv.session()->tempo_map().frame_at_beat (next_bar_in_beats);
 124                 framecnt_t len = next_bar_pos - step_edit_insert_position;
 125
 126                 step_edit_region = _mtv.add_region (step_edit_insert_position, len, true);
 127
 128                 RegionView* rv = _mtv.midi_view()->find_view (step_edit_region);
 129                 step_edit_region_view = dynamic_cast<MidiRegionView*>(rv);
 130         }
 131 }
 132
 133
 134 void
 135 StepEditor::reset_step_edit_beat_pos ()
 136 {
 137         assert (step_edit_region);
 138         assert (step_edit_region_view);
 139
 140         framecnt_t frames_from_start = _editor.get_preferred_edit_position() - step_edit_region->position();
 141
 142         if (frames_from_start < 0) {
 143                 /* this can happen with snap enabled, and the edit point == Playhead. we snap the
 144                    position of the new region, and it can end up after the edit point.
 145                 */
 146                 frames_from_start = 0;
 147         }
 148
 149         step_edit_beat_pos = step_edit_region_view->region_frames_to_region_beats (frames_from_start);
 150         step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 151 }
 152
 153 bool
 154 StepEditor::step_editor_hidden (GdkEventAny*)
 155 {
 156         step_editor_hide ();
 157         return true; // XXX remember position ?!
 158 }
 159
 160 void
 161 StepEditor::step_editor_hide ()
 162 {
 163         /* everything else will follow the change in the model */
 164         _track->set_step_editing (false);
 165 }
 166
 167 void
 168 StepEditor::stop_step_editing ()
 169 {
 170         if (step_editor) {
 171                 step_editor->hide ();
 172         }
 173
 174         if (step_edit_region_view) {
 175                 step_edit_region_view->hide_step_edit_cursor();
 176         }
 177
 178         step_edit_region.reset ();
 179 }
 180
 181 void
 182 StepEditor::check_step_edit ()
 183 {
 184         MidiRingBuffer<framepos_t>& incoming (_track->step_edit_ring_buffer());
 185         uint8_t* buf;
 186         uint32_t bufsize = 32;
 187
 188         buf = new uint8_t[bufsize];
 189
 190         while (incoming.read_space()) {
 191                 framepos_t time;
 192                 Evoral::EventType type;
 193                 uint32_t size;
 194
 195                 incoming.read_prefix (&time, &type, &size);
 196
 197                 if (size > bufsize) {
 198                         delete [] buf;
 199                         bufsize = size;
 200                         buf = new uint8_t[bufsize];
 201                 }
 202
 203                 incoming.read_contents (size, buf);
 204
 205                 if ((buf[0] & 0xf0) == MIDI_CMD_NOTE_ON) {
 206                         step_add_note (buf[0] & 0xf, buf[1], buf[2], Evoral::Beats());
 207                 }
 208         }
 209 }
 210
 211 int
 212 StepEditor::step_add_bank_change (uint8_t /*channel*/, uint8_t /*bank*/)
 213 {
 214         return 0;
 215 }
 216
 217 int
 218 StepEditor::step_add_program_change (uint8_t /*channel*/, uint8_t /*program*/)
 219 {
 220         return 0;
 221 }
 222
 223 void
 224 StepEditor::step_edit_sustain (Evoral::Beats beats)
 225 {
 226         if (step_edit_region_view) {
 227                 step_edit_region_view->step_sustain (beats);
 228         }
 229 }
 230
 231 void
 232 StepEditor::move_step_edit_beat_pos (Evoral::Beats beats)
 233 {
 234         if (!step_edit_region_view) {
 235                 return;
 236         }
 237         if (beats > 0.0) {
 238                 step_edit_beat_pos = min (step_edit_beat_pos + beats,
 239                                           step_edit_region_view->region_frames_to_region_beats (step_edit_region->length()));
 240         } else if (beats < 0.0) {
 241                 if (-beats < step_edit_beat_pos) {
 242                         step_edit_beat_pos += beats; // its negative, remember
 243                 } else {
 244                         step_edit_beat_pos = Evoral::Beats();
 245                 }
 246         }
 247         step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 248 }
 249
 250 int
 251 StepEditor::step_add_note (uint8_t channel, uint8_t pitch, uint8_t velocity, Evoral::Beats beat_duration)
 252 {
 253         /* do these things in case undo removed the step edit region
 254          */
 255         if (!step_edit_region) {
 256                 resync_step_edit_position ();
 257                 prepare_step_edit_region ();
 258                 reset_step_edit_beat_pos ();
 259                 step_edit_region_view->show_step_edit_cursor (step_edit_beat_pos);
 260                 step_edit_region_view->set_step_edit_cursor_width (step_editor->note_length());
 261         }
 262
 263         assert (step_edit_region);
 264         assert (step_edit_region_view);
 265
 266         if (beat_duration == 0.0 && step_editor) {
 267                 beat_duration = step_editor->note_length();
 268         } else if (beat_duration == 0.0) {
 269                 bool success;
 270                 beat_duration = _editor.get_grid_type_as_beats (success, step_edit_insert_position);
 271
 272                 if (!success) {
 273                         return -1;
 274                 }
 275         }
 276
 277         MidiStreamView* msv = _mtv.midi_view();
 278
 279         /* make sure its visible on the vertical axis */
 280
 281         if (pitch < msv->lowest_note() || pitch > msv->highest_note()) {
 282                 msv->update_note_range (pitch);
 283                 msv->set_note_range (MidiStreamView::ContentsRange);
 284         }
 285
 286         /* make sure its visible on the horizontal axis */
 287
 288         framepos_t fpos = step_edit_region_view->region_beats_to_absolute_frames (step_edit_beat_pos + beat_duration);
 289
 290         if (fpos >= (_editor.leftmost_sample() + _editor.current_page_samples())) {
 291                 _editor.reset_x_origin (fpos - (_editor.current_page_samples()/4));
 292         }
 293
 294         Evoral::Beats at = step_edit_beat_pos;
 295         Evoral::Beats len = beat_duration;
 296
 297         if ((last_added_pitch >= 0) && (pitch == last_added_pitch) && (last_added_end == step_edit_beat_pos)) {
 298
 299                 /* avoid any apparent note overlap - move the start of this note
 300                    up by 1 tick from where the last note ended
 301                 */
 302
 303                 at  += Evoral::Beats::ticks(1);
 304                 len -= Evoral::Beats::ticks(1);
 305         }
 306
 307         step_edit_region_view->step_add_note (channel, pitch, velocity, at, len);
 308
 309         last_added_pitch = pitch;
 310         last_added_end = at+len;
 311
 312         if (_step_edit_triplet_countdown > 0) {
 313                 _step_edit_triplet_countdown--;
 314
 315                 if (_step_edit_triplet_countdown == 0) {
 316                         _step_edit_triplet_countdown = 3;
 317                 }
 318         }
 319
 320         if (!_step_edit_within_chord) {
 321                 step_edit_beat_pos += beat_duration;
 322                 step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 323         } else {
 324                 step_edit_beat_pos += Evoral::Beats::ticks(1); // tiny, but no longer overlapping
 325                 _step_edit_chord_duration = max (_step_edit_chord_duration, beat_duration);
 326         }
 327
 328         return 0;
 329 }
 330
 331 void
 332 StepEditor::set_step_edit_cursor_width (Evoral::Beats beats)
 333 {
 334         if (step_edit_region_view) {
 335                 step_edit_region_view->set_step_edit_cursor_width (beats);
 336         }
 337 }
 338
 339 bool
 340 StepEditor::step_edit_within_triplet() const
 341 {
 342         return _step_edit_triplet_countdown > 0;
 343 }
 344
 345 bool
 346 StepEditor::step_edit_within_chord() const
 347 {
 348         return _step_edit_within_chord;
 349 }
 350
 351 void
 352 StepEditor::step_edit_toggle_triplet ()
 353 {
 354         if (_step_edit_triplet_countdown == 0) {
 355                 _step_edit_within_chord = false;
 356                 _step_edit_triplet_countdown = 3;
 357         } else {
 358                 _step_edit_triplet_countdown = 0;
 359         }
 360 }
 361
 362 void
 363 StepEditor::step_edit_toggle_chord ()
 364 {
 365         if (_step_edit_within_chord) {
 366                 _step_edit_within_chord = false;
 367                 if (step_edit_region_view) {
 368                         step_edit_beat_pos += _step_edit_chord_duration;
 369                         step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 370                 }
 371         } else {
 372                 _step_edit_triplet_countdown = 0;
 373                 _step_edit_within_chord = true;
 374         }
 375 }
 376
 377 void
 378 StepEditor::step_edit_rest (Evoral::Beats beats)
 379 {
 380         bool success;
 381
 382         if (beats == 0.0) {
 383                 beats = _editor.get_grid_type_as_beats (success, step_edit_insert_position);
 384         } else {
 385                 success = true;
 386         }
 387
 388         if (success && step_edit_region_view) {
 389                 step_edit_beat_pos += beats;
 390                 step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 391         }
 392 }
 393
 394 void
 395 StepEditor::step_edit_beat_sync ()
 396 {
 397         step_edit_beat_pos = step_edit_beat_pos.round_up_to_beat();
 398         if (step_edit_region_view) {
 399                 step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 400         }
 401 }
 402
 403 void
 404 StepEditor::step_edit_bar_sync ()
 405 {
 406         Session* _session = _mtv.session ();
 407
 408         if (!_session || !step_edit_region_view || !step_edit_region) {
 409                 return;
 410         }
 411
 412         framepos_t fpos = step_edit_region_view->region_beats_to_absolute_frames (step_edit_beat_pos);
 413         fpos = _session->tempo_map().round_to_bar (fpos, RoundUpAlways);
 414         step_edit_beat_pos = step_edit_region_view->region_frames_to_region_beats (fpos - step_edit_region->position()).round_up_to_beat();
 415         step_edit_region_view->move_step_edit_cursor (step_edit_beat_pos);
 416 }
 417
 418 void
 419 StepEditor::playlist_changed ()
 420 {
 421         step_edit_region_connection.disconnect ();
 422         _track->playlist()->RegionRemoved.connect (step_edit_region_connection, invalidator (*this),
 423                                                    boost::bind (&StepEditor::region_removed, this, _1),
 424                                                    gui_context());
 425 }
 426
 427 void
 428 StepEditor::region_removed (boost::weak_ptr<Region> wr)
 429 {
 430         boost::shared_ptr<Region> r (wr.lock());
 431
 432         if (!r) {
 433                 return;
 434         }
 435
 436         if (step_edit_region == r) {
 437                 step_edit_region.reset();
 438                 step_edit_region_view = 0;
 439                 // force a recompute of the insert position
 440                 step_edit_beat_pos = Evoral::Beats(-1);
 441         }
 442 }
 443
 444 string
 445 StepEditor::name() const
 446 {
 447         return _track->name();
 448 }