vreVideoStream.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file vreVideoStream.h
//! \brief Defines custom video stream handling for VR-Engage
//!
//! This file contains the DtVreVideoStream class which extends the base
//! DtVideoStream class to fix issues related to channel destruction and video
//! stream stopping. It also provides a creator class for instantiating these
//! customized video streams.
 
#pragma once
 
#include "vrePlayerStation/export.h"
 
#include <vrvVideoStream/DtVideoStream.h>
 
namespace makVrv
{
//! \brief Forward declaration of the display engine class
class DtDe;
 
//! \brief Forward declaration of the channel class
class DtChannel;
 
//! \brief Forward declaration of the channel manager class
class DtChannelManager;
 
//! \brief Forward declaration of the video stream manager class
class DtVideoStreamManager;
 
//! \brief Forward declaration of the Unicode string class
class DtUnicode;
} // namespace makVrv
 
namespace makVre
{
//! \brief Custom video stream implementation for VR-Engage
//!
//! DtVreVideoStream extends the base DtVideoStream class to fix a bug where
//! closing any channel would break the stopping of video streams. This class
//! overrides the channel destruction handling to ensure that video streams
//! are properly stopped only when their associated channel is destroyed,
//! not when any arbitrary channel is destroyed.
class PLAYERSTATION_DLL DtVreVideoStream : public makVrv::DtVideoStream
{
public:
   //! \brief Friend declaration for creator class
   //!
   //! Only DtVreVideoStreamCreator can construct a DtVideoStream.
   friend class DtVreVideoStreamCreator;
 
   //! \brief Friend declaration for manager class
   //!
   //! Only DtVideoStreamManager can save a videoStream.
   friend class DtVideoStreamManager;
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the video stream.
   virtual ~DtVreVideoStream() override;
 
protected:
   //! \brief Protected constructor
   //! \param de Reference to the display engine
   //! \param mgr Reference to the video stream manager
   //! \param className Class name of the video stream
   //! \param instanceName Unique instance name for this video stream
   //!
   //! Creates a new video stream with the specified parameters. This constructor
   //! is protected and can only be called by the friend DtVreVideoStreamCreator class.
   //! The instance name must be unique among all video streams.
   DtVreVideoStream(makVrv::DtDe& de, makVrv::DtVideoStreamManager& mgr, const makVrv::DtUnicode& className,
      const makVrv::DtUnicode& instanceName);
 
   //! \brief Channel destruction handler
   //! \param mgr Pointer to the channel manager
   //! \param channel Pointer to the channel being destroyed
   //!
   //! Overridden from the base class to fix a bug where closing any channel
   //! would break video stream stopping. This implementation checks that the
   //! channel being destroyed is actually the one associated with this video
   //! stream before taking action.
   virtual void slot_channelToBeDestroyed(makVrv::DtChannelManager* mgr, makVrv::DtChannel* channel) override;
 
private:
   //! \brief Default constructor (deleted)
   //!
   //! Default construction is not supported for this class.
   DtVreVideoStream();
 
   //! \brief Copy constructor (deleted)
   //!
   //! Copy construction is not supported for this class.
   DtVreVideoStream(const DtVreVideoStream& rhs);
 
   //! \brief Assignment operator (deleted)
   //!
   //! Assignment is not supported for this class.
   DtVreVideoStream& operator=(const DtVreVideoStream& rhs);
};
 
//! \brief Creator class for VR-Engage video streams
//!
//! DtVreVideoStreamCreator is responsible for creating instances of
//! DtVreVideoStream. It follows the factory pattern, providing a standard
//! way to instantiate video streams with the correct configuration.
class PLAYERSTATION_DLL DtVreVideoStreamCreator : public makVrv::DtVideoStreamCreator
{
public:
   //! \brief Friend declaration for manager class
   //!
   //! Only DtVreVideoStreamManager can call the create method.
   friend class DtVreVideoStreamManager;
 
   //! \brief Constructor
   //!
   //! Creates a new video stream creator.
   DtVreVideoStreamCreator();
 
   //! \brief Destructor
   //!
   //! Cleans up resources used by the video stream creator.
   virtual ~DtVreVideoStreamCreator() override;
 
protected:
   //! \brief Creates a new video stream instance
   //! \param de Reference to the display engine
   //! \param mgr Reference to the video stream manager
   //! \param className Class name of the video stream
   //! \param instanceName Unique instance name for this video stream
   //! \return Pointer to the newly created video stream
   //!
   //! Factory method that creates a new DtVreVideoStream instance with
   //! the specified parameters. This method is protected and can only be
   //! called by the friend DtVreVideoStreamManager class.
   virtual makVrv::DtVideoStream* create(makVrv::DtDe& de,
      makVrv::DtVideoStreamManager& mgr,
      const makVrv::DtUnicode& className,
      const makVrv::DtUnicode& instanceName) const override;
};
} // namespace makVre