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.
23 #include <glibmm/miscutils.h>
24 #include <glibmm/fileutils.h>
26 #include "pbd/xml++.h"
27 #include "pbd/convert.h"
28 #include "pbd/enumwriter.h"
29 #include "pbd/localtime_r.h"
31 #include "ardour/libardour_visibility.h"
32 #include "ardour/session.h"
33 #include "ardour/session_directory.h"
34 #include "ardour/export_filename.h"
35 #include "ardour/export_format_specification.h"
36 #include "ardour/export_channel_configuration.h"
37 #include "ardour/export_timespan.h"
38 #include "ardour/utils.h"
49 ExportFilename::ExportFilename (Session & session) :
50 include_label (false),
51 include_session (false),
52 include_revision (false),
53 include_channel_config (false),
54 include_format_name (false),
55 include_channel (false),
56 include_timespan (true), // Include timespan name always
66 localtime_r (&rawtime, &time_struct);
68 folder = session.session_directory().export_path();
70 XMLNode * extra_node = session.extra_xml ("ExportFilename");
71 /* Legacy sessions used Session instant.xml for this */
73 session.instant_xml ("ExportFilename");
77 set_state (*extra_node);
82 ExportFilename::get_state ()
84 XMLNode * node = new XMLNode ("ExportFilename");
87 FieldPair dir = analyse_folder();
88 child = node->add_child ("Folder");
89 child->add_property ("relative", dir.first ? "true" : "false");
90 child->add_property ("path", dir.second);
92 add_field (node, "label", include_label, label);
93 add_field (node, "session", include_session);
94 add_field (node, "timespan", include_timespan);
95 add_field (node, "revision", include_revision);
96 add_field (node, "time", include_time, enum_2_string (time_format));
97 add_field (node, "date", include_date, enum_2_string (date_format));
99 XMLNode * extra_node = new XMLNode ("ExportRevision");
100 extra_node->add_property ("revision", to_string (revision, std::dec));
101 session.add_extra_xml (*extra_node);
107 ExportFilename::set_state (const XMLNode & node)
110 XMLProperty const * prop;
113 child = node.child ("Folder");
114 if (!child) { return -1; }
118 if ((prop = child->property ("relative"))) {
119 if (string_is_affirmative (prop->value())) {
120 folder = session.session_directory().root_path();
124 if ((prop = child->property ("path"))) {
126 tmp = Glib::build_filename (folder, prop->value());
127 if (!Glib::file_test (tmp, Glib::FILE_TEST_EXISTS)) {
128 warning << string_compose (_("Existing export folder for this session (%1) does not exist - ignored"), tmp) << endmsg;
134 if (folder.empty()) {
135 folder = session.session_directory().export_path();
138 pair = get_field (node, "label");
139 include_label = pair.first;
142 pair = get_field (node, "session");
143 include_session = pair.first;
145 pair = get_field (node, "timespan");
146 include_timespan = pair.first;
148 pair = get_field (node, "revision");
149 include_revision = pair.first;
151 pair = get_field (node, "time");
152 include_time = pair.first;
153 time_format = (TimeFormat) string_2_enum (pair.second, time_format);
155 pair = get_field (node, "date");
156 include_date = pair.first;
157 date_format = (DateFormat) string_2_enum (pair.second, date_format);
159 XMLNode * extra_node = session.extra_xml ("ExportRevision");
160 /* Legacy sessions used Session instant.xml for this */
162 extra_node = session.instant_xml ("ExportRevision");
165 if (extra_node && (prop = extra_node->property ("revision"))) {
166 revision = atoi (prop->value());
173 ExportFilename::get_path (ExportFormatSpecPtr format) const
176 bool filename_empty = true;
177 bool with_timespan = include_timespan;
183 && !include_channel_config
186 && !include_format_name) {
187 with_timespan = true;
190 if (include_session) {
191 path += filename_empty ? "" : "_";
192 path += session.name();
193 filename_empty = false;
197 path += filename_empty ? "" : "_";
199 filename_empty = false;
202 if (include_revision) {
203 path += filename_empty ? "" : "_";
205 path += to_string (revision, std::dec);
206 filename_empty = false;
209 if (with_timespan && timespan) {
210 path += filename_empty ? "" : "_";
211 path += timespan->name();
212 filename_empty = false;
215 if (include_channel_config && channel_config) {
216 path += filename_empty ? "" : "_";
217 path += channel_config->name();
218 filename_empty = false;
221 if (include_channel) {
222 path += filename_empty ? "" : "_";
224 path += to_string (channel, std::dec);
225 filename_empty = false;
229 path += filename_empty ? "" : "_";
230 path += get_date_format_str (date_format);
231 filename_empty = false;
235 path += filename_empty ? "" : "_";
236 path += get_time_format_str (time_format);
237 filename_empty = false;
240 if (include_format_name) {
241 path += filename_empty ? "" : "_";
242 path += format->name();
243 filename_empty = false;
251 path += format->extension ();
253 path = legalize_for_universal_path (path);
255 return Glib::build_filename (folder, path);
259 ExportFilename::get_time_format_str (TimeFormat format) const
266 return get_formatted_time ("%H%M");
269 return get_formatted_time ("%H.%M");
272 return _("Invalid time format");
277 ExportFilename::get_date_format_str (DateFormat format) const
284 return get_formatted_time ("%Y%m%d");
287 return get_formatted_time ("%Y-%m-%d");
290 return get_formatted_time ("%y%m%d");
293 return get_formatted_time ("%y-%m-%d");
296 return _("Invalid date format");
301 ExportFilename::set_time_format (TimeFormat format)
303 time_format = format;
305 if (format == T_None) {
306 include_time = false;
313 ExportFilename::set_date_format (DateFormat format)
315 date_format = format;
317 if (format == D_None) {
318 include_date = false;
325 ExportFilename::set_label (string value)
328 include_label = !value.compare ("");
332 ExportFilename::set_folder (string path)
334 // TODO check folder existence
340 ExportFilename::get_formatted_time (string const & format) const
343 strftime (buffer, 80, format.c_str(), &time_struct);
345 string return_value (buffer);
350 ExportFilename::add_field (XMLNode * node, string const & name, bool enabled, string const & value)
352 XMLNode * child = node->add_child ("Field");
355 std::cerr << "Error adding a field to ExportFilename XML-tree" << std::endl;
359 child->add_property ("name", name);
360 child->add_property ("enabled", enabled ? "true" : "false");
361 if (!value.empty()) {
362 child->add_property ("value", value);
366 ExportFilename::FieldPair
367 ExportFilename::get_field (XMLNode const & node, string const & name)
372 XMLNodeList children = node.children();
374 for (XMLNodeList::iterator it = children.begin(); it != children.end(); ++it) {
375 XMLProperty const * prop = (*it)->property ("name");
376 if (prop && !prop->value().compare (name)) {
378 prop = (*it)->property ("enabled");
379 if (prop && !prop->value().compare ("true")) {
385 prop = (*it)->property ("value");
387 pair.second = prop->value();
397 ExportFilename::FieldPair
398 ExportFilename::analyse_folder ()
402 string session_dir = session.session_directory().root_path();
403 string::size_type session_dir_len = session_dir.length();
405 string folder_beginning = folder.substr (0, session_dir_len);
407 if (!folder_beginning.compare (session_dir)) {
409 pair.second = folder.substr (session_dir_len);
412 pair.second = folder;
418 } // namespace ARDOUR