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