libs/ardour/export_format_specification.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 "ardour/export_format_specification.h"
  22
  23 #include <sstream>
  24
  25 #include "ardour/export_format_compatibility.h"
  26 #include "ardour/export_formats.h"
  27 #include "ardour/session.h"
  28
  29 #include "pbd/error.h"
  30 #include "pbd/xml++.h"
  31 #include "pbd/enumwriter.h"
  32 #include "pbd/convert.h"
  33
  34 #include "i18n.h"
  35
  36 namespace ARDOUR
  37 {
  38
  39 using namespace PBD;
  40 using std::string;
  41 using std::list;
  42
  43 ExportFormatSpecification::Time &
  44 ExportFormatSpecification::Time::operator= (AnyTime const & other)
  45 {
  46         static_cast<AnyTime &>(*this) = other;
  47         return *this;
  48 }
  49
  50 framecnt_t
  51 ExportFormatSpecification::Time::get_frames_at (framepos_t position, framecnt_t target_rate) const
  52 {
  53         framecnt_t duration = session.any_duration_to_frames (position, *this);
  54         return ((double) target_rate / session.frame_rate()) * duration + 0.5;
  55 }
  56
  57 XMLNode &
  58 ExportFormatSpecification::Time::get_state ()
  59 {
  60
  61         XMLNode * node = new XMLNode ("Duration");
  62
  63         node->add_property ("format", enum_2_string (type));
  64
  65         switch (type) {
  66           case Timecode:
  67                 node->add_property ("hours", to_string (timecode.hours, std::dec));
  68                 node->add_property ("minutes", to_string (timecode.minutes, std::dec));
  69                 node->add_property ("seconds", to_string (timecode.seconds, std::dec));
  70                 node->add_property ("frames", to_string (timecode.frames, std::dec));
  71                 break;
  72           case BBT:
  73                 node->add_property ("bars", to_string (bbt.bars, std::dec));
  74                 node->add_property ("beats", to_string (bbt.beats, std::dec));
  75                 node->add_property ("ticks", to_string (bbt.ticks, std::dec));
  76                 break;
  77           case Frames:
  78                 node->add_property ("frames", to_string (frames, std::dec));
  79                 break;
  80           case Seconds:
  81                 node->add_property ("seconds", to_string (seconds, std::dec));
  82                 break;
  83         }
  84
  85         return *node;
  86 }
  87
  88 int
  89 ExportFormatSpecification::Time::set_state (const XMLNode & node)
  90 {
  91         XMLProperty const * prop;
  92
  93         prop = node.property ("format");
  94
  95         if (!prop) { return -1; }
  96
  97         type = (Type) string_2_enum (prop->value(), Type);
  98
  99         switch (type) {
 100           case Timecode:
 101                 if ((prop = node.property ("hours"))) {
 102                         timecode.hours = atoi (prop->value());
 103                 }
 104
 105                 if ((prop = node.property ("minutes"))) {
 106                         timecode.minutes = atoi (prop->value());
 107                 }
 108
 109                 if ((prop = node.property ("seconds"))) {
 110                         timecode.seconds = atoi (prop->value());
 111                 }
 112
 113                 if ((prop = node.property ("frames"))) {
 114                         timecode.frames = atoi (prop->value());
 115                 }
 116
 117                 break;
 118
 119           case BBT:
 120                 if ((prop = node.property ("bars"))) {
 121                         bbt.bars = atoi (prop->value());
 122                 }
 123
 124                 if ((prop = node.property ("beats"))) {
 125                         bbt.beats = atoi (prop->value());
 126                 }
 127
 128                 if ((prop = node.property ("ticks"))) {
 129                         bbt.ticks = atoi (prop->value());
 130                 }
 131
 132                 break;
 133
 134           case Frames:
 135                 if ((prop = node.property ("frames"))) {
 136                         std::istringstream iss (prop->value());
 137                         iss >> frames;
 138                 }
 139
 140                 break;
 141
 142           case Seconds:
 143                 if ((prop = node.property ("seconds"))) {
 144                         seconds = atof (prop->value());
 145                 }
 146
 147                 break;
 148         }
 149
 150         return 0;
 151 }
 152
 153 ExportFormatSpecification::ExportFormatSpecification (Session & s)
 154         : session (s)
 155
 156         , has_sample_format (false)
 157         , supports_tagging (false)
 158         , _has_broadcast_info (false)
 159         , _channel_limit (0)
 160         , _dither_type (D_None)
 161         , _src_quality (SRC_SincBest)
 162         , _tag (true)
 163
 164         , _trim_beginning (false)
 165         , _silence_beginning (s)
 166         , _trim_end (false)
 167         , _silence_end (s)
 168
 169         , _normalize (false)
 170         , _normalize_target (1.0)
 171         , _with_toc (false)
 172         , _with_cue (false)
 173         , _command ("")
 174 {
 175         format_ids.insert (F_None);
 176         endiannesses.insert (E_FileDefault);
 177         sample_formats.insert (SF_None);
 178         sample_rates.insert (SR_None);
 179         qualities.insert (Q_None);
 180 }
 181
 182 ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state)
 183         : session (s)
 184         , _silence_beginning (s)
 185         , _silence_end (s)
 186 {
 187         _silence_beginning.type = Time::Timecode;
 188         _silence_end.type = Time::Timecode;
 189
 190         set_state (state);
 191 }
 192
 193 ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other, bool modify_name)
 194         : ExportFormatBase(other)
 195         , session (other.session)
 196         , _silence_beginning (other.session)
 197         , _silence_end (other.session)
 198 {
 199         if (modify_name) {
 200                 set_name (other.name() + " (copy)");
 201         } else {
 202                 set_name (other.name());
 203         }
 204
 205         _format_name = other._format_name;
 206         has_sample_format = other.has_sample_format;
 207
 208         supports_tagging = other.supports_tagging;
 209         _has_broadcast_info = other._has_broadcast_info;
 210         _channel_limit = other._channel_limit;
 211
 212         set_type (other.type());
 213         set_format_id (other.format_id());
 214         set_endianness (other.endianness());
 215         set_sample_format (other.sample_format());
 216         set_sample_rate (other.sample_rate());
 217         set_quality (other.quality());
 218
 219         set_dither_type (other.dither_type());
 220         set_src_quality (other.src_quality());
 221         set_trim_beginning (other.trim_beginning());
 222         set_trim_end (other.trim_end());
 223         set_normalize (other.normalize());
 224         set_normalize_target (other.normalize_target());
 225
 226         set_tag (other.tag());
 227
 228         set_silence_beginning (other.silence_beginning_time());
 229         set_silence_end (other.silence_end_time());
 230
 231         set_extension(other.extension());
 232 }
 233
 234 ExportFormatSpecification::~ExportFormatSpecification ()
 235 {
 236 }
 237
 238 XMLNode &
 239 ExportFormatSpecification::get_state ()
 240 {
 241         XMLNode * node;
 242         XMLNode * root = new XMLNode ("ExportFormatSpecification");
 243
 244         root->add_property ("name", _name);
 245         root->add_property ("id", _id.to_s());
 246         root->add_property ("with-cue", _with_cue ? "true" : "false");
 247         root->add_property ("with-toc", _with_toc ? "true" : "false");
 248         root->add_property ("command", _command);
 249
 250         node = root->add_child ("Encoding");
 251         node->add_property ("id", enum_2_string (format_id()));
 252         node->add_property ("type", enum_2_string (type()));
 253         node->add_property ("extension", extension());
 254         node->add_property ("name", _format_name);
 255         node->add_property ("has-sample-format", has_sample_format ? "true" : "false");
 256         node->add_property ("channel-limit", to_string (_channel_limit, std::dec));
 257
 258         node = root->add_child ("SampleRate");
 259         node->add_property ("rate", to_string (sample_rate(), std::dec));
 260
 261         node = root->add_child ("SRCQuality");
 262         node->add_property ("quality", enum_2_string (src_quality()));
 263
 264         XMLNode * enc_opts = root->add_child ("EncodingOptions");
 265
 266         add_option (enc_opts, "sample-format", enum_2_string (sample_format()));
 267         add_option (enc_opts, "dithering", enum_2_string (dither_type()));
 268         add_option (enc_opts, "tag-metadata", _tag ? "true" : "false");
 269         add_option (enc_opts, "tag-support", supports_tagging ? "true" : "false");
 270         add_option (enc_opts, "broadcast-info", _has_broadcast_info ? "true" : "false");
 271
 272         XMLNode * processing = root->add_child ("Processing");
 273
 274         node = processing->add_child ("Normalize");
 275         node->add_property ("enabled", normalize() ? "true" : "false");
 276         node->add_property ("target", to_string (normalize_target(), std::dec));
 277
 278         XMLNode * silence = processing->add_child ("Silence");
 279         XMLNode * start = silence->add_child ("Start");
 280         XMLNode * end = silence->add_child ("End");
 281
 282         node = start->add_child ("Trim");
 283         node->add_property ("enabled", trim_beginning() ? "true" : "false");
 284
 285         node = start->add_child ("Add");
 286         node->add_property ("enabled", _silence_beginning.not_zero() ? "true" : "false");
 287         node->add_child_nocopy (_silence_beginning.get_state());
 288
 289         node = end->add_child ("Trim");
 290         node->add_property ("enabled", trim_end() ? "true" : "false");
 291
 292         node = end->add_child ("Add");
 293         node->add_property ("enabled", _silence_end.not_zero() ? "true" : "false");
 294         node->add_child_nocopy (_silence_end.get_state());
 295
 296         return *root;
 297 }
 298
 299 int
 300 ExportFormatSpecification::set_state (const XMLNode & root)
 301 {
 302         XMLProperty const * prop;
 303         XMLNode const * child;
 304         string value;
 305
 306         if ((prop = root.property ("name"))) {
 307                 _name = prop->value();
 308         }
 309
 310         if ((prop = root.property ("id"))) {
 311                 _id = prop->value();
 312         }
 313
 314         if ((prop = root.property ("with-cue"))) {
 315                 _with_cue = string_is_affirmative (prop->value());
 316         } else {
 317                 _with_cue = false;
 318         }
 319
 320         if ((prop = root.property ("with-toc"))) {
 321                 _with_toc = string_is_affirmative (prop->value());
 322         } else {
 323                 _with_toc = false;
 324         }
 325
 326
 327         if ((prop = root.property ("command"))) {
 328                 _command = prop->value();
 329         } else {
 330                 _command = "";
 331         }
 332
 333         /* Encoding and SRC */
 334
 335         if ((child = root.child ("Encoding"))) {
 336                 if ((prop = child->property ("id"))) {
 337                         set_format_id ((FormatId) string_2_enum (prop->value(), FormatId));
 338                 }
 339
 340                 if ((prop = child->property ("type"))) {
 341                         set_type ((Type) string_2_enum (prop->value(), Type));
 342                 }
 343
 344                 if ((prop = child->property ("extension"))) {
 345                         set_extension (prop->value());
 346                 }
 347
 348                 if ((prop = child->property ("name"))) {
 349                         _format_name = prop->value();
 350                 }
 351
 352                 if ((prop = child->property ("has-sample-format"))) {
 353                         has_sample_format = string_is_affirmative (prop->value());
 354                 }
 355
 356                 if ((prop = child->property ("has-sample-format"))) {
 357                         has_sample_format = string_is_affirmative (prop->value());
 358                 }
 359
 360                 if ((prop = child->property ("channel-limit"))) {
 361                         _channel_limit = atoi (prop->value());
 362                 }
 363         }
 364
 365         if ((child = root.child ("SampleRate"))) {
 366                 if ((prop = child->property ("rate"))) {
 367                         set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate));
 368                 }
 369         }
 370
 371         if ((child = root.child ("SRCQuality"))) {
 372                 if ((prop = child->property ("quality"))) {
 373                         _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality);
 374                 }
 375         }
 376
 377         /* Encoding options */
 378
 379         if ((child = root.child ("EncodingOptions"))) {
 380                 set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat));
 381                 set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType));
 382                 set_tag (!(get_option (child, "tag-metadata").compare ("true")));
 383                 supports_tagging = (!(get_option (child, "tag-support").compare ("true")));
 384                 _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true")));
 385         }
 386
 387         /* Processing */
 388
 389         XMLNode const * proc = root.child ("Processing");
 390         if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; }
 391
 392         if ((child = proc->child ("Normalize"))) {
 393                 if ((prop = child->property ("enabled"))) {
 394                         _normalize = (!prop->value().compare ("true"));
 395                 }
 396
 397                 if ((prop = child->property ("target"))) {
 398                         _normalize_target = atof (prop->value());
 399                 }
 400         }
 401
 402         XMLNode const * silence = proc->child ("Silence");
 403         if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; }
 404
 405         XMLNode const * start = silence->child ("Start");
 406         XMLNode const * end = silence->child ("End");
 407         if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; }
 408
 409         /* Silence start */
 410
 411         if ((child = start->child ("Trim"))) {
 412                 if ((prop = child->property ("enabled"))) {
 413                         _trim_beginning = (!prop->value().compare ("true"));
 414                 }
 415         }
 416
 417         if ((child = start->child ("Add"))) {
 418                 if ((prop = child->property ("enabled"))) {
 419                         if (!prop->value().compare ("true")) {
 420                                 if ((child = child->child ("Duration"))) {
 421                                         _silence_beginning.set_state (*child);
 422                                 }
 423                         } else {
 424                                 _silence_beginning.type = Time::Timecode;
 425                         }
 426                 }
 427         }
 428
 429         /* Silence end */
 430
 431         if ((child = end->child ("Trim"))) {
 432                 if ((prop = child->property ("enabled"))) {
 433                         _trim_end = (!prop->value().compare ("true"));
 434                 }
 435         }
 436
 437         if ((child = end->child ("Add"))) {
 438                 if ((prop = child->property ("enabled"))) {
 439                         if (!prop->value().compare ("true")) {
 440                                 if ((child = child->child ("Duration"))) {
 441                                         _silence_end.set_state (*child);
 442                                 }
 443                         } else {
 444                                 _silence_end.type = Time::Timecode;
 445                         }
 446                 }
 447         }
 448
 449         return 0;
 450 }
 451
 452 bool
 453 ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const
 454 {
 455         boost::shared_ptr<ExportFormatBase> intersection = get_intersection (compatibility);
 456
 457         if (intersection->formats_empty() && format_id() != 0) {
 458                 return false;
 459         }
 460
 461         if (intersection->endiannesses_empty() && endianness() != E_FileDefault) {
 462                 return false;
 463         }
 464
 465         if (intersection->sample_rates_empty() && sample_rate() != SR_None) {
 466                 return false;
 467         }
 468
 469         if (intersection->sample_formats_empty() && sample_format() != SF_None) {
 470                 return false;
 471         }
 472
 473         if (intersection->qualities_empty() && quality() != Q_None) {
 474                 return false;
 475         }
 476
 477         return true;
 478 }
 479
 480 bool
 481 ExportFormatSpecification::is_complete () const
 482 {
 483         if (type() == T_None) {
 484                 return false;
 485         }
 486
 487         if (!format_id()) {
 488                 return false;
 489         }
 490
 491         if (!sample_rate()) {
 492                 return false;
 493         }
 494
 495         if (has_sample_format) {
 496                 if (sample_format() == SF_None) {
 497                         return false;
 498                 }
 499         }
 500
 501         return true;
 502 }
 503
 504 void
 505 ExportFormatSpecification::set_format (boost::shared_ptr<ExportFormat> format)
 506 {
 507         if (format) {
 508                 set_format_id (format->get_format_id ());
 509                 set_type (format->get_type());
 510                 set_extension (format->extension());
 511
 512                 if (format->get_explicit_sample_format()) {
 513                         set_sample_format (format->get_explicit_sample_format());
 514                 }
 515
 516                 if (format->has_sample_format()) {
 517                         has_sample_format = true;
 518                 }
 519
 520                 if (format->has_broadcast_info()) {
 521                         _has_broadcast_info = true;
 522                 }
 523
 524                 supports_tagging = format->supports_tagging ();
 525                 _channel_limit = format->get_channel_limit();
 526
 527                 _format_name = format->name();
 528         } else {
 529                 set_format_id (F_None);
 530                 set_type (T_None);
 531                 set_extension ("");
 532                 _has_broadcast_info = false;
 533                 has_sample_format = false;
 534                 supports_tagging = false;
 535                 _channel_limit = 0;
 536                 _format_name = "";
 537         }
 538 }
 539
 540 string
 541 ExportFormatSpecification::description (bool include_name)
 542 {
 543         list<string> components;
 544
 545         if (_normalize) {
 546                 components.push_back (_("normalize"));
 547         }
 548
 549         if (_trim_beginning && _trim_end) {
 550                 components.push_back ( _("trim"));
 551         } else if (_trim_beginning) {
 552                 components.push_back (_("trim start"));
 553         } else if (_trim_end) {
 554                 components.push_back (_("trim end"));
 555         }
 556
 557         if (_format_name != "") {
 558                 components.push_back (_format_name);
 559         }
 560
 561         if (has_sample_format) {
 562                 components.push_back (HasSampleFormat::get_sample_format_name (sample_format()));
 563         }
 564
 565         switch (sample_rate()) {
 566         case SR_8:
 567                 components.push_back ("8 kHz");
 568                 break;
 569         case SR_22_05:
 570                 components.push_back ("22,5 kHz");
 571                 break;
 572         case SR_44_1:
 573                 components.push_back ("44,1 kHz");
 574                 break;
 575         case SR_48:
 576                 components.push_back ("48 kHz");
 577                 break;
 578         case SR_88_2:
 579                 components.push_back ("88,2 kHz");
 580                 break;
 581         case SR_96:
 582                 components.push_back ("96 kHz");
 583                 break;
 584         case SR_192:
 585                 components.push_back ("192 kHz");
 586                 break;
 587         case SR_Session:
 588                 components.push_back (_("Session rate"));
 589                 break;
 590         case SR_None:
 591                 break;
 592         }
 593
 594         if (_with_toc) {
 595                 components.push_back ("TOC");
 596         }
 597
 598         if (_with_cue) {
 599                 components.push_back ("CUE");
 600         }
 601
 602         if (!_command.empty()) {
 603                 components.push_back ("+");
 604         }
 605
 606         string desc;
 607         if (include_name) {
 608                 desc = _name + ": ";
 609         }
 610
 611         for (list<string>::const_iterator it = components.begin(); it != components.end(); ++it) {
 612                 if (it != components.begin()) { desc += ", "; }
 613                 desc += *it;
 614         }
 615         return desc;
 616 }
 617
 618 void
 619 ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value)
 620 {
 621         node = node->add_child ("Option");
 622         node->add_property ("name", name);
 623         node->add_property ("value", value);
 624 }
 625
 626 std::string
 627 ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name)
 628 {
 629         XMLNodeList list (node->children ("Option"));
 630
 631         for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) {
 632                 XMLProperty * prop = (*it)->property ("name");
 633                 if (prop && !name.compare (prop->value())) {
 634                         prop = (*it)->property ("value");
 635                         if (prop) {
 636                                 return prop->value();
 637                         }
 638                 }
 639         }
 640
 641         std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl;
 642
 643         return "";
 644 }
 645
 646 }; // namespace ARDOUR