X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Flib%2Futil.h;h=c62b98df65c140cfcedc90d13cbfca36e45dd181;hb=c66c2f0cc3371a26edb6cf2198bcc3fc45b26079;hp=9b201a50e7ab6cf92e59c2233809d1828d0b5ca7;hpb=ea910e250a0fb3b0ad3ce0cf32dd27b24c17cd1d;p=dcpomatic.git diff --git a/src/lib/util.h b/src/lib/util.h index 9b201a50e..c62b98df6 100644 --- a/src/lib/util.h +++ b/src/lib/util.h @@ -1,182 +1,153 @@ /* - Copyright (C) 2012 Carl Hetherington - Copyright (C) 2000-2007 Paul Davis + Copyright (C) 2012-2020 Carl Hetherington - This program is free software; you can redistribute it and/or modify + This file is part of DCP-o-matic. + + DCP-o-matic is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - This program is distributed in the hope that it will be useful, + DCP-o-matic is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License - along with this program; if not, write to the Free Software - Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA. + along with DCP-o-matic. If not, see . */ + /** @file src/util.h * @brief Some utility functions and classes. */ + #ifndef DCPOMATIC_UTIL_H #define DCPOMATIC_UTIL_H -#include -#include -#include -#include + +#include "audio_mapping.h" +#include "dcpomatic_time.h" +#include "pixel_quanta.h" +#include "types.h" +#include +#include +#include +#include #include #include -#include -extern "C" { -#include -#include -} -#include "compose.hpp" -#include "types.h" -#include "video_content.h" - -#ifdef DCPOMATIC_DEBUG -#define TIMING(...) _film->log()->microsecond_log (String::compose (__VA_ARGS__), Log::TIMING); -#else -#define TIMING(...) -#endif +#include +#include +#include +#include #undef check -/** The maximum number of audio channels that we can cope with */ -#define MAX_AUDIO_CHANNELS 6 - -#define DCPOMATIC_HELLO "Boys, you gotta learn not to talk to nuns that way" -namespace libdcp { - class Signer; +namespace dcp { + class PictureAsset; + class SoundAsset; + class SubtitleAsset; } -class Job; +/** The maximum number of audio channels that we can have in a DCP */ +#define MAX_DCP_AUDIO_CHANNELS 16 +/** Message broadcast to find possible encoding servers */ +#define DCPOMATIC_HELLO "I mean really, Ray, it's used." +/** Number of films to keep in history */ +#define HISTORY_SIZE 10 +#define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com") +#define TEXT_FONT_ID "font" +/** Largest KDM size (in bytes) that will be accepted */ +#define MAX_KDM_SIZE (256 * 1024) +/** Number of lines that closed caption viewers will display */ +#define MAX_CLOSED_CAPTION_LINES 3 +/** Maximum line length of closed caption viewers, according to SMPTE Bv2.1 */ +#define MAX_CLOSED_CAPTION_LENGTH 32 +/** Maximum size of a subtitle / closed caption MXF in bytes, according to SMPTE Bv2.1 */ +#define MAX_TEXT_MXF_SIZE (115 * 1024 * 1024) +#define MAX_TEXT_MXF_SIZE_TEXT "115MB" +/** Maximum size of a font file, in bytes */ +#define MAX_FONT_FILE_SIZE (640 * 1024) +#define MAX_FONT_FILE_SIZE_TEXT "640KB" +/** Maximum size of the XML part of a closed caption file, according to SMPTE Bv2.1 */ +#define MAX_CLOSED_CAPTION_XML_SIZE (256 * 1024) +#define MAX_CLOSED_CAPTION_XML_SIZE_TEXT "256KB" +#define CERTIFICATE_VALIDITY_PERIOD (10 * 365) + +extern std::string program_name; +extern bool is_batch_converter; + +struct AVSubtitle; +class AudioBuffers; +class TextDecoder; extern std::string seconds_to_hms (int); +extern std::string time_to_hmsf (dcpomatic::DCPTime time, Frame rate); extern std::string seconds_to_approximate_hms (int); -extern void stacktrace (std::ostream &, int); -extern std::string dependency_version_summary (); extern double seconds (struct timeval); extern void dcpomatic_setup (); +extern void dcpomatic_setup_path_encoding (); extern void dcpomatic_setup_gettext_i18n (std::string); -extern std::vector split_at_spaces_considering_quotes (std::string); -extern std::string md5_digest (std::vector, boost::shared_ptr); -extern std::string md5_digest (void const *, int); +extern std::string digest_head_tail (std::vector, boost::uintmax_t size); +extern std::string simple_digest (std::vector paths); extern void ensure_ui_thread (); extern std::string audio_channel_name (int); +extern std::string short_audio_channel_name (int); extern bool valid_image_file (boost::filesystem::path); +extern bool valid_sound_file (boost::filesystem::path); +extern bool valid_j2k_file (boost::filesystem::path); #ifdef DCPOMATIC_WINDOWS extern boost::filesystem::path mo_path (); #endif extern std::string tidy_for_filename (std::string); -extern boost::shared_ptr make_signer (); -extern libdcp::Size fit_ratio_within (float ratio, libdcp::Size); - -struct FrameRateChange +extern dcp::Size fit_ratio_within (float ratio, dcp::Size); +extern void set_backtrace_file (boost::filesystem::path); +extern std::map split_get_request (std::string url); +extern std::string video_asset_filename (std::shared_ptr asset, int reel_index, int reel_count, boost::optional content_summary); +extern std::string audio_asset_filename (std::shared_ptr asset, int reel_index, int reel_count, boost::optional content_summary); +extern std::string subtitle_asset_filename (std::shared_ptr asset, int reel_index, int reel_count, boost::optional content_summary, std::string extension); +extern std::string atmos_asset_filename (std::shared_ptr asset, int reel_index, int reel_count, boost::optional content_summary); +extern float relaxed_string_to_float (std::string); +extern std::string careful_string_filter (std::string); +extern std::pair audio_channel_types (std::list mapped, int channels); +extern std::shared_ptr remap (std::shared_ptr input, int output_channels, AudioMapping map); +extern Eyes increment_eyes (Eyes e); +extern size_t utf8_strlen (std::string s); +extern std::string day_of_week_to_string (boost::gregorian::greg_weekday d); +extern void emit_subtitle_image (dcpomatic::ContentTimePeriod period, dcp::SubtitleImage sub, dcp::Size size, std::shared_ptr decoder); +extern bool show_jobs_on_console (bool progress); +extern void copy_in_bits (boost::filesystem::path from, boost::filesystem::path to, std::function); +extern dcp::Size scale_for_display (dcp::Size s, dcp::Size display_container, dcp::Size film_container, PixelQuanta quanta); +extern dcp::DecryptedKDM decrypt_kdm_with_helpful_error (dcp::EncryptedKDM kdm); +extern boost::filesystem::path default_font_file (); +extern std::string to_upper (std::string s); +extern void start_of_thread (std::string name); +extern void capture_asdcp_logs (); +extern std::string error_details(boost::system::error_code ec); + +template +std::list +vector_to_list (std::vector v) { - FrameRateChange (float, int); - - /** @return factor by which to multiply a source frame rate - to get the effective rate after any skip or repeat has happened. - */ - float factor () const { - if (skip) { - return 0.5; - } - - return repeat; + std::list l; + for (auto& i: v) { + l.push_back (i); } + return l; +} - /** true to skip every other frame */ - bool skip; - /** number of times to use each frame (e.g. 1 is normal, 2 means repeat each frame once, and so on) */ - int repeat; - /** true if this DCP will run its video faster or slower than the source - * without taking into account `repeat' nor `skip'. - * (e.g. change_speed will be true if - * source is 29.97fps, DCP is 30fps - * source is 14.50fps, DCP is 30fps - * but not if - * source is 15.00fps, DCP is 30fps - * source is 12.50fps, DCP is 25fps) - */ - bool change_speed; - - /** Amount by which the video is being sped-up in the DCP; e.g. for a - * 24fps source in a 25fps DCP this would be 25/24. - */ - float speed_up; - - std::string description; -}; - -extern int dcp_audio_frame_rate (int); -extern int stride_round_up (int, int const *, int); -extern std::multimap read_key_value (std::istream& s); -extern int get_required_int (std::multimap const & kv, std::string k); -extern float get_required_float (std::multimap const & kv, std::string k); -extern std::string get_required_string (std::multimap const & kv, std::string k); -extern int get_optional_int (std::multimap const & kv, std::string k); -extern std::string get_optional_string (std::multimap const & kv, std::string k); - -/** @class Socket - * @brief A class to wrap a boost::asio::ip::tcp::socket with some things - * that are useful for DCP-o-matic. - * - * This class wraps some things that I could not work out how to do with boost; - * most notably, sync read/write calls with timeouts. - */ -class Socket +template +std::vector +list_to_vector (std::list v) { -public: - Socket (int timeout = 30); - ~Socket (); - - /** @return Our underlying socket */ - boost::asio::ip::tcp::socket& socket () { - return _socket; + std::vector l; + for (auto& i: v) { + l.push_back (i); } - - void connect (boost::asio::ip::tcp::endpoint); - void accept (int); - - void write (uint32_t n); - void write (uint8_t const * data, int size); - - void read (uint8_t* data, int size); - uint32_t read_uint32 (); - -private: - void check (); - - Socket (Socket const &); - - boost::asio::io_service _io_service; - boost::asio::deadline_timer _deadline; - boost::asio::ip::tcp::socket _socket; - boost::asio::ip::tcp::acceptor* _acceptor; - int _timeout; -}; - -extern int64_t video_frames_to_audio_frames (VideoContent::Frame v, float audio_sample_rate, float frames_per_second); - -class LocaleGuard -{ -public: - LocaleGuard (); - ~LocaleGuard (); - -private: - char* _old; -}; - + return l; +} #endif -