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