Add an assertion.
[dcpomatic.git] / src / lib / util.cc
1 /*
2     Copyright (C) 2012-2019 Carl Hetherington <cth@carlh.net>
3
4     This file is part of DCP-o-matic.
5
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.
10
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.
15
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/>.
18
19 */
20
21 /** @file src/lib/util.cc
22  *  @brief Some utility functions and classes.
23  */
24
25 #include "util.h"
26 #include "exceptions.h"
27 #include "dcp_content_type.h"
28 #include "filter.h"
29 #include "cinema_sound_processor.h"
30 #include "config.h"
31 #include "ratio.h"
32 #include "job.h"
33 #include "cross.h"
34 #include "video_content.h"
35 #include "rect.h"
36 #include "digester.h"
37 #include "audio_processor.h"
38 #include "crypto.h"
39 #include "compose.hpp"
40 #include "audio_buffers.h"
41 #include "string_text.h"
42 #include "font.h"
43 #include "render_text.h"
44 #include "ffmpeg_image_proxy.h"
45 #include "image.h"
46 #include "text_decoder.h"
47 #include <dcp/locale_convert.h>
48 #include <dcp/util.h>
49 #include <dcp/raw_convert.h>
50 #include <dcp/picture_asset.h>
51 #include <dcp/sound_asset.h>
52 #include <dcp/subtitle_asset.h>
53 extern "C" {
54 #include <libavfilter/avfilter.h>
55 #include <libavformat/avformat.h>
56 #include <libavcodec/avcodec.h>
57 }
58 #include <curl/curl.h>
59 #include <glib.h>
60 #include <pangomm/init.h>
61 #include <boost/algorithm/string.hpp>
62 #include <boost/range/algorithm/replace_if.hpp>
63 #include <boost/thread.hpp>
64 #include <boost/filesystem.hpp>
65 #include <boost/locale.hpp>
66 #ifdef DCPOMATIC_WINDOWS
67 #include <boost/locale.hpp>
68 #include <dbghelp.h>
69 #endif
70 #include <signal.h>
71 #include <iomanip>
72 #include <iostream>
73 #include <fstream>
74 #include <climits>
75 #include <stdexcept>
76 #ifdef DCPOMATIC_POSIX
77 #include <execinfo.h>
78 #include <cxxabi.h>
79 #endif
80
81 #include "i18n.h"
82
83 using std::string;
84 using std::wstring;
85 using std::setfill;
86 using std::ostream;
87 using std::endl;
88 using std::vector;
89 using std::min;
90 using std::max;
91 using std::map;
92 using std::list;
93 using std::multimap;
94 using std::istream;
95 using std::pair;
96 using std::cout;
97 using std::bad_alloc;
98 using std::set_terminate;
99 using std::make_pair;
100 using boost::shared_ptr;
101 using boost::thread;
102 using boost::optional;
103 using boost::lexical_cast;
104 using boost::bad_lexical_cast;
105 using boost::scoped_array;
106 using dcp::Size;
107 using dcp::raw_convert;
108 using dcp::locale_convert;
109 using namespace dcpomatic;
110
111 /** Path to our executable, required by the stacktrace stuff and filled
112  *  in during App::onInit().
113  */
114 string program_name;
115 bool is_batch_converter = false;
116 static boost::thread::id ui_thread;
117 static boost::filesystem::path backtrace_file;
118
119 /** Convert some number of seconds to a string representation
120  *  in hours, minutes and seconds.
121  *
122  *  @param s Seconds.
123  *  @return String of the form H:M:S (where H is hours, M
124  *  is minutes and S is seconds).
125  */
126 string
127 seconds_to_hms (int s)
128 {
129         int m = s / 60;
130         s -= (m * 60);
131         int h = m / 60;
132         m -= (h * 60);
133
134         char buffer[64];
135         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d", h, m, s);
136         return buffer;
137 }
138
139 string
140 time_to_hmsf (DCPTime time, Frame rate)
141 {
142         Frame f = time.frames_round (rate);
143         int s = f / rate;
144         f -= (s * rate);
145         int m = s / 60;
146         s -= m * 60;
147         int h = m / 60;
148         m -= h * 60;
149
150         char buffer[64];
151         snprintf (buffer, sizeof(buffer), "%d:%02d:%02d.%d", h, m, s, static_cast<int>(f));
152         return buffer;
153 }
154
155 /** @param s Number of seconds.
156  *  @return String containing an approximate description of s (e.g. "about 2 hours")
157  */
158 string
159 seconds_to_approximate_hms (int s)
160 {
161         int m = s / 60;
162         s -= (m * 60);
163         int h = m / 60;
164         m -= (h * 60);
165
166         string ap;
167
168         bool hours = h > 0;
169         bool minutes = h < 6 && m > 0;
170         bool seconds = h == 0 && m < 10 && s > 0;
171
172         if (m > 30 && !minutes) {
173                 /* round up the hours */
174                 ++h;
175         }
176         if (s > 30 && !seconds) {
177                 /* round up the minutes */
178                 ++m;
179                 if (m == 60) {
180                         m = 0;
181                         minutes = false;
182                         ++h;
183                 }
184         }
185
186         if (hours) {
187                 /// TRANSLATORS: h here is an abbreviation for hours
188                 ap += locale_convert<string>(h) + _("h");
189
190                 if (minutes || seconds) {
191                         ap += N_(" ");
192                 }
193         }
194
195         if (minutes) {
196                 /// TRANSLATORS: m here is an abbreviation for minutes
197                 ap += locale_convert<string>(m) + _("m");
198
199                 if (seconds) {
200                         ap += N_(" ");
201                 }
202         }
203
204         if (seconds) {
205                 /* Seconds */
206                 /// TRANSLATORS: s here is an abbreviation for seconds
207                 ap += locale_convert<string>(s) + _("s");
208         }
209
210         return ap;
211 }
212
213 double
214 seconds (struct timeval t)
215 {
216         return t.tv_sec + (double (t.tv_usec) / 1e6);
217 }
218
219 #ifdef DCPOMATIC_WINDOWS
220
221 /** Resolve symbol name and source location given the path to the executable */
222 int
223 addr2line (void const * const addr)
224 {
225         char addr2line_cmd[512] = { 0 };
226         sprintf (addr2line_cmd, "addr2line -f -p -e %.256s %p > %s", program_name.c_str(), addr, backtrace_file.string().c_str());
227         return system(addr2line_cmd);
228 }
229
230 /** This is called when C signals occur on Windows (e.g. SIGSEGV)
231  *  (NOT C++ exceptions!).  We write a backtrace to backtrace_file by dark means.
232  *  Adapted from code here: http://spin.atomicobject.com/2013/01/13/exceptions-stack-traces-c/
233  */
234 LONG WINAPI
235 exception_handler(struct _EXCEPTION_POINTERS * info)
236 {
237         FILE* f = fopen_boost (backtrace_file, "w");
238         fprintf (f, "C-style exception %d\n", info->ExceptionRecord->ExceptionCode);
239         fclose(f);
240
241         if (info->ExceptionRecord->ExceptionCode != EXCEPTION_STACK_OVERFLOW) {
242                 CONTEXT* context = info->ContextRecord;
243                 SymInitialize (GetCurrentProcess (), 0, true);
244
245                 STACKFRAME frame = { 0 };
246
247                 /* setup initial stack frame */
248 #if _WIN64
249                 frame.AddrPC.Offset    = context->Rip;
250                 frame.AddrStack.Offset = context->Rsp;
251                 frame.AddrFrame.Offset = context->Rbp;
252 #else
253                 frame.AddrPC.Offset    = context->Eip;
254                 frame.AddrStack.Offset = context->Esp;
255                 frame.AddrFrame.Offset = context->Ebp;
256 #endif
257                 frame.AddrPC.Mode      = AddrModeFlat;
258                 frame.AddrStack.Mode   = AddrModeFlat;
259                 frame.AddrFrame.Mode   = AddrModeFlat;
260
261                 while (
262                         StackWalk (
263                                 IMAGE_FILE_MACHINE_I386,
264                                 GetCurrentProcess (),
265                                 GetCurrentThread (),
266                                 &frame,
267                                 context,
268                                 0,
269                                 SymFunctionTableAccess,
270                                 SymGetModuleBase,
271                                 0
272                                 )
273                         ) {
274                         addr2line((void *) frame.AddrPC.Offset);
275                 }
276         } else {
277 #ifdef _WIN64
278                 addr2line ((void *) info->ContextRecord->Rip);
279 #else
280                 addr2line ((void *) info->ContextRecord->Eip);
281 #endif
282         }
283
284         return EXCEPTION_CONTINUE_SEARCH;
285 }
286 #endif
287
288 void
289 set_backtrace_file (boost::filesystem::path p)
290 {
291         backtrace_file = p;
292 }
293
294 /** This is called when there is an unhandled exception.  Any
295  *  backtrace in this function is useless on Windows as the stack has
296  *  already been unwound from the throw; we have the gdb wrap hack to
297  *  cope with that.
298  */
299 void
300 terminate ()
301 {
302         try {
303                 static bool tried_throw = false;
304                 // try once to re-throw currently active exception
305                 if (!tried_throw) {
306                         tried_throw = true;
307                         throw;
308                 }
309         }
310         catch (const std::exception &e) {
311                 std::cerr << __FUNCTION__ << " caught unhandled exception. what(): "
312                           << e.what() << std::endl;
313         }
314         catch (...) {
315                 std::cerr << __FUNCTION__ << " caught unknown/unhandled exception."
316                           << std::endl;
317         }
318
319         abort();
320 }
321
322 void
323 dcpomatic_setup_path_encoding ()
324 {
325 #ifdef DCPOMATIC_WINDOWS
326         /* Dark voodoo which, I think, gets boost::filesystem::path to
327            correctly convert UTF-8 strings to paths, and also paths
328            back to UTF-8 strings (on path::string()).
329
330            After this, constructing boost::filesystem::paths from strings
331            converts from UTF-8 to UTF-16 inside the path.  Then
332            path::string().c_str() gives UTF-8 and
333            path::c_str()          gives UTF-16.
334
335            This is all Windows-only.  AFAICT Linux/OS X use UTF-8 everywhere,
336            so things are much simpler.
337         */
338         std::locale::global (boost::locale::generator().generate (""));
339         boost::filesystem::path::imbue (std::locale ());
340 #endif
341 }
342
343 /** Call the required functions to set up DCP-o-matic's static arrays, etc.
344  *  Must be called from the UI thread, if there is one.
345  */
346 void
347 dcpomatic_setup ()
348 {
349 #ifdef DCPOMATIC_WINDOWS
350         boost::filesystem::path p = g_get_user_config_dir ();
351         p /= "backtrace.txt";
352         set_backtrace_file (p);
353         SetUnhandledExceptionFilter(exception_handler);
354 #endif
355
356         av_register_all ();
357         avfilter_register_all ();
358
359 #ifdef DCPOMATIC_OSX
360         /* Add our library directory to the libltdl search path so that
361            xmlsec can find xmlsec1-openssl.
362         */
363         boost::filesystem::path lib = app_contents ();
364         lib /= "Frameworks";
365         setenv ("LTDL_LIBRARY_PATH", lib.c_str (), 1);
366 #endif
367
368         set_terminate (terminate);
369
370 #ifdef DCPOMATIC_WINDOWS
371         putenv ("PANGOCAIRO_BACKEND=fontconfig");
372         putenv (String::compose("FONTCONFIG_PATH=%1", shared_path().string()).c_str());
373 #endif
374
375 #ifdef DCPOMATIC_OSX
376         setenv ("PANGOCAIRO_BACKEND", "fontconfig", 1);
377         setenv ("FONTCONFIG_PATH", shared_path().string().c_str(), 1);
378 #endif
379
380         Pango::init ();
381         dcp::init ();
382
383 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
384         /* Render something to fontconfig to create its cache */
385         list<StringText> subs;
386         dcp::SubtitleString ss(
387                 optional<string>(), false, false, false, dcp::Colour(), 42, 1, dcp::Time(), dcp::Time(), 0, dcp::HALIGN_CENTER, 0, dcp::VALIGN_CENTER, dcp::DIRECTION_LTR,
388                 "Hello dolly", dcp::NONE, dcp::Colour(), dcp::Time(), dcp::Time()
389                 );
390         subs.push_back (StringText(ss, 0));
391         render_text (subs, list<shared_ptr<Font> >(), dcp::Size(640, 480), DCPTime(), 24);
392 #endif
393
394         Ratio::setup_ratios ();
395         PresetColourConversion::setup_colour_conversion_presets ();
396         VideoContentScale::setup_scales ();
397         DCPContentType::setup_dcp_content_types ();
398         Filter::setup_filters ();
399         CinemaSoundProcessor::setup_cinema_sound_processors ();
400         AudioProcessor::setup_audio_processors ();
401
402         curl_global_init (CURL_GLOBAL_ALL);
403
404         ui_thread = boost::this_thread::get_id ();
405 }
406
407 #ifdef DCPOMATIC_WINDOWS
408 boost::filesystem::path
409 mo_path ()
410 {
411         wchar_t buffer[512];
412         GetModuleFileName (0, buffer, 512 * sizeof(wchar_t));
413         boost::filesystem::path p (buffer);
414         p = p.parent_path ();
415         p = p.parent_path ();
416         p /= "locale";
417         return p;
418 }
419 #endif
420
421 #ifdef DCPOMATIC_OSX
422 boost::filesystem::path
423 mo_path ()
424 {
425         return "DCP-o-matic 2.app/Contents/Resources";
426 }
427 #endif
428
429 void
430 dcpomatic_setup_gettext_i18n (string lang)
431 {
432 #ifdef DCPOMATIC_LINUX
433         lang += ".UTF8";
434 #endif
435
436         if (!lang.empty ()) {
437                 /* Override our environment language.  Note that the caller must not
438                    free the string passed into putenv().
439                 */
440                 string s = String::compose ("LANGUAGE=%1", lang);
441                 putenv (strdup (s.c_str ()));
442                 s = String::compose ("LANG=%1", lang);
443                 putenv (strdup (s.c_str ()));
444                 s = String::compose ("LC_ALL=%1", lang);
445                 putenv (strdup (s.c_str ()));
446         }
447
448         setlocale (LC_ALL, "");
449         textdomain ("libdcpomatic2");
450
451 #if defined(DCPOMATIC_WINDOWS) || defined(DCPOMATIC_OSX)
452         bindtextdomain ("libdcpomatic2", mo_path().string().c_str());
453         bind_textdomain_codeset ("libdcpomatic2", "UTF8");
454 #endif
455
456 #ifdef DCPOMATIC_LINUX
457         bindtextdomain ("libdcpomatic2", LINUX_LOCALE_PREFIX);
458 #endif
459 }
460
461 /** Compute a digest of the first and last `size' bytes of a set of files. */
462 string
463 digest_head_tail (vector<boost::filesystem::path> files, boost::uintmax_t size)
464 {
465         boost::scoped_array<char> buffer (new char[size]);
466         Digester digester;
467
468         /* Head */
469         boost::uintmax_t to_do = size;
470         char* p = buffer.get ();
471         int i = 0;
472         while (i < int64_t (files.size()) && to_do > 0) {
473                 FILE* f = fopen_boost (files[i], "rb");
474                 if (!f) {
475                         throw OpenFileError (files[i].string(), errno, true);
476                 }
477
478                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
479                 checked_fread (p, this_time, f, files[i]);
480                 p += this_time;
481                 to_do -= this_time;
482                 fclose (f);
483
484                 ++i;
485         }
486         digester.add (buffer.get(), size - to_do);
487
488         /* Tail */
489         to_do = size;
490         p = buffer.get ();
491         i = files.size() - 1;
492         while (i >= 0 && to_do > 0) {
493                 FILE* f = fopen_boost (files[i], "rb");
494                 if (!f) {
495                         throw OpenFileError (files[i].string(), errno, true);
496                 }
497
498                 boost::uintmax_t this_time = min (to_do, boost::filesystem::file_size (files[i]));
499                 dcpomatic_fseek (f, -this_time, SEEK_END);
500                 checked_fread (p, this_time, f, files[i]);
501                 p += this_time;
502                 to_do -= this_time;
503                 fclose (f);
504
505                 --i;
506         }
507         digester.add (buffer.get(), size - to_do);
508
509         return digester.get ();
510 }
511
512 /** Round a number up to the nearest multiple of another number.
513  *  @param c Index.
514  *  @param stride Array of numbers to round, indexed by c.
515  *  @param t Multiple to round to.
516  *  @return Rounded number.
517  */
518 int
519 stride_round_up (int c, int const * stride, int t)
520 {
521         int const a = stride[c] + (t - 1);
522         return a - (a % t);
523 }
524
525 /** Trip an assert if the caller is not in the UI thread */
526 void
527 ensure_ui_thread ()
528 {
529         DCPOMATIC_ASSERT (boost::this_thread::get_id() == ui_thread);
530 }
531
532 string
533 audio_channel_name (int c)
534 {
535         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
536
537         /// TRANSLATORS: these are the names of audio channels; Lfe (sub) is the low-frequency
538         /// enhancement channel (sub-woofer).
539         string const channels[] = {
540                 _("Left"),
541                 _("Right"),
542                 _("Centre"),
543                 _("Lfe (sub)"),
544                 _("Left surround"),
545                 _("Right surround"),
546                 _("Hearing impaired"),
547                 _("Visually impaired"),
548                 _("Left centre"),
549                 _("Right centre"),
550                 _("Left rear surround"),
551                 _("Right rear surround"),
552                 _("D-BOX primary"),
553                 _("D-BOX secondary"),
554                 _("Unused"),
555                 _("Unused")
556         };
557
558         return channels[c];
559 }
560
561 string
562 short_audio_channel_name (int c)
563 {
564         DCPOMATIC_ASSERT (MAX_DCP_AUDIO_CHANNELS == 16);
565
566         /// TRANSLATORS: these are short names of audio channels; Lfe is the low-frequency
567         /// enhancement channel (sub-woofer).  HI is the hearing-impaired audio track and
568         /// VI is the visually-impaired audio track (audio describe).  DBP is the D-BOX
569         /// primary channel and DBS is the D-BOX secondary channel.
570         string const channels[] = {
571                 _("L"),
572                 _("R"),
573                 _("C"),
574                 _("Lfe"),
575                 _("Ls"),
576                 _("Rs"),
577                 _("HI"),
578                 _("VI"),
579                 _("Lc"),
580                 _("Rc"),
581                 _("BsL"),
582                 _("BsR"),
583                 _("DBP"),
584                 _("DBS"),
585                 "",
586                 ""
587         };
588
589         return channels[c];
590 }
591
592
593 bool
594 valid_image_file (boost::filesystem::path f)
595 {
596         if (boost::starts_with (f.leaf().string(), "._")) {
597                 return false;
598         }
599
600         string ext = f.extension().string();
601         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
602         return (
603                 ext == ".tif" || ext == ".tiff" || ext == ".jpg" || ext == ".jpeg" ||
604                 ext == ".png" || ext == ".bmp" || ext == ".tga" || ext == ".dpx" ||
605                 ext == ".j2c" || ext == ".j2k" || ext == ".jp2" || ext == ".exr" ||
606                 ext == ".jpf"
607                 );
608 }
609
610 bool
611 valid_sound_file (boost::filesystem::path f)
612 {
613         if (boost::starts_with (f.leaf().string(), "._")) {
614                 return false;
615         }
616
617         string ext = f.extension().string();
618         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
619         return (ext == ".wav" || ext == ".mp3" || ext == ".aif" || ext == ".aiff");
620 }
621
622 bool
623 valid_j2k_file (boost::filesystem::path f)
624 {
625         string ext = f.extension().string();
626         transform (ext.begin(), ext.end(), ext.begin(), ::tolower);
627         return (ext == ".j2k" || ext == ".j2c" || ext == ".jp2");
628 }
629
630 string
631 tidy_for_filename (string f)
632 {
633         boost::replace_if (f, boost::is_any_of ("\\/:"), '_');
634         return f;
635 }
636
637 dcp::Size
638 fit_ratio_within (float ratio, dcp::Size full_frame)
639 {
640         if (ratio < full_frame.ratio ()) {
641                 return dcp::Size (lrintf (full_frame.height * ratio), full_frame.height);
642         }
643
644         return dcp::Size (full_frame.width, lrintf (full_frame.width / ratio));
645 }
646
647 void *
648 wrapped_av_malloc (size_t s)
649 {
650         void* p = av_malloc (s);
651         if (!p) {
652                 throw bad_alloc ();
653         }
654         return p;
655 }
656
657 map<string, string>
658 split_get_request (string url)
659 {
660         enum {
661                 AWAITING_QUESTION_MARK,
662                 KEY,
663                 VALUE
664         } state = AWAITING_QUESTION_MARK;
665
666         map<string, string> r;
667         string k;
668         string v;
669         for (size_t i = 0; i < url.length(); ++i) {
670                 switch (state) {
671                 case AWAITING_QUESTION_MARK:
672                         if (url[i] == '?') {
673                                 state = KEY;
674                         }
675                         break;
676                 case KEY:
677                         if (url[i] == '=') {
678                                 v.clear ();
679                                 state = VALUE;
680                         } else {
681                                 k += url[i];
682                         }
683                         break;
684                 case VALUE:
685                         if (url[i] == '&') {
686                                 r.insert (make_pair (k, v));
687                                 k.clear ();
688                                 state = KEY;
689                         } else {
690                                 v += url[i];
691                         }
692                         break;
693                 }
694         }
695
696         if (state == VALUE) {
697                 r.insert (make_pair (k, v));
698         }
699
700         return r;
701 }
702
703 string
704 video_asset_filename (shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, optional<string> summary)
705 {
706         dcp::NameFormat::Map values;
707         values['t'] = "j2c";
708         values['r'] = raw_convert<string> (reel_index + 1);
709         values['n'] = raw_convert<string> (reel_count);
710         if (summary) {
711                 values['c'] = careful_string_filter (summary.get());
712         }
713         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
714 }
715
716 string
717 audio_asset_filename (shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, optional<string> summary)
718 {
719         dcp::NameFormat::Map values;
720         values['t'] = "pcm";
721         values['r'] = raw_convert<string> (reel_index + 1);
722         values['n'] = raw_convert<string> (reel_count);
723         if (summary) {
724                 values['c'] = careful_string_filter (summary.get());
725         }
726         return Config::instance()->dcp_asset_filename_format().get(values, "_" + asset->id() + ".mxf");
727 }
728
729 float
730 relaxed_string_to_float (string s)
731 {
732         try {
733                 boost::algorithm::replace_all (s, ",", ".");
734                 return lexical_cast<float> (s);
735         } catch (bad_lexical_cast &) {
736                 boost::algorithm::replace_all (s, ".", ",");
737                 return lexical_cast<float> (s);
738         }
739 }
740
741 string
742 careful_string_filter (string s)
743 {
744         /* Filter out `bad' characters which `may' cause problems with some systems (either for DCP name or filename).
745            There's no apparent list of what really is allowed, so this is a guess.
746            Safety first and all that.
747         */
748
749         wstring ws = boost::locale::conv::utf_to_utf<wchar_t>(s);
750
751         string out;
752         string const allowed = "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_%.+";
753         for (size_t i = 0; i < ws.size(); ++i) {
754
755                 wchar_t c = ws[i];
756
757                 /* Remove some accents */
758                 if (wstring(L"áàâ").find(c) != string::npos) {
759                         c = 'a';
760                 }
761                 if (wstring(L"éèêë").find(c) != string::npos) {
762                         c = 'e';
763                 }
764                 if (wstring(L"ö").find(c) != string::npos) {
765                         c = 'o';
766                 }
767                 if (wstring(L"ü").find(c) != string::npos) {
768                         c = 'u';
769                 }
770
771                 if (allowed.find(c) != string::npos) {
772                         out += c;
773                 }
774         }
775
776         return boost::locale::conv::utf_to_utf<char>(out);
777 }
778
779 /** @param mapped List of mapped audio channels from a Film.
780  *  @param channels Total number of channels in the Film.
781  *  @return First: number of non-LFE channels, second: number of LFE channels.
782  */
783 pair<int, int>
784 audio_channel_types (list<int> mapped, int channels)
785 {
786         int non_lfe = 0;
787         int lfe = 0;
788
789         BOOST_FOREACH (int i, mapped) {
790                 if (i >= channels) {
791                         /* This channel is mapped but is not included in the DCP */
792                         continue;
793                 }
794
795                 if (static_cast<dcp::Channel> (i) == dcp::LFE) {
796                         ++lfe;
797                 } else {
798                         ++non_lfe;
799                 }
800         }
801
802         return make_pair (non_lfe, lfe);
803 }
804
805 shared_ptr<AudioBuffers>
806 remap (shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map)
807 {
808         shared_ptr<AudioBuffers> mapped (new AudioBuffers (output_channels, input->frames()));
809         mapped->make_silent ();
810
811         for (int i = 0; i < map.input_channels(); ++i) {
812                 for (int j = 0; j < mapped->channels(); ++j) {
813                         if (map.get (i, static_cast<dcp::Channel> (j)) > 0) {
814                                 mapped->accumulate_channel (
815                                         input.get(),
816                                         i,
817                                         static_cast<dcp::Channel> (j),
818                                         map.get (i, static_cast<dcp::Channel> (j))
819                                         );
820                         }
821                 }
822         }
823
824         return mapped;
825 }
826
827 Eyes
828 increment_eyes (Eyes e)
829 {
830         if (e == EYES_LEFT) {
831                 return EYES_RIGHT;
832         }
833
834         return EYES_LEFT;
835 }
836
837 void
838 checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path)
839 {
840         size_t N = fwrite (ptr, 1, size, stream);
841         if (N != size) {
842                 if (ferror(stream)) {
843                         fclose (stream);
844                         throw FileError (String::compose("fwrite error %1", errno), path);
845                 } else {
846                         fclose (stream);
847                         throw FileError ("Unexpected short write", path);
848                 }
849         }
850 }
851
852 void
853 checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path)
854 {
855         size_t N = fread (ptr, 1, size, stream);
856         if (N != size) {
857                 if (ferror(stream)) {
858                         fclose (stream);
859                         throw FileError (String::compose("fread error %1", errno), path);
860                 } else {
861                         fclose (stream);
862                         throw FileError ("Unexpected short read", path);
863                 }
864         }
865 }
866
867 size_t
868 utf8_strlen (string s)
869 {
870         size_t const len = s.length ();
871         int N = 0;
872         for (size_t i = 0; i < len; ++i) {
873                 unsigned char c = s[i];
874                 if ((c & 0xe0) == 0xc0) {
875                         ++i;
876                 } else if ((c & 0xf0) == 0xe0) {
877                         i += 2;
878                 } else if ((c & 0xf8) == 0xf0) {
879                         i += 3;
880                 }
881                 ++N;
882         }
883         return N;
884 }
885
886 string
887 day_of_week_to_string (boost::gregorian::greg_weekday d)
888 {
889         switch (d.as_enum()) {
890         case boost::date_time::Sunday:
891                 return _("Sunday");
892         case boost::date_time::Monday:
893                 return _("Monday");
894         case boost::date_time::Tuesday:
895                 return _("Tuesday");
896         case boost::date_time::Wednesday:
897                 return _("Wednesday");
898         case boost::date_time::Thursday:
899                 return _("Thursday");
900         case boost::date_time::Friday:
901                 return _("Friday");
902         case boost::date_time::Saturday:
903                 return _("Saturday");
904         }
905
906         return d.as_long_string ();
907 }
908
909 /** @param size Size of picture that the subtitle will be overlaid onto */
910 void
911 emit_subtitle_image (ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, shared_ptr<TextDecoder> decoder)
912 {
913         /* XXX: this is rather inefficient; decoding the image just to get its size */
914         FFmpegImageProxy proxy (sub.png_image());
915         shared_ptr<Image> image = proxy.image().first;
916         /* set up rect with height and width */
917         dcpomatic::Rect<double> rect(0, 0, image->size().width / double(size.width), image->size().height / double(size.height));
918
919         /* add in position */
920
921         switch (sub.h_align()) {
922         case dcp::HALIGN_LEFT:
923                 rect.x += sub.h_position();
924                 break;
925         case dcp::HALIGN_CENTER:
926                 rect.x += 0.5 + sub.h_position() - rect.width / 2;
927                 break;
928         case dcp::HALIGN_RIGHT:
929                 rect.x += 1 - sub.h_position() - rect.width;
930                 break;
931         }
932
933         switch (sub.v_align()) {
934         case dcp::VALIGN_TOP:
935                 rect.y += sub.v_position();
936                 break;
937         case dcp::VALIGN_CENTER:
938                 rect.y += 0.5 + sub.v_position() - rect.height / 2;
939                 break;
940         case dcp::VALIGN_BOTTOM:
941                 rect.y += 1 - sub.v_position() - rect.height;
942                 break;
943         }
944
945         decoder->emit_bitmap (period, image, rect);
946 }
947
948 #ifdef DCPOMATIC_VARIANT_SWAROOP
949
950 /* Make up a key from the machine UUID */
951 dcp::Data
952 key_from_uuid ()
953 {
954         dcp::Data key (dcpomatic::crypto_key_length());
955         memset (key.data().get(), 0, key.size());
956         string const magic = command_and_read ("dcpomatic2_uuid");
957         strncpy ((char *) key.data().get(), magic.c_str(), dcpomatic::crypto_key_length());
958         return key;
959 }
960
961 /* swaroop chain file format:
962  *
963  *  0 [int16_t] IV length
964  *  2 [int16_t] cert #1 length, or 0 for none
965  *  4 [int16_t] cert #2 length, or 0 for none
966  *  6 [int16_t] cert #3 length, or 0 for none
967  *  8 [int16_t] cert #4 length, or 0 for none
968  * 10 [int16_t] cert #5 length, or 0 for none
969  * 12 [int16_t] cert #6 length, or 0 for none
970  * 14 [int16_t] cert #7 length, or 0 for none
971  * 16 [int16_t] cert #8 length, or 0 for none
972  * 16 [int16_t] private key length
973  * 20 IV
974  *    cert #1
975  *    cert #2
976  *    cert #3
977  *    cert #4
978  *    cert #5
979  *    cert #6
980  *    cert #7
981  *    cert #8
982  *    private key
983  */
984
985 struct __attribute__ ((packed)) Header_ {
986         int16_t iv_length;
987         int16_t cert_length[8];
988         int16_t private_key_length;
989 };
990
991 typedef struct Header_ Header;
992
993 shared_ptr<dcp::CertificateChain>
994 read_swaroop_chain (boost::filesystem::path path)
995 {
996         dcp::Data data (path);
997         Header* header = (Header *) data.data().get();
998         uint8_t* p = data.data().get() + sizeof(Header);
999
1000         dcp::Data iv (p, header->iv_length);
1001         p += iv.size();
1002
1003         shared_ptr<dcp::CertificateChain> cc (new dcp::CertificateChain());
1004         for (int i = 0; i < 8; ++i) {
1005                 if (header->cert_length[i] == 0) {
1006                         break;
1007                 }
1008                 dcp::Data c(p, header->cert_length[i]);
1009                 p += c.size();
1010                 cc->add (dcp::Certificate(dcpomatic::decrypt(c, key_from_uuid(), iv)));
1011         }
1012
1013         dcp::Data k (p, header->private_key_length);
1014         cc->set_key (dcpomatic::decrypt(k, key_from_uuid(), iv));
1015         return cc;
1016 }
1017
1018 void
1019 write_swaroop_chain (shared_ptr<const dcp::CertificateChain> chain, boost::filesystem::path output)
1020 {
1021         scoped_array<uint8_t> buffer (new uint8_t[65536]);
1022         Header* header = (Header *) buffer.get();
1023         memset (header, 0, sizeof(Header));
1024         uint8_t* p = buffer.get() + sizeof(Header);
1025
1026         dcp::Data iv = dcpomatic::random_iv ();
1027         header->iv_length = iv.size ();
1028         memcpy (p, iv.data().get(), iv.size());
1029         p += iv.size();
1030
1031         int N = 0;
1032         BOOST_FOREACH (dcp::Certificate i, chain->root_to_leaf()) {
1033                 dcp::Data e = dcpomatic::encrypt (i.certificate(true), key_from_uuid(), iv);
1034                 memcpy (p, e.data().get(), e.size());
1035                 p += e.size();
1036                 DCPOMATIC_ASSERT (N < 8);
1037                 header->cert_length[N] = e.size ();
1038                 ++N;
1039         }
1040
1041         dcp::Data k = dcpomatic::encrypt (chain->key().get(), key_from_uuid(), iv);
1042         memcpy (p, k.data().get(), k.size());
1043         p += k.size();
1044         header->private_key_length = k.size ();
1045
1046         FILE* f = fopen_boost (output, "wb");
1047         checked_fwrite (buffer.get(), p - buffer.get(), f, output);
1048         fclose (f);
1049 }
1050
1051 #endif