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