uFMOD - это компактная, шустрая, надёжная, мультиплатформенная библиотека для качественного воспроизведения аудио в формате XM, разработанная полностью на ассемблере. XM может храниться в отдельном файле или предварительно загружен в память. Поддерживаются также битые и не совсем стандартные файлы. Библиотека распространяется с открытым исходным кодом и примерами для следующих компиляторов: GCC, Tcl/Tk, PureBasic, BlitzMax, FreeBASIC, FreePascal, FASM, NASM и GAS.

• OSS, ALSA или OpenAL?
• Утилиты
  • XMStrip
  • Eff
• Компиляция библиотеки
• Примеры
• Дополнительное уменьшение размера
• ЧаВо
• Благодарности

 
OSS, ALSA или OpenAL?

uFMOD для Linux поддерживает OSS, ALSA и OpenAL. Все 3 подсистемы имеют свои плюсы и минусы. ALSA является встроенной по умолчанию аудио системой в большинстве дистрибутивов Linux на базе ядра 2.6.x. С другой стороны, OSS поддерживается в дистрибутивах на базе 2.4.x и старше (такие уже пора относить к разряду анахронизмов). Поэтому многие считают OSS устаревшей системой, а ALSA - её достойной заменой. На самом деле всё сложнее, так как существуют коммерческие драйверы OSS для узкоспециализированных приложений. Некоторые звуковые карты поддерживаются не полностью или совсем не поддерживаются в ALSA, а в OSS их вполне можно использовать. Обратное тоже верно. В настоящее время, ALSA поддерживается только в Linux, тогда как OSS доступна и на многих других Unix-подобных системах, например: FreeBSD, Solaris и т.д. ALSA и OpenAL навязывают использование динамической библиотеки (libasound.so и libopenal.so соответственно), а это затрудняет или даже делает невозможной разработку статических приложений, без лишних зависимостей. Среди плюсов ALSA можно выделить высокую производительность на современных звуковых карточках, поддержку плагинов (виртуальных звуковых устройств), полную эмуляцию драйверов OSS для поддержки приложений, использующих OSS, и т.д. OpenAL кроссплатформенна (доступны версии для Windows, Linux, Macintosh и т.д.), поддерживает аппаратное ускорение эффектов 3D-окружения, что очень полезно для разработчиков игр. Для разработки приложений с использованием OpenAL необходимо скачать и установить соответствующий пакет, если он у Вас ещё не установлен. Если вы не уверены какую версию uFMOD выбрать для своего проекта, скорее всего вам больше подойдёт стандартная версия с OSS, так как она проще в использовании: для воспроизведения звука достаточно добавить всего лишь пару строчек кода. Версия с OSS для Linux полностью совместима на уровне исходных кодов с версиями WINMM для Win32 и OSS для Unix/BSD. Это позволяет писать мультиплатформенные приложения! Для приложений, ориентирующихся исключительно под Linux на ядре 2.6.x и новее, имеет смысл использовать ALSA. OpenAL также годится для мультиплатформенных проектов, в особенности в области игр.

 
Утилиты

В комплект включена пара бесплатных утилит для использования совместно с uFMOD: XMStrip и Eff. Обе утилиты заточены под консольный терминал. Графический интерфейс (GUI) доступен средствами Tcl/Tk. effgui и xmstripgui являются графическими расширениями eff и xmstrip соответственно. Обычно, для запуска скрипта Tcl/Tk в интерпретаторе, достаточно дважды щёлкнуть по файлу скрипта в графическом окружении, если Tcl/Tk установлен и настроен в системе. В некоторых конфигурациях популярных дистрибутивов требуется ввод команды wish ./<имя_скрипта> в эмуляторе терминала или выполнение более сложных действий для запуска нужного скрипта. Режим GUI интуитивно понятен. Давайте рассмотрим консольный интерфейс.

XMStrip обрабатывает заданный XM файл с целью уменьшения размера, без потери качества звучания. В процессе обработки, XMStrip удаляет неиспользующиеся инструменты и партитуры, вырезает комментарии и перепаковывает внутренние структуры файла для уменьшения размера и повышения скорости загрузки. Для начала, откроем терминал и введём ./xmstrip чтобы получить следующее сообщение:

 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 "".

