8cbb9727e9
If multiple filenames have the same extension, append the format name to the filename. This still requires a bit of extra logic to be optimal, as the format name will now be added in some situations where it is not needed. However, this is better than producing a broken file...
385 lines
8.4 KiB
C++
385 lines
8.4 KiB
C++
/*
|
|
Copyright (C) 2008 Paul Davis
|
|
Author: Sakari Bergen
|
|
|
|
This program is free software; you can redistribute it and/or modify
|
|
it under the terms of the GNU General Public License as published by
|
|
the Free Software Foundation; either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program; if not, write to the Free Software
|
|
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
|
|
|
|
*/
|
|
|
|
#include <string>
|
|
#include "ardour/export_filename.h"
|
|
|
|
#include <glibmm/miscutils.h>
|
|
#include <glibmm/fileutils.h>
|
|
|
|
#include "pbd/xml++.h"
|
|
#include "pbd/convert.h"
|
|
#include "pbd/enumwriter.h"
|
|
|
|
#include "ardour/session.h"
|
|
#include "ardour/session_directory.h"
|
|
#include "ardour/export_timespan.h"
|
|
#include "ardour/export_format_specification.h"
|
|
#include "ardour/export_channel_configuration.h"
|
|
#include "ardour/utils.h"
|
|
|
|
#include "i18n.h"
|
|
|
|
using namespace PBD;
|
|
using namespace Glib;
|
|
using std::string;
|
|
|
|
namespace ARDOUR
|
|
{
|
|
|
|
ExportFilename::ExportFilename (Session & session) :
|
|
include_label (false),
|
|
include_session (false),
|
|
include_revision (false),
|
|
include_channel_config (false),
|
|
include_format_name (false),
|
|
include_channel (false),
|
|
include_timespan (true), // Include timespan name always
|
|
include_time (false),
|
|
include_date (false),
|
|
session (session),
|
|
revision (1)
|
|
{
|
|
time_t rawtime;
|
|
std::time (&rawtime);
|
|
time_struct = localtime (&rawtime);
|
|
|
|
folder = session.session_directory().export_path();
|
|
|
|
XMLNode * instant_node = session.instant_xml ("ExportFilename");
|
|
if (instant_node) {
|
|
set_state (*instant_node);
|
|
}
|
|
}
|
|
|
|
XMLNode &
|
|
ExportFilename::get_state ()
|
|
{
|
|
XMLNode * node = new XMLNode ("ExportFilename");
|
|
XMLNode * child;
|
|
|
|
FieldPair dir = analyse_folder();
|
|
child = node->add_child ("Folder");
|
|
child->add_property ("relative", dir.first ? "true" : "false");
|
|
child->add_property ("path", dir.second);
|
|
|
|
add_field (node, "label", include_label, label);
|
|
add_field (node, "session", include_session);
|
|
add_field (node, "revision", include_revision);
|
|
add_field (node, "time", include_time, enum_2_string (time_format));
|
|
add_field (node, "date", include_date, enum_2_string (date_format));
|
|
|
|
XMLNode * instant_node = new XMLNode ("ExportRevision");
|
|
instant_node->add_property ("revision", to_string (revision, std::dec));
|
|
session.add_instant_xml (*instant_node);
|
|
|
|
return *node;
|
|
}
|
|
|
|
int
|
|
ExportFilename::set_state (const XMLNode & node)
|
|
{
|
|
XMLNode * child;
|
|
XMLProperty * prop;
|
|
FieldPair pair;
|
|
|
|
child = node.child ("Folder");
|
|
if (!child) { return -1; }
|
|
|
|
folder = "";
|
|
|
|
if ((prop = child->property ("relative"))) {
|
|
if (string_is_affirmative (prop->value())) {
|
|
folder = session.session_directory().root_path();
|
|
}
|
|
}
|
|
|
|
if ((prop = child->property ("path"))) {
|
|
std::string tmp;
|
|
tmp = Glib::build_filename (folder, prop->value());
|
|
if (!Glib::file_test (tmp, Glib::FILE_TEST_EXISTS)) {
|
|
warning << string_compose (_("Existing export folder for this session (%1) does not exist - ignored"), tmp) << endmsg;
|
|
} else {
|
|
folder = tmp;
|
|
}
|
|
}
|
|
|
|
if (folder.empty()) {
|
|
folder = session.session_directory().export_path();
|
|
}
|
|
|
|
pair = get_field (node, "label");
|
|
include_label = pair.first;
|
|
label = pair.second;
|
|
|
|
pair = get_field (node, "session");
|
|
include_session = pair.first;
|
|
|
|
pair = get_field (node, "revision");
|
|
include_revision = pair.first;
|
|
|
|
pair = get_field (node, "time");
|
|
include_time = pair.first;
|
|
time_format = (TimeFormat) string_2_enum (pair.second, time_format);
|
|
|
|
pair = get_field (node, "date");
|
|
include_date = pair.first;
|
|
date_format = (DateFormat) string_2_enum (pair.second, date_format);
|
|
|
|
XMLNode * instant_node = session.instant_xml ("ExportRevision");
|
|
if (instant_node && (prop = instant_node->property ("revision"))) {
|
|
revision = atoi (prop->value());
|
|
}
|
|
|
|
return 0;
|
|
}
|
|
|
|
string
|
|
ExportFilename::get_path (ExportFormatSpecPtr format) const
|
|
{
|
|
string path;
|
|
bool filename_empty = true;
|
|
|
|
if (include_session) {
|
|
path += filename_empty ? "" : "_";
|
|
path += session.name();
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_label) {
|
|
path += filename_empty ? "" : "_";
|
|
path += label;
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_revision) {
|
|
path += filename_empty ? "" : "_";
|
|
path += "r";
|
|
path += to_string (revision, std::dec);
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_timespan && timespan) {
|
|
path += filename_empty ? "" : "_";
|
|
path += timespan->name();
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_channel_config && channel_config) {
|
|
path += filename_empty ? "" : "_";
|
|
path += channel_config->name();
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_channel) {
|
|
path += filename_empty ? "" : "_";
|
|
path += "channel";
|
|
path += to_string (channel, std::dec);
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_date) {
|
|
path += filename_empty ? "" : "_";
|
|
path += get_date_format_str (date_format);
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_time) {
|
|
path += filename_empty ? "" : "_";
|
|
path += get_time_format_str (time_format);
|
|
filename_empty = false;
|
|
}
|
|
|
|
if (include_format_name) {
|
|
path += filename_empty ? "" : "_";
|
|
path += format->name();
|
|
filename_empty = false;
|
|
}
|
|
|
|
path += ".";
|
|
path += format->extension ();
|
|
|
|
path = legalize_for_universal_path (path);
|
|
|
|
return Glib::build_filename (folder, path);
|
|
}
|
|
|
|
string
|
|
ExportFilename::get_time_format_str (TimeFormat format) const
|
|
{
|
|
switch ( format ) {
|
|
case T_None:
|
|
return _("No Time");
|
|
|
|
case T_NoDelim:
|
|
return get_formatted_time ("%H%M");
|
|
|
|
case T_Delim:
|
|
return get_formatted_time ("%H.%M");
|
|
|
|
default:
|
|
return _("Invalid time format");
|
|
}
|
|
}
|
|
|
|
string
|
|
ExportFilename::get_date_format_str (DateFormat format) const
|
|
{
|
|
switch (format) {
|
|
case D_None:
|
|
return _("No Date");
|
|
|
|
case D_BE:
|
|
return get_formatted_time ("%Y%m%d");
|
|
|
|
case D_ISO:
|
|
return get_formatted_time ("%Y-%m-%d");
|
|
|
|
case D_BEShortY:
|
|
return get_formatted_time ("%y%m%d");
|
|
|
|
case D_ISOShortY:
|
|
return get_formatted_time ("%y-%m-%d");
|
|
|
|
default:
|
|
return _("Invalid date format");
|
|
}
|
|
}
|
|
|
|
void
|
|
ExportFilename::set_time_format (TimeFormat format)
|
|
{
|
|
time_format = format;
|
|
|
|
if (format == T_None) {
|
|
include_time = false;
|
|
} else {
|
|
include_time = true;
|
|
}
|
|
}
|
|
|
|
void
|
|
ExportFilename::set_date_format (DateFormat format)
|
|
{
|
|
date_format = format;
|
|
|
|
if (format == D_None) {
|
|
include_date = false;
|
|
} else {
|
|
include_date = true;
|
|
}
|
|
}
|
|
|
|
void
|
|
ExportFilename::set_label (string value)
|
|
{
|
|
label = value;
|
|
include_label = !value.compare ("");
|
|
}
|
|
|
|
bool
|
|
ExportFilename::set_folder (string path)
|
|
{
|
|
// TODO check folder existence
|
|
folder = path;
|
|
return true;
|
|
}
|
|
|
|
string
|
|
ExportFilename::get_formatted_time (string const & format) const
|
|
{
|
|
char buffer [80];
|
|
strftime (buffer, 80, format.c_str(), time_struct);
|
|
|
|
string return_value (buffer);
|
|
return return_value;
|
|
}
|
|
|
|
void
|
|
ExportFilename::add_field (XMLNode * node, string const & name, bool enabled, string const & value)
|
|
{
|
|
XMLNode * child = node->add_child ("Field");
|
|
|
|
if (!child) {
|
|
std::cerr << "Error adding a field to ExportFilename XML-tree" << std::endl;
|
|
return;
|
|
}
|
|
|
|
child->add_property ("name", name);
|
|
child->add_property ("enabled", enabled ? "true" : "false");
|
|
if (!value.empty()) {
|
|
child->add_property ("value", value);
|
|
}
|
|
}
|
|
|
|
ExportFilename::FieldPair
|
|
ExportFilename::get_field (XMLNode const & node, string const & name)
|
|
{
|
|
FieldPair pair;
|
|
pair.first = false;
|
|
|
|
XMLNodeList children = node.children();
|
|
|
|
for (XMLNodeList::iterator it = children.begin(); it != children.end(); ++it) {
|
|
XMLProperty * prop = (*it)->property ("name");
|
|
if (prop && !prop->value().compare (name)) {
|
|
|
|
prop = (*it)->property ("enabled");
|
|
if (prop && !prop->value().compare ("true")) {
|
|
pair.first = true;
|
|
} else {
|
|
pair.first = false;
|
|
}
|
|
|
|
prop = (*it)->property ("value");
|
|
if (prop) {
|
|
pair.second = prop->value();
|
|
}
|
|
|
|
return pair;
|
|
}
|
|
}
|
|
|
|
return pair;
|
|
}
|
|
|
|
ExportFilename::FieldPair
|
|
ExportFilename::analyse_folder ()
|
|
{
|
|
FieldPair pair;
|
|
|
|
string session_dir = session.session_directory().root_path();
|
|
string::size_type session_dir_len = session_dir.length();
|
|
|
|
string folder_beginning = folder.substr (0, session_dir_len);
|
|
|
|
if (!folder_beginning.compare (session_dir)) {
|
|
pair.first = true;
|
|
pair.second = folder.substr (session_dir_len);
|
|
} else {
|
|
pair.first = false;
|
|
pair.second = folder;
|
|
}
|
|
|
|
return pair;
|
|
}
|
|
|
|
} // namespace ARDOUR
|