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 start_frame Frame in the source to start writing from.
  48          *  @param encrypted true if asset should be encrypted.
  49          */
  50         SoundAsset (
  51                 std::vector<std::string> const & files,
  52                 std::string directory,
  53                 std::string mxf_name,
  54                 boost::signals2::signal<void (float)>* progress,
  55                 int fps,
  56                 int length,
  57                 int start_frame,
  58                 bool encrypted
  59                 );
  60
  61         /** Construct a SoundAsset, generating the MXF from some WAV files.
  62          *  This may take some time; progress is indicated by emission of the Progress signal.
  63          *  @param get_path Functor which returns a WAV file path for a given channel.
  64          *  @param directory Directory in which to create MXF file.
  65          *  @param mxf_name Name of MXF file to create.
  66          *  @param progress Signal to inform of progress.
  67          *  @param fps Frames per second.
  68          *  @param length Length in frames.
  69          *  @param start_frame Frame in the source to start writing from.
  70          *  @param channels Number of audio channels.
  71          *  @param encrypted true if asset should be encrypted.
  72          */
  73         SoundAsset (
  74                 boost::function<std::string (Channel)> get_path,
  75                 std::string directory,
  76                 std::string mxf_name,
  77                 boost::signals2::signal<void (float)>* progress,
  78                 int fps,
  79                 int length,
  80                 int start_frame,
  81                 int channels,
  82                 bool encrypted
  83                 );
  84
  85         SoundAsset (
  86                 std::string directory,
  87                 std::string mxf_name,
  88                 int fps,
  89                 int entry_point,
  90                 int length
  91                 );
  92
  93         /** Write details of the asset to a CPL AssetList node.
  94          *  @param p Parent node.
  95          */
  96         void write_to_cpl (xmlpp::Element* p) const;
  97
  98         bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
  99
 100         boost::shared_ptr<const SoundFrame> get_frame (int n) const;
 101
 102         int channels () const {
 103                 return _channels;
 104         }
 105
 106         int sampling_rate () const {
 107                 return _sampling_rate;
 108         }
 109
 110 private:
 111         std::string key_type () const;
 112
 113         void construct (boost::function<std::string (Channel)> get_path);
 114         std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
 115
 116         /** Number of channels in the asset */
 117         int _channels;
 118         int _sampling_rate;
 119         int _start_frame;
 120 };
 121
 122 }
 123
 124 #endif