Towards fixing AU preset invalidation
[ardour.git] / libs / ardour / export_profile_manager.cc
index deeb3aea2b07862873f43945d642f73b8ba70c7e..877b4343774e825555e20991b196f539019a7e98 100644 (file)
 #include <cerrno>
 
 #include <glib.h>
-#include <glib/gstdio.h>
+#include "pbd/gstdio_compat.h"
 
 #include <glibmm/fileutils.h>
 #include <glibmm/miscutils.h>
 
 #include "pbd/enumwriter.h"
+#include "pbd/enum_convert.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/search_paths.h"
 #include "ardour/export_timespan.h"
 #include "ardour/export_channel_configuration.h"
 #include "ardour/export_filename.h"
 #include "ardour/export_failed.h"
 #include "ardour/directory_names.h"
 #include "ardour/filename_extensions.h"
+#include "ardour/profile.h"
 #include "ardour/route.h"
 #include "ardour/session.h"
 #include "ardour/broadcast_info.h"
 
-#include "i18n.h"
+#include "pbd/i18n.h"
+
+namespace PBD {
+       DEFINE_ENUM_CONVERT(ARDOUR::ExportProfileManager::TimeFormat);
+}
 
 using namespace std;
 using namespace Glib;
@@ -57,11 +62,10 @@ namespace ARDOUR
 {
 
 ExportProfileManager::ExportProfileManager (Session & s, ExportType type)
-  : type(type)
+  : _type(type)
   , handler (s.get_export_handler())
   , session (s)
 
-  , session_range (new Location (s))
   , ranges (new LocationList ())
   , single_range_mode (false)
 
@@ -115,17 +119,22 @@ ExportProfileManager::ExportProfileManager (Session & s, ExportType type)
 
 ExportProfileManager::~ExportProfileManager ()
 {
-       XMLNode * instant_xml (new XMLNode (xml_node_name));
-       serialize_profile (*instant_xml);
-       session.add_instant_xml (*instant_xml, false);
+       XMLNode * extra_xml (new XMLNode (xml_node_name));
+       serialize_profile (*extra_xml);
+       session.add_extra_xml (*extra_xml);
 }
 
 void
 ExportProfileManager::load_profile ()
 {
-       XMLNode * instant_node = session.instant_xml (xml_node_name);
-       if (instant_node) {
-               set_state (*instant_node);
+       XMLNode * extra_node = session.extra_xml (xml_node_name);
+       /* Legacy sessions used Session instant.xml for this */
+       if (!extra_node) {
+               extra_node = session.instant_xml (xml_node_name);
+       }
+
+       if (extra_node) {
+               set_state (*extra_node);
        } else {
                XMLNode empty_node (xml_node_name);
                set_state (empty_node);
@@ -140,6 +149,7 @@ ExportProfileManager::prepare_for_export ()
        FormatStateList::const_iterator format_it;
        FilenameStateList::const_iterator filename_it;
 
+       handler->reset ();
        // For each timespan
        for (TimespanList::iterator ts_it = ts_list->begin(); ts_it != ts_list->end(); ++ts_it) {
                // ..., each format-filename pair
@@ -157,7 +167,7 @@ ExportProfileManager::prepare_for_export ()
                        }
 
                        // ...and each channel config
-                       filename->include_channel_config = (type == StemExport) ||
+                       filename->include_channel_config = (_type == StemExport) ||
                                                           (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);
@@ -175,9 +185,14 @@ ExportProfileManager::load_preset (ExportPresetPtr preset)
        if (!preset) { return false; }
 
        XMLNode const * state;
+       /* local state is saved in instant.xml and contains timespan
+        * and channel config for per session.
+        * It may not be present for a given preset/session combination
+        * and is never preset for system-wide presets, but that's OK.
+        */
        if ((state = preset->get_local_state())) {
                set_local_state (*state);
-       } else { ok = false; }
+       }
 
        if ((state = preset->get_global_state())) {
                if (!set_global_state (*state)) {
@@ -333,14 +348,13 @@ ExportProfileManager::find_file (std::string const & pattern)
 {
        vector<std::string> found;
 
-       Glib::PatternSpec pattern_spec (pattern);
-       find_matching_files_in_search_path (search_path, pattern_spec, found);
+       find_files_matching_pattern (found, search_path, pattern);
 
        return found;
 }
 
 void
-ExportProfileManager::set_selection_range (framepos_t start, framepos_t end)
+ExportProfileManager::set_selection_range (samplepos_t start, samplepos_t end)
 {
 
        if (start || end) {
@@ -357,7 +371,7 @@ ExportProfileManager::set_selection_range (framepos_t start, framepos_t end)
 }
 
 std::string
-ExportProfileManager::set_single_range (framepos_t start, framepos_t end, string name)
+ExportProfileManager::set_single_range (samplepos_t start, samplepos_t end, string name)
 {
        single_range_mode = true;
 
@@ -385,13 +399,23 @@ ExportProfileManager::init_timespans (XMLNodeList nodes)
        }
 
        if (timespans.empty()) {
-               TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
+               TimespanStatePtr state (new TimespanState (selection_range, ranges));
                timespans.push_back (state);
 
                // Add session as default selection
+               Location * session_range;
+
+               if (Profile->get_trx()) {
+                       session_range = (session.get_play_loop () ? session.locations()->auto_loop_location () : session.locations()->session_range_location());
+               } else {
+                       session_range = session.locations()->session_range_location();
+               }
+
+               if (!session_range) { return false; }
+
                ExportTimespanPtr timespan = handler->add_timespan();
                timespan->set_name (session_range->name());
-               timespan->set_range_id ("session");
+               timespan->set_range_id (session_range->id().to_s());
                timespan->set_range (session_range->start(), session_range->end());
                state->timespans->push_back (timespan);
                return false;
@@ -403,31 +427,38 @@ ExportProfileManager::init_timespans (XMLNodeList nodes)
 ExportProfileManager::TimespanStatePtr
 ExportProfileManager::deserialize_timespan (XMLNode & root)
 {
-       TimespanStatePtr state (new TimespanState (session_range, selection_range, ranges));
-       XMLProperty const * prop;
+       TimespanStatePtr state (new TimespanState (selection_range, 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; }
-               string id = prop->value();
+               std::string id;
+               if (!(*node_it)->get_property ("id", id)) {
+                       continue;
+               }
 
+               Location * location = 0;
                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()))) {
-                               ExportTimespanPtr timespan = handler->add_timespan();
-                               timespan->set_name ((*it)->name());
-                               timespan->set_range_id (id);
-                               timespan->set_range ((*it)->start(), (*it)->end());
-                               state->timespans->push_back (timespan);
+                       if ((id == "selection" && *it == selection_range.get()) ||
+                           (id == (*it)->id().to_s())) {
+                               location = *it;
+                               break;
                        }
                }
+
+               if (!location) { continue; }
+
+               ExportTimespanPtr timespan = handler->add_timespan();
+               timespan->set_name (location->name());
+               timespan->set_range_id (location->id().to_s());
+               timespan->set_range (location->start(), location->end());
+               state->timespans->push_back (timespan);
        }
 
-       if ((prop = root.property ("format"))) {
-               state->time_format = (TimeFormat) string_2_enum (prop->value(), TimeFormat);
+       root.get_property ("format", state->time_format);
+
+       if (state->timespans->empty()) {
+               return TimespanStatePtr();
        }
 
        return state;
@@ -440,14 +471,13 @@ ExportProfileManager::serialize_timespan (TimespanStatePtr state)
        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());
+                       span->set_property ("id", (*it)->range_id());
                }
        }
 
-       root.add_property ("format", enum_2_string (state->time_format));
+       root.set_property ("format", state->time_format);
 
        return root;
 }
@@ -461,11 +491,16 @@ ExportProfileManager::update_ranges () {
                return;
        }
 
-       /* Session */
 
-       session_range->set_name (_("Session"));
-       session_range->set (session.current_start_frame(), session.current_end_frame());
-       ranges->push_back (session_range.get());
+       /* Loop */
+       if (session.locations()->auto_loop_location ()) {
+               ranges->push_back (session.locations()->auto_loop_location ());
+       }
+
+       /* Session */
+       if (session.locations()->session_range_location()) {
+               ranges->push_back (session.locations()->session_range_location());
+       }
 
        /* Selection */
 
@@ -501,6 +536,8 @@ ExportProfileManager::init_channel_configs (XMLNodeList nodes)
                channel_configs.push_back (config);
 
                // Add master outs as default
+               if (!session.master_out()) { return false; }
+
                IO* master_out = session.master_out()->output().get();
                if (!master_out) { return false; }
 
@@ -555,9 +592,9 @@ ExportProfileManager::save_format_to_disk (ExportFormatSpecPtr format)
        string new_name = format->name();
        new_name += export_format_suffix;
 
-        /* make sure its legal for the filesystem */
+       /* make sure its legal for the filesystem */
 
-        new_name = legalize_for_path (new_name);
+       new_name = legalize_for_path (new_name);
 
        std::string new_path = Glib::build_filename (export_config_dir, new_name);
 
@@ -599,7 +636,6 @@ ExportProfileManager::save_format_to_disk (ExportFormatSpecPtr format)
                tree.write();
        }
 
-       FormatListChanged ();
        return new_path;
 }
 
