GLScene/Source/GLSM.BASS.pas

//
// This unit is part of the GLScene Engine, http://glscene.org
//

unit GLSM.BASS;

(*
  BASS based sound-manager (http://www.un4seen.com/music/, free for freeware).
  Unsupported feature(s) :
  sound source velocity
  looping (sounds are played either once or forever)
  source priorities (not relevant, channels are not limited)
*)

interface

{$I GLScene.inc}

uses
  System.Classes,
  System.SysUtils,
  Vcl.Forms,

  GLSound,
  GLScene,
  GLVectorTypes,
  GLVectorGeometry,

  Import.BASS;

type
  TBASS3DAlgorithm = (algDefault, algOff, algFull, algLight);

  TGLSMBASS = class(TGLSoundManager)
  private
    FActivated: Boolean;
    FAlgorithm3D: TBASS3DAlgorithm;
  protected
    function DoActivate: Boolean; override;
    procedure DoDeActivate; override;
    procedure NotifyMasterVolumeChange; override;
    procedure Notify3DFactorsChanged; override;
    procedure NotifyEnvironmentChanged; override;
    procedure KillSource(aSource: TGLBaseSoundSource); override;
    procedure UpdateSource(aSource: TGLBaseSoundSource); override;
    procedure MuteSource(aSource: TGLBaseSoundSource; muted: Boolean); override;
    procedure PauseSource(aSource: TGLBaseSoundSource;
      paused: Boolean); override;
    function GetDefaultFrequency(aSource: TGLBaseSoundSource): Integer;
  public
    constructor Create(AOwner: TComponent); override;
    destructor Destroy; override;
    procedure UpdateSources; override;
    function CPUUsagePercent: Single; override;
    function EAXSupported: Boolean; override;
  published
    property Algorithm3D: TBASS3DAlgorithm read FAlgorithm3D write FAlgorithm3D
      default algDefault;
  end;

// ---------------------------------------------------------------------
implementation
// ---------------------------------------------------------------------

type
  TBASSInfo = record
    channel: HCHANNEL;
    sample: HSAMPLE;
  end;

  PBASSInfo = ^TBASSInfo;

procedure VectorToBASSVector(const aVector: TVector;
  var aBASSVector: BASS_3DVECTOR);
begin
  aBASSVector.x := aVector.x;
  aBASSVector.y := aVector.y;
  aBASSVector.z := -aVector.z;
end;

// ------------------
// ------------------ TGLSMBASS ------------------
// ------------------

constructor TGLSMBASS.Create(AOwner: TComponent);
begin
  inherited Create(AOwner);
  BASS_Load(bassdll);
  MaxChannels := 32;
end;

destructor TGLSMBASS.Destroy;
begin
  inherited Destroy;
  BASS_UnLoad;
end;

function TGLSMBASS.DoActivate: Boolean;
const
  c3DAlgo: array [algDefault .. algLight] of Integer = (BASS_3DALG_DEFAULT,
    BASS_3DALG_OFF, BASS_3DALG_FULL, BASS_3DALG_LIGHT);
begin
  Assert(bass_isloaded, 'BASS DLL is not present');
  if not BASS_Init(1, OutputFrequency, BASS_DEVICE_3D, Application.Handle, nil)
  then
  begin
    Result := False;
    Exit;
  end;
  if not BASS_Start then
  begin
    Result := False;
    Exit;
  end;
  FActivated := True;
  BASS_SetConfig(BASS_CONFIG_3DALGORITHM, c3DAlgo[FAlgorithm3D]);
  NotifyMasterVolumeChange;
  Notify3DFactorsChanged;
  if Environment <> seDefault then
    NotifyEnvironmentChanged;
  Result := True;
end;

procedure TGLSMBASS.DoDeActivate;
begin
  FActivated := False;
  BASS_Stop;
  BASS_Free;
end;

procedure TGLSMBASS.NotifyMasterVolumeChange;
begin
  if FActivated then
    BASS_SetVolume(Round(MasterVolume * 100));
end;

procedure TGLSMBASS.Notify3DFactorsChanged;
begin
  if FActivated then
    BASS_Set3DFactors(DistanceFactor, RollOffFactor, DopplerFactor);
end;

procedure TGLSMBASS.NotifyEnvironmentChanged;
const
  cEnvironmentToBASSConstant: array [seDefault .. sePsychotic] of Integer =
    (EAX_ENVIRONMENT_GENERIC, EAX_ENVIRONMENT_PADDEDCELL, EAX_ENVIRONMENT_ROOM,
    EAX_ENVIRONMENT_BATHROOM, EAX_ENVIRONMENT_LIVINGROOM,
    EAX_ENVIRONMENT_STONEROOM, EAX_ENVIRONMENT_AUDITORIUM,
    EAX_ENVIRONMENT_CONCERTHALL, EAX_ENVIRONMENT_CAVE, EAX_ENVIRONMENT_ARENA,
    EAX_ENVIRONMENT_HANGAR, EAX_ENVIRONMENT_CARPETEDHALLWAY,
    EAX_ENVIRONMENT_HALLWAY, EAX_ENVIRONMENT_STONECORRIDOR,
    EAX_ENVIRONMENT_ALLEY, EAX_ENVIRONMENT_FOREST, EAX_ENVIRONMENT_CITY,
    EAX_ENVIRONMENT_MOUNTAINS, EAX_ENVIRONMENT_QUARRY, EAX_ENVIRONMENT_PLAIN,
    EAX_ENVIRONMENT_PARKINGLOT, EAX_ENVIRONMENT_SEWERPIPE,
    EAX_ENVIRONMENT_UNDERWATER, EAX_ENVIRONMENT_DRUGGED, EAX_ENVIRONMENT_DIZZY,
    EAX_ENVIRONMENT_PSYCHOTIC);
begin
  if FActivated and EAXSupported then
    BASS_SetEAXParameters(cEnvironmentToBASSConstant[Environment], -1, -1, -1);
end;

procedure TGLSMBASS.KillSource(aSource: TGLBaseSoundSource);
var
  p: PBASSInfo;
begin
  if aSource.ManagerTag <> 0 then
  begin
    p := PBASSInfo(aSource.ManagerTag);
    if p.channel <> 0 then
      if not BASS_ChannelStop(p.channel) then
        Assert(False);
    BASS_SampleFree(p.sample);
    FreeMem(p);
    aSource.ManagerTag := 0;
  end;
end;

procedure TGLSMBASS.UpdateSource(aSource: TGLBaseSoundSource);
var
  i: Integer;
  p: PBASSInfo;
  objPos, objOri, objVel: TVector;
  position, orientation, velocity: BASS_3DVECTOR;
  res: Boolean;
begin
  if (sscSample in aSource.Changes) then
  begin
    KillSource(aSource);
  end;

  if (aSource.sample = nil) or (aSource.sample.Data = nil) or
    (aSource.sample.Data.WAVDataSize = 0) then
    Exit;
  if aSource.ManagerTag <> 0 then
  begin
    p := PBASSInfo(aSource.ManagerTag);
    if BASS_ChannelIsActive(p.channel) = 0 then
    begin
      p.channel := 0;
      aSource.Free;
      Exit;
    end;
  end
  else
  begin
    p := AllocMem(SizeOf(TBASSInfo));
    p.channel := 0;
    i := BASS_SAMPLE_VAM + BASS_SAMPLE_3D + BASS_SAMPLE_OVER_DIST;
    if aSource.NbLoops > 1 then
      i := i + BASS_SAMPLE_LOOP;
    p.sample := BASS_SampleLoad(True, aSource.sample.Data.WAVData, 0,
      aSource.sample.Data.WAVDataSize, MaxChannels, i);
    Assert(p.sample <> 0, 'BASS Error ' + IntToStr(Integer(BASS_ErrorGetCode)));
    aSource.ManagerTag := Integer(p);
    if aSource.Frequency <= 0 then
      aSource.Frequency := -1;
  end;
  if aSource.Origin <> nil then
  begin
    objPos := aSource.Origin.AbsolutePosition;
    objOri := aSource.Origin.AbsoluteZVector;
    objVel := NullHmgVector;
  end
  else
  begin
    objPos := NullHmgPoint;
    objOri := ZHmgVector;
    objVel := NullHmgVector;
  end;
  VectorToBASSVector(objPos, position);
  VectorToBASSVector(objVel, velocity);
  VectorToBASSVector(objOri, orientation);
  if p.channel = 0 then
  begin
    p.channel := BASS_SampleGetChannel(p.sample, False);
    Assert(p.channel <> 0);
    BASS_ChannelSet3DPosition(p.channel, position, orientation, velocity);
    BASS_ChannelSet3DAttributes(p.channel, BASS_3DMODE_NORMAL,
      aSource.MinDistance, aSource.MaxDistance, Round(aSource.InsideConeAngle),
      Round(aSource.OutsideConeAngle), Round(aSource.ConeOutsideVolume * 100));
    if not aSource.Pause then
      BASS_ChannelPlay(p.channel, True);

  end
  else
    BASS_ChannelSet3DPosition(p.channel, position, orientation, velocity);

  if p.channel <> 0 then
  begin
    res := BASS_ChannelSetAttribute(p.channel, BASS_ATTRIB_FREQ, 0);
    Assert(res);
    if aSource.Mute then
      res := BASS_ChannelSetAttribute(p.channel, BASS_ATTRIB_VOL, 0)
    else
      res := BASS_ChannelSetAttribute(p.channel, BASS_ATTRIB_VOL,
        aSource.Volume);
    Assert(res);
  end
  else
    aSource.Free;
  inherited UpdateSource(aSource);
end;

procedure TGLSMBASS.MuteSource(aSource: TGLBaseSoundSource; muted: Boolean);
var
  p: PBASSInfo;
  res: Boolean;
begin
  if aSource.ManagerTag <> 0 then
  begin
    p := PBASSInfo(aSource.ManagerTag);
    if muted then
      res := BASS_ChannelSetAttribute(p.channel, BASS_ATTRIB_VOL, 0)
    else
      res := BASS_ChannelSetAttribute(p.channel, BASS_ATTRIB_VOL,
        aSource.Volume);
    Assert(res);
  end;
end;

procedure TGLSMBASS.PauseSource(aSource: TGLBaseSoundSource; paused: Boolean);
var
  p: PBASSInfo;
begin
  if aSource.ManagerTag <> 0 then
  begin
    p := PBASSInfo(aSource.ManagerTag);
    if paused then
      BASS_ChannelPause(p.channel)
    else
      BASS_ChannelPlay(p.channel, False);
  end;
end;

procedure TGLSMBASS.UpdateSources;
var
  objPos, objVel, objDir, objUp: TVector;
  position, velocity, fwd, top: BASS_3DVECTOR;
begin
  // update listener
  ListenerCoordinates(objPos, objVel, objDir, objUp);
  VectorToBASSVector(objPos, position);
  VectorToBASSVector(objVel, velocity);
  VectorToBASSVector(objDir, fwd);
  VectorToBASSVector(objUp, top);
  if not BASS_Set3DPosition(position, velocity, fwd, top) then
    Assert(False);
  // update sources
  inherited;
  { if not } BASS_Apply3D; { then Assert(False); }
end;

function TGLSMBASS.CPUUsagePercent: Single;
begin
  Result := BASS_GetCPU * 100;
end;

function TGLSMBASS.EAXSupported: Boolean;
var
  c: Cardinal;
  s: Single;
begin
  Result := BASS_GetEAXParameters(c, s, s, s);
end;

function TGLSMBASS.GetDefaultFrequency(aSource: TGLBaseSoundSource): Integer;
var
  p: PBASSInfo;
  sampleInfo: BASS_Sample;
begin
  try
    p := PBASSInfo(aSource.ManagerTag);
    BASS_SampleGetInfo(p.sample, sampleInfo);
    Result := sampleInfo.freq;
  except
    Result := -1;
  end;
end;

end.