Compilation de mkbitmap vers WebAssembly

Thomas Steiner

Dans Qu'est-ce que WebAssembly et d'où vient-il ?, Je vous ai expliqué comment nous en sommes arrivés au WebAssembly d'aujourd'hui. Dans cet article, je vais vous montrer comment compiler un programme C existant, mkbitmap, en WebAssembly. Il est plus complexe que l'exemple Hello World, car il implique de travailler avec des fichiers, de communiquer entre les environnements WebAssembly et JavaScript, et de dessiner sur un canevas. Il reste toutefois suffisamment gérable pour ne pas vous submerger.

Cet article s'adresse aux développeurs Web qui souhaitent découvrir WebAssembly. Il explique étape par étape comment compiler un élément tel que mkbitmap en WebAssembly. Sachez qu'il est tout à fait normal qu'une application ou une bibliothèque ne compile pas lors de la première exécution. C'est pourquoi certaines des étapes décrites ci-dessous n'ont pas fonctionné. J'ai donc dû revenir en arrière et essayer une autre méthode. L'article ne présente pas la commande de compilation finale magique comme si elle était tombée du ciel, mais décrit plutôt ma progression réelle, y compris certaines frustrations.

À propos de mkbitmap

Le programme C mkbitmap lit une image et lui applique une ou plusieurs des opérations suivantes, dans l'ordre suivant: inversion, filtrage passe-haut, mise à l'échelle et seuil. Chaque opération peut être contrôlée individuellement et activée ou désactivée. L'utilisation principale de mkbitmap consiste à convertir des images en couleur ou en niveaux de gris en un format adapté à l'entrée d'autres programmes, en particulier le programme de traçage potrace qui constitue la base de SVGcode. En tant qu'outil de prétraitement, mkbitmap est particulièrement utile pour convertir des dessins scannés, tels que des dessins animés ou du texte manuscrit, en images biniveau haute résolution.

Pour utiliser mkbitmap, vous devez lui transmettre un certain nombre d'options et un ou plusieurs noms de fichiers. Pour en savoir plus, consultez la page de manuel de l'outil:

$ mkbitmap [options] [filename...]

Obtenir le code

La première étape consiste à obtenir le code source de mkbitmap. Vous le trouverez sur le site Web du projet. Au moment de la rédaction de cet article, potrace-1.16.tar.gz est la dernière version.

Compiler et installer en local

L'étape suivante consiste à compiler et à installer l'outil localement pour vous faire une idée de son comportement. Le fichier INSTALL contient les instructions suivantes:

1. cd au répertoire contenant le code source du package, puis saisissez ./configure pour configurer le package pour votre système.

   L'exécution de configure peut prendre un certain temps. Pendant l'exécution, il affiche des messages indiquant les fonctionnalités qu'il vérifie.

2. Saisissez make pour compiler le package.

3. Vous pouvez également saisir make check pour exécuter tous les autotests fournis avec le package, généralement à l'aide des binaires non installés que vous venez de compiler.

4. Saisissez make install pour installer les programmes, ainsi que les fichiers de données et la documentation. Lors de l'installation dans un préfixe appartenant à root, il est recommandé de configurer et de compiler le package en tant qu'utilisateur standard, et de n'exécuter que la phase make install avec des privilèges root.

En suivant ces étapes, vous devriez obtenir deux exécutables, potrace et mkbitmap, ce dernier étant l'objet de cet article. Vous pouvez vérifier que l'opération a bien fonctionné en exécutant mkbitmap --version. Voici la sortie des quatre étapes de mon ordinateur, fortement abrégée pour plus de concision:

Étape 1, ./configure:

 $ ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... ./install-sh -c -d
checking for gawk... no
checking for mawk... no
checking for nawk... no
checking for awk... awk
checking whether make sets $(MAKE)... yes
[…]
config.status: executing libtool commands

Étape 2, make:

