2 Copyright (C) 2012-2016 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic is free software; you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation; either version 2 of the License, or
9 (at your option) any later version.
11 DCP-o-matic is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/lib/util.cc
22 * @brief Some utility functions and classes.
26 #include "exceptions.h"
27 #include "dcp_content_type.h"
29 #include "cinema_sound_processor.h"
34 #include "video_content.h"
37 #include "audio_processor.h"
39 #include "compose.hpp"
40 #include "audio_buffers.h"
41 #include "string_text.h"
43 #include "render_text.h"
44 #include <dcp/locale_convert.h>
46 #include <dcp/raw_convert.h>
47 #include <dcp/picture_asset.h>
48 #include <dcp/sound_asset.h>
49 #include <dcp/subtitle_asset.h>
51 #include <libavfilter/avfilter.h>
52 #include <libavformat/avformat.h>
53 #include <libavcodec/avcodec.h>
55 #include <curl/curl.h>
57 #include <pangomm/init.h>
58 #include <boost/algorithm/string.hpp>
59 #include <boost/range/algorithm/replace_if.hpp>
60 #include <boost/thread.hpp>
61 #include <boost/filesystem.hpp>
62 #ifdef DCPOMATIC_WINDOWS
63 #include <boost/locale.hpp>
72 #ifdef DCPOMATIC_POSIX
93 using std::set_terminate;
95 using boost::shared_ptr;
97 using boost::optional;
98 using boost::lexical_cast;
99 using boost::bad_lexical_cast;
100 using boost::scoped_array;
102 using dcp::raw_convert;
103 using dcp::locale_convert;
105 /** Path to our executable, required by the stacktrace stuff and filled
106 * in during App::onInit().
109 bool is_batch_converter = false;
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)
129 snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
134 time_to_hmsf (DCPTime time, Frame rate)
136 Frame f = time.frames_round (rate);
145 snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
149 /** @param s Number of seconds.
150 * @return String containing an approximate description of s (e.g. "about 2 hours")
153 seconds_to_approximate_hms (int s)
163 bool minutes = h < 6 && m > 0;
164 bool seconds = h == 0 && m < 10 && s > 0;
166 if (m > 30 && !minutes) {
167 /* round up the hours */
170 if (s > 30 && !seconds) {
171 /* round up the minutes */
181 /// TRANSLATORS: h here is an abbreviation for hours
182 ap += locale_convert<string>(h) + _("h");
184 if (minutes || seconds) {
190 /// TRANSLATORS: m here is an abbreviation for minutes
191 ap += locale_convert<string>(m) + _("m");
200 /// TRANSLATORS: s here is an abbreviation for seconds
201 ap += locale_convert<string>(s) + _("s");
208 seconds (struct timeval t)
210 return t.tv_sec + (double (t.tv_usec) / 1e6);
213 #ifdef DCPOMATIC_WINDOWS
215 /** Resolve symbol name and source location given the path to the executable */
217 addr2line (void const * const addr)
219 char addr2line_cmd[512] = { 0 };
220 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
221 return system(addr2line_cmd);
224 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
225 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
226 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
229 exception_handler(struct _EXCEPTION_POINTERS * info)
231 FILE* f = fopen_boost (backtrace_file, "w");
232 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
235 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
236 CONTEXT* context = info->ContextRecord;
237 SymInitialize (GetCurrentProcess (), 0, true);
239 STACKFRAME frame = { 0 };
241 /* setup initial stack frame */
243 frame.AddrPC.Offset = context->Rip;
244 frame.AddrStack.Offset = context->Rsp;
245 frame.AddrFrame.Offset = context->Rbp;
247 frame.AddrPC.Offset = context->Eip;
248 frame.AddrStack.Offset = context->Esp;
249 frame.AddrFrame.Offset = context->Ebp;
251 frame.AddrPC.Mode = AddrModeFlat;
252 frame.AddrStack.Mode = AddrModeFlat;
253 frame.AddrFrame.Mode = AddrModeFlat;
257 IMAGE_FILE_MACHINE_I386,
258 GetCurrentProcess (),
263 SymFunctionTableAccess,
268 addr2line((void *) frame.AddrPC.Offset);
272 addr2line ((void *) info->ContextRecord->Rip);
274 addr2line ((void *) info->ContextRecord->Eip);
278 return EXCEPTION_CONTINUE_SEARCH;
283 set_backtrace_file (boost::filesystem::path p)
288 /** This is called when there is an unhandled exception. Any
289 * backtrace in this function is useless on Windows as the stack has
290 * already been unwound from the throw; we have the gdb wrap hack to
297 static bool tried_throw = false;
298 // try once to re-throw currently active exception
304 catch (const std::exception &e) {
305 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
306 << e.what() << std::endl;
309 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
317 dcpomatic_setup_path_encoding ()
319 #ifdef DCPOMATIC_WINDOWS
320 /* Dark voodoo which, I think, gets boost::filesystem::path to
321 correctly convert UTF-8 strings to paths, and also paths
322 back to UTF-8 strings (on path::string()).
324 After this, constructing boost::filesystem::paths from strings
325 converts from UTF-8 to UTF-16 inside the path. Then
326 path::string().c_str() gives UTF-8 and
327 path::c_str() gives UTF-16.
329 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
330 so things are much simpler.
332 std::locale::global (boost::locale::generator().generate (""));
333 boost::filesystem::path::imbue (std::locale ());
337 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
338 * Must be called from the UI thread, if there is one.
343 #ifdef DCPOMATIC_WINDOWS
344 boost::filesystem::path p = g_get_user_config_dir ();
345 p /= "backtrace.txt";
346 set_backtrace_file (p);
347 SetUnhandledExceptionFilter(exception_handler);
351 avfilter_register_all ();
354 /* Add our library directory to the libltdl search path so that
355 xmlsec can find xmlsec1-openssl.
357 boost::filesystem::path lib = app_contents ();
359 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
362 set_terminate (terminate);
364 #ifdef DCPOMATIC_WINDOWS
365 putenv ("PANGOCAIRO_BACKEND=fontconfig");
366 putenv (String::compose("FONTCONFIG_PATH=%1", shared_path().string()).c_str());
372 #ifdef DCPOMATIC_WINDOWS
373 /* Render something to fontconfig to create its cache */
374 list<StringText> subs;
375 dcp::SubtitleString ss(
376 optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HALIGN_CENTER, 0, dcp::VALIGN_CENTER, dcp::DIRECTION_LTR,
377 "Hello dolly", dcp::NONE, dcp::Colour(), dcp::Time(), dcp::Time()
379 subs.push_back (StringText(ss, 0));
380 render_text (subs, list<shared_ptr<Font> >(), dcp::Size(640, 480), DCPTime(), 24);
383 Ratio::setup_ratios ();
384 PresetColourConversion::setup_colour_conversion_presets ();
385 VideoContentScale::setup_scales ();
386 DCPContentType::setup_dcp_content_types ();
387 Filter::setup_filters ();
388 CinemaSoundProcessor::setup_cinema_sound_processors ();
389 AudioProcessor::setup_audio_processors ();
391 curl_global_init (CURL_GLOBAL_ALL);
393 ui_thread = boost::this_thread::get_id ();
396 #ifdef DCPOMATIC_WINDOWS
397 boost::filesystem::path
401 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
402 boost::filesystem::path p (buffer);
403 p = p.parent_path ();
404 p = p.parent_path ();
411 boost::filesystem::path
414 return "DCP-o-matic 2.app/Contents/Resources";
419 dcpomatic_setup_gettext_i18n (string lang)
421 #ifdef DCPOMATIC_LINUX
425 if (!lang.empty ()) {
426 /* Override our environment language. Note that the caller must not
427 free the string passed into putenv().
429 string s = String::compose ("LANGUAGE=%1", lang);
430 putenv (strdup (s.c_str ()));
431 s = String::compose ("LANG=%1", lang);
432 putenv (strdup (s.c_str ()));
433 s = String::compose ("LC_ALL=%1", lang);
434 putenv (strdup (s.c_str ()));
437 setlocale (LC_ALL, "");
438 textdomain ("libdcpomatic2");
440 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
441 bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
442 bind_textdomain_codeset ("libdcpomatic2", "UTF8");
445 #ifdef DCPOMATIC_LINUX
446 bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
450 /** Compute a digest of the first and last `size' bytes of a set of files. */
452 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
454 boost::scoped_array<char> buffer (new char[size]);
458 boost::uintmax_t to_do = size;
459 char* p = buffer.get ();
461 while (i < int64_t (files.size()) && to_do > 0) {
462 FILE* f = fopen_boost (files[i], "rb");
464 throw OpenFileError (files[i].string(), errno, true);
467 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
468 checked_fread (p, this_time, f, files[i]);
475 digester.add (buffer.get(), size - to_do);
480 i = files.size() - 1;
481 while (i >= 0 && to_do > 0) {
482 FILE* f = fopen_boost (files[i], "rb");
484 throw OpenFileError (files[i].string(), errno, true);
487 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
488 dcpomatic_fseek (f, -this_time, SEEK_END);
489 checked_fread (p, this_time, f, files[i]);
496 digester.add (buffer.get(), size - to_do);
498 return digester.get ();
501 /** Round a number up to the nearest multiple of another number.
503 * @param stride Array of numbers to round, indexed by c.
504 * @param t Multiple to round to.
505 * @return Rounded number.
508 stride_round_up (int c, int const * stride, int t)
510 int const a = stride[c] + (t - 1);
514 /** Trip an assert if the caller is not in the UI thread */
518 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
522 audio_channel_name (int c)
524 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
526 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
527 /// enhancement channel (sub-woofer).
528 string const channels[] = {
535 _("Hearing impaired"),
536 _("Visually impaired"),
539 _("Left rear surround"),
540 _("Right rear surround"),
542 _("D-BOX secondary"),
551 short_audio_channel_name (int c)
553 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
555 /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
556 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
557 /// VI is the visually-impaired audio track (audio describe). DBP is the D-BOX
558 /// primary channel and DBS is the D-BOX secondary channel.
559 string const channels[] = {
583 valid_image_file (boost::filesystem::path f)
585 if (boost::starts_with (f.leaf().string(), "._")) {
589 string ext = f.extension().string();
590 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
592 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
593 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
594 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
600 valid_sound_file (boost::filesystem::path f)
602 if (boost::starts_with (f.leaf().string(), "._")) {
606 string ext = f.extension().string();
607 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
608 return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
612 valid_j2k_file (boost::filesystem::path f)
614 string ext = f.extension().string();
615 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
616 return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
620 tidy_for_filename (string f)
622 boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
627 fit_ratio_within (float ratio, dcp::Size full_frame)
629 if (ratio < full_frame.ratio ()) {
630 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
633 return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
637 wrapped_av_malloc (size_t s)
639 void* p = av_malloc (s);
647 split_get_request (string url)
650 AWAITING_QUESTION_MARK,
653 } state = AWAITING_QUESTION_MARK;
655 map<string, string> r;
658 for (size_t i = 0; i < url.length(); ++i) {
660 case AWAITING_QUESTION_MARK:
675 r.insert (make_pair (k, v));
685 if (state == VALUE) {
686 r.insert (make_pair (k, v));
693 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
695 dcp::NameFormat::Map values;
697 values['r'] = raw_convert<string> (reel_index + 1);
698 values['n'] = raw_convert<string> (reel_count);
700 values['c'] = careful_string_filter (summary.get());
702 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
706 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
708 dcp::NameFormat::Map values;
710 values['r'] = raw_convert<string> (reel_index + 1);
711 values['n'] = raw_convert<string> (reel_count);
713 values['c'] = careful_string_filter (summary.get());
715 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
719 relaxed_string_to_float (string s)
722 boost::algorithm::replace_all (s, ",", ".");
723 return lexical_cast<float> (s);
724 } catch (bad_lexical_cast) {
725 boost::algorithm::replace_all (s, ".", ",");
726 return lexical_cast<float> (s);
731 careful_string_filter (string s)
733 /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
734 There's no apparent list of what really is allowed, so this is a guess.
735 Safety first and all that.
739 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
740 for (size_t i = 0; i < s.size(); ++i) {
741 if (allowed.find (s[i]) != string::npos) {
749 /** @param mapped List of mapped audio channels from a Film.
750 * @param channels Total number of channels in the Film.
751 * @return First: number of non-LFE channels, second: number of LFE channels.
754 audio_channel_types (list<int> mapped, int channels)
759 BOOST_FOREACH (int i, mapped) {
761 /* This channel is mapped but is not included in the DCP */
765 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
772 return make_pair (non_lfe, lfe);
775 shared_ptr<AudioBuffers>
776 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
778 shared_ptr<AudioBuffers> mapped (new AudioBuffers (output_channels, input->frames()));
779 mapped->make_silent ();
781 for (int i = 0; i < map.input_channels(); ++i) {
782 for (int j = 0; j < mapped->channels(); ++j) {
783 if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
784 mapped->accumulate_channel (
787 static_cast<dcp::Channel> (j),
788 map.get (i, static_cast<dcp::Channel> (j))
798 increment_eyes (Eyes e)
800 if (e == EYES_LEFT) {
808 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
810 size_t N = fwrite (ptr, 1, size, stream);
812 if (ferror(stream)) {
814 throw FileError (String::compose("fwrite error %1", errno), path);
817 throw FileError ("Unexpected short write", path);
823 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
825 size_t N = fread (ptr, 1, size, stream);
827 if (ferror(stream)) {
829 throw FileError (String::compose("fread error %1", errno), path);
832 throw FileError ("Unexpected short read", path);
838 utf8_strlen (string s)
840 size_t const len = s.length ();
842 for (size_t i = 0; i < len; ++i) {
843 unsigned char c = s[i];
844 if ((c & 0xe0) == 0xc0) {
846 } else if ((c & 0xf0) == 0xe0) {
848 } else if ((c & 0xf8) == 0xf0) {
857 day_of_week_to_string (boost::gregorian::greg_weekday d)
859 switch (d.as_enum()) {
860 case boost::date_time::Sunday:
862 case boost::date_time::Monday:
864 case boost::date_time::Tuesday:
866 case boost::date_time::Wednesday:
867 return _("Wednesday");
868 case boost::date_time::Thursday:
869 return _("Thursday");
870 case boost::date_time::Friday:
872 case boost::date_time::Saturday:
873 return _("Saturday");
876 return d.as_long_string ();
879 #ifdef DCPOMATIC_VARIANT_SWAROOP
881 /* Make up a key from the machine UUID */
885 dcp::Data key (dcpomatic::crypto_key_length());
886 memset (key.data().get(), 0, key.size());
887 string const magic = command_and_read ("dcpomatic2_uuid");
888 strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length());
892 /* swaroop chain file format:
894 * 0 [int16_t] IV length
895 * 2 [int16_t] cert #1 length, or 0 for none
896 * 4 [int16_t] cert #2 length, or 0 for none
897 * 6 [int16_t] cert #3 length, or 0 for none
898 * 8 [int16_t] cert #4 length, or 0 for none
899 * 10 [int16_t] cert #5 length, or 0 for none
900 * 12 [int16_t] cert #6 length, or 0 for none
901 * 14 [int16_t] cert #7 length, or 0 for none
902 * 16 [int16_t] cert #8 length, or 0 for none
903 * 16 [int16_t] private key length
916 struct __attribute__ ((packed)) Header_ {
918 int16_t cert_length[8];
919 int16_t private_key_length;
922 typedef struct Header_ Header;
924 shared_ptr<dcp::CertificateChain>
925 read_swaroop_chain (boost::filesystem::path path)
927 dcp::Data data (path);
928 Header* header = (Header *) data.data().get();
929 uint8_t* p = data.data().get() + sizeof(Header);
931 dcp::Data iv (p, header->iv_length);
934 shared_ptr<dcp::CertificateChain> cc (new dcp::CertificateChain());
935 for (int i = 0; i < 8; ++i) {
936 if (header->cert_length[i] == 0) {
939 dcp::Data c(p, header->cert_length[i]);
941 cc->add (dcp::Certificate(dcpomatic::decrypt(c, key_from_uuid(), iv)));
944 dcp::Data k (p, header->private_key_length);
945 cc->set_key (dcpomatic::decrypt(k, key_from_uuid(), iv));
950 write_swaroop_chain (shared_ptr<const dcp::CertificateChain> chain, boost::filesystem::path output)
952 scoped_array<uint8_t> buffer (new uint8_t[65536]);
953 Header* header = (Header *) buffer.get();
954 memset (header, 0, sizeof(Header));
955 uint8_t* p = buffer.get() + sizeof(Header);
957 dcp::Data iv = dcpomatic::random_iv ();
958 header->iv_length = iv.size ();
959 memcpy (p, iv.data().get(), iv.size());
963 BOOST_FOREACH (dcp::Certificate i, chain->root_to_leaf()) {
964 dcp::Data e = dcpomatic::encrypt (i.certificate(true), key_from_uuid(), iv);
965 memcpy (p, e.data().get(), e.size());
967 DCPOMATIC_ASSERT (N < 8);
968 header->cert_length[N] = e.size ();
972 dcp::Data k = dcpomatic::encrypt (chain->key().get(), key_from_uuid(), iv);
973 memcpy (p, k.data().get(), k.size());
975 header->private_key_length = k.size ();
977 FILE* f = fopen_boost (output, "wb");
978 checked_fwrite (buffer.get(), p - buffer.get(), f, output);