View source for Documentation:Modules/mosaic

{{Module|name=mosaic|type=Video subfilter|first_version=0.8.2|description=Mosaic video sub source}}

Use this filter to blend videos on top of another video. This can be used to create TV channels mosaics, setup a weather channel-like stream (with the {{docmod|bluescreen}} video filter) and lots of other fun stuff.

Since VLC 0.8.6, you can also use the [[Documentation:Modules/http intf|HTTP interface]]'s mosaic wizard to configure a mosaic easily.

== Options ==
{{Option
|name=mosaic-alpha
|value=integer
|min=0
|max=255
|default=255
|description=Alpha blending (transparency) of the mosaic foreground pictures. 0 means transparent, 255 opaque.
}}
{{Option
|name=mosaic-height
|value=integer
|default=100
|description=Total height of the mosaic, in pixels.
}}
{{Option
|name=mosaic-width
|value=integer
|default=100
|description=Total width of the mosaic, in pixels.
}}
{{Option
|name=mosaic-align<span id="select_mosaic-align"></span>
|value=integer
|select=[[#appendix_select_mosaic-align|{ 0, 1, 2, 4, 8, 5, 6, 9, 10 }]]
|default=5
|description=You can enforce the mosaic alignment on the parent video.
}}
{{Option
|name=mosaic-xoffset
|value=integer
|default=0
|description=X Coordinate of the top-left corner of the mosaic.
}}
{{Option
|name=mosaic-yoffset
|value=integer
|default=0
|description=Y Coordinate of the top-left corner of the mosaic.
}}
{{Option
|name=mosaic-borderw
|value=integer
|default=0
|description=Border width between mosaic elements, in pixels.
}}
{{Option
|name=mosaic-borderh
|value=integer
|default=0
|description=Border height between mosaic elements, in pixels.
}}
{{Option
|name=mosaic-position<span id="mosaic-position"></span>
|value=integer
|select={ 0, 1, 2 }
|default=0
|description=Positioning method of the mosaic elements. Use <kbd>0</kbd> to position the elements automatically on the grid, <kbd>1</kbd> to position the elements in fixed positions on the grid (see mosaic-order) and <kbd>2</kbd> to use grid-independent offsets (see [[#mosaic-offsets|mosaic-offsets]]).
}}
{{Option
|name=mosaic-rows
|value=integer
|min=1
|max=<var>INT_MAX</var>
|default=2
|description=Number of image rows in the mosaic (only used if [[#mosaic-position|positioning method]] is set to "fixed").
}}
{{Option
|name=mosaic-cols
|value=integer
|min=1
|max=<var>INT_MAX</var>
|default=2
|description=Number of image columns in the mosaic (only used if [[#mosaic-position|positioning method]] is set to "fixed").
}}
{{Option
|name=mosaic-keep-aspect-ratio
|value=boolean
|default=disabled
|description=Keep the original [[aspect ratio]] when resizing mosaic elements.
}}
{{Option
|name=mosaic-keep-picture
|value=boolean
|default=disabled
|description=Do not resize or do any other transformation on the mosaic pictures. Should be enabled when using the {{docmod|mosaic-bridge}}'s resizing options.
}}
{{Option
|name=mosaic-order
|value=string
|default=""
|description=You can enforce the order of the elements on the mosaic. You must give a comma-separated list of picture ID(s) (For example: <kbd>tf1,fr2,fr3,m6</kbd>). These IDs are assigned in the {{docmod|mosaic-bridge}} module.
}}
{{Option
|name=mosaic-offsets<span id="mosaic-offsets"></span>
|value=string
|default=""
|description=You can enforce the <code>(x,y)</code> offsets of the elements on the mosaic (only used if [[#mosaic-position|positioning method]] is set to "offsets"). You must give a comma-separated list of coordinates. For example: <kbd>10,10,150,10</kbd> if you want to position the first picture at coordinates <code>(10,10)</code> and the second one at coordinates <code>(150,10)</code>.
}}
{{Option
|name=mosaic-delay
|value=integer
|default=0
|description=Pictures coming from the mosaic elements will be delayed according to this value (in milliseconds). For high values you will need to raise caching at input.
}}

== Source code ==
* {{VLCSourceFile|modules/spu/mosaic.c}}

== See also ==
* [[Documentation:Modules/mosaic-bridge]]
* [[Mosaic|The original Mosaic How-To]]

== Appendix ==
<span id="appendix_select_mosaic-align"></span>
{| class="mw-datatable sortable"
|+ Key: [[#select_mosaic-align|--mosaic-align]]
! scope="col" | Integer !! scope="col" | Effect !! scope="col" | Comment
|- style="font-weight:bold;"
| 0 || Center ||
|- style="font-weight:bold;"
| 1 || Left ||
|- style="font-weight:bold;"
| 2 || Right ||
|- style="font-weight:bold;"
| 4 || Top ||
|- style="font-weight:bold;"
| 8 || Bottom ||
|-
| 5 || Top-Left || 4 + 1
|-
| 6 || Top-Right || 4 + 2
|-
| 9 || Bottom-Left || 8 + 1
|-
| 10 || Bottom-Right || 8 + 2
|-
| 3 || {{n/a}} || contradictory
|-
| 7 || {{n/a}} || contradictory
|}

{{Documentation}}