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