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