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