2 Copyright (C) 2008 Paul Davis
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.
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.
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.
21 #ifndef __ardour_export_profile_manager_h__
22 #define __ardour_export_profile_manager_h__
30 #include <boost/shared_ptr.hpp>
33 #include "pbd/file_utils.h"
34 #include "pbd/xml++.h"
36 #include "ardour/filesystem_paths.h"
37 #include "ardour/location.h"
38 #include "ardour/types.h"
39 #include "ardour/export_handler.h"
48 /// Manages (de)serialization of export profiles and related classes
49 class ExportProfileManager
61 ExportProfileManager (Session & s, ExportType type);
62 ~ExportProfileManager ();
65 void prepare_for_export ();
67 typedef std::list<ExportPresetPtr> PresetList;
69 PresetList const & get_presets () { return preset_list; }
70 bool load_preset (ExportPresetPtr preset);
71 ExportPresetPtr new_preset (std::string const & name);
72 ExportPresetPtr save_preset (std::string const & name);
73 void remove_preset ();
76 typedef boost::shared_ptr<ExportHandler> HandlerPtr;
78 typedef std::pair<PBD::UUID, std::string> FilePair;
79 typedef std::map<PBD::UUID, std::string> FileMap;
82 std::string xml_node_name;
86 std::string preset_filename (std::string const & preset_name);
88 void load_preset_from_disk (std::string const & path);
90 bool set_state (XMLNode const & root);
91 bool set_global_state (XMLNode const & root);
92 bool set_local_state (XMLNode const & root);
94 void serialize_profile (XMLNode & root);
95 void serialize_global_profile (XMLNode & root);
96 void serialize_local_profile (XMLNode & root);
98 PresetList preset_list;
99 ExportPresetPtr current_preset;
100 FileMap preset_file_map;
102 std::vector<std::string> find_file (std::string const & pattern);
104 std::string export_config_dir;
105 PBD::Searchpath search_path;
110 typedef std::list<ExportTimespanPtr> TimespanList;
111 typedef boost::shared_ptr<TimespanList> TimespanListPtr;
112 typedef std::list<Location *> LocationList;
121 struct TimespanState {
122 TimespanListPtr timespans;
123 TimeFormat time_format;
125 boost::shared_ptr<Location> selection_range;
126 boost::shared_ptr<LocationList> ranges;
128 TimespanState (boost::shared_ptr<Location> selection_range,
129 boost::shared_ptr<LocationList> ranges)
130 : timespans (new TimespanList ())
131 , time_format (Timecode)
132 , selection_range (selection_range)
137 typedef boost::shared_ptr<TimespanState> TimespanStatePtr;
138 typedef std::list<TimespanStatePtr> TimespanStateList;
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); }
146 TimespanStateList timespans;
148 bool init_timespans (XMLNodeList nodes);
150 TimespanStatePtr deserialize_timespan (XMLNode & root);
151 XMLNode & serialize_timespan (TimespanStatePtr state);
155 void update_ranges ();
157 boost::shared_ptr<Location> selection_range;
158 boost::shared_ptr<LocationList> ranges;
160 bool single_range_mode;
161 boost::shared_ptr<Location> single_range;
163 /* Channel Configs */
166 struct ChannelConfigState {
167 ExportChannelConfigPtr config;
169 ChannelConfigState (ExportChannelConfigPtr ptr) : config (ptr) {}
171 typedef boost::shared_ptr<ChannelConfigState> ChannelConfigStatePtr;
172 typedef std::list<ChannelConfigStatePtr> ChannelConfigStateList;
174 ChannelConfigStateList const & get_channel_configs () { return check_list (channel_configs); }
175 void clear_channel_configs () { channel_configs.clear(); }
176 ChannelConfigStatePtr add_channel_config ();
180 ChannelConfigStateList channel_configs;
182 bool init_channel_configs (XMLNodeList nodes);
187 typedef std::list<ExportFormatSpecPtr> FormatList;
190 boost::shared_ptr<FormatList const> list;
191 ExportFormatSpecPtr format;
193 FormatState (boost::shared_ptr<FormatList const> list, ExportFormatSpecPtr format) :
194 list (list), format (format) {}
196 typedef boost::shared_ptr<FormatState> FormatStatePtr;
197 typedef std::list<FormatStatePtr> FormatStateList;
199 FormatStateList const & get_formats () { return check_list (formats); }
200 FormatStatePtr duplicate_format_state (FormatStatePtr state);
201 void remove_format_state (FormatStatePtr state);
203 std::string save_format_to_disk (ExportFormatSpecPtr format);
204 void remove_format_profile (ExportFormatSpecPtr format);
205 ExportFormatSpecPtr get_new_format (ExportFormatSpecPtr original);
207 PBD::Signal0<void> FormatListChanged;
211 FormatStateList formats;
213 bool init_formats (XMLNodeList nodes);
214 FormatStatePtr deserialize_format (XMLNode & root);
215 XMLNode & serialize_format (FormatStatePtr state);
217 void load_formats ();
219 ExportFormatSpecPtr load_format (XMLNode & node);
220 void load_format_from_disk (std::string const & path);
222 boost::shared_ptr<FormatList> format_list;
223 FileMap format_file_map;
228 struct FilenameState {
229 ExportFilenamePtr filename;
231 FilenameState (ExportFilenamePtr ptr) : filename (ptr) {}
233 typedef boost::shared_ptr<FilenameState> FilenameStatePtr;
234 typedef std::list<FilenameStatePtr> FilenameStateList;
236 FilenameStateList const & get_filenames () { return check_list (filenames); }
237 FilenameStatePtr duplicate_filename_state (FilenameStatePtr state);
238 void remove_filename_state (FilenameStatePtr state);
240 std::string get_sample_filename_for_format (ExportFilenamePtr filename, ExportFormatSpecPtr format);
244 FilenameStateList filenames;
246 bool init_filenames (XMLNodeList nodes);
247 ExportFilenamePtr load_filename (XMLNode & node);
252 std::list<std::string> errors;
253 std::list<std::string> warnings;
254 std::list<std::string> conflicting_filenames;
257 boost::shared_ptr<Warnings> get_warnings ();
260 void check_config (boost::shared_ptr<Warnings> warnings,
261 TimespanStatePtr timespan_state,
262 ChannelConfigStatePtr channel_config_state,
263 FormatStatePtr format_state,
264 FilenameStatePtr filename_state);
266 bool check_format (ExportFormatSpecPtr format, uint32_t channels);
267 bool check_sndfile_format (ExportFormatSpecPtr format, unsigned int channels);
271 void build_filenames(std::list<std::string> & result, ExportFilenamePtr filename,
272 TimespanListPtr timespans, ExportChannelConfigPtr channel_config,
273 ExportFormatSpecPtr format);
275 /* Element state lists should never be empty, this is used to check them */
278 check_list (std::list<T> const & list)
281 throw std::runtime_error ("Programming error: Uninitialized list in ExportProfileManager");
289 } // namespace ARDOUR
291 #endif /* __ardour_export_profile_manager_h__ */