src/lib/util.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/lib/util.cc
  21  *  @brief Some utility functions and classes.
  22  */
  23
  24 #include "util.h"
  25 #include "exceptions.h"
  26 #include "dcp_content_type.h"
  27 #include "filter.h"
  28 #include "cinema_sound_processor.h"
  29 #include "config.h"
  30 #include "ratio.h"
  31 #include "job.h"
  32 #include "cross.h"
  33 #include "video_content.h"
  34 #include "rect.h"
  35 #include "md5_digester.h"
  36 #include "audio_processor.h"
  37 #include "safe_stringstream.h"
  38 #include <dcp/util.h>
  39 #include <dcp/signer.h>
  40 #include <dcp/picture_asset.h>
  41 #include <dcp/sound_asset.h>
  42 #include <dcp/subtitle_asset.h>
  43 #include <glib.h>
  44 #include <pangomm/init.h>
  45 #include <boost/algorithm/string.hpp>
  46 #include <boost/bind.hpp>
  47 #include <boost/lambda/lambda.hpp>
  48 #include <boost/thread.hpp>
  49 #include <boost/filesystem.hpp>
  50 #ifdef DCPOMATIC_WINDOWS
  51 #include <boost/locale.hpp>
  52 #include <dbghelp.h>
  53 #endif
  54 #include <signal.h>
  55 #include <iomanip>
  56 #include <iostream>
  57 #include <fstream>
  58 #include <climits>
  59 #include <stdexcept>
  60 #ifdef DCPOMATIC_POSIX
  61 #include <execinfo.h>
  62 #include <cxxabi.h>
  63 #endif
  64
  65 #include "i18n.h"
  66
  67 using std::string;
  68 using std::setfill;
  69 using std::ostream;
  70 using std::endl;
  71 using std::vector;
  72 using std::min;
  73 using std::max;
  74 using std::map;
  75 using std::list;
  76 using std::multimap;
  77 using std::istream;
  78 using std::pair;
  79 using std::cout;
  80 using std::bad_alloc;
  81 using std::set_terminate;
  82 using boost::shared_ptr;
  83 using boost::thread;
  84 using boost::optional;
  85 using dcp::Size;
  86
  87 /** Path to our executable, required by the stacktrace stuff and filled
  88  *  in during App::onInit().
  89  */
  90 string program_name;
  91 static boost::thread::id ui_thread;
  92 static boost::filesystem::path backtrace_file;
  93
  94 /** Convert some number of seconds to a string representation
  95  *  in hours, minutes and seconds.
  96  *
  97  *  @param s Seconds.
  98  *  @return String of the form H:M:S (where H is hours, M
  99  *  is minutes and S is seconds).
 100  */
 101 string
 102 seconds_to_hms (int s)
 103 {
 104         int m = s / 60;
 105         s -= (m * 60);
 106         int h = m / 60;
 107         m -= (h * 60);
 108
 109         SafeStringStream hms;
 110         hms << h << N_(":");
 111         hms.width (2);
 112         hms << setfill ('0') << m << N_(":");
 113         hms.width (2);
 114         hms << setfill ('0') << s;
 115
 116         return hms.str ();
 117 }
 118
 119 /** @param s Number of seconds.
 120  *  @return String containing an approximate description of s (e.g. "about 2 hours")
 121  */
 122 string
 123 seconds_to_approximate_hms (int s)
 124 {
 125         int m = s / 60;
 126         s -= (m * 60);
 127         int h = m / 60;
 128         m -= (h * 60);
 129
 130         SafeStringStream ap;
 131
 132         bool const hours = h > 0;
 133         bool const minutes = h < 10 && m > 0;
 134         bool const seconds = m < 10 && s > 0;
 135
 136         if (hours) {
 137                 if (m > 30 && !minutes) {
 138                         /// TRANSLATORS: h here is an abbreviation for hours
 139                         ap << (h + 1) << _("h");
 140                 } else {
 141                         /// TRANSLATORS: h here is an abbreviation for hours
 142                         ap << h << _("h");
 143                 }
 144
 145                 if (minutes | seconds) {
 146                         ap << N_(" ");
 147                 }
 148         }
 149
 150         if (minutes) {
 151                 /* Minutes */
 152                 if (s > 30 && !seconds) {
 153                         /// TRANSLATORS: m here is an abbreviation for minutes
 154                         ap << (m + 1) << _("m");
 155                 } else {
 156                         /// TRANSLATORS: m here is an abbreviation for minutes
 157                         ap << m << _("m");
 158                 }
 159
 160                 if (seconds) {
 161                         ap << N_(" ");
 162                 }
 163         }
 164
 165         if (seconds) {
 166                 /* Seconds */
 167                 /// TRANSLATORS: s here is an abbreviation for seconds
 168                 ap << s << _("s");
 169         }
 170
 171         return ap.str ();
 172 }
 173
 174 double
 175 seconds (struct timeval t)
 176 {
 177         return t.tv_sec + (double (t.tv_usec) / 1e6);
 178 }
 179
 180 #ifdef DCPOMATIC_WINDOWS
 181
 182 /** Resolve symbol name and source location given the path to the executable */
 183 int
 184 addr2line (void const * const addr)
 185 {
 186         char addr2line_cmd[512] = { 0 };
 187         sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
 188         return system(addr2line_cmd);
 189 }
 190
 191 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
 192  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
 193  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
 194  */
 195 LONG WINAPI
 196 exception_handler(struct _EXCEPTION_POINTERS * info)
 197 {
 198         FILE* f = fopen_boost (backtrace_file, "w");
 199         fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
 200         fclose(f);
 201
 202         if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
 203                 CONTEXT* context = info->ContextRecord;
 204                 SymInitialize (GetCurrentProcess (), 0, true);
 205
 206                 STACKFRAME frame = { 0 };
 207
 208                 /* setup initial stack frame */
 209 #if _WIN64
 210                 frame.AddrPC.Offset    = context->Rip;
 211                 frame.AddrStack.Offset = context->Rsp;
 212                 frame.AddrFrame.Offset = context->Rbp;
 213 #else
 214                 frame.AddrPC.Offset    = context->Eip;
 215                 frame.AddrStack.Offset = context->Esp;
 216                 frame.AddrFrame.Offset = context->Ebp;
 217 #endif
 218                 frame.AddrPC.Mode      = AddrModeFlat;
 219                 frame.AddrStack.Mode   = AddrModeFlat;
 220                 frame.AddrFrame.Mode   = AddrModeFlat;
 221
 222                 while (
 223                         StackWalk (
 224                                 IMAGE_FILE_MACHINE_I386,
 225                                 GetCurrentProcess (),
 226                                 GetCurrentThread (),
 227                                 &frame,
 228                                 context,
 229                                 0,
 230                                 SymFunctionTableAccess,
 231                                 SymGetModuleBase,
 232                                 0
 233                                 )
 234                         ) {
 235                         addr2line((void *) frame.AddrPC.Offset);
 236                 }
 237         } else {
 238 #ifdef _WIN64
 239                 addr2line ((void *) info->ContextRecord->Rip);
 240 #else
 241                 addr2line ((void *) info->ContextRecord->Eip);
 242 #endif
 243         }
 244
 245         return EXCEPTION_CONTINUE_SEARCH;
 246 }
 247 #endif
 248
 249 void
 250 set_backtrace_file (boost::filesystem::path p)
 251 {
 252         backtrace_file = p;
 253 }
 254
 255 /** This is called when there is an unhandled exception.  Any
 256  *  backtrace in this function is useless on Windows as the stack has
 257  *  already been unwound from the throw; we have the gdb wrap hack to
 258  *  cope with that.
 259  */
 260 void
 261 terminate ()
 262 {
 263         try {
 264                 static bool tried_throw = false;
 265                 // try once to re-throw currently active exception
 266                 if (!tried_throw) {
 267                         tried_throw = true;
 268                         throw;
 269                 }
 270         }
 271         catch (const std::exception &e) {
 272                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
 273                           << e.what() << std::endl;
 274         }
 275         catch (...) {
 276                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
 277                           << std::endl;
 278         }
 279
 280         abort();
 281 }
 282
 283 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
 284  *  Must be called from the UI thread, if there is one.
 285  */
 286 void
 287 dcpomatic_setup ()
 288 {
 289 #ifdef DCPOMATIC_WINDOWS
 290         boost::filesystem::path p = g_get_user_config_dir ();
 291         p /= "backtrace.txt";
 292         set_backtrace_file (p);
 293         SetUnhandledExceptionFilter(exception_handler);
 294
 295         /* Dark voodoo which, I think, gets boost::filesystem::path to
 296            correctly convert UTF-8 strings to paths, and also paths
 297            back to UTF-8 strings (on path::string()).
 298
 299            After this, constructing boost::filesystem::paths from strings
 300            converts from UTF-8 to UTF-16 inside the path.  Then
 301            path::string().c_str() gives UTF-8 and
 302            path::c_str()          gives UTF-16.
 303
 304            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
 305            so things are much simpler.
 306         */
 307         std::locale::global (boost::locale::generator().generate (""));
 308         boost::filesystem::path::imbue (std::locale ());
 309 #endif
 310
 311         avfilter_register_all ();
 312
 313 #ifdef DCPOMATIC_OSX
 314         /* Add our lib directory to the libltdl search path so that
 315            xmlsec can find xmlsec1-openssl.
 316         */
 317         boost::filesystem::path lib = app_contents ();
 318         lib /= "lib";
 319         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
 320 #endif
 321
 322         set_terminate (terminate);
 323
 324         Pango::init ();
 325         dcp::init ();
 326
 327         Ratio::setup_ratios ();
 328         PresetColourConversion::setup_colour_conversion_presets ();
 329         VideoContentScale::setup_scales ();
 330         DCPContentType::setup_dcp_content_types ();
 331         Filter::setup_filters ();
 332         CinemaSoundProcessor::setup_cinema_sound_processors ();
 333         AudioProcessor::setup_audio_processors ();
 334
 335         ui_thread = boost::this_thread::get_id ();
 336 }
 337
 338 #ifdef DCPOMATIC_WINDOWS
 339 boost::filesystem::path
 340 mo_path ()
 341 {
 342         wchar_t buffer[512];
 343         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
 344         boost::filesystem::path p (buffer);
 345         p = p.parent_path ();
 346         p = p.parent_path ();
 347         p /= "locale";
 348         return p;
 349 }
 350 #endif
 351
 352 #ifdef DCPOMATIC_OSX
 353 boost::filesystem::path
 354 mo_path ()
 355 {
 356         return "DCP-o-matic 2.app/Contents/Resources";
 357 }
 358 #endif
 359
 360 void
 361 dcpomatic_setup_gettext_i18n (string lang)
 362 {
 363 #ifdef DCPOMATIC_LINUX
 364         lang += ".UTF8";
 365 #endif
 366
 367         if (!lang.empty ()) {
 368                 /* Override our environment language.  Note that the caller must not
 369                    free the string passed into putenv().
 370                 */
 371                 string s = String::compose ("LANGUAGE=%1", lang);
 372                 putenv (strdup (s.c_str ()));
 373                 s = String::compose ("LANG=%1", lang);
 374                 putenv (strdup (s.c_str ()));
 375                 s = String::compose ("LC_ALL=%1", lang);
 376                 putenv (strdup (s.c_str ()));
 377         }
 378
 379         setlocale (LC_ALL, "");
 380         textdomain ("libdcpomatic2");
 381
 382 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
 383         bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
 384         bind_textdomain_codeset ("libdcpomatic2", "UTF8");
 385 #endif
 386
 387 #ifdef DCPOMATIC_LINUX
 388         bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
 389 #endif
 390 }
 391
 392 /** Compute a digest of the first and last `size' bytes of a set of files. */
 393 string
 394 md5_digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
 395 {
 396         boost::scoped_array<char> buffer (new char[size]);
 397         MD5Digester digester;
 398
 399         /* Head */
 400         boost::uintmax_t to_do = size;
 401         char* p = buffer.get ();
 402         int i = 0;
 403         while (i < int64_t (files.size()) && to_do > 0) {
 404                 FILE* f = fopen_boost (files[i], "rb");
 405                 if (!f) {
 406                         throw OpenFileError (files[i].string());
 407                 }
 408
 409                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 410                 fread (p, 1, this_time, f);
 411                 p += this_time;
 412                 to_do -= this_time;
 413                 fclose (f);
 414
 415                 ++i;
 416         }
 417         digester.add (buffer.get(), size - to_do);
 418
 419         /* Tail */
 420         to_do = size;
 421         p = buffer.get ();
 422         i = files.size() - 1;
 423         while (i >= 0 && to_do > 0) {
 424                 FILE* f = fopen_boost (files[i], "rb");
 425                 if (!f) {
 426                         throw OpenFileError (files[i].string());
 427                 }
 428
 429                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
 430                 dcpomatic_fseek (f, -this_time, SEEK_END);
 431                 fread (p, 1, this_time, f);
 432                 p += this_time;
 433                 to_do -= this_time;
 434                 fclose (f);
 435
 436                 --i;
 437         }
 438         digester.add (buffer.get(), size - to_do);
 439
 440         return digester.get ();
 441 }
 442
 443 /** @param An arbitrary audio frame rate.
 444  *  @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
 445  */
 446 int
 447 dcp_audio_frame_rate (int fs)
 448 {
 449         if (fs <= 48000) {
 450                 return 48000;
 451         }
 452
 453         return 96000;
 454 }
 455
 456 /** Round a number up to the nearest multiple of another number.
 457  *  @param c Index.
 458  *  @param s Array of numbers to round, indexed by c.
 459  *  @param t Multiple to round to.
 460  *  @return Rounded number.
 461  */
 462 int
 463 stride_round_up (int c, int const * stride, int t)
 464 {
 465         int const a = stride[c] + (t - 1);
 466         return a - (a % t);
 467 }
 468
 469 /** @param n A number.
 470  *  @param r Rounding `boundary' (must be a power of 2)
 471  *  @return n rounded to the nearest r
 472  */
 473 int
 474 round_to (float n, int r)
 475 {
 476         DCPOMATIC_ASSERT (r == 1 || r == 2 || r == 4);
 477         return int (n + float(r) / 2) &~ (r - 1);
 478 }
 479
 480 /** Trip an assert if the caller is not in the UI thread */
 481 void
 482 ensure_ui_thread ()
 483 {
 484         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 485 }
 486
 487 string
 488 audio_channel_name (int c)
 489 {
 490         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 12);
 491
 492         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
 493         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
 494         /// VI is the visually-impaired audio track (audio describe).
 495         string const channels[] = {
 496                 _("Left"),
 497                 _("Right"),
 498                 _("Centre"),
 499                 _("Lfe (sub)"),
 500                 _("Left surround"),
 501                 _("Right surround"),
 502                 _("Hearing impaired"),
 503                 _("Visually impaired"),
 504                 _("Left centre"),
 505                 _("Right centre"),
 506                 _("Left rear surround"),
 507                 _("Right rear surround"),
 508         };
 509
 510         return channels[c];
 511 }
 512
 513 bool
 514 valid_image_file (boost::filesystem::path f)
 515 {
 516         if (boost::starts_with (f.leaf().string(), "._")) {
 517                 return false;
 518         }
 519
 520         string ext = f.extension().string();
 521         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 522         return (
 523                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
 524                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
 525                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2"
 526                 );
 527 }
 528
 529 bool
 530 valid_j2k_file (boost::filesystem::path f)
 531 {
 532         string ext = f.extension().string();
 533         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
 534         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
 535 }
 536
 537 string
 538 tidy_for_filename (string f)
 539 {
 540         string t;
 541         for (size_t i = 0; i < f.length(); ++i) {
 542                 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
 543                         t += f[i];
 544                 } else {
 545                         t += '_';
 546                 }
 547         }
 548
 549         return t;
 550 }
 551
 552 dcp::Size
 553 fit_ratio_within (float ratio, dcp::Size full_frame)
 554 {
 555         if (ratio < full_frame.ratio ()) {
 556                 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
 557         }
 558
 559         return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
 560 }
 561
 562 void *
 563 wrapped_av_malloc (size_t s)
 564 {
 565         void* p = av_malloc (s);
 566         if (!p) {
 567                 throw bad_alloc ();
 568         }
 569         return p;
 570 }
 571
 572 FFmpegSubtitlePeriod
 573 subtitle_period (AVSubtitle const & sub)
 574 {
 575         ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
 576
 577         if (sub.end_display_time == static_cast<uint32_t> (-1)) {
 578                 /* End time is not known */
 579                 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
 580         }
 581
 582         return FFmpegSubtitlePeriod (
 583                 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
 584                 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
 585                 );
 586 }
 587
 588 map<string, string>
 589 split_get_request (string url)
 590 {
 591         enum {
 592                 AWAITING_QUESTION_MARK,
 593                 KEY,
 594                 VALUE
 595         } state = AWAITING_QUESTION_MARK;
 596
 597         map<string, string> r;
 598         string k;
 599         string v;
 600         for (size_t i = 0; i < url.length(); ++i) {
 601                 switch (state) {
 602                 case AWAITING_QUESTION_MARK:
 603                         if (url[i] == '?') {
 604                                 state = KEY;
 605                         }
 606                         break;
 607                 case KEY:
 608                         if (url[i] == '=') {
 609                                 v.clear ();
 610                                 state = VALUE;
 611                         } else {
 612                                 k += url[i];
 613                         }
 614                         break;
 615                 case VALUE:
 616                         if (url[i] == '&') {
 617                                 r.insert (make_pair (k, v));
 618                                 k.clear ();
 619                                 state = KEY;
 620                         } else {
 621                                 v += url[i];
 622                         }
 623                         break;
 624                 }
 625         }
 626
 627         if (state == VALUE) {
 628                 r.insert (make_pair (k, v));
 629         }
 630
 631         return r;
 632 }
 633
 634 string
 635 video_asset_filename (shared_ptr<dcp::PictureAsset> asset)
 636 {
 637         return "j2c_" + asset->id() + ".mxf";
 638 }
 639
 640 string
 641 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset)
 642 {
 643         return "pcm_" + asset->id() + ".mxf";
 644 }