MPlayer skin format

# Appendice D - Formato skin di MPlayer

Il proposito di questo documento è di descrivere il formato delle skin di MPlayer. Le informazioni qui contenute possono essere errate, in quanto

1. non sono stato io a scrivere la GUI.
2. la GUI non è finita.
3. posso sbagliarmi.

Quindi non sorprenderti se qualcosa non funziona come descritto qui.

Grazie a Zoltán Ponekker per il suo aiuto.

András Mohari <mayday@freemail.hu>

## D.1 Generale

Non ha niente a che fare col formato delle skin, ma dovresti sapere che MPlayer non include una skin, quindi devi installare almeno una skin per poter usare la GUI.

### D.1.1 Directory

Le directory in cui si cerca per le skin sono (in ordine):

        $(DATADIR)/Skin/
        $(PREFIX)/share/mplayer/Skin/
        ~/.mplayer/Skin/

Nota che il primo path può variare a seconda di come è stato configurato MPlayer (vedi le opzioni `--datadir` e `--prefix` dello script `configure`).

Ogni skin è installata in una sua propria directory sotto una delle directory elencate sopra, per esempio:

        $(PREFIX)/share/mplayer/Skin/default/

### D.1.2 Formati delle immagini

Le immagini devono essere PNG in truecolor (24 o 32 bpp).

