[X] My Assistant

[GubiD]

Introduction
Ever want to have better audio but to still have loop functionality? This script will allow you to configure by song name a start/begin loop/end loop position that will allow you to achive looping regardless the file format. Be it MID, MP3, OGG, or WAV.

The script

RUBY

#==============================================================================
# Modified Audio MP3 loop v1.0 for RMXP
# Original Script by Cogwheel (http://members.jcom.home.ne.jp/cogwheel/)
# Must provide credit to GubiD and Cogwheel for this script.
#==============================================================================


#==============================================================================
# ■ RPG
#------------------------------------------------------------------------------
# Module RPG(The Game)
#==============================================================================

module RPG
#==============================================================================
# ■ BGM
#------------------------------------------------------------------------------
# BGM Audio File additional methods
#==============================================================================

  class AudioFile
    #--------------------------------------------------------------------------
    # ● Play audio file
    #--------------------------------------------------------------------------
    def play
      if @name.empty?
        Audio.bgm_stop
        @@last = BGM.new
      else
        name = "Audio/BGM/"
        start = 0
        loop = 0
        step = [0, 0]
        fin = 0
        case @name
        when "035-Dungeon01"
          type = "Dungeon"
          start = 0
          loop = 2000 #restart location
          fin = 10000 #return to loop when
        when "003-Battle03"
          type = "Battle"
          start = 0
          loop = 1000
          fin = 15000
        else
          type = "Normal"
        end
        if type == "Normal"
          name = @name
        else
          name = $game_audio.name?("Audio/BGM/" + @name)
        end
        $game_audio.bgm_play(name, @volume, @pitch, type, start, loop, fin)
        @@last = self
      end
    end
    #--------------------------------------------------------------------------
    # ● BGM の演奏停止
    #--------------------------------------------------------------------------
    def stop
      $game_audio.bgm_stop
    end
    #--------------------------------------------------------------------------
    # ● BGM のフェードアウト
    #--------------------------------------------------------------------------
    def fade(time)
      $game_audio.fadeout_set(time)  
    end
  end
end

