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 use_session_snapshot_name (false),
53 include_revision (false),
54 include_channel_config (false),
55 include_format_name (false),
56 include_channel (false),
57 include_timespan (true), // Include timespan name always
67 localtime_r (&rawtime, &time_struct);
69 folder = session.session_directory().export_path();
71 XMLNode * extra_node = session.extra_xml ("ExportFilename");
72 /* Legacy sessions used Session instant.xml for this */
74 session.instant_xml ("ExportFilename");
78 set_state (*extra_node);
83 ExportFilename::get_state ()
85 XMLNode * node = new XMLNode ("ExportFilename");
88 FieldPair dir = analyse_folder();
89 child = node->add_child ("Folder");
90 child->add_property ("relative", dir.first ? "true" : "false");
91 child->add_property ("path", dir.second);
93 add_field (node, "label", include_label, label);
94 add_field (node, "session", include_session);
95 add_field (node, "snapshot", use_session_snapshot_name);
96 add_field (node, "timespan", include_timespan);
97 add_field (node, "revision", include_revision);
98 add_field (node, "time", include_time, enum_2_string (time_format));
99 add_field (node, "date", include_date, enum_2_string (date_format));
101 XMLNode * extra_node = new XMLNode ("ExportRevision");
102 extra_node->add_property ("revision", to_string (revision, std::dec));
103 session.add_extra_xml (*extra_node);
109 ExportFilename::set_state (const XMLNode & node)
112 XMLProperty const * prop;
115 child = node.child ("Folder");
116 if (!child) { return -1; }
120 if ((prop = child->property ("relative"))) {
121 if (string_is_affirmative (prop->value())) {
122 folder = session.session_directory().root_path();
126 if ((prop = child->property ("path"))) {
128 tmp = Glib::build_filename (folder, prop->value());
129 if (!Glib::file_test (tmp, Glib::FILE_TEST_EXISTS)) {
130 warning << string_compose (_("Existing export folder for this session (%1) does not exist - ignored"), tmp) << endmsg;
136 if (folder.empty()) {
137 folder = session.session_directory().export_path();
140 pair = get_field (node, "label");
141 include_label = pair.first;
144 pair = get_field (node, "session");
145 include_session = pair.first;
147 pair = get_field (node, "snapshot");
148 use_session_snapshot_name = pair.first;
150 pair = get_field (node, "timespan");
151 include_timespan = pair.first;
153 pair = get_field (node, "revision");
154 include_revision = pair.first;
156 pair = get_field (node, "time");
157 include_time = pair.first;
158 time_format = (TimeFormat) string_2_enum (pair.second, time_format);
160 pair = get_field (node, "date");
161 include_date = pair.first;
162 date_format = (DateFormat) string_2_enum (pair.second, date_format);
164 XMLNode * extra_node = session.extra_xml ("ExportRevision");
165 /* Legacy sessions used Session instant.xml for this */
167 extra_node = session.instant_xml ("ExportRevision");
170 if (extra_node && (prop = extra_node->property ("revision"))) {
171 revision = atoi (prop->value());
178 ExportFilename::get_path (ExportFormatSpecPtr format) const
181 bool filename_empty = true;
182 bool with_timespan = include_timespan;
188 && !include_channel_config
191 && !include_format_name) {
192 with_timespan = true;
195 if (include_session) {
196 path += filename_empty ? "" : "_";
197 if (use_session_snapshot_name) {
198 path += session.snap_name();
200 path += session.name();
202 filename_empty = false;
206 path += filename_empty ? "" : "_";
208 filename_empty = false;
211 if (include_revision) {
212 path += filename_empty ? "" : "_";
214 path += to_string (revision, std::dec);
215 filename_empty = false;
218 if (with_timespan && timespan) {
219 path += filename_empty ? "" : "_";
220 path += timespan->name();
221 filename_empty = false;
224 if (include_channel_config && channel_config) {
225 path += filename_empty ? "" : "_";
226 path += channel_config->name();
227 filename_empty = false;
230 if (include_channel) {
231 path += filename_empty ? "" : "_";
233 path += to_string (channel, std::dec);
234 filename_empty = false;
238 path += filename_empty ? "" : "_";
239 path += get_date_format_str (date_format);
240 filename_empty = false;
244 path += filename_empty ? "" : "_";
245 path += get_time_format_str (time_format);
246 filename_empty = false;
249 if (include_format_name) {
250 path += filename_empty ? "" : "_";
251 path += format->name();
252 filename_empty = false;
260 path += format->extension ();
262 path = legalize_for_universal_path (path);
264 return Glib::build_filename (folder, path);
268 ExportFilename::get_time_format_str (TimeFormat format) const
275 return get_formatted_time ("%H%M");
278 return get_formatted_time ("%H.%M");
281 return _("Invalid time format");
286 ExportFilename::get_date_format_str (DateFormat format) const
293 return get_formatted_time ("%Y%m%d");
296 return get_formatted_time ("%Y-%m-%d");
299 return get_formatted_time ("%y%m%d");
302 return get_formatted_time ("%y-%m-%d");
305 return _("Invalid date format");
310 ExportFilename::set_time_format (TimeFormat format)
312 time_format = format;
314 if (format == T_None) {
315 include_time = false;
322 ExportFilename::set_date_format (DateFormat format)
324 date_format = format;
326 if (format == D_None) {
327 include_date = false;
334 ExportFilename::set_label (string value)
337 include_label = !value.compare ("");
341 ExportFilename::set_folder (string path)
343 // TODO check folder existence
349 ExportFilename::get_formatted_time (string const & format) const
352 strftime (buffer, 80, format.c_str(), &time_struct);
354 string return_value (buffer);
359 ExportFilename::add_field (XMLNode * node, string const & name, bool enabled, string const & value)
361 XMLNode * child = node->add_child ("Field");
364 std::cerr << "Error adding a field to ExportFilename XML-tree" << std::endl;
368 child->add_property ("name", name);
369 child->add_property ("enabled", enabled ? "true" : "false");
370 if (!value.empty()) {
371 child->add_property ("value", value);
375 ExportFilename::FieldPair
376 ExportFilename::get_field (XMLNode const & node, string const & name)
381 XMLNodeList children = node.children();
383 for (XMLNodeList::iterator it = children.begin(); it != children.end(); ++it) {
384 XMLProperty const * prop = (*it)->property ("name");
385 if (prop && !prop->value().compare (name)) {
387 prop = (*it)->property ("enabled");
388 if (prop && !prop->value().compare ("true")) {
394 prop = (*it)->property ("value");
396 pair.second = prop->value();
406 ExportFilename::FieldPair
407 ExportFilename::analyse_folder ()
411 string session_dir = session.session_directory().root_path();
412 string::size_type session_dir_len = session_dir.length();
414 string folder_beginning = folder.substr (0, session_dir_len);
416 if (!folder_beginning.compare (session_dir)) {
418 pair.second = folder.substr (session_dir_len);
421 pair.second = folder;
427 } // namespace ARDOUR