X-Git-Url: https://git.carlh.net/gitweb/?p=dcpomatic.git;a=blobdiff_plain;f=src%2Flib%2Futil.cc;h=3f0c34a15004a9da88806366bee51967278700d5;hp=2b7df86bfbf8fd5e64a6533004b22c2d4a8b22b0;hb=1a721b82d4094c00ee89574e17c58c23c0de8cdd;hpb=bf193143624df4cf3a49c99bda1955484051c722 diff --git a/src/lib/util.cc b/src/lib/util.cc index 2b7df86bf..7d0d2bf60 100644 --- a/src/lib/util.cc +++ b/src/lib/util.cc @@ -1,20 +1,20 @@ /* - Copyright (C) 2012-2014 Carl Hetherington - Copyright (C) 2000-2007 Paul Davis + Copyright (C) 2012-2021 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ @@ -22,6 +22,67 @@ * @brief Some utility functions and classes. */ + +#define UNICODE 1 + + +#include "audio_buffers.h" +#include "audio_processor.h" +#include "cinema_sound_processor.h" +#include "compose.hpp" +#include "config.h" +#include "cross.h" +#include "crypto.h" +#include "dcp_content_type.h" +#include "digester.h" +#include "exceptions.h" +#include "ffmpeg_image_proxy.h" +#include "filter.h" +#include "font.h" +#include "image.h" +#include "job.h" +#include "job_manager.h" +#include "ratio.h" +#include "rect.h" +#include "render_text.h" +#include "string_text.h" +#include "text_decoder.h" +#include "util.h" +#include "video_content.h" +#include +#include +#include +#include +#include +#include +#include +#include +#include +LIBDCP_DISABLE_WARNINGS +extern "C" { +#include +#include +#include +} +LIBDCP_ENABLE_WARNINGS +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +LIBDCP_DISABLE_WARNINGS +#include +LIBDCP_ENABLE_WARNINGS +#ifdef DCPOMATIC_WINDOWS +#include +#include +#endif +#include #include #include #include @@ -31,84 +92,42 @@ #include #include #endif -#include -#include -#include -#include -#include -#include -#include -#ifdef DCPOMATIC_WINDOWS -#include -#endif -#include -#include -#include -#ifdef DCPOMATIC_IMAGE_MAGICK -#include -#else -#include -#include -#endif -#include -#include -#include -#include -#include -extern "C" { -#include -#include -#include -#include -#include -} -#include "util.h" -#include "exceptions.h" -#include "scaler.h" -#include "dcp_content_type.h" -#include "filter.h" -#include "cinema_sound_processor.h" -#include "config.h" -#include "ratio.h" -#include "job.h" -#include "cross.h" -#include "video_content.h" -#include "rect.h" -#include "md5_digester.h" -#include "audio_processor.h" -#include "safe_stringstream.h" -#ifdef DCPOMATIC_WINDOWS -#include "stack.hpp" -#endif #include "i18n.h" -using std::string; -using std::setfill; -using std::ostream; + +using std::bad_alloc; +using std::cout; using std::endl; -using std::vector; -using std::hex; -using std::setw; -using std::ios; -using std::min; -using std::max; +using std::istream; using std::list; -using std::multimap; +using std::make_pair; +using std::make_shared; using std::map; -using std::istream; -using std::numeric_limits; +using std::min; +using std::ostream; using std::pair; -using std::cout; -using std::bad_alloc; -using std::streampos; using std::set_terminate; -using boost::shared_ptr; +using std::shared_ptr; +using std::string; +using std::vector; +using std::wstring; using boost::thread; using boost::optional; +using boost::lexical_cast; +using boost::bad_lexical_cast; +using boost::scoped_array; using dcp::Size; using dcp::raw_convert; +using dcp::locale_convert; +using namespace dcpomatic; + +/** Path to our executable, required by the stacktrace stuff and filled + * in during App::onInit(). + */ +string program_name; +bool is_batch_converter = false; static boost::thread::id ui_thread; static boost::filesystem::path backtrace_file; @@ -127,14 +146,25 @@ seconds_to_hms (int s) int h = m / 60; m -= (h * 60); - SafeStringStream hms; - hms << h << N_(":"); - hms.width (2); - hms << std::setfill ('0') << m << N_(":"); - hms.width (2); - hms << std::setfill ('0') << s; + char buffer[64]; + snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s); + return buffer; +} + +string +time_to_hmsf (DCPTime time, Frame rate) +{ + Frame f = time.frames_round (rate); + int s = f / rate; + f -= (s * rate); + int m = s / 60; + s -= m * 60; + int h = m / 60; + m -= h * 60; - return hms.str (); + char buffer[64]; + snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast(f)); + return buffer; } /** @param s Number of seconds. @@ -148,138 +178,130 @@ seconds_to_approximate_hms (int s) int h = m / 60; m -= (h * 60); - SafeStringStream ap; + string ap; - bool const hours = h > 0; - bool const minutes = h < 10 && m > 0; - bool const seconds = m < 10 && s > 0; + bool hours = h > 0; + bool minutes = h < 6 && m > 0; + bool seconds = h == 0 && m < 10 && s > 0; - if (hours) { - if (m > 30 && !minutes) { - /* TRANSLATORS: h here is an abbreviation for hours */ - ap << (h + 1) << _("h"); - } else { - /* TRANSLATORS: h here is an abbreviation for hours */ - ap << h << _("h"); + if (m > 30 && !minutes) { + /* round up the hours */ + ++h; + } + if (s > 30 && !seconds) { + /* round up the minutes */ + ++m; + if (m == 60) { + m = 0; + minutes = false; + ++h; } + } + + if (hours) { + /// TRANSLATORS: h here is an abbreviation for hours + ap += locale_convert(h) + _("h"); - if (minutes | seconds) { - ap << N_(" "); + if (minutes || seconds) { + ap += N_(" "); } } if (minutes) { - /* Minutes */ - if (s > 30 && !seconds) { - /* TRANSLATORS: m here is an abbreviation for minutes */ - ap << (m + 1) << _("m"); - } else { - /* TRANSLATORS: m here is an abbreviation for minutes */ - ap << m << _("m"); - } + /// TRANSLATORS: m here is an abbreviation for minutes + ap += locale_convert(m) + _("m"); if (seconds) { - ap << N_(" "); + ap += N_(" "); } } if (seconds) { /* Seconds */ - /* TRANSLATORS: s here is an abbreviation for seconds */ - ap << s << _("s"); + /// TRANSLATORS: s here is an abbreviation for seconds + ap += locale_convert(s) + _("s"); } - return ap.str (); + return ap; } -#ifdef DCPOMATIC_POSIX -/** @param l Mangled C++ identifier. - * @return Demangled version. - */ -static string -demangle (string l) +double +seconds (struct timeval t) { - 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; - } + return t.tv_sec + (double (t.tv_usec) / 1e6); +} - if ((p - b) <= 1) { - return l; - } - - string const fn = l.substr (b + 1, p - b - 1); +#ifdef DCPOMATIC_WINDOWS - 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); - } +/** Resolve symbol name and source location given the path to the executable */ +int +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()); + return system(addr2line_cmd); } -#endif -/** @param v Version as used by FFmpeg. - * @return A string representation of v. +LIBDCP_DISABLE_WARNINGS +/** This is called when C signals occur on Windows (e.g. SIGSEGV) + * (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/ */ -static string -ffmpeg_version_to_string (int v) +LONG WINAPI +exception_handler(struct _EXCEPTION_POINTERS * info) { - SafeStringStream s; - s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff); - return s.str (); -} + dcp::File f(backtrace_file, "w"); + if (f) { + fprintf(f.get(), "C-style exception %d\n", info->ExceptionRecord->ExceptionCode); + f.close(); + } -double -seconds (struct timeval t) -{ - return t.tv_sec + (double (t.tv_usec) / 1e6); -} + if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) { + CONTEXT* context = info->ContextRecord; + SymInitialize (GetCurrentProcess (), 0, true); -#ifdef DCPOMATIC_WINDOWS -LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *) -{ - dbg::stack s; - FILE* f = fopen_boost (backtrace_file, "w"); - fprintf (f, "Exception thrown:"); - for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) { - fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str()); + STACKFRAME frame = { 0 }; + + /* setup initial stack frame */ +#if _WIN64 + frame.AddrPC.Offset = context->Rip; + frame.AddrStack.Offset = context->Rsp; + frame.AddrFrame.Offset = context->Rbp; +#else + frame.AddrPC.Offset = context->Eip; + frame.AddrStack.Offset = context->Esp; + frame.AddrFrame.Offset = context->Ebp; +#endif + frame.AddrPC.Mode = AddrModeFlat; + frame.AddrStack.Mode = AddrModeFlat; + frame.AddrFrame.Mode = AddrModeFlat; + + while ( + StackWalk ( + IMAGE_FILE_MACHINE_I386, + GetCurrentProcess (), + GetCurrentThread (), + &frame, + context, + 0, + SymFunctionTableAccess, + SymGetModuleBase, + 0 + ) + ) { + addr2line((void *) frame.AddrPC.Offset); + } + } else { +#ifdef _WIN64 + addr2line ((void *) info->ContextRecord->Rip); +#else + addr2line ((void *) info->ContextRecord->Eip); +#endif } - fclose (f); + return EXCEPTION_CONTINUE_SEARCH; } +LIBDCP_ENABLE_WARNINGS #endif void @@ -288,13 +310,16 @@ set_backtrace_file (boost::filesystem::path p) backtrace_file = p; } -/* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */ +/** This is called when there is an unhandled exception. Any + * backtrace in this function is useless on Windows as the stack has + * already been unwound from the throw; we have the gdb wrap hack to + * cope with that. + */ 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; @@ -306,28 +331,17 @@ terminate () << e.what() << std::endl; } catch (...) { - std::cerr << __FUNCTION__ << " caught unknown/unhandled exception." + 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. - */ void -dcpomatic_setup () +dcpomatic_setup_path_encoding () { #ifdef DCPOMATIC_WINDOWS - boost::filesystem::path p = g_get_user_config_dir (); - p /= "backtrace.txt"; - set_backtrace_file (p); - 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()). @@ -342,32 +356,73 @@ dcpomatic_setup () */ std::locale::global (boost::locale::generator().generate ("")); boost::filesystem::path::imbue (std::locale ()); -#endif - +#endif +} + +/** 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. + */ +void +dcpomatic_setup () +{ +#ifdef DCPOMATIC_WINDOWS + boost::filesystem::path p = g_get_user_config_dir (); + p /= "backtrace.txt"; + set_backtrace_file (p); + SetUnhandledExceptionFilter(exception_handler); +#endif + +#ifdef DCPOMATIC_HAVE_AVREGISTER +LIBDCP_DISABLE_WARNINGS + av_register_all (); avfilter_register_all (); +LIBDCP_ENABLE_WARNINGS +#endif #ifdef DCPOMATIC_OSX - /* Add our lib directory to the libltdl search path so that + /* Add our library directory to the libltdl search path so that xmlsec can find xmlsec1-openssl. */ - boost::filesystem::path lib = app_contents (); - lib /= "lib"; + auto lib = directory_containing_executable().parent_path(); + lib /= "Frameworks"; setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1); #endif set_terminate (terminate); +#ifdef DCPOMATIC_WINDOWS + putenv ("PANGOCAIRO_BACKEND=fontconfig"); + putenv (String::compose("FONTCONFIG_PATH=%1", resources_path().string()).c_str()); +#endif + +#ifdef DCPOMATIC_OSX + setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1); + setenv ("FONTCONFIG_PATH", resources_path().string().c_str(), 1); +#endif + Pango::init (); - dcp::init (); - + dcp::init (libdcp_resources_path()); + +#if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX) + /* Render something to fontconfig to create its cache */ + list subs; + dcp::SubtitleString ss( + optional(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HAlign::CENTER, 0, dcp::VAlign::CENTER, dcp::Direction::LTR, + "Hello dolly", dcp::Effect::NONE, dcp::Colour(), dcp::Time(), dcp::Time(), 0 + ); + subs.push_back (StringText(ss, 0)); + render_text (subs, list>(), dcp::Size(640, 480), DCPTime(), 24); +#endif + Ratio::setup_ratios (); - VideoContentScale::setup_scales (); + PresetColourConversion::setup_colour_conversion_presets (); DCPContentType::setup_dcp_content_types (); - Scaler::setup_scalers (); Filter::setup_filters (); CinemaSoundProcessor::setup_cinema_sound_processors (); AudioProcessor::setup_audio_processors (); + curl_global_init (CURL_GLOBAL_ALL); + ui_thread = boost::this_thread::get_id (); } @@ -413,364 +468,89 @@ dcpomatic_setup_gettext_i18n (string lang) } setlocale (LC_ALL, ""); - textdomain ("libdcpomatic"); + textdomain ("libdcpomatic2"); #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX) - bindtextdomain ("libdcpomatic", mo_path().string().c_str()); - bind_textdomain_codeset ("libdcpomatic", "UTF8"); -#endif + bindtextdomain ("libdcpomatic2", mo_path().string().c_str()); + bind_textdomain_codeset ("libdcpomatic2", "UTF8"); +#endif #ifdef DCPOMATIC_LINUX - bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX); + bindtextdomain ("libdcpomatic2", 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 -split_at_spaces_considering_quotes (string s) -{ - vector 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 files, shared_ptr job) +digest_head_tail (vector files, boost::uintmax_t size) { - boost::uintmax_t const buffer_size = 64 * 1024; - char buffer[buffer_size]; - - MD5Digester digester; - - vector 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"); + boost::scoped_array buffer (new char[size]); + Digester digester; + + /* Head */ + boost::uintmax_t to_do = size; + char* p = buffer.get (); + int i = 0; + while (i < int64_t (files.size()) && to_do > 0) { + dcp::File f(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); - int const r = fread (buffer, 1, t, f); - if (r != t) { - throw ReadFileError (files[i], errno); - } - digester.add (buffer, t); - remaining -= t; - - if (job) { - job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ()); - } - } - - fclose (f); - } - - return digester.get (); -} - -/** @param An arbitrary audio frame rate. - * @return The appropriate DCP-approved frame rate (48kHz or 96kHz). - */ -int -dcp_audio_frame_rate (int fs) -{ - if (fs <= 48000) { - return 48000; - } - - 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 (); + throw OpenFileError (files[i].string(), errno, OpenFileError::READ); } - _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); + boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i])); + f.checked_read(p, this_time); + p += this_time; + to_do -= this_time; - if (ec) { - throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ())); + ++i; } - - 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 (&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 (&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. - * @param t Multiple to round to. - * @return Rounded number. - */ -int -stride_round_up (int c, int const * stride, int t) -{ - int const a = stride[c] + (t - 1); - return a - (a % t); -} - -/** @param n A number. - * @param r Rounding `boundary' (must be a power of 2) - * @return n rounded to the nearest r - */ -int -round_to (float n, int r) -{ - 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 -read_key_value (istream &s) -{ - multimap kv; - - string line; - while (getline (s, line)) { - if (line.empty ()) { - continue; - } - - if (line[0] == '#') { - continue; + digester.add (buffer.get(), size - to_do); + + /* Tail */ + to_do = size; + p = buffer.get (); + i = files.size() - 1; + while (i >= 0 && to_do > 0) { + dcp::File f(files[i], "rb"); + if (!f) { + throw OpenFileError (files[i].string(), errno, OpenFileError::READ); } - if (line[line.size() - 1] == '\r') { - line = line.substr (0, line.size() - 1); - } + boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i])); + f.seek(-this_time, SEEK_END); + f.checked_read(p, this_time); + p += this_time; + to_do -= this_time; - size_t const s = line.find (' '); - if (s == string::npos) { - continue; - } - - kv.insert (make_pair (line.substr (0, s), line.substr (s + 1))); + --i; } + digester.add (buffer.get(), size - to_do); - return kv; -} - -string -get_required_string (multimap const & kv, string k) -{ - if (kv.count (k) > 1) { - throw StringError (N_("unexpected multiple keys in key-value set")); - } - - multimap::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 const & kv, string k) -{ - string const v = get_required_string (kv, k); - return raw_convert (v); + return digester.get (); } -float -get_required_float (multimap const & kv, string k) -{ - string const v = get_required_string (kv, k); - return raw_convert (v); -} string -get_optional_string (multimap const & kv, string k) +simple_digest (vector paths) { - if (kv.count (k) > 1) { - throw StringError (N_("unexpected multiple keys in key-value set")); - } - - multimap::const_iterator i = kv.find (k); - if (i == kv.end ()) { - return N_(""); - } - - return i->second; + return digest_head_tail(paths, 1000000) + raw_convert(boost::filesystem::file_size(paths.front())); } -int -get_optional_int (multimap const & kv, string k) -{ - if (kv.count (k) > 1) { - throw StringError (N_("unexpected multiple keys in key-value set")); - } - - multimap::const_iterator i = kv.find (k); - if (i == kv.end ()) { - return 0; - } - - return raw_convert (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 == 16); - /* 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 - VI is the visually-impaired audio track (audio describe). - */ + /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency + /// enhancement channel (sub-woofer). string const channels[] = { _("Left"), _("Right"), @@ -784,32 +564,99 @@ audio_channel_name (int c) _("Right centre"), _("Left rear surround"), _("Right rear surround"), + _("D-BOX primary"), + _("D-BOX secondary"), + _("Unused"), + _("Unused") }; return channels[c]; } +string +short_audio_channel_name (int c) +{ + DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16); + + /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency + /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and + /// VI is the visually-impaired audio track (audio describe). DBP is the D-BOX + /// primary channel and DBS is the D-BOX secondary channel. + string const channels[] = { + _("L"), + _("R"), + _("C"), + _("Lfe"), + _("Ls"), + _("Rs"), + _("HI"), + _("VI"), + _("Lc"), + _("Rc"), + _("BsL"), + _("BsR"), + _("DBP"), + _("DBS"), + _("Sign"), + "" + }; + + return channels[c]; +} + + bool valid_image_file (boost::filesystem::path f) { - string ext = f.extension().string(); + if (boost::starts_with (f.leaf().string(), "._")) { + return false; + } + + auto 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" || ext == ".dpx" || + ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" || + ext == ".jpf" || ext == ".psd" + ); +} + +bool +valid_sound_file (boost::filesystem::path f) +{ + if (boost::starts_with (f.leaf().string(), "._")) { + return false; + } + + auto ext = f.extension().string(); + transform (ext.begin(), ext.end(), ext.begin(), ::tolower); + return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff"); +} + +bool +valid_j2k_file (boost::filesystem::path f) +{ + auto 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" || ext == ".dpx"); + return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2"); } 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 += '_'; - } + boost::replace_if (f, boost::is_any_of ("\\/:"), '_'); + return f; +} + +dcp::Size +fit_ratio_within (float ratio, dcp::Size full_frame) +{ + if (ratio < full_frame.ratio ()) { + return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height); } - return t; + return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio)); } map @@ -820,7 +667,7 @@ split_get_request (string url) KEY, VALUE } state = AWAITING_QUESTION_MARK; - + map r; string k; string v; @@ -858,115 +705,443 @@ split_get_request (string url) return r; } -dcp::Size -fit_ratio_within (float ratio, dcp::Size full_frame, int round) +string +video_asset_filename (shared_ptr asset, int reel_index, int reel_count, optional summary) { - if (ratio < full_frame.ratio ()) { - return dcp::Size (round_to (full_frame.height * ratio, round), full_frame.height); + dcp::NameFormat::Map values; + values['t'] = "j2c"; + values['r'] = raw_convert (reel_index + 1); + values['n'] = raw_convert (reel_count); + if (summary) { + values['c'] = careful_string_filter (summary.get()); } - - return dcp::Size (full_frame.width, round_to (full_frame.width / ratio, round)); + return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf"); } -void * -wrapped_av_malloc (size_t s) +string +audio_asset_filename (shared_ptr asset, int reel_index, int reel_count, optional summary) { - void* p = av_malloc (s); - if (!p) { - throw bad_alloc (); + dcp::NameFormat::Map values; + values['t'] = "pcm"; + values['r'] = raw_convert (reel_index + 1); + values['n'] = raw_convert (reel_count); + if (summary) { + values['c'] = careful_string_filter (summary.get()); } - return p; + return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf"); } - + + string -entities_to_text (string e) +atmos_asset_filename (shared_ptr asset, int reel_index, int reel_count, optional summary) { - boost::algorithm::replace_all (e, "%3A", ":"); - boost::algorithm::replace_all (e, "%2F", "/"); - return e; + dcp::NameFormat::Map values; + values['t'] = "atmos"; + values['r'] = raw_convert (reel_index + 1); + values['n'] = raw_convert (reel_count); + if (summary) { + values['c'] = careful_string_filter (summary.get()); + } + return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf"); } -int64_t -divide_with_round (int64_t a, int64_t b) + +float +relaxed_string_to_float (string s) { - if (a % b >= (b / 2)) { - return (a + b - 1) / b; - } else { - return a / b; + try { + boost::algorithm::replace_all (s, ",", "."); + return lexical_cast (s); + } catch (bad_lexical_cast &) { + boost::algorithm::replace_all (s, ".", ","); + return lexical_cast (s); } } -/** Return a user-readable string summarising the versions of our dependencies */ string -dependency_version_summary () +careful_string_filter (string s) { - 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; + /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename). + There's no apparent list of what really is allowed, so this is a guess. + Safety first and all that. + */ + + /* First transliterate using libicu to try to remove accents in a "nice" way */ + auto transliterated = icu::UnicodeString::fromUTF8(icu::StringPiece(s)); + auto status = U_ZERO_ERROR; + auto transliterator = icu::Transliterator::createInstance("NFD; [:M:] Remove; NFC", UTRANS_FORWARD, status); + transliterator->transliterate(transliterated); + + /* Some things are missed by ICU's transliterator */ + std::map replacements = { + { L'ł', L'l' }, + { L'Ł', L'L' } + }; - return s.str (); + icu::UnicodeString transliterated_more; + for (int i = 0; i < transliterated.length(); ++i) { + auto replacement = replacements.find(transliterated[i]); + if (replacement != replacements.end()) { + transliterated_more += replacement->second; + } else { + transliterated_more += transliterated[i]; + } + } + + /* Then remove anything that's not in a very limited character set */ + wstring out; + wstring const allowed = L"0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+"; + for (size_t i = 0; i < transliterated_more.length(); ++i) { + wchar_t c = transliterated_more[i]; + if (allowed.find(c) != string::npos) { + out += c; + } + } + + return boost::locale::conv::utf_to_utf(out); } -/** Construct a ScopedTemporary. A temporary filename is decided but the file is not opened - * until ::open() is called. +/** @param mapped List of mapped audio channels from a Film. + * @param channels Total number of channels in the Film. + * @return First: number of non-LFE soundtrack channels (L/R/C/Ls/Rs/Lc/Rc/Bsl/Bsr), second: number of LFE channels. */ -ScopedTemporary::ScopedTemporary () - : _open (0) +pair +audio_channel_types (list mapped, int channels) { - _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path (); + int non_lfe = 0; + int lfe = 0; + + for (auto i: mapped) { + if (i >= channels) { + /* This channel is mapped but is not included in the DCP */ + continue; + } + + switch (static_cast(i)) { + case dcp::Channel::LFE: + ++lfe; + break; + case dcp::Channel::LEFT: + case dcp::Channel::RIGHT: + case dcp::Channel::CENTRE: + case dcp::Channel::LS: + case dcp::Channel::RS: + case dcp::Channel::BSL: + case dcp::Channel::BSR: + ++non_lfe; + break; + case dcp::Channel::HI: + case dcp::Channel::VI: + case dcp::Channel::MOTION_DATA: + case dcp::Channel::SYNC_SIGNAL: + case dcp::Channel::SIGN_LANGUAGE: + case dcp::Channel::CHANNEL_COUNT: + break; + } + } + + return make_pair (non_lfe, lfe); } -/** Close and delete the temporary file */ -ScopedTemporary::~ScopedTemporary () +shared_ptr +remap (shared_ptr input, int output_channels, AudioMapping map) { - close (); - boost::system::error_code ec; - boost::filesystem::remove (_file, ec); + auto mapped = make_shared(output_channels, input->frames()); + mapped->make_silent (); + + int to_do = min (map.input_channels(), input->channels()); + + for (int i = 0; i < to_do; ++i) { + for (int j = 0; j < mapped->channels(); ++j) { + if (map.get(i, j) > 0) { + mapped->accumulate_channel( + input.get(), + i, + j, + map.get(i, j) + ); + } + } + } + + return mapped; } -/** @return temporary filename */ -char const * -ScopedTemporary::c_str () const +Eyes +increment_eyes (Eyes e) { - return _file.string().c_str (); + if (e == Eyes::LEFT) { + return Eyes::RIGHT; + } + + return Eyes::LEFT; } -/** Open the temporary file. - * @return File's FILE pointer. - */ -FILE* -ScopedTemporary::open (char const * params) + +size_t +utf8_strlen (string s) +{ + size_t const len = s.length (); + int N = 0; + for (size_t i = 0; i < len; ++i) { + unsigned char c = s[i]; + if ((c & 0xe0) == 0xc0) { + ++i; + } else if ((c & 0xf0) == 0xe0) { + i += 2; + } else if ((c & 0xf8) == 0xf0) { + i += 3; + } + ++N; + } + return N; +} + +string +day_of_week_to_string (boost::gregorian::greg_weekday d) { - _open = fopen (c_str(), params); - return _open; + switch (d.as_enum()) { + case boost::date_time::Sunday: + return _("Sunday"); + case boost::date_time::Monday: + return _("Monday"); + case boost::date_time::Tuesday: + return _("Tuesday"); + case boost::date_time::Wednesday: + return _("Wednesday"); + case boost::date_time::Thursday: + return _("Thursday"); + case boost::date_time::Friday: + return _("Friday"); + case boost::date_time::Saturday: + return _("Saturday"); + } + + return d.as_long_string (); } -/** Close the file */ +/** @param size Size of picture that the subtitle will be overlaid onto */ void -ScopedTemporary::close () +emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr decoder) { - if (_open) { - fclose (_open); - _open = 0; + /* XXX: this is rather inefficient; decoding the image just to get its size */ + FFmpegImageProxy proxy (sub.png_image()); + auto image = proxy.image(Image::Alignment::PADDED).image; + /* set up rect with height and width */ + dcpomatic::Rect rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height)); + + /* add in position */ + + switch (sub.h_align()) { + case dcp::HAlign::LEFT: + rect.x += sub.h_position(); + break; + case dcp::HAlign::CENTER: + rect.x += 0.5 + sub.h_position() - rect.width / 2; + break; + case dcp::HAlign::RIGHT: + rect.x += 1 - sub.h_position() - rect.width; + break; } + + switch (sub.v_align()) { + case dcp::VAlign::TOP: + rect.y += sub.v_position(); + break; + case dcp::VAlign::CENTER: + rect.y += 0.5 + sub.v_position() - rect.height / 2; + break; + case dcp::VAlign::BOTTOM: + rect.y += 1 - sub.v_position() - rect.height; + break; + } + + decoder->emit_bitmap (period, image, rect); } -ContentTimePeriod -subtitle_period (AVSubtitle const & sub) +bool +show_jobs_on_console (bool progress) { - ContentTime const packet_time = ContentTime::from_seconds (static_cast (sub.pts) / AV_TIME_BASE); + bool first = true; + bool error = false; + while (true) { - ContentTimePeriod period ( - packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3), - packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3) - ); + dcpomatic_sleep_seconds (5); + + auto jobs = JobManager::instance()->get(); + + if (!first && progress) { + for (size_t i = 0; i < jobs.size(); ++i) { + cout << "\033[1A\033[2K"; + } + cout.flush (); + } + + first = false; + + for (auto i: jobs) { + if (progress) { + cout << i->name(); + if (!i->sub_name().empty()) { + cout << "; " << i->sub_name(); + } + cout << ": "; + + if (i->progress ()) { + cout << i->status() << " \n"; + } else { + cout << ": Running \n"; + } + } + + if (!progress && i->finished_in_error()) { + /* We won't see this error if we haven't been showing progress, + so show it now. + */ + cout << i->status() << "\n"; + } + + if (i->finished_in_error()) { + error = true; + } + } + + if (!JobManager::instance()->work_to_do()) { + break; + } + } + + return error; +} + +/** XXX: could use mmap? */ +void +copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function progress) +{ + dcp::File f(from, "rb"); + if (!f) { + throw OpenFileError (from, errno, OpenFileError::READ); + } + dcp::File t(to, "wb"); + if (!t) { + throw OpenFileError (to, errno, OpenFileError::WRITE); + } + + /* on the order of a second's worth of copying */ + boost::uintmax_t const chunk = 20 * 1024 * 1024; + + std::vector buffer(chunk); + + boost::uintmax_t const total = boost::filesystem::file_size (from); + boost::uintmax_t remaining = total; + + while (remaining) { + boost::uintmax_t this_time = min (chunk, remaining); + size_t N = f.read(buffer.data(), 1, chunk); + if (N < this_time) { + throw ReadFileError (from, errno); + } + + N = t.write(buffer.data(), 1, this_time); + if (N < this_time) { + throw WriteFileError (to, errno); + } + + progress (1 - float(remaining) / total); + remaining -= this_time; + } +} + + +dcp::Size +scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta) +{ + /* Now scale it down if the display container is smaller than the film container */ + if (display_container != film_container) { + float const scale = min ( + float (display_container.width) / film_container.width, + float (display_container.height) / film_container.height + ); + + s.width = lrintf (s.width * scale); + s.height = lrintf (s.height * scale); + s = quanta.round (s); + } + + return s; +} + + +dcp::DecryptedKDM +decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm) +{ + try { + return dcp::DecryptedKDM (kdm, Config::instance()->decryption_chain()->key().get()); + } catch (dcp::KDMDecryptionError& e) { + /* Try to flesh out the error a bit */ + auto const kdm_subject_name = kdm.recipient_x509_subject_name(); + bool on_chain = false; + auto dc = Config::instance()->decryption_chain(); + for (auto i: dc->root_to_leaf()) { + if (i.subject() == kdm_subject_name) { + on_chain = true; + } + } + if (!on_chain) { + throw KDMError (_("This KDM was not made for DCP-o-matic's decryption certificate."), e.what()); + } else if (kdm_subject_name != dc->leaf().subject()) { + throw KDMError (_("This KDM was made for DCP-o-matic but not for its leaf certificate."), e.what()); + } else { + throw; + } + } +} + + +boost::filesystem::path +default_font_file () +{ + boost::filesystem::path liberation_normal; + try { + liberation_normal = resources_path() / "LiberationSans-Regular.ttf"; + if (!boost::filesystem::exists (liberation_normal)) { + /* Hack for unit tests */ + liberation_normal = resources_path() / "fonts" / "LiberationSans-Regular.ttf"; + } + } catch (boost::filesystem::filesystem_error& e) { - return period; + } + + if (!boost::filesystem::exists(liberation_normal)) { + liberation_normal = "/usr/share/fonts/truetype/liberation/LiberationSans-Regular.ttf"; + } + + return liberation_normal; } + + +string +to_upper (string s) +{ + transform (s.begin(), s.end(), s.begin(), ::toupper); + return s; +} + + +/* Set to 1 to print the IDs of some of our threads to stdout on creation */ +#define DCPOMATIC_DEBUG_THREADS 0 + +#if DCPOMATIC_DEBUG_THREADS +void +start_of_thread (string name) +{ + std::cout << "THREAD:" << name << ":" << std::hex << pthread_self() << "\n"; +} +#else +void +start_of_thread (string) +{ + +} +#endif +