Foobar2000:Components 0.9/Panel Stack Splitter (foo uie panel splitter)

From Hydrogenaudio Knowledgebase
Jump to: navigation, search

Panel Stack Splitter is a ColumnsUI extension for advanced placement and scripting of panels. It functions as a splitter in the ColumnsUI panel hierarchy (i.e., it can contain other panels).


Function and Use

Panel Stack Splitter is an extension for ColumnsUI which allows for greater control over the arrangement of panels. Not only can any panel be positioned freely within the Foobar2000 window, but the splitters themselves can be scripted, the panels can be resized using the cursor or by scripted actions, and panels can be hidden and displayed according to your script. It includes functions which make it easy to create graphical buttons and dynamic layouts. It can replace any number of more specific panels, such as those intended for displaying album art or track information.

Common uses include the creation of interfaces which reconfigure themselves automatically depending on the window size, panel-switching arrangements, and of course, all manner of window dressing. It's often used alongside other plugins such as ELPlaylist and WSH Panel to construct elaborate custom interfaces, but be warned that the results of such efforts are, unlike Foobar2000 itself, not always efficient or stable.


Panel Splitter was written by ssenna, who is also the author of ELPlaylist. Many of the functions are similar and both plug-ins work well together.



The following documentation is an imperfect translation and adaptation from the original Japanese readme. Until the page has been more thoroughly re-written, expect some confusing passages.


After installing the plug-in, in the options dialog under ColumnsUI's Layout tab you'll be able to add a Panel Stack Splitter to your layout and configure it. Once you've added a Panel Stack Splitter you can also edit it by right-clicking the panel and choosing Configure from the context menu. The relationship between Panel Stack Splitters and the resulting layout may initially be confusing. In theory, one could place all their panels under a single Panel Stack Splitter to achieve any layout, but in practice you will generally want to employ them more like traditional horizontal and vertical splitters, nesting hierarchically.

Splitter Settings dialog

The Splitter Settings dialog has four tabs, PanelList, Script, Behavior and Global variables.

PanelList shows subordinate panels and allows you to define their names, positions and sizes. Script allows you to script the Splitter panel itself; this is where you would define buttons, text to display, or scripts which alter the layout or operate invisibly. Behavior presents options related to how the Splitter is rendered and how it executes scripts, and Global variables lets you view and delete currently active global variables.


You can't add subordinate panels from this tab -- for this you must return to the ColumnsUI layout options. But once you've added panels, you can select them from the left box in this tab and define their display parameters at the right. Note that there is one option on this tab which is for the Splitter itself rather than its children; this is Panel placement mode, which allows you to select horizontal or vertical position. This parameter is irrelevant for forced layouts.

All fields accept numbers as pixel positions and widths by default, though you can switch to percentage values instead when in forced mode. You can use Titleformatting Script in all of these fields, which is often important for forced layouts if you want them to be resizeable.

This allows you to assign a unique name to the panel in question. In addition to providing a convenient label for the panel for when you're editing, this allows you make direct reference to the panel is scripts later on, for example if you wanted to display, hide or resize it.
Defines the size of the panel, but only if you are using a non-forced layout. Size means width when in horizontal panel placement mode and height when in vertical panel placement mode.
These values define padding between the edges of the panel's allotted space (size) and the actual panel.
Lock size 
This disables the user from resizing the panel using the mouse. Only applies to non-forced layout mode; in forced-layout mode this is already default. The original documentation provides further details about this option, including a caveat that seems to address the possibility of blurred pixels, but the auto-translation is garbled.
Forced layout 
This option allows you to directly determine the position and size of a panel. Turning it on disables Size and (by default) padding and makes panel placement mode irrelevant. Panels can even overlap, though you generally would only want to do this if you intend to provide a way to switch between them. Left and Right are measurements from the upper-left (0,0) of the panel.
  • Title Formatting script is enabled and you can use %_width% and %_height% to call the current width and height of the Splitter itself.
  • If two panels overlap, by default the one that renders in front is determined by the sequence of panels as defined in the ColumnsUI options. [?]
  • Example. This would always expand the panel to the width of the splitter minus 400 pixels:
       Width: $sub(%_width%,400)
  • Example. This would make the panel always fill the lower half of the available space:
       Top: $div(%_height%,2)
       Height: $div(%_height%,2)
