Twierdza RPG Maker

	Informacje \|\| Problemy z RPGXP \|\| Zgłoś nowe materiały
	RPG Maker :: RPG Maker XP

FMOD_AUDIER - dodatkowe formaty muzyczne

Witam! Dzisiaj prezentuje skrypt, który wzbogaca RPG Makera o funkcję odtwarzania nowych formatów dźwiękowych.
Lista obsługiwanych formatów:
AIFF, ASF, ASX, DLS, FLAC, FSB, IT, M3U, MID, MOD, MP2, MP3, OGG, PLS, RAW, S3M, VAG, WAV, WAX, WMA, XM, XMA.
Dodatkowo możliwa jest obsługa dźwięku tzw. 3-D przy użyciu opcji script na trzeciej karcie.
Wymagania: do projektu należy dodać bibliotekę ruby'ego FMOD. Wymagane biblioteki dll: fmodex.dll, rgss102e.dll lub nowsza.

1. Licencja. Ponieważ skrypt wykorzystuje komercyjne biblioteki, podaję tutaj licencję fmodex, a przynajmniej jej podstawowe założenie:
biblioteka FMOD może być dołączana do projektów, za których publikację autor nie pobiera opłat. W przypadku projektu komercyjnego, należy kupić licencję biblioteki FMOD. Cena tej licencji wynosi $100.
Niestety, darmowe biblioteki, które testowałem, nie obsługują Windowsa XP.

2. Dodawanie gemu FMOD.
W rubym podstawowym instalacja FMOD sprowadza się do jednego polecenia, w RGSS wygląda to jednak inaczej.
Instrukcja:
1. Pobierz bibliotekę fmodex.dll i wklej do folderu ze skryptem.
2. Utwórz nowy skrypt w script editorze i wklej ten tekst:
Uwaga! Oryginalny skrypt FMOD był przeze mnie edytowany tak, by łatwiej był zarządzać odtwarzaniem w pętli, nie należy więc korzystać z wersji pobranej ze strony FMOD.


# Audio module
# By Darkleo
 
module Audio
  extend self
end
 
class AudioFile
  attr_reader :name
  attr_reader :sound
  def initialize filename, loopmode = FMod::LOOP_OFF
    @name = filename
    @sound = FMod::Sound.new filename
    @sound.loopMode = loopmode
    @channel = @sound.play true
    @closed = false
  end
  # TODO : use method missing...
  def play
    fail 'File closed' if @closed
    @channel.paused = false
  end
  def playing?
    fail 'File closed' if @closed
    !@channel.paused?
    #@channel start paused
  end
  def pause
    fail 'File closed' if @closed
    @channel.paused = true
  end
  def paused= bool
    fail 'File closed' if @closed
    @channel.paused = bool
  end
  def paused?
    fail 'File closed' if @closed
    @channel.paused?
  end
  def volume
    fail 'File closed' if @closed
    @channel.volume
  end
  def volume= vol
    fail 'File closed' if @closed
    @channel.volume = vol
  end
  def pan
    fail 'File closed' if @closed
    @channel.pan
  end
  def pan= pa
    fail 'File closed' if @closed
    @channel.pan = pa
  end
  def frequency
    fail 'File closed' if @closed
    @channel.frequency
  end
  def frequency= freq
    fail 'File closed' if @closed
    @channel.frequency = freq
  end
  def position unit=FMod::DEFAULT_UNIT
    fail 'File closed' if @closed
    @channel.position unit
  end
  def position=(pos, unit=FMod::DEFAULT_UNIT)
    fail 'File closed' if @closed
    @channel.position= pos, unit
  end
  def close
    fail 'File already closed' if @closed
    @channel.stop
    @sound.release
    @closed = true
  end
end
 
 
 

# DLL handle
# By Darkleo
# Thx to for constants and methods names
 
