SoMPEGRenderer.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                                       ***
**=======================================================================*/
/*=======================================================================
** Author      : C. HUFSCHMITT (Jul 2001)
**=======================================================================*/
/*=======================================================================
** Modified by : Tristan Mehamli (Nov 2009)
**=======================================================================*/
 
#ifndef _SO_MPEGRENDERER_
#define _SO_MPEGRENDERER_
 
#include <Inventor/nodes/SoSeparator.h>
#include <Inventor/actions/SoGLRenderAction.h>
#include <Inventor/helpers/SbGlContextHelper.h>
#include <Inventor/SbBasic.h>
#include <Inventor/SbColor.h>
 
#include <Inventor/STL/list>
 
class TGSMPEG;
class SbThreadSignal;
class SbThreadMutex;
 
/*----------------------------------------------------------------------------*/
class  SoMPEGRenderer 
{
public:
 
  SoMPEGRenderer();
 
  virtual ~SoMPEGRenderer();
 
  enum Components 
  {
    LUMINANCE = 1,
    LUMINANCE_TRANSPARENCY = 2,
    RGB = 3,
    RGB_TRANSPARENCY = 4
  };
 
  SbBool openFile( const char* filename, unsigned int numFrames = 10000 );
 
  void closeFile();
 
  void setFilePointer( FILE* fp );
 
  FILE* getFilePointer() const;
 
  void setSize( const SbVec2s& size );
 
  SbVec2s getSize() const;
 
  void setComponents( const Components components );
 
  SoMPEGRenderer::Components getComponents() const;
 
  virtual void setSceneGraph( SoNode* node );
 
  SoNode* getSceneGraph() const;
 
  void setBackgroundColor( const SbColor& c );
 
  SbColor getBackgroundColor() const;
 
  void setGLRenderAction( SoGLRenderAction* ra );
 
  SoGLRenderAction* getGLRenderAction() const;
 
  void setCompressionRate( float value ); 
 
  float getCompressionRate() const;
 
  void setBitPerSec( float mbps );
 
  void setNumFramesPerSecond( float num );
 
  int getNumFramesPerSecond();
 
  void addFrame( const unsigned char* frame );
 
  void setShareContext( const SbGLShareContext shareCxt );
 
  const SbGLShareContext getShareContext() const;
 
  virtual void record();
 
  virtual void pause();
 
  virtual void stop();
 
  SbBool isRecording() const;
 
  void setViewerIsIdle( bool isIdle );
  bool isViewerIdle() const { return m_viewerIsIdle; };
 
  /*----------------------------------------------------------------------------*/
  private:
  void computeRate( double curVwrFPS );
 
  void addIdleFrame();
 
  int getNumFrameToEncode();
 
private:
  SoMPEGRenderer& operator =( const SoMPEGRenderer& a );
  // Share context
  SbGLShareContext m_glShareContext;
 
private:
  // Encoding Task that "loops" until there is no more frame to encode.
  void encodeTask(void);
  // main method for the recording thread.
  static void* encodeCB( void* data );
  // Streamed buffers stack.
  static std::list<unsigned char*>* m_frameStack;
  // Synchronization between app thread and encoding thread.
  static SbThreadMutex* m_stackMutex; // Used when accessing the stack.
  SbThread* m_stackThread;
  // Frame size in pixel.
  SbVec2s m_Size;
  // Component number for one frame, frame rate, frame number in m_frameStack.
  int m_frameSize, m_recFrameRate, m_frameCount;
  // Real frame rate (according to viewer FPS).
  double m_rate;
  // Backgroung color.
  SbColor m_BgColor;
  // Render action set by setGLRenderAction.
  SoGLRenderAction* m_ra, *m_defaultRenderAction;
  // MPEG algorithm.
  TGSMPEG* m_mpeg;
  // Current scene graph to render. 
  SoNode* m_SceneGraph;
  // Number of component for one frame.
  Components m_numComponents;
  // True if the scene do not change.
  bool m_viewerIsIdle;
  // True if a file is opened, true if recording.
  SbBool m_hasFileOpened, m_isRecording;
 
  // Name of the current opened file.
  SbString m_openedFile;
  // True if openFile displayed a warning to indicate that a thread
  // is encoding on this file.
  SbBool m_openedFileWarningDisplayed;
};/*----------------------------------------------------------------------------*/
 
#endif /* _SO_MPEGRENDERER_ */