Various bits related to subtitle font handling, particularly copying fonts to the...
[dcpomatic.git] / src / lib / util.cc
index 502393094b1e6b1989ab3d853280faf465de8835..f98e5960bb20e807f8bf2c9df0c0594a38f54926 100644 (file)
@@ -1,6 +1,5 @@
 /*
-    Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
-    Copyright (C) 2000-2007 Paul Davis
+    Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -24,7 +23,6 @@
 
 #include "util.h"
 #include "exceptions.h"
-#include "scaler.h"
 #include "dcp_content_type.h"
 #include "filter.h"
 #include "cinema_sound_processor.h"
 #include "md5_digester.h"
 #include "audio_processor.h"
 #include "safe_stringstream.h"
-#include <dcp/version.h>
 #include <dcp/util.h>
 #include <dcp/signer.h>
-#include <dcp/raw_convert.h>
-extern "C" {
-#include <libavcodec/avcodec.h>
-#include <libavformat/avformat.h>
-#include <libswscale/swscale.h>
-#include <libavfilter/avfiltergraph.h>
-#include <libavutil/pixfmt.h>
-}
 #include <glib.h>
-#include <openjpeg.h>
 #include <pangomm/init.h>
-#ifdef DCPOMATIC_IMAGE_MAGICK
-#include <magick/MagickCore.h>
-#else
-#include <magick/common.h>
-#include <magick/magick_config.h>
-#endif
-#include <magick/version.h>
-#include <libssh/libssh.h>
 #include <boost/algorithm/string.hpp>
 #include <boost/bind.hpp>
 #include <boost/lambda/lambda.hpp>
@@ -88,6 +68,7 @@ using std::endl;
 using std::vector;
 using std::min;
 using std::max;
+using std::map;
 using std::list;
 using std::multimap;
 using std::istream;
@@ -99,7 +80,6 @@ using boost::shared_ptr;
 using boost::thread;
 using boost::optional;
 using dcp::Size;
-using dcp::raw_convert;
 
 /** Path to our executable, required by the stacktrace stuff and filled
  *  in during App::onInit().
@@ -188,76 +168,6 @@ seconds_to_approximate_hms (int s)
        return ap.str ();
 }
 
-#ifdef DCPOMATIC_POSIX
-/** @param l Mangled C++ identifier.
- *  @return Demangled version.
- */
-static string
-demangle (string l)
-{
-       string::size_type const b = l.find_first_of (N_("("));
-       if (b == string::npos) {
-               return l;
-       }
-
-       string::size_type const p = l.find_last_of (N_("+"));
-       if (p == string::npos) {
-               return l;
-       }
-
-       if ((p - b) <= 1) {
-               return l;
-       }
-       
-       string const fn = l.substr (b + 1, p - b - 1);
-
-       int status;
-       try {
-               
-               char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
-               string d (realname);
-               free (realname);
-               return d;
-               
-       } catch (std::exception) {
-               
-       }
-       
-       return l;
-}
-
-/** Write a stacktrace to an ostream.
- *  @param out Stream to write to.
- *  @param levels Number of levels to go up the call stack.
- */
-void
-stacktrace (ostream& out, int levels)
-{
-       void *array[200];
-       size_t size = backtrace (array, 200);
-       char** strings = backtrace_symbols (array, size);
-     
-       if (strings) {
-               for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
-                       out << N_("  ") << demangle (strings[i]) << "\n";
-               }
-               
-               free (strings);
-       }
-}
-#endif
-
-/** @param v Version as used by FFmpeg.
- *  @return A string representation of v.
- */
-static string
-ffmpeg_version_to_string (int v)
-{
-       SafeStringStream s;
-       s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
-       return s.str ();
-}
-
 double
 seconds (struct timeval t)
 {
@@ -268,7 +178,7 @@ seconds (struct timeval t)
 
 /** Resolve symbol name and source location given the path to the executable */
 int
-addr2line (void const * const adr)
+addr2line (void const * const addr)
 {
        char addr2line_cmd[512] = { 0 };
        sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str()); 
@@ -279,7 +189,8 @@ addr2line (void const * const adr)
  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
  */
-LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
+LONG WINAPI
+exception_handler(struct _EXCEPTION_POINTERS * info)
 {
        FILE* f = fopen_boost (backtrace_file, "w");
        fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
@@ -346,9 +257,8 @@ set_backtrace_file (boost::filesystem::path p)
 void
 terminate ()
 {
-       static bool tried_throw = false;
-
        try {
+               static bool tried_throw = false;
                // try once to re-throw currently active exception
                if (!tried_throw) {
                        tried_throw = true;
@@ -364,9 +274,6 @@ terminate ()
                          << std::endl;
        }
 
-#ifdef DCPOMATIC_POSIX
-       stacktrace (cout, 50);
-#endif
        abort();
 }
 
@@ -417,7 +324,6 @@ dcpomatic_setup ()
        Ratio::setup_ratios ();
        VideoContentScale::setup_scales ();
        DCPContentType::setup_dcp_content_types ();
-       Scaler::setup_scalers ();
        Filter::setup_filters ();
        CinemaSoundProcessor::setup_cinema_sound_processors ();
        AudioProcessor::setup_audio_processors ();
@@ -475,73 +381,57 @@ dcpomatic_setup_gettext_i18n (string lang)
 #endif 
 
 #ifdef DCPOMATIC_LINUX
-       bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
+       bindtextdomain ("libdcpomatic", LINUX_LOCALE_PREFIX);
 #endif
 }
 
-/** @param s A string.
- *  @return Parts of the string split at spaces, except when a space is within quotation marks.
- */
-vector<string>
-split_at_spaces_considering_quotes (string s)
-{
-       vector<string> out;
-       bool in_quotes = false;
-       string c;
-       for (string::size_type i = 0; i < s.length(); ++i) {
-               if (s[i] == ' ' && !in_quotes) {
-                       out.push_back (c);
-                       c = N_("");
-               } else if (s[i] == '"') {
-                       in_quotes = !in_quotes;
-               } else {
-                       c += s[i];
-               }
-       }
-
-       out.push_back (c);
-       return out;
-}
-
-/** @param job Optional job for which to report progress */
+/** Compute a digest of the first and last `size' bytes of a set of files. */
 string
-md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
+md5_digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
 {
-       boost::uintmax_t const buffer_size = 64 * 1024;
-       char buffer[buffer_size];
-
+       boost::scoped_array<char> buffer (new char[size]);
        MD5Digester digester;
 
-       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) {
+       /* Head */
+       boost::uintmax_t to_do = size;
+       char* p = buffer.get ();
+       int i = 0;
+       while (i < int64_t (files.size()) && to_do > 0) {
                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;
+               boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
+               fread (p, 1, this_time, f);
+               p += this_time;
+               to_do -= this_time;
+               fclose (f);
 
-               while (remaining > 0) {
-                       int const t = min (remaining, buffer_size);
-                       int const r = fread (buffer, 1, t, f);
-                       if (r != t) {
-                               throw ReadFileError (files[i], errno);
-                       }
-                       digester.add (buffer, t);
-                       remaining -= t;
+               ++i;
+       }
+       digester.add (buffer.get(), size - to_do);
 
-                       if (job) {
-                               job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
-                       }
+       /* Tail */
+       to_do = size;
+       p = buffer.get ();
+       i = files.size() - 1;
+       while (i >= 0 && to_do > 0) {
+               FILE* f = fopen_boost (files[i], "rb");
+               if (!f) {
+                       throw OpenFileError (files[i].string());
                }
 
+               boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
+               dcpomatic_fseek (f, -this_time, SEEK_END);
+               fread (p, 1, this_time, f);
+               p += this_time;
+               to_do -= this_time;
                fclose (f);
-       }
+
+               --i;
+       }               
+       digester.add (buffer.get(), size - to_do);
 
        return digester.get ();
 }
@@ -559,135 +449,6 @@ dcp_audio_frame_rate (int fs)
        return 96000;
 }
 
-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 ()) {
-               if (_acceptor) {
-                       _acceptor->cancel ();
-               } else {
-                       _socket.close ();
-               }
-               _deadline.expires_at (boost::posix_time::pos_infin);
-       }
-
-       _deadline.async_wait (boost::bind (&Socket::check, this));
-}
-
-/** Blocking connect.
- *  @param endpoint End-point to connect to.
- */
-void
-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;
-       _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
-       do {
-               _io_service.run_one();
-       } while (ec == boost::asio::error::would_block);
-
-       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.
- */
-void
-Socket::write (uint8_t const * data, int size)
-{
-       _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
-       boost::system::error_code ec = boost::asio::error::would_block;
-
-       boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
-       
-       do {
-               _io_service.run_one ();
-       } while (ec == boost::asio::error::would_block);
-
-       if (ec) {
-               throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
-       }
-}
-
-void
-Socket::write (uint32_t v)
-{
-       v = htonl (v);
-       write (reinterpret_cast<uint8_t*> (&v), 4);
-}
-
-/** Blocking read.
- *  @param data Buffer to read to.
- *  @param size Number of bytes to read.
- */
-void
-Socket::read (uint8_t* data, int size)
-{
-       _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
-       boost::system::error_code ec = boost::asio::error::would_block;
-
-       boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
-
-       do {
-               _io_service.run_one ();
-       } while (ec == boost::asio::error::would_block);
-       
-       if (ec) {
-               throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
-       }
-}
-
-uint32_t
-Socket::read_uint32 ()
-{
-       uint32_t v;
-       read (reinterpret_cast<uint8_t *> (&v), 4);
-       return ntohl (v);
-}
-
 /** Round a number up to the nearest multiple of another number.
  *  @param c Index.
  *  @param s Array of numbers to round, indexed by c.
@@ -708,118 +469,21 @@ stride_round_up (int c, int const * stride, int t)
 int
 round_to (float n, int r)
 {
-       assert (r == 1 || r == 2 || r == 4);
+       DCPOMATIC_ASSERT (r == 1 || r == 2 || r == 4);
        return int (n + float(r) / 2) &~ (r - 1);
 }
 
-/** 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
- *  with # are ignored.
- *  @param s Stream to read.
- *  @return key/value pairs.
- */
-multimap<string, string>
-read_key_value (istream &s) 
-{
-       multimap<string, string> kv;
-       
-       string line;
-       while (getline (s, line)) {
-               if (line.empty ()) {
-                       continue;
-               }
-
-               if (line[0] == '#') {
-                       continue;
-               }
-
-               if (line[line.size() - 1] == '\r') {
-                       line = line.substr (0, line.size() - 1);
-               }
-
-               size_t const s = line.find (' ');
-               if (s == string::npos) {
-                       continue;
-               }
-
-               kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
-       }
-
-       return kv;
-}
-
-string
-get_required_string (multimap<string, string> const & kv, string k)
-{
-       if (kv.count (k) > 1) {
-               throw StringError (N_("unexpected multiple keys in key-value set"));
-       }
-
-       multimap<string, string>::const_iterator i = kv.find (k);
-       
-       if (i == kv.end ()) {
-               throw StringError (String::compose (_("missing key %1 in key-value set"), k));
-       }
-
-       return i->second;
-}
-
-int
-get_required_int (multimap<string, string> const & kv, string k)
-{
-       string const v = get_required_string (kv, k);
-       return raw_convert<int> (v);
-}
-
-float
-get_required_float (multimap<string, string> const & kv, string k)
-{
-       string const v = get_required_string (kv, k);
-       return raw_convert<float> (v);
-}
-
-string
-get_optional_string (multimap<string, string> const & kv, string k)
-{
-       if (kv.count (k) > 1) {
-               throw StringError (N_("unexpected multiple keys in key-value set"));
-       }
-
-       multimap<string, string>::const_iterator i = kv.find (k);
-       if (i == kv.end ()) {
-               return N_("");
-       }
-
-       return i->second;
-}
-
-int
-get_optional_int (multimap<string, string> const & kv, string k)
-{
-       if (kv.count (k) > 1) {
-               throw StringError (N_("unexpected multiple keys in key-value set"));
-       }
-
-       multimap<string, string>::const_iterator i = kv.find (k);
-       if (i == kv.end ()) {
-               return 0;
-       }
-
-       return raw_convert<int> (i->second);
-}
-
 /** Trip an assert if the caller is not in the UI thread */
 void
 ensure_ui_thread ()
 {
-       assert (boost::this_thread::get_id() == ui_thread);
+       DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
 }
 
 string
 audio_channel_name (int c)
 {
-       assert (MAX_DCP_AUDIO_CHANNELS == 12);
+       DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 12);
 
        /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
        /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