@@ -625,12 +661,30 @@ ExportProfileManager::remove_format_profile (ExportFormatSpecPtr format)
        FormatListChanged ();
 }
 
+void
+ExportProfileManager::revert_format_profile (ExportFormatSpecPtr format)
+{
+       FileMap::iterator it;
+       if ((it = format_file_map.find (format->id())) == format_file_map.end()) {
+               return;
+       }
+
+       XMLTree tree;
+       if (!tree.read (it->second.c_str())) {
+               return;
+       }
+
+       format->set_state (*tree.root());
+       FormatListChanged ();
+}
+
 ExportFormatSpecPtr
 ExportProfileManager::get_new_format (ExportFormatSpecPtr original)
 {
        ExportFormatSpecPtr format;
        if (original) {
                format.reset (new ExportFormatSpecification (*original));
+               std::cerr << "After new format created from original, format has id [" << format->id().to_s() << ']' << std::endl;
        } else {
                format = handler->add_format();
                format->set_name (_("empty format"));
@@ -671,8 +725,8 @@ ExportProfileManager::init_formats (XMLNodeList nodes)
 ExportProfileManager::FormatStatePtr
 ExportProfileManager::deserialize_format (XMLNode & root)
 {
-       XMLProperty * prop;
-       UUID id;
+       XMLProperty const * prop;
+       PBD::UUID id;
 
        if ((prop = root.property ("id"))) {
                id = prop->value();
@@ -693,7 +747,7 @@ ExportProfileManager::serialize_format (FormatStatePtr state)
        XMLNode * root = new XMLNode ("ExportFormat");
 
        string id = state->format ? state->format->id().to_s() : "";
-       root->add_property ("id", id);
+       root->set_property ("id", id);
 
        return *root;
 }
@@ -711,9 +765,28 @@ ExportProfileManager::load_formats ()
 void
 ExportProfileManager::load_format_from_disk (std::string const & path)
 {
-       XMLTree const tree (path);
-       ExportFormatSpecPtr format = handler->add_format (*tree.root());
+       XMLTree tree;
 
+       if (!tree.read (path)) {
+               error << string_compose (_("Cannot load export format from %1"), path) << endmsg;
+               return;
+       }
+
+       XMLNode* root = tree.root();
+       if (!root) {
+               error << string_compose (_("Cannot export format read from %1"), path) << endmsg;
+               return;
+       }
+
+       ExportFormatSpecPtr format = handler->add_format (*root);
+
+       if (format->format_id() == ExportFormatBase::F_FFMPEG) {
+               std::string unused;
+               if (!ArdourVideoToolPaths::transcoder_exe (unused, unused)) {
+                       error << string_compose (_("Ignored format '%1': encoder is not avilable"), path) << endmsg;
+                       return;
+               }
+       }
        /* Handle id to filename mapping and don't add duplicates to list */
 
        FilePair pair (format->id(), path);
@@ -747,7 +820,7 @@ std::string
 ExportProfileManager::get_sample_filename_for_format (ExportFilenamePtr filename, ExportFormatSpecPtr format)
 {
        assert (format);
-       
+
        if (channel_configs.empty()) { return ""; }
 
        std::list<string> filenames;
@@ -787,7 +860,7 @@ ExportProfileManager::get_warnings ()
        if (!channel_configs.empty ()) {
                channel_config_state = channel_configs.front();
        }
-       
+
        TimespanStatePtr timespan_state = timespans.front();
 
        /*** Check "global" config ***/
@@ -816,6 +889,8 @@ ExportProfileManager::get_warnings ()
 
        /*** Check files ***/
 
+       bool folder_ok = true;
+
        if (channel_config_state) {
                FormatStateList::const_iterator format_it;
                FilenameStateList::const_iterator filename_it;
@@ -823,18 +898,26 @@ ExportProfileManager::get_warnings ()
                     format_it != formats.end() && filename_it != filenames.end();
                     ++format_it, ++filename_it) {
                        check_config (warnings, timespan_state, channel_config_state, *format_it, *filename_it);
+
+                       if (!Glib::file_test ((*filename_it)->filename->get_folder(), Glib::FileTest (G_FILE_TEST_EXISTS | G_FILE_TEST_IS_DIR))) {
+                               folder_ok = false;
+                       }
+
                }
        }
-       
+
+       if (!folder_ok) {
+               warnings->errors.push_back (_("Destination folder does not exist."));
+       }
+
        return warnings;
 }
 
 void
 ExportProfileManager::check_config (boost::shared_ptr<Warnings> warnings,
-                                   TimespanStatePtr timespan_state,
-                                   ChannelConfigStatePtr channel_config_state,
-                                   FormatStatePtr format_state,
-                                   FilenameStatePtr filename_state)
+                                    TimespanStatePtr timespan_state,
+                                    ChannelConfigStatePtr channel_config_state,
+                                    FormatStatePtr format_state, FilenameStatePtr filename_state)
 {
        TimespanListPtr timespans = timespan_state->timespans;
        ExportChannelConfigPtr channel_config = channel_config_state->config;
@@ -895,6 +978,8 @@ ExportProfileManager::check_format (ExportFormatSpecPtr format, uint32_t channel
        switch (format->type()) {
          case ExportFormatBase::T_Sndfile:
                return check_sndfile_format (format, channels);
+         case ExportFormatBase::T_FFMPEG:
+               return true;
 
          default:
                throw ExportFailed (X_("Invalid format given for ExportFileFactory::check!"));