Dodate D - Format skórek MPlayera

Celem tej dokumentacji jest opisanie formatu skór MPlayera. Informacje zawarte w tym dokumencie mogą być błędne, ponieważ:

1. To nie ja napisałem GUI.
2. GUI nie jest skończone.
3. Mogę się mylić.

Więc nie bądź zaskoczony jeżeli coś nie będzie działało w sposób w jaki zostało tutaj opisane.

Podziękowania dla Zoltán Ponekker za jego pomoc.

András Mohari <mayday@freemail.hu>

D.1 Przedmowa

To nie ma tak naprawdę żadnego związku z formatem skór, ale powinieneś wiedzieć, że MPlayer nie ma wbudowanej skórki, więc musisz mieć zainstalowaną chociaż jedną skórę, aby mieć możliwość używania GUI.

D.1.1 Katalogi

Katalogi przeszukiwane przez MPlayera w poszukiwaniu skór to (w kolejności szukania):

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

Zauważ, że pierwsza ścieżka może być zależna od tego, jak MPlayer został skonfigurowany podczas kompilacji (zobacz argumenty --prefix i --datadir skryptu configure).

Każda skórka jest zainstalowana w swoim własnym katalogu znajdującym się w jednym z folderów wymienionych powyżej, na przykład:

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

D.1.2 Formaty obrazków

Obrazki muszą to być PNG z głębią kolorów truecolor (24, albo 32 bity).

W głównym oknie i w pasku odtwarzania (zobacz niżej) możesz używać obrazków z 'przeźroczystością': obszary wypełnione przy użyciu koloru #FF00FF (magenta) są dla MPlayera w pełni przeźroczyste. Oznacza to, że możesz używać dowolnych kształtów okna głównego, jeżeli twój X serwer posiada rozszerzenie XShape.

D.1.3 Części skórki

Skórki są całkowicie konfigurowalne (w przeciwieństwie np. do skór Winampa/XMMS) (chodzi o to, że możesz umieścić dowolny przycisk np. 'play' w dowolnym miejscu swojej skóry, format XMMSa i Winampa ma z góry ustalone położenie każdego elementu i nie można tego zmienić - przyp. tłumacza), więc tylko od ciebie zależy, czy stworzysz coś naprawdę fajnego.

Na dzień dzisiejszy są trzy okna do skonfigurowania: okno główne (main window), okno ekranu (subwindow), pasek odtwarzania (playbar) oraz menu skóry (skin menu) (które może zostać uaktywnione poprzez naciśnięcie prawego przycisku myszy).

• Okno główne i/lub pasek odtwarzania to okno w którym kontrolujesz MPlayera. Tło tego okna jest obrazkiem. Różne elementy mogą (i muszą) być umieszczone w tym oknie: przyciski (buttons), potencjometry (suwaki, ang. potmeters, sliders) i etykiety (labels). Dla każdego elementu musisz określić jego pozycję oraz rozmiar.

  Przycisk ma trzy fazy (wciśnięty, uwolniony oraz nieaktywny), więc ich obrazki muszą być podzielone na trzy części w pionie. Zobacz sekcję przyciski, aby uzyskać więcej informacji.

  Potencjometry (zazwyczaj używane do określania pozycji filmu (seek bar) oraz do kontroli głośności/balansu dźwięku) mogą posiadać dowolną liczbę faz poprzez podzielenie jego obrazka na części, gdzie następna faza jest poniżej poprzedniej. Zobacz sekcję hpotmeter i potmeter, aby dowiedzieć się więcej na ten temat.

  Etykiety są bardzo specyficzne: znaki służące do ich opisania są brane z poliku graficznego, a litery, które są w nim zawarte w pliku graficznym są opisane przez plik opisujący fonty. Jest to plik tekstowy, który określa pozycję x, y oraz rozmiar każdego symbolu znajdującego się w obrazku (a więc "plik graficzny z fontami" i "plik opisujący fonty" tworzą razem fonty). Zobacz dlabel i slabel, po więcej szczegółów.

  Informacja: wszystkie obrazki mogą posiadać przeźroczystość tak, jak opisano to w sekcji formaty plików graficznych. Jeżeli serwer X nie obsługuje rozszerzenia XShape, część oznaczona jako przezroczysta, będzie czarna. Jeżeli chcesz używać tej funkcji, szerokość obrazka tła głównego okna musi być podzielna przez 8.

