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
  42 ExportFormatSpecification::Time &
  43 ExportFormatSpecification::Time::operator= (AnyTime const & other)
  44 {
  45         type = other.type;
  46         timecode = other.timecode;
  47         bbt = other.bbt;
  48
  49         if (type == Frames) {
  50                 frames = other.frames;
  51         } else {
  52                 seconds = other.seconds;
  53         }
  54
  55         return *this;
  56 }
  57
  58 nframes_t
  59 ExportFormatSpecification::Time::get_frames (nframes_t target_rate) const
  60 {
  61         //TODO position
  62         nframes_t duration = session.convert_to_frames_at (0, *this);
  63
  64         return ((double) target_rate / session.frame_rate()) * duration + 0.5;
  65 }
  66
  67 XMLNode &
  68 ExportFormatSpecification::Time::get_state ()
  69 {
  70
  71         XMLNode * node = new XMLNode ("Duration");
  72
  73         node->add_property ("format", enum_2_string (type));
  74
  75         switch (type) {
  76           case Timecode:
  77                 node->add_property ("hours", to_string (timecode.hours, std::dec));
  78                 node->add_property ("minutes", to_string (timecode.minutes, std::dec));
  79                 node->add_property ("seconds", to_string (timecode.seconds, std::dec));
  80                 node->add_property ("frames", to_string (timecode.frames, std::dec));
  81                 break;
  82           case BBT:
  83                 node->add_property ("bars", to_string (bbt.bars, std::dec));
  84                 node->add_property ("beats", to_string (bbt.beats, std::dec));
  85                 node->add_property ("ticks", to_string (bbt.ticks, std::dec));
  86                 break;
  87           case Frames:
  88                 node->add_property ("frames", to_string (frames, std::dec));
  89                 break;
  90           case Seconds:
  91                 node->add_property ("seconds", to_string (seconds, std::dec));
  92                 break;
  93         }
  94
  95         return *node;
  96 }
  97
  98 int
  99 ExportFormatSpecification::Time::set_state (const XMLNode & node)
 100 {
 101         XMLProperty const * prop;
 102
 103         prop = node.property ("format");
 104
 105         if (!prop) { return -1; }
 106
 107         type = (Type) string_2_enum (prop->value(), Type);
 108
 109         switch (type) {
 110           case Timecode:
 111                 if ((prop = node.property ("hours"))) {
 112                         timecode.hours = atoi (prop->value());
 113                 }
 114
 115                 if ((prop = node.property ("minutes"))) {
 116                         timecode.minutes = atoi (prop->value());
 117                 }
 118
 119                 if ((prop = node.property ("seconds"))) {
 120                         timecode.seconds = atoi (prop->value());
 121                 }
 122
 123                 if ((prop = node.property ("frames"))) {
 124                         timecode.frames = atoi (prop->value());
 125                 }
 126
 127                 break;
 128
 129           case BBT:
 130                 if ((prop = node.property ("bars"))) {
 131                         bbt.bars = atoi (prop->value());
 132                 }
 133
 134                 if ((prop = node.property ("beats"))) {
 135                         bbt.beats = atoi (prop->value());
 136                 }
 137
 138                 if ((prop = node.property ("ticks"))) {
 139                         bbt.ticks = atoi (prop->value());
 140                 }
 141
 142                 break;
 143
 144           case Frames:
 145                 if ((prop = node.property ("frames"))) {
 146                         std::istringstream iss (prop->value());
 147                         iss >> frames;
 148                 }
 149
 150                 break;
 151
 152           case Seconds:
 153                 if ((prop = node.property ("seconds"))) {
 154                         seconds = atof (prop->value());
 155                 }
 156
 157                 break;
 158         }
 159
 160         return 0;
 161 }
 162
 163 ExportFormatSpecification::ExportFormatSpecification (Session & s)
 164         : session (s)
 165
 166         , has_sample_format (false)
 167         , supports_tagging (false)
 168         , _has_broadcast_info (false)
 169         , _channel_limit (0)
 170         , _dither_type (D_None)
 171         , _src_quality (SRC_SincBest)
 172         , _tag (true)
 173
 174         , _trim_beginning (false)
 175         , _silence_beginning (s)
 176         , _trim_end (false)
 177         , _silence_end (s)
 178
 179         , _normalize (false)
 180         , _normalize_target (1.0)
 181 {
 182         format_ids.insert (F_None);
 183         endiannesses.insert (E_FileDefault);
 184         sample_formats.insert (SF_None);
 185         sample_rates.insert (SR_None);
 186         qualities.insert (Q_None);
 187 }
 188
 189 ExportFormatSpecification::ExportFormatSpecification (Session & s, XMLNode const & state)
 190         : session (s)
 191         , _silence_beginning (s)
 192         , _silence_end (s)
 193 {
 194         _silence_beginning.type = Time::Timecode;
 195         _silence_end.type = Time::Timecode;
 196
 197         set_state (state);
 198 }
 199
 200 ExportFormatSpecification::ExportFormatSpecification (ExportFormatSpecification const & other)
 201         : ExportFormatBase(other)
 202         , session (other.session)
 203         , _silence_beginning (other.session)
 204         , _silence_end (other.session)
 205 {
 206         set_name (other.name() + " (copy)");
 207
 208         _format_name = other._format_name;
 209         has_sample_format = other.has_sample_format;
 210
 211         supports_tagging = other.supports_tagging;
 212         _has_broadcast_info = other._has_broadcast_info;
 213         _channel_limit = other._channel_limit;
 214
 215         set_type (other.type());
 216         set_format_id (other.format_id());
 217         set_endianness (other.endianness());
 218         set_sample_format (other.sample_format());
 219         set_sample_rate (other.sample_rate());
 220         set_quality (other.quality());
 221
 222         set_dither_type (other.dither_type());
 223         set_src_quality (other.src_quality());
 224         set_trim_beginning (other.trim_beginning());
 225         set_trim_end (other.trim_end());
 226         set_normalize (other.normalize());
 227         set_normalize_target (other.normalize_target());
 228
 229         set_tag (other.tag());
 230
 231         set_silence_beginning (other.silence_beginning_time());
 232         set_silence_end (other.silence_end_time());
 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
 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() > 0 ? "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() > 0 ? "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         /* Encoding and SRC */
 313
 314         if ((child = root.child ("Encoding"))) {
 315                 if ((prop = child->property ("id"))) {
 316                         set_format_id ((FormatId) string_2_enum (prop->value(), FormatId));
 317                 }
 318
 319                 if ((prop = child->property ("type"))) {
 320                         set_type ((Type) string_2_enum (prop->value(), Type));
 321                 }
 322
 323                 if ((prop = child->property ("extension"))) {
 324                         set_extension (prop->value());
 325                 }
 326
 327                 if ((prop = child->property ("name"))) {
 328                         _format_name = prop->value();
 329                 }
 330
 331                 if ((prop = child->property ("has-sample-format"))) {
 332                         has_sample_format = !prop->value().compare ("true");
 333                 }
 334
 335                 if ((prop = child->property ("channel-limit"))) {
 336                         _channel_limit = atoi (prop->value());
 337                 }
 338         }
 339
 340         if ((child = root.child ("SampleRate"))) {
 341                 if ((prop = child->property ("rate"))) {
 342                         set_sample_rate ( (SampleRate) string_2_enum (prop->value(), SampleRate));
 343                 }
 344         }
 345
 346         if ((child = root.child ("SRCQuality"))) {
 347                 if ((prop = child->property ("quality"))) {
 348                         _src_quality = (SRCQuality) string_2_enum (prop->value(), SRCQuality);
 349                 }
 350         }
 351
 352         /* Encoding options */
 353
 354         if ((child = root.child ("EncodingOptions"))) {
 355                 set_sample_format ((SampleFormat) string_2_enum (get_option (child, "sample-format"), SampleFormat));
 356                 set_dither_type ((DitherType) string_2_enum (get_option (child, "dithering"), DitherType));
 357                 set_tag (!(get_option (child, "tag-metadata").compare ("true")));
 358                 supports_tagging = (!(get_option (child, "tag-support").compare ("true")));
 359                 _has_broadcast_info = (!(get_option (child, "broadcast-info").compare ("true")));
 360         }
 361
 362         /* Processing */
 363
 364         XMLNode const * proc = root.child ("Processing");
 365         if (!proc) { std::cerr << X_("Could not load processing for export format") << std::endl; return -1; }
 366
 367         if ((child = proc->child ("Normalize"))) {
 368                 if ((prop = child->property ("enabled"))) {
 369                         _normalize = (!prop->value().compare ("true"));
 370                 }
 371
 372                 if ((prop = child->property ("target"))) {
 373                         _normalize_target = atof (prop->value());
 374                 }
 375         }
 376
 377         XMLNode const * silence = proc->child ("Silence");
 378         if (!silence) { std::cerr << X_("Could not load silence for export format") << std::endl; return -1; }
 379
 380         XMLNode const * start = silence->child ("Start");
 381         XMLNode const * end = silence->child ("End");
 382         if (!start || !end) { std::cerr << X_("Could not load end or start silence for export format") << std::endl; return -1; }
 383
 384         /* Silence start */
 385
 386         if ((child = start->child ("Trim"))) {
 387                 if ((prop = child->property ("enabled"))) {
 388                         _trim_beginning = (!prop->value().compare ("true"));
 389                 }
 390         }
 391
 392         if ((child = start->child ("Add"))) {
 393                 if ((prop = child->property ("enabled"))) {
 394                         if (!prop->value().compare ("true")) {
 395                                 if ((child = child->child ("Duration"))) {
 396                                         _silence_beginning.set_state (*child);
 397                                 }
 398                         } else {
 399                                 _silence_beginning.type = Time::Timecode;
 400                         }
 401                 }
 402         }
 403
 404         /* Silence end */
 405
 406         if ((child = end->child ("Trim"))) {
 407                 if ((prop = child->property ("enabled"))) {
 408                         _trim_end = (!prop->value().compare ("true"));
 409                 }
 410         }
 411
 412         if ((child = end->child ("Add"))) {
 413                 if ((prop = child->property ("enabled"))) {
 414                         if (!prop->value().compare ("true")) {
 415                                 if ((child = child->child ("Duration"))) {
 416                                         _silence_end.set_state (*child);
 417                                 }
 418                         } else {
 419                                 _silence_end.type = Time::Timecode;
 420                         }
 421                 }
 422         }
 423
 424         return 0;
 425 }
 426
 427 bool
 428 ExportFormatSpecification::is_compatible_with (ExportFormatCompatibility const & compatibility) const
 429 {
 430         boost::shared_ptr<ExportFormatBase> intersection = get_intersection (compatibility);
 431
 432         if (intersection->formats_empty() && format_id() != 0) {
 433                 return false;
 434         }
 435
 436         if (intersection->endiannesses_empty() && endianness() != E_FileDefault) {
 437                 return false;
 438         }
 439
 440         if (intersection->sample_rates_empty() && sample_rate() != SR_None) {
 441                 return false;
 442         }
 443
 444         if (intersection->sample_formats_empty() && sample_format() != SF_None) {
 445                 return false;
 446         }
 447
 448         if (intersection->qualities_empty() && quality() != Q_None) {
 449                 return false;
 450         }
 451
 452         return true;
 453 }
 454
 455 bool
 456 ExportFormatSpecification::is_complete () const
 457 {
 458         if (type() == T_None) {
 459                 return false;
 460         }
 461
 462         if (!format_id()) {
 463                 return false;
 464         }
 465
 466         if (!sample_rate()) {
 467                 return false;
 468         }
 469
 470         if (has_sample_format) {
 471                 if (sample_format() == SF_None) {
 472                         return false;
 473                 }
 474         }
 475
 476         return true;
 477 }
 478
 479 void
 480 ExportFormatSpecification::set_format (boost::shared_ptr<ExportFormat> format)
 481 {
 482         if (format) {
 483                 set_format_id (format->get_format_id ());
 484                 set_type (format->get_type());
 485                 set_extension (format->extension());
 486
 487                 if (format->get_explicit_sample_format()) {
 488                         set_sample_format (format->get_explicit_sample_format());
 489                 }
 490
 491                 if (format->has_sample_format()) {
 492                         has_sample_format = true;
 493                 }
 494
 495                 if (format->has_broadcast_info()) {
 496                         _has_broadcast_info = true;
 497                 }
 498
 499                 supports_tagging = format->supports_tagging ();
 500                 _channel_limit = format->get_channel_limit();
 501
 502                 _format_name = format->name();
 503         } else {
 504                 set_format_id (F_None);
 505                 set_type (T_None);
 506                 set_extension ("");
 507                 _has_broadcast_info = false;
 508                 has_sample_format = false;
 509                 supports_tagging = false;
 510                 _channel_limit = 0;
 511                 _format_name = "";
 512         }
 513 }
 514
 515 Glib::ustring
 516 ExportFormatSpecification::description ()
 517 {
 518         Glib::ustring desc;
 519
 520         desc = _name + ": ";
 521
 522         if (_normalize) {
 523                 desc += _("normalize, ");
 524         }
 525
 526         if (_trim_beginning && _trim_end) {
 527                 desc += _("trim, ");
 528         } else if (_trim_beginning) {
 529                 desc += _("trim start, ");
 530         } else if (_trim_end) {
 531                 desc += "trim end, ";
 532         }
 533
 534         desc += _format_name + ", ";
 535
 536         if (has_sample_format) {
 537                 desc += HasSampleFormat::get_sample_format_name (sample_format())  + ", ";
 538         }
 539
 540         switch (sample_rate()) {
 541           case SR_22_05:
 542                 desc += "22,5 kHz";
 543                 break;
 544           case SR_44_1:
 545                 desc += "44,1 kHz";
 546                 break;
 547           case SR_48:
 548                 desc += "48 kHz";
 549                 break;
 550           case SR_88_2:
 551                 desc += "88,2 kHz";
 552                 break;
 553           case SR_96:
 554                 desc += "96 kHz";
 555                 break;
 556           case SR_192:
 557                 desc += "192 kHz";
 558                 break;
 559           case SR_None:
 560                 break;
 561         }
 562
 563         return desc;
 564 }
 565
 566 void
 567 ExportFormatSpecification::add_option (XMLNode * node, std::string const & name, std::string const & value)
 568 {
 569         node = node->add_child ("Option");
 570         node->add_property ("name", name);
 571         node->add_property ("value", value);
 572 }
 573
 574 std::string
 575 ExportFormatSpecification::get_option (XMLNode const * node, std::string const & name)
 576 {
 577         XMLNodeList list (node->children ("Option"));
 578
 579         for (XMLNodeList::iterator it = list.begin(); it != list.end(); ++it) {
 580                 XMLProperty * prop = (*it)->property ("name");
 581                 if (prop && !name.compare (prop->value())) {
 582                         prop = (*it)->property ("value");
 583                         if (prop) {
 584                                 return prop->value();
 585                         }
 586                 }
 587         }
 588
 589         std::cerr << "Could not load encoding option \"" << name << "\" for export format" << std::endl;
 590
 591         return "";
 592 }
 593
 594 }; // namespace ARDOUR