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, recursos y arreglos estáticos en memoria. Es capaz de reproducir inclusive ficheros corruptos y/o modificados. Ejemplos de uso disponibles para muchos de los siguientes compiladores: Visual C++, C#, Visual Basic, PureBasic, FreeBASIC, BlitzMax, Emergence BASIC, Delphi, Borland C++ Builder, Dev-C++ (MingW), FreePascal, MASM32, FASM, NASM y TASM.

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

 
¿WINMM, DirectSound u OpenAL?

uFMOD para Win32 soporta WINMM, DirectX® DirectSound y OpenAL. Los tres tienen pros y contras. DirectSound ofrece efectos de sonido avanzados, administra automáticamente el mezclado de multiples canales y hasta permite generar ambientación en 3D. También es considerado ser mas confiable que WINMM. En cambio, WINMM es soportado hasta en los PC mas "viejitos" con Windows 95. 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. Sin embargo, OpenAL no viene preinstalado en Windows XP y anteriores, excepto en algunos equipos OEM con tarjetas de sonido Creative de gama alta. Siendo así, es probable que Ud. tenga que descargar e instalar OpenAL, si desea usar este sistema en el desarrollo de sus aplicaciones. Dependiendo del hardware y los controladores, WINMM a veces puede sonar mejor que DirectSound y viceversa. De todas formas, las diferencias generalmente no son notorias para la mayoria de los usuarios. Si no está seguro de cual escoger, es probable que la versión clásica de uFMOD para WINMM corresponda mejor con sus necesidades. Por lo menos, es mas fácil de usar: tan sólo un par de lineas de código hacen que su aplicación comience a reproducir audio.

 
Herramientas

Hay 2 herramientas gratuitas para usar con uFMOD: XMStrip y Eff. Ambas ofrecen una interfaz dual: consola y gráfica (GUI). Cuando se ejecutan con parametros de linea de comandos, se activa el modo de consola. 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 /h obtenemos la siguiente respuesta:

 uFMOD XMSTRIP
 USAGE:  xmstrip [options] file [output]
         file   - input file name, which can
                  contain wildcards (* and ?)         
                  for batch processing.
         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 (""). XMStrip admite el uso de comodines (* y ?) para procesamiento por lotes.

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 la consola y escribiendo eff /h para obtener el siguiente resúmen:

 uFMOD XM effects extractor
 USAGE:  eff file [options]
         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
          /Dr - disable loading XM from resource
          /Dl - disable XM_NOLOOP
          /M  - mark & clear unused chunks of
                data in a masm32/tasm compatible dump

Como puede ver, el último parámetro 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. Tanto los ejemplos de MASM32 incluidos con uFMOD, como los de TASM, utilizan este tipo de volcados en vez de recursos para ahorrar unos cuantos bytes.
• /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". El volcado RCDATA se debe usar para compatibilidad con versiones viejas del compilador de recursos GNU, como el que viene con Dev-C++.
• 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 y/o recursos? - ¡Los gurú de la optimización prefieren usar volcados en vez de recursos! Entonces, querrá aprovechar las opciones /Df y /Dr 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 MASM32/TASM. 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'. El ejemplo Masm32\winmm\ utiliza esta opción.

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

Cualquiera de estas sentencias produce un volcado para MASM32/TASM 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 recursos 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 la subcarpeta ufmodlib\src\:

• eff.inc es un fichero de cabecera. La herramienta Eff genera este fichero. No se recomienda modificarlo directamente.
• equs.inc contiene la mayor parte de las definiciones de estructuras y constantes de uso interno.
• core.asm contiene la mayor parte del código fuente de uFMOD. Exactamente el mismo fichero aparece en los paquetes de Win32, Linux, Unix/BSD 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: lectura de ficheros y recursos, manejo de hilos, etc. El contenido de este fichero varía en Win32, Linux, Unix/BSD 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.
• masm.asm define las estructuras de datos, constantes y demás, usando la sintaxis de MASM32/TASM. Este fichero permite compilar uFMOD con MASM32 o TASM.
• 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 dsufmod.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.
• ufmod.def, oalufmod.def y dsufmod.def son ficheros de definición de librería para compilar uFMOD en modo DLL.

ufmodlib\import\ contiene el código fuente usado para compilar todas las librerías de importación que se usan conjuntamente con uFMOD. Algunas de estas se usan para generar las librerías uFMOD para Visual Basic 6 y FreePascal. Dichas librerías de importación se encuentran precompiladas en la subcarpeta ufmodlib\lib\. Las librerías de importación para DirectSound y OpenAL para diferentes compiladores también se encuentran aquí. Todas estas librerías se pueden recompilar con el ImpLib SDK. ufmodlib\import\buildall.bat es un fichero de procesamiento por lotes. Sirve para recompilar todas las librerías anteriormente mencionadas.

