libs/ardour/ardour/export_profile_manager.h

   1 /*
   2     Copyright (C) 2008 Paul Davis
   3     Author: Sakari Bergen
   4
   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.
   9
  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.
  14
  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.
  18
  19 */
  20
  21 #ifndef __ardour_export_profile_manager_h__
  22 #define __ardour_export_profile_manager_h__
  23
  24 #include <list>
  25 #include <vector>
  26 #include <map>
  27 #include <stdexcept>
  28 #include <string>
  29
  30 #include <boost/shared_ptr.hpp>
  31 #include <boost/weak_ptr.hpp>
  32
  33 #include "pbd/uuid.h"
  34 #include "pbd/file_utils.h"
  35 #include "pbd/xml++.h"
  36
  37 #include "ardour/filesystem_paths.h"
  38 #include "ardour/location.h"
  39 #include "ardour/types.h"
  40
  41 namespace ARDOUR
  42 {
  43
  44 class ExportHandler;
  45 class ExportTimespan;
  46 class ExportChannelConfiguration;
  47 class ExportFormatSpecification;
  48 class ExportFilename;
  49 class ExportPreset;
  50 class Location;
  51 class Session;
  52
  53 /// Manages (de)serialization of export profiles and related classes
  54 class ExportProfileManager
  55 {
  56   public:
  57
  58         ExportProfileManager (Session & s, std::string xml_node_name);
  59         ~ExportProfileManager ();
  60
  61         void load_profile ();
  62         void prepare_for_export ();
  63
  64         typedef boost::shared_ptr<ExportPreset> PresetPtr;
  65         typedef std::list<PresetPtr> PresetList;
  66
  67         PresetList const & get_presets () { return preset_list; }
  68         bool load_preset (PresetPtr preset);
  69         PresetPtr save_preset (std::string const & name);
  70         void remove_preset ();
  71
  72   private:
  73         typedef boost::shared_ptr<ExportHandler> HandlerPtr;
  74
  75         typedef std::pair<PBD::UUID, PBD::sys::path> FilePair;
  76         typedef std::map<PBD::UUID, PBD::sys::path> FileMap;
  77
  78         std::string const xml_node_name;
  79         HandlerPtr  handler;
  80         Session &   session;
  81
  82         void load_presets ();
  83         void load_preset_from_disk (PBD::sys::path const & path);
  84
  85         bool set_state (XMLNode const & root);
  86         bool set_global_state (XMLNode const & root);
  87         bool set_local_state (XMLNode const & root);
  88
  89         void serialize_profile (XMLNode & root);
  90         void serialize_global_profile (XMLNode & root);
  91         void serialize_local_profile (XMLNode & root);
  92
  93         PresetList preset_list;
  94         PresetPtr  current_preset;
  95         FileMap    preset_file_map;
  96
  97         std::vector<PBD::sys::path> find_file (std::string const & pattern);
  98
  99         PBD::sys::path  export_config_dir;
 100         PBD::SearchPath search_path;
 101
 102 /* Timespans */
 103   public:
 104
 105         typedef boost::shared_ptr<ExportTimespan> TimespanPtr;
 106         typedef std::list<TimespanPtr> TimespanList;
 107         typedef boost::shared_ptr<TimespanList> TimespanListPtr;
 108         typedef std::list<Location *> LocationList;
 109
 110         enum TimeFormat {
 111                 Timecode,
 112                 BBT,
 113                 MinSec,
 114                 Frames,
 115                 Off
 116         };
 117
 118         struct TimespanState {
 119                 TimespanListPtr timespans;
 120                 TimeFormat      time_format;
 121
 122                 boost::shared_ptr<Location> session_range;
 123                 boost::shared_ptr<Location> selection_range;
 124                 boost::shared_ptr<LocationList> ranges;
 125
 126                 TimespanState (boost::shared_ptr<Location> session_range,
 127                                boost::shared_ptr<Location> selection_range,
 128                                boost::shared_ptr<LocationList> ranges)
 129                   : timespans (new TimespanList ())
 130                   , time_format (Timecode)
 131                   , session_range (session_range)
 132                   , selection_range (selection_range)
 133                   , ranges (ranges)
 134                 {}
 135         };
 136
 137         typedef boost::shared_ptr<TimespanState> TimespanStatePtr;
 138         typedef std::list<TimespanStatePtr> TimespanStateList;
 139
 140         void set_selection_range (framepos_t start = 0, framepos_t end = 0);
 141         std::string set_single_range (framepos_t start, framepos_t end, std::string name);
 142         TimespanStateList const & get_timespans () { return check_list (timespans); }
 143
 144   private:
 145
 146         TimespanStateList timespans;
 147
 148         bool init_timespans (XMLNodeList nodes);
 149
 150         TimespanStatePtr deserialize_timespan (XMLNode & root);
 151         XMLNode & serialize_timespan (TimespanStatePtr state);
 152
 153         /* Locations */
 154
 155         void update_ranges ();
 156
 157         boost::shared_ptr<Location>     session_range;
 158         boost::shared_ptr<Location>     selection_range;
 159         boost::shared_ptr<LocationList> ranges;
 160
 161         bool                            single_range_mode;
 162         boost::shared_ptr<Location>     single_range;
 163
 164 /* Channel Configs */
 165   public:
 166
 167         typedef boost::shared_ptr<ExportChannelConfiguration> ChannelConfigPtr;
 168
 169         struct ChannelConfigState {
 170                 ChannelConfigPtr config;
 171
 172                 ChannelConfigState (ChannelConfigPtr ptr) : config (ptr) {}
 173         };
 174         typedef boost::shared_ptr<ChannelConfigState> ChannelConfigStatePtr;
 175         typedef std::list<ChannelConfigStatePtr> ChannelConfigStateList;
 176
 177         ChannelConfigStateList const & get_channel_configs () { return check_list (channel_configs); }
 178         void clear_channel_configs () { channel_configs.clear(); }
 179         ChannelConfigStatePtr add_channel_config ();
 180
 181   private:
 182
 183         ChannelConfigStateList channel_configs;
 184
 185         bool init_channel_configs (XMLNodeList nodes);
 186
 187 /* Formats */
 188   public:
 189
 190         typedef boost::shared_ptr<ExportFormatSpecification> FormatPtr;
 191         typedef std::list<FormatPtr> FormatList;
 192
 193         struct FormatState {
 194                 boost::shared_ptr<FormatList const> list;
 195                 FormatPtr                           format;
 196
 197                 FormatState (boost::shared_ptr<FormatList const> list, FormatPtr format) :
 198                   list (list), format (format) {}
 199         };
 200         typedef boost::shared_ptr<FormatState> FormatStatePtr;
 201         typedef std::list<FormatStatePtr> FormatStateList;
 202
 203         FormatStateList const & get_formats () { return check_list (formats); }
 204         FormatStatePtr duplicate_format_state (FormatStatePtr state);
 205         void remove_format_state (FormatStatePtr state);
 206
 207         PBD::sys::path save_format_to_disk (FormatPtr format);
 208         void remove_format_profile (FormatPtr format);
 209         FormatPtr get_new_format (FormatPtr original);
 210
 211         PBD::Signal0<void> FormatListChanged;
 212
 213   private:
 214
 215         FormatStateList formats;
 216
 217         bool init_formats (XMLNodeList nodes);
 218         FormatStatePtr deserialize_format (XMLNode & root);
 219         XMLNode & serialize_format (FormatStatePtr state);
 220
 221         void load_formats ();
 222
 223         FormatPtr load_format (XMLNode & node);
 224         void load_format_from_disk (PBD::sys::path const & path);
 225
 226         boost::shared_ptr<FormatList> format_list;
 227         FileMap                       format_file_map;
 228
 229 /* Filenames */
 230   public:
 231
 232         typedef boost::shared_ptr<ExportFilename> FilenamePtr;
 233
 234         struct FilenameState {
 235                 FilenamePtr  filename;
 236
 237                 FilenameState (FilenamePtr ptr) : filename (ptr) {}
 238         };
 239         typedef boost::shared_ptr<FilenameState> FilenameStatePtr;
 240         typedef std::list<FilenameStatePtr> FilenameStateList;
 241
 242         FilenameStateList const & get_filenames () { return check_list (filenames); }
 243         FilenameStatePtr duplicate_filename_state (FilenameStatePtr state);
 244         void remove_filename_state (FilenameStatePtr state);
 245
 246   private:
 247
 248         FilenameStateList filenames;
 249
 250         bool init_filenames (XMLNodeList nodes);
 251         FilenamePtr load_filename (XMLNode & node);
 252
 253 /* Warnings */
 254   public:
 255         struct Warnings {
 256                 std::list<std::string> errors;
 257                 std::list<std::string> warnings;
 258                 std::list<std::string> conflicting_filenames;
 259         };
 260
 261         boost::shared_ptr<Warnings> get_warnings ();
 262
 263   private:
 264         void check_config (boost::shared_ptr<Warnings> warnings,
 265                            TimespanStatePtr timespan_state,
 266                            ChannelConfigStatePtr channel_config_state,
 267                            FormatStatePtr format_state,
 268                            FilenameStatePtr filename_state);
 269
 270         bool check_format (FormatPtr format, uint32_t channels);
 271         bool check_sndfile_format (FormatPtr format, unsigned int channels);
 272
 273  /* Utilities */
 274
 275         /* Element state lists should never be empty, this is used to check them */
 276         template<typename T>
 277         std::list<T> const &
 278         check_list (std::list<T> const & list)
 279         {
 280                 if (list.empty()) {
 281                         throw std::runtime_error ("Programming error: Uninitialized list in ExportProfileManager");
 282                 }
 283                 return list;
 284         }
 285
 286 };
 287
 288
 289 } // namespace ARDOUR
 290
 291 #endif /* __ardour_export_profile_manager_h__ */