Bv2.1 6.2.1: Check that the sound MXF Language tag conforms to RFC 5646.
[libdcp.git] / src / sound_asset.h
index b7542c735ee8104e6a4e78da1439785f30a086af..d4b41a1a47f6f41e93091248e84a80d4a00d6d3c 100644 (file)
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2012-2020 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
-#ifndef LIBDCP_SOUND_ASSET_H
-#define LIBDCP_SOUND_ASSET_H
-
 /** @file  src/sound_asset.h
- *  @brief An asset made up of PCM audio data files
+ *  @brief SoundAsset class
  */
 
-#include "mxf_asset.h"
+#ifndef LIBDCP_SOUND_ASSET_H
+#define LIBDCP_SOUND_ASSET_H
+
+#include "mxf.h"
 #include "types.h"
+#include "language_tag.h"
 #include "metadata.h"
+#include "sound_frame.h"
+#include "sound_asset_reader.h"
 
-namespace libdcp
-{
 
-class SoundFrame;
-class SoundAsset;
+namespace dcp {
+       class SoundAsset;
+}
 
-class SoundAssetWriter
-{
-public:
-       void write (float const * const *, int);
-       void finalize ();
+extern std::shared_ptr<dcp::SoundAsset> simple_sound (
+       boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language
+       );
 
-private:
-       friend class SoundAsset;
-
-       SoundAssetWriter (SoundAsset *, bool interop, MXFMetadata const &);
-
-       /* no copy construction */
-       SoundAssetWriter (SoundAssetWriter const &);
-       SoundAssetWriter& operator= (SoundAssetWriter const &);
-       
-       void write_current_frame ();
-
-       /* do this with an opaque pointer so we don't have to include
-          ASDCP headers
-       */
-          
-       struct ASDCPState;
-       boost::shared_ptr<ASDCPState> _state;
-
-       SoundAsset* _asset;
-       bool _finalized;
-       int _frames_written;
-       int _frame_buffer_offset;
-       MXFMetadata _metadata;
-};
 
-/** @brief An asset made up of WAV files */
-class SoundAsset : public MXFAsset
+namespace dcp
 {
-public:
-       /** Construct a SoundAsset, generating the MXF from some WAV files.
-        *  This may take some time; progress is indicated by emission of the Progress signal.
-        *  @param files Pathnames of sound files, in the order Left, Right, Centre, Lfe (sub), Left surround, Right surround.
-        *  @param directory Directory in which to create MXF file.
-        *  @param mxf_name Name of MXF file to create.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param length Length in frames.
-        *  @param start_frame Frame in the source to start writing from.
-        *  @param intrinsic_duration Length of the whole asset in frames.
-        *  @param encrypted true if asset should be encrypted.
-        *  Note that this is different to entry_point in that the asset will contain no data before start_frame.
-        */
-       SoundAsset (
-               std::vector<std::string> const & files,
-               std::string directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               bool encrypted,
-               bool interop,
-               MXFMetadata const & metadata = MXFMetadata ()
-               );
 
-       /** Construct a SoundAsset, generating the MXF from some WAV files.
-        *  This may take some time; progress is indicated by emission of the Progress signal.
-        *  @param get_path Functor which returns a WAV file path for a given channel.
-        *  @param directory Directory in which to create MXF file.
-        *  @param mxf_name Name of MXF file to create.
-        *  @param progress Signal to inform of progress.
-        *  @param fps Frames per second.
-        *  @param intrinsic_duration Length of the whole asset in frames.
-        *  @param channels Number of audio channels.
-        *  @param encrypted true if asset should be encrypted.
-        */
-       SoundAsset (
-               boost::function<std::string (Channel)> get_path,
-               std::string directory,
-               std::string mxf_name,
-               boost::signals2::signal<void (float)>* progress,
-               int fps,
-               int intrinsic_duration,
-               int channels,
-               bool encrypted,
-               bool interop,
-               MXFMetadata const & metadata = MXFMetadata ()
-               );
+class SoundAssetWriter;
 
-       SoundAsset (
-               std::string directory,
-               std::string mxf_name
-               );
+/** @class SoundAsset
+ *  @brief Representation of a sound asset
+ */
+class SoundAsset : public Asset, public MXF
+{
+public:
+       explicit SoundAsset (boost::filesystem::path file);
+       SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
 
-       SoundAsset (
-               std::string directory,
-               std::string mxf_name,
-               int fps,
-               int channels,
-               int sampling_rate
-               );
+       std::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, std::vector<Channel> active_channels, bool atmos_sync = false);
+       std::shared_ptr<SoundAssetReader> start_read () const;
 
-       boost::shared_ptr<SoundAssetWriter> start_write (bool, MXFMetadata const & metadata = MXFMetadata ());
-       
-       bool equals (boost::shared_ptr<const Asset> other, EqualityOptions opt, boost::function<void (NoteType, std::string)> note) const;
+       bool equals (
+               std::shared_ptr<const Asset> other,
+               EqualityOptions opt,
+               NoteHandler note
+               ) const;
 
-       boost::shared_ptr<const SoundFrame> get_frame (int n) const;
-       
+       /** @return number of channels */
        int channels () const {
                return _channels;
        }
 
+       /** @return sampling rate in Hz */
        int sampling_rate () const {
                return _sampling_rate;
        }
 
+       Fraction edit_rate () const {
+               return _edit_rate;
+       }
+
+       int64_t intrinsic_duration () const {
+               return _intrinsic_duration;
+       }
+
+       std::string language () const {
+               return _language;
+       }
+
+       static bool valid_mxf (boost::filesystem::path);
+       static std::string static_pkl_type (Standard standard);
+
 private:
-       std::string key_type () const;
-       void construct (boost::function<std::string (Channel)> get_path, bool interop, MXFMetadata const &);
-       std::string path_from_channel (Channel channel, std::vector<std::string> const & files);
-       std::string cpl_node_name () const;
-
-       /** Number of channels in the asset */
-       int _channels;
-       int _sampling_rate;
+       friend class SoundAssetWriter;
+       friend std::shared_ptr<dcp::SoundAsset> (::simple_sound) (
+               boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language
+               );
+
+       std::string pkl_type (Standard standard) const {
+               return static_pkl_type (standard);
+       }
+
+       Fraction _edit_rate;
+       /** The total length of this content in video frames.  The amount of
+        *  content presented may be less than this.
+        */
+       int64_t _intrinsic_duration;
+       int _channels;      ///< number of channels
+       int _sampling_rate; ///< sampling rate in Hz
+       std::string _language;
 };
 
 }