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