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.
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/thread.hpp>
41 #include <boost/filesystem.hpp>
42 #ifdef DCPOMATIC_WINDOWS
43 #include <boost/locale.hpp>
47 #include <pangomm/init.h>
48 #include <magick/MagickCore.h>
49 #include <magick/version.h>
50 #include <dcp/version.h>
52 #include <dcp/signer_chain.h>
53 #include <dcp/signer.h>
54 #include <dcp/raw_convert.h>
56 #include <libavcodec/avcodec.h>
57 #include <libavformat/avformat.h>
58 #include <libswscale/swscale.h>
59 #include <libavfilter/avfiltergraph.h>
60 #include <libavutil/pixfmt.h>
63 #include "exceptions.h"
65 #include "dcp_content_type.h"
67 #include "cinema_sound_processor.h"
72 #include "video_content.h"
74 #include "md5_digester.h"
75 #include "audio_processor.h"
76 #ifdef DCPOMATIC_WINDOWS
83 using std::stringstream;
97 using std::numeric_limits;
100 using std::bad_alloc;
101 using std::streampos;
102 using std::set_terminate;
103 using boost::shared_ptr;
105 using boost::optional;
107 using dcp::raw_convert;
109 static boost::thread::id ui_thread;
110 static boost::filesystem::path backtrace_file;
112 /** Convert some number of seconds to a string representation
113 * in hours, minutes and seconds.
116 * @return String of the form H:M:S (where H is hours, M
117 * is minutes and S is seconds).
120 seconds_to_hms (int s)
130 hms << std::setfill ('0') << m << N_(":");
132 hms << std::setfill ('0') << s;
137 /** @param s Number of seconds.
138 * @return String containing an approximate description of s (e.g. "about 2 hours")
141 seconds_to_approximate_hms (int s)
150 bool const hours = h > 0;
151 bool const minutes = h < 10 && m > 0;
152 bool const seconds = m < 10 && s > 0;
155 if (m > 30 && !minutes) {
156 ap << (h + 1) << N_(" ") << _("hours");
166 if (minutes | seconds) {
173 if (s > 30 && !seconds) {
174 ap << (m + 1) << N_(" ") << _("minutes");
202 #ifdef DCPOMATIC_POSIX
203 /** @param l Mangled C++ identifier.
204 * @return Demangled version.
209 string::size_type const b = l.find_first_of (N_("("));
210 if (b == string::npos) {
214 string::size_type const p = l.find_last_of (N_("+"));
215 if (p == string::npos) {
223 string const fn = l.substr (b + 1, p - b - 1);
228 char* realname = abi::__cxa_demangle (fn.c_str(), 0, 0, &status);
233 } catch (std::exception) {
240 /** Write a stacktrace to an ostream.
241 * @param out Stream to write to.
242 * @param levels Number of levels to go up the call stack.
245 stacktrace (ostream& out, int levels)
248 size_t size = backtrace (array, 200);
249 char** strings = backtrace_symbols (array, size);
252 for (size_t i = 0; i < size && (levels == 0 || i < size_t(levels)); i++) {
253 out << N_(" ") << demangle (strings[i]) << "\n";
261 /** @param v Version as used by FFmpeg.
262 * @return A string representation of v.
265 ffmpeg_version_to_string (int v)
268 s << ((v & 0xff0000) >> 16) << N_(".") << ((v & 0xff00) >> 8) << N_(".") << (v & 0xff);
273 seconds (struct timeval t)
275 return t.tv_sec + (double (t.tv_usec) / 1e6);
278 #ifdef DCPOMATIC_WINDOWS
279 LONG WINAPI exception_handler(struct _EXCEPTION_POINTERS *)
282 FILE* f = fopen_boost (backtrace_file, "w");
283 fprintf (f, "Exception thrown:");
284 for (dbg::stack::const_iterator i = s.begin(); i != s.end(); ++i) {
285 fprintf (f, "%p %s %d %s\n", i->instruction, i->function.c_str(), i->line, i->module.c_str());
288 return EXCEPTION_CONTINUE_SEARCH;
292 /* From http://stackoverflow.com/questions/2443135/how-do-i-find-where-an-exception-was-thrown-in-c */
296 static bool tried_throw = false;
299 // try once to re-throw currently active exception
305 catch (const std::exception &e) {
306 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
307 << e.what() << std::endl;
310 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
314 #ifdef DCPOMATIC_POSIX
315 stacktrace (cout, 50);
320 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
321 * Must be called from the UI thread, if there is one.
326 #ifdef DCPOMATIC_WINDOWS
327 backtrace_file /= g_get_user_config_dir ();
328 backtrace_file /= "backtrace.txt";
329 SetUnhandledExceptionFilter(exception_handler);
331 /* Dark voodoo which, I think, gets boost::filesystem::path to
332 correctly convert UTF-8 strings to paths, and also paths
333 back to UTF-8 strings (on path::string()).
335 After this, constructing boost::filesystem::paths from strings
336 converts from UTF-8 to UTF-16 inside the path. Then
337 path::string().c_str() gives UTF-8 and
338 path::c_str() gives UTF-16.
340 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
341 so things are much simpler.
343 std::locale::global (boost::locale::generator().generate (""));
344 boost::filesystem::path::imbue (std::locale ());
347 avfilter_register_all ();
350 /* Add our lib directory to the libltdl search path so that
351 xmlsec can find xmlsec1-openssl.
353 boost::filesystem::path lib = app_contents ();
355 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
358 set_terminate (terminate);
363 Ratio::setup_ratios ();
364 VideoContentScale::setup_scales ();
365 DCPContentType::setup_dcp_content_types ();
366 Scaler::setup_scalers ();
367 Filter::setup_filters ();
368 CinemaSoundProcessor::setup_cinema_sound_processors ();
369 AudioProcessor::setup_audio_processors ();
371 ui_thread = boost::this_thread::get_id ();
374 #ifdef DCPOMATIC_WINDOWS
375 boost::filesystem::path
379 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
380 boost::filesystem::path p (buffer);
381 p = p.parent_path ();
382 p = p.parent_path ();
389 dcpomatic_setup_gettext_i18n (string lang)
391 #ifdef DCPOMATIC_POSIX
395 if (!lang.empty ()) {
396 /* Override our environment language; this is essential on
400 snprintf (cmd, sizeof(cmd), "LANGUAGE=%s", lang.c_str ());
402 snprintf (cmd, sizeof(cmd), "LANG=%s", lang.c_str ());
404 snprintf (cmd, sizeof(cmd), "LC_ALL=%s", lang.c_str ());
408 setlocale (LC_ALL, "");
409 textdomain ("libdcpomatic");
411 #ifdef DCPOMATIC_WINDOWS
412 bindtextdomain ("libdcpomatic", mo_path().string().c_str());
413 bind_textdomain_codeset ("libdcpomatic", "UTF8");
416 #ifdef DCPOMATIC_POSIX
417 bindtextdomain ("libdcpomatic", POSIX_LOCALE_PREFIX);
421 /** @param s A string.
422 * @return Parts of the string split at spaces, except when a space is within quotation marks.
425 split_at_spaces_considering_quotes (string s)
428 bool in_quotes = false;
430 for (string::size_type i = 0; i < s.length(); ++i) {
431 if (s[i] == ' ' && !in_quotes) {
434 } else if (s[i] == '"') {
435 in_quotes = !in_quotes;
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];
452 MD5Digester digester;
454 vector<int64_t> sizes;
455 for (size_t i = 0; i < files.size(); ++i) {
456 sizes.push_back (boost::filesystem::file_size (files[i]));
459 for (size_t i = 0; i < files.size(); ++i) {
460 FILE* f = fopen_boost (files[i], "rb");
462 throw OpenFileError (files[i].string());
465 boost::uintmax_t const bytes = boost::filesystem::file_size (files[i]);
466 boost::uintmax_t remaining = bytes;
468 while (remaining > 0) {
469 int const t = min (remaining, buffer_size);
470 fread (buffer, 1, t, f);
471 digester.add (buffer, t);
475 job->set_progress ((float (i) + 1 - float(remaining) / bytes) / files.size ());
482 return digester.get ();
485 /** @param An arbitrary audio frame rate.
486 * @return The appropriate DCP-approved frame rate (48kHz or 96kHz).
489 dcp_audio_frame_rate (int fs)
498 Socket::Socket (int timeout)
499 : _deadline (_io_service)
500 , _socket (_io_service)
504 _deadline.expires_at (boost::posix_time::pos_infin);
516 if (_deadline.expires_at() <= boost::asio::deadline_timer::traits_type::now ()) {
518 _acceptor->cancel ();
522 _deadline.expires_at (boost::posix_time::pos_infin);
525 _deadline.async_wait (boost::bind (&Socket::check, this));
528 /** Blocking connect.
529 * @param endpoint End-point to connect to.
532 Socket::connect (boost::asio::ip::tcp::endpoint endpoint)
534 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
535 boost::system::error_code ec = boost::asio::error::would_block;
536 _socket.async_connect (endpoint, boost::lambda::var(ec) = boost::lambda::_1);
538 _io_service.run_one();
539 } while (ec == boost::asio::error::would_block);
542 throw NetworkError (String::compose (_("error during async_connect (%1)"), ec.value ()));
545 if (!_socket.is_open ()) {
546 throw NetworkError (_("connect timed out"));
551 Socket::accept (int port)
553 _acceptor = new boost::asio::ip::tcp::acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), port));
555 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
556 boost::system::error_code ec = boost::asio::error::would_block;
557 _acceptor->async_accept (_socket, boost::lambda::var(ec) = boost::lambda::_1);
559 _io_service.run_one ();
560 } while (ec == boost::asio::error::would_block );
566 throw NetworkError (String::compose (_("error during async_accept (%1)"), ec.value ()));
571 * @param data Buffer to write.
572 * @param size Number of bytes to write.
575 Socket::write (uint8_t const * data, int size)
577 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
578 boost::system::error_code ec = boost::asio::error::would_block;
580 boost::asio::async_write (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
583 _io_service.run_one ();
584 } while (ec == boost::asio::error::would_block);
587 throw NetworkError (String::compose (_("error during async_write (%1)"), ec.value ()));
592 Socket::write (uint32_t v)
595 write (reinterpret_cast<uint8_t*> (&v), 4);
599 * @param data Buffer to read to.
600 * @param size Number of bytes to read.
603 Socket::read (uint8_t* data, int size)
605 _deadline.expires_from_now (boost::posix_time::seconds (_timeout));
606 boost::system::error_code ec = boost::asio::error::would_block;
608 boost::asio::async_read (_socket, boost::asio::buffer (data, size), boost::lambda::var(ec) = boost::lambda::_1);
611 _io_service.run_one ();
612 } while (ec == boost::asio::error::would_block);
615 throw NetworkError (String::compose (_("error during async_read (%1)"), ec.value ()));
620 Socket::read_uint32 ()
623 read (reinterpret_cast<uint8_t *> (&v), 4);
627 /** Round a number up to the nearest multiple of another number.
629 * @param s Array of numbers to round, indexed by c.
630 * @param t Multiple to round to.
631 * @return Rounded number.
634 stride_round_up (int c, int const * stride, int t)
636 int const a = stride[c] + (t - 1);
640 /** Read a sequence of key / value pairs from a text stream;
641 * the keys are the first words on the line, and the values are
642 * the remainder of the line following the key. Lines beginning
643 * with # are ignored.
644 * @param s Stream to read.
645 * @return key/value pairs.
647 multimap<string, string>
648 read_key_value (istream &s)
650 multimap<string, string> kv;
653 while (getline (s, line)) {
658 if (line[0] == '#') {
662 if (line[line.size() - 1] == '\r') {
663 line = line.substr (0, line.size() - 1);
666 size_t const s = line.find (' ');
667 if (s == string::npos) {
671 kv.insert (make_pair (line.substr (0, s), line.substr (s + 1)));
678 get_required_string (multimap<string, string> const & kv, string k)
680 if (kv.count (k) > 1) {
681 throw StringError (N_("unexpected multiple keys in key-value set"));
684 multimap<string, string>::const_iterator i = kv.find (k);
686 if (i == kv.end ()) {
687 throw StringError (String::compose (_("missing key %1 in key-value set"), k));
694 get_required_int (multimap<string, string> const & kv, string k)
696 string const v = get_required_string (kv, k);
697 return raw_convert<int> (v);
701 get_required_float (multimap<string, string> const & kv, string k)
703 string const v = get_required_string (kv, k);
704 return raw_convert<float> (v);
708 get_optional_string (multimap<string, string> const & kv, string k)
710 if (kv.count (k) > 1) {
711 throw StringError (N_("unexpected multiple keys in key-value set"));
714 multimap<string, string>::const_iterator i = kv.find (k);
715 if (i == kv.end ()) {
723 get_optional_int (multimap<string, string> const & kv, string k)
725 if (kv.count (k) > 1) {
726 throw StringError (N_("unexpected multiple keys in key-value set"));
729 multimap<string, string>::const_iterator i = kv.find (k);
730 if (i == kv.end ()) {
734 return raw_convert<int> (i->second);
737 /** Trip an assert if the caller is not in the UI thread */
741 assert (boost::this_thread::get_id() == ui_thread);
745 audio_channel_name (int c)
747 assert (MAX_DCP_AUDIO_CHANNELS == 12);
749 /* TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
750 enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
751 VI is the visually-impaired audio track (audio describe).
753 string const channels[] = {
760 _("Hearing impaired"),
761 _("Visually impaired"),
764 _("Left rear surround"),
765 _("Right rear surround"),
772 valid_image_file (boost::filesystem::path f)
774 string ext = f.extension().string();
775 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
776 return (ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" || ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx");
780 tidy_for_filename (string f)
783 for (size_t i = 0; i < f.length(); ++i) {
784 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
794 shared_ptr<const dcp::Signer>
797 boost::filesystem::path const sd = Config::instance()->signer_chain_directory ();
799 /* Remake the chain if any of it is missing */
801 list<boost::filesystem::path> files;
802 files.push_back ("ca.self-signed.pem");
803 files.push_back ("intermediate.signed.pem");
804 files.push_back ("leaf.signed.pem");
805 files.push_back ("leaf.key");
807 list<boost::filesystem::path>::const_iterator i = files.begin();
808 while (i != files.end()) {
809 boost::filesystem::path p (sd);
811 if (!boost::filesystem::exists (p)) {
812 boost::filesystem::remove_all (sd);
813 boost::filesystem::create_directories (sd);
814 dcp::make_signer_chain (sd, openssl_path ());
821 dcp::CertificateChain chain;
824 boost::filesystem::path p (sd);
825 p /= "ca.self-signed.pem";
826 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
830 boost::filesystem::path p (sd);
831 p /= "intermediate.signed.pem";
832 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
836 boost::filesystem::path p (sd);
837 p /= "leaf.signed.pem";
838 chain.add (shared_ptr<dcp::Certificate> (new dcp::Certificate (p)));
841 boost::filesystem::path signer_key (sd);
842 signer_key /= "leaf.key";
844 return shared_ptr<const dcp::Signer> (new dcp::Signer (chain, signer_key));
848 split_get_request (string url)
851 AWAITING_QUESTION_MARK,
854 } state = AWAITING_QUESTION_MARK;
856 map<string, string> r;
859 for (size_t i = 0; i < url.length(); ++i) {
861 case AWAITING_QUESTION_MARK:
876 r.insert (make_pair (k, v));
886 if (state == VALUE) {
887 r.insert (make_pair (k, v));
894 fit_ratio_within (float ratio, dcp::Size full_frame)
896 if (ratio < full_frame.ratio ()) {
897 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
900 return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
904 wrapped_av_malloc (size_t s)
906 void* p = av_malloc (s);
914 entities_to_text (string e)
916 boost::algorithm::replace_all (e, "%3A", ":");
917 boost::algorithm::replace_all (e, "%2F", "/");
922 divide_with_round (int64_t a, int64_t b)
924 if (a % b >= (b / 2)) {
925 return (a + b - 1) / b;
931 /** Return a user-readable string summarising the versions of our dependencies */
933 dependency_version_summary ()
936 s << N_("libopenjpeg ") << opj_version () << N_(", ")
937 << N_("libavcodec ") << ffmpeg_version_to_string (avcodec_version()) << N_(", ")
938 << N_("libavfilter ") << ffmpeg_version_to_string (avfilter_version()) << N_(", ")
939 << N_("libavformat ") << ffmpeg_version_to_string (avformat_version()) << N_(", ")
940 << N_("libavutil ") << ffmpeg_version_to_string (avutil_version()) << N_(", ")
941 << N_("libswscale ") << ffmpeg_version_to_string (swscale_version()) << N_(", ")
942 << MagickVersion << N_(", ")
943 << N_("libssh ") << ssh_version (0) << N_(", ")
944 << N_("libdcp ") << dcp::version << N_(" git ") << dcp::git_commit;
949 /** Construct a ScopedTemporary. A temporary filename is decided but the file is not opened
950 * until ::open() is called.
952 ScopedTemporary::ScopedTemporary ()
955 _file = boost::filesystem::temp_directory_path() / boost::filesystem::unique_path ();
958 /** Close and delete the temporary file */
959 ScopedTemporary::~ScopedTemporary ()
962 boost::system::error_code ec;
963 boost::filesystem::remove (_file, ec);
966 /** @return temporary filename */
968 ScopedTemporary::c_str () const
970 return _file.string().c_str ();
973 /** Open the temporary file.
974 * @return File's FILE pointer.
977 ScopedTemporary::open (char const * params)
979 _open = fopen (c_str(), params);
983 /** Close the file */
985 ScopedTemporary::close ()
994 subtitle_period (AVSubtitle const & sub)
996 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
998 ContentTimePeriod period (
999 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
1000 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)