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 namespace xmlpp {
  34         class Node;
  35 }
  36
  37 /** @brief Namespace for everything in libdcp */
  38 namespace libdcp
  39 {
  40
  41 class Asset;
  42 class PictureAsset;
  43 class SoundAsset;
  44
  45 /** @class DCP dcp.h libdcp/dcp.h
  46  *  @brief A class to create or read a DCP.
  47  */
  48
  49 class DCP
  50 {
  51 public:
  52         /** Construct a DCP.
  53          *  @param directory Directory to write files to.
  54          *  @param name Name.
  55          *  @param content_kind Content kind.
  56          *  @param fps Frames per second.
  57          *  @param length Length in frames.
  58          */
  59         DCP (std::string directory, std::string name, ContentKind content_kind, int fps, int length);
  60
  61         DCP (std::string directory);
  62
  63         /** Add a sound asset.
  64          *  @param files Pathnames of WAV files to use in the order Left, Right,
  65          *  Centre, Lfe (sub), Left surround, Right surround; not all files need
  66          *  to be present.
  67          */
  68         void add_sound_asset (std::vector<std::string> const & files);
  69
  70         /** Add a sound asset.
  71          *  @param get_path Functor to get the path to the WAV for a given channel.
  72          *  @param channels Number of channels.
  73          */
  74         void add_sound_asset (sigc::slot<std::string, Channel> get_path, int channels);
  75
  76         /** Add a picture asset.
  77          *  @param files Pathnames of JPEG2000 files, in frame order.
  78          *  @param width Width of images in pixels.
  79          *  @param height Height of images in pixels.
  80          */
  81         void add_picture_asset (std::vector<std::string> const & files, int width, int height);
  82
  83         /** Add a picture asset.
  84          *  @param get_path Functor to get path to the JPEG2000 for a given frame.
  85          *  @param width Width of images in pixels.
  86          *  @param height Height of images in pixels.
  87          */
  88         void add_picture_asset (sigc::slot<std::string, int> get_path, int width, int height);
  89
  90         /** Write the required XML files to the directory that was
  91          *  passed into the constructor.
  92          */
  93         void write_xml () const;
  94
  95         std::string name () const {
  96                 return _name;
  97         }
  98
  99         ContentKind content_kind () const {
 100                 return _content_kind;
 101         }
 102
 103         int frames_per_second () const {
 104                 return _fps;
 105         }
 106
 107         int length () const {
 108                 return _length;
 109         }
 110
 111         boost::shared_ptr<const PictureAsset> picture_asset () const;
 112         boost::shared_ptr<const SoundAsset> sound_asset () const;
 113
 114         std::list<std::string> equals (DCP const & other, EqualityOptions options) const;
 115
 116         /** Emitted with a parameter between 0 and 1 to indicate progress
 117          *  for long jobs.
 118          */
 119         sigc::signal1<void, float> Progress;
 120
 121 private:
 122
 123         /** Write the CPL file.
 124          *  @param cpl_uuid UUID to use.
 125          *  @return CPL pathname.
 126          */
 127         std::string write_cpl (std::string cpl_uuid) const;
 128
 129         /** Write the PKL file.
 130          *  @param pkl_uuid UUID to use.
 131          *  @param cpl_uuid UUID of the CPL file.
 132          *  @param cpl_digest SHA digest of the CPL file.
 133          *  @param cpl_length Length of the CPL file in bytes.
 134          */
 135         std::string write_pkl (std::string pkl_uuid, std::string cpl_uuid, std::string cpl_digest, int cpl_length) const;
 136
 137         /** Write the VOLINDEX file */
 138         void write_volindex () const;
 139
 140         /** Write the ASSETMAP file.
 141          *  @param cpl_uuid UUID of our CPL.
 142          *  @param cpl_length Length of our CPL in bytes.
 143          *  @param pkl_uuid UUID of our PKL.
 144          *  @param pkl_length Length of our PKL in bytes.
 145          */
 146         void write_assetmap (std::string cpl_uuid, int cpl_length, std::string pkl_uuid, int pkl_length) const;
 147
 148         struct Files {
 149                 std::string cpl;
 150                 std::string pkl;
 151                 std::string asset_map;
 152         };
 153
 154         void scan (Files& files, std::string directory) const;
 155
 156         /** the directory that we are writing to */
 157         std::string _directory;
 158         /** the name of the DCP */
 159         std::string _name;
 160         /** the content kind of the DCP */
 161         ContentKind _content_kind;
 162         /** frames per second */
 163         int _fps;
 164         /** length in frames */
 165         int _length;
 166         /** assets */
 167         std::list<boost::shared_ptr<Asset> > _assets;
 168 };
 169
 170 }
 171
 172 #endif