$ make
/Applications/Xcode.app/Contents/Developer/usr/bin/make  all-recursive
Making all in src
clang -DHAVE_CONFIG_H -I. -I..     -g -O2 -MT main.o -MD -MP -MF .deps/main.Tpo -c -o main.o main.c
mv -f .deps/main.Tpo .deps/main.Po
[…]
make[2]: Nothing to be done for `all-am'.

Étape 3, make check:

$ make check
Making check in src
make[1]: Nothing to be done for `check'.
Making check in doc
make[1]: Nothing to be done for `check'.
[…]
============================================================================
Testsuite summary for potrace 1.16
============================================================================
# TOTAL: 8
# PASS:  8
# SKIP:  0
# XFAIL: 0
# FAIL:  0
# XPASS: 0
# ERROR: 0
============================================================================
make[1]: Nothing to be done for `check-am'.

Étape 4, sudo make install:

$ sudo make install
Password:
Making install in src
 .././install-sh -c -d '/usr/local/bin'
  /bin/sh ../libtool   --mode=install /usr/bin/install -c potrace mkbitmap '/usr/local/bin'
[…]
make[2]: Nothing to be done for `install-data-am'.

Pour vérifier si cela a fonctionné, exécutez mkbitmap --version:

$ mkbitmap --version
mkbitmap 1.16. Copyright (C) 2001-2019 Peter Selinger.

Si vous obtenez les détails de la version, cela signifie que vous avez bien compilé et installé mkbitmap. Ensuite, faites en sorte que l'équivalent de ces étapes fonctionne avec WebAssembly.

Compiler mkbitmap en WebAssembly

Emscripten est un outil permettant de compiler des programmes C/C++ en WebAssembly. La documentation Building Projects (Créer des projets) d'Emscripten indique ce qui suit:

Créer de grands projets avec Emscripten est très facile. Emscripten fournit deux scripts simples qui configurent vos fichiers make pour utiliser emcc comme remplacement de gcc. Dans la plupart des cas, le reste du système de compilation actuel de votre projet reste inchangé.

La documentation continue ensuite (un peu modifiée pour plus de concision):

Imaginons que vous effectuiez normalement la compilation avec les commandes suivantes:

./configure
make

Pour compiler avec Emscripten, vous devez utiliser les commandes suivantes:

emconfigure ./configure
emmake make

Ainsi, ./configure devient emconfigure ./configure et make devient emmake make. L'exemple suivant montre comment procéder avec mkbitmap.

Étape 0, make clean:

$ make clean
Making clean in src
 rm -f potrace mkbitmap
test -z "" || rm -f
rm -rf .libs _libs
[…]
rm -f *.lo

Étape 1, emconfigure ./configure:

$ emconfigure ./configure
configure: ./configure
checking for a BSD-compatible install... /usr/bin/install -c
checking whether build environment is sane... yes
checking for a thread-safe mkdir -p... ./install-sh -c -d
checking for gawk... no
checking for mawk... no
checking for nawk... no
checking for awk... awk
[…]
config.status: executing libtool commands

Étape 2, emmake make:

$ emmake make
make: make
/Applications/Xcode.app/Contents/Developer/usr/bin/make  all-recursive
Making all in src
/opt/homebrew/Cellar/emscripten/3.1.36/libexec/emcc -DHAVE_CONFIG_H -I. -I..     -g -O2 -MT main.o -MD -MP -MF .deps/main.Tpo -c -o main.o main.c
mv -f .deps/main.Tpo .deps/main.Po
[…]
make[2]: Nothing to be done for `all'.

Si tout s'est bien passé, des fichiers .wasm doivent maintenant se trouver dans le répertoire. Vous pouvez les trouver en exécutant find . -name "*.wasm":

$ find . -name "*.wasm"
./a.wasm
./src/mkbitmap.wasm
./src/potrace.wasm

Les deux derniers semblent prometteurs. cd dans le répertoire src/. Deux nouveaux fichiers correspondants, mkbitmap et potrace, sont également disponibles. Pour cet article, seul mkbitmap est pertinent. Le fait qu'ils ne comportent pas l'extension .js est un peu déroutant, mais il s'agit en fait de fichiers JavaScript, que vous pouvez vérifier à l'aide d'un appel head rapide:

