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.
26 #include <glib/gstdio.h>
28 #include <glibmm/fileutils.h>
29 #include <glibmm/miscutils.h>
31 #include "pbd/enumwriter.h"
32 #include "pbd/xml++.h"
33 #include "pbd/convert.h"
35 #include "ardour/export_profile_manager.h"
36 #include "ardour/export_format_specification.h"
37 #include "ardour/export_formats_search_path.h"
38 #include "ardour/export_timespan.h"
39 #include "ardour/export_channel_configuration.h"
40 #include "ardour/export_filename.h"
41 #include "ardour/export_preset.h"
42 #include "ardour/export_handler.h"
43 #include "ardour/export_failed.h"
44 #include "ardour/directory_names.h"
45 #include "ardour/filename_extensions.h"
46 #include "ardour/route.h"
47 #include "ardour/session.h"
48 #include "ardour/broadcast_info.h"
59 ExportProfileManager::ExportProfileManager (Session & s, ExportType type)
61 , handler (s.get_export_handler())
64 , session_range (new Location (s))
65 , ranges (new LocationList ())
66 , single_range_mode (false)
68 , format_list (new FormatList ())
72 xml_node_name = X_("ExportProfile");
75 xml_node_name = X_("RangeExportProfile");
78 xml_node_name = X_("SelectionExportProfile");
81 xml_node_name = X_("RegionExportProfile");
84 xml_node_name = X_("StemExportProfile");
88 /* Initialize path variables */
90 export_config_dir = Glib::build_filename (user_config_directory(), export_dir_name);
92 search_path += export_formats_search_path();
94 info << string_compose (_("Searching for export formats in %1"), search_path.to_string()) << endmsg;
96 /* create export config directory if necessary */
98 if (!Glib::file_test (export_config_dir, Glib::FILE_TEST_EXISTS)) {
99 if (g_mkdir_with_parents (export_config_dir.c_str(), 0755) != 0) {
100 error << string_compose (_("Unable to create export format directory %1: %2"), export_config_dir, g_strerror(errno)) << endmsg;
107 /* Initialize all lists with an empty config */
110 init_timespans (dummy);
111 init_channel_configs (dummy);
112 init_formats (dummy);
113 init_filenames (dummy);
116 ExportProfileManager::~ExportProfileManager ()
118 XMLNode * instant_xml (new XMLNode (xml_node_name));
119 serialize_profile (*instant_xml);
120 session.add_instant_xml (*instant_xml, false);
124 ExportProfileManager::load_profile ()
126 XMLNode * instant_node = session.instant_xml (xml_node_name);
128 set_state (*instant_node);
130 XMLNode empty_node (xml_node_name);
131 set_state (empty_node);
136 ExportProfileManager::prepare_for_export ()
138 TimespanListPtr ts_list = timespans.front()->timespans;
140 FormatStateList::const_iterator format_it;
141 FilenameStateList::const_iterator filename_it;
144 for (TimespanList::iterator ts_it = ts_list->begin(); ts_it != ts_list->end(); ++ts_it) {
145 // ..., each format-filename pair
146 for (format_it = formats.begin(), filename_it = filenames.begin();
147 format_it != formats.end() && filename_it != filenames.end();
148 ++format_it, ++filename_it) {
150 ExportFilenamePtr filename = (*filename_it)->filename;
151 // filename->include_timespan = (ts_list->size() > 1); Disabled for now...
153 boost::shared_ptr<BroadcastInfo> b;
154 if ((*format_it)->format->has_broadcast_info()) {
155 b.reset (new BroadcastInfo);
156 b->set_from_session (session, (*ts_it)->get_start());
159 // ...and each channel config
160 filename->include_channel_config = (type == StemExport) ||
161 (channel_configs.size() > 1);
162 for(ChannelConfigStateList::iterator cc_it = channel_configs.begin(); cc_it != channel_configs.end(); ++cc_it) {
163 handler->add_export_config (*ts_it, (*cc_it)->config, (*format_it)->format, filename, b);
170 ExportProfileManager::load_preset (ExportPresetPtr preset)
174 current_preset = preset;
175 if (!preset) { return false; }
177 XMLNode const * state;
178 if ((state = preset->get_local_state())) {
179 set_local_state (*state);
180 } else { ok = false; }
182 if ((state = preset->get_global_state())) {
183 if (!set_global_state (*state)) {
186 } else { ok = false; }
192 ExportProfileManager::load_presets ()
194 vector<std::string> found = find_file (string_compose (X_("*%1"),export_preset_suffix));
196 for (vector<std::string>::iterator it = found.begin(); it != found.end(); ++it) {
197 load_preset_from_disk (*it);
202 ExportProfileManager::preset_filename (std::string const & preset_name)
204 string safe_name = legalize_for_path (preset_name);
205 return Glib::build_filename (export_config_dir, safe_name + export_preset_suffix);
209 ExportProfileManager::new_preset (string const & name)
211 // Generate new ID and do regular save
212 string filename = preset_filename (name);
213 current_preset.reset (new ExportPreset (filename, session));
214 preset_list.push_back (current_preset);
215 return save_preset (name);
219 ExportProfileManager::save_preset (string const & name)
221 string filename = preset_filename (name);
223 if (!current_preset) {
224 current_preset.reset (new ExportPreset (filename, session));
225 preset_list.push_back (current_preset);
228 XMLNode * global_preset = new XMLNode ("ExportPreset");
229 XMLNode * local_preset = new XMLNode ("ExportPreset");
231 serialize_global_profile (*global_preset);
232 serialize_local_profile (*local_preset);
234 current_preset->set_name (name);
235 current_preset->set_global_state (*global_preset);
236 current_preset->set_local_state (*local_preset);
238 current_preset->save (filename);
240 return current_preset;
244 ExportProfileManager::remove_preset ()
246 if (!current_preset) { return; }
248 for (PresetList::iterator it = preset_list.begin(); it != preset_list.end(); ++it) {
249 if (*it == current_preset) {
250 preset_list.erase (it);
255 FileMap::iterator it = preset_file_map.find (current_preset->id());
256 if (it != preset_file_map.end()) {
257 if (g_remove (it->second.c_str()) != 0) {
258 error << string_compose (_("Unable to remove export preset %1: %2"), it->second, g_strerror(errno)) << endmsg;
260 preset_file_map.erase (it);
263 current_preset->remove_local();
264 current_preset.reset();
268 ExportProfileManager::load_preset_from_disk (std::string const & path)
270 ExportPresetPtr preset (new ExportPreset (path, session));
272 /* Handle id to filename mapping and don't add duplicates to list */
274 FilePair pair (preset->id(), path);
275 if (preset_file_map.insert (pair).second) {
276 preset_list.push_back (preset);
281 ExportProfileManager::set_state (XMLNode const & root)
283 return set_global_state (root) & set_local_state (root);
287 ExportProfileManager::set_global_state (XMLNode const & root)
289 return init_filenames (root.children ("ExportFilename")) &
290 init_formats (root.children ("ExportFormat"));
294 ExportProfileManager::set_local_state (XMLNode const & root)
296 return init_timespans (root.children ("ExportTimespan")) &
297 init_channel_configs (root.children ("ExportChannelConfiguration"));
301 ExportProfileManager::serialize_profile (XMLNode & root)
303 serialize_local_profile (root);
304 serialize_global_profile (root);
308 ExportProfileManager::serialize_global_profile (XMLNode & root)
310 for (FormatStateList::iterator it = formats.begin(); it != formats.end(); ++it) {
311 root.add_child_nocopy (serialize_format (*it));
314 for (FilenameStateList::iterator it = filenames.begin(); it != filenames.end(); ++it) {
315 root.add_child_nocopy ((*it)->filename->get_state());
320 ExportProfileManager::serialize_local_profile (XMLNode & root)
322 for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
323 root.add_child_nocopy (serialize_timespan (*it));
326 for (ChannelConfigStateList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
327 root.add_child_nocopy ((*it)->config->get_state());
331 std::vector<std::string>
332 ExportProfileManager::find_file (std::string const & pattern)
334 vector<std::string> found;
336 Glib::PatternSpec pattern_spec (pattern);
337 find_matching_files_in_search_path (search_path, pattern_spec, found);
343 ExportProfileManager::set_selection_range (framepos_t start, framepos_t end)
347 selection_range.reset (new Location (session));
348 selection_range->set_name (_("Selection"));
349 selection_range->set (start, end);
351 selection_range.reset();
354 for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
355 (*it)->selection_range = selection_range;
360 ExportProfileManager::set_single_range (framepos_t start, framepos_t end, string name)
362 single_range_mode = true;
364 single_range.reset (new Location (session));
365 single_range->set_name (name);
366 single_range->set (start, end);
370 return single_range->id().to_s();
374 ExportProfileManager::init_timespans (XMLNodeList nodes)
380 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
381 TimespanStatePtr span = deserialize_timespan (**it);
383 timespans.push_back (span);
384 } else { ok = false; }
387 if (timespans.empty()) {
388 TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
389 timespans.push_back (state);
391 // Add session as default selection
392 ExportTimespanPtr timespan = handler->add_timespan();
393 timespan->set_name (session_range->name());
394 timespan->set_range_id ("session");
395 timespan->set_range (session_range->start(), session_range->end());
396 state->timespans->push_back (timespan);
403 ExportProfileManager::TimespanStatePtr
404 ExportProfileManager::deserialize_timespan (XMLNode & root)
406 TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
407 XMLProperty const * prop;
409 XMLNodeList spans = root.children ("Range");
410 for (XMLNodeList::iterator node_it = spans.begin(); node_it != spans.end(); ++node_it) {
412 prop = (*node_it)->property ("id");
413 if (!prop) { continue; }
414 string id = prop->value();
416 for (LocationList::iterator it = ranges->begin(); it != ranges->end(); ++it) {
417 if ((!id.compare ("session") && *it == session_range.get()) ||
418 (!id.compare ("selection") && *it == selection_range.get()) ||
419 (!id.compare ((*it)->id().to_s()))) {
420 ExportTimespanPtr timespan = handler->add_timespan();
421 timespan->set_name ((*it)->name());
422 timespan->set_range_id (id);
423 timespan->set_range ((*it)->start(), (*it)->end());
424 state->timespans->push_back (timespan);
429 if ((prop = root.property ("format"))) {
430 state->time_format = (TimeFormat) string_2_enum (prop->value(), TimeFormat);
437 ExportProfileManager::serialize_timespan (TimespanStatePtr state)
439 XMLNode & root = *(new XMLNode ("ExportTimespan"));
444 for (TimespanList::iterator it = state->timespans->begin(); it != state->timespans->end(); ++it) {
445 if ((span = root.add_child ("Range"))) {
446 span->add_property ("id", (*it)->range_id());
450 root.add_property ("format", enum_2_string (state->time_format));
456 ExportProfileManager::update_ranges () {
459 if (single_range_mode) {
460 ranges->push_back (single_range.get());
466 session_range->set_name (_("Session"));
467 session_range->set (session.current_start_frame(), session.current_end_frame());
468 ranges->push_back (session_range.get());
472 if (selection_range) {
473 ranges->push_back (selection_range.get());
478 LocationList const & list (session.locations()->list());
479 for (LocationList::const_iterator it = list.begin(); it != list.end(); ++it) {
480 if ((*it)->is_range_marker()) {
481 ranges->push_back (*it);
486 ExportProfileManager::ChannelConfigStatePtr
487 ExportProfileManager::add_channel_config ()
489 ChannelConfigStatePtr ptr(new ChannelConfigState(handler->add_channel_config()));
490 channel_configs.push_back(ptr);
495 ExportProfileManager::init_channel_configs (XMLNodeList nodes)
497 channel_configs.clear();
500 ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
501 channel_configs.push_back (config);
503 // Add master outs as default
504 if (!session.master_out()) { return false; }
506 IO* master_out = session.master_out()->output().get();
507 if (!master_out) { return false; }
509 for (uint32_t n = 0; n < master_out->n_ports().n_audio(); ++n) {
510 PortExportChannel * channel = new PortExportChannel ();
511 channel->add_port (master_out->audio (n));
513 ExportChannelPtr chan_ptr (channel);
514 config->config->register_channel (chan_ptr);
519 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
520 ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
521 config->config->set_state (**it);
522 channel_configs.push_back (config);
528 ExportProfileManager::FormatStatePtr
529 ExportProfileManager::duplicate_format_state (FormatStatePtr state)
531 /* Note: The pointer in the new FormatState should point to the same format spec
532 as the original state's pointer. The spec itself should not be copied! */
534 FormatStatePtr format (new FormatState (format_list, state->format));
535 formats.push_back (format);
540 ExportProfileManager::remove_format_state (FormatStatePtr state)
542 for (FormatStateList::iterator it = formats.begin(); it != formats.end(); ++it) {
551 ExportProfileManager::save_format_to_disk (ExportFormatSpecPtr format)
553 // TODO filename character stripping
555 /* Get filename for file */
557 string new_name = format->name();
558 new_name += export_format_suffix;
560 /* make sure its legal for the filesystem */
562 new_name = legalize_for_path (new_name);
564 std::string new_path = Glib::build_filename (export_config_dir, new_name);
566 /* Check if format is on disk already */
567 FileMap::iterator it;
568 if ((it = format_file_map.find (format->id())) != format_file_map.end()) {
570 /* Check if config is not in user config dir */
571 if (Glib::path_get_dirname (it->second) != export_config_dir) {
575 XMLTree tree (new_path);
576 tree.set_root (&format->get_state());
581 /* Update file and rename if necessary */
583 XMLTree tree (it->second);
584 tree.set_root (&format->get_state());
587 if (new_name != Glib::path_get_basename (it->second)) {
588 if (g_rename (it->second.c_str(), new_path.c_str()) != 0) {
589 error << string_compose (_("Unable to rename export format %1 to %2: %3"), it->second, new_path, g_strerror(errno)) << endmsg;
594 it->second = new_path;
599 XMLTree tree (new_path);
600 tree.set_root (&format->get_state());
604 FormatListChanged ();
609 ExportProfileManager::remove_format_profile (ExportFormatSpecPtr format)
611 for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
613 format_list->erase (it);
618 FileMap::iterator it = format_file_map.find (format->id());
619 if (it != format_file_map.end()) {
620 if (g_remove (it->second.c_str()) != 0) {
621 error << string_compose (_("Unable to remove export profile %1: %2"), it->second, g_strerror(errno)) << endmsg;
624 format_file_map.erase (it);
627 FormatListChanged ();
631 ExportProfileManager::get_new_format (ExportFormatSpecPtr original)
633 ExportFormatSpecPtr format;
635 format.reset (new ExportFormatSpecification (*original));
637 format = handler->add_format();
638 format->set_name (_("empty format"));
641 std::string path = save_format_to_disk (format);
642 FilePair pair (format->id(), path);
643 format_file_map.insert (pair);
645 format_list->push_back (format);
646 FormatListChanged ();
652 ExportProfileManager::init_formats (XMLNodeList nodes)
657 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
658 FormatStatePtr format = deserialize_format (**it);
660 formats.push_back (format);
661 } else { ok = false; }
664 if (formats.empty ()) {
665 FormatStatePtr format (new FormatState (format_list, ExportFormatSpecPtr ()));
666 formats.push_back (format);
673 ExportProfileManager::FormatStatePtr
674 ExportProfileManager::deserialize_format (XMLNode & root)
679 if ((prop = root.property ("id"))) {
683 for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
684 if ((*it)->id() == id) {
685 return FormatStatePtr (new FormatState (format_list, *it));
689 return FormatStatePtr ();
693 ExportProfileManager::serialize_format (FormatStatePtr state)
695 XMLNode * root = new XMLNode ("ExportFormat");
697 string id = state->format ? state->format->id().to_s() : "";
698 root->add_property ("id", id);
704 ExportProfileManager::load_formats ()
706 vector<std::string> found = find_file (string_compose ("*%1", export_format_suffix));
708 for (vector<std::string>::iterator it = found.begin(); it != found.end(); ++it) {
709 load_format_from_disk (*it);
714 ExportProfileManager::load_format_from_disk (std::string const & path)
716 XMLTree const tree (path);
717 ExportFormatSpecPtr format = handler->add_format (*tree.root());
719 /* Handle id to filename mapping and don't add duplicates to list */
721 FilePair pair (format->id(), path);
722 if (format_file_map.insert (pair).second) {
723 format_list->push_back (format);
726 FormatListChanged ();
729 ExportProfileManager::FilenameStatePtr
730 ExportProfileManager::duplicate_filename_state (FilenameStatePtr state)
732 FilenameStatePtr filename (new FilenameState (handler->add_filename_copy (state->filename)));
733 filenames.push_back (filename);
738 ExportProfileManager::remove_filename_state (FilenameStatePtr state)
740 for (FilenameStateList::iterator it = filenames.begin(); it != filenames.end(); ++it) {
742 filenames.erase (it);
749 ExportProfileManager::get_sample_filename_for_format (ExportFilenamePtr filename, ExportFormatSpecPtr format)
753 if (channel_configs.empty()) { return ""; }
755 std::list<string> filenames;
756 build_filenames (filenames, filename, timespans.front()->timespans,
757 channel_configs.front()->config, format);
759 if (filenames.empty()) { return ""; }
760 return filenames.front();
764 ExportProfileManager::init_filenames (XMLNodeList nodes)
768 for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
769 ExportFilenamePtr filename = handler->add_filename();
770 filename->set_state (**it);
771 filenames.push_back (FilenameStatePtr (new FilenameState (filename)));
774 if (filenames.empty()) {
775 FilenameStatePtr filename (new FilenameState (handler->add_filename()));
776 filenames.push_back (filename);
783 boost::shared_ptr<ExportProfileManager::Warnings>
784 ExportProfileManager::get_warnings ()
786 boost::shared_ptr<Warnings> warnings (new Warnings ());
788 ChannelConfigStatePtr channel_config_state;
789 if (!channel_configs.empty ()) {
790 channel_config_state = channel_configs.front();
793 TimespanStatePtr timespan_state = timespans.front();
795 /*** Check "global" config ***/
797 TimespanListPtr timespans = timespan_state->timespans;
799 ExportChannelConfigPtr channel_config;
800 if (channel_config_state) {
801 channel_config = channel_config_state->config;
804 /* Check Timespans are not empty */
806 if (timespans->empty()) {
807 warnings->errors.push_back (_("No timespan has been selected!"));
810 if (channel_config_state == 0) {
811 warnings->errors.push_back (_("No channels have been selected!"));
813 /* Check channel config ports */
814 if (!channel_config->all_channels_have_ports ()) {
815 warnings->warnings.push_back (_("Some channels are empty"));
819 /*** Check files ***/
821 if (channel_config_state) {
822 FormatStateList::const_iterator format_it;
823 FilenameStateList::const_iterator filename_it;
824 for (format_it = formats.begin(), filename_it = filenames.begin();
825 format_it != formats.end() && filename_it != filenames.end();
826 ++format_it, ++filename_it) {
827 check_config (warnings, timespan_state, channel_config_state, *format_it, *filename_it);
835 ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
836 TimespanStatePtr timespan_state,
837 ChannelConfigStatePtr channel_config_state,
838 FormatStatePtr format_state,
839 FilenameStatePtr filename_state)
841 TimespanListPtr timespans = timespan_state->timespans;
842 ExportChannelConfigPtr channel_config = channel_config_state->config;
843 ExportFormatSpecPtr format = format_state->format;
844 ExportFilenamePtr filename = filename_state->filename;
846 /* Check format and maximum channel count */
847 if (!format || !format->type()) {
848 warnings->errors.push_back (_("No format selected!"));
849 } else if (!channel_config->get_n_chans()) {
850 warnings->errors.push_back (_("All channels are empty!"));
851 } else if (!check_format (format, channel_config->get_n_chans())) {
852 warnings->errors.push_back (_("One or more of the selected formats is not compatible with this system!"));
853 } else if (format->channel_limit() < channel_config->get_n_chans()) {
854 warnings->errors.push_back
855 (string_compose (_("%1 supports only %2 channels, but you have %3 channels in your channel configuration"),
856 format->format_name(),
857 format->channel_limit(),
858 channel_config->get_n_chans()));
861 if (!warnings->errors.empty()) { return; }
863 /* Check filenames */
865 // filename->include_timespan = (timespans->size() > 1); Disabled for now...
867 std::list<string> paths;
868 build_filenames(paths, filename, timespans, channel_config, format);
870 for (std::list<string>::const_iterator path_it = paths.begin(); path_it != paths.end(); ++path_it) {
872 string path = *path_it;
874 if (Glib::file_test (path, Glib::FILE_TEST_EXISTS)) {
875 warnings->conflicting_filenames.push_back (path);
878 if (format->with_toc()) {
879 string marker_file = handler->get_cd_marker_filename(path, CDMarkerTOC);
880 if (Glib::file_test (marker_file, Glib::FILE_TEST_EXISTS)) {
881 warnings->conflicting_filenames.push_back (marker_file);
885 if (format->with_cue()) {
886 string marker_file = handler->get_cd_marker_filename(path, CDMarkerCUE);
887 if (Glib::file_test (marker_file, Glib::FILE_TEST_EXISTS)) {
888 warnings->conflicting_filenames.push_back (marker_file);
895 ExportProfileManager::check_format (ExportFormatSpecPtr format, uint32_t channels)
897 switch (format->type()) {
898 case ExportFormatBase::T_Sndfile:
899 return check_sndfile_format (format, channels);
902 throw ExportFailed (X_("Invalid format given for ExportFileFactory::check!"));
907 ExportProfileManager::check_sndfile_format (ExportFormatSpecPtr format, unsigned int channels)
910 sf_info.channels = channels;
911 sf_info.samplerate = format->sample_rate ();
912 sf_info.format = format->format_id () | format->sample_format ();
914 return (sf_format_check (&sf_info) == SF_TRUE ? true : false);
918 ExportProfileManager::build_filenames(std::list<std::string> & result, ExportFilenamePtr filename,
919 TimespanListPtr timespans, ExportChannelConfigPtr channel_config,
920 ExportFormatSpecPtr format)
922 for (std::list<ExportTimespanPtr>::iterator timespan_it = timespans->begin();
923 timespan_it != timespans->end(); ++timespan_it) {
924 filename->set_timespan (*timespan_it);
926 if (channel_config->get_split()) {
927 filename->include_channel = true;
929 for (uint32_t chan = 1; chan <= channel_config->get_n_chans(); ++chan) {
930 filename->set_channel (chan);
931 result.push_back(filename->get_path (format));
935 filename->include_channel = false;
936 result.push_back(filename->get_path (format));
941 }; // namespace ARDOUR