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