uFMOD es una librería para reproducir música en formato XM, desarrollada completamente en lenguaje ensamblador. Es perfecta para aplicaciones de tamaño y tiempo crítico, libre de defectos audibles, altamente confiable, fácil de usar, de código fuente abierto y multiplataforma. Permite reproducir ficheros y arreglos estáticos en memoria. Es capaz de reproducir inclusive ficheros corruptos y/o modificados. Ejemplos de uso disponibles para los siguientes compiladores: GCC, Tcl/Tk, PureBasic, BlitzMax, FreeBASIC, FreePascal, FASM, NASM y GAS.

• ¿OSS, ALSA u OpenAL?
• Herramientas
  • XMStrip
  • Eff
• Compilando la librería
• Ejemplos
• Cómo lograr un ejecutable más compacto
• Preguntas frecuentes
• Agradecimientos

 
¿OSS, ALSA u OpenAL?

uFMOD para Linux soporta OSS, ALSA y OpenAL. Los tres tienen pros y contras. ALSA es la plataforma de audio predefinida en la mayoría de los distributivos de Linux basados en el nucleo 2.6.x. En cambio, OSS es el manejador de audio por defecto en 2.4.x y en versiones anteriores (las que se pueden considerar practicamente obsoletas hoy en día). Por lo tanto, muchos catalogan OSS como una plataforma obsoleta y consideran que ALSA es su reemplazo. Eso no es exactamente cierto, ya que existen sistemas de gama alta basados en componentes OSS comerciales. Existen tarjetas de sonido no soportadas por ALSA, pero compatibles con OSS. Lo contrario también es cierto. ALSA actualmente sólo está disponible en Linux, mientras que OSS se puede encontrar en muchos otros sistemas operativos derivados de Unix: FreeBSD, Solaris, etc. ALSA y OpenAL imponen el uso de librerías compartidas (libasound.so y libopenal.so respectivamente), lo cual dificulta o más bien imposibilita el desarrollo de aplicaciones estáticas, sin dependencias. Lo bueno en ALSA es su desempeño superior sobre dispositivos de audio actuales, soporte para plugins (tarjetas de sonido virtuales), emulación completa de OSS para soportar aplicaciones que lo utilicen, etc. OpenAL es multiplataforma (disponible en Windows, Linux, Macintosh, etc.), soporta efectos de ambientación acelerados en hardware, lo cual es muy útil en el desarrollo de juegos. Si no tiene preinstalado OpenAL y desea usarlo en el desarrollo de sus aplicaciones, tendrá que descargar e instalarlo. Si no está seguro de cual escoger, es probable que la versión clásica de uFMOD para OSS corresponda mejor con sus necesidades. Por lo menos, es más fácil de usar: tan sólo un par de lineas de código hacen que la aplicación comience a reproducir audio. La versión para OSS en Linux es completamente compatible a nivel de código fuente con las versiones WINMM en Windows y OSS en Unix/BSD. ¡Eso permite desarrollar aplicaciones multiplataforma! Si planea desarrollar una aplicación exclusivamente para Linux orientada hacia distributivos basados en 2.6.x o posteriores, es más recomendable usar ALSA. OpenAL también es recomendable en proyectos multiplataforma, especialmente en el desarrollo de juegos.

 
Herramientas

Hay 2 herramientas gratuitas para usar con uFMOD: XMStrip y Eff. Ambas son aplicaciones de consola, pero también se pueden ejecutar a través de una interfaz gráfica (GUI), desarrollada en Tcl/Tk: effgui y xmstripgui respectivamente. En la mayoría de los entornos Linux basta con hacer doble clic sobre el script ejecutable para iniciar el intérprete de Tcl/Tk y comenzar a ejecutar el script seleccionado, asumiendo que Tcl/Tk ha sido correctamente instalado. A veces, es necesario ingresar el comando wish ./<nombre> en un emulador de terminal o efectuar una secuencia de pasos mas compleja para poder ejecutar dichos scripts. El modo GUI es bastante intuitivo. Vamos a exponer el modo de consola.