Nella finestra principale e nella playbar (vedi sotto) puoi usare immagini con `trasparenze': le aree riempite col colore #FF00FF (magenta) sono del tutto trasparenti quando viste con MPlayer. Questo significa che puoi anche ottenere finestre sagomate se il tuo server X ha l'estensione XShape.

### D.1.3 Parti di una skin

Le skin sono del tutto in formato libero (non come le skin a formato fisso di Winamp/XMMS, per esempio), quindi sta a te creare qualcosa di grandioso.

Attualmente ci sono tre finestre da decorare: la finestra principale, la sotto finestra ed il menu della skin (che può essere attivato con il tasto destro).

- La finestra principale e/o la playbar sono usate per controllare MPlayer. Lo sfondo della finestra è un'immagine. Vari oggetti possono (e devono) essere piazzati nella finestra: bottoni, slider ed etichette. Per ogni oggetto, devi specificare la posizione e dimensione.

  Un bottone ha tre stati (premuto, rilasciato, disabilitato), quindi la sua immagine deve essere divisa in tre parti verticalmente. Vedi l'oggetto bottone per dettagli.

  Uno slider (usati principalmente per la barra di ricerca e il controllo di volume/bilanciamento) può avere qualsiasi numero di fasi dividendo la sua immagine in differenti parti una sotto l'altra. Vedi hslider e slider per dettagli.

  Le etichette sono un po' speciali: i caratteri necessari a disegnarle sono presi da un file immagine, e i caratteri nell'immagine sono descritti da un file per la descrizione del font. Questo è un normale file di testo che specifica la posizione x,y e la dimensione di ogni carattere nell'immagine. (Quindi il file d'immagine e il suo file di descrizione del font formano un font insieme.) Vedi dlabel e slabel per dettagli.

  Nota: tutte le immagini possono avere la piena trasparenza come descritto nella sezione sui formati immagine.

- La sotto finestra è dove appare il filmato. Può mostrare una specifica immagine se non c'è nessun video caricato (è noioso avere una finestra vuota :-)) Nota: la trasparenza non è permessa qui.
- Il menu della skin è solo un modo per controllare MPlayer per mezzo delle voci del menu. Sono necessarie due immagini per il menu: una è l'immagine di base che mostra il menu nel suo stato normale, l'altra è usata per mostrare le voci selezionate. Quando attivi il menu, viene mostrata la prima immagine. Se muovi il mouse sulle voci del menu, la voce attualmente selezionata è copiata dalla seconda immagine sotto il puntatore del mouse (la seconda immagine non è mai mostrata interamente).

  Una voce del menu è definita dalla sua posizione e dimensione nell'immagine (vedi la sezione sul menu della skin per dettagli).

C'è una cosa importante non ancora menzionata: per far funzionare bottoni, slider e voci del menu, MPlayer deve sapere cosa fare se sono cliccati. Questo è fatto tramite messaggi (eventi). Per questi oggetti devi definire i messaggi che devono essere generati quando vengono attivati.

### D.1.4 File

Devi avere i seguenti file per fare una skin:

- Il file di configurazione chiamato skin dice a MPlayer come mettere insieme le diverse parti della skin e cosa fare se si clicca da qualche parte nella finestra.
- L'immagine di sfondo della finestra principale.
- Immagini per gli oggetti della finestra principale (inclusi uno o più file di descrizione dei font necessari per disegnare le etichette).
- l'immagine da mostrare nella sotto finestra (opzionale).
- Due immagini per il menu della skin (ne hai bisogno solo se vuoi creare un menu).

Con l'eccezione del file di configurazione della skin, puoi nominare gli altri file come vuoi (ma nota che i file di descrizione dei font devono avere l'estensione .fnt).

## D.2 Il file skin

Come menzionato sopra, questo è il file di configurazione della skin. E' orientato alla linea; le linee di commento iniziano col carattere '`;`' all'inizio della linea (solo spazi e tab sono permessi prima del'`;`').

Il file è fatto di sezioni. Ogni sezione descrive la skin per un'applicazione ed ha la seguente forma:

    section = nome sezione
    .
    .
    .
    end

Attualmente c'è solo una applicazione, quindi hai bisogno solo di una sezione: il suo nome è movieplayer.

Dentro questa sezione ogni finestra è descritta da un blocco nella seguente forma:

    window = nome finestra
    .
    .
    .
    end

dove nome finestra può essere una di queste stringhe:

- main - per la finestra principale
- sub - per la sotto finestra
- menu - per il menu della skin
- olaybar - playbar

(I blocchi sub e menu sono opzionali - non devi per forza creare un menu o decorare la sotto finestra.)

Dentro un blocco finestra, puoi definire ogni oggetto della finestra con una linea in questa forma:

`oggetto = parametro`
  dove `oggetto` è una stringa che identifica il tipo di oggetto della GUI, `parametro` è un valore numerico o testuale (o una lista di valori separati da virgole).

mettendo insieme quanto sopra, l'intero file appare così:

    section = movieplayer
      window = main
      ; ... oggetti della finestra principale ...
      end

      window = sub
      ; ... oggetti della sotto finestra ...
      end

      window = menu
      ; ... oggetti del menu ...
      end

      window = playbar
      ; ... oggetti della palybar ...
      end
    end

Il nome di un file immagine deve essere dato senza il percorso - le immagini vengono cercate nella directory della skin. Puoi (ma non è necessario) specificare l'estensione del file. Se il file non esiste, MPlayer cerca di caricare il file <nomefile>.<est>, dove `png` e `PNG` sono provati al posto di <est> (in questo ordine). Il primo file corrispondente sarà usato.

Infine qualche parola sul posizionamento. La finestra principale e la sottofinestra possono essere posizionate in diversi angoli dello schermo impostando le coordinate `X` e `Y`. `0` è in alto o sinistra, `-1` è centro e `-2` è destra o in basso, come mostrato qui:

    (0, 0)----(-1, 0)----(-2, 0)
      |          |          |
      |          |          |
    (0,-1)----(-1,-1)----(-2,-1)
      |          |          |
      |          |          |
    (0,-2)----(-1,-2)----(-2,-2)

Ecco un esempio per rendere le cose chiare. Supponi di avere un'immagine chiamata `main.png` che usi per la finestra principale: `base = main, -1, -1` MPlayer cerca di caricare `main`, `main.png`, `main.PNG`.

### D.2.1 Finestra principale e playbar

Sotto puoi vedere la lista degli oggetti che possono essere usati nei blocchi '`window = main`' . . . '`end`', e '`window = playbar`' . . . '`end`'.

`base = immagine, X, Y`
  Permette di specificare l'immagine di sfondo da usare per la finestra principale. La finestra apparirà sullo schermo alla posizione `X, Y` data. La finestra sarà larga quanto l'immagine.
  Nota: al momento queste coordinate non funzionano per la finestra display.
  Attenzione: le zone trasparenti dell' immagine (colore #FF00FF) appaiono nere se il server X non supporta l'estensione XShape. La larghezza dell'immagine deve essere divisibile per 8.
`button = immagine, X, Y, larghezza, altezza, messaggio`
  Posiziona un bottone di dimensioni `larghezza` * `altezza` alla posizione `X`, `Y`. Il `messaggio` specificato è generato quando viene cliccato il bottone. L'immagine data da immagine deve avere tre parti una sotto l'altra (secondo i possibili stati del bottone), in questo modo:

      +------------+
      |  premuto   |
      +------------+
      | rilasciato |
      +------------+
      |disabilitato|
      +------------+

`decoration = enable|disable`
  Abilita o disabilita la decorazione della finestra principale. Il default è disable.
  Nota: non funziona per la finestra display, non ce n'è bisogno.
`hpotmeter = bott, lungb, altb, fasi, numfasi, default, X, Y, lung, alt, msg`
  Inserisce uno slider orizzontale (hpotmeter) o verticale (vpotmeter) di dimensioni `lung` * `alt` alla posizione `X`, `Y`. L'immagine può essere divisa in diverse parti per le diverse fasi dello slider (per esempio, puoi avere uno slider per il controllo volume che cambia da verde a rosso al cambiare del suo valore dal minimo al massimo). `hpotmeter` può avere un bottone che si può trascinare orizzontalmente.
  I parametri sono:
  - `bott` - l'immagine da usare per il bottone (deve avere tre parti una sotto l'altra, come nel caso del bottone )
  - `lunghb`, `altb` - dimensione del bottone
  - `fasi` - L'immagine da usare per le differenti fasi dello slider. il valore speciale `NULL` può essere usato se non vuoi un 'immagine. L'immagine deve essere divisa in `numfasi` parti verticalmente in questo modo:

        +------------+
        |  fase #1  |
        +------------+
        |  fase #2  |
        +------------+
             ...
        +------------+
        |  fase #n  |
        +------------+

  - `numfasi` - numero di fasi inserite nell'immagine `fasi`
  - `default` - valore di default dello slider (da 0 a 100)
  - `X`, `y` - posizione dello slider
  - `lungh`, `alt` - larghezza e altezza dello slider
  - `messaggio` - il messaggio da generare quando viene cambiato il valore dello slider
`potmeter = fasi, numfasi, default, X, Y, l, a, msg`
  Un `hpotmeter`slider senza bottone. (Penso sia inteso per essere girato, ma reagisce solo al trascinamento orizzontale.) Per la descrizione dei parametri vedi hpotmeter. `fasi` può essere `NULL`, ma è proprio inutile, infatti non puoi vedere dove è situato lo slider.
`font = filefont, fontid`
  Definisce un font. `filefont` è il nome di un file che descrive un font con estensione `.fnt` (non c'è bisogno di specificare l'estensione qui). `fontid` è usato per riferirsi al font (vedi dlabel e slabel). Possono essere definiti fino a 25 font.
`slabel = X, Y, fontid, "testo"`
  Posiziona una etichetta statica in `X`, `Y`. Il testo è una pura stringa (le variabili `$x` non funzionano) che deve essere racchiuso tra virgolette (le `"` non possono essere parte del testo). Il testo è visualizzato usando il font identificato da `fontid`.
