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 /** @file  src/sound_asset.h
  21  *  @brief An asset made up of WAV files
  22  */
  23
  24 #include "asset.h"
  25
  26 namespace libdcp
  27 {
  28
  29 /** @brief An asset made up of WAV files */
  30 class SoundAsset : public Asset
  31 {
  32 public:
  33         /** Construct a SoundAsset, generating the MXF from the WAV files.
  34          *  This may take some time; progress is indicated by emission of the Progress signal.
  35          *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
  36          *  @param mxf_path Pathname of MXF file to create.
  37          *  @param progress Signal to inform of progress.
  38          *  @param fps Frames per second.
  39          *  @param length Length in frames.
  40          */
  41         SoundAsset (std::list<std::string> const & files, std::string mxf_path, sigc::signal1<void, float>* progress, int fps, int length);
  42
  43         /** Write details of this asset to a CPL stream.
  44          *  @param s Stream.
  45          */
  46         void write_to_cpl (std::ostream& s) const;
  47 };
  48
  49 }