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