src/lib/util.h

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   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.
   8
   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.
  13
  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.
  17
  18 */
  19
  20 /** @file src/util.h
  21  *  @brief Some utility functions and classes.
  22  */
  23
  24 #ifndef DCPOMATIC_UTIL_H
  25 #define DCPOMATIC_UTIL_H
  26
  27 #include "types.h"
  28 #include "dcpomatic_time.h"
  29 #include <dcp/util.h>
  30 extern "C" {
  31 #include <libavcodec/avcodec.h>
  32 }
  33 #include <boost/shared_ptr.hpp>
  34 #include <boost/optional.hpp>
  35 #include <boost/filesystem.hpp>
  36 #include <string>
  37 #include <vector>
  38
  39 #undef check
  40
  41 namespace dcp {
  42         class PictureAsset;
  43         class SoundAsset;
  44         class SubtitleAsset;
  45 }
  46
  47 /** The maximum number of audio channels that we can have in a DCP */
  48 #define MAX_DCP_AUDIO_CHANNELS 12
  49 /** Message broadcast to find possible encoding servers */
  50 #define DCPOMATIC_HELLO "I mean really, Ray, it's used."
  51 /** Number of films to keep in history */
  52 #define HISTORY_SIZE 10
  53 #define REPORT_PROBLEM _("Please report this problem by using Help -> Report a problem or via email to carl@dcpomatic.com")
  54
  55 extern std::string program_name;
  56
  57 class Job;
  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 md5_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 bool valid_image_file (boost::filesystem::path);
  70 extern bool valid_j2k_file (boost::filesystem::path);
  71 #ifdef DCPOMATIC_WINDOWS
  72 extern boost::filesystem::path mo_path ();
  73 #endif
  74 extern std::string tidy_for_filename (std::string);
  75 extern dcp::Size fit_ratio_within (float ratio, dcp::Size);
  76 extern int stride_round_up (int, int const *, int);
  77 extern void* wrapped_av_malloc (size_t);
  78
  79 class FFmpegSubtitlePeriod
  80 {
  81 public:
  82         FFmpegSubtitlePeriod (ContentTime f)
  83                 : from (f)
  84         {}
  85
  86         FFmpegSubtitlePeriod (ContentTime f, ContentTime t)
  87                 : from (f)
  88                 , to (t)
  89         {}
  90
  91         ContentTime from;
  92         boost::optional<ContentTime> to;
  93 };
  94
  95 extern FFmpegSubtitlePeriod subtitle_period (AVSubtitle const &);
  96 extern void set_backtrace_file (boost::filesystem::path);
  97 extern std::map<std::string, std::string> split_get_request (std::string url);
  98 extern std::string video_asset_filename (boost::shared_ptr<dcp::PictureAsset> asset);
  99 extern std::string audio_asset_filename (boost::shared_ptr<dcp::SoundAsset> asset);
 100
 101 #endif