src/sound_asset.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 #ifndef LIBDCP_SOUND_ASSET_H
  21 #define LIBDCP_SOUND_ASSET_H
  22
  23 /** @file  src/sound_asset.h
  24  *  @brief An asset made up of PCM audio data files
  25  */
  26
  27 #include "mxf_asset.h"
  28 #include "types.h"
  29
  30 namespace libdcp
  31 {
  32
  33 class SoundFrame;
  34
  35 /** @brief An asset made up of WAV files */
  36 class SoundAsset : public MXFAsset
  37 {
  38 public:
  39         /** Construct a SoundAsset, generating the MXF from some WAV files.
  40          *  This may take some time; progress is indicated by emission of the Progress signal.
  41          *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
  42          *  @param directory Directory in which to create MXF file.
  43          *  @param mxf_name Name of MXF file to create.
  44          *  @param progress Signal to inform of progress.
  45          *  @param fps Frames per second.
  46          *  @param length Length in frames.
  47          *  @param encrypted true if asset should be encrypted.
  48          */
  49         SoundAsset (
  50                 std::vector<std::string> const & files,
  51                 std::string directory,
  52                 std::string mxf_name,
  53                 boost::signals2::signal<void (float)>* progress,
  54                 int fps,
  55                 int length,
  56                 bool encrypted
  57                 );
  58
  59         /** Construct a SoundAsset, generating the MXF from some WAV files.
  60          *  This may take some time; progress is indicated by emission of the Progress signal.
  61          *  @param get_path Functor which returns a WAV file path for a given channel.
  62          *  @param directory Directory in which to create MXF file.
  63          *  @param mxf_name Name of MXF file to create.
  64          *  @param progress Signal to inform of progress.
  65          *  @param fps Frames per second.
  66          *  @param length Length in frames.
  67          *  @param channels Number of audio channels.
  68          *  @param encrypted true if asset should be encrypted.
  69          */
  70         SoundAsset (
  71                 boost::function<std::string (Channel)> get_path,
  72                 std::string directory,
  73                 std::string mxf_name,
  74                 boost::signals2::signal<void (float)>* progress,
  75                 int fps,
  76                 int length,
  77                 int channels,
  78                 bool encrypted
  79                 );
  80
  81         SoundAsset (
  82                 std::string directory,
  83                 std::string mxf_name,
  84                 int fps,
  85                 int entry_point,
  86                 int length
  87                 );
  88
  89         /** Write details of this asset to a CPL stream.
  90          *  @param s Stream.
  91          */
  92         void write_to_cpl (std::ostream& s) const;
  93
  94         bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
  95
  96         boost::shared_ptr<const SoundFrame> get_frame (int n) const;
  97
  98         int channels () const {
  99                 return _channels;
 100         }
 101
 102         int sampling_rate () const {
 103                 return _sampling_rate;
 104         }
 105
 106 private:
 107         void construct (boost::function<std::string (Channel)> get_path);
 108         std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
 109
 110         /** Number of channels in the asset */
 111         int _channels;
 112         int _sampling_rate;
 113 };
 114
 115 }
 116
 117 #endif