Remove unused variables.
[ardour.git] / libs / ardour / export_profile_manager.cc
index 53e6338a12836cd0e37c02f2822594c74ff1d3db..7eaa7c0632a1185ff4486d16dc7d0dee747f446d 100644 (file)
@@ -29,6 +29,7 @@
 
 #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"
@@ -38,6 +39,7 @@
 #include "ardour/filename_extensions.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
+#include "ardour/broadcast_info.h"
 
 #include "i18n.h"
 
@@ -48,25 +50,25 @@ 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 ()),
-  single_range_mode (false),
+  , session_range (new Location (s))
+  , ranges (new LocationList ())
+  , single_range_mode (false)
 
-  format_list (new FormatList ())
+  format_list (new FormatList ())
 {
-
        /* Initialize path variables */
 
        export_config_dir = user_config_directory();
        export_config_dir /= "export";
-       search_path += export_config_dir;
 
-       search_path += ardour_search_path().add_subdirectory_to_paths("export");
-       search_path += system_config_search_path().add_subdirectory_to_paths("export");;
+       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 */
 
@@ -90,7 +92,7 @@ ExportProfileManager::~ExportProfileManager ()
 {
        if (single_range_mode) { return; }
 
-       XMLNode * instant_xml (new XMLNode ("ExportProfile"));
+       XMLNode * instant_xml (new XMLNode (xml_node_name));
        serialize_profile (*instant_xml);
        session.add_instant_xml (*instant_xml, false);
 }
@@ -98,11 +100,11 @@ ExportProfileManager::~ExportProfileManager ()
 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);
        }
 }
@@ -110,25 +112,38 @@ ExportProfileManager::load_profile ()
 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;
 
@@ -159,10 +174,27 @@ ExportProfileManager::load_presets ()
        }
 }
 
-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 = export_config_dir.to_string() + "/" + name + export_preset_suffix;
+       string filename = preset_filename (name);
 
        if (!current_preset) {
                current_preset.reset (new ExportPreset (filename, session));
@@ -209,7 +241,7 @@ ExportProfileManager::remove_preset ()
 void
 ExportProfileManager::load_preset_from_disk (PBD::sys::path const & path)
 {
-       PresetPtr preset (new ExportPreset (path.to_string(), session));
+       ExportPresetPtr preset (new ExportPreset (path.to_string(), session));
 
        /* Handle id to filename mapping and don't add duplicates to list */
 
@@ -282,11 +314,11 @@ ExportProfileManager::find_file (std::string const & pattern)
 }
 
 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 {
@@ -299,11 +331,11 @@ ExportProfileManager::set_selection_range (nframes_t start, nframes_t end)
 }
 
 std::string
-ExportProfileManager::set_single_range (nframes_t start, nframes_t end, Glib::ustring name)
+ExportProfileManager::set_single_range (framepos_t start, framepos_t end, string name)
 {
        single_range_mode = true;
 
-       single_range.reset (new Location());
+       single_range.reset (new Location (session));
        single_range->set_name (name);
        single_range->set (start, end);
 
@@ -329,9 +361,9 @@ ExportProfileManager::init_timespans (XMLNodeList nodes)
        if (timespans.empty()) {
                TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
                timespans.push_back (state);
-               
+
                // Add session as default selection
-               TimespanPtr timespan = handler->add_timespan();
+               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());
@@ -353,13 +385,13 @@ ExportProfileManager::deserialize_timespan (XMLNode & root)
 
                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());
@@ -425,6 +457,14 @@ ExportProfileManager::update_ranges () {
        }
 }
 
+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)
 {
@@ -433,15 +473,15 @@ ExportProfileManager::init_channel_configs (XMLNodeList nodes)
        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);
                }
@@ -480,15 +520,19 @@ ExportProfileManager::remove_format_state (FormatStatePtr state)
 }
 
 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;
 
@@ -533,7 +577,7 @@ ExportProfileManager::save_format_to_disk (FormatPtr format)
 }
 
 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) {
@@ -551,10 +595,10 @@ ExportProfileManager::remove_format_profile (FormatPtr format)
        FormatListChanged ();
 }
 
-ExportProfileManager::FormatPtr
-ExportProfileManager::get_new_format (FormatPtr original)
+ExportFormatSpecPtr
+ExportProfileManager::get_new_format (ExportFormatSpecPtr original)
 {
-       FormatPtr format;
+       ExportFormatSpecPtr format;
        if (original) {
                format.reset (new ExportFormatSpecification (*original));
        } else {
@@ -586,7 +630,7 @@ ExportProfileManager::init_formats (XMLNodeList nodes)
        }
 
        if (formats.empty ()) {
-               FormatStatePtr format (new FormatState (format_list, FormatPtr ()));
+               FormatStatePtr format (new FormatState (format_list, ExportFormatSpecPtr ()));
                formats.push_back (format);
                return false;
        }
@@ -638,7 +682,7 @@ void
 ExportProfileManager::load_format_from_disk (PBD::sys::path const & path)
 {
        XMLTree const tree (path.to_string());
-       FormatPtr format = handler->add_format (*tree.root());
+       ExportFormatSpecPtr format = handler->add_format (*tree.root());
 
        /* Handle id to filename mapping and don't add duplicates to list */
 
@@ -675,7 +719,7 @@ ExportProfileManager::init_filenames (XMLNodeList nodes)
        filenames.clear ();
 
        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)));
        }
@@ -694,13 +738,21 @@ ExportProfileManager::get_warnings ()
 {
        boost::shared_ptr<Warnings> warnings (new Warnings ());
 
-       ChannelConfigStatePtr channel_config_state = channel_configs.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 */
 
@@ -708,22 +760,27 @@ ExportProfileManager::get_warnings ()
                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;
 }
 
@@ -735,9 +792,9 @@ ExportProfileManager::check_config (boost::shared_ptr<Warnings> 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()) {
@@ -760,7 +817,7 @@ ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
 
 //     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()) {
@@ -769,7 +826,7 @@ ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
                        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);
@@ -777,7 +834,7 @@ ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
                        }
 
                } 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);
@@ -787,7 +844,7 @@ ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
 }
 
 bool
-ExportProfileManager::check_format (FormatPtr format, uint32_t channels)
+ExportProfileManager::check_format (ExportFormatSpecPtr format, uint32_t channels)
 {
        switch (format->type()) {
          case ExportFormatBase::T_Sndfile:
@@ -799,7 +856,7 @@ ExportProfileManager::check_format (FormatPtr format, uint32_t channels)
 }
 
 bool
-ExportProfileManager::check_sndfile_format (FormatPtr format, unsigned int channels)
+ExportProfileManager::check_sndfile_format (ExportFormatSpecPtr format, unsigned int channels)
 {
        SF_INFO sf_info;
        sf_info.channels = channels;