jaus++/2.0/include/jaus/extras/video/videosubscriber.h

Go to the documentation of this file.

#ifndef __JAUS_EXTRAS_VIDEO_VIDEO_SUBSCRIBER__H
#define __JAUS_EXTRAS_VIDEO_VIDEO_SUBSCRIBER__H

#include "jaus/core/management/management.h"
#include "jaus/extras/video/reportimage.h"
#include "jaus/extras/video/queryimage.h"
#include <cxutils/images/image.h>

namespace JAUS
{
    typedef CxUtils::Image Image;

    class SharedImage;

    class JAUS_EXTRAS_DLL VideoSubscriber : public Management::Child
    {
    public:
        class JAUS_EXTRAS_DLL Callback : public AccessControl::Callback
        {
        public:
            typedef std::set<Callback* > Set;
            Callback() {}
            virtual ~Callback() {}
            virtual void ProcessCompressedVideo(const Address& source,
                                                const Byte camera,
                                                const Image::Format format,
                                                const unsigned char* compressedImage,
                                                const unsigned int compressedImageSize,
                                                const unsigned int frameNumber) {}
            virtual void ProcessRawImage(const Address& source,
                                         const Byte camera,
                                         const Image& image,
                                         const unsigned int frameNumber) {}
        };
        const static std::string Name; 
        // Constructor.
        VideoSubscriber();
        // Destructor.
        ~VideoSubscriber();     
        // Shutsdown the service.
        virtual void Shutdown();
        // Create a video subscription.
        bool CreateVideoSubscription(const Address& id, 
                                     const Byte cameraID = 0,
                                     const unsigned int waitTimeMs = Service::DefaultWaitMs);
        bool GetCameraCount(const Address& id, 
                            unsigned int& count,
                            const unsigned int waitTimeMs = Service::DefaultWaitMs*3) const;
        bool GetCameraList(const Address& id, 
                           std::vector<Byte>& list,
                           const unsigned int waitTimeMs = Service::DefaultWaitMs*3) const;
        // Check to see if you have a video subscription.
        bool HaveVideoSubscription(const Address& id, const int cameraID = -1) const;
        // Cancel a video subscription.
        bool CancelVideoSubscription(const Address& id = Address(), const int cameraID = -1);
        // Register to receive updates of subsystems (add or removes callback).
        void RegisterCallback(Callback* callback, const bool rawImage, const bool add = true);  
        // Method called when an Event has been signaled, generates an Event message.
        virtual bool GenerateEvent(const Events::Subscription& info) const { return false; }
        // Method called to determine if an Event is supported by the service.
        virtual bool IsEventSupported(const Events::Type type,
                                      const double requestedPeriodicRate,
                                      const Message* queryMessage,
                                      double& confirmedPeriodicRate,
                                      std::string& errorMessage) const { return false; }
        // VideoSubscriber doesn't need to be discovered.
        virtual bool IsDiscoverable() const { return false; }
        // Processes messages associated with the VideoSubscriber Services.
        virtual void Receive(const Message* message);
        // Creates messages associated with the VideoSubscriber Service.
        virtual Message* CreateMessage(const UShort messageCode) const;
        // Method called when transitioning to a ready state.
        virtual bool Resume() { return true; }
        // Method called to transition due to reset.
        virtual bool Reset() { return true; }
        // Method called when transitioning to a standby state.
        virtual bool Standby() { return true; }
        // Method called when transitioning to an emergency state.
        virtual bool SetEmergency() { return true; }
        // Method called when leaving the emergency state.
        virtual bool ClearEmergency() { return true; }
        // Method called when control is released.
        virtual bool ReleaseControl() { return true; }
    private:
        static void SharedImageCallback(const Address& source,
                                        const Byte cameraID,
                                        const Image& img,
                                        const unsigned int frameNumber,
                                        void* fargs);
        Mutex mVideoCallbacksMutex;                       
        Mutex mSharedImagesMutex;                         
        Callback::Set mRawCallbacks;                      
        Callback::Set mCompressedCallbacks;               
        std::vector<SharedImage*> mSharedImages;          
    };
}

#endif
/*  End of File */