Если имя сохраняемого файла не указано, XMStrip перезапишет заданный файл. Если имя файла содержит пробелы, его необходимо заключить в кавычки ("").

Имейте в виду, что другие проигрыватели XM файлов, возможно, откажутся воспроизводить файл, обработанный XMStrip. Опция -c предусмотрена для восстановления таких файлов или обработки обычных XM файлов, которые планируется проигрывать не только в uFMOD.

Eff предназначается для опытных кодеров, желающих сэкономить каждый байт в своих приложениях. Для этого нужно выделить только те функции uFMOD, которые действительно будут использованы в целевом приложении, перекомпилировать библиотеку и получить наименьший возможный размер. Вот, что выдаёт ./eff :

 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

Последний параметр - имя XM файла, на использование которого ориентируются следующие параметры оптимизации:

• /Dm создаёт текстовый дамп данного XM файла для использования в исходнике на MASM32 или TASM. Ни тот, ни другой не используются в Linux, но синтаксис совместим с FASM и NASM. Вместе с тем, и FASM и NASM позволяют включать в исполнимый образ содержимое произвольных файлов напрямую. Поэтому, данная опция полезна только при использовании ключа /M (см. ниже).
• /Dd и /Dc создают подобные дампы, но для Pascal (Delphi, Kylix, FreePascal) или C/C++ соответственно.
• /Ds создаёт аналогичный дамп в формате RCDATA, который используется в скриптах описания ресурсов (*.rc). Не все компиляторы ресурсов поддерживают синтаксис Microsoft: id RCDATA "имя_файла". В Linux данная опция бесполезна.
• Ключ /Di отключает все информативные функции: uFMOD_GetStats, uFMOD_GetRowOrder, uFMOD_GetTitle и uFMOD_GetTime. Это даёт выигрыш не только в размере библиотеки, но и в скорости.
• /Dp отключает функции uFMOD_Pause и uFMOD_Resume и поддержку флага XM_SUSPENDED. Если Вы не собираетесь использовать pause/resume, включите этот ключ в параметры командной строки для экономии ещё нескольких байт.
• uFMOD_SetVolume увеличивает не только размер библиотеки, но ещё и загрузку CPU. Добавьте ключ /Dv, чтобы отключить эту функцию и сэкономить несколько байт и тактов ;)
• /Dj отключает функцию Jump2Pattern. Данная функция предназначена для очень специфичных задач и, поэтому, используется редко. В разделе "Дополнительное уменьшение размера" подробно описано использование Jump2Pattern.
• Вам не нужна поддержка загрузки файлов - только проигрывание из памяти? Тогда, не задумываясь, включайте /Df для дополнительного уменьшения размера.
• Ключ /Dl (маленькая L) отключает поддержку флага XM_NOLOOP (и, следовательно, благотворно влияет на размер и скорость).
• Совсем "экстремальный" вид оптимизации предусмотрен специально для ассемблерщиков. В каждом XM файле есть цепочки байт, которые зарезервированы на будущее, или просто содержат комментарии или любую другую, не имеющую отношения к проигрыванию, информацию. /M выделяет эти "дыры", предоставляя возможность заполнить их полезной информацией (разместить данные или даже код).

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

Любой из предыдущих примеров создаст ассемблерный дамп, выделит "дыры" и предварительно заполнит их нулями. Файл EFF.INC содержит список эффектов XM, которые действительно используются в заданном файле, и некоторые дополнительные флаги для отключения pause/resume, регулятора громкости, Jump2Pattern, поддержки файлов и XM_NOLOOP. Поместите этот новый EFF.INC в ufmodlib/src/ и перекомпилируйте библиотеку (в следующем разделе освещены некоторые вопросы касающиеся компиляции исходников библиотеки). Теперь у Вас имеется свой собственный оптимизированный билд uFMOD, но имейте в виду, что в этом билде включены не все эффекты XM. Поэтому, не следует использовать его для проигрывания других XM файлов, отличных от обработанного утилитой Eff!

 
Компиляция библиотеки

