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 namespace cxml {
  36         class Node;
  37 }
  38
  39 namespace xmlpp {
  40         class Node;
  41 }
  42
  43 /** The version number of the protocol used to communicate
  44  *  with servers.  Intended to be bumped when incompatibilities
  45  *  are introduced.
  46  */
  47 #define SERVER_LINK_VERSION 2
  48
  49 typedef int64_t Time;
  50 #define TIME_MAX INT64_MAX
  51 #define TIME_HZ  ((Time) 96000)
  52 typedef int64_t OutputAudioFrame;
  53 typedef int     OutputVideoFrame;
  54 typedef std::vector<boost::shared_ptr<Content> > ContentList;
  55 typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
  56 typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
  57 typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
  58 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
  59
  60 template<class T>
  61 struct TimedAudioBuffers
  62 {
  63         TimedAudioBuffers ()
  64                 : time (0)
  65         {}
  66
  67         TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, T t)
  68                 : audio (a)
  69                 , time (t)
  70         {}
  71
  72         boost::shared_ptr<AudioBuffers> audio;
  73         T time;
  74 };
  75
  76 enum VideoFrameType
  77 {
  78         VIDEO_FRAME_TYPE_2D,
  79         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
  80         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
  81         VIDEO_FRAME_TYPE_3D_ALTERNATE,
  82         /** This content is all the left frames of some 3D */
  83         VIDEO_FRAME_TYPE_3D_LEFT,
  84         /** This content is all the right frames of some 3D */
  85         VIDEO_FRAME_TYPE_3D_RIGHT
  86 };
  87
  88 enum Eyes
  89 {
  90         EYES_BOTH,
  91         EYES_LEFT,
  92         EYES_RIGHT,
  93         EYES_COUNT
  94 };
  95
  96 enum Part
  97 {
  98         PART_LEFT_HALF,
  99         PART_RIGHT_HALF,
 100         PART_TOP_HALF,
 101         PART_BOTTOM_HALF,
 102         PART_WHOLE
 103 };
 104
 105 /** @struct Crop
 106  *  @brief A description of the crop of an image or video.
 107  */
 108 struct Crop
 109 {
 110         Crop () : left (0), right (0), top (0), bottom (0) {}
 111         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
 112         Crop (boost::shared_ptr<cxml::Node>);
 113
 114         /** Number of pixels to remove from the left-hand side */
 115         int left;
 116         /** Number of pixels to remove from the right-hand side */
 117         int right;
 118         /** Number of pixels to remove from the top */
 119         int top;
 120         /** Number of pixels to remove from the bottom */
 121         int bottom;
 122
 123         libdcp::Size apply (libdcp::Size s, int minimum = 4) const {
 124                 s.width -= left + right;
 125                 s.height -= top + bottom;
 126
 127                 if (s.width < minimum) {
 128                         s.width = minimum;
 129                 }
 130
 131                 if (s.height < minimum) {
 132                         s.height = minimum;
 133                 }
 134
 135                 return s;
 136         }
 137
 138         void as_xml (xmlpp::Node *) const;
 139 };
 140
 141 extern bool operator== (Crop const & a, Crop const & b);
 142 extern bool operator!= (Crop const & a, Crop const & b);
 143
 144 enum Resolution {
 145         RESOLUTION_2K,
 146         RESOLUTION_4K
 147 };
 148
 149 std::string resolution_to_string (Resolution);
 150 Resolution string_to_resolution (std::string);
 151
 152 #endif