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 "AS_DCP.h"
  28 #include "mxf_asset.h"
  29 #include "types.h"
  30
  31 namespace libdcp
  32 {
  33
  34 class SoundFrame;
  35
  36 class SoundAsset;
  37
  38 class SoundAssetWriter
  39 {
  40 public:
  41         ~SoundAssetWriter ();
  42
  43         void write (float const * const *, int);
  44         void finalize ();
  45
  46 private:
  47         friend class SoundAsset;
  48
  49         SoundAssetWriter (SoundAsset *);
  50         void write_current_frame ();
  51
  52         SoundAsset* _asset;
  53         bool _finalized;
  54         int _frames_written;
  55         int _frame_buffer_offset;
  56         ASDCP::PCM::MXFWriter _mxf_writer;
  57         ASDCP::PCM::FrameBuffer _frame_buffer;
  58         ASDCP::WriterInfo _writer_info;
  59         ASDCP::PCM::AudioDescriptor _audio_desc;
  60 };
  61
  62 /** @brief An asset made up of WAV files */
  63 class SoundAsset : public MXFAsset
  64 {
  65 public:
  66         /** Construct a SoundAsset, generating the MXF from some WAV files.
  67          *  This may take some time; progress is indicated by emission of the Progress signal.
  68          *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
  69          *  @param directory Directory in which to create MXF file.
  70          *  @param mxf_name Name of MXF file to create.
  71          *  @param progress Signal to inform of progress.
  72          *  @param fps Frames per second.
  73          *  @param intrinsic_duration Length of the whole asset in frames.
  74          *  @param start_frame Frame in the source to start writing from.
  75          *  Note that this is different to entry_point in that the asset will contain no data before start_frame.
  76          */
  77         SoundAsset (
  78                 std::vector<std::string> const & files,
  79                 std::string directory,
  80                 std::string mxf_name,
  81                 boost::signals2::signal<void (float)>* progress,
  82                 int fps,
  83                 int intrinsic_duration,
  84                 int start_frame
  85                 );
  86
  87         /** Construct a SoundAsset, generating the MXF from some WAV files.
  88          *  This may take some time; progress is indicated by emission of the Progress signal.
  89          *  @param get_path Functor which returns a WAV file path for a given channel.
  90          *  @param directory Directory in which to create MXF file.
  91          *  @param mxf_name Name of MXF file to create.
  92          *  @param progress Signal to inform of progress.
  93          *  @param fps Frames per second.
  94          *  @param intrinsic_duration Length of the whole asset in frames.
  95          *  @param start_frame Frame in the source to start writing from.
  96          *  Note that this is different to entry_point in that the asset will contain no data before start_frame.
  97          *  @param channels Number of audio channels.
  98          */
  99         SoundAsset (
 100                 boost::function<std::string (Channel)> get_path,
 101                 std::string directory,
 102                 std::string mxf_name,
 103                 boost::signals2::signal<void (float)>* progress,
 104                 int fps,
 105                 int intrinsic_duration,
 106                 int start_frame,
 107                 int channels
 108                 );
 109
 110         SoundAsset (
 111                 std::string directory,
 112                 std::string mxf_name
 113                 );
 114
 115         SoundAsset (
 116                 std::string directory,
 117                 std::string mxf_name,
 118                 int fps,
 119                 int channels,
 120                 int sampling_rate
 121                 );
 122
 123         boost::shared_ptr<SoundAssetWriter> start_write ();
 124
 125         /** Write details of this asset to a CPL stream.
 126          *  @param s Stream.
 127          */
 128         void write_to_cpl (std::ostream& s) const;
 129
 130         bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, std::list<std::string>& notes) const;
 131
 132         boost::shared_ptr<const SoundFrame> get_frame (int n) const;
 133
 134         int channels () const {
 135                 return _channels;
 136         }
 137
 138         int sampling_rate () const {
 139                 return _sampling_rate;
 140         }
 141
 142 private:
 143         void construct (boost::function<std::string (Channel)> get_path);
 144         std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
 145
 146         /** Number of channels in the asset */
 147         int _channels;
 148         int _sampling_rate;
 149         int _start_frame;
 150 };
 151
 152 }
 153
 154 #endif