Use GTK+ and GStreamer to build a simple guitar tuner application for GNOME. Shows off how to use the interface designer.
Projet de Documentation GNOME
gnome-doc-list@gnome.org
Johannes Schmid
jhs@gnome.org
Tiffany Antopolski
tiffany.antopolski@gmail.com
Marta Maria Casetti
mmcasetti@gmail.com 2013
Luc Rebert,
traduc@rebert.name 2011
Alain Lojewski,
allomervan@gmail.com 2011-2012
Luc Pionchon
pionchon.luc@gmail.com 2011
Bruno Brouard
annoa.b@gmail.com 2011-12
Luis Menina
liberforce@freeside.fr 2014

# Guitar tuner

      Dans ce tutoriel, nous allons écrire un programme qui émet des sons servant à accorder une guitare. Nous allons apprendre comment :

        paramétrer un projet de base en utilisant Anjuta IDE,
        créer une interface graphique simple avec le concepteur d'interface utilisateur d'Anjuta,
        utiliser la bibliothèque GStreamer pour jouer des sons.

      Vous avez besoin de ce qui suit pour pouvoir suivre ce tutoriel :

        les connaissances de base du langage de programmation Vala.
        une copie installée de Anjuta.

# Création d'un projet dans Anjuta

Avant de commencer à programmer, vous devez ouvrir un nouveau projet dans Anjuta. Ceci crée tous les fichiers qui vous sont nécessaires pour construire et exécuter votre programme plus tard. C'est aussi utile pour tout regrouper en un seul endroit.

Lancez Anjuta et cliquez sur Créer un nouveau projet ou FichierNouveauProjet pour ouvrir l'assistant de création de projet.

Click on the Vala tab and select GTK+ (Simple). Click Continue, and fill out your details on the next few pages. Use guitar-tuner as project name and directory.

Assurez-vous que Configuration des paquets externes est basculée sur I. Sur la page suivante, choisissez gstreamer-0.10 dans la liste pour inclure la bibliothèque GStreamer à votre projet. Cliquez sur Continuer.

Cliquez sur Appliquer et votre projet est créé. Ouvrez src/guitar_tuner.vala en faisant un double clic depuis l'onglet Projet ou l'onglet Fichiers. Vous devez voir apparaître du code commençant par les lignes :

using GLib; using Gtk;

# Première construction du programme

Ce programme charge une fenêtre (vide) à partir du fichier de description de l'interface et l'affiche. Vous trouverez plus de détails ci-dessous ; passez cette liste si vous comprenez les bases :

Les deux lignes `using` importent des espaces de noms que nous n'aurons plus à nommer explicitement.

Le constructeur de la classe `Main` crée une nouvelle fenêtre en ouvrant un fichier GtkBuilder (src/guitar-tuner.ui, défini quelques lignes plus haut), en connectant son signal puis en l'affichant dans une fenêtre. Ce fichier GtkBuilder contient la description d'une interface utilisateur et tous ses éléments. On peut utiliser l'éditeur d'Anjuta pour concevoir des interfaces utilisateur GtkBuilder.

