Difference between revisions of "Documentation:Modules/transcode"

From VideoLAN Wiki
Jump to navigation Jump to search
(Create stub page)
 
m (Add more default module options)
 
(5 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
{{Stub}}
 
{{Stub}}
−
{{Module|name=transcode|type=Stream output|first_version=0.6.0|description=Transcode content on the fly}}
+
{{Module|name=stream_out_transcode|type=Stream output|first_version=0.6.0|description=[[Transcode]] content on the fly}}
  
−
[[Category:Modules]]
+
The only shortcut to this module is <code>transcode</code>.
 +
 
 +
== Options ==
 +
Note: Since [[supported]] codecs are dynamically assigned by the running program, <code>sout-transcode-venc</code>, <code>sout-transcode-aenc</code> and <code>sout-transcode-senc</code> have been left blank.
 +
 
 +
Looking at the source code for 4.0.0-dev it seems no checks are directly performed limiting <code>sout-transcode-samplerate</code> beyond <code>0 <= samplerate <= 48000</code>.
 +
 
 +
As of 2.2.0 <code>sout-transcode-fps</code> accepts fps as rationals e.g. <code>30000/1001</code>.
 +
 
 +
Deprecated options:
 +
* <code>hurry-up</code> (since 2.2.0), <code>sout-transcode-high-priority</code> seems to be equivalent
 +
* <code>audio-sync</code> (since 2.2.0)
 +
 
 +
=== Video ===
 +
{{Option
 +
|name=sout-transcode-venc
 +
|value=string
 +
|select=
 +
|description=This is the video encoder module that will be used (and its associated options)
 +
}}
 +
{{Option
 +
|name=sout-transcode-vcodec
 +
|value=string
 +
|default=NULL
 +
|description=This is the video codec that will be used
 +
}}
 +
{{Option
 +
|name=sout-transcode-vb
 +
|value=integer
 +
|default=0
 +
|description=Target bitrate of the transcoded video stream
 +
}}
 +
{{Option
 +
|name=sout-transcode-scale
 +
|value=float
 +
|default=0
 +
|description=Scale factor to apply to the video while transcoding (eg: 0.25)
 +
}}
 +
{{Option
 +
|name=sout-transcode-fps
 +
|value=string
 +
|default=NULL
 +
|description=Target output frame rate for the video stream
 +
}}
 +
{{Option
 +
|name=sout-transcode-deinterlace
 +
|value=boolean
 +
|description=Deinterlace the video before encoding
 +
|default=disabled
 +
}}
 +
{{Option
 +
|name=sout-transcode-deinterlace-module
 +
|value=string
 +
|default=deinterlace
 +
|select={deinterlace,ffmpeg-deinterlace}
 +
|description=Specify the deinterlace module to use
 +
}}
 +
{{Option
 +
|name=sout-transcode-width
 +
|value=integer
 +
|default=0
 +
|description=Output video width
 +
}}
 +
{{Option
 +
|name=sout-transcode-height
 +
|value=integer
 +
|default=0
 +
|description=Output video height
 +
}}
 +
{{Option
 +
|name=sout-transcode-maxwidth
 +
|value=integer
 +
|default=0
 +
|description=Maximum output video width
 +
}}
 +
{{Option
 +
|name=sout-transcode-maxheight
 +
|value=integer
 +
|default=0
 +
|description=Maximum output video height
 +
}}
 +
{{Option
 +
|name=sout-transcode-vfilter
 +
|value=string
 +
|description=Video filters will be applied to the video streams (after overlays are applied). You can enter a colon-separated list of filters
 +
}}
 +
 
 +
=== Audio ===
 +
{{Option
 +
|name=sout-transcode-aenc
 +
|value=string
 +
|select=
 +
|description=This is the audio encoder module that will be used (and its associated options)
 +
}}
 +
{{Option
 +
|name=sout-transcode-acodec
 +
|value=string
 +
|default=NULL
 +
|description=This is the audio codec that will be used
 +
}}
 +
{{Option
 +
|name=sout-transcode-ab
 +
|value=integer
 +
|default=96
 +
|description=Target bitrate of the transcoded audio stream
 +
}}
 +
{{Option
 +
|name=sout-transcode-alang
 +
|value=string
 +
|default=NULL
 +
|description=This is the language of the audio stream
 +
}}
 +
{{Option
 +
|name=sout-transcode-channels
 +
|value=integer
 +
|default=0
 +
|min=0
 +
|max=9
 +
|description=Number of audio channels in the transcoded streams
 +
}}
 +
{{Option
 +
|name=sout-transcode-samplerate
 +
|value=integer
 +
|default=0
 +
|min=0
 +
|max=48000
 +
|description=Sample rate of the transcoded audio stream (11250, 22500, 44100 or 48000)
 +
}}
 +
{{Option
 +
|name=sout-transcode-afilter
 +
|value=string
 +
|description=Audio filters will be applied to the audio streams (after conversion filters are applied). You can enter a colon-separated list of filters
 +
}}
 +
 
 +
=== Overlays/Subtitles ===
 +
{{Option
 +
|name=sout-transcode-senc
 +
|value=string
 +
|select=
 +
|description=This is the subtitle encoder module that will be used (and its associated options)
 +
}}
 +
{{Option
 +
|name=sout-transcode-scodec
 +
|value=string
 +
|default=NULL
 +
|description=This is the subtitle codec that will be used
 +
}}
 +
{{Option
 +
|name=sout-transcode-soverlay
 +
|value=boolean
 +
|default=disabled
 +
|description=This is the subtitle codec that will be used
 +
}}
 +
{{Option
 +
|name=sout-transcode-sfilter
 +
|value=string
 +
|description=This allows you to add overlays (also known as "subpictures") on the transcoded video stream. The subpictures produced by the filters will be overlayed directly onto the video. You can specify a colon-separated list of subpicture modules
 +
}}
 +
 
 +
=== Miscellaneous ===
 +
{{Option
 +
|name=sout-transcode-threads
 +
|value=integer
 +
|default=0
 +
|min=1
 +
|max=32
 +
|description=Number of threads used for the transcoding
 +
}}
 +
{{Option
 +
|name=sout-transcode-pool-size
 +
|value=integer
 +
|default=10
 +
|min=1
 +
|max=1000
 +
|description=Defines how many pictures we allow to be in pool between decoder/encoder threads when threads > 0
 +
}}
 +
{{Option
 +
|name=sout-transcode-high-priority
 +
|default=disabled
 +
|value=boolean
 +
|description=Runs the optional encoder thread at the OUTPUT priority instead of VIDEO
 +
}}
 +
 
 +
== Source code ==
 +
* {{VLCSourceFile|modules/stream_out/transcode/transcode.c}}
 +
 
 +
{{Documentation}}
 +
 
 +
[[Category:Transcoding]]

Latest revision as of 05:26, 1 April 2019

Help VideoLAN by adding to this page!
Create an account to start editing, and then click here to add to this article.
Module: stream_out_transcode
Type Stream output
First VLC version 0.6.0
Last VLC version -
Operating system(s) all
Description Transcode content on the fly
Shortcut(s) -

The only shortcut to this module is transcode.

Options

Note: Since supported codecs are dynamically assigned by the running program, sout-transcode-venc, sout-transcode-aenc and sout-transcode-senc have been left blank.

Looking at the source code for 4.0.0-dev it seems no checks are directly performed limiting sout-transcode-samplerate beyond 0 <= samplerate <= 48000.

As of 2.2.0 sout-transcode-fps accepts fps as rationals e.g. 30000/1001.

Deprecated options:

  • hurry-up (since 2.2.0), sout-transcode-high-priority seems to be equivalent
  • audio-sync (since 2.2.0)

Video

  • sout-transcode-venc <string> : This is the video encoder module that will be used (and its associated options)
  • sout-transcode-vcodec <string> : This is the video codec that will be used default value: NULL
  • sout-transcode-vb <integer> : Target bitrate of the transcoded video stream default value: 0
  • sout-transcode-scale <float> : Scale factor to apply to the video while transcoding (eg: 0.25) default value: 0
  • sout-transcode-fps <string> : Target output frame rate for the video stream default value: NULL
  • sout-transcode-deinterlace <boolean> : Deinterlace the video before encoding default value: disabled
  • sout-transcode-deinterlace-module <string> {deinterlace,ffmpeg-deinterlace} : Specify the deinterlace module to use default value: deinterlace
  • sout-transcode-width <integer> : Output video width default value: 0
  • sout-transcode-height <integer> : Output video height default value: 0
  • sout-transcode-maxwidth <integer> : Maximum output video width default value: 0
  • sout-transcode-maxheight <integer> : Maximum output video height default value: 0
  • sout-transcode-vfilter <string> : Video filters will be applied to the video streams (after overlays are applied). You can enter a colon-separated list of filters

Audio

  • sout-transcode-aenc <string> : This is the audio encoder module that will be used (and its associated options)
  • sout-transcode-acodec <string> : This is the audio codec that will be used default value: NULL
  • sout-transcode-ab <integer> : Target bitrate of the transcoded audio stream default value: 96
  • sout-transcode-alang <string> : This is the language of the audio stream default value: NULL
  • sout-transcode-channels <integer [0 .. 9]> : Number of audio channels in the transcoded streams default value: 0
  • sout-transcode-samplerate <integer [0 .. 48000]> : Sample rate of the transcoded audio stream (11250, 22500, 44100 or 48000) default value: 0
  • sout-transcode-afilter <string> : Audio filters will be applied to the audio streams (after conversion filters are applied). You can enter a colon-separated list of filters

Overlays/Subtitles

  • sout-transcode-senc <string> : This is the subtitle encoder module that will be used (and its associated options)
  • sout-transcode-scodec <string> : This is the subtitle codec that will be used default value: NULL
  • sout-transcode-soverlay <boolean> : This is the subtitle codec that will be used default value: disabled
  • sout-transcode-sfilter <string> : This allows you to add overlays (also known as "subpictures") on the transcoded video stream. The subpictures produced by the filters will be overlayed directly onto the video. You can specify a colon-separated list of subpicture modules

Miscellaneous

  • sout-transcode-threads <integer [1 .. 32]> : Number of threads used for the transcoding default value: 0
  • sout-transcode-pool-size <integer [1 .. 1000]> : Defines how many pictures we allow to be in pool between decoder/encoder threads when threads > 0 default value: 10
  • sout-transcode-high-priority <boolean> : Runs the optional encoder thread at the OUTPUT priority instead of VIDEO default value: disabled

Source code

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
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.
Retrieved from "https://wiki.videolan.org/index.php?title=Documentation:Modules/transcode&oldid=60500"