$ cd src/
$ head -n 20 mkbitmap
// include: shell.js
// The Module object: Our interface to the outside world. We import
// and export values on it. There are various ways Module can be used:
// 1. Not defined. We create it here
// 2. A function parameter, function(Module) { ..generated code.. }
// 3. pre-run appended it, var Module = {}; ..generated code..
// 4. External script tag defines var Module.
// We need to check if Module already exists (e.g. case 3 above).
// Substitution will be replaced with actual code on later stage of the build,
// this way Closure Compiler will not mangle it (e.g. case 4. above).
// Note that if you want to run closure, and also to use Module
// after the generated code, you will need to define   var Module = {};
// before the code. Then that object will be used in the code, and you
// can continue to use Module afterwards as well.
var Module = typeof Module != 'undefined' ? Module : {};

// --pre-jses are emitted after the Module integration code, so that they can
// refer to Module (if they choose; they can also define Module)

Renommez le fichier JavaScript en mkbitmap.js en appelant mv mkbitmap mkbitmap.js (et mv potrace potrace.js respectivement si vous le souhaitez). Il est maintenant temps de procéder au premier test pour voir si cela a fonctionné en exécutant le fichier avec Node.js sur la ligne de commande en exécutant node mkbitmap.js --version:

$ node mkbitmap.js --version
mkbitmap 1.16. Copyright (C) 2001-2019 Peter Selinger.

Vous avez bien compilé mkbitmap en WebAssembly. L'étape suivante consiste à le faire fonctionner dans le navigateur.

mkbitmap avec WebAssembly dans le navigateur

Copiez les fichiers mkbitmap.js et mkbitmap.wasm dans un nouveau répertoire appelé mkbitmap, puis créez un fichier de modèle HTML index.html qui charge le fichier JavaScript mkbitmap.js.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>mkbitmap</title>
  </head>
  <body>
    <script src="mkbitmap.js"></script>
  </body>
</html>

Démarrez un serveur local qui diffuse le répertoire mkbitmap, puis ouvrez-le dans votre navigateur. Une invite vous demandant de saisir des informations s'affiche. C'est normal, car, selon la page de manuel de l'outil, [si]aucun argument de nom de fichier n'est fourni, mkbitmap agit en tant que filtre, en lisant à partir de l'entrée standard, qui est par défaut un prompt() pour Emscripten.

Empêcher l'exécution automatique

Pour empêcher l'exécution immédiate de mkbitmap et l'obliger à attendre l'entrée utilisateur, vous devez comprendre l'objet Module d'Emscripten. Module est un objet JavaScript global avec des attributs que le code généré par Emscripten appelle à différents moments de son exécution. Vous pouvez fournir une implémentation de Module pour contrôler l'exécution du code. Lorsqu'une application Emscripten démarre, elle examine les valeurs de l'objet Module et les applique.

Dans le cas de mkbitmap, définissez Module.noInitialRun sur true pour empêcher l'exécution initiale à l'origine de l'invite. Créez un script nommé script.js, incluez-le avant le <script src="mkbitmap.js"></script> dans index.html et ajoutez le code suivant à script.js. Lorsque vous actualisez l'application, l'invite ne devrait plus s'afficher.

var Module = {
  // Don't run main() at page load
  noInitialRun: true,
};

Créer un build modulaire avec d'autres options de compilation

Pour fournir une entrée à l'application, vous pouvez utiliser la prise en charge du système de fichiers d'Emscripten dans Module.FS. La section Including File System Support (Inclure la prise en charge du système de fichiers) de la documentation indique:

Emscripten décide d'inclure automatiquement la prise en charge du système de fichiers. De nombreux programmes n'ont pas besoin de fichiers, et la prise en charge du système de fichiers n'est pas négligeable. Emscripten évite donc de l'inclure lorsqu'il n'en voit pas la nécessité. Cela signifie que si votre code C/C++ n'accède pas aux fichiers, l'objet FS et les autres API de système de fichiers ne seront pas inclus dans la sortie. À l'inverse, si votre code C/C++ utilise des fichiers, la prise en charge du système de fichiers est automatiquement incluse.