Connecter des signaux, c'est décider de ce qui doit se passer quand on appuie sur un bouton ou quand quelque chose d'autre se produit. Ici, la fonction `on_destroy` est appelée (et quitte l'application) quand la fenêtre est fermée.

La fonction statique `main` est exécutée par défaut quand vous lancez une application Vala. Elle appelle d'autres fonctions qui créent la classe Main, configurent puis exécutent l'application. La fonction `Gtk.Main` démarre la boucle principale de GTK, qui lance l'interface utilisateur et commence à écouter les événements (comme des clics de souris ou des appuis sur des touches).

Le programme est prêt à être utilisé, donc vous pouvez le compiler en cliquant sur ConstruireConstruire le projet ou en appuyant sur MajF7. Ceci fait apparaître une boîte de dialogue. Pour configurer le répertoire de compilation, modifiez la Configuration à Par défaut et cliquez sur Exécuter. Il ne faut le faire qu'une seule fois, à la première compilation.

# Création de l'interface utilisateur

Une description de l'interface utilisateur est contenue dans le fichier GtkBuilder src/guitar_tuner.ui défini au début de la classe. Pour la modifier, ouvrez le fichier src/guitar_tuner.ui en faisant un double clic depuis les onglets Projet ou Fichiers. Ceci vous renvoie vers le concepteur d'interface. La fenêtre de conception se trouve au centre ; les éléments graphiques et leurs propriétés sont sur la droite et la palette des éléments graphiques disponibles est sur la gauche.

La disposition de toute interface utilisateur dans GTK+ est organisée à l'aide de boîtes et de tableaux. Dans cet exemple, prenons une GtkButtonBox verticale pour y mettre six GtkButtons, un pour chacune des six cordes de la guitare.

Dans l'onglet Palette de la section Conteneurs, choisissez une Boîte (GtkButtonBox) en cliquant sur l'icône. Cliquez ensuite sur la fenêtre de conception au centre pour la placer dans la fenêtre. Une boîte de dialogue apparaît dans laquelle vous pouvez définir le nombre d'éléments à 6. Cliquez ensuite sur Créer.

Vous pouvez aussi modifier le Nombre d'éléments et l'Orientation dans l'onglet Général sur la droite.

Maintenant, à partir de la section Contrôle et affichage de la section Palette, sélectionnez un Bouton (GtkButton) en cliquant dessus et disposez-le dans la première case du GtkButtonBox en cliquant sur celle-ci.

Pendant que le bouton est encore sélectionné, déplacez-vous dans l'onglet Général à droite de la propriété Étiquette et modifiez-la en E. C'est la corde E en bas de la guitare.

L'onglet Général est situé dans la section Composants graphiques sur la droite.

Passez à l'onglet Signaux dans la section Composants graphiques et recherchez le signal `clicked` du bouton. Vous pouvez l'utiliser pour connecter un gestionnaire de signal qui sera appelé quand le bouton est cliqué. Pour cela, cliquez sur le signal et saisissez `main_on_button_clicked` dans la colonne Gestionnaire et appuyez sur Entrée.

Répétez cette procédure pour les autres boutons, ce qui ajoute les 5 autres cordes nommées A, D, G, B et e.

Enregistrez le fichier de conception de l'interface utilisateur (en cliquant sur FichierEnregistrer) et laissez-le ouvert.

# Les pipelines GStreamer

Cette section va vous montrer comment créer un programme qui produit des sons. GStreamer est l'architecture multimédia de GNOME — vous pouvez vous en servir pour des jeux, des enregistrements, pour traiter des flux vidéo, audio, de webcam entre autres. Ici, nous allons nous en servir pour émettre des tonalités à une seule fréquence.

Le concept de GStreamer est le suivant : il y a création d'un pipeline contenant plusieurs éléments de traitement en provenance d'une source à destination d'un collecteur (sortie). La source peut être un fichier image, une vidéo ou un fichier musical, par exemple, et la sortie un élément graphique ou une carte son.

Entre la source et le collecteur, vous pouvez appliquer différents filtres et convertisseurs pour prendre en charge les effets, les conversions de format et ainsi de suite. Chaque élément du pipeline possède des propriétés pouvant être utilisées pour modifier son comportement.

Un exemple de pipeline GStreamer.

# Configuration du pipeline

Dans cet exemple, nous utilisons une source génératrice de son de fréquence pure appelée `audiotestsrc` et envoyons sa sortie au périphérique son par défaut du système, `autoaudiosink`. Il nous faut seulement configurer la fréquence du générateur accessible depuis la propriété `freq` de `audiotestsrc`.

Il faut ajouter une ligne pour initialiser GStreamer ; écrivez le code suivant dans la ligne au-dessus de l'appel à `Gtk.init` dans la fonction `main` :

Gst.init (ref args);

Ensuite, copiez la fonction suivante dans le fichier guitar_tuner.vala à l'intérieur de notre classe `Main` :

Gst.Element sink; Gst.Element source; Gst.Pipeline pipeline;

private void play_sound(double frequency) { pipeline = new Gst.Pipeline ("note"); source = Gst.ElementFactory.make ("audiotestsrc", "source"); sink = Gst.ElementFactory.make ("autoaudiosink", "output");

/* set frequency */ source.set ("freq", frequency);

pipeline.add (source); pipeline.add (sink); source.link (sink);

pipeline.set_state (Gst.State.PLAYING);

/* stop it after 200ms */ var time = new TimeoutSource(200);

time.set_callback(() => { pipeline.set_state (Gst.State.NULL); return false; }); time.attach(null); }

Les trois premières lignes créent les éléments GStreamer source et sink (collecteur) (`Gst.Element`) et un élément pipeline element (qui sera utilisé comme conteneur pour les deux autres). Ce sont des variables de classe et sont donc définies en dehors de la méthode. Le pipeline est nommé « note » ; la source est nommée « source » et le collecteur est nommé « output » et est défini comme étant le connecteur `autoaudiosink` (qui est la sortie par défaut de la carte son).

L'appel à `source.set` définit la propriété `freq` de l'élément source à `frequency` qui est transmis comme argument de la fonction `play_sound`. Il s'agit simplement de la fréquence de la note de musique en Hertz ; certaines fréquences utiles seront définies plus tard.

`pipeline.add` place la source et le collecteur dans le pipeline. Le pipeline est un `Gst.Bin`, c.-à-d. juste un élément qui peut contenir beaucoup d'autres éléments GStreamer. En général, vous pouvez ajouter autant d'éléments que vous voulez au pipeline en faisant autant d'appels supplémentaires à `pipeline.add`.

Ensuite, `sink.link` sert à lier les éléments ensemble, de sorte que la sortie de la source (une note) va à l'entrée du collecteur (et est ensuite envoyée à la carte son). `pipeline.set_state` sert enfin à démarrer la lecture en basculant l'état du pipeline à « playing » (lecture) (`Gst.State.PLAYING`).

Comme nous ne voulons pas jouer indéfiniment une note ennuyeuse, la dernière chose que fait `play_sound` est d'ajouter un `TimeoutSource` qui définit un délai avant la coupure du son ; cela attend 200 millisecondes avant d'appeler un gestionnaire de signal défini ici même, qui stoppe et détruit le pipeline. Il renvoie `false` pour se supprimer lui-même du délai d'attente, sinon il serait constamment appelé toutes les 200 ms.

# Création du gestionnaire de signal

Dans le concepteur d'interface utilisateur, il a été fait en sorte que tous les boutons appellent la même fonction, on_button_clicked quand ils sont cliqués. En réalité, nous saisissons main_on_button_clicked qui indique au concepteur d'interface utilisateur que cette méthode fait partie de notre fonction `Main`. Nous devons ajouter cette fonction dans notre fichier source.

Pour cela, dans le fichier interface utilisateur (guitar_tuner.ui), sélectionnez un des boutons en cliquant dessus, puis ouvrez guitar_tuner.vala (en cliquant sur l'onglet au milieu). Allez sur la droite, dans l'onglet Signaux que vous aviez déjà utilisé pour nommer le signal. Prenez maintenant la ligne où vous aviez défini le signal clicked et faites-la glisser dans le fichier source au début de la classe. Le code suivant s'ajoute à votre fichier source :

public void on_button_clicked (Gtk.Button sender) {

}

Vous pouvez aussi saisir seulement le code au début de la classe au lieu d'utiliser le glisser-déposer.

Le récepteur du signal n'a qu'un seul argument : le `Gtk.Widget` qui a appelé la fonction (dans notre cas, toujours un `Gtk.Button`).

# Définition du gestionnaire de signal

Nous voulons jouer la note adéquate quand l'utilisateur clique sur un bouton. Pour cela, nous allons étoffer le gestionnaire de signal défini auparavant. Nous aurions pu connecter chaque bouton à un gestionnaire différent, mais cela aurait dupliqué beaucoup de code. Au lieu de ça, nous allons plutôt utiliser l'étiquette du bouton pour déterminer le bouton cliqué :

public void on_button_clicked (Gtk.Button sender) { var label = sender.get_child () as Gtk.Label; switch (label.get_label()) { case "E": play_sound (329.63); break; case "A": play_sound (440); break; case "D": play_sound (587.33); break; case "G": play_sound (783.99); break; case "B": play_sound (987.77); break; case "e": play_sound (1318); break; default: break; } }

Le bouton `Gtk.Button` qui a été cliqué est transmis comme argument (`sender`) à `on_button_clicked`. Nous pouvons obtenir l'étiquette de ce bouton en utilisant `get_child` puis, le texte de cette étiquette en utilisant `get_label`.

L'instruction « switch » compare le texte de l'étiquette à la note que nous pouvons jouer et `play_sound` est appelé avec la fréquence appropriée à cette note. Cela fonctionne ; nous obtenons un accordeur de guitare opérationnel !

# Construction et lancement de l'application

À ce stade, tout le programme est fonctionnel. Cliquez sur ConstruireConstruire le projet pour tout reconstruire et faites ExécuterExécuter pour lancer l'application.

Si ce n'est déjà fait, choisissez l'application Debug/src/guitar-tuner dans la boîte de dialogue qui s'affiche. Enfin, cliquez sur Exécuter et amusez-vous !

# Implémentation de référence

Si vous rencontrez des difficultés avec ce tutoriel, comparez votre programme à ce programme de référence.

# Documentation complémentaire

Pour en savoir plus à propos de la programmation en langage Vala, consultez le manuel Vala et la Documentation de Vala API.

# Les étapes suivantes

Voici quelques idées sur la manière d'étendre ce simple exemple :

Faire que le programme joue automatiquement les notes de manière cyclique.

Faire que le programme lise des enregistrements de vraies cordes de guitare pincées.

Pour y parvenir, vous devrez configurer un pipeline GStreamer un peu plus sophistiqué qui vous permette de charger et lire des fichiers musicaux. Vous devrez choisir des éléments GStreamer décodeur et démuxeur basés sur le format des sons enregistrés — par exemple, les MP3 utilisent des éléments différents de ceux des fichiers Ogg Vorbis.

Il vous faudra aussi peut-être connecter les éléments de façon plus complexe. Vous aurez sans doute besoin de consulter les concepts GStreamer que nous ne couvrons pas dans ce tutoriel, comme les pads. La commande gst-inspect peut également vous être utile.

Analyser automatiquement les notes jouées par l'utilisateur.

Vous pourriez branchez un microphone et enregistrez les sons obtenus en utilisant l'entrée source. Peut-être qu'une espèce d'analyseur de spectre peut vous aider à trouver les notes jouées ?