Difference between revisions of "Documentation:Modules/logo"

From VideoLAN Wiki
Jump to navigation Jump to search
m ({{See also|Documentation:Modules/erase}} for erasing a logo)
m (Tweaks)
 
(13 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{See also|Documentation:Modules/erase}}
+
{{See also|Documentation:Modules/erase|VLC HowTo/Add a logo}}
  
{{Module|name=logo|type=Video subfilter|description=Overlays a logo on the video}}
+
The logo filter can be used to add a logo on the video. This logo can be a static image or series of images which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.
{{Module|name=logo|type=Video output filter|description=Overlays a logo on the video}}
 
  
The logo filter can be used to add a logo on the video. This logo can be a static image or series of image which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.
+
== Video sub-filter ==
 
+
{{Module|name=logo|type=Video sub-filter|description=Logo sub source|sc=logo}}
== Options ==
+
<onlyinclude>{{Option
 
 
{{Option
 
 
|name=logo-file
 
|name=logo-file
 
|value=string
 
|value=string
|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}
+
|description=Image to display. The full format is <code><nowiki><image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]</nowiki></code>.
 
+
}}
 
{{Option
 
{{Option
 
|name=logo-x
 
|name=logo-x
 
|value=integer
 
|value=integer
|default=0 (0.8.6d and prior: -1)
+
|default=0
|description=X offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
+
|description=X offset from upper left corner.
 
}}
 
}}
 
 
{{Option
 
{{Option
 
|name=logo-y
 
|name=logo-y
 
|value=integer
 
|value=integer
 
|default=0
 
|default=0
|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
+
|description=Y offset from upper left corner.
 
}}
 
}}
 
 
{{Option
 
{{Option
|name=logo-position
+
|name=logo-position<span id="logo-position"></span>
 
|value=integer
 
|value=integer
 +
|select=[[#appendix_logo-position|{ 0, 1, 2, 4, 8, 5, 6, 9, 10 }]]
 
|default=5
 
|default=5
|description=Logo position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. (0.8.6d and prior: This is only used if logo-x or logo-y are negative)
+
|description=Logo position.
 
}}
 
}}
 
 
{{Option
 
{{Option
 
|name=logo-opacity
 
|name=logo-opacity
 
|value=integer
 
|value=integer
 
|default=255
 
|default=255
 +
|min=0
 +
|max=255
 
|description=Logo opacity. 0 is transparent, 255 is fully opaque.
 
|description=Logo opacity. 0 is transparent, 255 is fully opaque.
 
}}
 
}}
 
 
{{Option
 
{{Option
 
|name=logo-delay
 
|name=logo-delay
 
|value=integer
 
|value=integer
 
|default=1000
 
|default=1000
|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option.
+
|description=Global delay in [[wiktionary:ms#Translingual|ms]]. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the <code>--logo-file</code> option.
 
}}
 
}}
 
 
{{Option
 
{{Option
 
|name=logo-repeat
 
|name=logo-repeat
Line 53: Line 48:
 
|default=-1
 
|default=-1
 
|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.
 
|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.
}}
+
}}</onlyinclude>
 +
{{Clear}}
 +
 
 +
== Video output filter ==
 +
{{Module|name=logo|type=Video output filter|description=Logo video filter|sc=logo}}
 +
{{Clear}}
  
 
== Examples ==
 
== Examples ==
 
+
  {{%}} '''vlc --video-filter "logo{file=cone.png,opacity=128}" somevideo.avi'''
Example command line use '''(VLC 0.9.0 and above)''':
 
  % '''vlc --sub-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''
 
 
: This command will display image cone.png in the video's upper right corner with 50% transparency.
 
: This command will display image cone.png in the video's upper right corner with 50% transparency.
  
  % '''vlc --sub-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''
+
  {{%}} '''vlc --video-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''
 
: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.
 
: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.
  
Example command line '''(All versions including VLC 8.6d and prior)''':
+
== Source code ==
% '''vlc --sub-filter=logo --logo-file=cone.png --logo-transparency=128 somevideo.avi'''
+
* {{VLCSourceFile|modules/spu/logo.c}}
 
 
See also [[How to add a logo]]
 
  
{{Stub}}
+
== Appendix ==
 +
<div class="plainlist">
 +
*^ [[#logo-position|--logo-position]]<span id="appendix_logo-position"></span>
 +
</div>
 +
{{Alignment mapping}}
  
 
{{Documentation footer}}
 
{{Documentation footer}}
 
[[Category:Video Filters]]
 

Latest revision as of 04:22, 2 June 2019

The logo filter can be used to add a logo on the video. This logo can be a static image or series of images which will be displayed alternatively. When used as a video output filter, you can move the logo with the mouse.

Video sub-filter

Module: logo
Type Video sub-filter
First VLC version -
Last VLC version -
Operating system(s) all
Description Logo sub source
Shortcut(s) logo
  • logo-file <string> : Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...].
  • logo-x <integer> : X offset from upper left corner. default value: 0
  • logo-y <integer> : Y offset from upper left corner. default value: 0
  • logo-position <integer> { 0, 1, 2, 4, 8, 5, 6, 9, 10 } : Logo position. default value: 5
  • logo-opacity <integer [0 .. 255]> : Logo opacity. 0 is transparent, 255 is fully opaque. default value: 255
  • logo-delay <integer> : Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option. default value: 1000
  • logo-repeat <integer> : Number of loops for the logo animation. -1 for continuous, 0 to disable. default value: -1

Video output filter

Module: logo
Type Video output filter
First VLC version -
Last VLC version -
Operating system(s) all
Description Logo video filter
Shortcut(s) logo

Examples

% vlc --video-filter "logo{file=cone.png,opacity=128}" somevideo.avi
This command will display image cone.png in the video's upper right corner with 50% transparency.
% vlc --video-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi
This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.

Source code

Appendix

Integer alignment mapping
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 GuideStreaming HowToHacker GuideModules)
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.