class Game_Audio
  #--------------------------------------------------------------------------
  # ● Initialize method
  #--------------------------------------------------------------------------
  def initialize
    @play = Win32API.new("winmm.dll", "mciSendString", ["p","p","l","l"], "i")
    @play.call("Close all", "\" * 255, 255, 0)
    @type = "Normal"
    @me_count = 0
    fadein_set(0)
  end
  #--------------------------------------------------------------------------
  # ● BGM の演奏
  #     name       : BGM filename
  #     vol        : volume
  #     pitch      : tone level
  #     type       : battle/dungeon/normal, dungeon pauses when battle is called
  #     start      : start position
  #     loop       : loop position
  #     fin        : finish position
  #--------------------------------------------------------------------------
  def bgm_play(name, vol, pitch, type, start, loop, fin)
    fadein_set(0)
    if type == "Normal"
      bgm_stop(type) if @name != name
      Audio.bgm_play("Audio/BGM/" + name, vol, 100) if name != ""
    elsif @name != name
      bgm_stop(type)
      status = "\" * 255
      @play.call("Status " + type + " mode", status, 255, 0)
      if status.unpack("A*")[0] == "paused"
        @play.call("Setaudio " + type + " volume to 0", "\" * 255, 255, 0)
        @play.call("Play " + type, "\" * 255, 255, 0)
        fadein_set(1000)
      else
        @play.call("Open " + name + " alias " + type + " type MPEGVideo",
          "\" * 255, 255, 0)
        @play.call("Setaudio " + type + " volume to " +
          (vol ** 2 / 10).to_s, "\" * 255, 255, 0)
        @play.call("Play " + type + " from " +
          start.to_s + " to " + fin.to_s, "\" * 255, 255, 0)
      end
      if @me_count > 0
        fadein_set(0)
        @play.call("Setaudio " + type + " volume to 0", "\" * 255, 255, 0)
      end
    else
      if @me_count > 0
        @play.call("Setaudio " + type + " volume to 0", "\" * 255, 255, 0)
      else
        @play.call("Setaudio " + type + " volume to " +
          (vol ** 2 / 10).to_s, "\" * 255, 255, 0)
      end
    end
    @name = name
    @type = type
    @vol = vol
    @start = start
    @loop = loop
    @fin = fin
  end
  #--------------------------------------------------------------------------
  # ● get filename extension
  #--------------------------------------------------------------------------
  def name?(name)
    if FileTest.exist?(name + ".mp3")
      return (name + ".mp3")
    elsif FileTest.exist?(name + ".ogg")
      return (name + ".ogg")
    elsif FileTest.exist?(name + ".wav")
      return (name + ".wav")
    elsif FileTest.exist?(name + ".mid")
      return (name + ".mid")
    end
    return "name"
  end
  #--------------------------------------------------------------------------
  # ● fadein time
  #--------------------------------------------------------------------------
  def fadein(time)
    fadein_set(time * 1000)
  end
  #--------------------------------------------------------------------------
  # ● fadein Set counter
  #--------------------------------------------------------------------------
  def fadein_set(time)
    @fade_max = @fade_count = time * Graphics.frame_rate / 1000
  end
  #--------------------------------------------------------------------------
  # ● Fadeout time
  #--------------------------------------------------------------------------
  def fadeout_set(time)
    if @type == "Normal"
      Audio.bgm_fade(time)
    else
      if @fade_count == 0
        @fade_max = time * Graphics.frame_rate / 1000
        @fade_count = - time * Graphics.frame_rate / 1000
      elsif @fade_count > 0
        @fade_max = (time * @fade_max * Graphics.frame_rate) /
          (1000 * (@fade_max - @fade_count))
        @fade_count = - time * Graphics.frame_rate / 1000
      else
        @fade_max = - (time * @fade_max * Graphics.frame_rate) /
          (1000 * @fade_count)
        @fade_count = - time * Graphics.frame_rate / 1000
      end
    end
  end
  #--------------------------------------------------------------------------
  # ● stop BGM
  #--------------------------------------------------------------------------
  def bgm_stop(type = "")
    if @type == "Dungeon" and type == "Battle"
      @play.call("Pause " + @type, "\" * 255, 255, 0)
    else
      if @type == "Normal"
        Audio.bgm_stop
      else
        @play.call("Stop " + @type, "\" * 255, 255, 0)
        @play.call("Close " + @type, "\" * 255, 255, 0)
      end
    end
    @type = "Normal"
  end
  
  #--------------------------------------------------------------------------
  # ● Update process
  #--------------------------------------------------------------------------
  def update
    if @type != "Normal"
      code = "\" * 255
      @play.call("Status " + @type + " position", code, 255, 0)
      if code.unpack("A*")[0].to_i >= @fin
        @play.call("Seek " + @type + " to " + @loop.to_s, "\" * 255, 255, 0)
        @play.call("Play " + @type + " to " + @fin.to_s, "\" * 255, 255, 0)
      end
      if @fade_count > 0
        @fade_count -= 1
        @play.call("Setaudio " + @type + " volume to " +
          ((@vol * (@fade_max - @fade_count) / @fade_max) ** 2 / 10).to_s,
          "\" * 255, 255, 0)
      elsif @fade_count < 0
        @fade_count += 1
        @play.call("Setaudio " + @type + " volume to " +
          ((- @vol * @fade_count / @fade_max) ** 2 / 10).to_s,
          "\" * 255, 255, 0)
      end
    end
    if @me_count > 0
      @me_count -= 1
      if @type != "Normal" and @me_count == 0
        fadein_set(1000)
      end
    end
  end
end

#==============================================================================
# ■ initialize new audio module
#==============================================================================

if $game_audio == nil
  $game_audio = Game_Audio.new
end

#==============================================================================
# ■ Graphics
#------------------------------------------------------------------------------
# When graphics are updated.. update audio.
#==============================================================================

class << Graphics
  alias :update_audio :update unless method_defined?("update_audio")
  def update
    update_audio
    $game_audio.update
  end
end
#==============================================================================
# ■ System
#------------------------------------------------------------------------------
# Update bgm_play and bgm_Stop methods to use new audio module.
#==============================================================================

class Game_System
  def bgm_play(bgm)
    bgm.play unless bgm == nil
    if bgm == nil
      bgm_stop
    end
    @playing_bgm = bgm
  end
  def bgm_stop
    @playing_bgm.stop unless @playing_bgm == nil
    @playing_bgm = nil
    Audio.bgm_stop
  end
end

Instructions
At line 35 you start "case @name", each when statement below there should contain the file name of the song you are trying to play. (Note: All song files must be in the Audio\BGM folder!)
When a song is specified "When 035-Dungeon01", then you can define 4 things: type, start, loop, fin

Type:
Type is the type of song it is. This generally doesn't matter UNLESS you are calling a "battle" during a "dungeon". When a "Battle" is called from a "Dungeon", the "Dungeon" is paused and will later be resumed when called again.

Start:
This is the location to start the song. If you want to skip the first 10 seconds, then you are more than welcome to do so.

Loop:
This will be the location in which the song resumes when FIN in reached.

Fin:
This is the "end of song" or "end of loop". When reached, this will "rewind" the song to "loop" position. If this position is exceeded because the game is inactive, it will loop when the song is complete.

If there is not a "When *" statement for the song, then it will use the default audio system and looping. Also be sure that file names specified here must contain no SPACES: 106 IGNITION = BAD, 106_IGNITION = Good
Also note that if your Windows Media Player supports the audio type, then you can update this script to use that audio type as well. Just update the "def name?" method to search for that file extension.

Note:
All time measurements are done in 1/1000 sec, so 1000 would be 1 second. Whenever the song "rewinds" it has about a .2 second rewind time.


DEMO!

This post has been edited by GubiD: Nov 23 2008, 07:06 PM

[Ratty524]

Sweet. Now I can do what all those commercial games do! :O

[stupidstormy36]

Nice! I'll try it out now.

EDIT: Hmm, it doesn't seem to work with the mp3 file I have here. It doesn't loop.

Syntax

CODE

        
                when  "106 IGNITION"
                  type = "Normal"
          start = 0
          loop = 1000
          fin = 15000

This post has been edited by stupidstormy36: Apr 27 2008, 04:39 PM

[GubiD]

Should have mentioned that if the type is "Normal" then no looping will occur. It must be "Battle" or "Dungeon" for the looping to occur.

[chiem1000]

hey i didn't saw this yesterday, but i see now :), i can use this ^^,thx Gubid ^^, just what i needed :P

[-Vilkku-]

Wow! Something I requested a year ago! Thanks Gubid!
Or like my friend would say: WOWOMGTYM8

[vikirosen]

I've actually been looking for something like this... Thanks a lot, GubiD!
I have a question though. Is it possible to trick the .2 delay when rewinding? I have yet to actually try the script (I'm downloading the demo now), but what does this .2 rewind time mean? Is it silence, or does the song exceed FIN by .2 seconds before it starts over from LOOP? If it is silence, is there maybe a way to fill it with something, anything?

[GubiD]

It is dead air, and its the seek from WMP that takes that amount of time. unless you can establish another stream to start as soon as the other hits fin, then you could fill that space. You can hear the "gap" in the demo as well. But if you have someone helping you create music, they could build something in and make it sound like it was meant to be that way.

[I_Can_Explode]

GubiD...you are so awesome.

This is a very useful script.

[GoldenShadow]

It's a very handy script you have there, I was developing one myself for ES, ran into some problems, so I don't know if you have the same:
- When main window loses focus, will music still be updated?
- When music transision occurs (from battle to map, for example), will it "clear cache" of the previous and update the new song normally?

On a sidenote, OGG files can have built-in LOOP flags compiled into them. I have yet to find any useful program to do so, but it certainly would beat having a script to check the (milli)seconds.

Anyway. I like the script, I'll be probably using it in my own project sooner than later. Great job. ^^

[GubiD]

When focus is lost the music keeps playing until focus is returned in the "standard" fashion. By this I mean that it will continue playing until the EoF is reached and then return to 0 of the song.

When a song is replaced with a new one, it acquires the others memory space and hence, clears the cache.

[Chiem100]

huh it doesnt work anymore ? (the script) and error whit ???

EDIT: Ugh nvm already fixed it

This post has been edited by Chiem100: May 1 2008, 03:24 AM

[stupidstormy36]

I should have known it wasn't gonna loop. Sorry.

Ok I tried changing it to dungeon and now it won't play at all. I'll try a different MP3 file and see if that's the case.

Hmm. Does not seem to be working with any mp3 I use. Normal is the only thing that allows it to play.

Well at least one of my all time questions have been answered. Does ogg format support looping? And yes, it does. That's why it has to be completely loaded to play instead of mp3 where it supports streaming, right?

This post has been edited by stupidstormy36: May 11 2008, 10:35 AM

[GubiD]

That is correct. If the song just doesnt play it is likely because it isnt in the BGM folder. If it is, then what are the time values you entered for start, loop and fin? perhaps you could provide me with the file if you cannot get it to work.

[stupidstormy36]

It is in the BGM folder and the values are as follows:

CODE

        when  "106 IGNITION"
          type = "Battle"
          start = 0
          loop = 1000
          fin = 15000

Here is the bgm.

MediaFire:
http://www.mediafire.com/?me00mkzy4iz

Sorry, I couldn't upload it as a direct download. File size too big.

It was only supposed to be a test.

Does file size have anything to do with it?

Also, do mp3 formats support different codecs? If so, is this the case as to why it is not working?

[GubiD]

Hmm. You found an interesting bug. Its a bug but with how the filename is given to winmm.dll. It seems that if the name has a SPACE in it, then it wont work. Just rename it to have an _ in the name or a hyphen like all the default things and it should work for you.

As for the codecs thing. If it plays in Media Player it should work in here as well. We just called a private session of audio(from WinMediaPlayer) for the game is all.

[stupidstormy36]

Hmm, makes sense somehow to me seeing how the methods, constants, and variables are written the same way. OK, I'll try to add the underscore now.

I figured with the codec thing, though.

EDIT: Hey GubiD, I just realized, not too long ago,that I found out one of my mp3 files won't work in rmxp, even in a default script setup (meaning no edits to the scripting or addons what so ever), but will play in Media Player. That file seems to be the only one that doesn't work. Maybe it has something to with licensing or the id3 tags in the mp3 file seeing how the codec may not be the case here? Not sure. I'm not trying to imply anything, but just a thought and maybe something worth bringing attention to.

I haven't been able to try the other file by putting an underscore in the file name yet. I've been away for a while and not been using my own computer, but I will let you know if it worked for me as soon as I can.

I'm not a complete idiot when it comes to scripting and the syntax language, but I can understand a majority of the syntax when I sit down and actually have time to look at it. But I do have one more question. When you called a private session from WinMediaPlayer, where exactly did you call it from, the .exe file? How do you know how to call things like this from other programs? I would like to play around with such things as it seems very interesting.

Later and thanks for your help!

EDIT: OK! I got it to work now! Thanks a whole bunch. Anybody who else is having trouble, remember NO SPACES IN THE FILE NAME!

This post has been edited by stupidstormy36: May 16 2008, 10:17 PM

[pkmnfrk]

Hi, new here. Sorry about the necro-post, but I'd like to point out a few fixes I made to the script to get it to work properly. First off, when I pasted it into RMXP, I got a bunch of syntax errors, from likes like this one:

CODE

    @play.call("Close all", "\" * 255, 255, 0)

The problem was the "\", which is not a string with a slash in it, but a string with a literal quote, that extends to the end of the line (where it errors). I searched and replaced all "\" with "\\", and then it worked.

The other problem was the "File with spaces won't play" issue. That was an easy fix, you just have to pass quotes to WinMM. Replace this line:

CODE

        @play.call("Open " + name + " alias " + type + " type MPEGVideo",

with this one:

CODE

        @play.call("Open \"" + name + "\" alias " + type + " type MPEGVideo",

Also, when it was finally working properly, I did not experience the delay in rewinding that others experienced. :shrug:

This is the full script with these problems fixed:

Full script

CODE

#==============================================================================
# Modified Audio MP3 loop v1.0 for RMXP
# Original Script by Cogwheel (http://members.jcom.home.ne.jp/cogwheel/)
# Must provide credit to GubiD and Cogwheel for this script.
#==============================================================================


#==============================================================================
# ■ RPG
#------------------------------------------------------------------------------
# Module RPG(The Game)
#==============================================================================

module RPG
#==============================================================================
# ■ BGM
#------------------------------------------------------------------------------
# BGM Audio File additional methods
#==============================================================================

  class AudioFile
    #--------------------------------------------------------------------------
    # ● Play audio file
    #--------------------------------------------------------------------------
    def play
      if @name.empty?
        Audio.bgm_stop
        @@last = BGM.new
      else
        name = "Audio/BGM/"
        start = 0
        loop = 0
        step = [0, 0]
        fin = 0
        case @name
        when "whatever song"
          type = "Dungeon"
          start = 0
          loop = 6704
          fin = 97109
        else
          type = "Normal"
        end
        if type == "Normal"
          name = @name
        else
          name = $game_audio.name?("Audio/BGM/" + @name)
        end
        $game_audio.bgm_play(name, @volume, @pitch, type, start, loop, fin)
        @@last = self
      end
    end
    #--------------------------------------------------------------------------
    # ● BGM の演奏停止
    #--------------------------------------------------------------------------
    def stop
      $game_audio.bgm_stop
    end
    #--------------------------------------------------------------------------
    # ● BGM のフェードアウト
    #--------------------------------------------------------------------------
    def fade(time)
      $game_audio.fadeout_set(time)  
    end
  end
end

class Game_Audio
  #--------------------------------------------------------------------------
  # ● Initialize method
  #--------------------------------------------------------------------------
  def initialize
    @play = Win32API.new("winmm.dll", "mciSendString", ["p","p","l","l"], "i")
    @play.call("Close all", "\\" * 255, 255, 0)
    @type = "Normal"
    @me_count = 0
    fadein_set(0)
  end
  #--------------------------------------------------------------------------
  # ● BGM の演奏
  #     name       : BGM filename
  #     vol        : volume
  #     pitch      : tone level
  #     type       : battle/dungeon/normal, dungeon pauses when battle is called
  #     start      : start position
  #     loop       : loop position
  #     fin        : finish position
  #--------------------------------------------------------------------------
  def bgm_play(name, vol, pitch, type, start, loop, fin)
    fadein_set(0)
    if type == "Normal"
      bgm_stop(type) if @name != name
      Audio.bgm_play("Audio/BGM/" + name, vol, 100) if name != ""
    elsif @name != name
      bgm_stop(type)
      status = "\\" * 255
      @play.call("Status " + type + " mode", status, 255, 0)
      if status.unpack("A*")[0] == "paused"
        @play.call("Setaudio " + type + " volume to 0", "\\" * 255, 255, 0)
        @play.call("Play " + type, "\\" * 255, 255, 0)
        fadein_set(1000)
      else
        @play.call("Open \"" + name + "\" alias " + type + " type MPEGVideo",
          "\\" * 255, 255, 0)
        @play.call("Setaudio " + type + " volume to " +
          (vol ** 2 / 10).to_s, "\\" * 255, 255, 0)
        @play.call("Play " + type + " from " +
          start.to_s + " to " + fin.to_s, "\\" * 255, 255, 0)
      end
      if @me_count > 0
        fadein_set(0)
        @play.call("Setaudio " + type + " volume to 0", "\\" * 255, 255, 0)
      end
    else
      if @me_count > 0
        @play.call("Setaudio " + type + " volume to 0", "\\" * 255, 255, 0)
      else
        @play.call("Setaudio " + type + " volume to " +
          (vol ** 2 / 10).to_s, "\\" * 255, 255, 0)
      end
    end
    @name = name
    @type = type
    @vol = vol
    @start = start
    @loop = loop
    @fin = fin
  end
  #--------------------------------------------------------------------------
  # ● get filename extension
  #--------------------------------------------------------------------------
  def name?(name)
    if FileTest.exist?(name + ".mp3")
      return (name + ".mp3")
    elsif FileTest.exist?(name + ".ogg")
      return (name + ".ogg")
    elsif FileTest.exist?(name + ".wav")
      return (name + ".wav")
    elsif FileTest.exist?(name + ".mid")
      return (name + ".mid")
    end
    return "name"
  end
  #--------------------------------------------------------------------------
  # ● fadein time
  #--------------------------------------------------------------------------
  def fadein(time)
    fadein_set(time * 1000)
  end
  #--------------------------------------------------------------------------
  # ● fadein Set counter
  #--------------------------------------------------------------------------
  def fadein_set(time)
    @fade_max = @fade_count = time * Graphics.frame_rate / 1000
  end
  #--------------------------------------------------------------------------
  # ● Fadeout time
  #--------------------------------------------------------------------------
  def fadeout_set(time)
    if @type == "Normal"
      Audio.bgm_fade(time)
    else
      if @fade_count == 0
        @fade_max = time * Graphics.frame_rate / 1000
        @fade_count = - time * Graphics.frame_rate / 1000
      elsif @fade_count > 0
        @fade_max = (time * @fade_max * Graphics.frame_rate) /
          (1000 * (@fade_max - @fade_count))
        @fade_count = - time * Graphics.frame_rate / 1000
      else
        @fade_max = - (time * @fade_max * Graphics.frame_rate) /
          (1000 * @fade_count)
        @fade_count = - time * Graphics.frame_rate / 1000
      end
    end
  end
  #--------------------------------------------------------------------------
  # ● stop BGM
  #--------------------------------------------------------------------------
  def bgm_stop(type = "")
    if @type == "Dungeon" and type == "Battle"
      @play.call("Pause " + @type, "\\" * 255, 255, 0)
    else
      if @type == "Normal"
        Audio.bgm_stop
      else
        @play.call("Stop " + @type, "\\" * 255, 255, 0)
        @play.call("Close " + @type, "\\" * 255, 255, 0)
      end
    end
    @type = "Normal"
  end
  
  #--------------------------------------------------------------------------
  # ● Update process
  #--------------------------------------------------------------------------
  def update
    if @type != "Normal"
      code = "\\" * 255
      @play.call("Status " + @type + " position", code, 255, 0)
      if code.unpack("A*")[0].to_i >= @fin
        @play.call("Seek " + @type + " to " + @loop.to_s, "\\" * 255, 255, 0)
        @play.call("Play " + @type + " to " + @fin.to_s, "\\" * 255, 255, 0)
      end
      if @fade_count > 0
        @fade_count -= 1
        @play.call("Setaudio " + @type + " volume to " +
          ((@vol * (@fade_max - @fade_count) / @fade_max) ** 2 / 10).to_s,
          "\\" * 255, 255, 0)
      elsif @fade_count < 0
        @fade_count += 1
        @play.call("Setaudio " + @type + " volume to " +
          ((- @vol * @fade_count / @fade_max) ** 2 / 10).to_s,
          "\\" * 255, 255, 0)
      end
    end
    if @me_count > 0
      @me_count -= 1
      if @type != "Normal" and @me_count == 0
        fadein_set(1000)
      end
    end
  end
end

#==============================================================================
# ■ initialize new audio module
#==============================================================================

if $game_audio == nil
  $game_audio = Game_Audio.new
end

#==============================================================================
# ■ Graphics
#------------------------------------------------------------------------------
# When graphics are updated.. update audio.
#==============================================================================

class << Graphics
  alias :update_audio :update unless method_defined?("update_audio")
  def update
    update_audio
    $game_audio.update
  end
end
#==============================================================================
# ■ System
#------------------------------------------------------------------------------
# Update bgm_play and bgm_Stop methods to use new audio module.
#==============================================================================

class Game_System
  def bgm_play(bgm)
    bgm.play unless bgm == nil
    if bgm == nil
      bgm_stop
    end
    @playing_bgm = bgm
  end
  def bgm_stop
    @playing_bgm.stop unless @playing_bgm == nil
    @playing_bgm = nil
    Audio.bgm_stop
  end
end

[GubiD]

Cool, thanks for the review and the code refinement. This was my first script actually editing and playing with DLL's outside of the application. It was an adventure to say the least. Thanks again.

[pkmnfrk]

No problem!

Also, I just realized that you're the same one who made the Tactical Battle System, which I am also using in my game. Cool! Thank you for all your efforts!