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 mxf_path Pathname of MXF file to create.
  41          *  @param progress Signal to inform of progress.
  42          *  @param fps Frames per second.
  43          *  @param length Length in frames.
  44          */
  45         SoundAsset (
  46                 std::vector<std::string> const & files,
  47                 std::string mxf_path,
  48                 sigc::signal1<void, float>* progress,
  49                 int fps,
  50                 int length
  51                 );
  52
  53         /** Construct a SoundAsset, generating the MXF from the WAV files.
  54          *  This may take some time; progress is indicated by emission of the Progress signal.
  55          *  @param get_path Functor which returns a WAV file path for a given channel.
  56          *  @param mxf_path Pathname of MXF file to create.
  57          *  @param progress Signal to inform of progress.
  58          *  @param fps Frames per second.
  59          *  @param length Length in frames.
  60          *  @param channels Number of audio channels.
  61          */
  62         SoundAsset (
  63                 sigc::slot<std::string, Channel> get_path,
  64                 std::string mxf_path,
  65                 sigc::signal1<void, float>* progress,
  66                 int fps,
  67                 int length,
  68                 int channels
  69                 );
  70
  71         SoundAsset (
  72                 std::string mxf_path,
  73                 int fps,
  74                 int length
  75                 );
  76
  77         /** Write details of this asset to a CPL stream.
  78          *  @param s Stream.
  79          */
  80         void write_to_cpl (std::ostream& s) const;
  81
  82 private:
  83         void construct (sigc::slot<std::string, Channel> get_path);
  84         std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
  85
  86         /** Number of channels in the asset */
  87         int _channels;
  88 };
  89
  90 }
  91
  92 #endif