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