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 "safe_stringstream.h"
  35 #include "raw_convert.h"
  36 #include "compose.hpp"
  37 #include "log.h"
  38 #include "encoded_log_entry.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 <boost/make_shared.hpp>
  45 #include <string>
  46 #include <vector>
  47 #include <iostream>
  48
  49 #include "i18n.h"
  50
  51 #define LOG_GENERAL(...)    _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_GENERAL);
  52 #define LOG_GENERAL_NC(...) _log->log (__VA_ARGS__, LogEntry::TYPE_GENERAL);
  53 #define LOG_ERROR(...)      _log->log (String::compose (__VA_ARGS__), LogEntry::TYPE_ERROR);
  54 #define LOG_ERROR_NC(...)   _log->log (__VA_ARGS__, LogEntry::TYPE_ERROR);
  55
  56 using std::string;
  57 using std::vector;
  58 using std::list;
  59 using std::cout;
  60 using std::cerr;
  61 using std::fixed;
  62 using boost::shared_ptr;
  63 using boost::thread;
  64 using boost::bind;
  65 using boost::scoped_array;
  66 using boost::optional;
  67 using boost::make_shared;
  68 using dcp::Size;
  69 using dcp::Data;
  70
  71 EncodeServer::EncodeServer (shared_ptr<Log> log, bool verbose, int num_threads)
  72         : Server (Config::instance()->server_port_base())
  73         , _log (log)
  74         , _verbose (verbose)
  75         , _num_threads (num_threads)
  76 {
  77
  78 }
  79
  80 EncodeServer::~EncodeServer ()
  81 {
  82         {
  83                 boost::mutex::scoped_lock lm (_mutex);
  84                 _terminate = true;
  85                 _empty_condition.notify_all ();
  86                 _full_condition.notify_all ();
  87         }
  88
  89         BOOST_FOREACH (boost::thread* i, _worker_threads) {
  90                 DCPOMATIC_ASSERT (i->joinable ());
  91                 i->join ();
  92                 delete i;
  93         }
  94
  95         _broadcast.io_service.stop ();
  96         if (_broadcast.thread) {
  97                 DCPOMATIC_ASSERT (_broadcast.thread->joinable ());
  98                 _broadcast.thread->join ();
  99         }
 100 }
 101
 102 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
 103  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 104  */
 105 int
 106 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 107 {
 108         uint32_t length = socket->read_uint32 ();
 109         scoped_array<char> buffer (new char[length]);
 110         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 111
 112         string s (buffer.get());
 113         shared_ptr<cxml::Document> xml = make_shared<cxml::Document> ("EncodingRequest");
 114         xml->read_string (s);
 115         /* This is a double-check; the server shouldn't even be on the candidate list
 116            if it is the wrong version, but it doesn't hurt to make sure here.
 117         */
 118         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 119                 cerr << "Mismatched server/client versions\n";
 120                 LOG_ERROR_NC ("Mismatched server/client versions");
 121                 return -1;
 122         }
 123
 124         shared_ptr<PlayerVideo> pvf = make_shared<PlayerVideo> (xml, socket);
 125
 126         DCPVideo dcp_video_frame (pvf, xml, _log);
 127
 128         gettimeofday (&after_read, 0);
 129
 130         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
 131
 132         gettimeofday (&after_encode, 0);
 133
 134         try {
 135                 socket->write (encoded.size());
 136                 socket->write (encoded.data().get(), encoded.size());
 137         } catch (std::exception& e) {
 138                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
 139                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
 140                 throw;
 141         }
 142
 143         return dcp_video_frame.index ();
 144 }
 145
 146 void
 147 EncodeServer::worker_thread ()
 148 {
 149         while (true) {
 150                 boost::mutex::scoped_lock lock (_mutex);
 151                 while (_queue.empty () && !_terminate) {
 152                         _empty_condition.wait (lock);
 153                 }
 154
 155                 if (_terminate) {
 156                         return;
 157                 }
 158
 159                 shared_ptr<Socket> socket = _queue.front ();
 160                 _queue.pop_front ();
 161
 162                 lock.unlock ();
 163
 164                 int frame = -1;
 165                 string ip;
 166
 167                 struct timeval start;
 168                 struct timeval after_read;
 169                 struct timeval after_encode;
 170                 struct timeval end;
 171
 172                 gettimeofday (&start, 0);
 173
 174                 try {
 175                         frame = process (socket, after_read, after_encode);
 176                         ip = socket->socket().remote_endpoint().address().to_string();
 177                 } catch (std::exception& e) {
 178                         cerr << "Error: " << e.what() << "\n";
 179                         LOG_ERROR ("Error: %1", e.what());
 180                 }
 181
 182                 gettimeofday (&end, 0);
 183
 184                 socket.reset ();
 185
 186                 lock.lock ();
 187
 188                 if (frame >= 0) {
 189                         struct timeval end;
 190                         gettimeofday (&end, 0);
 191
 192                         shared_ptr<EncodedLogEntry> e (
 193                                 new EncodedLogEntry (
 194                                         frame, ip,
 195                                         seconds(after_read) - seconds(start),
 196                                         seconds(after_encode) - seconds(after_read),
 197                                         seconds(end) - seconds(after_encode)
 198                                         )
 199                                 );
 200
 201                         if (_verbose) {
 202                                 cout << e->get() << "\n";
 203                         }
 204
 205                         _log->log (e);
 206                 }
 207
 208                 _full_condition.notify_all ();
 209         }
 210 }
 211
 212 void
 213 EncodeServer::run ()
 214 {
 215         LOG_GENERAL ("Server starting with %1 threads", _num_threads);
 216         if (_verbose) {
 217                 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
 218         }
 219
 220         for (int i = 0; i < _num_threads; ++i) {
 221                 _worker_threads.push_back (new thread (bind (&EncodeServer::worker_thread, this)));
 222         }
 223
 224         _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
 225
 226         Server::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 = make_shared<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::handle (shared_ptr<Socket> socket)
 287 {
 288         boost::mutex::scoped_lock lock (_mutex);
 289
 290         /* Wait until the queue has gone down a bit */
 291         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 292                 _full_condition.wait (lock);
 293         }
 294
 295         _queue.push_back (socket);
 296         _empty_condition.notify_all ();
 297 }