B.2. The skin file
Prev | Appendix B. MPlayer skin format | Next

## B.2. The skin file

As mentioned above, this is the skin configuration file. It is line oriented; comments start with a '`;`' character and continue until the end of the line, or start with a '`#`' character at the beginning of the line (in that case only spaces and tabs are allowed before the '`#`').

The file is made up of sections. Each section describes the skin for an application and has the following form:

    section = section name
    .
    .
    .
    end

Currently there is only one application, so you need only one section: its name is movieplayer.

Within this section each window is described by a block of the following form:

    window = window name
    .
    .
    .
    end

where `window name` can be one of these strings:

- main - for the main window

- video - for the video window

- playbar - for the playbar

- menu - for the skin menu

(The video, playbar and menu blocks are optional - you do not need to decorate the video window, have a playbar or create a menu. A default menu is always available by a right mouse button click.)

Within a window block, you can define each item for the window by a line in this form:

    item = parameter

Where `item` is a string that identifies the type of the GUI item, `parameter` is a numeric or textual value (or a list of values separated by commas).

Putting the above together, the whole file looks something like this:

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

      window = video
      ; ... items for video window ...
      end

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

      window = playbar
      ; ... items for playbar ...
      end
    end

The name of an image file must be given without leading directories - images are searched for in the `skins` directory. You may (but you need not) specify the extension of the file. If the file does not exist, MPlayer tries to load the file `<filename>.<ext>`, where `png` and `PNG` are tried for `<ext>` (in this order). The first matching file will be used.

Finally some words about positioning. The main window and the video window can be placed in the different corners of the screen by giving `X` and `Y` coordinates. `0` is top or left, `-1` is center and `-2` is right or bottom, as shown in this illustration:

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

Here is an example to make this clear. Suppose that you have an image called `main.png` that you use for the main window:

    base = main, -1, -1

MPlayer tries to load `main`, `main.png`, `main.PNG` files and centers it.

### B.2.1. Main window and playbar

Below is the list of entries that can be used in the '`window = main`' ... '`end`', and the '`window = playbar`' ... '`end`' blocks.

`decoration = enable|disable`

  Enable or disable window manager decoration of the main window. Default is disable.

  ### Note

  This isn't available for the playbar.

