Message 1: sf3 - lack of documentation

Hello,

As the developer of the software Polyphone, one user asked me to work on the sf3 support. We exchanged a couple of emails and I'm now convinced of its benefits. By dividing by 10 the size of a soundfont and keeping most of its quality, it makes it easy to embed in a lot of applications (video games, mobile applications, ...). The idea is not new in that the format sf2pack (please note the "2") already exists for example, but it is now an open-source format which is promoted by a well-driven software with a pretty big community. Thus, I added the sf3 import / export.

The background being stated, I have several remarks and interrogations (most of them being technical). This message is part of a series comprising other messages.

Message 1: sf3 - lack of documentation

(GitHub issue created here )

A developer could expect to find a technical documentation regarding the Sf3 format, with more details than just "sf3 is like sf2 but using OGG samples". I indeed found that:

• the flag 0x10 has been added to the attribute sfSampleType, characterizing a sample,
• loop start and end are stored based on the beginning of the corresponding sample and not on the beginning of the smpl chunk anymore,
• moreover, we could expect that the 24-bit mode introduced in the 2.04 version of the sf2 format is not allowed.

Moreover a readme making it easy to build and use the sfTool library is missing. It could contain:

• the list of dependencies (ogg, vorbis, Qt, ...),
• the explanation of the variable "smallSf"?

A clear view of the format and what it proposes is essential for its spreading. Maybe a wiki dedicated to the sf3 should be created, with a page speaking of its specifications.