XMStrip recibe un fichero XM como entrada, modifica su contenido para minimizar el tamaño, sin que esto afecte la calidad del sonido. Concretamente, XMStrip elimina los datos no utilizados (instrumentos y patrones redundantes, comentarios, etc.) y agrupa los patrones de notas para optimizar el tiempo de lectura y procesamiento del XM. Al ingresar ./xmstrip obtenemos la siguiente respuesta:

 USAGE:  xmstrip [options] file [output]
         file   - input file name.
         output - optional output file name.          
 options:
  -c - clean only (don't strip)
 When [output] is not specified, XMSTRIP
 attempts to overwrite the input. If file
 name contains spaces, enclose it in "".

Si no especifica el nombre del fichero de salida, XMStrip intentará sobreescribir el fichero de entrada. Si el nombre del fichero contiene espacios, enciérrelo entre comillas dobles ("").

Tenga presente, que otros reproductores de XM, probablemente, rechacen los ficheros producidos por XMStrip. Especifique -c para 'recuperar' un fichero así o símplemente para procesar un fichero normal que desea poder usar en otros reproductores de XM.

Eff es útil para los usuarios avanzados, que desean ahorrar hasta el último byte en sus aplicaciones. La idea es extraer sólo aquellas opciones que realmente se van a usar en la aplicación, recompilar la librería uFMOD y obtener el menor tamaño posible. Comencemos abriendo una sesión de terminal y escribiendo ./eff para obtener el siguiente resúmen:

 USAGE:  eff [options] file
         file - input file name
         options:
          /Dm - generate a masm32/tasm dump
          /Dd - generate a Pascal (Delphi) dump
          /Dc - generate a C/C++ dump
          /Ds - generate an RCDATA resource dump
          /Di - disable infoAPI:
                    uFMOD_GetStats, uFMOD_GetRowOrder,
                    uFMOD_GetTitle and uFMOD_GetTime
          /Dp - disable uFMOD_Pause, uFMOD_Resume
                    and XM_SUSPENDED
          /Dv - disable volume control
          /Dj - disable Jump2Pattern
          /Df - disable loading XM from file
          /Dl - disable XM_NOLOOP
          /M  - mark & clear unused chunks of
                data in a masm32/tasm compatible dump

Como puede ver, el último parametro es el nombre del fichero XM que se va a usar con la aplicación. Opciones adicionales:

• /Dm genera un volcado hexadecimal a partir del fichero XM dado, para ser usado en MASM32 o TASM. Ninguno de los dos tiene utilidad en Linux, pero la sintaxis es compatible con FASM y NASM. Sin embargo, tanto FASM como NASM permiten incluir el contenido de un fichero binario directamente. Por lo tanto, la única utilidad de esta opción en Linux tiene que ver con /M (ver mas adelante).
• /Dd y /Dc generan volcados para Pascal (Delphi, Kylix, FreePascal) y C/C++ respectivamente.
• /Ds produce un volcado en formato RCDATA, usado en scripts de recursos. Algunos compiladores de recursos no soportan la sintaxis habitual de Microsoft: id RCDATA "nombre_de_fichero". No tiene mayor utilidad en Linux.
• Especifique /Di para deshabilitar todas las funciones informativas: uFMOD_GetStats, uFMOD_GetRowOrder, uFMOD_GetTitle y uFMOD_GetTime. Eliminarlas reduce el tamaño de la librería y mejora un poco el rendimiento.
• /Dp elimina las funciones uFMOD_Pause y uFMOD_Resume y hace que uFMOD ignore la bandera XM_SUSPENDED. Si no necesita pausar/reanudar, agregue esta opción a la linea de comandos para ahorrar otros tantos bytes.
• uFMOD_SetVolume no sólo hace la librería más grande, sino que también consume tiempo adicional de CPU. Utilice /Dv para deshabilitar esta función y recuperar algunos bytes y tics ;)
• /Dj deshabilita la función Jump2Pattern. Esta es una función avanzada, no usada en la mayoria de las aplicaciones. Consulte la sección "Cómo lograr un ejecutable más compacto" para mayor información sobre el uso de Jump2Pattern.
• ¿No va a reproducir ficheros - sólo arreglos estáticos? Entonces, querrá aprovechar la opción /Df para minimizar el tamaño de la librería.
• /Dl (L minúscula) hace que la librería ignore la bandera XM_NOLOOP (esto también reduce el tamaño y mejora la eficiencia).
• Por último, hay una opción de optimización realmente extrema, disponible sólo para los programadores en lenguaje ensamblador. En cada fichero XM hay secuencias de bytes que se encuentran reservadas para versiones futuras del formato XM o contienen metadatos (comentarios, publicidad, etc.) /M delimita y resalta estos 'huecos' en el volcado y los habilita para ser usados con mayor utilidad. Por ejemplo, puede almacenar datos y hasta código ejecutable en dichos 'huecos'.

eff /Dmpvjfl /M ejemplo.xm
eff /M /Dm /Dp /Dv /Dj /Df /Dl ejemplo.xm
eff -M -Dmpvjfl ejemplo.xm

