Merge master.
[dcpomatic.git] / src / lib / util.cc
index 667ee8ce95926f8c10bf24db3c71d2a41fa77b76..40e9d9c2eed730795a8f8476533ae16290c403c0 100644 (file)
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
     Copyright (C) 2000-2007 Paul Davis
 
     This program is free software; you can redistribute it and/or modify
@@ -27,6 +27,7 @@
 #include <iostream>
 #include <fstream>
 #include <climits>
+#include <stdexcept>
 #ifdef DCPOMATIC_POSIX
 #include <execinfo.h>
 #include <cxxabi.h>
 #include <boost/lexical_cast.hpp>
 #include <boost/thread.hpp>
 #include <boost/filesystem.hpp>
+#ifdef DCPOMATIC_WINDOWS
+#include <boost/locale.hpp>
+#endif
 #include <glib.h>
 #include <openjpeg.h>
 #include <openssl/md5.h>
+#include <pangomm/init.h>
 #include <magick/MagickCore.h>
 #include <magick/version.h>
-#include <libdcp/version.h>
-#include <libdcp/util.h>
+#include <dcp/version.h>
+#include <dcp/util.h>
+#include <dcp/signer_chain.h>
+#include <dcp/signer.h>
 extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavformat/avformat.h>
 #include <libswscale/swscale.h>
 #include <libavfilter/avfiltergraph.h>
-#include <libpostproc/postprocess.h>
 #include <libavutil/pixfmt.h>
 }
 #include "util.h"
@@ -63,6 +69,9 @@ extern "C" {
 #include "config.h"
 #include "ratio.h"
 #include "job.h"
+#include "cross.h"
+#include "video_content.h"
+#include "rect.h"
 #ifdef DCPOMATIC_WINDOWS
 #include "stack.hpp"
 #endif
@@ -77,21 +86,24 @@ using std::endl;
 using std::vector;
 using std::hex;
 using std::setw;
-using std::ifstream;
 using std::ios;
 using std::min;
 using std::max;
 using std::list;
 using std::multimap;
+using std::map;
 using std::istream;
 using std::numeric_limits;
 using std::pair;
-using std::ofstream;
+using std::cout;
+using std::bad_alloc;
+using std::streampos;
+using std::set_terminate;
 using boost::shared_ptr;
 using boost::thread;
 using boost::lexical_cast;
 using boost::optional;
-using libdcp::Size;
+using dcp::Size;
 
 static boost::thread::id ui_thread;
 static boost::filesystem::path backtrace_file;
@@ -227,25 +239,6 @@ ffmpeg_version_to_string (int v)
        return s.str ();
 }
 
-/** Return a user-readable string summarising the versions of our dependencies */
-string
-dependency_version_summary ()
-{
-       stringstream s;
-       s << N_("libopenjpeg ") << opj_version () << N_(", ")
-         << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
-         << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
-         << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
-         << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
-         << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
-         << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
-         << MagickVersion << N_(", ")
-         << N_("libssh ") << ssh_version (0) << N_(", ")
-         << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
-
-       return s.str ();
-}
-
 double
 seconds (struct timeval t)
 {
@@ -256,12 +249,42 @@ seconds (struct timeval t)
 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
 {
        dbg::stack s;
-       ofstream f (backtrace_file.string().c_str());
-       std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
+       FILE* f = fopen_boost (backtrace_file, "w");
+       for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
+               fprintf (f, "%p %s %d %s", i->instruction, i->function.c_str(), i->line, i->module.c_str());
+       }
+       fclose (f);
        return EXCEPTION_CONTINUE_SEARCH;
 }
 #endif
 
+/* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
+void
+terminate ()
+{
+       static bool tried_throw = false;
+
+       try {
+               // try once to re-throw currently active exception
+               if (!tried_throw++) {
+                       throw;
+               }
+       }
+       catch (const std::exception &e) {
+               std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
+                         << e.what() << std::endl;
+       }
+       catch (...) {
+               std::cerr << __FUNCTION__ << " caught unknown/unhandled exception." 
+                         << std::endl;
+       }
+
+#ifdef DCPOMATIC_POSIX
+       stacktrace (cout, 50);
+#endif
+       abort();
+}
+
 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
  *  Must be called from the UI thread, if there is one.
  */
@@ -272,13 +295,41 @@ dcpomatic_setup ()
        backtrace_file /= g_get_user_config_dir ();
        backtrace_file /= "backtrace.txt";
        SetUnhandledExceptionFilter(exception_handler);
