2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify it
6 under the terms of the GNU General Public License as published by the Free
7 Software Foundation; either version 2 of the License, or (at your option)
10 This program is distributed in the hope that it will be useful, but WITHOUT
11 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 You should have received a copy of the GNU General Public License along
16 with this program; if not, write to the Free Software Foundation, Inc.,
17 675 Mass Ave, Cambridge, MA 02139, USA.
20 #include "session_metadata_dialog.h"
24 #include <gtkmm2ext/utils.h>
25 #include <gtkmm2ext/window_title.h>
27 #include "pbd/xml++.h"
28 #include "ardour/session.h"
29 #include "ardour/session_directory.h"
30 #include "ardour/session_utils.h"
37 #define CALL_MEMBER_FN(object,ptrToMember) ((object).*(ptrToMember))
39 /*** MetadataField ***/
41 MetadataField::MetadataField (ustring const & field_name) :
46 MetadataField::~MetadataField() { }
48 /* TextMetadataField */
50 TextMetadataField::TextMetadataField (Getter getter, Setter setter, ustring const & field_name, guint width ) :
51 MetadataField (field_name),
62 TextMetadataField::copy ()
64 return MetadataPtr (new TextMetadataField (getter, setter, _name, width));
68 TextMetadataField::save_data (ARDOUR::SessionMetadata & data) const
70 CALL_MEMBER_FN (data, setter) (_value);
74 TextMetadataField::load_data (ARDOUR::SessionMetadata const & data)
76 _value = CALL_MEMBER_FN (data, getter) ();
78 entry->set_text (_value);
83 TextMetadataField::name_widget ()
85 label = Gtk::manage (new Gtk::Label(_name + ':', Gtk::ALIGN_LEFT));
90 TextMetadataField::value_widget ()
92 value_label = Gtk::manage (new Gtk::Label(_value));
97 TextMetadataField::edit_widget ()
99 entry = Gtk::manage (new Gtk::Entry());
101 entry->set_text (_value);
102 entry->set_width_chars (width);
103 entry->signal_changed().connect (sigc::mem_fun(*this, &TextMetadataField::update_value));
109 TextMetadataField::update_value ()
111 _value = entry->get_text ();
114 /* NumberMetadataField */
116 NumberMetadataField::NumberMetadataField (Getter getter, Setter setter, ustring const & field_name, guint numbers, guint width) :
117 MetadataField (field_name),
129 NumberMetadataField::copy ()
131 return MetadataPtr (new NumberMetadataField (getter, setter, _name, numbers, width));
135 NumberMetadataField::save_data (ARDOUR::SessionMetadata & data) const
137 uint32_t number = str_to_uint (_value);
138 CALL_MEMBER_FN (data, setter) (number);
142 NumberMetadataField::load_data (ARDOUR::SessionMetadata const & data)
144 uint32_t number = CALL_MEMBER_FN (data, getter) ();
145 _value = uint_to_str (number);
147 entry->set_text (_value);
152 NumberMetadataField::update_value ()
154 // Accpt only numbers
155 uint32_t number = str_to_uint (entry->get_text());
156 _value = uint_to_str (number);
157 entry->set_text (_value);
161 NumberMetadataField::name_widget ()
163 label = Gtk::manage (new Gtk::Label(_name + ':', Gtk::ALIGN_LEFT));
168 NumberMetadataField::value_widget ()
170 value_label = Gtk::manage (new Gtk::Label(_value));
175 NumberMetadataField::edit_widget ()
177 entry = Gtk::manage (new Gtk::Entry());
179 entry->set_text (_value);
180 entry->set_width_chars (width);
181 entry->set_max_length (numbers);
182 entry->signal_changed().connect (sigc::mem_fun(*this, &NumberMetadataField::update_value));
188 NumberMetadataField::uint_to_str (uint32_t i) const
190 std::ostringstream oss ("");
192 if (oss.str().compare("0")) {
200 NumberMetadataField::str_to_uint (ustring const & str) const
203 ustring::size_type i;
204 while ((i = tmp.find_first_not_of("1234567890")) != ustring::npos) {
208 std::istringstream iss(tmp);
215 /* SessionMetadataSet */
217 SessionMetadataSet::SessionMetadataSet (ustring const & name) :
224 SessionMetadataSet::add_data_field (MetadataPtr field)
226 list.push_back (field);
229 /* SessionMetadataSetEditable */
231 SessionMetadataSetEditable::SessionMetadataSetEditable (ustring const & name) :
232 SessionMetadataSet (name)
234 table.set_row_spacings (6);
235 table.set_col_spacings (12);
239 SessionMetadataSetEditable::get_tab_widget ()
241 tab_widget.set_text (name);
246 SessionMetadataSetEditable::set_session (ARDOUR::Session * s)
250 ARDOUR::SessionMetadata const & data = session->metadata();
252 table.resize (list.size(), 2);
255 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
257 field->load_data (data);
258 table.attach (field->name_widget(), 0, 1, row, row + 1);
259 table.attach (field->edit_widget(), 1, 2, row, row + 1);
265 SessionMetadataSetEditable::save_data ()
267 ARDOUR::SessionMetadata & data = session->metadata();
268 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
269 (*it)->save_data(data);
273 /* SessionMetadataSetImportable */
275 SessionMetadataSetImportable::SessionMetadataSetImportable (ustring const & name) :
276 SessionMetadataSet (name),
279 tree = Gtk::ListStore::create (tree_cols);
280 tree_view.set_model (tree);
282 Gtk::TreeView::Column * viewcol;
285 Gtk::CellRendererToggle * import_render = Gtk::manage(new Gtk::CellRendererToggle());
286 import_render->signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::selection_changed));
287 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Import"), *import_render));
288 viewcol->add_attribute (import_render->property_active(), tree_cols.import);
289 tree_view.append_column (*viewcol);
291 // Add field name column
292 tree_view.append_column(_("Field"), tree_cols.field);
294 // Add values column with pango markup
295 Gtk::CellRendererText * values_render = Gtk::manage(new Gtk::CellRendererText());
296 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Values (current value on top)"), *values_render));
297 viewcol->add_attribute (values_render->property_markup(), tree_cols.values);
298 tree_view.append_column (*viewcol);
300 select_all_check.signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::select_all));
306 SessionMetadataSetImportable::get_tab_widget ()
308 tab_widget.set_text (name);
313 SessionMetadataSetImportable::get_select_all_widget ()
315 select_all_check.set_label (name);
316 return select_all_check;
320 SessionMetadataSetImportable::load_extra_data (ARDOUR::SessionMetadata const & data)
323 std::cerr << "Programming error: no session set for SessionMetaDataSetImportable (in load_data)!" << std::endl;
327 ARDOUR::SessionMetadata & session_data = session->metadata();
329 MetadataPtr session_field;
330 MetadataPtr import_field;
331 DataList::iterator session_it;
332 DataList::iterator import_it;
334 // Copy list and load data to import
335 for (session_it = session_list.begin(); session_it != session_list.end(); ++session_it) {
336 session_field = *session_it;
337 session_field->load_data(session_data);
338 import_list.push_back (session_field->copy());
342 session_it = session_list.begin();
343 import_it = import_list.begin();
344 while (session_it != session_list.end() && import_it != import_list.end()) { // _should_ be the same...
345 session_field = *session_it;
346 import_field = *import_it;
348 import_field->load_data(data); // hasn't been done yet
350 // Make string for values TODO get color from somewhere?
351 ustring values = "<span weight=\"ultralight\" color=\"#777\">" + session_field->value() + "</span>\n"
352 + "<span weight=\"bold\">" + import_field->value() + "</span>";
354 Gtk::TreeModel::iterator row_iter = tree->append();
355 Gtk::TreeModel::Row row = *row_iter;
357 row[tree_cols.field] = import_field->name();
358 row[tree_cols.values] = values;
359 row[tree_cols.import] = false;
360 row[tree_cols.data] = import_field;
368 SessionMetadataSetImportable::save_data ()
371 std::cerr << "Programming error: no session set for SessionMetaDataSetImportable (in import_data)!" << std::endl;
375 ARDOUR::SessionMetadata & session_data = session->metadata();
377 Gtk::TreeModel::Children fields = tree->children();
378 Gtk::TreeModel::Children::iterator it;
379 for (it = fields.begin(); it != fields.end(); ++it) {
380 if ((*it)[tree_cols.import]) {
381 MetadataPtr field = (*it)[tree_cols.data];
382 field->save_data (session_data);
388 SessionMetadataSetImportable::select_all ()
390 select_all_check.set_inconsistent (false);
391 bool state = select_all_check.get_active();
393 Gtk::TreeModel::Children fields = tree->children();
394 Gtk::TreeModel::Children::iterator it;
395 for (it = fields.begin(); it != fields.end(); ++it) {
396 (*it)[tree_cols.import] = state;
401 SessionMetadataSetImportable::selection_changed (ustring const & path)
403 select_all_check.set_inconsistent (true);
405 Gtk::TreeModel::iterator iter = tree->get_iter (path);
406 bool value((*iter)[tree_cols.import]);
407 (*iter)[tree_cols.import] = !value;
410 /* SessionMetadataDialog */
412 template <typename DataSet>
413 SessionMetadataDialog<DataSet>::SessionMetadataDialog (ustring const & name) :
414 ArdourDialog (name, true)
416 cancel_button = add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
417 cancel_button->signal_clicked().connect (mem_fun(*this, &SessionMetadataDialog::end_dialog));
418 save_button = add_button (Gtk::Stock::SAVE, Gtk::RESPONSE_ACCEPT);
419 save_button->signal_clicked().connect (mem_fun(*this, &SessionMetadataDialog::save_and_close));
422 template <typename DataSet>
424 SessionMetadataDialog<DataSet>::init_data ()
427 std::cerr << "Programming error: no session set for SessionMetaDataDialog (in init_data)!" << std::endl;
435 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
436 (*it)->set_session (session);
438 notebook.append_page ((*it)->get_widget(), (*it)->get_tab_widget());
442 template <typename DataSet>
444 SessionMetadataDialog<DataSet>::load_extra_data (ARDOUR::SessionMetadata const & data)
446 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
447 (*it)->load_extra_data (data);
451 template <typename DataSet>
453 SessionMetadataDialog<DataSet>::save_data ()
455 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
460 template <typename DataSet>
462 SessionMetadataDialog<DataSet>::save_and_close ()
468 template <typename DataSet>
470 SessionMetadataDialog<DataSet>::end_dialog ()
475 template <typename DataSet>
477 SessionMetadataDialog<DataSet>::warn_user (ustring const & string)
479 Gtk::MessageDialog msg (string, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_OK, true);
483 template <typename DataSet>
484 boost::shared_ptr<std::list<Gtk::Widget *> >
485 SessionMetadataDialog<DataSet>::get_custom_widgets (WidgetFunc f)
487 WidgetListPtr list (new WidgetList);
488 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it)
490 DataSet * set = dynamic_cast<DataSet *> (it->get());
491 list->push_back (& CALL_MEMBER_FN (*set, f) ());
497 template <typename DataSet>
499 SessionMetadataDialog<DataSet>::add_widget (Gtk::Widget & widget)
501 get_vbox()->pack_start (widget, true, true, 0);
504 template <typename DataSet>
506 SessionMetadataDialog<DataSet>::init_track_data ()
508 DataSetPtr data_set (new DataSet (_("Track")));
509 data_list.push_back (data_set);
513 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::title, &ARDOUR::SessionMetadata::set_title, _("Title")));
514 data_set->add_data_field (ptr);
516 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::track_number, &ARDOUR::SessionMetadata::set_track_number, _("Track Number"), 3));
517 data_set->add_data_field (ptr);
519 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::subtitle, &ARDOUR::SessionMetadata::set_subtitle, _("Subtitle")));
520 data_set->add_data_field (ptr);
522 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::grouping, &ARDOUR::SessionMetadata::set_grouping, _("Grouping")));
523 data_set->add_data_field (ptr);
525 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::artist, &ARDOUR::SessionMetadata::set_artist, _("Artist")));
526 data_set->add_data_field (ptr);
528 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::genre, &ARDOUR::SessionMetadata::set_genre, _("Genre")));
529 data_set->add_data_field (ptr);
531 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::comment, &ARDOUR::SessionMetadata::set_comment, _("Comment")));
532 data_set->add_data_field (ptr);
534 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::copyright, &ARDOUR::SessionMetadata::set_copyright, _("Copyright")));
535 data_set->add_data_field (ptr);
538 template <typename DataSet>
540 SessionMetadataDialog<DataSet>::init_album_data ()
542 DataSetPtr data_set (new DataSet (_("Album")));
543 data_list.push_back (data_set);
547 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album, &ARDOUR::SessionMetadata::set_album, _("Album")));
548 data_set->add_data_field (ptr);
550 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::year, &ARDOUR::SessionMetadata::set_year, _("Year"), 4));
551 data_set->add_data_field (ptr);
553 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album_artist, &ARDOUR::SessionMetadata::set_album_artist, _("Album Artist")));
554 data_set->add_data_field (ptr);
556 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_tracks, &ARDOUR::SessionMetadata::set_total_tracks, _("Total Tracks"), 3));
557 data_set->add_data_field (ptr);
559 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::disc_subtitle, &ARDOUR::SessionMetadata::set_disc_subtitle, _("Disc Subtitle")));
560 data_set->add_data_field (ptr);
562 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::disc_number, &ARDOUR::SessionMetadata::set_disc_number, _("Disc Number"), 2));
563 data_set->add_data_field (ptr);
565 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_discs, &ARDOUR::SessionMetadata::set_total_discs, _("Total Discs"), 2));
566 data_set->add_data_field (ptr);
568 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::compilation, &ARDOUR::SessionMetadata::set_compilation, _("Compilation")));
569 data_set->add_data_field (ptr);
571 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::isrc, &ARDOUR::SessionMetadata::set_isrc, _("ISRC")));
572 data_set->add_data_field (ptr);
575 template <typename DataSet>
577 SessionMetadataDialog<DataSet>::init_people_data ()
579 DataSetPtr data_set (new DataSet (_("People")));
580 data_list.push_back (data_set);
584 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::lyricist, &ARDOUR::SessionMetadata::set_lyricist, _("Lyricist")));
585 data_set->add_data_field (ptr);
587 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::composer, &ARDOUR::SessionMetadata::set_composer, _("Composer")));
588 data_set->add_data_field (ptr);
590 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::conductor, &ARDOUR::SessionMetadata::set_conductor, _("Conductor")));
591 data_set->add_data_field (ptr);
593 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::remixer, &ARDOUR::SessionMetadata::set_remixer, _("Remixer")));
594 data_set->add_data_field (ptr);
596 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::arranger, &ARDOUR::SessionMetadata::set_arranger, _("Arranger")));
597 data_set->add_data_field (ptr);
599 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::engineer, &ARDOUR::SessionMetadata::set_engineer, _("Engineer")));
600 data_set->add_data_field (ptr);
602 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::producer, &ARDOUR::SessionMetadata::set_producer, _("Producer")));
603 data_set->add_data_field (ptr);
605 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::dj_mixer, &ARDOUR::SessionMetadata::set_dj_mixer, _("DJ Mixer")));
606 data_set->add_data_field (ptr);
608 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::mixer, &ARDOUR::SessionMetadata::set_mixer, _("Mixer")));
609 data_set->add_data_field (ptr);
612 /* SessionMetadataEditor */
614 SessionMetadataEditor::SessionMetadataEditor () :
615 SessionMetadataDialog<SessionMetadataSetEditable> (_("Edit session metadata"))
620 SessionMetadataEditor::~SessionMetadataEditor ()
622 // Remove pages from notebook to get rid of gsignal runtime warnings
623 notebook.pages().clear();
627 SessionMetadataEditor::run ()
636 SessionMetadataEditor::init_gui ()
638 add_widget (notebook);
643 /* SessionMetadataImporter */
645 SessionMetadataImporter::SessionMetadataImporter () :
646 SessionMetadataDialog<SessionMetadataSetImportable> (_("Import session metadata"))
651 SessionMetadataImporter::~SessionMetadataImporter ()
653 // Remove pages from notebook to get rid of gsignal runtime warnings
654 notebook.pages().clear();
658 SessionMetadataImporter::run ()
661 std::cerr << "Programming error: no session set for SessionMetaDataImporter (in run)!" << std::endl;
665 /* Open session file selector */
667 Gtk::FileChooserDialog session_selector(_("Choose session to import metadata from"), Gtk::FILE_CHOOSER_ACTION_OPEN);
668 session_selector.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
669 session_selector.add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
670 session_selector.set_default_response(Gtk::RESPONSE_ACCEPT);
672 Gtk::FileFilter session_filter;
673 session_filter.add_pattern ("*.ardour");
674 session_filter.set_name (_("Ardour sessions"));
675 session_selector.add_filter (session_filter);
676 session_selector.set_filter (session_filter);
678 int response = session_selector.run();
679 session_selector.hide ();
682 case Gtk::RESPONSE_ACCEPT:
688 string session_path = session_selector.get_filename();
692 if (session_path.length() > 0) {
693 if (ARDOUR::find_session (session_path, path, name, isnew) != 0) {
700 /* We have a session: load the data and run dialog */
702 string filename = Glib::build_filename (path, name + ".ardour");
703 XMLTree session_tree;
704 if (!session_tree.read (filename)) {
705 warn_user (_("A proper ardour session file was not selected!"));
709 XMLNode * node = session_tree.root()->child ("Metadata");
712 warn_user (_("The session file didn't contain metadata!\nMaybe this is an old session format?"));
716 ARDOUR::SessionMetadata data;
717 data.set_state (*node);
720 load_extra_data (data);
727 SessionMetadataImporter::init_gui ()
729 // Select all from -widget
730 add_widget (selection_hbox);
731 selection_label.set_text (_("Import all from:"));
732 selection_hbox.pack_start (selection_label, false, false);
734 WidgetListPtr list = get_custom_widgets (&SessionMetadataSetImportable::get_select_all_widget);
735 for (WidgetList::iterator it = list->begin(); it != list->end(); ++it) {
736 selection_hbox.pack_start (**it, false, false, 6);
739 add_widget (notebook);