Cualquiera de estas sentencias produce un volcado en lenguaje ensamblador con todos los 'huecos' delimitados y rellenos con ceros por defecto. El fichero de cabecera EFF.INC recopila los efectos XM que realmente se utilizan en el fichero XM dado, más algunas banderas adicionales para deshabilitar las funciones de pausar/reanudar, control de volumen, Jump2Pattern, soporte para ficheros y XM_NOLOOP. Copie EFF.INC en ufmodlib/src/ y recompile la librería. Consulte la siguiente sección para mayor información sobre cómo recompilar uFMOD. Acaba de compilar su propia versión ultraoptimizada de uFMOD, pero recuerde que ésta contiene un subconjunto de efectos XM. Entonces, ¡sólo servirá para reproducir correctamente el fichero XM especificado como parámetro!

 
Compilando la librería

Es necesario volver a compilar la librería luego de usar Eff y para habilitar ciertas funciones especiales (ver tabla Opciones mas adelante). Algunas personas querrán modificar el código fuente de la librería, para poner a prueba sus conocimientos en lenguaje ensamblador o por cualquier otra razón. Bueno, la siguiente información les podrá servir.

El código fuente completo se encuentra en el subdirectorio ufmodlib/src/:

• eff.inc es un fichero de cabecera. La herramienta Eff genera este fichero. No se recomienda modificarlo directamente, aunque un programador en lenguaje ensamblador rara vez presta atención a esta clase de recomendaciones :)
• core.asm contiene la mayor parte del código fuente de uFMOD. Exactamente el mismo fichero aparece en los paquetes de Linux, Unix/BSD, Win32 y KolibriOS. Cargar un fichero XM, mezclar los canales de audio, procesar los efectos XM y otras tareas comunes se encuentran implementadas en este fichero.
• ufmod.asm contiene todo el código dependiente del sistema operativo: E/S de ficheros, manejo de hilos, etc. El contenido de este fichero varía en Linux, Unix/BSD, Win32 y KolibriOS.
• fasm.asm define las estructuras de datos, constantes y demás, usando la sintaxis de Flat Assembler (FASM). Este fichero permite compilar uFMOD con FASM.
• nasm.asm define las estructuras de datos, constantes y demás, usando la sintaxis de Netwide Assembler (NASM). Este fichero permite compilar uFMOD con NASM.
• ufmod.desc, oalufmod.desc y alsaufmod.desc son ficheros de descripción de librería para PureBasic. El PureBasic Library SDK requiere de estos ficheros para poder generar las librerías uFMOD en formato PureLibrary.

Abra el makefile o el fichero de procesamiento por lotes en un editor de texto plano. Todo lo contenido entre las siguientes líneas:

*** CONFIG START

*** CONFIG END

SET UF_NASM=\nasm

SET UF_NASM=D:\TOOLS\NASM

SET UF_ARCH=ar

SET UF_ARCH=C:\Archivos de programa\BlitzMax\bin\ar.exe

Si utiliza el fichero Makefile, sólo debe ejecutar GNU Make para compilar la librería: make. Si utiliza un makefile con distinto nombre, debe especificarlo en la línea de comandos: make -f MakeBMod. Ejecute el makefile o el fichero de procesamiento por lotes para generar las librerías para todas las plataformas de audio soportadas: OSS, ALSA y OpenAL. ¡Eso es todo!

 
Ejemplos

Ejemplos de uso para cada compilador se encuentran en directorios separados. Cada directorio contiene ejemplos para OSS, ALSA y OpenAL. Algunos de los ejemplos mas representativos vienen acompañados de ejecutables precompilados para mostrar el menor tamaño de ejecutable conseguido hasta el momento. Nótese que los ejecutables no estan comprimidos, ni empaquetados.

 
Cómo lograr un ejecutable más compacto

Utilice Eff para optimizar la librería uFMOD y hacerla mas pequeña.

Si desea embeber la pista XM directamente en el ejecutable, puede intentar primero optimizar el fichero XM. Modplug Player permite comprimir un fichero XM usando ADPCM, ¡pero es un tipo de compresión con pérdidas! Utilice XMStrip para optimización sin pérdidas (en términos de calidad del sonido.)

Si tiene plena certeza de que todos los XM que va a reproducir la aplicación son válidos (ninguno puede estar corrupto o modificado), recompile la librería en modo UNSAFE.

Utilice strip y sstrip para remover datos innecesarios en la estructura del ejecutable, introducidos por el compilador/linker. A veces, secciones completas pueden ser suprimidas sin afectar la integridad del ejecutable.

Empaquetadores, como UPX, logran reducir el tamaño del ejecutable. Sin embargo, para mayor objetividad, los ejecutables de ejemplo ¡no estan comprimidos!