• Okno ekranu - tutaj pojawia się film podczas odtwarzania. Może ono wyświetlać określony obrazek jeżeli nie jest w danym momencie odgrywany żaden film (to dość nudne mieć puste okno :-)) Informacja: przeźroczystość jest tutaj niedostępna.

• # menu skóry to po prostu jeden ze sposobów do kontrolowania MPlayera poprzez polecenia z menu. Wymagane są tutaj dwa obrazki: pierwszy z nich jest podstawowym obrazkiem pokazującym menu w "normalnym" stanie, drugi natomiast jest używany do wyświetlania wybranych elementów. Kiedy aktywujesz menu pokazywany jest pierwszy obrazek. Kiedy najeżdżasz kursorem na którąś z pozycji, jej zaznaczenie jest kopiowane z drugiego obrazka na obszar menu znajdujący się pod wskaźnikiem myszy (a więc drugi obrazek nigdy nie jest pokazany w całości).

  Obszar menu znajdujący się pod kursorem jest zdefiniowany poprzez jego pozycję i rozmiar w obrazku (zobacz sekcję menu skóry aby dowiedzieć się więcej na ten temat).

Jest jeszcze jedna ważna rzecz, która nie została jeszcze wspomniana: dla przycisków, potencjometrów i obszarów menu, MPlayer musi wiedzieć co ma zrobić jeżeli zostaną one kliknięte. Zajmują się tym sygnały (zdarzenia). Dla wszystkich tych elementów muszą być zdefiniowane sygnały, które mają zostać wywołane po naciśnięciu przycisku myszy.

D.1.4 Pliki

Aby stworzyć skórę będziesz potrzebował następujących plików:

• Plik konfiguracyjny o nazwieskin, który informuje MPlayera w jaki sposób łączyć ze sobą poszczególne części skóry i co ma zrobić kiedy klikasz gdziesz w obszarze okna.
• Obrazek Tła do głównego okna.
• Obrazki dla elementów okna głównego (włączając w to jeden, albo więcej plików opisujących fonty potrzebnych do wyświetlania etykiet).
• Obrazek który ma być wyświetlony w oknie ekranu (opcjonalnie).
• Dwa obrazki do menu skóry (są one potrzebne tylko jeśli chcesz stworzyć takie menu).

Poza plikiem konfiguracyjnym skóry, możesz nazwać wszystkie inne pliki jak tylko chcesz (ale pamiętaj, że plik opisujący fonty musi mieć rozszerzenie .fnt).

D.2 Plik skin

Jak wspomniano powyżej jest to plik konfigurujący skórę. Potrafi on rozpoznawać typy wierszy: wiersze komentarza rozpoczyna średnik, czyli ';' (przed nim mogą znajdować się tylko spacje, lub znaki tabulacji).

Plik podzielony jest na sekcję. Każda z nich opisuje poszczególny element skóry dla każdej z aplikacji i ma następującą postać:

section = section name
.
.
.
end

Na dzień dzisiejszy istnieje tylko jedna aplikacja, więc potrzebujesz tylko jednej sekcji: jej nazwa to movieplayer (odtwarzacz filmów).

W tej sekcji każde z okien jest opisane poprzez dany blok w taki sposób:

window = window name
.
.
.
end

gdzie window name może być jednym z następujących ciągów znaków:

• main - dla głównego okna
• sub - dla okna ekranu
• menu - dla menu skóry
• playbar - pasek odtwarzania

(wpisy sub i menu są opcjonalne - nie musisz tworzyć menu, ani dekorować okna ekranu jeżeli nie chcesz.)

W każdym z bloków możesz zdefiniować poszczególne elementy (items) dla danego okna w sposób przedstawiony poniżej:

item = parameter