`base = image, X, Y`

  Lets you specify the background image to be used for the main window. The window will appear at the given `X,Y` position on the screen. It will have the size of the image.

  ### Warning

  Transparent regions in the image (colored #FF00FF) appear black on X servers without the XShape extension. The image's width must be dividable by 8.

`button = image, X, Y, width, height, message`

  Place a button of `width` * `height` size at position `X,Y`. The specified `message` is generated when the button is clicked. The image given by `image` must have three parts below each other (according to the possible states of the button), like this:

      +------------+
      |  pressed   |
      +------------+
      |  released  |
      +------------+
      |  disabled  |
      +------------+

  A special value of `NULL` can be used if you want no `image`.

`hpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message`

`vpotmeter = button, bwidth, bheight, phases, numphases, default, X, Y, width, height, message`

`rpotmeter = button, bwidth, bheight, phases, numphases, x0, y0, x1, y1, default, X, Y, width, height, message`

  Place a horizontal (`hpotmeter`), vertical (`vpotmeter`) or rotary (`rpotmeter`) potmeter of `width` * `height` size at position `X,Y`. The image can be divided into different parts for the different phases of the potmeter (for example, you can have a pot for volume control that turns from green to red while its value changes from the minimum to the maximum). All potentiometers can have a button that can be dragged with a `hpotmeter` and `vpotmeter`. A `rpotmeter` can be spun even without a button. The parameters are:

  - `button` - the image to be used for the button (must have three parts below each other, like in case of button). A special value of `NULL` can be used if you want no image.

  - `bwidth`, `bheight` - size of the button

  - `phases` - the image to be used for the different phases of the potentiometer. A special value of `NULL` can be used if you want no such image. The image must be divided into `numphases` parts below each other (resp. side by side for `vpotmeter`) like this:

        +------------+
        |  phase #1  |                vpotmeter only:
        +------------+
        |  phase #2  |                +------------+------------+     +------------+
        +------------+                |  phase #1  |  phase #2  | ... |  phase #n  |
             ...                      +------------+------------+     +------------+
        +------------+
        |  phase #n  |
        +------------+

  - `numphases` - number of phases stored in the `phases` image

  - `x0`, `y0` and `x1`, `y1` - position of the 0% start point and 100% stop point for the potentiometer (`rpotmeter` only)

    The first coordinate `x0,y0` defines the 0% start point (on the edge of the potentiometer) in the individual image of phase #1 and the second coordinate `x1,y1` the 100% stop point in the individual image of phase #n - in other words, the coordinates of the tip of the mark on the potentiometer in the two single images (not in the image of all phases).

  - `default` - default value for the potentiometer (in the range `0` to `100`)

    (If message is `evSetVolume`, it's allowed to use a plain hyphen-minus as value. This will cause the currently set volume to remain unchanged.)

  - `X`, `Y` - position for the potentiometer

  - `width`, `height` - width and height of the potentiometer

  - `message` - the message to be generated when the value of the potentiometer is changed

`pimage = phases, numphases, default, X, Y, width, height, message`

  Place different phases of an image at position `X,Y`. This element goes nicely with potentiometers to visualize their state. `phases` can be `NULL`, but this is quite useless, since nothing will be displayed then. For a description of the parameters see hpotmeter. There is only a difference concerning the message:

  - `message` - the message to be reacted on, i.e. which shall cause a change of `pimage`.

`font = fontfile`

  Defines a font. `fontfile` is the name of a font description file with a `.fnt` extension (do not specify the extension here) and is used to refer to the font (see dlabel and slabel). Up to 25 fonts can be defined.

`slabel = X, Y, fontfile, "text"`

  Place a static label at the position `X,Y`. `text` is displayed using the font identified by `fontfile`. The text is just a raw string (`$x` variables do not work) that must be enclosed between double quotes (but the " character cannot be part of the text). The label is displayed using the font identified by `fontfile`.

`dlabel = X, Y, width, align, fontfile, "text"`

  Place a dynamic label at the position `X,Y`. The label is called dynamic because its text is refreshed periodically. The maximum width of the label is given by `width` (its height is the height of a character). If the text to be displayed is wider than that, it will be scrolled, otherwise it is aligned within the specified space by the value of the `align` parameter: `0` is for left, `1` is for center, `2` is for right.

  The text to be displayed is given by `text`: It must be written between double quotes (but the " character cannot be part of the text). The label is displayed using the font identified by `fontfile`. You can use the following variables in the text:

  Variable | Meaning
  --- | ---
  $1 | elapsed time in hh:mm:ss format
  $2 | elapsed time in mmmm:ss format
  $3 | elapsed time in hh format (hours)
  $4 | elapsed time in mm format (minutes)
  $5 | elapsed time in ss format (seconds)
  $6 | running time in hh:mm:ss format
  $7 | running time in mmmm:ss format
  $8 | elapsed time in h:mm:ss format
  $v | volume in xxx.xx% format
  $V | volume in xxx.x format
  $U | volume in xxx format
  $b | balance in xxx.xx% format
  $B | balance in xxx.x format
  $D | balance in xxx format
  $$ | the $ character
  $a | a character according to the audio type (none: n, mono: m, stereo: t, surround: r)
  $t | track number (DVD, VCD, CD or playlist)
  $o | filename
  $O | filename (if no title name available) otherwise title
  $f | filename in lower case
  $F | filename in upper case
  $T | a character according to the stream type (file: f, CD: a, Video CD: v, DVD: d, URL: u, TV/DVB: b, CUE: c)
  $P | a character according to the playback state (stopped: s, playing: p, paused: e)
  $p | the p character (if a movie is playing)
  $s | the s character (if the movie is stopped)
  $e | the e character (if playback is paused)
  $g | the g character (if ReplayGain is active)
  $x | video width
  $y | video height
  $C | name of the codec used

  ### Note

  The `$a, $T, $P, $p, $s` and `$e` variables all return characters that should be displayed as special symbols (for example, e is for the pause symbol that usually looks something like ||). You should have a font for normal characters and a different font for symbols. See the section about symbols for more information.

### B.2.2. Video window

The following entries can be used in the '`window = video`' . . . '`end`' block.

`base = image, X, Y, width, height`

  The image to be displayed in the window. The window will be as large as the image. `width` and `height` denote the size of the window; they are optional (if they are missing, the window is the same size as the image). A special value of `NULL` can be used if you want no image (in which case `width` and `height` are mandatory).

`background = R, G, B`

  Lets you set the background color. It is useful if the image is smaller than the window. `R`, `G` and `B` specifies the red, green and blue component of the color (each of them is a decimal number from 0 to 255).

### B.2.3. Skin menu

As mentioned earlier, the menu is displayed using two images. Normal menu entries are taken from the image specified by the `base` item, while the currently selected entry is taken from the image specified by the `selected` item. You must define the position and size of each menu entry through the menu item.

The following entries can be used in the '`window = menu`'. . .'`end`' block.

`base = image`

  The image for normal menu entries.

`selected = image`

  The image showing the menu with all entries selected.

`menu = X, Y, width, height, message`

  Defines the `X,Y` position and the size of a menu entry in the image. `message` is the message to be generated when the mouse button is released over the entry.

Prev | Up | Next
B.1. Overview | Home | B.3. Fonts