artnetservice.h

/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/. */
 
#pragma once
 
// External Includes
#include <nap/service.h>
#include <entity.h>
 
namespace nap
{
    class ArtNetController;
    class ArtNetReceiver;
    class ArtNetInputComponentInstance;
 
    class NAPAPI ArtNetService : public Service
    {
        RTTI_ENABLE(Service)
 
    public:
        using ByteChannelData = std::vector<uint8>;
        using FloatChannelData = std::vector<float>;
 
        // Default Constructor
        ArtNetService(ServiceConfiguration* configuration);
 
        // Default Destructor
        virtual ~ArtNetService();
 
        ArtNetService(const ArtNetService& rhs) = delete;
        ArtNetService& operator=(const ArtNetService& rhs) = delete;
 
    protected:
        virtual void registerObjectCreators(rtti::Factory& factory) override;
 
        virtual void update(double deltaTime) override;
 
    private:
        bool addController(ArtNetController& controller, utility::ErrorState& errorState);
 
        void removeController(ArtNetController& controller);
 
        bool addReceiver(ArtNetReceiver& receiver, utility::ErrorState& errorState);
 
        void removeReceiver(ArtNetReceiver& receiver);
 
        void addInputComponent(ArtNetInputComponentInstance& input);
 
        void removeInputComponent(ArtNetInputComponentInstance& input);
 
        void send(ArtNetController& controller, const FloatChannelData& channelData, int channelOffset = 0);
 
        void send(ArtNetController& controller, float channelData, int channel);
 
        void send(ArtNetController& controller, const ByteChannelData& channelData, int channelOffset = 0);
 
        void send(ArtNetController& controller, uint8 channelData, int channel);
 
        void clear(ArtNetController& controller);
 
    private:
        friend class ArtNetController;
        friend class ArtNetReceiver;
        friend class ArtNetInputComponentInstance;
 
        struct ControllerData
        {
            ArtNetController*           mController;            // ArtNet controller specifying target subnet and universe
            ByteChannelData             mData;                  // Byte data for all channels for a single controller
            double                      mLastUpdateTime;        // Last time this controller was transmitted over the network
            bool                        mIsDirty;               // Identifies whether this controller contains new data
        };
 
        using ControllerKey = uint8;                            // The key is the target address (subnet-universe), which is currently limited to 8 bits as it does not include net (7 bits)
        using ReceiverKey = uint16;                             // The key is the port which the receiver will listen to
 
        using ControllerMap = std::unordered_map<ControllerKey, std::unique_ptr<ControllerData>>;
        using ReceiverMap = std::unordered_map<ReceiverKey, ArtNetReceiver*>;
        using InputComponents = std::vector<ArtNetInputComponentInstance*>;
        using DirtyNodeList = std::unordered_set<ControllerKey>;
 
        ControllerMap                   mControllers;           // Controller map that maps an absolute controller address to a controller
        ReceiverMap                     mReceivers;             // Receiver map that maps a receiver port to a receiver
        InputComponents                 mInputs;                // All the Art-Net input components registered to the service
    };
}