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