2 Copyright (C) 2008 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
24 #include <glibmm/fileutils.h>
26 #include "pbd/enumwriter.h"
27 #include "pbd/xml++.h"
28 #include "pbd/convert.h"
30 #include "ardour/export_profile_manager.h"
31 #include "ardour/export_format_specification.h"
32 #include "ardour/export_timespan.h"
33 #include "ardour/export_channel_configuration.h"
34 #include "ardour/export_filename.h"
35 #include "ardour/export_preset.h"
36 #include "ardour/export_handler.h"
37 #include "ardour/export_failed.h"
38 #include "ardour/filename_extensions.h"
39 #include "ardour/route.h"
40 #include "ardour/session.h"
41 #include "ardour/broadcast_info.h"
52 ExportProfileManager::ExportProfileManager (Session & s, std::string xml_node_name)
53 : xml_node_name (xml_node_name)
54 , handler (s.get_export_handler())
57 , session_range (new Location (s))
58 , ranges (new LocationList ())
59 , single_range_mode (false)
61 , format_list (new FormatList ())
64 /* Initialize path variables */
66 export_config_dir = user_config_directory();
67 export_config_dir /= "export";
69 search_path += export_config_dir;
70 search_path += system_data_search_path().add_subdirectory_to_paths("export");
72 info << string_compose (_("Searching for export formats in %1"), search_path.to_string()) << endmsg;
74 /* create export config directory if necessary */
76 if (!sys::exists (export_config_dir)) {
77 sys::create_directory (export_config_dir);
83 /* Initialize all lists with an empty config */
86 init_timespans (dummy);
87 init_channel_configs (dummy);
89 init_filenames (dummy);
92 ExportProfileManager::~ExportProfileManager ()
94 if (single_range_mode) { return; }
96 XMLNode * instant_xml (new XMLNode (xml_node_name));
97 serialize_profile (*instant_xml);
98 session.add_instant_xml (*instant_xml, false);
102 ExportProfileManager::load_profile ()
104 XMLNode * instant_node = session.instant_xml (xml_node_name);
106 set_state (*instant_node);
108 XMLNode empty_node (xml_node_name);
109 set_state (empty_node);
114 ExportProfileManager::prepare_for_export ()
116 TimespanListPtr ts_list = timespans.front()->timespans;
118 FormatStateList::const_iterator format_it;
119 FilenameStateList::const_iterator filename_it;
122 for (TimespanList::iterator ts_it = ts_list->begin(); ts_it != ts_list->end(); ++ts_it) {
123 // ..., each format-filename pair
124 for (format_it = formats.begin(), filename_it = filenames.begin();
125 format_it != formats.end() && filename_it != filenames.end();
126 ++format_it, ++filename_it) {
128 FilenamePtr filename = (*filename_it)->filename;
129 // filename->include_timespan = (ts_list->size() > 1); Disabled for now...
131 boost::shared_ptr<BroadcastInfo> b;
132 if ((*format_it)->format->has_broadcast_info()) {
133 b.reset (new BroadcastInfo);
134 b->set_from_session (session, (*ts_it)->get_start());
137 // ...and each channel config
138 filename->include_channel_config = (channel_configs.size() > 1);
139 for(ChannelConfigStateList::iterator cc_it = channel_configs.begin(); cc_it != channel_configs.end(); ++cc_it) {
140 handler->add_export_config (*ts_it, (*cc_it)->config, (*format_it)->format, filename, b);
147 ExportProfileManager::load_preset (PresetPtr preset)
151 current_preset = preset;
152 if (!preset) { return false; }
154 XMLNode const * state;
155 if ((state = preset->get_local_state())) {
156 set_local_state (*state);
157 } else { ok = false; }
159 if ((state = preset->get_global_state())) {
160 if (!set_global_state (*state)) {
163 } else { ok = false; }
169 ExportProfileManager::load_presets ()
171 vector<sys::path> found = find_file (string_compose (X_("*%1"),export_preset_suffix));
173 for (vector<sys::path>::iterator it = found.begin(); it != found.end(); ++it) {
174 load_preset_from_disk (*it);
179 ExportProfileManager::preset_filename (std::string const & preset_name)
181 string safe_name = legalize_for_path (preset_name);
182 return export_config_dir.to_string() + "/" + safe_name + export_preset_suffix;
185 ExportProfileManager::PresetPtr
186 ExportProfileManager::new_preset (string const & name)
188 // Generate new ID and do regular save
189 string filename = preset_filename (name);
190 current_preset.reset (new ExportPreset (filename, session));
191 preset_list.push_back (current_preset);
192 return save_preset (name);
195 ExportProfileManager::PresetPtr
196 ExportProfileManager::save_preset (string const & name)
198 string filename = preset_filename (name);
200 if (!current_preset) {
201 current_preset.reset (new ExportPreset (filename, session));
202 preset_list.push_back (current_preset);
205 XMLNode * global_preset = new XMLNode ("ExportPreset");
206 XMLNode * local_preset = new XMLNode ("ExportPreset");
208 serialize_global_profile (*global_preset);
209 serialize_local_profile (*local_preset);
211 current_preset->set_name (name);
212 current_preset->set_global_state (*global_preset);
213 current_preset->set_local_state (*local_preset);
215 current_preset->save (filename);
217 return current_preset;
221 ExportProfileManager::remove_preset ()
223 if (!current_preset) { return; }
225 for (PresetList::iterator it = preset_list.begin(); it != preset_list.end(); ++it) {
226 if (*it == current_preset) {
227 preset_list.erase (it);
232 FileMap::iterator it = preset_file_map.find (current_preset->id());
233 if (it != preset_file_map.end()) {
234 sys::remove (it->second);
235 preset_file_map.erase (it);
238 current_preset->remove_local();
239 current_preset.reset();
243 ExportProfileManager::load_preset_from_disk (PBD::sys::path const & path)
245 PresetPtr preset (new ExportPreset (path.to_string(), session));
247 /* Handle id to filename mapping and don't add duplicates to list */
249 FilePair pair (preset->id(), path);
250 if (preset_file_map.insert (pair).second) {
251 preset_list.push_back (preset);
256 ExportProfileManager::set_state (XMLNode const & root)
258 return set_global_state (root) & set_local_state (root);
262 ExportProfileManager::set_global_state (XMLNode const & root)
264 return init_filenames (root.children ("ExportFilename")) &
265 init_formats (root.children ("ExportFormat"));
269 ExportProfileManager::set_local_state (XMLNode const & root)
271 return init_timespans (root.children ("ExportTimespan")) &
272 init_channel_configs (root.children ("ExportChannelConfiguration"));
276 ExportProfileManager::serialize_profile (XMLNode & root)
278 serialize_local_profile (root);
279 serialize_global_profile (root);
283 ExportProfileManager::serialize_global_profile (XMLNode & root)
285 for (FormatStateList::iterator it = formats.begin(); it != formats.end(); ++it) {
286 root.add_child_nocopy (serialize_format (*it));
289 for (FilenameStateList::iterator it = filenames.begin(); it != filenames.end(); ++it) {
290 root.add_child_nocopy ((*it)->filename->get_state());
295 ExportProfileManager::serialize_local_profile (XMLNode & root)
297 for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
298 root.add_child_nocopy (serialize_timespan (*it));
301 for (ChannelConfigStateList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
302 root.add_child_nocopy ((*it)->config->get_state());
306 std::vector<sys::path>
307 ExportProfileManager::find_file (std::string const & pattern)
309 vector<sys::path> found;
311 Glib::PatternSpec pattern_spec (pattern);
312 find_matching_files_in_search_path (search_path, pattern_spec, found);
318 ExportProfileManager::set_selection_range (framepos_t start, framepos_t end)
322 selection_range.reset (new Location (session));
323 selection_range->set_name (_("Selection"));
324 selection_range->set (start, end);
326 selection_range.reset();
329 for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
330 (*it)->selection_range = selection_range;
335 ExportProfileManager::set_single_range (framepos_t start, framepos_t end, string name)
337 single_range_mode = true;
339 single_range.reset (new Location (session));
340 single_range->set_name (name);
341 single_range->set (start, end);
345 return single_range->id().to_s();
349 ExportProfileManager::init_timespans (XMLNodeList nodes)
355 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
356 TimespanStatePtr span = deserialize_timespan (**it);
358 timespans.push_back (span);
359 } else { ok = false; }
362 if (timespans.empty()) {
363 TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
364 timespans.push_back (state);
366 // Add session as default selection
367 TimespanPtr timespan = handler->add_timespan();
368 timespan->set_name (session_range->name());
369 timespan->set_range_id ("session");
370 timespan->set_range (session_range->start(), session_range->end());
371 state->timespans->push_back (timespan);
378 ExportProfileManager::TimespanStatePtr
379 ExportProfileManager::deserialize_timespan (XMLNode & root)
381 TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
382 XMLProperty const * prop;
384 XMLNodeList spans = root.children ("Range");
385 for (XMLNodeList::iterator node_it = spans.begin(); node_it != spans.end(); ++node_it) {
387 prop = (*node_it)->property ("id");
388 if (!prop) { continue; }
389 string id = prop->value();
391 for (LocationList::iterator it = ranges->begin(); it != ranges->end(); ++it) {
392 if ((!id.compare ("session") && *it == session_range.get()) ||
393 (!id.compare ("selection") && *it == selection_range.get()) ||
394 (!id.compare ((*it)->id().to_s()))) {
395 TimespanPtr timespan = handler->add_timespan();
396 timespan->set_name ((*it)->name());
397 timespan->set_range_id (id);
398 timespan->set_range ((*it)->start(), (*it)->end());
399 state->timespans->push_back (timespan);
404 if ((prop = root.property ("format"))) {
405 state->time_format = (TimeFormat) string_2_enum (prop->value(), TimeFormat);
412 ExportProfileManager::serialize_timespan (TimespanStatePtr state)
414 XMLNode & root = *(new XMLNode ("ExportTimespan"));
419 for (TimespanList::iterator it = state->timespans->begin(); it != state->timespans->end(); ++it) {
420 if ((span = root.add_child ("Range"))) {
421 span->add_property ("id", (*it)->range_id());
425 root.add_property ("format", enum_2_string (state->time_format));
431 ExportProfileManager::update_ranges () {
434 if (single_range_mode) {
435 ranges->push_back (single_range.get());
441 session_range->set_name (_("Session"));
442 session_range->set (session.current_start_frame(), session.current_end_frame());
443 ranges->push_back (session_range.get());
447 if (selection_range) {
448 ranges->push_back (selection_range.get());
453 LocationList const & list (session.locations()->list());
454 for (LocationList::const_iterator it = list.begin(); it != list.end(); ++it) {
455 if ((*it)->is_range_marker()) {
456 ranges->push_back (*it);
461 ExportProfileManager::ChannelConfigStatePtr
462 ExportProfileManager::add_channel_config ()
464 ChannelConfigStatePtr ptr(new ChannelConfigState(handler->add_channel_config()));
465 channel_configs.push_back(ptr);
470 ExportProfileManager::init_channel_configs (XMLNodeList nodes)
472 channel_configs.clear();
475 ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
476 channel_configs.push_back (config);
478 // Add master outs as default
479 IO* master_out = session.master_out()->output().get();
480 if (!master_out) { return false; }
482 for (uint32_t n = 0; n < master_out->n_ports().n_audio(); ++n) {
483 PortExportChannel * channel = new PortExportChannel ();
484 channel->add_port (master_out->audio (n));
486 ExportChannelPtr chan_ptr (channel);
487 config->config->register_channel (chan_ptr);
492 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
493 ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
494 config->config->set_state (**it);
495 channel_configs.push_back (config);
501 ExportProfileManager::FormatStatePtr
502 ExportProfileManager::duplicate_format_state (FormatStatePtr state)
504 /* Note: The pointer in the new FormatState should point to the same format spec
505 as the original state's pointer. The spec itself should not be copied! */
507 FormatStatePtr format (new FormatState (format_list, state->format));
508 formats.push_back (format);
513 ExportProfileManager::remove_format_state (FormatStatePtr state)
515 for (FormatStateList::iterator it = formats.begin(); it != formats.end(); ++it) {
524 ExportProfileManager::save_format_to_disk (FormatPtr format)
526 // TODO filename character stripping
528 /* Get filename for file */
530 string new_name = format->name();
531 new_name += export_format_suffix;
533 /* make sure its legal for the filesystem */
535 new_name = legalize_for_path (new_name);
537 sys::path new_path (export_config_dir);
538 new_path /= new_name;
540 /* Check if format is on disk already */
541 FileMap::iterator it;
542 if ((it = format_file_map.find (format->id())) != format_file_map.end()) {
544 /* Check if config is not in user config dir */
545 if (it->second.branch_path().to_string().compare (export_config_dir.to_string())) {
549 XMLTree tree (new_path.to_string());
550 tree.set_root (&format->get_state());
555 /* Update file and rename if necessary */
557 XMLTree tree (it->second.to_string());
558 tree.set_root (&format->get_state());
561 if (new_name.compare (it->second.leaf())) {
562 sys::rename (it->second, new_path);
566 it->second = new_path;
571 XMLTree tree (new_path.to_string());
572 tree.set_root (&format->get_state());
576 FormatListChanged ();
581 ExportProfileManager::remove_format_profile (FormatPtr format)
583 for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
585 format_list->erase (it);
590 FileMap::iterator it = format_file_map.find (format->id());
591 if (it != format_file_map.end()) {
592 sys::remove (it->second);
593 format_file_map.erase (it);
596 FormatListChanged ();
599 ExportProfileManager::FormatPtr
600 ExportProfileManager::get_new_format (FormatPtr original)
604 format.reset (new ExportFormatSpecification (*original));
606 format = handler->add_format();
607 format->set_name ("empty format");
610 sys::path path = save_format_to_disk (format);
611 FilePair pair (format->id(), path);
612 format_file_map.insert (pair);
614 format_list->push_back (format);
615 FormatListChanged ();
621 ExportProfileManager::init_formats (XMLNodeList nodes)
626 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
627 FormatStatePtr format = deserialize_format (**it);
629 formats.push_back (format);
630 } else { ok = false; }
633 if (formats.empty ()) {
634 FormatStatePtr format (new FormatState (format_list, FormatPtr ()));
635 formats.push_back (format);
642 ExportProfileManager::FormatStatePtr
643 ExportProfileManager::deserialize_format (XMLNode & root)
648 if ((prop = root.property ("id"))) {
652 for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
653 if ((*it)->id() == id) {
654 return FormatStatePtr (new FormatState (format_list, *it));
658 return FormatStatePtr ();
662 ExportProfileManager::serialize_format (FormatStatePtr state)
664 XMLNode * root = new XMLNode ("ExportFormat");
666 string id = state->format ? state->format->id().to_s() : "";
667 root->add_property ("id", id);
673 ExportProfileManager::load_formats ()
675 vector<sys::path> found = find_file (string_compose ("*%1", export_format_suffix));
677 for (vector<sys::path>::iterator it = found.begin(); it != found.end(); ++it) {
678 load_format_from_disk (*it);
683 ExportProfileManager::load_format_from_disk (PBD::sys::path const & path)
685 XMLTree const tree (path.to_string());
686 FormatPtr format = handler->add_format (*tree.root());
688 /* Handle id to filename mapping and don't add duplicates to list */
690 FilePair pair (format->id(), path);
691 if (format_file_map.insert (pair).second) {
692 format_list->push_back (format);
695 FormatListChanged ();
698 ExportProfileManager::FilenameStatePtr
699 ExportProfileManager::duplicate_filename_state (FilenameStatePtr state)
701 FilenameStatePtr filename (new FilenameState (handler->add_filename_copy (state->filename)));
702 filenames.push_back (filename);
707 ExportProfileManager::remove_filename_state (FilenameStatePtr state)
709 for (FilenameStateList::iterator it = filenames.begin(); it != filenames.end(); ++it) {
711 filenames.erase (it);
718 ExportProfileManager::init_filenames (XMLNodeList nodes)
722 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
723 FilenamePtr filename = handler->add_filename();
724 filename->set_state (**it);
725 filenames.push_back (FilenameStatePtr (new FilenameState (filename)));
728 if (filenames.empty()) {
729 FilenameStatePtr filename (new FilenameState (handler->add_filename()));
730 filenames.push_back (filename);
737 boost::shared_ptr<ExportProfileManager::Warnings>
738 ExportProfileManager::get_warnings ()
740 boost::shared_ptr<Warnings> warnings (new Warnings ());
742 assert (!channel_configs.empty ());
744 ChannelConfigStatePtr channel_config_state = channel_configs.front();
745 TimespanStatePtr timespan_state = timespans.front();
747 /*** Check "global" config ***/
749 TimespanListPtr timespans = timespan_state->timespans;
750 ChannelConfigPtr channel_config = channel_config_state->config;
752 /* Check Timespans are not empty */
754 if (timespans->empty()) {
755 warnings->errors.push_back (_("No timespan has been selected!"));
758 /* Check channel config ports */
760 if (!channel_config->all_channels_have_ports ()) {
761 warnings->warnings.push_back (_("Some channels are empty"));
764 /*** Check files ***/
766 FormatStateList::const_iterator format_it;
767 FilenameStateList::const_iterator filename_it;
768 for (format_it = formats.begin(), filename_it = filenames.begin();
769 format_it != formats.end() && filename_it != filenames.end();
770 ++format_it, ++filename_it) {
771 check_config (warnings, timespan_state, channel_config_state, *format_it, *filename_it);
778 ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
779 TimespanStatePtr timespan_state,
780 ChannelConfigStatePtr channel_config_state,
781 FormatStatePtr format_state,
782 FilenameStatePtr filename_state)
784 TimespanListPtr timespans = timespan_state->timespans;
785 ChannelConfigPtr channel_config = channel_config_state->config;
786 FormatPtr format = format_state->format;
787 FilenamePtr filename = filename_state->filename;
789 /* Check format and maximum channel count */
790 if (!format || !format->type()) {
791 warnings->errors.push_back (_("No format selected!"));
792 } else if (!channel_config->get_n_chans()) {
793 warnings->errors.push_back (_("All channels are empty!"));
794 } else if (!check_format (format, channel_config->get_n_chans())) {
795 warnings->errors.push_back (_("One or more of the selected formats is not compatible with this system!"));
796 } else if (format->channel_limit() < channel_config->get_n_chans()) {
797 warnings->errors.push_back
798 (string_compose (_("%1 supports only %2 channels, but you have %3 channels in your channel configuration"),
799 format->format_name(),
800 format->channel_limit(),
801 channel_config->get_n_chans()));
804 if (!warnings->errors.empty()) { return; }
806 /* Check filenames */
808 // filename->include_timespan = (timespans->size() > 1); Disabled for now...
810 for (std::list<TimespanPtr>::iterator timespan_it = timespans->begin(); timespan_it != timespans->end(); ++timespan_it) {
811 filename->set_timespan (*timespan_it);
813 if (channel_config->get_split()) {
814 filename->include_channel = true;
816 for (uint32_t chan = 1; chan <= channel_config->get_n_chans(); ++chan) {
817 filename->set_channel (chan);
819 string path = filename->get_path (format);
821 if (sys::exists (sys::path (path))) {
822 warnings->conflicting_filenames.push_back (path);
827 string path = filename->get_path (format);
829 if (sys::exists (sys::path (path))) {
830 warnings->conflicting_filenames.push_back (path);
837 ExportProfileManager::check_format (FormatPtr format, uint32_t channels)
839 switch (format->type()) {
840 case ExportFormatBase::T_Sndfile:
841 return check_sndfile_format (format, channels);
844 throw ExportFailed (X_("Invalid format given for ExportFileFactory::check!"));
849 ExportProfileManager::check_sndfile_format (FormatPtr format, unsigned int channels)
852 sf_info.channels = channels;
853 sf_info.samplerate = format->sample_rate ();
854 sf_info.format = format->format_id () | format->sample_format ();
856 return (sf_format_check (&sf_info) == SF_TRUE ? true : false);
859 }; // namespace ARDOUR