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