Use percentage value 
This option makes Panel Splitter interpret the values in Left, Top, Width and Height as percentages of available space instead of pixel measurements. Thus the second example above could be written as Top: 50 and Height: 50.
Enable padding settings
This option re-enables the padding values defined for non-forced-layout mode. Though this may seem redundant when you can simply include the padding in your position and size values, it may be useful for percentage-based layouts.
Ignore panel size limits 
This seems to be undocumented, but allows for sizes lower or higher than default caps. For example, the seekbar will display as 20px high if any value below 20px is entered into the Height field unless this box is checked.
Hide panel on startup 
This rather straight-forward option does precisely what its name indicates. To later make the panel visible, you would use a script function such as $showpanel_c.

Script Tab

titleformat mode on startup: when you start the TitleFormat PerTrack modes.

  • now playing TF play that track
  • follow cursor on the selected tracks in playlist
  • last mode at the end of the previous mode (the switch mode button to save)

  • title formatting script:

Titleformat here to describe, and decorative backgrounds. However, the child is on the panel can not be drawn.

Extended Command Reference Sensitive argument, or optional, and not implemented. Note: Do not waste the space. (Carriage return accepted)

in title formatting script is evaluated,

  • Today
  • Per Track: track and play and play·When the user changes the size of the state changed when paused. Function when the REFRESH button.
  • Per Second: second, when a change in the state play in the function when the REFRESH button.


  • Per Second, especially that not only can handle high-stress functions.
  • GDI is recommended that you use the drawing functions.

Behaviour Tab

  • use background color: the color specified, the background fill.
  • use image: specify a fixed background image. TitleFormatting is disabled.
  • pseudo transparent: splitter to simulate a transparent background. (splitter and if you use the nest)


  • ColumnsUI in the panel is to present the panel with the transparent background feature, use background color or use image backgrounds are often not transparent and does not use the panel.

Global variables Tab



Returns the width of the Splitter


Returns the height of the Splitter


TF mode returns. (Per Track when enabled)

  • 0 nowplaying mode
  • 1 follow cursor mode


Whether during playback


Whether suspended


Foobar2000 executable path


User profile path


Returns the playback order. However, playback order can not be immediately reflected in the change.(REFRESH commands are required)


TF mode returns state of the player, whether a track is present or not.

  • 0 no error
  • 1 no track
  • 2 dummy track (for mainly legacy metadb_display_hook API)



Valid only if there is no global variable name specified.

All global variables are shared between each of the TF although the PanelStackSplitter evaluation order is undefined. Persistency = 1 variable is set, $delete_ps_gobal you use will be saved until you delete from the settings dialog. $Init_ps_global(name,value) is, $if($get_ps_global(name),,$set_ps_global(name,value)) and almost equivalent.


Persistency - whether to save at the end.

  • 0 not saved on exit
  • 1 saved on exit (default)

$init_ps_global(NAME,VALUE,0) implies that the global variable "NAME" is deleted when quitting foobar2000.


$get_ps_global(name) or  %name%



Font settings.

  • OPTIONS: bold italic underline strikeout
  • Example: $font(Tahoma,10,bolditalic)


Draws a string at the coordinates (x,y). The size of the text field is defined by width (W) and height (H).

Note: This function is a string and there is also a GDI version of the same functions available $drawtext and $drawtextex. This function might work for TrueType fonts, only.

OPTIONS: Align specified, the specified quality of drawing, and to specify the clip.

  • Align: left hcenter right specified horizontal
  • Align: specified top vcenter bottom vertical
  • nowrap: disables text wrap
  • noaa: ClearType and disable anti-aliasing.
  • aa: put the anti-aliasing mode. ClearType font such as resistance to the anti-aliasing.
  • hq: high quality rendering mode. ClearType mode. (default)
  • glow_aa glow option to use a special mode. (noaa, aa, hq exclusive)
  • trimchar and trimword: Trimming of the text to fit the display range
  • elipchar and elipword: Shortens the text to fit the the display range. If set the end of the line will be replaced with "···"
  • mempos getlastpos: to be able to get the coordinates of the drawing

