src/lib/encode_server.cc

   1 /*
   2     Copyright (C) 2012-2018 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of DCP-o-matic.
   5
   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.
  10
  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.
  15
  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/>.
  18
  19 */
  20
  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.
  24  */
  25
  26 #include "encode_server.h"
  27 #include "util.h"
  28 #include "dcpomatic_socket.h"
  29 #include "image.h"
  30 #include "dcp_video.h"
  31 #include "config.h"
  32 #include "cross.h"
  33 #include "player_video.h"
  34 #include "compose.hpp"
  35 #include "log.h"
  36 #include "encoded_log_entry.h"
  37 #include "version.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>
  44 #include <string>
  45 #include <vector>
  46 #include <iostream>
  47
  48 #include "i18n.h"
  49
  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);
  54
  55 using std::string;
  56 using std::vector;
  57 using std::list;
  58 using std::cout;
  59 using std::cerr;
  60 using std::fixed;
  61 using boost::shared_ptr;
  62 using boost::thread;
  63 using boost::bind;
  64 using boost::scoped_array;
  65 using boost::optional;
  66 using dcp::Size;
  67 using dcp::Data;
  68 using dcp::raw_convert;
  69
  70 EncodeServer::EncodeServer (shared_ptr<Log> log, bool verbose, int num_threads)
  71         : Server (ENCODE_FRAME_PORT)
  72         , _log (log)
  73         , _verbose (verbose)
  74         , _num_threads (num_threads)
  75 {
  76
  77 }
  78
  79 EncodeServer::~EncodeServer ()
  80 {
  81         {
  82                 boost::mutex::scoped_lock lm (_mutex);
  83                 _terminate = true;
  84                 _empty_condition.notify_all ();
  85                 _full_condition.notify_all ();
  86         }
  87
  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.
  91                 */
  92                 if (i->joinable ()) {
  93                         i->join ();
  94                 }
  95                 delete i;
  96         }
  97
  98         if (_broadcast.socket) {
  99                 _broadcast.socket->close ();
 100         }
 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.
 105                 */
 106                 if (_broadcast.thread->joinable ()) {
 107                         _broadcast.thread->join ();
 108                 }
 109                 delete _broadcast.thread;
 110         }
 111 }
 112
 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.
 115  */
 116 int
 117 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 118 {
 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);
 122
 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.
 128         */
 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");
 132                 return -1;
 133         }
 134
 135         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 136
 137         DCPVideo dcp_video_frame (pvf, xml, _log);
 138
 139         gettimeofday (&after_read, 0);
 140
 141         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
 142
 143         gettimeofday (&after_encode, 0);
 144
 145         try {
 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());
 151                 throw;
 152         }
 153
 154         return dcp_video_frame.index ();
 155 }
 156
 157 void
 158 EncodeServer::worker_thread ()
 159 {
 160         while (true) {
 161                 boost::mutex::scoped_lock lock (_mutex);
 162                 while (_queue.empty () && !_terminate) {
 163                         _empty_condition.wait (lock);
 164                 }
 165
 166                 if (_terminate) {
 167                         return;
 168                 }
 169
 170                 shared_ptr<Socket> socket = _queue.front ();
 171                 _queue.pop_front ();
 172
 173                 lock.unlock ();
 174
 175                 int frame = -1;
 176                 string ip;
 177
 178                 struct timeval start;
 179                 struct timeval after_read;
 180                 struct timeval after_encode;
 181                 struct timeval end;
 182
 183                 gettimeofday (&start, 0);
 184
 185                 try {
 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());
 191                 }
 192
 193                 gettimeofday (&end, 0);
 194
 195                 socket.reset ();
 196
 197                 lock.lock ();
 198
 199                 if (frame >= 0) {
 200                         struct timeval end;
 201                         gettimeofday (&end, 0);
 202
 203                         shared_ptr<EncodedLogEntry> e (
 204                                 new EncodedLogEntry (
 205                                         frame, ip,
 206                                         seconds(after_read) - seconds(start),
 207                                         seconds(after_encode) - seconds(after_read),
 208                                         seconds(end) - seconds(after_encode)
 209                                         )
 210                                 );
 211
 212                         if (_verbose) {
 213                                 cout << e->get() << "\n";
 214                         }
 215
 216                         _log->log (e);
 217                 }
 218
 219                 _full_condition.notify_all ();
 220         }
 221 }
 222
 223 void
 224 EncodeServer::run ()
 225 {
 226         LOG_GENERAL ("Server %1 (%2) starting with %3 threads", dcpomatic_version, dcpomatic_git_commit, _num_threads);
 227         if (_verbose) {
 228                 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
 229         }
 230
 231         for (int i = 0; i < _num_threads; ++i) {
 232                 _worker_threads.push_back (new thread (bind (&EncodeServer::worker_thread, this)));
 233         }
 234
 235         _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
 236
 237         Server::run ();
 238 }
 239
 240 void
 241 EncodeServer::broadcast_thread ()
 242 try
 243 {
 244         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
 245         boost::asio::ip::udp::endpoint listen_endpoint (address, HELLO_PORT);
 246
 247         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
 248         _broadcast.socket->open (listen_endpoint.protocol ());
 249         _broadcast.socket->bind (listen_endpoint);
 250
 251         _broadcast.socket->async_receive_from (
 252                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 253                 _broadcast.send_endpoint,
 254                 boost::bind (&EncodeServer::broadcast_received, this)
 255                 );
 256
 257         _broadcast.io_service.run ();
 258 }
 259 catch (...)
 260 {
 261         store_current ();
 262 }
 263
 264 void
 265 EncodeServer::broadcast_received ()
 266 {
 267         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
 268
 269         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
 270                 /* Reply to the client saying what we can do */
 271                 xmlpp::Document doc;
 272                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
 273                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
 274                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 275                 string xml = doc.write_to_string ("UTF-8");
 276
 277                 if (_verbose) {
 278                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
 279                 }
 280
 281                 try {
 282                         shared_ptr<Socket> socket (new Socket);
 283                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), MAIN_SERVER_PRESENCE_PORT));
 284                         socket->write (xml.length() + 1);
 285                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 286                 } catch (...) {
 287
 288                 }
 289
 290                 try {
 291                         shared_ptr<Socket> socket (new Socket);
 292                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), BATCH_SERVER_PRESENCE_PORT));
 293                         socket->write (xml.length() + 1);
 294                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 295                 } catch (...) {
 296
 297                 }
 298         }
 299
 300         _broadcast.socket->async_receive_from (
 301                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 302                 _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
 303                 );
 304 }
 305
 306 void
 307 EncodeServer::handle (shared_ptr<Socket> socket)
 308 {
 309         boost::mutex::scoped_lock lock (_mutex);
 310
 311         /* Wait until the queue has gone down a bit */
 312         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 313                 _full_condition.wait (lock);
 314         }
 315
 316         _queue.push_back (socket);
 317         _empty_condition.notify_all ();
 318 }