# Format de skins MPlayer

## Sommaire

- 1 Introduction
- 2 Aperçu

- 2.1 Répertoires
- 2.2 Images
- 2.3 Composants d'une skin
- 2.4 Fichiers

- 3 Le fichier `skin`

- 3.1 Fenêtre principale
- 3.2 Sous fenêtres
- 3.3 Menu

- 4 Polices

- 4.1 Symboles

- Appendice A: messages de la GUI

Dernière modification: Sep 10, 2001

## 1 Introduction

L'objectif de ce document est de décrire le format de skins de MPlayer. Les informations présentées ici peuvent s'avérer fausses, du fait que a) ce n'est pas moi qui ait écrit la GUI, b) cette GUI n'est pas terminée, c) je peux me tromper. Ne soyez donc pas surpris si quelque chose ne correspond pas à cette description.

Merci à Zoltán Ponekker pour son aide.

András Mohari <mayday@freemail.hu>

## 2 Aperçu

Ce n'est pas en rapport direct avec le format des skins, mais vous devez savoir que MPlayer n'a pas de skin par défaut, donc une skin au moins doit être installée pour pouvoir utiliser la GUI.

### 2.1 Répertoires

MPlayer cherche des skins dans ces répertoires (dans cet ordre):

        /usr/local/share/mplayer/Skin/
        ~/.mplayer/Skin/

