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 <pangomm/init.h>
52 #include <libdcp/version.h>
53 #include <libdcp/util.h>
54 #include <libdcp/signer_chain.h>
55 #include <libdcp/signer.h>
57 #include <libavcodec/avcodec.h>
58 #include <libavformat/avformat.h>
59 #include <libswscale/swscale.h>
60 #include <libavfilter/avfiltergraph.h>
61 #include <libpostproc/postprocess.h>
62 #include <libavutil/pixfmt.h>
65 #include "exceptions.h"
67 #include "dcp_content_type.h"
69 #include "sound_processor.h"
74 #ifdef DCPOMATIC_WINDOWS
81 using std::stringstream;
94 using std::numeric_limits;
99 using std::set_terminate;
100 using boost::shared_ptr;
102 using boost::lexical_cast;
103 using boost::optional;
106 static boost::thread::id ui_thread;
107 static boost::filesystem::path backtrace_file;
109 /** Convert some number of seconds to a string representation
110 * in hours, minutes and seconds.
113 * @return String of the form H:M:S (where H is hours, M
114 * is minutes and S is seconds).
117 seconds_to_hms (int s)
127 hms << std::setfill ('0') << m << N_(":");
129 hms << std::setfill ('0') << s;
134 /** @param s Number of seconds.
135 * @return String containing an approximate description of s (e.g. "about 2 hours")
138 seconds_to_approximate_hms (int s)
149 ap << (h + 1) << N_(" ") << _("hours");
152 ap << N_("1 ") << _("hour");
154 ap << h << N_(" ") << _("hours");
159 ap << N_("1 ") << _("minute");
161 ap << m << N_(" ") << _("minutes");
164 ap << s << N_(" ") << _("seconds");
170 #ifdef DCPOMATIC_POSIX
171 /** @param l Mangled C++ identifier.
172 * @return Demangled version.
177 string::size_type const b = l.find_first_of (N_("("));
178 if (b == string::npos) {
182 string::size_type const p = l.find_last_of (N_("+"));
183 if (p == string::npos) {
191 string const fn = l.substr (b + 1, p - b - 1);
196 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
201 } catch (std::exception) {
208 /** Write a stacktrace to an ostream.
209 * @param out Stream to write to.
210 * @param levels Number of levels to go up the call stack.
213 stacktrace (ostream& out, int levels)
216 size_t size = backtrace (array, 200);
217 char** strings = backtrace_symbols (array, size);
220 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
221 out << N_(" ") << demangle (strings[i]) << "\n";
229 /** @param v Version as used by FFmpeg.
230 * @return A string representation of v.
233 ffmpeg_version_to_string (int v)
236 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
240 /** Return a user-readable string summarising the versions of our dependencies */
242 dependency_version_summary ()
245 s << N_("libopenjpeg ") << opj_version () << N_(", ")
246 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
247 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
248 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
249 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
250 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
251 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
252 << MagickVersion << N_(", ")
253 << N_("libssh ") << ssh_version (0) << N_(", ")
254 << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
260 seconds (struct timeval t)
262 return t.tv_sec + (double (t.tv_usec) / 1e6);
265 #ifdef DCPOMATIC_WINDOWS
266 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
269 FILE* f = fopen_boost (backtrace_file, "w");
270 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
271 fprintf (f, "%p %s %d %s", i->instruction, i->function.c_str(), i->line, i->module.c_str());
274 return EXCEPTION_CONTINUE_SEARCH;
278 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
282 static bool tried_throw = false;
285 // try once to re-throw currently active exception
286 if (!tried_throw++) {
290 catch (const std::exception &e) {
291 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
292 << e.what() << std::endl;
295 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
299 #ifdef DCPOMATIC_POSIX
300 stacktrace (cout, 50);
305 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
306 * Must be called from the UI thread, if there is one.
311 #ifdef DCPOMATIC_WINDOWS
312 backtrace_file /= g_get_user_config_dir ();
313 backtrace_file /= "backtrace.txt";
314 SetUnhandledExceptionFilter(exception_handler);
316 /* Dark voodoo which, I think, gets boost::filesystem::path to
317 correctly convert UTF-8 strings to paths, and also paths
318 back to UTF-8 strings (on path::string()).
320 After this, constructing boost::filesystem::paths from strings
321 converts from UTF-8 to UTF-16 inside the path. Then
322 path::string().c_str() gives UTF-8 and
323 path::c_str() gives UTF-16.
325 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
326 so things are much simpler.
328 std::locale::global (boost::locale::generator().generate (""));
329 boost::filesystem::path::imbue (std::locale ());
332 avfilter_register_all ();
335 /* Add our lib directory to the libltdl search path so that
336 xmlsec can find xmlsec1-openssl.
338 boost::filesystem::path lib = app_contents ();
340 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
343 set_terminate (terminate);
348 Ratio::setup_ratios ();
349 DCPContentType::setup_dcp_content_types ();
350 Scaler::setup_scalers ();
351 Filter::setup_filters ();
352 SoundProcessor::setup_sound_processors ();
354 ui_thread = boost::this_thread::get_id ();
357 #ifdef DCPOMATIC_WINDOWS
358 boost::filesystem::path
362 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
363 boost::filesystem::path p (buffer);
364 p = p.parent_path ();
365 p = p.parent_path ();
372 dcpomatic_setup_gettext_i18n (string lang)
374 #ifdef DCPOMATIC_POSIX
378 if (!lang.empty ()) {
379 /* Override our environment language; this is essential on
383 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
385 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
387 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
391 setlocale (LC_ALL, "");
392 textdomain ("libdcpomatic");
394 #ifdef DCPOMATIC_WINDOWS
395 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
396 bind_textdomain_codeset ("libdcpomatic", "UTF8");
399 #ifdef DCPOMATIC_POSIX
400 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
404 /** @param s A string.
405 * @return Parts of the string split at spaces, except when a space is within quotation marks.
408 split_at_spaces_considering_quotes (string s)
411 bool in_quotes = false;
413 for (string::size_type i = 0; i < s.length(); ++i) {
414 if (s[i] == ' ' && !in_quotes) {
417 } else if (s[i] == '"') {
418 in_quotes = !in_quotes;
429 md5_digest (void const * data, int size)
432 MD5_Init (&md5_context);
433 MD5_Update (&md5_context, data, size);
434 unsigned char digest[MD5_DIGEST_LENGTH];
435 MD5_Final (digest, &md5_context);
438 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
439 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
445 /** @param job Optional job for which to report progress */
447 md5_digest (vector<boost::filesystem::path> files, shared_ptr<Job> job)
449 boost::uintmax_t const buffer_size = 64 * 1024;
450 char buffer[buffer_size];
453 MD5_Init (&md5_context);
455 vector<int64_t> sizes;
456 for (size_t i = 0; i < files.size(); ++i) {
457 sizes.push_back (boost::filesystem::file_size (files[i]));
460 for (size_t i = 0; i < files.size(); ++i) {
461 FILE* f = fopen_boost (files[i], "rb");
463 throw OpenFileError (files[i].string());
466 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
467 boost::uintmax_t remaining = bytes;
469 while (remaining > 0) {
470 int const t = min (remaining, buffer_size);
471 fread (buffer, 1, t, f);
472 MD5_Update (&md5_context, buffer, t);
476 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
483 unsigned char digest[MD5_DIGEST_LENGTH];
484 MD5_Final (digest, &md5_context);
487 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
488 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
495 about_equal (float a, float b)
497 /* A film of F seconds at f FPS will be Ff frames;
498 Consider some delta FPS d, so if we run the same
499 film at (f + d) FPS it will last F(f + d) seconds.
501 Hence the difference in length over the length of the film will
502 be F(f + d) - Ff frames
503 = Ff + Fd - Ff frames
507 So if we accept a difference of 1 frame, ie 1/f seconds, we can
514 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
515 FPS error is 1/F ~= 0.0001 ~= 10-e4
518 return (fabs (a - b) < 1e-4);
521 /** @param An arbitrary audio frame rate.
522 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
525 dcp_audio_frame_rate (int fs)
534 Socket::Socket (int timeout)
535 : _deadline (_io_service)
536 , _socket (_io_service)
540 _deadline.expires_at (boost::posix_time::pos_infin);
552 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
554 _acceptor->cancel ();
558 _deadline.expires_at (boost::posix_time::pos_infin);
561 _deadline.async_wait (boost::bind (&Socket::check, this));
564 /** Blocking connect.
565 * @param endpoint End-point to connect to.
568 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
570 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
571 boost::system::error_code ec = boost::asio::error::would_block;
572 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
574 _io_service.run_one();
575 } while (ec == boost::asio::error::would_block);
578 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
581 if (!_socket.is_open ()) {
582 throw NetworkError (_("connect timed out"));
587 Socket::accept (int port)
589 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
591 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
592 boost::system::error_code ec = boost::asio::error::would_block;
593 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
595 _io_service.run_one ();
596 } while (ec == boost::asio::error::would_block );
602 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
607 * @param data Buffer to write.
608 * @param size Number of bytes to write.
611 Socket::write (uint8_t const * data, int size)
613 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
614 boost::system::error_code ec = boost::asio::error::would_block;
616 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
619 _io_service.run_one ();
620 } while (ec == boost::asio::error::would_block);
623 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
628 Socket::write (uint32_t v)
631 write (reinterpret_cast<uint8_t*> (&v), 4);
635 * @param data Buffer to read to.
636 * @param size Number of bytes to read.
639 Socket::read (uint8_t* data, int size)
641 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
642 boost::system::error_code ec = boost::asio::error::would_block;
644 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
647 _io_service.run_one ();
648 } while (ec == boost::asio::error::would_block);
651 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
656 Socket::read_uint32 ()
659 read (reinterpret_cast<uint8_t *> (&v), 4);
663 /** Round a number up to the nearest multiple of another number.
665 * @param s Array of numbers to round, indexed by c.
666 * @param t Multiple to round to.
667 * @return Rounded number.
670 stride_round_up (int c, int const * stride, int t)
672 int const a = stride[c] + (t - 1);
676 /** Read a sequence of key / value pairs from a text stream;
677 * the keys are the first words on the line, and the values are
678 * the remainder of the line following the key. Lines beginning
679 * with # are ignored.
680 * @param s Stream to read.
681 * @return key/value pairs.
683 multimap<string, string>
684 read_key_value (istream &s)
686 multimap<string, string> kv;
689 while (getline (s, line)) {
694 if (line[0] == '#') {
698 if (line[line.size() - 1] == '\r') {
699 line = line.substr (0, line.size() - 1);
702 size_t const s = line.find (' ');
703 if (s == string::npos) {
707 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
714 get_required_string (multimap<string, string> const & kv, string k)
716 if (kv.count (k) > 1) {
717 throw StringError (N_("unexpected multiple keys in key-value set"));
720 multimap<string, string>::const_iterator i = kv.find (k);
722 if (i == kv.end ()) {
723 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
730 get_required_int (multimap<string, string> const & kv, string k)
732 string const v = get_required_string (kv, k);
733 return lexical_cast<int> (v);
737 get_required_float (multimap<string, string> const & kv, string k)
739 string const v = get_required_string (kv, k);
740 return lexical_cast<float> (v);
744 get_optional_string (multimap<string, string> const & kv, string k)
746 if (kv.count (k) > 1) {
747 throw StringError (N_("unexpected multiple keys in key-value set"));
750 multimap<string, string>::const_iterator i = kv.find (k);
751 if (i == kv.end ()) {
759 get_optional_int (multimap<string, string> const & kv, string k)
761 if (kv.count (k) > 1) {
762 throw StringError (N_("unexpected multiple keys in key-value set"));
765 multimap<string, string>::const_iterator i = kv.find (k);
766 if (i == kv.end ()) {
770 return lexical_cast<int> (i->second);
773 /** Trip an assert if the caller is not in the UI thread */
777 assert (boost::this_thread::get_id() == ui_thread);
780 /** @param v Content video frame.
781 * @param audio_sample_rate Source audio sample rate.
782 * @param frames_per_second Number of video frames per second.
783 * @return Equivalent number of audio frames for `v'.
786 video_frames_to_audio_frames (VideoFrame v, float audio_sample_rate, float frames_per_second)
788 return ((int64_t) v * audio_sample_rate / frames_per_second);
792 audio_channel_name (int c)
794 assert (MAX_AUDIO_CHANNELS == 6);
796 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
797 enhancement channel (sub-woofer).
799 string const channels[] = {
811 FrameRateChange::FrameRateChange (float source, int dcp)
814 , change_speed (false)
816 if (fabs (source / 2.0 - dcp) < fabs (source - dcp)) {
817 /* The difference between source and DCP frame rate will be lower
818 (i.e. better) if we skip.
821 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
822 /* The difference between source and DCP frame rate would be better
823 if we repeated each frame once; it may be better still if we
824 repeated more than once. Work out the required repeat.
826 repeat = round (dcp / source);
829 speed_up = dcp / (source * factor());
830 change_speed = !about_equal (speed_up, 1.0);
832 if (!skip && repeat == 1 && !change_speed) {
833 description = _("Content and DCP have the same rate.\n");
836 description = _("DCP will use every other frame of the content.\n");
837 } else if (repeat == 2) {
838 description = _("Each content frame will be doubled in the DCP.\n");
839 } else if (repeat > 2) {
840 description = String::compose (_("Each content frame will be repeated %1 more times in the DCP.\n"), repeat - 1);
844 float const pc = dcp * 100 / (source * factor());
845 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
850 LocaleGuard::LocaleGuard ()
853 char const * old = setlocale (LC_NUMERIC, 0);
857 if (strcmp (_old, "C")) {
858 setlocale (LC_NUMERIC, "C");
863 LocaleGuard::~LocaleGuard ()
865 setlocale (LC_NUMERIC, _old);
870 valid_image_file (boost::filesystem::path f)
872 string ext = f.extension().string();
873 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
874 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
878 tidy_for_filename (string f)
881 for (size_t i = 0; i < f.length(); ++i) {
882 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
892 shared_ptr<const dcp::Signer>
895 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
897 /* Remake the chain if any of it is missing */
899 list<boost::filesystem::path> files;
900 files.push_back ("ca.self-signed.pem");
901 files.push_back ("intermediate.signed.pem");
902 files.push_back ("leaf.signed.pem");
903 files.push_back ("leaf.key");
905 list<boost::filesystem::path>::const_iterator i = files.begin();
906 while (i != files.end()) {
907 boost::filesystem::path p (sd);
909 if (!boost::filesystem::exists (p)) {
910 boost::filesystem::remove_all (sd);
911 boost::filesystem::create_directories (sd);
912 dcp::make_signer_chain (sd, openssl_path ());
919 dcp::CertificateChain chain;
922 boost::filesystem::path p (sd);
923 p /= "ca.self-signed.pem";
924 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
928 boost::filesystem::path p (sd);
929 p /= "intermediate.signed.pem";
930 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
934 boost::filesystem::path p (sd);
935 p /= "leaf.signed.pem";
936 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
939 boost::filesystem::path signer_key (sd);
940 signer_key /= "leaf.key";
942 return shared_ptr<const dcp::Signer> (new dcp::Signer (chain, signer_key));
946 fit_ratio_within (float ratio, dcp::Size full_frame)
948 if (ratio < full_frame.ratio ()) {
949 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
952 return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
956 time_round_up (DCPTime t, DCPTime nearest)
958 DCPTime const a = t + nearest - 1;
959 return a - (a % nearest);
963 wrapped_av_malloc (size_t s)
965 void* p = av_malloc (s);