Gdzie item jest ciągiem znaków identyfikującym typ danego elementu GUI, parametr jest numeryczną, lub tekstową wartością (lub listą wartości oddzieloną przecinkami).

Łącząc to wszystko ze sobą, uzyskujemy plik wyglądający mniej więcej tak:

section = movieplayer
  window = main
  ; ... elementy dla okna głównego ...
  end
  
  window = sub
  ; ... elementy dla okna ekranu ...
  end
  
  window = menu
  ; ... elementy dla menu skóry ...
  end

  window = playbar
  ; ... elementy dla paska odtwarzania ...
  end
end

Nazwa obrazk musi być podana bez żadnych głównych katalogów - obrazki są poszukiwane w katalogu ze skórką. Możesz (ale nie musisz) podać rozszerzenie plików. Jeżeli plik nie istnieje, MPlayer próbuje załadować plik <nazwa pliku>.<rozszerzenie>, gdzie png i PNG są próbowane jako <rozszerzenie> (w tej kolejności). Wykorzystany zostanie pierwszy pasujący plik.

Na koniec kilka słów o pozicjonowaniu. Główne okno i okno ekranu mogą być umieszczone w różnych narożnikach ekranu poprzez podanie parametrów X i Y. 0 jest górą lub lewą stroną, -1 wyśrodkowuje, a -2 jest dołem lub prawą stroną, jak pokazano na ilustracji:

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

D.2.1 Okno główne i pasek odtwarzania

Poniżej możesz zobaczyć listę elementów, które mogą być użyte w bloku 'window = main' . . . 'end', i w 'window = playbar'  . . 'end'.

base = obrazek, X, Y

Pozwala ci określić obrazek tła, który ma zostać użyty w głównym oknie. Okno to pojawi się w określonej przez x,y pozycji na ekranie. Okno to będzie rozmiarów obrazka tła.

Informacja: Te parametry narazie nie działają dla okna ekranu.

Ostrzeżenie: przeźroczyste obszary w obrazku (kolor #FF00FF) pojawiają się jako czarny kolor w X serwerach, które nie obsługują rozszerzenia XShape.

button = obrazek, X, Y, szerokość, wysokość, sygnał

Umieszcza przycisk o rozmiarze szerokość * wysokość na pozycji X,Y. Określony sygnał jest generowany, kiedy przycisk zostanie kliknięty. Obrazek określony przez obrazek musi być podzielony na trzy części umieszczone jedna pod drugą (podzielony według możliwych faz przycisku), w ten sposób:

+------------+
| wciśnięty  |
+------------+
| uwolniony  |
+------------+
| nieaktywny |
+------------+

decoration = enable|disable

Włącza, lub wyłącza dekoracje okna (pasek tytułowy) twojego menadżera okien Domyślnie jest to wyłączone.

Informacja: Nie działa z oknem ekranu, opcja nie jest wymagana.

hpotmeter = przycisk, szer_przycisku, wys_przycisku, fazy, liczbafaz, domyślna, X, Y, szerokość, wysokość, sygnał
vpotmeter = przycisk, szer_przycisku, wys_przycisku, fazy, liczbafaz, domyślna, X, Y, szerokość, wysokość, sygnał

Umieszcza poziomy (hpotmeter) lub pionowy (vpotmeter) potencjometr o rozmiarach szerokość * wysokość na pozycji X,Y. Obrazek może być podzielony na różne części dla różnych faz potencjometru (np. możesz mieć potencjometr głośności, który zmienia się z zielonego na czerwony podczas zmiany głośności z minimalnej do maksymalnej). hpotmeter może mieć przycisk który jest przesuwany w poziomie.

Parametry to:

• przycisk - obrazek który ma być użyty jako suwak (musi mieć trzy części umieszczone jedna pod drugą, tak jak w przypadku przycisku)
• szer_przycisku, wys_przycisku -rozmiar suwaka
• fazy - obrazek, który ma być użyty dla różnych faz hpotencjometru. Specjalna wartość NULL może być użyta, jeżeli nie chcesz żadnego obrazka. Obrazek musi być podzielony w pionie na liczbęfaz, w ten sposób:

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

• liczbafaz - liczba faz znajdująca się w obrazku z fazami
• domyślna - domyślna wartość dla hpotencjometru (w przedziale od 0 do 100)
• X, Y - pozycja hpotencjometru
• szerokość, wysokość - szerokość i wysokość hpotnecjometru
• sygnał - sygnał który ma być wywołany, kiedy zmienia się wartość hpotnecjometru

potmeter = fazy, liczbafaz, domyślna, X, Y, szerokość, wysokość, sygnał

Potencjometr bez suwaka. (Myślę, że chodzi tu o to żeby nim kręcić, ale reaguje on tylko na poziome przesuwanie.) Aby zobaczyć opis parametrów zobacz hpotmeter. fazy mogą mieć wartość NULL, ale jest to bezużyteczne, jeżeli nie możesz zobaczyć gdzie znajduje się potencjometr.

font = plikfontów, fontid

Definiuje fonty. fontfile jest nazwą pliku opisującego fonty z rozszerzeniem .fnt nie trzeba tu określać rozszerzenia). fontid jest używany do odsyłania się do danego fonta (zobacz dlabel i slabel). Możesz określić ponad 25 znaków.

