Properly support ContentKind scope attribute.v1.8.26

9 files changed, 316 insertions, 2 deletions

diff --git a/test/cpl_test.cc b/test/cpl_test.cc
new file mode 100644
index 00000000..cc51c12c
--- /dev/null
+++ b/test/cpl_test.cc
@@ -0,0 +1,71 @@
+/*
+    Copyright (C) 2022 Carl Hetherington <cth@carlh.net>
+
+    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.
+
+    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 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.
+*/
+
+
+#include "cpl.h"
+#include "test.h"
+#include <boost/test/unit_test.hpp>
+
+
+BOOST_AUTO_TEST_CASE(cpl_content_kind_test1)
+{
+	dcp::CPL cpl("test/data/cpl_content_kind_test1.xml");
+	BOOST_CHECK_EQUAL(cpl.content_kind().name(), "feature");
+	BOOST_CHECK(!cpl.content_kind().scope());
+	cpl.write_xml("build/test/cpl_content_kind_test1.xml", {});
+	check_xml(dcp::file_to_string("test/ref/cpl_content_kind_test1.xml"), dcp::file_to_string("build/test/cpl_content_kind_test1.xml"), {});
+}
+
+
+BOOST_AUTO_TEST_CASE(cpl_content_kind_test2)
+{
+	dcp::CPL cpl("test/data/cpl_content_kind_test2.xml");
+	BOOST_CHECK_EQUAL(cpl.content_kind().name(), "clip");
+	BOOST_REQUIRE(static_cast<bool>(cpl.content_kind().scope()));
+	BOOST_CHECK_EQUAL(*cpl.content_kind().scope(), "http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata#scope/content-kind");
+	cpl.write_xml("build/test/cpl_content_kind_test2.xml", {});
+	check_xml(dcp::file_to_string("test/ref/cpl_content_kind_test2.xml"), dcp::file_to_string("build/test/cpl_content_kind_test2.xml"), {});
+}
+
+
+BOOST_AUTO_TEST_CASE(cpl_content_kind_test3)
+{
+	dcp::CPL cpl("test/data/cpl_content_kind_test3.xml");
+	BOOST_CHECK_EQUAL(cpl.content_kind().name(), "tangoadvert");
+	BOOST_REQUIRE(static_cast<bool>(cpl.content_kind().scope()));
+	BOOST_CHECK_EQUAL(*cpl.content_kind().scope(), "youvebeentangoed");
+	cpl.write_xml("build/test/cpl_content_kind_test3.xml", {});
+	check_xml(dcp::file_to_string("test/ref/cpl_content_kind_test3.xml"), dcp::file_to_string("build/test/cpl_content_kind_test3.xml"), {});
+}
+
+
diff --git a/test/data/cpl_content_kind_test1.xml b/test/data/cpl_content_kind_test1.xml
new file mode 100644
index 00000000..7fcf2a15
--- /dev/null
+++ b/test/data/cpl_content_kind_test1.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind>feature</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/data/cpl_content_kind_test2.xml b/test/data/cpl_content_kind_test2.xml
new file mode 100644
index 00000000..7cdf1149
--- /dev/null
+++ b/test/data/cpl_content_kind_test2.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind scope="http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata#scope/content-kind">clip</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/data/cpl_content_kind_test3.xml b/test/data/cpl_content_kind_test3.xml
new file mode 100644
index 00000000..e67df3af
--- /dev/null
+++ b/test/data/cpl_content_kind_test3.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind scope="youvebeentangoed">tangoadvert</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/ref/cpl_content_kind_test1.xml b/test/ref/cpl_content_kind_test1.xml
new file mode 100644
index 00000000..7fcf2a15
--- /dev/null
+++ b/test/ref/cpl_content_kind_test1.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind>feature</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/ref/cpl_content_kind_test2.xml b/test/ref/cpl_content_kind_test2.xml
new file mode 100644
index 00000000..7cdf1149
--- /dev/null
+++ b/test/ref/cpl_content_kind_test2.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind scope="http://www.smpte-ra.org/schemas/429-16/2014/CPL-Metadata#scope/content-kind">clip</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/ref/cpl_content_kind_test3.xml b/test/ref/cpl_content_kind_test3.xml
new file mode 100644
index 00000000..e67df3af
--- /dev/null
+++ b/test/ref/cpl_content_kind_test3.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<CompositionPlaylist xmlns="http://www.smpte-ra.org/schemas/429-7/2006/CPL">
+  <Id>urn:uuid:81fb54df-e1bf-4647-8788-ea7ba154375b</Id>
+  <AnnotationText></AnnotationText>
+  <IssueDate>2020-08-28T13:35:06+02:00</IssueDate>
+  <Issuer>libdcp1.6.4devel</Issuer>
+  <Creator>libdcp1.6.4devel</Creator>
+  <ContentTitleText></ContentTitleText>
+  <ContentKind scope="youvebeentangoed">tangoadvert</ContentKind>
+  <ContentVersion>
+    <Id>some-id</Id>
+    <LabelText>version 1</LabelText>
+  </ContentVersion>
+  <RatingList/>
+  <ReelList>
+    <Reel>
+      <Id>urn:uuid:46c3eb45-15e5-47d6-8684-d8641e4dc516</Id>
+      <AssetList>
+        <MainPicture>
+          <Id>urn:uuid:e98d059d-645f-4343-a30f-edc61d58b8e0</Id>
+          <EditRate>24 1</EditRate>
+          <IntrinsicDuration>24</IntrinsicDuration>
+          <EntryPoint>0</EntryPoint>
+          <Duration>24</Duration>
+          <Hash>JtPL3uT3jyKMLysaqgdBWQb/n2E=</Hash>
+          <FrameRate>24 1</FrameRate>
+          <ScreenAspectRatio>1998 1080</ScreenAspectRatio>
+        </MainPicture>
+      </AssetList>
+    </Reel>
+  </ReelList>
+</CompositionPlaylist>
diff --git a/test/verify_test.cc b/test/verify_test.cc
index 20bef0fa..0b65c9d3 100644
--- a/test/verify_test.cc
+++ b/test/verify_test.cc
@@ -419,8 +419,10 @@ BOOST_AUTO_TEST_CASE (verify_failed_read_content_kind)
 
 	check_verify_result (
 		{ dir },
-		{{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::FAILED_READ, string("Bad content kind 'xtrailer'")}}
-		);
+		{
+			{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::MISMATCHED_CPL_HASHES, dcp_test1_cpl_id, canonical(dir / dcp_test1_cpl) },
+			{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::INVALID_CONTENT_KIND, string("xtrailer") }
+		});
 }
 
 
