2 Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
4 This file is part of DCP-o-matic.
6 DCP-o-matic 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.
11 DCP-o-matic 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.
16 You should have received a copy of the GNU General Public License
17 along with DCP-o-matic. If not, see <http://www.gnu.org/licenses/>.
21 /** @file src/encode_server.cc
22 * @brief Class to describe a server to which we can send
23 * encoding work, and a class to implement such a server.
26 #include "encode_server.h"
28 #include "dcpomatic_socket.h"
30 #include "dcp_video.h"
33 #include "player_video.h"
34 #include "compose.hpp"
36 #include "dcpomatic_log.h"
37 #include "encoded_log_entry.h"
39 #include <dcp/raw_convert.h>
40 #include <libcxml/cxml.h>
41 #include <libxml++/libxml++.h>
42 #include <boost/algorithm/string.hpp>
43 #include <boost/scoped_array.hpp>
44 #include <boost/foreach.hpp>
45 #ifdef HAVE_VALGRIND_H
46 #include <valgrind/memcheck.h>
60 using boost::shared_ptr;
63 using boost::scoped_array;
64 using boost::optional;
67 using dcp::raw_convert;
69 EncodeServer::EncodeServer (bool verbose, int num_threads)
70 #if !defined(RUNNING_ON_VALGRIND) || RUNNING_ON_VALGRIND == 0
71 : Server (ENCODE_FRAME_PORT)
73 : Server (ENCODE_FRAME_PORT, 2400)
76 , _num_threads (num_threads)
81 EncodeServer::~EncodeServer ()
84 boost::mutex::scoped_lock lm (_mutex);
86 _empty_condition.notify_all ();
87 _full_condition.notify_all ();
90 BOOST_FOREACH (boost::thread* i, _worker_threads) {
100 boost::mutex::scoped_lock lm (_broadcast.mutex);
101 if (_broadcast.socket) {
102 _broadcast.socket->close ();
103 delete _broadcast.socket;
104 _broadcast.socket = 0;
108 _broadcast.io_service.stop ();
109 if (_broadcast.thread.joinable()) {
111 _broadcast.thread.join ();
118 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
119 * @param after_encode Filled in with gettimeofday() after encoding the image.
122 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
124 Socket::ReadDigestScope ds (socket);
126 uint32_t length = socket->read_uint32 ();
127 scoped_array<char> buffer (new char[length]);
128 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
130 string s (buffer.get());
131 shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
132 xml->read_string (s);
133 /* This is a double-check; the server shouldn't even be on the candidate list
134 if it is the wrong version, but it doesn't hurt to make sure here.
136 if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
137 cerr << "Mismatched server/client versions\n";
138 LOG_ERROR_NC ("Mismatched server/client versions");
142 shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
145 throw NetworkError ("Checksums do not match");
148 DCPVideo dcp_video_frame (pvf, xml);
150 gettimeofday (&after_read, 0);
152 Data encoded = dcp_video_frame.encode_locally ();
154 gettimeofday (&after_encode, 0);
157 Socket::WriteDigestScope ds (socket);
158 socket->write (encoded.size());
159 socket->write (encoded.data().get(), encoded.size());
160 } catch (std::exception& e) {
161 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
162 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
166 return dcp_video_frame.index ();
170 EncodeServer::worker_thread ()
173 boost::mutex::scoped_lock lock (_mutex);
174 while (_queue.empty () && !_terminate) {
175 _empty_condition.wait (lock);
182 shared_ptr<Socket> socket = _queue.front ();
190 struct timeval start;
191 struct timeval after_read;
192 struct timeval after_encode;
195 gettimeofday (&start, 0);
198 frame = process (socket, after_read, after_encode);
199 ip = socket->socket().remote_endpoint().address().to_string();
200 } catch (std::exception& e) {
201 cerr << "Error: " << e.what() << "\n";
202 LOG_ERROR ("Error: %1", e.what());
205 gettimeofday (&end, 0);
213 gettimeofday (&end, 0);
215 shared_ptr<EncodedLogEntry> e (
216 new EncodedLogEntry (
218 seconds(after_read) - seconds(start),
219 seconds(after_encode) - seconds(after_read),
220 seconds(end) - seconds(after_encode)
225 cout << e->get() << "\n";
228 dcpomatic_log->log (e);
231 _full_condition.notify_all ();
238 LOG_GENERAL ("Server %1 (%2) starting with %3 threads", dcpomatic_version, dcpomatic_git_commit, _num_threads);
240 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
243 for (int i = 0; i < _num_threads; ++i) {
244 boost::thread* t = new thread(bind(&EncodeServer::worker_thread, this));
245 _worker_threads.push_back (t);
246 #ifdef DCPOMATIC_LINUX
247 pthread_setname_np (t->native_handle(), "encode-server-worker");
251 _broadcast.thread = thread (bind(&EncodeServer::broadcast_thread, this));
252 #ifdef DCPOMATIC_LINUX
253 pthread_setname_np (_broadcast.thread.native_handle(), "encode-server-broadcast");
260 EncodeServer::broadcast_thread ()
263 boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
264 boost::asio::ip::udp::endpoint listen_endpoint (address, HELLO_PORT);
266 _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
267 _broadcast.socket->open (listen_endpoint.protocol ());
268 _broadcast.socket->bind (listen_endpoint);
270 _broadcast.socket->async_receive_from (
271 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
272 _broadcast.send_endpoint,
273 boost::bind (&EncodeServer::broadcast_received, this)
276 _broadcast.io_service.run ();
284 EncodeServer::broadcast_received ()
286 _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
288 if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
289 /* Reply to the client saying what we can do */
291 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
292 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
293 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
294 string xml = doc.write_to_string ("UTF-8");
297 cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
301 shared_ptr<Socket> socket (new Socket);
302 socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), MAIN_SERVER_PRESENCE_PORT));
303 socket->write (xml.length() + 1);
304 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
310 shared_ptr<Socket> socket (new Socket);
311 socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), BATCH_SERVER_PRESENCE_PORT));
312 socket->write (xml.length() + 1);
313 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
319 boost::mutex::scoped_lock lm (_broadcast.mutex);
320 if (_broadcast.socket) {
321 _broadcast.socket->async_receive_from (
322 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
323 _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
329 EncodeServer::handle (shared_ptr<Socket> socket)
331 boost::mutex::scoped_lock lock (_mutex);
336 /* Wait until the queue has gone down a bit */
337 while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
338 _full_condition.wait (lock);
341 _queue.push_back (socket);
342 _empty_condition.notify_all ();