src/sound_asset_writer.h

   1 /*
   2     Copyright (C) 2012-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/sound_asset_writer.h
  36  *  @brief SoundAssetWriter class
  37  */
  38
  39
  40 #include "asset_writer.h"
  41 #include "fsk.h"
  42 #include "types.h"
  43 #include "sound_frame.h"
  44 #include <memory>
  45 #include <boost/filesystem.hpp>
  46 #include <boost/shared_array.hpp>
  47
  48
  49 struct sync_test1;
  50
  51
  52 namespace dcp {
  53
  54
  55 class SoundAsset;
  56
  57
  58 /** @class SoundAssetWriter
  59  *  @brief A helper class for writing to SoundAssets.
  60  *
  61  *  Objects of this class can only be created with SoundAsset::start_write().
  62  *
  63  *  Sound samples can be written to the SoundAsset by calling write() with
  64  *  a buffer of float values.  finalize() must be called after the last samples
  65  *  have been written.
  66  */
  67 class SoundAssetWriter : public AssetWriter
  68 {
  69 public:
  70         /** @param data Pointer an array of float pointers, one for each channel.
  71          *  @param frames Number of frames i.e. number of floats that are given for each channel.
  72          */
  73         void write (float const * const *, int);
  74
  75         bool finalize ();
  76
  77 private:
  78         friend class SoundAsset;
  79         friend struct ::sync_test1;
  80
  81         SoundAssetWriter (SoundAsset *, boost::filesystem::path, std::vector<Channel> active_channels, bool sync);
  82
  83         void start ();
  84         void write_current_frame ();
  85         std::vector<bool> create_sync_packets ();
  86
  87         /* do this with an opaque pointer so we don't have to include
  88            ASDCP headers
  89         */
  90
  91         struct ASDCPState;
  92         std::shared_ptr<ASDCPState> _state;
  93
  94         SoundAsset* _asset = nullptr;
  95         int _frame_buffer_offset = 0;
  96
  97         /** true to ignore any signal passed to write() on channel 14 and instead write a sync track */
  98         bool _sync = false;
  99         /** index of the sync packet (0-3) which starts the next edit unit */
 100         int _sync_packet = 0;
 101         FSK _fsk;
 102
 103         std::vector<Channel> _active_channels;
 104 };
 105
 106 }