*/
-#include <ardour/export_profile_manager.h>
-
#include <cassert>
#include <stdexcept>
#include <glibmm/fileutils.h>
-#include <pbd/enumwriter.h>
-#include <pbd/xml++.h>
-#include <pbd/convert.h>
-
-#include <ardour/export_failed.h>
-#include <ardour/export_format_specification.h>
-#include <ardour/export_timespan.h>
-#include <ardour/export_channel_configuration.h>
-#include <ardour/export_filename.h>
-#include <ardour/export_preset.h>
-#include <ardour/export_handler.h>
-#include <ardour/filename_extensions.h>
-#include <ardour/session.h>
+#include "pbd/enumwriter.h"
+#include "pbd/xml++.h"
+#include "pbd/convert.h"
+
+#include "ardour/export_profile_manager.h"
+#include "ardour/export_format_specification.h"
+#include "ardour/export_formats_search_path.h"
+#include "ardour/export_timespan.h"
+#include "ardour/export_channel_configuration.h"
+#include "ardour/export_filename.h"
+#include "ardour/export_preset.h"
+#include "ardour/export_handler.h"
+#include "ardour/export_failed.h"
+#include "ardour/filename_extensions.h"
+#include "ardour/route.h"
+#include "ardour/session.h"
+#include "ardour/broadcast_info.h"
#include "i18n.h"
+using namespace std;
+using namespace Glib;
using namespace PBD;
namespace ARDOUR
{
-ExportProfileManager::ExportProfileManager (Session & s) :
- handler (s.get_export_handler()),
- session (s),
+ExportProfileManager::ExportProfileManager (Session & s, std::string xml_node_name)
+ : xml_node_name (xml_node_name)
+ , handler (s.get_export_handler())
+ , session (s)
- session_range (new Location ()),
- ranges (new LocationList ()),
+ , session_range (new Location (s))
+ , ranges (new LocationList ())
+ , single_range_mode (false)
- format_list (new FormatList ())
+ , format_list (new FormatList ())
{
-
/* Initialize path variables */
- sys::path path;
-
export_config_dir = user_config_directory();
export_config_dir /= "export";
- search_path += export_config_dir;
-
- path = ardour_search_path().to_string();
- path /= "export";
- search_path += path;
-
- path = system_config_search_path().to_string();
- path /= "export";
- search_path += path;
-
+
+ search_path += export_formats_search_path();
+
+ info << string_compose (_("Searching for export formats in %1"), search_path.to_string()) << endmsg;
+
/* create export config directory if necessary */
if (!sys::exists (export_config_dir)) {
sys::create_directory (export_config_dir);
}
-
+
load_presets ();
load_formats ();
+
+ /* Initialize all lists with an empty config */
+
+ XMLNodeList dummy;
+ init_timespans (dummy);
+ init_channel_configs (dummy);
+ init_formats (dummy);
+ init_filenames (dummy);
}
ExportProfileManager::~ExportProfileManager ()
{
- XMLNode * instant_xml (new XMLNode ("ExportProfile"));
+ if (single_range_mode) { return; }
+
+ XMLNode * instant_xml (new XMLNode (xml_node_name));
serialize_profile (*instant_xml);
session.add_instant_xml (*instant_xml, false);
}
void
ExportProfileManager::load_profile ()
{
- XMLNode * instant_node = session.instant_xml ("ExportProfile");
+ XMLNode * instant_node = session.instant_xml (xml_node_name);
if (instant_node) {
set_state (*instant_node);
} else {
- XMLNode empty_node ("ExportProfile");
+ XMLNode empty_node (xml_node_name);
set_state (empty_node);
}
}
void
ExportProfileManager::prepare_for_export ()
{
- ChannelConfigPtr channel_config = channel_configs.front()->config;
TimespanListPtr ts_list = timespans.front()->timespans;
-
+
FormatStateList::const_iterator format_it;
FilenameStateList::const_iterator filename_it;
-
+
+ // For each timespan
for (TimespanList::iterator ts_it = ts_list->begin(); ts_it != ts_list->end(); ++ts_it) {
+ // ..., each format-filename pair
for (format_it = formats.begin(), filename_it = filenames.begin();
format_it != formats.end() && filename_it != filenames.end();
++format_it, ++filename_it) {
-
+
+ ExportFilenamePtr filename = (*filename_it)->filename;
// filename->include_timespan = (ts_list->size() > 1); Disabled for now...
- handler->add_export_config (*ts_it, channel_config, (*format_it)->format, (*filename_it)->filename);
+
+ boost::shared_ptr<BroadcastInfo> b;
+ if ((*format_it)->format->has_broadcast_info()) {
+ b.reset (new BroadcastInfo);
+ b->set_from_session (session, (*ts_it)->get_start());
+ }
+
+ // ...and each channel config
+ filename->include_channel_config = (channel_configs.size() > 1);
+ for(ChannelConfigStateList::iterator cc_it = channel_configs.begin(); cc_it != channel_configs.end(); ++cc_it) {
+ handler->add_export_config (*ts_it, (*cc_it)->config, (*format_it)->format, filename, b);
+ }
}
}
}
bool
-ExportProfileManager::load_preset (PresetPtr preset)
+ExportProfileManager::load_preset (ExportPresetPtr preset)
{
bool ok = true;
if ((state = preset->get_local_state())) {
set_local_state (*state);
} else { ok = false; }
-
+
if ((state = preset->get_global_state())) {
if (!set_global_state (*state)) {
ok = false;
}
} else { ok = false; }
-
+
return ok;
}
}
}
-ExportProfileManager::PresetPtr
+std::string
+ExportProfileManager::preset_filename (std::string const & preset_name)
+{
+ string safe_name = legalize_for_path (preset_name);
+ return export_config_dir.to_string() + "/" + safe_name + export_preset_suffix;
+}
+
+ExportPresetPtr
+ExportProfileManager::new_preset (string const & name)
+{
+ // Generate new ID and do regular save
+ string filename = preset_filename (name);
+ current_preset.reset (new ExportPreset (filename, session));
+ preset_list.push_back (current_preset);
+ return save_preset (name);
+}
+
+ExportPresetPtr
ExportProfileManager::save_preset (string const & name)
{
+ string filename = preset_filename (name);
+
if (!current_preset) {
- string filename = export_config_dir.to_string() + "/" + name + export_preset_suffix;
current_preset.reset (new ExportPreset (filename, session));
preset_list.push_back (current_preset);
}
-
+
XMLNode * global_preset = new XMLNode ("ExportPreset");
XMLNode * local_preset = new XMLNode ("ExportPreset");
current_preset->set_name (name);
current_preset->set_global_state (*global_preset);
current_preset->set_local_state (*local_preset);
-
- current_preset->save();
-
+
+ current_preset->save (filename);
+
return current_preset;
}
sys::remove (it->second);
preset_file_map.erase (it);
}
-
+
current_preset->remove_local();
current_preset.reset();
}
void
ExportProfileManager::load_preset_from_disk (PBD::sys::path const & path)
{
- PresetPtr preset (new ExportPreset (path.to_string(), session));
- preset_list.push_back (preset);
-
- /* Handle id to filename mapping */
-
+ ExportPresetPtr preset (new ExportPreset (path.to_string(), session));
+
+ /* Handle id to filename mapping and don't add duplicates to list */
+
FilePair pair (preset->id(), path);
- preset_file_map.insert (pair);
+ if (preset_file_map.insert (pair).second) {
+ preset_list.push_back (preset);
+ }
}
bool
ExportProfileManager::set_state (XMLNode const & root)
{
- return set_global_state (root) && set_local_state (root);
+ return set_global_state (root) & set_local_state (root);
}
bool
ExportProfileManager::set_global_state (XMLNode const & root)
{
- return init_filenames (root.children ("ExportFilename")) &&
+ return init_filenames (root.children ("ExportFilename")) &
init_formats (root.children ("ExportFormat"));
}
bool
ExportProfileManager::set_local_state (XMLNode const & root)
{
- return init_timespans (root.children ("ExportTimespan")) &&
+ return init_timespans (root.children ("ExportTimespan")) &
init_channel_configs (root.children ("ExportChannelConfiguration"));
}
for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
root.add_child_nocopy (serialize_timespan (*it));
}
-
+
for (ChannelConfigStateList::iterator it = channel_configs.begin(); it != channel_configs.end(); ++it) {
root.add_child_nocopy ((*it)->config->get_state());
}
}
void
-ExportProfileManager::set_selection_range (nframes_t start, nframes_t end)
+ExportProfileManager::set_selection_range (framepos_t start, framepos_t end)
{
if (start || end) {
- selection_range.reset (new Location());
+ selection_range.reset (new Location (session));
selection_range->set_name (_("Selection"));
selection_range->set (start, end);
} else {
selection_range.reset();
}
-
+
for (TimespanStateList::iterator it = timespans.begin(); it != timespans.end(); ++it) {
(*it)->selection_range = selection_range;
}
}
+std::string
+ExportProfileManager::set_single_range (framepos_t start, framepos_t end, string name)
+{
+ single_range_mode = true;
+
+ single_range.reset (new Location (session));
+ single_range->set_name (name);
+ single_range->set (start, end);
+
+ update_ranges ();
+
+ return single_range->id().to_s();
+}
+
bool
ExportProfileManager::init_timespans (XMLNodeList nodes)
{
timespans.clear ();
+ update_ranges ();
- if (nodes.empty()) {
- update_ranges ();
-
- TimespanStatePtr timespan (new TimespanState (session_range, selection_range, ranges));
-
- timespans.push_back (timespan);
+ bool ok = true;
+ for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
+ TimespanStatePtr span = deserialize_timespan (**it);
+ if (span) {
+ timespans.push_back (span);
+ } else { ok = false; }
+ }
+
+ if (timespans.empty()) {
+ TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
+ timespans.push_back (state);
+
+ // Add session as default selection
+ ExportTimespanPtr timespan = handler->add_timespan();
+ timespan->set_name (session_range->name());
+ timespan->set_range_id ("session");
+ timespan->set_range (session_range->start(), session_range->end());
+ state->timespans->push_back (timespan);
return false;
}
- for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
- timespans.push_back (deserialize_timespan (**it));
- }
-
- return true;
+ return ok;
}
ExportProfileManager::TimespanStatePtr
{
TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
XMLProperty const * prop;
-
- update_ranges ();
-
+
XMLNodeList spans = root.children ("Range");
for (XMLNodeList::iterator node_it = spans.begin(); node_it != spans.end(); ++node_it) {
-
+
prop = (*node_it)->property ("id");
if (!prop) { continue; }
- ustring id = prop->value();
-
+ string id = prop->value();
+
for (LocationList::iterator it = ranges->begin(); it != ranges->end(); ++it) {
if ((!id.compare ("session") && *it == session_range.get()) ||
(!id.compare ("selection") && *it == selection_range.get()) ||
(!id.compare ((*it)->id().to_s()))) {
- TimespanPtr timespan = handler->add_timespan();
+ ExportTimespanPtr timespan = handler->add_timespan();
timespan->set_name ((*it)->name());
timespan->set_range_id (id);
timespan->set_range ((*it)->start(), (*it)->end());
}
}
}
-
+
if ((prop = root.property ("format"))) {
state->time_format = (TimeFormat) string_2_enum (prop->value(), TimeFormat);
}
-
+
return state;
}
{
XMLNode & root = *(new XMLNode ("ExportTimespan"));
XMLNode * span;
-
+
update_ranges ();
-
+
for (TimespanList::iterator it = state->timespans->begin(); it != state->timespans->end(); ++it) {
if ((span = root.add_child ("Range"))) {
span->add_property ("id", (*it)->range_id());
}
}
-
+
root.add_property ("format", enum_2_string (state->time_format));
-
+
return root;
}
ExportProfileManager::update_ranges () {
ranges->clear();
+ if (single_range_mode) {
+ ranges->push_back (single_range.get());
+ return;
+ }
+
/* Session */
session_range->set_name (_("Session"));
session_range->set (session.current_start_frame(), session.current_end_frame());
ranges->push_back (session_range.get());
-
+
/* Selection */
-
+
if (selection_range) {
ranges->push_back (selection_range.get());
}
-
+
/* ranges */
-
+
LocationList const & list (session.locations()->list());
for (LocationList::const_iterator it = list.begin(); it != list.end(); ++it) {
if ((*it)->is_range_marker()) {
}
}
+ExportProfileManager::ChannelConfigStatePtr
+ExportProfileManager::add_channel_config ()
+{
+ ChannelConfigStatePtr ptr(new ChannelConfigState(handler->add_channel_config()));
+ channel_configs.push_back(ptr);
+ return ptr;
+}
+
bool
ExportProfileManager::init_channel_configs (XMLNodeList nodes)
{
channel_configs.clear();
- if (nodes.empty()) {
+ if (nodes.empty()) {
ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
channel_configs.push_back (config);
+
+ // Add master outs as default
+ IO* master_out = session.master_out()->output().get();
+ if (!master_out) { return false; }
+
+ for (uint32_t n = 0; n < master_out->n_ports().n_audio(); ++n) {
+ PortExportChannel * channel = new PortExportChannel ();
+ channel->add_port (master_out->audio (n));
+
+ ExportChannelPtr chan_ptr (channel);
+ config->config->register_channel (chan_ptr);
+ }
return false;
}
-
+
for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
ChannelConfigStatePtr config (new ChannelConfigState (handler->add_channel_config()));
config->config->set_state (**it);
channel_configs.push_back (config);
}
-
+
return true;
}
}
sys::path
-ExportProfileManager::save_format_to_disk (FormatPtr format)
+ExportProfileManager::save_format_to_disk (ExportFormatSpecPtr format)
{
// TODO filename character stripping
/* Get filename for file */
- Glib::ustring new_name = format->name();
+ string new_name = format->name();
new_name += export_format_suffix;
-
+
+ /* make sure its legal for the filesystem */
+
+ new_name = legalize_for_path (new_name);
+
sys::path new_path (export_config_dir);
new_path /= new_name;
/* Check if format is on disk already */
FileMap::iterator it;
if ((it = format_file_map.find (format->id())) != format_file_map.end()) {
- /* Update data */
- {
+
+ /* Check if config is not in user config dir */
+ if (it->second.branch_path().to_string().compare (export_config_dir.to_string())) {
+
+ /* Write new file */
+
+ XMLTree tree (new_path.to_string());
+ tree.set_root (&format->get_state());
+ tree.write();
+
+ } else {
+
+ /* Update file and rename if necessary */
+
XMLTree tree (it->second.to_string());
tree.set_root (&format->get_state());
tree.write();
+
+ if (new_name.compare (it->second.leaf())) {
+ sys::rename (it->second, new_path);
+ }
}
-
- /* Rename if necessary */
-
- if (new_name.compare (it->second.leaf())) {
- sys::rename (it->second, new_path);
- }
-
+
+ it->second = new_path;
+
} else {
/* Write new file */
-
+
XMLTree tree (new_path.to_string());
tree.set_root (&format->get_state());
tree.write();
}
-
+
FormatListChanged ();
return new_path;
}
void
-ExportProfileManager::remove_format_profile (FormatPtr format)
+ExportProfileManager::remove_format_profile (ExportFormatSpecPtr format)
{
for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
if (*it == format) {
sys::remove (it->second);
format_file_map.erase (it);
}
-
+
FormatListChanged ();
}
-ExportProfileManager::FormatPtr
-ExportProfileManager::get_new_format (FormatPtr original)
-{
- FormatPtr format;
+ExportFormatSpecPtr
+ExportProfileManager::get_new_format (ExportFormatSpecPtr original)
+{
+ ExportFormatSpecPtr format;
if (original) {
format.reset (new ExportFormatSpecification (*original));
} else {
format = handler->add_format();
format->set_name ("empty format");
}
-
+
sys::path path = save_format_to_disk (format);
FilePair pair (format->id(), path);
format_file_map.insert (pair);
-
+
format_list->push_back (format);
FormatListChanged ();
-
+
return format;
}
bool
ExportProfileManager::init_formats (XMLNodeList nodes)
{
- bool ok = true;
formats.clear();
- if (nodes.empty()) {
- FormatStatePtr format (new FormatState (format_list, FormatPtr ()));
- formats.push_back (format);
- return false;
- }
-
+ bool ok = true;
for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
- FormatStatePtr format;
- if ((format = deserialize_format (**it))) {
+ FormatStatePtr format = deserialize_format (**it);
+ if (format) {
formats.push_back (format);
- } else {
- ok = false;
- }
+ } else { ok = false; }
}
-
+
if (formats.empty ()) {
- FormatStatePtr format (new FormatState (format_list, FormatPtr ()));
+ FormatStatePtr format (new FormatState (format_list, ExportFormatSpecPtr ()));
formats.push_back (format);
+ return false;
}
-
+
return ok;
}
{
XMLProperty * prop;
UUID id;
-
+
if ((prop = root.property ("id"))) {
id = prop->value();
}
-
+
for (FormatList::iterator it = format_list->begin(); it != format_list->end(); ++it) {
if ((*it)->id() == id) {
return FormatStatePtr (new FormatState (format_list, *it));
ExportProfileManager::serialize_format (FormatStatePtr state)
{
XMLNode * root = new XMLNode ("ExportFormat");
-
+
string id = state->format ? state->format->id().to_s() : "";
root->add_property ("id", id);
-
+
return *root;
}
ExportProfileManager::load_format_from_disk (PBD::sys::path const & path)
{
XMLTree const tree (path.to_string());
- FormatPtr format = handler->add_format (*tree.root());
- format_list->push_back (format);
-
- /* Handle id to filename mapping */
-
+ ExportFormatSpecPtr format = handler->add_format (*tree.root());
+
+ /* Handle id to filename mapping and don't add duplicates to list */
+
FilePair pair (format->id(), path);
- format_file_map.insert (pair);
-
+ if (format_file_map.insert (pair).second) {
+ format_list->push_back (format);
+ }
+
FormatListChanged ();
}
{
filenames.clear ();
- if (nodes.empty()) {
- FilenameStatePtr filename (new FilenameState (handler->add_filename()));
- filenames.push_back (filename);
- return false;
- }
-
for (XMLNodeList::const_iterator it = nodes.begin(); it != nodes.end(); ++it) {
- FilenamePtr filename = handler->add_filename();
+ ExportFilenamePtr filename = handler->add_filename();
filename->set_state (**it);
filenames.push_back (FilenameStatePtr (new FilenameState (filename)));
}
-
+
+ if (filenames.empty()) {
+ FilenameStatePtr filename (new FilenameState (handler->add_filename()));
+ filenames.push_back (filename);
+ return false;
+ }
+
return true;
}
{
boost::shared_ptr<Warnings> warnings (new Warnings ());
- ChannelConfigStatePtr channel_config_state = channel_configs.front();
- TimespanStatePtr timespan_state = timespans.front();
+ ChannelConfigStatePtr channel_config_state;
+ if (!channel_configs.empty ()) {
+ channel_config_state = channel_configs.front();
+ }
+ TimespanStatePtr timespan_state = timespans.front();
+
/*** Check "global" config ***/
-
+
TimespanListPtr timespans = timespan_state->timespans;
- ChannelConfigPtr channel_config = channel_config_state->config;
+
+ ExportChannelConfigPtr channel_config;
+ if (channel_config_state) {
+ channel_config = channel_config_state->config;
+ }
/* Check Timespans are not empty */
-
+
if (timespans->empty()) {
warnings->errors.push_back (_("No timespan has been selected!"));
}
- /* Check channel config ports */
-
- if (!channel_config->all_channels_have_ports ()) {
- warnings->warnings.push_back (_("Some channels are empty"));
+ if (channel_config_state == 0) {
+ warnings->errors.push_back (_("No channels have been selected!"));
+ } else {
+ /* Check channel config ports */
+ if (!channel_config->all_channels_have_ports ()) {
+ warnings->warnings.push_back (_("Some channels are empty"));
+ }
}
-
+
/*** Check files ***/
-
- FormatStateList::const_iterator format_it;
- FilenameStateList::const_iterator filename_it;
- for (format_it = formats.begin(), filename_it = filenames.begin();
- format_it != formats.end() && filename_it != filenames.end();
- ++format_it, ++filename_it) {
+
+ if (channel_config_state) {
+ FormatStateList::const_iterator format_it;
+ FilenameStateList::const_iterator filename_it;
+ for (format_it = formats.begin(), filename_it = filenames.begin();
+ format_it != formats.end() && filename_it != filenames.end();
+ ++format_it, ++filename_it) {
check_config (warnings, timespan_state, channel_config_state, *format_it, *filename_it);
+ }
}
return warnings;
FilenameStatePtr filename_state)
{
TimespanListPtr timespans = timespan_state->timespans;
- ChannelConfigPtr channel_config = channel_config_state->config;
- FormatPtr format = format_state->format;
- FilenamePtr filename = filename_state->filename;
+ ExportChannelConfigPtr channel_config = channel_config_state->config;
+ ExportFormatSpecPtr format = format_state->format;
+ ExportFilenamePtr filename = filename_state->filename;
/* Check format and maximum channel count */
if (!format || !format->type()) {
warnings->errors.push_back (_("No format selected!"));
+ } else if (!channel_config->get_n_chans()) {
+ warnings->errors.push_back (_("All channels are empty!"));
+ } else if (!check_format (format, channel_config->get_n_chans())) {
+ warnings->errors.push_back (_("One or more of the selected formats is not compatible with this system!"));
} else if (format->channel_limit() < channel_config->get_n_chans()) {
warnings->errors.push_back
(string_compose (_("%1 supports only %2 channels, but you have %3 channels in your channel configuration"),
format->channel_limit(),
channel_config->get_n_chans()));
}
-
+
if (!warnings->errors.empty()) { return; }
-
+
/* Check filenames */
-
+
// filename->include_timespan = (timespans->size() > 1); Disabled for now...
-
- for (std::list<TimespanPtr>::iterator timespan_it = timespans->begin(); timespan_it != timespans->end(); ++timespan_it) {
+
+ for (std::list<ExportTimespanPtr>::iterator timespan_it = timespans->begin(); timespan_it != timespans->end(); ++timespan_it) {
filename->set_timespan (*timespan_it);
-
+
if (channel_config->get_split()) {
filename->include_channel = true;
-
+
for (uint32_t chan = 1; chan <= channel_config->get_n_chans(); ++chan) {
filename->set_channel (chan);
-
- Glib::ustring path = filename->get_path (format);
-
+
+ string path = filename->get_path (format);
+
if (sys::exists (sys::path (path))) {
warnings->conflicting_filenames.push_back (path);
}
}
-
+
} else {
- Glib::ustring path = filename->get_path (format);
-
+ string path = filename->get_path (format);
+
if (sys::exists (sys::path (path))) {
warnings->conflicting_filenames.push_back (path);
}
}
}
+bool
+ExportProfileManager::check_format (ExportFormatSpecPtr format, uint32_t channels)
+{
+ switch (format->type()) {
+ case ExportFormatBase::T_Sndfile:
+ return check_sndfile_format (format, channels);
+
+ default:
+ throw ExportFailed (X_("Invalid format given for ExportFileFactory::check!"));
+ }
+}
+
+bool
+ExportProfileManager::check_sndfile_format (ExportFormatSpecPtr format, unsigned int channels)
+{
+ SF_INFO sf_info;
+ sf_info.channels = channels;
+ sf_info.samplerate = format->sample_rate ();
+ sf_info.format = format->format_id () | format->sample_format ();
+
+ return (sf_format_check (&sf_info) == SF_TRUE ? true : false);
+}
+
}; // namespace ARDOUR
projects / ardour.git / blobdiff