`dlabel = X, Y, lunghezza, allineamento, fontid, "testo"`
  Posiziona una etichetta dinamica in `X`, `Y`. L'etichetta è detta dinamica perchè il suo testo è aggiornato periodicamente. La lunghezza massima dell'etichetta è data da `lunghezza` (la sua altezza è quella di un carattere). Se il testo da visualizzare è più largo, allora sarà fatto ruotare, altrimenti è allineato nello spazio specificato tramite il valore del parametro `allineamento`: 0 per destra, 1 per centro, 2 per sinistra.
  Il testo da mostrare è dato da `testo`: deve essere scritto tra virgolette (`"`) (ma le `"` non possono essere parte del testo). L'etichetta è visualizzata usando il font identificato da `fontid`.Puoi usare le seguenti variabili nel testo:

  Variabile | Significato
  --- | ---
  `$1` | tempo in formato hh:mm:ss
  `$2` | tempo in formato mmmm:ss
  `$3` | tempo in formato hh (ore)
  `$4` | tempo in formato mm (minuti)
  `$5` | tempo in formato ss (secondi)
  `$6` | lunghezza filmato nel formato hh:mm:ss
  `$7` | lunghezza filmato nel formato mmmm:ss
  `$8` | tempo in formato h:mm:ss
  `$v` | volume in formato xxx.xx%
  `$V` | volume in formato xxx.x
  `$b` | bilanciamento in formato xxx.xx%
  `$B` | bilanciamento in formato xxx.x
  `$$` | il carattere `$`
  `$a` | un carattere a seconda del tipo di audio (nessuno: `n`, mono: `m`, stereo: `t`)
  `$t` | numero traccia (nella playlist)
  `$o` | nomefile
  `$f` | nomefile in minuscolo
  `$F` | nomefile in maiuscolo
  `$T` | un carattere a seconda del tipo di stream (file: `f`, video CD: `v`, DVD: `d`, URL: `u`)
  `$p` | il carattere "p" (se si sta leggendo un filmato e il font ha il carattere "p")
  `$s` | il carattere "s" (se non si sta leggendo un filmato e il font ha il carattere "s")
  `$e` | il carattere "e" (se il filmato è in pausa e il font ha il carattere "e")
  `$x` | larghezza del filmato
  `$y` | altezza del filmato
  `$C` | nome del codec utilizzato

  Nota: Le variabili `$a`, `$T`, `$p`, `$s` e `$e` ritornano tutte caratteri che dovrebbero essere visualizzati come simboli speciali (per esempio, "e" è per il simbolo della pausa che di solito appare come `||`). Dovresti avere un font per i caratteri normali e un altro per i simboli. Vedi la sezione sui simboli per altre informazioni.