OPTIONS2 - specifying the glow effect (experimental stage):

  • glow:expand:colour[:strength]: glow options
    • Expand - [0-5]
    • Colour - r-g-b
    • Strength - [0-3] glow_aa case of disabled


  • X - glow in the horizontal offset
  • Y - glow in the vertical offset

Glow is a heavy process. (Especially the pseudo transparent)

  • glow_aa be used only when the specified
  • outline: colour color draws a thin border of the specified character (if glow_aa)
  • Colour r-g-b
  • semibold to the characters a little thick (if glow_aa)

These specifications may be changed. Changes in the glow, especially drawing, and semibold outline and may be discontinued.


  • $drawstring(abcd,10,10,,,255-128-64-128,)
  • $drawstring(abcd,10,10,,,255-128-64-128,leftvcenter,glow:2:255-255-255)
  • $drawstring(efgh,10,10,,,255-255-255,vcenterglow_aa,glow:1:32-168-268semibold)
  • $drawstring(wxyz,10,10,,,255-255-255,glow_aa,glow:0:32-168-268semiboldoffset:2:1outline:32-168-268)
  • $drawstring(wxyz,10,10,,,255-255-255,,glow:2:32-168-268:1)
  • $drawstring(wxyz,10,10,,,255-255-255,elipchar)


Rectangular drawing function. Coordinates (x,y) size (w,h) Draws a rectangle.

  • R1-G1-B1-A1 internal color
  • R2-G2-B2-A2 border color



  • $drawrect(0,50,50,50,255-128-64-128,,aa)


Draws a rectangle with gradient fill at the coordinates (x,y) and size (w,h)

  • r1-g1-b1-a1 gradient start color
  • r2-g2-b2-a2 peak color gradient


  • vertical: vertical gradient
  • horizontal: horizontal gradient
  • aa: enable anti aliasing
  • nonlinear: nonlinear gradient

PEAK: 0-100

  • Shifted the peak position of the gradient.
    • 0 by default, to end at peak color.
    • 50 When is the peak of color.


  • $gradientrect(0,50,50,50255-128-64-128255-255-255,vertical aa)
  • $gradientrect(0,50,50,50255-128-64-128255-255-255,,10)


Draws a rectangle with a blured outline at the coordinates (x,y) and size (w,h)

  • Colour [r1-g1-b1-a1]: blur colour
  • Level [1-7]: blur level


Function to draw a dotted line shows the focus rectangle frame specified.


Visual Style in a rectangle with a control (button or progress bar) function to draw. The only practical to draw a picture may be low. Visual Style not defined in control will not be drawn. At least WindowXP required.


  • Specify the name of the type of control you want to draw. One of the following:
  • window button rebar toolbar status listview header progress tab trackbar tooltip treeview spin scrollbar
  • edit combobox taskbar taskband startpanel explorerbar


  • the parts you want to draw ID. Could we use the following number in the range for each control as a guide.
  • In most cases, less than what I have defined.
  • Window: 1-37
  • Button rebar listview tooltip: 1-5
  • Toolbar: 1-6
  • Status treeview taskband: 1-3
  • Header spin: 1-4
  • Progress: 1-4
  • Tab trackbar scrollbar :1-10
  • Edit: 1-2
  • Combobox: 1
  • Taskbar: 1-8
  • Startpanel: 1-11
  • Explorerbar: 1-12


  • the state and selected ID. If the component does not have to specify the state is 0.
  • stateId is 0 or 1 or 2 would not be drawn in, the parts are not defined.


  • $drawthemerect (0,0,%el_width%,%el_height%,tab,10,0) / / tab of body parts drawn
  • $drawthemerect (,,,,progress,3,0) / / Draw the progress bar bar


Draws a rectangle with rounded corners at coordinates (x,y) and size (w, h). The degree of roundness is defined by (w2,h2).

  • In order to achieve a decent effect the condition w>4*w2 and h>4*h2 should be matched.
  • R1-G1-B1-A1 internal color
  • R2-G2-B2-A2 border color


  • $drawroundrect(10,20,50,50,4,4,255-255-128-255,,)


