EncodedFrame.h

/*=======================================================================
 *** THE CONTENT OF THIS WORK IS PROPRIETARY TO FEI S.A.S, (FEI S.A.S.),            ***
 ***              AND IS DISTRIBUTED UNDER A LICENSE AGREEMENT.                     ***
 ***                                                                                ***
 ***  REPRODUCTION, DISCLOSURE,  OR USE,  IN WHOLE OR IN PART,  OTHER THAN AS       ***
 ***  SPECIFIED  IN THE LICENSE ARE  NOT TO BE  UNDERTAKEN  EXCEPT WITH PRIOR       ***
 ***  WRITTEN AUTHORIZATION OF FEI S.A.S.                                           ***
 ***                                                                                ***
 ***                        RESTRICTED RIGHTS LEGEND                                ***
 ***  USE, DUPLICATION, OR DISCLOSURE BY THE GOVERNMENT OF THE CONTENT OF THIS      ***
 ***  WORK OR RELATED DOCUMENTATION IS SUBJECT TO RESTRICTIONS AS SET FORTH IN      ***
 ***  SUBPARAGRAPH (C)(1) OF THE COMMERCIAL COMPUTER SOFTWARE RESTRICTED RIGHT      ***
 ***  CLAUSE  AT FAR 52.227-19  OR SUBPARAGRAPH  (C)(1)(II)  OF  THE RIGHTS IN      ***
 ***  TECHNICAL DATA AND COMPUTER SOFTWARE CLAUSE AT DFARS 52.227-7013.             ***
 ***                                                                                ***
 ***                   COPYRIGHT (C) 1996-2023 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
 
#pragma once
 
#include <Inventor/sys/port.h>
#include <string>
#include <memory>
 
namespace RemoteViz
{
  namespace Rendering
  {
    class EncodedFrameImpl;
 
    class RENDERSERVICE_API EncodedFrame
    {
 
      friend class ConnectionImpl;
    public:
 
      enum EncodingFormat {
        JPEG,
        PNG,
        H264,
        VP9
      };
 
      EncodedFrame();
 
      EncodedFrame(const EncodedFrame& obj);
 
      EncodedFrame& operator=(const EncodedFrame& obj);
 
      ~EncodedFrame();
 
      size_t getBufferSize() const;
 
      EncodingFormat getEncodingFormat() const;
 
      size_t getId() const;
 
      bool isLossless() const;
 
      bool isInteractive() const;
 
      std::string getMessage() const;
 
    private:
      std::shared_ptr<EncodedFrameImpl> getImpl() const;
    private:
 
      std::shared_ptr<EncodedFrameImpl> pImpl;
 
    };
  }
}