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>
26 #include "pbd/xml++.h"
27 #include "pbd/error.h"
29 #include "ardour/session.h"
30 #include "ardour/session_utils.h"
38 #define CALL_MEMBER_FN(object,ptrToMember) ((object).*(ptrToMember))
40 /*** MetadataField ***/
42 MetadataField::MetadataField (string const & field_name) :
47 MetadataField::~MetadataField() { }
49 /* TextMetadataField */
51 TextMetadataField::TextMetadataField (Getter getter, Setter setter, string const & field_name, guint width ) :
52 MetadataField (field_name),
63 TextMetadataField::copy ()
65 return MetadataPtr (new TextMetadataField (getter, setter, _name, width));
69 TextMetadataField::save_data (ARDOUR::SessionMetadata & data) const
71 CALL_MEMBER_FN (data, setter) (_value);
75 TextMetadataField::load_data (ARDOUR::SessionMetadata const & data)
77 _value = CALL_MEMBER_FN (data, getter) ();
79 entry->set_text (_value);
84 TextMetadataField::name_widget ()
86 label = Gtk::manage (new Gtk::Label(_name + ':'));
87 label->set_alignment (1, 0.5);
92 TextMetadataField::value_widget ()
94 value_label = Gtk::manage (new Gtk::Label(_value));
99 TextMetadataField::edit_widget ()
101 entry = Gtk::manage (new Gtk::Entry());
103 entry->set_text (_value);
104 entry->set_width_chars (width);
105 entry->signal_changed().connect (sigc::mem_fun(*this, &TextMetadataField::update_value));
111 TextMetadataField::update_value ()
113 _value = entry->get_text ();
116 /* NumberMetadataField */
118 NumberMetadataField::NumberMetadataField (Getter getter, Setter setter, string const & field_name, guint numbers, guint width) :
119 MetadataField (field_name),
131 NumberMetadataField::copy ()
133 return MetadataPtr (new NumberMetadataField (getter, setter, _name, numbers, width));
137 NumberMetadataField::save_data (ARDOUR::SessionMetadata & data) const
139 uint32_t number = str_to_uint (_value);
140 CALL_MEMBER_FN (data, setter) (number);
144 NumberMetadataField::load_data (ARDOUR::SessionMetadata const & data)
146 uint32_t number = CALL_MEMBER_FN (data, getter) ();
147 _value = uint_to_str (number);
149 entry->set_text (_value);
154 NumberMetadataField::update_value ()
156 // Accpt only numbers
157 uint32_t number = str_to_uint (entry->get_text());
158 _value = uint_to_str (number);
159 entry->set_text (_value);
163 NumberMetadataField::name_widget ()
165 label = Gtk::manage (new Gtk::Label(_name + ':'));
166 label->set_alignment (1, 0.5);
171 NumberMetadataField::value_widget ()
173 value_label = Gtk::manage (new Gtk::Label(_value));
178 NumberMetadataField::edit_widget ()
180 entry = Gtk::manage (new Gtk::Entry());
182 entry->set_text (_value);
183 entry->set_width_chars (width);
184 entry->set_max_length (numbers);
185 entry->signal_changed().connect (sigc::mem_fun(*this, &NumberMetadataField::update_value));
191 NumberMetadataField::uint_to_str (uint32_t i) const
193 std::ostringstream oss ("");
195 if (oss.str().compare("0")) {
203 NumberMetadataField::str_to_uint (string const & str) const
207 while ((i = tmp.find_first_not_of("1234567890")) != string::npos) {
211 std::istringstream iss(tmp);
218 /* SessionMetadataSet */
220 SessionMetadataSet::SessionMetadataSet (string const & name)
226 SessionMetadataSet::add_data_field (MetadataPtr field)
228 list.push_back (field);
231 /* SessionMetadataSetEditable */
233 SessionMetadataSetEditable::SessionMetadataSetEditable (string const & name)
234 : SessionMetadataSet (name)
236 table.set_row_spacings (6);
237 table.set_col_spacings (12);
238 table.set_homogeneous (false);
239 vbox.pack_start (table, false, false);
240 vbox.set_spacing (6);
241 vbox.set_border_width (6);
245 SessionMetadataSetEditable::get_tab_widget ()
247 tab_widget.set_text (name);
252 SessionMetadataSetEditable::set_session (ARDOUR::Session * s)
254 SessionHandlePtr::set_session (s);
260 ARDOUR::SessionMetadata const & data = *(ARDOUR::SessionMetadata::Metadata());
262 table.resize (list.size(), 2);
265 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
267 field->load_data (data);
268 table.attach (field->name_widget(), 0, 1, row, row + 1, Gtk::FILL);
269 table.attach (field->edit_widget(), 1, 2, row, row + 1);
275 SessionMetadataSetEditable::save_data ()
277 ARDOUR::SessionMetadata & data = *(ARDOUR::SessionMetadata::Metadata());
278 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
279 (*it)->save_data(data);
283 /* SessionMetadataSetImportable */
285 SessionMetadataSetImportable::SessionMetadataSetImportable (string const & name)
286 : SessionMetadataSet (name)
287 , session_list (list)
289 tree = Gtk::ListStore::create (tree_cols);
290 tree_view.set_model (tree);
292 Gtk::TreeView::Column * viewcol;
295 Gtk::CellRendererToggle * import_render = Gtk::manage(new Gtk::CellRendererToggle());
296 import_render->signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::selection_changed));
297 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Import"), *import_render));
298 viewcol->add_attribute (import_render->property_active(), tree_cols.import);
299 tree_view.append_column (*viewcol);
301 // Add field name column
302 tree_view.append_column(_("Field"), tree_cols.field);
304 // Add values column with pango markup
305 Gtk::CellRendererText * values_render = Gtk::manage(new Gtk::CellRendererText());
306 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Values (current value on top)"), *values_render));
307 viewcol->add_attribute (values_render->property_markup(), tree_cols.values);
308 tree_view.append_column (*viewcol);
310 select_all_check.signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::select_all));
314 SessionMetadataSetImportable::get_tab_widget ()
316 tab_widget.set_text (name);
321 SessionMetadataSetImportable::get_select_all_widget ()
323 select_all_check.set_label (name);
324 return select_all_check;
328 SessionMetadataSetImportable::load_extra_data (ARDOUR::SessionMetadata const & data)
331 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataSetImportable (in load_data)!") << endmsg;
335 ARDOUR::SessionMetadata const & session_data = *(ARDOUR::SessionMetadata::Metadata());
337 MetadataPtr session_field;
338 MetadataPtr import_field;
339 DataList::iterator session_it;
340 DataList::iterator import_it;
342 // Copy list and load data to import
343 for (session_it = session_list.begin(); session_it != session_list.end(); ++session_it) {
344 session_field = *session_it;
345 session_field->load_data(session_data);
346 import_list.push_back (session_field->copy());
350 session_it = session_list.begin();
351 import_it = import_list.begin();
352 while (session_it != session_list.end() && import_it != import_list.end()) { // _should_ be the same...
353 session_field = *session_it;
354 import_field = *import_it;
356 import_field->load_data(data); // hasn't been done yet
358 // Make string for values TODO get color from somewhere?
359 string values = "<span weight=\"ultralight\" color=\"#777\">" + session_field->value() + "</span>\n"
360 + "<span weight=\"bold\">" + import_field->value() + "</span>";
362 Gtk::TreeModel::iterator row_iter = tree->append();
363 Gtk::TreeModel::Row row = *row_iter;
365 row[tree_cols.field] = import_field->name();
366 row[tree_cols.values] = values;
367 row[tree_cols.import] = false;
368 row[tree_cols.data] = import_field;
376 SessionMetadataSetImportable::save_data ()
379 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataSetImportable (in import_data)!") << endmsg;
383 ARDOUR::SessionMetadata & session_data = *(ARDOUR::SessionMetadata::Metadata());
385 Gtk::TreeModel::Children fields = tree->children();
386 Gtk::TreeModel::Children::iterator it;
387 for (it = fields.begin(); it != fields.end(); ++it) {
388 if ((*it)[tree_cols.import]) {
389 MetadataPtr field = (*it)[tree_cols.data];
390 field->save_data (session_data);
396 SessionMetadataSetImportable::select_all ()
398 select_all_check.set_inconsistent (false);
399 bool state = select_all_check.get_active();
401 Gtk::TreeModel::Children fields = tree->children();
402 Gtk::TreeModel::Children::iterator it;
403 for (it = fields.begin(); it != fields.end(); ++it) {
404 (*it)[tree_cols.import] = state;
409 SessionMetadataSetImportable::selection_changed (string const & path)
411 select_all_check.set_inconsistent (true);
413 Gtk::TreeModel::iterator iter = tree->get_iter (path);
414 bool value((*iter)[tree_cols.import]);
415 (*iter)[tree_cols.import] = !value;
418 /* SessionMetadataDialog */
420 template <typename DataSet>
421 SessionMetadataDialog<DataSet>::SessionMetadataDialog (string const & name) :
422 ArdourDialog (name, true)
424 cancel_button = add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
425 cancel_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::end_dialog));
426 save_button = add_button (Gtk::Stock::OK, Gtk::RESPONSE_ACCEPT);
427 save_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::save_and_close));
430 template <typename DataSet>
432 SessionMetadataDialog<DataSet>::init_data ( bool skip_user )
435 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataDialog (in init_data)!") << endmsg;
446 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
447 (*it)->set_session (_session);
449 notebook.append_page ((*it)->get_widget(), (*it)->get_tab_widget());
453 template <typename DataSet>
455 SessionMetadataDialog<DataSet>::load_extra_data (ARDOUR::SessionMetadata const & data)
457 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
458 (*it)->load_extra_data (data);
462 template <typename DataSet>
464 SessionMetadataDialog<DataSet>::save_data ()
466 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
471 template <typename DataSet>
473 SessionMetadataDialog<DataSet>::save_and_close ()
476 _session->set_dirty();
480 template <typename DataSet>
482 SessionMetadataDialog<DataSet>::end_dialog ()
487 template <typename DataSet>
489 SessionMetadataDialog<DataSet>::warn_user (string const & string)
491 Gtk::MessageDialog msg (string, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_OK, true);
495 template <typename DataSet>
496 boost::shared_ptr<std::list<Gtk::Widget *> >
497 SessionMetadataDialog<DataSet>::get_custom_widgets (WidgetFunc f)
499 WidgetListPtr list (new WidgetList);
500 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it)
502 DataSet * set = dynamic_cast<DataSet *> (it->get());
503 list->push_back (& CALL_MEMBER_FN (*set, f) ());
509 template <typename DataSet>
511 SessionMetadataDialog<DataSet>::add_widget (Gtk::Widget & widget)
513 get_vbox()->pack_start (widget, true, true, 0);
516 template <typename DataSet>
518 SessionMetadataDialog<DataSet>::init_user_data ()
520 DataSetPtr data_set (new DataSet (_("User")));
521 data_list.push_back (data_set);
525 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_name, &ARDOUR::SessionMetadata::set_user_name, _("Name")));
526 data_set->add_data_field (ptr);
528 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_email, &ARDOUR::SessionMetadata::set_user_email, _("Email")));
529 data_set->add_data_field (ptr);
531 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_web, &ARDOUR::SessionMetadata::set_user_web, _("Web")));
532 data_set->add_data_field (ptr);
534 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::organization, &ARDOUR::SessionMetadata::set_organization, _("Organization")));
535 data_set->add_data_field (ptr);
537 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::country, &ARDOUR::SessionMetadata::set_country, _("Country")));
538 data_set->add_data_field (ptr);
542 template <typename DataSet>
544 SessionMetadataDialog<DataSet>::init_track_data ()
546 DataSetPtr data_set (new DataSet (_("Track")));
547 data_list.push_back (data_set);
551 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::title, &ARDOUR::SessionMetadata::set_title, _("Title")));
552 data_set->add_data_field (ptr);
554 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::track_number, &ARDOUR::SessionMetadata::set_track_number, _("Track Number"), 3));
555 data_set->add_data_field (ptr);
557 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::subtitle, &ARDOUR::SessionMetadata::set_subtitle, _("Subtitle")));
558 data_set->add_data_field (ptr);
560 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::grouping, &ARDOUR::SessionMetadata::set_grouping, _("Grouping")));
561 data_set->add_data_field (ptr);
563 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::artist, &ARDOUR::SessionMetadata::set_artist, _("Artist")));
564 data_set->add_data_field (ptr);
566 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::genre, &ARDOUR::SessionMetadata::set_genre, _("Genre")));
567 data_set->add_data_field (ptr);
569 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::comment, &ARDOUR::SessionMetadata::set_comment, _("Comment")));
570 data_set->add_data_field (ptr);
572 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::copyright, &ARDOUR::SessionMetadata::set_copyright, _("Copyright")));
573 data_set->add_data_field (ptr);
576 template <typename DataSet>
578 SessionMetadataDialog<DataSet>::init_album_data ()
580 DataSetPtr data_set (new DataSet (_("Album")));
581 data_list.push_back (data_set);
585 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album, &ARDOUR::SessionMetadata::set_album, _("Album")));
586 data_set->add_data_field (ptr);
588 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::year, &ARDOUR::SessionMetadata::set_year, _("Year"), 4));
589 data_set->add_data_field (ptr);
591 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album_artist, &ARDOUR::SessionMetadata::set_album_artist, _("Album Artist")));
592 data_set->add_data_field (ptr);
594 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_tracks, &ARDOUR::SessionMetadata::set_total_tracks, _("Total Tracks"), 3));
595 data_set->add_data_field (ptr);
597 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::disc_subtitle, &ARDOUR::SessionMetadata::set_disc_subtitle, _("Disc Subtitle")));
598 data_set->add_data_field (ptr);
600 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::disc_number, &ARDOUR::SessionMetadata::set_disc_number, _("Disc Number"), 2));
601 data_set->add_data_field (ptr);
603 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_discs, &ARDOUR::SessionMetadata::set_total_discs, _("Total Discs"), 2));
604 data_set->add_data_field (ptr);
606 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::compilation, &ARDOUR::SessionMetadata::set_compilation, _("Compilation")));
607 data_set->add_data_field (ptr);
609 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::isrc, &ARDOUR::SessionMetadata::set_isrc, _("ISRC")));
610 data_set->add_data_field (ptr);
613 template <typename DataSet>
615 SessionMetadataDialog<DataSet>::init_people_data ()
617 DataSetPtr data_set (new DataSet (_("People")));
618 data_list.push_back (data_set);
622 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::lyricist, &ARDOUR::SessionMetadata::set_lyricist, _("Lyricist")));
623 data_set->add_data_field (ptr);
625 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::composer, &ARDOUR::SessionMetadata::set_composer, _("Composer")));
626 data_set->add_data_field (ptr);
628 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::conductor, &ARDOUR::SessionMetadata::set_conductor, _("Conductor")));
629 data_set->add_data_field (ptr);
631 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::remixer, &ARDOUR::SessionMetadata::set_remixer, _("Remixer")));
632 data_set->add_data_field (ptr);
634 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::arranger, &ARDOUR::SessionMetadata::set_arranger, _("Arranger")));
635 data_set->add_data_field (ptr);
637 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::engineer, &ARDOUR::SessionMetadata::set_engineer, _("Engineer")));
638 data_set->add_data_field (ptr);
640 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::producer, &ARDOUR::SessionMetadata::set_producer, _("Producer")));
641 data_set->add_data_field (ptr);
643 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::dj_mixer, &ARDOUR::SessionMetadata::set_dj_mixer, _("DJ Mixer")));
644 data_set->add_data_field (ptr);
646 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::mixer, &ARDOUR::SessionMetadata::set_mixer, S_("Metadata|Mixer")));
647 data_set->add_data_field (ptr);
650 template <typename DataSet>
652 SessionMetadataDialog<DataSet>::init_school_data ()
654 DataSetPtr data_set (new DataSet (_("School")));
655 data_list.push_back (data_set);
659 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::instructor, &ARDOUR::SessionMetadata::set_instructor, _("Instructor")));
660 data_set->add_data_field (ptr);
662 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::course, &ARDOUR::SessionMetadata::set_course, _("Course")));
663 data_set->add_data_field (ptr);
667 /* SessionMetadataEditor */
669 SessionMetadataEditor::SessionMetadataEditor () :
670 SessionMetadataDialog<SessionMetadataSetEditable> (_("Edit Session Metadata"))
675 SessionMetadataEditor::~SessionMetadataEditor ()
677 // Remove pages from notebook to get rid of gsignal runtime warnings
678 notebook.pages().clear();
682 SessionMetadataEditor::run ()
691 SessionMetadataEditor::init_gui ()
693 add_widget (notebook);
698 /* SessionMetadataImporter */
700 SessionMetadataImporter::SessionMetadataImporter () :
701 SessionMetadataDialog<SessionMetadataSetImportable> (_("Import session metadata"))
706 SessionMetadataImporter::~SessionMetadataImporter ()
708 // Remove pages from notebook to get rid of gsignal runtime warnings
709 notebook.pages().clear();
713 SessionMetadataImporter::run ()
716 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataImporter (in run)!") << endmsg;
720 /* Open session file selector */
722 Gtk::FileChooserDialog session_selector(_("Choose session to import metadata from"), Gtk::FILE_CHOOSER_ACTION_OPEN);
723 session_selector.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
724 session_selector.add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
725 session_selector.set_default_response(Gtk::RESPONSE_ACCEPT);
727 Gtk::FileFilter session_filter;
728 session_filter.add_pattern ("*.ardour");
729 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
730 session_selector.add_filter (session_filter);
731 session_selector.set_filter (session_filter);
733 int response = session_selector.run();
734 session_selector.hide ();
737 case Gtk::RESPONSE_ACCEPT:
743 string session_path = session_selector.get_filename();
747 if (session_path.length() > 0) {
748 if (ARDOUR::find_session (session_path, path, name, isnew) != 0) {
755 /* We have a session: load the data and run dialog */
757 string filename = Glib::build_filename (path, name + ".ardour");
758 XMLTree session_tree;
759 if (!session_tree.read (filename)) {
760 warn_user (_("This session file could not be read!"));
764 /* XXX GET VERSION FROM TREE */
767 XMLNode * node = session_tree.root()->child ("Metadata");
770 warn_user (_("The session file didn't contain metadata!\nMaybe this is an old session format?"));
775 ARDOUR::SessionMetadata data;
776 data.set_state (*node, version);
777 init_data ( true ); //skip user data here
778 load_extra_data (data);
785 SessionMetadataImporter::init_gui ()
787 // Select all from -widget
788 add_widget (selection_hbox);
789 selection_label.set_text (_("Import all from:"));
790 selection_hbox.pack_start (selection_label, false, false);
792 WidgetListPtr list = get_custom_widgets (&SessionMetadataSetImportable::get_select_all_widget);
793 for (WidgetList::iterator it = list->begin(); it != list->end(); ++it) {
794 selection_hbox.pack_start (**it, false, false, 6);
797 add_widget (notebook);