SoundSprocket.h

Go to the documentation of this file.

 
#ifndef __SOUNDSPROCKET__
#define __SOUNDSPROCKET__
 
#ifndef __MACTYPES__
#include <MacTypes.h>
#endif
 
#ifndef __EVENTS__
#include <Events.h>
#endif
 
#ifndef __QD3D__
#include <QD3D.h>
#endif
 
#ifndef __QD3DCAMERA__
#include <QD3DCamera.h>
#endif
 
#ifndef __MACERRORS__
#include <MacErrors.h>
#endif
 
#if PRAGMA_ONCE
#pragma once
#endif
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#if PRAGMA_IMPORT
#pragma import on
#endif
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = mac68k
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(push, 2)
#elif PRAGMA_STRUCT_PACK
#pragma pack(2)
#endif
 
  /********************************************************************************
   *  SndSetInfo/SndGetInfo Messages
   ******************************************************************************/
  enum
  {
    kSSpSpeakerKind_Stereo = 0,
    kSSpSpeakerKind_Mono = 1,
    kSSpSpeakerKind_Headphones = 2
  };
 
  struct SSpSpeakerSetupData
  {
    UInt32 speakerKind; 
    float speakerAngle; 
    UInt32 reserved0; 
    UInt32 reserved1; 
  };
  typedef struct SSpSpeakerSetupData SSpSpeakerSetupData;
  enum
  {
    kSSpMedium_Air = 0,
    kSSpMedium_Water = 1
  };
 
  enum
  {
    kSSpSourceMode_Unfiltered = 0, 
    kSSpSourceMode_Localized = 1,  
    kSSpSourceMode_Ambient = 2,    
    kSSpSourceMode_Binaural = 3    
  };
 
  struct SSpLocationData
  {
    float elevation;        
    float azimuth;          
    float distance;         
    float projectionAngle;  
    float sourceVelocity;   
    float listenerVelocity; 
  };
  typedef struct SSpLocationData SSpLocationData;
  struct SSpVirtualSourceData
  {
    float attenuation;        
    SSpLocationData location; 
  };
  typedef struct SSpVirtualSourceData SSpVirtualSourceData;
  struct SSpLocalizationData
  {
    UInt32 cpuLoad; 
    UInt32 medium;           
    float humidity;          
    float roomSize;          
    float roomReflectivity;  
    float reverbAttenuation; 
    UInt32 sourceMode;               
    float referenceDistance;         
    float coneAngleCos;              
    float coneAttenuation;           
    SSpLocationData currentLocation; 
    UInt32 reserved0; 
    UInt32 reserved1; 
    UInt32 reserved2; 
    UInt32 reserved3; 
    UInt32 virtualSourceCount;             
    SSpVirtualSourceData virtualSource[4]; 
  };
  typedef struct SSpLocalizationData SSpLocalizationData;
