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 Frame;
  59
  60 enum VideoFrameType
  61 {
  62         VIDEO_FRAME_TYPE_2D,
  63         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT,
  64         VIDEO_FRAME_TYPE_3D_TOP_BOTTOM,
  65         VIDEO_FRAME_TYPE_3D_ALTERNATE,
  66         /** This content is all the left frames of some 3D */
  67         VIDEO_FRAME_TYPE_3D_LEFT,
  68         /** This content is all the right frames of some 3D */
  69         VIDEO_FRAME_TYPE_3D_RIGHT
  70 };
  71
  72 enum Eyes
  73 {
  74         EYES_BOTH,
  75         EYES_LEFT,
  76         EYES_RIGHT,
  77         EYES_COUNT
  78 };
  79
  80 enum Part
  81 {
  82         PART_LEFT_HALF,
  83         PART_RIGHT_HALF,
  84         PART_TOP_HALF,
  85         PART_BOTTOM_HALF,
  86         PART_WHOLE
  87 };
  88
  89 /** @struct Crop
  90  *  @brief A description of the crop of an image or video.
  91  */
  92 struct Crop
  93 {
  94         Crop () : left (0), right (0), top (0), bottom (0) {}
  95         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  96         Crop (boost::shared_ptr<cxml::Node>);
  97
  98         /** Number of pixels to remove from the left-hand side */
  99         int left;
 100         /** Number of pixels to remove from the right-hand side */
 101         int right;
 102         /** Number of pixels to remove from the top */
 103         int top;
 104         /** Number of pixels to remove from the bottom */
 105         int bottom;
 106
 107         dcp::Size apply (dcp::Size s, int minimum = 4) const {
 108                 s.width -= left + right;
 109                 s.height -= top + bottom;
 110
 111                 if (s.width < minimum) {
 112                         s.width = minimum;
 113                 }
 114
 115                 if (s.height < minimum) {
 116                         s.height = minimum;
 117                 }
 118
 119                 return s;
 120         }
 121
 122         void as_xml (xmlpp::Node *) const;
 123 };
 124
 125 struct CPLSummary
 126 {
 127         CPLSummary (std::string d, std::string i, std::string a, boost::filesystem::path f)
 128                 : dcp_directory (d)
 129                 , cpl_id (i)
 130                 , cpl_annotation_text (a)
 131                 , cpl_file (f)
 132         {}
 133
 134         std::string dcp_directory;
 135         std::string cpl_id;
 136         std::string cpl_annotation_text;
 137         boost::filesystem::path cpl_file;
 138 };
 139
 140 extern bool operator== (Crop const & a, Crop const & b);
 141 extern bool operator!= (Crop const & a, Crop const & b);
 142
 143 enum Resolution {
 144         RESOLUTION_2K,
 145         RESOLUTION_4K
 146 };
 147
 148 std::string resolution_to_string (Resolution);
 149 Resolution string_to_resolution (std::string);
 150
 151 enum Protocol {
 152         PROTOCOL_SCP,
 153         PROTOCOL_FTP
 154 };
 155
 156 #endif