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