Inventor/VRMLnodes/SoVRMLSound.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_VRMLSOUND_
#define  _SO_VRMLSOUND_

#include <Inventor/fields/SoSFVec3f.h>
#include <Inventor/fields/SoSFFloat.h>
#include <Inventor/fields/SoSFTime.h>
#include <Inventor/fields/SoSFEnum.h>
#include <Inventor/fields/SoSFBool.h>
#include <Inventor/fields/SoMFString.h>
#include <Inventor/nodes/SoNode.h>
#include <Inventor/fields/SoSFNode.h>
#include <Inventor/VRMLnodes/SoVRMLNode.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

#ifdef _WIN32
class SoSensor;
class SoFieldSensor;
class SoTimerSensor;
class SoWavDecoder;
class SoSoundDecoder;
class SoVRMLSound;
class SoSFNode;
class SoSoundSpatializer;
class SoVRMLAudioClip ;
enum  SoSoundType ;

#endif
#ifdef SO_MPEG_DECODER
#define MPEG_NUM_BUFFERS 5 // Number of buffers for MPEG streaming

#endif
class SoDEPRECATED  SoVRMLSound : public SoVRMLNode {

  SO_NODE_HEADER(SoVRMLSound);

 public:
  // Fields

  SoSFNode            source;


  SoSFFloat           intensity;

  SoSFFloat           priority;

  SoSFVec3f           location;

  SoSFVec3f           direction;
  SoSFFloat           minFront;


  SoSFFloat           maxFront;
  SoSFFloat           minBack;
  SoSFFloat           maxBack;

  SoSFBool            spatialize;

  SoSFFloat                             dopplerFactor ;

  SoSFFloat                             dopplerVelocity ;

  SoVRMLSound();

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

 private:
  virtual void GLRender(SoGLRenderAction *action);

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

 private:
  static void initClass();
  static void exitClass();
#ifdef _WIN32
  void   setSoundSpatializer(SoSoundSpatializer * ss);    //set a new sound Manager

#endif
 private:
  virtual ~SoVRMLSound();

 private:
#ifdef _WIN32
  // Sensor callbacks
  static void grabCB(void *, SoSensor *);
  static void sourceChangedCB(void *, SoSensor *);
  static void dopplerFactorChangedCB(void *, SoSensor *);
  static void dopplerVelocityChangedCB(void *, SoSensor *);
  static void intensityChangedCB(void *, SoSensor *);
  static void soundBufferChangedCB(void *data, SoSensor *);
  static void computeDopplerEffectCB(void *data, SoSensor *);

  // SoVRMLAudioClip sensors    callbacks
  static void startChangedCB(void *data, SoSensor *);
  static void stopChangedCB(void *data, SoSensor *);
  static void startSoundCB(void *data, SoSensor *);
  static void stopSoundCB(void *data, SoSensor *);
  static void pitchChangedCB(void *, SoSensor *);
  static void filenameChangedCB(void *, SoSensor *);
  static void loopChangedCB(void *, SoSensor *);


  void configStartTimeSensor(SoVRMLAudioClip *audioClip) ;
  void configStopTimeSensor(SoVRMLAudioClip *audioClip) ;

  SoSoundType checkFileType();              // Verify the extension
  bool openSound();                               // Open the sound
  void closeSound(bool close_file=false);   // Close the sound
  SbBool initSoundSource();                   // Initialize the sound source

  // Dynamic types of the sound
  SoSoundDecoder *m_soundDecoder ;          // Static type of the sound

  SoFieldSensor  *m_sourceChangedSensor;            // Controls the modification of source
  SoFieldSensor  *m_soundBufferChangedSensor;         // Controls the modification of the video sound
  SoFieldSensor  *m_dopplerFactorChangedSensor ;    // Controls the modification of dopplerFactor
  SoFieldSensor  *m_dopplerVelocityChangedSensor ;  // Controls the modification of dopplerVelocity
  SoFieldSensor  *m_intensityChangedSensor;                     // Controls the modification of the intensity

  // SoVRMLAudioClip sensors    
  SoFieldSensor  *m_pitchChangedSensor;                    // Controls the pitch
  SoFieldSensor  *m_startChangedSensor;                    // Controls the start time
  SoFieldSensor  *m_stopChangedSensor;                     // Controls the end time
  SoFieldSensor  *m_loopChangedSensor;                     // Controls the loop
  SoFieldSensor  *m_filenameSensor;                                  // Controls the filename
        
  SoAlarmSensor  *m_startSensor;                                 // Controls the beginning  
  SoAlarmSensor  *m_stopSensor;                                          // Controls the end  
  SoTimerSensor  *m_grabSensor;                                          // Controls the streaming 
  SoTimerSensor  *m_dopplerEffectSensor;             // Controls the Doppler effect

  bool  m_loop;           // Corresponds to source->loop if source is a SoVRMLAudioClip
  float m_pitch;          // Corresponds to source->pitch if source is a SoVRMLAudioClip

  bool m_isEndDecodingSound;      // True if decoding the sound is finished
  bool m_isCorrectAudioClipFile ; // True if the extension of the file is correct and if the 
  // file exists
  bool m_shouldPlaySound;         // True if the sound should be played
  bool m_isSoundOpened;             // True if the sound is opened
  bool m_isEndPlayingSound;                   // True if the sound is finished
  bool m_isRenderedOnce;          // True if at least one rendering has been done.
  // Useful for Doppler effect.


  int m_soundBufferQueue ;                          // Sound buffer queue
  int m_numSoundBuffersInQueue;   // Nb sound buffers in the queue

  SoSoundType         m_soundType;          // Type of the sound
  SbString            m_audioClipURL;           // The url of the SoVRMLAudioClip
  int                 m_numSoundBuffers ;   // Numbers of sound buffers
  SoSoundSpatializer *m_soundSpatializer;   // 3D Sound Spatializer

  SoType              m_currentSourceType;  // Current source type (ie VRMLMovieTexture or
  // VRMLAudioClip)

  // Manage the doppler Effect
  double  m_prevRenderTime;                             // Previous GLRender time
  SbVec3f m_prevListenerPos;                    // Previous position of the Listener
  SbVec3f m_prevSourcePos;                        // Previous position of the source
#endif // _WIN32
};



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

#endif /* _SO_VRMLSOUND_ */

---

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