= Audio
* ((<Audio ǽ>))
* ((<Ѳǽʲ/եޥå>))
* ((<SDL::Mixer::Wave>))
* ((<SDL::Mixer::Music>))
* AudioϢ᥽å
TOC

== Audio ǽ
SDLϥݡ֥٥ʥǥϵǽäƤޤ
٥ʵǽRubyľѤΤ꤬뤿ᡢ
Ruby/SDLǤϹ٥ SDL_mixer 饤֥ͳ
ϵǽΤ󶡤ޤΤᥪǥϵǽѤ뤿
ˤ SDL_mixer 饤֥򥤥󥹥ȡ뤹ɬפޤ

SDL_mixer 饤֥ϰŪʼפ뤿ᡢ
ñʣͥƱդǤ벻ߥ󥰵ǽ󶡤ޤ
16ӥåȥƥ쥪8ͥ벻Ϥȡ
MOD/MIDI/MP3ʤɤˤ벻ڱ1ͥ뤬ѲǽǤ

Τ褦˲ϤȲڱդʬƤΤϡ˼
ͳǤֲϡפֲ̲ڱաפBGMȹͤɤǤ礦
ˤ @[Mixer::Wave] 饹ڤˤ @[Mixer::Music] 饹б
Ƥޤ

MIDIեαդCPU٤򤫤뤿ᡢ̤WAVEե
ʹΤˡMIDIեդȤҤɤ
ȤȤޤ
ξϡ8-bitϤΥϡ㤤ȿƤ

