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)
50 frames = other.frames;
52 seconds = other.seconds;
59 ExportFormatSpecification::Time::get_frames (nframes_t target_rate) const
62 nframes_t duration = session.convert_to_frames_at (0, *this);
64 return ((double) target_rate / session.frame_rate()) * duration + 0.5;
68 ExportFormatSpecification::Time::get_state ()
71 XMLNode * node = new XMLNode ("Duration");
73 node->add_property ("format", enum_2_string (type));
77 node->add_property ("hours", to_string (smpte.hours, std::dec));
78 node->add_property ("minutes", to_string (smpte.minutes, std::dec));
79 node->add_property ("seconds", to_string (smpte.seconds, std::dec));
80 node->add_property ("frames", to_string (smpte.frames, std::dec));
83 node->add_property ("bars", to_string (bbt.bars, std::dec));
84 node->add_property ("beats", to_string (bbt.beats, std::dec));
85 node->add_property ("ticks", to_string (bbt.ticks, std::dec));
88 node->add_property ("frames", to_string (frames, std::dec));
91 node->add_property ("seconds", to_string (seconds, std::dec));
99 ExportFormatSpecification::Time::set_state (const XMLNode & node)
101 XMLProperty const * prop;
103 prop = node.property ("format");
105 if (!prop) { return -1; }
107 type = (Type) string_2_enum (prop->value(), Type);
111 if ((prop = node.property ("hours"))) {
112 smpte.hours = atoi (prop->value());
115 if ((prop = node.property ("minutes"))) {
116 smpte.minutes = atoi (prop->value());
119 if ((prop = node.property ("seconds"))) {
120 smpte.seconds = atoi (prop->value());
123 if ((prop = node.property ("frames"))) {
124 smpte.frames = atoi (prop->value());
130 if ((prop = node.property ("bars"))) {
131 bbt.bars = atoi (prop->value());
134 if ((prop = node.property ("beats"))) {
135 bbt.beats = atoi (prop->value());
138 if ((prop = node.property ("ticks"))) {
139 bbt.ticks = atoi (prop->value());
145 if ((prop = node.property ("frames"))) {
146 std::istringstream iss (prop->value());
153 if ((prop = node.property ("seconds"))) {
154 seconds = atof (prop->value());
163 ExportFormatSpecification::ExportFormatSpecification (Session & s) :
166 has_sample_format (false),
167 supports_tagging (false),
168 _has_broadcast_info (false),
170 _dither_type (D_None),
171 _src_quality (SRC_SincBest),
174 _trim_beginning (false),
175 _silence_beginning (s),
180 _normalize_target (1.0)
182 format_ids.insert (F_None);
183 endiannesses.insert (E_FileDefault);
184 sample_formats.insert (SF_None);
185 sample_rates.insert (SR_None);
186 qualities.insert (Q_None);
189 ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state) :
191 _silence_beginning (s),
194 _silence_beginning.type = Time::SMPTE;
195 _silence_end.type = Time::SMPTE;
200 ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other) :
201 session (other.session),
202 _silence_beginning (other.session),
203 _silence_end (other.session)
205 set_name (other.name() + " (copy)");
207 _format_name = other._format_name;
208 has_sample_format = other.has_sample_format;
210 supports_tagging = other.supports_tagging;
211 _has_broadcast_info = other._has_broadcast_info;
212 _channel_limit = other._channel_limit;
214 set_type (other.type());
215 set_format_id (other.format_id());
216 set_endianness (other.endianness());
217 set_sample_format (other.sample_format());
218 set_sample_rate (other.sample_rate());
219 set_quality (other.quality());
221 set_dither_type (other.dither_type());
222 set_src_quality (other.src_quality());
223 set_trim_beginning (other.trim_beginning());
224 set_trim_end (other.trim_end());
225 set_normalize (other.normalize());
226 set_normalize_target (other.normalize_target());
228 set_tag (other.tag());
230 set_silence_beginning (other.silence_beginning_time());
231 set_silence_end (other.silence_end_time());
234 ExportFormatSpecification::~ExportFormatSpecification ()
239 ExportFormatSpecification::get_state ()
242 XMLNode * root = new XMLNode ("ExportFormatSpecification");
244 root->add_property ("name", _name);
245 root->add_property ("id", _id.to_s());
247 node = root->add_child ("Encoding");
248 node->add_property ("id", enum_2_string (format_id()));
249 node->add_property ("type", enum_2_string (type()));
250 node->add_property ("extension", extension());
251 node->add_property ("name", _format_name);
252 node->add_property ("has-sample-format", has_sample_format ? "true" : "false");
253 node->add_property ("channel-limit", to_string (_channel_limit, std::dec));
255 node = root->add_child ("SampleRate");
256 node->add_property ("rate", to_string (sample_rate(), std::dec));
258 node = root->add_child ("SRCQuality");
259 node->add_property ("quality", enum_2_string (src_quality()));
261 XMLNode * enc_opts = root->add_child ("EncodingOptions");
263 add_option (enc_opts, "sample-format", enum_2_string (sample_format()));
264 add_option (enc_opts, "dithering", enum_2_string (dither_type()));
265 add_option (enc_opts, "tag-metadata", _tag ? "true" : "false");
266 add_option (enc_opts, "tag-support", supports_tagging ? "true" : "false");
267 add_option (enc_opts, "broadcast-info", _has_broadcast_info ? "true" : "false");
269 XMLNode * processing = root->add_child ("Processing");
271 node = processing->add_child ("Normalize");
272 node->add_property ("enabled", normalize() ? "true" : "false");
273 node->add_property ("target", to_string (normalize_target(), std::dec));
275 XMLNode * silence = processing->add_child ("Silence");
276 XMLNode * start = silence->add_child ("Start");
277 XMLNode * end = silence->add_child ("End");
279 node = start->add_child ("Trim");
280 node->add_property ("enabled", trim_beginning() ? "true" : "false");
282 node = start->add_child ("Add");
283 node->add_property ("enabled", silence_beginning() > 0 ? "true" : "false");
284 node->add_child_nocopy (_silence_beginning.get_state());
286 node = end->add_child ("Trim");
287 node->add_property ("enabled", trim_end() ? "true" : "false");
289 node = end->add_child ("Add");
290 node->add_property ("enabled", silence_end() > 0 ? "true" : "false");
291 node->add_child_nocopy (_silence_end.get_state());
297 ExportFormatSpecification::set_state (const XMLNode & root)
299 XMLProperty const * prop;
300 XMLNode const * child;
303 if ((prop = root.property ("name"))) {
304 _name = prop->value();
307 if ((prop = root.property ("id"))) {
311 /* Encoding and SRC */
313 if ((child = root.child ("Encoding"))) {
314 if ((prop = child->property ("id"))) {
315 set_format_id ((FormatId) string_2_enum (prop->value(), FormatId));
318 if ((prop = child->property ("type"))) {
319 set_type ((Type) string_2_enum (prop->value(), Type));
322 if ((prop = child->property ("extension"))) {
323 set_extension (prop->value());
326 if ((prop = child->property ("name"))) {
327 _format_name = prop->value();
330 if ((prop = child->property ("has-sample-format"))) {
331 has_sample_format = !prop->value().compare ("true");
334 if ((prop = child->property ("channel-limit"))) {
335 _channel_limit = atoi (prop->value());
339 if ((child = root.child ("SampleRate"))) {
340 if ((prop = child->property ("rate"))) {
341 set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate));
345 if ((child = root.child ("SRCQuality"))) {
346 if ((prop = child->property ("quality"))) {
347 _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality);
351 /* Encoding options */
353 if ((child = root.child ("EncodingOptions"))) {
354 set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat));
355 set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType));
356 set_tag (!(get_option (child, "tag-metadata").compare ("true")));
357 supports_tagging = (!(get_option (child, "tag-support").compare ("true")));
358 _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true")));
363 XMLNode const * proc = root.child ("Processing");
364 if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; }
366 if ((child = proc->child ("Normalize"))) {
367 if ((prop = child->property ("enabled"))) {
368 _normalize = (!prop->value().compare ("true"));
371 if ((prop = child->property ("target"))) {
372 _normalize_target = atof (prop->value());
376 XMLNode const * silence = proc->child ("Silence");
377 if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; }
379 XMLNode const * start = silence->child ("Start");
380 XMLNode const * end = silence->child ("End");
381 if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; }
385 if ((child = start->child ("Trim"))) {
386 if ((prop = child->property ("enabled"))) {
387 _trim_beginning = (!prop->value().compare ("true"));
391 if ((child = start->child ("Add"))) {
392 if ((prop = child->property ("enabled"))) {
393 if (!prop->value().compare ("true")) {
394 if ((child = child->child ("Duration"))) {
395 _silence_beginning.set_state (*child);
398 _silence_beginning.type = Time::SMPTE;
405 if ((child = end->child ("Trim"))) {
406 if ((prop = child->property ("enabled"))) {
407 _trim_end = (!prop->value().compare ("true"));
411 if ((child = end->child ("Add"))) {
412 if ((prop = child->property ("enabled"))) {
413 if (!prop->value().compare ("true")) {
414 if ((child = child->child ("Duration"))) {
415 _silence_end.set_state (*child);
418 _silence_end.type = Time::SMPTE;
427 ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const
429 boost::shared_ptr<ExportFormatBase> intersection = get_intersection (compatibility);
431 if (intersection->formats_empty() && format_id() != 0) {
435 if (intersection->endiannesses_empty() && endianness() != E_FileDefault) {
439 if (intersection->sample_rates_empty() && sample_rate() != SR_None) {
443 if (intersection->sample_formats_empty() && sample_format() != SF_None) {
447 if (intersection->qualities_empty() && quality() != Q_None) {
455 ExportFormatSpecification::is_complete () const
457 if (type() == T_None) {
465 if (!sample_rate()) {
469 if (has_sample_format) {
470 if (sample_format() == SF_None) {
479 ExportFormatSpecification::set_format (boost::shared_ptr<ExportFormat> format)
482 set_format_id (format->get_format_id ());
483 set_type (format->get_type());
484 set_extension (format->extension());
486 if (format->get_explicit_sample_format()) {
487 set_sample_format (format->get_explicit_sample_format());
490 if (format->has_sample_format()) {
491 has_sample_format = true;
494 if (format->has_broadcast_info()) {
495 _has_broadcast_info = true;
498 supports_tagging = format->supports_tagging ();
499 _channel_limit = format->get_channel_limit();
501 _format_name = format->name();
503 set_format_id (F_None);
506 _has_broadcast_info = false;
507 has_sample_format = false;
508 supports_tagging = false;
515 ExportFormatSpecification::description ()
522 desc += _("normalize, ");
525 if (_trim_beginning && _trim_end) {
527 } else if (_trim_beginning) {
528 desc += _("trim start, ");
529 } else if (_trim_end) {
530 desc += "trim end, ";
533 desc += _format_name + ", ";
535 if (has_sample_format) {
536 desc += HasSampleFormat::get_sample_format_name (sample_format()) + ", ";
539 switch (sample_rate()) {
566 ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value)
568 node = node->add_child ("Option");
569 node->add_property ("name", name);
570 node->add_property ("value", value);
574 ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name)
576 XMLNodeList list (node->children ("Option"));
578 for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) {
579 XMLProperty * prop = (*it)->property ("name");
580 if (prop && !name.compare (prop->value())) {
581 prop = (*it)->property ("value");
583 return prop->value();
588 std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl;
593 }; // namespace ARDOUR