Draws an ellipse at coordinates (x,y) with size (w,h).

  • R1-G1-B1-A1 internal color
  • R2-G2-B2-A2 border Color


Draw a triangle and vertex function.

  • (x1,y1),(x2,y2),(x3,y3)
  • R1-G1-B1-A1 internal color
  • R2-G2-B2-A2 Border Color



  • $drawtriangle(10,5,20,10,10,15,200-100-100,,aa)


Displays an image (path) at coordinates (x,y) with size (w,h). By default, an image is expanded to the maximum size allowed by (w,h) without changing the aspect ratio of the image. After the image has been resized (if indeed it has been), the resized version is cached in the memory, which means any further references to it will return the modified rather than original values.

Path is the absolute path of the image. It can also point to an audio file if it has an embedded image or if you are using one of the "artreader" options, and the path can include compressed archives if the "archive" option is active (see below).

Options are flags which you separate with a space.

  • Resizing options
    • nokeepaspect ignores the image's aspect ratio and expands the image to fill both width and height regardless of distortion (nodisplay, archive, icon options and non-exclusive) [?]
    • noexpansion prevents resizing to fill the space if the image turns out to be smaller than the specified width and height.
  • Alignment options
    • left and right determine horizontal alignment (left is default).
    • top and bottom determine vertical alignment (top is default).
  • Miscellaneous options
    • wc enables wildcard characters (*,?).
    • nodisplay caches the image without actually displaying it.
  • Read-mode (path-related) options
    • archive allows references to compressed archives to be included in the path. The path format is the absolute path of the archive followed by the base path within the archive file, using a pipe (|) as the separator. For example: C:\aaa\|bbb/ccc.jpg
    • icon indicates that the path is specified in the icon file (*.ico) [?].
    • artreader uses embedded images or the default album art paths you've defined in Foobar2000's options to determine the image to be displayed. The path supplied should be that of an audio file (typically, this would be %path%).
      • artreader_front, artreader_back, artreader_disc and artreader_icon are variations on this option which select the specific corresponding album art. However, the original documentation suggests one avoid these options because they seem to be slow.

n: rotateflip Index for:

  • 1: 90°
  • 2: 180°
  • 3: 270°
  • 4: flip horizontal
  • 5: 90° + flip horizontal
  • 6: Flipped vertically
  • 7: 90° + Flip Vertically

Alpha (Opacity)

  • 0-255

OPTIONS2 (shadow effect)

  • Glow:expand:colour
  • Offset:x:y


  • $imageabs(10,10,50,50,C:\%album%.jpg)
  • $imageabs(10,10,50,50,C:\%album%.jpg,left top)
  • $imageabs(10,10,50,50,C:\%album%.jpg,,6)
  • $imageabs(10,10,50,50,C:\%album%.*,wc,6)
  • $imageabs(10,10,50,50,C:\%album%.jpg,bottom,,128)
  • $imageabs(10,10,50,50,C:\%album%.jpg,bottom,,,glow :2:0-0-0 offset: 4:4)
  • $imageabs(10,10,50,50,%path%,artreader)


To view the clip and resize images. Path specified by the image size (rw, rh) after resizing, portion of the area (srcx, srcy, srcw, srch) coordinates (x, y) size (srcw, srch) to display. In memory (rw, rh) cache. When you evaluate the TF (rw, rh) with changes in, to refresh the image. Therefore, rw, rh is to specify a fixed value. If there are images true, if false is returned.

OPTIONS (imageabs):

  • nokeepaspect: not maintain the aspect ratio
  • nodisplay: Hide read only memory
  • archive
  • Icon
  • Horizontal Alignment
    • left
    • hcener
    • right
  • Vertical Alignment
    • top
    • vcenter
    • bottom

N rotateflip Index for:

  • 1: 90°
  • 2: 180°
  • 3: 270°
  • 4: flip horizontal
  • 5: 90° + flip horizontal
  • 6: Flipped vertically
  • 7: 90° + Flip Vertically

