src/lib/util.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file src/lib/util.cc
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #include <sstream>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <fstream>
  29 #include <climits>
  30 #ifdef DCPOMATIC_POSIX
  31 #include <execinfo.h>
  32 #include <cxxabi.h>
  33 #endif
  34 #include <libssh/libssh.h>
  35 #include <signal.h>
  36 #include <boost/algorithm/string.hpp>
  37 #include <boost/bind.hpp>
  38 #include <boost/lambda/lambda.hpp>
  39 #include <boost/lexical_cast.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/filesystem.hpp>
  42 #include <glib.h>
  43 #include <openjpeg.h>
  44 #include <openssl/md5.h>
  45 #include <magick/MagickCore.h>
  46 #include <magick/version.h>
  47 #include <libdcp/version.h>
  48 #include <libdcp/util.h>
  49 #include <libdcp/signer_chain.h>
  50 #include <libdcp/signer.h>
  51 extern "C" {
  52 #include <libavcodec/avcodec.h>
  53 #include <libavformat/avformat.h>
  54 #include <libswscale/swscale.h>
  55 #include <libavfilter/avfiltergraph.h>
  56 #include <libpostproc/postprocess.h>
  57 #include <libavutil/pixfmt.h>
  58 }
  59 #include "util.h"
  60 #include "exceptions.h"
  61 #include "scaler.h"
  62 #include "dcp_content_type.h"
  63 #include "filter.h"
  64 #include "sound_processor.h"
  65 #include "config.h"
  66 #include "ratio.h"
  67 #include "job.h"
  68 #include "cross.h"
  69 #ifdef DCPOMATIC_WINDOWS
  70 #include "stack.hpp"
  71 #endif
  72
  73 #include "i18n.h"
  74
  75 using std::string;
  76 using std::stringstream;
  77 using std::setfill;
  78 using std::ostream;
  79 using std::endl;
  80 using std::vector;
  81 using std::hex;
  82 using std::setw;
  83 using std::ifstream;
  84 using std::ios;
  85 using std::min;
  86 using std::max;
  87 using std::list;
  88 using std::multimap;
  89 using std::istream;
  90 using std::numeric_limits;
  91 using std::pair;
  92 using std::cout;
  93 using boost::shared_ptr;
  94 using boost::thread;
  95 using boost::lexical_cast;
  96 using boost::optional;
  97 using libdcp::Size;
  98
  99 static boost::thread::id ui_thread;
 100 static boost::filesystem::path backtrace_file;
 101
 102 /** Convert some number of seconds to a string representation
 103  *  in hours, minutes and seconds.
 104  *
 105  *  @param s Seconds.
 106  *  @return String of the form H:M:S (where H is hours, M
 107  *  is minutes and S is seconds).
 108  */
 109 string
 110 seconds_to_hms (int s)
 111 {
 112         int m = s / 60;
 113         s -= (m * 60);
 114         int h = m / 60;
 115         m -= (h * 60);
 116
 117         stringstream hms;
 118         hms << h << N_(":");
 119         hms.width (2);
 120         hms << std::setfill ('0') << m << N_(":");
 121         hms.width (2);
 122         hms << std::setfill ('0') << s;
 123
 124         return hms.str ();
 125 }
 126
 127 /** @param s Number of seconds.
 128  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 129  */
 130 string
 131 seconds_to_approximate_hms (int s)
 132 {
 133         int m = s / 60;
 134         s -= (m * 60);
 135         int h = m / 60;
 136         m -= (h * 60);
 137
 138         stringstream ap;
 139
 140         if (h > 0) {
 141                 if (m > 30) {
 142                         ap << (h + 1) << N_(" ") << _("hours");
 143                 } else {
 144                         if (h == 1) {
 145                                 ap << N_("1 ") << _("hour");
 146                         } else {
 147                                 ap << h << N_(" ") << _("hours");
 148                         }
 149                 }
 150         } else if (m > 0) {
 151                 if (m == 1) {
 152                         ap << N_("1 ") << _("minute");
 153                 } else {
 154                         ap << m << N_(" ") << _("minutes");
 155                 }
 156         } else {
 157                 ap << s << N_(" ") << _("seconds");
 158         }
 159
 160         return ap.str ();
 161 }
 162
 163 #ifdef DCPOMATIC_POSIX
 164 /** @param l Mangled C++ identifier.
 165  *  @return Demangled version.
 166  */
 167 static string
 168 demangle (string l)
 169 {
 170         string::size_type const b = l.find_first_of (N_("("));
 171         if (b == string::npos) {
 172                 return l;
 173         }
 174
 175         string::size_type const p = l.find_last_of (N_("+"));
 176         if (p == string::npos) {
 177                 return l;
 178         }
 179
 180         if ((p - b) <= 1) {
 181                 return l;
 182         }
 183
 184         string const fn = l.substr (b + 1, p - b - 1);
 185
 186         int status;
 187         try {
 188
 189                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 190                 string d (realname);
 191                 free (realname);
 192                 return d;
 193
 194         } catch (std::exception) {
 195
 196         }
 197
 198         return l;
 199 }
 200
 201 /** Write a stacktrace to an ostream.
 202  *  @param out Stream to write to.
 203  *  @param levels Number of levels to go up the call stack.
 204  */
 205 void
 206 stacktrace (ostream& out, int levels)
 207 {
 208         void *array[200];
 209         size_t size = backtrace (array, 200);
 210         char** strings = backtrace_symbols (array, size);
 211
 212         if (strings) {
 213                 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 214                         out << N_("  ") << demangle (strings[i]) << "\n";
 215                 }
 216
 217                 free (strings);
 218         }
 219 }
 220 #endif
 221
 222 /** @param v Version as used by FFmpeg.
 223  *  @return A string representation of v.
 224  */
 225 static string
 226 ffmpeg_version_to_string (int v)
 227 {
 228         stringstream s;
 229         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 230         return s.str ();
 231 }
 232
 233 /** Return a user-readable string summarising the versions of our dependencies */
 234 string
 235 dependency_version_summary ()
 236 {
 237         stringstream s;
 238         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 239           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 240           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 241           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 242           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 243           << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
 244           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 245           << MagickVersion << N_(", ")
 246           << N_("libssh ") << ssh_version (0) << N_(", ")
 247           << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
 248
 249         return s.str ();
 250 }
 251
 252 double
 253 seconds (struct timeval t)
 254 {
 255         return t.tv_sec + (double (t.tv_usec) / 1e6);
 256 }
 257
 258 #ifdef DCPOMATIC_WINDOWS
 259 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
 260 {
 261         dbg::stack s;
 262         FILE* f = fopen_boost (backtrace_file, "w");
 263         for (dbg::stack_frame::const_iterator i = s.begin(); i != s.end(); ++i) {
 264                 fprintf (f, "%p %s %d %s", i->instruction, i->function.c_str(), i->line, i->module.c_str());
 265         }
 266         fclose (f);
 267         return EXCEPTION_CONTINUE_SEARCH;
 268 }
 269 #endif
 270
 271 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 272  *  Must be called from the UI thread, if there is one.
 273  */
 274 void
 275 dcpomatic_setup ()
 276 {
 277 #ifdef DCPOMATIC_WINDOWS
 278         backtrace_file /= g_get_user_config_dir ();
 279         backtrace_file /= "backtrace.txt";
 280         SetUnhandledExceptionFilter(exception_handler);
 281 #endif
 282
 283         avfilter_register_all ();
 284
 285 #ifdef DCPOMATIC_OSX
 286         /* Add our lib directory to the libltdl search path so that
 287            xmlsec can find xmlsec1-openssl.
 288         */
 289         boost::filesystem::path lib = app_contents ();
 290         lib /= "lib";
 291         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 292 #endif
 293
 294         libdcp::init ();
 295
 296         Ratio::setup_ratios ();
 297         DCPContentType::setup_dcp_content_types ();
 298         Scaler::setup_scalers ();
 299         Filter::setup_filters ();
 300         SoundProcessor::setup_sound_processors ();
 301
 302         ui_thread = boost::this_thread::get_id ();
 303 }
 304
 305 #ifdef DCPOMATIC_WINDOWS
 306 boost::filesystem::path
 307 mo_path ()
 308 {
 309         wchar_t buffer[512];
 310         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 311         boost::filesystem::path p (buffer);
 312         p = p.parent_path ();
 313         p = p.parent_path ();
 314         p /= "locale";
 315         return p;
 316 }
 317 #endif
 318
 319 void
 320 dcpomatic_setup_gettext_i18n (string lang)
 321 {
 322 #ifdef DCPOMATIC_POSIX
 323         lang += ".UTF8";
 324 #endif
 325
 326         if (!lang.empty ()) {
 327                 /* Override our environment language; this is essential on
 328                    Windows.
 329                 */
 330                 char cmd[64];
 331                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 332                 putenv (cmd);
 333                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 334                 putenv (cmd);
 335         }
 336
 337         setlocale (LC_ALL, "");
 338         textdomain ("libdcpomatic");
 339
 340 #ifdef DCPOMATIC_WINDOWS
 341         bindtextdomain ("libdcpomatic", mo_path().string().c_str());
 342         bind_textdomain_codeset ("libdcpomatic", "UTF8");
 343 #endif
 344
 345 #ifdef DCPOMATIC_POSIX
 346         bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
 347 #endif
 348 }
 349
 350 /** @param s A string.
 351  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 352  */
 353 vector<string>
 354 split_at_spaces_considering_quotes (string s)
 355 {
 356         vector<string> out;
 357         bool in_quotes = false;
 358         string c;
 359         for (string::size_type i = 0; i < s.length(); ++i) {
 360                 if (s[i] == ' ' && !in_quotes) {
 361                         out.push_back (c);
 362                         c = N_("");
 363                 } else if (s[i] == '"') {
 364                         in_quotes = !in_quotes;
 365                 } else {
 366                         c += s[i];
 367                 }
 368         }
 369
 370         out.push_back (c);
 371         return out;
 372 }
 373
 374 string
 375 md5_digest (void const * data, int size)
 376 {
 377         MD5_CTX md5_context;
 378         MD5_Init (&md5_context);
 379         MD5_Update (&md5_context, data, size);
 380         unsigned char digest[MD5_DIGEST_LENGTH];
 381         MD5_Final (digest, &md5_context);
 382
 383         stringstream s;
 384         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 385                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 386         }
 387
 388         return s.str ();
 389 }
 390
 391 /** @param file File name.
 392  *  @return MD5 digest of file's contents.
 393  */
 394 string
 395 md5_digest (boost::filesystem::path file)
 396 {
 397         ifstream f (file.string().c_str(), std::ios::binary);
 398         if (!f.good ()) {
 399                 throw OpenFileError (file.string());
 400         }
 401
 402         f.seekg (0, std::ios::end);
 403         int bytes = f.tellg ();
 404         f.seekg (0, std::ios::beg);
 405
 406         int const buffer_size = 64 * 1024;
 407         char buffer[buffer_size];
 408
 409         MD5_CTX md5_context;
 410         MD5_Init (&md5_context);
 411         while (bytes > 0) {
 412                 int const t = min (bytes, buffer_size);
 413                 f.read (buffer, t);
 414                 MD5_Update (&md5_context, buffer, t);
 415                 bytes -= t;
 416         }
 417
 418         unsigned char digest[MD5_DIGEST_LENGTH];
 419         MD5_Final (digest, &md5_context);
 420
 421         stringstream s;
 422         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 423                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 424         }
 425
 426         return s.str ();
 427 }
 428
 429 /** @param job Optional job for which to report progress */
 430 string
 431 md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
 432 {
 433         int const buffer_size = 64 * 1024;
 434         char buffer[buffer_size];
 435
 436         MD5_CTX md5_context;
 437         MD5_Init (&md5_context);
 438
 439         int files = 0;
 440         if (job) {
 441                 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
 442                         ++files;
 443                 }
 444         }
 445
 446         int j = 0;
 447         for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
 448                 ifstream f (i->path().string().c_str(), std::ios::binary);
 449                 if (!f.good ()) {
 450                         throw OpenFileError (i->path().string());
 451                 }
 452
 453                 f.seekg (0, std::ios::end);
 454                 int bytes = f.tellg ();
 455                 f.seekg (0, std::ios::beg);
 456
 457                 while (bytes > 0) {
 458                         int const t = min (bytes, buffer_size);
 459                         f.read (buffer, t);
 460                         MD5_Update (&md5_context, buffer, t);
 461                         bytes -= t;
 462                 }
 463
 464                 if (job) {
 465                         job->set_progress (float (j) / files);
 466                         ++j;
 467                 }
 468         }
 469
 470         unsigned char digest[MD5_DIGEST_LENGTH];
 471         MD5_Final (digest, &md5_context);
 472
 473         stringstream s;
 474         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 475                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 476         }
 477
 478         return s.str ();
 479 }
 480
 481 static bool
 482 about_equal (float a, float b)
 483 {
 484         /* A film of F seconds at f FPS will be Ff frames;
 485            Consider some delta FPS d, so if we run the same
 486            film at (f + d) FPS it will last F(f + d) seconds.
 487
 488            Hence the difference in length over the length of the film will
 489            be F(f + d) - Ff frames
 490             = Ff + Fd - Ff frames
 491             = Fd frames
 492             = Fd/f seconds
 493
 494            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 495            say that
 496
 497            1/f = Fd/f
 498         ie 1 = Fd
 499         ie d = 1/F
 500
 501            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 502            FPS error is 1/F ~= 0.0001 ~= 10-e4
 503         */
 504
 505         return (fabs (a - b) < 1e-4);
 506 }
 507
 508 /** @param An arbitrary audio frame rate.
 509  *  @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
 510  */
 511 int
 512 dcp_audio_frame_rate (int fs)
 513 {
 514         if (fs <= 48000) {
 515                 return 48000;
 516         }
 517
 518         return 96000;
 519 }
 520
 521 Socket::Socket (int timeout)
 522         : _deadline (_io_service)
 523         , _socket (_io_service)
 524         , _acceptor (0)
 525         , _timeout (timeout)
 526 {
 527         _deadline.expires_at (boost::posix_time::pos_infin);
 528         check ();
 529 }
 530
 531 Socket::~Socket ()
 532 {
 533         delete _acceptor;
 534 }
 535
 536 void
 537 Socket::check ()
 538 {
 539         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 540                 if (_acceptor) {
 541                         _acceptor->cancel ();
 542                 } else {
 543                         _socket.close ();
 544                 }
 545                 _deadline.expires_at (boost::posix_time::pos_infin);
 546         }
 547
 548         _deadline.async_wait (boost::bind (&Socket::check, this));
 549 }
 550
 551 /** Blocking connect.
 552  *  @param endpoint End-point to connect to.
 553  */
 554 void
 555 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
 556 {
 557         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 558         boost::system::error_code ec = boost::asio::error::would_block;
 559         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 560         do {
 561                 _io_service.run_one();
 562         } while (ec == boost::asio::error::would_block);
 563
 564         if (ec) {
 565                 throw NetworkError (ec.message ());
 566         }
 567
 568         if (!_socket.is_open ()) {
 569                 throw NetworkError (_("connect timed out"));
 570         }
 571 }
 572
 573 void
 574 Socket::accept (int port)
 575 {
 576         _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
 577
 578         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 579         boost::system::error_code ec = boost::asio::error::would_block;
 580         _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
 581         do {
 582                 _io_service.run_one ();
 583         } while (ec == boost::asio::error::would_block );
 584
 585         delete _acceptor;
 586         _acceptor = 0;
 587
 588         if (ec) {
 589                 throw NetworkError (ec.message ());
 590         }
 591 }
 592
 593 /** Blocking write.
 594  *  @param data Buffer to write.
 595  *  @param size Number of bytes to write.
 596  */
 597 void
 598 Socket::write (uint8_t const * data, int size)
 599 {
 600         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 601         boost::system::error_code ec = boost::asio::error::would_block;
 602
 603         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 604
 605         do {
 606                 _io_service.run_one ();
 607         } while (ec == boost::asio::error::would_block);
 608
 609         if (ec) {
 610                 throw NetworkError (ec.message ());
 611         }
 612 }
 613
 614 void
 615 Socket::write (uint32_t v)
 616 {
 617         v = htonl (v);
 618         write (reinterpret_cast<uint8_t*> (&v), 4);
 619 }
 620
 621 /** Blocking read.
 622  *  @param data Buffer to read to.
 623  *  @param size Number of bytes to read.
 624  */
 625 void
 626 Socket::read (uint8_t* data, int size)
 627 {
 628         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 629         boost::system::error_code ec = boost::asio::error::would_block;
 630
 631         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 632
 633         do {
 634                 _io_service.run_one ();
 635         } while (ec == boost::asio::error::would_block);
 636
 637         if (ec) {
 638                 throw NetworkError (ec.message ());
 639         }
 640 }
 641
 642 uint32_t
 643 Socket::read_uint32 ()
 644 {
 645         uint32_t v;
 646         read (reinterpret_cast<uint8_t *> (&v), 4);
 647         return ntohl (v);
 648 }
 649
 650 /** Round a number up to the nearest multiple of another number.
 651  *  @param c Index.
 652  *  @param s Array of numbers to round, indexed by c.
 653  *  @param t Multiple to round to.
 654  *  @return Rounded number.
 655  */
 656 int
 657 stride_round_up (int c, int const * stride, int t)
 658 {
 659         int const a = stride[c] + (t - 1);
 660         return a - (a % t);
 661 }
 662
 663 /** Read a sequence of key / value pairs from a text stream;
 664  *  the keys are the first words on the line, and the values are
 665  *  the remainder of the line following the key.  Lines beginning
 666  *  with # are ignored.
 667  *  @param s Stream to read.
 668  *  @return key/value pairs.
 669  */
 670 multimap<string, string>
 671 read_key_value (istream &s)
 672 {
 673         multimap<string, string> kv;
 674
 675         string line;
 676         while (getline (s, line)) {
 677                 if (line.empty ()) {
 678                         continue;
 679                 }
 680
 681                 if (line[0] == '#') {
 682                         continue;
 683                 }
 684
 685                 if (line[line.size() - 1] == '\r') {
 686                         line = line.substr (0, line.size() - 1);
 687                 }
 688
 689                 size_t const s = line.find (' ');
 690                 if (s == string::npos) {
 691                         continue;
 692                 }
 693
 694                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 695         }
 696
 697         return kv;
 698 }
 699
 700 string
 701 get_required_string (multimap<string, string> const & kv, string k)
 702 {
 703         if (kv.count (k) > 1) {
 704                 throw StringError (N_("unexpected multiple keys in key-value set"));
 705         }
 706
 707         multimap<string, string>::const_iterator i = kv.find (k);
 708
 709         if (i == kv.end ()) {
 710                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 711         }
 712
 713         return i->second;
 714 }
 715
 716 int
 717 get_required_int (multimap<string, string> const & kv, string k)
 718 {
 719         string const v = get_required_string (kv, k);
 720         return lexical_cast<int> (v);
 721 }
 722
 723 float
 724 get_required_float (multimap<string, string> const & kv, string k)
 725 {
 726         string const v = get_required_string (kv, k);
 727         return lexical_cast<float> (v);
 728 }
 729
 730 string
 731 get_optional_string (multimap<string, string> const & kv, string k)
 732 {
 733         if (kv.count (k) > 1) {
 734                 throw StringError (N_("unexpected multiple keys in key-value set"));
 735         }
 736
 737         multimap<string, string>::const_iterator i = kv.find (k);
 738         if (i == kv.end ()) {
 739                 return N_("");
 740         }
 741
 742         return i->second;
 743 }
 744
 745 int
 746 get_optional_int (multimap<string, string> const & kv, string k)
 747 {
 748         if (kv.count (k) > 1) {
 749                 throw StringError (N_("unexpected multiple keys in key-value set"));
 750         }
 751
 752         multimap<string, string>::const_iterator i = kv.find (k);
 753         if (i == kv.end ()) {
 754                 return 0;
 755         }
 756
 757         return lexical_cast<int> (i->second);
 758 }
 759
 760 /** Trip an assert if the caller is not in the UI thread */
 761 void
 762 ensure_ui_thread ()
 763 {
 764         assert (boost::this_thread::get_id() == ui_thread);
 765 }
 766
 767 /** @param v Content video frame.
 768  *  @param audio_sample_rate Source audio sample rate.
 769  *  @param frames_per_second Number of video frames per second.
 770  *  @return Equivalent number of audio frames for `v'.
 771  */
 772 int64_t
 773 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
 774 {
 775         return ((int64_t) v * audio_sample_rate / frames_per_second);
 776 }
 777
 778 string
 779 audio_channel_name (int c)
 780 {
 781         assert (MAX_AUDIO_CHANNELS == 6);
 782
 783         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 784            enhancement channel (sub-woofer).
 785         */
 786         string const channels[] = {
 787                 _("Left"),
 788                 _("Right"),
 789                 _("Centre"),
 790                 _("Lfe (sub)"),
 791                 _("Left surround"),
 792                 _("Right surround"),
 793         };
 794
 795         return channels[c];
 796 }
 797
 798 FrameRateConversion::FrameRateConversion (float source, int dcp)
 799         : skip (false)
 800         , repeat (1)
 801         , change_speed (false)
 802 {
 803         if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
 804                 /* The difference between source and DCP frame rate will be lower
 805                    (i.e. better) if we skip.
 806                 */
 807                 skip = true;
 808         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
 809                 /* The difference between source and DCP frame rate would be better
 810                    if we repeated each frame once; it may be better still if we
 811                    repeated more than once.  Work out the required repeat.
 812                 */
 813                 repeat = round (dcp / source);
 814         }
 815
 816         change_speed = !about_equal (source * factor(), dcp);
 817
 818         if (!skip && repeat == 1 && !change_speed) {
 819                 description = _("Content and DCP have the same rate.\n");
 820         } else {
 821                 if (skip) {
 822                         description = _("DCP will use every other frame of the content.\n");
 823                 } else if (repeat == 2) {
 824                         description = _("Each content frame will be doubled in the DCP.\n");
 825                 } else if (repeat > 2) {
 826                         description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
 827                 }
 828
 829                 if (change_speed) {
 830                         float const pc = dcp * 100 / (source * factor());
 831                         description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
 832                 }
 833         }
 834 }
 835
 836 LocaleGuard::LocaleGuard ()
 837         : _old (0)
 838 {
 839         char const * old = setlocale (LC_NUMERIC, 0);
 840
 841         if (old) {
 842                 _old = strdup (old);
 843                 if (strcmp (_old, "C")) {
 844                         setlocale (LC_NUMERIC, "C");
 845                 }
 846         }
 847 }
 848
 849 LocaleGuard::~LocaleGuard ()
 850 {
 851         setlocale (LC_NUMERIC, _old);
 852         free (_old);
 853 }
 854
 855 bool
 856 valid_image_file (boost::filesystem::path f)
 857 {
 858         string ext = f.extension().string();
 859         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 860         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
 861 }
 862
 863 string
 864 tidy_for_filename (string f)
 865 {
 866         string t;
 867         for (size_t i = 0; i < f.length(); ++i) {
 868                 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
 869                         t += f[i];
 870                 } else {
 871                         t += '_';
 872                 }
 873         }
 874
 875         return t;
 876 }
 877
 878 shared_ptr<const libdcp::Signer>
 879 make_signer ()
 880 {
 881         boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
 882
 883         /* Remake the chain if any of it is missing */
 884
 885         list<boost::filesystem::path> files;
 886         files.push_back ("ca.self-signed.pem");
 887         files.push_back ("intermediate.signed.pem");
 888         files.push_back ("leaf.signed.pem");
 889         files.push_back ("leaf.key");
 890
 891         list<boost::filesystem::path>::const_iterator i = files.begin();
 892         while (i != files.end()) {
 893                 boost::filesystem::path p (sd);
 894                 p /= *i;
 895                 if (!boost::filesystem::exists (p)) {
 896                         boost::filesystem::remove_all (sd);
 897                         boost::filesystem::create_directories (sd);
 898                         libdcp::make_signer_chain (sd, openssl_path ());
 899                         break;
 900                 }
 901
 902                 ++i;
 903         }
 904
 905         libdcp::CertificateChain chain;
 906
 907         {
 908                 boost::filesystem::path p (sd);
 909                 p /= "ca.self-signed.pem";
 910                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 911         }
 912
 913         {
 914                 boost::filesystem::path p (sd);
 915                 p /= "intermediate.signed.pem";
 916                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 917         }
 918
 919         {
 920                 boost::filesystem::path p (sd);
 921                 p /= "leaf.signed.pem";
 922                 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
 923         }
 924
 925         boost::filesystem::path signer_key (sd);
 926         signer_key /= "leaf.key";
 927
 928         return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));
 929 }
 930
 931 libdcp::Size
 932 fit_ratio_within (float ratio, libdcp::Size full_frame)
 933 {
 934         if (ratio < full_frame.ratio ()) {
 935                 return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
 936         }
 937
 938         return libdcp::Size (full_frame.width, rint (full_frame.width / ratio));
 939 }