@@ -897,95 +561,105 @@ wrapped_av_malloc (size_t s)
        return p;
 }
                
-string
-entities_to_text (string e)
+ContentTimePeriod
+subtitle_period (AVSubtitle const & sub)
 {
-       boost::algorithm::replace_all (e, "%3A", ":");
-       boost::algorithm::replace_all (e, "%2F", "/");
-       return e;
+       ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
+
+       ContentTimePeriod period (
+               packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
+               packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
+               );
+
+       return period;
 }
 
-int64_t
-divide_with_round (int64_t a, int64_t b)
+map<string, string>
+split_get_request (string url)
 {
-       if (a % b >= (b / 2)) {
-               return (a + b - 1) / b;
-       } else {
-               return a / b;
+       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;
+               }
        }
-}
 
-/** Return a user-readable string summarising the versions of our dependencies */
-string
-dependency_version_summary ()
-{
-       SafeStringStream 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 ();
-}
+       if (state == VALUE) {
+               r.insert (make_pair (k, v));
+       }
 
-/** Construct a ScopedTemporary.  A temporary filename is decided but the file is not opened
- *  until ::open() is called.
- */
-ScopedTemporary::ScopedTemporary ()
-       : _open (0)
-{
-       _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
+       return r;
 }
 
-/** Close and delete the temporary file */
-ScopedTemporary::~ScopedTemporary ()
+long
+frame_info_position (int frame, Eyes eyes)
 {
-       close ();       
-       boost::system::error_code ec;
-       boost::filesystem::remove (_file, ec);
-}
+       static int const info_size = 48;
+       
+       switch (eyes) {
+       case EYES_BOTH:
+               return frame * info_size;
+       case EYES_LEFT:
+               return frame * info_size * 2;
+       case EYES_RIGHT:
+               return frame * info_size * 2 + info_size;
+       default:
+               DCPOMATIC_ASSERT (false);
+       }
 
