src/lib/util.cc

   1 /*
   2     Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
   3     Copyright (C) 2000-2007 Paul Davis
   4
   5     This program is free software; you can redistribute it and/or modify
   6     it under the terms of the GNU General Public License as published by
   7     the Free Software Foundation; either version 2 of the License, or
   8     (at your option) any later version.
   9
  10     This program is distributed in the hope that it will be useful,
  11     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13     GNU General Public License for more details.
  14
  15     You should have received a copy of the GNU General Public License
  16     along with this program; if not, write to the Free Software
  17     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  18
  19 */
  20
  21 /** @file src/lib/util.cc
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #include <sstream>
  26 #include <iomanip>
  27 #include <iostream>
  28 #include <fstream>
  29 #include <climits>
  30 #ifdef DVDOMATIC_POSIX
  31 #include <execinfo.h>
  32 #include <cxxabi.h>
  33 #endif
  34 #include <libssh/libssh.h>
  35 #include <signal.h>
  36 #include <boost/algorithm/string.hpp>
  37 #include <boost/bind.hpp>
  38 #include <boost/lambda/lambda.hpp>
  39 #include <boost/lexical_cast.hpp>
  40 #include <boost/thread.hpp>
  41 #include <boost/filesystem.hpp>
  42 #include <openjpeg.h>
  43 #include <openssl/md5.h>
  44 #include <magick/MagickCore.h>
  45 #include <magick/version.h>
  46 #include <libdcp/version.h>
  47 extern "C" {
  48 #include <libavcodec/avcodec.h>
  49 #include <libavformat/avformat.h>
  50 #include <libswscale/swscale.h>
  51 #include <libavfilter/avfiltergraph.h>
  52 #include <libpostproc/postprocess.h>
  53 #include <libavutil/pixfmt.h>
  54 }
  55 #include "util.h"
  56 #include "exceptions.h"
  57 #include "scaler.h"
  58 #include "format.h"
  59 #include "dcp_content_type.h"
  60 #include "filter.h"
  61 #include "sound_processor.h"
  62 #include "config.h"
  63
  64 using namespace std;
  65 using namespace boost;
  66 using libdcp::Size;
  67
  68 thread::id ui_thread;
  69
  70 /** Convert some number of seconds to a string representation
  71  *  in hours, minutes and seconds.
  72  *
  73  *  @param s Seconds.
  74  *  @return String of the form H:M:S (where H is hours, M
  75  *  is minutes and S is seconds).
  76  */
  77 string
  78 seconds_to_hms (int s)
  79 {
  80         int m = s / 60;
  81         s -= (m * 60);
  82         int h = m / 60;
  83         m -= (h * 60);
  84
  85         stringstream hms;
  86         hms << h << ":";
  87         hms.width (2);
  88         hms << setfill ('0') << m << ":";
  89         hms.width (2);
  90         hms << setfill ('0') << s;
  91
  92         return hms.str ();
  93 }
  94
  95 /** @param s Number of seconds.
  96  *  @return String containing an approximate description of s (e.g. "about 2 hours")
  97  */
  98 string
  99 seconds_to_approximate_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 ap;
 107
 108         if (h > 0) {
 109                 if (m > 30) {
 110                         ap << (h + 1) << " hours";
 111                 } else {
 112                         if (h == 1) {
 113                                 ap << "1 hour";
 114                         } else {
 115                                 ap << h << " hours";
 116                         }
 117                 }
 118         } else if (m > 0) {
 119                 if (m == 1) {
 120                         ap << "1 minute";
 121                 } else {
 122                         ap << m << " minutes";
 123                 }
 124         } else {
 125                 ap << s << " seconds";
 126         }
 127
 128         return ap.str ();
 129 }
 130
 131 #ifdef DVDOMATIC_POSIX
 132 /** @param l Mangled C++ identifier.
 133  *  @return Demangled version.
 134  */
 135 static string
 136 demangle (string l)
 137 {
 138         string::size_type const b = l.find_first_of ("(");
 139         if (b == string::npos) {
 140                 return l;
 141         }
 142
 143         string::size_type const p = l.find_last_of ("+");
 144         if (p == string::npos) {
 145                 return l;
 146         }
 147
 148         if ((p - b) <= 1) {
 149                 return l;
 150         }
 151
 152         string const fn = l.substr (b + 1, p - b - 1);
 153
 154         int status;
 155         try {
 156
 157                 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
 158                 string d (realname);
 159                 free (realname);
 160                 return d;
 161
 162         } catch (std::exception) {
 163
 164         }
 165
 166         return l;
 167 }
 168
 169 /** Write a stacktrace to an ostream.
 170  *  @param out Stream to write to.
 171  *  @param levels Number of levels to go up the call stack.
 172  */
 173 void
 174 stacktrace (ostream& out, int levels)
 175 {
 176         void *array[200];
 177         size_t size;
 178         char **strings;
 179         size_t i;
 180
 181         size = backtrace (array, 200);
 182         strings = backtrace_symbols (array, size);
 183
 184         if (strings) {
 185                 for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
 186                         out << "  " << demangle (strings[i]) << endl;
 187                 }
 188
 189                 free (strings);
 190         }
 191 }
 192 #endif
 193
 194 /** @param v Version as used by FFmpeg.
 195  *  @return A string representation of v.
 196  */
 197 static string
 198 ffmpeg_version_to_string (int v)
 199 {
 200         stringstream s;
 201         s << ((v & 0xff0000) >> 16) << "." << ((v & 0xff00) >> 8) << "." << (v & 0xff);
 202         return s.str ();
 203 }
 204
 205 /** Return a user-readable string summarising the versions of our dependencies */
 206 string
 207 dependency_version_summary ()
 208 {
 209         stringstream s;
 210         s << "libopenjpeg " << opj_version () << ", "
 211           << "libavcodec " << ffmpeg_version_to_string (avcodec_version()) << ", "
 212           << "libavfilter " << ffmpeg_version_to_string (avfilter_version()) << ", "
 213           << "libavformat " << ffmpeg_version_to_string (avformat_version()) << ", "
 214           << "libavutil " << ffmpeg_version_to_string (avutil_version()) << ", "
 215           << "libpostproc " << ffmpeg_version_to_string (postproc_version()) << ", "
 216           << "libswscale " << ffmpeg_version_to_string (swscale_version()) << ", "
 217           << MagickVersion << ", "
 218           << "libssh " << ssh_version (0) << ", "
 219           << "libdcp " << libdcp::version << " git " << libdcp::git_commit;
 220
 221         return s.str ();
 222 }
 223
 224 double
 225 seconds (struct timeval t)
 226 {
 227         return t.tv_sec + (double (t.tv_usec) / 1e6);
 228 }
 229
 230 /** Call the required functions to set up DVD-o-matic's static arrays, etc.
 231  *  Must be called from the UI thread, if there is one.
 232  */
 233 void
 234 dvdomatic_setup ()
 235 {
 236         avfilter_register_all ();
 237
 238         Format::setup_formats ();
 239         DCPContentType::setup_dcp_content_types ();
 240         Scaler::setup_scalers ();
 241         Filter::setup_filters ();
 242         SoundProcessor::setup_sound_processors ();
 243
 244         ui_thread = this_thread::get_id ();
 245 }
 246
 247 /** @param start Start position for the crop within the image.
 248  *  @param size Size of the cropped area.
 249  *  @return FFmpeg crop filter string.
 250  */
 251 string
 252 crop_string (Position start, libdcp::Size size)
 253 {
 254         stringstream s;
 255         s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
 256         return s.str ();
 257 }
 258
 259 /** @param s A string.
 260  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 261  */
 262 vector<string>
 263 split_at_spaces_considering_quotes (string s)
 264 {
 265         vector<string> out;
 266         bool in_quotes = false;
 267         string c;
 268         for (string::size_type i = 0; i < s.length(); ++i) {
 269                 if (s[i] == ' ' && !in_quotes) {
 270                         out.push_back (c);
 271                         c = "";
 272                 } else if (s[i] == '"') {
 273                         in_quotes = !in_quotes;
 274                 } else {
 275                         c += s[i];
 276                 }
 277         }
 278
 279         out.push_back (c);
 280         return out;
 281 }
 282
 283 string
 284 md5_digest (void const * data, int size)
 285 {
 286         MD5_CTX md5_context;
 287         MD5_Init (&md5_context);
 288         MD5_Update (&md5_context, data, size);
 289         unsigned char digest[MD5_DIGEST_LENGTH];
 290         MD5_Final (digest, &md5_context);
 291
 292         stringstream s;
 293         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 294                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 295         }
 296
 297         return s.str ();
 298 }
 299
 300 /** @param file File name.
 301  *  @return MD5 digest of file's contents.
 302  */
 303 string
 304 md5_digest (string file)
 305 {
 306         ifstream f (file.c_str(), ios::binary);
 307         if (!f.good ()) {
 308                 throw OpenFileError (file);
 309         }
 310
 311         f.seekg (0, ios::end);
 312         int bytes = f.tellg ();
 313         f.seekg (0, ios::beg);
 314
 315         int const buffer_size = 64 * 1024;
 316         char buffer[buffer_size];
 317
 318         MD5_CTX md5_context;
 319         MD5_Init (&md5_context);
 320         while (bytes > 0) {
 321                 int const t = min (bytes, buffer_size);
 322                 f.read (buffer, t);
 323                 MD5_Update (&md5_context, buffer, t);
 324                 bytes -= t;
 325         }
 326
 327         unsigned char digest[MD5_DIGEST_LENGTH];
 328         MD5_Final (digest, &md5_context);
 329
 330         stringstream s;
 331         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 332                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 333         }
 334
 335         return s.str ();
 336 }
 337
 338 static bool about_equal (float a, float b)
 339 {
 340         /* A film of F seconds at f FPS will be Ff frames;
 341            Consider some delta FPS d, so if we run the same
 342            film at (f + d) FPS it will last F(f + d) seconds.
 343
 344            Hence the difference in length over the length of the film will
 345            be F(f + d) - Ff frames
 346             = Ff + Fd - Ff frames
 347             = Fd frames
 348             = Fd/f seconds
 349
 350            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 351            say that
 352
 353            1/f = Fd/f
 354         ie 1 = Fd
 355         ie d = 1/F
 356
 357            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 358            FPS error is 1/F ~= 0.0001 ~= 10-e4
 359         */
 360
 361         return (fabs (a - b) < 1e-4);
 362 }
 363
 364 class FrameRateCandidate
 365 {
 366 public:
 367         FrameRateCandidate (float source_, int dcp_)
 368                 : source (source_)
 369                 , dcp (dcp_)
 370         {}
 371
 372         bool skip () const {
 373                 return !about_equal (source, dcp) && source > dcp;
 374         }
 375
 376         bool repeat () const {
 377                 return !about_equal (source, dcp) && source < dcp;
 378         }
 379
 380         float source;
 381         int dcp;
 382 };
 383
 384 /** @param fps Arbitrary source frames-per-second value */
 385 /** XXX: this could be slow-ish */
 386 DCPFrameRate::DCPFrameRate (float source_fps)
 387 {
 388         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 389
 390         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 391         list<FrameRateCandidate> candidates;
 392
 393         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 394         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 395                 candidates.push_back (FrameRateCandidate (*i, *i));
 396         }
 397
 398         /* Then the skip/repeat ones */
 399         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 400                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 401                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 402         }
 403
 404         /* Pick the best one, bailing early if we hit an exact match */
 405         float error = numeric_limits<float>::max ();
 406         boost::optional<FrameRateCandidate> best;
 407         list<FrameRateCandidate>::iterator i = candidates.begin();
 408         while (i != candidates.end()) {
 409
 410                 if (about_equal (i->source, source_fps)) {
 411                         best = *i;
 412                         break;
 413                 }
 414
 415                 float const e = fabs (i->source - source_fps);
 416                 if (e < error) {
 417                         error = e;
 418                         best = *i;
 419                 }
 420
 421                 ++i;
 422         }
 423
 424         if (!best) {
 425                 throw EncodeError ("cannot find a suitable DCP frame rate for this source");
 426         }
 427
 428         frames_per_second = best->dcp;
 429         skip = best->skip ();
 430         repeat = best->repeat ();
 431         change_speed = !about_equal (source_fps * factor(), frames_per_second);
 432 }
 433
 434 /** @param An arbitrary sampling rate.
 435  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 436  */
 437 int
 438 dcp_audio_sample_rate (int fs)
 439 {
 440         if (fs <= 48000) {
 441                 return 48000;
 442         }
 443
 444         return 96000;
 445 }
 446
 447 int
 448 dcp_audio_channels (int f)
 449 {
 450         if (f == 1) {
 451                 /* The source is mono, so to put the mono channel into
 452                    the centre we need to generate a 5.1 soundtrack.
 453                 */
 454                 return 6;
 455         }
 456
 457         return f;
 458 }
 459
 460 bool operator== (Crop const & a, Crop const & b)
 461 {
 462         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 463 }
 464
 465 bool operator!= (Crop const & a, Crop const & b)
 466 {
 467         return !(a == b);
 468 }
 469
 470 /** @param index Colour LUT index.
 471  *  @return Human-readable name.
 472  */
 473 string
 474 colour_lut_index_to_name (int index)
 475 {
 476         switch (index) {
 477         case 0:
 478                 return "sRGB";
 479         case 1:
 480                 return "Rec 709";
 481         }
 482
 483         assert (false);
 484         return "";
 485 }
 486
 487 Socket::Socket ()
 488         : _deadline (_io_service)
 489         , _socket (_io_service)
 490         , _buffer_data (0)
 491 {
 492         _deadline.expires_at (posix_time::pos_infin);
 493         check ();
 494 }
 495
 496 void
 497 Socket::check ()
 498 {
 499         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 500                 _socket.close ();
 501                 _deadline.expires_at (posix_time::pos_infin);
 502         }
 503
 504         _deadline.async_wait (boost::bind (&Socket::check, this));
 505 }
 506
 507 /** Blocking connect with timeout.
 508  *  @param endpoint End-point to connect to.
 509  *  @param timeout Time-out in seconds.
 510  */
 511 void
 512 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
 513 {
 514         _deadline.expires_from_now (posix_time::seconds (timeout));
 515         system::error_code ec = asio::error::would_block;
 516         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 517         do {
 518                 _io_service.run_one();
 519         } while (ec == asio::error::would_block);
 520
 521         if (ec || !_socket.is_open ()) {
 522                 throw NetworkError ("connect timed out");
 523         }
 524 }
 525
 526 /** Blocking write with timeout.
 527  *  @param data Buffer to write.
 528  *  @param size Number of bytes to write.
 529  *  @param timeout Time-out, in seconds.
 530  */
 531 void
 532 Socket::write (uint8_t const * data, int size, int timeout)
 533 {
 534         _deadline.expires_from_now (posix_time::seconds (timeout));
 535         system::error_code ec = asio::error::would_block;
 536
 537         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 538         do {
 539                 _io_service.run_one ();
 540         } while (ec == asio::error::would_block);
 541
 542         if (ec) {
 543                 throw NetworkError ("write timed out");
 544         }
 545 }
 546
 547 /** Blocking read with timeout.
 548  *  @param data Buffer to read to.
 549  *  @param size Number of bytes to read.
 550  *  @param timeout Time-out, in seconds.
 551  */
 552 int
 553 Socket::read (uint8_t* data, int size, int timeout)
 554 {
 555         _deadline.expires_from_now (posix_time::seconds (timeout));
 556         system::error_code ec = asio::error::would_block;
 557
 558         int amount_read = 0;
 559
 560         _socket.async_read_some (
 561                 asio::buffer (data, size),
 562                 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
 563                 );
 564
 565         do {
 566                 _io_service.run_one ();
 567         } while (ec == asio::error::would_block);
 568
 569         if (ec) {
 570                 amount_read = 0;
 571         }
 572
 573         return amount_read;
 574 }
 575
 576 /** Mark some data as being `consumed', so that it will not be returned
 577  *  as data again.
 578  *  @param size Amount of data to consume, in bytes.
 579  */
 580 void
 581 Socket::consume (int size)
 582 {
 583         assert (_buffer_data >= size);
 584
 585         _buffer_data -= size;
 586         if (_buffer_data > 0) {
 587                 /* Shift still-valid data to the start of the buffer */
 588                 memmove (_buffer, _buffer + size, _buffer_data);
 589         }
 590 }
 591
 592 /** Read a definite amount of data from our socket, and mark
 593  *  it as consumed.
 594  *  @param data Where to put the data.
 595  *  @param size Number of bytes to read.
 596  */
 597 void
 598 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
 599 {
 600         int const from_buffer = min (_buffer_data, size);
 601         if (from_buffer > 0) {
 602                 /* Get data from our buffer */
 603                 memcpy (data, _buffer, from_buffer);
 604                 consume (from_buffer);
 605                 /* Update our output state */
 606                 data += from_buffer;
 607                 size -= from_buffer;
 608         }
 609
 610         /* read() the rest */
 611         while (size > 0) {
 612                 int const n = read (data, size, timeout);
 613                 if (n <= 0) {
 614                         throw NetworkError ("could not read");
 615                 }
 616
 617                 data += n;
 618                 size -= n;
 619         }
 620 }
 621
 622 /** Read as much data as is available, up to some limit.
 623  *  @param data Where to put the data.
 624  *  @param size Maximum amount of data to read.
 625  */
 626 void
 627 Socket::read_indefinite (uint8_t* data, int size, int timeout)
 628 {
 629         assert (size < int (sizeof (_buffer)));
 630
 631         /* Amount of extra data we need to read () */
 632         int to_read = size - _buffer_data;
 633         while (to_read > 0) {
 634                 /* read as much of it as we can (into our buffer) */
 635                 int const n = read (_buffer + _buffer_data, to_read, timeout);
 636                 if (n <= 0) {
 637                         throw NetworkError ("could not read");
 638                 }
 639
 640                 to_read -= n;
 641                 _buffer_data += n;
 642         }
 643
 644         assert (_buffer_data >= size);
 645
 646         /* copy data into the output buffer */
 647         assert (size >= _buffer_data);
 648         memcpy (data, _buffer, size);
 649 }
 650
 651 /** @param other A Rect.
 652  *  @return The intersection of this with `other'.
 653  */
 654 Rect
 655 Rect::intersection (Rect const & other) const
 656 {
 657         int const tx = max (x, other.x);
 658         int const ty = max (y, other.y);
 659
 660         return Rect (
 661                 tx, ty,
 662                 min (x + width, other.x + other.width) - tx,
 663                 min (y + height, other.y + other.height) - ty
 664                 );
 665 }
 666
 667 /** Round a number up to the nearest multiple of another number.
 668  *  @param c Index.
 669  *  @param s Array of numbers to round, indexed by c.
 670  *  @param t Multiple to round to.
 671  *  @return Rounded number.
 672  */
 673 int
 674 stride_round_up (int c, int const * stride, int t)
 675 {
 676         int const a = stride[c] + (t - 1);
 677         return a - (a % t);
 678 }
 679
 680 int
 681 stride_lookup (int c, int const * stride)
 682 {
 683         return stride[c];
 684 }
 685
 686 /** Read a sequence of key / value pairs from a text stream;
 687  *  the keys are the first words on the line, and the values are
 688  *  the remainder of the line following the key.  Lines beginning
 689  *  with # are ignored.
 690  *  @param s Stream to read.
 691  *  @return key/value pairs.
 692  */
 693 multimap<string, string>
 694 read_key_value (istream &s)
 695 {
 696         multimap<string, string> kv;
 697
 698         string line;
 699         while (getline (s, line)) {
 700                 if (line.empty ()) {
 701                         continue;
 702                 }
 703
 704                 if (line[0] == '#') {
 705                         continue;
 706                 }
 707
 708                 if (line[line.size() - 1] == '\r') {
 709                         line = line.substr (0, line.size() - 1);
 710                 }
 711
 712                 size_t const s = line.find (' ');
 713                 if (s == string::npos) {
 714                         continue;
 715                 }
 716
 717                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 718         }
 719
 720         return kv;
 721 }
 722
 723 string
 724 get_required_string (multimap<string, string> const & kv, string k)
 725 {
 726         if (kv.count (k) > 1) {
 727                 throw StringError ("unexpected multiple keys in key-value set");
 728         }
 729
 730         multimap<string, string>::const_iterator i = kv.find (k);
 731
 732         if (i == kv.end ()) {
 733                 throw StringError (String::compose ("missing key %1 in key-value set", k));
 734         }
 735
 736         return i->second;
 737 }
 738
 739 int
 740 get_required_int (multimap<string, string> const & kv, string k)
 741 {
 742         string const v = get_required_string (kv, k);
 743         return lexical_cast<int> (v);
 744 }
 745
 746 float
 747 get_required_float (multimap<string, string> const & kv, string k)
 748 {
 749         string const v = get_required_string (kv, k);
 750         return lexical_cast<float> (v);
 751 }
 752
 753 string
 754 get_optional_string (multimap<string, string> const & kv, string k)
 755 {
 756         if (kv.count (k) > 1) {
 757                 throw StringError ("unexpected multiple keys in key-value set");
 758         }
 759
 760         multimap<string, string>::const_iterator i = kv.find (k);
 761         if (i == kv.end ()) {
 762                 return "";
 763         }
 764
 765         return i->second;
 766 }
 767
 768 int
 769 get_optional_int (multimap<string, string> const & kv, string k)
 770 {
 771         if (kv.count (k) > 1) {
 772                 throw StringError ("unexpected multiple keys in key-value set");
 773         }
 774
 775         multimap<string, string>::const_iterator i = kv.find (k);
 776         if (i == kv.end ()) {
 777                 return 0;
 778         }
 779
 780         return lexical_cast<int> (i->second);
 781 }
 782
 783 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 784  *  @param channels Number of channels.
 785  *  @param frames Number of frames to reserve space for.
 786  */
 787 AudioBuffers::AudioBuffers (int channels, int frames)
 788         : _channels (channels)
 789         , _frames (frames)
 790         , _allocated_frames (frames)
 791 {
 792         _data = new float*[_channels];
 793         for (int i = 0; i < _channels; ++i) {
 794                 _data[i] = new float[frames];
 795         }
 796 }
 797
 798 /** Copy constructor.
 799  *  @param other Other AudioBuffers; data is copied.
 800  */
 801 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 802         : _channels (other._channels)
 803         , _frames (other._frames)
 804         , _allocated_frames (other._frames)
 805 {
 806         _data = new float*[_channels];
 807         for (int i = 0; i < _channels; ++i) {
 808                 _data[i] = new float[_frames];
 809                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 810         }
 811 }
 812
 813 /** AudioBuffers destructor */
 814 AudioBuffers::~AudioBuffers ()
 815 {
 816         for (int i = 0; i < _channels; ++i) {
 817                 delete[] _data[i];
 818         }
 819
 820         delete[] _data;
 821 }
 822
 823 /** @param c Channel index.
 824  *  @return Buffer for this channel.
 825  */
 826 float*
 827 AudioBuffers::data (int c) const
 828 {
 829         assert (c >= 0 && c < _channels);
 830         return _data[c];
 831 }
 832
 833 /** Set the number of frames that these AudioBuffers will report themselves
 834  *  as having.
 835  *  @param f Frames; must be less than or equal to the number of allocated frames.
 836  */
 837 void
 838 AudioBuffers::set_frames (int f)
 839 {
 840         assert (f <= _allocated_frames);
 841         _frames = f;
 842 }
 843
 844 /** Make all samples on all channels silent */
 845 void
 846 AudioBuffers::make_silent ()
 847 {
 848         for (int i = 0; i < _channels; ++i) {
 849                 make_silent (i);
 850         }
 851 }
 852
 853 /** Make all samples on a given channel silent.
 854  *  @param c Channel.
 855  */
 856 void
 857 AudioBuffers::make_silent (int c)
 858 {
 859         assert (c >= 0 && c < _channels);
 860
 861         for (int i = 0; i < _frames; ++i) {
 862                 _data[c][i] = 0;
 863         }
 864 }
 865
 866 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 867  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 868  *  @param frames_to_copy Number of frames to copy.
 869  *  @param read_offset Offset to read from in `from'.
 870  *  @param write_offset Offset to write to in `to'.
 871  */
 872 void
 873 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 874 {
 875         assert (from->channels() == channels());
 876
 877         assert (from);
 878         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 879         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 880
 881         for (int i = 0; i < _channels; ++i) {
 882                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 883         }
 884 }
 885
 886 /** Move audio data around.
 887  *  @param from Offset to move from.
 888  *  @param to Offset to move to.
 889  *  @param frames Number of frames to move.
 890  */
 891
 892 void
 893 AudioBuffers::move (int from, int to, int frames)
 894 {
 895         if (frames == 0) {
 896                 return;
 897         }
 898
 899         assert (from >= 0);
 900         assert (from < _frames);
 901         assert (to >= 0);
 902         assert (to < _frames);
 903         assert (frames > 0);
 904         assert (frames <= _frames);
 905         assert ((from + frames) <= _frames);
 906         assert ((to + frames) <= _frames);
 907
 908         for (int i = 0; i < _channels; ++i) {
 909                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 910         }
 911 }
 912
 913 /** Trip an assert if the caller is not in the UI thread */
 914 void
 915 ensure_ui_thread ()
 916 {
 917         assert (this_thread::get_id() == ui_thread);
 918 }
 919
 920 /** @param v Source video frame.
 921  *  @param audio_sample_rate Source audio sample rate.
 922  *  @param frames_per_second Number of video frames per second.
 923  *  @return Equivalent number of audio frames for `v'.
 924  */
 925 int64_t
 926 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 927 {
 928         return ((int64_t) v * audio_sample_rate / frames_per_second);
 929 }
 930
 931 /** @param f Filename.
 932  *  @return true if this file is a still image, false if it is something else.
 933  */
 934 bool
 935 still_image_file (string f)
 936 {
 937 #if BOOST_FILESYSTEM_VERSION == 3
 938         string ext = boost::filesystem::path(f).extension().string();
 939 #else
 940         string ext = boost::filesystem::path(f).extension();
 941 #endif
 942
 943         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 944
 945         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
 946 }
 947
 948 /** @return A pair containing CPU model name and the number of processors */
 949 pair<string, int>
 950 cpu_info ()
 951 {
 952         pair<string, int> info;
 953         info.second = 0;
 954
 955 #ifdef DVDOMATIC_POSIX
 956         ifstream f ("/proc/cpuinfo");
 957         while (f.good ()) {
 958                 string l;
 959                 getline (f, l);
 960                 if (boost::algorithm::starts_with (l, "model name")) {
 961                         string::size_type const c = l.find (':');
 962                         if (c != string::npos) {
 963                                 info.first = l.substr (c + 2);
 964                         }
 965                 } else if (boost::algorithm::starts_with (l, "processor")) {
 966                         ++info.second;
 967                 }
 968         }
 969 #endif
 970
 971         return info;
 972 }