slabel = X, Y, fontid, "text"

Umieszcza statyczną etykietę na pozycji X,Y. text jest wyświetlany używając fontid. Text jest po prostu nieprzetworzonym ciągiem znaków (zmienne $x nie działają) który musi znajdować się w cudzysłowiu (" nie może być częścią tekstu). Etykieta jest wyświetlana używając fontid.

dlabel = X, Y, długość, align, fontid, "text"

Umieszcza dynamiczne etykiety na pozycji X,Y. Etykieta nazywana jest dynamiczną, ponieważ tekst w niej jest regularnie odświeżany. Maksymalna długość etykiety jest ustalona przez długość przez label is called dynamic because its text is refreshed periodically. The maximum length of the label is given by length (jej wysokość jest wysokością fontów). Jeżeli tekst który ma być wyświetlony jest dłuższy od tej wartości, wtedy będzie on przewijany, w innym przypadku będzie on wyrównany do określonej przez align (wyrównanie) przestrzeni. 0 dla wyrównania do prawej, 1 dla wyśrodkowania, 2 dla wyrównania do lewej.
Tekst, który ma zostać wyświetlony jest określony przez text: musi być on opisany w cudzysłowiu (ale " nie może być częścią tekstu). Etykieta jest wyświetlana używając fontid. Możesz użyć poniższych zmiennych w tekście:

Zmienna	Znaczenie
$1	play time in hh:mm:ss format
$2	odtwarza czas w formacie mmmm:ss
$3	odtwarza czas w formacie hh (godziny)
$4	odtwarza czas w formacie mm (minuty)
$5	odtwarza czas w formacie ss (sekundy)
$6	wyświetla długość filmu w formacie hh:mm:ss
$7	wyświetla długość filmu w formacie mmmm:ss
$8	odtwarza czas w formacie h:mm:ss
$v	głośność w formacie xxx.xx%
$V	głośność w formacie xxx.x
$b	balans w formacie xxx.xx%
$B	balans w formacie xxx.x
$$	znak $
$a	znak określający typ dźwięku (żaden: n, mono: m, stereo: t)
$t	Numer ścieżki (w playliście)
$o	>nazwa pliku
$f	nazwa pliku małymi literami
$F	nazwa pliku dużymi literami
$T	znak określający typ strumienia (plik: f, Video CD: v, DVD: d, URL: u)
$p	znak "p" (jeżeli film jest odgrywany i font ma określony symbol "p")
$s	znak "s" (jeżeli film jest zatrzymany i font ma określony symbol "s")
$e	znak "e" (jeżeli włączona jest pauza i font ma określony symbol "e")
$x	szerokość filmu
$y	wysokość filmu
$C	nazwa użytego kodeka

Informacja: Zmienne $a, $T, $p, $s i $e mają znaki które powinny być wyświetlane jako znaki specjalne (np. "e" jest symbolem pauzy wyglądającym zazwyczaj tak ||). Powinieneś mieć fonty dla normalnych znaków i osobne dla znaków specjalnych. Zobacz sekcję symbole, aby dowiedzieć się więcej.

D.2.2 Okno ekranu

Poniżej możesz zobaczyć listę elementów, które mogą być użyte w bloku 'window = sub' . . . 'end'.

base = obrazek, X, Y, szerokość, wysokość

Obrazek który ma być wyświetlony w tym oknie. Okno pojawi się w określonej przez ciebie pozycji X,Y na ekranie(0,0 umieszcza obrazek w lewym górnym rogu). Możesz tu użyć także następujących wartości: -1 dla wyśrodkowania, -2 dla wyrównania do prawej (dla wartości X) i do dołu (dla wartości Y). Okno to będzie rozmiarów obrazka. szerokość i wysokość określa rozmiar okna. Te zmienne są opcjonalne (jeżeli ich nie będzie, okno będzie takich samych rozmiarów jak obrazek).

background = R, G, B

Pozwala ci ustalić kolor tła. Jest to przydatne jeżeli obrazek jest mniejszy od okna. R, G i B określają czerwoną, zieloną i niebieską wartość koloru (każda z nich jest określona w przedziale od 0 do 255).

D.2.3 Menu Skóry

Jak wspomnianow wcześniej, menu jest wyświtlane przy użyciu dwóch obrazków. Normalny stan menu jest brany z obrazka określonego jako base, podczas gdy zaznaczony obszar jest brany z obrazka określonego jako selected. Musisz zdefiniować pozycję i rozmiar każdego z elementów menu poprzez element menu.

Te elementy mogą zostać wykorzystane w bloku 'window = menu' . . . 'end'.

base = obrazek

Obrazek pokazujący normalny stan menu.

selected = obrazek

Obrazek pokazujący zaznaczony stan menu.

menu = X, Y, szerokość, wysokość, sygnał

Definiuje pozycję X,Y i rozmiar poszczególnych elementów menu w obrazku. sygnał jest sygnałem, który ma być uaktywniony, kiedy klikniesz tą pozycję.

D.3 Fonty

Tak jak wspomniano w sekcji o częściach skóry, fonty są zdefiniowane przez obrazek i plik opisujący fonty. Możesz umieścić znaki w dowolnym miejscu obrazka, ale upewnij się, że ich pozycja i rozmiar są dokładnie określone w pliku opisującym fonty.

Plik opisujący fonty (z rozszerzeniem .fnt) może mieć linie komentarza rozpoczęte średnikiem ';'. Plik musi mieć tę linie w formacie:

image = obrazek

gdzie obrazek jest nazwą pliku w którym znajdują się fonty (nie musisz podawać rozszerzenia).

"znak" = X, Y, szerokość, wysokość

Tutaj X i Y określają pozycję znaku w obrazku (0,0 to lewy górny róg). szerokość i wysokość wymiary znaku w pikselach.

Poniżej możesz zobaczyć przykład definiujący znaki A, B, C znajdujące się w pliku font.png:

; może być "font" zamiast "font.png".
image = font.png

; Trzy znaki są wystarczające, aby zademonstrować jak to działa. :-)
"A" =  0,0, 7,13
"B" =  7,0, 7,13
"C" = 14,0, 7,13

D.3.1 Symbole

Niektóre znaki mają specjalne znaczenia kiedy są zmiennymi używanymi w dlabel. Te znaki są wyświetlane jako symbole co oznacza, że kiedy odgrywasz strumień DVD, możesz wyświetlić fajne logo DVD zdefiniowane pod znakiem 'd'.

Poniższa tabelka zawiera wszystkie znaki, które mogą być wykorzystane do wyświetlania symboli (i wymagają one osobnych fontów).

D.4 Sygnały GUI

Tutaj znajdują się sygnały które mogą zostać wywołane przez przyciski, potencjometry i elementy menu.

Informacja: Niektóre z sygnałów mogą działać nieprawidłowo (albo w ogóle nie działać). Jak wiesz, GUI jest ciągle w fazie rozwoju.

Opcje odgrywania:

evNext

Przeskakuje do następnej ścieżki z playlisty.

evPause

Wstrzymuje odgrywanie.

evPauseSwitchToPlay

Przełącza między sobą użuwając evPlaySwitchToPause. Może to zostać wykorzystane aby utworzyć jeden przycisk spełniający równocześnie funkcje odgrywania i pauzy. Oba sygnały powinny być przydzielone do przycisków wyświetlanych w tym samym miejscu w oknie. Ten sygnał wstrzymuje odtwarzanie i wyświetlany jest obrazek dla przycisku evPlaySwitchToPause (aby zaznaczyć, że ten przycisk może być wciśnięty, aby kontynuować odgrywanie).

evPlay

Rozpoczyna odgrywanie.

evPlaySwitchToPause

Przeciwieństwo evPauseSwitchToPlay. Ten sygnał rozpoczyna odgrywanie i wyświetlany jest obrazek dla przycisku evPauseSwitchToPlay (aby zaznaczyć, że ten przycisk może być wciśnięty, aby wstrzymać odgrywanie).

evPrev

Przeskakuje do poprzedniej ścieżki z playlisty.

evStop

Zatrzymuje odgrywanie.

Przeszukiwanie:

evBackward10sec

evBackward1min

evBackward10min

Przeskakuje w tył o 10 sekund / 1 minutę / 10 minut.

evForward10sec

evForward1min

evForward10min

Przeskakuje w przód o 10 sekund / 1 minutę / 10 minut.

evSetMoviePosition

Ustawia pozycję (może być zmieniane za pomocą suwaka; wykorzystywane są relatywne (0-100%) wartości potencjometru).

Kontrola obrazu:

evDoubleSize

Ustawia podwójny rozmiar okna z filmem.

evFullScreen

Włącza/wyłącza tryb pełnoekranowy.

evNormalSize

Ustawia oryginalny rozmiar okna z filmem.

Kontrola Dźwięku:

evDecAudioBufDelay

Zmniejsza opóźnienie buffera dźwięku.

evDecBalance

Zmniejsza balans.

evDecVolume

Zmniejsza głośność.

evIncAudioBufDelay

Zmniejsza opóźnienie buffera dźwięku.

evIncBalance

Zwiększa balans.

evIncVolume

Zwiększa głośność.

evMute

Wycisz/włącz dźwięk.

evSetBalance

Ustawia balans (może być używane przez suwak; wykorzystywane są relatywne (0-100%) wartości potencjometru).

evSetVolume

Ustawia głośność (może być używane przez suwak; wykorzystywane są relatywne (0-100%) wartości potencjometru).

Różne:

evAbout

Otwiera okno "o programie".

evDropSubtitle

Wyłącza aktualnie używane napisy.

evEqualizer

Włącza/wyłącza equalizer.

evExit

Zamyka program.

evIconify

Minimalizuje okno.

evLoad

Wczytuje plik (poprzez otwarcie przeglądarki plików, w której możesz wybrać plik).

evLoadPlay

Robi dokładnie to samo co evLoad z tym, że po wczytaniu pliku automatycznie rozpoczyna jego odtwarzanie.

evLoadSubtitle

Wczytuje plik napisów (poprzez otwarcie przeglądarki plików)

evLoadAudioFile

Wczytuje plik z dźwiękiem (poprzez otwarcie przeglądarki plików)

evNone

Pusty sygnał, nic nie robi. (No może nie dotyczy to wersji CVS :-)).

evPlayList

Otwiera/zamyka okno playlisty.

evPlayDVD

Próbuje otworzyć dysk z podanej stacji DVD-ROM.

evPlayVCD

Próbuje otworzyć dysk z podanej stacji CD-ROM.

evPreferences

Otwiera okno preferencji.

evSetAspect

Ustawia stosunek obrazu (aspekt).

evSetURL

Wyświetla okno dialogowe, gdzie podaje się URL.

evSkinBrowser

Otwiera okno z przeglądarką skórek.