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 void
 250 dvdomatic_setup_i18n (string lang)
 251 {
 252 #ifdef DVDOMATIC_WINDOWS
 253         string const e = "LANGUAGE=" + lang;
 254         putenv (e.c_str());
 255 #endif
 256
 257         setlocale (LC_ALL, "");
 258         textdomain ("libdvdomatic");
 259         bindtextdomain ("libdvdomatic", LOCALE_PREFIX);
 260 }
 261
 262 /** @param start Start position for the crop within the image.
 263  *  @param size Size of the cropped area.
 264  *  @return FFmpeg crop filter string.
 265  */
 266 string
 267 crop_string (Position start, libdcp::Size size)
 268 {
 269         stringstream s;
 270         s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
 271         return s.str ();
 272 }
 273
 274 /** @param s A string.
 275  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 276  */
 277 vector<string>
 278 split_at_spaces_considering_quotes (string s)
 279 {
 280         vector<string> out;
 281         bool in_quotes = false;
 282         string c;
 283         for (string::size_type i = 0; i < s.length(); ++i) {
 284                 if (s[i] == ' ' && !in_quotes) {
 285                         out.push_back (c);
 286                         c = N_("");
 287                 } else if (s[i] == '"') {
 288                         in_quotes = !in_quotes;
 289                 } else {
 290                         c += s[i];
 291                 }
 292         }
 293
 294         out.push_back (c);
 295         return out;
 296 }
 297
 298 string
 299 md5_digest (void const * data, int size)
 300 {
 301         MD5_CTX md5_context;
 302         MD5_Init (&md5_context);
 303         MD5_Update (&md5_context, data, size);
 304         unsigned char digest[MD5_DIGEST_LENGTH];
 305         MD5_Final (digest, &md5_context);
 306
 307         stringstream s;
 308         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 309                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 310         }
 311
 312         return s.str ();
 313 }
 314
 315 /** @param file File name.
 316  *  @return MD5 digest of file's contents.
 317  */
 318 string
 319 md5_digest (string file)
 320 {
 321         ifstream f (file.c_str(), ios::binary);
 322         if (!f.good ()) {
 323                 throw OpenFileError (file);
 324         }
 325
 326         f.seekg (0, ios::end);
 327         int bytes = f.tellg ();
 328         f.seekg (0, ios::beg);
 329
 330         int const buffer_size = 64 * 1024;
 331         char buffer[buffer_size];
 332
 333         MD5_CTX md5_context;
 334         MD5_Init (&md5_context);
 335         while (bytes > 0) {
 336                 int const t = min (bytes, buffer_size);
 337                 f.read (buffer, t);
 338                 MD5_Update (&md5_context, buffer, t);
 339                 bytes -= t;
 340         }
 341
 342         unsigned char digest[MD5_DIGEST_LENGTH];
 343         MD5_Final (digest, &md5_context);
 344
 345         stringstream s;
 346         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 347                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 348         }
 349
 350         return s.str ();
 351 }
 352
 353 static bool
 354 about_equal (float a, float b)
 355 {
 356         /* A film of F seconds at f FPS will be Ff frames;
 357            Consider some delta FPS d, so if we run the same
 358            film at (f + d) FPS it will last F(f + d) seconds.
 359
 360            Hence the difference in length over the length of the film will
 361            be F(f + d) - Ff frames
 362             = Ff + Fd - Ff frames
 363             = Fd frames
 364             = Fd/f seconds
 365
 366            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 367            say that
 368
 369            1/f = Fd/f
 370         ie 1 = Fd
 371         ie d = 1/F
 372
 373            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 374            FPS error is 1/F ~= 0.0001 ~= 10-e4
 375         */
 376
 377         return (fabs (a - b) < 1e-4);
 378 }
 379
 380 class FrameRateCandidate
 381 {
 382 public:
 383         FrameRateCandidate (float source_, int dcp_)
 384                 : source (source_)
 385                 , dcp (dcp_)
 386         {}
 387
 388         float source;
 389         int dcp;
 390 };
 391
 392 int
 393 best_dcp_frame_rate (float source_fps)
 394 {
 395         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 396
 397         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 398         list<FrameRateCandidate> candidates;
 399
 400         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 401         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 402                 candidates.push_back (FrameRateCandidate (*i, *i));
 403         }
 404
 405         /* Then the skip/repeat ones */
 406         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 407                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 408                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 409         }
 410
 411         /* Pick the best one, bailing early if we hit an exact match */
 412         float error = numeric_limits<float>::max ();
 413         boost::optional<FrameRateCandidate> best;
 414         list<FrameRateCandidate>::iterator i = candidates.begin();
 415         while (i != candidates.end()) {
 416
 417                 if (about_equal (i->source, source_fps)) {
 418                         best = *i;
 419                         break;
 420                 }
 421
 422                 float const e = fabs (i->source - source_fps);
 423                 if (e < error) {
 424                         error = e;
 425                         best = *i;
 426                 }
 427
 428                 ++i;
 429         }
 430
 431         assert (best);
 432         return best->dcp;
 433 }
 434
 435 /** @param An arbitrary sampling rate.
 436  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 437  */
 438 int
 439 dcp_audio_sample_rate (int fs)
 440 {
 441         if (fs <= 48000) {
 442                 return 48000;
 443         }
 444
 445         return 96000;
 446 }
 447
 448 bool operator== (Crop const & a, Crop const & b)
 449 {
 450         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 451 }
 452
 453 bool operator!= (Crop const & a, Crop const & b)
 454 {
 455         return !(a == b);
 456 }
 457
 458 /** @param index Colour LUT index.
 459  *  @return Human-readable name.
 460  */
 461 string
 462 colour_lut_index_to_name (int index)
 463 {
 464         switch (index) {
 465         case 0:
 466                 return _("sRGB");
 467         case 1:
 468                 return _("Rec 709");
 469         }
 470
 471         assert (false);
 472         return N_("");
 473 }
 474
 475 Socket::Socket (int timeout)
 476         : _deadline (_io_service)
 477         , _socket (_io_service)
 478         , _timeout (timeout)
 479 {
 480         _deadline.expires_at (posix_time::pos_infin);
 481         check ();
 482 }
 483
 484 void
 485 Socket::check ()
 486 {
 487         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 488                 _socket.close ();
 489                 _deadline.expires_at (posix_time::pos_infin);
 490         }
 491
 492         _deadline.async_wait (boost::bind (&Socket::check, this));
 493 }
 494
 495 /** Blocking connect.
 496  *  @param endpoint End-point to connect to.
 497  */
 498 void
 499 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint)
 500 {
 501         _deadline.expires_from_now (posix_time::seconds (_timeout));
 502         system::error_code ec = asio::error::would_block;
 503         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 504         do {
 505                 _io_service.run_one();
 506         } while (ec == asio::error::would_block);
 507
 508         if (ec || !_socket.is_open ()) {
 509                 throw NetworkError (_("connect timed out"));
 510         }
 511 }
 512
 513 /** Blocking write.
 514  *  @param data Buffer to write.
 515  *  @param size Number of bytes to write.
 516  */
 517 void
 518 Socket::write (uint8_t const * data, int size)
 519 {
 520         _deadline.expires_from_now (posix_time::seconds (_timeout));
 521         system::error_code ec = asio::error::would_block;
 522
 523         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 524
 525         do {
 526                 _io_service.run_one ();
 527         } while (ec == asio::error::would_block);
 528
 529         if (ec) {
 530                 throw NetworkError (ec.message ());
 531         }
 532 }
 533
 534 void
 535 Socket::write (uint32_t v)
 536 {
 537         v = htonl (v);
 538         write (reinterpret_cast<uint8_t*> (&v), 4);
 539 }
 540
 541 /** Blocking read.
 542  *  @param data Buffer to read to.
 543  *  @param size Number of bytes to read.
 544  */
 545 void
 546 Socket::read (uint8_t* data, int size)
 547 {
 548         _deadline.expires_from_now (posix_time::seconds (_timeout));
 549         system::error_code ec = asio::error::would_block;
 550
 551         asio::async_read (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 552
 553         do {
 554                 _io_service.run_one ();
 555         } while (ec == asio::error::would_block);
 556
 557         if (ec) {
 558                 throw NetworkError (ec.message ());
 559         }
 560 }
 561
 562 uint32_t
 563 Socket::read_uint32 ()
 564 {
 565         uint32_t v;
 566         read (reinterpret_cast<uint8_t *> (&v), 4);
 567         return ntohl (v);
 568 }
 569
 570 /** @param other A Rect.
 571  *  @return The intersection of this with `other'.
 572  */
 573 Rect
 574 Rect::intersection (Rect const & other) const
 575 {
 576         int const tx = max (x, other.x);
 577         int const ty = max (y, other.y);
 578
 579         return Rect (
 580                 tx, ty,
 581                 min (x + width, other.x + other.width) - tx,
 582                 min (y + height, other.y + other.height) - ty
 583                 );
 584 }
 585
 586 /** Round a number up to the nearest multiple of another number.
 587  *  @param c Index.
 588  *  @param s Array of numbers to round, indexed by c.
 589  *  @param t Multiple to round to.
 590  *  @return Rounded number.
 591  */
 592 int
 593 stride_round_up (int c, int const * stride, int t)
 594 {
 595         int const a = stride[c] + (t - 1);
 596         return a - (a % t);
 597 }
 598
 599 int
 600 stride_lookup (int c, int const * stride)
 601 {
 602         return stride[c];
 603 }
 604
 605 /** Read a sequence of key / value pairs from a text stream;
 606  *  the keys are the first words on the line, and the values are
 607  *  the remainder of the line following the key.  Lines beginning
 608  *  with # are ignored.
 609  *  @param s Stream to read.
 610  *  @return key/value pairs.
 611  */
 612 multimap<string, string>
 613 read_key_value (istream &s)
 614 {
 615         multimap<string, string> kv;
 616
 617         string line;
 618         while (getline (s, line)) {
 619                 if (line.empty ()) {
 620                         continue;
 621                 }
 622
 623                 if (line[0] == '#') {
 624                         continue;
 625                 }
 626
 627                 if (line[line.size() - 1] == '\r') {
 628                         line = line.substr (0, line.size() - 1);
 629                 }
 630
 631                 size_t const s = line.find (' ');
 632                 if (s == string::npos) {
 633                         continue;
 634                 }
 635
 636                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 637         }
 638
 639         return kv;
 640 }
 641
 642 string
 643 get_required_string (multimap<string, string> const & kv, string k)
 644 {
 645         if (kv.count (k) > 1) {
 646                 throw StringError (N_("unexpected multiple keys in key-value set"));
 647         }
 648
 649         multimap<string, string>::const_iterator i = kv.find (k);
 650
 651         if (i == kv.end ()) {
 652                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 653         }
 654
 655         return i->second;
 656 }
 657
 658 int
 659 get_required_int (multimap<string, string> const & kv, string k)
 660 {
 661         string const v = get_required_string (kv, k);
 662         return lexical_cast<int> (v);
 663 }
 664
 665 float
 666 get_required_float (multimap<string, string> const & kv, string k)
 667 {
 668         string const v = get_required_string (kv, k);
 669         return lexical_cast<float> (v);
 670 }
 671
 672 string
 673 get_optional_string (multimap<string, string> const & kv, string k)
 674 {
 675         if (kv.count (k) > 1) {
 676                 throw StringError (N_("unexpected multiple keys in key-value set"));
 677         }
 678
 679         multimap<string, string>::const_iterator i = kv.find (k);
 680         if (i == kv.end ()) {
 681                 return N_("");
 682         }
 683
 684         return i->second;
 685 }
 686
 687 int
 688 get_optional_int (multimap<string, string> const & kv, string k)
 689 {
 690         if (kv.count (k) > 1) {
 691                 throw StringError (N_("unexpected multiple keys in key-value set"));
 692         }
 693
 694         multimap<string, string>::const_iterator i = kv.find (k);
 695         if (i == kv.end ()) {
 696                 return 0;
 697         }
 698
 699         return lexical_cast<int> (i->second);
 700 }
 701
 702 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 703  *  @param channels Number of channels.
 704  *  @param frames Number of frames to reserve space for.
 705  */
 706 AudioBuffers::AudioBuffers (int channels, int frames)
 707         : _channels (channels)
 708         , _frames (frames)
 709         , _allocated_frames (frames)
 710 {
 711         _data = new float*[_channels];
 712         for (int i = 0; i < _channels; ++i) {
 713                 _data[i] = new float[frames];
 714         }
 715 }
 716
 717 /** Copy constructor.
 718  *  @param other Other AudioBuffers; data is copied.
 719  */
 720 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 721         : _channels (other._channels)
 722         , _frames (other._frames)
 723         , _allocated_frames (other._frames)
 724 {
 725         _data = new float*[_channels];
 726         for (int i = 0; i < _channels; ++i) {
 727                 _data[i] = new float[_frames];
 728                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 729         }
 730 }
 731
 732 /** AudioBuffers destructor */
 733 AudioBuffers::~AudioBuffers ()
 734 {
 735         for (int i = 0; i < _channels; ++i) {
 736                 delete[] _data[i];
 737         }
 738
 739         delete[] _data;
 740 }
 741
 742 /** @param c Channel index.
 743  *  @return Buffer for this channel.
 744  */
 745 float*
 746 AudioBuffers::data (int c) const
 747 {
 748         assert (c >= 0 && c < _channels);
 749         return _data[c];
 750 }
 751
 752 /** Set the number of frames that these AudioBuffers will report themselves
 753  *  as having.
 754  *  @param f Frames; must be less than or equal to the number of allocated frames.
 755  */
 756 void
 757 AudioBuffers::set_frames (int f)
 758 {
 759         assert (f <= _allocated_frames);
 760         _frames = f;
 761 }
 762
 763 /** Make all samples on all channels silent */
 764 void
 765 AudioBuffers::make_silent ()
 766 {
 767         for (int i = 0; i < _channels; ++i) {
 768                 make_silent (i);
 769         }
 770 }
 771
 772 /** Make all samples on a given channel silent.
 773  *  @param c Channel.
 774  */
 775 void
 776 AudioBuffers::make_silent (int c)
 777 {
 778         assert (c >= 0 && c < _channels);
 779
 780         for (int i = 0; i < _frames; ++i) {
 781                 _data[c][i] = 0;
 782         }
 783 }
 784
 785 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 786  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 787  *  @param frames_to_copy Number of frames to copy.
 788  *  @param read_offset Offset to read from in `from'.
 789  *  @param write_offset Offset to write to in `to'.
 790  */
 791 void
 792 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 793 {
 794         assert (from->channels() == channels());
 795
 796         assert (from);
 797         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 798         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 799
 800         for (int i = 0; i < _channels; ++i) {
 801                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 802         }
 803 }
 804
 805 /** Move audio data around.
 806  *  @param from Offset to move from.
 807  *  @param to Offset to move to.
 808  *  @param frames Number of frames to move.
 809  */
 810
 811 void
 812 AudioBuffers::move (int from, int to, int frames)
 813 {
 814         if (frames == 0) {
 815                 return;
 816         }
 817
 818         assert (from >= 0);
 819         assert (from < _frames);
 820         assert (to >= 0);
 821         assert (to < _frames);
 822         assert (frames > 0);
 823         assert (frames <= _frames);
 824         assert ((from + frames) <= _frames);
 825         assert ((to + frames) <= _frames);
 826
 827         for (int i = 0; i < _channels; ++i) {
 828                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 829         }
 830 }
 831
 832 /** Trip an assert if the caller is not in the UI thread */
 833 void
 834 ensure_ui_thread ()
 835 {
 836         assert (this_thread::get_id() == ui_thread);
 837 }
 838
 839 /** @param v Source video frame.
 840  *  @param audio_sample_rate Source audio sample rate.
 841  *  @param frames_per_second Number of video frames per second.
 842  *  @return Equivalent number of audio frames for `v'.
 843  */
 844 int64_t
 845 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 846 {
 847         return ((int64_t) v * audio_sample_rate / frames_per_second);
 848 }
 849
 850 /** @param f Filename.
 851  *  @return true if this file is a still image, false if it is something else.
 852  */
 853 bool
 854 still_image_file (string f)
 855 {
 856         string ext = boost::filesystem::path(f).extension().string();
 857
 858         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 859
 860         return (ext == N_(".tif") || ext == N_(".tiff") || ext == N_(".jpg") || ext == N_(".jpeg") || ext == N_(".png") || ext == N_(".bmp"));
 861 }
 862
 863 /** @return A pair containing CPU model name and the number of processors */
 864 pair<string, int>
 865 cpu_info ()
 866 {
 867         pair<string, int> info;
 868         info.second = 0;
 869
 870 #ifdef DVDOMATIC_POSIX
 871         ifstream f (N_("/proc/cpuinfo"));
 872         while (f.good ()) {
 873                 string l;
 874                 getline (f, l);
 875                 if (boost::algorithm::starts_with (l, N_("model name"))) {
 876                         string::size_type const c = l.find (':');
 877                         if (c != string::npos) {
 878                                 info.first = l.substr (c + 2);
 879                         }
 880                 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
 881                         ++info.second;
 882                 }
 883         }
 884 #endif
 885
 886         return info;
 887 }
 888
 889 string
 890 audio_channel_name (int c)
 891 {
 892         assert (MAX_AUDIO_CHANNELS == 6);
 893
 894         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 895            enhancement channel (sub-woofer)./
 896         */
 897         string const channels[] = {
 898                 "Left",
 899                 "Right",
 900                 "Centre",
 901                 "Lfe (sub)",
 902                 "Left surround",
 903                 "Right surround",
 904         };
 905
 906         return channels[c];
 907 }
 908
 909 AudioMapping::AudioMapping (int c)
 910         : _source_channels (c)
 911 {
 912
 913 }
 914
 915 optional<libdcp::Channel>
 916 AudioMapping::source_to_dcp (int c) const
 917 {
 918         if (c >= _source_channels) {
 919                 return optional<libdcp::Channel> ();
 920         }
 921
 922         if (_source_channels == 1) {
 923                 /* mono sources to centre */
 924                 return libdcp::CENTRE;
 925         }
 926
 927         return static_cast<libdcp::Channel> (c);
 928 }
 929
 930 optional<int>
 931 AudioMapping::dcp_to_source (libdcp::Channel c) const
 932 {
 933         if (_source_channels == 1) {
 934                 if (c == libdcp::CENTRE) {
 935                         return 0;
 936                 } else {
 937                         return optional<int> ();
 938                 }
 939         }
 940
 941         if (static_cast<int> (c) >= _source_channels) {
 942                 return optional<int> ();
 943         }
 944
 945         return static_cast<int> (c);
 946 }
 947
 948 int
 949 AudioMapping::dcp_channels () const
 950 {
 951         if (_source_channels == 1) {
 952                 /* The source is mono, so to put the mono channel into
 953                    the centre we need to generate a 5.1 soundtrack.
 954                 */
 955                 return 6;
 956         }
 957
 958         return _source_channels;
 959 }
 960
 961 FrameRateConversion::FrameRateConversion (float source, int dcp)
 962         : skip (false)
 963         , repeat (false)
 964         , change_speed (false)
 965 {
 966         if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
 967                 skip = true;
 968         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
 969                 repeat = true;
 970         }
 971
 972         change_speed = !about_equal (source * factor(), dcp);
 973
 974         if (!skip && !repeat && !change_speed) {
 975                 description = _("DCP and source have the same rate.\n");
 976         } else {
 977                 if (skip) {
 978                         description = _("DCP will use every other frame of the source.\n");
 979                 } else if (repeat) {
 980                         description = _("Each source frame will be doubled in the DCP.\n");
 981                 }
 982
 983                 if (change_speed) {
 984                         float const pc = dcp * 100 / (source * factor());
 985                         description += String::compose (_("DCP will run at %1%% of the source speed."), pc);
 986                 }
 987         }
 988 }