libs/ardour/export_filename.cc

   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 #include <string>
  22
  23 #include <glibmm/miscutils.h>
  24 #include <glibmm/fileutils.h>
  25
  26 #include "pbd/xml++.h"
  27 #include "pbd/string_convert.h"
  28 #include "pbd/enumwriter.h"
  29 #include "pbd/localtime_r.h"
  30
  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"
  39
  40 #include "pbd/i18n.h"
  41
  42 using namespace PBD;
  43 using namespace Glib;
  44 using std::string;
  45
  46 namespace ARDOUR
  47 {
  48
  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
  58   include_time (false),
  59   include_date (false),
  60   session (session),
  61   revision (1),
  62   date_format (D_None),
  63   time_format (T_None)
  64 {
  65         time_t rawtime;
  66         std::time (&rawtime);
  67         localtime_r (&rawtime, &time_struct);
  68
  69         folder = session.session_directory().export_path();
  70
  71         XMLNode * extra_node = session.extra_xml ("ExportFilename");
  72         /* Legacy sessions used Session instant.xml for this */
  73         if (!extra_node) {
  74                 session.instant_xml ("ExportFilename");
  75         }
  76
  77         if (extra_node) {
  78                 set_state (*extra_node);
  79         }
  80 }
  81
  82 XMLNode &
  83 ExportFilename::get_state ()
  84 {
  85         XMLNode * node = new XMLNode ("ExportFilename");
  86         XMLNode * child;
  87
  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);
  92
  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));
 100
 101         XMLNode * extra_node = new XMLNode ("ExportRevision");
 102         extra_node->set_property ("revision", revision);
 103         session.add_extra_xml (*extra_node);
 104
 105         return *node;
 106 }
 107
 108 int
 109 ExportFilename::set_state (const XMLNode & node)
 110 {
 111         XMLNode * child;
 112         FieldPair pair;
 113
 114         child = node.child ("Folder");
 115         if (!child) { return -1; }
 116
 117         folder = "";
 118
 119         bool is_relative;
 120         if (child->get_property ("relative", is_relative) && is_relative) {
 121                 folder = session.session_directory ().root_path ();
 122         }
 123
 124         std::string tmp;
 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;
 129                 } else {
 130                         folder = tmp;
 131                 }
 132         }
 133
 134         if (folder.empty()) {
 135                 folder = session.session_directory().export_path();
 136         }
 137
 138         pair = get_field (node, "label");
 139         include_label = pair.first;
 140         label = pair.second;
 141
 142         pair = get_field (node, "session");
 143         include_session = pair.first;
 144
 145         pair = get_field (node, "snapshot");
 146         use_session_snapshot_name = pair.first;
 147
 148         pair = get_field (node, "timespan");
 149         include_timespan = pair.first;
 150
 151         pair = get_field (node, "revision");
 152         include_revision = pair.first;
 153
 154         pair = get_field (node, "time");
 155         include_time = pair.first;
 156         time_format = (TimeFormat) string_2_enum (pair.second, time_format);
 157
 158         pair = get_field (node, "date");
 159         include_date = pair.first;
 160         date_format = (DateFormat) string_2_enum (pair.second, date_format);
 161
 162         XMLNode * extra_node = session.extra_xml ("ExportRevision");
 163         /* Legacy sessions used Session instant.xml for this */
 164         if (!extra_node) {
 165                 extra_node = session.instant_xml ("ExportRevision");
 166         }
 167
 168         if (extra_node) {
 169                 extra_node->get_property ("revision", revision);
 170         }
 171
 172         return 0;
 173 }
 174
 175 string
 176 ExportFilename::get_path (ExportFormatSpecPtr format) const
 177 {
 178         string path;
 179         bool filename_empty = true;
 180         bool with_timespan = include_timespan;
 181
 182         if (!include_session
 183                         && !include_label
 184                         && !include_revision
 185                         && !include_timespan
 186                         && !include_channel_config
 187                         && !include_channel
 188                         && !include_date
 189                         && !include_format_name) {
 190                 with_timespan = true;
 191         }
 192
 193         if (include_session) {
 194                 path += filename_empty ? "" : "_";
 195                 if (use_session_snapshot_name) {
 196                         path += session.snap_name();
 197                 } else {
 198                         path += session.name();
 199                 }
 200                 filename_empty = false;
 201         }
 202
 203         if (include_label) {
 204                 path += filename_empty ? "" : "_";
 205                 path += label;
 206                 filename_empty = false;
 207         }
 208
 209         if (include_revision) {
 210                 path += filename_empty ? "" : "_";
 211                 path += "r";
 212                 path += to_string (revision);
 213                 filename_empty = false;
 214         }
 215
 216         if (with_timespan && timespan) {
 217                 path += filename_empty ? "" : "_";
 218                 path += timespan->name();
 219                 filename_empty = false;
 220         }
 221
 222         if (include_channel_config && channel_config) {
 223                 path += filename_empty ? "" : "_";
 224                 path += channel_config->name();
 225                 filename_empty = false;
 226         }
 227
 228         if (include_channel) {
 229                 path += filename_empty ? "" : "_";
 230                 path += "channel";
 231                 path += to_string (channel);
 232                 filename_empty = false;
 233         }
 234
 235         if (include_date) {
 236                 path += filename_empty ? "" : "_";
 237                 path += get_date_format_str (date_format);
 238                 filename_empty = false;
 239         }
 240
 241         if (include_time) {
 242                 path += filename_empty ? "" : "_";
 243                 path += get_time_format_str (time_format);
 244                 filename_empty = false;
 245         }
 246
 247         if (include_format_name) {
 248                 path += filename_empty ? "" : "_";
 249                 path += format->name();
 250                 filename_empty = false;
 251         }
 252
 253         if (path.empty ()) {
 254                 path = "export";
 255         }
 256
 257         path += ".";
 258         path += format->extension ();
 259
 260         path = legalize_for_universal_path (path);
 261
 262         return Glib::build_filename (folder, path);
 263 }
 264
 265 string
 266 ExportFilename::get_time_format_str (TimeFormat format) const
 267 {
 268         switch ( format ) {
 269           case T_None:
 270                 return _("No Time");
 271
 272           case T_NoDelim:
 273                 return get_formatted_time ("%H%M");
 274
 275           case T_Delim:
 276                 return get_formatted_time ("%H.%M");
 277
 278           default:
 279                 return _("Invalid time format");
 280         }
 281 }
 282
 283 string
 284 ExportFilename::get_date_format_str (DateFormat format) const
 285 {
 286         switch (format) {
 287           case D_None:
 288                 return _("No Date");
 289
 290           case D_BE:
 291                 return get_formatted_time ("%Y%m%d");
 292
 293           case D_ISO:
 294                 return get_formatted_time ("%Y-%m-%d");
 295
 296           case D_BEShortY:
 297                 return get_formatted_time ("%y%m%d");
 298
 299           case D_ISOShortY:
 300                 return get_formatted_time ("%y-%m-%d");
 301
 302           default:
 303                 return _("Invalid date format");
 304         }
 305 }
 306
 307 void
 308 ExportFilename::set_time_format (TimeFormat format)
 309 {
 310         time_format = format;
 311
 312         if (format == T_None) {
 313                 include_time = false;
 314         } else {
 315                 include_time = true;
 316         }
 317 }
 318
 319 void
 320 ExportFilename::set_date_format (DateFormat format)
 321 {
 322         date_format = format;
 323
 324         if (format == D_None) {
 325                 include_date = false;
 326         } else {
 327                 include_date = true;
 328         }
 329 }
 330
 331 void
 332 ExportFilename::set_label (string value)
 333 {
 334         label = value;
 335         include_label = !value.compare ("");
 336 }
 337
 338 bool
 339 ExportFilename::set_folder (string path)
 340 {
 341         // TODO check folder existence
 342         folder = path;
 343         return true;
 344 }
 345
 346 string
 347 ExportFilename::get_formatted_time (string const & format) const
 348 {
 349         char buffer [80];
 350         strftime (buffer, 80, format.c_str(), &time_struct);
 351
 352         string return_value (buffer);
 353         return return_value;
 354 }
 355
 356 void
 357 ExportFilename::add_field (XMLNode * node, string const & name, bool enabled, string const & value)
 358 {
 359         XMLNode * child = node->add_child ("Field");
 360
 361         if (!child) {
 362                 std::cerr << "Error adding a field to ExportFilename XML-tree" << std::endl;
 363                 return;
 364         }
 365
 366         child->set_property ("name", name);
 367         child->set_property ("enabled", enabled);
 368         if (!value.empty()) {
 369                 child->set_property ("value", value);
 370         }
 371 }
 372
 373 ExportFilename::FieldPair
 374 ExportFilename::get_field (XMLNode const & node, string const & name)
 375 {
 376         FieldPair pair;
 377         pair.first = false;
 378
 379         XMLNodeList children = node.children();
 380
 381         for (XMLNodeList::iterator it = children.begin(); it != children.end(); ++it) {
 382                 std::string str;
 383                 if ((*it)->get_property ("name", str) && name == str) {
 384
 385                         (*it)->get_property ("enabled", pair.first);
 386                         (*it)->get_property ("value", pair.second);
 387
 388                         return pair;
 389                 }
 390         }
 391
 392         return pair;
 393 }
 394
 395 ExportFilename::FieldPair
 396 ExportFilename::analyse_folder ()
 397 {
 398         FieldPair pair;
 399
 400         string session_dir = session.session_directory().root_path();
 401         string::size_type session_dir_len = session_dir.length();
 402
 403         string folder_beginning = folder.substr (0, session_dir_len);
 404
 405         if (!folder_beginning.compare (session_dir)) {
 406                 pair.first = true;
 407                 pair.second = folder.substr (session_dir_len);
 408         } else {
 409                 pair.first = false;
 410                 pair.second = folder;
 411         }
 412
 413         return pair;
 414 }
 415
 416 } // namespace ARDOUR