-/** @return temporary filename */
-char const *
-ScopedTemporary::c_str () const
-{
-       return _file.string().c_str ();
+       DCPOMATIC_ASSERT (false);
 }
 
-/** Open the temporary file.
- *  @return File's FILE pointer.
- */
-FILE*
-ScopedTemporary::open (char const * params)
+dcp::FrameInfo
+read_frame_info (FILE* file, int frame, Eyes eyes)
 {
-       _open = fopen (c_str(), params);
-       return _open;
-}
+       dcp::FrameInfo info;
+       dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
+       fread (&info.offset, sizeof (info.offset), 1, file);
+       fread (&info.size, sizeof (info.size), 1, file);
+       
+       char hash_buffer[33];
+       fread (hash_buffer, 1, 32, file);
+       hash_buffer[32] = '\0';
+       info.hash = hash_buffer;
 
-/** Close the file */
-void
-ScopedTemporary::close ()
-{
-       if (_open) {
-               fclose (_open);
-               _open = 0;
-       }
+       return info;
 }
 
-ContentTimePeriod
-subtitle_period (AVSubtitle const & sub)
+void
+write_frame_info (FILE* file, int frame, Eyes eyes, dcp::FrameInfo info)
 {
-       ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
-
-       ContentTimePeriod period (
-               packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
-               packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
-               );
-
-       return period;
+       dcpomatic_fseek (file, frame_info_position (frame, eyes), SEEK_SET);
+       fwrite (&info.offset, sizeof (info.offset), 1, file);
+       fwrite (&info.size, sizeof (info.size), 1, file);
+       fwrite (info.hash.c_str(), 1, info.hash.size(), file);
 }