Rearrange encoder threading.

Soon we'll add a new encoder type, and the existing structure was
already creaking a bit at the seams while handling local and remote
encodes.  Here we split out an encoder thread and introduce the concept
of a "sync" thread (which blocks while the encoding is happening).
Later we'll have another type which submits the encode request to a
GPU and receives the reply back later.

3 files changed, 140 insertions, 5 deletions

diff --git a/test/client_server_test.cc b/test/client_server_test.cc
index 4f5015fc8..1bfa4c5a6 100644
--- a/test/client_server_test.cc
+++ b/test/client_server_test.cc
@@ -20,20 +20,18 @@
 
 
 /** @file  test/client_server_test.cc
- *  @brief Test the server class.
+ *  @brief Test the remote encoding code.
  *  @ingroup feature
- *
- *  Create a test image and then encode it using the standard mechanism
- *  and also using a EncodeServer object running on localhost.  Compare the resulting
- *  encoded data to check that they are the same.
  */
 
 
+#include "lib/content_factory.h"
 #include "lib/cross.h"
 #include "lib/dcp_video.h"
 #include "lib/dcpomatic_log.h"
 #include "lib/encode_server.h"
 #include "lib/encode_server_description.h"
+#include "lib/encode_server_finder.h"
 #include "lib/file_log.h"
 #include "lib/image.h"
 #include "lib/j2k_image_proxy.h"
@@ -316,3 +314,22 @@ BOOST_AUTO_TEST_CASE (client_server_test_j2k)
 }
 
 
+BOOST_AUTO_TEST_CASE(real_encode_with_server)
+{
+	auto content = content_factory(TestPaths::private_data() / "dolby_aurora.vob");
+	auto film = new_test_film2("real_encode_with_server", content);
+
+	EncodeServerFinder::instance();
+
+	EncodeServer server(true, 4);
+	thread server_thread(boost::bind(&EncodeServer::run, &server));
+
+	make_and_verify_dcp(film);
+
+	server.stop();
+	server_thread.join();
+
+	BOOST_CHECK(server.frames_encoded() > 0);
+	EncodeServerFinder::drop();
+}
+
diff --git a/test/j2k_encode_threading_test.cc b/test/j2k_encode_threading_test.cc
new file mode 100644
index 000000000..ff2e7b0dc
--- /dev/null
+++ b/test/j2k_encode_threading_test.cc
@@ -0,0 +1,117 @@
+/*
+    Copyright (C) 2023 Carl Hetherington <cth@carlh.net>
+
+    This file is part of DCP-o-matic.
+
+    DCP-o-matic 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.
+
+    DCP-o-matic 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 DCP-o-matic.  If not, see <http://www.gnu.org/licenses/>.
+
+*/
+
+
+#include "lib/config.h"
+#include "lib/content_factory.h"
+#include "lib/dcp_encoder.h"
+#include "lib/dcp_transcode_job.h"
+#include "lib/encode_server_description.h"
+#include "lib/film.h"
+#include "lib/j2k_encoder.h"
+#include "lib/job_manager.h"
+#include "lib/make_dcp.h"
+#include "lib/transcode_job.h"
+#include "test.h"
+#include <dcp/cpl.h>
+#include <dcp/dcp.h>
+#include <dcp/reel.h>
+#include <dcp/reel_picture_asset.h>
+#include <boost/test/unit_test.hpp>
+
+
+using std::dynamic_pointer_cast;
+using std::list;
+
+
+BOOST_AUTO_TEST_CASE(local_threads_created_and_destroyed)
+{
+	auto film = new_test_film2("local_threads_created_and_destroyed", {});
+	Writer writer(film, {});
+	J2KEncoder encoder(film, writer);
+
+	encoder.remake_threads(32, 0, {});
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 32U);
+
+	encoder.remake_threads(9, 0, {});
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 9U);
+
+	encoder.end();
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 0U);
+}
+
+
+BOOST_AUTO_TEST_CASE(remote_threads_created_and_destroyed)
+{
+	auto film = new_test_film2("remote_threads_created_and_destroyed", {});
+	Writer writer(film, {});
+	J2KEncoder encoder(film, writer);
+
+	list<EncodeServerDescription> servers = {
+		{ "fred", 7, SERVER_LINK_VERSION },
+		{ "jim", 2, SERVER_LINK_VERSION },
+		{ "sheila", 14, SERVER_LINK_VERSION },
+	};
+
+	encoder.remake_threads(0, 0, servers);
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 7U + 2U + 14U);
+
+	servers = {
+		{ "fred", 7, SERVER_LINK_VERSION },
+		{ "jim", 5, SERVER_LINK_VERSION },
+		{ "sheila", 14, SERVER_LINK_VERSION },
+	};
+
+	encoder.remake_threads(0, 0, servers);
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 7U + 5U + 14U);
+
+	servers = {
+		{ "fred", 0, SERVER_LINK_VERSION },
+		{ "jim", 0, SERVER_LINK_VERSION },
+		{ "sheila", 11, SERVER_LINK_VERSION },
+	};
+
+	encoder.remake_threads(0, 0, servers);
+	BOOST_CHECK_EQUAL(encoder._threads.size(), 11U);
+}
+
+
+BOOST_AUTO_TEST_CASE(frames_not_lost_when_threads_disappear)
+{
+	auto content = content_factory(TestPaths::private_data() / "clapperboard.mp4");
+	auto film = new_test_film2("frames_not_lost", content);
+	film->write_metadata();
+	auto job = make_dcp(film, TranscodeJob::ChangedBehaviour::IGNORE);
+	auto& encoder = dynamic_pointer_cast<DCPEncoder>(job->_encoder)->_j2k_encoder;
+
+	while (JobManager::instance()->work_to_do()) {
+		encoder.remake_threads(rand() % 8, 0, {});
+		dcpomatic_sleep_seconds(1);
+	}
+
+	BOOST_CHECK(!JobManager::instance()->errors());
+
+	dcp::DCP dcp(film->dir(film->dcp_name()));
+	dcp.read();
+	BOOST_REQUIRE_EQUAL(dcp.cpls().size(), 1U);
+	BOOST_REQUIRE_EQUAL(dcp.cpls()[0]->reels().size(), 1U);
+	BOOST_REQUIRE_EQUAL(dcp.cpls()[0]->reels()[0]->main_picture()->intrinsic_duration(), 423U);
+}
+
diff --git a/test/wscript b/test/wscript
index 7930397f6..f464b34cd 100644
--- a/test/wscript
+++ b/test/wscript
@@ -111,6 +111,7 @@ def build(bld):
                  interrupt_encoder_test.cc
                  isdcf_name_test.cc
                  j2k_bandwidth_test.cc
+                 j2k_encode_threading_test.cc
                  job_manager_test.cc
                  kdm_cli_test.cc
                  kdm_naming_test.cc