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