src/dcp.h

   1 /*
   2     Copyright (C) 2012 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 /** @file  src/dcp.h
  21  *  @brief A class to create a DCP.
  22  */
  23
  24 #ifndef LIBDCP_DCP_H
  25 #define LIBDCP_DCP_H
  26
  27 #include <string>
  28 #include <vector>
  29 #include <boost/shared_ptr.hpp>
  30 #include <sigc++/sigc++.h>
  31 #include "types.h"
  32
  33 /** @brief Namespace for everything in libdcp */
  34 namespace libdcp
  35 {
  36
  37 class Asset;
  38
  39 /** @class DCP dcp.h libdcp/dcp.h
  40  *  @brief A class to create a DCP.
  41  */
  42
  43 class DCP
  44 {
  45 public:
  46         enum ContentType
  47         {
  48                 FEATURE,
  49                 SHORT,
  50                 TRAILER,
  51                 TEST,
  52                 TRANSITIONAL,
  53                 RATING,
  54                 TEASER,
  55                 POLICY,
  56                 PUBLIC_SERVICE_ANNOUNCEMENT,
  57                 ADVERTISEMENT
  58         };
  59
  60         /** Construct a DCP.
  61          *  @param directory Directory to write files to.
  62          *  @param name Name.
  63          *  @param content_type Content type.
  64          *  @param fps Frames per second.
  65          *  @param length Length in frames.
  66          */
  67         DCP (std::string directory, std::string name, ContentType content_type, int fps, int length);
  68
  69         /** Add a sound asset.
  70          *  @param files Pathnames of WAV files to use in the order Left, Right,
  71          *  Centre, Lfe (sub), Left surround, Right surround; not all files need
  72          *  to be present.
  73          */
  74         void add_sound_asset (std::vector<std::string> const & files);
  75
  76         /** Add a sound asset.
  77          *  @param get_path Functor to get the path to the WAV for a given channel.
  78          *  @param channels Number of channels.
  79          */
  80         void add_sound_asset (sigc::slot<std::string, Channel> get_path, int channels);
  81
  82         /** Add a picture asset.
  83          *  @param files Pathnames of JPEG2000 files, in frame order.
  84          *  @param width Width of images in pixels.
  85          *  @param height Height of images in pixels.
  86          */
  87         void add_picture_asset (std::vector<std::string> const & files, int width, int height);
  88
  89         /** Add a picture asset.
  90          *  @param get_path Functor to get path to the JPEG2000 for a given frame.
  91          *  @param width Width of images in pixels.
  92          *  @param height Height of images in pixels.
  93          */
  94         void add_picture_asset (sigc::slot<std::string, int> get_path, int width, int height);
  95
  96         /** Write the required XML files to the directory that was
  97          *  passed into the constructor.
  98          */
  99         void write_xml () const;
 100
 101         /** Emitted with a parameter between 0 and 1 to indicate progress
 102          *  for long jobs.
 103          */
 104         sigc::signal1<void, float> Progress;
 105
 106 private:
 107
 108         /** Write the CPL file.
 109          *  @param cpl_uuid UUID to use.
 110          *  @return CPL pathname.
 111          */
 112         std::string write_cpl (std::string cpl_uuid) const;
 113
 114         /** Write the PKL file.
 115          *  @param pkl_uuid UUID to use.
 116          *  @param cpl_uuid UUID of the CPL file.
 117          *  @param cpl_digest SHA digest of the CPL file.
 118          *  @param cpl_length Length of the CPL file in bytes.
 119          */
 120         std::string write_pkl (std::string pkl_uuid, std::string cpl_uuid, std::string cpl_digest, int cpl_length) const;
 121
 122         /** Write the VOLINDEX file */
 123         void write_volindex () const;
 124
 125         /** Write the ASSETMAP file.
 126          *  @param cpl_uuid UUID of our CPL.
 127          *  @param cpl_length Length of our CPL in bytes.
 128          *  @param pkl_uuid UUID of our PKL.
 129          *  @param pkl_length Length of our PKL in bytes.
 130          */
 131         void write_assetmap (std::string cpl_uuid, int cpl_length, std::string pkl_uuid, int pkl_length) const;
 132
 133         /** @param type A content type.
 134          *  @return A string representation suitable for use in a CPL.
 135          */
 136         static std::string content_type_string (ContentType type);
 137
 138         /** the directory that we are writing to */
 139         std::string _directory;
 140         /** the name of the DCP */
 141         std::string _name;
 142         /** the content type of the DCP */
 143         ContentType _content_type;
 144         /** frames per second */
 145         int _fps;
 146         /** length in frames */
 147         int _length;
 148         /** assets */
 149         std::list<boost::shared_ptr<Asset> > _assets;
 150 };
 151
 152 }
 153
 154 #endif