src/lib/util.h

   1 /*
   2     Copyright (C) 2012-2016 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/util.h
  22  *  @brief Some utility functions and classes.
  23  */
  24
  25 #ifndef DCPOMATIC_UTIL_H
  26 #define DCPOMATIC_UTIL_H
  27
  28 #include "types.h"
  29 #include "dcpomatic_time.h"
  30 #include <dcp/util.h>
  31 #include <boost/shared_ptr.hpp>
  32 #include <boost/optional.hpp>
  33 #include <boost/filesystem.hpp>
  34 #include <string>
  35 #include <map>
  36 #include <vector>
  37
  38 #undef check
  39
  40 namespace dcp {
  41         class PictureAsset;
  42         class SoundAsset;
  43 }
  44
  45 /** The maximum number of audio channels that we can have in a DCP */
  46 #define MAX_DCP_AUDIO_CHANNELS 16
  47 /** Message broadcast to find possible encoding servers */
  48 #define DCPOMATIC_HELLO "I mean really, Ray, it's used."
  49 /** Number of films to keep in history */
  50 #define HISTORY_SIZE 10
  51 #define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
  52 #define TEXT_FONT_ID "font"
  53 /** Largest KDM size (in bytes) that will be accepted */
  54 #define MAX_KDM_SIZE (256 * 1024)
  55
  56 extern std::string program_name;
  57
  58 struct AVSubtitle;
  59
  60 extern std::string seconds_to_hms (int);
  61 extern std::string seconds_to_approximate_hms (int);
  62 extern double seconds (struct timeval);
  63 extern void dcpomatic_setup ();
  64 extern void dcpomatic_setup_path_encoding ();
  65 extern void dcpomatic_setup_gettext_i18n (std::string);
  66 extern std::string digest_head_tail (std::vector<boost::filesystem::path>, boost::uintmax_t size);
  67 extern void ensure_ui_thread ();
  68 extern std::string audio_channel_name (int);
  69 extern std::string short_audio_channel_name (int);
  70 extern bool valid_image_file (boost::filesystem::path);
  71 extern bool valid_sound_file (boost::filesystem::path);
  72 extern bool valid_j2k_file (boost::filesystem::path);
  73 #ifdef DCPOMATIC_WINDOWS
  74 extern boost::filesystem::path mo_path ();
  75 #endif
  76 extern std::string tidy_for_filename (std::string);
  77 extern dcp::Size fit_ratio_within (float ratio, dcp::Size);
  78 extern int stride_round_up (int, int const *, int);
  79 extern void* wrapped_av_malloc (size_t);
  80 extern void set_backtrace_file (boost::filesystem::path);
  81 extern std::map<std::string, std::string> split_get_request (std::string url);
  82 extern std::string video_asset_filename (boost::shared_ptr<dcp::PictureAsset> asset, int reel_index, int reel_count, boost::optional<std::string> content_summary);
  83 extern std::string audio_asset_filename (boost::shared_ptr<dcp::SoundAsset> asset, int reel_index, int reel_count, boost::optional<std::string> content_summary);
  84 extern float relaxed_string_to_float (std::string);
  85 extern std::string careful_string_filter (std::string);
  86 extern std::pair<int, int> audio_channel_types (std::list<int> mapped, int channels);
  87
  88 #endif