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 "locale_convert.h"
41 #include <dcp/raw_convert.h>
42 #include <dcp/picture_asset.h>
43 #include <dcp/sound_asset.h>
44 #include <dcp/subtitle_asset.h>
46 #include <libavfilter/avfilter.h>
47 #include <libavcodec/avcodec.h>
49 #include <curl/curl.h>
50 #ifdef DCPOMATIC_GRAPHICS_MAGICK
54 #include <pangomm/init.h>
55 #include <boost/algorithm/string.hpp>
56 #include <boost/thread.hpp>
57 #include <boost/filesystem.hpp>
58 #ifdef DCPOMATIC_WINDOWS
59 #include <boost/locale.hpp>
68 #ifdef DCPOMATIC_POSIX
89 using std::set_terminate;
90 using boost::shared_ptr;
92 using boost::optional;
93 using boost::lexical_cast;
94 using boost::bad_lexical_cast;
96 using dcp::raw_convert;
98 /** Path to our executable, required by the stacktrace stuff and filled
99 * in during App::onInit().
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)
121 snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
125 /** @param s Number of seconds.
126 * @return String containing an approximate description of s (e.g. "about 2 hours")
129 seconds_to_approximate_hms (int s)
138 bool const hours = h > 0;
139 bool const minutes = h < 6 && m > 0;
140 bool const seconds = h == 0 && m < 10 && s > 0;
143 if (m > 30 && !minutes) {
144 /// TRANSLATORS: h here is an abbreviation for hours
145 ap += locale_convert<string>(h + 1) + _("h");
147 /// TRANSLATORS: h here is an abbreviation for hours
148 ap += locale_convert<string>(h) + _("h");
151 if (minutes || seconds) {
158 if (s > 30 && !seconds) {
159 /// TRANSLATORS: m here is an abbreviation for minutes
160 ap += locale_convert<string>(m + 1) + _("m");
162 /// TRANSLATORS: m here is an abbreviation for minutes
163 ap += locale_convert<string>(m) + _("m");
173 /// TRANSLATORS: s here is an abbreviation for seconds
174 ap += locale_convert<string>(s) + _("s");
181 seconds (struct timeval t)
183 return t.tv_sec + (double (t.tv_usec) / 1e6);
186 #ifdef DCPOMATIC_WINDOWS
188 /** Resolve symbol name and source location given the path to the executable */
190 addr2line (void const * const addr)
192 char addr2line_cmd[512] = { 0 };
193 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
194 return system(addr2line_cmd);
197 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
198 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
199 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
202 exception_handler(struct _EXCEPTION_POINTERS * info)
204 FILE* f = fopen_boost (backtrace_file, "w");
205 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
208 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
209 CONTEXT* context = info->ContextRecord;
210 SymInitialize (GetCurrentProcess (), 0, true);
212 STACKFRAME frame = { 0 };
214 /* setup initial stack frame */
216 frame.AddrPC.Offset = context->Rip;
217 frame.AddrStack.Offset = context->Rsp;
218 frame.AddrFrame.Offset = context->Rbp;
220 frame.AddrPC.Offset = context->Eip;
221 frame.AddrStack.Offset = context->Esp;
222 frame.AddrFrame.Offset = context->Ebp;
224 frame.AddrPC.Mode = AddrModeFlat;
225 frame.AddrStack.Mode = AddrModeFlat;
226 frame.AddrFrame.Mode = AddrModeFlat;
230 IMAGE_FILE_MACHINE_I386,
231 GetCurrentProcess (),
236 SymFunctionTableAccess,
241 addr2line((void *) frame.AddrPC.Offset);
245 addr2line ((void *) info->ContextRecord->Rip);
247 addr2line ((void *) info->ContextRecord->Eip);
251 return EXCEPTION_CONTINUE_SEARCH;
256 set_backtrace_file (boost::filesystem::path p)
261 /** This is called when there is an unhandled exception. Any
262 * backtrace in this function is useless on Windows as the stack has
263 * already been unwound from the throw; we have the gdb wrap hack to
270 static bool tried_throw = false;
271 // try once to re-throw currently active exception
277 catch (const std::exception &e) {
278 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
279 << e.what() << std::endl;
282 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
290 dcpomatic_setup_path_encoding ()
292 #ifdef DCPOMATIC_WINDOWS
293 /* Dark voodoo which, I think, gets boost::filesystem::path to
294 correctly convert UTF-8 strings to paths, and also paths
295 back to UTF-8 strings (on path::string()).
297 After this, constructing boost::filesystem::paths from strings
298 converts from UTF-8 to UTF-16 inside the path. Then
299 path::string().c_str() gives UTF-8 and
300 path::c_str() gives UTF-16.
302 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
303 so things are much simpler.
305 std::locale::global (boost::locale::generator().generate (""));
306 boost::filesystem::path::imbue (std::locale ());
310 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
311 * Must be called from the UI thread, if there is one.
316 #ifdef DCPOMATIC_WINDOWS
317 boost::filesystem::path p = g_get_user_config_dir ();
318 p /= "backtrace.txt";
319 set_backtrace_file (p);
320 SetUnhandledExceptionFilter(exception_handler);
323 avfilter_register_all ();
326 /* Add our lib directory to the libltdl search path so that
327 xmlsec can find xmlsec1-openssl.
329 boost::filesystem::path lib = app_contents ();
331 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
334 set_terminate (terminate);
339 Ratio::setup_ratios ();
340 PresetColourConversion::setup_colour_conversion_presets ();
341 VideoContentScale::setup_scales ();
342 DCPContentType::setup_dcp_content_types ();
343 Filter::setup_filters ();
344 CinemaSoundProcessor::setup_cinema_sound_processors ();
345 AudioProcessor::setup_audio_processors ();
347 curl_global_init (CURL_GLOBAL_ALL);
349 #ifdef DCPOMATIC_GRAPHICS_MAGICK
350 Magick::InitializeMagick (0);
353 ui_thread = boost::this_thread::get_id ();
356 #ifdef DCPOMATIC_WINDOWS
357 boost::filesystem::path
361 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
362 boost::filesystem::path p (buffer);
363 p = p.parent_path ();
364 p = p.parent_path ();
371 boost::filesystem::path
374 return "DCP-o-matic 2.app/Contents/Resources";
379 dcpomatic_setup_gettext_i18n (string lang)
381 #ifdef DCPOMATIC_LINUX
385 if (!lang.empty ()) {
386 /* Override our environment language. Note that the caller must not
387 free the string passed into putenv().
389 string s = String::compose ("LANGUAGE=%1", lang);
390 putenv (strdup (s.c_str ()));
391 s = String::compose ("LANG=%1", lang);
392 putenv (strdup (s.c_str ()));
393 s = String::compose ("LC_ALL=%1", lang);
394 putenv (strdup (s.c_str ()));
397 setlocale (LC_ALL, "");
398 textdomain ("libdcpomatic2");
400 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
401 bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
402 bind_textdomain_codeset ("libdcpomatic2", "UTF8");
405 #ifdef DCPOMATIC_LINUX
406 bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
410 /** Compute a digest of the first and last `size' bytes of a set of files. */
412 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
414 boost::scoped_array<char> buffer (new char[size]);
418 boost::uintmax_t to_do = size;
419 char* p = buffer.get ();
421 while (i < int64_t (files.size()) && to_do > 0) {
422 FILE* f = fopen_boost (files[i], "rb");
424 throw OpenFileError (files[i].string());
427 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
428 fread (p, 1, this_time, f);
435 digester.add (buffer.get(), size - to_do);
440 i = files.size() - 1;
441 while (i >= 0 && to_do > 0) {
442 FILE* f = fopen_boost (files[i], "rb");
444 throw OpenFileError (files[i].string());
447 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
448 dcpomatic_fseek (f, -this_time, SEEK_END);
449 fread (p, 1, this_time, f);
456 digester.add (buffer.get(), size - to_do);
458 return digester.get ();
461 /** Round a number up to the nearest multiple of another number.
463 * @param s Array of numbers to round, indexed by c.
464 * @param t Multiple to round to.
465 * @return Rounded number.
468 stride_round_up (int c, int const * stride, int t)
470 int const a = stride[c] + (t - 1);
474 /** Trip an assert if the caller is not in the UI thread */
478 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
482 audio_channel_name (int c)
484 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
486 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
487 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
488 /// VI is the visually-impaired audio track (audio describe).
489 string const channels[] = {
496 _("Hearing impaired"),
497 _("Visually impaired"),
500 _("Left rear surround"),
501 _("Right rear surround"),
503 _("D-BOX secondary"),
512 valid_image_file (boost::filesystem::path f)
514 if (boost::starts_with (f.leaf().string(), "._")) {
518 string ext = f.extension().string();
519 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
521 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
522 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
523 ext == ".j2c" || ext == ".j2k" || ext == ".jp2"
528 valid_j2k_file (boost::filesystem::path f)
530 string ext = f.extension().string();
531 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
532 return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
536 tidy_for_filename (string f)
539 for (size_t i = 0; i < f.length(); ++i) {
540 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
551 fit_ratio_within (float ratio, dcp::Size full_frame)
553 if (ratio < full_frame.ratio ()) {
554 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
557 return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
561 wrapped_av_malloc (size_t s)
563 void* p = av_malloc (s);
571 split_get_request (string url)
574 AWAITING_QUESTION_MARK,
577 } state = AWAITING_QUESTION_MARK;
579 map<string, string> r;
582 for (size_t i = 0; i < url.length(); ++i) {
584 case AWAITING_QUESTION_MARK:
599 r.insert (make_pair (k, v));
609 if (state == VALUE) {
610 r.insert (make_pair (k, v));
617 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
619 dcp::NameFormat::Map values;
621 values['i'] = asset->id();
622 values['r'] = raw_convert<string> (reel_index + 1);
623 values['n'] = raw_convert<string> (reel_count);
625 values['c'] = summary.get();
627 return Config::instance()->dcp_asset_filename_format().get(values) + ".mxf";
631 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
633 dcp::NameFormat::Map values;
635 values['i'] = asset->id();
636 values['r'] = raw_convert<string> (reel_index + 1);
637 values['n'] = raw_convert<string> (reel_count);
639 values['c'] = summary.get();
641 return Config::instance()->dcp_asset_filename_format().get(values) + ".mxf";
645 relaxed_string_to_float (string s)
648 boost::algorithm::replace_all (s, ",", ".");
649 return lexical_cast<float> (s);
650 } catch (bad_lexical_cast) {
651 boost::algorithm::replace_all (s, ".", ",");
652 return lexical_cast<float> (s);
657 string_not_empty (string s)