path: root/us_maker_edition/src/media/UAudioCore_Bass.pas

{* UltraStar Deluxe - Karaoke Game
 *
 * UltraStar Deluxe is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; see the file COPYING. If not, write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
 * Boston, MA 02110-1301, USA.
 *
 * $URL$
 * $Id$
 *}

unit UAudioCore_Bass;

interface

{$IFDEF FPC}
  {$MODE Delphi}
{$ENDIF}

{$I switches.inc}

uses
  Classes,
  SysUtils,
  UMusic,
  bass;     // (Note: DWORD is defined here)

type
  TAudioCore_Bass = class
    public
      constructor Create();
      class function GetInstance(): TAudioCore_Bass;
      function CheckVersion(): boolean;
      function ErrorGetString(): string; overload;
      function ErrorGetString(errCode: integer): string; overload;
      function ConvertAudioFormatToBASSFlags(Format: TAudioSampleFormat; out Flags: DWORD): boolean;
      function ConvertBASSFlagsToAudioFormat(Flags: DWORD; out Format: TAudioSampleFormat): boolean;
    private
      function DecodeVersion(VersionHex: integer): string;
  end;

implementation

uses
  UMain,
  ULog;

const
  // BASS 2.4.2 is not ABI compatible with older versions
  // as (BASS_RECORDINFO.driver was removed)
  BASS_MIN_REQUIRED_VERSION = $02040201;

var
  Instance: TAudioCore_Bass;

constructor TAudioCore_Bass.Create();
begin
  inherited;
end;

class function TAudioCore_Bass.GetInstance(): TAudioCore_Bass;
begin
  if (not Assigned(Instance)) then
    Instance := TAudioCore_Bass.Create();
  Result := Instance;
end;

function TAudioCore_Bass.DecodeVersion(VersionHex: integer): string;
var
  Version: array [0..3] of integer;
begin
  Version[0] := (VersionHex shr 24) and $FF;
  Version[1] := (VersionHex shr 16) and $FF;
  Version[2] := (VersionHex shr 8) and $FF;
  Version[3] := (VersionHex shr 0) and $FF;
  Result := Format('%x.%x.%x.%x', [Version[0], Version[1], Version[2], Version[3]]);
end;

function TAudioCore_Bass.CheckVersion(): boolean;
begin
  Result := BASS_GetVersion() >= BASS_MIN_REQUIRED_VERSION;
  if (not Result) then
  begin
    Log.LogWarn('Could not init BASS audio library. ''bass.dll'' version is ' + DecodeVersion(BASS_GetVersion()) + ' but ' + DecodeVersion(BASS_MIN_REQUIRED_VERSION) + ' or higher is required.',
        'TAudioCore_Bass.CheckVersion');
  end;
end;

function TAudioCore_Bass.ErrorGetString(): string;
begin
  Result := ErrorGetString(BASS_ErrorGetCode());
end;

function TAudioCore_Bass.ErrorGetString(errCode: integer): string;
begin
  case errCode of
    BASS_OK:             result := 'No error';
    BASS_ERROR_MEM:      result := 'Insufficient memory';
    BASS_ERROR_FILEOPEN: result := 'File could not be opened';
    BASS_ERROR_DRIVER:   result := 'Device driver not available';
    BASS_ERROR_BUFLOST:  result := 'Buffer lost';
    BASS_ERROR_HANDLE:   result := 'Invalid Handle';
    BASS_ERROR_FORMAT:   result := 'Sample-Format not supported';
    BASS_ERROR_POSITION: result := 'Illegal position';
    BASS_ERROR_INIT:     result := 'BASS_Init has not been successfully called';
    BASS_ERROR_START:    result := 'Paused/stopped';
    BASS_ERROR_ALREADY:  result := 'Already created/used';
    BASS_ERROR_NOCHAN:   result := 'No free channels';
    BASS_ERROR_ILLTYPE:  result := 'Type is invalid';
    BASS_ERROR_ILLPARAM: result := 'Illegal parameter';
    BASS_ERROR_NO3D:     result := 'No 3D support';
    BASS_ERROR_NOEAX:    result := 'No EAX support';
    BASS_ERROR_DEVICE:   result := 'Invalid device number';
    BASS_ERROR_NOPLAY:   result := 'Channel not playing';
    BASS_ERROR_FREQ:     result := 'Freq out of range';
    BASS_ERROR_NOTFILE:  result := 'Not a file stream';
    BASS_ERROR_NOHW:     result := 'No hardware support';
    BASS_ERROR_EMPTY:    result := 'Is empty';
    BASS_ERROR_NONET:    result := 'Network unavailable';
    BASS_ERROR_CREATE:   result := 'Creation error';
    BASS_ERROR_NOFX:     result := 'DX8 effects unavailable';
    BASS_ERROR_NOTAVAIL: result := 'Not available';
    BASS_ERROR_DECODE:   result := 'Is a decoding channel';
    BASS_ERROR_DX:       result := 'Insufficient version of DirectX';
    BASS_ERROR_TIMEOUT:  result := 'Timeout';
    BASS_ERROR_FILEFORM: result := 'File-Format not recognised/supported';
    BASS_ERROR_SPEAKER:  result := 'Requested speaker(s) not support';
    BASS_ERROR_VERSION:  result := 'Version error';
    BASS_ERROR_CODEC:    result := 'Codec not available/supported';
    BASS_ERROR_ENDED:    result := 'The channel/file has ended';
    BASS_ERROR_UNKNOWN:  result := 'Unknown error';
    else                 result := 'Unknown error';
  end;
end;

function TAudioCore_Bass.ConvertAudioFormatToBASSFlags(Format: TAudioSampleFormat; out Flags: DWORD): boolean;
begin
  case Format of
    asfS16:   Flags := 0;
    asfFloat: Flags := BASS_SAMPLE_FLOAT;
    asfU8:    Flags := BASS_SAMPLE_8BITS;
    else begin
      Result := false;
      Exit;
    end;
  end;

  Result := true;
end;

function TAudioCore_Bass.ConvertBASSFlagsToAudioFormat(Flags: DWORD; out Format: TAudioSampleFormat): boolean;
begin
  if ((Flags and BASS_SAMPLE_FLOAT) <> 0) then
    Format := asfFloat
  else if ((Flags and BASS_SAMPLE_8BITS) <> 0) then
    Format := asfU8
  else
    Format := asfS16;

  Result := true;
end;

end.