Version 2 of TclMixer

Updated 2005-03-08 10:55:01 by Googie

Googie - TclMixer is SDL_mixer [L1 ] bindings for Tcl. It allows to play multiple sounds at the same time using built-in software mixer.

It supports following sound formats: WAV/RIFF, MP3, OGG, MID (midi), MOD (including standart MOD modules, but also S3M, IT, XM).

There are basic effects implemented, which would be very useful, such as individual sound volume level, 3D sound source positioning, stereo balance, fading in/out and sound source distance. All these goodies closed in well known, simple Tcl syntax.

To make this extension work, end-user has to got installed SDL [L2 ] (in version 1.2.x) and SDL_mixer [L3 ] (in version 1.2.x), which are quiet famous and presents on most Unix desktop machines (in future tclmixer.so could be linked statically with these libraries to takes dependencies off).

Generaly, it's low-latency alternative for Snack package. It's excellent for a game sound system, but not only.

Licence is LGPL (same as SDL).

You can download it from http://scripts.one.pl/tclmixer/

Documentation is at above link.


Some examples

Get some supported sound file. If it's some effect (gun shot, or explosion or sth) load it as short sound (which gives very low latency):

 #!/usr/bin/env wish
 load tclmixer.so
 set snd [tclmixer::sound file.<mp3|wav|ogg>]
 tclmixer::play $snd

if file is big (usually some music), then load it as long sound, to prevent loading it into memory:

 #!/usr/bin/env wish
 load tclmixer.so
 set music [tclmixer::music file.<mp3|wav|ogg|mid|mod>]
 tclmixer::play $music

There is 'wish' used, not 'tclsh', becouse we need some event loop, since SDL_mixer hasn't its own. If you want to use 'tclsh', you need to create some event loop, to let SDL_mixer play whole sound. You can use CALLBACK mechanism:

 #!/usr/bin/env tclsh
 load tclmixer.so
 set sleep 0
 proc musicFinished {} {
     global sleep
     set sleep 1
 }

 tclmixer::setCallback MUSIC musicFinished ;# this binds finishing
                                           ;# sound playback to call [musicFinished]

 set music [tclmixer::music file.<mp3|wav|ogg|mid|mod>]
 tclmixer::play $music
 while {$sleep} {after 1000}

[ Category Package | Category Multimedia ]