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 <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 extern "C" {
  49 #include <libavcodec/avcodec.h>
  50 #include <libavformat/avformat.h>
  51 #include <libswscale/swscale.h>
  52 #include <libavfilter/avfiltergraph.h>
  53 #include <libpostproc/postprocess.h>
  54 #include <libavutil/pixfmt.h>
  55 }
  56 #include "util.h"
  57 #include "exceptions.h"
  58 #include "scaler.h"
  59 #include "format.h"
  60 #include "dcp_content_type.h"
  61 #include "filter.h"
  62 #include "sound_processor.h"
  63 #include "config.h"
  64 #include "film.h"
  65 #ifdef DVDOMATIC_WINDOWS
  66 #include "stack.hpp"
  67 #endif
  68
  69 #include "i18n.h"
  70
  71 using std::cout;
  72 using std::string;
  73 using std::stringstream;
  74 using std::list;
  75 using std::ostream;
  76 using std::vector;
  77 using std::ifstream;
  78 using std::istream;
  79 using std::min;
  80 using std::max;
  81 using std::multimap;
  82 using std::pair;
  83 using std::ofstream;
  84 using boost::shared_ptr;
  85 using boost::lexical_cast;
  86 using boost::optional;
  87 using libdcp::Size;
  88
  89 boost::thread::id ui_thread;
  90 boost::filesystem::path backtrace_file;
  91
  92 /** Convert some number of seconds to a string representation
  93  *  in hours, minutes and seconds.
  94  *
  95  *  @param s Seconds.
  96  *  @return String of the form H:M:S (where H is hours, M
  97  *  is minutes and S is seconds).
  98  */
  99 string
 100 seconds_to_hms (int s)
 101 {
 102         int m = s / 60;
 103         s -= (m * 60);
 104         int h = m / 60;
 105         m -= (h * 60);
 106
 107         stringstream hms;
 108         hms << h << N_(":");
 109         hms.width (2);
 110         hms << std::setfill ('0') << m << N_(":");
 111         hms.width (2);
 112         hms << std::setfill ('0') << s;
 113
 114         return hms.str ();
 115 }
 116
 117 /** @param s Number of seconds.
 118  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 119  */
 120 string
 121 seconds_to_approximate_hms (int s)
 122 {
 123         int m = s / 60;
 124         s -= (m * 60);
 125         int h = m / 60;
 126         m -= (h * 60);
 127
 128         stringstream ap;
 129
 130         if (h > 0) {
 131                 if (m > 30) {
 132                         ap << (h + 1) << N_(" ") << _("hours");
 133                 } else {
 134                         if (h == 1) {
 135                                 ap << N_("1 ") << _("hour");
 136                         } else {
 137                                 ap << h << N_(" ") << _("hours");
 138                         }
 139                 }
 140         } else if (m > 0) {
 141                 if (m == 1) {
 142                         ap << N_("1 ") << _("minute");
 143                 } else {
 144                         ap << m << N_(" ") << _("minutes");
 145                 }
 146         } else {
 147                 ap << s << N_(" ") << _("seconds");
 148         }
 149
 150         return ap.str ();
 151 }
 152
 153 #ifdef DVDOMATIC_POSIX
 154 /** @param l Mangled C++ identifier.
 155  *  @return Demangled version.
 156  */
 157 static string
 158 demangle (string l)
 159 {
 160         string::size_type const b = l.find_first_of (N_("("));
 161         if (b == string::npos) {
 162                 return l;
 163         }
 164
 165         string::size_type const p = l.find_last_of (N_("+"));
 166         if (p == string::npos) {
 167                 return l;
 168         }
 169
 170         if ((p - b) <= 1) {
 171                 return l;
 172         }
 173
 174         string const fn = l.substr (b + 1, p - b - 1);
 175
 176         int status;
 177         try {
 178
 179                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 180                 string d (realname);
 181                 free (realname);
 182                 return d;
 183
 184         } catch (std::exception) {
 185
 186         }
 187
 188         return l;
 189 }
 190
 191 /** Write a stacktrace to an ostream.
 192  *  @param out Stream to write to.
 193  *  @param levels Number of levels to go up the call stack.
 194  */
 195 void
 196 stacktrace (ostream& out, int levels)
 197 {
 198         void *array[200];
 199         size_t size;
 200         char **strings;
 201         size_t i;
 202
 203         size = backtrace (array, 200);
 204         strings = backtrace_symbols (array, size);
 205
 206         if (strings) {
 207                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 208                         out << N_("  ") << demangle (strings[i]) << "\n";
 209                 }
 210
 211                 free (strings);
 212         }
 213 }
 214 #endif
 215
 216 /** @param v Version as used by FFmpeg.
 217  *  @return A string representation of v.
 218  */
 219 static string
 220 ffmpeg_version_to_string (int v)
 221 {
 222         stringstream s;
 223         s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
 224         return s.str ();
 225 }
 226
 227 /** Return a user-readable string summarising the versions of our dependencies */
 228 string
 229 dependency_version_summary ()
 230 {
 231         stringstream s;
 232         s << N_("libopenjpeg ") << opj_version () << N_(", ")
 233           << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
 234           << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
 235           << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
 236           << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
 237           << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
 238           << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
 239           << MagickVersion << N_(", ")
 240           << N_("libssh ") << ssh_version (0) << N_(", ")
 241           << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
 242
 243         return s.str ();
 244 }
 245
 246 double
 247 seconds (struct timeval t)
 248 {
 249         return t.tv_sec + (double (t.tv_usec) / 1e6);
 250 }
 251
 252 #ifdef DVDOMATIC_WINDOWS
 253 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
 254 {
 255         dbg::stack s;
 256         ofstream f (backtrace_file.string().c_str());
 257         std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
 258         return EXCEPTION_CONTINUE_SEARCH;
 259 }
 260 #endif
 261
 262 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
 263  *  Must be called from the UI thread, if there is one.
 264  */
 265 void
 266 dvdomatic_setup ()
 267 {
 268 #ifdef DVDOMATIC_WINDOWS
 269         backtrace_file /= g_get_user_config_dir ();
 270         backtrace_file /= "backtrace.txt";
 271         SetUnhandledExceptionFilter(exception_handler);
 272 #endif
 273
 274         avfilter_register_all ();
 275
 276         Format::setup_formats ();
 277         DCPContentType::setup_dcp_content_types ();
 278         Scaler::setup_scalers ();
 279         Filter::setup_filters ();
 280         SoundProcessor::setup_sound_processors ();
 281
 282         ui_thread = boost::this_thread::get_id ();
 283 }
 284
 285 #ifdef DVDOMATIC_WINDOWS
 286 boost::filesystem::path
 287 mo_path ()
 288 {
 289         wchar_t buffer[512];
 290         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 291         boost::filesystem::path p (buffer);
 292         p = p.parent_path ();
 293         p = p.parent_path ();
 294         p /= "locale";
 295         return p;
 296 }
 297 #endif
 298
 299 void
 300 dvdomatic_setup_gettext_i18n (string lang)
 301 {
 302 #ifdef DVDOMATIC_POSIX
 303         lang += ".UTF8";
 304 #endif
 305
 306         if (!lang.empty ()) {
 307                 /* Override our environment language; this is essential on
 308                    Windows.
 309                 */
 310                 char cmd[64];
 311                 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
 312                 putenv (cmd);
 313                 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
 314                 putenv (cmd);
 315         }
 316
 317         setlocale (LC_ALL, "");
 318         textdomain ("libdvdomatic");
 319
 320 #ifdef DVDOMATIC_WINDOWS
 321         bindtextdomain ("libdvdomatic", mo_path().string().c_str());
 322         bind_textdomain_codeset ("libdvdomatic", "UTF8");
 323 #endif
 324
 325 #ifdef DVDOMATIC_POSIX
 326         bindtextdomain ("libdvdomatic", POSIX_LOCALE_PREFIX);
 327 #endif
 328 }
 329
 330 /** @param start Start position for the crop within the image.
 331  *  @param size Size of the cropped area.
 332  *  @return FFmpeg crop filter string.
 333  */
 334 string
 335 crop_string (Position start, libdcp::Size size)
 336 {
 337         stringstream s;
 338         s << N_("crop=") << size.width << N_(":") << size.height << N_(":") << start.x << N_(":") << start.y;
 339         return s.str ();
 340 }
 341
 342 /** @param s A string.
 343  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 344  */
 345 vector<string>
 346 split_at_spaces_considering_quotes (string s)
 347 {
 348         vector<string> out;
 349         bool in_quotes = false;
 350         string c;
 351         for (string::size_type i = 0; i < s.length(); ++i) {
 352                 if (s[i] == ' ' && !in_quotes) {
 353                         out.push_back (c);
 354                         c = N_("");
 355                 } else if (s[i] == '"') {
 356                         in_quotes = !in_quotes;
 357                 } else {
 358                         c += s[i];
 359                 }
 360         }
 361
 362         out.push_back (c);
 363         return out;
 364 }
 365
 366 string
 367 md5_digest (void const * data, int size)
 368 {
 369         MD5_CTX md5_context;
 370         MD5_Init (&md5_context);
 371         MD5_Update (&md5_context, data, size);
 372         unsigned char digest[MD5_DIGEST_LENGTH];
 373         MD5_Final (digest, &md5_context);
 374
 375         stringstream s;
 376         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 377                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 378         }
 379
 380         return s.str ();
 381 }
 382
 383 /** @param file File name.
 384  *  @return MD5 digest of file's contents.
 385  */
 386 string
 387 md5_digest (string file)
 388 {
 389         ifstream f (file.c_str(), std::ios::binary);
 390         if (!f.good ()) {
 391                 throw OpenFileError (file);
 392         }
 393
 394         f.seekg (0, std::ios::end);
 395         int bytes = f.tellg ();
 396         f.seekg (0, std::ios::beg);
 397
 398         int const buffer_size = 64 * 1024;
 399         char buffer[buffer_size];
 400
 401         MD5_CTX md5_context;
 402         MD5_Init (&md5_context);
 403         while (bytes > 0) {
 404                 int const t = min (bytes, buffer_size);
 405                 f.read (buffer, t);
 406                 MD5_Update (&md5_context, buffer, t);
 407                 bytes -= t;
 408         }
 409
 410         unsigned char digest[MD5_DIGEST_LENGTH];
 411         MD5_Final (digest, &md5_context);
 412
 413         stringstream s;
 414         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 415                 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
 416         }
 417
 418         return s.str ();
 419 }
 420
 421 static bool
 422 about_equal (float a, float b)
 423 {
 424         /* A film of F seconds at f FPS will be Ff frames;
 425            Consider some delta FPS d, so if we run the same
 426            film at (f + d) FPS it will last F(f + d) seconds.
 427
 428            Hence the difference in length over the length of the film will
 429            be F(f + d) - Ff frames
 430             = Ff + Fd - Ff frames
 431             = Fd frames
 432             = Fd/f seconds
 433
 434            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 435            say that
 436
 437            1/f = Fd/f
 438         ie 1 = Fd
 439         ie d = 1/F
 440
 441            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 442            FPS error is 1/F ~= 0.0001 ~= 10-e4
 443         */
 444
 445         return (fabs (a - b) < 1e-4);
 446 }
 447
 448 class FrameRateCandidate
 449 {
 450 public:
 451         FrameRateCandidate (float source_, int dcp_)
 452                 : source (source_)
 453                 , dcp (dcp_)
 454         {}
 455
 456         float source;
 457         int dcp;
 458 };
 459
 460 int
 461 best_dcp_frame_rate (float source_fps)
 462 {
 463         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 464
 465         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 466         list<FrameRateCandidate> candidates;
 467
 468         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 469         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 470                 candidates.push_back (FrameRateCandidate (*i, *i));
 471         }
 472
 473         /* Then the skip/repeat ones */
 474         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 475                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 476                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 477         }
 478
 479         /* Pick the best one, bailing early if we hit an exact match */
 480         float error = std::numeric_limits<float>::max ();
 481         optional<FrameRateCandidate> best;
 482         list<FrameRateCandidate>::iterator i = candidates.begin();
 483         while (i != candidates.end()) {
 484
 485                 if (about_equal (i->source, source_fps)) {
 486                         best = *i;
 487                         break;
 488                 }
 489
 490                 float const e = fabs (i->source - source_fps);
 491                 if (e < error) {
 492                         error = e;
 493                         best = *i;
 494                 }
 495
 496                 ++i;
 497         }
 498
 499         assert (best);
 500         return best->dcp;
 501 }
 502
 503 /** @param An arbitrary sampling rate.
 504  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 505  */
 506 int
 507 dcp_audio_sample_rate (int fs)
 508 {
 509         if (fs <= 48000) {
 510                 return 48000;
 511         }
 512
 513         return 96000;
 514 }
 515
 516 bool operator== (Crop const & a, Crop const & b)
 517 {
 518         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 519 }
 520
 521 bool operator!= (Crop const & a, Crop const & b)
 522 {
 523         return !(a == b);
 524 }
 525
 526 /** @param index Colour LUT index.
 527  *  @return Human-readable name.
 528  */
 529 string
 530 colour_lut_index_to_name (int index)
 531 {
 532         switch (index) {
 533         case 0:
 534                 return _("sRGB");
 535         case 1:
 536                 return _("Rec 709");
 537         }
 538
 539         assert (false);
 540         return N_("");
 541 }
 542
 543 Socket::Socket (int timeout)
 544         : _deadline (_io_service)
 545         , _socket (_io_service)
 546         , _timeout (timeout)
 547 {
 548         _deadline.expires_at (boost::posix_time::pos_infin);
 549         check ();
 550 }
 551
 552 void
 553 Socket::check ()
 554 {
 555         if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
 556                 _socket.close ();
 557                 _deadline.expires_at (boost::posix_time::pos_infin);
 558         }
 559
 560         _deadline.async_wait (boost::bind (&Socket::check, this));
 561 }
 562
 563 /** Blocking connect.
 564  *  @param endpoint End-point to connect to.
 565  */
 566 void
 567 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
 568 {
 569         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 570         boost::system::error_code ec = boost::asio::error::would_block;
 571         _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
 572         do {
 573                 _io_service.run_one();
 574         } while (ec == boost::asio::error::would_block);
 575
 576         if (ec || !_socket.is_open ()) {
 577                 throw NetworkError (_("connect timed out"));
 578         }
 579 }
 580
 581 /** Blocking write.
 582  *  @param data Buffer to write.
 583  *  @param size Number of bytes to write.
 584  */
 585 void
 586 Socket::write (uint8_t const * data, int size)
 587 {
 588         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 589         boost::system::error_code ec = boost::asio::error::would_block;
 590
 591         boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 592
 593         do {
 594                 _io_service.run_one ();
 595         } while (ec == boost::asio::error::would_block);
 596
 597         if (ec) {
 598                 throw NetworkError (ec.message ());
 599         }
 600 }
 601
 602 void
 603 Socket::write (uint32_t v)
 604 {
 605         v = htonl (v);
 606         write (reinterpret_cast<uint8_t*> (&v), 4);
 607 }
 608
 609 /** Blocking read.
 610  *  @param data Buffer to read to.
 611  *  @param size Number of bytes to read.
 612  */
 613 void
 614 Socket::read (uint8_t* data, int size)
 615 {
 616         _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
 617         boost::system::error_code ec = boost::asio::error::would_block;
 618
 619         boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
 620
 621         do {
 622                 _io_service.run_one ();
 623         } while (ec == boost::asio::error::would_block);
 624
 625         if (ec) {
 626                 throw NetworkError (ec.message ());
 627         }
 628 }
 629
 630 uint32_t
 631 Socket::read_uint32 ()
 632 {
 633         uint32_t v;
 634         read (reinterpret_cast<uint8_t *> (&v), 4);
 635         return ntohl (v);
 636 }
 637
 638 /** @param other A Rect.
 639  *  @return The intersection of this with `other'.
 640  */
 641 dvdomatic::Rect
 642 dvdomatic::Rect::intersection (Rect const & other) const
 643 {
 644         int const tx = max (x, other.x);
 645         int const ty = max (y, other.y);
 646
 647         return Rect (
 648                 tx, ty,
 649                 min (x + width, other.x + other.width) - tx,
 650                 min (y + height, other.y + other.height) - ty
 651                 );
 652 }
 653
 654 /** Round a number up to the nearest multiple of another number.
 655  *  @param c Index.
 656  *  @param s Array of numbers to round, indexed by c.
 657  *  @param t Multiple to round to.
 658  *  @return Rounded number.
 659  */
 660 int
 661 stride_round_up (int c, int const * stride, int t)
 662 {
 663         int const a = stride[c] + (t - 1);
 664         return a - (a % t);
 665 }
 666
 667 int
 668 stride_lookup (int c, int const * stride)
 669 {
 670         return stride[c];
 671 }
 672
 673 /** Read a sequence of key / value pairs from a text stream;
 674  *  the keys are the first words on the line, and the values are
 675  *  the remainder of the line following the key.  Lines beginning
 676  *  with # are ignored.
 677  *  @param s Stream to read.
 678  *  @return key/value pairs.
 679  */
 680 multimap<string, string>
 681 read_key_value (istream &s)
 682 {
 683         multimap<string, string> kv;
 684
 685         string line;
 686         while (getline (s, line)) {
 687                 if (line.empty ()) {
 688                         continue;
 689                 }
 690
 691                 if (line[0] == '#') {
 692                         continue;
 693                 }
 694
 695                 if (line[line.size() - 1] == '\r') {
 696                         line = line.substr (0, line.size() - 1);
 697                 }
 698
 699                 size_t const s = line.find (' ');
 700                 if (s == string::npos) {
 701                         continue;
 702                 }
 703
 704                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 705         }
 706
 707         return kv;
 708 }
 709
 710 string
 711 get_required_string (multimap<string, string> const & kv, string k)
 712 {
 713         if (kv.count (k) > 1) {
 714                 throw StringError (N_("unexpected multiple keys in key-value set"));
 715         }
 716
 717         multimap<string, string>::const_iterator i = kv.find (k);
 718
 719         if (i == kv.end ()) {
 720                 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
 721         }
 722
 723         return i->second;
 724 }
 725
 726 int
 727 get_required_int (multimap<string, string> const & kv, string k)
 728 {
 729         string const v = get_required_string (kv, k);
 730         return lexical_cast<int> (v);
 731 }
 732
 733 float
 734 get_required_float (multimap<string, string> const & kv, string k)
 735 {
 736         string const v = get_required_string (kv, k);
 737         return lexical_cast<float> (v);
 738 }
 739
 740 string
 741 get_optional_string (multimap<string, string> const & kv, string k)
 742 {
 743         if (kv.count (k) > 1) {
 744                 throw StringError (N_("unexpected multiple keys in key-value set"));
 745         }
 746
 747         multimap<string, string>::const_iterator i = kv.find (k);
 748         if (i == kv.end ()) {
 749                 return N_("");
 750         }
 751
 752         return i->second;
 753 }
 754
 755 int
 756 get_optional_int (multimap<string, string> const & kv, string k)
 757 {
 758         if (kv.count (k) > 1) {
 759                 throw StringError (N_("unexpected multiple keys in key-value set"));
 760         }
 761
 762         multimap<string, string>::const_iterator i = kv.find (k);
 763         if (i == kv.end ()) {
 764                 return 0;
 765         }
 766
 767         return lexical_cast<int> (i->second);
 768 }
 769
 770 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 771  *  @param channels Number of channels.
 772  *  @param frames Number of frames to reserve space for.
 773  */
 774 AudioBuffers::AudioBuffers (int channels, int frames)
 775         : _channels (channels)
 776         , _frames (frames)
 777         , _allocated_frames (frames)
 778 {
 779         _data = new float*[_channels];
 780         for (int i = 0; i < _channels; ++i) {
 781                 _data[i] = new float[frames];
 782         }
 783 }
 784
 785 /** Copy constructor.
 786  *  @param other Other AudioBuffers; data is copied.
 787  */
 788 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 789         : _channels (other._channels)
 790         , _frames (other._frames)
 791         , _allocated_frames (other._frames)
 792 {
 793         _data = new float*[_channels];
 794         for (int i = 0; i < _channels; ++i) {
 795                 _data[i] = new float[_frames];
 796                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 797         }
 798 }
 799
 800 /* XXX: it's a shame that this is a copy-and-paste of the above;
 801    probably fixable with c++0x.
 802 */
 803 AudioBuffers::AudioBuffers (boost::shared_ptr<const AudioBuffers> other)
 804         : _channels (other->_channels)
 805         , _frames (other->_frames)
 806         , _allocated_frames (other->_frames)
 807 {
 808         _data = new float*[_channels];
 809         for (int i = 0; i < _channels; ++i) {
 810                 _data[i] = new float[_frames];
 811                 memcpy (_data[i], other->_data[i], _frames * sizeof (float));
 812         }
 813 }
 814
 815 /** AudioBuffers destructor */
 816 AudioBuffers::~AudioBuffers ()
 817 {
 818         for (int i = 0; i < _channels; ++i) {
 819                 delete[] _data[i];
 820         }
 821
 822         delete[] _data;
 823 }
 824
 825 /** @param c Channel index.
 826  *  @return Buffer for this channel.
 827  */
 828 float*
 829 AudioBuffers::data (int c) const
 830 {
 831         assert (c >= 0 && c < _channels);
 832         return _data[c];
 833 }
 834
 835 /** Set the number of frames that these AudioBuffers will report themselves
 836  *  as having.
 837  *  @param f Frames; must be less than or equal to the number of allocated frames.
 838  */
 839 void
 840 AudioBuffers::set_frames (int f)
 841 {
 842         assert (f <= _allocated_frames);
 843         _frames = f;
 844 }
 845
 846 /** Make all samples on all channels silent */
 847 void
 848 AudioBuffers::make_silent ()
 849 {
 850         for (int i = 0; i < _channels; ++i) {
 851                 make_silent (i);
 852         }
 853 }
 854
 855 /** Make all samples on a given channel silent.
 856  *  @param c Channel.
 857  */
 858 void
 859 AudioBuffers::make_silent (int c)
 860 {
 861         assert (c >= 0 && c < _channels);
 862
 863         for (int i = 0; i < _frames; ++i) {
 864                 _data[c][i] = 0;
 865         }
 866 }
 867
 868 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 869  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 870  *  @param frames_to_copy Number of frames to copy.
 871  *  @param read_offset Offset to read from in `from'.
 872  *  @param write_offset Offset to write to in `to'.
 873  */
 874 void
 875 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 876 {
 877         assert (from->channels() == channels());
 878
 879         assert (from);
 880         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 881         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 882
 883         for (int i = 0; i < _channels; ++i) {
 884                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 885         }
 886 }
 887
 888 /** Move audio data around.
 889  *  @param from Offset to move from.
 890  *  @param to Offset to move to.
 891  *  @param frames Number of frames to move.
 892  */
 893
 894 void
 895 AudioBuffers::move (int from, int to, int frames)
 896 {
 897         if (frames == 0) {
 898                 return;
 899         }
 900
 901         assert (from >= 0);
 902         assert (from < _frames);
 903         assert (to >= 0);
 904         assert (to < _frames);
 905         assert (frames > 0);
 906         assert (frames <= _frames);
 907         assert ((from + frames) <= _frames);
 908         assert ((to + frames) <= _frames);
 909
 910         for (int i = 0; i < _channels; ++i) {
 911                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 912         }
 913 }
 914
 915 /** Trip an assert if the caller is not in the UI thread */
 916 void
 917 ensure_ui_thread ()
 918 {
 919         assert (boost::this_thread::get_id() == ui_thread);
 920 }
 921
 922 /** @param v Source video frame.
 923  *  @param audio_sample_rate Source audio sample rate.
 924  *  @param frames_per_second Number of video frames per second.
 925  *  @return Equivalent number of audio frames for `v'.
 926  */
 927 int64_t
 928 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 929 {
 930         return ((int64_t) v * audio_sample_rate / frames_per_second);
 931 }
 932
 933 /** @param f Filename.
 934  *  @return true if this file is a still image, false if it is something else.
 935  */
 936 bool
 937 still_image_file (string f)
 938 {
 939         string ext = boost::filesystem::path(f).extension().string();
 940
 941         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 942
 943         return (ext == N_(".tif") || ext == N_(".tiff") || ext == N_(".jpg") || ext == N_(".jpeg") || ext == N_(".png") || ext == N_(".bmp"));
 944 }
 945
 946 string
 947 audio_channel_name (int c)
 948 {
 949         assert (MAX_AUDIO_CHANNELS == 6);
 950
 951         /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 952            enhancement channel (sub-woofer)./
 953         */
 954         string const channels[] = {
 955                 _("Left"),
 956                 _("Right"),
 957                 _("Centre"),
 958                 _("Lfe (sub)"),
 959                 _("Left surround"),
 960                 _("Right surround"),
 961         };
 962
 963         return channels[c];
 964 }
 965
 966 AudioMapping::AudioMapping (shared_ptr<const Film> f)
 967         : _source_channels (f->audio_stream() ? f->audio_stream()->channels() : 0)
 968         , _minimum_channels (f->minimum_audio_channels ())
 969 {
 970
 971 }
 972
 973 optional<libdcp::Channel>
 974 AudioMapping::source_to_dcp (int c) const
 975 {
 976         if (c >= _source_channels) {
 977                 return optional<libdcp::Channel> ();
 978         }
 979
 980         if (_source_channels == 1) {
 981                 /* mono sources to centre */
 982                 return libdcp::CENTRE;
 983         }
 984
 985         return static_cast<libdcp::Channel> (c);
 986 }
 987
 988 optional<int>
 989 AudioMapping::dcp_to_source (libdcp::Channel c) const
 990 {
 991         if (_source_channels == 1) {
 992                 if (c == libdcp::CENTRE) {
 993                         return 0;
 994                 } else {
 995                         return optional<int> ();
 996                 }
 997         }
 998
 999         if (static_cast<int> (c) >= _source_channels) {
1000                 return optional<int> ();
1001         }
1002
1003         return static_cast<int> (c);
1004 }
1005
1006 /** @return minimum number of DCP channels that we can allow in this
1007     DCP, given the nature of the source.
1008 */
1009 int
1010 AudioMapping::minimum_dcp_channels () const
1011 {
1012         if (_source_channels == 1) {
1013                 /* The source is mono, so to put the mono channel into
1014                    the centre we need to generate a 5.1 soundtrack.
1015                 */
1016                 return 6;
1017         }
1018
1019         return _source_channels;
1020 }
1021
1022 /** @return number of channels that there should be in the DCP, including
1023  *  any silent padded ones.
1024  */
1025 int
1026 AudioMapping::dcp_channels () const
1027 {
1028         return max (_source_channels, _minimum_channels);
1029 }
1030
1031 FrameRateConversion::FrameRateConversion (float source, int dcp)
1032         : skip (false)
1033         , repeat (false)
1034         , change_speed (false)
1035 {
1036         if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
1037                 skip = true;
1038         } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
1039                 repeat = true;
1040         }
1041
1042         change_speed = !about_equal (source * factor(), dcp);
1043
1044         if (!skip && !repeat && !change_speed) {
1045                 description = _("DCP and source have the same rate.\n");
1046         } else {
1047                 if (skip) {
1048                         description = _("DCP will use every other frame of the source.\n");
1049                 } else if (repeat) {
1050                         description = _("Each source frame will be doubled in the DCP.\n");
1051                 }
1052
1053                 if (change_speed) {
1054                         float const pc = dcp * 100 / (source * factor());
1055                         description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);
1056                 }
1057         }
1058 }
1059
1060 LocaleGuard::LocaleGuard ()
1061         : _old (0)
1062 {
1063         char const * old = setlocale (LC_NUMERIC, 0);
1064
1065         if (old) {
1066                 _old = strdup (old);
1067                 if (strcmp (_old, "C")) {
1068                         setlocale (LC_NUMERIC, "C");
1069                 }
1070         }
1071 }
1072
1073 LocaleGuard::~LocaleGuard ()
1074 {
1075         setlocale (LC_NUMERIC, _old);
1076         free (_old);
1077 }