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"
28 #include "ardour/session.h"
29 #include "ardour/session_utils.h"
36 #define CALL_MEMBER_FN(object,ptrToMember) ((object).*(ptrToMember))
38 /*** MetadataField ***/
40 MetadataField::MetadataField (string const & field_name) :
45 MetadataField::~MetadataField() { }
47 /* TextMetadataField */
49 TextMetadataField::TextMetadataField (Getter getter, Setter setter, string const & field_name, guint width ) :
50 MetadataField (field_name),
61 TextMetadataField::copy ()
63 return MetadataPtr (new TextMetadataField (getter, setter, _name, width));
67 TextMetadataField::save_data (ARDOUR::SessionMetadata & data) const
69 CALL_MEMBER_FN (data, setter) (_value);
73 TextMetadataField::load_data (ARDOUR::SessionMetadata const & data)
75 _value = CALL_MEMBER_FN (data, getter) ();
77 entry->set_text (_value);
82 TextMetadataField::name_widget ()
84 label = Gtk::manage (new Gtk::Label(_name + ':'));
85 label->set_alignment (1, 0.5);
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, string 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 + ':'));
164 label->set_alignment (1, 0.5);
169 NumberMetadataField::value_widget ()
171 value_label = Gtk::manage (new Gtk::Label(_value));
176 NumberMetadataField::edit_widget ()
178 entry = Gtk::manage (new Gtk::Entry());
180 entry->set_text (_value);
181 entry->set_width_chars (width);
182 entry->set_max_length (numbers);
183 entry->signal_changed().connect (sigc::mem_fun(*this, &NumberMetadataField::update_value));
189 NumberMetadataField::uint_to_str (uint32_t i) const
191 std::ostringstream oss ("");
193 if (oss.str().compare("0")) {
201 NumberMetadataField::str_to_uint (string const & str) const
205 while ((i = tmp.find_first_not_of("1234567890")) != string::npos) {
209 std::istringstream iss(tmp);
216 /* SessionMetadataSet */
218 SessionMetadataSet::SessionMetadataSet (string const & name)
224 SessionMetadataSet::add_data_field (MetadataPtr field)
226 list.push_back (field);
229 /* SessionMetadataSetEditable */
231 SessionMetadataSetEditable::SessionMetadataSetEditable (string const & name)
232 : SessionMetadataSet (name)
234 table.set_row_spacings (6);
235 table.set_col_spacings (12);
236 table.set_homogeneous (false);
237 vbox.pack_start (table, false, false);
238 vbox.set_spacing (6);
239 vbox.set_border_width (6);
243 SessionMetadataSetEditable::get_tab_widget ()
245 tab_widget.set_text (name);
250 SessionMetadataSetEditable::set_session (ARDOUR::Session * s)
252 SessionHandlePtr::set_session (s);
258 ARDOUR::SessionMetadata const & data = *(ARDOUR::SessionMetadata::Metadata());
260 table.resize (list.size(), 2);
263 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
265 field->load_data (data);
266 table.attach (field->name_widget(), 0, 1, row, row + 1, Gtk::FILL);
267 table.attach (field->edit_widget(), 1, 2, row, row + 1);
273 SessionMetadataSetEditable::save_data ()
275 ARDOUR::SessionMetadata & data = *(ARDOUR::SessionMetadata::Metadata());
276 for (DataList::const_iterator it = list.begin(); it != list.end(); ++it) {
277 (*it)->save_data(data);
281 /* SessionMetadataSetImportable */
283 SessionMetadataSetImportable::SessionMetadataSetImportable (string const & name)
284 : SessionMetadataSet (name)
285 , session_list (list)
287 tree = Gtk::ListStore::create (tree_cols);
288 tree_view.set_model (tree);
290 Gtk::TreeView::Column * viewcol;
293 Gtk::CellRendererToggle * import_render = Gtk::manage(new Gtk::CellRendererToggle());
294 import_render->signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::selection_changed));
295 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Import"), *import_render));
296 viewcol->add_attribute (import_render->property_active(), tree_cols.import);
297 tree_view.append_column (*viewcol);
299 // Add field name column
300 tree_view.append_column(_("Field"), tree_cols.field);
302 // Add values column with pango markup
303 Gtk::CellRendererText * values_render = Gtk::manage(new Gtk::CellRendererText());
304 viewcol = Gtk::manage(new Gtk::TreeView::Column (_("Values (current value on top)"), *values_render));
305 viewcol->add_attribute (values_render->property_markup(), tree_cols.values);
306 tree_view.append_column (*viewcol);
308 select_all_check.signal_toggled().connect (sigc::mem_fun(*this, &SessionMetadataSetImportable::select_all));
312 SessionMetadataSetImportable::get_tab_widget ()
314 tab_widget.set_text (name);
319 SessionMetadataSetImportable::get_select_all_widget ()
321 select_all_check.set_label (name);
322 return select_all_check;
326 SessionMetadataSetImportable::load_extra_data (ARDOUR::SessionMetadata const & data)
329 std::cerr << "Programming error: no session set for SessionMetaDataSetImportable (in load_data)!" << std::endl;
333 ARDOUR::SessionMetadata const & session_data = *(ARDOUR::SessionMetadata::Metadata());
335 MetadataPtr session_field;
336 MetadataPtr import_field;
337 DataList::iterator session_it;
338 DataList::iterator import_it;
340 // Copy list and load data to import
341 for (session_it = session_list.begin(); session_it != session_list.end(); ++session_it) {
342 session_field = *session_it;
343 session_field->load_data(session_data);
344 import_list.push_back (session_field->copy());
348 session_it = session_list.begin();
349 import_it = import_list.begin();
350 while (session_it != session_list.end() && import_it != import_list.end()) { // _should_ be the same...
351 session_field = *session_it;
352 import_field = *import_it;
354 import_field->load_data(data); // hasn't been done yet
356 // Make string for values TODO get color from somewhere?
357 string values = "<span weight=\"ultralight\" color=\"#777\">" + session_field->value() + "</span>\n"
358 + "<span weight=\"bold\">" + import_field->value() + "</span>";
360 Gtk::TreeModel::iterator row_iter = tree->append();
361 Gtk::TreeModel::Row row = *row_iter;
363 row[tree_cols.field] = import_field->name();
364 row[tree_cols.values] = values;
365 row[tree_cols.import] = false;
366 row[tree_cols.data] = import_field;
374 SessionMetadataSetImportable::save_data ()
377 std::cerr << "Programming error: no session set for SessionMetaDataSetImportable (in import_data)!" << std::endl;
381 ARDOUR::SessionMetadata & session_data = *(ARDOUR::SessionMetadata::Metadata());
383 Gtk::TreeModel::Children fields = tree->children();
384 Gtk::TreeModel::Children::iterator it;
385 for (it = fields.begin(); it != fields.end(); ++it) {
386 if ((*it)[tree_cols.import]) {
387 MetadataPtr field = (*it)[tree_cols.data];
388 field->save_data (session_data);
394 SessionMetadataSetImportable::select_all ()
396 select_all_check.set_inconsistent (false);
397 bool state = select_all_check.get_active();
399 Gtk::TreeModel::Children fields = tree->children();
400 Gtk::TreeModel::Children::iterator it;
401 for (it = fields.begin(); it != fields.end(); ++it) {
402 (*it)[tree_cols.import] = state;
407 SessionMetadataSetImportable::selection_changed (string const & path)
409 select_all_check.set_inconsistent (true);
411 Gtk::TreeModel::iterator iter = tree->get_iter (path);
412 bool value((*iter)[tree_cols.import]);
413 (*iter)[tree_cols.import] = !value;
416 /* SessionMetadataDialog */
418 template <typename DataSet>
419 SessionMetadataDialog<DataSet>::SessionMetadataDialog (string const & name) :
420 ArdourDialog (name, true)
422 cancel_button = add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
423 cancel_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::end_dialog));
424 save_button = add_button (Gtk::Stock::OK, Gtk::RESPONSE_ACCEPT);
425 save_button->signal_clicked().connect (sigc::mem_fun(*this, &SessionMetadataDialog::save_and_close));
428 template <typename DataSet>
430 SessionMetadataDialog<DataSet>::init_data ( bool skip_user )
433 std::cerr << "Programming error: no session set for SessionMetaDataDialog (in init_data)!" << std::endl;
444 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
445 (*it)->set_session (_session);
447 notebook.append_page ((*it)->get_widget(), (*it)->get_tab_widget());
451 template <typename DataSet>
453 SessionMetadataDialog<DataSet>::load_extra_data (ARDOUR::SessionMetadata const & data)
455 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
456 (*it)->load_extra_data (data);
460 template <typename DataSet>
462 SessionMetadataDialog<DataSet>::save_data ()
464 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it) {
469 template <typename DataSet>
471 SessionMetadataDialog<DataSet>::save_and_close ()
474 _session->set_dirty();
478 template <typename DataSet>
480 SessionMetadataDialog<DataSet>::end_dialog ()
485 template <typename DataSet>
487 SessionMetadataDialog<DataSet>::warn_user (string const & string)
489 Gtk::MessageDialog msg (string, false, Gtk::MESSAGE_WARNING, Gtk::BUTTONS_OK, true);
493 template <typename DataSet>
494 boost::shared_ptr<std::list<Gtk::Widget *> >
495 SessionMetadataDialog<DataSet>::get_custom_widgets (WidgetFunc f)
497 WidgetListPtr list (new WidgetList);
498 for (DataSetList::iterator it = data_list.begin(); it != data_list.end(); ++it)
500 DataSet * set = dynamic_cast<DataSet *> (it->get());
501 list->push_back (& CALL_MEMBER_FN (*set, f) ());
507 template <typename DataSet>
509 SessionMetadataDialog<DataSet>::add_widget (Gtk::Widget & widget)
511 get_vbox()->pack_start (widget, true, true, 0);
514 template <typename DataSet>
516 SessionMetadataDialog<DataSet>::init_user_data ()
518 DataSetPtr data_set (new DataSet (_("User")));
519 data_list.push_back (data_set);
523 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_name, &ARDOUR::SessionMetadata::set_user_name, _("Name")));
524 data_set->add_data_field (ptr);
526 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_email, &ARDOUR::SessionMetadata::set_user_email, _("Email")));
527 data_set->add_data_field (ptr);
529 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::user_web, &ARDOUR::SessionMetadata::set_user_web, _("Web")));
530 data_set->add_data_field (ptr);
532 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::organization, &ARDOUR::SessionMetadata::set_organization, _("Organization")));
533 data_set->add_data_field (ptr);
535 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::country, &ARDOUR::SessionMetadata::set_country, _("Country")));
536 data_set->add_data_field (ptr);
540 template <typename DataSet>
542 SessionMetadataDialog<DataSet>::init_track_data ()
544 DataSetPtr data_set (new DataSet (_("Track")));
545 data_list.push_back (data_set);
549 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::title, &ARDOUR::SessionMetadata::set_title, _("Title")));
550 data_set->add_data_field (ptr);
552 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::track_number, &ARDOUR::SessionMetadata::set_track_number, _("Track Number"), 3));
553 data_set->add_data_field (ptr);
555 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::subtitle, &ARDOUR::SessionMetadata::set_subtitle, _("Subtitle")));
556 data_set->add_data_field (ptr);
558 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::grouping, &ARDOUR::SessionMetadata::set_grouping, _("Grouping")));
559 data_set->add_data_field (ptr);
561 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::artist, &ARDOUR::SessionMetadata::set_artist, _("Artist")));
562 data_set->add_data_field (ptr);
564 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::genre, &ARDOUR::SessionMetadata::set_genre, _("Genre")));
565 data_set->add_data_field (ptr);
567 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::comment, &ARDOUR::SessionMetadata::set_comment, _("Comment")));
568 data_set->add_data_field (ptr);
570 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::copyright, &ARDOUR::SessionMetadata::set_copyright, _("Copyright")));
571 data_set->add_data_field (ptr);
574 template <typename DataSet>
576 SessionMetadataDialog<DataSet>::init_album_data ()
578 DataSetPtr data_set (new DataSet (_("Album")));
579 data_list.push_back (data_set);
583 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album, &ARDOUR::SessionMetadata::set_album, _("Album")));
584 data_set->add_data_field (ptr);
586 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::year, &ARDOUR::SessionMetadata::set_year, _("Year"), 4));
587 data_set->add_data_field (ptr);
589 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::album_artist, &ARDOUR::SessionMetadata::set_album_artist, _("Album Artist")));
590 data_set->add_data_field (ptr);
592 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_tracks, &ARDOUR::SessionMetadata::set_total_tracks, _("Total Tracks"), 3));
593 data_set->add_data_field (ptr);
595 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::disc_subtitle, &ARDOUR::SessionMetadata::set_disc_subtitle, _("Disc Subtitle")));
596 data_set->add_data_field (ptr);
598 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::disc_number, &ARDOUR::SessionMetadata::set_disc_number, _("Disc Number"), 2));
599 data_set->add_data_field (ptr);
601 ptr = MetadataPtr (new NumberMetadataField (&ARDOUR::SessionMetadata::total_discs, &ARDOUR::SessionMetadata::set_total_discs, _("Total Discs"), 2));
602 data_set->add_data_field (ptr);
604 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::compilation, &ARDOUR::SessionMetadata::set_compilation, _("Compilation")));
605 data_set->add_data_field (ptr);
607 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::isrc, &ARDOUR::SessionMetadata::set_isrc, _("ISRC")));
608 data_set->add_data_field (ptr);
611 template <typename DataSet>
613 SessionMetadataDialog<DataSet>::init_people_data ()
615 DataSetPtr data_set (new DataSet (_("People")));
616 data_list.push_back (data_set);
620 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::lyricist, &ARDOUR::SessionMetadata::set_lyricist, _("Lyricist")));
621 data_set->add_data_field (ptr);
623 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::composer, &ARDOUR::SessionMetadata::set_composer, _("Composer")));
624 data_set->add_data_field (ptr);
626 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::conductor, &ARDOUR::SessionMetadata::set_conductor, _("Conductor")));
627 data_set->add_data_field (ptr);
629 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::remixer, &ARDOUR::SessionMetadata::set_remixer, _("Remixer")));
630 data_set->add_data_field (ptr);
632 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::arranger, &ARDOUR::SessionMetadata::set_arranger, _("Arranger")));
633 data_set->add_data_field (ptr);
635 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::engineer, &ARDOUR::SessionMetadata::set_engineer, _("Engineer")));
636 data_set->add_data_field (ptr);
638 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::producer, &ARDOUR::SessionMetadata::set_producer, _("Producer")));
639 data_set->add_data_field (ptr);
641 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::dj_mixer, &ARDOUR::SessionMetadata::set_dj_mixer, _("DJ Mixer")));
642 data_set->add_data_field (ptr);
644 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::mixer, &ARDOUR::SessionMetadata::set_mixer, S_("Metadata|Mixer")));
645 data_set->add_data_field (ptr);
648 template <typename DataSet>
650 SessionMetadataDialog<DataSet>::init_school_data ()
652 DataSetPtr data_set (new DataSet (_("School")));
653 data_list.push_back (data_set);
657 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::instructor, &ARDOUR::SessionMetadata::set_instructor, _("Instructor")));
658 data_set->add_data_field (ptr);
660 ptr = MetadataPtr (new TextMetadataField (&ARDOUR::SessionMetadata::course, &ARDOUR::SessionMetadata::set_course, _("Course")));
661 data_set->add_data_field (ptr);
665 /* SessionMetadataEditor */
667 SessionMetadataEditor::SessionMetadataEditor () :
668 SessionMetadataDialog<SessionMetadataSetEditable> (_("Edit Session Metadata"))
673 SessionMetadataEditor::~SessionMetadataEditor ()
675 // Remove pages from notebook to get rid of gsignal runtime warnings
676 notebook.pages().clear();
680 SessionMetadataEditor::run ()
689 SessionMetadataEditor::init_gui ()
691 add_widget (notebook);
696 /* SessionMetadataImporter */
698 SessionMetadataImporter::SessionMetadataImporter () :
699 SessionMetadataDialog<SessionMetadataSetImportable> (_("Import session metadata"))
704 SessionMetadataImporter::~SessionMetadataImporter ()
706 // Remove pages from notebook to get rid of gsignal runtime warnings
707 notebook.pages().clear();
711 SessionMetadataImporter::run ()
714 std::cerr << "Programming error: no session set for SessionMetaDataImporter (in run)!" << std::endl;
718 /* Open session file selector */
720 Gtk::FileChooserDialog session_selector(_("Choose session to import metadata from"), Gtk::FILE_CHOOSER_ACTION_OPEN);
721 session_selector.add_button (Gtk::Stock::CANCEL, Gtk::RESPONSE_CANCEL);
722 session_selector.add_button (Gtk::Stock::OPEN, Gtk::RESPONSE_ACCEPT);
723 session_selector.set_default_response(Gtk::RESPONSE_ACCEPT);
725 Gtk::FileFilter session_filter;
726 session_filter.add_pattern ("*.ardour");
727 session_filter.set_name (string_compose (_("%1 sessions"), PROGRAM_NAME));
728 session_selector.add_filter (session_filter);
729 session_selector.set_filter (session_filter);
731 int response = session_selector.run();
732 session_selector.hide ();
735 case Gtk::RESPONSE_ACCEPT:
741 string session_path = session_selector.get_filename();
745 if (session_path.length() > 0) {
746 if (ARDOUR::find_session (session_path, path, name, isnew) != 0) {
753 /* We have a session: load the data and run dialog */
755 string filename = Glib::build_filename (path, name + ".ardour");
756 XMLTree session_tree;
757 if (!session_tree.read (filename)) {
758 warn_user (_("This session file could not be read!"));
762 /* XXX GET VERSION FROM TREE */
765 XMLNode * node = session_tree.root()->child ("Metadata");
768 warn_user (_("The session file didn't contain metadata!\nMaybe this is an old session format?"));
773 ARDOUR::SessionMetadata data;
774 data.set_state (*node, version);
775 init_data ( true ); //skip user data here
776 load_extra_data (data);
783 SessionMetadataImporter::init_gui ()
785 // Select all from -widget
786 add_widget (selection_hbox);
787 selection_label.set_text (_("Import all from:"));
788 selection_hbox.pack_start (selection_label, false, false);
790 WidgetListPtr list = get_custom_widgets (&SessionMetadataSetImportable::get_select_all_widget);
791 for (WidgetList::iterator it = list->begin(); it != list->end(); ++it) {
792 selection_hbox.pack_start (**it, false, false, 6);
795 add_widget (notebook);