X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=libs%2Fardour%2Fexport_format_specification.cc;h=a41c2a085affd5721241b509f3724596c27192f8;hb=a5e8a69dec467cc7d938cc3d92acb218b04486a9;hp=61d9bef523e4199a35ef3b7e24a218ecb027058d;hpb=f2b007195cd75b195e38a4cd7757debac73e7792;p=ardour.git diff --git a/libs/ardour/export_format_specification.cc b/libs/ardour/export_format_specification.cc index 61d9bef523..a41c2a085a 100644 --- a/libs/ardour/export_format_specification.cc +++ b/libs/ardour/export_format_specification.cc @@ -18,203 +18,203 @@ */ -#include - -#include - -#include -#include -#include - -#include -#include -#include -#include - -#include "i18n.h" +#include "ardour/export_format_specification.h" + +#include "ardour/export_format_compatibility.h" +#include "ardour/export_formats.h" +#include "ardour/session.h" +#include "ardour/types_convert.h" + +#include "pbd/error.h" +#include "pbd/xml++.h" +#include "pbd/enumwriter.h" +#include "pbd/enum_convert.h" +#include "pbd/string_convert.h" +#include "pbd/types_convert.h" + +#include "pbd/i18n.h" + +namespace PBD { + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::FormatId) + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::SampleRate) + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::SampleFormat) + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::DitherType) + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::SRCQuality) + DEFINE_ENUM_CONVERT (ARDOUR::ExportFormatBase::Type) +} namespace ARDOUR { using namespace PBD; using std::string; - -/* The id counter is initialized to 1000 so that user created profiles have a id > 1000 - * while ones shipped with ardour have one < 1000 - */ -uint32_t ExportFormatSpecification::_counter = 1000; +using std::list; ExportFormatSpecification::Time & ExportFormatSpecification::Time::operator= (AnyTime const & other) { - type = other.type; - smpte = other.smpte; - bbt = other.bbt; - - if (type == Frames) { - frames = other.frames; - } else { - seconds = other.seconds; - } - + static_cast(*this) = other; return *this; } -nframes_t -ExportFormatSpecification::Time::get_frames (nframes_t target_rate) const -{ - //TODO position - nframes_t duration = session.convert_to_frames_at (0, *this); - - return ((double) target_rate / session.frame_rate()) * duration + 0.5; +samplecnt_t +ExportFormatSpecification::Time::get_samples_at (samplepos_t position, samplecnt_t target_rate) const +{ + samplecnt_t duration = session.any_duration_to_samples (position, *this); + return ((double) target_rate / session.sample_rate()) * duration + 0.5; } XMLNode & ExportFormatSpecification::Time::get_state () { - + XMLNode * node = new XMLNode ("Duration"); - node->add_property ("format", enum_2_string (type)); + node->set_property ("format", type); switch (type) { - case SMPTE: - node->add_property ("hours", to_string (smpte.hours, std::dec)); - node->add_property ("minutes", to_string (smpte.minutes, std::dec)); - node->add_property ("seconds", to_string (smpte.seconds, std::dec)); - node->add_property ("frames", to_string (smpte.frames, std::dec)); + case Timecode: + node->set_property ("hours", timecode.hours); + node->set_property ("minutes", timecode.minutes); + node->set_property ("seconds", timecode.seconds); + node->set_property ("frames", timecode.frames); break; case BBT: - node->add_property ("bars", to_string (bbt.bars, std::dec)); - node->add_property ("beats", to_string (bbt.beats, std::dec)); - node->add_property ("ticks", to_string (bbt.ticks, std::dec)); + node->set_property ("bars", bbt.bars); + node->set_property ("beats", bbt.beats); + node->set_property ("ticks", bbt.ticks); break; - case Frames: - node->add_property ("frames", to_string (frames, std::dec)); + case Samples: + node->set_property ("samples", samples); break; case Seconds: - node->add_property ("seconds", to_string (seconds, std::dec)); + node->set_property ("seconds", seconds); break; } - + return *node; } int ExportFormatSpecification::Time::set_state (const XMLNode & node) { - XMLProperty const * prop; - - prop = node.property ("format"); - - if (!prop) { return -1; } - - type = (Type) string_2_enum (prop->value(), Type); - + if (!node.get_property ("format", type)) { + return -1; + } + switch (type) { - case SMPTE: - if ((prop = node.property ("hours"))) { - smpte.hours = atoi (prop->value()); - } - - if ((prop = node.property ("minutes"))) { - smpte.minutes = atoi (prop->value()); - } - - if ((prop = node.property ("seconds"))) { - smpte.seconds = atoi (prop->value()); - } - - if ((prop = node.property ("frames"))) { - smpte.frames = atoi (prop->value()); - } - + case Timecode: + node.get_property ("hours", timecode.hours); + node.get_property ("minutes", timecode.minutes); + node.get_property ("seconds", timecode.seconds); + node.get_property ("frames", timecode.frames); break; - - case BBT: - if ((prop = node.property ("bars"))) { - bbt.bars = atoi (prop->value()); - } - - if ((prop = node.property ("beats"))) { - bbt.beats = atoi (prop->value()); - } - - if ((prop = node.property ("ticks"))) { - bbt.ticks = atoi (prop->value()); - } - + + case BBT: + node.get_property ("bars", bbt.bars); + node.get_property ("beats", bbt.beats); + node.get_property ("ticks", bbt.ticks); break; - - case Frames: - if ((prop = node.property ("frames"))) { - std::istringstream iss (prop->value()); - iss >> frames; - } - + + case Samples: + node.get_property ("samples", samples); break; - - case Seconds: - if ((prop = node.property ("seconds"))) { - seconds = atof (prop->value()); - } - + + case Seconds: + node.get_property ("seconds", seconds); break; + } return 0; } -ExportFormatSpecification::ExportFormatSpecification (Session & s) : - session (s), - - has_sample_format (false), - supports_tagging (false), - _has_broadcast_info (false), - _channel_limit (0), - _dither_type (D_None), - _src_quality (SRC_SincBest), - _tag (true), - - _trim_beginning (false), - _silence_beginning (s), - _trim_end (false), - _silence_end (s), - - _normalize (false), - _normalize_target (1.0) +ExportFormatSpecification::ExportFormatSpecification (Session & s) + : session (s) + + , has_sample_format (false) + , supports_tagging (false) + , _has_broadcast_info (false) + , _channel_limit (0) + , _dither_type (D_None) + , _src_quality (SRC_SincBest) + , _tag (true) + + , _trim_beginning (false) + , _silence_beginning (s) + , _trim_end (false) + , _silence_end (s) + + , _normalize (false) + , _normalize_loudness (false) + , _normalize_dbfs (GAIN_COEFF_UNITY) + , _normalize_lufs (-23) + , _normalize_dbtp (-1) + , _with_toc (false) + , _with_cue (false) + , _with_mp4chaps (false) + , _soundcloud_upload (false) + , _command ("") + , _analyse (true) { format_ids.insert (F_None); endiannesses.insert (E_FileDefault); sample_formats.insert (SF_None); sample_rates.insert (SR_None); qualities.insert (Q_None); - - _id = ++_counter; } -ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state) : - session (s), - _silence_beginning (s), - _silence_end (s) +ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state) + : session (s) + + , has_sample_format (false) + , supports_tagging (false) + , _has_broadcast_info (false) + , _channel_limit (0) + , _dither_type (D_None) + , _src_quality (SRC_SincBest) + , _tag (true) + + , _trim_beginning (false) + , _silence_beginning (s) + , _trim_end (false) + , _silence_end (s) + + , _normalize (false) + , _normalize_loudness (false) + , _normalize_dbfs (GAIN_COEFF_UNITY) + , _normalize_lufs (-23) + , _normalize_dbtp (-1) + , _with_toc (false) + , _with_cue (false) + , _with_mp4chaps (false) + , _soundcloud_upload (false) + , _command ("") + , _analyse (true) { - _silence_beginning.type = Time::SMPTE; - _silence_end.type = Time::SMPTE; + _silence_beginning.type = Time::Timecode; + _silence_end.type = Time::Timecode; set_state (state); } -ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other) : - session (other.session), - _silence_beginning (other.session), - _silence_end (other.session) +ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other, bool modify_name) + : ExportFormatBase(other) + , session (other.session) + , _silence_beginning (other.session) + , _silence_end (other.session) + , _soundcloud_upload (false) + , _analyse (other._analyse) { - set_name (other.name() + " (copy)"); - _id = ++_counter; + if (modify_name) { + set_name (other.name() + " (copy)"); + } else { + set_name (other.name()); + } _format_name = other._format_name; has_sample_format = other.has_sample_format; - + supports_tagging = other.supports_tagging; _has_broadcast_info = other._has_broadcast_info; _channel_limit = other._channel_limit; @@ -225,18 +225,23 @@ ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification set_sample_format (other.sample_format()); set_sample_rate (other.sample_rate()); set_quality (other.quality()); - + set_dither_type (other.dither_type()); set_src_quality (other.src_quality()); set_trim_beginning (other.trim_beginning()); set_trim_end (other.trim_end()); set_normalize (other.normalize()); - set_normalize_target (other.normalize_target()); - + set_normalize_loudness (other.normalize_loudness()); + set_normalize_dbfs (other.normalize_dbfs()); + set_normalize_lufs (other.normalize_lufs()); + set_normalize_dbtp (other.normalize_dbtp()); + set_tag (other.tag()); - + set_silence_beginning (other.silence_beginning_time()); set_silence_end (other.silence_end_time()); + + set_extension(other.extension()); } ExportFormatSpecification::~ExportFormatSpecification () @@ -248,187 +253,202 @@ ExportFormatSpecification::get_state () { XMLNode * node; XMLNode * root = new XMLNode ("ExportFormatSpecification"); - - root->add_property ("name", _name); - root->add_property ("id", to_string (_id, std::dec)); - + + root->set_property ("name", _name); + root->set_property ("id", _id.to_s()); + root->set_property ("with-cue", _with_cue); + root->set_property ("with-toc", _with_toc); + root->set_property ("with-mp4chaps", _with_mp4chaps); + root->set_property ("command", _command); + root->set_property ("analyse", _analyse); + root->set_property ("soundcloud-upload", _soundcloud_upload); + node = root->add_child ("Encoding"); - node->add_property ("id", enum_2_string (format_id())); - node->add_property ("type", enum_2_string (type())); - node->add_property ("extension", extension()); - node->add_property ("name", _format_name); - node->add_property ("has-sample-format", has_sample_format ? "true" : "false"); - node->add_property ("channel-limit", to_string (_channel_limit, std::dec)); - + node->set_property ("id", format_id()); + node->set_property ("type", type()); + node->set_property ("extension", extension()); + node->set_property ("name", _format_name); + node->set_property ("has-sample-format", has_sample_format); + node->set_property ("channel-limit", _channel_limit); + node = root->add_child ("SampleRate"); - node->add_property ("rate", to_string (sample_rate(), std::dec)); - + node->set_property ("rate", sample_rate()); + node = root->add_child ("SRCQuality"); - node->add_property ("quality", enum_2_string (src_quality())); - + node->set_property ("quality", src_quality()); + XMLNode * enc_opts = root->add_child ("EncodingOptions"); - - add_option (enc_opts, "sample-format", enum_2_string (sample_format())); - add_option (enc_opts, "dithering", enum_2_string (dither_type())); - add_option (enc_opts, "tag-metadata", _tag ? "true" : "false"); - add_option (enc_opts, "tag-support", supports_tagging ? "true" : "false"); - add_option (enc_opts, "broadcast-info", _has_broadcast_info ? "true" : "false"); - + + add_option (enc_opts, "sample-format", to_string(sample_format())); + add_option (enc_opts, "dithering", to_string (dither_type())); + add_option (enc_opts, "tag-metadata", to_string (_tag)); + add_option (enc_opts, "tag-support", to_string (supports_tagging)); + add_option (enc_opts, "broadcast-info", to_string (_has_broadcast_info)); + XMLNode * processing = root->add_child ("Processing"); - + node = processing->add_child ("Normalize"); - node->add_property ("enabled", normalize() ? "true" : "false"); - node->add_property ("target", to_string (normalize_target(), std::dec)); - + node->set_property ("enabled", normalize()); + node->set_property ("loudness", normalize_loudness()); + node->set_property ("dbfs", normalize_dbfs()); + node->set_property ("lufs", normalize_lufs()); + node->set_property ("dbtp", normalize_dbtp()); + XMLNode * silence = processing->add_child ("Silence"); XMLNode * start = silence->add_child ("Start"); XMLNode * end = silence->add_child ("End"); - + node = start->add_child ("Trim"); - node->add_property ("enabled", trim_beginning() ? "true" : "false"); - + node->set_property ("enabled", trim_beginning()); + node = start->add_child ("Add"); - node->add_property ("enabled", silence_beginning() > 0 ? "true" : "false"); + node->set_property ("enabled", _silence_beginning.not_zero()); node->add_child_nocopy (_silence_beginning.get_state()); - + node = end->add_child ("Trim"); - node->add_property ("enabled", trim_end() ? "true" : "false"); - + node->set_property ("enabled", trim_end()); + node = end->add_child ("Add"); - node->add_property ("enabled", silence_end() > 0 ? "true" : "false"); + node->set_property ("enabled", _silence_end.not_zero()); node->add_child_nocopy (_silence_end.get_state()); - + return *root; } int ExportFormatSpecification::set_state (const XMLNode & root) { - XMLProperty const * prop; XMLNode const * child; - string value; - - if ((prop = root.property ("name"))) { - _name = prop->value(); + string str; + + root.get_property ("name", _name); + + if (root.get_property ("id", str)) { + _id = str; + } + + if (!root.get_property ("with-cue", _with_cue)) { + _with_cue = false; + } + + if (!root.get_property ("with-toc", _with_toc)) { + _with_toc = false; + } + + if (!root.get_property ("with-mp4chaps", _with_mp4chaps)) { + _with_mp4chaps = false; + } + + if (!root.get_property ("command", _command)) { + _command = ""; + } + + if (!root.get_property ("analyse", _analyse)) { + _analyse = false; } - - if ((prop = root.property ("id"))) { - std::istringstream iss (prop->value()); - iss >> _id; + + if (!root.get_property ("soundcloud-upload", _soundcloud_upload)) { + _soundcloud_upload = false; } - + /* Encoding and SRC */ - + if ((child = root.child ("Encoding"))) { - if ((prop = child->property ("id"))) { - set_format_id ((FormatId) string_2_enum (prop->value(), FormatId)); + FormatId fid; + if (child->get_property ("id", fid)) { + set_format_id (fid); } - - if ((prop = child->property ("type"))) { - set_type ((Type) string_2_enum (prop->value(), Type)); - } - - if ((prop = child->property ("extension"))) { - set_extension (prop->value()); - } - - if ((prop = child->property ("name"))) { - _format_name = prop->value(); - } - - if ((prop = child->property ("has-sample-format"))) { - has_sample_format = !prop->value().compare ("true"); + + ExportFormatBase::Type type; + if (child->get_property ("type", type)) { + set_type (type); } - - if ((prop = child->property ("channel-limit"))) { - _channel_limit = atoi (prop->value()); + + if (child->get_property ("extension", str)) { + set_extension (str); } + + child->get_property ("name", _format_name); + child->get_property ("has-sample-format", has_sample_format); + child->get_property ("channel-limit", _channel_limit); } - + if ((child = root.child ("SampleRate"))) { - if ((prop = child->property ("rate"))) { - set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate)); + SampleRate rate; + if (child->get_property ("rate", rate)) { + set_sample_rate (rate); } } - + if ((child = root.child ("SRCQuality"))) { - if ((prop = child->property ("quality"))) { - _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality); - } + child->get_property ("quality", _src_quality); } - + /* Encoding options */ - + if ((child = root.child ("EncodingOptions"))) { set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat)); set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType)); - set_tag (!(get_option (child, "tag-metadata").compare ("true"))); - supports_tagging = (!(get_option (child, "tag-support").compare ("true"))); - _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true"))); + set_tag (string_to(get_option (child, "tag-metadata"))); + supports_tagging = string_to(get_option (child, "tag-support")); + _has_broadcast_info = string_to(get_option (child, "broadcast-info")); } - + /* Processing */ - + XMLNode const * proc = root.child ("Processing"); if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; } - + if ((child = proc->child ("Normalize"))) { - if ((prop = child->property ("enabled"))) { - _normalize = (!prop->value().compare ("true")); - } - - if ((prop = child->property ("target"))) { - _normalize_target = atof (prop->value()); - } + child->get_property ("enabled", _normalize); + // old formats before ~ 4.7-930ish + child->get_property ("target", _normalize_dbfs); + child->get_property ("loudness", _normalize_loudness); + child->get_property ("dbfs", _normalize_dbfs); + child->get_property ("lufs", _normalize_lufs); + child->get_property ("dbtp", _normalize_dbtp); } - + XMLNode const * silence = proc->child ("Silence"); if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; } - + XMLNode const * start = silence->child ("Start"); XMLNode const * end = silence->child ("End"); if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; } - + /* Silence start */ - + if ((child = start->child ("Trim"))) { - if ((prop = child->property ("enabled"))) { - _trim_beginning = (!prop->value().compare ("true")); - } + child->get_property ("enabled", _trim_beginning); } - + + bool enabled; if ((child = start->child ("Add"))) { - if ((prop = child->property ("enabled"))) { - if (!prop->value().compare ("true")) { - if ((child = child->child ("Duration"))) { - _silence_beginning.set_state (*child); - } - } else { - _silence_beginning.type = Time::SMPTE; + if (child->get_property ("enabled", enabled) && enabled) { + if ((child = child->child ("Duration"))) { + _silence_beginning.set_state (*child); } + } else { + _silence_beginning.type = Time::Timecode; } } - + /* Silence end */ - + if ((child = end->child ("Trim"))) { - if ((prop = child->property ("enabled"))) { - _trim_end = (!prop->value().compare ("true")); - } + child->get_property ("enabled", _trim_end); } - + if ((child = end->child ("Add"))) { - if ((prop = child->property ("enabled"))) { - if (!prop->value().compare ("true")) { - if ((child = child->child ("Duration"))) { - _silence_end.set_state (*child); - } - } else { - _silence_end.type = Time::SMPTE; + if (child->get_property ("enabled", enabled) && enabled) { + if ((child = child->child ("Duration"))) { + _silence_end.set_state (*child); } + } else { + _silence_end.type = Time::Timecode; } } - + return 0; } @@ -436,27 +456,27 @@ bool ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const { boost::shared_ptr intersection = get_intersection (compatibility); - + if (intersection->formats_empty() && format_id() != 0) { return false; } - + if (intersection->endiannesses_empty() && endianness() != E_FileDefault) { return false; } - + if (intersection->sample_rates_empty() && sample_rate() != SR_None) { return false; } - + if (intersection->sample_formats_empty() && sample_format() != SF_None) { return false; } - + if (intersection->qualities_empty() && quality() != Q_None) { return false; } - + return true; } @@ -466,15 +486,15 @@ ExportFormatSpecification::is_complete () const if (type() == T_None) { return false; } - + if (!format_id()) { return false; } - + if (!sample_rate()) { return false; } - + if (has_sample_format) { if (sample_format() == SF_None) { return false; @@ -491,22 +511,22 @@ ExportFormatSpecification::set_format (boost::shared_ptr format) set_format_id (format->get_format_id ()); set_type (format->get_type()); set_extension (format->extension()); - + if (format->get_explicit_sample_format()) { set_sample_format (format->get_explicit_sample_format()); } - + if (format->has_sample_format()) { has_sample_format = true; } - + if (format->has_broadcast_info()) { _has_broadcast_info = true; } - + supports_tagging = format->supports_tagging (); _channel_limit = format->get_channel_limit(); - + _format_name = format->name(); } else { set_format_id (F_None); @@ -520,54 +540,92 @@ ExportFormatSpecification::set_format (boost::shared_ptr format) } } -Glib::ustring -ExportFormatSpecification::description () +string +ExportFormatSpecification::description (bool include_name) { - Glib::ustring desc; - - desc = _name + ": "; - + list components; + if (_normalize) { - desc += _("normalize, "); + if (_normalize_loudness) { + components.push_back (_("normalize loudness")); + } else { + components.push_back (_("normalize peak")); + } } - + if (_trim_beginning && _trim_end) { - desc += _("trim, "); + components.push_back ( _("trim")); } else if (_trim_beginning) { - desc += _("trim start, "); + components.push_back (_("trim start")); } else if (_trim_end) { - desc += "trim end, "; + components.push_back (_("trim end")); + } + + if (_format_name != "") { + components.push_back (_format_name); } - - desc += _format_name + ", "; - + if (has_sample_format) { - desc += HasSampleFormat::get_sample_format_name (sample_format()) + ", "; + components.push_back (HasSampleFormat::get_sample_format_name (sample_format())); } - + switch (sample_rate()) { - case SR_22_05: - desc += "22,5 kHz"; + case SR_8: + components.push_back ("8 kHz"); + break; + case SR_22_05: + components.push_back ("22,5 kHz"); + break; + case SR_44_1: + components.push_back ("44,1 kHz"); break; - case SR_44_1: - desc += "44,1 kHz"; + case SR_48: + components.push_back ("48 kHz"); break; - case SR_48: - desc += "48 kHz"; + case SR_88_2: + components.push_back ("88,2 kHz"); break; - case SR_88_2: - desc += "88,2 kHz"; + case SR_96: + components.push_back ("96 kHz"); break; - case SR_96: - desc += "96 kHz"; + case SR_176_4: + components.push_back ("176.4 kHz"); break; - case SR_192: - desc += "192 kHz"; + case SR_192: + components.push_back ("192 kHz"); break; - case SR_None: + case SR_Session: + components.push_back (_("Session rate")); break; + case SR_None: + break; + } + + if (_with_toc) { + components.push_back ("TOC"); + } + + if (_with_cue) { + components.push_back ("CUE"); + } + + if (_with_mp4chaps) { + components.push_back ("MP4ch"); + } + + if (!_command.empty()) { + components.push_back ("+"); + } + + string desc; + if (include_name) { + desc = _name + ": "; + } + + for (list::const_iterator it = components.begin(); it != components.end(); ++it) { + if (it != components.begin()) { desc += ", "; } + desc += *it; } - return desc; } @@ -575,27 +633,26 @@ void ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value) { node = node->add_child ("Option"); - node->add_property ("name", name); - node->add_property ("value", value); + node->set_property ("name", name); + node->set_property ("value", value); } std::string ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name) { XMLNodeList list (node->children ("Option")); - + for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) { - XMLProperty * prop = (*it)->property ("name"); - if (prop && !name.compare (prop->value())) { - prop = (*it)->property ("value"); - if (prop) { - return prop->value(); + std::string str; + if ((*it)->get_property ("name", str) && name == str) { + if ((*it)->get_property ("value", str)) { + return str; } } } - + std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl; - + return ""; }