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 "encoded_log_entry.h"
38 #include <dcp/raw_convert.h>
39 #include <libcxml/cxml.h>
40 #include <libxml++/libxml++.h>
41 #include <boost/algorithm/string.hpp>
42 #include <boost/scoped_array.hpp>
43 #include <boost/foreach.hpp>
50 #define LOG_GENERAL(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
51 #define LOG_GENERAL_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
52 #define LOG_ERROR(...) _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
53 #define LOG_ERROR_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
61 using boost::shared_ptr;
64 using boost::scoped_array;
65 using boost::optional;
68 using dcp::raw_convert;
70 EncodeServer::EncodeServer (shared_ptr<Log> log, bool verbose, int num_threads)
71 : Server (ENCODE_FRAME_PORT)
74 , _num_threads (num_threads)
79 EncodeServer::~EncodeServer ()
82 boost::mutex::scoped_lock lm (_mutex);
84 _empty_condition.notify_all ();
85 _full_condition.notify_all ();
88 BOOST_FOREACH (boost::thread* i, _worker_threads) {
89 /* Ideally this would be a DCPOMATIC_ASSERT(i->joinable()) but we
90 can't throw exceptions from a destructor.
98 if (_broadcast.socket) {
99 _broadcast.socket->close ();
101 _broadcast.io_service.stop ();
102 if (_broadcast.thread) {
103 /* Ideally this would be a DCPOMATIC_ASSERT(_broadcast.thread->joinable()) but we
104 can't throw exceptions from a destructor.
106 if (_broadcast.thread->joinable ()) {
107 _broadcast.thread->join ();
109 delete _broadcast.thread;
113 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
114 * @param after_encode Filled in with gettimeofday() after encoding the image.
117 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
119 uint32_t length = socket->read_uint32 ();
120 scoped_array<char> buffer (new char[length]);
121 socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
123 string s (buffer.get());
124 shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
125 xml->read_string (s);
126 /* This is a double-check; the server shouldn't even be on the candidate list
127 if it is the wrong version, but it doesn't hurt to make sure here.
129 if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
130 cerr << "Mismatched server/client versions\n";
131 LOG_ERROR_NC ("Mismatched server/client versions");
135 shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
137 DCPVideo dcp_video_frame (pvf, xml, _log);
139 gettimeofday (&after_read, 0);
141 Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
143 gettimeofday (&after_encode, 0);
146 socket->write (encoded.size());
147 socket->write (encoded.data().get(), encoded.size());
148 } catch (std::exception& e) {
149 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
150 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
154 return dcp_video_frame.index ();
158 EncodeServer::worker_thread ()
161 boost::mutex::scoped_lock lock (_mutex);
162 while (_queue.empty () && !_terminate) {
163 _empty_condition.wait (lock);
170 shared_ptr<Socket> socket = _queue.front ();
178 struct timeval start;
179 struct timeval after_read;
180 struct timeval after_encode;
183 gettimeofday (&start, 0);
186 frame = process (socket, after_read, after_encode);
187 ip = socket->socket().remote_endpoint().address().to_string();
188 } catch (std::exception& e) {
189 cerr << "Error: " << e.what() << "\n";
190 LOG_ERROR ("Error: %1", e.what());
193 gettimeofday (&end, 0);
201 gettimeofday (&end, 0);
203 shared_ptr<EncodedLogEntry> e (
204 new EncodedLogEntry (
206 seconds(after_read) - seconds(start),
207 seconds(after_encode) - seconds(after_read),
208 seconds(end) - seconds(after_encode)
213 cout << e->get() << "\n";
219 _full_condition.notify_all ();
226 LOG_GENERAL ("Server %1 (%2) starting with %3 threads", dcpomatic_version, dcpomatic_git_commit, _num_threads);
228 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
231 for (int i = 0; i < _num_threads; ++i) {
232 thread* t = new thread (bind (&EncodeServer::worker_thread, this));
233 #ifdef DCPOMATIC_LINUX
234 pthread_setname_np (t->native_handle(), "encode-server-worker");
236 _worker_threads.push_back (t);
239 _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
240 #ifdef DCPOMATIC_LINUX
241 pthread_setname_np (_broadcast.thread->native_handle(), "encode-server-broadcast");
248 EncodeServer::broadcast_thread ()
251 boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
252 boost::asio::ip::udp::endpoint listen_endpoint (address, HELLO_PORT);
254 _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
255 _broadcast.socket->open (listen_endpoint.protocol ());
256 _broadcast.socket->bind (listen_endpoint);
258 _broadcast.socket->async_receive_from (
259 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
260 _broadcast.send_endpoint,
261 boost::bind (&EncodeServer::broadcast_received, this)
264 _broadcast.io_service.run ();
272 EncodeServer::broadcast_received ()
274 _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
276 if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
277 /* Reply to the client saying what we can do */
279 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
280 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
281 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
282 string xml = doc.write_to_string ("UTF-8");
285 cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
289 shared_ptr<Socket> socket (new Socket);
290 socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), MAIN_SERVER_PRESENCE_PORT));
291 socket->write (xml.length() + 1);
292 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
298 shared_ptr<Socket> socket (new Socket);
299 socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), BATCH_SERVER_PRESENCE_PORT));
300 socket->write (xml.length() + 1);
301 socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
307 _broadcast.socket->async_receive_from (
308 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
309 _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
314 EncodeServer::handle (shared_ptr<Socket> socket)
316 boost::mutex::scoped_lock lock (_mutex);
318 /* Wait until the queue has gone down a bit */
319 while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
320 _full_condition.wait (lock);
323 _queue.push_back (socket);
324 _empty_condition.notify_all ();