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