Malheureusement, mkbitmap est l'un des cas où Emscripten n'inclut pas automatiquement la prise en charge du système de fichiers. Vous devez donc lui demander explicitement de le faire. Cela signifie que vous devez suivre les étapes emconfigure et emmake décrites précédemment, avec quelques autres indicateurs définis via un argument CFLAGS. Les indicateurs suivants peuvent également être utiles pour d'autres projets.

• Définissez -sFILESYSTEM=1 pour que la compatibilité avec le système de fichiers soit incluse.
• Définissez -sEXPORTED_RUNTIME_METHODS=FS,callMain pour que Module.FS et Module.callMain soient exportés.
• Définissez -sMODULARIZE=1 et -sEXPORT_ES6 pour générer un module ES6 moderne.
• Définissez -sINVOKE_RUN=0 pour empêcher l'exécution initiale à l'origine de l'invite.

Dans ce cas particulier, vous devez également définir l'option --host sur wasm32 pour indiquer au script configure que vous le compilez pour WebAssembly.

La commande emconfigure finale se présente comme suit:

$ emconfigure ./configure --host=wasm32 CFLAGS='-sFILESYSTEM=1 -sEXPORTED_RUNTIME_METHODS=FS,callMain -sMODULARIZE=1 -sEXPORT_ES6 -sINVOKE_RUN=0'

N'oubliez pas d'exécuter à nouveau emmake make et de copier les fichiers nouvellement créés dans le dossier mkbitmap.

Modifiez index.html pour qu'il ne charge que le module ES script.js, à partir duquel vous importez le module mkbitmap.js.

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8" />
    <title>mkbitmap</title>
  </head>
  <body>
    <!-- No longer load `mkbitmap.js` here -->
    <script src="script.js" type="module"></script>
  </body>
</html>

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  const Module = await loadWASM();
  console.log(Module);
};

run();

Lorsque vous ouvrez l'application dans le navigateur, l'objet Module doit être enregistré dans la console DevTools. L'invite a disparu, car la fonction main() de mkbitmap n'est plus appelée au début.

Exécuter manuellement la fonction principale

L'étape suivante consiste à appeler manuellement la fonction main() de mkbitmap en exécutant Module.callMain(). La fonction callMain() utilise un tableau d'arguments, qui correspondent un par un à ce que vous transmettez sur la ligne de commande. Si vous exécutez mkbitmap -v sur la ligne de commande, vous appelez Module.callMain(['-v']) dans le navigateur. Le numéro de version mkbitmap est alors consigné dans la console DevTools.

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  const Module = await loadWASM();
  Module.callMain(['-v']);
};

run();

Rediriger la sortie standard

La sortie standard (stdout) est par défaut la console. Toutefois, vous pouvez le rediriger vers un autre élément, par exemple une fonction qui stocke la sortie dans une variable. Vous pouvez donc ajouter la sortie au code HTML en définissant la propriété Module.print.

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  let consoleOutput = 'Powered by ';
  const Module = await loadWASM({
    print: (text) => (consoleOutput += text),
  });
  Module.callMain(['-v']);
  document.body.textContent = consoleOutput;
};

run();

Obtenir le fichier d'entrée dans le système de fichiers en mémoire

Pour placer le fichier d'entrée dans le système de fichiers de mémoire, vous avez besoin de l'équivalent de mkbitmap filename sur la ligne de commande. Pour comprendre comment j'aborde cette question, je vais d'abord vous expliquer comment mkbitmap attend son entrée et crée sa sortie.

Les formats d'entrée compatibles avec mkbitmap sont PNM (PBM, PGM, PPM) et BMP. Les formats de sortie sont PBM pour les bitmaps et PGM pour les cartes de gris. Si un argument filename est fourni, mkbitmap crée par défaut un fichier de sortie dont le nom est obtenu à partir du nom du fichier d'entrée en remplaçant son suffixe par .pbm. Par exemple, pour le nom de fichier d'entrée example.bmp, le nom de fichier de sortie est example.pbm.

Emscripten fournit un système de fichiers virtuel qui simule le système de fichiers local, de sorte que le code natif utilisant des API de fichiers synchrones puisse être compilé et exécuté avec peu ou pas de modifications. Pour que mkbitmap lise un fichier d'entrée comme s'il était transmis en tant qu'argument de ligne de commande filename, vous devez utiliser l'objet FS fourni par Emscripten.

