src/lib/types.h

   1 /*
   2     Copyright (C) 2013 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 #ifndef DCPOMATIC_TYPES_H
  21 #define DCPOMATIC_TYPES_H
  22
  23 #include <vector>
  24 #include <stdint.h>
  25 #include <boost/shared_ptr.hpp>
  26 #include <libdcp/util.h>
  27
  28 class Content;
  29 class VideoContent;
  30 class AudioContent;
  31 class SubtitleContent;
  32 class FFmpegContent;
  33 class AudioBuffers;
  34
  35 /** The version number of the protocol used to communicate
  36  *  with servers.  Intended to be bumped when incompatibilities
  37  *  are introduced.
  38  */
  39 #define SERVER_LINK_VERSION 1
  40
  41 typedef int64_t Time;
  42 #define TIME_MAX INT64_MAX
  43 #define TIME_HZ  ((Time) 96000)
  44 typedef int64_t OutputAudioFrame;
  45 typedef int     OutputVideoFrame;
  46 typedef std::vector<boost::shared_ptr<Content> > ContentList;
  47 typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
  48 typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
  49 typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
  50 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
  51
  52 template<class T>
  53 struct TimedAudioBuffers
  54 {
  55         TimedAudioBuffers ()
  56                 : time (0)
  57         {}
  58
  59         TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, T t)
  60                 : audio (a)
  61                 , time (t)
  62         {}
  63
  64         boost::shared_ptr<AudioBuffers> audio;
  65         T time;
  66 };
  67
  68 enum VideoFrameType
  69 {
  70         VIDEO_FRAME_TYPE_2D,
  71         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
  72         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM
  73 };
  74
  75 enum Eyes
  76 {
  77         EYES_BOTH,
  78         EYES_LEFT,
  79         EYES_RIGHT,
  80         EYES_COUNT
  81 };
  82
  83 /** @struct Crop
  84  *  @brief A description of the crop of an image or video.
  85  */
  86 struct Crop
  87 {
  88         Crop () : left (0), right (0), top (0), bottom (0) {}
  89         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  90
  91         /** Number of pixels to remove from the left-hand side */
  92         int left;
  93         /** Number of pixels to remove from the right-hand side */
  94         int right;
  95         /** Number of pixels to remove from the top */
  96         int top;
  97         /** Number of pixels to remove from the bottom */
  98         int bottom;
  99
 100         libdcp::Size apply (libdcp::Size s, int minimum = 4) const {
 101                 s.width -= left + right;
 102                 s.height -= top + bottom;
 103
 104                 if (s.width < minimum) {
 105                         s.width = minimum;
 106                 }
 107
 108                 if (s.height < minimum) {
 109                         s.height = minimum;
 110                 }
 111
 112                 return s;
 113         }
 114 };
 115
 116 extern bool operator== (Crop const & a, Crop const & b);
 117 extern bool operator!= (Crop const & a, Crop const & b);
 118
 119 enum Resolution {
 120         RESOLUTION_2K,
 121         RESOLUTION_4K
 122 };
 123
 124 std::string resolution_to_string (Resolution);
 125 Resolution string_to_resolution (std::string);
 126
 127 #endif