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         bool skip () const {
 379                 return !about_equal (source, dcp) && source > dcp;
 380         }
 381
 382         bool repeat () const {
 383                 return !about_equal (source, dcp) && source < dcp;
 384         }
 385
 386         float source;
 387         int dcp;
 388 };
 389
 390 /** @param fps Arbitrary source frames-per-second value */
 391 /** XXX: this could be slow-ish */
 392 DCPFrameRate::DCPFrameRate (float source_fps)
 393 {
 394         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 395
 396         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 397         list<FrameRateCandidate> candidates;
 398
 399         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 400         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 401                 candidates.push_back (FrameRateCandidate (*i, *i));
 402         }
 403
 404         /* Then the skip/repeat ones */
 405         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 406                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 407                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 408         }
 409
 410         /* Pick the best one, bailing early if we hit an exact match */
 411         float error = numeric_limits<float>::max ();
 412         boost::optional<FrameRateCandidate> best;
 413         list<FrameRateCandidate>::iterator i = candidates.begin();
 414         while (i != candidates.end()) {
 415
 416                 if (about_equal (i->source, source_fps)) {
 417                         best = *i;
 418                         break;
 419                 }
 420
 421                 float const e = fabs (i->source - source_fps);
 422                 if (e < error) {
 423                         error = e;
 424                         best = *i;
 425                 }
 426
 427                 ++i;
 428         }
 429
 430         if (!best) {
 431                 throw EncodeError (_("cannot find a suitable DCP frame rate for this source"));
 432         }
 433
 434         frames_per_second = best->dcp;
 435         skip = best->skip ();
 436         repeat = best->repeat ();
 437         change_speed = !about_equal (source_fps * factor(), frames_per_second);
 438 }
 439
 440 /** @param An arbitrary sampling rate.
 441  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 442  */
 443 int
 444 dcp_audio_sample_rate (int fs)
 445 {
 446         if (fs <= 48000) {
 447                 return 48000;
 448         }
 449
 450         return 96000;
 451 }
 452
 453 bool operator== (Crop const & a, Crop const & b)
 454 {
 455         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 456 }
 457
 458 bool operator!= (Crop const & a, Crop const & b)
 459 {
 460         return !(a == b);
 461 }
 462
 463 /** @param index Colour LUT index.
 464  *  @return Human-readable name.
 465  */
 466 string
 467 colour_lut_index_to_name (int index)
 468 {
 469         switch (index) {
 470         case 0:
 471                 return _("sRGB");
 472         case 1:
 473                 return _("Rec 709");
 474         }
 475
 476         assert (false);
 477         return N_("");
 478 }
 479
 480 Socket::Socket (int timeout)
 481         : _deadline (_io_service)
 482         , _socket (_io_service)
 483         , _timeout (timeout)
 484 {
 485         _deadline.expires_at (posix_time::pos_infin);
 486         check ();
 487 }
 488
 489 void
 490 Socket::check ()
 491 {
 492         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 493                 _socket.close ();
 494                 _deadline.expires_at (posix_time::pos_infin);
 495         }
 496
 497         _deadline.async_wait (boost::bind (&Socket::check, this));
 498 }
 499
 500 /** Blocking connect.
 501  *  @param endpoint End-point to connect to.
 502  */
 503 void
 504 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint)
 505 {
 506         _deadline.expires_from_now (posix_time::seconds (_timeout));
 507         system::error_code ec = asio::error::would_block;
 508         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 509         do {
 510                 _io_service.run_one();
 511         } while (ec == asio::error::would_block);
 512
 513         if (ec || !_socket.is_open ()) {
 514                 throw NetworkError (_("connect timed out"));
 515         }
 516 }
 517
 518 /** Blocking write.
 519  *  @param data Buffer to write.
 520  *  @param size Number of bytes to write.
 521  */
 522 void
 523 Socket::write (uint8_t const * data, int size)
 524 {
 525         _deadline.expires_from_now (posix_time::seconds (_timeout));
 526         system::error_code ec = asio::error::would_block;
 527
 528         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 529
 530         do {
 531                 _io_service.run_one ();
 532         } while (ec == asio::error::would_block);
 533
 534         if (ec) {
 535                 throw NetworkError (ec.message ());
 536         }
 537 }
 538
 539 void
 540 Socket::write (uint32_t v)
 541 {
 542         v = htonl (v);
 543         write (reinterpret_cast<uint8_t*> (&v), 4);
 544 }
 545
 546 /** Blocking read.
 547  *  @param data Buffer to read to.
 548  *  @param size Number of bytes to read.
 549  */
 550 void
 551 Socket::read (uint8_t* data, int size)
 552 {
 553         _deadline.expires_from_now (posix_time::seconds (_timeout));
 554         system::error_code ec = asio::error::would_block;
 555
 556         asio::async_read (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 557
 558         do {
 559                 _io_service.run_one ();
 560         } while (ec == asio::error::would_block);
 561
 562         if (ec) {
 563                 throw NetworkError (ec.message ());
 564         }
 565 }
 566
 567 uint32_t
 568 Socket::read_uint32 ()
 569 {
 570         uint32_t v;
 571         read (reinterpret_cast<uint8_t *> (&v), 4);
 572         return ntohl (v);
 573 }
 574
 575 /** @param other A Rect.
 576  *  @return The intersection of this with `other'.
 577  */
 578 Rect
 579 Rect::intersection (Rect const & other) const
 580 {
 581         int const tx = max (x, other.x);
 582         int const ty = max (y, other.y);
 583
 584         return Rect (
 585                 tx, ty,
 586                 min (x + width, other.x + other.width) - tx,
 587                 min (y + height, other.y + other.height) - ty
 588                 );
 589 }
 590
 591 /** Round a number up to the nearest multiple of another number.
 592  *  @param c Index.
 593  *  @param s Array of numbers to round, indexed by c.
 594  *  @param t Multiple to round to.
 595  *  @return Rounded number.
 596  */
 597 int
 598 stride_round_up (int c, int const * stride, int t)
 599 {
 600         int const a = stride[c] + (t - 1);
 601         return a - (a % t);
 602 }
 603
 604 int
 605 stride_lookup (int c, int const * stride)
 606 {
 607         return stride[c];
 608 }
 609
 610 /** Read a sequence of key / value pairs from a text stream;
 611  *  the keys are the first words on the line, and the values are
 612  *  the remainder of the line following the key.  Lines beginning
 613  *  with # are ignored.
 614  *  @param s Stream to read.
 615  *  @return key/value pairs.
 616  */
 617 multimap<string, string>
 618 read_key_value (istream &s)
 619 {
 620         multimap<string, string> kv;
 621
 622         string line;
 623         while (getline (s, line)) {
 624                 if (line.empty ()) {
 625                         continue;
 626                 }
 627
 628                 if (line[0] == '#') {
 629                         continue;
 630                 }
 631
 632                 if (line[line.size() - 1] == '\r') {
 633                         line = line.substr (0, line.size() - 1);
 634                 }
 635
 636                 size_t const s = line.find (' ');
 637                 if (s == string::npos) {
 638                         continue;
 639                 }
 640
 641                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 642         }
 643
 644         return kv;
 645 }
 646
 647 string
 648 get_required_string (multimap<string, string> const & kv, string k)
 649 {
 650         if (kv.count (k) > 1) {
 651                 throw StringError (N_("unexpected multiple keys in key-value set"));
 652         }
 653
 654         multimap<string, string>::const_iterator i = kv.find (k);
 655
 656         if (i == kv.end ()) {
 657                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 658         }
 659
 660         return i->second;
 661 }
 662
 663 int
 664 get_required_int (multimap<string, string> const & kv, string k)
 665 {
 666         string const v = get_required_string (kv, k);
 667         return lexical_cast<int> (v);
 668 }
 669
 670 float
 671 get_required_float (multimap<string, string> const & kv, string k)
 672 {
 673         string const v = get_required_string (kv, k);
 674         return lexical_cast<float> (v);
 675 }
 676
 677 string
 678 get_optional_string (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 N_("");
 687         }
 688
 689         return i->second;
 690 }
 691
 692 int
 693 get_optional_int (multimap<string, string> const & kv, string k)
 694 {
 695         if (kv.count (k) > 1) {
 696                 throw StringError (N_("unexpected multiple keys in key-value set"));
 697         }
 698
 699         multimap<string, string>::const_iterator i = kv.find (k);
 700         if (i == kv.end ()) {
 701                 return 0;
 702         }
 703
 704         return lexical_cast<int> (i->second);
 705 }
 706
 707 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 708  *  @param channels Number of channels.
 709  *  @param frames Number of frames to reserve space for.
 710  */
 711 AudioBuffers::AudioBuffers (int channels, int frames)
 712         : _channels (channels)
 713         , _frames (frames)
 714         , _allocated_frames (frames)
 715 {
 716         _data = new float*[_channels];
 717         for (int i = 0; i < _channels; ++i) {
 718                 _data[i] = new float[frames];
 719         }
 720 }
 721
 722 /** Copy constructor.
 723  *  @param other Other AudioBuffers; data is copied.
 724  */
 725 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 726         : _channels (other._channels)
 727         , _frames (other._frames)
 728         , _allocated_frames (other._frames)
 729 {
 730         _data = new float*[_channels];
 731         for (int i = 0; i < _channels; ++i) {
 732                 _data[i] = new float[_frames];
 733                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 734         }
 735 }
 736
 737 /** AudioBuffers destructor */
 738 AudioBuffers::~AudioBuffers ()
 739 {
 740         for (int i = 0; i < _channels; ++i) {
 741                 delete[] _data[i];
 742         }
 743
 744         delete[] _data;
 745 }
 746
 747 /** @param c Channel index.
 748  *  @return Buffer for this channel.
 749  */
 750 float*
 751 AudioBuffers::data (int c) const
 752 {
 753         assert (c >= 0 && c < _channels);
 754         return _data[c];
 755 }
 756
 757 /** Set the number of frames that these AudioBuffers will report themselves
 758  *  as having.
 759  *  @param f Frames; must be less than or equal to the number of allocated frames.
 760  */
 761 void
 762 AudioBuffers::set_frames (int f)
 763 {
 764         assert (f <= _allocated_frames);
 765         _frames = f;
 766 }
 767
 768 /** Make all samples on all channels silent */
 769 void
 770 AudioBuffers::make_silent ()
 771 {
 772         for (int i = 0; i < _channels; ++i) {
 773                 make_silent (i);
 774         }
 775 }
 776
 777 /** Make all samples on a given channel silent.
 778  *  @param c Channel.
 779  */
 780 void
 781 AudioBuffers::make_silent (int c)
 782 {
 783         assert (c >= 0 && c < _channels);
 784
 785         for (int i = 0; i < _frames; ++i) {
 786                 _data[c][i] = 0;
 787         }
 788 }
 789
 790 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 791  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 792  *  @param frames_to_copy Number of frames to copy.
 793  *  @param read_offset Offset to read from in `from'.
 794  *  @param write_offset Offset to write to in `to'.
 795  */
 796 void
 797 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 798 {
 799         assert (from->channels() == channels());
 800
 801         assert (from);
 802         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 803         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 804
 805         for (int i = 0; i < _channels; ++i) {
 806                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 807         }
 808 }
 809
 810 /** Move audio data around.
 811  *  @param from Offset to move from.
 812  *  @param to Offset to move to.
 813  *  @param frames Number of frames to move.
 814  */
 815
 816 void
 817 AudioBuffers::move (int from, int to, int frames)
 818 {
 819         if (frames == 0) {
 820                 return;
 821         }
 822
 823         assert (from >= 0);
 824         assert (from < _frames);
 825         assert (to >= 0);
 826         assert (to < _frames);
 827         assert (frames > 0);
 828         assert (frames <= _frames);
 829         assert ((from + frames) <= _frames);
 830         assert ((to + frames) <= _frames);
 831
 832         for (int i = 0; i < _channels; ++i) {
 833                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 834         }
 835 }
 836
 837 /** Trip an assert if the caller is not in the UI thread */
 838 void
 839 ensure_ui_thread ()
 840 {
 841         assert (this_thread::get_id() == ui_thread);
 842 }
 843
 844 /** @param v Source video frame.
 845  *  @param audio_sample_rate Source audio sample rate.
 846  *  @param frames_per_second Number of video frames per second.
 847  *  @return Equivalent number of audio frames for `v'.
 848  */
 849 int64_t
 850 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 851 {
 852         return ((int64_t) v * audio_sample_rate / frames_per_second);
 853 }
 854
 855 /** @param f Filename.
 856  *  @return true if this file is a still image, false if it is something else.
 857  */
 858 bool
 859 still_image_file (string f)
 860 {
 861         string ext = boost::filesystem::path(f).extension().string();
 862
 863         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 864
 865         return (ext == N_(".tif") || ext == N_(".tiff") || ext == N_(".jpg") || ext == N_(".jpeg") || ext == N_(".png") || ext == N_(".bmp"));
 866 }
 867
 868 /** @return A pair containing CPU model name and the number of processors */
 869 pair<string, int>
 870 cpu_info ()
 871 {
 872         pair<string, int> info;
 873         info.second = 0;
 874
 875 #ifdef DVDOMATIC_POSIX
 876         ifstream f (N_("/proc/cpuinfo"));
 877         while (f.good ()) {
 878                 string l;
 879                 getline (f, l);
 880                 if (boost::algorithm::starts_with (l, N_("model name"))) {
 881                         string::size_type const c = l.find (':');
 882                         if (c != string::npos) {
 883                                 info.first = l.substr (c + 2);
 884                         }
 885                 } else if (boost::algorithm::starts_with (l, N_("processor"))) {
 886                         ++info.second;
 887                 }
 888         }
 889 #endif
 890
 891         return info;
 892 }
 893
 894 string
 895 audio_channel_name (int c)
 896 {
 897         assert (MAX_AUDIO_CHANNELS == 6);
 898
 899         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 900            enhancement channel (sub-woofer)./
 901         */
 902         string const channels[] = {
 903                 "Left",
 904                 "Right",
 905                 "Centre",
 906                 "Lfe (sub)",
 907                 "Left surround",
 908                 "Right surround",
 909         };
 910
 911         return channels[c];
 912 }
 913
 914 AudioMapping::AudioMapping (int c)
 915         : _source_channels (c)
 916 {
 917
 918 }
 919
 920 optional<libdcp::Channel>
 921 AudioMapping::source_to_dcp (int c) const
 922 {
 923         if (c >= _source_channels) {
 924                 return optional<libdcp::Channel> ();
 925         }
 926
 927         if (_source_channels == 1) {
 928                 /* mono sources to centre */
 929                 return libdcp::CENTRE;
 930         }
 931
 932         return static_cast<libdcp::Channel> (c);
 933 }
 934
 935 optional<int>
 936 AudioMapping::dcp_to_source (libdcp::Channel c) const
 937 {
 938         if (_source_channels == 1) {
 939                 if (c == libdcp::CENTRE) {
 940                         return 0;
 941                 } else {
 942                         return optional<int> ();
 943                 }
 944         }
 945
 946         if (static_cast<int> (c) >= _source_channels) {
 947                 return optional<int> ();
 948         }
 949
 950         return static_cast<int> (c);
 951 }
 952
 953 int
 954 AudioMapping::dcp_channels () const
 955 {
 956         if (_source_channels == 1) {
 957                 /* The source is mono, so to put the mono channel into
 958                    the centre we need to generate a 5.1 soundtrack.
 959                 */
 960                 return 6;
 961         }
 962
 963         return _source_channels;
 964 }