module FMod
  extend self
  dir = File.dirname(File.dirname(__FILE__))
  DLL_PATH = dir + '/fmodex.dll'
 
  # FMOD_INITFLAGS flags
  INIT_NORMAL = 0
  # FMOD_RESULT flags
  OK = 0
  ERR_CHANNEL_STOLEN = 11
  ERR_FILE_NOT_FOUND = 23
  ERR_INVALID_HANDLE = 36
  # FMOD_MODE flags
  DEFAULT = 0
  LOOP_OFF = 1
  LOOP_NORMAL = 2
  LOOP_BIDI = 4
  LOOP_BITMASK = 7
  FMOD_2D = 8
  FMOD_3D = 16
  HARDWARE = 32
  SOFTWARE = 64
  CREATESTREAM = 128
  CREATESAMPLE = 256
  OPENUSER = 512
  OPENMEMORY = 1024
  OPENRAW = 2048
  OPENONLY = 4096
  ACCURATETIME = 8192
  MPEGSEARCH = 16384
  NONBLOCKING = 32768
  UNIQUE = 65536
  # The default mode that the script uses
  DEFAULT_SOFTWARWE = LOOP_OFF | FMOD_2D | SOFTWARE
  # FMOD_CHANNELINDEX flags
  CHANNEL_FREE = -1
  CHANNEL_REUSE = -2
  # FMOD_TIMEUNIT_flags
  TIMEUNIT_MS = 1
  TIMEUNIT_PCM = 2
  # The default time unit the script uses
  DEFAULT_UNIT = TIMEUNIT_MS
  # Types supported by FMOD Ex
  FILE_TYPES = ['ogg', 'aac', 'wma', 'mp3', 'wav', 'it', 'xm', 'mod', 's3m', 'mid', 'midi']
 
  module System
    extend self
    pre = 'FMOD_System_'
    Create       = Win32API.new DLL_PATH, pre + 'Create',       'p',     'l'
    Init         = Win32API.new DLL_PATH, pre + 'Init',         'llll',  'l'
    Close        = Win32API.new DLL_PATH, pre + 'Close',        'l',     'l'
    Release      = Win32API.new DLL_PATH, pre + 'Release',      'l',     'l'
    CreateSound  = Win32API.new DLL_PATH, pre + 'CreateSound',  'lpllp', 'l'
    CreateStream = Win32API.new DLL_PATH, pre + 'CreateStream', 'lpllp', 'l'
    PlaySound    = Win32API.new DLL_PATH, pre + 'PlaySound',    'llllp', 'l'
 
    def start max_channels=32, flag=INIT_NORMAL, extraDriverData=0
      temp = '\x00'*4
      Create.call temp
      @@id = temp.unpack('i')[0]
      Init.call @@id, 32, INIT_NORMAL, 0
    end
    def dispose
      return unless @@id
      Close @@id
      Release @@id
      @@id = nil
    end
    def createSound filename, mode=DEFAULT_SOFTWARWE
      temp = '\x00'*4
      result = CreateSound.call @@id, filename, mode, 0, temp
      fail "File not found: \"#{filename}\"" if result == ERR_FILE_NOT_FOUND
      temp.unpack('i')[0]
    end
    def createStream filename, mode=DEFAULT_SOFTWARWE
      temp = '\x00'*4
      result = CreateStream.call @@id, filename, mode, 0, temp
      fail "File not found: \"#{filename}\"" if result == ERR_FILE_NOT_FOUND
      temp.unpack('i')[0]
    end
    def playSound id, paused=false, channel=nil
      temp = channel ? [channel].pack('l') : '\x00'*4
      mode = channel ? CHANNEL_REUSE : CHANNEL_FREE
      paused = paused ? 1 : 0
      PlaySound.call @@id, mode, id, paused, temp
      Channel.new temp.unpack('i')[0]
    end
  end
  System.start
 
  class Sound
    pre = 'FMOD_Sound_'
    Release       = Win32API.new DLL_PATH, pre + 'Release',       'l',     'l'
    GetMode       = Win32API.new DLL_PATH, pre + 'GetMode',       'lp',    'l'
    SetMode       = Win32API.new DLL_PATH, pre + 'SetMode',       'll',    'l'
    SetLoopPoints = Win32API.new DLL_PATH, pre + 'SetLoopPoints', 'lllll', 'l'
    GetLength     = Win32API.new DLL_PATH, pre + 'GetLength',     'lpl',   'l'
 
    attr_reader :id
    attr_reader :channel
    def initialize filename
      @id = System.createSound filename
    end
    def release
      Release.call @id
    end
    def play paused=false
      @channel = System.playSound @id, paused
    end
    def mode
      temp = '\x00'*4
      GetMode.call @id, temp
      temp.unpack('i')[0]
    end
    def mode=
      temp = '\x00'*4
      GetMode.call @id, temp
      temp.unpack('i')[0]
    end
    def loopMode
      temp = '\x00'*4
      GetMode.call @id, temp
      temp.unpack('i')[0] & LOOP_BITMASK
    end
    def loopMode= newMode
      SetMode.call @id, (mode & ~LOOP_BITMASK | newMode)
    end
    def lenght unit=DEFAULT_UNIT
      temp = '\x00'*4
      GetLength.call @id, temp, unit
      temp.unpack('i')[0]
    end
  end
 
  class Channel
    pre = 'FMOD_Channel_'
    Stop         = Win32API.new DLL_PATH, pre + 'Stop',         'l',   'l'
    IsPlaying    = Win32API.new DLL_PATH, pre + 'IsPlaying',    'lp',  'l'
    GetPaused    = Win32API.new DLL_PATH, pre + 'GetPaused',    'lp',  'l'
    SetPaused    = Win32API.new DLL_PATH, pre + 'SetPaused',    'll',  'l'
    GetVolume    = Win32API.new DLL_PATH, pre + 'GetVolume',    'lp',  'l'
    SetVolume    = Win32API.new DLL_PATH, pre + 'SetVolume',    'll',  'l'
    GetPan       = Win32API.new DLL_PATH, pre + 'GetPan',       'lp',  'l'
    SetPan       = Win32API.new DLL_PATH, pre + 'SetPan',       'll',  'l'
    GetFrequency = Win32API.new DLL_PATH, pre + 'GetFrequency', 'lp',  'l'
    SetFrequency = Win32API.new DLL_PATH, pre + 'SetFrequency', 'll',  'l'
    GetPosition  = Win32API.new DLL_PATH, pre + 'GetPosition',  'lpl', 'l'
    SetPosition  = Win32API.new DLL_PATH, pre + 'SetPosition',  'lll', 'l'
 
    attr_reader :id
    def initialize id
      @id = id
    end
    def stop
      Stop.call @id
    end
    def playing?
      temp = '\x00'*4
      IsPlaying.call @id, temp
      temp.unpack('i')[0] != 0
    end
    def paused?
      temp = '\x00'*4
      GetPaused.call @id, temp
      temp.unpack('i')[0] != 0
    end
    def paused=bool
      SetPaused.call @id, (bool ? 1 : 0)
    end
    def volume
      temp = '\x00'*4
      GetVolume.call @id, temp
      temp.unpack('f')[0]
    end
    def volume= vol
      SetVolume.call @id, [vol].pack('f').unpack('i')[0]
    end
    def pan
      temp = '\x00'*4
      GetPan.call @id, temp
      temp.unpack('f')[0]
    end
    def pan= pa
      SetPan.call @id, [pa].pack('f').unpack('i')[0]
    end
    def frequency
      temp = '\x00'*4
      GetFrequency.call @id, temp
      temp.unpack('f')[0]
    end
    def frequency= freq
      SetFrequency.call @id, [freq].pack('f').unpack('i')[0]
    end
    def position unit=DEFAULT_UNIT
      temp = '\x00'*4
      GetPosition.call @id, temp, unit
      temp.unpack('i')[0]
    end
    def position= pos, unit=DEFAULT_UNIT
      pos = pos[0] if Array === pos # why [pos, unit] ???
      SetPosition.call @id, pos, unit
    end
  end
