src/lib/encode_server.cc

   1 /*
   2     Copyright (C) 2012-2015 Carl Hetherington <cth@carlh.net>
   3
   4     This program is free software; you can redistribute it and/or modify
   5     it under the terms of the GNU General Public License as published by
   6     the Free Software Foundation; either version 2 of the License, or
   7     (at your option) any later version.
   8
   9     This program is distributed in the hope that it will be useful,
  10     but WITHOUT ANY WARRANTY; without even the implied warranty of
  11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12     GNU General Public License for more details.
  13
  14     You should have received a copy of the GNU General Public License
  15     along with this program; if not, write to the Free Software
  16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
  17
  18 */
  19
  20 /** @file src/encode_server.cc
  21  *  @brief Class to describe a server to which we can send
  22  *  encoding work, and a class to implement such a server.
  23  */
  24
  25 #include "encode_server.h"
  26 #include "util.h"
  27 #include "dcpomatic_socket.h"
  28 #include "image.h"
  29 #include "dcp_video.h"
  30 #include "config.h"
  31 #include "cross.h"
  32 #include "player_video.h"
  33 #include "safe_stringstream.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                 _empty_condition.notify_all ();
  82                 _full_condition.notify_all ();
  83         }
  84
  85         BOOST_FOREACH (boost::thread* i, _worker_threads) {
  86                 DCPOMATIC_ASSERT (i->joinable ());
  87                 i->join ();
  88                 delete i;
  89         }
  90
  91         _broadcast.io_service.stop ();
  92         if (_broadcast.thread) {
  93                 DCPOMATIC_ASSERT (_broadcast.thread->joinable ());
  94                 _broadcast.thread->join ();
  95         }
  96 }
  97
  98 /** @param after_read Filled in with gettimeofday() after reading the input from the network.
  99  *  @param after_encode Filled in with gettimeofday() after encoding the image.
 100  */
 101 int
 102 EncodeServer::process (shared_ptr<Socket> socket, struct timeval& after_read, struct timeval& after_encode)
 103 {
 104         uint32_t length = socket->read_uint32 ();
 105         scoped_array<char> buffer (new char[length]);
 106         socket->read (reinterpret_cast<uint8_t*> (buffer.get()), length);
 107
 108         string s (buffer.get());
 109         shared_ptr<cxml::Document> xml (new cxml::Document ("EncodingRequest"));
 110         xml->read_string (s);
 111         /* This is a double-check; the server shouldn't even be on the candidate list
 112            if it is the wrong version, but it doesn't hurt to make sure here.
 113         */
 114         if (xml->number_child<int> ("Version") != SERVER_LINK_VERSION) {
 115                 cerr << "Mismatched server/client versions\n";
 116                 LOG_ERROR_NC ("Mismatched server/client versions");
 117                 return -1;
 118         }
 119
 120         shared_ptr<PlayerVideo> pvf (new PlayerVideo (xml, socket));
 121
 122         DCPVideo dcp_video_frame (pvf, xml, _log);
 123
 124         gettimeofday (&after_read, 0);
 125
 126         Data encoded = dcp_video_frame.encode_locally (boost::bind (&Log::dcp_log, _log.get(), _1, _2));
 127
 128         gettimeofday (&after_encode, 0);
 129
 130         try {
 131                 socket->write (encoded.size());
 132                 socket->write (encoded.data().get(), encoded.size());
 133         } catch (std::exception& e) {
 134                 cerr << "Send failed; frame " << dcp_video_frame.index() << "\n";
 135                 LOG_ERROR ("Send failed; frame %1", dcp_video_frame.index());
 136                 throw;
 137         }
 138
 139         return dcp_video_frame.index ();
 140 }
 141
 142 void
 143 EncodeServer::worker_thread ()
 144 {
 145         while (true) {
 146                 boost::mutex::scoped_lock lock (_mutex);
 147                 while (_queue.empty () && !_terminate) {
 148                         _empty_condition.wait (lock);
 149                 }
 150
 151                 if (_terminate) {
 152                         return;
 153                 }
 154
 155                 shared_ptr<Socket> socket = _queue.front ();
 156                 _queue.pop_front ();
 157
 158                 lock.unlock ();
 159
 160                 int frame = -1;
 161                 string ip;
 162
 163                 struct timeval start;
 164                 struct timeval after_read;
 165                 struct timeval after_encode;
 166                 struct timeval end;
 167
 168                 gettimeofday (&start, 0);
 169
 170                 try {
 171                         frame = process (socket, after_read, after_encode);
 172                         ip = socket->socket().remote_endpoint().address().to_string();
 173                 } catch (std::exception& e) {
 174                         cerr << "Error: " << e.what() << "\n";
 175                         LOG_ERROR ("Error: %1", e.what());
 176                 }
 177
 178                 gettimeofday (&end, 0);
 179
 180                 socket.reset ();
 181
 182                 lock.lock ();
 183
 184                 if (frame >= 0) {
 185                         struct timeval end;
 186                         gettimeofday (&end, 0);
 187
 188                         shared_ptr<EncodedLogEntry> e (
 189                                 new EncodedLogEntry (
 190                                         frame, ip,
 191                                         seconds(after_read) - seconds(start),
 192                                         seconds(after_encode) - seconds(after_read),
 193                                         seconds(end) - seconds(after_encode)
 194                                         )
 195                                 );
 196
 197                         if (_verbose) {
 198                                 cout << e->get() << "\n";
 199                         }
 200
 201                         _log->log (e);
 202                 }
 203
 204                 _full_condition.notify_all ();
 205         }
 206 }
 207
 208 void
 209 EncodeServer::run ()
 210 {
 211         LOG_GENERAL ("Server starting with %1 threads", _num_threads);
 212         if (_verbose) {
 213                 cout << "DCP-o-matic server starting with " << _num_threads << " threads.\n";
 214         }
 215
 216         for (int i = 0; i < _num_threads; ++i) {
 217                 _worker_threads.push_back (new thread (bind (&EncodeServer::worker_thread, this)));
 218         }
 219
 220         _broadcast.thread = new thread (bind (&EncodeServer::broadcast_thread, this));
 221
 222         Server::run ();
 223 }
 224
 225 void
 226 EncodeServer::broadcast_thread ()
 227 try
 228 {
 229         boost::asio::ip::address address = boost::asio::ip::address_v4::any ();
 230         boost::asio::ip::udp::endpoint listen_endpoint (address, Config::instance()->server_port_base() + 1);
 231
 232         _broadcast.socket = new boost::asio::ip::udp::socket (_broadcast.io_service);
 233         _broadcast.socket->open (listen_endpoint.protocol ());
 234         _broadcast.socket->bind (listen_endpoint);
 235
 236         _broadcast.socket->async_receive_from (
 237                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 238                 _broadcast.send_endpoint,
 239                 boost::bind (&EncodeServer::broadcast_received, this)
 240                 );
 241
 242         _broadcast.io_service.run ();
 243 }
 244 catch (...)
 245 {
 246         store_current ();
 247 }
 248
 249 void
 250 EncodeServer::broadcast_received ()
 251 {
 252         _broadcast.buffer[sizeof(_broadcast.buffer) - 1] = '\0';
 253
 254         if (strcmp (_broadcast.buffer, DCPOMATIC_HELLO) == 0) {
 255                 /* Reply to the client saying what we can do */
 256                 xmlpp::Document doc;
 257                 xmlpp::Element* root = doc.create_root_node ("ServerAvailable");
 258                 root->add_child("Threads")->add_child_text (raw_convert<string> (_worker_threads.size ()));
 259                 root->add_child("Version")->add_child_text (raw_convert<string> (SERVER_LINK_VERSION));
 260                 string xml = doc.write_to_string ("UTF-8");
 261
 262                 if (_verbose) {
 263                         cout << "Offering services to master " << _broadcast.send_endpoint.address().to_string () << "\n";
 264                 }
 265                 shared_ptr<Socket> socket (new Socket);
 266                 try {
 267                         socket->connect (boost::asio::ip::tcp::endpoint (_broadcast.send_endpoint.address(), Config::instance()->server_port_base() + 1));
 268                         socket->write (xml.length() + 1);
 269                         socket->write ((uint8_t *) xml.c_str(), xml.length() + 1);
 270                 } catch (...) {
 271
 272                 }
 273         }
 274
 275         _broadcast.socket->async_receive_from (
 276                 boost::asio::buffer (_broadcast.buffer, sizeof (_broadcast.buffer)),
 277                 _broadcast.send_endpoint, boost::bind (&EncodeServer::broadcast_received, this)
 278                 );
 279 }
 280
 281 void
 282 EncodeServer::handle (shared_ptr<Socket> socket)
 283 {
 284         boost::mutex::scoped_lock lock (_mutex);
 285
 286         /* Wait until the queue has gone down a bit */
 287         while (_queue.size() >= _worker_threads.size() * 2 && !_terminate) {
 288                 _full_condition.wait (lock);
 289         }
 290
 291         _queue.push_back (socket);
 292         _empty_condition.notify_all ();
 293 }