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