2 Copyright (C) 2012 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.
31 #ifdef DCPOMATIC_POSIX
35 #include <libssh/libssh.h>
37 #include <boost/algorithm/string.hpp>
38 #include <boost/bind.hpp>
39 #include <boost/lambda/lambda.hpp>
40 #include <boost/lexical_cast.hpp>
41 #include <boost/thread.hpp>
42 #include <boost/filesystem.hpp>
43 #ifdef DCPOMATIC_WINDOWS
44 #include <boost/locale.hpp>
48 #include <openssl/md5.h>
49 #include <magick/MagickCore.h>
50 #include <magick/version.h>
51 #include <libdcp/version.h>
52 #include <libdcp/util.h>
53 #include <libdcp/signer_chain.h>
54 #include <libdcp/signer.h>
56 #include <libavcodec/avcodec.h>
57 #include <libavformat/avformat.h>
58 #include <libswscale/swscale.h>
59 #include <libavfilter/avfiltergraph.h>
60 #include <libpostproc/postprocess.h>
61 #include <libavutil/pixfmt.h>
64 #include "exceptions.h"
66 #include "dcp_content_type.h"
68 #include "sound_processor.h"
73 #ifdef DCPOMATIC_WINDOWS
80 using std::stringstream;
93 using std::numeric_limits;
98 using std::set_terminate;
99 using boost::shared_ptr;
101 using boost::lexical_cast;
102 using boost::optional;
105 static boost::thread::id ui_thread;
106 static boost::filesystem::path backtrace_file;
108 /** Convert some number of seconds to a string representation
109 * in hours, minutes and seconds.
112 * @return String of the form H:M:S (where H is hours, M
113 * is minutes and S is seconds).
116 seconds_to_hms (int s)
126 hms << std::setfill ('0') << m << N_(":");
128 hms << std::setfill ('0') << s;
133 /** @param s Number of seconds.
134 * @return String containing an approximate description of s (e.g. "about 2 hours")
137 seconds_to_approximate_hms (int s)
148 ap << (h + 1) << N_(" ") << _("hours");
151 ap << N_("1 ") << _("hour");
153 ap << h << N_(" ") << _("hours");
158 ap << N_("1 ") << _("minute");
160 ap << m << N_(" ") << _("minutes");
163 ap << s << N_(" ") << _("seconds");
169 #ifdef DCPOMATIC_POSIX
170 /** @param l Mangled C++ identifier.
171 * @return Demangled version.
176 string::size_type const b = l.find_first_of (N_("("));
177 if (b == string::npos) {
181 string::size_type const p = l.find_last_of (N_("+"));
182 if (p == string::npos) {
190 string const fn = l.substr (b + 1, p - b - 1);
195 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
200 } catch (std::exception) {
207 /** Write a stacktrace to an ostream.
208 * @param out Stream to write to.
209 * @param levels Number of levels to go up the call stack.
212 stacktrace (ostream& out, int levels)
215 size_t size = backtrace (array, 200);
216 char** strings = backtrace_symbols (array, size);
219 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
220 out << N_(" ") << demangle (strings[i]) << "\n";
228 /** @param v Version as used by FFmpeg.
229 * @return A string representation of v.
232 ffmpeg_version_to_string (int v)
235 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
239 /** Return a user-readable string summarising the versions of our dependencies */
241 dependency_version_summary ()
244 s << N_("libopenjpeg ") << opj_version () << N_(", ")
245 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
246 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
247 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
248 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
249 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
250 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
251 << MagickVersion << N_(", ")
252 << N_("libssh ") << ssh_version (0) << N_(", ")
253 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
259 seconds (struct timeval t)
261 return t.tv_sec + (double (t.tv_usec) / 1e6);
264 #ifdef DCPOMATIC_WINDOWS
265 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
268 FILE* f = fopen_boost (backtrace_file, "w");
269 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
270 fprintf (f, "%p %s %d %s", i->instruction, i->function.c_str(), i->line, i->module.c_str());
273 return EXCEPTION_CONTINUE_SEARCH;
277 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
281 static bool tried_throw = false;
284 // try once to re-throw currently active exception
285 if (!tried_throw++) {
289 catch (const std::exception &e) {
290 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
291 << e.what() << std::endl;
294 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
298 stacktrace (cout, 50);
302 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
303 * Must be called from the UI thread, if there is one.
308 #ifdef DCPOMATIC_WINDOWS
309 backtrace_file /= g_get_user_config_dir ();
310 backtrace_file /= "backtrace.txt";
311 SetUnhandledExceptionFilter(exception_handler);
313 /* Dark voodoo which, I think, gets boost::filesystem::path to
314 correctly convert UTF-8 strings to paths, and also paths
315 back to UTF-8 strings (on path::string()).
317 After this, constructing boost::filesystem::paths from strings
318 converts from UTF-8 to UTF-16 inside the path. Then
319 path::string().c_str() gives UTF-8 and
320 path::c_str() gives UTF-16.
322 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
323 so things are much simpler.
325 std::locale::global (boost::locale::generator().generate (""));
326 boost::filesystem::path::imbue (std::locale ());
329 avfilter_register_all ();
332 /* Add our lib directory to the libltdl search path so that
333 xmlsec can find xmlsec1-openssl.
335 boost::filesystem::path lib = app_contents ();
337 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
340 set_terminate (terminate);
344 Ratio::setup_ratios ();
345 DCPContentType::setup_dcp_content_types ();
346 Scaler::setup_scalers ();
347 Filter::setup_filters ();
348 SoundProcessor::setup_sound_processors ();
350 ui_thread = boost::this_thread::get_id ();
353 #ifdef DCPOMATIC_WINDOWS
354 boost::filesystem::path
358 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
359 boost::filesystem::path p (buffer);
360 p = p.parent_path ();
361 p = p.parent_path ();
368 dcpomatic_setup_gettext_i18n (string lang)
370 #ifdef DCPOMATIC_POSIX
374 if (!lang.empty ()) {
375 /* Override our environment language; this is essential on
379 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
381 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
383 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
387 setlocale (LC_ALL, "");
388 textdomain ("libdcpomatic");
390 #ifdef DCPOMATIC_WINDOWS
391 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
392 bind_textdomain_codeset ("libdcpomatic", "UTF8");
395 #ifdef DCPOMATIC_POSIX
396 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
400 /** @param s A string.
401 * @return Parts of the string split at spaces, except when a space is within quotation marks.
404 split_at_spaces_considering_quotes (string s)
407 bool in_quotes = false;
409 for (string::size_type i = 0; i < s.length(); ++i) {
410 if (s[i] == ' ' && !in_quotes) {
413 } else if (s[i] == '"') {
414 in_quotes = !in_quotes;
425 md5_digest (void const * data, int size)
428 MD5_Init (&md5_context);
429 MD5_Update (&md5_context, data, size);
430 unsigned char digest[MD5_DIGEST_LENGTH];
431 MD5_Final (digest, &md5_context);
434 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
435 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
441 /** @param job Optional job for which to report progress */
443 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
445 boost::uintmax_t const buffer_size = 64 * 1024;
446 char buffer[buffer_size];
449 MD5_Init (&md5_context);
451 vector<int64_t> sizes;
452 for (size_t i = 0; i < files.size(); ++i) {
453 sizes.push_back (boost::filesystem::file_size (files[i]));
456 for (size_t i = 0; i < files.size(); ++i) {
457 FILE* f = fopen_boost (files[i], "rb");
459 throw OpenFileError (files[i].string());
462 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
463 boost::uintmax_t remaining = bytes;
465 while (remaining > 0) {
466 int const t = min (remaining, buffer_size);
467 fread (buffer, 1, t, f);
468 MD5_Update (&md5_context, buffer, t);
472 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
479 unsigned char digest[MD5_DIGEST_LENGTH];
480 MD5_Final (digest, &md5_context);
483 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
484 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
491 about_equal (float a, float b)
493 /* A film of F seconds at f FPS will be Ff frames;
494 Consider some delta FPS d, so if we run the same
495 film at (f + d) FPS it will last F(f + d) seconds.
497 Hence the difference in length over the length of the film will
498 be F(f + d) - Ff frames
499 = Ff + Fd - Ff frames
503 So if we accept a difference of 1 frame, ie 1/f seconds, we can
510 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
511 FPS error is 1/F ~= 0.0001 ~= 10-e4
514 return (fabs (a - b) < 1e-4);
517 /** @param An arbitrary audio frame rate.
518 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
521 dcp_audio_frame_rate (int fs)
530 Socket::Socket (int timeout)
531 : _deadline (_io_service)
532 , _socket (_io_service)
536 _deadline.expires_at (boost::posix_time::pos_infin);
548 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
550 _acceptor->cancel ();
554 _deadline.expires_at (boost::posix_time::pos_infin);
557 _deadline.async_wait (boost::bind (&Socket::check, this));
560 /** Blocking connect.
561 * @param endpoint End-point to connect to.
564 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
566 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
567 boost::system::error_code ec = boost::asio::error::would_block;
568 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
570 _io_service.run_one();
571 } while (ec == boost::asio::error::would_block);
574 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
577 if (!_socket.is_open ()) {
578 throw NetworkError (_("connect timed out"));
583 Socket::accept (int port)
585 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
587 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
588 boost::system::error_code ec = boost::asio::error::would_block;
589 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
591 _io_service.run_one ();
592 } while (ec == boost::asio::error::would_block );
598 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
603 * @param data Buffer to write.
604 * @param size Number of bytes to write.
607 Socket::write (uint8_t const * data, int size)
609 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
610 boost::system::error_code ec = boost::asio::error::would_block;
612 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
615 _io_service.run_one ();
616 } while (ec == boost::asio::error::would_block);
619 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
624 Socket::write (uint32_t v)
627 write (reinterpret_cast<uint8_t*> (&v), 4);
631 * @param data Buffer to read to.
632 * @param size Number of bytes to read.
635 Socket::read (uint8_t* data, int size)
637 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
638 boost::system::error_code ec = boost::asio::error::would_block;
640 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
643 _io_service.run_one ();
644 } while (ec == boost::asio::error::would_block);
647 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
652 Socket::read_uint32 ()
655 read (reinterpret_cast<uint8_t *> (&v), 4);
659 /** Round a number up to the nearest multiple of another number.
661 * @param s Array of numbers to round, indexed by c.
662 * @param t Multiple to round to.
663 * @return Rounded number.
666 stride_round_up (int c, int const * stride, int t)
668 int const a = stride[c] + (t - 1);
672 /** Read a sequence of key / value pairs from a text stream;
673 * the keys are the first words on the line, and the values are
674 * the remainder of the line following the key. Lines beginning
675 * with # are ignored.
676 * @param s Stream to read.
677 * @return key/value pairs.
679 multimap<string, string>
680 read_key_value (istream &s)
682 multimap<string, string> kv;
685 while (getline (s, line)) {
690 if (line[0] == '#') {
694 if (line[line.size() - 1] == '\r') {
695 line = line.substr (0, line.size() - 1);
698 size_t const s = line.find (' ');
699 if (s == string::npos) {
703 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
710 get_required_string (multimap<string, string> const & kv, string k)
712 if (kv.count (k) > 1) {
713 throw StringError (N_("unexpected multiple keys in key-value set"));
716 multimap<string, string>::const_iterator i = kv.find (k);
718 if (i == kv.end ()) {
719 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
726 get_required_int (multimap<string, string> const & kv, string k)
728 string const v = get_required_string (kv, k);
729 return lexical_cast<int> (v);
733 get_required_float (multimap<string, string> const & kv, string k)
735 string const v = get_required_string (kv, k);
736 return lexical_cast<float> (v);
740 get_optional_string (multimap<string, string> const & kv, string k)
742 if (kv.count (k) > 1) {
743 throw StringError (N_("unexpected multiple keys in key-value set"));
746 multimap<string, string>::const_iterator i = kv.find (k);
747 if (i == kv.end ()) {
755 get_optional_int (multimap<string, string> const & kv, string k)
757 if (kv.count (k) > 1) {
758 throw StringError (N_("unexpected multiple keys in key-value set"));
761 multimap<string, string>::const_iterator i = kv.find (k);
762 if (i == kv.end ()) {
766 return lexical_cast<int> (i->second);
769 /** Trip an assert if the caller is not in the UI thread */
773 assert (boost::this_thread::get_id() == ui_thread);
776 /** @param v Content video frame.
777 * @param audio_sample_rate Source audio sample rate.
778 * @param frames_per_second Number of video frames per second.
779 * @return Equivalent number of audio frames for `v'.
782 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
784 return ((int64_t) v * audio_sample_rate / frames_per_second);
788 audio_channel_name (int c)
790 assert (MAX_AUDIO_CHANNELS == 6);
792 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
793 enhancement channel (sub-woofer).
795 string const channels[] = {
807 FrameRateConversion::FrameRateConversion (float source, int dcp)
810 , change_speed (false)
812 if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
813 /* The difference between source and DCP frame rate will be lower
814 (i.e. better) if we skip.
817 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
818 /* The difference between source and DCP frame rate would be better
819 if we repeated each frame once; it may be better still if we
820 repeated more than once. Work out the required repeat.
822 repeat = round (dcp / source);
825 change_speed = !about_equal (source * factor(), dcp);
827 if (!skip && repeat == 1 && !change_speed) {
828 description = _("Content and DCP have the same rate.\n");
831 description = _("DCP will use every other frame of the content.\n");
832 } else if (repeat == 2) {
833 description = _("Each content frame will be doubled in the DCP.\n");
834 } else if (repeat > 2) {
835 description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
839 float const pc = dcp * 100 / (source * factor());
840 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
845 LocaleGuard::LocaleGuard ()
848 char const * old = setlocale (LC_NUMERIC, 0);
852 if (strcmp (_old, "C")) {
853 setlocale (LC_NUMERIC, "C");
858 LocaleGuard::~LocaleGuard ()
860 setlocale (LC_NUMERIC, _old);
865 valid_image_file (boost::filesystem::path f)
867 string ext = f.extension().string();
868 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
869 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
873 tidy_for_filename (string f)
876 for (size_t i = 0; i < f.length(); ++i) {
877 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
887 shared_ptr<const libdcp::Signer>
890 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
892 /* Remake the chain if any of it is missing */
894 list<boost::filesystem::path> files;
895 files.push_back ("ca.self-signed.pem");
896 files.push_back ("intermediate.signed.pem");
897 files.push_back ("leaf.signed.pem");
898 files.push_back ("leaf.key");
900 list<boost::filesystem::path>::const_iterator i = files.begin();
901 while (i != files.end()) {
902 boost::filesystem::path p (sd);
904 if (!boost::filesystem::exists (p)) {
905 boost::filesystem::remove_all (sd);
906 boost::filesystem::create_directories (sd);
907 libdcp::make_signer_chain (sd, openssl_path ());
914 libdcp::CertificateChain chain;
917 boost::filesystem::path p (sd);
918 p /= "ca.self-signed.pem";
919 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
923 boost::filesystem::path p (sd);
924 p /= "intermediate.signed.pem";
925 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
929 boost::filesystem::path p (sd);
930 p /= "leaf.signed.pem";
931 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
934 boost::filesystem::path signer_key (sd);
935 signer_key /= "leaf.key";
937 return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));
941 fit_ratio_within (float ratio, libdcp::Size full_frame)
943 if (ratio < full_frame.ratio ()) {
944 return libdcp::Size (rint (full_frame.height * ratio), full_frame.height);
947 return libdcp::Size (full_frame.width, rint (full_frame.width / ratio));
951 wrapped_av_malloc (size_t s)
953 void* p = av_malloc (s);