Hay mas pautas de optimización en el siguiente artículo de Brian Raiter: "A Whirlwind Tutorial on Creating Really Teensy ELF Executables for Linux".

Ahora veamos otra técnica interesante para minimizar el tamaño de los ficheros XM:

Es posible unir varias pistas XM en un solo fichero compuesto. Ya que es posible compartir los instrumentos entre las pistas en el fichero compuesto, el tamaño resultante de este fichero puede ser mucho menor que la suma de los tamaños de los ficheros por separado. Aún sin compartir los instrumentos el tamaño debe ser menor, puesto que sólo se usa un único ejemplar de cabecera XM. Veamos un ejemplo con 3 ficheros XM:

Fichero 1 : CABECERA_XM1 P11 P12 P13     I11 I12
Fichero 2 : CABECERA_XM2 P21 P22 P23 P24 I21 I22 I23 I24
Fichero 3 : CABECERA_XM3 P31             I31

Primero, vamos a unir los 3 ficheros en uno solo sin compartir los instrumentos:

Fichero 4 : CABECERA_XM4 P11 P12 P13 P21 P22 P23 P24 P31 I11 I12 I21 I22 I23 I24 I31

Fichero 4 : CABECERA_XM4 P11 P12 P13 P21 P22 P23 P24 P31 I11 I12 I21 I22 I24

El uso de Jump2Pattern tiene otra ventaja: la conmutación de pistas se realiza mucho más rápido (casi de inmediato) que el proceso habitual de parar la pista actual y cargar una pista nueva. Por lo tanto, puede usar esta técnica cuando necesite conmutar las pistas de audio de la manera más rápida posible.

 
Preguntas frecuentes

P: ¿Es uFMOD gratis para cualquier tipo de uso, incluido el comercial?
R: Si, actualmente así es.

P: ¿En donde puedo conseguir música en formato XM?
R: En The Mod Archive hay un enorme archivo de música gratis en formatos XM, IT, S3M y MOD. Puede usar el Open Modplug Tracker para convertir ficheros IT, S3M y MOD a formato XM sin perder la calidad. Hay muchos compositores talentosos en la red dispuestos a compartir su música de manera gratuita. ¡Pero no olvide el copyright!

P: ¿Existe alguna relación entre el proyecto uFMOD y las librerías FMOD y/o miniFMOD de Firelight Technologies®?
R: Ya no. Hasta el año 2004 uFMOD se basó en el código fuente abierto de la librería miniFMOD. Desde ese entonces, el código fuente de uFMOD fue completamente reescrito, optimizado y depurado. También fueron agregadas muchas funciones nuevas. Por lo tanto, la versión actual de uFMOD no tiene relación alguna con FMOD o miniFMOD.

P: Algunas librerías aseguran incrementar el tamaño del ejecutable en N kilobytes. ¿En cuanto se incrementa el tamaño de un ejecutable con uFMOD?
R: No es posible establecer un valor exacto, ya que el tamaño depende de muchos factores, a saber: funciones usadas (en especial, si se utiliza la herramienta EFF), código de la aplicación principal, tamaño del fichero XM (cuando el XM es embebido en el ejecutable). También depende de las opciones del linker. El ejemplo Fasm/minimal ocupa únicamente 4.921 bytes sin compresión.

P: ¿En dónde puedo conseguir la especificación oficial del formato XM?
R: No existe especificación oficial actualizada. En cambio, puede estudiar el documento "The Unofficial XM File Format Specification: FastTracker II, ADPCM and Stripped Module Subformats" (sólo en inglés). Este documento describe la mayoría de los aspectos relevantes del formato XM original, al igual que todas las extensiones extraoficiales actualmente soportadas por uFMOD. Los códigos fuente de ModPlug (en C++) sirven de referencia sobre formatos derivados del MOD, XM, IT, S3M y muchos otros.

 
Agradecemos a

antarman, Barracuda, bogrus, chris_b, cresta, dododo, flaith, Four-F, GL#0M, norki, q_q, ReSampled, S_T_A_S_, voodooattack y yoxola por reportar errores, sugerir nuevas ideas, aportar ejemplos de uso y de otras formas ayudarnos a mejorar uFMOD.

[WASM.RU], CelerSMS y SourceForge.net por el soporte y hosting.

 
Copyright

Los códigos fuente y ficheros binarios de uFMOD © 2005 - 2022 Asterix y Quantum.
Todos los derechos reservados.

Pistas de ejemplo:

• «mini.xm» by ReSampled © 2006 - 2022.
• BlitzXMK.XM del ejemplo Jump2Pat © 2007 - 2022 Kim (también conocido como norki).