VideoLAN Wiki - User contributions [en]

SoC 2010

2010-02-11T13:53:53Z

Dionoea:

'''Google Summer of Code 2010.'''

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}} .

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}} .

=== VLC media player ===
{{VLC}} is a cross-platform multimedia player, encoder and streamer application.
It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 5 millions from the main website and that's not including third-party distributions (Linux)!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main_Page|wiki]].

=== Summer of Code ===

If selected and developed, SoC projects for VLC will be included in later releases.
All projects are covered by the GPL licence. (v2+)

=== Ideas for VLC ===

'''''Read this'''''

This page is split in three lists of ideas:

# [[Mini_Projects]] are short-span projects which can be given as Qualification tasks.
# The ''main ideas'' are what seem to be ''key projects'' for VLC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.

* '''Original good ideas will be valued'''. Last year, half of the ideas were given by students. We don't want to impose anything. This is free and Open Source software.

If you don't want to apply for SoC but want other ideas to develop on, check the [[Mini Projects]] page!

And on the IRC channel, you can have even more ideas.

== Main ideas ==

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* Profiling VLC.
* memcpy implementations in SSE* and MMX (see modules/misc/memcpy/fastmemcpy.h)
* video filters ASM speedups (see modules/video_filter/blend.c)
* audio filters ASM speedups (see modules/audio_filter/equalizer.c)
* Porting other ASM video filters to VLC.

This project needs some good ASM knowledge and good C experience.

* Stuff to read: http://www.agner.org/optimize/

''Proposed mentor: [[User:J-b|jb]]''

=== Audio Filters ===

We are looking for a skilled audiophile that knows a lot about audio theory and practice:
* to create or implement new algorithms, like SRS WoW or other 3D effects
* to work on channels mixing,
* to work on tracks mixing,
* to create scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script.

This project needs some good audio knowledge and good C experience.

''Proposed mentor: [[User:Geal|geal]]''

=== Test Suite ===
This project aims at making automatic tests to improve VLC quality.

* Write a series of tests for vlc-internal
* Integrate a framework for automated plugins testing with the automake build system
* Automate the different codec playback/mux/etc tests
* Automate the subtitles tests
* Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require good knowledge of C

''Proposed mentor: Rémi''

=== Qt embedded interface ===

VLC uses Qt for its main interfaces on desktop systems. It would be nice to have the same type of UI on systems like Maemo or Windows Mobile.

''Proposed mentor: ILEoo''

== Mini Projects - More ideas ==

This sections welcomes all '''Original''' ideas which can be implemented in a short span of time.However, We have a more general page for ideas for Project in {{VLC}}, that could give you ideas: [[Mini_Projects]].

=== Gmail Integration ===

To Develop a Combination of VLC Patch and a FireFox Extension , working together to set currently Playing track as Custom Message in Gmail Chat. The FireFox Extension will fetch the track Information from VLC instance running and will
* Either, generate an XmlHttpRequest to send the new status to Server.
* Or, Fire the Gmail Eventlisteners accordingly.
The project succesfully completed this way will be Platform Independent.Had it been done through Google Talk Client , it would have been available for Windows users only.Had it been done using VLC<->Google server interaction, it would have required User authentications ,Proxy Handling etc.

''Proposed by :'' pk

