Difference between revisions of "Documentation:Modules/mosaic"
Jump to navigation
Jump to search
m (Remove line breaks between options) |
m (→Appendix: Tweaks) |
||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{Module|name=mosaic|type=Video subfilter|first_version=0.8.2|description= | + | {{Mosaic framework}} |
| + | {{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 | + | 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/ | + | Since VLC 0.8.6, you can also use the [[Documentation:Modules/http intf|HTTP interface]]'s mosaic wizard to configure a mosaic easily. |
| + | __TOC__ | ||
| + | {{Clear}} | ||
== Options == | == Options == | ||
| Line 9: | Line 12: | ||
|name=mosaic-alpha | |name=mosaic-alpha | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=255 | ||
|default=255 | |default=255 | ||
| − | |description= | + | |description=Alpha blending (transparency) of the mosaic foreground pictures. 0 means transparent, 255 opaque. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-height | |name=mosaic-height | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=100 | |default=100 | ||
| − | |description= | + | |description=Total height of the mosaic, in pixels. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-width | |name=mosaic-width | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=100 | |default=100 | ||
| − | |description= | + | |description=Total width of the mosaic, in pixels. |
}} | }} | ||
{{Option | {{Option | ||
| − | |name=mosaic-align | + | |name=mosaic-align<span id="select_mosaic-align"></span> |
|value=integer | |value=integer | ||
| + | |select=[[#appendix_select_mosaic-align|{ 0, 1, 2, 4, 8, 5, 6, 9, 10 }]] | ||
|default=5 | |default=5 | ||
| − | |description= | + | |description=You can enforce the mosaic alignment on the parent video. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-xoffset | |name=mosaic-xoffset | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=0 | |default=0 | ||
| − | |description= | + | |description=X Coordinate of the top-left corner of the mosaic. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-yoffset | |name=mosaic-yoffset | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=0 | |default=0 | ||
| − | |description= | + | |description=Y Coordinate of the top-left corner of the mosaic. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-borderw | |name=mosaic-borderw | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=0 | |default=0 | ||
| − | |description=Border width | + | |description=Border width between mosaic elements, in pixels. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-borderh | |name=mosaic-borderh | ||
|value=integer | |value=integer | ||
| + | |min=0 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=0 | |default=0 | ||
| − | |description=Border height | + | |description=Border height between mosaic elements, in pixels. |
}} | }} | ||
{{Option | {{Option | ||
| − | |name=mosaic-position | + | |name=mosaic-position<span id="mosaic-position"></span> |
|value=integer | |value=integer | ||
| + | |select={ 0, 1, 2 } | ||
|default=0 | |default=0 | ||
| − | |description=Positioning method of the mosaic elements. Use 0 to position the elements automatically on the grid, 1 to position the elements in fixed positions on the grid (see mosaic-order) and 2 to use grid | + | |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 | {{Option | ||
|name=mosaic-rows | |name=mosaic-rows | ||
|value=integer | |value=integer | ||
| + | |min=1 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=2 | |default=2 | ||
| − | |description=Number of rows in the mosaic | + | |description=Number of image rows in the mosaic (only used if [[#mosaic-position|positioning method]] is set to "fixed"). |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-cols | |name=mosaic-cols | ||
|value=integer | |value=integer | ||
| + | |min=1 | ||
| + | |max=<var>INT_MAX</var> | ||
|default=2 | |default=2 | ||
| − | |description=Number of columns in the mosaic | + | |description=Number of image columns in the mosaic (only used if [[#mosaic-position|positioning method]] is set to "fixed"). |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-keep-aspect-ratio | |name=mosaic-keep-aspect-ratio | ||
| + | |value=boolean | ||
|default=disabled | |default=disabled | ||
| − | |description=Keep the | + | |description=Keep the original [[aspect ratio]] when resizing mosaic elements. |
}} | }} | ||
{{Option | {{Option | ||
|name=mosaic-keep-picture | |name=mosaic-keep-picture | ||
| + | |value=boolean | ||
|default=disabled | |default=disabled | ||
| − | |description=Do not resize or do any other transformation on the mosaic pictures. Should be enabled when using the | + | |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 | {{Option | ||
| Line 86: | Line 111: | ||
|value=string | |value=string | ||
|default="" | |default="" | ||
| − | |description= | + | |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 | {{Option | ||
| − | |name=mosaic-offsets | + | |name=mosaic-offsets<span id="mosaic-offsets"></span> |
|value=string | |value=string | ||
|default="" | |default="" | ||
| − | |description= | + | |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 | {{Option | ||
| Line 98: | Line 123: | ||
|value=integer | |value=integer | ||
|default=0 | |default=0 | ||
| − | |description= | + | |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}} |
| − | |||
| − | {{Documentation}} | + | == Appendix == |
| + | <div class="plainlist"> | ||
| + | *^ [[#select_mosaic-align|--mosaic-align]]<span id="appendix_select_mosaic-align"></span> | ||
| + | </div> | ||
| + | {{Alignment mapping}} | ||
| + | |||
| + | {{Documentation footer}} | ||
Latest revision as of 04:21, 2 June 2019
| Mosaic framework (How-To) |
| Modules: mosaic (mosaic-bridge • bridge-in • bridge-out) • alphamask • bluescreen |
| Module: mosaic | |
|---|---|
| Type | Video sub-filter |
| First VLC version | 0.8.2 |
| Last VLC version | - |
| Operating system(s) | all |
| Description | Mosaic video sub source |
| Shortcut(s) | - |
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 bluescreen video filter) and lots of other fun stuff.
Since VLC 0.8.6, you can also use the HTTP interface's mosaic wizard to configure a mosaic easily.
Contents
Options
- mosaic-alpha <integer [0 .. 255]> : Alpha blending (transparency) of the mosaic foreground pictures. 0 means transparent, 255 opaque. default value: 255
- mosaic-height <integer [0 .. INT_MAX]> : Total height of the mosaic, in pixels. default value: 100
- mosaic-width <integer [0 .. INT_MAX]> : Total width of the mosaic, in pixels. default value: 100
- mosaic-align <integer> { 0, 1, 2, 4, 8, 5, 6, 9, 10 } : You can enforce the mosaic alignment on the parent video. default value: 5
- mosaic-xoffset <integer [0 .. INT_MAX]> : X Coordinate of the top-left corner of the mosaic. default value: 0
- mosaic-yoffset <integer [0 .. INT_MAX]> : Y Coordinate of the top-left corner of the mosaic. default value: 0
- mosaic-borderw <integer [0 .. INT_MAX]> : Border width between mosaic elements, in pixels. default value: 0
- mosaic-borderh <integer [0 .. INT_MAX]> : Border height between mosaic elements, in pixels. default value: 0
- mosaic-position <integer> { 0, 1, 2 } : Positioning method of the mosaic elements. Use 0 to position the elements automatically on the grid, 1 to position the elements in fixed positions on the grid (see mosaic-order) and 2 to use grid-independent offsets (see mosaic-offsets). default value: 0
- mosaic-rows <integer [1 .. INT_MAX]> : Number of image rows in the mosaic (only used if positioning method is set to "fixed"). default value: 2
- mosaic-cols <integer [1 .. INT_MAX]> : Number of image columns in the mosaic (only used if positioning method is set to "fixed"). default value: 2
- mosaic-keep-aspect-ratio <boolean> : Keep the original aspect ratio when resizing mosaic elements. default value: disabled
- mosaic-keep-picture <boolean> : Do not resize or do any other transformation on the mosaic pictures. Should be enabled when using the mosaic-bridge's resizing options. default value: disabled
- mosaic-order <string> : You can enforce the order of the elements on the mosaic. You must give a comma-separated list of picture ID(s) (For example: tf1,fr2,fr3,m6). These IDs are assigned in the mosaic-bridge module. default value: ""
- mosaic-offsets <string> : You can enforce the
(x,y)offsets of the elements on the mosaic (only used if positioning method is set to "offsets"). You must give a comma-separated list of coordinates. For example: 10,10,150,10 if you want to position the first picture at coordinates(10,10)and the second one at coordinates(150,10). default value: "" - mosaic-delay <integer> : 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. default value: 0
Source code
Appendix
| Integer | Alignment | Comment |
|---|---|---|
| 0 | Center | |
| 1 | Left | |
| 2 | Right | |
| 4 | Top | |
| 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 |
This page is part of official VLC media player Documentation (User Guide • Streaming HowTo • Hacker Guide • Modules)
Please read the Documentation Editing Guidelines before you edit the documentation
Please read the Documentation Editing Guidelines before you edit the documentation
Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.
