# Universal Subtitle Format

Le Universal Subtitle Format, abrégé sous le sigle USF (de l'anglais signifiant littéralement « format universel de sous-titrage »), est un format de sous-titrage basé sur XML pour des raisons de flexibilité, de portabilité, et de support de l'Unicode.

## Introduction

L'Universal Subtitle Format a été conçu avec l'idée de fournir toutes les capacités des formats les plus complets déjà existants (SSA, ASS, etc) et de promouvoir une utilisation de type softsub (en opposition avec le hardsub) afin d'éviter toute perte de qualité.

## Historique

La version v1.0 a été rendue publique en 2002.
La dernière spécification officielle date du 2003-06-18 et est en état de brouillon, actuellement le développement semble arrêté, néanmoins la majorité des implémentations qui existent se basent sur cette spécification.

## Caractéristiques

* Basé sur XML
* Basé sur le temps
* 4 types d'éléments :
** texte
** image
** karaoke
** forme (rectangle, ...)
* Système avancé de positionnement des éléments :
** 9 types d'alignement (TopLeft, TopMiddle, TopRight, MiddleLeft, MiddleCenter, MiddleRight, BottomLeft, BottomCenter, BottomRight).
** Relatif à la fenêtre ou a la vidéo.
** Marge horizontale et verticale en pixel ou en pourcentage de la vidéo ou de la fenêtre.
* Attribut du texte utilisable au niveau caractère :
** couleur
** italique, gras, souligné
** taille
** police
* Possibilité de définir des styles
* Information meta pour augmenter les facilités de stockage/recherche (tri).
** title (titre)
** author (auteur)
** language (langage) (ISO 639-2 plus une définie par l'utilisateur)
** date (date)
** comment (commentaire)

## La syntaxe du format

Un fichier XML peut être vu comme un arbre ayant une racine, des branches et des nœuds.
La racine de l'arbre USF est appelé "USFSubtitles".
Entre les parenthèses le numéro possible des éléments. (1: requis, 0..1: optionnel, 1..N: au moins un, 0..N). @ est la marque pour un attribut.
L'attribut de la "version" est utilisé par le lecteur pour identifier les caractéristiques qui sont utilisées dans l'archive actuelle. La version sera incrémentée dans le futur si de nouvelles caractéristiques sont nécessaires.

### Métadonnée

Le nœud de meta-donnée est assez explicite.
L'attribut du code de la langue (language code) est normalisé (ISO 639-2), vers Codes for the Representation of Names of Languages pour la liste complète. Autres exemples :
L'extension du langage (languageext) doit être défini sur cette ligne : Normal, HearingImpaired, DirectorComments, Forced, Children.
La date utilise le standard international des dates (ISO 8601).
On peut utiliser les étiquettes basiques (i, b, u, font, br) dans l'élément commentaire (comment), cela permet de donner un format au texte comme italique, gras, souligné, etc.

### Styles

Définir des styles est optionnel, mais il faut que les styles soient bien structurés et faciles à maintenir.
Les styles sont utilisés pour définir des configurations applicables à un groupe de sous-titres du texte. Un style a un attribut nom (name) requis, c'est le nom qui servira de référence plus tard. Tous les autres attributs sont optionnels.
Si on change le nom du style (actuellement appelé "MonNomDeStyle"), on devra changer les 2 lignes qui y font référence.
Tous les styles héritent, dans un premier temps, des attributs du style défini dans le lecteur.
Si le lecteur est configuré pour afficher une police avec une taille définie à 10, que vous définissiez un style, dans mon fichier USF, avec une taille relative "+2", alors, tous les sous-titres utilisant ce style auront une taille 20 % plus grande que la police configurée dans le lecteur. On a le même mécanisme avec le style "Default" et les autres styles. Ceci permet à l'utilisateur de fixer une taille "normale" qui lui convienne pour la lecture de la vidéo et au sous-titreur de choisir le texte qui apparaîtra relativement plus gros que la normale ou plus petit. Le style par défaut est celui dont le nom est "Default".
Tout le style est hérité du style par défaut (celui du lecteur ou celui qui a été redéfini).
La hiérarchie utilisée :
* Style de police (fontstyle)
L'attribut famille (family) spécifie une liste priorisée de noms de famille de polices ou noms génériques de familles. Quelques exemples :
Il est recommandé de définir le nom d'une famille générique de police après n'importe quelle police nommée comme ci-dessus à une famille préférée des types de police ; une en serif, sans-serif, monospace, cursive ou fantasy. (Generic font families)
Les couleurs sont définies, comme en HTML, avec 3 composantes, rouge, vert et bleu RVB dans l'intervalle 0..255 codé en hexadecimal (00..FF). Ainsi le rouge pur c'est #FF0000, le vert pur #00FF00 et le bleu pur #0000FF.
La couleur peut être étendue à une 4e composante (alpha) spécifiant la transparence de la couleur. Une valeur de l'alpha à 255 spécifie que la couleur est totalement transparente et une valeur de 0 spécifie que la couleur est opaque. Quand on écrit #FF0000 cela revient à écrire #00FF0000 une couleur rouge pur opaque. Pour faire une couleur rouge transparente on doit écrire, par exemple #DDFF0000.
"alpha" : permet d'appliquer une transparence générale à l'ensemble des couleurs définies. La transparence est une valeur comprise entre 0 et 100. Cette valeur remplace la transparence de chacune des couleurs. Par exemple, si la couleur du texte (color) est #40FFFFFF" et la transparence (alpha) est 50, alors la valeur de color devient #A0FFFFFF.
"color" : C'est la couleur principale du texte ou la couleur d'apparition lorsque le karaoke est activé. "backcolor" : C'est la couleur du texte avant apparition durant le mode karaoke.
L'épaisseur de la police (font weight) doit être définie dans la liste suivante:
* Position
L'attribut "alignment" (alignement) a 9 valeurs possibles :
L'attribut "relative-to" (relatif à) a deux valeurs possibles : "Window" ou "Video".
Les marges sont définies en pixels ou en pourcentage de la fenêtre, ou de la vidéo, suivant ce qui a été défini dans l'attribut "relative-to".
La rotation est définie en degrés. On peut utiliser différents axes de rotation pour créer un effet 3D.
La rotation commune utilisée en 2D est celle d'axe Z. Par exemple, pour écrire un texte en diagonal depuis le coin inférieur gauche au coin supérieur droit on peut écrire :

### Effets

Les effets sont encore considérés comme inachevés ou en développement. Ce qui suit est une idée, on définit quelques balises et le lecteur interpole la balise requise pour faire l'animation. Exemple :
On remplace $debut, $fin par les positions des balises.
Attributs qui peuvent être "animés" :

### Sous-titres

C'est la partie essentielle du fichier, elle contient le contenu des sous-titres.
Un sous-titre a 2 attributs de temps (timestamps) : start (départ) et stop (arrêt). Les timestamps utilisent le format suivant :
Au lieu d'utiliser un "timestamp" pour arrêter, on peut utiliser l'attribut de durée. Il est aussi permis d'utiliser un "timestamp" raccourci : ss[.mmm]
Le contenu d'un sous-titre peut être composé de différents éléments : texte, image ou karaoke dans certains cas.
Tous les éléments peuvent être localisés indépendamment avec les mêmes attributs de position que les styles : "alignment", "horizontal-margin", "vertical-margin" et "relative-to".
* Texte
Les éléments du texte sont définis par une propriété XHTML. Toutes les étiquettes disponibles sont utilisées dans l'exemple précédent. Une note spéciale pour les utilisateurs de HTML, XHTML est un peu plus strict que HTML.
* Image
L'élément "image" apporte un support pour inclure des images dans la vidéo, comme des sous-titres. Normalement, seul le format Bitmap est supporté.
L'image doit être dans le même répertoire ou dans un sous-répertoire du fichier du sous-titre.
L'attribut "colorkey" est la couleur qui sera transparente dans l'image, donc une valeur de #FFFFFF rendra transparente toutes les parties blanches de l'image.
* Karaoke
L'élément karaoke est très similaire à l'élément texte. La principale différence est qu'il faut utiliser une étiquette spéciale : <k t="durée_en_ms"/>
Ainsi que dans l'exemple dessous le texte "chanson" a une durée de 400 ms, "cool" a une durée de 300 ms...
La somme de toutes les durées doit être égale à la durée du sous-titre. Ici 100 + 400 + 200 + 300 = 1000 ms = 1s
* Forme (Shape)
L'élément "shape" se considère incomplet ou en développement (voire abandonné).
Un exemple simple de la façon dont cela pourrait se faire :
Dans les dernières propositions non officielles l'élément "sharp" a été rejeté en faveur de "USFxSVG", pour utiliser des images vectorielles SVG de manière appropriée, mais limitée, en comparaison à celui-ci. (cf. USFxSVG proposal 4)