Необходимость компиляции исходников библиотеки uFMOD возникает при использовании утилиты Eff, а также для включения особых режимов и опций, которые отключены в сборке по умолчанию (см. таблицу Опции ниже). Для тех, кто хочет попрактиковаться в ассемблере и/или разобраться в библиотеке на самом низком уровне, и предназначен данный раздел.

Исходники uFMOD расположены в ufmodlib/src/:

• eff.inc - этот заголовочный файл создаётся утилитой Eff. Не рекомендуется редактировать данный файл вручную! Настоящие кодеры не обращают внимания на подобные предупреждения, но всё же... :)
• В core.asm находится большая часть исходного кода uFMOD. Этот самый файл присутствует во всех дистрибутивах библиотеки: Linux, Unix/BSD, Win32 и KolibriOS. Загрузка XM-файла, смешивание каналов, наложение эффектов и многие другие общие для всех дистрибутивов алгоритмы реализованы в данном файле.
• ufmod.asm содержит платформозависимые процедуры: файловый В/В, создание потоков и т.д. Поэтому, содержимое данного файла различается в дистрибутивах для разных ОСей.
• fasm.asm хранит определения констант, структур и т.д. под синтаксис Flat Assembler (FASM). Этот файл позволяет собирать различные версии библиотеки с помощью FASM.
• nasm.asm хранит определения констант, структур и т.д. под синтаксис Netwide Assembler (NASM). Этот файл позволяет собирать различные версии библиотеки с помощью NASM.
• ufmod.desc, oalufmod.desc и alsaufmod.desc содержат описания библиотек для PureBasic. PureBasic Library SDK использует эти файлы при компиляции библиотек uFMOD в формате PureLibrary.

Теперь откройте выбранный makefile или батник в текстовом редакторе. Всё, что находится между следующих строк:

*** CONFIG START

*** CONFIG END

SET UF_NASM=\nasm

SET UF_NASM=D:\TOOLS\NASM

SET UF_ARCH=ar

SET UF_ARCH=C:\Program files\BlitzMax\bin\ar.exe

При использовании Makefile, достаточно запустить GNU Make для компиляции библиотеки: make. При использовании файла с нестандартным именем, его следует указать в параметрах командной строки: make -f Makefile. Запустите makefile или батник, чтобы собрать библиотеку. Вот и всё!

 
Примеры

В каждом из каталогов представлены примеры с использованием всех трёх версий библиотеки: OSS, ALSA и OpenAL. Некоторые примеры сопровождаются откомпилированными экзешниками, чтобы показать минимальный размер, характерный для данного компилятора. Заметьте, что экзешники представлены без сжатия.

 
Дополнительное уменьшение размера

Утилита Eff предназначена для оптимизации и уменьшения размера библиотеки uFMOD.

Если Вы собираетесь включить XM статически в экзешник, можете попробовать оптимизировать сначала сам XM. Modplug Player умеет сжимать XM-композиции по схеме APDCM, но учтите, что этот тип сжатия пагубно влияет на качество звучания! Утилита XMStrip перепаковывает XM файл без потери качества.

Если Вы уверены в корректности формата всех композиций, которые будут использованы в приложении, можете пересобрать библиотеку в режиме UNSAFE.

Используйте strip и sstrip для удаления из экзешника лишних данных, вставленных компилятором/линкером. Иногда бывает возможно полностью удалить некоторые секции не нарушая целостности экзешника.

Упаковщики, вроде UPX, умеют ужимать экзешники. Тем не менее, для наглядности, все примеры предоставлены без сжатия!

Дополнительные советы по уменьшению размера исполнимого модуля можно найти в статье Браяна Рейтера (Brian Raiter): "A Whirlwind Tutorial on Creating Really Teensy ELF Executables for Linux".

