/* * Copyright (C) 2006-2009 David Robillard * Copyright (C) 2006-2018 Paul Davis * Copyright (C) 2009-2010 Carl Hetherington * Copyright (C) 2015 Robin Gareus * Copyright (C) 2016-2017 Ben Loftis * Copyright (C) 2017-2019 Johannes Mueller * Copyright (C) 2017 Len Ovens * Copyright (C) 2017 Tim Mayberry * * This program is free software; you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation; either version 2 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License along * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ #include "pbd/pthread_utils.h" #include "pbd/memento_command.h" #include "temporal/tempo.h" #include "ardour/session.h" #include "ardour/location.h" #include "ardour/tempo.h" #include "ardour/transport_master_manager.h" #include "ardour/utils.h" #include "control_protocol/basic_ui.h" #include "pbd/i18n.h" using namespace ARDOUR; using namespace Temporal; PBD::Signal BasicUI::AccessAction; BasicUI::BasicUI (Session& s) : session (&s), _tbank_route_width (8), _tbank_row_height (8), _tbank_start_route (0), _tbank_start_row (0) { } BasicUI::BasicUI () : session (0) { } BasicUI::~BasicUI () { } void BasicUI::register_thread (std::string name) { std::string pool_name = name; pool_name += " events"; SessionEvent::create_per_thread_pool (pool_name, 64); } void BasicUI::access_action ( std::string action_path ) { int split_at = action_path.find( "/" ); std::string group = action_path.substr( 0, split_at ); std::string item = action_path.substr( split_at + 1 ); AccessAction( group, item ); } void BasicUI::loop_toggle () { if (!session) { return; } Location * looploc = session->locations()->auto_loop_location(); if (!looploc) { return; } if (session->get_play_loop()) { /* looping enabled, our job is to disable it */ session->request_play_loop (false); } else { /* looping not enabled, our job is to enable it. loop-is-NOT-mode: this action always starts the transport rolling. loop-IS-mode: this action simply sets the loop play mechanism, but does not start transport. */ if (Config->get_loop_is_mode()) { session->request_play_loop (true, false); } else { session->request_play_loop (true, true); } } //show the loop markers looploc->set_hidden (false, this); } void BasicUI::loop_location (timepos_t const & start, timepos_t const & end) { Location* tll; if ((tll = session->locations()->auto_loop_location()) == 0) { Location* loc = new Location (*session, start, end, _("Loop"), Location::IsAutoLoop); session->locations()->add (loc, true); session->set_auto_loop_location (loc); } else { tll->set_hidden (false, this); tll->set (start, end); } } void BasicUI::goto_start (bool and_roll) { session->goto_start (and_roll); } void BasicUI::goto_zero () { session->request_locate (0); } void BasicUI::goto_end () { session->goto_end (); } void BasicUI::add_marker (const std::string& markername) { timepos_t where (session->audible_sample()); Location *location = new Location (*session, where, where, markername, Location::IsMark); session->begin_reversible_command (_("add marker")); XMLNode &before = session->locations()->get_state(); session->locations()->add (location, true); XMLNode &after = session->locations()->get_state(); session->add_command (new MementoCommand(*(session->locations()), &before, &after)); session->commit_reversible_command (); } void BasicUI::remove_marker_at_playhead () { access_action("Common/remove-location-from-playhead"); } void BasicUI::button_varispeed (bool fwd) { // incrementally increase speed by semitones // (keypress auto-repeat is 100ms) const float maxspeed = Config->get_shuttle_max_speed(); float semitone_ratio = exp2f (1.0f/12.0f); const float octave_down = pow (1.0/semitone_ratio, 12.0); float transport_speed = get_transport_speed (); float speed; if (Config->get_rewind_ffwd_like_tape_decks()) { if (fwd) { if (transport_speed <= 0) { session->request_transport_speed (1.0); session->request_roll (TRS_UI); return; } } else { if (transport_speed >= 0) { session->request_transport_speed (-1.0); session->request_roll (TRS_UI); return; } } } else { if (fabs (transport_speed) <= 0.1) { /* close to zero, maybe flip direction */ if (fwd) { if (transport_speed <= 0) { session->request_transport_speed (1.0); session->request_roll (TRS_UI); } } else { if (transport_speed >= 0) { session->request_transport_speed (-1.0); session->request_roll (TRS_UI); } } /* either we've just started, or we're moving as slowly as we * ever should */ return; } if (fwd) { if (transport_speed < 0.f) { if (fabs (transport_speed) < octave_down) { /* we need to move the speed back towards zero */ semitone_ratio = powf (1.f / semitone_ratio, 4.f); } else { semitone_ratio = 1.f / semitone_ratio; } } else { if (fabs (transport_speed) < octave_down) { /* moving very slowly, use 4 semitone steps */ semitone_ratio = powf (semitone_ratio, 4.f); } } } else { if (transport_speed > 0.f) { /* we need to move the speed back towards zero */ if (transport_speed < octave_down) { semitone_ratio = powf (1.f / semitone_ratio, 4.f); } else { semitone_ratio = 1.f / semitone_ratio; } } else { if (fabs (transport_speed) < octave_down) { /* moving very slowly, use 4 semitone steps */ semitone_ratio = powf (semitone_ratio, 4.f); } } } } speed = semitone_ratio * transport_speed; speed = std::max (-maxspeed, std::min (maxspeed, speed)); session->request_transport_speed (speed); session->request_roll (TRS_UI); } void BasicUI::rewind () { button_varispeed (false); } void BasicUI::ffwd () { button_varispeed (true); } void BasicUI::transport_stop () { session->request_stop (); } bool BasicUI::stop_button_onoff () const { return session->transport_stopped_or_stopping (); } bool BasicUI::play_button_onoff () const { return get_transport_speed() == 1.0; } bool BasicUI::ffwd_button_onoff () const { return get_transport_speed() > 1.0; } bool BasicUI::rewind_button_onoff () const { return get_transport_speed() < 0.0; } bool BasicUI::loop_button_onoff () const { return session->get_play_loop(); } void BasicUI::transport_play (bool from_last_start) { /* ::toggle_roll() is smarter and preferred */ if (!session) { return; } if (session->is_auditioning()) { return; } #if 0 if (session->config.get_external_sync()) { switch (TransportMasterManager::instance().current().type()) { case Engine: break; default: /* transport controlled by the master */ return; } } #endif bool rolling = transport_rolling(); if (session->get_play_loop()) { /* If loop playback is not a mode, then we should cancel it when this action is requested. If it is a mode we just leave it in place. */ if (!Config->get_loop_is_mode()) { /* XXX it is not possible to just leave seamless loop and keep playing at present (nov 4th 2009) */ if (rolling) { /* stop loop playback but keep rolling */ session->request_play_loop (false, false); } } } else if (session->get_play_range () ) { /* stop playing a range if we currently are */ session->request_play_range (0, true); } if (rolling) { session->request_transport_speed (1.0, TRS_UI); } else { session->request_roll (); } } void BasicUI::rec_enable_toggle () { switch (session->record_status()) { case Disabled: if (session->ntracks() == 0) { // string txt = _("Please create 1 or more track\nbefore trying to record.\nCheck the Session menu."); // MessageDialog msg (*editor, txt); // msg.run (); return; } session->maybe_enable_record (); break; case Recording: case Enabled: session->disable_record (false, true); } } void BasicUI::all_tracks_rec_in () { session->set_all_tracks_record_enabled (true); } void BasicUI::all_tracks_rec_out () { session->set_all_tracks_record_enabled (false); } void BasicUI::save_state () { session->save_state (""); } void BasicUI::prev_marker () { access_action("Common/jump-backward-to-mark"); } void BasicUI::next_marker () { access_action("Common/jump-forward-to-mark"); } void BasicUI::set_transport_speed (double speed) { session->request_roll (TRS_UI); session->request_transport_speed (speed); } double BasicUI::get_transport_speed () const { return session->actual_speed (); } double BasicUI::transport_rolling () const { return !session->transport_stopped_or_stopping (); } void BasicUI::trigger_stop_all (bool immediately) { session->trigger_stop_all (immediately); } void BasicUI::trigger_cue_row (int cue_idx) { session->trigger_cue_row (cue_idx); } void BasicUI::trigger_stop_col (int col, bool immediately) { std::shared_ptr tb = session->triggerbox_at (col); if (tb) { if (immediately) { tb->stop_all_immediately (); } else { tb->stop_all_quantized (); } } } void BasicUI::tbank_set_size (int width, int height) { _tbank_route_width = width; _tbank_row_height = height; } void BasicUI::tbank_step_routes (int step_size) { _tbank_start_route += step_size; if (_tbank_start_route + _tbank_route_width > session->num_triggerboxes() ) { _tbank_start_route=session->num_triggerboxes() - _tbank_route_width; } if (_tbank_start_route < 0) { _tbank_start_route=0; } } void BasicUI::tbank_step_rows (int step_size) { _tbank_start_row += step_size; if (_tbank_start_row + _tbank_row_height > TriggerBox::default_triggers_per_box ) { _tbank_start_row=TriggerBox::default_triggers_per_box - _tbank_row_height; } if (_tbank_start_row < 0) { _tbank_start_row=0; } } void BasicUI::store_mixer_scene (int idx) { session->store_nth_mixer_scene (idx); } void BasicUI::apply_mixer_scene (int idx) { session->apply_nth_mixer_scene (idx); } void BasicUI::undo () { access_action ("Editor/undo"); } void BasicUI::redo () { access_action ("Editor/redo"); } void BasicUI::toggle_all_rec_enables () { if (session->get_record_enabled()) { // session->record_disenable_all (); } else { // session->record_enable_all (); } } void BasicUI::toggle_punch_in () { session->config.set_punch_in (!session->config.get_punch_in()); } void BasicUI::toggle_punch_out () { session->config.set_punch_out (!session->config.get_punch_out()); } bool BasicUI::get_record_enabled () { return session->get_record_enabled(); } void BasicUI::set_record_enable (bool yn) { if (yn) { session->maybe_enable_record (); } else { session->disable_record (false, true); } } samplepos_t BasicUI::transport_sample () { return session->transport_sample(); } void BasicUI::locate (samplepos_t where, LocateTransportDisposition ltd) { session->request_locate (where, false, ltd); } void BasicUI::locate (samplepos_t where, bool roll) { session->request_locate (where, false, roll ? MustRoll : RollIfAppropriate); } void BasicUI::jump_by_seconds (double secs, LocateTransportDisposition ltd) { samplepos_t current = session->transport_sample(); double s = (double) current / (double) session->nominal_sample_rate(); s+= secs; if (s < 0) { s = 0; } s = s * session->nominal_sample_rate(); session->request_locate (floor(s), false, ltd); } void BasicUI::jump_by_bars (int bars, LocateTransportDisposition ltd) { TempoMap::SharedPtr tmap (TempoMap::fetch()); Temporal::BBT_Argument bbt (tmap->bbt_at (timepos_t (session->transport_sample()))); bbt.bars += bars; if (bbt.bars < 0) { bbt.bars = 1; } bbt.beats = 1; bbt.ticks = 0; session->request_locate (tmap->sample_at (bbt), false, ltd); } void BasicUI::jump_by_beats (int beats, LocateTransportDisposition ltd) { Beats qn_goal = timepos_t (session->transport_sample ()).beats() + Beats (beats, 0); if (qn_goal < Beats()) { qn_goal = Beats(); } session->request_locate (timepos_t (qn_goal).samples()); } void BasicUI::toggle_monitor_mute () { if (session->monitor_out()) { std::shared_ptr mon = session->monitor_out()->monitor_control(); if (mon->cut_all ()) { mon->set_cut_all (false); } else { mon->set_cut_all (true); } } } void BasicUI::toggle_monitor_dim () { if (session->monitor_out()) { std::shared_ptr mon = session->monitor_out()->monitor_control(); if (mon->dim_all ()) { mon->set_dim_all (false); } else { mon->set_dim_all (true); } } } void BasicUI::toggle_monitor_mono () { if (session->monitor_out()) { std::shared_ptr mon = session->monitor_out()->monitor_control(); if (mon->mono()) { mon->set_mono (false); } else { mon->set_mono (true); } } } void BasicUI::midi_panic () { session->midi_panic (); } void BasicUI::toggle_click () { bool state = !Config->get_clicking(); Config->set_clicking (state); } void BasicUI::toggle_roll (bool with_abort, bool roll_out_of_bounded_mode) { /* TO BE KEPT IN SYNC WITH ARDOUR_UI::toggle_roll() */ if (!session) { return; } if (session->is_auditioning()) { session->cancel_audition (); return; } if (session->config.get_external_sync()) { switch (TransportMasterManager::instance().current()->type()) { case Engine: break; default: /* transport controlled by the master */ return; } } bool rolling = transport_rolling(); if (rolling) { if (roll_out_of_bounded_mode) { /* drop out of loop/range playback but leave transport rolling */ if (session->get_play_loop()) { if (session->actively_recording()) { /* actually stop transport because otherwise the captured data will make no sense. */ session->request_play_loop (false, true); } else { session->request_play_loop (false, false); } } else if (session->get_play_range ()) { session->request_cancel_play_range (); } else { session->request_stop (with_abort, true); } } else { session->request_stop (with_abort, true); } } else { /* not rolling */ if (session->get_play_loop() && Config->get_loop_is_mode()) { session->request_locate (session->locations()->auto_loop_location()->start().samples(), false, MustRoll); } else { session->request_roll (TRS_UI); } } } void BasicUI::stop_forget () { session->request_stop (true, true); } void BasicUI::mark_in () { access_action("Common/start-range-from-playhead"); } void BasicUI::mark_out () { access_action("Common/finish-range-from-playhead"); } void BasicUI::set_punch_range () { access_action("Editor/set-punch-from-edit-range"); } void BasicUI::set_loop_range () { access_action("Editor/set-loop-from-edit-range"); } void BasicUI::set_session_range () { access_action("Editor/set-session-from-edit-range"); } void BasicUI::quick_snapshot_stay () { access_action("Main/QuickSnapshotStay"); } void BasicUI::quick_snapshot_switch () { access_action("Main/QuickSnapshotSwitch"); } void BasicUI::fit_1_track() { access_action("Editor/fit_1_track"); } void BasicUI::fit_2_tracks() { access_action("Editor/fit_2_tracks"); } void BasicUI::fit_4_tracks() { access_action("Editor/fit_4_tracks"); } void BasicUI::fit_8_tracks() { access_action("Editor/fit_8_tracks"); } void BasicUI::fit_16_tracks() { access_action("Editor/fit_16_tracks"); } void BasicUI::fit_32_tracks() { access_action("Editor/fit_32_tracks"); } void BasicUI::fit_all_tracks() { access_action("Editor/fit_all_tracks"); } void BasicUI::zoom_10_ms() { access_action("Editor/zoom_10_ms"); } void BasicUI::zoom_100_ms() { access_action("Editor/zoom_100_ms"); } void BasicUI::zoom_1_sec() { access_action("Editor/zoom_1_sec"); } void BasicUI::zoom_10_sec() { access_action("Editor/zoom_10_sec"); } void BasicUI::zoom_1_min() { access_action("Editor/zoom_1_min"); } void BasicUI::zoom_5_min() { access_action("Editor/zoom_5_min"); } void BasicUI::zoom_10_min() { access_action("Editor/zoom_10_min"); } void BasicUI::zoom_to_session() { access_action("Editor/zoom-to-session"); } void BasicUI::temporal_zoom_in() { access_action("Editor/temporal-zoom-in"); } void BasicUI::temporal_zoom_out() { access_action("Editor/temporal-zoom-out"); } void BasicUI::scroll_up_1_track() { access_action("Editor/step-tracks-up"); } void BasicUI::scroll_dn_1_track() { access_action("Editor/step-tracks-down"); } void BasicUI::scroll_up_1_page() { access_action("Editor/scroll-tracks-up"); } void BasicUI::scroll_dn_1_page() { access_action("Editor/scroll-tracks-down"); } bool BasicUI::locating () { return session->locate_pending(); } bool BasicUI::locked () { return session->transport_locked (); } ARDOUR::samplecnt_t BasicUI::timecode_frames_per_hour () { return session->timecode_frames_per_hour (); } void BasicUI::timecode_time (samplepos_t where, Timecode::Time& timecode) { session->timecode_time (where, *((Timecode::Time *) &timecode)); } void BasicUI::timecode_to_sample (Timecode::Time& timecode, samplepos_t & sample, bool use_offset, bool use_subframes) const { session->timecode_to_sample (*((Timecode::Time*)&timecode), sample, use_offset, use_subframes); } void BasicUI::sample_to_timecode (samplepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const { session->sample_to_timecode (sample, *((Timecode::Time*)&timecode), use_offset, use_subframes); } void BasicUI::cancel_all_solo () { if (session) { session->cancel_all_solo (); } } struct SortLocationsByPosition { bool operator() (Location* a, Location* b) { return a->start() < b->start(); } }; void BasicUI::goto_nth_marker (int n) { if (!session) { return; } const Locations::LocationList& l (session->locations()->list()); Locations::LocationList ordered; ordered = l; SortLocationsByPosition cmp; ordered.sort (cmp); for (Locations::LocationList::iterator i = ordered.begin(); n >= 0 && i != ordered.end(); ++i) { if ((*i)->is_mark() && !(*i)->is_hidden() && !(*i)->is_session_range()) { if (n == 0) { session->request_locate ((*i)->start().samples()); break; } --n; } } } ARDOUR::TriggerPtr BasicUI::find_trigger (int x, int y) { std::shared_ptr r = session->get_remote_nth_route (x); if (!r) { return TriggerPtr(); } std::shared_ptr tb = r->triggerbox(); if (!tb || !tb->active()) { return TriggerPtr(); } TriggerPtr tp (tb->trigger (y)); if (!tp) { return TriggerPtr(); } return tp; } float BasicUI::trigger_progress_at (int x) { std::shared_ptr tb = session->triggerbox_at (_tbank_start_route + x); if (tb) { ARDOUR::TriggerPtr trigger = tb->currently_playing (); if (trigger) { return trigger->position_as_fraction (); } } return -1; } BasicUI::TriggerDisplay BasicUI::trigger_display_at (int x, int y) { TriggerDisplay disp; std::shared_ptr tb = session->triggerbox_at (_tbank_start_route + x); if (tb) { ARDOUR::TriggerPtr current = tb->currently_playing (); TriggerPtr tp = tb->trigger (_tbank_start_row + y); if (tp) { if (!tp->playable()) { disp.state = -1; } else if (tp == current) { disp.state = 1; } else { disp.state = 0; } } } return disp; } void BasicUI::bang_trigger_at (int x, int y) { session->bang_trigger_at (_tbank_start_route + x, _tbank_start_row + y); } void BasicUI::unbang_trigger_at (int x, int y) { session->unbang_trigger_at (_tbank_start_route + x, _tbank_start_row + y); } #if 0 this stuff is waiting to go in so that all UIs can offer complex solo/mute functionality void BasicUI::solo_release (std::shared_ptr r) { } void BasicUI::solo_press (std::shared_ptr r, bool momentary, bool global, bool exclusive, bool isolate, bool solo_group) { if (momentary) { _solo_release = new SoloMuteRelease (_route->soloed()); } if (global) { if (_solo_release) { _solo_release->routes = _session->get_routes (); } if (Config->get_solo_control_is_listen_control()) { _session->set_listen (_session->get_routes(), !_route->listening(), Session::rt_cleanup, true); } else { _session->set_solo (_session->get_routes(), !_route->soloed(), Session::rt_cleanup, true); } } else if (exclusive) { if (_solo_release) { _solo_release->exclusive = true; std::shared_ptr routes = _session->get_routes(); for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) { if ((*i)->soloed ()) { _solo_release->routes_on->push_back (*i); } else { _solo_release->routes_off->push_back (*i); } } } if (Config->get_solo_control_is_listen_control()) { /* ??? we need a just_one_listen() method */ } else { _session->set_just_one_solo (_route, true); } } else if (isolate) { // shift-click: toggle solo isolated status _route->set_solo_isolated (!_route->solo_isolated(), this); delete _solo_release; _solo_release = 0; } else if (solo_group) { /* Primary-button1: solo mix group. NOTE: Primary-button2 is MIDI learn. */ if (_route->route_group()) { if (_solo_release) { _solo_release->routes = _route->route_group()->route_list(); } if (Config->get_solo_control_is_listen_control()) { _session->set_listen (_route->route_group()->route_list(), !_route->listening(), Session::rt_cleanup, true); } else { _session->set_solo (_route->route_group()->route_list(), !_route->soloed(), Session::rt_cleanup, true); } } } else { /* click: solo this route */ std::shared_ptr rl (new RouteList); rl->push_back (route()); if (_solo_release) { _solo_release->routes = rl; } if (Config->get_solo_control_is_listen_control()) { _session->set_listen (rl, !_route->listening()); } else { _session->set_solo (rl, !_route->soloed()); } } } #endif