Notez que le premier répertoire peut varier suivant la façon dont MPlayer a été configuré (c.f. l'argument `--datadir` du script `configure`).

Chaque skin est installée dans son propre répertoire sous l'un des répertoires listés ci-dessus, par exemple:

        /usr/local/share/mplayer/Skin/default/

### 2.2 Format d'images

Les images doivent être en truecolor (24 ou 32 bpp) et enregistrées au format BMP, PNG ou TGA (sans compression pour les images TGA). le format par excellence reste le PNG, qui assure un très bon taux de compression.

Dans la fenêtre principale (c.f. ci-dessous) vous pouvez utiliser des images dotées de régions "transparentes" : les régions remplies avec la couleur #FF00FF (magenta) deviennent transparentes dans MPlayer. De même, vous pouvez obtenir des formes particulières pour vos fenêtres si votre serveur X possède l'extension XShape.

### 2.3 Parties d'une skin

Les skins sont d'un format plutôt libre (contrairement aux formats fixes de Winamp/XMMS, par exemple), donc il ne tient qu'a vous de créer quelque chose de bien.

Actuellement, trois fenêtres doivent être décorées : la fenêtre principale, la sous-fenêtre et le menu (activable par un clic droit).

- Vous controlez MPlayer par la fenêtre principale. L'arrière plan en est une image. Divers objets doivent venir se placer dans cette fenêtre : boutons, podomètres (ou des sliders si vous préferez) et des labels. Pour chaque objet, vous devez spécifier sa taille et sa position.

  Un bouton comprend trois états (pressé, relaché, désactivé), donc l'image doit se diviser en trois parties, verticalement. c.f. l'objet bouton pour plus de détails.

  Un podomètre (principalement utilisé pour la barre d'avancement et le contrôle du volume/balance) peut posséder n'importe quel nombre d'états en empilant ces images, verticalement. C.f. hpotmeter et potmeter pour plus de détails.

  Les labels sont un peut particuliers : les caractères nécessaires pour les dessiner sont récupérés depuis un fichier image, décrit par un fichier de description de polices. Ce dernier est un fichier texte brut spécifiant la position x,y ainsi que la taille de chaque caractère dans l'image. (donc le fichier image et son descripteur forment une police ensemble.) C.f. dlabel et slabel pour plus de détails.

  Note: toutes les images diposent de la couleur de transparence décrite dans la section formats d'images.

- La sous-fenêtre contient la vidéo en elle même. Elle peut affichier une image si aucun film n'est chargé (ce n'est jamais plaisant d'avoir une fenêtre vide :-)) Note: la couleur de transparence n'est pas autorisée ici
- Le menu est simplement un moyen de controler MPlayer par des entrées graphiques. Deux images sont nécessaires pour le menu : l'une d'elle, l'image de base, affiche le menu dans son été normal, l'autre est utilisée pour afficher les entrées sélectionnées. Quand vous faites apparaitre le menu, la première image s'affiche. Si vous passez la souris sur les entrées du menu, l'entrée sélectionnée est copiée depuis la seconde image, et uniquement la partie concernée par cette sélection (Donc la seconde image ne s'affiche jamais complètement.)

  Une entrée de menu se définit par sa position et sa taille dans l'image (c.f. la section menu pour plus de détails).

Une chose essentielle n'a pas encore été mentionnée : pour que les boutons podomètres et entrées du menu fonctionnent, MPlayer doit savoir quoi en faire. Ceci dépend des messages (events) envoyés. Pour chaque objet vous devez définir une action a réaliser.

### 2.4 Fichiers

Vous aurez besoin des fichiers suivants pour construire une skin.

- Le fichier de configuration nommé skin indique à MPlayer comment assembler les différentes images et comment interpréter les clics de souris sur l'interface.
- L'image de fond de la fenêtre principale.
- Les images correspondant aux objets de la fenêtre principale (y compris une ou plusieurs polices et descripteurs nécessaires à l'affichage des textes).
- L'image affichée dans la sous-fenêtre (optionnel).
- Deux images pour le menu (nécessaires uniquement si vous voulez créer un menu).

A l'exception du fichier de configuration, vous pouvez nommer les fichiers comme bon vous semble (mais notez que les descripteurs de polices doivent avoir une extension .fnt)

## 3 Le fichier `skin`

Il est lu ligne par ligne; les lignes de commentaire démarrent par le caractère '`;`' en début de ligne (seuls les espace et tabulations sont autorisées avant ce signe).

Les fichiers se composent de sections. Chaque section décrit la skin pour une application et s'écrit sous la forme :

    section = section name
    .
    .
    .
    end

Actuellement il n'existe qu'une application, donc vous n'aurez besoin que d'une section: dont le nom est movieplayer.

Dans cette section chaque fenêtre est décrite par un bloc de la forme suivante :

    window = window name
    .
    .
    .
    end

ou window name peut-être l'un des types suivants :

- main - pour la fenêtre principale
- sub - pour la sous-fenêtre
- menu - pour le menu

(Les bloace sub et menu sont optionnels --- vous n'avez pas d'obligation de décorer le menu et la sous-fenêtre.)

Dans un bloc window, vous pouvez définir chaque objet sous la forme :

>     item = parameter

ou item est une ligne identifiant le type d'objet de la GUI, parameter est une valeur numérique ou textuelle (ou une liste de valeurs séparées par des virgules).

Le fichier final doit donc ressembler à ceci :

    section = movieplayer
      window = main
      ; ... items for main window ...
      end

      window = sub
      ; ... items for subwindow ...
      end

      window = menu
      ; ... items for skin menu ...
      end
    end

Quelques précisions sur l'appel des images dans la configuration.
Le nom d'un fichier image doit être donné sans distinction de répertoire --- les images seront cherchées dans le même répertoire que le fichier de configuration. Vous pouvez (mais ce n'est pas obligatoire) spécifier l'extension du fichier. Si le fichier n'existe pas, MPlayer essaie de charger le fichier <filename>.<ext>, ou <ext> sera respectivement tga,TGA, bmp, BMP, png et PNG dans cet ordre. La première correspondance trouvée sera utilisée.

> Un exemple. Supposons que vous avez crée une image main.png que vous voulez utiliser pour la fenêtre principale:
>         base = main, -1, -1
> MPlayer essaie de charger main, main.tga, main.TGA, main.bmp etc, donc main.png sera trouvé. Si (par accident) vous écrivez
>         base = main.bmp, -1, -1
alors main.bmp, main.bmp.tga, main.bmp.TGA, main.bmp.bmp seront recherchés et MPlayer et MPlayer abandonnera parce qu'il ne trouvera pas de main.bmp dans le répertoire, mais main.png.

### 3.1 Fenêtre principale

Vous trouverez ci-dessous la liste des objets utilisables dans le bloc '`window = main`' . . . '`end`'.

base = image, x, y
  Vous spécifiez ici l'image de fond utilisée dans la fenêtre principale. La fenêtre apparaitra a la position x,y sur l'ecran (0,0 est le coin supérieur gauche). Vous pouvez spécifier -1 pour le centre et -2 pour droite (x) et bas (y). La fenêtre prendra la taille de l'image.

  Attention : les régions transparentes (couleur #FF00FF) apparaitront en noir sur les serveurs X n'ayant pas l'extension XShape.

button = image, x, y, largeur, hauteur, message
  Place un bouton de taille largeur * hauteur a la position x,y. Le message sera généré au clic sur ce bouton. L'image appellée par image doit avoir trois états empilés verticalement (pour les trois états du bouton), comme ceci:

      +--------+
      |  pressé	|
      +--------+
      |  relaché	|
      +--------+
      |  désactivé	|
      +--------+

decoration = enable|disable
  Active ou désactive la décoration du gestionnaire de fenêtre pour la fenêtre principale. Désactivé par défaut.

hpotmeter = butt, bw,bh, phases, numphases, default, x, y, w, h, msg
  Place un podomètre horizontal de taille w * h a la position x,y. L'image peut être divisée en différentes parties pour les différentes phases du podomètre (par exemple, vous pouvez en avoir un pour le contrôle du volume qui passe du vert au rouge quand sa valeur passe du minimum au maximum.) hpotmeter peut posséder un bouton qui sera glissé horizontalement. Les paramètres sont :
  - butt - l'image utilisée pour le bouton (doit avoir trois états superposés, comme pour les boutons)
  - bw, bh - taille du bouton
  - phases - L'image utilisée pour les différentes phases du podomètre. L'image doit être divisée en numphases parties verticalement (c.f. ci-dessous). Une valeur `NULL` spéciale peut-être utilisée si vous ne voulez pas d'image.
  - numphases - nombre d'états placés dans l'image.
  - default - valeur par défaut du podomètre (dans un intervalle de 0 a 100)
  - x, y - position pour le podomètre
  - w, h - largeur et hauteur du podomètre
  - msg - le message généré lors des changements d'état du podomètre
  L'image utilisée pour les différents états doit correspondre a ceci :

      +--------+
      |  état #1	|
      +--------+
      |  état #2	|
      +--------+
           ...
      +--------+
      |  état #n	|
      +--------+

  Note: il y aura également un podomètre vertical (vpotmeter), qui n'a pas encore été programmé.

podomètre = phases, numphases, default, x, y, w, h, msg
  Un podomètre sans boutons. (je suppose qu'il est censé tourner en rond, mais il réagit uniquement aux tractions horizontales.) Pour une descritpion de ses paramètres lisez hpotmeter. Ses états peuvent être `NULL`, mais ce n'est pas vraiment utile, puisque vous ne pouvez pas voir son niveau.

font = fontfile, fontid
  Définit une police. fontfile est le nom du descripteur de police avec l'extension `.fnt` (inutile de préciser son extension ici). fontid réfère à la police (c.f. dlabel et slabel). Plus de 25 polices peuvent être définies.

dlabel = x, y, length, align, fontid, "text"
  Place un label dynamique à la position x,y. Le label est appelé dynamique parce que sont texte est rafraichi péridiquement.. La longeur maximum du label est définie par length (sa hauteur dépend de la hauteur des caractères). Si le texte a afficher dépasse cette longeur il sera scrollé, au bien aligné dans l'espace spécifié par la valeur du paramètre align : 0 pour droite, 1 pour centré, 2 pour gauche.
  Le texte a afficher est donné par text: il doit être écrit entre guillemets doubles (`"`) (mais le caractère `"`ne peut pas faire partie du texte). Le texte s'affiche en utilisant la police spécifiée par fontid. Vous pouvez utiliser les variables suivantes dans le texte :

  Variable | Signification
  --- | ---
  `$1` | temps de lecture en hh:mm:ss
  `$2` | temps de lecture en mmmm:ss
  `$3` | temps de lecture en hh(heures)
  `$4` | temps de lecture en mm(minutes)
  `$5` | temps de lecture en ss(secondes)
  `$6` | longeur du film en hh:mm:ss
  `$7` | longeur du film en mmmm:ss
  `$8` | temps de lecture en h:mm:ss
  `$v` | volume en xxx.xx%
  `$V` | volume en xxx.x
  `$b` | balance en xxx.xx%
  `$B` | balance en xxx.x
  `$$` | le caractère `$`
  `$a` | un caractère dépendant du type audio (aucun: `n`, mono: `m`, stereo: `t`)
  `$t` | numéro de piste (dans la playlist)
  `$o` | nom du fichier
  `$f` | nom du fichier en minuscule
  `$F` | nom du fichier en majuscule
  `$T` | un caractère dépendant du type de flux (fichier: `f`, video CD: `v`, DVD: `d`, URL: `u`)
  `$p` | le caractère "p" (si une vidéo est en lecture et que la police a le caractère "p")
  `$s` | le caractère "s" (si une vidéo est stoppée et que la police a le caractère "s")
  `$e` | le caractère "e" (si une vidéo est en pause et que la police a le caractère "e")

  Note: les variables `$a`, `$T`, `$p`, `$s` et `$e`retournent toutres des caractères pouvant s'afficher comme des symboles spéciaux (par exemple, "e" est le symbole de pause qui ressemble généralement à `||`). Vous pouvez avoir une police pour les saractères normaux et une autre pour les symboles. Lisez la section sur les symboles pour plus d'informations.

slabel = x, y, fontid, text
  Place un label statique à la position x,y. text s'affiche en utilisant la police spécifiée par fontid. Le texte est seulement du texte brut (les variables $x ne fonctionnent pas) et doit être enfermé entre des guillements doubles (le caractère `"` ne doit pas faire partie du texte).

### 3.2 Sous-fenêtre/a>

Vous trouverez ci-dessous la liste des objets utilisables dans le bloc '`window = sub`' . . . '`end`'.

base = image, x, y, largeur, hauteur
  L'image qui s'affichera dans la fenêtre. La fenêtre apparaîtra à la position x,y sur l'écran (0,0 est le coin supérieur gauche). Vous pouvez spécifier -1 pour centre et -2 pour droite. La fenêtre prendra la taille de l'image. largeur et hauteur donnent la taille de la fenêtre; ces paramètres sont optionnels (si ils sont absents, le fenêtre prend la taille de l'image).

background = r, g, b
  Vous permet de définir la couleur de fond. Utile si l'image est plus petite que la fenêtre. r, g et b spécifient les composantes rouge, verte et bleue de la couleur (d'une intervalle entre 0 et 255).

### 3.3 Menu

Comme mentionné précédemment, le menu s'affiche en utilisant deux images. Les entrées normales du menu sont extraitres de l'image spécifiée par l'objet base, tandis que l'entrée actuellement sélectionnée est extraite de l'image spécifiée par l'objet selected. Vous devez définir la taille et la position de chaque entrée du menu par l'objet menu.

Ils correspondent aux objets utilisés dans le bloc '`window = menu`' . . . '`end`'.

base = image
  L'image utilisée pour les entrées normales.

selected = image
  L'image utilisée pour les entrées selectionnées.

menu = x, y, largeur, hauteur, message
  Définit la position x,y et la taille des entrées du menu dans les images. message est le message généré quand le bouton de la souris est relaché sur l'entrée..

## 4 Polices

Comme mentionné dans la section sur les parties de la skin, une police est définie par une image et un fichier de description. Vous pouvez placer les caractères n'importe ou sur l'image, mais vous devez vous assurer que leur position et taille correspondent précisément au fichier de description..

Les fichier descriptif des polices (avec l'extension .fnt) peut avoir des lignes de commentaires commençant par '`;`'. Le fichier doit avoir une ligne du type

>     image = image

où image est le nom de l'image qui sera utilisée pour la police (vous n'avez pas à définir d'extension). Cette ligne est suivie par une définition de caractère du type :

>     "char" = x, y, w, h

Ici x et y précisent la position du caractère char dans l'image (0,0 est le coin supérieur gauche). w et h sont la largeur et la hauteur du caractère (en pixels, bien sûr).

Voici un exemple définissant les caractères A, B, C utilisant la police font.png.

    ; peut être "font" au lieu de "font.png"
    image = font.png

    ; Trois caractères suffisent, mais seulement pour une démonstration. :-)
    "A" =  0,0, 7,13
    "B" =  7,0, 7,13
    "C" = 14,0, 7,13

### 4.1 Symboles

Certains caractères ont une sugnifaction spéciale quand retournés par des variables utilisées dans dlabel; ces caractères sont censés s'aficher comme des symboles. (par exemple, dans le cas d'une lecture DVD, vous pouvez afficher un beau logo DVD a la place du caractère 'd').

La table ci-dessous liste les caractères pouvant s'afficher comme des symboles (et nécessitent donc une police différente).

Character | Symbole
--- | ---
`p` | lecture
`s` | stop
`e` | pause
`n` | pas de son
`m` | son mono
`t` | son stereo
`f` | lecture depuis un fichier
`v` | lecture depuis un video CD
`d` | lecture depuis un DVD
`u` | lecture depuis une URL

Note: actuellement uniquement 'p', 's', 'e', 'n', 'm' et 't' sont utilisables.

## Appendice A: messages de la GUI

Ce sont les messages qui peuvent être générés par les boutons, podomètres et entrées du menu.

Note: certains messages peuvent ne pas fonctionner comme prévu (ou ne pas fonctionner du tout). Comme vous le savez, la GUI est en cours de développement.

Contrôle de lecture :

> evNext
>   Saute à la prochaine piste dans la playlist.
> evPause
>   Pause.
> evPauseSwitchToPlay
>   Associé à la commande evPlaySwitchToPause. Ils s'utilisent pour avoir un bouton play/pause commun. Les deux messages peuvent être assignés aux boutons affiches exactement à la même position dans la fenêtre. Ces message mettent la lecture en pause et le bouton evPlaySwitchToPause s'affiche (pour indiquer que le bouton peut être pressé pour continuer la lecture).
> evPlay
>   Commence la lecture.
> evPlaySwitchToPause
>   Le contraire de evPauseSwitchToPlay. Ce message démarre la lecture et l'image associée au bouton evPauseSwitchToPlay s'affiche (pour indiquer que le bouton peut être pressé pour mettre en pause la lecture).
> evPrev
>   Saute à la piste précedente dans la playlist.
> evStop
>   Stoppe la lecture.

Avancée dans le flux:

> evBackward10sec
> evBackward1min
> evBackward10min
>   Recule de 10 secondes / 1 minute / 10 minutes.
> evForward10sec
> evForward1min
> evForward10min
>   Avance de 10 secondes / 1 minute / 10 minutes.
> evSetMoviePosition
>   Se place à la position (utilisable avec un podomètre; utilise la valeur relative (0-100%) du podomètre).

Contrôle vidéo :

> evDoubleSize
>   Double la taille de la fenêtre vidéo.
> evFullScreen
>   Passe en mode plein écran.
> evNormalSize
>   Met la vidéo à sa taille réelle.

Contôle audio :

> evDecAudioBufDelay
>   Diminue le délai du buffer audio.
> evDecBalance
>   Diminue la balance.
> evDecVolume
>   Diminue le volume.
> evIncAudioBufDelay
>   Augmente le délai du buffer audio.
> evIncBalance
>   Augmente la balance.
> evIncVolume
>   Augmente le volume.
> evMute
>   Active/désactive le son.
> evSetBalance
>   Fixe la balance (utilisable avec un podomètre; utilise la valeur relative (0-100%) du podomètre).
> evSetVolume
>   Fixe le volume (utilisable avec un podomètre; utilise la valeur relative (0-100%) du podomètre).

Divers :

> evAbout
>   Ouvre la fenêtre 'A Propos'.
> evEqualizer
>   Active/désactive l'equalizer.
> evExit
>   Quite le programme.
> evIconify
>   Iconifie la fenêtre.
> evLoad
>   Charge un fichier (en ouvrant un mini navigateur de fichiers, où vous pouvez choisir un fichier).
> evLoadPlay
>   Fait la même chose que evLoad,mais démarre la lecture automatiquement après le chargement du fichier.
> evNone
>   Message vide, sans effet. (A part peut-re dans les versions CVS :-))
> evPlayList
>   Ouvre/ferme la playlist.
> evPreferences
>   Ouvre la fenêtre de preferences.
> evSkinBrowser
>   Ouvre le navigateur de revêtements.