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"
38 #include "compose.hpp"
39 #include "audio_buffers.h"
40 #include <dcp/locale_convert.h>
42 #include <dcp/raw_convert.h>
43 #include <dcp/picture_asset.h>
44 #include <dcp/sound_asset.h>
45 #include <dcp/subtitle_asset.h>
47 #include <libavfilter/avfilter.h>
48 #include <libavformat/avformat.h>
49 #include <libavcodec/avcodec.h>
51 #include <curl/curl.h>
52 #ifdef DCPOMATIC_GRAPHICS_MAGICK
56 #include <pangomm/init.h>
57 #include <boost/algorithm/string.hpp>
58 #include <boost/range/algorithm/replace_if.hpp>
59 #include <boost/thread.hpp>
60 #include <boost/filesystem.hpp>
61 #ifdef DCPOMATIC_WINDOWS
62 #include <boost/locale.hpp>
71 #ifdef DCPOMATIC_POSIX
92 using std::set_terminate;
94 using boost::shared_ptr;
96 using boost::optional;
97 using boost::lexical_cast;
98 using boost::bad_lexical_cast;
100 using dcp::raw_convert;
101 using dcp::locale_convert;
103 /** Path to our executable, required by the stacktrace stuff and filled
104 * in during App::onInit().
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);
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)
143 bool const hours = h > 0;
144 bool const minutes = h < 6 && m > 0;
145 bool const seconds = h == 0 && m < 10 && s > 0;
148 if (m > 30 && !minutes) {
149 /// TRANSLATORS: h here is an abbreviation for hours
150 ap += locale_convert<string>(h + 1) + _("h");
152 /// TRANSLATORS: h here is an abbreviation for hours
153 ap += locale_convert<string>(h) + _("h");
156 if (minutes || seconds) {
163 if (s > 30 && !seconds) {
164 /// TRANSLATORS: m here is an abbreviation for minutes
165 ap += locale_convert<string>(m + 1) + _("m");
167 /// TRANSLATORS: m here is an abbreviation for minutes
168 ap += locale_convert<string>(m) + _("m");
178 /// TRANSLATORS: s here is an abbreviation for seconds
179 ap += locale_convert<string>(s) + _("s");
186 seconds (struct timeval t)
188 return t.tv_sec + (double (t.tv_usec) / 1e6);
191 #ifdef DCPOMATIC_WINDOWS
193 /** Resolve symbol name and source location given the path to the executable */
195 addr2line (void const * const addr)
197 char addr2line_cmd[512] = { 0 };
198 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
199 return system(addr2line_cmd);
202 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
203 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
204 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
207 exception_handler(struct _EXCEPTION_POINTERS * info)
209 FILE* f = fopen_boost (backtrace_file, "w");
210 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
213 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
214 CONTEXT* context = info->ContextRecord;
215 SymInitialize (GetCurrentProcess (), 0, true);
217 STACKFRAME frame = { 0 };
219 /* setup initial stack frame */
221 frame.AddrPC.Offset = context->Rip;
222 frame.AddrStack.Offset = context->Rsp;
223 frame.AddrFrame.Offset = context->Rbp;
225 frame.AddrPC.Offset = context->Eip;
226 frame.AddrStack.Offset = context->Esp;
227 frame.AddrFrame.Offset = context->Ebp;
229 frame.AddrPC.Mode = AddrModeFlat;
230 frame.AddrStack.Mode = AddrModeFlat;
231 frame.AddrFrame.Mode = AddrModeFlat;
235 IMAGE_FILE_MACHINE_I386,
236 GetCurrentProcess (),
241 SymFunctionTableAccess,
246 addr2line((void *) frame.AddrPC.Offset);
250 addr2line ((void *) info->ContextRecord->Rip);
252 addr2line ((void *) info->ContextRecord->Eip);
256 return EXCEPTION_CONTINUE_SEARCH;
261 set_backtrace_file (boost::filesystem::path p)
266 /** This is called when there is an unhandled exception. Any
267 * backtrace in this function is useless on Windows as the stack has
268 * already been unwound from the throw; we have the gdb wrap hack to
275 static bool tried_throw = false;
276 // try once to re-throw currently active exception
282 catch (const std::exception &e) {
283 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
284 << e.what() << std::endl;
287 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
295 dcpomatic_setup_path_encoding ()
297 #ifdef DCPOMATIC_WINDOWS
298 /* Dark voodoo which, I think, gets boost::filesystem::path to
299 correctly convert UTF-8 strings to paths, and also paths
300 back to UTF-8 strings (on path::string()).
302 After this, constructing boost::filesystem::paths from strings
303 converts from UTF-8 to UTF-16 inside the path. Then
304 path::string().c_str() gives UTF-8 and
305 path::c_str() gives UTF-16.
307 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
308 so things are much simpler.
310 std::locale::global (boost::locale::generator().generate (""));
311 boost::filesystem::path::imbue (std::locale ());
315 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
316 * Must be called from the UI thread, if there is one.
321 #ifdef DCPOMATIC_WINDOWS
322 boost::filesystem::path p = g_get_user_config_dir ();
323 p /= "backtrace.txt";
324 set_backtrace_file (p);
325 SetUnhandledExceptionFilter(exception_handler);
329 avfilter_register_all ();
332 /* Add our lib directory to the libltdl search path so that
333 xmlsec can find xmlsec1-openssl.
335 boost::filesystem::path lib = app_contents ();
337 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
340 set_terminate (terminate);
345 Ratio::setup_ratios ();
346 PresetColourConversion::setup_colour_conversion_presets ();
347 VideoContentScale::setup_scales ();
348 DCPContentType::setup_dcp_content_types ();
349 Filter::setup_filters ();
350 CinemaSoundProcessor::setup_cinema_sound_processors ();
351 AudioProcessor::setup_audio_processors ();
353 curl_global_init (CURL_GLOBAL_ALL);
355 #ifdef DCPOMATIC_GRAPHICS_MAGICK
356 Magick::InitializeMagick (0);
359 ui_thread = boost::this_thread::get_id ();
362 #ifdef DCPOMATIC_WINDOWS
363 boost::filesystem::path
367 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
368 boost::filesystem::path p (buffer);
369 p = p.parent_path ();
370 p = p.parent_path ();
377 boost::filesystem::path
380 return "DCP-o-matic 2.app/Contents/Resources";
385 dcpomatic_setup_gettext_i18n (string lang)
387 #ifdef DCPOMATIC_LINUX
391 if (!lang.empty ()) {
392 /* Override our environment language. Note that the caller must not
393 free the string passed into putenv().
395 string s = String::compose ("LANGUAGE=%1", lang);
396 putenv (strdup (s.c_str ()));
397 s = String::compose ("LANG=%1", lang);
398 putenv (strdup (s.c_str ()));
399 s = String::compose ("LC_ALL=%1", lang);
400 putenv (strdup (s.c_str ()));
403 setlocale (LC_ALL, "");
404 textdomain ("libdcpomatic2");
406 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
407 bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
408 bind_textdomain_codeset ("libdcpomatic2", "UTF8");
411 #ifdef DCPOMATIC_LINUX
412 bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
416 /** Compute a digest of the first and last `size' bytes of a set of files. */
418 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
420 boost::scoped_array<char> buffer (new char[size]);
424 boost::uintmax_t to_do = size;
425 char* p = buffer.get ();
427 while (i < int64_t (files.size()) && to_do > 0) {
428 FILE* f = fopen_boost (files[i], "rb");
430 throw OpenFileError (files[i].string(), errno, true);
433 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
434 fread (p, 1, this_time, f);
441 digester.add (buffer.get(), size - to_do);
446 i = files.size() - 1;
447 while (i >= 0 && to_do > 0) {
448 FILE* f = fopen_boost (files[i], "rb");
450 throw OpenFileError (files[i].string(), errno, true);
453 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
454 dcpomatic_fseek (f, -this_time, SEEK_END);
455 fread (p, 1, this_time, f);
462 digester.add (buffer.get(), size - to_do);
464 return digester.get ();
467 /** Round a number up to the nearest multiple of another number.
469 * @param stride Array of numbers to round, indexed by c.
470 * @param t Multiple to round to.
471 * @return Rounded number.
474 stride_round_up (int c, int const * stride, int t)
476 int const a = stride[c] + (t - 1);
480 /** Trip an assert if the caller is not in the UI thread */
484 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
488 audio_channel_name (int c)
490 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
492 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
493 /// enhancement channel (sub-woofer).
494 string const channels[] = {
501 _("Hearing impaired"),
502 _("Visually impaired"),
505 _("Left rear surround"),
506 _("Right rear surround"),
508 _("D-BOX secondary"),
517 short_audio_channel_name (int c)
519 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
521 /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
522 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
523 /// VI is the visually-impaired audio track (audio describe). DBP is the D-BOX
524 /// primary channel and DBS is the D-BOX secondary channel.
525 string const channels[] = {
549 valid_image_file (boost::filesystem::path f)
551 if (boost::starts_with (f.leaf().string(), "._")) {
555 string ext = f.extension().string();
556 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
558 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
559 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
560 ext == ".j2c" || ext == ".j2k" || ext == ".jp2"
565 valid_sound_file (boost::filesystem::path f)
567 if (boost::starts_with (f.leaf().string(), "._")) {
571 string ext = f.extension().string();
572 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
573 return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
577 valid_j2k_file (boost::filesystem::path f)
579 string ext = f.extension().string();
580 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
581 return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
585 tidy_for_filename (string f)
587 boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
592 fit_ratio_within (float ratio, dcp::Size full_frame)
594 if (ratio < full_frame.ratio ()) {
595 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
598 return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
602 wrapped_av_malloc (size_t s)
604 void* p = av_malloc (s);
612 split_get_request (string url)
615 AWAITING_QUESTION_MARK,
618 } state = AWAITING_QUESTION_MARK;
620 map<string, string> r;
623 for (size_t i = 0; i < url.length(); ++i) {
625 case AWAITING_QUESTION_MARK:
640 r.insert (make_pair (k, v));
650 if (state == VALUE) {
651 r.insert (make_pair (k, v));
658 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
660 dcp::NameFormat::Map values;
662 values['r'] = raw_convert<string> (reel_index + 1);
663 values['n'] = raw_convert<string> (reel_count);
665 values['c'] = careful_string_filter (summary.get());
667 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
671 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
673 dcp::NameFormat::Map values;
675 values['r'] = raw_convert<string> (reel_index + 1);
676 values['n'] = raw_convert<string> (reel_count);
678 values['c'] = careful_string_filter (summary.get());
680 return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
684 relaxed_string_to_float (string s)
687 boost::algorithm::replace_all (s, ",", ".");
688 return lexical_cast<float> (s);
689 } catch (bad_lexical_cast) {
690 boost::algorithm::replace_all (s, ".", ",");
691 return lexical_cast<float> (s);
696 careful_string_filter (string s)
698 /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
699 There's no apparent list of what really is allowed, so this is a guess.
700 Safety first and all that.
704 string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.";
705 for (size_t i = 0; i < s.size(); ++i) {
706 if (allowed.find (s[i]) != string::npos) {
714 /** @param mapped List of mapped audio channels from a Film.
715 * @param channels Total number of channels in the Film.
716 * @return First: number of non-LFE channels, second: number of LFE channels.
719 audio_channel_types (list<int> mapped, int channels)
724 BOOST_FOREACH (int i, mapped) {
726 /* This channel is mapped but is not included in the DCP */
730 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
737 return make_pair (non_lfe, lfe);
740 shared_ptr<AudioBuffers>
741 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
743 shared_ptr<AudioBuffers> mapped (new AudioBuffers (output_channels, input->frames()));
744 mapped->make_silent ();
746 for (int i = 0; i < map.input_channels(); ++i) {
747 for (int j = 0; j < mapped->channels(); ++j) {
748 if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
749 mapped->accumulate_channel (
752 static_cast<dcp::Channel> (j),
753 map.get (i, static_cast<dcp::Channel> (j))