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