### D.2.2 Sotto finestra

I seguenti oggetti possono essere usati nel blocco '`window = sub`' . . . '`end`'.

`base = immagine, X, Y, larghezza, altezza`
  L'immagine da visualizzare nella finestra. La finestra apparirà alla posizione `X`, `Y` data sullo schermo (`0,0` è l'angolo in alto a sinistra). Puoi specificare `-1` per centro e `-2` per destra (`X`) e sotto (`Y`). La finestra sarà grande quanto l'immagine. `larghezza` e `altezza` danno la dimensione della finestra; sono opzionali (se mancano, la finestra è grande quanto l'immagine).
`background = R, G, B`
  Permette di definire il colore di sfondo. Utile se l'immagine è più piccola della finestra. `R`, `G` e `B` specificano le componenti rossa, verde e blu del colore (ognuno è un numero decimale compreso tra 0 e 255).

### D.2.3 Menu della skin

Come menzionato prima, il menu è visualizzato usando due immagini. Le normali voci del menu sono prese dall'immagine specificata dall'oggetto `base`, mentre la voce attualmente selezionata è presa dall'immagine specificata dall'oggetto `selected`. Devi definire la posizione e la dimensione di ogni voce del menu tramite l'oggetto `menu`.

Questi sono gli oggetti che possono essere usati nel blocco '`window = menu`' . . . '`end`'.

`base = immagine`
  L'immagine delle normali voci del menu.
`selected = immagine`
  L'immagine che mostra il menu con tutte le voci selezionate.
`menu = X, Y, larghezza, altezza, messaggio`
  Definisce la posizione `X`, `Y e la grandezza di una voce del menu nelle immagini. `messaggio` è il messaggio da generare quando il bottone del mouse è rilasciato sopra la voce.`

## D.3 Font

Come detto nella sezione sulle varie parti di una skin, un font è definito da un'immagine e un file di descrizione. Puoi mettere i caratteri ovunque nell'immagine, ma assicurati che la loro posizione e dimensione sia data esattamente nel file di descrizione.

Il file di descrizione del font (con estensione `.fnt`) può avere linee di commento che iniziano con '`;`'. Il file deve avere una linea nella forma

`image = immagine`
  Dove `immagine` è il nome del file immagine da usare per il font (non devi specificare l'estensione).
`car = X, Y, l, a`
  Qui `X` e `Y` specificano la posizione del carattere `car` nell'immagine (`0,0`) è l'angolo in alto a sinistra). `l` e `a` sono le dimensioni del carattere in pixel.

Questo esempio definisce i caratteri A, B, C usando `font.png`.

    ; Può essere "font" invece di "font.png"
    image = font.png

    ; Tre caratteri sono abbastanza solo per una dimostrazione. :-)
    "A" =  0,0, 7,13
    "B" =  7,0, 7,13
    "C" = 14,0, 7,13

### D.3..1 Simboli

Alcuni caratteri hanno significati speciali quando ritornati da alcune variabili usate in dlabel; questi caratteri vengono visualizzati come simboli in modo che code come il logo DVD possano essere visualizzate invece del carattere 'd'.)

La tabella seguente elenca tutti i caratteri che possono essere usati per visualizzare simboli (e quindi richiedono un font differente).