MIDIեդ뤿ˤϡ
((<Timidity GUS Patches|URL:http://www.libsdl.org/projects/mixer/timidity/timidity.tar.gz>))
Ŭڤʾ(UNIXǤ /use/local/lib, WindowsǤ C:\)ŸƤ

== Ѳǽʲ/եޥå

Ruby/SDL Ǥϰʲβ/եޥåȤѲǽǤ
* WAVE/RIFF (.wav)
* AIFF (.aiff)
* VOC (.voc)
* MOD (.mod .xm .s3m .669 .it .med ʤ)
* MIDI (.mod) timidityѤ⤷MIDIϡɥ
* OggVorbis (.ogg) ogg/vorbis 饤֥꤬ɬ
* MP3 (.mp3) SMPEG 饤֥꤬ɬ

== SDL::Mixer
audioϢΥ饹ؿĥ⥸塼Ǥ

== SDL::Mixer::Wave
ʣͥˤǽʲǡɽ魯饹Ǥ
WAVE,  AIFF, RIFF, OGG, VOC бƤޤ

== SDL::Mixer::Music
ڥǡɽ魯饹Ǥ
WAVE, MOD, MIDI, OGG, MP3 бƤޤ

== AudioϢ᥽å
%%%
NAME open
MOD Mixer
TYPE .
PURPOSE AudioϢAPIν򤷤ޤ

PROTO
open(frequency=Mixer::DEFAULT_FREQUENCY,format=Mixer::DEFAULT_FORMAT,cannels=Mixer::DEFAULT_CHANNELS,chunksize=4096)

DESC
AudioϢAPIν򤷤ޤ¾AudioϢΥ᥽åɤƤˤ
ƤɬפޤޤƤ@[init](SDL::INIT_AUDIO)Ƥ
ʤƤϤʤޤ
CDƱ44.1KHzΥץ󥰥졼ȤȤȤ $[frequency] Ȥ
44100ͿƤ44100ǤϸŤԥ塼ǤCPUѥȤ
ΤǥǤϤƤ22050Ȥޤ
 Mixer::DEFAULT_FREQUENCY Ϥ 22050 ɽ路ޤ
$[chunksize] Ϥ줾Υͥ˳Ƥ(byteñ)Ǥ
٤ԥ塼 $[chunksize] 򾮤ȡڤǽ
ޤޤ$[chunksize] 礭ȡ̲ȯٱ䤷ޤ
оݤΥԥ塼˹碌Ƥ礦ɤ褤ͤꤷƤ
ñ˲ڤդʤ顢4096ʾˤƤɤǤ礦
ǥեȤǤ8(Mixer::CHANNELS)ͥ뤬ݤޤ

$[format] ϰʲΤΤѤǤޤ
:SDL::Mixer::FORMAT_U8
    Unsigned 8-bit samples
:SDL::Mixer::FORMAT_S8
    Signed 8-bit samples
:SDL::Mixer::FORMAT_U16LSB
    Unsigned 16-bit samples, in little-endian byte order
:SDL::Mixer::FORMAT_S16LSB
    Signed 16-bit samples, in little-endian byte order
:SDL::Mixer::FORMAT_U16MSB
    Unsigned 16-bit samples, in big-endian byte order
:SDL::Mixer::FORMAT_S16MSB
    Signed 16-bit samples, in big-endian byte order
:SDL::Mixer::FORMAT_U16
    same as FORMAT_U16LSB (for backwards compatability probably)
:SDL::Mixer::FORMAT_S16
    same as FORMAT_S16LSB (for backwards compatability probably)
:SDL::Mixer::FORMAT_U16SYS
    Unsigned 16-bit samples, in system byte order
:SDL::Mixer::FORMAT_S16SYS
    Signed 16-bit samples, in system byte order

SDL::DEFAULT_FORMAT  SDL::Mixer::FORMAT_S16SYS ؤޤ

$[channels]  1 ǥΥ롢2ǥƥ쥪Ϥꤷޤ
Mixer::DEFAULT_CHANNELS  2 Ǥ

NOTES
ȯٱ䤹ϤͿѥ᡼Ѥ
礬ޤ
$[frequency]  22050 ˤꡢ$[chunksize] 20481024ʤɤ
ꤷƤߤƤ$[format] ѤΤͭʾ⤢ޤ

EXAMPLE
# SDLAudioǽͭˤ롣
SDL.init(SDL::INIT_AUDIO)
# 44.1KHz, signed 16bit, system byte order, ƥ쥪ϡ
# 1024 byte 󥯥
SDL::Mixer.open(44100, SDL::Mixer::DEFAULT_FORMAT, 2, 1024)

EXCEPTION *

SEEALSO
Mixer.spec
Mixer.allocate_channels

%%
NAME spec
MOD Mixer
TYPE .
PURPOSE ǥХºݤ˻ȤäƤեޥåȤޤ
RVAL [Integer, UINT, Integer]

PROTO
spec

DESC
ǥХºݤ˻ȤäƤեޥåȤޤ
@[Mixer.open] Ϳѥ᡼Ʊ⤢ޤ㤦⤢ޤ
֤ͤ [frequency, format, channels] ȤǤܤ̣
@[Mixer.open] 򻲾ȤƤ

EXAMPLE
frequency, format, channels = SDL::Mixer.spec
format_str = case format
when SDL::Mixer::AUDIO_U8 then "U8"
when SDL::Mixer::AUDIO_S8 then "S8"
when SDL::Mixer::AUDIO_U16LSB then "U16LSB"
when SDL::Mixer::AUDIO_S16LSB then "S16LSB"
when SDL::Mixer::AUDIO_U16MSB then "U16MSB"
when SDL::Mixer::AUDIO_S16MSB then "S16MSB"
end

printf "frequency=%dHz format=%s channels=%d", frequency, format_str, channels

EXCEPTION *

SEEALSO
Mixer.open

%%
NAME driver_name
MOD Mixer
TYPE .
PURPOSE ǥХ̾ޤ
RVAL String

PROTO
driver_name
driverName

DESC
߻ȤƤ륪ǥǥХ̾ʸޤ

EXCEPTION
@[Mixer.open] ˤޤƤʤ
㳰 @[Error] ȯޤ

SEEALSO
Mixer.open

%%
NAME load
MOD Mixer::Wave
TYPE .
PURPOSE ե뤫鲻ɤ롣
RVAL Mixer::Wave

PROTO
load(filename)

DESC
$[filename] 鲻ɤޤ
WAVE, AIFF, RIFF, OGG, VOC бƤޤ

NOTES
Ƥ @[Mixer.open] ƤǤɬפޤ

OGGɤ硢ɻˤ٤ƤΥǡRAWǡȤ
ŸΤǡ̤դƤ

EXCEPTION *

%%
NAME load_from_io
MOD Mixer::Wave
TYPE .
PURPOSE IO֥Ȥ鲻ɤ롣
RVAL Mixer::Wave

PROTO
load_from_io(io)
loadFromIO(io)

DESC
$[io]鲻ɤޤ$[io]ˤRubyIO֥
(IO, StringIOʤread, tell, rewindĥ֥)ꤷޤ
WAVE, AIFF, RIFF, OGG, VOC бƤޤ

NOTES
Ƥ @[Mixer.open] ƤǤɬפޤ

OGGɤ硢ɻˤ٤ƤΥǡRAWǡȤ
ŸΤǡ̤դƤ

EXCEPTION *

%%
NAME load
MOD Mixer::Music
TYPE .
PURPOSE ե뤫鲻ڥǡɤ롣
RVAL Mixer::Music
nn
PROTO
load(filename)

DESC
$[filename] 鲻ڥǡɤޤ
WAVE, MOD, MIDI, OGG, MP3 бƤޤ

NOTES
WindowsǤϴĶˤäƤMP3ɤǤʤȤޤ

EXCEPTION *

%%
NAME load_from_string
MOD Mixer::Music
TYPE .
PURPOSE ʸ󤫤鲻ڥǡɤ롣
RVAL Mixer::Music

PROTO
load_from_string(str)
loadFromString(str)

DESC
$[str]鲻ڥǡɤޤ$[str]ˤϲڥǡΥХʥʸ
Ϳޤ
MOD, OGG бƤޤ

NOTES
Ū $[str] 򥳥ԡ̤ݻƤ뤿ᡢλ̤
դƤ

WindowsǤϤΥ᥽åɤȤʤ礬ޤ

EXCEPTION *

%%
NAME set_volume
MOD Mixer::Wave
TYPE #
PURPOSE ܥ塼ꤷޤ

PROTO
set_volume(volume)
setVolume(volume)

DESC
ܥ塼 $[volume] ꤷޤܥ塼 0  128 ޤǤ
ͤꤷޤ

%%
NAME allocate_channels
MOD Mixer
TYPE .
PURPOSE ͥꤷޤ
RVAL Integer

PROTO
allocate_channels(num_channels)
allocateChannels(num_channels)

DESC
ߥ󥰤ͥꤷޤδؿϲٸƤǤ⤫ޤޤ
˸ƤǤ⤫ޤޤ󡣤⤷ʥͥΤΤ
ʤС礭ۤΥͥϺߤ꥽
ߥ󥰤ʤʤޤ1ô֤1000ͥѹ褦
ȤϤʤۤ褤Ǥ礦

NOTES
⤷ $[num_channels]  0 ͿʤСȤǤ
٤ƤΥͥƤޤޤ

RET
ݤ֤ͥޤ

EXAMPLE
# 16ͥ
SDL::Mixer.allocate_channels(16)

%%
NAME set_volume
MOD Mixer
TYPE .
PURPOSE ꤷͥΥܥ塼ѹޤ
RVAL Integer

PROTO
set_volume(channel, volume)
setVolume(channel, volume)

DESC
$[channel] ǻꤷͥΥܥ塼 $[volume] ꤷޤ
$[channel]  -1 ꤷϤ٤ƤΥͥΥܥ塼
٤ѹޤΥܥ塼Ϻǽߥ󥰻ŬѤΤǤꡢ
@[Wave#set_volume] ǻꤷΤȤΩ˺ѤޤĤޤꤷͥ
Ǻ벻򤹤٤Ⱦʬ礭ˤϡ $[volume] Ȥ64
Ƥ٤ƤΥͥϥǥեȤǤϲ̤ 128 Ĥޤ
ͤꤵƤޤ@[Mixer.allocate_channels] ǿ˳ݤ줿
ͥβ̤ 128 ꤵޤΤ $[volume]  -1 ꤷ
٤ƤΥͥβ̤ѹ塢ʥͥݤȡ
Υͥϲѹθ̤ޤ

RET
ߤΥܥ塼֤ޤ$[channel] Ȥ -1 Ϳ
٤ƤΥͥʿѤ֤ޤ

SEEALSO
Mixer::Wave#set_volume
Mixer.set_volume_music

%%
NAME play_channel
MOD Mixer
TYPE .
PURPOSE ꤷͥDzޤ
RVAL Integer

PROTO
play_channel(channel, wave, loops)
playChannel(channel, wave, loops)

DESC
$[channel] ǻꤷͥ $[wave] ǻꤷ(@[Mixer::Wave]
Υ󥹥)ޤ $[channel]  -1 ꤷϻȤƤʤ
ͥǰּ㤤ΤȤޤ$[loops] + 1 󷫤֤դޤ
$[loops]  -1 ꤹ̵¤˷֤ޤ

RET
ɤΥͥȤäƺ֤ޤ

EXAMPLE
# ȤƤʤͥȤä sample 
# ֤Ϥʤ
SDL::Mixer.play_channel(-1, sample, 0)

SEEALSO
Mixer.play_channel_timed
Mixer.fade_in_channel
Mixer.halt
Mixer.expire

%%
NAME play_channel_timed
MOD Mixer
TYPE .
PURPOSE ꤷͥǻꤷ֤ޤ
RVAL Integer

PROTO
play_channel_timed(channel, wave, loops, ticks)
playChannelTimed(channel, wave, loops, ticks)

DESC
$[wave] ʬĹ⤷ $[loops] ʬ礭
$[ticks] ߥäޤ
¾ @[Mixer.play_channel] ƱǤ

EXAMPLE
# ȤƤʤͥȤä sample  1/2ú
SDL::Mixer.play_channel(-1, sample, -1, 500)

SEEALSO
Mixer.play_channel
Mixer.fade_in_channel_timed
Mixer.fade_out
Mixer.halt
Mixer.expire

%%
NAME fade_in_channel
MOD Mixer
TYPE .
PURPOSE ꤷͥDzեɥ󤷤ƺޤ
RVAL Integer

PROTO
fade_in_channel(channel, wave, loops, ms)
fadeInChannel(channel, wave, loops, ms)

DESC
ꤷͥDzեɥ󤷤ƺޤ
$[ms] ߥäƥեɥʳ @[Mixer.play_channel] 
ƱǤ

EXAMPLE
# ȤƤʤͥȤä
# sample 1äƥեɥ󤷤3
SDL::Mixer.fade_in_channel(-1, sample, 2, 1000)

SEEALSO
Mixer.play_channel
Mixer.fade_in_channel_timed
Mixer.fading
Mixer.fade_out
Mixer.halt
Mixer.expire

%%
NAME fade_in_channel_timed
MOD Mixer
TYPE .
PURPOSE ꤷͥDzեɥ󤷤ƻꤷ֤ޤ
RVAL Integer

PROTO
fade_in_channel_timed(channel, wave, loops, ms, ticks)
fadeInChannelTimed(channel, wave, loops, ms, ticks)

DESC
ꤷͥDzեɥ󤷤ƻꤷ֤ޤ
$[ms] ߥäƥեɥʳ @[Mixer.play_channel_timed] 
ƱǤ

SEEALSO
Mixer.play_channel_timed
Mixer.fade_in_channel
Mixer.fading
Mixer.fade_out
Mixer.halt
Mixer.expire

%%
NAME pause
MOD Mixer
TYPE .
PURPOSE ꤷͥκߤޤ

PROTO
pause(channel)

DESC
$[channel] ǻꤷͥκߤޤ
$[channel]  -1 ꤹȤ٤ƤΥͥߤޤ
ǰߤͥ @[Mixer.halt] ǴߤƤ⤫
ޤ

EXAMPLE
# ٤Ƥβߤ
SDL::Mixer.pause(-1)

SEEALSO
Mixer.resume
Mixer.pause?
Mixer.halt

%%
NAME resume
MOD Mixer
TYPE .
PURPOSE ꤷͥκƳ롣

PROTO
resume(channel)

DESC
@[Mixer.pause] ǺߤƤͥκƳޤ
$[channel] ǺƳͥꤷޤ-1 Ϳ
٤ƤΥͥǺƳޤ

SEEALSO
Mixer.pause
Mixer.pause?

%%
NAME halt
MOD Mixer
TYPE .
PURPOSE ꤷͥκߤޤ

PROTO
halt(channel)

DESC
$[channel] ǻꤷͥκߤޤ-1Ϳ
٤ƤΥͥκߤޤ

SEEALSO
Mixer.expire
Mixer.fade_out

%%
NAME expire
MOD Mixer
TYPE .
PURPOSE ꤷߥø˺ߤޤ
RVAL Integer

PROTO
expire(channel, ticks)

DESC
$[ticks] ߥøˡ$[channel] ǻꤷͥκߤޤ
$[channel]  -1 ͿȤ٤ƤΥͥߤޤ

RET
ߤͥο֤ޤ

EXAMPLE
# 2øƤΥͥκߤ
SDL::Mixer.expire(-1, 2000)

SEEALSO
Mixer.halt
Mixer.fade_out

%%
NAME fade_out
MOD Mixer
TYPE .
PURPOSE ꤷͥեɥȤޤ
RVAL Integer

PROTO
fade_out(channel, ms)
fadeOut(channel, ms)

DESC
δؿƤ $[ms] ߥä $[channel] եɥȤޤ
եɥȤλ餽ΥͥϺߤޤ
ޤ$[channel] -1ϤȤ٤ƤΥͥեɥȤޤ
Υͥ뤷ƶڤܤޤ󤬡ΤΤ
ƶޤ

RET
եɥȤͥο֤ޤ

EXAMPLE
# ٤ƤΥͥ3äǥեɥȤ
printf "starting fade out of %d channels", SDL::Mixer.fade_out(-1, 3000)

SEEALSO
Mixer.fade_in_channel
Mixer.fade_in_channel_timed
Mixer.fading

%%
NAME play?
MOD Mixer
TYPE .
PURPOSE ꤷͥ뤬Ǥ뤫ɤ롣
RVAL true/false

PROTO
play?(channel)

DESC
$[channel] ǻꤷͥ뤬Ǥʤ
true 򡢤ʤ false ֤

SEEALSO
Mixer.pause?
Mixer.fading
Mixer.play_channel
Mixer.pause

%%
NAME pause?
MOD Mixer
TYPE .
PURPOSE ꤷͥ뤬椫ɤ롣
RVAL true/false

PROTO
pause?(channel)

DESC
ꤷͥ뤬ʤ鿿򡢤ʤе֤

SEEALSO
Mixer.play?
Mixer.pause
Mixer.resume

%%
NAME fading
MOD Mixer
TYPE .
PURPOSE ꤷͥ뤬եɥ/եɥȤƤ뤫ɤ
RVAL Integer

PROTO
fading(which)

DESC
ꤷͥ뤬եɥȤƤʤ SDL::Mixer::FADING_OUT 
եɥ󤷤Ƥʤ SDL::Mixer::FADING_IN 
ɤǤʤ SDL::Mixer::NO_FADING ֤

SEEALSO
Mixer.play?
Mixer.pause?
Mixer.fade_in_channel
Mixer.fade_in_channel_timed
Mixer.fade_out

%%
NAME play_music
MOD Mixer
TYPE .
PURPOSE ڤդޤ

PROTO
play_music(music, loops)
playMusic(music, loops)

DESC
$[music] ǻꤷڤ
$[loop] ǽ餫ǸޤDZդޤ$[loops]  -1 ꤹ
ʱ˱դ򷫤֤ޤ
˱դƤƤڤϱդߤޤեɥȤκˤ
ϥեɥȤäƤ鼡Τդޤ

EXCEPTION *

SEEALSO
Mixer.fade_in_music

%%
NAME fade_in_music
MOD Mixer
TYPE .
PURPOSE ڤեɥ󤷤Ʊդޤ

PROTO
fade_in_music(music, loops, ms)
fadeInMusic(music, loops, ms)

DESC
$[music] ǻꤷڤ $[ms] ߥäƥեɥ󤷤Ʊդ򳫻Ϥޤ
$[loops] 󷫤֤դޤ-1 Ϳȱʱ˷֤ޤ
֤κǽ1ܤΤߥեɥ󤷤ޤ
λDZդƤʤߤޤեɥȤκˤ
ϥեɥȤäƤ鼡Τդޤ

EXCEPTION *

SEEALSO
Mixer.play_music

%%
NAME set_volume_music
MOD Mixer
TYPE .
PURPOSE ڱդβ̤ꤷޤ

PROTO
set_volume_music(volume)
setVolumeMusic(volume)

DESC
ڱդβ̤ $[volume] ꤷޤ0 Ǿ 128 Ǥ
եɥ/ˤΥ⥸塼ؿƤǤ̤ޤ
ʤʤեɥ/Ȥ¸뤿ˤȤäƤ뤫Ǥ

SEEALSO
Mixer.fade_in_music
Mixer.fade_out_music

%%
NAME pause_music
MOD Mixer
TYPE .
PURPOSE ڤαդߤޤ

PROTO
pause_music
pauseMusic

DESC
ڤαդߤޤǤ @[Mixer.halt_music] 
դߤ뤳ȤǤޤ

SEEALSO
Mixer.resume_music
Mixer.pause_music?
Mixer.halt_music

%%
NAME resume_music
MOD Mixer
TYPE .
PURPOSE ڤαդƳޤ

PROTO
resume_music
resumeMusic

DESC
@[Mixer.pause_music] ǰߤƤ벻ڤƳޤ

SEEALSO
Mixer.pause_music
Mixer.pause_music?

%%
NAME rewind_music
MOD Mixer
TYPE .
PURPOSE հ֤ǽ˰ưޤ

PROTO
rewind_music
rewindMusic

DESC
հ֤ǽ˰ưޤڤ桢桢桢
˸ƤǤꤢޤ

Υ⥸塼ؿ MOD, OGG, MP3, Native MIDI ξΤߤ
Ȥޤ

%%
NAME halt_music
MOD Mixer
TYPE .
PURPOSE ڤαդߤޤ

PROTO
halt_music
haltMusic

DESC
ڤαդߤޤ
եɥ/Ǥ⤹ߤޤ

SEEALSO
Mixer.fade_out_music

%%
NAME fade_out_music
MOD Mixer
TYPE .
PURPOSE ڱդեɥȤߤޤ

PROTO
fade_out_music(ms)
fadeOutMusic(ms)

DESC
ڱդ $[ms] ߥäƥեɥȤߤޤ
ξˤ̤ޤ

%%
NAME play_music?
MOD Mixer
TYPE .
PURPOSE ڤ椫ɤޤ
RVAL true/false

PROTO
play_music?
playMusic?

DESC
ڤʤ鿿򡢤ʤе֤ޤ

SEEALSO
Mixer.pause_music?
Mixer.fading_music
Mixer.play_music

%%
NAME pause_music?
MOD Mixer
TYPE .
PURPOSE ڤ椫ɤ롣
RVAL true/false

PROTO
pause_music?
pauseMusic?

DESC
ʤ true 򡢤ʤ false ֤

SEEALSO
Mixer.play_music?
Mixer.pause_music
Mixer.resume_music

%%
NAME fading_music
MOD Mixer
TYPE .
PURPOSE ڱդΥեɥ/Ȥξޤ
RVAL Integer

PROTO
fading_music
fadingMusic

DESC
ڱդեɥȤƤʤ SDL::Mixer::FADING_OUT 
եɥ󤷤Ƥʤ SDL::Mixer::FADING_IN 
ɤǤʤ SDL::Mixer::NO_FADING ֤

SEEALSO
Mixer.fading
Mixer.pause_music?
Mixer.play_music?
Mixer.fade_out_music