Hay una herramienta adicional en ufmodlib\bin\. Esta se utiliza para hacer un código objeto en formato OMF compatible con Delphi. No es tan sofisticada como OMF2D de EliCZ, pero tiene la capacidad necesaria para lograr una versión de la librería uFMOD para Delphi. Cuando se compila uFMOD en formato OMF con NASM, o4delphi entra en acción.

Una vez terminada la modificación del código fuente, lo que hace falta es compilarlo. Seleccione uno de los ficheros de procesamiento por lotes (BAT) en ufmodlib\, según el compilador para el cual se desea generar la librería. La siguiente tabla le ayudará a escoger el fichero apropiado:

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

rem *** CONFIG START

rem *** CONFIG END

SET UF_MASM=C:\masm32

SET UF_MASM=D:\TOOLS\MASM32

SET UF_ARCH=ar

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

Ejecute el BAT para generar las librerías para todas las plataformas de audio soportadas: WINMM, OpenAL y DirectX DIrectSound. ¡Eso es todo!

 
Ejemplos

Ejemplos de uso para cada compilador se encuentran en carpetas separadas. Cada carpeta contiene tanto la versión para WINMM, como para DirectX. La mayoría también incluye ejemplos para 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 o anexarla como recurso binario, 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 el comando no documentado /opt:nowin98 en la línea de comandos del linker de VC++ o MASM32 para reducir al mínimo la alineación de secciones. Las secciones .rdata (datos de sólo lectura, donde se encuentran la IAT y otras constantes) y .text (generalmente contiene código ejecutable) se pueden combinar en una. Adicione el siguiente comando en las opciones de MS LINK.EXE o POLINK.EXE: /MERGE:.rdata=.text

Hay otro asunto interesante relacionado con el linker de MS. link.exe introduce cierta información innecesaria entre el DOS stub y el inicio de la cabecera PE. Resulta sencillo localizar estos datos en un editor hexa, porque empiezan con la palabra 'Rich'. A continuación de esta palabra se encuentra el compid codificado de su PC. Si no desea que sus aplicaciones resulten firmadas de esta manera o simplemente prefiere no gastar unos cuantos bytes extra (en realidad, ¡medio Kb!) en la firma, existen 2 formas de evitarlo. En primer lugar, puede cambiar de linker. Como alternativa, puede buscar el la red un artículo sobre cómo modificar link.exe. Por cierto, el artículo en ruso se puede encontrar en wasm.ru.

Delphi acostumbra incluir una sección extra con fixups (.reloc) en cada ejecutable. Las DLL requieren de fixups, pero los ejecutables no. Entonces, intente eliminar la sección .reloc para ahorrar en el tamaño del ejecutable. Las herramientas StripReloc de Jordan Russel, PE Optimizer de Dr. Golova o cualquier otra aplicación similar sirven para este propósito, en caso de que no sepa cómo eliminar los fixups manualmente.

Visual Basic y Delphi suelen crear una sección de recursos (.rsrc) aún cuando su contenido no represente utilidad alguna. Entonces, por lo general, resulta seguro eliminar la sección completa .rsrc, siempre y cuando no contenga plantillas, pistas XM o cualquier otro recurso que su aplicación en verdad necesite. La misma observación tiene validez para la sección .flat en un ejecutable generado con PureBasic. ¡Tenga mucho cuidado al realizar esta clase de operaciones con el ejecutable!

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

Al usar librerías de importación en formato MS-COFF (como kernel32.lib, libkernel32.a, etc.) se desperdicia algo de espacio en el ejecutable para almacenar las tablas de thunks originales. Estas tablas sólo se usan al hacer binding. Si Ud. no tiene pensado hacer binding con su ejecutable, puede prescindir de estas tablas y ahorrar hasta 512 bytes o hasta un par de kilobytes, si está usando muchas funciones externas (funciones que se encuentran en DLLs). Para ello debe reemplazar las librerías de importación que vienen con el SDK de su compilador (Visual Studio, masm32, etc.) por versiones modificadas. Dichas versiones modificadas se pueden construir con el ImpLib SDK.

Eso era prácticamente todo lo que se debe saber sobre la optimización del tamaño de un ejecutable. 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 MASM32\minimal.exe ocupa únicamente 5.632 bytes sin compresión, sin alterar la estructura del ejecutable, ni otros trucos "sucios" para reducir el tamaño.

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_, ts-soft, 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).