src/lib/types.h

   1 /*
   2     Copyright (C) 2013-2016 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   6     DCP-o-matic is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     DCP-o-matic is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
  18
  19 */
  20
  21 #ifndef DCPOMATIC_TYPES_H
  22 #define DCPOMATIC_TYPES_H
  23
  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
  37 namespace cxml {
  38         class Node;
  39 }
  40
  41 namespace xmlpp {
  42         class Node;
  43 }
  44
  45 /** The version number of the protocol used to communicate
  46  *  with servers.  Intended to be bumped when incompatibilities
  47  *  are introduced.  v2 uses 64+n
  48  */
  49 #define SERVER_LINK_VERSION (64+0)
  50
  51 typedef std::vector<boost::shared_ptr<Content> > ContentList;
  52 typedef std::vector<boost::shared_ptr<FFmpegContent> > FFmpegContentList;
  53
  54 typedef int64_t Frame;
  55
  56 enum VideoFrameType
  57 {
  58         VIDEO_FRAME_TYPE_2D,
  59         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
  60         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
  61         VIDEO_FRAME_TYPE_3D_ALTERNATE,
  62         /** This content is all the left frames of some 3D */
  63         VIDEO_FRAME_TYPE_3D_LEFT,
  64         /** This content is all the right frames of some 3D */
  65         VIDEO_FRAME_TYPE_3D_RIGHT
  66 };
  67
  68 enum Eyes
  69 {
  70         EYES_BOTH,
  71         EYES_LEFT,
  72         EYES_RIGHT,
  73         EYES_COUNT
  74 };
  75
  76 enum Part
  77 {
  78         PART_LEFT_HALF,
  79         PART_RIGHT_HALF,
  80         PART_TOP_HALF,
  81         PART_BOTTOM_HALF,
  82         PART_WHOLE
  83 };
  84
  85 enum ReelType
  86 {
  87         REELTYPE_SINGLE,
  88         REELTYPE_BY_VIDEO_CONTENT,
  89         REELTYPE_BY_LENGTH
  90 };
  91
  92 /** @struct Crop
  93  *  @brief A description of the crop of an image or video.
  94  */
  95 struct Crop
  96 {
  97         Crop () : left (0), right (0), top (0), bottom (0) {}
  98         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  99         Crop (boost::shared_ptr<cxml::Node>);
 100
 101         /** Number of pixels to remove from the left-hand side */
 102         int left;
 103         /** Number of pixels to remove from the right-hand side */
 104         int right;
 105         /** Number of pixels to remove from the top */
 106         int top;
 107         /** Number of pixels to remove from the bottom */
 108         int bottom;
 109
 110         dcp::Size apply (dcp::Size s, int minimum = 4) const {
 111                 s.width -= left + right;
 112                 s.height -= top + bottom;
 113
 114                 if (s.width < minimum) {
 115                         s.width = minimum;
 116                 }
 117
 118                 if (s.height < minimum) {
 119                         s.height = minimum;
 120                 }
 121
 122                 return s;
 123         }
 124
 125         void as_xml (xmlpp::Node *) const;
 126 };
 127
 128 struct CPLSummary
 129 {
 130         CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
 131                 : dcp_directory (d)
 132                 , cpl_id (i)
 133                 , cpl_annotation_text (a)
 134                 , cpl_file (f)
 135         {}
 136
 137         std::string dcp_directory;
 138         std::string cpl_id;
 139         std::string cpl_annotation_text;
 140         boost::filesystem::path cpl_file;
 141 };
 142
 143 extern bool operator== (Crop const & a, Crop const & b);
 144 extern bool operator!= (Crop const & a, Crop const & b);
 145
 146 enum Resolution {
 147         RESOLUTION_2K,
 148         RESOLUTION_4K
 149 };
 150
 151 std::string resolution_to_string (Resolution);
 152 Resolution string_to_resolution (std::string);
 153
 154 enum Protocol {
 155         PROTOCOL_SCP,
 156         PROTOCOL_FTP
 157 };
 158
 159 #endif