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 boost::optional;
  87 using libdcp::Size;
  88
  89 boost::thread::id ui_thread;
  90
  91 /** Convert some number of seconds to a string representation
  92  *  in hours, minutes and seconds.
  93  *
  94  *  @param s Seconds.
  95  *  @return String of the form H:M:S (where H is hours, M
  96  *  is minutes and S is seconds).
  97  */
  98 string
  99 seconds_to_hms (int s)
 100 {
 101         int m = s / 60;
 102         s -= (m * 60);
 103         int h = m / 60;
 104         m -= (h * 60);
 105
 106         stringstream hms;
 107         hms << h << N_(":");
 108         hms.width (2);
 109         hms << std::setfill ('0') << m << N_(":");
 110         hms.width (2);
 111         hms << std::setfill ('0') << s;
 112
 113         return hms.str ();
 114 }
 115
 116 /** @param s Number of seconds.
 117  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 118  */
 119 string
 120 seconds_to_approximate_hms (int s)
 121 {
 122         int m = s / 60;
 123         s -= (m * 60);
 124         int h = m / 60;
 125         m -= (h * 60);
 126
 127         stringstream ap;
 128
 129         if (h > 0) {
 130                 if (m > 30) {
 131                         ap << (h + 1) << N_(" ") << _("hours");
 132                 } else {
 133                         if (h == 1) {
 134                                 ap << N_("1 ") << _("hour");
 135                         } else {
 136                                 ap << h << N_(" ") << _("hours");
 137                         }
 138                 }
 139         } else if (m > 0) {
 140                 if (m == 1) {
 141                         ap << N_("1 ") << _("minute");
 142                 } else {
 143                         ap << m << N_(" ") << _("minutes");
 144                 }
 145         } else {
 146                 ap << s << N_(" ") << _("seconds");
 147         }
 148
 149         return ap.str ();
 150 }
 151
 152 #ifdef DCPOMATIC_POSIX
 153 /** @param l Mangled C++ identifier.
 154  *  @return Demangled version.
 155  */
 156 static string
 157 demangle (string l)
 158 {
 159         string::size_type const b = l.find_first_of (N_("("));
 160         if (b == string::npos) {
 161                 return l;
 162         }
 163
 164         string::size_type const p = l.find_last_of (N_("+"));
 165         if (p == string::npos) {
 166                 return l;
 167         }
 168
 169         if ((p - b) <= 1) {
 170                 return l;
 171         }
 172
 173         string const fn = l.substr (b + 1, p - b - 1);
 174
 175         int status;
 176         try {
 177
 178                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 179                 string d (realname);
 180                 free (realname);
 181                 return d;
 182
 183         } catch (std::exception) {
 184
 185         }
 186
 187         return l;
 188 }
 189
 190 /** Write a stacktrace to an ostream.
 191  *  @param out Stream to write to.
 192  *  @param levels Number of levels to go up the call stack.
 193  */
 194 void
 195 stacktrace (ostream& out, int levels)
 196 {
 197         void *array[200];
 198         size_t size;
 199         char **strings;
 200         size_t i;
 201
 202         size = backtrace (array, 200);
 203         strings = backtrace_symbols (array, size);
 204
 205         if (strings) {
 206                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 207                         out << N_("  ") << demangle (strings[i]) << "\n";
 208                 }
 209
 210                 free (strings);
 211         }
 212 }
 213 #endif
 214
 215 /** @param v Version as used by FFmpeg.
 216  *  @return A string representation of v.
 217  */
 218 static string
 219 ffmpeg_version_to_string (int v)
 220 {
 221         stringstream s;
 222         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 223         return s.str ();
 224 }
 225
 226 /** Return a user-readable string summarising the versions of our dependencies */
 227 string
 228 dependency_version_summary ()
 229 {
 230         stringstream s;
 231         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 232           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 233           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 234           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 235           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 236           << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
 237           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 238           << MagickVersion << N_(", ")
 239           << N_("libssh ") << ssh_version (0) << N_(", ")
 240           << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
 241
 242         return s.str ();
 243 }
 244
 245 double
 246 seconds (struct timeval t)
 247 {
 248         return t.tv_sec + (double (t.tv_usec) / 1e6);
 249 }
 250
 251 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 252  *  Must be called from the UI thread, if there is one.
 253  */
 254 void
 255 dcpomatic_setup ()
 256 {
 257         avfilter_register_all ();
 258
 259         Format::setup_formats ();
 260         DCPContentType::setup_dcp_content_types ();
 261         Scaler::setup_scalers ();
 262         Filter::setup_filters ();
 263         SoundProcessor::setup_sound_processors ();
 264
 265         ui_thread = boost::this_thread::get_id ();
 266 }
 267
 268 #ifdef DCPOMATIC_WINDOWS
 269 boost::filesystem::path
 270 mo_path ()
 271 {
 272         wchar_t buffer[512];
 273         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 274         boost::filesystem::path p (buffer);
 275         p = p.parent_path ();
 276         p = p.parent_path ();
 277         p /= "locale";
 278         return p;
 279 }
 280 #endif
 281
 282 void
 283 dcpomatic_setup_gettext_i18n (string lang)
 284 {
 285 #ifdef DCPOMATIC_POSIX
 286         lang += ".UTF8";
 287 #endif
 288
 289         if (!lang.empty ()) {
 290                 /* Override our environment language; this is essential on
 291                    Windows.
 292                 */
 293                 char cmd[64];
 294                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 295                 putenv (cmd);
 296                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 297                 putenv (cmd);
 298         }
 299
 300         setlocale (LC_ALL, "");
 301         textdomain ("libdcpomatic");
 302
 303 #ifdef DCPOMATIC_WINDOWS
 304         bindtextdomain ("libdcpomatic", mo_path().string().c_str());
 305         bind_textdomain_codeset ("libdcpomatic", "UTF8");
 306 #endif
 307
 308 #ifdef DCPOMATIC_POSIX
 309         bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
 310 #endif
 311 }
 312
 313 /** @param start Start position for the crop within the image.
 314  *  @param size Size of the cropped area.
 315  *  @return FFmpeg crop filter string.
 316  */
 317 string
 318 crop_string (Position start, libdcp::Size size)
 319 {
 320         stringstream s;
 321         s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
 322         return s.str ();
 323 }
 324
 325 /** @param s A string.
 326  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 327  */
 328 vector<string>
 329 split_at_spaces_considering_quotes (string s)
 330 {
 331         vector<string> out;
 332         bool in_quotes = false;
 333         string c;
 334         for (string::size_type i = 0; i < s.length(); ++i) {
 335                 if (s[i] == ' ' && !in_quotes) {
 336                         out.push_back (c);
 337                         c = N_("");
 338                 } else if (s[i] == '"') {
 339                         in_quotes = !in_quotes;
 340                 } else {
 341                         c += s[i];
 342                 }
 343         }
 344
 345         out.push_back (c);
 346         return out;
 347 }
 348
 349 string
 350 md5_digest (void const * data, int size)
 351 {
 352         MD5_CTX md5_context;
 353         MD5_Init (&md5_context);
 354         MD5_Update (&md5_context, data, size);
 355         unsigned char digest[MD5_DIGEST_LENGTH];
 356         MD5_Final (digest, &md5_context);
 357
 358         stringstream s;
 359         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 360                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 361         }
 362
 363         return s.str ();
 364 }
 365
 366 /** @param file File name.
 367  *  @return MD5 digest of file's contents.
 368  */
 369 string
 370 md5_digest (boost::filesystem::path file)
 371 {
 372         ifstream f (file.string().c_str(), std::ios::binary);
 373         if (!f.good ()) {
 374                 throw OpenFileError (file.string());
 375         }
 376
 377         f.seekg (0, std::ios::end);
 378         int bytes = f.tellg ();
 379         f.seekg (0, std::ios::beg);
 380
 381         int const buffer_size = 64 * 1024;
 382         char buffer[buffer_size];
 383
 384         MD5_CTX md5_context;
 385         MD5_Init (&md5_context);
 386         while (bytes > 0) {
 387                 int const t = min (bytes, buffer_size);
 388                 f.read (buffer, t);
 389                 MD5_Update (&md5_context, buffer, t);
 390                 bytes -= t;
 391         }
 392
 393         unsigned char digest[MD5_DIGEST_LENGTH];
 394         MD5_Final (digest, &md5_context);
 395
 396         stringstream s;
 397         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 398                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 399         }
 400
 401         return s.str ();
 402 }
 403
 404 static bool
 405 about_equal (float a, float b)
 406 {
 407         /* A film of F seconds at f FPS will be Ff frames;
 408            Consider some delta FPS d, so if we run the same
 409            film at (f + d) FPS it will last F(f + d) seconds.
 410
 411            Hence the difference in length over the length of the film will
 412            be F(f + d) - Ff frames
 413             = Ff + Fd - Ff frames
 414             = Fd frames
 415             = Fd/f seconds
 416
 417            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 418            say that
 419
 420            1/f = Fd/f
 421         ie 1 = Fd
 422         ie d = 1/F
 423
 424            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 425            FPS error is 1/F ~= 0.0001 ~= 10-e4
 426         */
 427
 428         return (fabs (a - b) < 1e-4);
 429 }
 430
 431 class FrameRateCandidate
 432 {
 433 public:
 434         FrameRateCandidate (float source_, int dcp_)
 435                 : source (source_)
 436                 , dcp (dcp_)
 437         {}
 438
 439         float source;
 440         int dcp;
 441 };
 442
 443 int
 444 best_dcp_frame_rate (float source_fps)
 445 {
 446         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 447
 448         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 449         list<FrameRateCandidate> candidates;
 450
 451         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 452         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 453                 candidates.push_back (FrameRateCandidate (*i, *i));
 454         }
 455
 456         /* Then the skip/repeat ones */
 457         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 458                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 459                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 460         }
 461
 462         /* Pick the best one, bailing early if we hit an exact match */
 463         float error = std::numeric_limits<float>::max ();
 464         optional<FrameRateCandidate> best;
 465         list<FrameRateCandidate>::iterator i = candidates.begin();
 466         while (i != candidates.end()) {
 467
 468                 if (about_equal (i->source, source_fps)) {
 469                         best = *i;
 470                         break;
 471                 }
 472
 473                 float const e = fabs (i->source - source_fps);
 474                 if (e < error) {
 475                         error = e;
 476                         best = *i;
 477                 }
 478
 479                 ++i;
 480         }
 481
 482         assert (best);
 483         return best->dcp;
 484 }
 485
 486 /** @param An arbitrary sampling rate.
 487  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 488  */
 489 int
 490 dcp_audio_sample_rate (int fs)
 491 {
 492         if (fs <= 48000) {
 493                 return 48000;
 494         }
 495
 496         return 96000;
 497 }
 498
 499 /** @param index Colour LUT index.
 500  *  @return Human-readable name.
 501  */
 502 string
 503 colour_lut_index_to_name (int index)
 504 {
 505         switch (index) {
 506         case 0:
 507                 return _("sRGB");
 508         case 1:
 509                 return _("Rec 709");
 510         }
 511
 512         assert (false);
 513         return N_("");
 514 }
 515
 516 Socket::Socket (int timeout)
 517         : _deadline (_io_service)
 518         , _socket (_io_service)
 519         , _timeout (timeout)
 520 {
 521         _deadline.expires_at (boost::posix_time::pos_infin);
 522         check ();
 523 }
 524
 525 void
 526 Socket::check ()
 527 {
 528         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 529                 _socket.close ();
 530                 _deadline.expires_at (boost::posix_time::pos_infin);
 531         }
 532
 533         _deadline.async_wait (boost::bind (&Socket::check, this));
 534 }
 535
 536 /** Blocking connect.
 537  *  @param endpoint End-point to connect to.
 538  */
 539 void
 540 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
 541 {
 542         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 543         boost::system::error_code ec = boost::asio::error::would_block;
 544         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 545         do {
 546                 _io_service.run_one();
 547         } while (ec == boost::asio::error::would_block);
 548
 549         if (ec || !_socket.is_open ()) {
 550                 throw NetworkError (_("connect timed out"));
 551         }
 552 }
 553
 554 /** Blocking write.
 555  *  @param data Buffer to write.
 556  *  @param size Number of bytes to write.
 557  */
 558 void
 559 Socket::write (uint8_t const * data, int size)
 560 {
 561         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 562         boost::system::error_code ec = boost::asio::error::would_block;
 563
 564         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 565
 566         do {
 567                 _io_service.run_one ();
 568         } while (ec == boost::asio::error::would_block);
 569
 570         if (ec) {
 571                 throw NetworkError (ec.message ());
 572         }
 573 }
 574
 575 void
 576 Socket::write (uint32_t v)
 577 {
 578         v = htonl (v);
 579         write (reinterpret_cast<uint8_t*> (&v), 4);
 580 }
 581
 582 /** Blocking read.
 583  *  @param data Buffer to read to.
 584  *  @param size Number of bytes to read.
 585  */
 586 void
 587 Socket::read (uint8_t* data, int size)
 588 {
 589         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 590         boost::system::error_code ec = boost::asio::error::would_block;
 591
 592         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 593
 594         do {
 595                 _io_service.run_one ();
 596         } while (ec == boost::asio::error::would_block);
 597
 598         if (ec) {
 599                 throw NetworkError (ec.message ());
 600         }
 601 }
 602
 603 uint32_t
 604 Socket::read_uint32 ()
 605 {
 606         uint32_t v;
 607         read (reinterpret_cast<uint8_t *> (&v), 4);
 608         return ntohl (v);
 609 }
 610
 611 /** Round a number up to the nearest multiple of another number.
 612  *  @param c Index.
 613  *  @param s Array of numbers to round, indexed by c.
 614  *  @param t Multiple to round to.
 615  *  @return Rounded number.
 616  */
 617 int
 618 stride_round_up (int c, int const * stride, int t)
 619 {
 620         int const a = stride[c] + (t - 1);
 621         return a - (a % t);
 622 }
 623
 624 int
 625 stride_lookup (int c, int const * stride)
 626 {
 627         return stride[c];
 628 }
 629
 630 /** Read a sequence of key / value pairs from a text stream;
 631  *  the keys are the first words on the line, and the values are
 632  *  the remainder of the line following the key.  Lines beginning
 633  *  with # are ignored.
 634  *  @param s Stream to read.
 635  *  @return key/value pairs.
 636  */
 637 multimap<string, string>
 638 read_key_value (istream &s)
 639 {
 640         multimap<string, string> kv;
 641
 642         string line;
 643         while (getline (s, line)) {
 644                 if (line.empty ()) {
 645                         continue;
 646                 }
 647
 648                 if (line[0] == '#') {
 649                         continue;
 650                 }
 651
 652                 if (line[line.size() - 1] == '\r') {
 653                         line = line.substr (0, line.size() - 1);
 654                 }
 655
 656                 size_t const s = line.find (' ');
 657                 if (s == string::npos) {
 658                         continue;
 659                 }
 660
 661                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 662         }
 663
 664         return kv;
 665 }
 666
 667 string
 668 get_required_string (multimap<string, string> const & kv, string k)
 669 {
 670         if (kv.count (k) > 1) {
 671                 throw StringError (N_("unexpected multiple keys in key-value set"));
 672         }
 673
 674         multimap<string, string>::const_iterator i = kv.find (k);
 675
 676         if (i == kv.end ()) {
 677                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 678         }
 679
 680         return i->second;
 681 }
 682
 683 int
 684 get_required_int (multimap<string, string> const & kv, string k)
 685 {
 686         string const v = get_required_string (kv, k);
 687         return lexical_cast<int> (v);
 688 }
 689
 690 float
 691 get_required_float (multimap<string, string> const & kv, string k)
 692 {
 693         string const v = get_required_string (kv, k);
 694         return lexical_cast<float> (v);
 695 }
 696
 697 string
 698 get_optional_string (multimap<string, string> const & kv, string k)
 699 {
 700         if (kv.count (k) > 1) {
 701                 throw StringError (N_("unexpected multiple keys in key-value set"));
 702         }
 703
 704         multimap<string, string>::const_iterator i = kv.find (k);
 705         if (i == kv.end ()) {
 706                 return N_("");
 707         }
 708
 709         return i->second;
 710 }
 711
 712 int
 713 get_optional_int (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 0;
 722         }
 723
 724         return lexical_cast<int> (i->second);
 725 }
 726
 727 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 728  *  @param channels Number of channels.
 729  *  @param frames Number of frames to reserve space for.
 730  */
 731 AudioBuffers::AudioBuffers (int channels, int frames)
 732         : _channels (channels)
 733         , _frames (frames)
 734         , _allocated_frames (frames)
 735 {
 736         _data = new float*[_channels];
 737         for (int i = 0; i < _channels; ++i) {
 738                 _data[i] = new float[frames];
 739         }
 740 }
 741
 742 /** Copy constructor.
 743  *  @param other Other AudioBuffers; data is copied.
 744  */
 745 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 746         : _channels (other._channels)
 747         , _frames (other._frames)
 748         , _allocated_frames (other._frames)
 749 {
 750         _data = new float*[_channels];
 751         for (int i = 0; i < _channels; ++i) {
 752                 _data[i] = new float[_frames];
 753                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 754         }
 755 }
 756
 757 /* XXX: it's a shame that this is a copy-and-paste of the above;
 758    probably fixable with c++0x.
 759 */
 760 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> 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<const 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 }