== Questions? Contact us? ==
If you need to contact us for any questions, you can:
* use the [http://www.videolan.org/developers/lists.html vlc-devel] mailing list,
* come on IRC irc://irc.videolan.org #videolan
* contact one of the mentors or the backup mentors,
* or contact [[User:J-b| Jean-Baptiste Kempf]]

=== Mentors ===
The proposed mentors are:
* jpeg
* remi
* xtophe
* jb
* dionoea
* jpsaman
* jpd

=== Administrators ===
* jb
* xtophe

[[Category:Activities]] [[Category:SoC]]

Documentation:Format String

2010-02-09T15:10:43Z

Dionoea:

{{RightMenu|documentation play howto toc}}

Starting with [[VLC media player]] 0.9.0, format string variables can be used with the following options:
* --marq-marquee
* --snapshot-path (when specifying a full image path, not a directory)
* --snapshot-prefix
* --image-out-prefix
* --msn-format (windows only)
* file access output dst/url (like in std{access=file,mux=ts,dst='''THIS'''})

There are two kinds of format string variables: time variables and meta variables.

==Time==

Time variables are those defined by the '''strftime''' C function. Those include:
* %Y : year
* %m : month
* %d : day
* %H : hour
* %M : minute
* %S : second
For an extensive list have a look at [http://www.hmug.org/man/3/strftime.php man strftime].

==Meta==

Meta variables are VLC specific. The complete list is:
* $a : artist
* $b : album
* $c : copyright
* $d : description
* $e : encoded by
* $f : frame count
* $g : genre
* $l : language
* $n : track num
* $p : now playing
* $r : rating
* $s : subtitles language
* $t : title
* $u : url
* $A : date
* $B : audio bitrate (in kb/s)
* $C : chapter (as in DVD chapter number)
* $D : duration
* $F : full name with path
* $I : title (as in DVD title number)
* $L : time left
* $N : name (media name as seen in the VLC playlist)
* $O : audio language
* $P : position (in %)
* $R : rate
* $S : audio sample rate (in kHz)
* $T : time code of the video
* $U : publisher
* $V : volume
* $_ : new line
* $<any other char> : <any other char> (for example: $$ transforms to $)

You can insert a space between the $ sign and the character to tell it to not display anything if the meta data isn't available. For example: $ T instead will display "" if no time is available while $T would display something like "01_22_13" (for a snapshot from one hour, 22 minutes and 13 seconds in a video).

{{Documentation}}

Python bindings

2010-01-14T15:00:54Z

Dionoea: 2nd try

= Python bindings =

You can find two versions of python bindings: an old one (see [[Old Python bindings]]), hand-written C-module, and a new one, which is ctypes-based and automatically generated.
The old version of the bindings is now deprecated and will be removed in some future version.

== Features ==

The new module features :
* a complete cover of the libvlc/MediaControl API, since it is automatically generated from the include files.
* no compilation hassle: the generated module is pure python.
* no versioning hassle: the same module works with multiple VLC versions.
* a [http://www.advene.org/download/python-ctypes/doc/ complete documentation].

== Download ==

You can download the [http://www.advene.org/download/python-ctypes/ vlc.py] module from the [http://www.advene.org/ Advene] website. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

Alternatively, you can generate it by yourself using the generate.py program and accompanying files in the vlc source tree (see [http://git.videolan.org/?p=vlc.git;a=tree;f=bindings/python-ctypes]).

== Usage ==

The vlc.py module is also a runnable example player application (see code at the end of the module, starting from the line "if __name__ == '__main__'). A helper module [http://git.videolan.org/?p=vlc.git;a=blob;f=bindings/python-ctypes/vlcwidget.py;hb=HEAD vlcwidget.py] provides a pygtk VLCWidget() to ease integration.

Python bindings

2010-01-14T14:58:27Z

Dionoea: fix gitweb link

= Python bindings =

You can find two versions of python bindings: an old one (see [[Old Python bindings]]), hand-written C-module, and a new one, which is ctypes-based and automatically generated.
The old version of the bindings is now deprecated and will be removed in some future version.

== Features ==

The new module features :
* a complete cover of the libvlc/MediaControl API, since it is automatically generated from the include files.
* no compilation hassle: the generated module is pure python.
* no versioning hassle: the same module works with multiple VLC versions.
* a [http://www.advene.org/download/python-ctypes/doc/ complete documentation].

== Download ==

You can download the [http://www.advene.org/download/python-ctypes/ vlc.py] module from the [http://www.advene.org/ Advene] website. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

Alternatively, you can generate it by yourself using the generate.py program and accompanying files in the vlc source tree (see [http://git.videolan.org/?p=vlc.git;a=tree;f=bindings/python-ctypes]).

== Usage ==

The vlc.py module is also a runnable example player application (see code at the end of the module, starting from the line "if __name__ == '__main__'). A helper module [http://git.videolan.org/?p=vlc.git;a=tree;f=bindings/python-
ctypes;hb=HEAD] provides a pygtk VLCWidget() to ease integration.

Documentation:Modules/netsync

2008-12-23T09:38:36Z

Dionoea: Looks like netsync not being in (some?) 0.9 builds is a buildsystem issue (the module is still available)

{{Module|name=netsync|first_version=0.8.0|type=Video output|description=Synchronise remote VLC instances}}

Use this module to keep several clients synchronised on a single VLC stream.

{{Option|name=netsync-master|default=disabled|description=Act as master}}
{{Option|name=netsync-master-ip|value=string|default=""|description=Master client ip address}}

Common uses of this module are:
* Synchronise lots of loud PC speakers during a party;
* Synchronise several computers playing parts of a [[Documentation:Modules/wall|video wall]].

Here's a small example:
:We're going to be listening to a multicast stream.
:Run a client as master syncronisation client (master has IP address 192.168.0.1):
%''' vlc udp://@239.255.1.1 --control netsync --netsync-master '''
:And on the other clients:
%''' vlc udp://@239.255.1.1 --control netsync --netsync-master-ip 192.168.0.1 '''

{{Documentation}}

Documentation:Modules/screen

2008-12-17T11:24:11Z

Dionoea: /* Options */

{{Module|name=screen|type=Access|description=screen capture}}

Stream or save a video of your computer screen.

== Options ==
{{Option
|name=screen-caching
|value=integer
|description=Time in milliseconds
}}

{{Option
|name=screen-fps
|value=integer
|default=0
|description=Capture frames per second
}}

{{Option
|name=screen-fragment-size
|value=integer
|default=0
|description=(Windows only) Optimize the capture by fragmenting the screen in chunks of predefined height (16 might be a good value, and 0 means disabled)
}}

{{Option
|name=screen-top
|value=integer
|default=0
|description=The top edge coordinate of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-left
|value=integer
|default=0
|description=The left edge coordinate of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-width
|value=integer
|default=<full screen width>
|description=The width of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-height
|value=integer
|default=<full screen height>
|description=The height of the subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-follow-mouse, no-screen-follow-mouse
|default=no-screen-follow-mouse
|description=Follow the mouse when capturing a subscreen. (New in VLC 0.9.0 on x11, New in VLC 1.0.0 on Windows)
}}

{{Option
|name=screen-mouse-image
|value=filename
|default=""
|description=Mouse pointer image to use. If specified, the pointer will be overlayed on the captured video. (New in VLC 1.0.0, Windows and x11 only)
}}

Run...
% '''vlc -H'''
...for the definitive options for your version.

== Example ==
Capture a screen:
% '''vlc screen:// --screen-fps=1 --screen-width=100 --screen-height=100'''
The screen thus captured is 100x100 pixels in from the top left corner of the active screen.

{{Stub}}

{{Documentation}}

Documentation:Modules/screen

2008-12-17T11:21:57Z

Dionoea:

{{Module|name=screen|type=Access|description=screen capture}}

Stream or save a video of your computer screen.

== Options ==
{{Option
|name=screen-caching
|value=integer
|description=Time in milliseconds
}}

{{Option
|name=screen-fps
|value=integer
|default=0
|description=Capture frames per second
}}

{{Option
|name=screen-fragment-size
|value=integer
|default=0
|description=(Windows only) Optimize the capture by fragmenting the screen in chunks of predefined height (16 might be a good value, and 0 means disabled)
}}

{{Option
|name=screen-top
|value=integer
|default=0
|description=The top edge coordinate of the subscreen. (New in VLC 1.0.0, Windows and Linux only)
}}

{{Option
|name=screen-left
|value=integer
|default=0
|description=The left edge coordinate of the subscreen. (New in VLC 1.0.0, Windows and Linux only)
}}

{{Option
|name=screen-width
|value=integer
|default=<full screen width>
|description=The width of the subscreen. (New in VLC 1.0.0, Windows and Linux only)
}}

{{Option
|name=screen-height
|value=integer
|default=<full screen height>
|description=The height of the subscreen. (New in VLC 1.0.0, Windows and Linux only)
}}

{{Option
|name=screen-follow-mouse, no-screen-follow-mouse
|default=no-screen-follow-mouse
|description=Follow the mouse when capturing a subscreen. (New in VLC 1.0.0, Windows and Linux only)
}}

{{Option
|name=screen-mouse-image
|value=filename
|default=""
|description=Mouse pointer image to use. If specified, the pointer will be overlayed on the captured video. (New in VLC 1.0.0, Windows and Linux only)
}}

Run...
% '''vlc -H'''
...for the definitive options for your version.

== Example ==
Capture a screen:
% '''vlc screen:// --screen-fps=1 --screen-width=100 --screen-height=100'''
The screen thus captured is 100x100 pixels in from the top left corner of the active screen.

{{Stub}}

{{Documentation}}

User talk:Nhumfrey

2008-12-17T11:18:00Z

Dionoea: New page: Hello, Thanks for your help on the VLC documentation. I see that you added documentation for an OSC module but can't find it in the VLC tree. (I haven't been following development for the ...

Hello,
Thanks for your help on the VLC documentation. I see that you added documentation for an OSC module but can't find it in the VLC tree. (I haven't been following development for the last 2 or 3 months so I could have missed something.) Is this officially included in VLC? If not, it could be a good idea to add a flag to the module template to mention that a module isn't part of the official VLC tree. Cheers, [[User:Dionoea|Dionoea]] 12:18, 17 December 2008 (CET)

Qt and GTK

2008-09-21T00:49:01Z

Dionoea:

VLC media player 0.9 introduces a new interface based on the Qt toolkit.

Some of you, using GNOME or Xfce, seem reticent to that change, but let us explain a few things:

== VLC media player interface is a PLUGIN ==
* You can use VLC in command line, with the http interface, or even the old wx interface, that you can compile.

== VLC media player '''DOES NOT DEPEND''' on kdelibs ==

VLC media player Qt module needs:
* libQtCore,
* libQtGui,
* libvlc

That's it.

== How to have a Native look of VLC using Qt inside GTK environnement ==

You can use trolltech's QGtkStyle project to get a native GTK look. See http://labs.trolltech.com/page/Projects/Styles/GtkStyle for more information.

Qt and GTK

2008-09-21T00:47:17Z

Dionoea:

Qt and GTK

2008-09-17T16:36:16Z

Dionoea:

What is cool in 0.9

2008-09-14T23:20:11Z

Dionoea: /* A bit more */

This page is intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "'''Important features (AKA: the cool stuff)'''" kernelnewbies-like page, so you don't have to read the complete changelog.

== Very short summary ==

=== One liner ===
The 0.9 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

=== A bit more ===
For video playback, new protocols, new codecs, new demuxers and many bug-fixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework.<br /> Scripts written in lua can expand VLC media player's capabilities (read Youtube, Dailymotion URLs, fetch meta-data...)

If you are a ''journalist'', ''press'' related or a ''blogger'', please look [[What_is_cool_in_0.9#Press|here]]. If you distribute VLC on your website, please do the same. In both case, please state that we [[Help us|need help]].

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

<html><object width="400" height="302"> <param name="allowfullscreen" value="true" /> <param name="allowscriptaccess" value="always" /> <param name="movie" value="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" /> <embed src="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" type="application/x-shockwave-flash" allowfullscreen="true" allowscriptaccess="always" width="400" height="302"></embed></object></html>

You can also get [http://www.videolan.org/videos/ better quality], [http://www.youtube.com/watch?v=zVhk7Kq1rEU Youtube] or [http://www.dailymotion.com/dionoea/video/11351932 dailymotion] versions of this video.

== Summary ==

=== Interface ===

A new interface module based on the Qt toolkit has been added to VLC. If you are a '''GNOME''' or '''Xfce''' user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controller
And many other improvements and bug-fixes.

Moreover, some global hotkeys plugin can be found on the forum.

=== Playlist ===

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

=== Playback ===

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, camcorder codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance. Many thanks to the [http://ffmpeg.org FFmpeg project] which can take most of the credit for these improvements.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight Webcams, v4l2 on Linux and many other ones.

=== Filters ===

Many new audio and video filters have been added:
* New video filters like puzzle game, color extracting, sharpen, logo erasing, blue-screen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

=== Developers ===

* libVLC has been rewritten and split and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

=== Misc ===

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

== Long summary and details ==

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

You can also have the mailing list information on http://mailman.videolan.org

== Press ==

If you are press related, can you please note a few things:
* The software name is "VLC media player", not "VLC Media Player", not "VideoLAN", not "VideoLan Client" nor any other variation.
* The team behind videolan.org is "VideoLAN", not "Videolan", not "VLC folks", nor "vlc".

Please be nice to state that we need help to develop the software, and link to the [[Help us]] page.

What is cool in 0.9

2008-09-14T23:17:37Z

Dionoea:

This page is intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "'''Important features (AKA: the cool stuff)'''" kernelnewbies-like page, so you don't have to read the complete changelog.

== Very short summary ==

=== One liner ===
The 0.9 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

=== A bit more ===
For video playback, new protocols, new codecs, new demuxers and many bug-fixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework.<br /> Scripts written in lua can expand VLC media player's capabilities (read Youtube, Dailymotion URLs, fetch meta-data...)

If you are ''journalist'', ''press'' related or a ''blogger'', please look [[What_is_cool_in_0.9#Press|here]]. If you distribute VLC on your website, please do the same. In both case, please state that [[Help us|need help]].

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

<html><object width="400" height="302"> <param name="allowfullscreen" value="true" /> <param name="allowscriptaccess" value="always" /> <param name="movie" value="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" /> <embed src="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" type="application/x-shockwave-flash" allowfullscreen="true" allowscriptaccess="always" width="400" height="302"></embed></object></html>

You can also get [http://www.videolan.org/videos/ better quality], [http://www.youtube.com/watch?v=zVhk7Kq1rEU Youtube] or [http://www.dailymotion.com/dionoea/video/11351932 dailymotion] versions of this video.

== Summary ==

=== Interface ===

A new interface module based on the Qt toolkit has been added to VLC. If you are a '''GNOME''' or '''Xfce''' user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controller
And many other improvements and bug-fixes.

Moreover, some global hotkeys plugin can be found on the forum.

=== Playlist ===

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

=== Playback ===

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, camcorder codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance. Many thanks to the [http://ffmpeg.org FFmpeg project] which can take most of the credit for these improvements.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight Webcams, v4l2 on Linux and many other ones.

=== Filters ===

Many new audio and video filters have been added:
* New video filters like puzzle game, color extracting, sharpen, logo erasing, blue-screen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

=== Developers ===

* libVLC has been rewritten and split and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

=== Misc ===

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

== Long summary and details ==

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

You can also have the mailing list information on http://mailman.videolan.org

== Press ==

If you are press related, can you please note a few things:
* The software name is "VLC media player", not "VLC Media Player", not "VideoLAN", not "VideoLan Client" nor any other variation.
* The team behind videolan.org is "VideoLAN", not "Videolan", not "VLC folks", nor "vlc".

Please be nice to state that we need help to develop the software, and link to the [[Help us]] page.

What is cool in 0.9

2008-09-14T23:15:08Z

Dionoea: /* Playback */

This page is intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "'''Important features (AKA: the cool stuff)'''" kernelnewbies-like page, so you don't have to read the complete changelog.

== Very short summary ==

=== One liner ===
The 0.9 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

=== A bit more ===
For video playback, new protocols, new codecs, new demuxers and many bug-fixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework.<br /> Scripts written in lua can expand VLC media player's capabilities (read Youtube, Dailymotion URLs, fetch meta-data...)

If you are ''journalist'', ''press'' related or a ''blogger'', please look [[What_is_cool_in_0.9#Press|here]]. If you distribute VLC on your website, please do the same. In both case, please state that [[Help us|need help]].

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

<html><object width="400" height="302"> <param name="allowfullscreen" value="true" /> <param name="allowscriptaccess" value="always" /> <param name="movie" value="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" /> <embed src="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" type="application/x-shockwave-flash" allowfullscreen="true" allowscriptaccess="always" width="400" height="302"></embed></object></html>

You can find [http://www.videolan.org/videos/ better quality Videos], [http://www.youtube.com/watch?v=zVhk7Kq1rEU Youtube] or [http://www.dailymotion.com/dionoea/video/11351932 dailymotion].

== Summary ==

=== Interface ===

A new interface module based on the Qt toolkit has been added to VLC. If you are a '''GNOME''' or '''Xfce''' user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controller
And many other improvements and bug-fixes.

Moreover, some global hotkeys plugin can be found on the forum.

=== Playlist ===

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

=== Playback ===

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, camcorder codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance. Many thanks to the [http://ffmpeg.org FFmpeg project] which can take most of the credit for these improvements.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight Webcams, v4l2 on Linux and many other ones.

=== Filters ===

Many new audio and video filters have been added:
* New video filters like puzzle game, color extracting, sharpen, logo erasing, blue-screen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

=== Developers ===

* libVLC has been rewritten and splitted and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

=== Misc ===

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

== Long summary and details ==

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

You can also have the mailing list information on http://mailman.videolan.org

== Press ==

If you are press related, can you please note a few things:
* The software name is "VLC media player", not "VLC Media Player", not "VideoLAN", not "VideoLan Client" nor any other variation.
* The team behind videolan.org is "VideoLAN", not "Videolan", not "VLC folks", nor "vlc".

Please be nice to state that we need help to develop the software, and link to the [[Help us]] page.

What is cool in 0.9

2008-09-14T23:14:27Z

Dionoea: /* Playback */

This page is intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "'''Important features (AKA: the cool stuff)'''" kernelnewbies-like page, so you don't have to read the complete changelog.

== Very short summary ==

=== One liner ===
The 0.9 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

=== A bit more ===
For video playback, new protocols, new codecs, new demuxers and many bug-fixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework.<br /> Scripts written in lua can expand VLC media player's capabilities (read Youtube, Dailymotion URLs, fetch meta-data...)

If you are ''journalist'', ''press'' related or a ''blogger'', please look [[What_is_cool_in_0.9#Press|here]]. If you distribute VLC on your website, please do the same. In both case, please state that [[Help us|need help]].

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

<html><object width="400" height="302"> <param name="allowfullscreen" value="true" /> <param name="allowscriptaccess" value="always" /> <param name="movie" value="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" /> <embed src="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" type="application/x-shockwave-flash" allowfullscreen="true" allowscriptaccess="always" width="400" height="302"></embed></object></html>

You can find [http://www.videolan.org/videos/ better quality Videos], [http://www.youtube.com/watch?v=zVhk7Kq1rEU Youtube] or [http://www.dailymotion.com/dionoea/video/11351932 dailymotion].

== Summary ==

=== Interface ===

A new interface module based on the Qt toolkit has been added to VLC. If you are a '''GNOME''' or '''Xfce''' user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controller
And many other improvements and bug-fixes.

Moreover, some global hotkeys plugin can be found on the forum.

=== Playlist ===

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

=== Playback ===

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, camcorder codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance. Many thanks to the [http://ffmpeg.org FFmpeg project] which can take most of the credits for these improvements.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight Webcams, v4l2 on Linux and many other ones.

=== Filters ===

Many new audio and video filters have been added:
* New video filters like puzzle game, color extracting, sharpen, logo erasing, blue-screen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

=== Developers ===

* libVLC has been rewritten and splitted and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

=== Misc ===

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

== Long summary and details ==

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

You can also have the mailing list information on http://mailman.videolan.org

== Press ==

If you are press related, can you please note a few things:
* The software name is "VLC media player", not "VLC Media Player", not "VideoLAN", not "VideoLan Client" nor any other variation.
* The team behind videolan.org is "VideoLAN", not "Videolan", not "VLC folks", nor "vlc".

Please be nice to state that we need help to develop the software, and link to the [[Help us]] page.

What is cool in 0.9

2008-09-14T21:56:46Z

Dionoea:

This page is intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "'''Important features (AKA: the cool stuff)'''" kernelnewbies-like page, so you don't have to read the complete changelog.

== Very short summary ==

=== One liner ===
The 0.9 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

=== A bit more ===
For video playback, new protocols, new codecs, new demuxers and many bug-fixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework.<br /> Scripts written in lua can expand VLC media player's capabilities (read Youtube, Dailymotion URLs, fetch meta-data...)

If you are ''journalist'', ''press'' related or a ''blogger'', please look [[What_is_cool_in_0.9#Press|here]]. If you distribute VLC on your website, please do the same. In both case, please state that [[Help us|need help]].

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

<html><object width="400" height="302"> <param name="allowfullscreen" value="true" /> <param name="allowscriptaccess" value="always" /> <param name="movie" value="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" /> <embed src="http://vimeo.com/moogaloop.swf?clip_id=1732418&server=vimeo.com&show_title=1&show_byline=1&show_portrait=0&color=&fullscreen=1" type="application/x-shockwave-flash" allowfullscreen="true" allowscriptaccess="always" width="400" height="302"></embed></object></html>

You can find [http://www.videolan.org/videos/ better quality Videos].

== Summary ==

=== Interface ===

A new interface module based on the Qt toolkit has been added to VLC. If you are a GNOME user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controller
And many other improvements and bug-fixes.

Moreover, some global hotkeys plugin can be found on the forum.

=== Playlist ===

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

=== Playback ===

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, camcorder codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight Webcams, v4l2 on Linux and many other ones.

=== Filters ===

Many new audio and video filters have been added:
* New video filters like puzzle game, color extracting, sharpen, logo erasing, blue-screen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

=== Developers ===

* libVLC has been rewritten and splitted and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

=== Misc ===

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

== Long summary and details ==

If this page is not detailed enough for you, please read [[Next_changes]]. If you want the complete ''Changelog'', see [http://git.videolan.org/?p=vlc.git;a=log;h=0.9-bugfix Git].

You can also have the mailing list information on http://mailman.videolan.org

== Press ==

If you are press related, can you please note a few things:
* The software name is "VLC media player", not "VLC Media Player", not "VideoLAN", not "VideoLan Client" nor any other variation.
* The team behind videolan.org is "VideoLAN", not "Videolan", not "VLC folks", nor "vlc".

Please be nice to state that we need help to develop the software, and link to the [[Help us]] page.

Documentation:Building Lua Playlist Scripts

2008-09-04T22:50:57Z

Dionoea: /* Reference */

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.peek( 512 ), "gvp_version:" )
end

The '''vlc.peek(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==

Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

* [http://www.videolan.org/developers/vlc/share/lua/README.txt Global VLC Lua README]
* [http://www.videolan.org/developers/vlc/share/lua/playlist/README.txt Playlist script specific README]

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

What is cool in 0.9.0

2008-09-03T23:50:30Z

Dionoea: /* Filters */

This page is a '''draft''' intended to explain what are the cool features of '''''VLC media player 0.9''''', codename '''Grishenko'''.

Think about it as a "Cool features from kernelnewbies"-like page.

== Short summary ==

The 0.9.0 version of {{VLC}} adds a new interface module for Linux, Unix and Windows, a media library and an improved playlist, many new inputs and codecs support and many new audio and video filters.

For video playback, new protocols, new codecs, new demuxers and many bugfixes have been added to support more formats.

For audio playback, cover art and metadata support (and editing) have been vastly enhanced. It can play audio when the playback speed is changed.

For the developers, libVLC has been simplified and improved, many bindings for many languages were added and there is a new Mac OS X Framework. Scripts written in lua can expand VLC media player's capacities.

For more details, please read [[Next_changes]].

== Interface ==

A new interface module based on the Qt toolkit has been added to VLC. If you are a GNOME user, '''before trolling''', please read [[Qt and GTK|this]].

This new interface module has a few improvements on the old one:
* Simplified settings and dialogs
* Media library integration
* Album art displaying and metadata editing
* Live activation of Video and audio filters
* Basic encoding profiles
* Multiple start modes (classic, enhanced and minimalist)
* System tray icon and minimizing
* Fullscreen controler
And many other improvements and bugfixes.

Moreover, some global hotkeys plugin can be found on the forum.

== Playlist ==

The playlist has been improved in many ways, in addition to the new Media Library ''(very simple so far, but will be extended in the future)'':
* Live Searching in the playlist,
* Youtube, Dailymotion, Google Video and similar services URL can be scripted in VLC to play directly those URLs,
* last.fm submission support,
* Album art support,
* Better metadata tagging reading and writing support for audio files.

== Playback ==

A lot of new decoders, demuxers, and protocols have been added.

There are new codecs support, like Flash video variants, Camescope codecs (M2TS ones), Dirac, Atrac3, H.264 PAFF, APE audio, RealVideo, VC-3, Fraps and others, but also better decoding and better performance.

There are improvements in the demuxers and new supports (subtitles format rework with many new formats, Tivo2, OMA, MIDI support...).

Tag supports of audio files have vastly been improved(fix of APE, AAC, OGG tags,...)

This version also supports DVB windows devices (BDA), iSight webcams, v4l2 on linux and many other ones.

== Filters ==

Many new audio and video filters have been added:
* New video filters like puzzle game, colour extracting, sharpen, logo erasing, bluescreen and more have been added.
* New audio filters have introduced Replay Gain support, Faster/Slower audio playback with pitch correction and a spatializer.

Most video filters can now be streamed.

== Developers ==

* libVLC has been rewritten ? and supports externally built plugins
* VLCKit, a Mac OS X Framework, enables external developers to develop applications around VLC.
* New bindings can be found on the wiki and the forums

== Misc ==

A new update system, more secured, was developed for this release.

New localizations in Finnish, Persian, Polish, Punjabi, Bulgarian have joined the old ones.

VideoLAN Sites

2008-09-03T11:04:30Z

Dionoea: /* Ganesh */

= WebSites =
== VideoLAN public sites ==
* [http://www.videolan.org Main Site]
* [http://wiki.videolan.org Wiki]
* [http://forum.videolan.org Forum]
* [http://planet.videolan.org Developers' News]
* [ftp://ftp.videolan.org/pub/videolan/ Main FTP]
* [http://paste.videolan.org/ PasteBin]
* [http://lists.videolan.org/ Files Attachments from the mailing-lists]

== Developers ==
* [http://developers.videolan.org Main Developers Site]
* [http://nightlies.videolan.org Nightly builds]
* [http://buildbot.videolan.org Buildbot for Automatic Builds]
* [http://trac.videolan.org Trac, bugs, features, roadmap]
* [http://git.videolan.org Gitweb]
* [http://mirrors.videolan.org Mirrors check]
* [http://downloads.videolan.org/pub/ Download Site]
* [http://stats.videolan.org Servers stats]
* [ftp://streams.videolan.org Reference and buggy stream collection]

== Update ==
* [http://update.videolan.org VLC update site] - Non human readable site !

== Other ==
* [http://getvlcstatus.videolan.org VLC Status Page] (This is humour, of course)

= Servers =
== Ganesh ==
* ganesh.videolan.org
* developers.videolan.org
* download.videolan.org, downloads.videolan.org
* ftp.videolan.org
* rsync.videolan.org
* forum.videolan.org
* lists.videolan.org
* mirrors.videolan.org
* planet.videolan.org
* paste.videolan.org
* stats.videolan.org
* svn.videolan.org
* trac.videolan.org
* update.videolan.org
* www.videolan.org

The primary web and FTP server
Hosted in one of FREE S.A.S' datacenter.

== Altair ==
* altair.videolan.org
* buildbot.videolan.org
* nightlies.videolan.org
* people.videolan.org
* git-soc.videolan.org

It is the dev server, that hosts the automatic builds.
Hosted at VIA.

== Epsilon (Shipped back, RIP) ==
*epsilon.videolan.org

Used to be...
Mac Intel Developer Preview machine
Also a nightly build machine for Mac OS X Intel.
Hosted at VIA.

== Jones ==
*jones.videolan.org
* streams.videolan.org
* hudson.videolan.org

Mac Pro (Intel)
build bot machine for Mac OS X Intel.
Hosted at VIA.
Named after Christmas Jones

== Veda ==
*veda.student.utwente.nl
PowerMac - 1.8Ghz Dual, 750MB RAM
Primary Mac OS X PowerPC development machine. Hosts the nightly build client for the OSX PowerPC platform.
Hosted by TheDJ.

== Deneb ==
*deneb.student.utwente.nl
Imac 17" - 2Ghz DC, 1GB RAM
Primary Mac OS X Intel development machine. Hosts the nightly build client for the OSX Intel platform.
Hosted by TheDJ.

== Skanda ==
* skanda.videolan.org
* wiki.videolan.org
* git.videolan.org
* svn.videolan.org
* mailman.videolan.org
* download2.videolan.org (for backup, currently unused)
Hosted by OVH with donations of Actech. For more information contact [[User:Remiii|Remiii]].

Some server pictures can be found on: http://people.videolan.org/~dionoea/servers/

{{stub}}

[[Category:About VideoLAN]]

VideoLAN Sites

2008-09-03T11:02:54Z

Dionoea: /* Krishna */ -> We don't use it to host anything anymore.

= WebSites =
== VideoLAN public sites ==
* [http://www.videolan.org Main Site]
* [http://wiki.videolan.org Wiki]
* [http://forum.videolan.org Forum]
* [http://planet.videolan.org Developers' News]
* [ftp://ftp.videolan.org/pub/videolan/ Main FTP]
* [http://paste.videolan.org/ PasteBin]
* [http://lists.videolan.org/ Files Attachments from the mailing-lists]

== Developers ==
* [http://developers.videolan.org Main Developers Site]
* [http://nightlies.videolan.org Nightly builds]
* [http://buildbot.videolan.org Buildbot for Automatic Builds]
* [http://trac.videolan.org Trac, bugs, features, roadmap]
* [http://git.videolan.org Gitweb]
* [http://mirrors.videolan.org Mirrors check]
* [http://downloads.videolan.org/pub/ Download Site]
* [http://stats.videolan.org Servers stats]
* [ftp://streams.videolan.org Reference and buggy stream collection]

== Update ==
* [http://update.videolan.org VLC update site] - Non human readable site !

== Other ==
* [http://getvlcstatus.videolan.org VLC Status Page] (This is humour, of course)

= Servers =
== Ganesh ==
* ganesh.videolan.org
* developers.videolan.org
* download.videolan.org, downloads.videolan.org
* ftp.videolan.org
* forum.videolan.org
* lists.videolan.org
* mirrors.videolan.org
* planet.videolan.org
* paste.videolan.org
* stats.videolan.org
* svn.videolan.org
* trac.videolan.org
* update.videolan.org
* www.videolan.org

The primary web and FTP server
Hosted in one of FREE S.A.S' datacenter.

== Altair ==
* altair.videolan.org
* buildbot.videolan.org
* nightlies.videolan.org
* people.videolan.org
* git-soc.videolan.org

It is the dev server, that hosts the automatic builds.
Hosted at VIA.

== Epsilon (Shipped back, RIP) ==
*epsilon.videolan.org

Used to be...
Mac Intel Developer Preview machine
Also a nightly build machine for Mac OS X Intel.
Hosted at VIA.

== Jones ==
*jones.videolan.org
* streams.videolan.org
* hudson.videolan.org

Mac Pro (Intel)
build bot machine for Mac OS X Intel.
Hosted at VIA.
Named after Christmas Jones

== Veda ==
*veda.student.utwente.nl
PowerMac - 1.8Ghz Dual, 750MB RAM
Primary Mac OS X PowerPC development machine. Hosts the nightly build client for the OSX PowerPC platform.
Hosted by TheDJ.

== Deneb ==
*deneb.student.utwente.nl
Imac 17" - 2Ghz DC, 1GB RAM
Primary Mac OS X Intel development machine. Hosts the nightly build client for the OSX Intel platform.
Hosted by TheDJ.

== Skanda ==
* skanda.videolan.org
* wiki.videolan.org
* git.videolan.org
* svn.videolan.org
* mailman.videolan.org
* download2.videolan.org (for backup, currently unused)
Hosted by OVH with donations of Actech. For more information contact [[User:Remiii|Remiii]].

Some server pictures can be found on: http://people.videolan.org/~dionoea/servers/

{{stub}}

[[Category:About VideoLAN]]

VideoLAN Sites

2008-09-03T10:59:40Z

Dionoea: /* Skanda */

= WebSites =
== VideoLAN public sites ==
* [http://www.videolan.org Main Site]
* [http://wiki.videolan.org Wiki]
* [http://forum.videolan.org Forum]
* [http://planet.videolan.org Developers' News]
* [ftp://ftp.videolan.org/pub/videolan/ Main FTP]
* [http://paste.videolan.org/ PasteBin]
* [http://lists.videolan.org/ Files Attachments from the mailing-lists]

== Developers ==
* [http://developers.videolan.org Main Developers Site]
* [http://nightlies.videolan.org Nightly builds]
* [http://buildbot.videolan.org Buildbot for Automatic Builds]
* [http://trac.videolan.org Trac, bugs, features, roadmap]
* [http://git.videolan.org Gitweb]
* [http://mirrors.videolan.org Mirrors check]
* [http://downloads.videolan.org/pub/ Download Site]
* [http://stats.videolan.org Servers stats]
* [ftp://streams.videolan.org Reference and buggy stream collection]

== Update ==
* [http://update.videolan.org VLC update site] - Non human readable site !

== Other ==
* [http://getvlcstatus.videolan.org VLC Status Page] (This is humour, of course)

= Servers =
== Ganesh ==
* ganesh.videolan.org
* developers.videolan.org
* download.videolan.org, downloads.videolan.org
* ftp.videolan.org
* forum.videolan.org
* lists.videolan.org
* mirrors.videolan.org
* planet.videolan.org
* paste.videolan.org
* stats.videolan.org
* svn.videolan.org
* trac.videolan.org
* update.videolan.org
* www.videolan.org

The primary web and FTP server
Hosted in one of FREE S.A.S' datacenter.

== Altair ==
* altair.videolan.org
* buildbot.videolan.org
* nightlies.videolan.org
* people.videolan.org
* git-soc.videolan.org

It is the dev server, that hosts the automatic builds.
Hosted at VIA.

== Krishna ==
It is one of [http://www.via.ecp.fr VIA]'s servers.
* wiki.videolan.org

== Epsilon (Shipped back, RIP) ==
*epsilon.videolan.org

Used to be...
Mac Intel Developer Preview machine
Also a nightly build machine for Mac OS X Intel.
Hosted at VIA.

== Jones ==
*jones.videolan.org
* streams.videolan.org
* hudson.videolan.org

Mac Pro (Intel)
build bot machine for Mac OS X Intel.
Hosted at VIA.
Named after Christmas Jones

== Veda ==
*veda.student.utwente.nl
PowerMac - 1.8Ghz Dual, 750MB RAM
Primary Mac OS X PowerPC development machine. Hosts the nightly build client for the OSX PowerPC platform.
Hosted by TheDJ.

== Deneb ==
*deneb.student.utwente.nl
Imac 17" - 2Ghz DC, 1GB RAM
Primary Mac OS X Intel development machine. Hosts the nightly build client for the OSX Intel platform.
Hosted by TheDJ.

== Skanda ==
* skanda.videolan.org
* wiki.videolan.org
* git.videolan.org
* svn.videolan.org
* mailman.videolan.org
* download2.videolan.org (for backup, currently unused)
Hosted by OVH with donations of Actech. For more information contact [[User:Remiii|Remiii]].

Some server pictures can be found on: http://people.videolan.org/~dionoea/servers/

{{stub}}

[[Category:About VideoLAN]]

VideoLAN Sites

2008-09-03T10:59:19Z

Dionoea: /* Skanda */

= WebSites =
== VideoLAN public sites ==
* [http://www.videolan.org Main Site]
* [http://wiki.videolan.org Wiki]
* [http://forum.videolan.org Forum]
* [http://planet.videolan.org Developers' News]
* [ftp://ftp.videolan.org/pub/videolan/ Main FTP]
* [http://paste.videolan.org/ PasteBin]
* [http://lists.videolan.org/ Files Attachments from the mailing-lists]

== Developers ==
* [http://developers.videolan.org Main Developers Site]
* [http://nightlies.videolan.org Nightly builds]
* [http://buildbot.videolan.org Buildbot for Automatic Builds]
* [http://trac.videolan.org Trac, bugs, features, roadmap]
* [http://git.videolan.org Gitweb]
* [http://mirrors.videolan.org Mirrors check]
* [http://downloads.videolan.org/pub/ Download Site]
* [http://stats.videolan.org Servers stats]
* [ftp://streams.videolan.org Reference and buggy stream collection]

== Update ==
* [http://update.videolan.org VLC update site] - Non human readable site !

== Other ==
* [http://getvlcstatus.videolan.org VLC Status Page] (This is humour, of course)

= Servers =
== Ganesh ==
* ganesh.videolan.org
* developers.videolan.org
* download.videolan.org, downloads.videolan.org
* ftp.videolan.org
* forum.videolan.org
* lists.videolan.org
* mirrors.videolan.org
* planet.videolan.org
* paste.videolan.org
* stats.videolan.org
* svn.videolan.org
* trac.videolan.org
* update.videolan.org
* www.videolan.org

The primary web and FTP server
Hosted in one of FREE S.A.S' datacenter.

== Altair ==
* altair.videolan.org
* buildbot.videolan.org
* nightlies.videolan.org
* people.videolan.org
* git-soc.videolan.org

It is the dev server, that hosts the automatic builds.
Hosted at VIA.

== Krishna ==
It is one of [http://www.via.ecp.fr VIA]'s servers.
* wiki.videolan.org

== Epsilon (Shipped back, RIP) ==
*epsilon.videolan.org

Used to be...
Mac Intel Developer Preview machine
Also a nightly build machine for Mac OS X Intel.
Hosted at VIA.

== Jones ==
*jones.videolan.org
* streams.videolan.org
* hudson.videolan.org

Mac Pro (Intel)
build bot machine for Mac OS X Intel.
Hosted at VIA.
Named after Christmas Jones

== Veda ==
*veda.student.utwente.nl
PowerMac - 1.8Ghz Dual, 750MB RAM
Primary Mac OS X PowerPC development machine. Hosts the nightly build client for the OSX PowerPC platform.
Hosted by TheDJ.

== Deneb ==
*deneb.student.utwente.nl
Imac 17" - 2Ghz DC, 1GB RAM
Primary Mac OS X Intel development machine. Hosts the nightly build client for the OSX Intel platform.
Hosted by TheDJ.

== Skanda ==
* skanda.videolan.org
* git.videolan.org
* svn.videolan.org
* mailman.videolan.org
* download2.videolan.org (for backup, currently unused)
Hosted by OVH with donations of Actech. For more information contact [[User:Remiii|Remiii]].

Some server pictures can be found on: http://people.videolan.org/~dionoea/servers/

{{stub}}

[[Category:About VideoLAN]]

VideoLAN Sites

2008-09-03T10:58:09Z

Dionoea: /* Ganesh */

= WebSites =
== VideoLAN public sites ==
* [http://www.videolan.org Main Site]
* [http://wiki.videolan.org Wiki]
* [http://forum.videolan.org Forum]
* [http://planet.videolan.org Developers' News]
* [ftp://ftp.videolan.org/pub/videolan/ Main FTP]
* [http://paste.videolan.org/ PasteBin]
* [http://lists.videolan.org/ Files Attachments from the mailing-lists]

== Developers ==
* [http://developers.videolan.org Main Developers Site]
* [http://nightlies.videolan.org Nightly builds]
* [http://buildbot.videolan.org Buildbot for Automatic Builds]
* [http://trac.videolan.org Trac, bugs, features, roadmap]
* [http://git.videolan.org Gitweb]
* [http://mirrors.videolan.org Mirrors check]
* [http://downloads.videolan.org/pub/ Download Site]
* [http://stats.videolan.org Servers stats]
* [ftp://streams.videolan.org Reference and buggy stream collection]

== Update ==
* [http://update.videolan.org VLC update site] - Non human readable site !

== Other ==
* [http://getvlcstatus.videolan.org VLC Status Page] (This is humour, of course)

= Servers =
== Ganesh ==
* ganesh.videolan.org
* developers.videolan.org
* download.videolan.org, downloads.videolan.org
* ftp.videolan.org
* forum.videolan.org
* lists.videolan.org
* mirrors.videolan.org
* planet.videolan.org
* paste.videolan.org
* stats.videolan.org
* svn.videolan.org
* trac.videolan.org
* update.videolan.org
* www.videolan.org

The primary web and FTP server
Hosted in one of FREE S.A.S' datacenter.

== Altair ==
* altair.videolan.org
* buildbot.videolan.org
* nightlies.videolan.org
* people.videolan.org
* git-soc.videolan.org

It is the dev server, that hosts the automatic builds.
Hosted at VIA.

== Krishna ==
It is one of [http://www.via.ecp.fr VIA]'s servers.
* wiki.videolan.org

== Epsilon (Shipped back, RIP) ==
*epsilon.videolan.org

Used to be...
Mac Intel Developer Preview machine
Also a nightly build machine for Mac OS X Intel.
Hosted at VIA.

== Jones ==
*jones.videolan.org
* streams.videolan.org
* hudson.videolan.org

Mac Pro (Intel)
build bot machine for Mac OS X Intel.
Hosted at VIA.
Named after Christmas Jones

== Veda ==
*veda.student.utwente.nl
PowerMac - 1.8Ghz Dual, 750MB RAM
Primary Mac OS X PowerPC development machine. Hosts the nightly build client for the OSX PowerPC platform.
Hosted by TheDJ.

== Deneb ==
*deneb.student.utwente.nl
Imac 17" - 2Ghz DC, 1GB RAM
Primary Mac OS X Intel development machine. Hosts the nightly build client for the OSX Intel platform.
Hosted by TheDJ.

== Skanda ==
*skanda.videolan.org
*git.videolan.org
Hosted by OVH with donations of Actech. For more information contact [[User:Remiii|Remiii]].

Some server pictures can be found on: http://people.videolan.org/~dionoea/servers/

{{stub}}

[[Category:About VideoLAN]]

User talk:Narendra Sisodiya

2008-09-03T10:57:20Z

Dionoea: New page: Please do *not* ask questions in the documentation pages. You can use http://forum.videolan.org for that. ~~~~

Please do *not* ask questions in the documentation pages. You can use http://forum.videolan.org for that. [[User:Dionoea|Dionoea]] 12:57, 3 September 2008 (CEST)

Documentation:Advanced Use of VLC

2008-09-03T10:56:27Z

Dionoea: Reverted edits by Narendra Sisodiya (Talk); changed back to last version by Jpsaman

{{RightMenu|documentation play howto toc}}

==Use the command line==

'''TODO: completely outdated'''

All standard operations of VLC should be available from the GUI. However, some complex operations can only be done from the command line and there are situations in which you don't need or want a GUI. Here is the complete description of VLC's command line and how to use it.

You need to be quite comfortable with command line usage to use this.

Note: Windows users have to use the ''--option-name="value"'' syntax instead of the ''--option-name value'' syntax.

===Getting help===

VLC uses a modular structure. The core mainly manages communication between modules. All the multimedia processing is done by modules. There are input modules, demultiplexers, decoders, video output modules, ...

This chapter will only describe the "general" options, i.e. the core options. Each module adds new options. For example, the HTTP input module will add options for caching, proxy, authentication, ...

By using '''vlc --help''', you will get the basic core options. '''vlc --longhelp''' will give all the basic options (core + modules). Adding '''--advanced''' will give the "advanced options" (for advanced users). So '''vlc --longhelp --advanced''' will give you all options. You can also append '''--help-verbose''' if you want more detailed help.

Also, you might want to get debug informations. To do this, use '''-v''' or '''-vv''' (this will show lower severity messages). If your console supports it, you can add '''--color to get messages in color.

===Opening streams===

The following commands start VLC and start reading the given element(s)

====Opening a file====

Start VLC with:

% '''vlc my_file'''

VLC should be able to recognize the file type. If it does not, you can force demultiplexer and decoder (see below).

A list of all video and audio codecs supported by VLC is available on the [http://www.videolan.org/vlc/features.html VLC features list].

====Opening a DVD or VCD, or an audio CD====

Start VLC with:

For a DVD with menus:
% '''vlc dvd://[device][@raw_device][@[title][:[chapter][:angle]]]'''

In most cases, '''vlc dvd://''' or '''vlc dvd://[device]''' will do. [device] is for example '''/dev/dvd''' on GNU/Linux or '''D:''' on Windows (complete path to your DVD drive).

or

(DVD without menus):

% '''vlc dvdsimple://[device][@raw_device][@[title][:[chapter][:angle]]]'''

or

(VCD):

% '''vlc vcd://[device][@{E|P|E|T|S}[number]]'''

or

(Audio CD):

% '''vlc cdda://[device][@[track]]'''

====Receiving a network stream====

To receive an unicast UDP stream (sent by VLS or VLC's stream output), start VLC with:

% '''vlc udp:[@:server_port]'''

If you use the default port (1234), '''vlc udp:''' will do. For more information, look at the Streaming Howto.

To receive an multicast UDP stream (sent by VLS or VLC's stream output), start VLC with:

% '''vlc udp:@multicast_address[:server_port]'''

To receive a SSM (source specific multicast) stream, you can use:

% '''vlc udp:server_address@multicast_address[:server_port]'''

This only works on OSs that support SSM (Windows XP and recent Linux kernels).

To receive a HTTP stream, start VLC with:

% '''vlc http://www.example.org/your_file.mpg'''

To receive a RTSP stream, start VLC with:</para>

% '''vlc rtsp://www.example.org/your_stream'''

===Modules selection===

VLC always try to select the most appropriate interface, input and output modules, among the ones available on the system, according to the stream it is given to read. However, you may wish to force the use of a specific module with the following options.

*'''--intf <module>''' allows you to select the interface module.
*'''--extraintf <module>''' allows you to select extra interface modules that will be launched in addition to the main one. This is mainly useful for special ''control'' interfaces, like HTTP, RC (Remote Control), ... (see below)
*'''--aout <module>''' allows you to select the audio output module.
*'''--vout <module>''' allows you to select the video output module.
*'''--memcpy <module>''' allows you to choose a memory copy module. You should probably never touch that.

You can get a listing of the available modules by using '''vlc -l'''

===Stream Output===

The Stream output system allows vlc to become a streaming server.

For more details on the stream output system, please have a look at the [[Documentation:Streaming HowTo|Streaming HowTo]].

===Other Options===

====Audio options====

*'''--noaudio''' disables audio output.
*'''--mono''' forces VLC to treat the stream in mono audio.
*'''--volume <integer>''' sets the level of audio output (between 0 and 1024).
*'''--aout-rate <integer>''' sets the audio output frequency (Hz). By default, VLC will try to autodetect this.
*'''--desync <integer>''' compensates desynchronization of audio (ms). (If audio and video streams are not synchronized, use this setting to delay the audio stream)
*'''--audio-filter <string>''' adds audio filters to the processing chain. Available filters are visual (visualizer with spectrum analyzer and oscilloscope), headphone (virtual headphone patialization) and normalizer (volume normalizer)

====Video options====

*'''--novideo''' disables video output.
*'''--greyscale''' turns video output into grayscale mode.
*'''--fullscreen''' ( or '''-f''') sets fullscreen video.
*'''--nooverlay''' disables hardware acceleration for the video output.
*'''--width, --height <integer>''' sets the video window dimensions. By default, the video window size will be adjusted to match the video dimensions.
*'''--zoom <float>''' adds a zoom factor.
*'''--aspect-ratio <mode>''' forces source aspect ratio. Modes are 4x3, 16x9, ...
*'''--spumargin <integer>''' forces SPU subtitles postion.
*'''--filter <string>''' adds video filters to the processing chain. You can add several filters, separated by commas
*'''--sub-filter <string>''' adds video subpictures filter to the processing chain.

====Playlist options====

*'''--random''' plays files randomly forever.
*'''--loop''' loops playlist on end.
*'''--repeat''' repeats current item until another item is forced
*'''--play-and-stop''' stops the playlist after each played item.

====Network options====

*'''--server-port <integer>''' sets server port.
*'''--iface <string>''' specifies the network interface to use.
*'''--iface-addr <string>''' specifies your network interface IP address.
*'''--mtu <integer>''' specifies the MTU of the network interface.
*'''--ipv6''' forces IPv6.
*'''--ipv4''' forces IPv4.

====CPU options====

You should probably not touch these options unless you know what you are doing.

*'''--nommx''' disables the use of MMX CPU extensions.
*'''--no3dn''' disables the use of 3D Now! CPU extensions.
*'''--nommxext''' disables the use of MMX Ext CPU extensions.
*'''--nosse''' disables the use of SSE CPU extensions.
*'''--noaltivec''' disables the use of Altivec CPU extensions.

====Miscellaneous options====

*'''--quiet''' deactivates all console messages.
*'''--color''' displays color messages.
*'''--search-path <string>''' specifies interface default search path.
*'''--plugin-path <string>''' specifies plugin search path.
*'''--no-plugins-cache''' disables the plugin cache (plugins cache speeds up startup)
*'''--dvd <string>''' specifies the default DVD device.
*'''--vcd <string>''' specifies the default VCD device.
*'''--program <integer>''' specifies program (SID) (for streams with several programs, like satellite ones).
*'''--audio-type <integer>''' specifies the default audio type to use with dvds.
*'''--audio-channel <integer>''' specifies the default audio channel to use with dvds.
*'''--spu-channel <integer>''' specifies the default subtitle channel to use with dvds.
*'''--version''' gives you information about the current VLC version.
*'''--module <module> ''' displays help about specified module. (Shortcut: '''-p''')

===Item-specific options===

There are many options that are related to items (like '''--novideo''', '''--codec''', '''--fullscreen''').

For all of these, you have the possibility to make them item-specific, using ":" instead of "--" and putting the option just after the concerned item.

Examples:

% '''vlc file1.mpg :fullscreen file2.mpg'''
will play file1.mpg in fullscreen mode and file2.mpg in the default mode (which is generally no fullscreen), whereas
% '''vlc --fullscreen file1.mpg file2.mpg'''
will play both files in fullscreen mode

% '''vlc --fullscreen file1.mpg :sub-file=file1.srt :no-fullscreen file2.mpg :filter=distort'''
will play file1.mpg in windowed (no-fullscreen) mode with the subtitles file file1.srt and will play file2.mpg with video filter distort enabled in fullscreen mode (item-specific options override global options)

==Advanced use of filters==

===Filters===

These are the old style VLC filters. They only apply to on screen display and thus cannot be streamed.

====Deinterlacing video filter====

Module name: '''deinterlace'''

*'''--deinterlace-mode {discard,blend,mean,bob,linear}''' choose a deinterlacing mode.

====Invert video filter====

Module name: '''invert'''

====Image properties filter====

Module name: '''adjust'''

*'''--contrast <float>''' Image contrast in the 0-2 range.
*'''--brightness <float>''' Image brightness in the 0-2 range.
*'''--hue <integer>''' Image hue in the 0-360 range.
*'''--saturation <float>''' Image saturation in the 0-3 range.
*'''-gamma <float>''' Image gamma in the 0-10 range.

====Wall video filter====

Module name: '''wall'''

This filter splits the output in several windows.

*'''--wall-cols <integer>''' Number of columns.
*'''--wall-rows <integer>''' Number of rows.
*'''--wall-active <string>''' Select the windows you want to display. To select windows 2 and 4 you would write '''--wall-active 2,4'''. When this option isn't specified, all windows are displayed.

====Video transformation filter====

Module name: '''transform'''

*'''--transform-type {90,180,270,hflip,vflip}''' Select rotation angle or symmetry.

====Distort video filter====

Module name: '''distort'''

====Clone video filter====

This filter clones the output window.

Module name: '''clone'''

*'''--clone-count <integer>''' Number of clones.
*'''--clone-vout-list <string>''' Comma separated string of video output modules.

====Crop video filter====

Module name: '''crop'''

*'''--crop-geometry <string>''' Set the geometry of the zone to crop. This is set as <width> x <height> + <left offset> + <top offset>.
*'''--autocrop''' Enable automatic black border cropping.

====Motion blur filter====

Module name: '''motionblur'''

*'''blur-factor <integer>''' Blur factor in the 1-127 range.

====Video pictures blending====

Module name: '''blend'''

====Video scaling filter====

Module name: '''scale'''

===Subpictures Filters===

These are the new VLC filters. They can be streamed.

====Time display sub filter====

Module name: '''time'''

*'''--time-format <string>''' Time format string. You can use the following special characters %Y = year, %m = month, %d = day, %H = hour, %M = minute, %S = second.
*'''--time-x <integer>''' X offset from the left in pixels.
*'''--time-y <integer>''' Y offset from the top in pixels.

====Marquee display sub filter====

Module name: '''marq'''

*'''--marq-marquee <string>''' Marquee text to display.
*'''--marq-x <integer>''' X offset from the left in pixels.
*'''--marq-y <integer>''' Y offset from the top in pixels.
*'''--marq-timeout <timeout>''' Defines the time the marquee must remain displayed in milliseconds. Default value is 0 (remain forever).

====Logo video filter====

Module name: '''logo'''

This filter can be used both as an old style filter or a subpictures filter.

*'''--logo-file <string>''' Full path of the PNG file to use.
*'''--logo-x <integer>''' X offset from the left in pixels.
*'''--logo-y <integer>''' Y offset from the top in pixels.
*'''--logo-transparency <integer>''' You can set the logo transparency value here (from 0 for full transparency to 255 for full opacity).

Note: You can move the logo by left-clicking on it.

==The HTTP interface==

VLC ships with a little HTTP server integrated. It is used both to stream using HTTP, and for the HTTP remote control interface.

To start VLC with the HTTP interface, use:
% '''vlc -I http [--http-src /directory/] [--http-host host:port]'''

If you want to have both the "normal" interface and the HTTP interface, use '''vlc --extraintf http'''.

The HTTP interface will start listening at host:port (<all interfaces>:8080 if omitted), and will reproduce the structure of /directory at http://host:port/ ( vlc_source_path/share/http if omitted ).

Use a browser to go to http://your_host_machine:port. You should be taken to the main page.

VLC is shipped with a set of files that should be enough for generic needs. It is also possible to customize pages. See [[Documentation:Play_HowTo/Building_Pages_for_the_HTTP_Interface]].

Available pages are:
* '''list was obsolete'''

==Other control interfaces==

VLC includes a number of so-called interfaces that are not really interfaces, but means of controlling VLC. Nevertheless, they are enabled by setting them as interface or extra interface, either in the Preferences, in General/Interface, or using '''-I''' or '''--extraintf''' on the command line.

===Hotkeys===

This module allows you to control VLC and playback via hotkeys. It is always enabled by default. You can use hotkeys in the video output window.

Hotkeys can be hacked by:
% '''vlc --key-<function> <code>'''

Code is composed by modifiers keys (Alt, Shift, Ctrl, Meta,Command) separated by a dash (-) and terminated by a key (a...z, +, =, -, ',', +, <, >, `, /, ;, ', \, [, ], *, Left, Right, Up, Down, Space, Enter, F1...F12, Home, End, Menu, Esc, Page Up, Page Down, Tab, Backspace, Mouse Wheel Up and Mouse Wheel Down). Main controls are available from hotkeys, such as : fullscreen, play-pause, faster, slower, next, prev, stop, quit, vol-up, etc. (use the '''--longhelp''' option for full list of functions).
For example, for binding fullscreen to Ctrl-f, run:
% '''vlc --key-fullscreen 'Ctrl-f' '''

===RC and RTCI===

These two interfaces allow you to control VLC from a command shell (possibly using a remote connexion or a Unix socket).

Start VLC with '''-I rc''' or '''--extraintf rc'''. When you get the '''Remote control interface initialized, `h' for help''' message, press h and Enter to get help about available commands.

To be able to remote connect to your VLC using a TCP socket (telnet-like connexion), use '''--rc-host your_host:port'''. Then, by connecting (using telnet or netcat) to the host on the given port, you will get the command shell.

To use a UNIX socket (local socket, this does not work for Windows), use '''--rc-unix /path/to/socket'''. Commands can then be passed using this UNIX socket.

The RTCI interface gives you more advanced options, such as marquee control for the marquee subpicture filter (See filter section).

===Ncurses===

This is a text interface, using ncurses library.

Start VLC with '''-I ncurses''' or '''--extraintf ncurses'''. You will then get something like that:

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-playlist.jpg The ncurses interface

Press h to get the list of all available commands, with a short description.

There is also a filebrowser available for the ncurses interface in order to add playlist items. Press 'B' to use it.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-ncurses-filebrowser.jpg The ncurses filebrowser

You can set the filebrowser starting point by launching vlc with the '''--browse-dir''' option:

% '''vlc -I ncurses --browse-dir /filebrowser/starting/point/'''

===Gestures===

Gestures provide a simple mouse gestures control. TODO

==The Mozilla plugin==

VLC can also be embedded in a web browser! The following browsers are supported [http://www.mozilla.org/ Mozilla], [http://www.mozilla.org/products/firefox/ Firefox] and [http://www.apple.com/macosx/features/safari Safari].

===Install the plugin===

====GNU/Linux Debian====

Install the ''mozilla-plugin-vlc'' package:

# '''apt-get update'''
# '''apt-get install mozilla-plugin-vlc'''

====Windows====

Quit Firefox or Mozilla.

Copy the two files in '''VLC_Installation_folder\mozilla''' (usually '''C:\Program Files\VideoLAN\VLC\mozilla''') to your mozilla plugins directory (Usually '''C:\Program Files\Mozilla\plugins''' or '''C:\Program Files\Mozilla
Firefox\plugins''').

Restart Firefox or Mozilla.

====MacOS X====

''The Mozilla/Safari plugin for MacOS X is only available from vlc version 0.8.5.1 and onwards.''

Quit Safari browser.

Download the Mozilla/safari plugin package from [http://www.videolan.org/vlc/download-macosx.html MacOS X download page].

Run the installer from the dmg image.

====Compile the sources yourself====

Please look at the [http://developers.videolan.org developers page] for information on how to do this.

===Use the mozilla plugin===

If you open a link to a video file handled by the VLC plugin (To get the list of handled types, browse to '''about:plugins''') or a page with an embedded video, the plugin should open and read the
video.

===Build HTML pages that use the plugin (VLC version up to 0.8.5)===

'''WARNING:''' the APIs described in this section are '''deprecated''', do not use,

The following API description is only valid uptill version 0.8.5 of the mozilla plugin.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
plugin.

The vlc plugin supports the following function calls:
*'''play()''': Start playing media in the plugin.
*'''pause()''': Pause playback.
*'''stop()''': Stop media playback.
*'''fullscreen()''': Switch the video to full screen.
*'''set_volume(vol)''': Set the volume. '''vol''' has to be an int in the 0-200 range.
*'''get_volume()''': Get the current volume setting.
*'''mute()''': Toggle volume muting.
*'''set_int_variable(var_name, value)''':
*'''set_bool_variable(var_name, value)''':
*'''set_str_variable(var_name, value)''':
*'''get_int_variable(var_name)''':
*'''get_bool_variable(var_name)''':
*'''get_str_variable(var_name)''':
*'''clear_playlist()''': Clear the playlist.
*'''add_item(mrl)''': Append an item whose location is given by the [[media resource locator]] to the playlist.
*'''next()'''
*'''previous()'''
*'''isplaying()''': return true if the plugin is playing something.
*'''get_length()''': Get the media's length in seconds.
*'''get_position()''': Get the current position in the media in percent.
*'''get_time()''': Get the current position in the media in seconds.
*'''seek(seconds,is_relative)''': If is_relative is true, seek relatively to current time, else seek from beginning of the stream. Seek time is specified in seconds.

Here are a few examples of HTML pages that use the
Mozilla plugin.

====Example 1====

In this example, the plugin will read an HTTP stream inside the web page. If the user goes fullscreen, he will have to press ''f'' or double-click on the video to go back in normal view.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 1</h1>

<embed type="application/x-vlc-plugin"
name="video1"
autoplay="no" loop="yes" width="400" height="300"
target="http://server.example.org/video1.vob" />
<br />
<a href="javascript:;" onclick='document.video1.play()'>Play video1</a>
<a href="javascript:;" onclick='document.video1.pause()'>Pause video1</a>
<a href="javascript:;" onclick='document.video1.stop()'>Stop video1</a>
<a href="javascript:;" onclick='document.video1.fullscreen()'>Fullscreen</a>

</body>
</html>

====Example 2====

In this example, the plugin will read a multicast UDP stream in a dedicated video output window.

<html>
<head><title>Demo of VLC mozilla plugin</title></head>

<body>

<h1>Demo of VLC mozilla plugin - Example 2</h1>

<embed type="application/x-vlc-plugin"
name="video2"
autoplay="no" loop="no" hidden="yes"
target="udp:@239.255.12.42" />
<br />
<a href="javascript:;" onclick='document.video2.play()'>Play video2</a>
<a href="javascript:;" onclick='document.video2.stop()'>Stop video2</a>
<a href="javascript:;" onclick='document.video2.fullscreen()'>Fullscreen</a>

</body>
</html>

==Building HTML pages for Mozilla/Firefox/Internet Explorere/Safari (VLC version 0.8.6 and above)==

The following description works for any of the browsers VLC supports. The JavaScript API has been unified between Mozilla/Firefox/IE (ActiveX) and Safari, thus targetting at all of the major OS out there. This is only valid for VLC version 0.8.6 and above.

Additionally to viewing video on all pages, you can build custom pages that will use the advanced features of the plugin, using Javascript functions to control playback or extract information from the
plugin.

The vlc plugin exports serveral objects that can be accessed for setting and getting information. When used improperly the API's will throw an exception that includes a string that explains what happened. For example when asking for vlc.input.length when there is no playlist item playing.

The vlc plugin knows the following objects:

*'''audio''': Access audio properties.
*'''input''': Access input properties.
*'''playlist''': Access playlist properties.
*'''video''': Access video properties.
*'''log''': Access log properties.
*'''messages''': Access to log message properties.
*'''iterator''': Access to log iterator properties.

The following JavaScript code shows howto get a reference to the vlc plugin. This reference can then be used to access the objects of the vlc plugin.

<html>
<title>VLC Mozilla plugin test page</title>
<body>
<embed type="application/x-vlc-plugin" pluginspage="http://www.videolan.org" version="VideoLAN.VLCPlugin.2"
width="640"
height="480"
id="vlc">
</embed>
<script language="Javascript">

</script>
</body>
</html>

====Root object====

readonly properties
*'''VersionInfo''': returns version information string

read/write properties
*''none''

methods
*'''vlc.versionInfo()''': returns version information string (same as VersionInfo)

====Audio object====

readonly properties
*''none''

read/write properties
*'''vlc.audio.mute''': boolean value to mute and ummute the audio
*'''vlc.audio.volume''': a value between [0-200] which indicates a percentage of the volume.
*'''vlc.audio.track''': (supported in vlc version > 0.8.6) a value between [1-65535] which indicates the audio track to play or that is playing. a value of 0 means the audio is/will be disabled.
*'''vlc.audio.channel''': (supported in vlc version > 0.8.6) integer value between [1-5] that indicates which audio channel mode is used, values can be: "1=stereo", "2=reverse stereo", "3=left", "4=right", "5=dolby". Use vlc.audio.channel to check if setting of the audio channel mode has succeeded.

Audio Channel:
<SELECT readonly onChange='doAudioChannel(this.value)'>
<OPTION value=1>Stereo</OPTION>
<OPTION value=2>Reverse stereo</OPTION>
<OPTION value=3>Left</OPTION>
<OPTION value=4>Right</OPTION>
<OPTION value=5>Dolby</OPTION>
</SELECT>

<SCRIPT language="javascript">


methods
*'''vlc.audio.toggleMute()''': boolean toggle that mutes and unmutes the audio based upon the previous state

====Input object====

readonly properties
*'''vlc.input.length''': length of the input file in number of milliseconds. 0 is returned for 'live' streams or clips whose length cannot be determined by VLC
*'''vlc.input.fps''': frames per second returned as a float (typically 60.0, 50.0, 23.976, etc...)
*'''vlc.input.hasVout''': a boolean that returns true when the video is being displayed, it returns false when video is not displayed

read/write properties
*'''vlc.input.position''': normalized position in multimedia stream item given as a float value between [0.0 - 1.0]
*'''vlc.input.time''': the absolute position in time given in milliseconds, this property can be used to seek through the stream

vlc.input.time = <absolute seek>

vlc.input.time = vlc.input.time + <relative seek>
*'''vlc.input.state''': current state of the input chain given as enumeration (IDLE/CLOSE=0, OPENING=1, BUFFERING=2, PLAYING=3, PAUSED=4, STOPPING=5, FORWARD=6, BACKWARD=7, ENDED=8, ERROR=9). '''Note that FORWARD and BACKWARD states are currently reserved and not yet operational.'''
*'''vlc.input.rate''': input speed given as float (1.0 for normal speed, 0.5 for half speed, 2.0 for twice as fast, etc.)

methods
*''none''

====Playlist object====

readonly properties
*'''vlc.playlist.itemCount''': number that returns the amount of items currently in the playlist ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])
*'''vlc.playlist.isPlaying''': a boolean that returns true if the current playlist item is playing and false when it is not playing
*'''vlc.playlist.items''': return the playlist items collection, see [[#Playlist_items_object| Playlist items]]

read/write properties
*''none''

methods
*'''vlc.playlist.add(mrl)''': add a playlist item as [[MRL]]. The MRL must be given as a string. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.add(mrl,name,options)''': add a playlist item as MRL, with metaname 'name' and options 'options'. options are text arguments which can be provided either as a single string containing space separated values, akin to VLC command line, or as an array of string values. Returns a number as an item identifier in playlist (this is not a position in playlist).
*'''vlc.playlist.play()''': start playing the current playlist item
*'''vlc.playlist.playItem(number)''': start playing the item whose identifier is number
*'''vlc.playlist.togglePause()''': toggle the pause state for the current playlist item
*'''vlc.playlist.stop()''': stop playing the current playlist item
*'''vlc.playlist.next()''': iterate to the next playlist item
*'''vlc.playlist.prev()''': iterate to the previous playlist item
*'''vlc.playlist.clear()''': empty the current playlist, all items will be deleted from the playlist ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])
*'''vlc.playlist.removeItem(number)''': remove the item from playlist whose identifier is number  ('''deprecated''', do not use, see [[#Playlist_items_object| Playlist items]])

====Playlist items object====

readonly properties
*'''vlc.playlist.items.count''': number of items currently in the playlist

read/write properties
*''none''

methods
*'''vlc.playlist.items.clear()''': empty the current playlist, all items will be deleted from the playlist. If a movie is playing, it stop. Note that when this method returns, playlist may not have been entirely been cleared as this operation is performed asynchronously; use the ''count'' property to verify/wait until the playlist is empty.
*'''vlc.playlist.items.remove(number)''': remove the item whose identifier is number from playlist. (note: this number isn't the position in the playlist, but the number given by vlc.playlist.add() )

====Video object====

readonly properties
*'''vlc.video.width''': returns the horizontal size of the video
*'''vlc.video.height''': returns the vertical size of the video

read/write properties
*'''vlc.video.fullscreen''': when set to true the video will be displayed in fullscreen mode, when set to false the video will be shown inside the video output size. The property takes a boolean as input.
*'''vlc.video.aspectRatio''': get and set the aspect ratio to use in the video screen. The property takes a string as input value. Typical values are: "1:1", "4:3", "16:9", "16:10", "221:100" and "5:4"
*'''vlc.video.subtitle''': (supported in vlc version > 0.8.6a) get and set the subtitle track to show on the video screen. The property takes an integer as input value [1..65535]. If subtitle track is set to 0, the subtitles will be disabled. If set to a value outside the current subtitle tracks range, then it will return -1 and display an error message.
*'''vlc.video.teletext''': (supported in vlc version >= 0.9.0) get and set teletext page to show on the video stream. This will only work if a teletext elementary stream is available in the video stream. The property takes an integer as input value [0..999] for indicating the teletext page to view, setting the value to 0 means hide teletext. On error it will return -1 and display an error message.

methods
*'''vlc.video.toggleFullscreen()''': toggle the fullscreen mode based on the previous setting
*'''vlc.video.toggleTeletext()''': (supported in vlc version >= 0.9.0) toggle the teletext page to overlay transparent or not, based on the previous setting

====Log object====

this object allows accessing VLC main message logging queue. Typically this queue capacity is very small (no nore than 256 entries) and can easily overflow, therefore messages should be read and cleared as often as possible.

readonly properties
*'''vlc.log.messages''': returns the message collection, see [[Messages object]]

read/write properties
*'''vlc.log.verbosity''': write number [-1,0,1,2,3] for changing the verbosity level of the log messages; messages whose verbosity is higher than set will be not be logged in the queue. The numbers have the following meaning: -1 disable, 0 info, 1 error, 2 warning, 3 debug.

methods
*''none''

====Messages object====

readonly properties
*'''messages.count''': returns number of messages in the log

read/write properties
*''none''

methods
*'''messages.clear()''': clear the current log buffer. It should be called as frequently as possible to not overflow the message queue. Call this method after the log messages of interest are read.
*'''messages.iterator()''': creates and returns an iterator object, used to iterate over the messages in the log. '''Don't clear the log buffer while holding an iterator object.'''

====Messages Iterator object====

readonly properties
*'''iterator.hasNext''': returns a boolean that indicates whether ''vlc.log.messages.next()'' will return the next message.

read/write properties
*''none''

methods
*'''iterator.next()''': returns the next message object in the log, see [[Message object]]

====Message object====

*'''message.severity''': number that indicates the severity of the log message (0 = info, 1 = error, 2 = warning, 3 = debug)
*'''message.name''': name of VLC module that printed the log message (e.g: main, http, directx, etc...)
*'''message.type''': type of VLC module that printed the log message (eg: input, access, vout, sout, etc...)
*'''message.message''': the message text

{{Documentation}}

Documentation:Building Lua Playlist Scripts

2008-08-31T21:11:20Z

Dionoea: fixes

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.peek( 512 ), "gvp_version:" )
end

The '''vlc.peek(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==

Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

* [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/README.txt;hb=HEAD Global VLC Lua README]
* [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/playlist/README.txt;hb=HEAD Playlist script specific README]

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Documentation:Building Lua Playlist Scripts

2008-08-31T21:08:03Z

Dionoea: /* Reference */

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.probe( 512 ), "gvp_version:" )
end

The '''vlc.probe(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==

Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

* [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/README.txt;hb=HEAD Global VLC Lua README]
* [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/playlist/README.txt;hb=HEAD Playlist script specific README]

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Documentation:Building Lua Playlist Scripts

2008-08-31T21:07:45Z

Dionoea: /* Reference */

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.probe( 512 ), "gvp_version:" )
end

The '''vlc.probe(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==

Information about the VLC Lua scripts is available in your VLC installation in the lua subdirectory.

[http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/README.txt;hb=HEAD Global VLC Lua README]
[http://git.videolan.org/gitweb.cgi?p=vlc.git;a=blob_plain;f=share/lua/playlist/README.txt;hb=HEAD Playlist script specific README]

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Documentation:Building Lua Playlist Scripts

2008-08-31T20:58:59Z

Dionoea: /* Introduction */ clarify

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory on Windows or Mac OS X and in your local VLC shared data folder on Linux (~/.local/share/vlc/lua/playlist).

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.probe( 512 ), "gvp_version:" )
end

The '''vlc.probe(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==
=== VLC Lua playlist script ===
VLC Lua playlist modules should define two functions:
* '''probe()''': returns true if we want to handle the playlist in this script
* '''parse()''': read the incoming data and return playlist item(s)

The playlist is a table of playlist objects.
A playlist object has the following members:
* '''.path''': the item's full path / URL
* '''.name''': the item's name in playlist ''(OPTIONAL)''
* '''.title''': the item's Title ''(OPTIONAL, meta data)''
* '''.artist''': the item's Artist ''(OPTIONAL, meta data)''
* '''.genre''': the item's Genre ''(OPTIONAL, meta data)''
* '''.copyright''': the item's Copyright ''(OPTIONAL, meta data)''
* '''.album''': the item's Album ''(OPTIONAL, meta data)''
* '''.tracknum''': the item's Tracknum ''(OPTIONAL, meta data)''
* '''.description''': the item's Description ''(OPTIONAL, meta data)''
* '''.rating''': the item's Rating ''(OPTIONAL, meta data)''
* '''.date''': the item's Date ''(OPTIONAL, meta data)''
* '''.setting''': the item's Setting ''(OPTIONAL, meta data)''
* '''.url''': the item's URL ''(OPTIONAL, meta data)''
* '''.language''': the item's Language ''(OPTIONAL, meta data)''
* '''.nowplaying''': the item's NowPlaying ''(OPTIONAL, meta data)''
* '''.publisher''': the item's Publisher ''(OPTIONAL, meta data)''
* '''.encodedby''': the item's EncodedBy ''(OPTIONAL, meta data)''
* '''.arturl''': the item's ArtURL ''(OPTIONAL, meta data)''
* '''.trackid''': the item's TrackID ''(OPTIONAL, meta data)''
* '''.options''': a list of VLC options ''(OPTIONAL)'' <br/> example: .options = { "fullscreen" }
* '''.duration''': stream duration in seconds ''(OPTIONAL)''
* '''.meta''': custom meta data ''(OPTIONAL, meta data)'' <br/> A .meta field is a table of custom meta categories which each have custom meta properties. <br/> example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }

Invalid playlist items will be discarded by VLC.

=== The vlc Lua object ===
VLC defines a global vlc object with the following members:
* '''vlc.path''': the URL string (without the leading http:// or file:// element)
* '''vlc.access''': the access used ("http" for <nowiki>http://,</nowiki> "file" for file://, etc.)
* '''vlc.peek(''' ''<int>'' ''')''': return the first <int> characters from the playlist file.
* '''vlc.read(''' ''<int>'' ''')''': read <int> characters from the playlist file. '''THIS FUNCTION CANNOT BE USED IN peek().'''
* '''vlc.readline()''': return a new line of playlist data on each call. '''THIS FUNCTION CANNOT BE USED IN peek().'''
* '''vlc.decode_uri(''' ''<string>'' ''')''': decode %xy characters in a string.
* '''vlc.resolve_xml_special_chars(''' ''<string>'' ''')''': decode &abc; characters in a string.
* '''vlc.msg_dbg(''' ''<string>'' ''')''': print a debug message.
* '''vlc.msg_warn(''' ''<string>'' ''')''': print a warning message.
* '''vlc.msg_err(''' ''<string>'' ''')''': print an error message.
* '''vlc.msg_info(''' ''<string>'' ''')''': print an info message.

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

Documentation:Modules

2008-08-24T21:01:48Z

Dionoea: add croppadd and canvas

__NOTOC__

This page lists most of the modules present in the official VLC source code. Understanding these pages might require that you know about VLC and its command line usage. It is recommended that you read the other [[Documentation:Documentation|documentation]] first.

To list all the available modules in your VLC build, use:
% '''vlc --list'''

To list a module's configuration options, use:
% '''vlc -p <modulename> --advanced --help-verbose'''

== Interfaces ==

=== Graphical ===

*[[Documentation:Modules/wxWidgets|wxWidgets]]
*[[Documentation:Modules/skins2|Skins2]]
*[[Documentation:Modules/Qt4|Qt4]]
*[[Documentation:Modules/macosx_gui|Mac OS X]]
*[[Documentation:Modules/beos_gui|BeOS]]
*[[Documentation:Modules/wince|Windows CE]]

=== Text ===

*[[Documentation:Modules/rc|remote control (rc)]]
*[[Documentation:Modules/telnet|telnet]]
*[[Documentation:Modules/ncurses|ncurses]]

=== Other ===

*[[Documentation:Modules/http_intf|HTTP]]
*[[Documentation:Modules/hotkeys|Hotkeys]]
*[[Documentation:Modules/lirc|lirc]]

== Outputs ==

=== Audio Output ===

*[[Documentation:Modules/directx_aout|DirectX]]
*[[Documentation:Modules/waveout|waveout]]
*[[Documentation:Modules/portaudio|portaudio]]
*[[Documentation:Modules/sdl_aout|SDL]]

*[[Documentation:Modules/auhal|AUHAL]]
*[[Documentation:Modules/jack|jack]]

*[[Documentation:Modules/alsa|Alsa]]
*[[Documentation:Modules/oss|OSS]]
*[[Documentation:Modules/arts|aRts]]
*[[Documentation:Modules/esd|esound]]

*[[Documentation:Modules/file_aout|file]]

=== Video Output ===
*[[Documentation:Modules/direct3d|Direct3D]]
*[[Documentation:Modules/directx_vout|DirectX]]
*[[Documentation:Modules/wingdi|Windows GDI]]
*[[Documentation:Modules/glwin32|OpenGL for windows]]

*[[Documentation:Modules/opengl|OpenGL]]

*[[Documentation:Modules/xvideo|XVideo]]
*[[Documentation:Modules/x11|X11]]
*[[Documentation:Modules/glx|OpenGL (GLX)]]
*[[Documentation:Modules/fb|Framebuffer]]
*[[Documentation:Modules/directfb|Direct framebuffer]]

*[[Documentation:Modules/sdl_vout|SDL]]
*[[Documentation:Modules/caca|Colored ASCII Art]]
*[[Documentation:Modules/aa|ASCII Art]]
*[[Documentation:Modules/image|Image]]

=== Stream Output ===

*[[Documentation:Modules/standard|Standard (std)]]
*[[Documentation:Modules/transcode|Transcode]]
*[[Documentation:Modules/duplicate|Duplicate]]
*[[Documentation:Modules/rtp|RTP]]
*[[Documentation:Modules/es|Elementary Stream (es)]]
*[[Documentation:Modules/display|Display]]
*[[Documentation:Modules/dummy_sout|Dummy]]

*[[Documentation:Modules/bridge-out|Bridge Out]]
*[[Documentation:Modules/bridge-in|Bridge In]]
*[[Documentation:Modules/mosaic-bridge|Mosaic Bridge]]

*[[Documentation:Modules/autodel|Autodel]]
*[[Documentation:Modules/gather|Gather]]
*[[Documentation:Modules/description|Description]]
*[[Documentation:Modules/switcher|Switcher]]
*[[Documentation:Modules/transrate|Transrate]]

== Filters ==

=== Audio Filters ===

=== Video Filters ===

*[[Documentation:Modules/adjust|Adjust]]
*[[Documentation:Modules/gradient|Gradient]]
*[[Documentation:Modules/invert|Invert]]
*[[Documentation:Modules/wave|Wave]]
*[[Documentation:Modules/ripple|Ripple]]
*[[Documentation:Modules/motionblur|Motion Blur]]
*[[Documentation:Modules/psychedelic|Psychedelic]]
*[[Documentation:Modules/noise|Noise]]
*[[Documentation:Modules/colorthres|Color Threshold]]
*[[Documentation:Modules/rotate|Rotate]]
*[[Documentation:Modules/extract|Extract]]
*[[Documentation:Modules/erase|Logo Erase]]
*[[Documentation:Modules/gaussianblur|Gaussian Blur]]
*[[Documentation:Modules/sharpen|Sharpen]]

The following video filters are for use in transcode only:
*[[Documentation:Modules/croppadd|Crop Padd]]
*[[Documentation:Modules/canvas|Canvas]]

The following video filters are for use in the mosaic framework only:
*[[Documentation:Modules/bluescreen|Blue Screen]]
*[[Documentation:Modules/alphamask|Alpha mask]]

=== Video Sub-Filters ===

*[[Documentation:Modules/marq|Marq]]
*[[Documentation:Modules/rss|RSS]]
*[[Documentation:Modules/logo|Logo]]
*[[Documentation:Modules/mosaic|Mosaic]]
*[[Documentation:Modules/time|Time]] (up to 0.8.6)

=== Video Output Filters ===

*[[Documentation:Modules/deinterlace|Deinterlace]]
*[[Documentation:Modules/transform|Transform]]
*[[Documentation:Modules/wall|Wall]]
*[[Documentation:Modules/crop|Crop]]
*[[Documentation:Modules/panoramix|Panoramix]]
*[[Documentation:Modules/clone|Clone]]
*[[Documentation:Modules/logo|Logo]]
*[[Documentation:Modules/magnify|Magnify]]
*[[Documentation:Modules/puzzle|Puzzle]]
*[[Documentation:Modules/distort|Distort]] (up to 0.8.6)

=== Visualizations ===

*[[Documentation:Modules/visualizer|Visualizer]]
*[[Documentation:Modules/goom|Goom]]
*[[Documentation:Modules/galaktos|Galaktos]]

=== Access Filters ===
*[[Documentation:Modules/timeshift|Timeshift]]
*[[Documentation:Modules/record|Record]]
*[[Documentation:Modules/dump|Dump]]
*[[Documentation:Modules/bandwidth|Bandwidth]]

== Other ==

=== Accesses ===
*[[Documentation:Modules/file|File]]
*[[Documentation:Modules/directory|Directory]]
*[[Documentation:Modules/dvdnav|dvdnav]]
*[[Documentation:Modules/dvdread|dvdread]]
*[[Documentation:Modules/vcd|VCD]]
*[[Documentation:Modules/http|HTTP]]
*[[Documentation:Modules/ftp|FTP]]
*[[Documentation:Modules/udp|UDP/RTP]]
*[[Documentation:Modules/rtsp|RTSP]]
*[[Documentation:Modules/mms|MMS]]
*[[Documentation:Modules/screen|Screen]]
*[[Documentation:Modules/fake|Fake]]
Linux specific:
*[[Documentation:Modules/dv|DV]]
*[[Documentation:Modules/dvb|DVB]]
*[[Documentation:Modules/pvr|PVR]]
*[[Documentation:Modules/v4l|Video4Linux (v4l)]]
*[[Documentation:Modules/v4l2|Video4Linux2 (v4l2)]]
*[[Dc1394|Dc 1394]] FIXME: shouldn't link outside of Documentation:Modules/
Windows specific:
*[[Documentation:Modules/bda|BDA]]
*[[Documentation:Modules/dshow|DirectShow]]

=== Access Outputs ===

=== Codecs ===

==== Audio ====
==== Video ====
==== Subtitles ====

=== Demuxers ===
==== Playlist ====
*[[Documentation:Modules/m3u-open|m3u]]
*[[Documentation:Modules/pls-open|pls]]
*[[Documentation:Modules/b4s-open|b4s]]
*[[Documentation:Modules/dvb-open|dvb]]
*[[Documentation:Modules/podcast|podcast]]
*[[Documentation:Modules/xspf-open|XSPF]]
*[[Documentation:Modules/shout-winamp|Winamp Shoutcast]]
*[[Documentation:Modules/asx-open|ASX]]
*[[Documentation:Modules/sgimb|sgimb]]
*[[Documentation:Modules/qtl|QTL]]
*[[Documentation:Modules/gvi|gvi]]

=== Muxers ===

=== Service Discovery ===

*[[Documentation:Modules/sap|SAP]]
*[[Documentation:Modules/shout|Shoutcast]]
*[[Documentation:Modules/podcast_sd|Podcast]]
*[[Documentation:Modules/hal|HAL]]
*[[Documentation:Modules/daap|DAAP]]
*[[Documentation:Modules/bonjour|Bonjour]]
*[[Documentation:Modules/upnp_intel|UPnP (intel)]]
*[[Documentation:Modules/upnp_cc|UPnP (cyberlink)]]

=== Misc ===
*[[Documentation:Modules/netsync|netsync]]
*[[Documentation:Modules/motion_control|motion control]]

{{Documentation}}

VLC HowTo/Make a mosaic

2008-08-24T14:31:34Z

Dionoea:

{{howto| set up a mosaic of a few videos or stream like a TV portal}}

==VLC mosaic howto==

This is a small example about how to use {{VLC}} to create a mosaic. What we basically want is a video mosaic mixing 3 video channels (channels 1, 2 and 3) on a background image (background.png) and streaming the resulting video on the network. Note that we will also be streaming the 3 sound tracks from channels 1, 2 and 3 in the same mpeg-ts stream.

Starting with VLC 0.8.5-test2, the http interface features a "Mosaic wizard". You might want to use it if you have no knowledge of VLC command line usage.

http://people.via.ecp.fr/~dionoea/videolan/mosaic1.png

Other neat examples :

[http://people.via.ecp.fr/~dionoea/videolan/mosaic2.jpg 12 video mosaic]

[http://people.via.ecp.fr/~dionoea/videolan/mos1.png 20 video mosaic]

[http://people.via.ecp.fr/~dionoea/videolan/mos2.png 20 video mosaic]

===Step 0===

Read the VLC streaming howto (chapters 3 and 5 concerning command line and vlm usage in VLC) : http://videolan.org/doc/

===Step 1===

Get VLC 0.8.4-test1 or newer and install it on your computer.

===Step 2===

You now have to get a background image. Many image formats are supported (JPEG, PNG ...).

You can also test it with VLC to see if it displays locally :
<pre>
./vlc --fake-file background.png --fake-aspect-ratio "4:3" fake:
</pre>

===Step 3===

You now need to configure VLC to get the 3 source streams and blend them on the background image.

The vlm configuration file looks like :

<pre>
new channel1 broadcast enabled
setup channel1 input udp://@239.255.2.60:1234
setup channel1 output #duplicate{dst=mosaic-bridge{id=1,height=144,width=180},select=video,dst=bridge-out{id=1},select=audio}

new channel2 broadcast enabled
setup channel2 input udp://@239.255.10.200:1234
setup channel2 output #duplicate{dst=mosaic-bridge{id=2,height=144,width=180},select=video,dst=bridge-out{id=2},select=audio}

new channel3 broadcast enabled
setup channel3 input udp://@239.255.6.9:1234
setup channel3 output #duplicate{dst=mosaic-bridge{id=3,height=144,width=180},select=video,dst=bridge-out{id=3},select=audio}

new background broadcast enabled
setup background input fake:
setup background output #transcode{sfilter=mosaic,vcodec=mp2v,vb=10000,scale=1}:bridge-in{delay=400,id-offset=100}:standard{access=udp,mux=ts,url=239.255.12.42,sap,name="mosaic"}

control background play
control channel1 play
control channel2 play
control channel3 play
</pre>

Note that the source streams are network streams, which is likely to be the case if you're considering doing a mosaic.

===Step 4===

And now, the right command to launch vlc :

<pre>
./vlc --color -I telnet --vlm-conf ../mosaic.vlm.conf --ttl 12 \
--fake-file background.png --fake-aspect-ratio "4:3" \
--mosaic-width 360 --mosaic-height 288 --udp-caching 800 \
--mosaic-keep-picture --mosaic-rows 2 --mosaic-cols 2 \
--mosaic-position 1 --mosaic-order 1,2,3
</pre>

== Other examples ==

=== Dual webcam with alphamask ===

http://people.videolan.org/~dionoea/mosaic/dual-webcam.png

<pre>new isight broadcast
setup isight input v4l2:///dev/video0:width=320:height=240:audio-method=0
setup isight option v4l2-brightness=90
setup isight output #mosaic-bridge{chroma=YUVA,vfilter=alphamask{mask=../mask.png},width=320,height=240}
setup isight enabled

new logitech broadcast
setup logitech input v4l2:///dev/video1:width=640:height=480:audio-method=0
setup logitech output #transcode{vcodec=mp4v,vb=1024,sfilter="mosaic:marq{marquee='VLC dual webcam setup',position=8}"}:bridge-in:display
setup logitech enabled

new audio broadcast enabled
setup audio input v4l:///dev/dsp1
setup audio output #transcode{acodec=mp4a,ab=128}:bridge-out

control isight play
#control audio play
control logitech play</pre>

You can then launch it with:
vlc --vlm-conf ../dual-webcam.conf --no-media-library --plugin-path modules -v --no-video-title --mosaic-keep-picture

The mask.png file is used to set transparency values on the isight camera (uses the png alpha plane). An example file to use is available at http://people.videolan.org/~dionoea/mosaic/.

==See Also==
* [http://people.via.ecp.fr/~dionoea/videolan/mosaic-diagram.png Small Diagram That Might Help]
* [http://people.videolan.org/~dionoea/mosaic/ VLC Mosaic related resources]
* [[MosaicExampleSetup | Example set-up of conference web-streaming with two grabber cards]]

==Appendix==
* [[Documentation:Modules/mosaic]]
* [[Documentation:Modules/mosaic-bridge]]
* [[Documentation:Modules/bridge-out]]
* [[Documentation:Modules/bridge-in]]
===Mosaic specific video filters===
* [[Documentation:Modules/alphamask]]
* [[Documentation:Modules/bluescreen]]

VLC HowTo/Make a mosaic

2008-08-24T14:15:41Z

Dionoea: /* Dual webcam with alphamask */

VLC HowTo/Make a mosaic

2008-08-24T14:13:32Z

Dionoea:

{{howto| set up a mosaic of a few videos or stream like a TV portal}}

==VLC mosaic howto==

This is a small example about how to use {{VLC}} to create a mosaic. What we basically want is a video mosaic mixing 3 video channels (channels 1, 2 and 3) on a background image (background.png) and streaming the resulting video on the network. Note that we will also be streaming the 3 sound tracks from channels 1, 2 and 3 in the same mpeg-ts stream.

Starting with VLC 0.8.5-test2, the http interface features a "Mosaic wizard". You might want to use it if you have no knowledge of VLC command line usage.

http://people.via.ecp.fr/~dionoea/videolan/mosaic1.png

Other neat examples :

[http://people.via.ecp.fr/~dionoea/videolan/mosaic2.jpg 12 video mosaic]

[http://people.via.ecp.fr/~dionoea/videolan/mos1.png 20 video mosaic]

[http://people.via.ecp.fr/~dionoea/videolan/mos2.png 20 video mosaic]

===Step 0===

Read the VLC streaming howto (chapters 3 and 5 concerning command line and vlm usage in VLC) : http://videolan.org/doc/

===Step 1===

Get VLC 0.8.4-test1 or newer and install it on your computer.

===Step 2===

You now have to get a background image. Many image formats are supported (JPEG, PNG ...).

You can also test it with VLC to see if it displays locally :
<pre>
./vlc --fake-file background.png --fake-aspect-ratio "4:3" fake:
</pre>

===Step 3===

You now need to configure VLC to get the 3 source streams and blend them on the background image.

The vlm configuration file looks like :

<pre>
new channel1 broadcast enabled
setup channel1 input udp://@239.255.2.60:1234
setup channel1 output #duplicate{dst=mosaic-bridge{id=1,height=144,width=180},select=video,dst=bridge-out{id=1},select=audio}

new channel2 broadcast enabled
setup channel2 input udp://@239.255.10.200:1234
setup channel2 output #duplicate{dst=mosaic-bridge{id=2,height=144,width=180},select=video,dst=bridge-out{id=2},select=audio}

new channel3 broadcast enabled
setup channel3 input udp://@239.255.6.9:1234
setup channel3 output #duplicate{dst=mosaic-bridge{id=3,height=144,width=180},select=video,dst=bridge-out{id=3},select=audio}

new background broadcast enabled
setup background input fake:
setup background output #transcode{sfilter=mosaic,vcodec=mp2v,vb=10000,scale=1}:bridge-in{delay=400,id-offset=100}:standard{access=udp,mux=ts,url=239.255.12.42,sap,name="mosaic"}

control background play
control channel1 play
control channel2 play
control channel3 play
</pre>

Note that the source streams are network streams, which is likely to be the case if you're considering doing a mosaic.

===Step 4===

And now, the right command to launch vlc :

<pre>
./vlc --color -I telnet --vlm-conf ../mosaic.vlm.conf --ttl 12 \
--fake-file background.png --fake-aspect-ratio "4:3" \
--mosaic-width 360 --mosaic-height 288 --udp-caching 800 \
--mosaic-keep-picture --mosaic-rows 2 --mosaic-cols 2 \
--mosaic-position 1 --mosaic-order 1,2,3
</pre>

== Other examples ==

=== Dual webcam with alphamask ===
<pre>new isight broadcast
setup isight input v4l2:///dev/video0:width=320:height=240:audio-method=0
setup isight option v4l2-brightness=90
setup isight output #mosaic-bridge{chroma=YUVA,vfilter=alphamask{mask=../mask.png},width=320,height=240}
setup isight enabled

new logitech broadcast
setup logitech input v4l2:///dev/video1:width=640:height=480:audio-method=0
setup logitech output #transcode{vcodec=mp4v,vb=1024,sfilter="mosaic:marq{marquee='VLC dual webcam setup',position=8}"}:bridge-in:display
setup logitech enabled

new audio broadcast enabled
setup audio input v4l:///dev/dsp1
setup audio output #transcode{acodec=mp4a,ab=128}:bridge-out

control isight play
#control audio play
control logitech play</pre>

You can then launch it with:
vlc --vlm-conf ../dual-webcam.conf --no-media-library --plugin-path modules -v --no-video-title --mosaic-keep-picture

The mask.png file is used to set transparency values on the isight camera (uses the png alpha plane). An example file to use is available at http://people.videolan.org/~dionoea/mosaic/.

==See Also==
* [http://people.via.ecp.fr/~dionoea/videolan/mosaic-diagram.png Small Diagram That Might Help]
* [http://people.videolan.org/~dionoea/mosaic/ VLC Mosaic related resources]
* [[MosaicExampleSetup | Example set-up of conference web-streaming with two grabber cards]]

==Appendix==
* [[Documentation:Modules/mosaic]]
* [[Documentation:Modules/mosaic-bridge]]
* [[Documentation:Modules/bridge-out]]
* [[Documentation:Modules/bridge-in]]

SoC 2008 projects

2008-06-16T18:18:24Z

Dionoea: /* Panorama Viewing */

Here is a list of the accepted projects for Google Summer of Code 2OO8.

You can see how good the student do on their project on [[SoC_2008/Student_Tracking]].

= List of current VLC projects =

== Panorama Viewing ==

* '''Project page: [[SoC 2008/PanoramaViewing]]'''
* '''Student''': [[User:Plouj|Michael Ploujnikov]]
* '''Mentor''': Yuval Levy, [[User:J-b|Jean-Baptiste Kempf]], [[User:Dionoea|Antoine Cellerier]]
* '''Abstract''':

: The goal of this project is to make VLC a one-stop solution for viewing panoramas of various formats. Currently, FreePV is the best/only cross-platform, non-proprietary solution for viewing QuickTimeVR and plain image panoramas. However it suffers from a few drawbacks, which include difficult installation, browser plug-in conflicts and low popularity. The intent is to integrate the FreePV rendering code with VLC. This should not only automatically alleviate installation difficulty and plug-in conflicts, but also bring panorama viewing to a much larger audience. This project will initially focus on basic support for QTVR files and equirectangular images.

'''This project has been discontinued.'''

== Qt improvements ==

* '''Project page: [[SoC 2008/Qt improvements]]'''
* '''Student''': Lukas Durfina
* '''Mentor''': [[User:J-b|Jean-Baptiste Kempf]]
* '''Abstract''':

: In my project I should do fullscreen controller, backend for Phonon and playlist improvements. FS controller have to be clickable, dragable with all VLC functionality. Phonon backend will help spread VLC and support its using by other developers. And finally I will upgrade playlist, fix and update DragAndDrop and other bugs.

== Enhance PVR capabilities of VLC ==
* '''Project page: [[SoC 2008/Enhance PVR capabilities of VLC]]'''
* '''Student''': [[User:Dylan|Dylan Yudaken]]
* '''Mentor''': [[User:Pdherbemont|Pierre d'Herbemont]]
* '''Abstract''':

: VLC has fast become one of the most common video players available for 'non-technical' users. The ability to watch streams easily and efficiently is a huge advantage for VLC. The ability to timeshift streams has been added to the latest unstable builds, however it is vastly underfeatured and not nearly ready for release. The features would enhance VLC to a new level which would allow a new set of users to use it.

: I propose to extend & improve the PVR capabilities of VLC. The current version is severely lacking in functionality and performance. There is a very basic timeshift capability already. To this I will add the ability to randomly seek through the buffer (fast forward, rewind, etc ). The ability to save buffers and continue recording to the new file will be added. These recordings will be in any chosen format. These features will help anyone who uses VLC to watch TV shows to easily turn their client into a MythTV/Media Centre style client.
: I will tie the module in with the user interface properly so that the state of the buffer and the current position can be easily seen.
: I then plan to begin work on a framework that combines all of these features into a simple interface easily accessible with a remote control. The interface will combine VLM and the media library into a single easily accesible place. The interface will have the ability to 'talk' to the server sending commands such as changing tv channel or switching input source.

: With this and the completion of VLM and the playlist managing system VLC will have the capabilities to become a fully featured PVR system with the massive advantage of it being run off a streaming server if need be.

== WinCE Port ==
* '''Project page: [[SoC 2008/WinCE Port]]'''
* '''Student''': [[User:Geal|Geoffroy Couprie]]
* '''Mentor''': Jérôme Decoodt
* '''Abstract''':
:The VLC media player has been port to many different platforms, but it lacks Windows CE support since some versions. This project aims at making VLC work on a Windows CE platform, with a few features:
:*RTSP
:*H264
:*Snapshots
:*Playlist
:*Rebuild of interface to adapt it to small screens

== Create a new VLC interface for Maemo (internet tablet) ==
* '''Project page: [[SoC 2008/New VLC interface for Maemo]]'''
* '''Student''': [[User:Phytos|Antoine Lejeune]]
* '''Mentor''': [[User:funman|Rafaël Carré]]
* '''Abstract''':
: The goal is to create a new interface for VLC with Maemo, a Debian-based development platform for handheld devices used by Nokia N800 and N810 devices and to package VLC for this platform.
: The main constraint are the small size of the screen which means the GUI must be thought specifically for this platform and the fact that the devices is not very powerful.

== DLNA UPnP A/V integration ==
* '''Project page: [[SoC 2008/UPnP]]'''
* '''Student''': [[User:Mr_Mirsal|Mirsal Ennaime]]
* '''Mentor''': [[User:funman|Rafaël Carré]]
* '''Abstract''':
Even if it is controverted, UPnP A/V Is a widely used standard set of protocols for networked digital
audio and video equipment interoperability, thus making it almost a requirement digital media software
that aim to become real part of the average multimedia home network. This project aims to implement
at least the Media Server part in VLC media player, which will enable it to advertise and stream media
to DNLA UPnP A/V enabled devices, such as the PlayStation 3.

== MTP Devices Support ==

* '''Project page: [[SoC 2008/MTP]]'''
* '''Student''': [[User:Sephiroth87|Fabio Ritrovato]]
* '''Mentor''': [[User:Dionoea|Antoine Cellerier]]
* '''Abstract''':

:As MTP (Media Transfer Protocol) devices become more and more popular, and the protocol itself is about to become a standard, using them is still a problem for some people, since they cannot be mounted or opened as disks, but can be natively used only on Vista and Windows XP with WMP10, or using other programs.
:Adding the MTP support to VLC would not only give the opportunity to use these device on almost every platform, but also allow to have a free, open source and largely diffuse program to manage them.
:My work on the MTP support will enable VLC not only to play music from the device, but also to add new music, manage the content of the device, edit tags, playlists and anything else that would be needed by an Mp3 player user.

== Mac OS X (Leopard) Integration ==
* '''Project page: [[SoC 2008/OS X Integration]]'''
* '''Student''': [[User:dudiak|Eric Dudiak]]
* '''Mentor''': [[User:Fkuehne|Felix Paul Kühne]]
* '''Abstract''':

:Unlike Windows and Linux, Mac OS X does not offer much in terms of alternatives to its built-in QuickTime media player. VLC media player represents the only Mac media player with significant support for various media formats and a tight integration with the OS, including a "Mac-like" user interface. As it is the only full, viable alternative to QuickTime on the Mac OS X platform, it is important that it stay current with various Mac technologies to offer users a comprehensive option for media playback.

:Aspects of tighter Mac OS X integration:
:*Quick Look Generator for Leopard (to generate thumbnails and full media previews from the Finder)
:*Making most common preferences accessible in a Mac-style preference window organized with icon tabs across the top such as in Safari and Mail.
:*Moving the Readme document and other help resources into a HelpViewer HTML document to allow better help searching in Leopard.
:*Improvements in steaming server wizard to be more in-line with other Mac wizards and easier to use for personal streaming between Macs.
:*Add better support for package files that contain media VLC can play, such as iMovie Projects and EyeTV recordings.
:*Update the VLC file icons to the 512 by 512 size for Leopard.

== Vista Enhanced Video Renderer output module ==

* '''Project page: [[SoC_2008/EVR_video_output_module]]'''
* '''Student''': [[User:VLC_help|Kaarlo Räihä]]
* '''Mentor''': [[User:Atmo|André Weber]]
* '''Abstract''':

: EVR (Enhanced Video Renderer) is new video renderer that came with Windows Vista. Goal of this project is to implement EVR video output module for VLC media player. EVR will hopefully be default video output module for Windows Vista but it might also work with Windows XP if the .NET Framework 3.0 is installed. EVR should guarantee tearing free output that also works with Aero. It should also be more compatible with different display adapters (or driver versions) and that way hopefully end problems that certain people have with their video watching.

: If there will be some extra time (EVR finishes early), I will try to add some features to Direct3D output module (shaders, rotating video etc.)

= List of current x264 projects =

== Macroblock tree ==

* '''Project page: [[SoC_2008/x264/Macroblock_tree]]'''
* '''Student''': [[User:Kuukunen|Aki Jäntti]]
* '''Mentor''': Alex Izvorski
* '''Abstract''':

: The basic idea of a "macroblock tree" is to keep track of macroblock references to try to figure out which macroblocks are the most important. This information can be used for deciding the quantizers for frames or even individual macroblocks.

User:Dionoea

2008-06-04T22:46:29Z

Dionoea: /* My VideoLAN to do list */

Antoine Cellerier

Contact me: dionoea on irc.freenode.net #videolan
([http://dionoea.chewa.net/irc/videolan #videolan IRC logs since March 2004])

My vlc compilation scripts are available online: http://people.videolan.org/~dionoea/config/ .

[[Special:Contributions/Dionoea|My contributions to this wiki]]

== My VLC to do list ==

For 0.9.0:
* finish the video filter2 transition (core + interface).
* clean up the motion detection plugin code + add VLM callbacks when motion is detected.
* help with the Qt interface.
* fix the marq/logo callbacks in the RC interface. '''Done'''
Other stuff I'm thinking about:
* my secret project (can't tell you what that is yet ... sorry).
* erase video filter2 to remove logos from a live stream. '''Done'''
* change hotkeys handling in VLC (from 1 action -> 1 key to 1 key -> 1 action). Would make it possible to have multiple hotkeys for 1 action.
* add DVD menu controls to the HTTP interface (using hotkey simulations from the HTTP interface code ... or maybe something cleaner).
* improve the HTTP interface's Flash plugin page. Add a page using the VLC plugin (both IE and Mozilla).
* subtitles support in the ffmpeg muxer.

Code I have lying around which might need to be commited one day:
* cache access filter (not finished). Basic idea was to read as much data as possible from the hard drive (or a DVD drive) and put it in RAM to lower battery usage (and noise) in VLC. Maybe we'd need to implement that directly in the VLC core ... and maybe it's even already available using some obscure command line option. I'll have to ask fenrir about that.
* VLC screen saver on win32.
* Start of native windows (XP(?)) remote control handling code on win32.

== My VideoLAN to do list ==

* add country detection to our mirrors script (using mod_geoip from [http://www.maxmind.com maxmind] ? Test page available [http://dionoea.chewa.net/geoip.php here]). '''Done'''
* install punBB with [[User:J-b]] to offload Ganesh. '''Not needed since phpBB 3 works far better'''
* move the last 2 pages from the [http://www.videolan.org/doc/ documentation] to the [[Documentation:Documentation|wiki]] and start updating it. '''Done'''

User:Dionoea

2008-06-04T22:45:08Z

Dionoea:

Antoine Cellerier

Contact me: dionoea on irc.freenode.net #videolan
([http://dionoea.chewa.net/irc/videolan #videolan IRC logs since March 2004])

My vlc compilation scripts are available online: http://people.videolan.org/~dionoea/config/ .

[[Special:Contributions/Dionoea|My contributions to this wiki]]

== My VLC to do list ==

For 0.9.0:
* finish the video filter2 transition (core + interface).
* clean up the motion detection plugin code + add VLM callbacks when motion is detected.
* help with the Qt interface.
* fix the marq/logo callbacks in the RC interface. '''Done'''
Other stuff I'm thinking about:
* my secret project (can't tell you what that is yet ... sorry).
* erase video filter2 to remove logos from a live stream. '''Done'''
* change hotkeys handling in VLC (from 1 action -> 1 key to 1 key -> 1 action). Would make it possible to have multiple hotkeys for 1 action.
* add DVD menu controls to the HTTP interface (using hotkey simulations from the HTTP interface code ... or maybe something cleaner).
* improve the HTTP interface's Flash plugin page. Add a page using the VLC plugin (both IE and Mozilla).
* subtitles support in the ffmpeg muxer.

Code I have lying around which might need to be commited one day:
* cache access filter (not finished). Basic idea was to read as much data as possible from the hard drive (or a DVD drive) and put it in RAM to lower battery usage (and noise) in VLC. Maybe we'd need to implement that directly in the VLC core ... and maybe it's even already available using some obscure command line option. I'll have to ask fenrir about that.
* VLC screen saver on win32.
* Start of native windows (XP(?)) remote control handling code on win32.

== My VideoLAN to do list ==

* add country detection to our mirrors script (using mod_geoip from [http://www.maxmind.com maxmind] ? Test page available [http://dionoea.chewa.net/geoip.php here]).
* install punBB with [[User:J-b]] to offload Ganesh.
* move the last 2 pages from the [http://www.videolan.org/doc/ documentation] to the [[Documentation:Documentation|wiki]] and start updating it. '''Done'''

Documentation:Format String

2008-05-26T09:10:24Z

Dionoea: Add missing $f variable.

{{RightMenu|documentation play howto toc}}

Starting with [[VLC media player]] 0.9.0, format string variables can be used with the following options:
* --marq-marquee
* --snapshot-path (when specifying a full image path, not a directory)
* --snapshot-prefix
* --image-out-prefix
* --msn-format (windows only)
* file access output dst/url (like in std{access=file,mux=ts,dst='''THIS'''})

There are two kinds of format string variables: time variables and meta variables.

==Time==

Time variables are those defined by the '''strftime''' C function. Those include:
* %Y : year
* %m : month
* %d : day
* %H : hour
* %M : minute
* %s : second
For an extensive list have a look at [http://www.hmug.org/man/3/strftime.php man strftime].

==Meta==

Meta variables are VLC specific. The complete list is:
* $a : artist
* $b : album
* $c : copyright
* $d : description
* $e : encoded by
* $f : frame count
* $g : genre
* $l : language
* $n : track num
* $p : now playing
* $r : rating
* $s : subtitles language
* $t : title
* $u : url
* $A : date
* $B : audio bitrate (in kb/s)
* $C : chapter
* $D : duration
* $F : full name with path
* $I : title
* $L : time left
* $N : name
* $O : audio language
* $P : position (in %)
* $R : rate
* $S : audio sample rate (in kHz)
* $T : time
* $U : publisher
* $V : volume
* $_ : new line
* $<any other char> : <any other char> (for example: $$ transforms to $)

You can insert a space between the $ sign and the character to tell it to not display anything if the meta data isn't available. For example: $ T instead will display "" if no time is available while $T would display "--:--:--".

{{Documentation}}

Git

2008-05-07T14:02:04Z

Dionoea: Comment GSoC 2007 specific instructions.

= Basic Git usage =
== Getting VLC source code via Git ==
$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/. Type

You can also clone using http with out repo.or.cz mirror.
$ git clone http://repo.or.cz/r/vlc.git

$ git log
to see the full log of the trunk.
$ gitk
to see the log graphically.

You can also browse the sources via [http://git.videolan.org/ gitweb].

== Configure your global git config ==
=== Personal Information ===
Tell git your name. (use mostly by git-commit)
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

=== Using git with color (Tip) ===
If you want to use git with colored output use:
$ git config --global color.ui true

If you are using an old git version (prior to 1.5.5) and previous command didn't work, use:
$ git config --global color.diff auto
$ git config --global color.status auto
$ git config --global color.branch auto

=== Setting up "git up" (Tip) ===
If you want to be able to just keep in sync using "git up" use:
$ git config --global alias.up "pull --rebase"
And if you like your tree to be messy and don't want git too complain (like in svn) use:
$ git config --global alias.up '!sh -c "git stash && git pull --rebase && git stash apply"'

=== Setting up "git wu" (Git What's Up) (Tip) ===
If you want to see what you are about to "git push":
$ git config --global alias.wu "log --stat origin..@{0}"
Now use:
$ git wu

=== Setting up "git wup" (Git What's Up - with patch) (Tip) ===
If you want to see what you are about to "git push", along with the diff:
$ git config --global alias.wup "log -p origin..@{0}"
Now use:
$ git wup

== General GIT Workflow ==
1. Make your file edits in your local repository.

2. "git commit" the changes in your local repository

3. "git pull --rebase" or "git up" (if you did ''git config --global alias.up "pull --rebase"'') to bring the rest of your local repository up to date

4. "git log origin..master" to check what you are going to commit

4. "git push" to move your changes up to the master

"git stash" if you want to "hide" your changes. Do this if you think there may be other commits against ther same things you are working on, want to refresh yourself (using a git pull --rebase) from the master. Use "git stash apply" to get your stash back.

"git checkout -f master" if you think your tree is pretty hopeless, need a kill-and-fill to bring the master into your local repository.

== List the local branch ==
You can now list your local branch by doing
$ git branch
which should ouput
$ git branch
* master

== List your local non committed changes ==
$ git status | less

== Commit ==
Now you can start to work on your tree. As soon as you feel you've reached a step in developement you can commit '''locally''' your work by
$ git commit -a
or
$ git commit <specific files>

== List your commits ==
$ git log

== Keeping your local working branch in sync ==
$ git pull --rebase

To shorten up that command type
$ git config --global alias.up "pull --rebase"

Now you can just type:
$ git up

== Use a graphical interface ==
$ gitk # Tree Browser
$ qgit # Tree Browser
$ git-gui # Commit/push/... editor

== Submitting patches to the vlc-devel ==

First make sure you have '''read''' our [[Sending Patches]] page. And that you've '''read''' the [[Sending Patches#Check_List| Check List]].

If you have been developing on vlc locally and (still) don't have write access, you can submit all your commit in one shot using:
$ rm -Rf patches
$ git format-patch -o patches origin
$ git-send-email --to vlc-devel@videolan.org patches
If you have multiple patch consider using:
$ git-send-email --compose --no-chain-reply-to --to vlc-devel@videolan.org patches
which will produce the patches for each local commit in the directory "patches" and send them.
--no-chain-reply-to make sure it doesn't reply do
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...
But :
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

= Advanced usage =
== Creating a secondary local branch ==
If you want to work on a specific project that could require a branch of the trunk, create a local branch of the current branch by doing:
$ git branch mywork
and to actually use it do:
$ git checkout mywork
Which could be summarized by:
$ git checkout -b mywork

Then do some commit on it... And you can go back to your original master branch by doing:
$ git checkout master

== Fetching a remote branch ==
To see the remote branch use:
$ git branch -r
If the remote branch is named 0.8.6-bugfix
$ git branch 0.8.6-bugfix origin/0.8.6-bugfix
Branch 0.8.6-bugfix set up to track remote branch refs/remotes/origin/0.8.6-bugfix.
$ git branch
0.8.6-bugfix
* master
To checkout that branch use:
$ git checkout 0.8.6-bugfix
To stay up-to-date a simple
$ git pull --rebase
Should be enough.

To push to the remote branch, use:
$git push origin 0.8.6-bugfix:0.8.6-bugfix

== Creating a remote branch ==
If the new remote branch is named 0.9.0-bugfix, and is based on the local master branch.
First make sure everything go as planned with the --dry-run option:
$ git push --dry-run origin master:refs/heads/0.9.0-stable
To git@git.videolan.org:vlc.git
* [new branch] master -> 0.9.0-stable

Then push it:
$ git push origin master:refs/heads/0.9.0-stable
To git@git.videolan.org:vlc.git
* [new branch] master -> 0.9.0-stable
$ git branch -r
origin/0.9.0-stable
origin/master

To checkout that branch now see ''Fetching a remote branch''

== Publishing your own fork ==
Goto [http://repo.or.cz/w/vlc.git http://repo.or.cz/w/vlc.git] and click [http://repo.or.cz/m/regproj.cgi?name=vlc/ fork]. You will be able to publish your work there.

Please don't forget to send a mail to the vlc-devel as soon as you create your fork.

== Revert your non-committed local changes ==
$ git checkout -f

==Edit or undo not yet pushed commits ==
This will undo the last commit
$ git reset HEAD^
which is the same as
$ git reset master^
(if you are checked-out copy of your tree is master)
And also the same as
$ git reset a44a594 # note that there is no need to use the full sha id

If you have a stack of patch that you have not yet committed you can delete one patch from the list using git rebase --interactive
$ git rebase --interactive origin
pick eacf185 test
pick 56322eb VLMA owner is vlma prod.

# Rebase 826757e..56322eb onto 826757e
#
# Commands:
# pick = use commit
# edit = use commit, but stop for amending
# squash = use commit, but meld into previous commit

== Diff-ing ==
* You can diff between two branches using
$ git diff branch1 branch2
* You can diff between the previous 10th commit and current using
$ git diff HEAD~10 HEAD
* You can diff between the previous 10th commit and current of the branch "mywork" using
$ git diff mywork~10 mywork
* Imagine that git log is like
$ git log
commit e0394f269305edd09843257e7c1d1a66aaf48ab3
Author: jb <jb>
Date: Fri Apr 13 07:14:48 2007 +0000
qt4 - Mousewheel (2)
commit e80b339081aa6755f67c9bd8e2aacf93a9a79d95
[..]
commit ff7004b70fd239e4120deb160e2991bd5237b8df
[..]
commit a44a594898f981a145cfcace5f16f8973f9eb46f
[..]
commit 690df705c963cf6bf6f5746d54bc97a85ff91919
[..]
commit 679f8b1c3e0baa469efa970588b95a625c595d64
[..]

$ git diff a44a594898f981a145cfcace5f16f8973f9eb46f~2 e80b339081aa6755f67c9bd8e2aacf93a9a79d95
Will be equivalent to:
$ git diff ff7004b70fd239e4120deb160e2991bd5237b8df e80b339081aa6755f67c9bd8e2aacf93a9a79d95
And to:
$ git diff HEAD~4 HEAD^

* Remember that to produce a patch you should rather use git-format-patch than git-diff most of the time.

== Tracking regression ==
git has a great tool called [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect] to help you to track a faulty commit. Imagine you are tracking a bug that is known to appear after 0.8.6 (assuming 0.8.6 is tagged):
$ git bisect start
$ git bisect bad # tell git current version has the bug you are tracking
$ git bisect good 0.8.6 # tell git 0.8.6 didn't has the bug
And then git will checkout a certain revision, and ask you to test it. And you simply say whether this version has the bug.
If it has the bug:
$ git bisect bad
if the bug is not present:
$ git bisect good
And so on by bisection... At the end git will indicate the faulty commit. Most of the time this tool is really efficient to track regression.

If you can provide a script that test the presence of the bug
$ git bisect run <script_name>
will be able to track down the regression by itself. See [http://www.kernel.org/pub/software/scm/git/docs/git-bisect.html git-bisect Documentation].

= Using Git to push to VideoLAN git =
== Initial requirement ==
* Make sure you've set your name and email in your commits
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

== Convert your tree to use your ssh push commit access ==
$ vi vlc/.git/config
And replace git://git.videolan.org/vlc.git by git@git.videolan.org:vlc.git

== Staying up to date ==
$ git pull --rebase

If you don't want to have to type --rebase everytime you pull do:
$ git config branch.master.rebase true

This one creates a merge object which is not how SVN worked, so let's use the first version...
$ git pull

== Pushing your work ==
$ git log origin..master # Check what you are going to push
$ git push



= Documentation about git =
* [http://git.or.cz/ Official Git Website]
* [http://www.kernel.org/pub/software/scm/git/docs/tutorial.html Git Tutorial]
* [http://git.or.cz/course/svn.html Switching from SVN to git using cogito]
* [http://wiki.sourcemage.org/Git_Guide Very good Git guide]

[[Category:Building]]

Documentation:Building Lua Playlist Scripts

2008-04-02T21:49:03Z

Dionoea: Sync with 4ad218c25fb08d55b944e1c78c20cb96492f6267

{{RightMenu|documentation play howto toc}}

== Introduction ==

Starting with version 0.9.0, VLC gives you the possible to implement your own playlist loading modules easily. Such modules can do stuff like:
* ''URL translation'': You give it the youtube webpage URL and VLC starts playing the corresponding video;
* ''Text playlist parsing'': You use some custom text playlist format.

Lua playlist scripts shipped with VLC are stored in the following directory:
* C:\Program Files\VideoLAN\VLC\lua\playlist\ on Windows;
* VLC.app/Contents/MacOS/share/lua/playlist/ on Mac OS X;
* /usr/share/vlc/lua/playlist/ on Linux.

You can add your own Lua playlist scripts in this directory or in your VLC's preferences folder "lua/playlist" subdirectory.

== Simple Examples ==

=== URL translation ===

==== What we want to do ====
Lets say that we want VLC to open Google Video links automatically. Google Video pages have URLs like
<nowiki>http://video.google.com/videoplay?docid=-5784010886294950089</nowiki>
to the URL of the corresponding Google Video Playlist file which is
<nowiki>http://video.google.com/videogvp?docid=-5784010886294950089</nowiki>

==== Probe ====
The Lua script is going to be made of 2 functions. The first one is the '''probe()''' function. This function tells VLC if the Lua script should be used (function returns true) or not (function returns false). Here it would look like:
function probe()
if vlc.access ~= "http"
then
return false
end
if string.match( vlc.path, "video.google.com/videoplay" )
then
return true
else
return false
end
end

Lets analyse that function step by step. First we check that VLC is using HTTP. If it isn't (for example it's reading a file off your hard drive or a DVD), we don't want to trigger the Google Video URL translation. The '''vlc''' Lua object provides '''vlc.access''' which should be equal to string '''"http"'''. Then we check that the URL is a Google Video page. This is easily done by trying to find the '''"video.google.com/videoplay"''' string in '''vlc.path'''.

Note that the same function can be written as
function probe()
return vlc.access == "http" and string.match( vlc.path, "video.google.com/videoplay" )
end

==== Parse ====
If the '''probe()''' function returns true, VLC will use the '''parse()''' to ask for the new playlist item(s) which need to be added.
function parse()
item = {}
item.path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" )
item.name = "Some Google video playlist"
return { item }
end

We create a new playlist item (a Lua table). We set the item's path to the appropriate string: 1/ we prepend "http://" since the '''vlc.path''' string doesn't include that part of the original URL and 2/ we replace "videoplay" by "videogvp".

We also set the new playlist item's name to "Some Google video playlist".

We then return the new playlist to VLC (a Lua table which basically represents a list of items).

A shorter version would be:
function parse()
return { { path = "http://" .. string.gsub( vlc.path, "videoplay", "videogvp" ); name = "Some Google video playlist" } }
end

==== Saving that to a file ====
To make that script available to VLC, simply create a new something.lua file in one of the directories listed in the introduction (You should also remove the googlevideo.lua file shipped with VLC to make sure that it isn't used instead of your new script).

=== Text Playlist Parsing ===

In the previous example we translated a URL to another URL. This new URL redirects VLC to a Google Video Playlist which is basically a text file. This file needs to be read to get the final video's true URL. Here's what such a file would look like if you were to open it with a text editor:
<pre>
# download the free Google Video Player from http://video.google.com/
gvp_version:1.1
url:http://vp.video.google.com/videodownload?version=0&secureurl=uQAAAAznrU3q0BdxTkn_lLSpVJQ4a4JBDFAc5V8lB5OXXPqJ6Dts-Hq5Ll-2dIgeBIDGN1ZAMv65MMP0Zu5cwbIrgAhinWRNl-UtZCU4CgPpnYrR5IwLCk-sEXjs4o89dTT8MQxWcSo3lFPKulC0_TT9L0EW_IyANloBjyoEld5KGkcXdUTtXvj1TmaRh5Yvq4zIfxmYPQ4fehJY6rucnqMQLm8NTD32NvVpSp1bJ06ub_YJgDz4Nic-_qpW0rnFReSyrQ&sigh=zy8gMs8AhAM0Hv3N1PR7djz3m2I&begin=0&len=72640&docid=-5784010886294950089
docid:-5784010886294950089
duration:72640
title:Penguins go for a stroll
description:African penguins caught a breath of fresh air as they were out for a stroll through Tokyo's aquarium. Ikebukuro Sunshine Aquarium offer spectators a chance to get a closer encounter with penguins as they are taken for a walk through the aquariums compound.
description:
description:During the parade the penguins were separated from spectators, mainly children, by portable fences on wheels which were pushed by the zookeepers. The fence ensures they don't run away and also prevents them from biting spectators.
description:
description:"I came up with this idea to let people get a close look at penguins walking." said Keeper Masahiro Tomiyama, adding only penguins born and raised at the aquarium can walk outside their cage without feeling stressed by all the attention.
description:
description:Reuters 16094/06
description:Keywords: animals, cute, sweet, funny, ITN Source.
</pre>

==== Probe ====
The first thing we need to worry about is making sure that the file we're playing is a Google Video Playlist (GVP) file. We could rely on the URL, but that would prevent playing GVP files from our hard drive. Fortunately, the file's contents, especially the "gvp_version:" string seem specific to GVP files. We'll thus try reading a bunch of characters from the begining of the file and look for the "gvp_version:" string.
function probe()
return string.match( vlc.probe( 512 ), "gvp_version:" )
end

The '''vlc.probe(''' ''<number of chars>'' ''')''' function asks VLC to return the first <number of chars> characters. If the string "gvp_version:" isn't found in a file's first 512 characters, we're almost 100% sure that it's not a valid GVP file.

==== Parse ====
We now need to read information from the file to create our new playlist item. A simple version would only fetch the URL:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
end
end
return { item }
end

We read all the file's lines using the '''vlc.readline()''' function. If we encounter the line starting with '''"url:"''' (''string.match( line, "url:" )'' would match lines containing "url:", while ''string.match( line, "^url:" )'' only matches those starting with "url:"), we use that as our new item's path.

If vlc.readline() returns nil, this means that we've finished reading the file so we break out of the while loop and return our new playlist.

This simple '''parse()''' function unfortunately discards all the other usefull meta information available in the GVP file. Lets try to use it:
function parse()
item = {}
while true
do
line = vlc.readline()
if not line
then
break
end
if string.match( line, "^url:" )
then
item.path = string.sub( line, 5 )
elseif string.match( line, "^title:" )
then
item.name = string.sub( line, 7 )
elseif string.match( line, "^duration:" )
then
item.duration = string.sub( line, 10 ) / 1000
elseif string.match( line, "^description:" )
then
if item.description
then
item.description = item.description .. "\n" .. string.sub( line, 13 )
else
item.description = string.sub( line, 13 )
end
end
end
return { item }
end

Getting the video's title works like the URL parameter.
The duration is a bit more tricky. GVP uses times in miliseconds while VLC wants a time in seconds. We thus have to divide it by 1000.
For the description, it works like the URL and title parameters except that a GVP file can have more than one description parameter. If we read more than one parameter we thus concatenate the different description lines.

== Reference ==
=== VLC Lua playlist script ===
VLC Lua playlist modules should define two functions:
* '''probe()''': returns true if we want to handle the playlist in this script
* '''parse()''': read the incoming data and return playlist item(s)

The playlist is a table of playlist objects.
A playlist object has the following members:
* '''.path''': the item's full path / URL
* '''.name''': the item's name in playlist ''(OPTIONAL)''
* '''.title''': the item's Title ''(OPTIONAL, meta data)''
* '''.artist''': the item's Artist ''(OPTIONAL, meta data)''
* '''.genre''': the item's Genre ''(OPTIONAL, meta data)''
* '''.copyright''': the item's Copyright ''(OPTIONAL, meta data)''
* '''.album''': the item's Album ''(OPTIONAL, meta data)''
* '''.tracknum''': the item's Tracknum ''(OPTIONAL, meta data)''
* '''.description''': the item's Description ''(OPTIONAL, meta data)''
* '''.rating''': the item's Rating ''(OPTIONAL, meta data)''
* '''.date''': the item's Date ''(OPTIONAL, meta data)''
* '''.setting''': the item's Setting ''(OPTIONAL, meta data)''
* '''.url''': the item's URL ''(OPTIONAL, meta data)''
* '''.language''': the item's Language ''(OPTIONAL, meta data)''
* '''.nowplaying''': the item's NowPlaying ''(OPTIONAL, meta data)''
* '''.publisher''': the item's Publisher ''(OPTIONAL, meta data)''
* '''.encodedby''': the item's EncodedBy ''(OPTIONAL, meta data)''
* '''.arturl''': the item's ArtURL ''(OPTIONAL, meta data)''
* '''.trackid''': the item's TrackID ''(OPTIONAL, meta data)''
* '''.options''': a list of VLC options ''(OPTIONAL)'' <br/> example: .options = { "fullscreen" }
* '''.duration''': stream duration in seconds ''(OPTIONAL)''
* '''.meta''': custom meta data ''(OPTIONAL, meta data)'' <br/> A .meta field is a table of custom meta categories which each have custom meta properties. <br/> example: .meta = { ["Google video"] = { ["docid"] = "-5784010886294950089"; ["GVP version"] = "1.1" }; ["misc"] = { "Hello" = "World!" } }

Invalid playlist items will be discarded by VLC.

=== The vlc Lua object ===
VLC defines a global vlc object with the following members:
* '''vlc.path''': the URL string (without the leading http:// or file:// element)
* '''vlc.access''': the access used ("http" for <nowiki>http://,</nowiki> "file" for file://, etc.)
* '''vlc.peek(''' ''<int>'' ''')''': return the first <int> characters from the playlist file.
* '''vlc.read(''' ''<int>'' ''')''': read <int> characters from the playlist file. '''THIS FUNCTION CANNOT BE USED IN peek().'''
* '''vlc.readline()''': return a new line of playlist data on each call. '''THIS FUNCTION CANNOT BE USED IN peek().'''
* '''vlc.decode_uri(''' ''<string>'' ''')''': decode %xy characters in a string.
* '''vlc.resolve_xml_special_chars(''' ''<string>'' ''')''': decode &abc; characters in a string.
* '''vlc.msg_dbg(''' ''<string>'' ''')''': print a debug message.
* '''vlc.msg_warn(''' ''<string>'' ''')''': print a warning message.
* '''vlc.msg_err(''' ''<string>'' ''')''': print an error message.
* '''vlc.msg_info(''' ''<string>'' ''')''': print an info message.

== Scripts shipped with VLC ==

Scripts for popular playlist formats and video websites are available in the default VLC installer:
* dailymotion.lua: URL translation for Daily Motion video pages;
* googlevideo.lua: URL translation for Google Video video pages;
* metacafe.lua: URL translation for metacafe video pages and flash player;
* youtube.lua: URL translation for YouTube video pages and flash player (including fullscreen video URLs);
* youtube_hompage.lua: Parse YouTube homepage and browse page.

== Usefull links ==
* [http://www.lua.org/manual/5.1/ Lua 5.1 reference manual]
* [http://lua-users.org/wiki/TutorialDirectory Lua tutorials]

VLC Dev Projects

2008-03-25T12:58:27Z

Dionoea:

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Plugin is done and availabe in the current Git version. Code by kenS

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== V4L2 support ==

VLC currently has a pvr module and a v4l (video for linux) module.
However
* some cards are only supported in the new v4l2 API
* The linux kernel will soon drop v4l support

So if someone could update VLC's current modules to work with V4L2 and the new ivtv api, this would be a welcome addition.
This is not a very difficult project, but you will need to have the hardware to test against.
The code has been began, so it should not be too difficult.

Plugin is done and available in the current Git version. Code by Richard Hosking, [[User:dionoea|dionoea]] and Dennis Lou.

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:56:13Z

Dionoea: Undo revision 11106 by Dionoea (Talk)

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== V4L2 support ==

VLC currently has a pvr module and a v4l (video for linux) module.
However
* some cards are only supported in the new v4l2 API
* The linux kernel will soon drop v4l support

So if someone could update VLC's current modules to work with V4L2 and the new ivtv api, this would be a welcome addition.
This is not a very difficult project, but you will need to have the hardware to test against.
The code has been began, so it should not be too difficult.

Plugin updated by Richard Hosking

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:55:57Z

Dionoea: Undo revision 11107 by Dionoea (Talk)

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:55:29Z

Dionoea: Undo revision 11108 by Dionoea (Talk)

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:54:55Z

Dionoea: Undo revision 11109 by Dionoea (Talk)

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:54:22Z

Dionoea: Reverted edits by Dionoea (Talk); changed back to last version by J-b

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== V4L2 support ==

VLC currently has a pvr module and a v4l (video for linux) module.
However
* some cards are only supported in the new v4l2 API
* The linux kernel will soon drop v4l support

So if someone could update VLC's current modules to work with V4L2 and the new ivtv api, this would be a welcome addition.
This is not a very difficult project, but you will need to have the hardware to test against.
The code has been began, so it should not be too difficult.

Plugin updated by Richard Hosking

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:53:25Z

Dionoea: /* DVB support for Windows / BDA Drivers */ -> done too

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:52:56Z

Dionoea: /* DVB support for Windows / BDA Drivers */ -> done too.

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

VLC Dev Projects

2008-03-25T12:52:28Z

Dionoea: /* V4L2 support */ -> done.

This is a list of small independent improvements to {{VLC}} for which we are looking for interested developers, because we simply don't have enough time.

These do not require advanced knowledge of VLC internals but they can still vastly improve many parts of VLC

For each project, we list a contact person, who knows the subject best and who will be able to assist you if you are interested in working on these. We generally are very often present on irc.videolan.org, chan #videolan, so please don't hesitate to drop by or to send a mail if you are interested in a given problem (our mail adresses are generally <nick>@videolan.org).

'''Be careful, some projects may be unrelated, or deprecated, because of fast evolving software! Ask before !'''

= Easy projects =

These projects are junior projects, the most easy ones to do, that require minimum knowledge of VLC.

We also have a number of "easy" bugs. You can check them out [http://trac.videolan.org/vlc/query?status=new&status=assigned&status=reopened&difficulty=easy&order=priority` here]

== Code Janitorial ==
It basically means to clean the code, it is helpful for all programmers. It helps to find bugs, and is a good way to learn about VLC's internals.

It is covered in the [[Code Janitorial]] section.

if you feel confortable with english language, be sure to have a look to [[QT4StringsReview|the QT4 Strings Review]].

== Video Filters ==
You can do video filters for {{VLC}}.

You can inspire yourself on this
[http://movavi.com/enhancemovie/filters.html list of filters] from a commercial product.

You can start the code [http://trac.videolan.org/vlc/browser/trunk/modules/video_filter/ here].

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

= Network =

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:
* The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
* mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
* The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
* There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
* The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

* Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
* Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Inputs =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:some1|some1]]

= Video =

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

= Interfaces =

== Streaming profiles ==

This is a big subject, that has barely started. Interested persons will need to work closely with existing developers to implement this.
Not much information is available yet. The idea is to make streaming very easy, and yet powerful by using parametrable profiles. These could be used either by the graphical interfaces or through HTTP/command line interfaces

Contact: [[User:Zorglub|Zorglub]]

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

= Playlist =

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at
https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

=== Hint MP4/MOV Files ===

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

= Projects running =

== Subtitles improvements ==
{{VLC}} does not support all the styles for a lot of subtitles type.
Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

= Finished projects =

==Audioscrobbler==

A [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br />

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :
* Digital Terrestrial TV (aka DVB-T)
* Digital Cable TV (aka DVB-C)
* Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Someone has already began it on the forum, so start from there.
kenS has '''begun''' it, but no code has yet been produced today - [[User:J-b|jb]] 01:56, 8 March 2007 (CET)
Contact before starting it !!!

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:funman|funman]]

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP.
Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

[[Category:Coding]] [[Category:Activities]]

SoC 2008

2008-03-24T18:27:46Z

Dionoea: /* QuickTimeVR Playing */

Google Summer of Code 2008.

''VideoLAN is an official mentoring organization'' for {{VLC}} and [[x264]] for Google Summer of Code 2008.

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}} and [[x264]], the H.264 video encoder.

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

=== VLC media player ===
{{VLC}} is a cross-platform Multimedia player, and encoding and streaming application.
It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 4 millions from the main website (not including third-party distributions (Linux)), which means about 30 million people have downloaded VLC 0.8.5 from the main website!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main_Page|wiki]].

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 0.9.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

'''''Read this'''''

We (the VideoLAN team, and [[User:J-b|jb]], the author of this page) have split this page in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

If you don't want to apply for SoC but want other ideas to develop on, check the [[Mini Projects]] page!

And on IRC channel, you can have even more ideas.

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

=== Test Suite ===
This project aims at making automatic tests to improve VLC quality.

* Write a series of tests for vlc-internal
* Integrate a framework for automated plugins testing with the automake build system
* Automate the different codec playback/mux/etc tests
* Automate the subtitles tests
* Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require some knowledge of C

''Proposed mentor: [[User:Pdherbemont]]'' (backup: courmisch)

=== MTP Device Service Discovery ===
This projects consists of adding support for finding and reading content from attached USB MTP (Media Transfer Protocol) devices,
such as the Apple iPod, as a Service Discovery and input plugins for VLC.

This project might need improvements in the Service Discovery subsystem for hotplug.

This project needs a student to have a MP3 player device...

You should have a look at [http://libmtp.sf.net libmtp library] and at [http://blog.songbirdnest.com/2008/02/29/mtp-device-support-for-windows/ Songbird MTP implementation].

''Proposed mentor: funman'' (backup jb)

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: dionoea'' (backup Yuval Levy)

''Interested students:'' [[User:Plouj]]

=== UPnP media service ===
This project involves adding support for advertizing the stream on the LAN using Universal Plug'n'Play A/V / DLNA.

Streaming to the PS3 can be one achievement of it.

Using [http://libdlna.geexbox.org/ libdlna] might be a good idea.

Having a cross platform solution is almost a must.

''Proposed mentor: funman''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: dionoea''

=== Fullscreen Controller ===
This project is easy to describe, it would provide a fullscreen controller for Linux/Unix and Windows, as {{VLC}} already has on Mac OS X version since 0.8.6.

It should:
* be draggable,
* be clickable,
* support the classical control buttons to control VLC playback in fullscreen mode,
* have all the VLC functionalities in it.

With this project, which is not too long, there should be some related work on Vout (Making sure the video output does not close and reopen between files for example...)

This project needs basic C++ knowledge. Qt knowledge would be a plus.

This project should be doable by any serious student in a summer.

Aim: [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg VLC on Mac fullscreen controller]

''Proposed mentor: [[User:J-b|jb]]'' (backup atmo)

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This project needs also GUI Integration.

''Proposed mentor: BigBen'' (backup feepk)

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

''Proposed mentor: pdherbemont, feepk''

=== iPhone / iPod touch port ===
Port VLC to the iPhone / iPod touch platform.

This project does not necessarily require the student to own such a device due to the availability of a simulator as part of the official SDK, although it is probably helpful.

''Proposed mentor: pdherbemont'' (backup feepk)

=== Vista acceleration and DirectX improvements ===
Current versions of {{VLC}} have a lot of problems on Windows Vista (check the forums for specifics).

We need support for the new EVR (enhanced video renderer) in Windows Vista, and make it the default Video Output module for that OS.

See [http://download.microsoft.com/download/5/b/9/5b97017b-e28a-4bae-ba48-174cf47d23cd/MED134_WH06.ppt Windows Vista Video Pipeline Architecture And Implementation] and [http://msdn2.microsoft.com/en-us/library/ms788119.aspx DirectShow Improvements in Vista]

Some rework and enhancements of the DirectX and Direct3D Video Output modules may also be necessary.

''Proposed mentor: atmo''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''mentoring would be done by courmisch''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

This project needs some good ASM knowledge and good C experience.

''Proposed mentor: jb, Dark_Shikari"

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''robUx4 can do the mentoring. He has already wrote the demux and has worked for matroska, so knows it very well.''

=== WinCE port ===
The WinCE port has been broken for some time now before 0.8.4. Repairing the builds of all the external libraries build and making VLC build and work should take some time :D

Then a rework of the interface should happen.

''Proposed mentor: djc.''

=== Skins improvements ===

Better video output integration.

Better skin support.

See with [[User:J-b|jb]]

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: rockyb.''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

We have a more general page for ideas for Project in {{VLC}}, that could give you ideas: [[Mini_Projects]].

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

== Questions? Contact us? ==
If you need to contact us for any questions, you can:
* use this [[Talk:SoC_2008| Talk page]],
* use the [http://www.videolan.org/developers/lists.html vlc-devel] mailing list,
* come on IRC irc://irc.videolan.org #videolan
* contact one of the mentors or the backup mentors,
* or contact [[User:J-b| Jean-Baptiste Kempf]]

=== Mentors ===
The proposed mentors are:
* courmisch,
* dionoea,
* djc
* feepk,
* pdherbemont,
* jb,
* funman,
* robUx4,
* BigBen
* rockyb (for VCD/SVCD)

=== Administrators ===
* jb
* xtophe

[[Category:Activities]]

SoC 2008

2008-03-24T18:20:32Z

Dionoea: /* QuickTimeVR Playing */ Fix broken link.

Google Summer of Code 2008.

''VideoLAN is an official mentoring organization'' for {{VLC}} and [[x264]] for Google Summer of Code 2008.

== Introduction & Information ==

This wiki page covers the attempt by the [[VideoLAN]] project to act as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}} and [[x264]], the H.264 video encoder.

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

=== VLC media player ===
{{VLC}} is a cross-platform Multimedia player, and encoding and streaming application.
It is one of the most successful open-source projects without any professional structure underneath.

{{VLC}} is downloaded at an approximate monthly rate of 4 millions from the main website (not including third-party distributions (Linux)), which means about 30 million people have downloaded VLC 0.8.5 from the main website!

You can find more information on [http://en.wikipedia.org/wiki/VLC_media_player VLC on Wikipedia] or on this [[Main_Page|wiki]].

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 0.9.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

'''''Read this'''''

We (the VideoLAN team, and [[User:J-b|jb]], the author of this page) have split this page in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

If you don't want to apply for SoC but want other ideas to develop on, check the [[Mini Projects]] page!

And on IRC channel, you can have even more ideas.

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

=== Test Suite ===
This project aims at making automatic tests to improve VLC quality.

* Write a series of tests for vlc-internal
* Integrate a framework for automated plugins testing with the automake build system
* Automate the different codec playback/mux/etc tests
* Automate the subtitles tests
* Write tests for the different bindings: Mac OS X Framework/Python Bindings... etc.

This project is a code project, require some knowledge of C

''Proposed mentor: [[User:Pdherbemont]]'' (backup: courmisch)

=== MTP Device Service Discovery ===
This projects consists of adding support for finding and reading content from attached USB MTP (Media Transfer Protocol) devices,
such as the Apple iPod, as a Service Discovery and input plugins for VLC.

This project might need improvements in the Service Discovery subsystem for hotplug.

This project needs a student to have a MP3 player device...

You should have a look at [http://libmtp.sf.net libmtp library] and at [http://blog.songbirdnest.com/2008/02/29/mtp-device-support-for-windows/ Songbird MTP implementation].

''Proposed mentor: funman'' (backup jb)

=== QuickTimeVR Playing ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).

This project will require some modification on image handling inside VLC, before starting.

''Proposed mentor: dionoea'' (backup Yuval Levy)

''Interested students:'' [[User:Plouj]]

=== UPnP media service ===
This project involves adding support for advertizing the stream on the LAN using Universal Plug'n'Play A/V / DLNA.

Streaming to the PS3 can be one achievement of it.

Using [http://libdlna.geexbox.org/ libdlna] might be a good idea.

Having a cross platform solution is almost a must.

''Proposed mentor: funman''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: dionoea''

=== Fullscreen Controller ===
This project is easy to describe, it would provide a fullscreen controller for Linux/Unix and Windows, as {{VLC}} already has on Mac OS X version since 0.8.6.

It should:
* be draggable,
* be clickable,
* support the classical control buttons to control VLC playback in fullscreen mode,
* have all the VLC functionalities in it.

With this project, which is not too long, there should be some related work on Vout (Making sure the video output does not close and reopen between files for example...)

This project needs basic C++ knowledge. Qt knowledge would be a plus.

This project should be doable by any serious student in a summer.

Aim: [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg VLC on Mac fullscreen controller]

''Proposed mentor: [[User:J-b|jb]]'' (backup atmo)

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This project needs also GUI Integration.

''Proposed mentor: BigBen'' (backup feepk)

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

''Proposed mentor: pdherbemont, feepk''

=== iPhone / iPod touch port ===
Port VLC to the iPhone / iPod touch platform.

This project does not necessarily require the student to own such a device due to the availability of a simulator as part of the official SDK, although it is probably helpful.

''Proposed mentor: pdherbemont'' (backup feepk)

=== Vista acceleration and DirectX improvements ===
Current versions of {{VLC}} have a lot of problems on Windows Vista (check the forums for specifics).

We need support for the new EVR (enhanced video renderer) in Windows Vista, and make it the default Video Output module for that OS.

See [http://download.microsoft.com/download/5/b/9/5b97017b-e28a-4bae-ba48-174cf47d23cd/MED134_WH06.ppt Windows Vista Video Pipeline Architecture And Implementation] and [http://msdn2.microsoft.com/en-us/library/ms788119.aspx DirectShow Improvements in Vista]

Some rework and enhancements of the DirectX and Direct3D Video Output modules may also be necessary.

''Proposed mentor: atmo''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''mentoring would be done by courmisch''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

This project needs some good ASM knowledge and good C experience.

''Proposed mentor: jb, Dark_Shikari"

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''robUx4 can do the mentoring. He has already wrote the demux and has worked for matroska, so knows it very well.''

=== WinCE port ===
The WinCE port has been broken for some time now before 0.8.4. Repairing the builds of all the external libraries build and making VLC build and work should take some time :D

Then a rework of the interface should happen.

''Proposed mentor: djc.''

=== Skins improvements ===

Better video output integration.

Better skin support.

See with [[User:J-b|jb]]

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: rockyb.''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

We have a more general page for ideas for Project in {{VLC}}, that could give you ideas: [[Mini_Projects]].

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

== Questions? Contact us? ==
If you need to contact us for any questions, you can:
* use this [[Talk:SoC_2008| Talk page]],
* use the [http://www.videolan.org/developers/lists.html vlc-devel] mailing list,
* come on IRC irc://irc.videolan.org #videolan
* contact one of the mentors or the backup mentors,
* or contact [[User:J-b| Jean-Baptiste Kempf]]

=== Mentors ===
The proposed mentors are:
* courmisch,
* dionoea,
* djc
* feepk,
* pdherbemont,
* jb,
* funman,
* robUx4,
* BigBen
* rockyb (for VCD/SVCD)

=== Administrators ===
* jb
* xtophe

[[Category:Activities]]