Add some basic JSON stuff.
[dcpomatic.git] / src / lib / util.cc
index 305aae4f8211a500104b2b034609915390a267fe..a86033e572f7655f5ebc67e5195e04018c4aa358 100644 (file)
@@ -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 <magick/MagickCore.h>
 #include <magick/version.h>
 #include <libdcp/version.h>
+#include <libdcp/util.h>
+#include <libdcp/signer_chain.h>
+#include <libdcp/signer.h>
 extern "C" {
 #include <libavcodec/avcodec.h>
 #include <libavformat/avformat.h>
@@ -61,6 +68,8 @@ extern "C" {
 #include "sound_processor.h"
 #include "config.h"
 #include "ratio.h"
+#include "job.h"
+#include "cross.h"
 #ifdef DCPOMATIC_WINDOWS
 #include "stack.hpp"
 #endif
@@ -75,16 +84,19 @@ 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;
@@ -119,12 +131,6 @@ seconds_to_hms (int s)
        return hms.str ();
 }
 
-string
-time_to_hms (Time t)
-{
-       return seconds_to_hms (t / TIME_HZ);
-}
-
 /** @param s Number of seconds.
  *  @return String containing an approximate description of s (e.g. "about 2 hours")
  */
@@ -207,15 +213,11 @@ void
 stacktrace (ostream& out, int levels)
 {
        void *array[200];
-       size_t size;
-       char **strings;
-       size_t i;
-     
-       size = backtrace (array, 200);
-       strings = backtrace_symbols (array, size);
+       size_t size = backtrace (array, 200);
+       char** strings = backtrace_symbols (array, size);
      
        if (strings) {
-               for (i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
+               for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
                        out << N_("  ") << demangle (strings[i]) << "\n";
                }
                
@@ -264,12 +266,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.
  */
@@ -280,9 +312,37 @@ 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 ();
+
+#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);
+
+       libdcp::init ();
        
        Ratio::setup_ratios ();
        DCPContentType::setup_dcp_content_types ();
@@ -323,6 +383,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, "");
@@ -379,31 +441,42 @@ md5_digest (void const * data, int size)
        return s.str ();
 }
 
-/** @param file File name.
- *  @return MD5 digest of file's contents.
- */
+/** @param job Optional job for which to report progress */
 string
-md5_digest (boost::filesystem::path file)
+md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
 {
-       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;
+       boost::uintmax_t 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;
+
+       vector<int64_t> sizes;
+       for (size_t i = 0; i < files.size(); ++i) {
+               sizes.push_back (boost::filesystem::file_size (files[i]));
+       }
+
+       for (size_t i = 0; i < files.size(); ++i) {
+               FILE* f = fopen_boost (files[i], "rb");
+               if (!f) {
+                       throw OpenFileError (files[i].string());
+               }
+
+               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);
+                       remaining -= t;
+
+                       if (job) {
+                               job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
+                       }
+               }
+
+               fclose (f);
        }
 
        unsigned char digest[MD5_DIGEST_LENGTH];
@@ -460,17 +533,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);
        }
 
@@ -481,7 +564,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;
@@ -490,11 +573,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.
@@ -512,7 +619,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 ()));
        }
 }
 
@@ -540,7 +647,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 ()));
        }
 }
 
@@ -565,12 +672,6 @@ stride_round_up (int c, int const * stride, int t)
        return a - (a % t);
 }
 
-int
-stride_lookup (int c, int const * stride)
-{
-       return stride[c];
-}
-
 /** Read a sequence of key / value pairs from a text stream;
  *  the keys are the first words on the line, and the values are
  *  the remainder of the line following the key.  Lines beginning
@@ -692,7 +793,7 @@ audio_channel_name (int c)
        assert (MAX_AUDIO_CHANNELS == 6);
 
        /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
-          enhancement channel (sub-woofer)./
+          enhancement channel (sub-woofer).
        */
        string const channels[] = {
                _("Left"),
@@ -708,29 +809,38 @@ audio_channel_name (int c)
 
 FrameRateConversion::FrameRateConversion (float source, int dcp)
        : skip (false)
-       , repeat (false)
+       , repeat (1)
        , change_speed (false)
 {
-       if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
+       if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
+               /* The difference between source and DCP frame rate will be lower
+                  (i.e. better) if we skip.
+               */
                skip = true;
        } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
-               repeat = true;
+               /* The difference between source and DCP frame rate would be better
+                  if we repeated each frame once; it may be better still if we
+                  repeated more than once.  Work out the required repeat.
+               */
+               repeat = round (dcp / source);
        }
 
        change_speed = !about_equal (source * factor(), dcp);
 
-       if (!skip && !repeat && !change_speed) {
-               description = _("DCP and source have the same rate.\n");
+       if (!skip && repeat == 1 && !change_speed) {
+               description = _("Content and DCP have the same rate.\n");
        } else {
                if (skip) {
-                       description = _("DCP will use every other frame of the source.\n");
-               } else if (repeat) {
-                       description = _("Each source frame will be doubled in the DCP.\n");
+                       description = _("DCP will use every other frame of the content.\n");
+               } else if (repeat == 2) {
+                       description = _("Each content frame will be doubled in the DCP.\n");
+               } else if (repeat > 2) {
+                       description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
                }
 
                if (change_speed) {
                        float const pc = dcp * 100 / (source * factor());
-                       description += String::compose (_("DCP will run at %1%% of the source speed.\n"), pc);
+                       description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
                }
        }
 }
@@ -740,12 +850,12 @@ LocaleGuard::LocaleGuard ()
 {
        char const * old = setlocale (LC_NUMERIC, 0);
 
-        if (old) {
-                _old = strdup (old);
-                if (strcmp (_old, "C")) {
-                        setlocale (LC_NUMERIC, "C");
-                }
-        }
+       if (old) {
+               _old = strdup (old);
+               if (strcmp (_old, "C")) {
+                       setlocale (LC_NUMERIC, "C");
+               }
+       }
 }
 
 LocaleGuard::~LocaleGuard ()
@@ -753,3 +863,153 @@ LocaleGuard::~LocaleGuard ()
        setlocale (LC_NUMERIC, _old);
        free (_old);
 }
+
+bool
+valid_image_file (boost::filesystem::path f)
+{
+       string ext = f.extension().string();
+       transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
+       return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
+}
+
+string
+tidy_for_filename (string f)
+{
+       string t;
+       for (size_t i = 0; i < f.length(); ++i) {
+               if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
+                       t += f[i];
+               } else {
+                       t += '_';
+               }
+       }
+
+       return t;
+}
+
+shared_ptr<const libdcp::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);
+                       libdcp::make_signer_chain (sd, openssl_path ());
+                       break;
+               }
+
+               ++i;
+       }
+       
+       libdcp::CertificateChain chain;
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "ca.self-signed.pem";
+               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
+       }
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "intermediate.signed.pem";
+               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
+       }
+
+       {
+               boost::filesystem::path p (sd);
+               p /= "leaf.signed.pem";
+               chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
+       }
+
+       boost::filesystem::path signer_key (sd);
+       signer_key /= "leaf.key";
+
+       return shared_ptr<const libdcp::Signer> (new libdcp::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;
+}
+
+libdcp::Size
+fit_ratio_within (float ratio, libdcp::Size full_frame)
+{
+       if (ratio < full_frame.ratio ()) {
+               return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
+       }
+       
+       return libdcp::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;
+}