2 Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
20 /** @file src/lib/util.cc
21 * @brief Some utility functions and classes.
25 #include "exceptions.h"
26 #include "dcp_content_type.h"
28 #include "cinema_sound_processor.h"
33 #include "video_content.h"
35 #include "md5_digester.h"
36 #include "audio_processor.h"
37 #include "safe_stringstream.h"
39 #include <dcp/signer.h>
40 #include <dcp/picture_asset.h>
41 #include <dcp/sound_asset.h>
42 #include <dcp/subtitle_asset.h>
43 #include <curl/curl.h>
45 #include <pangomm/init.h>
46 #include <boost/algorithm/string.hpp>
47 #include <boost/bind.hpp>
48 #include <boost/lambda/lambda.hpp>
49 #include <boost/thread.hpp>
50 #include <boost/filesystem.hpp>
51 #ifdef DCPOMATIC_WINDOWS
52 #include <boost/locale.hpp>
61 #ifdef DCPOMATIC_POSIX
82 using std::set_terminate;
83 using boost::shared_ptr;
85 using boost::optional;
88 /** Path to our executable, required by the stacktrace stuff and filled
89 * in during App::onInit().
92 static boost::thread::id ui_thread;
93 static boost::filesystem::path backtrace_file;
95 /** Convert some number of seconds to a string representation
96 * in hours, minutes and seconds.
99 * @return String of the form H:M:S (where H is hours, M
100 * is minutes and S is seconds).
103 seconds_to_hms (int s)
110 SafeStringStream hms;
113 hms << setfill ('0') << m << N_(":");
115 hms << setfill ('0') << s;
120 /** @param s Number of seconds.
121 * @return String containing an approximate description of s (e.g. "about 2 hours")
124 seconds_to_approximate_hms (int s)
133 bool const hours = h > 0;
134 bool const minutes = h < 10 && m > 0;
135 bool const seconds = m < 10 && s > 0;
138 if (m > 30 && !minutes) {
139 /// TRANSLATORS: h here is an abbreviation for hours
140 ap << (h + 1) << _("h");
142 /// TRANSLATORS: h here is an abbreviation for hours
146 if (minutes | seconds) {
153 if (s > 30 && !seconds) {
154 /// TRANSLATORS: m here is an abbreviation for minutes
155 ap << (m + 1) << _("m");
157 /// TRANSLATORS: m here is an abbreviation for minutes
168 /// TRANSLATORS: s here is an abbreviation for seconds
176 seconds (struct timeval t)
178 return t.tv_sec + (double (t.tv_usec) / 1e6);
181 #ifdef DCPOMATIC_WINDOWS
183 /** Resolve symbol name and source location given the path to the executable */
185 addr2line (void const * const addr)
187 char addr2line_cmd[512] = { 0 };
188 sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
189 return system(addr2line_cmd);
192 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
193 * (NOT C++ exceptions!). We write a backtrace to backtrace_file by dark means.
194 * Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
197 exception_handler(struct _EXCEPTION_POINTERS * info)
199 FILE* f = fopen_boost (backtrace_file, "w");
200 fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
203 if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
204 CONTEXT* context = info->ContextRecord;
205 SymInitialize (GetCurrentProcess (), 0, true);
207 STACKFRAME frame = { 0 };
209 /* setup initial stack frame */
211 frame.AddrPC.Offset = context->Rip;
212 frame.AddrStack.Offset = context->Rsp;
213 frame.AddrFrame.Offset = context->Rbp;
215 frame.AddrPC.Offset = context->Eip;
216 frame.AddrStack.Offset = context->Esp;
217 frame.AddrFrame.Offset = context->Ebp;
219 frame.AddrPC.Mode = AddrModeFlat;
220 frame.AddrStack.Mode = AddrModeFlat;
221 frame.AddrFrame.Mode = AddrModeFlat;
225 IMAGE_FILE_MACHINE_I386,
226 GetCurrentProcess (),
231 SymFunctionTableAccess,
236 addr2line((void *) frame.AddrPC.Offset);
240 addr2line ((void *) info->ContextRecord->Rip);
242 addr2line ((void *) info->ContextRecord->Eip);
246 return EXCEPTION_CONTINUE_SEARCH;
251 set_backtrace_file (boost::filesystem::path p)
256 /** This is called when there is an unhandled exception. Any
257 * backtrace in this function is useless on Windows as the stack has
258 * already been unwound from the throw; we have the gdb wrap hack to
265 static bool tried_throw = false;
266 // try once to re-throw currently active exception
272 catch (const std::exception &e) {
273 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
274 << e.what() << std::endl;
277 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
284 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
285 * Must be called from the UI thread, if there is one.
290 #ifdef DCPOMATIC_WINDOWS
291 boost::filesystem::path p = g_get_user_config_dir ();
292 p /= "backtrace.txt";
293 set_backtrace_file (p);
294 SetUnhandledExceptionFilter(exception_handler);
296 /* Dark voodoo which, I think, gets boost::filesystem::path to
297 correctly convert UTF-8 strings to paths, and also paths
298 back to UTF-8 strings (on path::string()).
300 After this, constructing boost::filesystem::paths from strings
301 converts from UTF-8 to UTF-16 inside the path. Then
302 path::string().c_str() gives UTF-8 and
303 path::c_str() gives UTF-16.
305 This is all Windows-only. AFAICT Linux/OS X use UTF-8 everywhere,
306 so things are much simpler.
308 std::locale::global (boost::locale::generator().generate (""));
309 boost::filesystem::path::imbue (std::locale ());
312 avfilter_register_all ();
315 /* Add our lib directory to the libltdl search path so that
316 xmlsec can find xmlsec1-openssl.
318 boost::filesystem::path lib = app_contents ();
320 setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
323 set_terminate (terminate);
328 Ratio::setup_ratios ();
329 PresetColourConversion::setup_colour_conversion_presets ();
330 VideoContentScale::setup_scales ();
331 DCPContentType::setup_dcp_content_types ();
332 Filter::setup_filters ();
333 CinemaSoundProcessor::setup_cinema_sound_processors ();
334 AudioProcessor::setup_audio_processors ();
336 curl_global_init (CURL_GLOBAL_ALL);
338 ui_thread = boost::this_thread::get_id ();
341 #ifdef DCPOMATIC_WINDOWS
342 boost::filesystem::path
346 GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
347 boost::filesystem::path p (buffer);
348 p = p.parent_path ();
349 p = p.parent_path ();
356 boost::filesystem::path
359 return "DCP-o-matic 2.app/Contents/Resources";
364 dcpomatic_setup_gettext_i18n (string lang)
366 #ifdef DCPOMATIC_LINUX
370 if (!lang.empty ()) {
371 /* Override our environment language. Note that the caller must not
372 free the string passed into putenv().
374 string s = String::compose ("LANGUAGE=%1", lang);
375 putenv (strdup (s.c_str ()));
376 s = String::compose ("LANG=%1", lang);
377 putenv (strdup (s.c_str ()));
378 s = String::compose ("LC_ALL=%1", lang);
379 putenv (strdup (s.c_str ()));
382 setlocale (LC_ALL, "");
383 textdomain ("libdcpomatic2");
385 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
386 bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
387 bind_textdomain_codeset ("libdcpomatic2", "UTF8");
390 #ifdef DCPOMATIC_LINUX
391 bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
395 /** Compute a digest of the first and last `size' bytes of a set of files. */
397 md5_digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
399 boost::scoped_array<char> buffer (new char[size]);
400 MD5Digester digester;
403 boost::uintmax_t to_do = size;
404 char* p = buffer.get ();
406 while (i < int64_t (files.size()) && to_do > 0) {
407 FILE* f = fopen_boost (files[i], "rb");
409 throw OpenFileError (files[i].string());
412 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
413 fread (p, 1, this_time, f);
420 digester.add (buffer.get(), size - to_do);
425 i = files.size() - 1;
426 while (i >= 0 && to_do > 0) {
427 FILE* f = fopen_boost (files[i], "rb");
429 throw OpenFileError (files[i].string());
432 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
433 dcpomatic_fseek (f, -this_time, SEEK_END);
434 fread (p, 1, this_time, f);
441 digester.add (buffer.get(), size - to_do);
443 return digester.get ();
446 /** Round a number up to the nearest multiple of another number.
448 * @param s Array of numbers to round, indexed by c.
449 * @param t Multiple to round to.
450 * @return Rounded number.
453 stride_round_up (int c, int const * stride, int t)
455 int const a = stride[c] + (t - 1);
459 /** Trip an assert if the caller is not in the UI thread */
463 DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
467 audio_channel_name (int c)
469 DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 12);
471 /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
472 /// enhancement channel (sub-woofer). HI is the hearing-impaired audio track and
473 /// VI is the visually-impaired audio track (audio describe).
474 string const channels[] = {
481 _("Hearing impaired"),
482 _("Visually impaired"),
485 _("Left rear surround"),
486 _("Right rear surround"),
493 valid_image_file (boost::filesystem::path f)
495 if (boost::starts_with (f.leaf().string(), "._")) {
499 string ext = f.extension().string();
500 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
502 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
503 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
504 ext == ".j2c" || ext == ".j2k" || ext == ".jp2"
509 valid_j2k_file (boost::filesystem::path f)
511 string ext = f.extension().string();
512 transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
513 return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
517 tidy_for_filename (string f)
520 for (size_t i = 0; i < f.length(); ++i) {
521 if (isalnum (f[i]) || f[i] == '_' || f[i] == '-') {
532 fit_ratio_within (float ratio, dcp::Size full_frame)
534 if (ratio < full_frame.ratio ()) {
535 return dcp::Size (rint (full_frame.height * ratio), full_frame.height);
538 return dcp::Size (full_frame.width, rint (full_frame.width / ratio));
542 wrapped_av_malloc (size_t s)
544 void* p = av_malloc (s);
552 subtitle_period (AVSubtitle const & sub)
554 ContentTime const packet_time = ContentTime::from_seconds (static_cast<double> (sub.pts) / AV_TIME_BASE);
556 if (sub.end_display_time == static_cast<uint32_t> (-1)) {
557 /* End time is not known */
558 return FFmpegSubtitlePeriod (packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3));
561 return FFmpegSubtitlePeriod (
562 packet_time + ContentTime::from_seconds (sub.start_display_time / 1e3),
563 packet_time + ContentTime::from_seconds (sub.end_display_time / 1e3)
568 split_get_request (string url)
571 AWAITING_QUESTION_MARK,
574 } state = AWAITING_QUESTION_MARK;
576 map<string, string> r;
579 for (size_t i = 0; i < url.length(); ++i) {
581 case AWAITING_QUESTION_MARK:
596 r.insert (make_pair (k, v));
606 if (state == VALUE) {
607 r.insert (make_pair (k, v));
614 video_asset_filename (shared_ptr<dcp::PictureAsset> asset)
616 return "j2c_" + asset->id() + ".mxf";
620 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset)
622 return "pcm_" + asset->id() + ".mxf";