end

Ok, gem FMOD został dodany.

3. Skrypt obsługi unikodu.
Do korzystania z FMOD_Audier wymagany jest jeszcze skrypt obsługi utf. Nie wiem, komu przyznać autorstwo, w napisaniu jego pierwszej części pomogła mi Ayene z ultimaforum, drugą napisałem, a trzecią znalazłem w Internecie. :)


  def futf8(text)
    mw = Win32API.new("kernel32", "MultiByteToWideChar", "ilpipi", "i")
    wm = Win32API.new("kernel32", "WideCharToMultiByte", "ilpipipp", "i")
    len = mw.call(0, 0, text, -1, nil, 0)
    buf = "\0" * (len*2)
    mw.call(0, 0, text, -1, buf, buf.size/2)
    len = wm.call(65001, 0, buf, -1, nil, 0, nil, nil)
    ret = "\0" * len
    wm.call(65001, 0, buf, -1, ret, ret.size, nil, nil)
    for i in 0..ret.size - 1
      ret[i..i] = "\0" if ret[i] == 0
    end
    ret.delete!("\0")
    return ret
  end
 
def utf8(text)
  text = "" if text == nil or text == false
ext = "\0" if text == nil
to_char = Win32API.new("kernel32", "MultiByteToWideChar", 'ilpipi', 'i')
to_byte = Win32API.new("kernel32", "WideCharToMultiByte", 'ilpipipp', 'i')
utf8 = 65001
w = to_char.call(utf8, 0, text.to_s, text.size, nil, 0)
b = "\0" * (w*2)
w = to_char.call(utf8, 0, text.to_s, text.size, b, b.size/2)
w = to_byte.call(0, 0, b, b.size/2, nil, 0, nil, nil)
b2 = "\0" * w
w = to_byte.call(0, 0, b, b.size/2, b2, b2.size, nil, nil)
return(b2)
  end

