src/lib/util.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   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 /** @file src/lib/util.cc
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #include <sstream>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <fstream>
  29 #include <climits>
  30 #ifdef DVDOMATIC_POSIX
  31 #include <execinfo.h>
  32 #include <cxxabi.h>
  33 #endif
  34 #include <libssh/libssh.h>
  35 #include <signal.h>
  36 #include <boost/algorithm/string.hpp>
  37 #include <boost/bind.hpp>
  38 #include <boost/lambda/lambda.hpp>
  39 #include <boost/lexical_cast.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/filesystem.hpp>
  42 #include <openjpeg.h>
  43 #include <openssl/md5.h>
  44 #include <magick/MagickCore.h>
  45 #include <magick/version.h>
  46 #include <libdcp/version.h>
  47 extern "C" {
  48 #include <libavcodec/avcodec.h>
  49 #include <libavformat/avformat.h>
  50 #include <libswscale/swscale.h>
  51 #include <libavfilter/avfiltergraph.h>
  52 #include <libpostproc/postprocess.h>
  53 #include <libavutil/pixfmt.h>
  54 }
  55 #include "util.h"
  56 #include "exceptions.h"
  57 #include "scaler.h"
  58 #include "format.h"
  59 #include "dcp_content_type.h"
  60 #include "filter.h"
  61 #include "sound_processor.h"
  62 #include "config.h"
  63
  64 #include "i18n.h"
  65
  66 using std::string;
  67 using std::stringstream;
  68 using std::setfill;
  69 using std::ostream;
  70 using std::endl;
  71 using std::vector;
  72 using std::hex;
  73 using std::setw;
  74 using std::ifstream;
  75 using std::ios;
  76 using std::min;
  77 using std::max;
  78 using std::list;
  79 using std::multimap;
  80 using std::istream;
  81 using std::numeric_limits;
  82 using std::pair;
  83 using boost::shared_ptr;
  84 using boost::thread;
  85 using boost::lexical_cast;
  86 using libdcp::Size;
  87
  88 thread::id ui_thread;
  89
  90 /** Convert some number of seconds to a string representation
  91  *  in hours, minutes and seconds.
  92  *
  93  *  @param s Seconds.
  94  *  @return String of the form H:M:S (where H is hours, M
  95  *  is minutes and S is seconds).
  96  */
  97 string
  98 seconds_to_hms (int s)
  99 {
 100         int m = s / 60;
 101         s -= (m * 60);
 102         int h = m / 60;
 103         m -= (h * 60);
 104
 105         stringstream hms;
 106         hms << h << N_(":");
 107         hms.width (2);
 108         hms << setfill ('0') << m << N_(":");
 109         hms.width (2);
 110         hms << setfill ('0') << s;
 111
 112         return hms.str ();
 113 }
 114
 115 /** @param s Number of seconds.
 116  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 117  */
 118 string
 119 seconds_to_approximate_hms (int s)
 120 {
 121         int m = s / 60;
 122         s -= (m * 60);
 123         int h = m / 60;
 124         m -= (h * 60);
 125
 126         stringstream ap;
 127
 128         if (h > 0) {
 129                 if (m > 30) {
 130                         ap << (h + 1) << N_(" ") << _("hours");
 131                 } else {
 132                         if (h == 1) {
 133                                 ap << N_("1 ") << _("hour");
 134                         } else {
 135                                 ap << h << N_(" ") << _("hours");
 136                         }
 137                 }
 138         } else if (m > 0) {
 139                 if (m == 1) {
 140                         ap << N_("1 ") << _("minute");
 141                 } else {
 142                         ap << m << N_(" ") << _("minutes");
 143                 }
 144         } else {
 145                 ap << s << N_(" ") << _("seconds");
 146         }
 147
 148         return ap.str ();
 149 }
 150
 151 #ifdef DVDOMATIC_POSIX
 152 /** @param l Mangled C++ identifier.
 153  *  @return Demangled version.
 154  */
 155 static string
 156 demangle (string l)
 157 {
 158         string::size_type const b = l.find_first_of (N_("("));
 159         if (b == string::npos) {
 160                 return l;
 161         }
 162
 163         string::size_type const p = l.find_last_of (N_("+"));
 164         if (p == string::npos) {
 165                 return l;
 166         }
 167
 168         if ((p - b) <= 1) {
 169                 return l;
 170         }
 171
 172         string const fn = l.substr (b + 1, p - b - 1);
 173
 174         int status;
 175         try {
 176
 177                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 178                 string d (realname);
 179                 free (realname);
 180                 return d;
 181
 182         } catch (std::exception) {
 183
 184         }
 185
 186         return l;
 187 }
 188
 189 /** Write a stacktrace to an ostream.
 190  *  @param out Stream to write to.
 191  *  @param levels Number of levels to go up the call stack.
 192  */
 193 void
 194 stacktrace (ostream& out, int levels)
 195 {
 196         void *array[200];
 197         size_t size;
 198         char **strings;
 199         size_t i;
 200
 201         size = backtrace (array, 200);
 202         strings = backtrace_symbols (array, size);
 203
 204         if (strings) {
 205                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 206                         out << N_("  ") << demangle (strings[i]) << endl;
 207                 }
 208
 209                 free (strings);
 210         }
 211 }
 212 #endif
 213
 214 /** @param v Version as used by FFmpeg.
 215  *  @return A string representation of v.
 216  */
 217 static string
 218 ffmpeg_version_to_string (int v)
 219 {
 220         stringstream s;
 221         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 222         return s.str ();
 223 }
 224
 225 /** Return a user-readable string summarising the versions of our dependencies */
 226 string
 227 dependency_version_summary ()
 228 {
 229         stringstream s;
 230         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 231           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 232           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 233           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 234           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 235           << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
 236           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 237           << MagickVersion << N_(", ")
 238           << N_("libssh ") << ssh_version (0) << N_(", ")
 239           << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
 240
 241         return s.str ();
 242 }
 243
 244 double
 245 seconds (struct timeval t)
 246 {
 247         return t.tv_sec + (double (t.tv_usec) / 1e6);
 248 }
 249
 250 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
 251  *  Must be called from the UI thread, if there is one.
 252  */
 253 void
 254 dvdomatic_setup ()
 255 {
 256         avfilter_register_all ();
 257
 258         Format::setup_formats ();
 259         DCPContentType::setup_dcp_content_types ();
 260         Scaler::setup_scalers ();
 261         Filter::setup_filters ();
 262         SoundProcessor::setup_sound_processors ();
 263
 264         ui_thread = boost::this_thread::get_id ();
 265 }
 266
 267 #ifdef DVDOMATIC_WINDOWS
 268 boost::filesystem::path
 269 mo_path ()
 270 {
 271         wchar_t buffer[512];
 272         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 273         boost::filesystem::path p (buffer);
 274         p = p.parent_path ();
 275         p = p.parent_path ();
 276         p /= "locale";
 277         return p;
 278 }
 279 #endif
 280
 281 void
 282 dvdomatic_setup_i18n (string lang)
 283 {
 284 #ifdef DVDOMATIC_POSIX
 285         lang += ".UTF8";
 286 #endif
 287
 288         if (!lang.empty ()) {
 289                 /* Override our environment language; this is essential on
 290                    Windows.
 291                 */
 292                 char cmd[64];
 293                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 294                 putenv (cmd);
 295                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 296                 putenv (cmd);
 297         }
 298
 299         setlocale (LC_ALL, "");
 300         textdomain ("libdvdomatic");
 301
 302 #ifdef DVDOMATIC_WINDOWS
 303         bindtextdomain ("libdvdomatic", mo_path().string().c_str());
 304 #endif
 305
 306 #ifdef DVDOMATIC_POSIX
 307         bindtextdomain ("libdvdomatic", POSIX_LOCALE_PREFIX);
 308 #endif
 309 }
 310
 311 /** @param start Start position for the crop within the image.
 312  *  @param size Size of the cropped area.
 313  *  @return FFmpeg crop filter string.
 314  */
 315 string
 316 crop_string (Position start, libdcp::Size size)
 317 {
 318         stringstream s;
 319         s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
 320         return s.str ();
 321 }
 322
 323 /** @param s A string.
 324  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 325  */
 326 vector<string>
 327 split_at_spaces_considering_quotes (string s)
 328 {
 329         vector<string> out;
 330         bool in_quotes = false;
 331         string c;
 332         for (string::size_type i = 0; i < s.length(); ++i) {
 333                 if (s[i] == ' ' && !in_quotes) {
 334                         out.push_back (c);
 335                         c = N_("");
 336                 } else if (s[i] == '"') {
 337                         in_quotes = !in_quotes;
 338                 } else {
 339                         c += s[i];
 340                 }
 341         }
 342
 343         out.push_back (c);
 344         return out;
 345 }
 346
 347 string
 348 md5_digest (void const * data, int size)
 349 {
 350         MD5_CTX md5_context;
 351         MD5_Init (&md5_context);
 352         MD5_Update (&md5_context, data, size);
 353         unsigned char digest[MD5_DIGEST_LENGTH];
 354         MD5_Final (digest, &md5_context);
 355
 356         stringstream s;
 357         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 358                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 359         }
 360
 361         return s.str ();
 362 }
 363
 364 /** @param file File name.
 365  *  @return MD5 digest of file's contents.
 366  */
 367 string
 368 md5_digest (boost::filesystem::path file)
 369 {
 370         ifstream f (file.string().c_str(), ios::binary);
 371         if (!f.good ()) {
 372                 throw OpenFileError (file.string());
 373         }
 374
 375         f.seekg (0, ios::end);
 376         int bytes = f.tellg ();
 377         f.seekg (0, ios::beg);
 378
 379         int const buffer_size = 64 * 1024;
 380         char buffer[buffer_size];
 381
 382         MD5_CTX md5_context;
 383         MD5_Init (&md5_context);
 384         while (bytes > 0) {
 385                 int const t = min (bytes, buffer_size);
 386                 f.read (buffer, t);
 387                 MD5_Update (&md5_context, buffer, t);
 388                 bytes -= t;
 389         }
 390
 391         unsigned char digest[MD5_DIGEST_LENGTH];
 392         MD5_Final (digest, &md5_context);
 393
 394         stringstream s;
 395         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 396                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 397         }
 398
 399         return s.str ();
 400 }
 401
 402 static bool
 403 about_equal (float a, float b)
 404 {
 405         /* A film of F seconds at f FPS will be Ff frames;
 406            Consider some delta FPS d, so if we run the same
 407            film at (f + d) FPS it will last F(f + d) seconds.
 408
 409            Hence the difference in length over the length of the film will
 410            be F(f + d) - Ff frames
 411             = Ff + Fd - Ff frames
 412             = Fd frames
 413             = Fd/f seconds
 414
 415            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 416            say that
 417
 418            1/f = Fd/f
 419         ie 1 = Fd
 420         ie d = 1/F
 421
 422            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 423            FPS error is 1/F ~= 0.0001 ~= 10-e4
 424         */
 425
 426         return (fabs (a - b) < 1e-4);
 427 }
 428
 429 class FrameRateCandidate
 430 {
 431 public:
 432         FrameRateCandidate (float source_, int dcp_)
 433                 : source (source_)
 434                 , dcp (dcp_)
 435         {}
 436
 437         float source;
 438         int dcp;
 439 };
 440
 441 int
 442 best_dcp_frame_rate (float source_fps)
 443 {
 444         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 445
 446         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 447         list<FrameRateCandidate> candidates;
 448
 449         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 450         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 451                 candidates.push_back (FrameRateCandidate (*i, *i));
 452         }
 453
 454         /* Then the skip/repeat ones */
 455         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 456                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 457                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 458         }
 459
 460         /* Pick the best one, bailing early if we hit an exact match */
 461         float error = numeric_limits<float>::max ();
 462         boost::optional<FrameRateCandidate> best;
 463         list<FrameRateCandidate>::iterator i = candidates.begin();
 464         while (i != candidates.end()) {
 465
 466                 if (about_equal (i->source, source_fps)) {
 467                         best = *i;
 468                         break;
 469                 }
 470
 471                 float const e = fabs (i->source - source_fps);
 472                 if (e < error) {
 473                         error = e;
 474                         best = *i;
 475                 }
 476
 477                 ++i;
 478         }
 479
 480         assert (best);
 481         return best->dcp;
 482 }
 483
 484 /** @param An arbitrary sampling rate.
 485  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 486  */
 487 int
 488 dcp_audio_sample_rate (int fs)
 489 {
 490         if (fs <= 48000) {
 491                 return 48000;
 492         }
 493
 494         return 96000;
 495 }
 496
 497 /** @param index Colour LUT index.
 498  *  @return Human-readable name.
 499  */
 500 string
 501 colour_lut_index_to_name (int index)
 502 {
 503         switch (index) {
 504         case 0:
 505                 return _("sRGB");
 506         case 1:
 507                 return _("Rec 709");
 508         }
 509
 510         assert (false);
 511         return N_("");
 512 }
 513
 514 Socket::Socket (int timeout)
 515         : _deadline (_io_service)
 516         , _socket (_io_service)
 517         , _timeout (timeout)
 518 {
 519         _deadline.expires_at (boost::posix_time::pos_infin);
 520         check ();
 521 }
 522
 523 void
 524 Socket::check ()
 525 {
 526         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 527                 _socket.close ();
 528                 _deadline.expires_at (boost::posix_time::pos_infin);
 529         }
 530
 531         _deadline.async_wait (boost::bind (&Socket::check, this));
 532 }
 533
 534 /** Blocking connect.
 535  *  @param endpoint End-point to connect to.
 536  */
 537 void
 538 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
 539 {
 540         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 541         boost::system::error_code ec = boost::asio::error::would_block;
 542         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 543         do {
 544                 _io_service.run_one();
 545         } while (ec == boost::asio::error::would_block);
 546
 547         if (ec || !_socket.is_open ()) {
 548                 throw NetworkError (_("connect timed out"));
 549         }
 550 }
 551
 552 /** Blocking write.
 553  *  @param data Buffer to write.
 554  *  @param size Number of bytes to write.
 555  */
 556 void
 557 Socket::write (uint8_t const * data, int size)
 558 {
 559         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 560         boost::system::error_code ec = boost::asio::error::would_block;
 561
 562         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 563
 564         do {
 565                 _io_service.run_one ();
 566         } while (ec == boost::asio::error::would_block);
 567
 568         if (ec) {
 569                 throw NetworkError (ec.message ());
 570         }
 571 }
 572
 573 void
 574 Socket::write (uint32_t v)
 575 {
 576         v = htonl (v);
 577         write (reinterpret_cast<uint8_t*> (&v), 4);
 578 }
 579
 580 /** Blocking read.
 581  *  @param data Buffer to read to.
 582  *  @param size Number of bytes to read.
 583  */
 584 void
 585 Socket::read (uint8_t* data, int size)
 586 {
 587         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 588         boost::system::error_code ec = boost::asio::error::would_block;
 589
 590         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 591
 592         do {
 593                 _io_service.run_one ();
 594         } while (ec == boost::asio::error::would_block);
 595
 596         if (ec) {
 597                 throw NetworkError (ec.message ());
 598         }
 599 }
 600
 601 uint32_t
 602 Socket::read_uint32 ()
 603 {
 604         uint32_t v;
 605         read (reinterpret_cast<uint8_t *> (&v), 4);
 606         return ntohl (v);
 607 }
 608
 609 /** @param other A Rect.
 610  *  @return The intersection of this with `other'.
 611  */
 612 Rect
 613 Rect::intersection (Rect const & other) const
 614 {
 615         int const tx = max (x, other.x);
 616         int const ty = max (y, other.y);
 617
 618         return Rect (
 619                 tx, ty,
 620                 min (x + width, other.x + other.width) - tx,
 621                 min (y + height, other.y + other.height) - ty
 622                 );
 623 }
 624
 625 /** Round a number up to the nearest multiple of another number.
 626  *  @param c Index.
 627  *  @param s Array of numbers to round, indexed by c.
 628  *  @param t Multiple to round to.
 629  *  @return Rounded number.
 630  */
 631 int
 632 stride_round_up (int c, int const * stride, int t)
 633 {
 634         int const a = stride[c] + (t - 1);
 635         return a - (a % t);
 636 }
 637
 638 int
 639 stride_lookup (int c, int const * stride)
 640 {
 641         return stride[c];
 642 }
 643
 644 /** Read a sequence of key / value pairs from a text stream;
 645  *  the keys are the first words on the line, and the values are
 646  *  the remainder of the line following the key.  Lines beginning
 647  *  with # are ignored.
 648  *  @param s Stream to read.
 649  *  @return key/value pairs.
 650  */
 651 multimap<string, string>
 652 read_key_value (istream &s)
 653 {
 654         multimap<string, string> kv;
 655
 656         string line;
 657         while (getline (s, line)) {
 658                 if (line.empty ()) {
 659                         continue;
 660                 }
 661
 662                 if (line[0] == '#') {
 663                         continue;
 664                 }
 665
 666                 if (line[line.size() - 1] == '\r') {
 667                         line = line.substr (0, line.size() - 1);
 668                 }
 669
 670                 size_t const s = line.find (' ');
 671                 if (s == string::npos) {
 672                         continue;
 673                 }
 674
 675                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 676         }
 677
 678         return kv;
 679 }
 680
 681 string
 682 get_required_string (multimap<string, string> const & kv, string k)
 683 {
 684         if (kv.count (k) > 1) {
 685                 throw StringError (N_("unexpected multiple keys in key-value set"));
 686         }
 687
 688         multimap<string, string>::const_iterator i = kv.find (k);
 689
 690         if (i == kv.end ()) {
 691                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 692         }
 693
 694         return i->second;
 695 }
 696
 697 int
 698 get_required_int (multimap<string, string> const & kv, string k)
 699 {
 700         string const v = get_required_string (kv, k);
 701         return lexical_cast<int> (v);
 702 }
 703
 704 float
 705 get_required_float (multimap<string, string> const & kv, string k)
 706 {
 707         string const v = get_required_string (kv, k);
 708         return lexical_cast<float> (v);
 709 }
 710
 711 string
 712 get_optional_string (multimap<string, string> const & kv, string k)
 713 {
 714         if (kv.count (k) > 1) {
 715                 throw StringError (N_("unexpected multiple keys in key-value set"));
 716         }
 717
 718         multimap<string, string>::const_iterator i = kv.find (k);
 719         if (i == kv.end ()) {
 720                 return N_("");
 721         }
 722
 723         return i->second;
 724 }
 725
 726 int
 727 get_optional_int (multimap<string, string> const & kv, string k)
 728 {
 729         if (kv.count (k) > 1) {
 730                 throw StringError (N_("unexpected multiple keys in key-value set"));
 731         }
 732
 733         multimap<string, string>::const_iterator i = kv.find (k);
 734         if (i == kv.end ()) {
 735                 return 0;
 736         }
 737
 738         return lexical_cast<int> (i->second);
 739 }
 740
 741 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 742  *  @param channels Number of channels.
 743  *  @param frames Number of frames to reserve space for.
 744  */
 745 AudioBuffers::AudioBuffers (int channels, int frames)
 746         : _channels (channels)
 747         , _frames (frames)
 748         , _allocated_frames (frames)
 749 {
 750         _data = new float*[_channels];
 751         for (int i = 0; i < _channels; ++i) {
 752                 _data[i] = new float[frames];
 753         }
 754 }
 755
 756 /** Copy constructor.
 757  *  @param other Other AudioBuffers; data is copied.
 758  */
 759 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 760         : _channels (other._channels)
 761         , _frames (other._frames)
 762         , _allocated_frames (other._frames)
 763 {
 764         _data = new float*[_channels];
 765         for (int i = 0; i < _channels; ++i) {
 766                 _data[i] = new float[_frames];
 767                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 768         }
 769 }
 770
 771 /** AudioBuffers destructor */
 772 AudioBuffers::~AudioBuffers ()
 773 {
 774         for (int i = 0; i < _channels; ++i) {
 775                 delete[] _data[i];
 776         }
 777
 778         delete[] _data;
 779 }
 780
 781 /** @param c Channel index.
 782  *  @return Buffer for this channel.
 783  */
 784 float*
 785 AudioBuffers::data (int c) const
 786 {
 787         assert (c >= 0 && c < _channels);
 788         return _data[c];
 789 }
 790
 791 /** Set the number of frames that these AudioBuffers will report themselves
 792  *  as having.
 793  *  @param f Frames; must be less than or equal to the number of allocated frames.
 794  */
 795 void
 796 AudioBuffers::set_frames (int f)
 797 {
 798         assert (f <= _allocated_frames);
 799         _frames = f;
 800 }
 801
 802 /** Make all samples on all channels silent */
 803 void
 804 AudioBuffers::make_silent ()
 805 {
 806         for (int i = 0; i < _channels; ++i) {
 807                 make_silent (i);
 808         }
 809 }
 810
 811 /** Make all samples on a given channel silent.
 812  *  @param c Channel.
 813  */
 814 void
 815 AudioBuffers::make_silent (int c)
 816 {
 817         assert (c >= 0 && c < _channels);
 818
 819         for (int i = 0; i < _frames; ++i) {
 820                 _data[c][i] = 0;
 821         }
 822 }
 823
 824 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 825  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 826  *  @param frames_to_copy Number of frames to copy.
 827  *  @param read_offset Offset to read from in `from'.
 828  *  @param write_offset Offset to write to in `to'.
 829  */
 830 void
 831 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 832 {
 833         assert (from->channels() == channels());
 834
 835         assert (from);
 836         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 837         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 838
 839         for (int i = 0; i < _channels; ++i) {
 840                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 841         }
 842 }
 843
 844 /** Move audio data around.
 845  *  @param from Offset to move from.
 846  *  @param to Offset to move to.
 847  *  @param frames Number of frames to move.
 848  */
 849
 850 void
 851 AudioBuffers::move (int from, int to, int frames)
 852 {
 853         if (frames == 0) {
 854                 return;
 855         }
 856
 857         assert (from >= 0);
 858         assert (from < _frames);
 859         assert (to >= 0);
 860         assert (to < _frames);
 861         assert (frames > 0);
 862         assert (frames <= _frames);
 863         assert ((from + frames) <= _frames);
 864         assert ((to + frames) <= _frames);
 865
 866         for (int i = 0; i < _channels; ++i) {
 867                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 868         }
 869 }
 870
 871 /** Add data from from `from', `from_channel' to our channel `to_channel' */
 872 void
 873 AudioBuffers::accumulate (shared_ptr<AudioBuffers> from, int from_channel, int to_channel)
 874 {
 875         int const N = frames ();
 876         assert (from->frames() == N);
 877
 878         float* s = from->data (from_channel);
 879         float* d = _data[to_channel];
 880
 881         for (int i = 0; i < N; ++i) {
 882                 *d++ += *s++;
 883         }
 884 }
 885
 886 /** Trip an assert if the caller is not in the UI thread */
 887 void
 888 ensure_ui_thread ()
 889 {
 890         assert (boost::this_thread::get_id() == ui_thread);
 891 }
 892
 893 /** @param v Content video frame.
 894  *  @param audio_sample_rate Source audio sample rate.
 895  *  @param frames_per_second Number of video frames per second.
 896  *  @return Equivalent number of audio frames for `v'.
 897  */
 898 int64_t
 899 video_frames_to_audio_frames (ContentVideoFrame v, float audio_sample_rate, float frames_per_second)
 900 {
 901         return ((int64_t) v * audio_sample_rate / frames_per_second);
 902 }
 903
 904 /** @return A pair containing CPU model name and the number of processors */
 905 pair<string, int>
 906 cpu_info ()
 907 {
 908         pair<string, int> info;
 909         info.second = 0;
 910
 911 #ifdef DVDOMATIC_POSIX
 912         ifstream f (N_("/proc/cpuinfo"));
 913         while (f.good ()) {
 914                 string l;
 915                 getline (f, l);
 916                 if (boost::algorithm::starts_with (l, N_("model name"))) {
 917                         string::size_type const c = l.find (':');
 918                         if (c != string::npos) {
 919                                 info.first = l.substr (c + 2);
 920                         }
 921                 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
 922                         ++info.second;
 923                 }
 924         }
 925 #endif
 926
 927         return info;
 928 }
 929
 930 string
 931 audio_channel_name (int c)
 932 {
 933         assert (MAX_AUDIO_CHANNELS == 6);
 934
 935         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 936            enhancement channel (sub-woofer)./
 937         */
 938         string const channels[] = {
 939                 _("Left"),
 940                 _("Right"),
 941                 _("Centre"),
 942                 _("Lfe (sub)"),
 943                 _("Left surround"),
 944                 _("Right surround"),
 945         };
 946
 947         return channels[c];
 948 }
 949
 950 FrameRateConversion::FrameRateConversion (float source, int dcp)
 951         : skip (false)
 952         , repeat (false)
 953         , change_speed (false)
 954 {
 955         if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
 956                 skip = true;
 957         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
 958                 repeat = true;
 959         }
 960
 961         change_speed = !about_equal (source * factor(), dcp);
 962
 963         if (!skip && !repeat && !change_speed) {
 964                 description = _("DCP and source have the same rate.\n");
 965         } else {
 966                 if (skip) {
 967                         description = _("DCP will use every other frame of the source.\n");
 968                 } else if (repeat) {
 969                         description = _("Each source frame will be doubled in the DCP.\n");
 970                 }
 971
 972                 if (change_speed) {
 973                         float const pc = dcp * 100 / (source * factor());
 974                         description += String::compose (_("DCP will run at %1%% of the source speed."), pc);
 975                 }
 976         }
 977 }