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.
21 #include "ardour/export_format_specification.h"
25 #include "ardour/export_format_compatibility.h"
26 #include "ardour/export_formats.h"
27 #include "ardour/session.h"
29 #include "pbd/error.h"
30 #include "pbd/xml++.h"
31 #include "pbd/enumwriter.h"
32 #include "pbd/convert.h"
42 ExportFormatSpecification::Time &
43 ExportFormatSpecification::Time::operator= (AnyTime const & other)
45 static_cast<AnyTime &>(*this) = other;
50 ExportFormatSpecification::Time::get_frames_at (framepos_t position, framecnt_t target_rate) const
52 framecnt_t duration = session.any_duration_to_frames (position, *this);
53 return ((double) target_rate / session.frame_rate()) * duration + 0.5;
57 ExportFormatSpecification::Time::get_state ()
60 XMLNode * node = new XMLNode ("Duration");
62 node->add_property ("format", enum_2_string (type));
66 node->add_property ("hours", to_string (timecode.hours, std::dec));
67 node->add_property ("minutes", to_string (timecode.minutes, std::dec));
68 node->add_property ("seconds", to_string (timecode.seconds, std::dec));
69 node->add_property ("frames", to_string (timecode.frames, std::dec));
72 node->add_property ("bars", to_string (bbt.bars, std::dec));
73 node->add_property ("beats", to_string (bbt.beats, std::dec));
74 node->add_property ("ticks", to_string (bbt.ticks, std::dec));
77 node->add_property ("frames", to_string (frames, std::dec));
80 node->add_property ("seconds", to_string (seconds, std::dec));
88 ExportFormatSpecification::Time::set_state (const XMLNode & node)
90 XMLProperty const * prop;
92 prop = node.property ("format");
94 if (!prop) { return -1; }
96 type = (Type) string_2_enum (prop->value(), Type);
100 if ((prop = node.property ("hours"))) {
101 timecode.hours = atoi (prop->value());
104 if ((prop = node.property ("minutes"))) {
105 timecode.minutes = atoi (prop->value());
108 if ((prop = node.property ("seconds"))) {
109 timecode.seconds = atoi (prop->value());
112 if ((prop = node.property ("frames"))) {
113 timecode.frames = atoi (prop->value());
119 if ((prop = node.property ("bars"))) {
120 bbt.bars = atoi (prop->value());
123 if ((prop = node.property ("beats"))) {
124 bbt.beats = atoi (prop->value());
127 if ((prop = node.property ("ticks"))) {
128 bbt.ticks = atoi (prop->value());
134 if ((prop = node.property ("frames"))) {
135 std::istringstream iss (prop->value());
142 if ((prop = node.property ("seconds"))) {
143 seconds = atof (prop->value());
152 ExportFormatSpecification::ExportFormatSpecification (Session & s)
155 , has_sample_format (false)
156 , supports_tagging (false)
157 , _has_broadcast_info (false)
159 , _dither_type (D_None)
160 , _src_quality (SRC_SincBest)
163 , _trim_beginning (false)
164 , _silence_beginning (s)
169 , _normalize_target (1.0)
173 format_ids.insert (F_None);
174 endiannesses.insert (E_FileDefault);
175 sample_formats.insert (SF_None);
176 sample_rates.insert (SR_None);
177 qualities.insert (Q_None);
180 ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state)
182 , _silence_beginning (s)
185 _silence_beginning.type = Time::Timecode;
186 _silence_end.type = Time::Timecode;
191 ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other)
192 : ExportFormatBase(other)
193 , session (other.session)
194 , _silence_beginning (other.session)
195 , _silence_end (other.session)
197 set_name (other.name() + " (copy)");
199 _format_name = other._format_name;
200 has_sample_format = other.has_sample_format;
202 supports_tagging = other.supports_tagging;
203 _has_broadcast_info = other._has_broadcast_info;
204 _channel_limit = other._channel_limit;
206 set_type (other.type());
207 set_format_id (other.format_id());
208 set_endianness (other.endianness());
209 set_sample_format (other.sample_format());
210 set_sample_rate (other.sample_rate());
211 set_quality (other.quality());
213 set_dither_type (other.dither_type());
214 set_src_quality (other.src_quality());
215 set_trim_beginning (other.trim_beginning());
216 set_trim_end (other.trim_end());
217 set_normalize (other.normalize());
218 set_normalize_target (other.normalize_target());
220 set_tag (other.tag());
222 set_silence_beginning (other.silence_beginning_time());
223 set_silence_end (other.silence_end_time());
225 set_extension(other.extension());
228 ExportFormatSpecification::~ExportFormatSpecification ()
233 ExportFormatSpecification::get_state ()
236 XMLNode * root = new XMLNode ("ExportFormatSpecification");
238 root->add_property ("name", _name);
239 root->add_property ("id", _id.to_s());
240 root->add_property ("with-cue", _with_cue ? "true" : "false");
241 root->add_property ("with-toc", _with_toc ? "true" : "false");
243 node = root->add_child ("Encoding");
244 node->add_property ("id", enum_2_string (format_id()));
245 node->add_property ("type", enum_2_string (type()));
246 node->add_property ("extension", extension());
247 node->add_property ("name", _format_name);
248 node->add_property ("has-sample-format", has_sample_format ? "true" : "false");
249 node->add_property ("channel-limit", to_string (_channel_limit, std::dec));
251 node = root->add_child ("SampleRate");
252 node->add_property ("rate", to_string (sample_rate(), std::dec));
254 node = root->add_child ("SRCQuality");
255 node->add_property ("quality", enum_2_string (src_quality()));
257 XMLNode * enc_opts = root->add_child ("EncodingOptions");
259 add_option (enc_opts, "sample-format", enum_2_string (sample_format()));
260 add_option (enc_opts, "dithering", enum_2_string (dither_type()));
261 add_option (enc_opts, "tag-metadata", _tag ? "true" : "false");
262 add_option (enc_opts, "tag-support", supports_tagging ? "true" : "false");
263 add_option (enc_opts, "broadcast-info", _has_broadcast_info ? "true" : "false");
265 XMLNode * processing = root->add_child ("Processing");
267 node = processing->add_child ("Normalize");
268 node->add_property ("enabled", normalize() ? "true" : "false");
269 node->add_property ("target", to_string (normalize_target(), std::dec));
271 XMLNode * silence = processing->add_child ("Silence");
272 XMLNode * start = silence->add_child ("Start");
273 XMLNode * end = silence->add_child ("End");
275 node = start->add_child ("Trim");
276 node->add_property ("enabled", trim_beginning() ? "true" : "false");
278 node = start->add_child ("Add");
279 node->add_property ("enabled", _silence_beginning.not_zero() ? "true" : "false");
280 node->add_child_nocopy (_silence_beginning.get_state());
282 node = end->add_child ("Trim");
283 node->add_property ("enabled", trim_end() ? "true" : "false");
285 node = end->add_child ("Add");
286 node->add_property ("enabled", _silence_end.not_zero() ? "true" : "false");
287 node->add_child_nocopy (_silence_end.get_state());
293 ExportFormatSpecification::set_state (const XMLNode & root)
295 XMLProperty const * prop;
296 XMLNode const * child;
299 if ((prop = root.property ("name"))) {
300 _name = prop->value();
303 if ((prop = root.property ("id"))) {
307 if ((prop = root.property ("with-cue"))) {
308 _with_cue = string_is_affirmative (prop->value());
313 if ((prop = root.property ("with-toc"))) {
314 _with_toc = string_is_affirmative (prop->value());
319 /* Encoding and SRC */
321 if ((child = root.child ("Encoding"))) {
322 if ((prop = child->property ("id"))) {
323 set_format_id ((FormatId) string_2_enum (prop->value(), FormatId));
326 if ((prop = child->property ("type"))) {
327 set_type ((Type) string_2_enum (prop->value(), Type));
330 if ((prop = child->property ("extension"))) {
331 set_extension (prop->value());
334 if ((prop = child->property ("name"))) {
335 _format_name = prop->value();
338 if ((prop = child->property ("has-sample-format"))) {
339 has_sample_format = string_is_affirmative (prop->value());
342 if ((prop = child->property ("has-sample-format"))) {
343 has_sample_format = string_is_affirmative (prop->value());
346 if ((prop = child->property ("channel-limit"))) {
347 _channel_limit = atoi (prop->value());
351 if ((child = root.child ("SampleRate"))) {
352 if ((prop = child->property ("rate"))) {
353 set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate));
357 if ((child = root.child ("SRCQuality"))) {
358 if ((prop = child->property ("quality"))) {
359 _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality);
363 /* Encoding options */
365 if ((child = root.child ("EncodingOptions"))) {
366 set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat));
367 set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType));
368 set_tag (!(get_option (child, "tag-metadata").compare ("true")));
369 supports_tagging = (!(get_option (child, "tag-support").compare ("true")));
370 _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true")));
375 XMLNode const * proc = root.child ("Processing");
376 if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; }
378 if ((child = proc->child ("Normalize"))) {
379 if ((prop = child->property ("enabled"))) {
380 _normalize = (!prop->value().compare ("true"));
383 if ((prop = child->property ("target"))) {
384 _normalize_target = atof (prop->value());
388 XMLNode const * silence = proc->child ("Silence");
389 if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; }
391 XMLNode const * start = silence->child ("Start");
392 XMLNode const * end = silence->child ("End");
393 if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; }
397 if ((child = start->child ("Trim"))) {
398 if ((prop = child->property ("enabled"))) {
399 _trim_beginning = (!prop->value().compare ("true"));
403 if ((child = start->child ("Add"))) {
404 if ((prop = child->property ("enabled"))) {
405 if (!prop->value().compare ("true")) {
406 if ((child = child->child ("Duration"))) {
407 _silence_beginning.set_state (*child);
410 _silence_beginning.type = Time::Timecode;
417 if ((child = end->child ("Trim"))) {
418 if ((prop = child->property ("enabled"))) {
419 _trim_end = (!prop->value().compare ("true"));
423 if ((child = end->child ("Add"))) {
424 if ((prop = child->property ("enabled"))) {
425 if (!prop->value().compare ("true")) {
426 if ((child = child->child ("Duration"))) {
427 _silence_end.set_state (*child);
430 _silence_end.type = Time::Timecode;
439 ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const
441 boost::shared_ptr<ExportFormatBase> intersection = get_intersection (compatibility);
443 if (intersection->formats_empty() && format_id() != 0) {
447 if (intersection->endiannesses_empty() && endianness() != E_FileDefault) {
451 if (intersection->sample_rates_empty() && sample_rate() != SR_None) {
455 if (intersection->sample_formats_empty() && sample_format() != SF_None) {
459 if (intersection->qualities_empty() && quality() != Q_None) {
467 ExportFormatSpecification::is_complete () const
469 if (type() == T_None) {
477 if (!sample_rate()) {
481 if (has_sample_format) {
482 if (sample_format() == SF_None) {
491 ExportFormatSpecification::set_format (boost::shared_ptr<ExportFormat> format)
494 set_format_id (format->get_format_id ());
495 set_type (format->get_type());
496 set_extension (format->extension());
498 if (format->get_explicit_sample_format()) {
499 set_sample_format (format->get_explicit_sample_format());
502 if (format->has_sample_format()) {
503 has_sample_format = true;
506 if (format->has_broadcast_info()) {
507 _has_broadcast_info = true;
510 supports_tagging = format->supports_tagging ();
511 _channel_limit = format->get_channel_limit();
513 _format_name = format->name();
515 set_format_id (F_None);
518 _has_broadcast_info = false;
519 has_sample_format = false;
520 supports_tagging = false;
527 ExportFormatSpecification::description ()
534 desc += _("normalize, ");
537 if (_trim_beginning && _trim_end) {
539 } else if (_trim_beginning) {
540 desc += _("trim start, ");
541 } else if (_trim_end) {
542 desc += _("trim end, ");
545 desc += _format_name + ", ";
547 if (has_sample_format) {
548 desc += HasSampleFormat::get_sample_format_name (sample_format()) + ", ";
551 switch (sample_rate()) {
571 desc += _("Session rate");
589 ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value)
591 node = node->add_child ("Option");
592 node->add_property ("name", name);
593 node->add_property ("value", value);
597 ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name)
599 XMLNodeList list (node->children ("Option"));
601 for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) {
602 XMLProperty * prop = (*it)->property ("name");
603 if (prop && !name.compare (prop->value())) {
604 prop = (*it)->property ("value");
606 return prop->value();
611 std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl;
616 }; // namespace ARDOUR