#if TARGET_CPU_PPC
  typedef CALLBACK_API_C(Boolean, SSpEventProcPtr)(EventRecord *inEvent);
 
  /********************************************************************************
   *  Global functions
   ******************************************************************************/
  OSStatus
  SSpConfigureSpeakerSetup(SSpEventProcPtr inEventProcPtr);
 
  OSStatus
  SSpGetCPULoadLimit(UInt32 *outCPULoadLimit);
 
  /********************************************************************************
   *  Routines for Maniulating Listeners
   ******************************************************************************/
  typedef struct OpaqueSSpListenerReference *SSpListenerReference;
  OSStatus
  SSpListener_New(SSpListenerReference *outListenerReference);
 
  OSStatus
  SSpListener_Dispose(SSpListenerReference inListenerReference);
 
  OSStatus
  SSpListener_SetTransform(SSpListenerReference inListenerReference,
                           const TQ3Matrix4x4 *inTransform);
 
  OSStatus
  SSpListener_GetTransform(SSpListenerReference inListenerReference,
                           TQ3Matrix4x4 *outTransform);
 
  OSStatus
  SSpListener_SetPosition(SSpListenerReference inListenerReference,
                          const TQ3Point3D *inPosition);
 
  OSStatus
  SSpListener_GetPosition(SSpListenerReference inListenerReference,
                          TQ3Point3D *outPosition);
 
  OSStatus
  SSpListener_SetOrientation(SSpListenerReference inListenerReference,
                             const TQ3Vector3D *inOrientation);
 
  OSStatus
  SSpListener_GetOrientation(SSpListenerReference inListenerReference,
                             TQ3Vector3D *outOrientation);
 
  OSStatus
  SSpListener_SetUpVector(SSpListenerReference inListenerReference,
                          const TQ3Vector3D *inUpVector);
 
  OSStatus
  SSpListener_GetUpVector(SSpListenerReference inListenerReference,
                          TQ3Vector3D *outUpVector);
 
  OSStatus
  SSpListener_SetCameraPlacement(SSpListenerReference inListenerReference,
                                 const TQ3CameraPlacement *inCameraPlacement);
 
  OSStatus
  SSpListener_GetCameraPlacement(SSpListenerReference inListenerReference,
                                 TQ3CameraPlacement *outCameraPlacement);
 
  OSStatus
  SSpListener_SetVelocity(SSpListenerReference inListenerReference,
                          const TQ3Vector3D *inVelocity);
 
  OSStatus
  SSpListener_GetVelocity(SSpListenerReference inListenerReference,
                          TQ3Vector3D *outVelocity);
 
  OSStatus
  SSpListener_GetActualVelocity(SSpListenerReference inListenerReference,
                                TQ3Vector3D *outVelocity);
 
  OSStatus
  SSpListener_SetMedium(SSpListenerReference inListenerReference, UInt32 inMedium,
                        float inHumidity);
 
  OSStatus
  SSpListener_GetMedium(SSpListenerReference inListenerReference,
                        UInt32 *outMedium, float *outHumidity);
 
  OSStatus
  SSpListener_SetReverb(SSpListenerReference inListenerReference,
                        float inRoomSize, float inRoomReflectivity,
                        float inReverbAttenuation);
 
  OSStatus
  SSpListener_GetReverb(SSpListenerReference inListenerReference,
                        float *outRoomSize, float *outRoomReflectivity,
                        float *outReverbAttenuation);
 
  OSStatus
  SSpListener_SetMetersPerUnit(SSpListenerReference inListenerReference,
                               float inMetersPerUnit);
 
  OSStatus
  SSpListener_GetMetersPerUnit(SSpListenerReference inListenerReference,
                               float *outMetersPerUnit);
 
  /********************************************************************************
   *  Routines for Manipulating Sources
   ******************************************************************************/
  typedef struct OpaqueSSpSourceReference *SSpSourceReference;
  OSStatus
  SSpSource_New(SSpSourceReference *outSourceReference);
 
  OSStatus
  SSpSource_Dispose(SSpSourceReference inSourceReference);
 
  OSStatus
  SSpSource_CalcLocalization(SSpSourceReference inSourceReference,
                             SSpListenerReference inListenerReference,
                             SSpLocalizationData *out3DInfo);
 
  OSStatus
  SSpSource_SetTransform(SSpSourceReference inSourceReference,
                         const TQ3Matrix4x4 *inTransform);
 
  OSStatus
  SSpSource_GetTransform(SSpSourceReference inSourceReference,
                         TQ3Matrix4x4 *outTransform);
 
  OSStatus
  SSpSource_SetPosition(SSpSourceReference inSourceReference,
                        const TQ3Point3D *inPosition);
 
  OSStatus
  SSpSource_GetPosition(SSpSourceReference inSourceReference,
                        TQ3Point3D *outPosition);
 
  OSStatus
  SSpSource_SetOrientation(SSpSourceReference inSourceReference,
                           const TQ3Vector3D *inOrientation);
 
  OSStatus
  SSpSource_GetOrientation(SSpSourceReference inSourceReference,
                           TQ3Vector3D *outOrientation);
 
  OSStatus
  SSpSource_SetUpVector(SSpSourceReference inSourceReference,
                        const TQ3Vector3D *inUpVector);
 
  OSStatus
  SSpSource_GetUpVector(SSpSourceReference inSourceReference,
                        TQ3Vector3D *outUpVector);
 
  OSStatus
  SSpSource_SetCameraPlacement(SSpSourceReference inSourceReference,
                               const TQ3CameraPlacement *inCameraPlacement);
 
  OSStatus
  SSpSource_GetCameraPlacement(SSpSourceReference inSourceReference,
                               TQ3CameraPlacement *outCameraPlacement);
 
  OSStatus
  SSpSource_SetVelocity(SSpSourceReference inSourceReference,
                        const TQ3Vector3D *inVelocity);
 
  OSStatus
  SSpSource_GetVelocity(SSpSourceReference inSourceReference,
                        TQ3Vector3D *outVelocity);
 
  OSStatus
  SSpSource_GetActualVelocity(SSpSourceReference inSourceReference,
                              TQ3Vector3D *outVelocity);
 
  OSStatus
  SSpSource_SetCPULoad(SSpSourceReference inSourceReference, UInt32 inCPULoad);
 
  OSStatus
  SSpSource_GetCPULoad(SSpSourceReference inSourceReference, UInt32 *outCPULoad);
 
  OSStatus
  SSpSource_SetMode(SSpSourceReference inSourceReference, UInt32 inMode);
 
  OSStatus
  SSpSource_GetMode(SSpSourceReference inSourceReference, UInt32 *outMode);
 
  OSStatus
  SSpSource_SetReferenceDistance(SSpSourceReference inSourceReference,
                                 float inReferenceDistance);
 
  OSStatus
  SSpSource_GetReferenceDistance(SSpSourceReference inSourceReference,
                                 float *outReferenceDistance);
 
  OSStatus
  SSpSource_SetSize(SSpSourceReference inSourceReference, float inLength,
                    float inWidth, float inHeight);
 
  OSStatus
  SSpSource_GetSize(SSpSourceReference inSourceReference, float *outLength,
                    float *outWidth, float *outHeight);
 
  OSStatus
  SSpSource_SetAngularAttenuation(SSpSourceReference inSourceReference,
                                  float inConeAngle, float inConeAttenuation);
 
  OSStatus
  SSpSource_GetAngularAttenuation(SSpSourceReference inSourceReference,
                                  float *outConeAngle, float *outConeAttenuation);
 
  /********************************************************************************
   *  OpenGL Calling Convention Call Variants
   ******************************************************************************/
  OSStatus
  SSpListener_SetTransformfv(SSpListenerReference inListenerReference,
                             const float *inTransform);
 
  OSStatus
  SSpListener_GetTransformfv(SSpListenerReference inListenerReference,
                             float *outTransform);
 
  OSStatus
  SSpListener_SetPosition3f(SSpListenerReference inListenerReference, float inX,
                            float inY, float inZ);
 
  OSStatus
  SSpListener_SetPositionfv(SSpListenerReference inListenerReference,
                            const float *inPosition);
 
  OSStatus
  SSpListener_GetPositionfv(SSpListenerReference inListenerReference,
                            float *outPosition);
 
  OSStatus
  SSpListener_SetOrientation3f(SSpListenerReference inListenerReference,
                               float inX, float inY, float inZ);
 
  OSStatus
  SSpListener_SetOrientationfv(SSpListenerReference inListenerReference,
                               const float *inOrientation);
 
  OSStatus
  SSpListener_GetOrientationfv(SSpListenerReference inListenerReference,
                               float *outOrientation);
 
  OSStatus
  SSpListener_SetUpVector3f(SSpListenerReference inListenerReference, float inX,
                            float inY, float inZ);
 
  OSStatus
  SSpListener_SetUpVectorfv(SSpListenerReference inListenerReference,
                            const float *inUpVector);
 
  OSStatus
  SSpListener_GetUpVectorfv(SSpListenerReference inListenerReference,
                            float *outUpVector);
 
  OSStatus
  SSpListener_SetCameraPlacementfv(SSpListenerReference inListenerReference,
                                   const float *inCameraLocation,
                                   const float *inPointOfInterest,
                                   const float *inUpVector);
 
  OSStatus
  SSpListener_GetCameraPlacementfv(SSpListenerReference inListenerReference,
                                   float *outCameraPlacement,
                                   float *outPointOfInterest, float *outUpVector);
 
  OSStatus
  SSpListener_SetVelocity3f(SSpListenerReference inListenerReference, float inX,
                            float inY, float inZ);
 
  OSStatus
  SSpListener_SetVelocityfv(SSpListenerReference inListenerReference,
                            const float *inVelocity);
 
  OSStatus
  SSpListener_GetVelocityfv(SSpListenerReference inListenerReference,
                            float *outVelocity);
 
  OSStatus
  SSpListener_GetActualVelocityfv(SSpListenerReference inListenerReference,
                                  float *outVelocity);
 
  OSStatus
  SSpSource_SetTransformfv(SSpSourceReference inSourceReference,
                           const float *inTransform);
 
  OSStatus
  SSpSource_GetTransformfv(SSpSourceReference inSourceReference,
                           float *outTransform);
 
  OSStatus
  SSpSource_SetPosition3f(SSpSourceReference inSourceReference, float inX,
                          float inY, float inZ);
 
  OSStatus
  SSpSource_SetPositionfv(SSpSourceReference inSourceReference,
                          const float *inPosition);
 
  OSStatus
  SSpSource_GetPositionfv(SSpSourceReference inSourceReference,
                          float *outPosition);
 
  OSStatus
  SSpSource_SetOrientation3f(SSpSourceReference inSourceReference, float inX,
                             float inY, float inZ);
 
  OSStatus
  SSpSource_SetOrientationfv(SSpSourceReference inSourceReference,
                             const float *inOrientation);
 
  OSStatus
  SSpSource_GetOrientationfv(SSpSourceReference inSourceReference,
                             float *outOrientation);
 
  OSStatus
  SSpSource_SetUpVector3f(SSpSourceReference inSourceReference, float inX,
                          float inY, float inZ);
 
  OSStatus
  SSpSource_SetUpVectorfv(SSpSourceReference inSourceReference,
                          const float *inUpVector);
 
  OSStatus
  SSpSource_GetUpVectorfv(SSpSourceReference inSourceReference,
                          float *outUpVector);
 
  OSStatus
  SSpSource_SetCameraPlacementfv(SSpSourceReference inSourceReference,
                                 const float *inCameraLocation,
                                 const float *inPointOfInterest,
                                 const float *inUpVector);
 
  OSStatus
  SSpSource_GetCameraPlacementfv(SSpSourceReference inSourceReference,
                                 float *outCameraPlacement,
                                 float *outPointOfInterest, float *outUpVector);
 
  OSStatus
  SSpSource_SetVelocity3f(SSpSourceReference inSourceReference, float inX,
                          float inY, float inZ);
 
  OSStatus
  SSpSource_SetVelocityfv(SSpSourceReference inSourceReference,
                          const float *inVelocity);
 
  OSStatus
  SSpSource_GetVelocityfv(SSpSourceReference inSourceReference,
                          float *outVelocity);
 
  OSStatus
  SSpSource_GetActualVelocityfv(SSpSourceReference inSourceReference,
                                float *outVelocity);
 