4. Skrypt właściwy.
Czas wkleić właściwy skrypt:


#FMOD_AUDIER SCRIPT BY PAJPER
module Audio_FMOD
  $bgm = nil
  $bgs = nil
  $me = []
  $se = []
  def self.bgm_play(file,volume=100,pitch=100)
    file = file.to_s
    volume = volume.to_i
    pitch = pitch.to_i
    file = searchaudiofileextension(file)
if $bgm != nil
  $bgm.close
  $bgm = nil
end
$bgm = AudioFile.new(utf8(file),2)
if volume < 100
  $bgm.volume = (volume.to_f / 100.to_f).to_f
end
if pitch != 100 and pitch >= 0 and pitch <= 200
  bs = $bgm.frequency
  freq = bs.to_f * (pitch.to_f / 100.to_f).to_f
  $bgm.frequency = freq
end
$bgm.play
return file
  end
  def self.bgm_stop
    if $bgm != nil
      $bgm.close
      $bgm = nil
      return true
    end
    return false
  end
  def self.bgm_fade(time=1000)
    Thread.new do
      t = time
                    pr = ($bgs.volume.to_f / 100.to_f).to_f
        w = (t.to_f / 100.to_f / 1000.to_f).to_f
      for i in 1..100
        if $bgm != nil
        sleep(w)
        $bgm.volume -= pr
      else
        break
        end
        end
      end
    end
    def self.bgs_play(file,volume=100,pitch=100)
    file = file.to_s
    volume = volume.to_i
    pitch = pitch.to_i
    file = searchaudiofileextension(file)
if $bgs != nil
  $bgs.close
  $bgs = nil
end
$bgs = AudioFile.new(utf8(file),2)
if volume < 100
  $bgs.volume = (volume.to_f / 100.to_f).to_f
end
if pitch != 100 and pitch >= 0 and pitch <= 200
  bs = $bgs.frequency
  freq = bs.to_f * (pitch.to_f / 100.to_f).to_f
  $bgs.frequency = freq
end
$bgs.play
return file
  end
  def self.bgs_stop
    if $bgs != nil
      $bgs.close
      $bgs = nil
      return true
    end
    return false
  end
    def self.bgs_fade(time=1000)
    Thread.new do
      t = time
              pr = ($bgs.volume.to_f / 100.to_f).to_f
        w = (t.to_f / 100.to_f / 1000.to_f).to_f
      for i in 1..100
        if $bgs != nil
        sleep(w)
        $bgs.volume -= pr
      else
        break
        end
        end
      end
    end
    def self.me_play(file,volume=100,pitch=100)
    file = file.to_s
    volume = volume.to_i
    pitch = pitch.to_i
    file = searchaudiofileextension(file)
$me.push(AudioFile.new(utf8(file),1))
if volume < 100
  $me[$me.size - 1].volume = (volume.to_f / 100.to_f).to_f
end
if pitch != 100 and pitch >= 0 and pitch <= 200
  bs = $me[$me.size - 1].frequency
  freq = bs.to_f * (pitch.to_f / 100.to_f).to_f
  $me[$me.size - 1].frequency = freq
end
$me[$me.size - 1].play
return file
  end
  def self.me_stop
    suc = false
    for i in 0..$me.size - 1
      $me[i].close
      $me[i] = nil
    end
    $me = []
    return suc
  end
    def self.se_play(file,volume=100,pitch=100)
      file = file.to_s
    volume = volume.to_i
    pitch = pitch.to_i
    file = searchaudiofileextension(file)
