2 Copyright (C) 2012-2014 Carl Hetherington <cth@carlh.net>
3 Copyright (C) 2000-2007 Paul Davis
5 This program is free software; you can redistribute it and/or modify
6 it under the terms of the GNU General Public License as published by
7 the Free Software Foundation; either version 2 of the License, or
8 (at your option) any later version.
10 This program is distributed in the hope that it will be useful,
11 but WITHOUT ANY WARRANTY; without even the implied warranty of
12 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 GNU General Public License for more details.
15 You should have received a copy of the GNU General Public License
16 along with this program; if not, write to the Free Software
17 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
21 /** @file src/lib/util.cc
22 * @brief Some utility functions and classes.
30 #ifdef DCPOMATIC_POSIX
34 #include <libssh/libssh.h>
36 #include <boost/algorithm/string.hpp>
37 #include <boost/bind.hpp>
38 #include <boost/lambda/lambda.hpp>
39 #include <boost/thread.hpp>
40 #include <boost/filesystem.hpp>
41 #ifdef DCPOMATIC_WINDOWS
42 #include <boost/locale.hpp>
46 #ifdef DCPOMATIC_IMAGE_MAGICK
47 #include <magick/MagickCore.h>
49 #include <magick/common.h>
50 #include <magick/magick_config.h>
52 #include <magick/version.h>
53 #include <libdcp/version.h>
54 #include <libdcp/util.h>
55 #include <libdcp/signer_chain.h>
56 #include <libdcp/signer.h>
57 #include <libdcp/raw_convert.h>
59 #include <libavcodec/avcodec.h>
60 #include <libavformat/avformat.h>
61 #include <libswscale/swscale.h>
62 #include <libavfilter/avfiltergraph.h>
63 #include <libavutil/pixfmt.h>
66 #include "exceptions.h"
68 #include "dcp_content_type.h"
70 #include "sound_processor.h"
75 #include "video_content.h"
76 #include "md5_digester.h"
77 #include "safe_stringstream.h"
78 #ifdef DCPOMATIC_WINDOWS
98 using std::numeric_limits;
101 using std::bad_alloc;
102 using std::streampos;
103 using std::set_terminate;
104 using boost::shared_ptr;
106 using boost::optional;
108 using libdcp::raw_convert;
110 static boost::thread::id ui_thread;
111 static boost::filesystem::path backtrace_file;
113 /** Convert some number of seconds to a string representation
114 * in hours, minutes and seconds.
117 * @return String of the form H:M:S (where H is hours, M
118 * is minutes and S is seconds).
121 seconds_to_hms (int s)
128 SafeStringStream hms;
131 hms << std::setfill ('0') << m << N_(":");
133 hms << std::setfill ('0') << s;
138 /** @param s Number of seconds.
139 * @return String containing an approximate description of s (e.g. "about 2 hours")
142 seconds_to_approximate_hms (int s)
151 bool const hours = h > 0;
152 bool const minutes = h < 10 && m > 0;
153 bool const seconds = m < 10 && s > 0;
156 if (m > 30 && !minutes) {
157 ap << (h + 1) << N_(" ") << _("hours");
167 if (minutes | seconds) {
174 if (s > 30 && !seconds) {
175 ap << (m + 1) << N_(" ") << _("minutes");
203 #ifdef DCPOMATIC_POSIX
204 /** @param l Mangled C++ identifier.
205 * @return Demangled version.
210 string::size_type const b = l.find_first_of (N_("("));
211 if (b == string::npos) {
215 string::size_type const p = l.find_last_of (N_("+"));
216 if (p == string::npos) {
224 string const fn = l.substr (b + 1, p - b - 1);
229 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
234 } catch (std::exception) {
241 /** Write a stacktrace to an ostream.
242 * @param out Stream to write to.
243 * @param levels Number of levels to go up the call stack.
246 stacktrace (ostream& out, int levels)
249 size_t size = backtrace (array, 200);
250 char** strings = backtrace_symbols (array, size);
253 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
254 out << N_(" ") << demangle (strings[i]) << "\n";
262 /** @param v Version as used by FFmpeg.
263 * @return A string representation of v.
266 ffmpeg_version_to_string (int v)
269 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
273 /** Return a user-readable string summarising the versions of our dependencies */
275 dependency_version_summary ()
278 s << N_("libopenjpeg ") << opj_version () << N_(", ")
279 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
280 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
281 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
282 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
283 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
284 << MagickVersion << N_(", ")
285 << N_("libssh ") << ssh_version (0) << N_(", ")
286 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
292 seconds (struct timeval t)
294 return t.tv_sec + (double (t.tv_usec) / 1e6);
297 #ifdef DCPOMATIC_WINDOWS
298 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
301 FILE* f = fopen_boost (backtrace_file, "w");
302 fprintf (f, "Exception thrown:");
303 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
304 fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str());
307 return EXCEPTION_CONTINUE_SEARCH;
311 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
315 static bool tried_throw = false;
318 // try once to re-throw currently active exception
324 catch (const std::exception &e) {
325 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
326 << e.what() << std::endl;
329 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
333 #ifdef DCPOMATIC_POSIX
334 stacktrace (cout, 50);
339 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
340 * Must be called from the UI thread, if there is one.
345 #ifdef DCPOMATIC_WINDOWS
346 backtrace_file /= g_get_user_config_dir ();
347 backtrace_file /= "backtrace.txt";
348 SetUnhandledExceptionFilter(exception_handler);
350 /* Dark voodoo which, I think, gets boost::filesystem::path to
351 correctly convert UTF-8 strings to paths, and also paths
352 back to UTF-8 strings (on path::string()).
354 After this, constructing boost::filesystem::paths from strings
355 converts from UTF-8 to UTF-16 inside the path. Then
356 path::string().c_str() gives UTF-8 and
357 path::c_str() gives UTF-16.
359 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
360 so things are much simpler.
362 std::locale::global (boost::locale::generator().generate (""));
363 boost::filesystem::path::imbue (std::locale ());
366 avfilter_register_all ();
369 /* Add our lib directory to the libltdl search path so that
370 xmlsec can find xmlsec1-openssl.
372 boost::filesystem::path lib = app_contents ();
374 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
377 set_terminate (terminate);
381 Ratio::setup_ratios ();
382 VideoContentScale::setup_scales ();
383 DCPContentType::setup_dcp_content_types ();
384 Scaler::setup_scalers ();
385 Filter::setup_filters ();
386 SoundProcessor::setup_sound_processors ();
388 ui_thread = boost::this_thread::get_id ();
391 #ifdef DCPOMATIC_WINDOWS
392 boost::filesystem::path
396 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
397 boost::filesystem::path p (buffer);
398 p = p.parent_path ();
399 p = p.parent_path ();
406 boost::filesystem::path
409 return "DCP-o-matic.app/Contents/Resources";
414 dcpomatic_setup_gettext_i18n (string lang)
416 #ifdef DCPOMATIC_LINUX
420 if (!lang.empty ()) {
421 /* Override our environment language. Note that the caller must not
422 free the string passed into putenv().
424 string s = String::compose ("LANGUAGE=%1", lang);
425 putenv (strdup (s.c_str ()));
426 s = String::compose ("LANG=%1", lang);
427 putenv (strdup (s.c_str ()));
428 s = String::compose ("LC_ALL=%1", lang);
429 putenv (strdup (s.c_str ()));
432 setlocale (LC_ALL, "");
433 textdomain ("libdcpomatic");
435 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
436 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
437 bind_textdomain_codeset ("libdcpomatic", "UTF8");
440 #ifdef DCPOMATIC_LINUX
441 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
445 /** @param s A string.
446 * @return Parts of the string split at spaces, except when a space is within quotation marks.
449 split_at_spaces_considering_quotes (string s)
452 bool in_quotes = false;
454 for (string::size_type i = 0; i < s.length(); ++i) {
455 if (s[i] == ' ' && !in_quotes) {
458 } else if (s[i] == '"') {
459 in_quotes = !in_quotes;
469 /** @param job Optional job for which to report progress */
471 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
473 boost::uintmax_t const buffer_size = 64 * 1024;
474 char buffer[buffer_size];
476 MD5Digester digester;
478 vector<int64_t> sizes;
479 for (size_t i = 0; i < files.size(); ++i) {
480 sizes.push_back (boost::filesystem::file_size (files[i]));
483 for (size_t i = 0; i < files.size(); ++i) {
484 FILE* f = fopen_boost (files[i], "rb");
486 throw OpenFileError (files[i].string());
489 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
490 boost::uintmax_t remaining = bytes;
492 while (remaining > 0) {
493 int const t = min (remaining, buffer_size);
494 fread (buffer, 1, t, f);
495 digester.add (buffer, t);
499 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
506 return digester.get ();
509 /** @param An arbitrary audio frame rate.
510 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
513 dcp_audio_frame_rate (int fs)
522 Socket::Socket (int timeout)
523 : _deadline (_io_service)
524 , _socket (_io_service)
528 _deadline.expires_at (boost::posix_time::pos_infin);
540 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
542 _acceptor->cancel ();
546 _deadline.expires_at (boost::posix_time::pos_infin);
549 _deadline.async_wait (boost::bind (&Socket::check, this));
552 /** Blocking connect.
553 * @param endpoint End-point to connect to.
556 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
558 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
559 boost::system::error_code ec = boost::asio::error::would_block;
560 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
562 _io_service.run_one();
563 } while (ec == boost::asio::error::would_block);
566 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
569 if (!_socket.is_open ()) {
570 throw NetworkError (_("connect timed out"));
575 Socket::accept (int port)
577 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
579 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
580 boost::system::error_code ec = boost::asio::error::would_block;
581 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
583 _io_service.run_one ();
584 } while (ec == boost::asio::error::would_block);
590 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
595 * @param data Buffer to write.
596 * @param size Number of bytes to write.
599 Socket::write (uint8_t const * data, int size)
601 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
602 boost::system::error_code ec = boost::asio::error::would_block;
604 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
607 _io_service.run_one ();
608 } while (ec == boost::asio::error::would_block);
611 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
616 Socket::write (uint32_t v)
619 write (reinterpret_cast<uint8_t*> (&v), 4);
623 * @param data Buffer to read to.
624 * @param size Number of bytes to read.
627 Socket::read (uint8_t* data, int size)
629 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
630 boost::system::error_code ec = boost::asio::error::would_block;
632 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
635 _io_service.run_one ();
636 } while (ec == boost::asio::error::would_block);
639 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
644 Socket::read_uint32 ()
647 read (reinterpret_cast<uint8_t *> (&v), 4);
651 /** Round a number up to the nearest multiple of another number.
653 * @param s Array of numbers to round, indexed by c.
654 * @param t Multiple to round to.
655 * @return Rounded number.
658 stride_round_up (int c, int const * stride, int t)
660 int const a = stride[c] + (t - 1);
664 /** Read a sequence of key / value pairs from a text stream;
665 * the keys are the first words on the line, and the values are
666 * the remainder of the line following the key. Lines beginning
667 * with # are ignored.
668 * @param s Stream to read.
669 * @return key/value pairs.
671 multimap<string, string>
672 read_key_value (istream &s)
674 multimap<string, string> kv;
677 while (getline (s, line)) {
682 if (line[0] == '#') {
686 if (line[line.size() - 1] == '\r') {
687 line = line.substr (0, line.size() - 1);
690 size_t const s = line.find (' ');
691 if (s == string::npos) {
695 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
702 get_required_string (multimap<string, string> const & kv, string k)
704 if (kv.count (k) > 1) {
705 throw StringError (N_("unexpected multiple keys in key-value set"));
708 multimap<string, string>::const_iterator i = kv.find (k);
710 if (i == kv.end ()) {
711 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
718 get_required_int (multimap<string, string> const & kv, string k)
720 string const v = get_required_string (kv, k);
721 return raw_convert<int> (v);
725 get_required_float (multimap<string, string> const & kv, string k)
727 string const v = get_required_string (kv, k);
728 return raw_convert<float> (v);
732 get_optional_string (multimap<string, string> const & kv, string k)
734 if (kv.count (k) > 1) {
735 throw StringError (N_("unexpected multiple keys in key-value set"));
738 multimap<string, string>::const_iterator i = kv.find (k);
739 if (i == kv.end ()) {
747 get_optional_int (multimap<string, string> const & kv, string k)
749 if (kv.count (k) > 1) {
750 throw StringError (N_("unexpected multiple keys in key-value set"));
753 multimap<string, string>::const_iterator i = kv.find (k);
754 if (i == kv.end ()) {
758 return raw_convert<int> (i->second);
761 /** Trip an assert if the caller is not in the UI thread */
765 assert (boost::this_thread::get_id() == ui_thread);
768 /** @param v Content video frame.
769 * @param audio_sample_rate Source audio sample rate.
770 * @param frames_per_second Number of video frames per second.
771 * @return Equivalent number of audio frames for `v'.
774 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
776 return ((int64_t) v * audio_sample_rate / frames_per_second);
780 audio_channel_name (int c)
782 assert (MAX_DCP_AUDIO_CHANNELS == 12);
784 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
785 enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
786 VI is the visually-impaired audio track (audio describe).
788 string const channels[] = {
795 _("Hearing impaired"),
796 _("Visually impaired"),
799 _("Left rear surround"),
800 _("Right rear surround"),
807 valid_image_file (boost::filesystem::path f)
809 string ext = f.extension().string();
810 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
811 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx");
815 tidy_for_filename (string f)
818 for (size_t i = 0; i < f.length(); ++i) {
819 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
829 shared_ptr<const libdcp::Signer>
832 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
834 /* Remake the chain if any of it is missing */
836 list<boost::filesystem::path> files;
837 files.push_back ("ca.self-signed.pem");
838 files.push_back ("intermediate.signed.pem");
839 files.push_back ("leaf.signed.pem");
840 files.push_back ("leaf.key");
842 list<boost::filesystem::path>::const_iterator i = files.begin();
843 while (i != files.end()) {
844 boost::filesystem::path p (sd);
846 if (!boost::filesystem::exists (p)) {
847 boost::filesystem::remove_all (sd);
848 boost::filesystem::create_directories (sd);
849 libdcp::make_signer_chain (sd, openssl_path ());
856 libdcp::CertificateChain chain;
859 boost::filesystem::path p (sd);
860 p /= "ca.self-signed.pem";
861 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
865 boost::filesystem::path p (sd);
866 p /= "intermediate.signed.pem";
867 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
871 boost::filesystem::path p (sd);
872 p /= "leaf.signed.pem";
873 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
876 boost::filesystem::path signer_key (sd);
877 signer_key /= "leaf.key";
879 return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));
883 split_get_request (string url)
886 AWAITING_QUESTION_MARK,
889 } state = AWAITING_QUESTION_MARK;
891 map<string, string> r;
894 for (size_t i = 0; i < url.length(); ++i) {
896 case AWAITING_QUESTION_MARK:
911 r.insert (make_pair (k, v));
921 if (state == VALUE) {
922 r.insert (make_pair (k, v));
929 fit_ratio_within (float ratio, libdcp::Size full_frame)
931 if (ratio < full_frame.ratio ()) {
932 return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
935 return libdcp::Size (full_frame.width, rint (full_frame.width / ratio));
939 wrapped_av_malloc (size_t s)
941 void* p = av_malloc (s);
949 entities_to_text (string e)
951 boost::algorithm::replace_all (e, "%3A", ":");
952 boost::algorithm::replace_all (e, "%2F", "/");
957 divide_with_round (int64_t a, int64_t b)
959 if (a % b >= (b / 2)) {
960 return (a + b - 1) / b;
966 ScopedTemporary::ScopedTemporary ()
969 _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
972 ScopedTemporary::~ScopedTemporary ()
975 boost::system::error_code ec;
976 boost::filesystem::remove (_file, ec);
980 ScopedTemporary::c_str () const
982 return _file.string().c_str ();
986 ScopedTemporary::open (char const * params)
988 _open = fopen (c_str(), params);
993 ScopedTemporary::close ()