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/filename_extensions.h"
30 #include "ardour/session.h"
31 #include "ardour/session_utils.h"
39 #define CALL_MEMBER_FN(object,ptrToMember) ((object).*(ptrToMember))
41 /*** MetadataField ***/
43 MetadataField::MetadataField (string const & field_name) :
48 MetadataField::~MetadataField() { }
50 /* TextMetadataField */
52 TextMetadataField::TextMetadataField (Getter getter, Setter setter, string const & field_name, guint width ) :
53 MetadataField (field_name),
64 TextMetadataField::copy ()
66 return MetadataPtr (new TextMetadataField (getter, setter, _name, width));
70 TextMetadataField::save_data (ARDOUR::SessionMetadata & data) const
72 CALL_MEMBER_FN (data, setter) (_value);
76 TextMetadataField::load_data (ARDOUR::SessionMetadata const & data)
78 _value = CALL_MEMBER_FN (data, getter) ();
80 entry->set_text (_value);
85 TextMetadataField::name_widget ()
87 label = Gtk::manage (new Gtk::Label(_name + ':'));
88 label->set_alignment (1, 0.5);
93 TextMetadataField::value_widget ()
95 value_label = Gtk::manage (new Gtk::Label(_value));
100 TextMetadataField::edit_widget ()
102 entry = Gtk::manage (new Gtk::Entry());
104 entry->set_text (_value);
105 entry->set_width_chars (width);
106 entry->signal_changed().connect (sigc::mem_fun(*this, &TextMetadataField::update_value));
112 TextMetadataField::update_value ()
114 _value = entry->get_text ();
117 /* NumberMetadataField */
119 NumberMetadataField::NumberMetadataField (Getter getter, Setter setter, string const & field_name, guint numbers, guint width) :
120 MetadataField (field_name),
132 NumberMetadataField::copy ()
134 return MetadataPtr (new NumberMetadataField (getter, setter, _name, numbers, width));
138 NumberMetadataField::save_data (ARDOUR::SessionMetadata & data) const
140 uint32_t number = str_to_uint (_value);
141 CALL_MEMBER_FN (data, setter) (number);
145 NumberMetadataField::load_data (ARDOUR::SessionMetadata const & data)
147 uint32_t number = CALL_MEMBER_FN (data, getter) ();
148 _value = uint_to_str (number);
150 entry->set_text (_value);
155 NumberMetadataField::update_value ()
157 // Accpt only numbers
158 uint32_t number = str_to_uint (entry->get_text());
159 _value = uint_to_str (number);
160 entry->set_text (_value);
164 NumberMetadataField::name_widget ()
166 label = Gtk::manage (new Gtk::Label(_name + ':'));
167 label->set_alignment (1, 0.5);
172 NumberMetadataField::value_widget ()
174 value_label = Gtk::manage (new Gtk::Label(_value));
179 NumberMetadataField::edit_widget ()
181 entry = Gtk::manage (new Gtk::Entry());
183 entry->set_text (_value);
184 entry->set_width_chars (width);
185 entry->set_max_length (numbers);
186 entry->signal_changed().connect (sigc::mem_fun(*this, &NumberMetadataField::update_value));
192 NumberMetadataField::uint_to_str (uint32_t i) const
194 std::ostringstream oss ("");
196 if (oss.str().compare("0")) {
204 NumberMetadataField::str_to_uint (string const & str) const
208 while ((i = tmp.find_first_not_of("1234567890")) != string::npos) {
212 std::istringstream iss(tmp);
219 /* SessionMetadataSet */
221 SessionMetadataSet::SessionMetadataSet (string const & name)
227 SessionMetadataSet::add_data_field (MetadataPtr field)
229 list.push_back (field);
232 /* SessionMetadataSetEditable */
234 SessionMetadataSetEditable::SessionMetadataSetEditable (string const & name)
235 : SessionMetadataSet (name)
237 table.set_row_spacings (6);
238 table.set_col_spacings (12);
239 table.set_homogeneous (false);
240 vbox.pack_start (table, false, false);
241 vbox.set_spacing (6);
242 vbox.set_border_width (6);
246 SessionMetadataSetEditable::get_tab_widget ()
248 tab_widget.set_text (name);
253 SessionMetadataSetEditable::set_session (ARDOUR::Session * s)
255 SessionHandlePtr::set_session (s);
261 ARDOUR::SessionMetadata const & data = *(ARDOUR::SessionMetadata::Metadata());
263 table.resize (list.size(), 2);
266 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
268 field->load_data (data);
269 table.attach (field->name_widget(), 0, 1, row, row + 1, Gtk::FILL);
270 table.attach (field->edit_widget(), 1, 2, row, row + 1);
276 SessionMetadataSetEditable::save_data ()
278 ARDOUR::SessionMetadata & data = *(ARDOUR::SessionMetadata::Metadata());
279 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
280 (*it)->save_data(data);
284 /* SessionMetadataSetImportable */
286 SessionMetadataSetImportable::SessionMetadataSetImportable (string const & name)
287 : SessionMetadataSet (name)
288 , session_list (list)
290 tree = Gtk::ListStore::create (tree_cols);
291 tree_view.set_model (tree);
293 Gtk::TreeView::Column * viewcol;
296 Gtk::CellRendererToggle * import_render = Gtk::manage(new Gtk::CellRendererToggle());
297 import_render->signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::selection_changed));
298 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Import"), *import_render));
299 viewcol->add_attribute (import_render->property_active(), tree_cols.import);
300 tree_view.append_column (*viewcol);
302 // Add field name column
303 tree_view.append_column(_("Field"), tree_cols.field);
305 // Add values column with pango markup
306 Gtk::CellRendererText * values_render = Gtk::manage(new Gtk::CellRendererText());
307 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Values (current value on top)"), *values_render));
308 viewcol->add_attribute (values_render->property_markup(), tree_cols.values);
309 tree_view.append_column (*viewcol);
311 select_all_check.signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::select_all));
315 SessionMetadataSetImportable::get_tab_widget ()
317 tab_widget.set_text (name);
322 SessionMetadataSetImportable::get_select_all_widget ()
324 select_all_check.set_label (name);
325 return select_all_check;
329 SessionMetadataSetImportable::load_extra_data (ARDOUR::SessionMetadata const & data)
332 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataSetImportable (in load_data)!") << endmsg;
336 ARDOUR::SessionMetadata const & session_data = *(ARDOUR::SessionMetadata::Metadata());
338 MetadataPtr session_field;
339 MetadataPtr import_field;
340 DataList::iterator session_it;
341 DataList::iterator import_it;
343 // Copy list and load data to import
344 for (session_it = session_list.begin(); session_it != session_list.end(); ++session_it) {
345 session_field = *session_it;
346 session_field->load_data(session_data);
347 import_list.push_back (session_field->copy());
351 session_it = session_list.begin();
352 import_it = import_list.begin();
353 while (session_it != session_list.end() && import_it != import_list.end()) { // _should_ be the same...
354 session_field = *session_it;
355 import_field = *import_it;
357 import_field->load_data(data); // hasn't been done yet
359 // Make string for values TODO get color from somewhere?
360 string values = "<span weight=\"ultralight\" color=\"#777\">" + session_field->value() + "</span>\n"
361 + "<span weight=\"bold\">" + import_field->value() + "</span>";
363 Gtk::TreeModel::iterator row_iter = tree->append();
364 Gtk::TreeModel::Row row = *row_iter;
366 row[tree_cols.field] = import_field->name();
367 row[tree_cols.values] = values;
368 row[tree_cols.import] = false;
369 row[tree_cols.data] = import_field;
377 SessionMetadataSetImportable::save_data ()
380 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataSetImportable (in import_data)!") << endmsg;
384 ARDOUR::SessionMetadata & session_data = *(ARDOUR::SessionMetadata::Metadata());
386 Gtk::TreeModel::Children fields = tree->children();
387 Gtk::TreeModel::Children::iterator it;
388 for (it = fields.begin(); it != fields.end(); ++it) {
389 if ((*it)[tree_cols.import]) {
390 MetadataPtr field = (*it)[tree_cols.data];
391 field->save_data (session_data);
397 SessionMetadataSetImportable::select_all ()
399 select_all_check.set_inconsistent (false);
400 bool state = select_all_check.get_active();
402 Gtk::TreeModel::Children fields = tree->children();
403 Gtk::TreeModel::Children::iterator it;
404 for (it = fields.begin(); it != fields.end(); ++it) {
405 (*it)[tree_cols.import] = state;
410 SessionMetadataSetImportable::selection_changed (string const & path)
412 select_all_check.set_inconsistent (true);
414 Gtk::TreeModel::iterator iter = tree->get_iter (path);
415 bool value((*iter)[tree_cols.import]);
416 (*iter)[tree_cols.import] = !value;
419 /* SessionMetadataDialog */
421 template <typename DataSet>
422 SessionMetadataDialog<DataSet>::SessionMetadataDialog (string const & name) :
423 ArdourDialog (name, true)
425 cancel_button = add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
426 cancel_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::end_dialog));
427 save_button = add_button (Gtk::Stock::OK, Gtk::RESPONSE_ACCEPT);
428 save_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::save_and_close));
431 template <typename DataSet>
433 SessionMetadataDialog<DataSet>::init_data ( bool skip_user )
436 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataDialog (in init_data)!") << endmsg;
447 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
448 (*it)->set_session (_session);
450 notebook.append_page ((*it)->get_widget(), (*it)->get_tab_widget());
454 template <typename DataSet>
456 SessionMetadataDialog<DataSet>::load_extra_data (ARDOUR::SessionMetadata const & data)
458 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
459 (*it)->load_extra_data (data);
463 template <typename DataSet>
465 SessionMetadataDialog<DataSet>::save_data ()
467 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
472 template <typename DataSet>
474 SessionMetadataDialog<DataSet>::save_and_close ()
477 _session->set_dirty();
481 template <typename DataSet>
483 SessionMetadataDialog<DataSet>::end_dialog ()
488 template <typename DataSet>
490 SessionMetadataDialog<DataSet>::warn_user (string const & string)
492 Gtk::MessageDialog msg (string, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_OK, true);
496 template <typename DataSet>
497 boost::shared_ptr<std::list<Gtk::Widget *> >
498 SessionMetadataDialog<DataSet>::get_custom_widgets (WidgetFunc f)
500 WidgetListPtr list (new WidgetList);
501 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it)
503 DataSet * set = dynamic_cast<DataSet *> (it->get());
504 list->push_back (& CALL_MEMBER_FN (*set, f) ());
510 template <typename DataSet>
512 SessionMetadataDialog<DataSet>::add_widget (Gtk::Widget & widget)
514 get_vbox()->pack_start (widget, true, true, 0);
517 template <typename DataSet>
519 SessionMetadataDialog<DataSet>::init_user_data ()
521 DataSetPtr data_set (new DataSet (_("User")));
522 data_list.push_back (data_set);
526 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_name, &ARDOUR::SessionMetadata::set_user_name, _("Name")));
527 data_set->add_data_field (ptr);
529 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_email, &ARDOUR::SessionMetadata::set_user_email, _("Email")));
530 data_set->add_data_field (ptr);
532 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_web, &ARDOUR::SessionMetadata::set_user_web, _("Web")));
533 data_set->add_data_field (ptr);
535 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::organization, &ARDOUR::SessionMetadata::set_organization, _("Organization")));
536 data_set->add_data_field (ptr);
538 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::country, &ARDOUR::SessionMetadata::set_country, _("Country")));
539 data_set->add_data_field (ptr);
543 template <typename DataSet>
545 SessionMetadataDialog<DataSet>::init_track_data ()
547 DataSetPtr data_set (new DataSet (_("Track")));
548 data_list.push_back (data_set);
552 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::title, &ARDOUR::SessionMetadata::set_title, _("Title")));
553 data_set->add_data_field (ptr);
555 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::track_number, &ARDOUR::SessionMetadata::set_track_number, _("Track Number"), 3));
556 data_set->add_data_field (ptr);
558 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::subtitle, &ARDOUR::SessionMetadata::set_subtitle, _("Subtitle")));
559 data_set->add_data_field (ptr);
561 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::grouping, &ARDOUR::SessionMetadata::set_grouping, _("Grouping")));
562 data_set->add_data_field (ptr);
564 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::artist, &ARDOUR::SessionMetadata::set_artist, _("Artist")));
565 data_set->add_data_field (ptr);
567 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::genre, &ARDOUR::SessionMetadata::set_genre, _("Genre")));
568 data_set->add_data_field (ptr);
570 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::comment, &ARDOUR::SessionMetadata::set_comment, _("Comment")));
571 data_set->add_data_field (ptr);
573 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::copyright, &ARDOUR::SessionMetadata::set_copyright, _("Copyright")));
574 data_set->add_data_field (ptr);
577 template <typename DataSet>
579 SessionMetadataDialog<DataSet>::init_album_data ()
581 DataSetPtr data_set (new DataSet (_("Album")));
582 data_list.push_back (data_set);
586 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album, &ARDOUR::SessionMetadata::set_album, _("Album")));
587 data_set->add_data_field (ptr);
589 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::year, &ARDOUR::SessionMetadata::set_year, _("Year"), 4));
590 data_set->add_data_field (ptr);
592 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album_artist, &ARDOUR::SessionMetadata::set_album_artist, _("Album Artist")));
593 data_set->add_data_field (ptr);
595 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_tracks, &ARDOUR::SessionMetadata::set_total_tracks, _("Total Tracks"), 3));
596 data_set->add_data_field (ptr);
598 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::disc_subtitle, &ARDOUR::SessionMetadata::set_disc_subtitle, _("Disc Subtitle")));
599 data_set->add_data_field (ptr);
601 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::disc_number, &ARDOUR::SessionMetadata::set_disc_number, _("Disc Number"), 2));
602 data_set->add_data_field (ptr);
604 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_discs, &ARDOUR::SessionMetadata::set_total_discs, _("Total Discs"), 2));
605 data_set->add_data_field (ptr);
607 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::compilation, &ARDOUR::SessionMetadata::set_compilation, _("Compilation")));
608 data_set->add_data_field (ptr);
610 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::isrc, &ARDOUR::SessionMetadata::set_isrc, _("ISRC")));
611 data_set->add_data_field (ptr);
614 template <typename DataSet>
616 SessionMetadataDialog<DataSet>::init_people_data ()
618 DataSetPtr data_set (new DataSet (_("People")));
619 data_list.push_back (data_set);
623 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::lyricist, &ARDOUR::SessionMetadata::set_lyricist, _("Lyricist")));
624 data_set->add_data_field (ptr);
626 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::composer, &ARDOUR::SessionMetadata::set_composer, _("Composer")));
627 data_set->add_data_field (ptr);
629 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::conductor, &ARDOUR::SessionMetadata::set_conductor, _("Conductor")));
630 data_set->add_data_field (ptr);
632 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::remixer, &ARDOUR::SessionMetadata::set_remixer, _("Remixer")));
633 data_set->add_data_field (ptr);
635 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::arranger, &ARDOUR::SessionMetadata::set_arranger, _("Arranger")));
636 data_set->add_data_field (ptr);
638 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::engineer, &ARDOUR::SessionMetadata::set_engineer, _("Engineer")));
639 data_set->add_data_field (ptr);
641 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::producer, &ARDOUR::SessionMetadata::set_producer, _("Producer")));
642 data_set->add_data_field (ptr);
644 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::dj_mixer, &ARDOUR::SessionMetadata::set_dj_mixer, _("DJ Mixer")));
645 data_set->add_data_field (ptr);
647 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::mixer, &ARDOUR::SessionMetadata::set_mixer, S_("Metadata|Mixer")));
648 data_set->add_data_field (ptr);
651 template <typename DataSet>
653 SessionMetadataDialog<DataSet>::init_school_data ()
655 DataSetPtr data_set (new DataSet (_("School")));
656 data_list.push_back (data_set);
660 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::instructor, &ARDOUR::SessionMetadata::set_instructor, _("Instructor")));
661 data_set->add_data_field (ptr);
663 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::course, &ARDOUR::SessionMetadata::set_course, _("Course")));
664 data_set->add_data_field (ptr);
668 /* SessionMetadataEditor */
670 SessionMetadataEditor::SessionMetadataEditor () :
671 SessionMetadataDialog<SessionMetadataSetEditable> (_("Edit Session Metadata"))
676 SessionMetadataEditor::~SessionMetadataEditor ()
678 // Remove pages from notebook to get rid of gsignal runtime warnings
679 notebook.pages().clear();
683 SessionMetadataEditor::run ()
692 SessionMetadataEditor::init_gui ()
694 add_widget (notebook);
699 /* SessionMetadataImporter */
701 SessionMetadataImporter::SessionMetadataImporter () :
702 SessionMetadataDialog<SessionMetadataSetImportable> (_("Import session metadata"))
707 SessionMetadataImporter::~SessionMetadataImporter ()
709 // Remove pages from notebook to get rid of gsignal runtime warnings
710 notebook.pages().clear();
714 SessionMetadataImporter::run ()
717 error << string_compose (_("programming error: %1"), "no session set for SessionMetaDataImporter (in run)!") << endmsg;
721 /* Open session file selector */
723 Gtk::FileChooserDialog session_selector(_("Choose session to import metadata from"), Gtk::FILE_CHOOSER_ACTION_OPEN);
724 session_selector.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
725 session_selector.add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
726 session_selector.set_default_response(Gtk::RESPONSE_ACCEPT);
728 Gtk::FileFilter session_filter;
729 session_filter.add_pattern (string_compose(X_("*.%1"), ARDOUR::statefile_suffix));
730 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
731 session_selector.add_filter (session_filter);
732 session_selector.set_filter (session_filter);
734 int response = session_selector.run();
735 session_selector.hide ();
738 case Gtk::RESPONSE_ACCEPT:
744 string session_path = session_selector.get_filename();
748 if (session_path.length() > 0) {
749 if (ARDOUR::find_session (session_path, path, name, isnew) != 0) {
756 /* We have a session: load the data and run dialog */
758 string filename = Glib::build_filename (path, name + "." + ARDOUR::statefile_suffix);
759 XMLTree session_tree;
760 if (!session_tree.read (filename)) {
761 warn_user (_("This session file could not be read!"));
765 /* XXX GET VERSION FROM TREE */
768 XMLNode * node = session_tree.root()->child ("Metadata");
771 warn_user (_("The session file didn't contain metadata!\nMaybe this is an old session format?"));
776 ARDOUR::SessionMetadata data;
777 data.set_state (*node, version);
778 init_data ( true ); //skip user data here
779 load_extra_data (data);
786 SessionMetadataImporter::init_gui ()
788 // Select all from -widget
789 add_widget (selection_hbox);
790 selection_label.set_text (_("Import all from:"));
791 selection_hbox.pack_start (selection_label, false, false);
793 WidgetListPtr list = get_custom_widgets (&SessionMetadataSetImportable::get_select_all_widget);
794 for (WidgetList::iterator it = list->begin(); it != list->end(); ++it) {
795 selection_hbox.pack_start (**it, false, false, 6);
798 add_widget (notebook);