Bv2.1 6.2.1: Check that the sound MXF Language tag conforms to RFC 5646.

[libdcp.git] / src / sound_asset.h

diff --git a/src/sound_asset.h b/src/sound_asset.h
index 968f7dded8033ee474f308199bb60afefba8b6d5..d4b41a1a47f6f41e93091248e84a80d4a00d6d3c 100644 (file)
--- a/src/sound_asset.h
+++ b/src/sound_asset.h
@@ -1,20 +1,34 @@
 /*
-    Copyright (C) 2012-2014 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.
 */
 
 /** @file  src/sound_asset.h
@@ -26,12 +40,24 @@
 
 #include "mxf.h"
 #include "types.h"
+#include "language_tag.h"
 #include "metadata.h"
+#include "sound_frame.h"
+#include "sound_asset_reader.h"
+
+
+namespace dcp {
+       class SoundAsset;
+}
+
+extern std::shared_ptr<dcp::SoundAsset> simple_sound (
+       boost::filesystem::path path, std::string suffix, dcp::MXFMetadata mxf_meta, std::string language
+       );
+
 
 namespace dcp
 {
 
-class SoundFrame;
 class SoundAssetWriter;
 
 /** @class SoundAsset
@@ -40,19 +66,18 @@ class SoundAssetWriter;
 class SoundAsset : public Asset, public MXF
 {
 public:
-       SoundAsset (boost::filesystem::path file);
-       SoundAsset (Fraction edit_rate, int sampling_rate, int channels);
+       explicit SoundAsset (boost::filesystem::path file);
+       SoundAsset (Fraction edit_rate, int sampling_rate, int channels, LanguageTag language, Standard standard);
 
-       boost::shared_ptr<SoundAssetWriter> start_write (boost::filesystem::path file, Standard standard);
+       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;
 
        bool equals (
-               boost::shared_ptr<const Asset> other,
+               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;
@@ -71,10 +96,22 @@ public:
                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:
        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;
+       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
@@ -83,6 +120,7 @@ private:
        int64_t _intrinsic_duration;
        int _channels;      ///< number of channels
        int _sampling_rate; ///< sampling rate in Hz
+       std::string _language;
 };
 
 }