+
+       /* Dark voodoo which, I think, gets boost::filesystem::path to
+          correctly convert UTF-8 strings to paths, and also paths
+          back to UTF-8 strings (on path::string()).
+
+          After this, constructing boost::filesystem::paths from strings
+          converts from UTF-8 to UTF-16 inside the path.  Then
+          path::string().c_str() gives UTF-8 and
+          path::c_str()          gives UTF-16.
+
+          This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
+          so things are much simpler.
+       */
+       std::locale::global (boost::locale::generator().generate (""));
+       boost::filesystem::path::imbue (std::locale ());
 #endif 
        
        avfilter_register_all ();
 
-       libdcp::init ();
+#ifdef DCPOMATIC_OSX
+       /* Add our lib directory to the libltdl search path so that
+          xmlsec can find xmlsec1-openssl.
+       */
+       boost::filesystem::path lib = app_contents ();
+       lib /= "lib";
+       setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
+#endif
+
+       set_terminate (terminate);
+
+       Pango::init ();
+       dcp::init ();
        
        Ratio::setup_ratios ();
+       VideoContentScale::setup_scales ();
        DCPContentType::setup_dcp_content_types ();
        Scaler::setup_scalers ();
        Filter::setup_filters ();
@@ -317,6 +368,8 @@ dcpomatic_setup_gettext_i18n (string lang)
                putenv (cmd);
                snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
                putenv (cmd);
+               snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
+               putenv (cmd);
        }
 
        setlocale (LC_ALL, "");
@@ -373,83 +426,42 @@ md5_digest (void const * data, int size)
        return s.str ();
 }
 
-/** @param file File name.
- *  @return MD5 digest of file's contents.
- */
-string
-md5_digest (boost::filesystem::path file)
-{
-       ifstream f (file.string().c_str(), std::ios::binary);
-       if (!f.good ()) {
-               throw OpenFileError (file.string());
-       }
-       
-       f.seekg (0, std::ios::end);
-       int bytes = f.tellg ();
-       f.seekg (0, std::ios::beg);
-
-       int const buffer_size = 64 * 1024;
-       char buffer[buffer_size];
-
-       MD5_CTX md5_context;
-       MD5_Init (&md5_context);
-       while (bytes > 0) {
-               int const t = min (bytes, buffer_size);
-               f.read (buffer, t);
-               MD5_Update (&md5_context, buffer, t);
-               bytes -= t;
-       }
-
-       unsigned char digest[MD5_DIGEST_LENGTH];
-       MD5_Final (digest, &md5_context);
-
-       stringstream s;
-       for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
-               s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
-       }
-
-       return s.str ();
-}
-
 /** @param job Optional job for which to report progress */
 string
