1 /*
2  * Copyright (C) 2006-2009 David Robillard <d@drobilla.net>
3  * Copyright (C) 2006-2018 Paul Davis <paul@linuxaudiosystems.com>
4  * Copyright (C) 2009-2010 Carl Hetherington <carl@carlh.net>
5  * Copyright (C) 2015 Robin Gareus <robin@gareus.org>
6  * Copyright (C) 2016-2017 Ben Loftis <ben@harrisonconsoles.com>
7  * Copyright (C) 2017-2019 Johannes Mueller <github@johannes-mueller.org>
8  * Copyright (C) 2017 Len Ovens <len@ovenwerks.net>
9  * Copyright (C) 2017 Tim Mayberry <mojofunk@gmail.com>
10  *
11  * This program is free software; you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation; either version 2 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License along
22  * with this program; if not, write to the Free Software Foundation, Inc.,
23  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24  */
25 
26 #include "pbd/pthread_utils.h"
27 #include "pbd/memento_command.h"
28 
29 #include "ardour/session.h"
30 #include "ardour/location.h"
31 #include "ardour/tempo.h"
32 #include "ardour/transport_master_manager.h"
33 #include "ardour/utils.h"
34 
35 #include "control_protocol/basic_ui.h"
36 
37 #include "pbd/i18n.h"
38 
39 using namespace ARDOUR;
40 
41 PBD::Signal2<void,std::string,std::string> BasicUI::AccessAction;
42 
BasicUI(Session & s)43 BasicUI::BasicUI (Session& s)
44 	: session (&s)
45 {
46 }
47 
BasicUI()48 BasicUI::BasicUI ()
49 	: session (0)
50 {
51 }
52 
~BasicUI()53 BasicUI::~BasicUI ()
54 {
55 
56 }
57 
58 void
register_thread(std::string name)59 BasicUI::register_thread (std::string name)
60 {
61 	std::string pool_name = name;
62 	pool_name += " events";
63 
64 	SessionEvent::create_per_thread_pool (pool_name, 64);
65 }
66 
67 void
access_action(std::string action_path)68 BasicUI::access_action ( std::string action_path )
69 {
70 	int split_at = action_path.find( "/" );
71 	std::string group = action_path.substr( 0, split_at );
72 	std::string item = action_path.substr( split_at + 1 );
73 
74 	AccessAction( group, item );
75 }
76 
77 void
loop_toggle()78 BasicUI::loop_toggle ()
79 {
80 	if (!session) {
81 		return;
82 	}
83 
84 	Location * looploc = session->locations()->auto_loop_location();
85 
86 	if (!looploc) {
87 		return;
88 	}
89 
90 	if (session->get_play_loop()) {
91 
92 		/* looping enabled, our job is to disable it */
93 
94 		session->request_play_loop (false);
95 
96 	} else {
97 
98 		/* looping not enabled, our job is to enable it.
99 
100 		   loop-is-NOT-mode: this action always starts the transport rolling.
101 		   loop-IS-mode:     this action simply sets the loop play mechanism, but
102 		                        does not start transport.
103 		*/
104 		if (Config->get_loop_is_mode()) {
105 			session->request_play_loop (true, false);
106 		} else {
107 			session->request_play_loop (true, true);
108 		}
109 	}
110 
111 	//show the loop markers
112 	looploc->set_hidden (false, this);
113 }
114 
115 void
loop_location(samplepos_t start,samplepos_t end)116 BasicUI::loop_location (samplepos_t start, samplepos_t end)
117 {
118 	Location* tll;
119 	if ((tll = session->locations()->auto_loop_location()) == 0) {
120 		Location* loc = new Location (*session, start, end, _("Loop"),  Location::IsAutoLoop);
121 		session->locations()->add (loc, true);
122 		session->set_auto_loop_location (loc);
123 	} else {
124 		tll->set_hidden (false, this);
125 		tll->set (start, end);
126 	}
127 }
128 
129 void
goto_start(bool and_roll)130 BasicUI::goto_start (bool and_roll)
131 {
132 	session->goto_start (and_roll);
133 }
134 
135 void
goto_zero()136 BasicUI::goto_zero ()
137 {
138 	session->request_locate (0);
139 }
140 
141 void
goto_end()142 BasicUI::goto_end ()
143 {
144 	session->goto_end ();
145 }
146 
147 void
add_marker(const std::string & markername)148 BasicUI::add_marker (const std::string& markername)
149 {
150 	samplepos_t where = session->audible_sample();
151 	Location *location = new Location (*session, where, where, markername, Location::IsMark);
152 	session->begin_reversible_command (_("add marker"));
153 	XMLNode &before = session->locations()->get_state();
154 	session->locations()->add (location, true);
155 	XMLNode &after = session->locations()->get_state();
156 	session->add_command (new MementoCommand<Locations>(*(session->locations()), &before, &after));
157 	session->commit_reversible_command ();
158 }
159 
160 void
remove_marker_at_playhead()161 BasicUI::remove_marker_at_playhead ()
162 {
163 	if (session) {
164 		//set up for undo
165 		XMLNode &before = session->locations()->get_state();
166 		bool removed = false;
167 
168 		//find location(s) at this time
169 		Locations::LocationList locs;
170 		session->locations()->find_all_between (session->audible_sample(), session->audible_sample()+1, locs, Location::Flags(0));
171 		for (Locations::LocationList::iterator i = locs.begin(); i != locs.end(); ++i) {
172 			if ((*i)->is_mark()) {
173 				session->locations()->remove (*i);
174 				removed = true;
175 			}
176 		}
177 
178 		//store undo
179 		if (removed) {
180 			session->begin_reversible_command (_("remove marker"));
181 			XMLNode &after = session->locations()->get_state();
182 			session->add_command(new MementoCommand<Locations>(*(session->locations()), &before, &after));
183 			session->commit_reversible_command ();
184 		}
185 	}
186 }
187 
188 void
button_varispeed(bool fwd)189 BasicUI::button_varispeed (bool fwd)
190 {
191 	// incrementally increase speed by semitones
192 	// (keypress auto-repeat is 100ms)
193 	const float maxspeed = Config->get_shuttle_max_speed();
194 	float semitone_ratio = exp2f (1.0f/12.0f);
195 	const float octave_down = pow (1.0/semitone_ratio, 12.0);
196 	float transport_speed = get_transport_speed ();
197 	float speed;
198 
199 	if (Config->get_rewind_ffwd_like_tape_decks()) {
200 
201 		if (fwd) {
202 			if (transport_speed <= 0) {
203 				session->request_transport_speed (1.0, false);
204 				session->request_roll (TRS_UI);
205 				return;
206 			}
207 		} else {
208 			if (transport_speed >= 0) {
209 				session->request_transport_speed (-1.0, false);
210 				session->request_roll (TRS_UI);
211 				return;
212 			}
213 		}
214 
215 
216 	} else {
217 
218 		if (fabs (transport_speed) <= 0.1) {
219 
220 			/* close to zero, maybe flip direction */
221 
222 			if (fwd) {
223 				if (transport_speed <= 0) {
224 					session->request_transport_speed (1.0, false);
225 					session->request_roll (TRS_UI);
226 				}
227 			} else {
228 				if (transport_speed >= 0) {
229 					session->request_transport_speed (-1.0, false);
230 					session->request_roll (TRS_UI);
231 				}
232 			}
233 
234 			/* either we've just started, or we're moving as slowly as we
235 			 * ever should
236 			 */
237 
238 			return;
239 		}
240 
241 		if (fwd) {
242 			if (transport_speed < 0.f) {
243 				if (fabs (transport_speed) < octave_down) {
244 					/* we need to move the speed back towards zero */
245 					semitone_ratio = powf (1.f / semitone_ratio, 4.f);
246 				} else {
247 					semitone_ratio = 1.f / semitone_ratio;
248 				}
249 			} else {
250 				if (fabs (transport_speed) < octave_down) {
251 					/* moving very slowly, use 4 semitone steps */
252 					semitone_ratio = powf (semitone_ratio, 4.f);
253 				}
254 			}
255 		} else {
256 			if (transport_speed > 0.f) {
257 				/* we need to move the speed back towards zero */
258 
259 				if (transport_speed < octave_down) {
260 					semitone_ratio = powf (1.f / semitone_ratio, 4.f);
261 				} else {
262 					semitone_ratio = 1.f / semitone_ratio;
263 				}
264 			} else {
265 				if (fabs (transport_speed) < octave_down) {
266 					/* moving very slowly, use 4 semitone steps */
267 					semitone_ratio = powf (semitone_ratio, 4.f);
268 				}
269 			}
270 		}
271 	}
272 
273 	speed = semitone_ratio * transport_speed;
274 	speed = std::max (-maxspeed, std::min (maxspeed, speed));
275 	session->request_transport_speed (speed, false);
276 	session->request_roll (TRS_UI);
277 }
278 
279 void
rewind()280 BasicUI::rewind ()
281 {
282 	button_varispeed (false);
283 }
284 
285 void
ffwd()286 BasicUI::ffwd ()
287 {
288 	button_varispeed (true);
289 }
290 
291 void
transport_stop()292 BasicUI::transport_stop ()
293 {
294 	session->request_stop ();
295 }
296 
297 bool
stop_button_onoff() const298 BasicUI::stop_button_onoff () const
299 {
300 	return session->transport_stopped_or_stopping ();
301 }
302 
303 bool
play_button_onoff() const304 BasicUI::play_button_onoff () const
305 {
306 	return get_transport_speed() == 1.0;
307 }
308 
309 bool
ffwd_button_onoff() const310 BasicUI::ffwd_button_onoff () const
311 {
312 	return get_transport_speed() > 1.0;
313 }
314 
315 bool
rewind_button_onoff() const316 BasicUI::rewind_button_onoff () const
317 {
318 	return get_transport_speed() < 0.0;
319 }
320 
321 bool
loop_button_onoff() const322 BasicUI::loop_button_onoff () const
323 {
324 	return session->get_play_loop();
325 }
326 
327 void
transport_play(bool from_last_start)328 BasicUI::transport_play (bool from_last_start)
329 {
330 	/* ::toggle_roll() is smarter and preferred */
331 
332 	if (!session) {
333 		return;
334 	}
335 
336 	if (session->is_auditioning()) {
337 		return;
338 	}
339 
340 #if 0
341 	if (session->config.get_external_sync()) {
342 		switch (TransportMasterManager::instance().current().type()) {
343 		case Engine:
344 			break;
345 		default:
346 			/* transport controlled by the master */
347 			return;
348 		}
349 	}
350 #endif
351 
352 	bool rolling = transport_rolling();
353 
354 	if (session->get_play_loop()) {
355 
356 		/* If loop playback is not a mode, then we should cancel
357 		   it when this action is requested. If it is a mode
358 		   we just leave it in place.
359 		*/
360 
361 		if (!Config->get_loop_is_mode()) {
362 			/* XXX it is not possible to just leave seamless loop and keep
363 			   playing at present (nov 4th 2009)
364 			*/
365 			if (rolling) {
366 				/* stop loop playback but keep rolling */
367 				session->request_play_loop (false, false);
368 			}
369 		}
370 
371 	} else if (session->get_play_range () ) {
372 		/* stop playing a range if we currently are */
373 		session->request_play_range (0, true);
374 	}
375 
376 	if (rolling) {
377 		session->request_transport_speed (1.0, false, TRS_UI);
378 	} else {
379 		session->request_roll ();
380 	}
381 }
382 
383 void
rec_enable_toggle()384 BasicUI::rec_enable_toggle ()
385 {
386 	switch (session->record_status()) {
387 	case Session::Disabled:
388 		if (session->ntracks() == 0) {
389 			// string txt = _("Please create 1 or more track\nbefore trying to record.\nCheck the Session menu.");
390 			// MessageDialog msg (*editor, txt);
391 			// msg.run ();
392 			return;
393 		}
394 		session->maybe_enable_record ();
395 		break;
396 	case Session::Recording:
397 	case Session::Enabled:
398 		session->disable_record (false, true);
399 	}
400 }
401 
402 void
all_tracks_rec_in()403 BasicUI::all_tracks_rec_in ()
404 {
405 	session->set_all_tracks_record_enabled (true);
406 }
407 
408 void
all_tracks_rec_out()409 BasicUI::all_tracks_rec_out ()
410 {
411 	session->set_all_tracks_record_enabled (false);
412 }
413 
414 void
save_state()415 BasicUI::save_state ()
416 {
417 	session->save_state ("");
418 }
419 
420 void
prev_marker()421 BasicUI::prev_marker ()
422 {
423 	samplepos_t pos = session->locations()->first_mark_before (session->transport_sample());
424 
425 	if (pos >= 0) {
426 		session->request_locate (pos);
427 	} else {
428 		session->goto_start ();
429 	}
430 }
431 
432 void
next_marker()433 BasicUI::next_marker ()
434 {
435 	samplepos_t pos = session->locations()->first_mark_after (session->transport_sample());
436 
437 	if (pos >= 0) {
438 		session->request_locate (pos);
439 	} else {
440 		session->goto_end();
441 	}
442 }
443 
444 void
set_transport_speed(double speed)445 BasicUI::set_transport_speed (double speed)
446 {
447 	session->request_transport_speed (speed);
448 }
449 
450 double
get_transport_speed() const451 BasicUI::get_transport_speed () const
452 {
453 	return session->actual_speed ();
454 }
455 
456 double
transport_rolling() const457 BasicUI::transport_rolling () const
458 {
459 	return !session->transport_stopped_or_stopping ();
460 }
461 
462 void
undo()463 BasicUI::undo ()
464 {
465 	access_action ("Editor/undo");
466 }
467 
468 void
redo()469 BasicUI::redo ()
470 {
471 	access_action ("Editor/redo");
472 }
473 
474 void
toggle_all_rec_enables()475 BasicUI::toggle_all_rec_enables ()
476 {
477 	if (session->get_record_enabled()) {
478 		// session->record_disenable_all ();
479 	} else {
480 		// session->record_enable_all ();
481 	}
482 }
483 
484 void
toggle_punch_in()485 BasicUI::toggle_punch_in ()
486 {
487 	session->config.set_punch_in (!session->config.get_punch_in());
488 }
489 
490 void
toggle_punch_out()491 BasicUI::toggle_punch_out ()
492 {
493 	session->config.set_punch_out (!session->config.get_punch_out());
494 }
495 
496 bool
get_record_enabled()497 BasicUI::get_record_enabled ()
498 {
499 	return session->get_record_enabled();
500 }
501 
502 void
set_record_enable(bool yn)503 BasicUI::set_record_enable (bool yn)
504 {
505 	if (yn) {
506 		session->maybe_enable_record ();
507 	} else {
508 		session->disable_record (false, true);
509 	}
510 }
511 
512 samplepos_t
transport_sample()513 BasicUI::transport_sample ()
514 {
515 	return session->transport_sample();
516 }
517 
518 void
locate(samplepos_t where,LocateTransportDisposition ltd)519 BasicUI::locate (samplepos_t where, LocateTransportDisposition ltd)
520 {
521 	session->request_locate (where, ltd);
522 }
523 
524 void
locate(samplepos_t where,bool roll)525 BasicUI::locate (samplepos_t where, bool roll)
526 {
527 	session->request_locate (where, roll ? MustRoll : RollIfAppropriate);
528 }
529 
530 void
jump_by_seconds(double secs,LocateTransportDisposition ltd)531 BasicUI::jump_by_seconds (double secs, LocateTransportDisposition ltd)
532 {
533 	samplepos_t current = session->transport_sample();
534 	double s = (double) current / (double) session->nominal_sample_rate();
535 
536 	s+= secs;
537 	if (s < 0) {
538 		s = 0;
539 	}
540 	s = s * session->nominal_sample_rate();
541 
542 	session->request_locate (floor(s), ltd);
543 }
544 
545 void
jump_by_bars(double bars,LocateTransportDisposition ltd)546 BasicUI::jump_by_bars (double bars, LocateTransportDisposition ltd)
547 {
548 	TempoMap& tmap (session->tempo_map());
549 	Timecode::BBT_Time bbt (tmap.bbt_at_sample (session->transport_sample()));
550 
551 	bars += bbt.bars;
552 	if (bars < 0) {
553 		bars = 0;
554 	}
555 
556 	AnyTime any;
557 	any.type = AnyTime::BBT;
558 	any.bbt.bars = bars;
559 
560 	session->request_locate (session->convert_to_samples (any), ltd);
561 }
562 
563 void
jump_by_beats(double beats,LocateTransportDisposition ltd)564 BasicUI::jump_by_beats (double beats, LocateTransportDisposition ltd)
565 {
566 	TempoMap& tmap (session->tempo_map ());
567 	double qn_goal = tmap.quarter_note_at_sample (session->transport_sample ()) + beats;
568 	if (qn_goal < 0.0) {
569 		qn_goal = 0.0;
570 	}
571 	session->request_locate (tmap.sample_at_quarter_note (qn_goal), ltd);
572 }
573 
574 void
toggle_monitor_mute()575 BasicUI::toggle_monitor_mute ()
576 {
577 	if (session->monitor_out()) {
578 		boost::shared_ptr<MonitorProcessor> mon = session->monitor_out()->monitor_control();
579 		if (mon->cut_all ()) {
580 			mon->set_cut_all (false);
581 		} else {
582 			mon->set_cut_all (true);
583 		}
584 	}
585 }
586 
587 void
toggle_monitor_dim()588 BasicUI::toggle_monitor_dim ()
589 {
590 	if (session->monitor_out()) {
591 		boost::shared_ptr<MonitorProcessor> mon = session->monitor_out()->monitor_control();
592 		if (mon->dim_all ()) {
593 			mon->set_dim_all (false);
594 		} else {
595 			mon->set_dim_all (true);
596 		}
597 	}
598 }
599 
600 void
toggle_monitor_mono()601 BasicUI::toggle_monitor_mono ()
602 {
603 	if (session->monitor_out()) {
604 		boost::shared_ptr<MonitorProcessor> mon = session->monitor_out()->monitor_control();
605 		if (mon->mono()) {
606 			mon->set_mono (false);
607 		} else {
608 			mon->set_mono (true);
609 		}
610 	}
611 }
612 
613 void
midi_panic()614 BasicUI::midi_panic ()
615 {
616 	session->midi_panic ();
617 }
618 
619 void
toggle_click()620 BasicUI::toggle_click ()
621 {
622 	bool state = !Config->get_clicking();
623 	Config->set_clicking (state);
624 }
625 
626 void
toggle_roll(bool roll_out_of_bounded_mode)627 BasicUI::toggle_roll (bool roll_out_of_bounded_mode)
628 {
629 	/* TO BE KEPT IN SYNC WITH ARDOUR_UI::toggle_roll() */
630 
631 	if (!session) {
632 		return;
633 	}
634 
635 	if (session->is_auditioning()) {
636 		session->cancel_audition ();
637 		return;
638 	}
639 
640 	if (session->config.get_external_sync()) {
641 		switch (TransportMasterManager::instance().current()->type()) {
642 		case Engine:
643 			break;
644 		default:
645 			/* transport controlled by the master */
646 			return;
647 		}
648 	}
649 
650 	bool rolling = transport_rolling();
651 
652 	if (rolling) {
653 
654 		if (roll_out_of_bounded_mode) {
655 			/* drop out of loop/range playback but leave transport rolling */
656 
657 			if (session->get_play_loop()) {
658 
659 				if (session->actively_recording()) {
660 					/* actually stop transport because
661 					   otherwise the captured data will make
662 					   no sense.
663 					*/
664 					session->request_play_loop (false, true);
665 
666 				} else {
667 					session->request_play_loop (false, false);
668 				}
669 
670 			} else if (session->get_play_range ()) {
671 
672 				session->request_cancel_play_range ();
673 			}
674 
675 		} else {
676 			session->request_stop (true, true);
677 		}
678 
679 	} else { /* not rolling */
680 
681 		if (session->get_play_loop() && Config->get_loop_is_mode()) {
682 			session->request_locate (session->locations()->auto_loop_location()->start(), MustRoll);
683 		} else {
684 			session->request_roll (TRS_UI);
685 		}
686 	}
687 }
688 
689 void
stop_forget()690 BasicUI::stop_forget ()
691 {
692 	session->request_stop (true, true);
693 }
694 
mark_in()695 void BasicUI::mark_in () { access_action("Common/start-range-from-playhead"); }
mark_out()696 void BasicUI::mark_out () { access_action("Common/finish-range-from-playhead"); }
697 
set_punch_range()698 void BasicUI::set_punch_range () { access_action("Editor/set-punch-from-edit-range"); }
set_loop_range()699 void BasicUI::set_loop_range () { access_action("Editor/set-loop-from-edit-range"); }
set_session_range()700 void BasicUI::set_session_range () { access_action("Editor/set-session-from-edit-range"); }
701 
quick_snapshot_stay()702 void BasicUI::quick_snapshot_stay () { access_action("Main/QuickSnapshotStay"); }
quick_snapshot_switch()703 void BasicUI::quick_snapshot_switch () { access_action("Main/QuickSnapshotSwitch"); }
704 
fit_1_track()705 void BasicUI::fit_1_track() { access_action("Editor/fit_1_track"); }
fit_2_tracks()706 void BasicUI::fit_2_tracks() { access_action("Editor/fit_2_tracks"); }
fit_4_tracks()707 void BasicUI::fit_4_tracks() { access_action("Editor/fit_4_tracks"); }
fit_8_tracks()708 void BasicUI::fit_8_tracks() { access_action("Editor/fit_8_tracks"); }
fit_16_tracks()709 void BasicUI::fit_16_tracks() { access_action("Editor/fit_16_tracks"); }
fit_32_tracks()710 void BasicUI::fit_32_tracks() { access_action("Editor/fit_32_tracks"); }
fit_all_tracks()711 void BasicUI::fit_all_tracks() { access_action("Editor/fit_all_tracks"); }
712 
zoom_10_ms()713 void BasicUI::zoom_10_ms() { access_action("Editor/zoom_10_ms"); }
zoom_100_ms()714 void BasicUI::zoom_100_ms() { access_action("Editor/zoom_100_ms"); }
zoom_1_sec()715 void BasicUI::zoom_1_sec() { access_action("Editor/zoom_1_sec"); }
zoom_10_sec()716 void BasicUI::zoom_10_sec() { access_action("Editor/zoom_10_sec"); }
zoom_1_min()717 void BasicUI::zoom_1_min() { access_action("Editor/zoom_1_min"); }
zoom_5_min()718 void BasicUI::zoom_5_min() { access_action("Editor/zoom_5_min"); }
zoom_10_min()719 void BasicUI::zoom_10_min() { access_action("Editor/zoom_10_min"); }
zoom_to_session()720 void BasicUI::zoom_to_session() { access_action("Editor/zoom-to-session"); }
temporal_zoom_in()721 void BasicUI::temporal_zoom_in() { access_action("Editor/temporal-zoom-in"); }
temporal_zoom_out()722 void BasicUI::temporal_zoom_out() { access_action("Editor/temporal-zoom-out"); }
723 
scroll_up_1_track()724 void BasicUI::scroll_up_1_track() { access_action("Editor/step-tracks-up"); }
scroll_dn_1_track()725 void BasicUI::scroll_dn_1_track() { access_action("Editor/step-tracks-down"); }
scroll_up_1_page()726 void BasicUI::scroll_up_1_page() { access_action("Editor/scroll-tracks-up"); }
scroll_dn_1_page()727 void BasicUI::scroll_dn_1_page() { access_action("Editor/scroll-tracks-down"); }
728 
729 
730 bool
locating()731 BasicUI::locating ()
732 {
733 	return session->locate_pending();
734 }
735 
736 bool
locked()737 BasicUI::locked ()
738 {
739 	return session->transport_locked ();
740 }
741 
742 ARDOUR::samplecnt_t
timecode_frames_per_hour()743 BasicUI::timecode_frames_per_hour ()
744 {
745 	return session->timecode_frames_per_hour ();
746 }
747 
748 void
timecode_time(samplepos_t where,Timecode::Time & timecode)749 BasicUI::timecode_time (samplepos_t where, Timecode::Time& timecode)
750 {
751 	session->timecode_time (where, *((Timecode::Time *) &timecode));
752 }
753 
754 void
timecode_to_sample(Timecode::Time & timecode,samplepos_t & sample,bool use_offset,bool use_subframes) const755 BasicUI::timecode_to_sample (Timecode::Time& timecode, samplepos_t & sample, bool use_offset, bool use_subframes) const
756 {
757 	session->timecode_to_sample (*((Timecode::Time*)&timecode), sample, use_offset, use_subframes);
758 }
759 
760 void
sample_to_timecode(samplepos_t sample,Timecode::Time & timecode,bool use_offset,bool use_subframes) const761 BasicUI::sample_to_timecode (samplepos_t sample, Timecode::Time& timecode, bool use_offset, bool use_subframes) const
762 {
763 	session->sample_to_timecode (sample, *((Timecode::Time*)&timecode), use_offset, use_subframes);
764 }
765 
766 void
cancel_all_solo()767 BasicUI::cancel_all_solo ()
768 {
769 	if (session) {
770 		session->cancel_all_solo ();
771 	}
772 }
773 
774 struct SortLocationsByPosition {
operator ()SortLocationsByPosition775     bool operator() (Location* a, Location* b) {
776 	    return a->start() < b->start();
777     }
778 };
779 
780 void
goto_nth_marker(int n)781 BasicUI::goto_nth_marker (int n)
782 {
783 	if (!session) {
784 		return;
785 	}
786 
787 	const Locations::LocationList& l (session->locations()->list());
788 	Locations::LocationList ordered;
789 	ordered = l;
790 
791 	SortLocationsByPosition cmp;
792 	ordered.sort (cmp);
793 
794 	for (Locations::LocationList::iterator i = ordered.begin(); n >= 0 && i != ordered.end(); ++i) {
795 		if ((*i)->is_mark() && !(*i)->is_hidden() && !(*i)->is_session_range()) {
796 			if (n == 0) {
797 				session->request_locate ((*i)->start());
798 				break;
799 			}
800 			--n;
801 		}
802 	}
803 }
804 
805 #if 0
806 this stuff is waiting to go in so that all UIs can offer complex solo/mute functionality
807 
808 void
809 BasicUI::solo_release (boost::shared_ptr<Route> r)
810 {
811 }
812 
813 void
814 BasicUI::solo_press (boost::shared_ptr<Route> r, bool momentary, bool global, bool exclusive, bool isolate, bool solo_group)
815 {
816 	if (momentary) {
817 		_solo_release = new SoloMuteRelease (_route->soloed());
818 	}
819 
820 	if (global) {
821 
822 		if (_solo_release) {
823 			_solo_release->routes = _session->get_routes ();
824 		}
825 
826 		if (Config->get_solo_control_is_listen_control()) {
827 			_session->set_listen (_session->get_routes(), !_route->listening(),  Session::rt_cleanup, true);
828 		} else {
829 			_session->set_solo (_session->get_routes(), !_route->soloed(),  Session::rt_cleanup, true);
830 		}
831 
832 	} else if (exclusive) {
833 
834 		if (_solo_release) {
835 			_solo_release->exclusive = true;
836 
837 			boost::shared_ptr<RouteList> routes = _session->get_routes();
838 
839 			for (RouteList::iterator i = routes->begin(); i != routes->end(); ++i) {
840 				if ((*i)->soloed ()) {
841 					_solo_release->routes_on->push_back (*i);
842 				} else {
843 					_solo_release->routes_off->push_back (*i);
844 				}
845 			}
846 		}
847 
848 		if (Config->get_solo_control_is_listen_control()) {
849 			/* ??? we need a just_one_listen() method */
850 		} else {
851 			_session->set_just_one_solo (_route, true);
852 		}
853 
854 	} else if (isolate) {
855 
856 		// shift-click: toggle solo isolated status
857 
858 		_route->set_solo_isolated (!_route->solo_isolated(), this);
859 		delete _solo_release;
860 		_solo_release = 0;
861 
862 	} else if (solo_group) {
863 
864 		/* Primary-button1: solo mix group.
865 		   NOTE: Primary-button2 is MIDI learn.
866 		*/
867 
868 		if (_route->route_group()) {
869 
870 			if (_solo_release) {
871 				_solo_release->routes = _route->route_group()->route_list();
872 			}
873 
874 			if (Config->get_solo_control_is_listen_control()) {
875 				_session->set_listen (_route->route_group()->route_list(), !_route->listening(),  Session::rt_cleanup, true);
876 			} else {
877 				_session->set_solo (_route->route_group()->route_list(), !_route->soloed(),  Session::rt_cleanup, true);
878 			}
879 		}
880 
881 	} else {
882 
883 		/* click: solo this route */
884 
885 		boost::shared_ptr<RouteList> rl (new RouteList);
886 		rl->push_back (route());
887 
888 		if (_solo_release) {
889 			_solo_release->routes = rl;
890 		}
891 
892 		if (Config->get_solo_control_is_listen_control()) {
893 			_session->set_listen (rl, !_route->listening());
894 		} else {
895 			_session->set_solo (rl, !_route->soloed());
896 		}
897 	}
898 }
899 #endif
900