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