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