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.
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/lexical_cast.hpp>
40 #include <boost/thread.hpp>
41 #include <boost/filesystem.hpp>
44 #include <openssl/md5.h>
45 #include <magick/MagickCore.h>
46 #include <magick/version.h>
47 #include <libdcp/version.h>
48 #include <libdcp/util.h>
49 #include <libdcp/signer_chain.h>
50 #include <libdcp/signer.h>
52 #include <libavcodec/avcodec.h>
53 #include <libavformat/avformat.h>
54 #include <libswscale/swscale.h>
55 #include <libavfilter/avfiltergraph.h>
56 #include <libpostproc/postprocess.h>
57 #include <libavutil/pixfmt.h>
60 #include "exceptions.h"
62 #include "dcp_content_type.h"
64 #include "sound_processor.h"
69 #ifdef DCPOMATIC_WINDOWS
79 using std::stringstream;
93 using std::numeric_limits;
96 using boost::shared_ptr;
98 using boost::lexical_cast;
99 using boost::optional;
102 static boost::thread::id ui_thread;
103 static boost::filesystem::path backtrace_file;
105 /** Convert some number of seconds to a string representation
106 * in hours, minutes and seconds.
109 * @return String of the form H:M:S (where H is hours, M
110 * is minutes and S is seconds).
113 seconds_to_hms (int s)
123 hms << std::setfill ('0') << m << N_(":");
125 hms << std::setfill ('0') << s;
130 /** @param s Number of seconds.
131 * @return String containing an approximate description of s (e.g. "about 2 hours")
134 seconds_to_approximate_hms (int s)
145 ap << (h + 1) << N_(" ") << _("hours");
148 ap << N_("1 ") << _("hour");
150 ap << h << N_(" ") << _("hours");
155 ap << N_("1 ") << _("minute");
157 ap << m << N_(" ") << _("minutes");
160 ap << s << N_(" ") << _("seconds");
166 #ifdef DCPOMATIC_POSIX
167 /** @param l Mangled C++ identifier.
168 * @return Demangled version.
173 string::size_type const b = l.find_first_of (N_("("));
174 if (b == string::npos) {
178 string::size_type const p = l.find_last_of (N_("+"));
179 if (p == string::npos) {
187 string const fn = l.substr (b + 1, p - b - 1);
192 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
197 } catch (std::exception) {
204 /** Write a stacktrace to an ostream.
205 * @param out Stream to write to.
206 * @param levels Number of levels to go up the call stack.
209 stacktrace (ostream& out, int levels)
212 size_t size = backtrace (array, 200);
213 char** strings = backtrace_symbols (array, size);
216 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
217 out << N_(" ") << demangle (strings[i]) << "\n";
225 /** @param v Version as used by FFmpeg.
226 * @return A string representation of v.
229 ffmpeg_version_to_string (int v)
232 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
236 /** Return a user-readable string summarising the versions of our dependencies */
238 dependency_version_summary ()
241 s << N_("libopenjpeg ") << opj_version () << N_(", ")
242 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
243 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
244 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
245 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
246 << N_("libpostproc ") << ffmpeg_version_to_string (postproc_version()) << N_(", ")
247 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
248 << MagickVersion << N_(", ")
249 << N_("libssh ") << ssh_version (0) << N_(", ")
250 << N_("libdcp ") << libdcp::version << N_(" git ") << libdcp::git_commit;
256 seconds (struct timeval t)
258 return t.tv_sec + (double (t.tv_usec) / 1e6);
261 #ifdef DCPOMATIC_WINDOWS
262 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
265 ofstream f (backtrace_file.string().c_str());
266 std::copy(s.begin(), s.end(), std::ostream_iterator<dbg::stack_frame>(f, "\n"));
267 return EXCEPTION_CONTINUE_SEARCH;
271 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
272 * Must be called from the UI thread, if there is one.
277 #ifdef DCPOMATIC_WINDOWS
278 backtrace_file /= g_get_user_config_dir ();
279 backtrace_file /= "backtrace.txt";
280 SetUnhandledExceptionFilter(exception_handler);
283 avfilter_register_all ();
286 /* Add our lib directory to the libltdl search path so that
287 xmlsec can find xmlsec1-openssl.
289 boost::filesystem::path lib = app_contents ();
291 lt_dladdsearchdir (lib.c_str ());
296 Ratio::setup_ratios ();
297 DCPContentType::setup_dcp_content_types ();
298 Scaler::setup_scalers ();
299 Filter::setup_filters ();
300 SoundProcessor::setup_sound_processors ();
302 ui_thread = boost::this_thread::get_id ();
305 #ifdef DCPOMATIC_WINDOWS
306 boost::filesystem::path
310 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
311 boost::filesystem::path p (buffer);
312 p = p.parent_path ();
313 p = p.parent_path ();
320 dcpomatic_setup_gettext_i18n (string lang)
322 #ifdef DCPOMATIC_POSIX
326 if (!lang.empty ()) {
327 /* Override our environment language; this is essential on
331 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
333 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
337 setlocale (LC_ALL, "");
338 textdomain ("libdcpomatic");
340 #ifdef DCPOMATIC_WINDOWS
341 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
342 bind_textdomain_codeset ("libdcpomatic", "UTF8");
345 #ifdef DCPOMATIC_POSIX
346 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
350 /** @param s A string.
351 * @return Parts of the string split at spaces, except when a space is within quotation marks.
354 split_at_spaces_considering_quotes (string s)
357 bool in_quotes = false;
359 for (string::size_type i = 0; i < s.length(); ++i) {
360 if (s[i] == ' ' && !in_quotes) {
363 } else if (s[i] == '"') {
364 in_quotes = !in_quotes;
375 md5_digest (void const * data, int size)
378 MD5_Init (&md5_context);
379 MD5_Update (&md5_context, data, size);
380 unsigned char digest[MD5_DIGEST_LENGTH];
381 MD5_Final (digest, &md5_context);
384 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
385 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
391 /** @param file File name.
392 * @return MD5 digest of file's contents.
395 md5_digest (boost::filesystem::path file)
397 ifstream f (file.string().c_str(), std::ios::binary);
399 throw OpenFileError (file.string());
402 f.seekg (0, std::ios::end);
403 int bytes = f.tellg ();
404 f.seekg (0, std::ios::beg);
406 int const buffer_size = 64 * 1024;
407 char buffer[buffer_size];
410 MD5_Init (&md5_context);
412 int const t = min (bytes, buffer_size);
414 MD5_Update (&md5_context, buffer, t);
418 unsigned char digest[MD5_DIGEST_LENGTH];
419 MD5_Final (digest, &md5_context);
422 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
423 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
429 /** @param job Optional job for which to report progress */
431 md5_digest_directory (boost::filesystem::path directory, shared_ptr<Job> job)
433 int const buffer_size = 64 * 1024;
434 char buffer[buffer_size];
437 MD5_Init (&md5_context);
441 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
447 for (boost::filesystem::directory_iterator i(directory); i != boost::filesystem::directory_iterator(); ++i) {
448 ifstream f (i->path().string().c_str(), std::ios::binary);
450 throw OpenFileError (i->path().string());
453 f.seekg (0, std::ios::end);
454 int bytes = f.tellg ();
455 f.seekg (0, std::ios::beg);
458 int const t = min (bytes, buffer_size);
460 MD5_Update (&md5_context, buffer, t);
465 job->set_progress (float (j) / files);
470 unsigned char digest[MD5_DIGEST_LENGTH];
471 MD5_Final (digest, &md5_context);
474 for (int i = 0; i < MD5_DIGEST_LENGTH; ++i) {
475 s << std::hex << std::setfill('0') << std::setw(2) << ((int) digest[i]);
482 about_equal (float a, float b)
484 /* A film of F seconds at f FPS will be Ff frames;
485 Consider some delta FPS d, so if we run the same
486 film at (f + d) FPS it will last F(f + d) seconds.
488 Hence the difference in length over the length of the film will
489 be F(f + d) - Ff frames
490 = Ff + Fd - Ff frames
494 So if we accept a difference of 1 frame, ie 1/f seconds, we can
501 So for a 3hr film, ie F = 3 * 60 * 60 = 10800, the acceptable
502 FPS error is 1/F ~= 0.0001 ~= 10-e4
505 return (fabs (a - b) < 1e-4);
508 /** @param An arbitrary audio frame rate.
509 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
512 dcp_audio_frame_rate (int fs)
521 Socket::Socket (int timeout)
522 : _deadline (_io_service)
523 , _socket (_io_service)
526 _deadline.expires_at (boost::posix_time::pos_infin);
533 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
535 _deadline.expires_at (boost::posix_time::pos_infin);
538 _deadline.async_wait (boost::bind (&Socket::check, this));
541 /** Blocking connect.
542 * @param endpoint End-point to connect to.
545 Socket::connect (boost::asio::ip::basic_resolver_entry<boost::asio::ip::tcp> const & endpoint)
547 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
548 boost::system::error_code ec = boost::asio::error::would_block;
549 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
551 _io_service.run_one();
552 } while (ec == boost::asio::error::would_block);
554 if (ec || !_socket.is_open ()) {
555 throw NetworkError (_("connect timed out"));
560 * @param data Buffer to write.
561 * @param size Number of bytes to write.
564 Socket::write (uint8_t const * data, int size)
566 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
567 boost::system::error_code ec = boost::asio::error::would_block;
569 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
572 _io_service.run_one ();
573 } while (ec == boost::asio::error::would_block);
576 throw NetworkError (ec.message ());
581 Socket::write (uint32_t v)
584 write (reinterpret_cast<uint8_t*> (&v), 4);
588 * @param data Buffer to read to.
589 * @param size Number of bytes to read.
592 Socket::read (uint8_t* data, int size)
594 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
595 boost::system::error_code ec = boost::asio::error::would_block;
597 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
600 _io_service.run_one ();
601 } while (ec == boost::asio::error::would_block);
604 throw NetworkError (ec.message ());
609 Socket::read_uint32 ()
612 read (reinterpret_cast<uint8_t *> (&v), 4);
616 /** Round a number up to the nearest multiple of another number.
618 * @param s Array of numbers to round, indexed by c.
619 * @param t Multiple to round to.
620 * @return Rounded number.
623 stride_round_up (int c, int const * stride, int t)
625 int const a = stride[c] + (t - 1);
629 /** Read a sequence of key / value pairs from a text stream;
630 * the keys are the first words on the line, and the values are
631 * the remainder of the line following the key. Lines beginning
632 * with # are ignored.
633 * @param s Stream to read.
634 * @return key/value pairs.
636 multimap<string, string>
637 read_key_value (istream &s)
639 multimap<string, string> kv;
642 while (getline (s, line)) {
647 if (line[0] == '#') {
651 if (line[line.size() - 1] == '\r') {
652 line = line.substr (0, line.size() - 1);
655 size_t const s = line.find (' ');
656 if (s == string::npos) {
660 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
667 get_required_string (multimap<string, string> const & kv, string k)
669 if (kv.count (k) > 1) {
670 throw StringError (N_("unexpected multiple keys in key-value set"));
673 multimap<string, string>::const_iterator i = kv.find (k);
675 if (i == kv.end ()) {
676 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
683 get_required_int (multimap<string, string> const & kv, string k)
685 string const v = get_required_string (kv, k);
686 return lexical_cast<int> (v);
690 get_required_float (multimap<string, string> const & kv, string k)
692 string const v = get_required_string (kv, k);
693 return lexical_cast<float> (v);
697 get_optional_string (multimap<string, string> const & kv, string k)
699 if (kv.count (k) > 1) {
700 throw StringError (N_("unexpected multiple keys in key-value set"));
703 multimap<string, string>::const_iterator i = kv.find (k);
704 if (i == kv.end ()) {
712 get_optional_int (multimap<string, string> const & kv, string k)
714 if (kv.count (k) > 1) {
715 throw StringError (N_("unexpected multiple keys in key-value set"));
718 multimap<string, string>::const_iterator i = kv.find (k);
719 if (i == kv.end ()) {
723 return lexical_cast<int> (i->second);
726 /** Trip an assert if the caller is not in the UI thread */
730 assert (boost::this_thread::get_id() == ui_thread);
733 /** @param v Content video frame.
734 * @param audio_sample_rate Source audio sample rate.
735 * @param frames_per_second Number of video frames per second.
736 * @return Equivalent number of audio frames for `v'.
739 video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second)
741 return ((int64_t) v * audio_sample_rate / frames_per_second);
745 audio_channel_name (int c)
747 assert (MAX_AUDIO_CHANNELS == 6);
749 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
750 enhancement channel (sub-woofer)./
752 string const channels[] = {
764 FrameRateConversion::FrameRateConversion (float source, int dcp)
767 , change_speed (false)
769 if (fabs (source / 2.0 - dcp) < (fabs (source - dcp))) {
771 } else if (fabs (source * 2 - dcp) < fabs (source - dcp)) {
775 change_speed = !about_equal (source * factor(), dcp);
777 if (!skip && !repeat && !change_speed) {
778 description = _("Content and DCP have the same rate.\n");
781 description = _("DCP will use every other frame of the content.\n");
783 description = _("Each content frame will be doubled in the DCP.\n");
787 float const pc = dcp * 100 / (source * factor());
788 description += String::compose (_("DCP will run at %1%% of the content speed.\n"), pc);
793 LocaleGuard::LocaleGuard ()
796 char const * old = setlocale (LC_NUMERIC, 0);
800 if (strcmp (_old, "C")) {
801 setlocale (LC_NUMERIC, "C");
806 LocaleGuard::~LocaleGuard ()
808 setlocale (LC_NUMERIC, _old);
813 valid_image_file (boost::filesystem::path f)
815 string ext = f.extension().string();
816 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
817 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga");
821 tidy_for_filename (string f)
824 for (size_t i = 0; i < f.length(); ++i) {
825 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
835 shared_ptr<const libdcp::Signer>
838 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
840 /* Remake the chain if any of it is missing */
842 list<boost::filesystem::path> files;
843 files.push_back ("ca.self-signed.pem");
844 files.push_back ("intermediate.signed.pem");
845 files.push_back ("leaf.signed.pem");
846 files.push_back ("leaf.key");
848 list<boost::filesystem::path>::const_iterator i = files.begin();
849 while (i != files.end()) {
850 boost::filesystem::path p (sd);
852 if (!boost::filesystem::exists (p)) {
853 boost::filesystem::remove_all (sd);
854 boost::filesystem::create_directories (sd);
855 libdcp::make_signer_chain (sd, openssl_path ());
862 libdcp::CertificateChain chain;
865 boost::filesystem::path p (sd);
866 p /= "ca.self-signed.pem";
867 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
871 boost::filesystem::path p (sd);
872 p /= "intermediate.signed.pem";
873 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
877 boost::filesystem::path p (sd);
878 p /= "leaf.signed.pem";
879 chain.add (shared_ptr<libdcp::Certificate> (new libdcp::Certificate (p)));
882 boost::filesystem::path signer_key (sd);
883 signer_key /= "leaf.key";
885 return shared_ptr<const libdcp::Signer> (new libdcp::Signer (chain, signer_key));