Blog du projet ZiK

Sortie de ZiK 0.17.1

vinc-mai — Wed, 14 Dec 2011 16:32:19 +0000

Un court billet pour annoncer la sortie de ZiK en version 0.17.1.
Cette version apporte uniquement des corrections de bugs.

Non, le développement de ZiK n’est pas stoppé.

vinc-mai — Tue, 19 Apr 2011 16:13:43 +0000

Le lecteur audio ZiK est sorti en version 0.17.

Les nouveautés sont :
nouveaux icônes créés par J. Kaiden,
fermeture du bug 28638 qui bloquer l’interface graphique,
application du choix de session (multi/unique) sans redémarrage de ZiK,
clôture d’un bug qui empêcher de recharger le navigateur de la session précédente,
lors de l’édition de la liste de lecture le dialogue d’information n’est affichée plus qu’une fois,
lors de l’affichage de la fenêtre ZiK utilise la position précédente,
ajout d’ascenseurs dans l’assistant.

Et pour les modules :
cacher ZiK lors d’un clic sur la croix de la fenêtre (TrayICon),
afficher/cacher ZiK (HotKeys),
clôture d’un bug qui empêcher les sessions multiple (HotKeys),
clôture d’un bug qui prévenait de rapatrier les informations depuis le web (Brainz).

Sortie de ZiK 0.16.2

vinc-mai — Sat, 12 Mar 2011 19:01:42 +0000

Je viens de sortir la version 0.16.2 qui corrige 2 bogues afin d’éviter que ZiK ne plante au démarrage.

Sortie de ZiK 0.16

vinc-mai — Fri, 11 Mar 2011 06:46:41 +0000

Les nouveautés sont :
un gem.
l’installation des greffons de GStreamer au besoin (nécessite la future version 0.90.9 de ruby-gnome2),
l’export des fichiers audio de la liste de lecture dans un répertoire.

Cette nouvelle version corrige aussi des bogues.

Adapter une bibliothèque C pour ruby (1)

vinc-mai — Fri, 01 Oct 2010 15:17:24 +0000

Introduction

J’utilise régulièrement ruby-taglib. Malheureusement, certains bugs empêchent son utilisation avec ruby 1.9. Après avoir tenté, avec plus ou moins de succès, de corriger ces bugs, j’ai décidé de réécrire cette bibliothèque. La version originale est basée sur ruby/DL, bibliothèque que je n’ai jamais utilisée. Je profite de cette réécriture pour proposer une série d’articles sur la manière d’adapter une bibliothèque C.

Préparation

Je développe pour l’instant sous ubuntu 10.04 (je terminerai sûrement ces articles sous la version 10.10). J’ai installé taglib, ruby et rdoc soit les paquets debian suivant : libtagc0, libtagc0-dev, ruby, ruby-dev, rdoc.

Hiérarchie

La commande tree présente l’arborescence de mon répertoire de travail.

$ tree
.
├── extconf.rb
├── lib
│ └── taglib2.rb
└── taglib2.c

Le fichier extconf.rb, écrit en ruby, permettra de préparer les sources en vue de compiler la bibliothèque. Le fichier lib/taglib2.rb, lui aussi écrit en ruby, est le fichier lu par l’interpréteur ruby lors de l’appel à require « taglib2″ qui chargera notre future bibliothèque.Le fichier taglib2.c, écrit en C, contiendra les méthodes qui permettent d’interfacer taglib.

Ruby

Dans un premier temps, j’utiliserai seulement le langage ruby. J’écris donc les premières lignes de code dans le fichier lib/taglib2.rb.

$ cat lib/taglib2.rb
module TagLib
VERSION=[0, 0, 1]
end

Une constante nommée VERSION est définie comme un tableau contenant 3 entiers. D’ores et déjà, je peux tester mon code grâce à irb, un interpréteur ruby en ligne de commande. La bibliothèque n’étant pas encore installée, j’utilise un chemin relatif pour y accéder.

$ irb
> require "./lib/taglib2"
=> true
> TagLib::VERSION
=> [0, 0, 1]

Interface ruby/C

Exceptions

Nous nous intéressons enfin au fichier taglib2.c. Nous définissons, tout d’abord, les différents types d’exceptions qui peuvent être levés par la bibliothèque.

$ cat taglib2.c
#include
#include

VALUE mTagLib;
VALUE eBadPath, eBadFile, eBadTag, eBadAudioProperties;

void
Init_taglib2()
{
mTagLib=rb_define_module("TagLib");
eBadPath=rb_define_class_under(mTagLib, "BadPath", rb_eException);
eBadFile=rb_define_class_under(mTagLib, "BadFile", rb_eException);
eBadTag=rb_define_class_under(mTagLib, "BadTag", rb_eException);
eBadAudioProperties=rb_define_class_under(mTagLib, "BadAudioProperties", rb_eException);
}

