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 <libdcp/util.h>
  27
  28 class Content;
  29 class AudioBuffers;
  30
  31 typedef int64_t Time;
  32 #define TIME_MAX INT64_MAX
  33 #define TIME_HZ  ((Time) 96000)
  34 typedef int64_t OutputAudioFrame;
  35 typedef int     OutputVideoFrame;
  36 typedef std::vector<boost::shared_ptr<Content> > ContentList;
  37
  38 template<class T>
  39 struct TimedAudioBuffers
  40 {
  41         TimedAudioBuffers ()
  42                 : time (0)
  43         {}
  44
  45         TimedAudioBuffers (boost::shared_ptr<AudioBuffers> a, T t)
  46                 : audio (a)
  47                 , time (t)
  48         {}
  49
  50         boost::shared_ptr<AudioBuffers> audio;
  51         T time;
  52 };
  53
  54 enum VideoFrameType
  55 {
  56         VIDEO_FRAME_TYPE_2D,
  57         VIDEO_FRAME_TYPE_3D_LEFT_RIGHT
  58 };
  59
  60 enum Eyes
  61 {
  62         EYES_BOTH,
  63         EYES_LEFT,
  64         EYES_RIGHT,
  65         EYES_COUNT
  66 };
  67
  68 /** @struct Crop
  69  *  @brief A description of the crop of an image or video.
  70  */
  71 struct Crop
  72 {
  73         Crop () : left (0), right (0), top (0), bottom (0) {}
  74         Crop (int l, int r, int t, int b) : left (l), right (r), top (t), bottom (b) {}
  75
  76         /** Number of pixels to remove from the left-hand side */
  77         int left;
  78         /** Number of pixels to remove from the right-hand side */
  79         int right;
  80         /** Number of pixels to remove from the top */
  81         int top;
  82         /** Number of pixels to remove from the bottom */
  83         int bottom;
  84 };
  85
  86 extern bool operator== (Crop const & a, Crop const & b);
  87 extern bool operator!= (Crop const & a, Crop const & b);
  88
  89 enum Resolution {
  90         RESOLUTION_2K,
  91         RESOLUTION_4K
  92 };
  93
  94 std::string resolution_to_string (Resolution);
  95 Resolution string_to_resolution (std::string);
  96
  97 #endif