Move ServerDescription into its own header.
[dcpomatic.git] / src / lib / server.cc
1 /*
2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 /** @file src/server.cc
21  *  @brief Class to describe a server to which we can send
22  *  encoding work, and a class to implement such a server.
23  */
24
25 #include "server.h"
26 #include "dcpomatic_socket.h"
27 #include "image.h"
28 #include "dcp_video.h"
29 #include "config.h"
30 #include "cross.h"
31 #include "player_video.h"
32 #include "data.h"
33 #include "safe_stringstream.h"
34 #include "raw_convert.h"
35 #include "compose.hpp"
36 #include "log.h"
37 #include <libcxml/cxml.h>
38 #include <boost/algorithm/string.hpp>
39 #include <boost/scoped_array.hpp>
40 #include <string>
41 #include <vector>
42 #include <iostream>
43
44 #include "i18n.h"
45
46 #define LOG_GENERAL(...)    _log->log (String::compose (__VA_ARGS__), Log::TYPE_GENERAL);
47 #define LOG_GENERAL_NC(...) _log->log (__VA_ARGS__, Log::TYPE_GENERAL);
48 #define LOG_ERROR(...)      _log->log (String::compose (__VA_ARGS__), Log::TYPE_ERROR);
49 #define LOG_ERROR_NC(...)   _log->log (__VA_ARGS__, Log::TYPE_ERROR);
50
51 using std::string;
52 using std::vector;
53 using std::list;
54 using std::cout;
55 using std::cerr;
56 using std::fixed;
57 using boost::shared_ptr;
58 using boost::thread;
59 using boost::bind;
60 using boost::scoped_array;
61 using boost::optional;
62 using dcp::Size;
63
64 Server::Server (shared_ptr<Log> log, bool verbose)
65         : _terminate (false)
66         , _log (log)
67         , _verbose (verbose)
68         , _acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), Config::instance()->server_port_base()))
69 {
70
71 }
72
73 Server::~Server ()
74 {
75         {
76                 boost::mutex::scoped_lock lm (_worker_mutex);
77                 _terminate = true;
78                 _empty_condition.notify_all ();
79         }
80
81         for (vector<boost::thread*>::iterator i = _worker_threads.begin(); i != _worker_threads.end(); ++i) {
82                 (*i)->join ();
83                 delete *i;
84         }
85
86         _io_service.stop ();
87
88         _broadcast.io_service.stop ();
89         _broadcast.thread->join ();
90 }
91
92 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
93  *  @param after_encode Filled in with gettimeofday() after encoding the image.
94  */
95 int
96 Server::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
97 {
98         uint32_t length = socket->read_uint32 ();
99         scoped_array<char> buffer (new char[length]);
100         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
101
102         string s (buffer.get());
103         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
104         xml->read_string (s);
105         /* This is a double-check; the server shouldn't even be on the candidate list
106            if it is the wrong version, but it doesn't hurt to make sure here.
107         */
108         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
109                 cerr << "Mismatched server/client versions\n";
110                 LOG_ERROR_NC ("Mismatched server/client versions");
111                 return -1;
112         }
113
114         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
115
116         DCPVideo dcp_video_frame (pvf, xml, _log);
117
118         gettimeofday (&after_read, 0);
119
120         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
121
122         gettimeofday (&after_encode, 0);
123
124         try {
125                 socket->write (encoded.size ());
126                 socket->write (encoded.data ().get (), encoded.size ());
127         } catch (std::exception& e) {
128                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
129                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
130                 throw;
131         }
132
133         return dcp_video_frame.index ();
134 }
135
136 void
137 Server::worker_thread ()
138 {
139         while (true) {
140                 boost::mutex::scoped_lock lock (_worker_mutex);
141                 while (_queue.empty () && !_terminate) {
142                         _empty_condition.wait (lock);
143                 }
144
145                 if (_terminate) {
146                         return;
147                 }
148
149                 shared_ptr<Socket> socket = _queue.front ();
150                 _queue.pop_front ();
151
152                 lock.unlock ();
153
154                 int frame = -1;
155                 string ip;
156
157                 struct timeval start;
158                 struct timeval after_read;
159                 struct timeval after_encode;
160                 struct timeval end;
161
162                 gettimeofday (&start, 0);
163
164                 try {
165                         frame = process (socket, after_read, after_encode);
166                         ip = socket->socket().remote_endpoint().address().to_string();
167                 } catch (std::exception& e) {
168                         cerr << "Error: " << e.what() << "\n";
169                         LOG_ERROR ("Error: %1", e.what());
170                 }
171
172                 gettimeofday (&end, 0);
173
174                 socket.reset ();
175
176                 lock.lock ();
177
178                 if (frame >= 0) {
179                         struct timeval end;
180                         gettimeofday (&end, 0);
181
182                         SafeStringStream message;
183                         message.precision (2);
184                         message << fixed
185                                 << "Encoded frame " << frame << " from " << ip << ": "
186                                 << "receive " << (seconds(after_read) - seconds(start)) << "s "
187                                 << "encode " << (seconds(after_encode) - seconds(after_read)) << "s "
188                                 << "send " << (seconds(end) - seconds(after_encode)) << "s.";
189
190                         if (_verbose) {
191                                 cout << message.str() << "\n";
192                         }
193
194                         LOG_GENERAL_NC (message.str ());
195                 }
196
197                 _full_condition.notify_all ();
198         }
199 }
200
201 void
202 Server::run (int num_threads)
203 {
204         LOG_GENERAL ("Server starting with %1 threads", num_threads);
205         if (_verbose) {
206                 cout << "DCP-o-matic server starting with " << num_threads << " threads.\n";
207         }
208
209         for (int i = 0; i < num_threads; ++i) {
210                 _worker_threads.push_back (new thread (bind (&Server::worker_thread, this)));
211         }
212
213         _broadcast.thread = new thread (bind (&Server::broadcast_thread, this));
214
215         start_accept ();
216         _io_service.run ();
217 }
218
219 void
220 Server::broadcast_thread ()
221 try
222 {
223         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
224         boost::asio::ip::udp::endpoint listen_endpoint (address, Config::instance()->server_port_base() + 1);
225
226         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
227         _broadcast.socket->open (listen_endpoint.protocol ());
228         _broadcast.socket->bind (listen_endpoint);
229
230         _broadcast.socket->async_receive_from (
231                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
232                 _broadcast.send_endpoint,
233                 boost::bind (&Server::broadcast_received, this)
234                 );
235
236         _broadcast.io_service.run ();
237 }
238 catch (...)
239 {
240         store_current ();
241 }
242
243 void
244 Server::broadcast_received ()
245 {
246         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
247
248         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
249                 /* Reply to the client saying what we can do */
250                 xmlpp::Document doc;
251                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
252                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
253                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
254                 string xml = doc.write_to_string ("UTF-8");
255
256                 if (_verbose) {
257                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
258                 }
259                 shared_ptr<Socket> socket (new Socket);
260                 try {
261                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), Config::instance()->server_port_base() + 1));
262                         socket->write (xml.length() + 1);
263                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
264                 } catch (...) {
265
266                 }
267         }
268
269         _broadcast.socket->async_receive_from (
270                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
271                 _broadcast.send_endpoint, boost::bind (&Server::broadcast_received, this)
272                 );
273 }
274
275 void
276 Server::start_accept ()
277 {
278         if (_terminate) {
279                 return;
280         }
281
282         shared_ptr<Socket> socket (new Socket);
283         _acceptor.async_accept (socket->socket (), boost::bind (&Server::handle_accept, this, socket, boost::asio::placeholders::error));
284 }
285
286 void
287 Server::handle_accept (shared_ptr<Socket> socket, boost::system::error_code const & error)
288 {
289         if (error) {
290                 return;
291         }
292
293         boost::mutex::scoped_lock lock (_worker_mutex);
294
295         /* Wait until the queue has gone down a bit */
296         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
297                 _full_condition.wait (lock);
298         }
299
300         _queue.push_back (socket);
301         _empty_condition.notify_all ();
302
303         start_accept ();
304 }