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