$se.push(AudioFile.new(utf8(file),1))
if volume < 100
  $se[$se.size - 1].volume = (volume.to_f / 100.to_f).to_f
end
if pitch != 100 and pitch >= 0 and pitch <= 200
  bs = $se[$se.size - 1].frequency
  freq = bs.to_f * (pitch.to_f / 100.to_f).to_f
  $se[$se.size - 1].frequency = freq
end
$se[$se.size - 1].play
return file
  end
  def self.se_stop
    suc = false
for i in 0..$se.size - 1
      $se[i].close
      $se[i] = nil
      suc = true
    end
   $se = []
   return suc
  end
  def self.searchaudiofileextension(file)
    if FileTest.exist?(file) == false
ext = ['AIFF', 'ASF', 'ASX', 'DLS', 'FLAC', 'FSB', 'IT', 'M3U', 'MID', 'MOD', 'MP2', 'MP3', 'OGG', 'PLS', 'RAW', 'S3M', 'VAG', 'WAV', 'WAX', 'WMA', 'XM', 'XMA']
suc = false
for i in 0..ext.size - 1
  if FileTest.exist?(file + "." + ext[i])
    suc = true
    found = file + "." + ext[i]
    break
    end
end
if suc == true
  return found
else
  libfile = "\0" * 1024
  Win32API.new("kernel32","GetModuleFileNameA",'ipi','i').call(0,libfile,libfile.size)
  libfile.delete!("\0")
libfile = libfile.sub(File.dirname(libfile),".")
  libfile = libfile.sub(".exe",".ini")
  libfile = libfile.sub(".EXE",".INI")
  lib = "\0" * 1024
  Win32API.new("kernel32","GetPrivateProfileString",'ppppip','i').call("Game","Library","RGSS102E.dll",lib,lib.size,libfile)
  getrtppath = Win32API.new(lib, 'RGSSGetRTPPath', 'L', 'L')
    getpathwithrtp = Win32API.new(lib, 'RGSSGetPathWithRTP', 'L', 'P')
    rtp = ""
    for i in 0..1024
    rtp = getpathwithrtp.call(getrtppath.call(i))
    if rtp != ""
      break
      end
    end
    rtp = "." if rtp == ""
  return searchaudiofileextensionrtp(file,rtp)
  end
end
else
  return file
end
  def self.searchaudiofileextensionrtp(file,rtp)
file = rtp + "\\" + file
    if FileTest.exist?(file) == false
ext = ['AIFF', 'ASF', 'ASX', 'DLS', 'FLAC', 'FSB', 'IT', 'M3U', 'MID', 'MOD', 'MP2', 'MP3', 'OGG', 'PLS', 'RAW', 'S3M', 'VAG', 'WAV', 'WAX', 'WMA', 'XM', 'XMA']
suc = false
for i in 0..ext.size - 1
  if FileTest.exist?(file + "." + ext[i])
    suc = true
    found = file + "." + ext[i]
    break
    end
end
if suc == true
  return found
else
  return utf8(file)
  end
end
else
  return file
  end
end
Audio_OLD = Audio
Audio = Audio_FMOD

5. Instrukcja.
Po dodaniu skryptu, podmieniony zostanie moduł Audio. Sprawi to, że użycie w zdarzeniach opcji typu play se, automatycznie go uruchomi, odtwarzając pożądany plik. Skrypt potrafi odszukiwać RTP kompatybilne z RMXP. Używa on kilku zmiennych:
$bgm - zawiera uchwyt do odtwarzanego Audio bgm
$bgs - zawiera uchwyt do odtwarzanego dźwięku bgs
$me - tablica z uchwytami do muzyczek me
$se - tablica z uchwytami do dźwięków se.

Maksymalna ilość dźwięków SE/ME odtwarzana jednocześnie zależy od pamięci RAM komputera i przeciętnie wynosi około 1048576*128.
Jeśli z jakieś przyczyny ktoś będzie się chciał odwołać do starej metody odtwarzania dźwięku, informuję, że zapisana została ona w zmiennej Audio_OLD, zatem przykładowe odtworzenie pliku test.ogg wygląda tak:
Audio_OLD.se_play("test")

Autor: Pajper
Email: dawidpieper@o2.pl
Pobierz:

Biblioteka FMODEX.DLL (spakowana w zip)