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 <dcp/locale_convert.h>
43 #include <dcp/raw_convert.h>
44 #include <dcp/picture_asset.h>
45 #include <dcp/sound_asset.h>
46 #include <dcp/subtitle_asset.h>
48 #include <libavfilter/avfilter.h>
49 #include <libavformat/avformat.h>
50 #include <libavcodec/avcodec.h>
52 #include <curl/curl.h>
54 #include <pangomm/init.h>
55 #include <boost/algorithm/string.hpp>
56 #include <boost/range/algorithm/replace_if.hpp>
57 #include <boost/thread.hpp>
58 #include <boost/filesystem.hpp>
59 #ifdef DCPOMATIC_WINDOWS
60 #include <boost/locale.hpp>
69 #ifdef DCPOMATIC_POSIX
90 using std::set_terminate;
92 using boost::shared_ptr;
94 using boost::optional;
95 using boost::lexical_cast;
96 using boost::bad_lexical_cast;
97 using boost::scoped_array;
99 using dcp::raw_convert;
100 using dcp::locale_convert;
102 /** Path to our executable, required by the stacktrace stuff and filled
103 * in during App::onInit().
106 bool is_batch_converter = false;
107 static boost::thread::id ui_thread;
108 static boost::filesystem::path backtrace_file;
110 /** Convert some number of seconds to a string representation
111 * in hours, minutes and seconds.
114 * @return String of the form H:M:S (where H is hours, M
115 * is minutes and S is seconds).
118 seconds_to_hms (int s)
126 snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
131 time_to_hmsf (DCPTime time, Frame rate)
133 Frame f = time.frames_round (rate);
142 snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
146 /** @param s Number of seconds.
147 * @return String containing an approximate description of s (e.g. "about 2 hours")
150 seconds_to_approximate_hms (int s)
160 bool minutes = h < 6 && m > 0;
161 bool seconds = h == 0 && m < 10 && s > 0;
163 if (m > 30 && !minutes) {
164 /* round up the hours */
167 if (s > 30 && !seconds) {
168 /* round up the minutes */
178 /// TRANSLATORS: h here is an abbreviation for hours
179 ap += locale_convert<string>(h) + _("h");
181 if (minutes || seconds) {
187 /// TRANSLATORS: m here is an abbreviation for minutes
188 ap += locale_convert<string>(m) + _("m");
197 /// TRANSLATORS: s here is an abbreviation for seconds
198 ap += locale_convert<string>(s) + _("s");
205 seconds (struct timeval t)
207 return t.tv_sec + (double (t.tv_usec) / 1e6);
210 #ifdef DCPOMATIC_WINDOWS
212 /** Resolve symbol name and source location given the path to the executable */
214 addr2line (void const * const addr)
216 char addr2line_cmd[512] = { 0 };
217 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
218 return system(addr2line_cmd);
221 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
222 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
223 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
226 exception_handler(struct _EXCEPTION_POINTERS * info)
228 FILE* f = fopen_boost (backtrace_file, "w");
229 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
232 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
233 CONTEXT* context = info->ContextRecord;
234 SymInitialize (GetCurrentProcess (), 0, true);
236 STACKFRAME frame = { 0 };
238 /* setup initial stack frame */
240 frame.AddrPC.Offset = context->Rip;
241 frame.AddrStack.Offset = context->Rsp;
242 frame.AddrFrame.Offset = context->Rbp;
244 frame.AddrPC.Offset = context->Eip;
245 frame.AddrStack.Offset = context->Esp;
246 frame.AddrFrame.Offset = context->Ebp;
248 frame.AddrPC.Mode = AddrModeFlat;
249 frame.AddrStack.Mode = AddrModeFlat;
250 frame.AddrFrame.Mode = AddrModeFlat;
254 IMAGE_FILE_MACHINE_I386,
255 GetCurrentProcess (),
260 SymFunctionTableAccess,
265 addr2line((void *) frame.AddrPC.Offset);
269 addr2line ((void *) info->ContextRecord->Rip);
271 addr2line ((void *) info->ContextRecord->Eip);
275 return EXCEPTION_CONTINUE_SEARCH;
280 set_backtrace_file (boost::filesystem::path p)
285 /** This is called when there is an unhandled exception. Any
286 * backtrace in this function is useless on Windows as the stack has
287 * already been unwound from the throw; we have the gdb wrap hack to
294 static bool tried_throw = false;
295 // try once to re-throw currently active exception
301 catch (const std::exception &e) {
302 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
303 << e.what() << std::endl;
306 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
314 dcpomatic_setup_path_encoding ()
316 #ifdef DCPOMATIC_WINDOWS
317 /* Dark voodoo which, I think, gets boost::filesystem::path to
318 correctly convert UTF-8 strings to paths, and also paths
319 back to UTF-8 strings (on path::string()).
321 After this, constructing boost::filesystem::paths from strings
322 converts from UTF-8 to UTF-16 inside the path. Then
323 path::string().c_str() gives UTF-8 and
324 path::c_str() gives UTF-16.
326 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
327 so things are much simpler.
329 std::locale::global (boost::locale::generator().generate (""));
330 boost::filesystem::path::imbue (std::locale ());
334 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
335 * Must be called from the UI thread, if there is one.
340 #ifdef DCPOMATIC_WINDOWS
341 boost::filesystem::path p = g_get_user_config_dir ();
342 p /= "backtrace.txt";
343 set_backtrace_file (p);
344 SetUnhandledExceptionFilter(exception_handler);
348 avfilter_register_all ();
351 /* Add our library directory to the libltdl search path so that
352 xmlsec can find xmlsec1-openssl.
354 boost::filesystem::path lib = app_contents ();
356 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
359 set_terminate (terminate);
364 Ratio::setup_ratios ();
365 PresetColourConversion::setup_colour_conversion_presets ();
366 VideoContentScale::setup_scales ();
367 DCPContentType::setup_dcp_content_types ();
368 Filter::setup_filters ();
369 CinemaSoundProcessor::setup_cinema_sound_processors ();
370 AudioProcessor::setup_audio_processors ();
372 curl_global_init (CURL_GLOBAL_ALL);
374 ui_thread = boost::this_thread::get_id ();
377 #ifdef DCPOMATIC_WINDOWS
378 boost::filesystem::path
382 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
383 boost::filesystem::path p (buffer);
384 p = p.parent_path ();
385 p = p.parent_path ();
392 boost::filesystem::path
395 return "DCP-o-matic 2.app/Contents/Resources";
400 dcpomatic_setup_gettext_i18n (string lang)
402 #ifdef DCPOMATIC_LINUX
406 if (!lang.empty ()) {
407 /* Override our environment language. Note that the caller must not
408 free the string passed into putenv().
410 string s = String::compose ("LANGUAGE=%1", lang);
411 putenv (strdup (s.c_str ()));
412 s = String::compose ("LANG=%1", lang);
413 putenv (strdup (s.c_str ()));
414 s = String::compose ("LC_ALL=%1", lang);
415 putenv (strdup (s.c_str ()));
418 setlocale (LC_ALL, "");
419 textdomain ("libdcpomatic2");
421 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
422 bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
423 bind_textdomain_codeset ("libdcpomatic2", "UTF8");
426 #ifdef DCPOMATIC_LINUX
427 bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
431 /** Compute a digest of the first and last `size' bytes of a set of files. */
433 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
435 boost::scoped_array<char> buffer (new char[size]);
439 boost::uintmax_t to_do = size;
440 char* p = buffer.get ();
442 while (i < int64_t (files.size()) && to_do > 0) {
443 FILE* f = fopen_boost (files[i], "rb");
445 throw OpenFileError (files[i].string(), errno, true);
448 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
449 checked_fread (p, this_time, f, files[i]);
456 digester.add (buffer.get(), size - to_do);
461 i = files.size() - 1;
462 while (i >= 0 && to_do > 0) {
463 FILE* f = fopen_boost (files[i], "rb");
465 throw OpenFileError (files[i].string(), errno, true);
468 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
469 dcpomatic_fseek (f, -this_time, SEEK_END);
470 checked_fread (p, this_time, f, files[i]);
477 digester.add (buffer.get(), size - to_do);
479 return digester.get ();
482 /** Round a number up to the nearest multiple of another number.
484 * @param stride Array of numbers to round, indexed by c.
485 * @param t Multiple to round to.
486 * @return Rounded number.
489 stride_round_up (int c, int const * stride, int t)
491 int const a = stride[c] + (t - 1);
495 /** Trip an assert if the caller is not in the UI thread */
499 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
503 audio_channel_name (int c)
505 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
507 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
508 /// enhancement channel (sub-woofer).
509 string const channels[] = {
516 _("Hearing impaired"),
517 _("Visually impaired"),
520 _("Left rear surround"),
521 _("Right rear surround"),
523 _("D-BOX secondary"),
532 short_audio_channel_name (int c)
534 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
536 /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
537 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
538 /// VI is the visually-impaired audio track (audio describe). DBP is the D-BOX
539 /// primary channel and DBS is the D-BOX secondary channel.
540 string const channels[] = {
564 valid_image_file (boost::filesystem::path f)
566 if (boost::starts_with (f.leaf().string(), "._")) {
570 string ext = f.extension().string();
571 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
573 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
574 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
575 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
581 valid_sound_file (boost::filesystem::path f)
583 if (boost::starts_with (f.leaf().string(), "._")) {
587 string ext = f.extension().string();
588 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
589 return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
593 valid_j2k_file (boost::filesystem::path f)
595 string ext = f.extension().string();
596 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
597 return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
601 tidy_for_filename (string f)
603 boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
608 fit_ratio_within (float ratio, dcp::Size full_frame)
610 if (ratio < full_frame.ratio ()) {
611 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
614 return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
618 wrapped_av_malloc (size_t s)
620 void* p = av_malloc (s);
628 split_get_request (string url)
631 AWAITING_QUESTION_MARK,
634 } state = AWAITING_QUESTION_MARK;
636 map<string, string> r;
639 for (size_t i = 0; i < url.length(); ++i) {
641 case AWAITING_QUESTION_MARK:
656 r.insert (make_pair (k, v));
666 if (state == VALUE) {
667 r.insert (make_pair (k, v));
674 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
676 dcp::NameFormat::Map values;
678 values['r'] = raw_convert<string> (reel_index + 1);
679 values['n'] = raw_convert<string> (reel_count);
681 values['c'] = careful_string_filter (summary.get());
683 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
687 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
689 dcp::NameFormat::Map values;
691 values['r'] = raw_convert<string> (reel_index + 1);
692 values['n'] = raw_convert<string> (reel_count);
694 values['c'] = careful_string_filter (summary.get());
696 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
700 relaxed_string_to_float (string s)
703 boost::algorithm::replace_all (s, ",", ".");
704 return lexical_cast<float> (s);
705 } catch (bad_lexical_cast) {
706 boost::algorithm::replace_all (s, ".", ",");
707 return lexical_cast<float> (s);
712 careful_string_filter (string s)
714 /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
715 There's no apparent list of what really is allowed, so this is a guess.
716 Safety first and all that.
720 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
721 for (size_t i = 0; i < s.size(); ++i) {
722 if (allowed.find (s[i]) != string::npos) {
730 /** @param mapped List of mapped audio channels from a Film.
731 * @param channels Total number of channels in the Film.
732 * @return First: number of non-LFE channels, second: number of LFE channels.
735 audio_channel_types (list<int> mapped, int channels)
740 BOOST_FOREACH (int i, mapped) {
742 /* This channel is mapped but is not included in the DCP */
746 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
753 return make_pair (non_lfe, lfe);
756 shared_ptr<AudioBuffers>
757 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
759 shared_ptr<AudioBuffers> mapped (new AudioBuffers (output_channels, input->frames()));
760 mapped->make_silent ();
762 for (int i = 0; i < map.input_channels(); ++i) {
763 for (int j = 0; j < mapped->channels(); ++j) {
764 if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
765 mapped->accumulate_channel (
768 static_cast<dcp::Channel> (j),
769 map.get (i, static_cast<dcp::Channel> (j))
779 increment_eyes (Eyes e)
781 if (e == EYES_LEFT) {
789 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
791 size_t N = fwrite (ptr, 1, size, stream);
793 if (ferror(stream)) {
795 throw FileError (String::compose("fwrite error %1", errno), path);
798 throw FileError ("Unexpected short write", path);
804 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
806 size_t N = fread (ptr, 1, size, stream);
808 if (ferror(stream)) {
810 throw FileError (String::compose("fread error %1", errno), path);
813 throw FileError ("Unexpected short read", path);
818 #ifdef DCPOMATIC_VARIANT_SWAROOP
820 /* Make up a key from the machine UUID */
824 dcp::Data key (dcpomatic::crypto_key_length());
825 memset (key.data().get(), 0, key.size());
826 string const magic = command_and_read ("dcpomatic2_uuid");
827 strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length());
831 /* swaroop chain file format:
833 * 0 [int16_t] IV length
834 * 2 [int16_t] cert #1 length, or 0 for none
835 * 4 [int16_t] cert #2 length, or 0 for none
836 * 6 [int16_t] cert #3 length, or 0 for none
837 * 8 [int16_t] cert #4 length, or 0 for none
838 * 10 [int16_t] cert #5 length, or 0 for none
839 * 12 [int16_t] cert #6 length, or 0 for none
840 * 14 [int16_t] cert #7 length, or 0 for none
841 * 16 [int16_t] cert #8 length, or 0 for none
842 * 16 [int16_t] private key length
855 struct __attribute__ ((packed)) Header_ {
857 int16_t cert_length[8];
858 int16_t private_key_length;
861 typedef struct Header_ Header;
863 shared_ptr<dcp::CertificateChain>
864 read_swaroop_chain (boost::filesystem::path path)
866 dcp::Data data (path);
867 Header* header = (Header *) data.data().get();
868 uint8_t* p = data.data().get() + sizeof(Header);
870 dcp::Data iv (p, header->iv_length);
873 shared_ptr<dcp::CertificateChain> cc (new dcp::CertificateChain());
874 for (int i = 0; i < 8; ++i) {
875 if (header->cert_length[i] == 0) {
878 dcp::Data c(p, header->cert_length[i]);
880 cc->add (dcp::Certificate(dcpomatic::decrypt(c, key_from_uuid(), iv)));
883 dcp::Data k (p, header->private_key_length);
884 cc->set_key (dcpomatic::decrypt(k, key_from_uuid(), iv));
889 write_swaroop_chain (shared_ptr<const dcp::CertificateChain> chain, boost::filesystem::path output)
891 cout << "write " << output.string() << "\n";
893 scoped_array<uint8_t> buffer (new uint8_t[65536]);
894 Header* header = (Header *) buffer.get();
895 memset (header, 0, sizeof(Header));
896 uint8_t* p = buffer.get() + sizeof(Header);
898 dcp::Data iv = dcpomatic::random_iv ();
899 header->iv_length = iv.size ();
900 memcpy (p, iv.data().get(), iv.size());
904 BOOST_FOREACH (dcp::Certificate i, chain->root_to_leaf()) {
905 dcp::Data e = dcpomatic::encrypt (i.certificate(true), key_from_uuid(), iv);
906 memcpy (p, e.data().get(), e.size());
908 DCPOMATIC_ASSERT (N < 8);
909 header->cert_length[N] = e.size ();
913 dcp::Data k = dcpomatic::encrypt (chain->key().get(), key_from_uuid(), iv);
914 memcpy (p, k.data().get(), k.size());
916 header->private_key_length = k.size ();
918 FILE* f = fopen_boost (output, "wb");
919 checked_fwrite (buffer.get(), p - buffer.get(), f, output);