Inventor/VRMLnodes/SoVRMLMovieTexture.h

Go to the documentation of this file.

/*=======================================================================
 * Copyright 1991-1996, Silicon Graphics, Inc.
 * ALL RIGHTS RESERVED
 *
 * UNPUBLISHED -- Rights reserved under the copyright laws of the United
 * States.   Use of a copyright notice is precautionary only and does not
 * imply publication or disclosure.
 *
 * U.S. GOVERNMENT RESTRICTED RIGHTS LEGEND:
 * Use, duplication or disclosure by the Government is subject to restrictions
 * as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights
 * in Technical Data and Computer Software clause at DFARS 252.227-7013 and/or
 * in similar or successor clauses in the FAR, or the DOD or NASA FAR
 * Supplement.  Contractor/manufacturer is Silicon Graphics, Inc.,
 * 2011 N. Shoreline Blvd. Mountain View, CA 94039-7311.
 *
 * THE CONTENT OF THIS WORK CONTAINS CONFIDENTIAL AND PROPRIETARY
 * INFORMATION OF SILICON GRAPHICS, INC. ANY DUPLICATION, MODIFICATION,
 * DISTRIBUTION, OR DISCLOSURE IN ANY FORM, IN WHOLE, OR IN PART, IS STRICTLY
 * PROHIBITED WITHOUT THE PRIOR EXPRESS WRITTEN PERMISSION OF SILICON
 * GRAPHICS, INC.
**=======================================================================*/
/*=======================================================================
** Author      : SGI (MMM YYYY)
**=======================================================================*/
/*=======================================================================
 *** 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-2020 BY FEI S.A.S,                        ***
 ***                        BORDEAUX, FRANCE                                        ***
 ***                      ALL RIGHTS RESERVED                                       ***
**=======================================================================*/
/*=======================================================================
** Modified by : Gwenole Tallec (MMM yyyy)
**=======================================================================*/

#ifndef  _SO_VRML_MOVIE_TEXTURE
#define  _SO_VRML_MOVIE_TEXTURE

#include <Inventor/VRMLnodes/SoVRMLTexture.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFTime.h>
#include <Inventor/fields/SoSFImage.h>
#include <Inventor/fields/SoSFColor.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoSFInt32.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFString.h>
#include <Inventor/fields/SoMFFilePathString.h>
#include <Inventor/nodes/SoNode.h>

#include <Inventor/threads/SbThread.h>
#include <Inventor/threads/SbThreadStorage.h>
#include <Inventor/caches/SoGLTexCacheList.h>
#include <Inventor/sys/SoGLType.h>


#if defined(OIV_IGNORE_VRML_DEPRECATED)
  #include <SoDeprecationRules.h>
  #pragma push_macro("SoDEPRECATED_CLASS")
  #pragma push_macro("SoDEPRECATED_TYPEDEF")
  #undef SoDEPRECATED_CLASS
  #undef SoDEPRECATED_TYPEDEF
  #define SoDEPRECATED_CLASS(x,y)
  #define SoDEPRECATED_TYPEDEF(x,y)
#endif

class SoState ;
class SoSensor;
class SoTimerSensor;
class SoAlarmSensor;
class SoFieldSensor;
class SoGLDisplayList;
class SoMPEG2Decoder;
class SoAVIDecoder;
class SoWebCamDecoder;
class SoVideoDecoder;
class SoVRMLMovieTexture;
class SbThreadRWMutex;
class SoSoundDecoder;

#ifdef _MSC_VER
#pragma warning( push )
#pragma warning(disable:4251)

#endif

typedef     SoDEPRECATED SbBool VRMLMoviePrequalifyFileCallback(const SbString &, void *, SoVRMLMovieTexture *);

typedef     SoDEPRECATED int SoMovieType ;
class SoDEPRECATED  SoVRMLMovieTexture : public SoVRMLTexture {

  SO_NODE_HEADER(SoVRMLMovieTexture);

 public:
 
  enum Model {
    MODULATE  = GL_MODULATE,

    DECAL = GL_DECAL,

    BLEND = GL_BLEND,

    REPLACE = GL_REPLACE
  };

  SoVRMLMovieTexture();


  SoSFBool            loop; 

  SoSFFloat           speed;

  SoSFTime            startTime;

  SoSFTime            stopTime;
  SoSFTime            pauseTime;
  SoSFTime            resumeTime;

  SoMFFilePathString          url;
   
  SoSFFloat           alpha;

  SoSFEnum                            model;

  SoSFColor                             blendColor;
        
  SoSFBool            scaleTexCoord;

  SoSFTime            duration_changed;

  SoSFBool            isActive;

  SoSFBool            isPaused;

  SoSFTime            elapsedTime;

  void setVideoCaptureFormat(int32_t width, int32_t height, int32_t framePerSec) ;
  static void setPrequalifyFileCallBack(VRMLMoviePrequalifyFileCallback *, void *);
  void allowPrequalifyFile(SbBool);

  /*----------------------------------------------------------------------------*/

 private:

  virtual void GLRender(SoGLRenderAction *action);

 private:

  const SbString & getOverrideURL() { return overrideURL; }
  void setOverrideURL(const SbString &path) { overrideURL = path; }

  SoSFInt32 soundDecoded;  // Change when a SoSounDecoder object is built
  // A SoSounDecoder is built only if a sound sequence 
  // is found.
  // The node VRMLSound is connected to this field.
  //  0 = No sound has been decoded
  //  1 = A sound has been decoded
  // -1 = The video is closed. No sound will be decoded

  static void initClass();
  static void exitClass();

  // Indicate if the sound within the video should be decoded
  void shoudDecodeSound(SbBool decodeSound) ;