Alpha (Opacity)

  • 0-255


  • $imageabs_rc(200,100,0,0,100,50,10,10,C:\%album%.jpg,,6,192)
  • $imageabs_rc(200,100,0,0,200,100,10,10,C:\%album%.jpg,,) ( = $imageabs(10,10,200,100,C:\%album%.jpg,left top,,) )
  • $imageabs_rc(150,120,0,0,150,120,20,15,C:\%album%.jpg,hcenter vcenter,) ( = $imageabs(20,15,150,120,C:\%album%.jpg,,,) )


Displays an image at Coordinates (x,y) with size (w,h) specified by path. The function is similar to $imageabs. w and h show the size of the original if omitted. Removed from memory immediately after being displayed. TF to be reloaded each time the images are evaluated.

You can see a huge image, the amount of occupied memory?RASHITAKATTARI to see more pictures, $imageabs for those who do not like the resizing process.


  • nokeepaspect: not to maintain aspect ratio
  • Alignment
    • Left
    • Right
    • Top
    • Bottom

n: rotateflip index for

  • 1: 90°
  • 2: 180°
  • 3: 270°
  • 4: flip horizontal
  • 5: 90° + flip horizontal
  • 6: Flipped vertically
  • 7: 90° + Flip Vertically

alpha: 0-255

  • Opacity (transparency)

Additional drawing functions


Display function imageabs, imageabs_rc right after, to get the coordinates to draw a picture. Also, $measurestring use them when you get the results. If you are drawString, mempos available only immediately after the specified coordinates.

Elem element to retrieve.

X: left
Y: top
W: width
H: height
R: right
B: bottom


$imageabs(10,4,100,100,$get(img_path),top noexpansion,)
$imageabs($getlastpos(x),$getlastpos(b),$getlastpos(w),20,$get(img_path),top nokeepaspect,6)


$drawstring to calculate the area when drawing text. As a result, returns to the horizontal width of the viewing area. The display area is to get $getlastpos. OPTIONS is the same as $drawstring. If $drawstring uses the glow_aa or glow options, the $measurestring value returned may not be accurate.


The image path is specified in $imageabs $imageabs_rc of cache memory. If the image has been resized in the horizontal width and vertical width it returns the respective values. This means that only have $imageabs $imageabs_rc behind. nokeepaspect may be able to calculate the aspect ratio should be applied.


Set the mode to specify the coordinates. Window space (0,0) ~ (%_width%,%_height%) where a, percentage specified in the mode, (0,0) to (100100) mapping.

  • x,y,W,H, can be set individually.
  • x,y,W,H, all affect the function of one argument.
  • bx x coordinate specified mode
    • 0: Splitter mode specified in absolute coordinates
    • 1: Splitter value relative to the size (percentage) and designated.
  • mode specified by y coordinates
  • bw w coordinates specified mode
  • bh h coordinates specified mode

$getsyscolour (index)

The r-g-b color system in the fo

index: [0-30] color index system


Calculates the average color R-g-b-a of a given set of colors.

(Colour1 + colour2 +···) / N


Calculates the average weighted w1,w2[,···] color R-g-b-a of a given set of colors.

(w1 * colur1 + w2 * colour2 +···+ wN * colourN) / (w1 + w2 +···+ wN)


Adds colors r-g-b-a of a given set.

Colour1 + colour2 + ··· + colourN


Substracts colors r-g-b-a of a given set.

Colour1 - colour2 - colour3···- colourN

General-purpose system functions


Determinates whether the specified file(s) exist(s) and returns the first file. If you do not have the file does not return anything. (Strictly speaking, "false" returns). Path can be specified. The path allows wildcards.

Function buttons


Create a button. Per Track only available. Per Second is not to write.

  • text: the button label
  • mover_text: the button label when mouse over

command: "Type of instruction: arguments" specified in the form of

  • be no extra spaces
  • Going to be separated by a specified multiple orders.
  • A few instructions that can be specified.
  • Very difficult to implement. . .
  • And the splitter so that the characters and words in these arguments, could not parse well.

Note 1: Do not specify the order processing time. Note 2: If you specify more than one instruction, the instruction execution order is not guaranteed. Especially if WINDOWSIZE and COMMAND is specified, WINDOWSIZE probably be better to run. COMMAND, CONTEXT and others, the order may be warranted.

