livetrax/gtk2_ardour/playlist_selector.cc

/*
 * Copyright (C) 2005-2017 Paul Davis <paul@linuxaudiosystems.com>
 * Copyright (C) 2005 Taybin Rutkin <taybin@taybin.com>
 * Copyright (C) 2006-2012 David Robillard <d@drobilla.net>
 * Copyright (C) 2009-2012 Carl Hetherington <carl@carlh.net>
 * Copyright (C) 2015-2019 Robin Gareus <robin@gareus.org>
 *
 * 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 <gtkmm/button.h>
#include <gtkmm/stock.h>

#include "pbd/unwind.h"

#include "ardour/audio_track.h"
#include "ardour/audioplaylist.h"
#include "ardour/midi_playlist.h"
#include "ardour/playlist_factory.h"
#include "ardour/session_playlist.h"

#include <gtkmm2ext/gtk_ui.h>

#include "ardour_ui.h"
#include "gui_thread.h"
#include "playlist_selector.h"
#include "public_editor.h"
#include "route_ui.h"
#include "utils.h"

#include "pbd/i18n.h"

using namespace std;
using namespace Gtk;
using namespace Gtkmm2ext;
using namespace ARDOUR;
using namespace PBD;

PlaylistSelector::PlaylistSelector ()
	: ArdourDialog (_("Playlists"))
	, _rui (0)
	, _mode (plSelect)
	, _ignore_selection (false)
{
	set_name ("PlaylistSelectorWindow");
	set_modal (false);
	add_events (Gdk::KEY_PRESS_MASK | Gdk::KEY_RELEASE_MASK);
	set_size_request (500, 250);

	model = TreeStore::create (columns);
	tree.set_model (model);
	int name_column_n = tree.append_column (_("Name"), columns.text);
	tree.append_column (_("Group ID"), columns.pgrp);
	tree.set_headers_visible (true);

	TreeViewColumn* name_column = tree.get_column (name_column_n);
	name_column->set_sizing (TREE_VIEW_COLUMN_FIXED);
	name_column->set_expand (true);
	name_column->set_min_width (250);

	Gtk::ScrolledWindow* scroller = manage (new Gtk::ScrolledWindow);
	scroller->add (tree);
	scroller->set_policy (POLICY_AUTOMATIC, POLICY_AUTOMATIC);

	Gtk::Frame* scroller_frame = manage (new Frame ());
	scroller_frame->add (*scroller);

	Gtk::Label* scope_label = manage (new Gtk::Label (_("Scope: ")));

	Gtk::RadioButtonGroup scope_group;
	_scope_grp_radio = manage (new RadioButton (scope_group, _("Only this track/group")));
	_scope_rec_radio = manage (new RadioButton (scope_group, _("Rec-armed tracks")));
	_scope_all_radio = manage (new RadioButton (scope_group, _("ALL tracks")));

	_scope_box = manage (new HBox ());
	_scope_box->set_spacing (4);
	_scope_box->set_border_width (2);
	_scope_box->pack_start (*_scope_grp_radio, false, false);
	_scope_box->pack_start (*_scope_rec_radio, false, false);
	_scope_box->pack_start (*_scope_all_radio, false, false);
	Gtk::Frame* scope_frame = manage (new Frame ());
	scope_frame->add (*_scope_box);

	_button_box.set_spacing (6);
	_button_box.pack_start (_btn_new_plist);
	_button_box.pack_start (_btn_copy_plist);

	_scope_container.pack_start (*scope_label);
	_scope_container.pack_start (*scope_frame);

	Gtk::Table* table = manage (new Gtk::Table ());
	table->set_border_width (6);
	table->attach (*scroller_frame,  0, 2, 0, 1, EXPAND | FILL, EXPAND | FILL, 0, 4);
	table->attach (_scope_container, 0, 2, 1, 2, EXPAND | FILL, SHRINK, 0, 6);
	table->attach (_button_box,      0, 2, 2, 3, EXPAND | FILL, SHRINK, 0, 0);

	get_vbox ()->pack_start (*table, true, true);
	get_vbox ()->show_all ();

	_btn_new_plist.set_name ("generic button");
	_btn_new_plist.set_text ("New Playlist(s)");
	_btn_new_plist.signal_clicked.connect (sigc::mem_fun (*this, &PlaylistSelector::new_plist_button_clicked));

	_btn_copy_plist.set_name ("generic button");
	_btn_copy_plist.set_text ("Copy Playlist(s)");
	_btn_copy_plist.signal_clicked.connect (sigc::mem_fun (*this, &PlaylistSelector::copy_plist_button_clicked));

	tree.get_selection ()->signal_changed ().connect (sigc::mem_fun (*this, &PlaylistSelector::selection_changed));

	_scope_grp_radio->set_active (true);
}

void
PlaylistSelector::new_plist_button_clicked ()
{
	if (_scope_all_radio->get_active ()) {
		PublicEditor::instance ().new_playlists_for_all_tracks (false);
	} else if (_scope_rec_radio->get_active ()) {
		PublicEditor::instance ().new_playlists_for_armed_tracks (false);
	} else {
		PublicEditor::instance ().new_playlists_for_grouped_tracks (_rui, false);
	}
}

void
PlaylistSelector::copy_plist_button_clicked ()
{
	if (_scope_all_radio->get_active ()) {
		PublicEditor::instance ().new_playlists_for_all_tracks (true);
	} else if (_scope_rec_radio->get_active ()) {
		PublicEditor::instance ().new_playlists_for_armed_tracks (true);
	} else {
		PublicEditor::instance ().new_playlists_for_grouped_tracks (_rui, true);
	}
}

void
PlaylistSelector::prepare (RouteUI* ruix, plMode mode)
{
	_mode = mode;

	if (_rui != ruix) {
		_rui = ruix;
		_track_connections.drop_connections ();

		std::shared_ptr<Track> this_track = _rui->track ();

		if (this_track) {
			this_track->PlaylistChanged.connect (
			    _track_connections,
			    invalidator (*this),
			    std::bind (&PlaylistSelector::redisplay, this),
			    gui_context ());

			this_track->PlaylistAdded.connect (
			    _track_connections,
			    invalidator (*this),
			    std::bind (&PlaylistSelector::redisplay, this),
			    gui_context ());

			this_track->DropReferences.connect (
			    _track_connections,
			    invalidator (*this),
			    std::bind (&PlaylistSelector::ok_button_click, this),
			    gui_context ());
		}
	}

	redisplay ();
}

PlaylistSelector::~PlaylistSelector ()
{
	clear_map ();
}

void
PlaylistSelector::clear_map ()
{
	for (TrackPlaylistMap::iterator x = _trpl_map.begin (); x != _trpl_map.end (); ++x) {
		delete x->second;
	}
	_trpl_map.clear ();
}

void
PlaylistSelector::redisplay ()
{
	if (!_rui) {
		return;
	}

	if (_mode == plSelect) {
		_scope_container.show ();
		_button_box.show ();
	} else {
		_scope_container.hide ();
		_button_box.hide ();
	}

	switch (_mode) {
		case plSelect:
			set_title (string_compose (_("Select a Playlist for: %1"), _rui->route ()->name ()));
			break;
		case plCopy:
			set_title (string_compose (_("Copy a Playlist for: %1"), _rui->route ()->name ()));
			break;
		case plShare:
			set_title (string_compose (_("Share a Playlist for: %1"), _rui->route ()->name ()));
			break;
		case plSteal:
			set_title (string_compose (_("Steal a Playlist for: %1"), _rui->route ()->name ()));
			break;
	}

	clear_map ();
	if (model) {
		model->clear ();
	}

	_playlist_connections.drop_connections ();

	_session->playlists ()->foreach (this, &PlaylistSelector::add_playlist_to_map);

	std::shared_ptr<Track> this_track = _rui->track ();

	TreeModel::Row selected_row;
	bool           have_selected = false;

	for (TrackPlaylistMap::iterator x = _trpl_map.begin (); x != _trpl_map.end (); ++x) {
		std::shared_ptr<Track> tr = std::dynamic_pointer_cast<Track> (_session->route_by_id (x->first));

		/* add a node for the track */

		string nodename;

		if (!tr || tr->name ().empty ()) {
			nodename = _("unassigned");
		} else {
			nodename = tr->name ().c_str ();
		}

		TreeModel::Row row;

		/* make a heading for each other track, if needed */
		if (_mode != plSelect) {
			row               = *(model->prepend ());
			row[columns.text] = nodename;
		}

		/* Now insert all the playlists for this diskstream/track in a subtree */
		vector<std::shared_ptr<Playlist> > pls = *(x->second);

		/* sort the playlists to match the order they appear in the track menu */
		PlaylistSorterByID cmp;
		sort (pls.begin (), pls.end (), cmp);

		for (vector<std::shared_ptr<Playlist> >::iterator p = pls.begin (); p != pls.end (); ++p) {
			(*p)->PropertyChanged.connect (_playlist_connections, invalidator (*this), std::bind (&PlaylistSelector::pl_property_changed, this, _1), gui_context ());

			TreeModel::Row child_row;

			if (tr == this_track && _mode == plSelect) {
				child_row = *(model->append ());
			} else if (_mode != plSelect) {
				child_row = *(model->append (row.children ()));
			}

			if (!child_row) {
				continue;
			}
			child_row[columns.text]     = (*p)->name ();
			child_row[columns.pgrp]     = (*p)->pgroup_id ();
			child_row[columns.playlist] = *p;

			if (*p == this_track->playlist ()) {
				selected_row  = child_row;
				have_selected = true;
			}
		}
	}

	if (_mode != plSelect) {
		// Add unassigned (imported) playlists to the list
		list<std::shared_ptr<Playlist> > unassigned;
		_session->playlists ()->unassigned (unassigned);

		if (unassigned.begin () != unassigned.end ()) {
			TreeModel::Row row = *(model->append ());
			row[columns.text]  = _("Imported");

			for (list<std::shared_ptr<Playlist> >::iterator p = unassigned.begin (); p != unassigned.end (); ++p) {
				TreeModel::Row child_row;

				child_row = *(model->append (row.children ()));

				child_row[columns.text]     = (*p)->name ();
				child_row[columns.pgrp]     = (*p)->pgroup_id ();
				child_row[columns.playlist] = *p;

				if (*p == this_track->playlist ()) {
					selected_row  = child_row;
					have_selected = true;
				}
			}
		}
	}

	if (have_selected) {
		PBD::Unwinder<bool> uw (_ignore_selection, true);

		TreeIter parent = selected_row.parent ();
		while (parent) {
			tree.expand_row (TreePath (parent), false);
			parent = parent->parent ();
		}
		tree.get_selection ()->select (selected_row);
	}
}

