1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337
|
<html>
<title>OGMRip</title>
<subtitle>Greffons</subtitle>
<alternates>
<alternate name="english">en/index.html</alternate>
</alternates>
<content>
<p>Depuis la version 0.11, OGMRip dispose d'un système de greffons pour les conteneurs et les codecs vidéo, audio et sous-titres. Ce document présente par l'exemple comment écrire un nouveau greffon. Nous allons donc développer étape par étape un nouveau codec audio qui permet d'encoder au format AAC en utilisant le codec neroAac.</p>
<h2 id="generalites">Généralités</h2>
<p>Un plugin OGMRip est principalement composé d'un GObject, d'une description et d'une fonction permettant de la récupérer. Selon le greffon, le GObject implémente un type spécifique: un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/OGMRipContainer.html">OGMRipContainer</a> pour un conteneur, un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/OGMRipVideoCodec.html">OGMRipVideoCodec</a> pour un codec vidéo, un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/OGMRipAudioCodec.html">OGMRipAudioCodec</a> pour un codec audio ou un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/OGMRipSubpCodec.html">OGMRipSubpCodec</a> pour un codec de sous-titres. La description est contenue dans une structure dépendant elle aussi du type de greffon: un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/ogmrip-ogmrip-plugin.html#OGMRipContainerPlugin">OGMRipContainerPlugin</a> pour un conteneur, un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/ogmrip-ogmrip-plugin.html#OGMRipVideoPlugin">OGMRipVideoPlugin</a> pour un codec vidéo, un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/ogmrip-ogmrip-plugin.html#OGMRipAudioPlugin">OGMRipAudioPlugin</a> pour un codec audio et un <a href="http://ogmrip.sourceforge.net/reference/ogmrip/ogmrip-ogmrip-plugin.html#OGMRipSubpPlugin">OGMRipSubpPlugin</a> pour un codec de sous-titres.</p>
<h2 id="ogmripneroaac">OGMRipNeroAac</h2>
<p>Nous allons donc, dans un premier temps, définir l'objet OGMRipNeroAac. Comme il s'agit d'un codec audio, il doit hériter de OGMRipAudioCodec:</p>
<pre>typedef struct _OGMRipNeroAac OGMRipNeroAac;
typedef struct _OGMRipNeroAacClass OGMRipNeroAacClass;
struct _OGMRipNeroAac
{
  OGMRipAudioCodec parent_instance;
};
struct _OGMRipNeroAacClass
{
  OGMRipAudioCodecClass parent_class;
};
G_DEFINE_TYPE (OGMRipNeroAac, ogmrip_nero_aac, OGMRIP_TYPE_AUDIO_CODEC)</pre>
<br/>
<p>Spécifier un type de cette manière impose de définir deux procédures au préalable, une pour initialiser la classe et une pour initialiser l'objet:</p>
<pre>static void
ogmrip_nero_aac_class_init (OGMRipNeroAacClass *klass)
{
}
static void
ogmrip_nero_aac_init (OGMRipNeroAac *nouveau)
{
}</pre>
<br/>
<p>En l'état, le greffon est quasiment compilable; il lui manque seulement les entêtes:</p>
<pre> #include <ogmrip.h>
#include <ogmjob.h></pre>
<p>On peut maintenant compiler:</p>
<pre>$ gcc -Wall -c ogmrip-nero-aac.c `pkg-config --cflags ogmrip`</pre>
<br/>
<p>Et même éditer les liens:</p>
<pre>$ gcc -shared ogmrip-nero-aac.o -o libogmrip-nero-aac.so</pre>
<p>Évidemment, le greffon ne fait pour l'instant absolument rien. Il faut y ajouter le code pour l'encodage proprement dit. Ainsi, il faut d'abord extraire la piste audio au format wave puis l'encoder en AAC. Heureusement, ces deux actions peuvent être effectuées en parallèle grâce à une fifo et un <a href="http://ogmrip.sourceforge.net/reference/ogmjob/OGMJobPipeline.html">OGMJobPipeline</a>.</p>
<p>Nous allons donc commencer par modifier le code pour créer la fifo et ajouter le pipeline:</p>
<pre>static gint ogmrip_nero_aac_run (OGMJobSpawn *spawn);<br/>
static void
ogmrip_nero_aac_class_init (OGMRipAacClass *klass)
{
OGMJobSpawnClass *spawn_class = OGMJOB_SPAWN_CLASS (klass);
/*
* Surcharge de la fonction run()
*/
spawn_class->run = ogmrip_nero_aac_run;
}
static void
ogmrip_nero_aac_init (OGMRipNeroAac *nouveau)
{
}
G_DEFINE_TYPE (OGMRipNeroAac, ogmrip_nero_aac, OGMRIP_TYPE_AUDIO_CODEC)
static gint
ogmrip_nero_aac_run (OGMJobSpawn *spawn)
{
OGMJobSpawn *pipeline;
gchar *fifo;
gint result;
/*
* Création de la fifo
*/
fifo = ogmrip_fs_mkftemp ("fifo.XXXXXX", NULL);
/*
* Création du pipeline
*/
pipeline = ogmjob_pipeline_new ();
/*
* Ajout du pipeline dans le conteneur
*/
ogmjob_container_add (OGMJOB_CONTAINER (spawn), pipeline);
/*
* Déréférencement du pipeline
*/
g_object_unref (pipeline);
/*
* Appel de la fonction run() de l'object parent. Il s'agit d'une
* éxécution bloquante.
*/
result = OGMJOB_SPAWN_CLASS (ogmrip_nero_aac_parent_class)->run (spawn);
/*
* Après l'encodage, suppression du pipeline du conteneur
*/
ogmjob_container_remove (OGMJOB_CONTAINER (spawn), pipeline);
/*
* Suppression de la fifo
*/
ogmrip_fs_unref (fifo, TRUE);
return result;
}</pre>
<br/>
<p>Là encore, notre greffon ne fait pas grand chose, mais l'infrastructure est complètement en place, prête à recevoir les processus pour l'encodage. Pour cela, nous allons définir deux fonctions, l'une pour constuire la ligne de commande d'extraction du wave, l'autre pour l'encodage en AAC.</p>
<pre>static gchar **
ogmrip_wav_command (OGMRipAudioCodec *audio, const gchar *output)
{
GPtrArray *argv;
/*
* Une fonction de création de ligne de commande wav/pcm est disponible
* dans la libogmrip-mplayer
*/
argv = ogmrip_mplayer_wav_command (audio, TRUE, NULL, output);
return (gchar **) g_ptr_array_free (argv, FALSE);
}
static gchar **
ogmrip_aac_command (OGMRipAudioCodec *audio, const gchar *input)
{
GPtrArray *argv;
const gchar *output;
gint quality;
/*
* Pour OGMRip, la qualité est comprise entre 0 et 10
*/
quality = ogmrip_audio_codec_get_quality (audio);
argv = g_ptr_array_new ();
/*
* Le nom de l'encodeur
*/
g_ptr_array_add (argv, g_strdup ("neroAacEnc"));
/*
* La qualité est un nombre flottant compris entre 0 et 1
*/
g_ptr_array_add (argv, g_strdup ("-q"));
g_ptr_array_add (argv,
g_strdup_printf ("%d.%d", quality / 10, quality % 10));
/*
* Le fichier d'entrée; il s'agit en fait de la fifo
*/
g_ptr_array_add (argv, g_strdup ("-if"));
g_ptr_array_add (argv, g_strdup (input));
/*
* Le fichier de sortie
*/
g_ptr_array_add (argv, g_strdup ("-of"));
output = ogmrip_codec_get_output (OGMRIP_CODEC (audio));
g_ptr_array_add (argv, g_strdup (output));
g_ptr_array_add (argv, NULL);
return (gchar **) g_ptr_array_free (argv, FALSE);
}</pre>
<br/>
<p>Comme nous utilisons des fonctions de la libogmrip-mplayer, il ne faut pas oublier d'ajouter l'entête qui va avec:</p>
<pre>#include <ogmrip-mplayer.h></pre>
<br/>
<p>Modifions maintenant la fonction run() pour ajouter des processus dans le pipeline qui invoqueront les procédures définies au-dessus.</p>
<pre>static gint
ogmrip_nero_aac_run (OGMJobSpawn *spawn)
{
OGMJobSpawn *pipeline;
OGMJobSpawn *child;
gchar *fifo, **argv;
gint result = OGMJOB_RESULT_ERROR;
/*
* Création de la fifo
*/
fifo = ogmrip_fs_mkftemp ("fifo.XXXXXX", NULL);
/*
* Création du pipeline
*/
pipeline = ogmjob_pipeline_new ();
/*
* Ajout du pipeline dans le conteneur
*/
ogmjob_container_add (OGMJOB_CONTAINER (spawn), pipeline);
/*
* Déréférencement du pipeline
*/
g_object_unref (pipeline);
/*
* Création de la ligne de commande pour l'extraction en wave
*/
argv = ogmrip_wav_command (OGMRIP_AUDIO_CODEC (spawn), fifo);
if (argv)
{
/*
* Création du processus associé
*/
child = ogmjob_exec_newv (argv);
/*
* Ajout d'une fonction pour analyser la sortie standard du processus.
* Cette fonction est définie dans la libogmrip-mplayer
*/
ogmjob_exec_add_watch_full (OGMJOB_EXEC (child),
(OGMJobWatch) ogmrip_mplayer_wav_watch, spawn, TRUE, FALSE, FALSE);
/*
* Ajout du processus dans le conteneur
*/
ogmjob_container_add (OGMJOB_CONTAINER (pipeline), child);
/*
* Déréférencement du processus
*/
g_object_unref (child);
/*
* Création de la ligne de commande pour la conversion en AAC
*/
argv = ogmrip_aac_command (OGMRIP_AUDIO_CODEC (spawn), fifo);
if (argv)
{
/*
* Création du processus associé
*/
child = ogmjob_exec_newv (argv);
/*
* Ajout du processus dans le conteneur
*/
ogmjob_container_add (OGMJOB_CONTAINER (pipeline), child);
/*
* Déréférencement du processus
*/
g_object_unref (child);
/*
* Appel de la fonction run() de l'object parent. Il s'agit d'une
* exécution bloquante.
*/
result =
OGMJOB_SPAWN_CLASS (ogmrip_nero_aac_parent_class)->run (spawn);
}
}
/*
* Après l'encodage, suppression du pipeline du conteneur
*/
ogmjob_container_remove (OGMJOB_CONTAINER (spawn), pipeline);
/*
* Suppression de la fifo
*/
ogmrip_fs_unref (fifo, TRUE);
return result;
}</pre>
<h2 id="description">Description</h2>
<p>Maintenant que le l'objet est complètement spécifié, il faut remplir la structure décrivant le plugin et définir la fonction permettant de la récupérer.</p>
<p>La structure de description requiert:</p>
<ul>
<li>une référence vers le module qui doit être initialisée à NULL;</li>
<li>un type qui doit être initialisé en appelant la fonction ogmrip_nero_aac_get_type;</li>
<li>le nom du module;</li>
<li>une description du module;</li>
<li>le format du fichier créé par le module. OGMRip supporte autant de format que MPlayer, il sont tous définis dans le type énuméré <a href="http://ogmrip.sourceforge.net/reference/ogmrip/ogmrip-ogmrip-enums.html#OGMRipFormatType">OGMRipFormatType</a>.</li>
</ul>
<p>La fonction doit obligatoirement s'appeler ogmrip_init_plugin et retourne un pointeur vers la structure de description. On profite également de cette fonction pour tester les prérequis, en l'occurrence si mplayer et neroAacEnc sont installés.</p>
<pre>static OGMRipAudioPlugin nero_aac_plugin =
{
NULL,
G_TYPE_NONE,
"nero-aac",
"Nero AAC",
OGMRIP_FORMAT_AAC
};
OGMRipPluginAudioCodec *
ogmrip_init_plugin (void)
{
gchar *fullname;
/*
* Vérifier si mplayer est installé
*/
if (!ogmrip_check_mplayer ())
return NULL;
/*
* Vérifier si neroAacEnc est installé
*/
fullname = g_find_program_in_path ("neroAacEnc");
if (!fullname)
return NULL;
g_free (fullname);
nero_aac_plugin.type = ogmrip_nero_aac_get_type ();
return &nero_aac_plugin;
}</pre>
<br/>
<p>Il ne reste plus qu'à copier le plugin dans le répertoire dans lequel OGMRip cherche les greffons audio. Il s'agira probablement de /usr/lib/ogmrip/audio-codecs, /usr/local/lib/ogmrip/audio-codecs ou encore $HOME/lib/ogmrip/audio-codecs. Les codecs video, de sous-titres et les conteneurs doivent être installés dans les répertoires video-codecs, subp-codecs et containers, respectivement.</p>
<p>Et si tout s'est bien passé, le greffon apparaitra automatiquement dans la section appropriée de la fenêtre de préférences d'OGMRip ou dans une des listes de codecs ou de conteneurs de shRip.</p>
<h2 id="conclusion">Conclusion</h2>
<p>Nous venons donc de voir comment créer un nouveau greffon pour OGMRip permettant d'encoder des pistes audio au format AAC en utilisant neroAAC. La création de greffon vidéo ou de sous-titres est quasiment similaire hormis quelques spécificités de la structure de description.</p>
<p>Ainsi, un greffon pour un codec vidéo nécessite de connaître le nombre de passes et le nombre de threads qu'il supporte; pour un codec de sous-titres, il faut spécifier s'ils sont au format texte.</p>
<p>La structure de description d'un conteneur diffère un peu plus en cela qu'elle doit spécifier s'il supporte les B-frames, le nombre maximum de flux audio et de sous-titres qu'il peut comporter et une liste de tous les formats qu'il peut contenir. Pour plus d'informations à ce sujet, vous pouvez vous référer au <a href="http://ogmrip.svn.sourceforge.net/viewvc/ogmrip/trunk/ogmrip/libogmrip/ogmrip-mkv.c?view=markup">code</a> du conteneur Matroska.</p>
<p>Enfin, vous pouvez récupérer l'<a href="http://ogmrip.sourceforge.net/plugins/ogmrip-nero-aac-0.3.tar.gz">archive</a> complète du codec audio neroAac et vous en servir comme base pour d'autres greffons.</p>
</content>
<sidebar>
<p>
<a href="#generalites">Généralités</a><br/>
<a href="#ogmripneroaac">OGMRipNeroAac</a><br/>
<a href="#description">Description</a><br/>
<a href="#conclusion">Conclusion</a><br/>
</p>
</sidebar>
</html>
|