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