src/lib/encode_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/encode_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 "encode_server.h"
  26 #include "util.h"
  27 #include "dcpomatic_socket.h"
  28 #include "image.h"
  29 #include "dcp_video.h"
  30 #include "config.h"
  31 #include "cross.h"
  32 #include "player_video.h"
  33 #include "safe_stringstream.h"
  34 #include "raw_convert.h"
  35 #include "compose.hpp"
  36 #include "log.h"
  37 #include "encoded_log_entry.h"
  38 #include <libcxml/cxml.h>
  39 #include <libxml++/libxml++.h>
  40 #include <boost/algorithm/string.hpp>
  41 #include <boost/scoped_array.hpp>
  42 #include <boost/foreach.hpp>
  43 #include <string>
  44 #include <vector>
  45 #include <iostream>
  46
  47 #include "i18n.h"
  48
  49 #define LOG_GENERAL(...)    _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  50 #define LOG_GENERAL_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  51 #define LOG_ERROR(...)      _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  52 #define LOG_ERROR_NC(...)   _log->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
  53
  54 using std::string;
  55 using std::vector;
  56 using std::list;
  57 using std::cout;
  58 using std::cerr;
  59 using std::fixed;
  60 using boost::shared_ptr;
  61 using boost::thread;
  62 using boost::bind;
  63 using boost::scoped_array;
  64 using boost::optional;
  65 using dcp::Size;
  66 using dcp::Data;
  67
  68 EncodeServer::EncodeServer (shared_ptr<Log> log, bool verbose)
  69         : _terminate (false)
  70         , _log (log)
  71         , _verbose (verbose)
  72         , _acceptor (_io_service, boost::asio::ip::tcp::endpoint (boost::asio::ip::tcp::v4(), Config::instance()->server_port_base()))
  73 {
  74
  75 }
  76
  77 EncodeServer::~EncodeServer ()
  78 {
  79         {
  80                 boost::mutex::scoped_lock lm (_worker_mutex);
  81                 _terminate = true;
  82                 _empty_condition.notify_all ();
  83                 _full_condition.notify_all ();
  84         }
  85
  86         BOOST_FOREACH (boost::thread* i, _worker_threads) {
  87                 DCPOMATIC_ASSERT (i->joinable ());
  88                 i->join ();
  89                 delete i;
  90         }
  91
  92         _io_service.stop ();
  93
  94         _broadcast.io_service.stop ();
  95         if (_broadcast.thread) {
  96                 DCPOMATIC_ASSERT (_broadcast.thread->joinable ());
  97                 _broadcast.thread->join ();
  98         }
  99 }
 100
 101 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
 102  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 103  */
 104 int
 105 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 106 {
 107         uint32_t length = socket->read_uint32 ();
 108         scoped_array<char> buffer (new char[length]);
 109         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 110
 111         string s (buffer.get());
 112         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
 113         xml->read_string (s);
 114         /* This is a double-check; the server shouldn't even be on the candidate list
 115            if it is the wrong version, but it doesn't hurt to make sure here.
 116         */
 117         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 118                 cerr << "Mismatched server/client versions\n";
 119                 LOG_ERROR_NC ("Mismatched server/client versions");
 120                 return -1;
 121         }
 122
 123         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 124
 125         DCPVideo dcp_video_frame (pvf, xml, _log);
 126
 127         gettimeofday (&after_read, 0);
 128
 129         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
 130
 131         gettimeofday (&after_encode, 0);
 132
 133         try {
 134                 socket->write (encoded.size());
 135                 socket->write (encoded.data().get(), encoded.size());
 136         } catch (std::exception& e) {
 137                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
 138                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
 139                 throw;
 140         }
 141
 142         return dcp_video_frame.index ();
 143 }
 144
 145 void
 146 EncodeServer::worker_thread ()
 147 {
 148         while (true) {
 149                 boost::mutex::scoped_lock lock (_worker_mutex);
 150                 while (_queue.empty () && !_terminate) {
 151                         _empty_condition.wait (lock);
 152                 }
 153
 154                 if (_terminate) {
 155                         return;
 156                 }
 157
 158                 shared_ptr<Socket> socket = _queue.front ();
 159                 _queue.pop_front ();
 160
 161                 lock.unlock ();
 162
 163                 int frame = -1;
 164                 string ip;
 165
 166                 struct timeval start;
 167                 struct timeval after_read;
 168                 struct timeval after_encode;
 169                 struct timeval end;
 170
 171                 gettimeofday (&start, 0);
 172
 173                 try {
 174                         frame = process (socket, after_read, after_encode);
 175                         ip = socket->socket().remote_endpoint().address().to_string();
 176                 } catch (std::exception& e) {
 177                         cerr << "Error: " << e.what() << "\n";
 178                         LOG_ERROR ("Error: %1", e.what());
 179                 }
 180
 181                 gettimeofday (&end, 0);
 182
 183                 socket.reset ();
 184
 185                 lock.lock ();
 186
 187                 if (frame >= 0) {
 188                         struct timeval end;
 189                         gettimeofday (&end, 0);
 190
 191                         shared_ptr<EncodedLogEntry> e (
 192                                 new EncodedLogEntry (
 193                                         frame, ip,
 194                                         seconds(after_read) - seconds(start),
 195                                         seconds(after_encode) - seconds(after_read),
 196                                         seconds(end) - seconds(after_encode)
 197                                         )
 198                                 );
 199
 200                         if (_verbose) {
 201                                 cout << e->get() << "\n";
 202                         }
 203
 204                         _log->log (e);
 205                 }
 206
 207                 _full_condition.notify_all ();
 208         }
 209 }
 210
 211 void
 212 EncodeServer::run (int num_threads)
 213 {
 214         LOG_GENERAL ("Server starting with %1 threads", num_threads);
 215         if (_verbose) {
 216                 cout << "DCP-o-matic server starting with " << num_threads << " threads.\n";
 217         }
 218
 219         for (int i = 0; i < num_threads; ++i) {
 220                 _worker_threads.push_back (new thread (bind (&EncodeServer::worker_thread, this)));
 221         }
 222
 223         _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
 224
 225         start_accept ();
 226         _io_service.run ();
 227 }
 228
 229 void
 230 EncodeServer::broadcast_thread ()
 231 try
 232 {
 233         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
 234         boost::asio::ip::udp::endpoint listen_endpoint (address, Config::instance()->server_port_base() + 1);
 235
 236         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
 237         _broadcast.socket->open (listen_endpoint.protocol ());
 238         _broadcast.socket->bind (listen_endpoint);
 239
 240         _broadcast.socket->async_receive_from (
 241                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 242                 _broadcast.send_endpoint,
 243                 boost::bind (&EncodeServer::broadcast_received, this)
 244                 );
 245
 246         _broadcast.io_service.run ();
 247 }
 248 catch (...)
 249 {
 250         store_current ();
 251 }
 252
 253 void
 254 EncodeServer::broadcast_received ()
 255 {
 256         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
 257
 258         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
 259                 /* Reply to the client saying what we can do */
 260                 xmlpp::Document doc;
 261                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
 262                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
 263                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 264                 string xml = doc.write_to_string ("UTF-8");
 265
 266                 if (_verbose) {
 267                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
 268                 }
 269                 shared_ptr<Socket> socket (new Socket);
 270                 try {
 271                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), Config::instance()->server_port_base() + 1));
 272                         socket->write (xml.length() + 1);
 273                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 274                 } catch (...) {
 275
 276                 }
 277         }
 278
 279         _broadcast.socket->async_receive_from (
 280                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 281                 _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
 282                 );
 283 }
 284
 285 void
 286 EncodeServer::start_accept ()
 287 {
 288         if (_terminate) {
 289                 return;
 290         }
 291
 292         shared_ptr<Socket> socket (new Socket);
 293         _acceptor.async_accept (socket->socket (), boost::bind (&EncodeServer::handle_accept, this, socket, boost::asio::placeholders::error));
 294 }
 295
 296 void
 297 EncodeServer::handle_accept (shared_ptr<Socket> socket, boost::system::error_code const & error)
 298 {
 299         if (error) {
 300                 return;
 301         }
 302
 303         boost::mutex::scoped_lock lock (_worker_mutex);
 304
 305         /* Wait until the queue has gone down a bit */
 306         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 307                 _full_condition.wait (lock);
 308         }
 309
 310         _queue.push_back (socket);
 311         _empty_condition.notify_all ();
 312
 313         start_accept ();
 314 }