Command: command_path

  • command_path to run the command specified by menu.
  • COMMAND: View / Equalizer and COMMAND: File / Preferences; COMMAND: Playback / Play
  • To specify that you can use the input help in setting some of them.
  • TF command_path Note also that as COMMAND: 'View / Equalizer' and it's recommended.

Context: context_path

  • context_path KONTEKISUTOMENYUKOMANDO be designated to perform.
  • Handles the context menu of the currently playing track.
  • CONTEXT: Properties to specify the like.
  • TF context_path Note also that as

Panelshow: cap: sh

  • The caption of the child panel cap / hide.
  • sh: 0 hide
    • 1.
    • -1 Show / hide toggle

TFMode: mode

  • Per Track titleformat to change the mode.
  • mode: 0 nowplaying mode
    • 1 follow curosr mode
    • -1 Toggle

Windowsize: width:height

  • Sets the size of the entire foobar2000 window.

Setglobal: name:value

Refresh: TF of PerTrack, PerSecond update.


specify the default decoration (can specify more than one, separated by spaces)

  • fontcolor: r-g-b color of the text
  • brushcolor: r-g-b-a color fills the rectangle button
  • pencolor: r-g-b-a color button border
  • left top bottom right position of the text


decorative specify when mouse over (can specify more than one, separated by spaces)

  • fontcolor: r-g-b color of the text
  • brushcolor: r-g-b-a color fills the rectangle button
  • pencolor: r-g-b-a color button border
  • left top bottom right position of the text


  • $textbutton (0,0,80,20,play,play,COMMAND: Playback / Play,fontcolor:64-64-64 brushcolor:192-192-192-128 pencolor:0-0-0-0,fontcolor:32-32-32)
  • $textbutton (100,0,80,20,Resize,Resize,PANELSHOW:aaa:-1;REFRESH,fontcolor:64-64-64 left bottom,fontcolor:32-32-32)


Create an image button. Per Track only available. Per Second is not to write. The internal processing of the images are treated equally and $imageabs will be cached in memory. w, h is omitted, path to original image size is specified. textbutton command is common.

Display options:


  • nokeepaspect
  • left
  • top
  • bottom
  • right


When mouse over the image display options

  • nokeepaspect
  • left
  • top
  • bottom
  • right

GDI drawing functions

Using the Windows System Component GDI to draw. GDI functions are usually faster, but they do not allow alpha blending and shadow effects (glow).


GDI text drawing functions. Text coordinates (x, y) in output


  • Align left hcenter right specified horizontal
  • Align specified top vcenter bottom vertical
  • Not noclip clip


GDI drawing functions text_2 Text coordinates (x, y) in output


  • Align left hcenter right specified horizontal
  • Align specified top vcenter bottom vertical
  • Not noclip clip
  • Allow specified wrap wraparound (vcenter, bottom and exclusive)
  • end_ellipsis If you clip text, replace the end of the text ...

Example: $drawtextex(text,0,0,%_width%,%_height%,0-0-0,hcenter vcenter end_ellipsis)


For the use with GDI text functions (drawtext, drawtextex). Returns the width in the text when drawing horizontal text. Optionaly the font can be specified FONTNAME, SIZE and OPTIONS (bold, italic, etc).


For the use with GDI text functions (drawtext, drawtextex). Returns vertical width of text. can specify the font ($ font option). Optionaly the font can be specified FONTNAME, SIZE and OPTIONS (bold, italic, etc).


Filled rectangle function


Function of the fill rectangle with rounded corners

Panel operating system functions

Apparently drawing functions and the TF is such low efficiency of the frame together, Future plans to??.

$showpanel(i,sh) or $showpanel_c(caption,sh)

Panel, change the function inactive

  • i: somethingth in the child panel list (counting from 0)
  • sh: 0: Inactive 1: View

$movepanel(i,x,y,W,H,) or $movepanel_c(caption,x,y,W,H,)

i: something in the child panel list (counting from 0)

Panel Force layout only for the specified coordinates (x, y) size (w, h) to move on.


i: returns the list of child panel captions are set in the second panel.


Returns the status panel.

External links