#endif 
/********************************************************************************
 *    LATE-BREAKING NEWS
 *
 *    After the documentation was completed, it was decided that the SSpSetup
 *  were not specific enough.  We renamed them to SSpSpeakerSetup.  These
 *    #defines allow code to be written per the documentation.  But please use
 * the new, longer names, as the #defines will be removed in a later release.
 ******************************************************************************/
#define SSpConfigureSetup SSpConfigureSpeakerSetup
 
#define siSSpSetup siSSpSpeakerSetup
#define SSpSetupData SSpSpeakerSetupData
 
  /********************************************************************************
   *  MORE LATE-BREAKING NEWS
   *
   *  The SndGetInfo selector siSSpFilterVersion and datatype SSpFilterVersionData
   *  have been removed in favor of an alternate way of accessing filter version
   *  information.  The following function may be used for this purpose.
   *******************************************************************************
  // **************************** GetSSpFilterVersion ****************************
  // Finds the manufacturer and version number of the SoundSprocket filter that
  // may be installed.  inManufacturer should be the manufacturer code specified
  // at the installation time, which may be zero to allow any manufacturer.
  // If no error is encountered, outManufacturer is set to the actual manufacturer
  // code and outMajorVersion and outMinorVersion are set to the component
  // specification level and manufacturer's implementation revision, respectively.
  OSStatus GetSSpFilterVersion(
      OSType                  inManufacturer,
      OSType*                 outManufacturer,
      UInt32*                 outMajorVersion,
      UInt32*                 outMinorVersion)
  {
      OSStatus                err;
      ComponentDescription    description;
      Component               componentRef;
      UInt32                  vers;
 
      // Set up the component description
      description.componentType           = kSoundEffectsType;
      description.componentSubType        = kSSpLocalizationSubType;
      description.componentManufacturer   = inManufacturer;
      description.componentFlags          = 0;
      description.componentFlagsMask      = 0;
 
      // Find a component matching the description
      componentRef = FindNextComponent(nil, &description);
      if (componentRef == nil)  return couldntGetRequiredComponent;
 
      // Get the component description (for the manufacturer code)
      err = GetComponentInfo(componentRef, &description, nil, nil, nil);
      if (err != noErr)  return err;
 
      // Get the version composite
      vers = (UInt32) GetComponentVersion((ComponentInstance) componentRef);
 
      // Return the results
      *outManufacturer = description.componentManufacturer;
      *outMajorVersion = HiWord(vers);
      *outMinorVersion = LoWord(vers);
 
      return noErr;
  }
  *******************************************************************************/
 
#if PRAGMA_STRUCT_ALIGN
#pragma options align = reset
#elif PRAGMA_STRUCT_PACKPUSH
#pragma pack(pop)
#elif PRAGMA_STRUCT_PACK
#pragma pack()
#endif
 
#ifdef PRAGMA_IMPORT_OFF
#pragma import off
#elif PRAGMA_IMPORT
#pragma import reset
#endif
 
#ifdef __cplusplus
}
#endif
 
#endif