@@ -3159,3 +3161,51 @@ BOOST_AUTO_TEST_CASE (verify_unexpected_things_in_main_markers)
 		});
 }
 
+
+BOOST_AUTO_TEST_CASE(verify_invalid_content_kind)
+{
+	path dir = "build/test/verify_invalid_content_kind";
+	prepare_directory (dir);
+	auto dcp = make_simple (dir, 1, 24);
+	dcp->set_annotation_text("A Test DCP");
+	dcp->write_xml();
+
+	{
+		Editor e(find_cpl(dir));
+		e.replace("trailer", "trip");
+	}
+
+	dcp::CPL cpl (find_cpl(dir));
+
+	check_verify_result (
+		{ dir },
+		{
+			{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::MISMATCHED_CPL_HASHES, cpl.id(), canonical(find_cpl(dir)) },
+			{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::INVALID_CONTENT_KIND, string("trip") }
+		});
+
+}
+
+
+BOOST_AUTO_TEST_CASE(verify_valid_content_kind)
+{
+	path dir = "build/test/verify_valid_content_kind";
+	prepare_directory (dir);
+	auto dcp = make_simple (dir, 1, 24);
+	dcp->set_annotation_text("A Test DCP");
+	dcp->write_xml();
+
+	{
+		Editor e(find_cpl(dir));
+		e.replace("<ContentKind>trailer</ContentKind>", "<ContentKind scope=\"http://bobs.contents/\">trip</ContentKind>");
+	}
+
+	dcp::CPL cpl (find_cpl(dir));
+
+	check_verify_result (
+		{ dir },
+		{
+			{ dcp::VerificationNote::Type::ERROR, dcp::VerificationNote::Code::MISMATCHED_CPL_HASHES, cpl.id(), canonical(find_cpl(dir)) },
+		});
+
+}
diff --git a/test/wscript b/test/wscript
index 340c6e7d..b6cec631 100644
--- a/test/wscript
+++ b/test/wscript
@@ -71,6 +71,7 @@ def build(bld):
                  colour_test.cc
                  colour_conversion_test.cc
                  combine_test.cc
+                 cpl_test.cc
                  cpl_metadata_test.cc
                  cpl_sar_test.cc
                  cpl_ratings_test.cc