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 "dcpomatic_time.h"
  24 #include "position.h"
  25 #include "rect.h"
  26 #include <dcp/util.h>
  27 #include <boost/shared_ptr.hpp>
  28 #include <vector>
  29 #include <stdint.h>
  30
  31 class Content;
  32 class VideoContent;
  33 class AudioContent;
  34 class SubtitleContent;
  35 class FFmpegContent;
  36 class AudioBuffers;
  37
  38 namespace cxml {
  39         class Node;
  40 }
  41
  42 namespace xmlpp {
  43         class Node;
  44 }
  45
  46 /** The version number of the protocol used to communicate
  47  *  with servers.  Intended to be bumped when incompatibilities
  48  *  are introduced.  v2 uses 64+n
  49  */
  50 #define SERVER_LINK_VERSION (64+0)
  51
  52 typedef std::vector<boost::shared_ptr<Content> > ContentList;
  53 typedef std::vector<boost::shared_ptr<VideoContent> > VideoContentList;
  54 typedef std::vector<boost::shared_ptr<AudioContent> > AudioContentList;
  55 typedef std::vector<boost::shared_ptr<SubtitleContent> > SubtitleContentList;
  56 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
  57
  58 typedef int64_t VideoFrame;
  59 typedef int64_t AudioFrame;
  60
  61 enum VideoFrameType
  62 {
  63         VIDEO_FRAME_TYPE_2D,
  64         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
  65         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
  66         VIDEO_FRAME_TYPE_3D_ALTERNATE,
  67         /** This content is all the left frames of some 3D */
  68         VIDEO_FRAME_TYPE_3D_LEFT,
  69         /** This content is all the right frames of some 3D */
  70         VIDEO_FRAME_TYPE_3D_RIGHT
  71 };
  72
  73 enum Eyes
  74 {
  75         EYES_BOTH,
  76         EYES_LEFT,
  77         EYES_RIGHT,
  78         EYES_COUNT
  79 };
  80
  81 enum Part
  82 {
  83         PART_LEFT_HALF,
  84         PART_RIGHT_HALF,
  85         PART_TOP_HALF,
  86         PART_BOTTOM_HALF,
  87         PART_WHOLE
  88 };
  89
  90 /** @struct Crop
  91  *  @brief A description of the crop of an image or video.
  92  */
  93 struct Crop
  94 {
  95         Crop () : left (0), right (0), top (0), bottom (0) {}
  96         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  97         Crop (boost::shared_ptr<cxml::Node>);
  98
  99         /** Number of pixels to remove from the left-hand side */
 100         int left;
 101         /** Number of pixels to remove from the right-hand side */
 102         int right;
 103         /** Number of pixels to remove from the top */
 104         int top;
 105         /** Number of pixels to remove from the bottom */
 106         int bottom;
 107
 108         dcp::Size apply (dcp::Size s, int minimum = 4) const {
 109                 s.width -= left + right;
 110                 s.height -= top + bottom;
 111
 112                 if (s.width < minimum) {
 113                         s.width = minimum;
 114                 }
 115
 116                 if (s.height < minimum) {
 117                         s.height = minimum;
 118                 }
 119
 120                 return s;
 121         }
 122
 123         void as_xml (xmlpp::Node *) const;
 124 };
 125
 126 struct CPLSummary
 127 {
 128         CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
 129                 : dcp_directory (d)
 130                 , cpl_id (i)
 131                 , cpl_annotation_text (a)
 132                 , cpl_file (f)
 133         {}
 134
 135         std::string dcp_directory;
 136         std::string cpl_id;
 137         std::string cpl_annotation_text;
 138         boost::filesystem::path cpl_file;
 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