Les fichiers nécessaires au développement de la bibliothèque sont tout d’abord inclus puis nous déclarons des variables de type VALUE. Ce type est utilisé pour toute variable représentant un objet du langage ruby. Les noms de variables représentant des exceptions sont généralement préfixés par la lettre e. Pour les modules, la lettre m est utilisée, pour les classes, la lettre c.
Il s’agit d’une convention et non d’une règle. Finalement, on retrouve la fonction Init_taglib2 qui (re)définit le module TagLib ainsi que 4 classes descendant de la classe ruby Exception représentée en C par la variable rb_eException.

Le code suivant, écrit en ruby, est équivalent à la définition donnée en C de l’exception TagLib::BadPath

module TagLib
class BadPath < Exception
end
end

Compilation

Afin de compiler notre bibliothèque, nous devons créer un fichier Makefile. La bibliothèque mkmf nous facilite le travail.

$ cat -n extconf.rb
1 require 'mkmf'
2
3 have_header('ruby.h') || exit 1
4 have_header('taglib/tag_c.h') || exit(1)
5
6 create_makefile("taglib2")
$ ruby extconf.rb
checking for ruby.h... yes
checking for taglib/tag_c.h... yes
creating Makefile

Dans le fichier extconf.rb, la présence des fichiers « header » de ruby et de taglib sont vérifiées ligne 3 et 4. La ligne 6 permet de créer le fichier Makefile du projet taglib2. Lors du chargement d’une interface ruby/C, la fontion appelée est de la forme Init_NomDuProjet,c’est pourquoi l’unique fonction du fichier taglib2.c s’appelle Init_taglib2. Il s’agit de l’équivalent de la fonction main d’un programme C traditionnel.

Après avoir créer le fichier Makefile, compilons.

$ ruby extconf.rb
$ make

Un bibliothèque dynamique taglib2.so vient de faire son apparition. Ruby permet de charger directement ce type de bibliothèque. Nous ajoutons donc l’instruction (require « taglib2.so ») de chargement dans le fichier lib/taglib2.rb.

$ cat lib/taglib2.rb
require "taglib2.so"

module TagLib
VERSION=[0, 0, 1]
end

Test

Nous testons notre code sous irb.

$ irb
> $:.unshift('.')
> $:.unshift('lib')
> require "taglib2"
=> true
> TagLib.constants
=> ["BadFile", "BadPath", "BadAudioProperties", "VERSION", "BadTag"]
> TagLib::BadPath.new
=> #

J’ajoute tout d’abord le répertoire courant et le répertoire lib dans les chemins vérifiés lors du chargement d’un fichier afin que les appels à require « taglib2″ et à require « taglib2.so » n’échouent pas. Cette astuce ne sera plus nécessaire une fois la bibliothèque installée. On vérifie que les constantes définies dans les fichiers sources lib/taglib2.rb et taglib2.c sont accessibles.

Conclusion

Lors de ce premier billet, j’ai mis en place les différents éléments (bibliothèques, fichiers) qui seront nécessaires à l’interface ruby de taglib. Nous avons, déjà, réussi à obtenir un code fonctionnel. Il nous reste à porter les fonctions proposées par taglib afin de pourvoir accéder, en ruby, aux tags de fichiers musicaux.
À la prochaine.

Je ne suis pas un spécialiste du langage C, si vous avez des suggestions à faire sur mon code
commentez ce billet.

Addendum

Je rajoute la liste des billets faisant suite à celui-ci :

Future 0.16

vinc-mai — Sat, 11 Dec 2010 03:17:16 +0000

Quelques nouvelles de la version en développement.

En réponse à la demande #28702, il est maintenant possible d’exporter l’ensemble des chansons composant la liste de lecture grâce au menu Liste de lecture/Export songs (à traduire). La liste est écrite, au format local, dans le fichier que vous avez spécifié dans le dialogue. Afin de respecter votre classement par dossier, une option du dialogue permet de recréer l’arborescence utilisée pour les fichier d’origine.

L’ébauche d’un nouveau module fait son apparition dans le dépôt git. Il permettra d’ajouter des entrées dans certains menus afin d’appeler un programme externe. Pour l’instant, seul le menu principal (en haut de la fenêtre ZiK) est concerné. Je pense ajouter la gestion des menus contextuels au niveau de la liste de lecture et du navigateur et la capacité à appeler un programme lors de la lecture d’une nouvelle chanson.

Lien : discussion sur le forum.

Sortie de ZiK 0.15.3

vinc-mai — Mon, 08 Nov 2010 17:33:42 +0000

Cette nouvelle version corrige quelques bugs dont un qui empêche ZiK de fonctionner après une nouvelle installation.

ZiK 0.15.2

vinc-mai — Mon, 11 Oct 2010 15:18:08 +0000