Есть ещё один хитрый способ оптимизации размера XM-файлов, который заключается в совмещении сразу нескольких композиций в одном файле. При этом можно удалять лишние экземпляры повторяющихся инструментов, если таковые имеются, что очень заметно сказывается на размере конечного файла. Даже без оптимизации инструментов размер композитного файла должен получиться меньше суммы размеров отдельных файлов, так как заголовки всех файлов заменяются одним общим. Давайте рассмотрим пример с тремя файлами:

Файл 1 : XM1_HEADER P11 P12 P13     I11 I12
Файл 2 : XM2_HEADER P21 P22 P23 P24 I21 I22 I23 I24
Файл 3 : XM3_HEADER P31             I31

Для начала, совместим все 3 композиции без оптимизации инструментов:

Файл 4 : XM4_HEADER P11 P12 P13 P21 P22 P23 P24 P31 I11 I12 I21 I22 I23 I24 I31

Файл 4 : XM4_HEADER P11 P12 P13 P21 P22 P23 P24 P31 I11 I12 I21 I22 I24

В использовании Jump2Pattern есть ещё один плюс - переключение происходит гораздо быстрее (практически моментально) чем при остановке текущей композиции и последующей загрузке новой. Можете брать на вооружение эту фишку для реализации решений, требующих максимально быстрого переключения музыкального фона.

 
ЧаВо

В: Библиотека uFMOD действительно бесплатна для любого использования, включая коммерческое?
О: Да, текущая версия абсолютно бесплатна для использования в любых целях.

В: Где бы достать композиции в формате XM?
О: The Mod Archive содержит внушительных размеров архив с бесплатными трекерскими композициями в формате XM, IT, S3M и MOD. Open Modplug Tracker умеет конвертировать IT, S3M и MOD в XM без потери качества. В сети много талантливых композиторов, которые бесплатно выкладывают свои работы. Не забывайте указывать соответствующие пометки об авторстве!

В: Существует ли какая-либо связь между проектом uFMOD и разработками Firelight Technologies®: FMOD и miniFMOD?
О: На данный момент никакой связи уже нет. До 2004го года включительно проект uFMOD основывался на исходных кодах библиотеки miniFMOD. С тех пор, код uFMOD был полностью переписан, оснащён новыми функциями, оптимизирован и отлажен. Таким образом, uFMOD более не связан ни с FMOD, ни с miniFMOD.

В: Некоторые разработчики утверждают, что их библиотеки увеличивают экзешники на N-ное количество килобайт. На сколько килобайт увеличивается размер экзешника при использовании uFMOD?
О: Точного ответа на этот вопрос нет, так как этот размер зависит от многих факторов: используемые характеристики библиотеки (особенно при использовании утилиты Eff), основной код программы, размер XM-файла (если XM включается в образ экзешника). Размер также зависит от опций линкера. Пример Fasm/minimal занимает 4921 байт без сжатия.

В: Где можно раздобыть официальное описание формата XM?
О: Полного официального описания современного формата XM нет. Позвольте предложить взамен этот документ: "The Unofficial XM File Format Specification: FastTracker II, ADPCM and Stripped Module Subformats" (только на англ.). В данном документе описаны многие тонкости работы с форматом XM, включая все нестандартные расширения, которые на данный момент поддерживает uFMOD. К тому же, из исходников ModPlug (на C++) можно почерпнуть массу полезной информации по трекерским форматам файлов.

 
Благодарности

antarman, Barracuda, bogrus, chris_b, cresta, dododo, flaith, Four-F, GL#0M, norki, q_q, ReSampled, S_T_A_S_, voodooattack и yoxola за помощь в устранении ошибок, предложения по улучшению библиотеки, примеры использования под разные компиляторы и всё остальное, так или иначе помогающее нам в развитии проекта.

[WASM.RU], CelerSMS и SourceForge.net за поддержку и хостинг.

 
Автор©тво

Исходные коды uFMOD и сопровождающие утилитарные приложения © 2005 - 2022 Asterix и Quantum.
Все права защищены.

Композиции:

• «mini.xm» by ReSampled © 2006 - 2022.
• BlitzXMK.XM из примера Jump2Pat © 2007 - 2022 Kim (он же - norki).