src/lib/encode_server.cc

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