void
PlaylistSelector::pl_property_changed (PBD::PropertyChange const& what_changed)
{
	redisplay ();
}

void
PlaylistSelector::add_playlist_to_map (std::shared_ptr<Playlist> pl)
{
	if (pl->frozen ()) {
		return;
	}

	if (!_rui) {
		return;
	}

	if (_rui->is_midi_track ()) {
		if (std::dynamic_pointer_cast<MidiPlaylist> (pl) == 0) {
			return;
		}
	} else {
		assert (_rui->is_audio_track ());
		if (std::dynamic_pointer_cast<AudioPlaylist> (pl) == 0) {
			return;
		}
	}

	TrackPlaylistMap::iterator x;

	if ((x = _trpl_map.find (pl->get_orig_track_id ())) == _trpl_map.end ()) {
		x = _trpl_map.insert (_trpl_map.end (), make_pair (pl->get_orig_track_id (), new vector<std::shared_ptr<Playlist> >));
	}

	x->second->push_back (pl);
}

void
PlaylistSelector::ok_button_click ()
{
	hide ();
}

void
PlaylistSelector::selection_changed ()
{
	if (_ignore_selection) {
		/* selection came from libardour, not the user's action */
		return;
	}

	TreeModel::iterator iter = tree.get_selection ()->get_selected ();

	if (!iter || _rui == 0) {
		/* nothing selected */
		return;
	}

	std::shared_ptr<Playlist> pl;
	if ((pl = ((*iter)[columns.playlist])) != 0) {
		if (_rui->is_audio_track () && std::dynamic_pointer_cast<AudioPlaylist> (pl) == 0) {
			return;
		}
		if (_rui->is_midi_track () && std::dynamic_pointer_cast<MidiPlaylist> (pl) == 0) {
			return;
		}

		XMLNode* before = &_rui->track ()->playlist_state ();
		switch (_mode) {
			/*  @Robin:  I dont see a way to undo these playlist actions
			 *  @Ben: me neither :)
			 *  @Robin: Now I do.
			 */
			case plCopy:
				{
					std::shared_ptr<Playlist> playlist = PlaylistFactory::create (pl, string_compose ("%1.1", pl->name ()));
					/* playlist->reset_shares ();  @Robin is this needed? */
					_rui->track ()->use_playlist (_rui->is_audio_track () ? DataType::AUDIO : DataType::MIDI, playlist);
				}
				break;
			case plShare:
				/* share pl but do NOT set me as the owner */
				_rui->track ()->use_playlist (_rui->is_audio_track () ? DataType::AUDIO : DataType::MIDI, pl, false);
				break;
			case plSteal:
				/* share the playlist and set ME as the owner */
				_rui->track ()->use_playlist (_rui->is_audio_track () ? DataType::AUDIO : DataType::MIDI, pl);
				break;
			case plSelect:
				if (_scope_all_radio->get_active ()) {
					PublicEditor::instance ().mapover_all_routes (sigc::bind (sigc::mem_fun (PublicEditor::instance (), &PublicEditor::mapped_select_playlist_matching), pl));
				} else if (_scope_rec_radio->get_active ()) {
					PublicEditor::instance ().mapover_armed_routes (sigc::bind (sigc::mem_fun (PublicEditor::instance (), &PublicEditor::mapped_select_playlist_matching), pl));
				} else {
					PublicEditor::instance ().mapover_grouped_routes (sigc::bind (sigc::mem_fun (PublicEditor::instance (), &PublicEditor::mapped_select_playlist_matching), pl), _rui, ARDOUR::Properties::group_select.property_id);
				}
				break;
		}

		XMLNode* after = &_rui->track ()->playlist_state ();
		if (*before != *after) {
			_session->begin_reversible_command (string_compose (_("Switch Playlist for track %1"), _rui->track ()->name ()));
			_session->commit_reversible_command (new MementoCommand<Track>(*_rui->track (), before, after));
		} else {
			delete before;
			delete after;
		}
	}
}

bool
PlaylistSelector::on_key_press_event (GdkEventKey* ev)
{
	switch (ev->keyval) {
		case GDK_Up:
		case GDK_Down:
			/* Allow these keys to have their in-dialog effect */
			return ArdourDialog::on_key_press_event (ev);
		default:
			break;
	}

	/* Don't just forward the key press ... make it act as if it occurred in
	 * whatever the main window currently is.
	 */
	Gtk::Window& main_window (ARDOUR_UI::instance ()->main_window ());
	return ARDOUR_UI_UTILS::relay_key_press (ev, &main_window);
}