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/>.
22 * @brief Some utility functions and classes.
25 #ifndef DCPOMATIC_UTIL_H
26 #define DCPOMATIC_UTIL_H
29 #include "dcpomatic_time.h"
30 #include "audio_mapping.h"
32 #include <boost/shared_ptr.hpp>
33 #include <boost/optional.hpp>
34 #include <boost/filesystem.hpp>
35 #include <boost/date_time/gregorian/gregorian.hpp>
48 #define M_PI (3.14159265358979323846)
51 /** The maximum number of audio channels that we can have in a DCP */
52 #define MAX_DCP_AUDIO_CHANNELS 16
53 /** Message broadcast to find possible encoding servers */
54 #define DCPOMATIC_HELLO "I mean really, Ray, it's used."
55 /** Number of films to keep in history */
56 #define HISTORY_SIZE 10
57 #define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
58 #define TEXT_FONT_ID "font"
59 /** Largest KDM size (in bytes) that will be accepted */
60 #define MAX_KDM_SIZE (256 * 1024)
61 /** Number of lines that closed caption viewers will display */
62 #define CLOSED_CAPTION_LINES 3
63 /** Maximum line length of closed caption viewers */
64 #define CLOSED_CAPTION_LENGTH 30
66 extern std::string program_name;
67 extern bool is_batch_converter;
72 extern std::string seconds_to_hms (int);
73 extern std::string time_to_hmsf (DCPTime time, Frame rate);
74 extern std::string seconds_to_approximate_hms (int);
75 extern double seconds (struct timeval);
76 extern void dcpomatic_setup ();
77 extern void dcpomatic_setup_path_encoding ();
78 extern void dcpomatic_setup_gettext_i18n (std::string);
79 extern std::string digest_head_tail (std::vector<boost::filesystem::path>, boost::uintmax_t size);
80 extern void ensure_ui_thread ();
81 extern std::string audio_channel_name (int);
82 extern std::string short_audio_channel_name (int);
83 extern bool valid_image_file (boost::filesystem::path);
84 extern bool valid_sound_file (boost::filesystem::path);
85 extern bool valid_j2k_file (boost::filesystem::path);
86 #ifdef DCPOMATIC_WINDOWS
87 extern boost::filesystem::path mo_path ();
89 extern std::string tidy_for_filename (std::string);
90 extern dcp::Size fit_ratio_within (float ratio, dcp::Size);
91 extern int stride_round_up (int, int const *, int);
92 extern void* wrapped_av_malloc (size_t);
93 extern void set_backtrace_file (boost::filesystem::path);
94 extern std::map<std::string, std::string> split_get_request (std::string url);
95 extern std::string video_asset_filename (boost::shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, boost::optional<std::string> content_summary);
96 extern std::string audio_asset_filename (boost::shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, boost::optional<std::string> content_summary);
97 extern float relaxed_string_to_float (std::string);
98 extern std::string careful_string_filter (std::string);
99 extern std::pair<int, int> audio_channel_types (std::list<int> mapped, int channels);
100 extern boost::shared_ptr<AudioBuffers> remap (boost::shared_ptr<const AudioBuffers> input, int output_channels, AudioMapping map);
101 extern Eyes increment_eyes (Eyes e);
102 extern void checked_fread (void* ptr, size_t size, FILE* stream, boost::filesystem::path path);
103 extern void checked_fwrite (void const * ptr, size_t size, FILE* stream, boost::filesystem::path path);
104 extern size_t utf8_strlen (std::string s);
105 extern std::string day_of_week_to_string (boost::gregorian::greg_weekday d);
106 #ifdef DCPOMATIC_VARIANT_SWAROOP
107 extern boost::shared_ptr<dcp::CertificateChain> read_swaroop_chain (boost::filesystem::path path);
108 extern void write_swaroop_chain (boost::shared_ptr<const dcp::CertificateChain> chain, boost::filesystem::path output);