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 "pbd/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_loudness (false)
 171         , _normalize_dbfs (GAIN_COEFF_UNITY)
 172         , _normalize_lufs (-23)
 173         , _normalize_dbtp (-1)
 174         , _with_toc (false)
 175         , _with_cue (false)
 176         , _with_mp4chaps (false)
 177         , _soundcloud_upload (false)
 178         , _command ("")
 179         , _analyse (true)
 180 {
 181         format_ids.insert (F_None);
 182         endiannesses.insert (E_FileDefault);
 183         sample_formats.insert (SF_None);
 184         sample_rates.insert (SR_None);
 185         qualities.insert (Q_None);
 186 }
 187
 188 ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state)
 189         : session (s)
 190
 191         , has_sample_format (false)
 192         , supports_tagging (false)
 193         , _has_broadcast_info (false)
 194         , _channel_limit (0)
 195         , _dither_type (D_None)
 196         , _src_quality (SRC_SincBest)
 197         , _tag (true)
 198
 199         , _trim_beginning (false)
 200         , _silence_beginning (s)
 201         , _trim_end (false)
 202         , _silence_end (s)
 203
 204         , _normalize (false)
 205         , _normalize_loudness (false)
 206         , _normalize_dbfs (GAIN_COEFF_UNITY)
 207         , _normalize_lufs (-23)
 208         , _normalize_dbtp (-1)
 209         , _with_toc (false)
 210         , _with_cue (false)
 211         , _with_mp4chaps (false)
 212         , _soundcloud_upload (false)
 213         , _command ("")
 214         , _analyse (true)
 215 {
 216         _silence_beginning.type = Time::Timecode;
 217         _silence_end.type = Time::Timecode;
 218
 219         set_state (state);
 220 }
 221
 222 ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other, bool modify_name)
 223         : ExportFormatBase(other)
 224         , session (other.session)
 225         , _silence_beginning (other.session)
 226         , _silence_end (other.session)
 227         , _soundcloud_upload (false)
 228         , _analyse (other._analyse)
 229 {
 230         if (modify_name) {
 231                 set_name (other.name() + " (copy)");
 232         } else {
 233                 set_name (other.name());
 234         }
 235
 236         _format_name = other._format_name;
 237         has_sample_format = other.has_sample_format;
 238
 239         supports_tagging = other.supports_tagging;
 240         _has_broadcast_info = other._has_broadcast_info;
 241         _channel_limit = other._channel_limit;
 242
 243         set_type (other.type());
 244         set_format_id (other.format_id());
 245         set_endianness (other.endianness());
 246         set_sample_format (other.sample_format());
 247         set_sample_rate (other.sample_rate());
 248         set_quality (other.quality());
 249
 250         set_dither_type (other.dither_type());
 251         set_src_quality (other.src_quality());
 252         set_trim_beginning (other.trim_beginning());
 253         set_trim_end (other.trim_end());
 254         set_normalize (other.normalize());
 255         set_normalize_loudness (other.normalize_loudness());
 256         set_normalize_dbfs (other.normalize_dbfs());
 257         set_normalize_lufs (other.normalize_lufs());
 258         set_normalize_dbtp (other.normalize_dbtp());
 259
 260         set_tag (other.tag());
 261
 262         set_silence_beginning (other.silence_beginning_time());
 263         set_silence_end (other.silence_end_time());
 264
 265         set_extension(other.extension());
 266 }
 267
 268 ExportFormatSpecification::~ExportFormatSpecification ()
 269 {
 270 }
 271
 272 XMLNode &
 273 ExportFormatSpecification::get_state ()
 274 {
 275         LocaleGuard lg;
 276         XMLNode * node;
 277         XMLNode * root = new XMLNode ("ExportFormatSpecification");
 278
 279         root->add_property ("name", _name);
 280         root->add_property ("id", _id.to_s());
 281         root->add_property ("with-cue", _with_cue ? "true" : "false");
 282         root->add_property ("with-toc", _with_toc ? "true" : "false");
 283         root->add_property ("with-mp4chaps", _with_mp4chaps ? "true" : "false");
 284         root->add_property ("command", _command);
 285
 286         node = root->add_child ("Encoding");
 287         node->add_property ("id", enum_2_string (format_id()));
 288         node->add_property ("type", enum_2_string (type()));
 289         node->add_property ("extension", extension());
 290         node->add_property ("name", _format_name);
 291         node->add_property ("has-sample-format", has_sample_format ? "true" : "false");
 292         node->add_property ("channel-limit", to_string (_channel_limit, std::dec));
 293
 294         node = root->add_child ("SampleRate");
 295         node->add_property ("rate", to_string (sample_rate(), std::dec));
 296
 297         node = root->add_child ("SRCQuality");
 298         node->add_property ("quality", enum_2_string (src_quality()));
 299
 300         XMLNode * enc_opts = root->add_child ("EncodingOptions");
 301
 302         add_option (enc_opts, "sample-format", enum_2_string (sample_format()));
 303         add_option (enc_opts, "dithering", enum_2_string (dither_type()));
 304         add_option (enc_opts, "tag-metadata", _tag ? "true" : "false");
 305         add_option (enc_opts, "tag-support", supports_tagging ? "true" : "false");
 306         add_option (enc_opts, "broadcast-info", _has_broadcast_info ? "true" : "false");
 307
 308         XMLNode * processing = root->add_child ("Processing");
 309
 310         node = processing->add_child ("Normalize");
 311         node->add_property ("enabled", normalize() ? "true" : "false");
 312         node->add_property ("loudness", normalize_loudness() ? "yes" : "no");
 313         node->add_property ("dbfs", to_string (normalize_dbfs(), std::dec));
 314         node->add_property ("lufs", to_string (normalize_lufs(), std::dec));
 315         node->add_property ("dbtp", to_string (normalize_dbtp(), std::dec));
 316
 317         XMLNode * silence = processing->add_child ("Silence");
 318         XMLNode * start = silence->add_child ("Start");
 319         XMLNode * end = silence->add_child ("End");
 320
 321         node = start->add_child ("Trim");
 322         node->add_property ("enabled", trim_beginning() ? "true" : "false");
 323
 324         node = start->add_child ("Add");
 325         node->add_property ("enabled", _silence_beginning.not_zero() ? "true" : "false");
 326         node->add_child_nocopy (_silence_beginning.get_state());
 327
 328         node = end->add_child ("Trim");
 329         node->add_property ("enabled", trim_end() ? "true" : "false");
 330
 331         node = end->add_child ("Add");
 332         node->add_property ("enabled", _silence_end.not_zero() ? "true" : "false");
 333         node->add_child_nocopy (_silence_end.get_state());
 334
 335         return *root;
 336 }
 337
 338 int
 339 ExportFormatSpecification::set_state (const XMLNode & root)
 340 {
 341         XMLProperty const * prop;
 342         XMLNode const * child;
 343         string value;
 344         LocaleGuard lg;
 345
 346         if ((prop = root.property ("name"))) {
 347                 _name = prop->value();
 348         }
 349
 350         if ((prop = root.property ("id"))) {
 351                 _id = prop->value();
 352         }
 353
 354         if ((prop = root.property ("with-cue"))) {
 355                 _with_cue = string_is_affirmative (prop->value());
 356         } else {
 357                 _with_cue = false;
 358         }
 359
 360         if ((prop = root.property ("with-toc"))) {
 361                 _with_toc = string_is_affirmative (prop->value());
 362         } else {
 363                 _with_toc = false;
 364         }
 365
 366         if ((prop = root.property ("with-mp4chaps"))) {
 367                 _with_mp4chaps = string_is_affirmative (prop->value());
 368         } else {
 369                 _with_mp4chaps = false;
 370         }
 371
 372         if ((prop = root.property ("command"))) {
 373                 _command = prop->value();
 374         } else {
 375                 _command = "";
 376         }
 377
 378         /* Encoding and SRC */
 379
 380         if ((child = root.child ("Encoding"))) {
 381                 if ((prop = child->property ("id"))) {
 382                         set_format_id ((FormatId) string_2_enum (prop->value(), FormatId));
 383                 }
 384
 385                 if ((prop = child->property ("type"))) {
 386                         set_type ((Type) string_2_enum (prop->value(), Type));
 387                 }
 388
 389                 if ((prop = child->property ("extension"))) {
 390                         set_extension (prop->value());
 391                 }
 392
 393                 if ((prop = child->property ("name"))) {
 394                         _format_name = prop->value();
 395                 }
 396
 397                 if ((prop = child->property ("has-sample-format"))) {
 398                         has_sample_format = string_is_affirmative (prop->value());
 399                 }
 400
 401                 if ((prop = child->property ("has-sample-format"))) {
 402                         has_sample_format = string_is_affirmative (prop->value());
 403                 }
 404
 405                 if ((prop = child->property ("channel-limit"))) {
 406                         _channel_limit = atoi (prop->value());
 407                 }
 408         }
 409
 410         if ((child = root.child ("SampleRate"))) {
 411                 if ((prop = child->property ("rate"))) {
 412                         set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate));
 413                 }
 414         }
 415
 416         if ((child = root.child ("SRCQuality"))) {
 417                 if ((prop = child->property ("quality"))) {
 418                         _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality);
 419                 }
 420         }
 421
 422         /* Encoding options */
 423
 424         if ((child = root.child ("EncodingOptions"))) {
 425                 set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat));
 426                 set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType));
 427                 set_tag (!(get_option (child, "tag-metadata").compare ("true")));
 428                 supports_tagging = (!(get_option (child, "tag-support").compare ("true")));
 429                 _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true")));
 430         }
 431
 432         /* Processing */
 433
 434         XMLNode const * proc = root.child ("Processing");
 435         if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; }
 436
 437         if ((child = proc->child ("Normalize"))) {
 438                 if ((prop = child->property ("enabled"))) {
 439                         _normalize = (!prop->value().compare ("true"));
 440                 }
 441
 442                 // old formats before ~ 4.7-930ish
 443                 if ((prop = child->property ("target"))) {
 444                         _normalize_dbfs = atof (prop->value());
 445                 }
 446
 447                 if ((prop = child->property ("loudness"))) {
 448                         _normalize_loudness = string_is_affirmative (prop->value());
 449                 }
 450
 451                 if ((prop = child->property ("dbfs"))) {
 452                         _normalize_dbfs = atof (prop->value());
 453                 }
 454
 455                 if ((prop = child->property ("lufs"))) {
 456                         _normalize_lufs = atof (prop->value());
 457                 }
 458
 459                 if ((prop = child->property ("dbtp"))) {
 460                         _normalize_dbtp = atof (prop->value());
 461                 }
 462         }
 463
 464         XMLNode const * silence = proc->child ("Silence");
 465         if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; }
 466
 467         XMLNode const * start = silence->child ("Start");
 468         XMLNode const * end = silence->child ("End");
 469         if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; }
 470
 471         /* Silence start */
 472
 473         if ((child = start->child ("Trim"))) {
 474                 if ((prop = child->property ("enabled"))) {
 475                         _trim_beginning = (!prop->value().compare ("true"));
 476                 }
 477         }
 478
 479         if ((child = start->child ("Add"))) {
 480                 if ((prop = child->property ("enabled"))) {
 481                         if (!prop->value().compare ("true")) {
 482                                 if ((child = child->child ("Duration"))) {
 483                                         _silence_beginning.set_state (*child);
 484                                 }
 485                         } else {
 486                                 _silence_beginning.type = Time::Timecode;
 487                         }
 488                 }
 489         }
 490
 491         /* Silence end */
 492
 493         if ((child = end->child ("Trim"))) {
 494                 if ((prop = child->property ("enabled"))) {
 495                         _trim_end = (!prop->value().compare ("true"));
 496                 }
 497         }
 498
 499         if ((child = end->child ("Add"))) {
 500                 if ((prop = child->property ("enabled"))) {
 501                         if (!prop->value().compare ("true")) {
 502                                 if ((child = child->child ("Duration"))) {
 503                                         _silence_end.set_state (*child);
 504                                 }
 505                         } else {
 506                                 _silence_end.type = Time::Timecode;
 507                         }
 508                 }
 509         }
 510
 511         return 0;
 512 }
 513
 514 bool
 515 ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const
 516 {
 517         boost::shared_ptr<ExportFormatBase> intersection = get_intersection (compatibility);
 518
 519         if (intersection->formats_empty() && format_id() != 0) {
 520                 return false;
 521         }
 522
 523         if (intersection->endiannesses_empty() && endianness() != E_FileDefault) {
 524                 return false;
 525         }
 526
 527         if (intersection->sample_rates_empty() && sample_rate() != SR_None) {
 528                 return false;
 529         }
 530
 531         if (intersection->sample_formats_empty() && sample_format() != SF_None) {
 532                 return false;
 533         }
 534
 535         if (intersection->qualities_empty() && quality() != Q_None) {
 536                 return false;
 537         }
 538
 539         return true;
 540 }
 541
 542 bool
 543 ExportFormatSpecification::is_complete () const
 544 {
 545         if (type() == T_None) {
 546                 return false;
 547         }
 548
 549         if (!format_id()) {
 550                 return false;
 551         }
 552
 553         if (!sample_rate()) {
 554                 return false;
 555         }
 556
 557         if (has_sample_format) {
 558                 if (sample_format() == SF_None) {
 559                         return false;
 560                 }
 561         }
 562
 563         return true;
 564 }
 565
 566 void
 567 ExportFormatSpecification::set_format (boost::shared_ptr<ExportFormat> format)
 568 {
 569         if (format) {
 570                 set_format_id (format->get_format_id ());
 571                 set_type (format->get_type());
 572                 set_extension (format->extension());
 573
 574                 if (format->get_explicit_sample_format()) {
 575                         set_sample_format (format->get_explicit_sample_format());
 576                 }
 577
 578                 if (format->has_sample_format()) {
 579                         has_sample_format = true;
 580                 }
 581
 582                 if (format->has_broadcast_info()) {
 583                         _has_broadcast_info = true;
 584                 }
 585
 586                 supports_tagging = format->supports_tagging ();
 587                 _channel_limit = format->get_channel_limit();
 588
 589                 _format_name = format->name();
 590         } else {
 591                 set_format_id (F_None);
 592                 set_type (T_None);
 593                 set_extension ("");
 594                 _has_broadcast_info = false;
 595                 has_sample_format = false;
 596                 supports_tagging = false;
 597                 _channel_limit = 0;
 598                 _format_name = "";
 599         }
 600 }
 601
 602 string
 603 ExportFormatSpecification::description (bool include_name)
 604 {
 605         list<string> components;
 606
 607         if (_normalize) {
 608                 if (_normalize_loudness) {
 609                         components.push_back (_("normalize loudness"));
 610                 } else {
 611                         components.push_back (_("normalize peak"));
 612                 }
 613         }
 614
 615         if (_trim_beginning && _trim_end) {
 616                 components.push_back ( _("trim"));
 617         } else if (_trim_beginning) {
 618                 components.push_back (_("trim start"));
 619         } else if (_trim_end) {
 620                 components.push_back (_("trim end"));
 621         }
 622
 623         if (_format_name != "") {
 624                 components.push_back (_format_name);
 625         }
 626
 627         if (has_sample_format) {
 628                 components.push_back (HasSampleFormat::get_sample_format_name (sample_format()));
 629         }
 630
 631         switch (sample_rate()) {
 632         case SR_8:
 633                 components.push_back ("8 kHz");
 634                 break;
 635         case SR_22_05:
 636                 components.push_back ("22,5 kHz");
 637                 break;
 638         case SR_44_1:
 639                 components.push_back ("44,1 kHz");
 640                 break;
 641         case SR_48:
 642                 components.push_back ("48 kHz");
 643                 break;
 644         case SR_88_2:
 645                 components.push_back ("88,2 kHz");
 646                 break;
 647         case SR_96:
 648                 components.push_back ("96 kHz");
 649                 break;
 650         case SR_176_4:
 651                 components.push_back ("176.4 kHz");
 652                 break;
 653         case SR_192:
 654                 components.push_back ("192 kHz");
 655                 break;
 656         case SR_Session:
 657                 components.push_back (_("Session rate"));
 658                 break;
 659         case SR_None:
 660                 break;
 661         }
 662
 663         if (_with_toc) {
 664                 components.push_back ("TOC");
 665         }
 666
 667         if (_with_cue) {
 668                 components.push_back ("CUE");
 669         }
 670
 671         if (_with_mp4chaps) {
 672                 components.push_back ("MP4ch");
 673         }
 674
 675         if (!_command.empty()) {
 676                 components.push_back ("+");
 677         }
 678
 679         string desc;
 680         if (include_name) {
 681                 desc = _name + ": ";
 682         }
 683
 684         for (list<string>::const_iterator it = components.begin(); it != components.end(); ++it) {
 685                 if (it != components.begin()) { desc += ", "; }
 686                 desc += *it;
 687         }
 688         return desc;
 689 }
 690
 691 void
 692 ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value)
 693 {
 694         node = node->add_child ("Option");
 695         node->add_property ("name", name);
 696         node->add_property ("value", value);
 697 }
 698
 699 std::string
 700 ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name)
 701 {
 702         XMLNodeList list (node->children ("Option"));
 703
 704         for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) {
 705                 XMLProperty const * prop = (*it)->property ("name");
 706                 if (prop && !name.compare (prop->value())) {
 707                         prop = (*it)->property ("value");
 708                         if (prop) {
 709                                 return prop->value();
 710                         }
 711                 }
 712         }
 713
 714         std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl;
 715
 716         return "";
 717 }
 718
 719 }; // namespace ARDOUR