L'objet FS est basé sur un système de fichiers en mémoire (généralement appelé MEMFS) et dispose d'une fonction writeFile() que vous pouvez utiliser pour écrire des fichiers dans le système de fichiers virtuel. Vous utilisez writeFile() comme indiqué dans l'exemple de code suivant.

Pour vérifier que l'opération d'écriture de fichier a fonctionné, exécutez la fonction readdir() de l'objet FS avec le paramètre '/'. Vous verrez example.bmp et un certain nombre de fichiers par défaut qui sont toujours créés automatiquement.

Notez que l'appel précédent de Module.callMain(['-v']) pour imprimer le numéro de version a été supprimé. En effet, Module.callMain() est une fonction qui ne doit généralement s'exécuter qu'une seule fois.

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  const Module = await loadWASM();
  const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
  Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
  console.log(Module.FS.readdir('/'));
};

run();

Première exécution réelle

Une fois tout en place, exécutez mkbitmap en exécutant Module.callMain(['example.bmp']). Enregistrez le contenu du dossier '/' du MEMFS. Vous devriez voir le fichier de sortie example.pbm nouvellement créé à côté du fichier d'entrée example.bmp.

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  const Module = await loadWASM();
  const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
  Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
  Module.callMain(['example.bmp']);
  console.log(Module.FS.readdir('/'));
};

run();

Extraire le fichier de sortie du système de fichiers de mémoire

La fonction readFile() de l'objet FS permet d'obtenir le example.pbm créé à l'étape précédente à partir du système de fichiers en mémoire. La fonction renvoie un Uint8Array que vous convertissez en objet File et enregistrez sur disque, car les navigateurs n'acceptent généralement pas les fichiers PBM pour la visualisation directe dans le navigateur. (Il existe des méthodes plus élégantes pour enregistrer un fichier, mais l'utilisation d'un <a download> créé dynamiquement est la plus largement acceptée.) Une fois le fichier enregistré, vous pouvez l'ouvrir dans votre visionneuse d'images préférée.

// This is `script.js`.
import loadWASM from './mkbitmap.js';

const run = async () => {
  const Module = await loadWASM();
  const buffer = await fetch('https://example.com/example.bmp').then((res) => res.arrayBuffer());
  Module.FS.writeFile('example.bmp', new Uint8Array(buffer));
  Module.callMain(['example.bmp']);
  const output = Module.FS.readFile('example.pbm', { encoding: 'binary' });
  const file = new File([output], 'example.pbm', {
    type: 'image/x-portable-bitmap',
  });
  const a = document.createElement('a');
  a.href = URL.createObjectURL(file);
  a.download = file.name;
  a.click();
};

run();

Ajouter une UI interactive

À ce stade, le fichier d'entrée est codé en dur et mkbitmap s'exécute avec les paramètres par défaut. La dernière étape consiste à permettre à l'utilisateur de sélectionner dynamiquement un fichier d'entrée, d'ajuster les paramètres mkbitmap, puis d'exécuter l'outil avec les options sélectionnées.

// Corresponds to `mkbitmap -o output.pbm input.bmp -s 8 -3 -f 4 -t 0.45`.
Module.callMain(['-o', 'output.pbm', 'input.bmp', '-s', '8', '-3', '-f', '4', '-t', '0.45']);

Le format d'image PBM n'est pas particulièrement difficile à analyser. Avec un code JavaScript, vous pouvez même afficher un aperçu de l'image de sortie. Pour savoir comment procéder, consultez le code source de la démonstration intégrée ci-dessous.

Conclusion

Félicitations, vous avez réussi à compiler mkbitmap en WebAssembly et à le faire fonctionner dans le navigateur. Vous avez rencontré des impasses et vous avez dû compiler l'outil plusieurs fois jusqu'à ce qu'il fonctionne, mais comme je l'ai indiqué ci-dessus, cela fait partie de l'expérience. N'oubliez pas non plus la balise webassembly de StackOverflow si vous rencontrez des difficultés. Bonne compilation !

Remerciements

Cet article a été relu par Sam Clegg et Rachel Andrew.