-md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
+md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
 {
-       int const buffer_size = 64 * 1024;
+       boost::uintmax_t const buffer_size = 64 * 1024;
        char buffer[buffer_size];
 
        MD5_CTX md5_context;
        MD5_Init (&md5_context);
 
-       int files = 0;
-       if (job) {
-               for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
-                       ++files;
-               }
+       vector<int64_t> sizes;
+       for (size_t i = 0; i < files.size(); ++i) {
+               sizes.push_back (boost::filesystem::file_size (files[i]));
        }
 
-       int j = 0;
-       for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
-               ifstream f (i->path().string().c_str(), std::ios::binary);
-               if (!f.good ()) {
-                       throw OpenFileError (i->path().string());
+       for (size_t i = 0; i < files.size(); ++i) {
+               FILE* f = fopen_boost (files[i], "rb");
+               if (!f) {
+                       throw OpenFileError (files[i].string());
                }
-       
-               f.seekg (0, std::ios::end);
-               int bytes = f.tellg ();
-               f.seekg (0, std::ios::beg);
 
-               while (bytes > 0) {
-                       int const t = min (bytes, buffer_size);
-                       f.read (buffer, t);
+               boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
+               boost::uintmax_t remaining = bytes;
+
+               while (remaining > 0) {
+                       int const t = min (remaining, buffer_size);
+                       fread (buffer, 1, t, f);
                        MD5_Update (&md5_context, buffer, t);
-                       bytes -= t;
-               }
+                       remaining -= t;
 
-               if (job) {
-                       job->set_progress (float (j) / files);
-                       ++j;
+                       if (job) {
+                               job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
+                       }
                }
+
+               fclose (f);
        }
 
        unsigned char digest[MD5_DIGEST_LENGTH];
@@ -463,33 +475,6 @@ md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
        return s.str ();
 }
 
-static bool
-about_equal (float a, float b)
-{
-       /* A film of F seconds at f FPS will be Ff frames;
-          Consider some delta FPS d, so if we run the same
-          film at (f + d) FPS it will last F(f + d) seconds.
-
-          Hence the difference in length over the length of the film will
-          be F(f + d) - Ff frames
-           = Ff + Fd - Ff frames
-           = Fd frames
-           = Fd/f seconds
-          So if we accept a difference of 1 frame, ie 1/f seconds, we can
-          say that
-
-          1/f = Fd/f
-       ie 1 = Fd
-       ie d = 1/F
-          So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
-          FPS error is 1/F ~= 0.0001 ~= 10-e4
-       */
-
-       return (fabs (a - b) < 1e-4);
-}
-
 /** @param An arbitrary audio frame rate.
  *  @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
  */
@@ -506,17 +491,27 @@ dcp_audio_frame_rate (int fs)
 Socket::Socket (int timeout)
        : _deadline (_io_service)
        , _socket (_io_service)
+       , _acceptor (0)
        , _timeout (timeout)
 {
        _deadline.expires_at (boost::posix_time::pos_infin);
        check ();
 }
 
+Socket::~Socket ()
+{
+       delete _acceptor;
+}
+
 void
 Socket::check ()
 {
        if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
-               _socket.close ();
+               if (_acceptor) {
+                       _acceptor->cancel ();
+               } else {
+                       _socket.close ();
+               }
                _deadline.expires_at (boost::posix_time::pos_infin);
        }
 
@@ -527,7 +522,7 @@ Socket::check ()
  *  @param endpoint End-point to connect to.
  */
 void
-Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
+Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
 {
        _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
        boost::system::error_code ec = boost::asio::error::would_block;
@@ -536,11 +531,35 @@ Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> con
                _io_service.run_one();
        } while (ec == boost::asio::error::would_block);
 
-       if (ec || !_socket.is_open ()) {
+       if (ec) {
+               throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
+       }
+
+       if (!_socket.is_open ()) {
                throw NetworkError (_("connect timed out"));
        }
 }
 
+void
+Socket::accept (int port)
+{
+       _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
+       
+       _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
+       boost::system::error_code ec = boost::asio::error::would_block;
+       _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
+       do {
+               _io_service.run_one ();
+       } while (ec == boost::asio::error::would_block );
+
+       delete _acceptor;
+       _acceptor = 0;
+       
+       if (ec) {
+               throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
+       }
+}
+
 /** Blocking write.
  *  @param data Buffer to write.
  *  @param size Number of bytes to write.
@@ -558,7 +577,7 @@ Socket::write (uint8_t const * data, int size)
        } while (ec == boost::asio::error::would_block);
 
        if (ec) {
-               throw NetworkError (ec.message ());
+               throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
        }
 }
 
@@ -586,7 +605,7 @@ Socket::read (uint8_t* data, int size)
        } while (ec == boost::asio::error::would_block);
        
        if (ec) {
-               throw NetworkError (ec.message ());
+               throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
        }
 }
 
@@ -715,24 +734,14 @@ ensure_ui_thread ()
        assert (boost::this_thread::get_id() == ui_thread);
 }
 
-/** @param v Content video frame.
- *  @param audio_sample_rate Source audio sample rate.
- *  @param frames_per_second Number of video frames per second.
- *  @return Equivalent number of audio frames for `v'.
- */
-int64_t
-video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
-{
-       return ((int64_t) v * audio_sample_rate / frames_per_second);
-}
-
 string
 audio_channel_name (int c)
 {
-       assert (MAX_AUDIO_CHANNELS == 6);
+       assert (MAX_AUDIO_CHANNELS == 12);
 
        /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
-          enhancement channel (sub-woofer)./
+          enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
+          VI is the visually-impaired audio track (audio describe).
        */
        string const channels[] = {
                _("Left"),
@@ -741,40 +750,17 @@ audio_channel_name (int c)
                _("Lfe (sub)"),
                _("Left surround"),
                _("Right surround"),
+               _("Hearing impaired"),
+               _("Visually impaired"),
+               _("Left centre"),
+               _("Right centre"),
+               _("Left rear surround"),
+               _("Right rear surround"),
        };
 
        return channels[c];
 }
 
-FrameRateConversion::FrameRateConversion (float source, int dcp)
-       : skip (false)
-       , repeat (false)
-       , change_speed (false)
-{
-       if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
-               skip = true;
-       } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
-               repeat = true;
-       }
-
-       change_speed = !about_equal (source * factor(), dcp);
-
-       if (!skip && !repeat && !change_speed) {
-               description = _("Content and DCP have the same rate.\n");
-       } else {
-               if (skip) {
-                       description = _("DCP will use every other frame of the content.\n");
-               } else if (repeat) {
-                       description = _("Each content frame will be doubled in the DCP.\n");
-               }
-
-               if (change_speed) {
-                       float const pc = dcp * 100 / (source * factor());
-                       description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
-               }
-       }
-}
-
 LocaleGuard::LocaleGuard ()
        : _old (0)
 {
@@ -807,7 +793,7 @@ tidy_for_filename (string f)
 {
        string t;
        for (size_t i = 0; i < f.length(); ++i) {
-               if (isalpha (f[i]) || f[i] == '_' || f[i] == '-') {
+               if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
                        t += f[i];
                } else {
                        t += '_';
@@ -816,4 +802,193 @@ tidy_for_filename (string f)
 
        return t;
 }
+
+shared_ptr<const dcp::Signer>
+make_signer ()
+{
+       boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
+
+       /* Remake the chain if any of it is missing */
+       
+       list<boost::filesystem::path> files;
+       files.push_back ("ca.self-signed.pem");
+       files.push_back ("intermediate.signed.pem");
+       files.push_back ("leaf.signed.pem");
+       files.push_back ("leaf.key");
+
+       list<boost::filesystem::path>::const_iterator i = files.begin();
+       while (i != files.end()) {
+               boost::filesystem::path p (sd);
+               p /= *i;
+               if (!boost::filesystem::exists (p)) {
+                       boost::filesystem::remove_all (sd);
+                       boost::filesystem::create_directories (sd);
+                       dcp::make_signer_chain (sd, openssl_path ());
+                       break;
+               }
+
+               ++i;
+       }
        
+       dcp::CertificateChain chain;
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "ca.self-signed.pem";
+               chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
+       }
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "intermediate.signed.pem";
+               chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
+       }
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "leaf.signed.pem";
+               chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
+       }
+
+       boost::filesystem::path signer_key (sd);
+       signer_key /= "leaf.key";
+
+       return shared_ptr<const dcp::Signer> (new dcp::Signer (chain, signer_key));
+}
+
+map<string, string>
+split_get_request (string url)
+{
+       enum {
+               AWAITING_QUESTION_MARK,
+               KEY,
+               VALUE
+       } state = AWAITING_QUESTION_MARK;
+       
+       map<string, string> r;
+       string k;
+       string v;
+       for (size_t i = 0; i < url.length(); ++i) {
+               switch (state) {
+               case AWAITING_QUESTION_MARK:
+                       if (url[i] == '?') {
+                               state = KEY;
+                       }
+                       break;
+               case KEY:
+                       if (url[i] == '=') {
+                               v.clear ();
+                               state = VALUE;
+                       } else {
+                               k += url[i];
+                       }
+                       break;
+               case VALUE:
+                       if (url[i] == '&') {
+                               r.insert (make_pair (k, v));
+                               k.clear ();
+                               state = KEY;
+                       } else {
+                               v += url[i];
+                       }
+                       break;
+               }
+       }
+
+       if (state == VALUE) {
+               r.insert (make_pair (k, v));
+       }
+
+       return r;
+}
+
+dcp::Size
+fit_ratio_within (float ratio, dcp::Size full_frame)
+{
+       if (ratio < full_frame.ratio ()) {
+               return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
+       }
+       
+       return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
+}
+
+void *
+wrapped_av_malloc (size_t s)
+{
+       void* p = av_malloc (s);
+       if (!p) {
+               throw bad_alloc ();
+       }
+       return p;
+}
+               
+string
+entities_to_text (string e)
+{
+       boost::algorithm::replace_all (e, "%3A", ":");
+       boost::algorithm::replace_all (e, "%2F", "/");
+       return e;
+}
+
+int64_t
+divide_with_round (int64_t a, int64_t b)
+{
+       if (a % b >= (b / 2)) {
+               return (a + b - 1) / b;
+       } else {
+               return a / b;
+       }
+}
+
+/** Return a user-readable string summarising the versions of our dependencies */
+string
+dependency_version_summary ()
+{
+       stringstream s;
+       s << N_("libopenjpeg ") << opj_version () << N_(", ")
+         << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
+         << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
+         << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
+         << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
+         << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
+         << MagickVersion << N_(", ")
+         << N_("libssh ") << ssh_version (0) << N_(", ")
+         << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
+
+       return s.str ();
+}
+
+ScopedTemporary::ScopedTemporary ()
+       : _open (0)
+{
+       _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
+}
+
+ScopedTemporary::~ScopedTemporary ()
+{
+       close ();       
+       boost::system::error_code ec;
+       boost::filesystem::remove (_file, ec);
+}
+
+char const *
+ScopedTemporary::c_str () const
+{
+       return _file.string().c_str ();
+}
+
+FILE*
+ScopedTemporary::open (char const * params)
+{
+       _open = fopen (c_str(), params);
+       return _open;
+}
+
+void
+ScopedTemporary::close ()
+{
+       if (_open) {
+               fclose (_open);
+               _open = 0;
+       }
+}