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