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/string_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->set_property ("relative", dir.first);
91 child->set_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->set_property ("revision", revision);
103 session.add_extra_xml (*extra_node);
109 ExportFilename::set_state (const XMLNode & node)
114 child = node.child ("Folder");
115 if (!child) { return -1; }
120 if (child->get_property ("relative", is_relative) && is_relative) {
121 folder = session.session_directory ().root_path ();
125 if (child->get_property ("path", tmp)) {
126 tmp = Glib::build_filename (folder, tmp);
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, "snapshot");
146 use_session_snapshot_name = pair.first;
148 pair = get_field (node, "timespan");
149 include_timespan = pair.first;
151 pair = get_field (node, "revision");
152 include_revision = pair.first;
154 pair = get_field (node, "time");
155 include_time = pair.first;
156 time_format = (TimeFormat) string_2_enum (pair.second, time_format);
158 pair = get_field (node, "date");
159 include_date = pair.first;
160 date_format = (DateFormat) string_2_enum (pair.second, date_format);
162 XMLNode * extra_node = session.extra_xml ("ExportRevision");
163 /* Legacy sessions used Session instant.xml for this */
165 extra_node = session.instant_xml ("ExportRevision");
169 extra_node->get_property ("revision", revision);
176 ExportFilename::get_path (ExportFormatSpecPtr format) const
179 bool filename_empty = true;
180 bool with_timespan = include_timespan;
186 && !include_channel_config
189 && !include_format_name) {
190 with_timespan = true;
193 if (include_session) {
194 path += filename_empty ? "" : "_";
195 if (use_session_snapshot_name) {
196 path += session.snap_name();
198 path += session.name();
200 filename_empty = false;
204 path += filename_empty ? "" : "_";
206 filename_empty = false;
209 if (include_revision) {
210 path += filename_empty ? "" : "_";
212 path += to_string (revision);
213 filename_empty = false;
216 if (with_timespan && timespan) {
217 path += filename_empty ? "" : "_";
218 path += timespan->name();
219 filename_empty = false;
222 if (include_channel_config && channel_config) {
223 path += filename_empty ? "" : "_";
224 path += channel_config->name();
225 filename_empty = false;
228 if (include_channel) {
229 path += filename_empty ? "" : "_";
231 path += to_string (channel);
232 filename_empty = false;
236 path += filename_empty ? "" : "_";
237 path += get_date_format_str (date_format);
238 filename_empty = false;
242 path += filename_empty ? "" : "_";
243 path += get_time_format_str (time_format);
244 filename_empty = false;
247 if (include_format_name) {
248 path += filename_empty ? "" : "_";
249 path += format->name();
250 filename_empty = false;
258 path += format->extension ();
260 path = legalize_for_universal_path (path);
262 return Glib::build_filename (folder, path);
266 ExportFilename::get_time_format_str (TimeFormat format) const
273 return get_formatted_time ("%H%M");
276 return get_formatted_time ("%H.%M");
279 return _("Invalid time format");
284 ExportFilename::get_date_format_str (DateFormat format) const
291 return get_formatted_time ("%Y%m%d");
294 return get_formatted_time ("%Y-%m-%d");
297 return get_formatted_time ("%y%m%d");
300 return get_formatted_time ("%y-%m-%d");
303 return _("Invalid date format");
308 ExportFilename::set_time_format (TimeFormat format)
310 time_format = format;
312 if (format == T_None) {
313 include_time = false;
320 ExportFilename::set_date_format (DateFormat format)
322 date_format = format;
324 if (format == D_None) {
325 include_date = false;
332 ExportFilename::set_label (string value)
335 include_label = !value.compare ("");
339 ExportFilename::set_folder (string path)
341 // TODO check folder existence
347 ExportFilename::get_formatted_time (string const & format) const
350 strftime (buffer, 80, format.c_str(), &time_struct);
352 string return_value (buffer);
357 ExportFilename::add_field (XMLNode * node, string const & name, bool enabled, string const & value)
359 XMLNode * child = node->add_child ("Field");
362 std::cerr << "Error adding a field to ExportFilename XML-tree" << std::endl;
366 child->set_property ("name", name);
367 child->set_property ("enabled", enabled);
368 if (!value.empty()) {
369 child->set_property ("value", value);
373 ExportFilename::FieldPair
374 ExportFilename::get_field (XMLNode const & node, string const & name)
379 XMLNodeList children = node.children();
381 for (XMLNodeList::iterator it = children.begin(); it != children.end(); ++it) {
383 if ((*it)->get_property ("name", str) && name == str) {
385 (*it)->get_property ("enabled", pair.first);
386 (*it)->get_property ("value", pair.second);
395 ExportFilename::FieldPair
396 ExportFilename::analyse_folder ()
400 string session_dir = session.session_directory().root_path();
401 string::size_type session_dir_len = session_dir.length();
403 string folder_beginning = folder.substr (0, session_dir_len);
405 if (!folder_beginning.compare (session_dir)) {
407 pair.second = folder.substr (session_dir_len);
410 pair.second = folder;
416 } // namespace ARDOUR