Carattere | Simbolo
--- | ---
`p` | play
`s` | stop
`e` | pausa
`n` | muto
`m` | suono mono
`t` | suono stereo
`f` | lo stream è un file
`v` | lo stream è un video CD
`d` | lo stream è un DVD
`u` | lo stream è una URL

## D.4 Messaggi della GUI

Questi sono i messaggi che possono essere generati da bottoni, slider e voci del menu.

Nota: alcuni messaggi possono non funzionare come ci si aspetta (o non funzionare del tutto). Come sai, la GUI è in sviluppo.

### Controllo riproduzione:

> evNext
>   Salta alla prossima traccia della playlist.
> evPause
>   Pausa la riproduzione.
> evPauseSwitchToPlay
>   Forma un interruttore logico insieme a `evPlaySwitchToPause`. Possono essere usati per avere un bottone comune di play/pausa. Entrambi i messaggi dovrebbero venire assegnati a bottoni visualizzati nella stessa posizione della finestra. Questo messaggio mette in pausa la riproduzione e viene mostrata l'immagine per il bottone `evPlaySwitchToPause` (ad indicare che il bottone può essere premuto per continuare la riproduzione).
> evPlay
>   Inizia la riproduzione.
> evPlaySwitchToPause
>   L'opposto di `evPauseSwitchToPlay`. Questo messaggio inizia la riproduzione ed è mostrata l'immagine per il bottone `evPauseSwitchToPlay` (ad indicare che il bottone può essere premuto per mettere in pausa).
> evPrev
>   Salta alla traccia precedente nella playlist.
> evStop
>   Ferma la riproduzione.

### Ricerca nello stream:

> evBackward10sec
> evBackward1min
> evBackward10min
>   Per andare indietro di 10 secondi / 1 minuto / 10 minuti.
> evForward10sec
> evForward1min
> evForward10min
>   Per andare avanti di 10 secondi / 1 minuto / 10 minuti.
> evSetMoviePosition
>   Per andare alla posizione (può essere usato da uno slider; è usato il valore relativo (0-100%) dello slider).

### Controllo video:

> evDoubleSize
>   Raddoppia le dimensioni della finestra del filmato.
> evFullScreen
>   Manda a pieno schermo e vice versa.
> evNormalSize
>   Regola la finestra del filmato alle sue dimensioni normali.

### Controllo audio:

> evDecAudioBufDelay
>   Diminuisce il ritardo del buffer audio.
> evDecBalance
>   Diminuisce il bilanciamento.
> evDecVolume
>   Diminuisce il volume.
> evIncAudioBufDelay
>   Aumenta il ritardo del buffer audio.
> evIncBalance
>   Aumenta il bilanciamento.
> evIncVolume
>   Aumenta il volume.
> evMute
>   Regola il suono su muto e vice versa.
> evSetBalance
>   Regola il bilanciamento (può essere usato da uno slider; è usato il valore relativo (0-100%) dello slider).
> evSetVolume
>   Regola il volume (può essere usato da uno slider; è usato il valore relativo (0-100%) dello slider).

### Vari:

> evAbout
>   Apre la finestra "about".
> evDropSubtitle
>   Disabilita il sottotitolo attualmente in uso.
> evEqualizer
>   Accende/spegne l'equalizzatore.
> evExit
>   Esce dal programma.
> evIconify
>   Riduce ad icona la finestra.
> evLoad
>   Carica un file (aprendo una finestra del file browser, dove puoi scegliere un file).
> evLoadPlay
>   Fa la stessa cosa di `evLoad`, ma inizia automaticamente la riproduzione dopo il caricamento del file.
> evLoadSubtitle
>   Carica un file di sottotitolo (con il fileselector)
> evLoadAudioFile
>   Carica un file audio (con il fileselector)
> evNone
>   Messaggio vuoto, non ha nessun effetto. (Eccetto forse nella versione CVS. :-))
> evPlaylist
>   Apre/chiude la finestra della playlist.
> evPlayDVD
>   Prova a leggere il disco nel drive DVD-ROM dato.
> evPlayVCD
>   Prova a leggere il disco nel drive CD-ROM dato.
> evPreferences
>   Apre la finestra delle preferenze.
> evSetAspect
>   Imposta le proporzioni dell'immagine mostrata.
> evSetURL
>   Mostra la finestra di dialogo dell' URL.
> evSkinBrowser
>   Apre la finestra dello skin browser.