Tutorial 5: Irrlicht, ODE, os presento a irrKlang!

Siguiendo la línea de "Los Hola Mundos más Simples" pasamos a añadir a nuestra sencilla escena de la pelota una nueva librería para dotar a esta de sonido: irrKlang.
Librería, como podeis intuir, del mismo equipo que desarrolla Irrlich. Misma filosofía, misma simpleza, mismo potencial.

IrrKlang se distribuye como un proyecto aparte de Irrlicht, por ello tiene su propia web. También tiene diferencias en cuanto a su licencia, ya que si se desea utilizar para uso comercial hay que pagar por la versión Pro. Pero cabe destacar que la única diferencia entre la versión para uso NO comercial y la versión Pro es la posibilidad de compilar irrKlang en forma de librería estática. Como podeis observar en esta comparativa la versión no comercial mantiene las mismas interesantes características que la versión de pago.
Y al igual que irrlicht soportaba una gran cantidad de formatos de modelos 3D, irrklang tiene un buen soporte en formatos de audio (wav, ogg, mp3...). Aunque es importante recordar que MP3 tiene su propia licencia que se debería pagar aparte, es por ello que no está integrado realmente en el núcleo de la librería irrklang, sino que viene en forma de plugin ("ikpMP3.dll") por si te interesara eliminarlo de tu aplicación.
Para acabar esta introducción de la librería, comentar lo que me parece la característica más interesante: Sonido 3D. De forma graciosa el API de irrklang llama "Sonido 2D" al sonido digamos estéreo de toda la vida, y "Sonido 3D" a aquel que está posicionado en un espacio tridimensional y suena de una forma u otra dependiento de un ficticio observador (oyente en este caso ;D) de la escena. Y todo ésto es fácil de integrar en una escena irrlicht gracias al ISceneNode implementado para irrKlang que podemos encontrar en su web: irrKlangSceneNode.

Pero vayamos al grano. Un hola mundo de irrKlang se podría resumir en el siguiente par de líneas:

ISoundEngine* engine = createIrrKlangDevice();
engine->play2D("path/myFile", false);

Y ya tendríamos sonido en nuestra aplicación.
El booleano de play2D es por si queremos la reproducción en loop, así que para tener música de fondo tan sólo hay que ejecutar dicha línea con true.

En nuestro tutorial hemos dotado de sonido a la pelota cuando choca contra el suelo, y para ello hemos hecho uso de ese par de líneas, y además hemos ajustado el volumen según la fuerza del rebote para darle algo de gracia. Veamos como:

Un nuevo include:

#include <irrKlang/irrKlang.h>

Una nueva variable:

ISoundEngine* engine;

Una nueva inicialización de librería:

void irrklang_inicializacion()
{
  engine = createIrrKlangDevice();
}

Y simplemente, en el instante en el que sabemos que se produce una colisión, reproducimos el sonido. Ésto es, dentro del "ode_nearCallback".
Primeros se ha capturado la velocidad lineal del body de la esfera mediante "dBodyGetLinearVel( sphereBody )", ODE siempre devuelve los datos en forma de array, como la velocidad lineal es un vector, esta función nos proporciona un array con (x,y,z). Sólo nos interesa la velocidad vertical, con lo cual: "dBodyGetLinearVel( sphereBody )[1]".
En las siguientes líneas simplemente hemos obtenido el valor absoluto de la velocidad lineal:

dReal verticalVelocity = dBodyGetLinearVel( sphereBody )[1];
if ( verticalVelocity < 0.0 )
  verticalVelocity *= -1.0;

Y en el caso de que haya una velocidad lineal mínima en el eje Y, reproducimos el sonido del boing. Para dotar de algo más de realismo el sonido, modificamos el volumen mediante "setSoundVolume" en función de la velocidad. El volumen se ajusta de [0..1], así que simplemente, cuando la fuerza empiece a ser muy débil (<1.0) empazará a disminuir el volumen.

if( verticalVelocity > 0.1 )
{
  engine->setSoundVolume( verticalVelocity );
  engine->play2D("res/boing.mp3", false);
}

Y poco más!

A nivel de archivos, han sido añadidos al tutorial la dll "irrKlang.dll" y el pluging para mp3 "ikpMP3.dll", la librería estática "libirrKlang.a, libirrKlang.def" (tan sólo son la interfaz a la dll), y la colección de cabeceras en "include\irrKlang".

Ya sabeis, el código en el box bajo el nombre "tutorial_05.zip".