Cette version corrige des bogues dans l’assistant and dans le module brainz qui peuvent provoquer la fermeture de ZiK.
L’entrée « éditer » a disparu du menu « liste de lecture » car il provoque un bogue. La liste peut toujours être éditée via le boutton ou le menu contextuel.

Sortie de ZiK 0.15

vinc-mai — Sat, 09 Oct 2010 17:03:17 +0000

La version 0.15 de ZiK est sortie.

Un assistant explique le fonctionnement de ZiK lors d’une nouvelle installation. Il permet aussi une configuration rapide du logiciel. Il est disponible via le menu aide.
L’édition de la liste de lecture et la recherche de pistes audio sont maintenant intégrées à la fenêtre principale.
La vue compact permet d’afficher un plus grand nombre de pistes audio dans la liste de lecture.
ZiK supporte maintenant ruby-taglib2 et les nouvelles versions de rghk (0.2) et de gtk (2.22).
La traduction française a été mise à jour.
Pour plus d’informations, voyer le fichier ChangeLog.

Téléchargez ZiK sur developpez.com.

Adapter une bibliothèque C pour ruby (5)

vinc-mai — Thu, 07 Oct 2010 16:26:01 +0000

Diverses fonctions

Je vais présenter ici quelques fonctions utiles. Pour des questions de faciliter, j’ai créé deux nouvelles méthodes pour le module TagLib bien qu’elles n’aient rien avoir avec taglib.

Utiliser un bloc

rb_define_singleton_method(mTagLib, "block", block, 0);

La méthode TagLib.block ne prend aucun paramètre, mais un bloc doit lui être fourni. Elle exécute ce bloc en lui passant comme argument l’objet TagLib et retourne le bloc sous la forme d’un Proc.

$ make
$ irb
> require './lib/taglib2.rb'
=> true
TagLib.block{|a| p a}
TagLib
=> #

Voici la fonction implémentant ce comportement.

VALUE
block(VALUE self)
{
rb_yield(self);
return rb_block_proc();
}

rb_yield permet d’appeler le bloc passé à la méthode alors que rb_block_proc permet de le manipuler sous la forme d’un Proc.

Utiliser des paramètres optionnels

Je propose d’écrire l’équivalent de code écrit en ruby.

def TagLib.n(tab=["Salut", "Re"])
tab.to_a
tab.each{|s| $stdout.puts s}
tab[0]
end

rb_define_singleton_method(mTagLib, "n", n, -1);

Le dernier argument lors de la déclaration de la méthode TagLib.n vaut -1 ce qui indique que la méthode ne possède pas un nombre d’arguments fixees. La fonction rb_scan_args permet de récupérer de manière propre les paramètres passés à la méthode. Le troisième argument de cette fonction est une chaîne de caractère représentant deux chiffres. Le premier indique le nombre de paramètres obligatoires, le second indique le nombre de paramètres optionnels.

VALUE
n1(VALUE str)
{
return rb_funcall(rb_stdout, rb_intern("puts"), 1, str);
}

VALUE
n(int argc, VALUE* argv, VALUE self)
{
VALUE tab;

rb_scan_args(argc, argv, "01", &tab);
if (NIL_P(tab))
tab=rb_ary_new3(2, rb_str_new2("Salut"), rb_str_new2("Re"));
rb_funcall(tab, rb_intern("to_a"), 0);

rb_iterate(rb_each, tab, n1, Qnil);
return RARRAY(tab)->ptr[0];
}

TagLib.n peut donc être appelée avec un paramètre ou sans. Si aucun argument n’a été passé (tab=nil), tab est initialisé en créant un tableau contenant deux objets String. On vérifie ensuite que tab appartient à la classe Array ou s’en rapproche (duck typing). rb_funcall permet d’appeler une méthode (deuxième argument) d’un objet (premier argument) avec un certain nombre (troisième argument) de paramètres (arguments suivant). rb_intern permet d’obtenir la méthode à partir d’une chaîne de caractères.
La fonction n1 est ensuite appelé pour chacun des éléments du tableau grâce à rb_iterate. LA méthode retourne, finalement, le premier élément de tab, la macro RARRAY permettant d’accéder à la structure interne d’un objet de la classe Array, le champ ptr permettant d’accéder aux éléments.

> TagLib.n
Salut
Re
=> "Salut"
> TagLib.n(["Bonjour"])
Bonjour
=> "Bonjour"

Liens utiles

Quelques liens qui m’ont aidé à écrire des extensions pour ruby en C :
le fichier README.EXt fourni avec ruby,
ruby-doc.
En ce qui concerne taglib :
l’exemple dans les sources de taglib,
le fichier bindings/c/tag_c.h.

Sources

Le code, présenté dans ces billets, implémentant le module, TagLib est téléchargeable ici.

Conclusion

Cette série d’articles est finie. J’espère qu’ils vous seront utiles.