game_protocol.hpp

//  SuperTuxKart - a fun racing game with go-kart
//  Copyright (C) 2015  Supertuxkart-Team
//
//  This program is free software; you can redistribute it and/or
//  modify it under the terms of the GNU General Public License
//  as published by the Free Software Foundation; either version 3
//  of the License, or (at your option) any later version.
//
//  This program is distributed in the hope that it will be useful,
//  but WITHOUT ANY WARRANTY; without even the implied warranty of
//  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
//  GNU General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with this program; if not, write to the Free Software
//  Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 
#ifndef GAME_PROTOCOL_HPP
#define GAME_PROTOCOL_HPP
 
#include "network/event_rewinder.hpp"
#include "network/protocol.hpp"
 
#include "input/input.hpp"                // for PlayerAction
#include "utils/cpp2011.hpp"
#include "utils/stk_process.hpp"
 
#include <cstdlib>
#include <mutex>
#include <vector>
#include <tuple>
 
class BareNetworkString;
class NetworkItemManager;
class NetworkString;
class STKPeer;
 
class GameProtocol : public Protocol
                   , public EventRewinder
{
private:
    /* Used to check if deleting world is doing at the same the for
     * asynchronous event update. */
    mutable std::mutex m_world_deleting_mutex;
 
    enum { GP_CONTROLLER_ACTION,
           GP_STATE,
           GP_ITEM_UPDATE,
           GP_ITEM_CONFIRMATION,
           GP_ADJUST_TIME
    };
 
    NetworkString *m_data_to_send;
 
    std::vector<int8_t> m_adjust_time;
 
    // Dummy data structure to save all kart actions.
    struct Action
    {
        int          m_ticks;
        int          m_kart_id;
        PlayerAction m_action;
        int          m_value;
        int          m_value_l;
        int          m_value_r;
    };   // struct Action
 
    // List of all kart actions to send to the server
    std::vector<Action> m_all_actions;
 
    void handleControllerAction(Event *event);
    void handleState(Event *event);
    void handleAdjustTime(Event *event);
    void handleItemEventConfirmation(Event *event);
    static std::weak_ptr<GameProtocol> m_game_protocol[PT_COUNT];
    NetworkItemManager* m_network_item_manager;
    // Maximum value of values are only 32768
    std::tuple<uint8_t, uint16_t, uint16_t, uint16_t>
                                                compressAction(const Action& a)
    {
        uint8_t w = (uint8_t)(a.m_action & 63) |
            (a.m_value_l > 0 ? 64 : 0) | (a.m_value_r > 0 ? 128 : 0);
        uint16_t x = (uint16_t)a.m_value;
        uint16_t y = (uint16_t)std::abs(a.m_value_l);
        uint16_t z = (uint16_t)std::abs(a.m_value_r);
        return std::make_tuple(w, x, y, z);
    }
    std::tuple<PlayerAction, int, int, int>
               decompressAction(uint8_t w, uint16_t x, uint16_t y , uint16_t z)
    {
        PlayerAction a = (PlayerAction)(w & 63);
        int l_sign = ((w >> 6) & 1) != 0 ? 1 : -1;
        int r_sign = ((w >> 7) & 1) != 0 ? 1 : -1;
        int b = x;
        int c = y * l_sign;
        int d = z * r_sign;
        return std::make_tuple(a, b, c, d);
    }
public:
             GameProtocol();
    virtual ~GameProtocol();
 
    virtual bool notifyEventAsynchronous(Event* event) OVERRIDE;
    virtual void update(int ticks) OVERRIDE;
    void sendActions();
    void controllerAction(int kart_id, PlayerAction action,
                          int value, int val_l, int val_r);
    void startNewState();
    void addState(BareNetworkString *buffer);
    void sendState();
    void finalizeState(std::vector<std::string>& cur_rewinder);
    void sendItemEventConfirmation(int ticks);
 
    virtual void undo(BareNetworkString *buffer) OVERRIDE;
    virtual void rewind(BareNetworkString *buffer) OVERRIDE;
    // ------------------------------------------------------------------------
    virtual void setup() OVERRIDE {};
    // ------------------------------------------------------------------------
    virtual void asynchronousUpdate() OVERRIDE {}
    // ------------------------------------------------------------------------
    static std::shared_ptr<GameProtocol> createInstance();
    // ------------------------------------------------------------------------
    static bool emptyInstance()
    {
        ProcessType pt = STKProcess::getType();
        return m_game_protocol[pt].expired();
    }   // emptyInstance
    // ------------------------------------------------------------------------
    static std::shared_ptr<GameProtocol> lock()
    {
        ProcessType pt = STKProcess::getType();
        return m_game_protocol[pt].lock();
    }   // lock
    // ------------------------------------------------------------------------
    NetworkString* getState() const { return m_data_to_send;  }
    // ------------------------------------------------------------------------
    std::unique_lock<std::mutex> acquireWorldDeletingMutex() const
               { return std::unique_lock<std::mutex>(m_world_deleting_mutex); }
};   // class GameProtocol
 
#endif // GAME_PROTOCOL_HPP