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