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         Format::setup_formats ();
 237         DCPContentType::setup_dcp_content_types ();
 238         Scaler::setup_scalers ();
 239         Filter::setup_filters ();
 240         SoundProcessor::setup_sound_processors ();
 241
 242         ui_thread = this_thread::get_id ();
 243 }
 244
 245 /** @param start Start position for the crop within the image.
 246  *  @param size Size of the cropped area.
 247  *  @return FFmpeg crop filter string.
 248  */
 249 string
 250 crop_string (Position start, Size size)
 251 {
 252         stringstream s;
 253         s << "crop=" << size.width << ":" << size.height << ":" << start.x << ":" << start.y;
 254         return s.str ();
 255 }
 256
 257 /** @param s A string.
 258  *  @return Parts of the string split at spaces, except when a space is within quotation marks.
 259  */
 260 vector<string>
 261 split_at_spaces_considering_quotes (string s)
 262 {
 263         vector<string> out;
 264         bool in_quotes = false;
 265         string c;
 266         for (string::size_type i = 0; i < s.length(); ++i) {
 267                 if (s[i] == ' ' && !in_quotes) {
 268                         out.push_back (c);
 269                         c = "";
 270                 } else if (s[i] == '"') {
 271                         in_quotes = !in_quotes;
 272                 } else {
 273                         c += s[i];
 274                 }
 275         }
 276
 277         out.push_back (c);
 278         return out;
 279 }
 280
 281 string
 282 md5_digest (void const * data, int size)
 283 {
 284         MD5_CTX md5_context;
 285         MD5_Init (&md5_context);
 286         MD5_Update (&md5_context, data, size);
 287         unsigned char digest[MD5_DIGEST_LENGTH];
 288         MD5_Final (digest, &md5_context);
 289
 290         stringstream s;
 291         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 292                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 293         }
 294
 295         return s.str ();
 296 }
 297
 298 /** @param file File name.
 299  *  @return MD5 digest of file's contents.
 300  */
 301 string
 302 md5_digest (string file)
 303 {
 304         ifstream f (file.c_str(), ios::binary);
 305         if (!f.good ()) {
 306                 throw OpenFileError (file);
 307         }
 308
 309         f.seekg (0, ios::end);
 310         int bytes = f.tellg ();
 311         f.seekg (0, ios::beg);
 312
 313         int const buffer_size = 64 * 1024;
 314         char buffer[buffer_size];
 315
 316         MD5_CTX md5_context;
 317         MD5_Init (&md5_context);
 318         while (bytes > 0) {
 319                 int const t = min (bytes, buffer_size);
 320                 f.read (buffer, t);
 321                 MD5_Update (&md5_context, buffer, t);
 322                 bytes -= t;
 323         }
 324
 325         unsigned char digest[MD5_DIGEST_LENGTH];
 326         MD5_Final (digest, &md5_context);
 327
 328         stringstream s;
 329         for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
 330                 s << hex << setfill('0') << setw(2) << ((int) digest[i]);
 331         }
 332
 333         return s.str ();
 334 }
 335
 336 static bool about_equal (float a, float b)
 337 {
 338         /* A film of F seconds at f FPS will be Ff frames;
 339            Consider some delta FPS d, so if we run the same
 340            film at (f + d) FPS it will last F(f + d) seconds.
 341
 342            Hence the difference in length over the length of the film will
 343            be F(f + d) - Ff frames
 344             = Ff + Fd - Ff frames
 345             = Fd frames
 346             = Fd/f seconds
 347
 348            So if we accept a difference of 1 frame, ie 1/f seconds, we can
 349            say that
 350
 351            1/f = Fd/f
 352         ie 1 = Fd
 353         ie d = 1/F
 354
 355            So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
 356            FPS error is 1/F ~= 0.0001 ~= 10-e4
 357         */
 358
 359         return (fabs (a - b) < 1e-4);
 360 }
 361
 362 class FrameRateCandidate
 363 {
 364 public:
 365         FrameRateCandidate (float source_, int dcp_)
 366                 : source (source_)
 367                 , dcp (dcp_)
 368         {}
 369
 370         bool skip () const {
 371                 return !about_equal (source, dcp) && source > dcp;
 372         }
 373
 374         bool repeat () const {
 375                 return !about_equal (source, dcp) && source < dcp;
 376         }
 377
 378         float source;
 379         int dcp;
 380 };
 381
 382 /** @param fps Arbitrary source frames-per-second value */
 383 /** XXX: this could be slow-ish */
 384 DCPFrameRate::DCPFrameRate (float source_fps)
 385 {
 386         list<int> const allowed_dcp_frame_rates = Config::instance()->allowed_dcp_frame_rates ();
 387
 388         /* Work out what rates we could manage, including those achieved by using skip / repeat. */
 389         list<FrameRateCandidate> candidates;
 390
 391         /* Start with the ones without skip / repeat so they will get matched in preference to skipped/repeated ones */
 392         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 393                 candidates.push_back (FrameRateCandidate (*i, *i));
 394         }
 395
 396         /* Then the skip/repeat ones */
 397         for (list<int>::const_iterator i = allowed_dcp_frame_rates.begin(); i != allowed_dcp_frame_rates.end(); ++i) {
 398                 candidates.push_back (FrameRateCandidate (float (*i) / 2, *i));
 399                 candidates.push_back (FrameRateCandidate (float (*i) * 2, *i));
 400         }
 401
 402         /* Pick the best one, bailing early if we hit an exact match */
 403         float error = numeric_limits<float>::max ();
 404         boost::optional<FrameRateCandidate> best;
 405         list<FrameRateCandidate>::iterator i = candidates.begin();
 406         while (i != candidates.end()) {
 407
 408                 if (about_equal (i->source, source_fps)) {
 409                         best = *i;
 410                         break;
 411                 }
 412
 413                 float const e = fabs (i->source - source_fps);
 414                 if (e < error) {
 415                         error = e;
 416                         best = *i;
 417                 }
 418
 419                 ++i;
 420         }
 421
 422         if (!best) {
 423                 throw EncodeError ("cannot find a suitable DCP frame rate for this source");
 424         }
 425
 426         frames_per_second = best->dcp;
 427         skip = best->skip ();
 428         repeat = best->repeat ();
 429         change_speed = !about_equal (source_fps * factor(), frames_per_second);
 430 }
 431
 432 /** @param An arbitrary sampling rate.
 433  *  @return The appropriate DCP-approved sampling rate (48kHz or 96kHz).
 434  */
 435 int
 436 dcp_audio_sample_rate (int fs)
 437 {
 438         if (fs <= 48000) {
 439                 return 48000;
 440         }
 441
 442         return 96000;
 443 }
 444
 445 int
 446 dcp_audio_channels (int f)
 447 {
 448         if (f == 1) {
 449                 /* The source is mono, so to put the mono channel into
 450                    the centre we need to generate a 5.1 soundtrack.
 451                 */
 452                 return 6;
 453         }
 454
 455         return f;
 456 }
 457
 458
 459 bool operator== (Crop const & a, Crop const & b)
 460 {
 461         return (a.left == b.left && a.right == b.right && a.top == b.top && a.bottom == b.bottom);
 462 }
 463
 464 bool operator!= (Crop const & a, Crop const & b)
 465 {
 466         return !(a == b);
 467 }
 468
 469 /** @param index Colour LUT index.
 470  *  @return Human-readable name.
 471  */
 472 string
 473 colour_lut_index_to_name (int index)
 474 {
 475         switch (index) {
 476         case 0:
 477                 return "sRGB";
 478         case 1:
 479                 return "Rec 709";
 480         }
 481
 482         assert (false);
 483         return "";
 484 }
 485
 486 Socket::Socket ()
 487         : _deadline (_io_service)
 488         , _socket (_io_service)
 489         , _buffer_data (0)
 490 {
 491         _deadline.expires_at (posix_time::pos_infin);
 492         check ();
 493 }
 494
 495 void
 496 Socket::check ()
 497 {
 498         if (_deadline.expires_at() <= asio::deadline_timer::traits_type::now ()) {
 499                 _socket.close ();
 500                 _deadline.expires_at (posix_time::pos_infin);
 501         }
 502
 503         _deadline.async_wait (boost::bind (&Socket::check, this));
 504 }
 505
 506 /** Blocking connect with timeout.
 507  *  @param endpoint End-point to connect to.
 508  *  @param timeout Time-out in seconds.
 509  */
 510 void
 511 Socket::connect (asio::ip::basic_resolver_entry<asio::ip::tcp> const & endpoint, int timeout)
 512 {
 513         _deadline.expires_from_now (posix_time::seconds (timeout));
 514         system::error_code ec = asio::error::would_block;
 515         _socket.async_connect (endpoint, lambda::var(ec) = lambda::_1);
 516         do {
 517                 _io_service.run_one();
 518         } while (ec == asio::error::would_block);
 519
 520         if (ec || !_socket.is_open ()) {
 521                 throw NetworkError ("connect timed out");
 522         }
 523 }
 524
 525 /** Blocking write with timeout.
 526  *  @param data Buffer to write.
 527  *  @param size Number of bytes to write.
 528  *  @param timeout Time-out, in seconds.
 529  */
 530 void
 531 Socket::write (uint8_t const * data, int size, int timeout)
 532 {
 533         _deadline.expires_from_now (posix_time::seconds (timeout));
 534         system::error_code ec = asio::error::would_block;
 535
 536         asio::async_write (_socket, asio::buffer (data, size), lambda::var(ec) = lambda::_1);
 537         do {
 538                 _io_service.run_one ();
 539         } while (ec == asio::error::would_block);
 540
 541         if (ec) {
 542                 throw NetworkError ("write timed out");
 543         }
 544 }
 545
 546 /** Blocking read with timeout.
 547  *  @param data Buffer to read to.
 548  *  @param size Number of bytes to read.
 549  *  @param timeout Time-out, in seconds.
 550  */
 551 int
 552 Socket::read (uint8_t* data, int size, int timeout)
 553 {
 554         _deadline.expires_from_now (posix_time::seconds (timeout));
 555         system::error_code ec = asio::error::would_block;
 556
 557         int amount_read = 0;
 558
 559         _socket.async_read_some (
 560                 asio::buffer (data, size),
 561                 (lambda::var(ec) = lambda::_1, lambda::var(amount_read) = lambda::_2)
 562                 );
 563
 564         do {
 565                 _io_service.run_one ();
 566         } while (ec == asio::error::would_block);
 567
 568         if (ec) {
 569                 amount_read = 0;
 570         }
 571
 572         return amount_read;
 573 }
 574
 575 /** Mark some data as being `consumed', so that it will not be returned
 576  *  as data again.
 577  *  @param size Amount of data to consume, in bytes.
 578  */
 579 void
 580 Socket::consume (int size)
 581 {
 582         assert (_buffer_data >= size);
 583
 584         _buffer_data -= size;
 585         if (_buffer_data > 0) {
 586                 /* Shift still-valid data to the start of the buffer */
 587                 memmove (_buffer, _buffer + size, _buffer_data);
 588         }
 589 }
 590
 591 /** Read a definite amount of data from our socket, and mark
 592  *  it as consumed.
 593  *  @param data Where to put the data.
 594  *  @param size Number of bytes to read.
 595  */
 596 void
 597 Socket::read_definite_and_consume (uint8_t* data, int size, int timeout)
 598 {
 599         int const from_buffer = min (_buffer_data, size);
 600         if (from_buffer > 0) {
 601                 /* Get data from our buffer */
 602                 memcpy (data, _buffer, from_buffer);
 603                 consume (from_buffer);
 604                 /* Update our output state */
 605                 data += from_buffer;
 606                 size -= from_buffer;
 607         }
 608
 609         /* read() the rest */
 610         while (size > 0) {
 611                 int const n = read (data, size, timeout);
 612                 if (n <= 0) {
 613                         throw NetworkError ("could not read");
 614                 }
 615
 616                 data += n;
 617                 size -= n;
 618         }
 619 }
 620
 621 /** Read as much data as is available, up to some limit.
 622  *  @param data Where to put the data.
 623  *  @param size Maximum amount of data to read.
 624  */
 625 void
 626 Socket::read_indefinite (uint8_t* data, int size, int timeout)
 627 {
 628         assert (size < int (sizeof (_buffer)));
 629
 630         /* Amount of extra data we need to read () */
 631         int to_read = size - _buffer_data;
 632         while (to_read > 0) {
 633                 /* read as much of it as we can (into our buffer) */
 634                 int const n = read (_buffer + _buffer_data, to_read, timeout);
 635                 if (n <= 0) {
 636                         throw NetworkError ("could not read");
 637                 }
 638
 639                 to_read -= n;
 640                 _buffer_data += n;
 641         }
 642
 643         assert (_buffer_data >= size);
 644
 645         /* copy data into the output buffer */
 646         assert (size >= _buffer_data);
 647         memcpy (data, _buffer, size);
 648 }
 649
 650 /** @param other A Rect.
 651  *  @return The intersection of this with `other'.
 652  */
 653 Rect
 654 Rect::intersection (Rect const & other) const
 655 {
 656         int const tx = max (x, other.x);
 657         int const ty = max (y, other.y);
 658
 659         return Rect (
 660                 tx, ty,
 661                 min (x + width, other.x + other.width) - tx,
 662                 min (y + height, other.y + other.height) - ty
 663                 );
 664 }
 665
 666 /** Round a number up to the nearest multiple of another number.
 667  *  @param c Index.
 668  *  @param s Array of numbers to round, indexed by c.
 669  *  @param t Multiple to round to.
 670  *  @return Rounded number.
 671  */
 672 int
 673 stride_round_up (int c, int const * stride, int t)
 674 {
 675         int const a = stride[c] + (t - 1);
 676         return a - (a % t);
 677 }
 678
 679 int
 680 stride_lookup (int c, int const * stride)
 681 {
 682         return stride[c];
 683 }
 684
 685 /** Read a sequence of key / value pairs from a text stream;
 686  *  the keys are the first words on the line, and the values are
 687  *  the remainder of the line following the key.  Lines beginning
 688  *  with # are ignored.
 689  *  @param s Stream to read.
 690  *  @return key/value pairs.
 691  */
 692 multimap<string, string>
 693 read_key_value (istream &s)
 694 {
 695         multimap<string, string> kv;
 696
 697         string line;
 698         while (getline (s, line)) {
 699                 if (line.empty ()) {
 700                         continue;
 701                 }
 702
 703                 if (line[0] == '#') {
 704                         continue;
 705                 }
 706
 707                 if (line[line.size() - 1] == '\r') {
 708                         line = line.substr (0, line.size() - 1);
 709                 }
 710
 711                 size_t const s = line.find (' ');
 712                 if (s == string::npos) {
 713                         continue;
 714                 }
 715
 716                 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
 717         }
 718
 719         return kv;
 720 }
 721
 722 string
 723 get_required_string (multimap<string, string> const & kv, string k)
 724 {
 725         if (kv.count (k) > 1) {
 726                 throw StringError ("unexpected multiple keys in key-value set");
 727         }
 728
 729         multimap<string, string>::const_iterator i = kv.find (k);
 730
 731         if (i == kv.end ()) {
 732                 throw StringError (String::compose ("missing key %1 in key-value set", k));
 733         }
 734
 735         return i->second;
 736 }
 737
 738 int
 739 get_required_int (multimap<string, string> const & kv, string k)
 740 {
 741         string const v = get_required_string (kv, k);
 742         return lexical_cast<int> (v);
 743 }
 744
 745 float
 746 get_required_float (multimap<string, string> const & kv, string k)
 747 {
 748         string const v = get_required_string (kv, k);
 749         return lexical_cast<float> (v);
 750 }
 751
 752 string
 753 get_optional_string (multimap<string, string> const & kv, string k)
 754 {
 755         if (kv.count (k) > 1) {
 756                 throw StringError ("unexpected multiple keys in key-value set");
 757         }
 758
 759         multimap<string, string>::const_iterator i = kv.find (k);
 760         if (i == kv.end ()) {
 761                 return "";
 762         }
 763
 764         return i->second;
 765 }
 766
 767 int
 768 get_optional_int (multimap<string, string> const & kv, string k)
 769 {
 770         if (kv.count (k) > 1) {
 771                 throw StringError ("unexpected multiple keys in key-value set");
 772         }
 773
 774         multimap<string, string>::const_iterator i = kv.find (k);
 775         if (i == kv.end ()) {
 776                 return 0;
 777         }
 778
 779         return lexical_cast<int> (i->second);
 780 }
 781
 782 /** Construct an AudioBuffers.  Audio data is undefined after this constructor.
 783  *  @param channels Number of channels.
 784  *  @param frames Number of frames to reserve space for.
 785  */
 786 AudioBuffers::AudioBuffers (int channels, int frames)
 787         : _channels (channels)
 788         , _frames (frames)
 789         , _allocated_frames (frames)
 790 {
 791         _data = new float*[_channels];
 792         for (int i = 0; i < _channels; ++i) {
 793                 _data[i] = new float[frames];
 794         }
 795 }
 796
 797 /** Copy constructor.
 798  *  @param other Other AudioBuffers; data is copied.
 799  */
 800 AudioBuffers::AudioBuffers (AudioBuffers const & other)
 801         : _channels (other._channels)
 802         , _frames (other._frames)
 803         , _allocated_frames (other._frames)
 804 {
 805         _data = new float*[_channels];
 806         for (int i = 0; i < _channels; ++i) {
 807                 _data[i] = new float[_frames];
 808                 memcpy (_data[i], other._data[i], _frames * sizeof (float));
 809         }
 810 }
 811
 812 /** AudioBuffers destructor */
 813 AudioBuffers::~AudioBuffers ()
 814 {
 815         for (int i = 0; i < _channels; ++i) {
 816                 delete[] _data[i];
 817         }
 818
 819         delete[] _data;
 820 }
 821
 822 /** @param c Channel index.
 823  *  @return Buffer for this channel.
 824  */
 825 float*
 826 AudioBuffers::data (int c) const
 827 {
 828         assert (c >= 0 && c < _channels);
 829         return _data[c];
 830 }
 831
 832 /** Set the number of frames that these AudioBuffers will report themselves
 833  *  as having.
 834  *  @param f Frames; must be less than or equal to the number of allocated frames.
 835  */
 836 void
 837 AudioBuffers::set_frames (int f)
 838 {
 839         assert (f <= _allocated_frames);
 840         _frames = f;
 841 }
 842
 843 /** Make all samples on all channels silent */
 844 void
 845 AudioBuffers::make_silent ()
 846 {
 847         for (int i = 0; i < _channels; ++i) {
 848                 make_silent (i);
 849         }
 850 }
 851
 852 /** Make all samples on a given channel silent.
 853  *  @param c Channel.
 854  */
 855 void
 856 AudioBuffers::make_silent (int c)
 857 {
 858         assert (c >= 0 && c < _channels);
 859
 860         for (int i = 0; i < _frames; ++i) {
 861                 _data[c][i] = 0;
 862         }
 863 }
 864
 865 /** Copy data from another AudioBuffers to this one.  All channels are copied.
 866  *  @param from AudioBuffers to copy from; must have the same number of channels as this.
 867  *  @param frames_to_copy Number of frames to copy.
 868  *  @param read_offset Offset to read from in `from'.
 869  *  @param write_offset Offset to write to in `to'.
 870  */
 871 void
 872 AudioBuffers::copy_from (AudioBuffers* from, int frames_to_copy, int read_offset, int write_offset)
 873 {
 874         assert (from->channels() == channels());
 875
 876         assert (from);
 877         assert (read_offset >= 0 && (read_offset + frames_to_copy) <= from->_allocated_frames);
 878         assert (write_offset >= 0 && (write_offset + frames_to_copy) <= _allocated_frames);
 879
 880         for (int i = 0; i < _channels; ++i) {
 881                 memcpy (_data[i] + write_offset, from->_data[i] + read_offset, frames_to_copy * sizeof(float));
 882         }
 883 }
 884
 885 /** Move audio data around.
 886  *  @param from Offset to move from.
 887  *  @param to Offset to move to.
 888  *  @param frames Number of frames to move.
 889  */
 890
 891 void
 892 AudioBuffers::move (int from, int to, int frames)
 893 {
 894         if (frames == 0) {
 895                 return;
 896         }
 897
 898         assert (from >= 0);
 899         assert (from < _frames);
 900         assert (to >= 0);
 901         assert (to < _frames);
 902         assert (frames > 0);
 903         assert (frames <= _frames);
 904         assert ((from + frames) <= _frames);
 905         assert ((to + frames) <= _frames);
 906
 907         for (int i = 0; i < _channels; ++i) {
 908                 memmove (_data[i] + to, _data[i] + from, frames * sizeof(float));
 909         }
 910 }
 911
 912 /** Trip an assert if the caller is not in the UI thread */
 913 void
 914 ensure_ui_thread ()
 915 {
 916         assert (this_thread::get_id() == ui_thread);
 917 }
 918
 919 /** @param v Source video frame.
 920  *  @param audio_sample_rate Source audio sample rate.
 921  *  @param frames_per_second Number of video frames per second.
 922  *  @return Equivalent number of audio frames for `v'.
 923  */
 924 int64_t
 925 video_frames_to_audio_frames (SourceFrame v, float audio_sample_rate, float frames_per_second)
 926 {
 927         return ((int64_t) v * audio_sample_rate / frames_per_second);
 928 }
 929
 930 /** @param f Filename.
 931  *  @return true if this file is a still image, false if it is something else.
 932  */
 933 bool
 934 still_image_file (string f)
 935 {
 936 #if BOOST_FILESYSTEM_VERSION == 3
 937         string ext = boost::filesystem::path(f).extension().string();
 938 #else
 939         string ext = boost::filesystem::path(f).extension();
 940 #endif
 941
 942         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 943
 944         return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png");
 945 }
 946
 947 /** @return A pair containing CPU model name and the number of processors */
 948 pair<string, int>
 949 cpu_info ()
 950 {
 951         pair<string, int> info;
 952         info.second = 0;
 953
 954 #ifdef DVDOMATIC_POSIX
 955         ifstream f ("/proc/cpuinfo");
 956         while (f.good ()) {
 957                 string l;
 958                 getline (f, l);
 959                 if (boost::algorithm::starts_with (l, "model name")) {
 960                         string::size_type const c = l.find (':');
 961                         if (c != string::npos) {
 962                                 info.first = l.substr (c + 2);
 963                         }
 964                 } else if (boost::algorithm::starts_with (l, "processor")) {
 965                         ++info.second;
 966                 }
 967         }
 968 #endif
 969
 970         return info;
 971 }