  // Return the sound decoder
  SoSoundDecoder* getSoundDecoder() ;

 private:
  virtual ~SoVRMLMovieTexture();

 private:
  SbString overrideURL;
  static VRMLMoviePrequalifyFileCallback *prequalifyFileCB;
  static void *prequalifyFileCB_udata;

  SbBool prequalifyFileFlag;
        
  SoFieldSensor *filenameSensor;     // Controls the filename
  SoFieldSensor *loopChangedSensor;  // Controls the loop
  SoFieldSensor *startChangedSensor; // Controls the start time
  SoFieldSensor *endChangedSensor;   // Controls the end time
  SoFieldSensor *speedChangedSensor; // Controls the speed
  SoFieldSensor *wrapSChangedSensor; // Controls the wrapS
  SoFieldSensor *wrapTChangedSensor; // Controls the wrapT
  SoFieldSensor *scaleChangedSensor; // Controls the scale_tex_coord

  SoAlarmSensor *startSensor;        // Controls the beginning of the video playing
  SoAlarmSensor *endSensor;          // Controls the end of the video playing
  SoTimerSensor *grabSensor;         // Controls the retrieve of the images to put 
  // them in cache
                                      
  SoTimerSensor *displaySensor;      // Controls the display. Causes the call to GLRender.

  static void filenameChangedCB(void *, SoSensor *);
  static void loopChangedCB(void *data, SoSensor *);
  static void startVideoCB(void *data, SoSensor *);
  static void endChangedCB(void *data, SoSensor *);
  static void speedChangedCB(void *data, SoSensor *);
  static void scaleChangedCB(void *data, SoSensor *);

  static void wrapChangedCB(void *data, SoSensor *);
  static void endVideoCB(void *data, SoSensor *);
  static void startChangedCB(void *data, SoSensor *);
  static void grabNewFrame(void *data, SoSensor *);
  static void displayNewFrame(void *data, SoSensor *);

  void configStartTimeSensor() ;
  void configStopTimeSensor() ;
  void prepareVideoToBePlayed() ;
  void setGLTextureImageElement(SoState *state) ;

  void invalidateRenderList();      // Delete the TexObj

  // Display list info for this texture:
  SbThreadStorage< SoGLTexCacheList* > m_texList;

  // Used for threading decoding
  SbThreadRWMutex *m_mutex;
  SbThread *m_thread;
  static void *grab(void *data);
  SbBool createThread();
        
  // -1 = don't know yet, 0 = no transp, 1 = has transp
  int m_hasTransparency;
  int m_num_components; //alpha >=1 : 3  ; alpha <1 :  4 

  void openVideo();                       // Open the video
  void closeVideo(SbBool close_file = FALSE); // Close the video
  void displayFrame();                    // Display a frame of the video
  void init();                            // Initialise the booleans

  SbVec2s m_size_video; // Size of the video
  SbVec3f m_scale_vec;  // Size of the scaled video
  SbVec2i32 m_size_scale;

  unsigned char *m_video_buf; // Buffer that contain the frame to play
  unsigned char *m_scale_buf; // Buffer used when scale_tex_coord is FALSE
  unsigned char *m_alpha_buf; // Buffer used when alpha < 1

  SbTime m_startRealTime; // Time the video begin.
  int m_dispFrame;        // Num of the frame waiting to be displayed by glrender
  int m_cptFrame;         // Number of the frame related to the time of the video


  SbBool m_soundPlayed ;      // Indicate if the sound has been played
  SbBool m_shouldDecodeSound; // True the sound shoud be decoded
  SbBool m_END_VIDEO;         // The video is finished
  SbBool m_ADVANCE;           // Must slow the video
  SbBool m_ONCE;              // For the initialization in glRender
  SbBool m_FIRST_TRAVERSAL;   // To avoid skipping the first frame
  SbBool m_STOP_GRAB;         // No more rames to grab
  SbBool m_FIRST ;            // First time the video is played
  SbBool m_URL;               // Wether the url given is correct or not
  SbBool m_START;             // The video is being played
  SbBool m_CLOSED;            // The video is closed
  SbBool m_SCALED;            // The buffer is scaled by gluscaleimage
  SbBool m_SCALE_SIZED;       // The size of the scaled buffer is set
  SbBool m_BUFFER;            // If there is a new buffer taken from the cache
  SbBool m_CLOSED_FILE;       // If the file is closed

  int m_late ;              // Number of frames we're late

  SoMovieType checkFileType( const SbString& ); // Verify the extension
  SoMovieType m_movieType;                 // Type of the video : AVI or MPEG

  static SbString basePath;
  static SbBool basePathSet;

  // Dynamic type of the video
  SoMPEG2Decoder  *m_mpeg;
  SoAVIDecoder    *m_avi;
  SoWebCamDecoder *m_webcam;

  // Static type of the video 
  SoVideoDecoder  *m_video;

  // Corresponds to repeatS and repeatT
  SoSFEnum m_wrapS,m_wrapT;

  // Video Capture format
  int32_t m_videoCapWidth ;
  int32_t m_videoCapHeight ; 
  int32_t m_videoCapFPS ;

  int m_numRenderCaches;
};

#ifdef _MSC_VER
#pragma warning( pop )

#endif


#if defined(OIV_IGNORE_VRML_DEPRECATED)
  #pragma pop_macro("SoDEPRECATED_TYPEDEF")
  #pragma pop_macro("SoDEPRECATED_CLASS")
#endif

#endif /* _SO_VRMLMOVIE_TEXTURE */

---

Open Inventor Toolkit reference manual, generated on 12 Feb 2024
Copyright © Thermo Fisher Scientific All rights reserved. http://www.openinventor.com/