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