VideoLAN Wiki - User contributions [en]

User:Materthron/NotesAndIdeas

2010-05-03T21:02:48Z

Materthron: + pie menu idea

Here you can find my VLC related notes and ideas. It's primarily for me so that I don't forget things. ;D

== Deutsche Übersetzung ==
Media Kontextmenü:
*"Wiedergabe mit VLC" => "Mit VLC wiedergeben"
*"Zur VLC's Wiedergabeliste hinzufügen" => "Zu VLC-Wiedergabeliste hinzufügen"

Menüs:
*Extras->"Vollbildsteuerung" => "Vollbild" (wie Firefox)
*Medien->"Advanced open file" => "" ('''NICHT ÜBERSETZT''')

In Goldeneye:
*"Systray-Icon" => "Kontrolleisten-Icon anzeigen" (Pidgin)
*"Audio aktivieren" => "Audioausgabe aktivieren"
*"Video aktivieren" => "Videoausgabe aktivieren"
*"Vollbild" (Im einfachen Modus; "Vollbildausgabe" im Alle-Modus) => "Im Vollbildmodus starten"
*"Beschleunigte Videoausgabe (Overlay)" (im einfachen Modus; "Videoausgabe überlagern" im Alle-Modus) => "Videoausgabe beschleunigen (Overlay benutzen)"

== Misc. ==
Menus:
*Extras->"Media info", Extras->"Codec info"
** Duplicate functionality: First one already allows for switching to second one '''[DUP]'''
*Media->"Open file", Media->"Advanced open file"
** Duplicate functionality: Second one always opens as file selection dialogue, which is exactly what the first one provides '''[DUP]'''

== TODO ==
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!</s> Gone! Resort to wiki editing :-(
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].

=== Fullscreen controller polishing ===
Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
* Supports:
** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
** Transparency (specify <tt>background-color</tt> as a rgba color)
** More things to ponder on?

Alternative: Use a [http://web.archive.org/web/20080410001552/http://trolltech.com/products/qt/addon/solutions/catalog/4/Widgets/qtpiemenu/ pie menu]!

=== Improve translation process ===
Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''
'''''Is this still the case?'''''
--[[User:Materthron|materthron]] 17:58, 4 January 2009 (CET)

Migrate to [http://www.transifex.net/ Transifex]?

User:Materthron/NotesAndIdeas

2010-05-03T21:00:28Z

Materthron: /* Improve translation process */ + transifex

Here you can find my VLC related notes and ideas. It's primarily good for me so that I don't forget things. :D

== Deutsche Übersetzung ==
Media Kontextmenü:
*"Wiedergabe mit VLC" => "Mit VLC wiedergeben"
*"Zur VLC's Wiedergabeliste hinzufügen" => "Zu VLC-Wiedergabeliste hinzufügen"

Menüs:
*Extras->"Vollbildsteuerung" => "Vollbild" (wie Firefox)
*Medien->"Advanced open file" => "" ('''NICHT ÜBERSETZT''')

In Goldeneye:
*"Systray-Icon" => "Kontrolleisten-Icon anzeigen" (Pidgin)
*"Audio aktivieren" => "Audioausgabe aktivieren"
*"Video aktivieren" => "Videoausgabe aktivieren"
*"Vollbild" (Im einfachen Modus; "Vollbildausgabe" im Alle-Modus) => "Im Vollbildmodus starten"
*"Beschleunigte Videoausgabe (Overlay)" (im einfachen Modus; "Videoausgabe überlagern" im Alle-Modus) => "Videoausgabe beschleunigen (Overlay benutzen)"

== Miscellaneous ==
Menus:
*Extras->"Media info", Extras->"Codec info"
** Duplicate functionality: First one already allows for switching to second one '''[DUP]'''
*Media->"Open file", Media->"Advanced open file"
** Duplicate functionality: Second one always opens as file selection dialogue, which is exactly what the first one provides '''[DUP]'''

== TODO ==
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!</s> Gone! Resort to wiki editing :-(
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].

=== Fullscreen controller polishing ===
Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
* Supports:
** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
** Transparency (specify <tt>background-color</tt> as a rgba color)
** More things to ponder on?

=== Improve translation process ===
Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''
'''''Is this still the case?'''''
--[[User:Materthron|materthron]] 17:58, 4 January 2009 (CET)

Migrate to [http://www.transifex.net/ Transifex]?

User:Materthron

2009-11-02T23:49:27Z

Materthron: /* Getting in touch */

My name is Philipp Weissenbacher, I'm a third semester cs student at the University of Vienna. My primary field of interest is HCI and i18n and to a lesser extent more technical things like coding.

I've joined the VideoLAN project like 2 years ago, but haven't been very active. I've been helping [[User:Fkuehne|Felix Kühne]] with the German translation and I'm trying to improve the wiki in as many ways I can.
Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]] to which I'm also fairly new).
From time to time I'm getting the latest nighties to see if everything (still) works fine on Windows.
See [[Special:Contributions/Materthron|my contributions]] if you're more curious.

See my [[User:Materthron/NotesAndIdeas|Notes and Ideas]].

== Getting in touch ==
Email me at materthron ÄT users DOT sourceforge DOT net.

Java bindings

2009-08-24T00:46:41Z

Materthron: added compile and eclipse integration from README and links to the examples

For a complete overview about Java binding in VideoLAN goto to the [http://trac.videolan.org/jvlc/ JVLC homepage].

= Source code =
Find the source code at {{file|bindings/java|bindings}}

== Compile ==
We use [http://maven.apache.org/ Maven2] as the project management tool.

Take a look at the website to download and for general instructions on how to use it.

To compile the project, run from the bindings/java folder:

mvn install

== Tips and tricks ==

=== Eclipse integration ===
To import the JVLC project into the eclipse IDE:

mvn eclipse:eclipse

and then import as an existing Java project.

=== Samples ===
{{file|bindings/java/samples}}
Is the samples directory with a simple client.

A simple VLC client
{{file|bindings/java/samples/client/src/main/java/VlcClient.java}}

Display multiple videos
{{file|bindings/java/samples/client/src/main/java/MultipleVideosSample.java}}

A comprehensive JVLC example
{{file|bindings/java/core/src/main/java/org/videolan/jvlc/example/VLCExample.java}}

= OSGi =
For the use of Java binding under OSGi go to the [http://vlc4osgi.forge.os4os.org VLC4OSGi Homepage]

[[Category:Bindings]]

User:Materthron/NotesAndIdeas

2009-06-25T18:42:46Z

Materthron: + Goldeneye

Ubuntu

2009-06-23T14:09:12Z

Materthron: minor clean up

== Installing VLC on Ubunu GNU/Linux ==

You can install VLC using the apt-get programme (or it's GUI, Synaptic). Make sure you [https://help.ubuntu.com/community/Repositories/Ubuntu enabled the Universe repository] and type the following:

$ sudo apt-get install vlc

Look out: there are many deprecated vlc based packages, like gnome-vlc, etc. Just installing vlc will do.

Many vlc plugins can be installed afterwards (some of these may no longer be needed):{{check}}
vlc-plugin-alsa - ALSA audio output plugin for VLC (install it if sound doesn't work)
vlc-plugin-arts - aRts audio output plugin for VLC (install it if sound still doesn't work and you're using KDE)
vlc-plugin-esd - Esound audio output plugin for VLC (install it if sound still doesn't work and you're using Gnome)
vlc-plugin-ggi - GGI video output plugin for VLC
vlc-plugin-glide - Glide video output plugin for VLC
vlc-plugin-pulse - PulseAudio audio output plugin for VLC
vlc-plugin-sdl - SDL video and audio output plugin for VLC
vlc-plugin-svgalib - SVGAlib video output plugin for VLC
mozilla-plugin-vlc - the VLC plugin for Mozilla based browsers

[[Category:Operating systems]]

User:Materthron

2009-01-04T17:01:04Z

Materthron: cleanup

My name is Philipp Weissenbacher, I'm a third semester cs student at the University of Vienna. My primary field of interest is HCI and i18n and to a lesser extent more technical things like coding.

I've joined the VideoLAN project like 2 years ago, but haven't been very active. I've been helping [[User:Fkuehne|Felix Kühne]] with the German translation and I'm trying to improve the wiki in as many ways I can.
Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]] to which I'm also fairly new).
From time to time I'm getting the latest nighties to see if everything (still) works fine on Windows.
See [[Special:Contributions/Materthron|my contributions]] if you're more curious.

See my [[User:Materthron/NotesAndIdeas|Notes and Ideas]].

== Getting in touch ==
Feel free to contact me via ICQ (496133349), Skype (materthron) or email (materthron ÄT users DOT sourceforge DOT net).

User:Materthron/NotesAndIdeas

2009-01-04T16:58:47Z

Materthron: created and filled with life

Here you can find my VLC related notes and ideas. It's primarily good for me so that I don't forget things. :D

== Deutsche Übersetzung ==
Media Kontextmenü:
*"Wiedergabe mit VLC" => "Mit VLC wiedergeben"
*"Zur VLC's Wiedergabeliste hinzufügen" => "Zu VLC-Wiedergabeliste hinzufügen"

Menüs:
*Extras->"Vollbildsteuerung" => "Vollbild" (wie Firefox)
*Medien->"Advanced open file" => "" ('''NICHT ÜBERSETZT''')

== Miscellaneous ==
Menus:
*Extras->"Media info", Extras->"Codec info"
** Duplicate functionality: First one already allows for switching to second one '''[DUP]'''
*Media->"Open file", Media->"Advanced open file"
** Duplicate functionality: Second one always opens as file selection dialogue, which is exactly what the first one provides '''[DUP]'''

== TODO ==
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!</s> Gone! Resort to wiki editing :-(
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].

=== Fullscreen controller polishing ===
Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
* Supports:
** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
** Transparency (specify <tt>background-color</tt> as a rgba color)
** More things to ponder on?

=== Improve translation process ===
Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''
'''''Is this still the case?'''''
--[[User:Materthron|materthron]] 17:58, 4 January 2009 (CET)

User:Materthron

2009-01-04T16:42:24Z

Materthron: lnk corr + ICQ# update

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. My primary field of interest is HCI and i18n; to a lesser extent more technical things like coding.

I've joined the VideoLAN project like 1 year ago, but haven't been very active. I've been helping [[User:Fkuehne|Felix Kühne]] with the German translation and I'm trying to improve the wiki in as many ways I can.
Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]] to which I'm also fairly new).
From time to time I'm getting the latest nighties to see if everything (still) works fine.
See [[Special:Contributions/Materthron|my contributions]] if you're more curious.



'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
** Supports:
*** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
*** Transparency (specify <tt>background-color</tt> as a rgba color)
*** More things to ponder on?
* Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''

[[User:Materthron/NotesAndIdeas|Notes and Ideas]]

== Getting in touch ==
Feel free to contact me via ICQ (496133349), Skype (materthron) or email (materthron ÄT users DOT sourceforge DOT com).

User:Materthron

2009-01-04T16:39:57Z

Materthron:

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. My primary field of interest is HCI and i18n; to a lesser extent more technical things like coding.

I've joined the VideoLAN project like 1 year ago, but haven't been very active. I've been helping [[User:Fkuehne|Felix Kühne]] with the German translation and I'm trying to improve the wiki in as many ways I can.
Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]] to which I'm also fairly new).
From time to time I'm getting the latest nighties to see if everything (still) works fine.
See [[Special:Contributions/Materthron|my contributions]] if you're more curious.



'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
** Supports:
*** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
*** Transparency (specify <tt>background-color</tt> as a rgba color)
*** More things to ponder on?
* Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''

[[User:Materthron/NotesAndIdeas Notes and Ideas]]

== Getting in touch ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (materthron ÄT users DOT sourceforge DOT com).

Documentation:Play HowTo/Basic Use

2008-12-28T17:33:30Z

Materthron: /* Example finding a Shoutcast radio stream */ spelling

{{RightMenu|documentation play howto toc 0.9}}

'''Note: this documentation is for versions 0.9 and newer and is under construction. For simple help with 0.9 see [[Documentation:VLC for dummies| VLC for dummies: an introduction to VLC]]. For older versions please see and [[Documentation:Play_HowTo/Basic_Use|Basic Use]].'''

== General interface description==

VLC has several interfaces:
*A cross-platform interface, for Windows and GNU/Linux, called wxWidgets,
*A native Mac OS X interface, and
*A skinnable interface for Windows and GNU/Linux.
Screenshots below are drawn from the various interfaces, but VLC's functions work essentially the same on all operating systems.

===Windows and GNU/Linux (Qt)===

This is the default interface on Windows and GNU/Linux (the screenshot is done on GNU/Linux, but it would look quite the same on Windows).

[[Image:Vlc-en.png]]

If you are using VLC 0.9.4 under Windows Vista with Classic mode then you will see this:

[[Image:Vlc-vistaclassic-en.png]]

You can also choose to display advanced buttons on this interface. To do this, go to the ''Tools'' menu and click ''Advanced Controls''. You will see extra buttons, such as loop and take snapshot, shown below.

[[Image:Vlc-advancedcontrols-vistaclassic-en.png]]

This interface also features ''Extended Settings'' which contains additional features, such as Video, Audio and Synchronisation. To display or hide it, click on the button displaying the equalizer icon (three vertical sliders). Alternatively, go to the ''Tools'' menu and click ''Extended Settings''. (VLC versions older than 0.9 named these extended settings as ''Extended GUI'' and displayed them attached to the main window.) VLC 0.9 displays these extended setting in a separate window, as shown below.

[[Image:Vlc-extendedsettings-vistaclassic-en.png]]

The interface's general appearance can be changed. To do this go to the ''Tools'' menu and click ''Preferences'' and select ''Interface''.

===Native Mac OS X (Cocoa)===

This is the default interface on Mac OS X.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx.jpg The Mac OS X interface '''- this screenshot needs to be verified and updated if needed for the 0.9 interface'''

This interface features an ''Extended GUI'' as well. It is called "Extended Controls" and can be opened through the Window menu.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-extended.jpg The Mac OSX interface with with the extended controls panel'''- this screenshot needs to be verified and updated if needed for the 0.9 interface'''

==Basic playback==

===Play a file===

To play a file, open the Media menu, and select the Open File menu item. An Open File dialog box will appear. Select the file you want to open, and click Open. VLC will start playing the selected file.
An alternative is to drag 'and' drop your file onto the VLC main interface or playlist window from the file explorer (Finder on MacOS X).
[[Image:Vlc-mediaopenfile-vistaclassic-en.png]]

VLC 0.9.8a version Windows XP mode

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-file-menu.jpg The File menu - MacOS X interface'''- needs verifying for 0.9'''

[[Image:Vlc-mediaopenfileselected-vistaclassic-en.png]] The Open file dialog - wxWidgets interface

(need 0.9 screenshot for MacOS) The Open file dialog - MacOS X interface

===Play a CD/DVD/VCD===

To Play a CD, VCD or a DVD, open the ''File'' menu, and select the ''Open Disc...'' menu item. In the Open Disk Dialog Box, select the type of media (DVD, VCD or Audio CD). When reading a DVD, you can enable DVD menus by selecting the ''DVD (menus)'' disc type in the wxWidgets Interface. In the MacOS X interface, this can be done by selecting the "Use DVD menus" dialog box.

You can select the drive from which the media should be read by giving the appropriate drive letter or device name in the "Device Name" text input. This should be auto-detected on MacOS X.

If you want to start the DVD or VCD playback from a given title and chapter instead of from the beginning, you can set it using the ''Title'' and ''Chapter'' selectors.

You can start playback by selecting the ''Ok'' button.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-open-disk.jpg The Open disk dialog - wxWidgets interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-open-disk.jpg The Open disk dialog - MacOS X interface'''- needs verifying for 0.9'''

===Play a network stream (WebRadio, WebTV, etc.)===

To open a network stream, open the "Media" menu and select the "Open Network" menu item.

*To open a UDP unicast stream, select ''UDP/RTP'', and set the appropriate UDP port in the selector (it is 1234 for streams sent by a VLC or VLS server).
*To open a UDP multicast stream, select ''UDP/RTP multicast''. Give the address of the multicast group in the "Address" text input, and select the appropriate UDP port.
*To open a stream sent over http (Webradios, WebTVs, Shoutcast, Icecast...), ftp, or mms (Microsoft Media Server), select "HTTP/FTP/MMS", and give the corresponding complete URL, (http://www.tvcultura.com.br/radiofm/radiofm.asx) in the corresponding text input. This also the way to open a RTSP stream with the MacOS X interface.
*To open a RTSP stream (sent by Darwin Streaming Server, VLC, etc), in the wxWidgets interface, select "RTSP" and give the URL in the text input.

You can start playback by selecting the ''Ok'' button.

If you get some stuttering during playback, you can try to increase the size of the read buffer. This can be done in the ''Open Network Stream'' dialog box, by selecting the ''Caching'' box. You can then choose the amount time (in milliseconds) VLC should store data in its buffer before starting playback.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-open-net.jpg The Open network dialog - wxWidgets interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-open-net.jpg The Open network dialog - MacOS X interface'''- needs verifying for 0.9'''

==== Example finding a Shoutcast radio stream ====

This example was verified as working on 15 October 2008, using VLC 0.9.4 under Windows Vista.
''This needs reproducing by other people on other versions and other operating systems.''

1. Ensure your firewall is set to allow the VideoLan program to make outgoing connections.

2. Click ''Tools'' then ''Preferences'', click Interface and then click All under "Show settings". Then click the "-" next to "Playlist" in order to show the "Services discovery" submenu. If the shoutcast radio listings box is empty, click it so that a check-mark appears. The text field underneath should now show the word "shout". Click the Save button to save and close the Preferences window:

[[Image:Vlc-preferencesservicesdiscoveryshoutcrop-en.png]]

3. Restart VLC media player to make it take notice of the changed preferences.

4. On the VLC interface click ''Playlist'', then click ''Show Playlist''. Select the "Shoutcast Radio" in the left hand panel. If nothing appears in the righthand panel, try double-clicking "Shoutcast Radio" and waiting, it may take a few minutes the first time. After a while the righthand panel displays a long list of titles.

[[Image:Vlc-playlistshoutcastradio-en.png]]

5. Scroll down the radio stations in the right-hand panel and select one. Click the mouse right button and click the "Play" item.

[[Image:Vlc-playlistshoutcastradioplay-en.png]]

6. It may take some time for the connection to the radio station to establish (and it may fail if the station's outgoing streams are all occupied). When it does connect, VLC should start playing the audio stream from the station:

[[Image:Vlc-playlistshoutcastradioplayingsmall-en.png]]

==== Example playing a known Shoutcast radio stream ====

Go to http://www.shoutcast.com/ and search for a radio station of your choice. On Windows, right-click your mouse over Shoutcast's "Tunein" button and click "Save Link As..." to save the playlist on your computer. Remember where you saved the playlist, rename it to something that makes sense.

At any time later, you can use VLC to open the saved playlist and listen to that radio station.

For example, to find a BBC World Service radio stream, use a browser to go to:
http://www.shoutcast.com/directory/search_results.jsp?searchCrit=simple&s=bbc

One of the stations listed may be playing the World Service, if so move your mouse over the "TUNEIN!" webicon and click the right mouse button and click "Save Link As...", as described above.

===Play from an acquisition card===

This currently only possible on Linux and Windows. Open the File menu, and select "Open Capture Device..."

On Windows, supported cards include webcams, TV cards, acquisition cards... provided they come with directshow compatible drivers (Almost all acquisition cards do). You can choose the device to use for video and audio capture using the "Video device name" and "Audio device name" selectors. If your device doesn't appear in the list, try to select the "Refresh list" button. You can access the settings of your acquisition device by selecting the ''configure'' button. Options here depend on the driver of the device. You can select the "Device Proprieties" box if you want the configuration dialog box of every device to be displayed after having pressed the ''Ok'' button. Select the ''Tuner properties'' box to be prompted for tuner settings (PAL/NTSC standard, frequency...) for TV cards. The ''Advanced options...'' button allows to select some further settings useful in some rare cases, such as the chroma of the input (the way colors are encoded) and the size of the input buffer.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-open-capture.jpg The Open Capture device dialog and a device configuration windows- wxWidgets interface'''- needs verifying for 0.9'''

On Linux, supported cards include webcams, TV cards, acquisition cards, provided they are supported by the Video4Linux architecture. Haupaugge PVR 250/350 cards are also supported, using the [http://ivtv.sourceforge.net/ IVTV drivers].

*For Video4Linux devices, you can set the name of the video and audio devices using the "Video device name" and "Audio device name" text inputs. The "Advanced options..." button allows to select some further settings useful in some rare cases, such as the chroma of the input (the way colors are encoded) and the size of the input buffer.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-open-v4l.jpg The Open Video4Linux dialog- wxWidgets interface'''- needs verifying for 0.9'''

*To use a Hauppauge PVR card, select the PVR tab in the "Open" dialog box. Use the "Device" text input to set the device of the card you want to use. You can set the Norm of the tuner (PAL, SECAM or NTSC) by using the "Norm" Drop Down. The Frequency selector allows you to set the frequency of the tuner (in kHz), the bitrate selector to set the bitrate of the resulting encoded stream (in bit/s). The "Advanced Options button allows to set some more settings, such as the size of the encoded video (in pixels), its framerate (in frame per second), the interval between 2 key frames, etc.

After having set all the required parameters, you can start the capture by selecting the "Ok" button.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-open-pvr.jpg The Open PVR dialog- wxWidgets interface'''- needs verifying for 0.9'''

==Playlist==

VLC can store a list of several files to play one after the other, using its playlist system. To access the playlist, click on the ''Playlist'' button on the main interface.

Each time you use the Open dialog box, the stream you select is appended at the end of the playlist and started.

The playlist window shows all the available streams. Double-click one to play it.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-playlist.jpg The Playlist - wxWidgets interface'''- needs updating for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-playlist.jpg The Playlist - MacOS X interface'''- needs verifying for 0.9'''

===Adding items, saving and loading playlists===

In the wxWidgets interface, the ''Manage'' menu allows you to append an item at the end of the playlist (its playback won't start immediately), to save the playlist as a M3U or PLS file, or to import a playlist file.

In the MacOS X interface, saving a playlist can be done using the ''Save Playlist...'' function in the ''File'' menu. To import a playlist file, open it the same way as any other media file, using the ''Quick Open File...'' menu item.

===Sorting===

In the wxWidgets interface, ''Sort'' allows you to sort the playlist according to several criteria, or to shuffle it. You can also sort by clicking the header of the column.

In the MacOS X interface, sorting can be done by clicking the header of the column matching the criteria you want to use for sorting.

===Playlist modes===

The playlist supports several playback modes.

In the wxWidgets interface, the toolbar contains three playlist mode buttons. They allow to enable random mode, to repeat the whole playlist or to repeat one item.

In the MacOS X interface, random mode can be enabled by selecting the ''Random'' box. A drop down menu allows you to enable playlist and item repeat modes.

===Misc===

====Search====

You also have a search tool. Enter a search string and hit search. The next item to match the string will be highlighted. Keep hitting Search to cycle between all matching items.

====Moving items====

In the wxWidgets interface, the ''Up'' and ''Down'' buttons at the bottom of the playlist window allow you to move an item. Select an item and use these buttons to move it.

In the MacOS X interface, you can easily move an item with the mouse, using drag-and-drop.

====Contextual menu====

By right-clicking or control-clicking an item, a contextual menu will appear, giving access to a number of functions (for example, play the item, disable it, delete it, or get info on it).

If you ask for info, an ''item info'' dialog box will appear. This dialog box also allows you to change the name, the author and the location of the item to play.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-iteminfo.jpg Item Info Dialog - wx Interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-iteminfo.jpg Item Info Dialog - MacOS X interface'''- needs verifying for 0.9'''

==Subtitles==

VLC supports many kinds of subtitles.

===Media with included subtitles===

Many types of media can have embedded subtitles. VLC can read subtitles for the following media:
*DVD
*SVCD
*OGM files
*Matroska (MKV) files

Subtitles are disabled by default. To enable them, go to the ''Video'' menu, and to ''Subtitles track''. All available subtitles tracks will be listed. Select one to get the subtitles. Depending on the media, a description (language, for example) might be available for the track.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-select-sub.jpg Select a subtitles track under Windows or Linux'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-select-sub.jpg Select a subtitles track under MacOS X'''- needs verifying for 0.9'''

DVD and SVCD subtitles are merely images, so you won't be able to change anything for them. OGM and Matroska subtitles are rendered text, so you will be able to change several options.

Text rendering options can be changed in the Preferences. In the ''Modules'' section, ''text renderer'' subsection, open the ''freetype'' page. You can then set the font and its size. For the font, you have to select a font file. Under Windows, they can be found in ''C:\Windows\Fonts''. Under MacOS X, they are in ''/System/Library/Fonts''. Size can be set either relatively or as a number of pixels.

You need to restart your stream for the font modifications to take effect.

===Subtitles files===

While modern file formats like Matroska or OGM can handle subtitles directly, older formats like AVI can't. Therefore, a number of subtitles files formats have been created. You need two files: the
video file and the subtitles files that only contains the text of the subtitles and timestamps.

VLC can handle these types of subtitles files:
*MicroDVD
*SubRIP
*SubViewer
*SSA
*Sami
*Vobsub (this one is quite special: it is not made from text but from images, which means that you can't change the fonts)

To open a subtitles file, use the Advanced Open dialog box (Menu File, Open file). Select your file by clicking on the ''Browse'' button. Then, check the ''Subtitle options'' checkbox and click on the Settings button.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-sub-file.jpg Select a subtitles file under Windows or Linux'''- needs verifying for 0.9'''

You can then select the subtitles file by clicking the ''Browse'' button. You can also set a few options like character encoding, alignment and size. The delay option allows you to delay the subtitles against the video if they are not in sync. If they are not at the same speed, you might also want to adjust the subtitles framerate.

Note: For Vobsub subtitles, you need to select the '''.idx''' file, not the '''.sub''' file.
Encoding, alignment and size won't have any effect for Vobsub subtitles.

Font can be changed as explained in the previous section.

==Video and audio filters==

VLC includes a system of ''filters'' that allow you to modify the audio and video.

===Deinterlacement and Post Processing===

VLC is able to deinterlace a video stream using different deinterlacement methods. Deinterlacement can be enabled in the ''Video'' menu, ''Deinterlacement'' menu item. The ''Blend'' methods gives the best results in most cases. The ''discard''method is a less resource consuming alternative.

On some particular streams (MPEG 4, DIVX, XVID, Sorenson, etc.), some additional image filtering can be applied to the video before display, improving its quality in some cases. This can be enabled in the ''Video'' menu, ''Post processing'' menu item. Different levels of post processing can be chosen here. A higher level means more filtering.

===Video filters===

VLC features several filters able to change the video (distortion, brightness adjustment, motion blurring, etc.).

With the wxWidgets interface, filters can be easily enabled using the Extended GUI. In the Video tab, simply select the filters to enable. Image settings can be easily adjusted.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-vfilters.jpg Video filters selection in the wxWidgets interface'''- needs verifying for 0.9'''

You can enable these filters through the ''Extended Controls panel'' on Mac OS X. Click on the triangle next to ''Video filters'' to select your filters or expand the ''Adjust Image'' section to change the contrast, hue, etc.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-vfilters.jpg Video filters selection in the Mac OS X interface'''- needs verifying for 0.9'''

For better control, you need to go to the preferences. To select the filters to be enabled, go to ''Video'', then to ''Filters''. In the "video filter module" box, enter the names of the filters to enable, separated by semicommas. Filters will be applied in the selected order. Valid names are "clone", "wall", "transform", "adjust", "crop", "deinterlace", "distort", "motionblur" and "logo".

If you want to tune the behavior of these filters, go to ''Video, Filters, [your filter]''. For each filter, you will find a short description and the options.

===Audio filters===

====Equalizer====

VLC features a 10-band graphical equalizer. You can display it by activating the advanced GUI on wxWidgets or by clicking the ''Equalizer'' button on the MacOS X interface.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-equalizer.jpg The equalizer in the wxWidgets interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-equalizer.jpg The equalizer in the MacOS X interface'''- needs verifying for 0.9'''

Presets are available in the Audio menu in wxWidgets, or in the Equalizer window in the MacOS X interface.

====Other audio filters====

At the moment, VLC features two other audio filters: a volume normalizer and a filter providing sound spatialization with a headphone. They can be enabled in the Audio tab of the extended GUI for the wxWidgets interface and in the Audio section of the Extended Controls panel of the Mac OS X interface.

For better control, you need to go to the preferences. To select the filters to be enabled, go to ''Audio'', then to ''Filters''. In the "audio filters" box, enter the names of the filters to enable, separated by commas. Valid names are "equalizer", "normvol" and "headphone".

If you want to tune the behavior of these filters, go to ''Audio, Filters, [your filter]''. The equalizer and headphone filters can be tuned.

==Snapshots (aka, screenshots)==
There are two ways to take snapshots (i.e., screenshots or frame grabs) with VLC:
#Go to Video -> Snapshot, or
#Press the snapshot hotkey
#*Windows / Linux / Unix: Ctrl-Alt-s
#*Mac OS X: Command-Alt-s

When a snapshot is taken, it will briefly preview as a thumbnail with its filename and then fade away.

To change the hotkey, go to Preferences -> Interface -> Hotkeys settings. Check Advanced options, and set Take video snapshot.

===Snapshot location, format and name===
The snapshot location depends upon your operating system:
*Windows: My Documents\My Pictures\
*Linux / Unix: $(HOME)/.vlc/
*Mac OS X: Desktop/

The default format for snapshots is PNG, but this may be changed to JPEG. Also, the default name for snapshots is ''vlcsnap-'' followed by a timestamp that is ''not'' the time of the frame in the video you're viewing.

The location, format and name of snapshots may be changed in the Preferences. Also, you may substitute other text for ''vlcsnap-'' in the ''Video snapshot file prefix'' and you may choose to have snapshots numbered sequentially (i.e., 000001, 000002, 000003, and so on) instead of with a timestamp. As of version 0.9.0, you may even use [[Documentation:Play HowTo/Format String|variables]] in the text used for the filename. For example, ''$T'' (must be upper case) will insert the video's time code into the file name. If you were to change the prefix to ''Friends-$T-'' while watching a DVD of ''Friends'', then the snapshot filenames would look something like this: Friends-00_05_21-00004.png . This indicates a snapshot taken at 5 minutes and 21 seconds into the video; and it was the number 00004 snapshot of the day.

For a full list of variables, please see [[Documentation:Play HowTo/Format String]].

==Hotkeys==

Most of VLC functions are accessible using hotkeys.

The list of the available hotkeys and their functions can be retrieved and altered in the preferences panel of the player. In the wxWidgets interface, preferences are available in the "Settings" menu, "Preferences" menu item. In the MacOS X interface, open the "VLC" menu, and select "Preferences". Select the "Hot keys" panel in the dialog.

As of version 0.9, a list of hotkeys is presented in a drop-down window. To change one, double-click its name to select it. Then, press the new key that will trigger the specified action. Modifier keys (such as Control/Command and Alt) may also be used.

In earlier versions, several boxes give the list of modifiers for the hotkey. To trigger an action using a hotkey, you need to press simultaneously the keys corresponding to the different selected modifiers as well as the key set in the dropdown.

To change the binding of a hotkey, select or deselect boxes corresponding to the different modifiers, and change the key by using the drop-down menu. Select the ''Save'' button to apply the changes.

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-hotkeys.jpg The Hotkeys Panel - wxWidgets interface'''- needs verifying for 0.9'''

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-osx-hotkeys.jpg The Hotkeys Panel - MacOS X interface'''- needs verifying for 0.9'''

==Basic troubleshooting==

===File does not play, only sound or only video===

Maybe the file you are trying to read is not fully supported. VLC does not use the codec packs (the software that decodes video signals) you might have installed. It comes with its own codecs. If there is no open-source decoder for the format you are trying to read, it won't be supported. (There is an exception, under Windows, for codecs that use the DirectShow framework.)

To find out, open the Messages Window (View menu) and restart your stream. Look for error messages (red messages)

http://www.videolan.org/doc/play-howto/en/images/play-howto/intf-wx-messages.jpg The wxWidgets messages window'''- needs verifying for 0.9'''

In this example, the file contains a IV41 video stream, a codec that is not supported by VLC.

You may of course have other messages. If you post to a VideoLAN mailing list or in the forum, please include such a log. It is very valuable in troubleshooting.

===Weird VLC behavior and crashes===

A very common thing is a corrupted VLC preferences file. Don't hesitate to delete it if problems appear suddenly. You will find in the FAQ details on [http://www.videolan.org/doc/faq/en/index.html#id2470084 how to delete your preferences file].

===Computer crashes / Video is corrupted===

Another common problem is buggy video drivers. Try upgrading them from the website of your video card's manufacturer.

Also, you can try disabling Overlay (Preferences/General/Video, untick "Overlay video output")

{{Documentation}}

QtHotkeys

2008-12-28T17:20:11Z

Materthron: /* Main Interface Shortcuts */

This page is just a reminder of what the hotkeys are in the Qt4 Interface.

== Main Interface Shortcuts ==

'''Ctrl + A''' : Advanced controls

'''Ctrl + B''' : Bookmarks

'''Ctrl + C''' : Open capture device

'''Ctrl + D''' : Open disc

'''Ctrl + E''' : Extended settings

'''Ctrl + F''' : Open Folder/Directory

'''Ctrl + G''' :

'''Ctrl + H''' : hide/show menus (a.k.a Minimal view; like in Acrobat Reader)

'''Ctrl + I''' : Media Information

'''Ctrl + J''' : Codecs Information

'''Ctrl + K''' : 

'''Ctrl + L''' : Hide/Show playlist

'''Ctrl + M''' : Messages

'''Ctrl + N''' : Open network stream

'''Ctrl + O''' : Open File

'''Ctrl + P''' : Preferences

'''Ctrl + Q''' : Quit

'''Ctrl + R''' : Convert/Save

'''Ctrl + S''' : Streaming

'''Ctrl + T''' : Goto Time

'''Ctrl + U''' : Dock/Undock playlist

'''Ctrl + V''' :

'''Ctrl + W''' : VLM configurator

'''Ctrl + X''' : Load playlist

'''Ctrl + Y''' : Save playlist

'''Ctrl + Z''' : Switch to skins (requires restart)

== Core hotkeys ==

'''+''' : faster

'''-''' : slower

'''ESC''' : leave fullscreen/close dialogue

'''space''' : play/pause

'''Enter''' : select menu entry (dvd)

'''Arrows''' : navigate menus (dvd)

'''A''' : cycle aspect ratio

'''B''' : cycle audio track

'''C''' : cycle cropping ratio

'''D''' : cycle deinterlace filters

'''E''' : next frame (1.0 and over)

'''F''' : toggle fullscreen

'''G''' : subdelay down

'''H''' : subdelay up

'''I''' : 

'''J''' : audiodelay down

'''K''' : audiodelay up

'''L''' : 

'''M''' : mute

'''N''' : next track

'''O''' :

'''P''' : previous track

'''Q''' :

'''R''' : 

'''S''' : stop

'''T''' : 

'''U''' :

'''V''' : subtitle track cycle

'''W''' : wallpaper (does only work with video output DirectX)

'''X''' :

'''Y''' :

'''Z''' : cycle zoom

== Core hotkeys ==

'''Shift + A''' : cycle audio device

'''Shift + B''' : title next

'''Shift + G''' : history back

'''Shift + H''' : history forward

'''Shift + N''' : chapter next

'''Shift + O''' : title prev

'''Shift + P''' : chapter prev

'''Shift + M''' : disc menu

'''Shift + S''' : snapshot

'''Alt + A''' : audio menu (English translation)

'''Alt + B''' :

'''Alt + C''' : crop / (+shift) uncrop bottom

'''Alt + D''' : crop / (+shift) uncrop left

'''Alt + E''' :

'''Alt + F''' : crop / (+shift) uncrop right

'''Alt + G''' :

'''Alt + H''' : help menu (English translation)

'''Alt + I''' :

'''Alt + J''' :

'''Alt + K''' :

'''Alt + L''' : playback menu (English translation)

'''Alt + M''' : media menu (English translation)

'''Alt + N''' :

'''Alt + O''' :

'''Alt + P''' :

'''Alt + Q''' :

'''Alt + R''' : crop / (+shift) uncrop top

'''Alt + S''' :

'''Alt + T''' : tools menu (English translation)

'''Alt + U''' :

'''Alt + V''' : video menu (English translation)

'''Alt + W''' :

'''Alt + X''' :

'''Alt + Y''' :

'''Alt + Z''' :

'''Alt + Left Arrow''' : jump 10 sec. in the past

QtHotkeys

2008-12-26T16:18:46Z

Materthron: /* Core hotkeys */ tested and updated appropriately

This page is just a reminder of what the hotkeys are in the Qt4 Interface.

== Main Interface Shortcuts ==

'''Ctrl + A''' : Advanced controls

'''Ctrl + B''' : Bookmarks

'''Ctrl + C''' : Open capture device

'''Ctrl + D''' : Open disc

'''Ctrl + E''' : Extended settings

'''Ctrl + F''' : Open Folder/Directory

'''Ctrl + G''' :

'''Ctrl + H''' : hide/show menus (a.k.a Minimal view)

'''Ctrl + I''' : Media Information

'''Ctrl + J''' : Codecs Information

'''Ctrl + K''' : 

'''Ctrl + L''' : Hide/Show playlist

'''Ctrl + M''' : Messages

'''Ctrl + N''' : Open network stream

'''Ctrl + O''' : Open File

'''Ctrl + P''' : Preferences

'''Ctrl + Q''' : Quit

'''Ctrl + R''' : Convert/Save

'''Ctrl + S''' : Streaming

'''Ctrl + T''' : Goto Time

'''Ctrl + U''' : Dock/Undock playlist

'''Ctrl + V''' :

'''Ctrl + W''' : VLM configurator

'''Ctrl + X''' : Load playlist

'''Ctrl + Y''' : Save playlist

'''Ctrl + Z''' : Switch to skins (requires restart)

== Core hotkeys ==

'''+''' : faster

'''-''' : slower

'''ESC''' : leave fullscreen/close dialogue

'''space''' : play/pause

'''Enter''' : select menu entry (dvd)

'''Arrows''' : navigate menus (dvd)

'''A''' : cycle aspect ratio

'''B''' : cycle audio track

'''C''' : cycle cropping ratio

'''D''' : cycle deinterlace filters

'''E''' : next frame (1.0 and over)

'''F''' : toggle fullscreen

'''G''' : subdelay down

'''H''' : subdelay up

'''I''' : 

'''J''' : audiodelay down

'''K''' : audiodelay up

'''L''' : 

'''M''' : mute

'''N''' : next track

'''O''' :

'''P''' : previous track

'''Q''' :

'''R''' : 

'''S''' : stop

'''T''' : 

'''U''' :

'''V''' : subtitle track cycle

'''W''' : wallpaper (does only work with video output DirectX)

'''X''' :

'''Y''' :

'''Z''' : cycle zoom

== Core hotkeys ==

'''Shift + A''' : cycle audio device

'''Shift + B''' : title next

'''Shift + G''' : history back

'''Shift + H''' : history forward

'''Shift + N''' : chapter next

'''Shift + O''' : title prev

'''Shift + P''' : chapter prev

'''Shift + M''' : disc menu

'''Shift + S''' : snapshot

'''Alt + A''' : audio menu (English translation)

'''Alt + B''' :

'''Alt + C''' : crop / (+shift) uncrop bottom

'''Alt + D''' : crop / (+shift) uncrop left

'''Alt + E''' :

'''Alt + F''' : crop / (+shift) uncrop right

'''Alt + G''' :

'''Alt + H''' : help menu (English translation)

'''Alt + I''' :

'''Alt + J''' :

'''Alt + K''' :

'''Alt + L''' : playback menu (English translation)

'''Alt + M''' : media menu (English translation)

'''Alt + N''' :

'''Alt + O''' :

'''Alt + P''' :

'''Alt + Q''' :

'''Alt + R''' : crop / (+shift) uncrop top

'''Alt + S''' :

'''Alt + T''' : tools menu (English translation)

'''Alt + U''' :

'''Alt + V''' : video menu (English translation)

'''Alt + W''' :

'''Alt + X''' :

'''Alt + Y''' :

'''Alt + Z''' :

'''Alt + Left Arrow''' : jump 10 sec. in the past

QtHotkeys

2008-12-26T16:04:08Z

Materthron: /* Core hotkeys */ tested and updated appropriately

This page is just a reminder of what the hotkeys are in the Qt4 Interface.

== Main Interface Shortcuts ==

'''Ctrl + A''' : Advanced controls

'''Ctrl + B''' : Bookmarks

'''Ctrl + C''' : Open capture device

'''Ctrl + D''' : Open disc

'''Ctrl + E''' : Extended settings

'''Ctrl + F''' : Open Folder/Directory

'''Ctrl + G''' :

'''Ctrl + H''' : hide/show menus (a.k.a Minimal view)

'''Ctrl + I''' : Media Information

'''Ctrl + J''' : Codecs Information

'''Ctrl + K''' : 

'''Ctrl + L''' : Hide/Show playlist

'''Ctrl + M''' : Messages

'''Ctrl + N''' : Open network stream

'''Ctrl + O''' : Open File

'''Ctrl + P''' : Preferences

'''Ctrl + Q''' : Quit

'''Ctrl + R''' : Convert/Save

'''Ctrl + S''' : Streaming

'''Ctrl + T''' : Goto Time

'''Ctrl + U''' : Dock/Undock playlist

'''Ctrl + V''' :

'''Ctrl + W''' : VLM configurator

'''Ctrl + X''' : Load playlist

'''Ctrl + Y''' : Save playlist

'''Ctrl + Z''' : Switch to skins (requires restart)

== Core hotkeys ==

'''+''' : faster

'''-''' : slower

'''ESC''' : leave fullscreen/close dialogue

'''space''' : play/pause

'''Enter''' : select menu entry (dvd)

'''Arrows''' : navigate menus (dvd)

'''A''' : cycle aspect ratio

'''B''' : cycle audio track

'''C''' : cycle cropping ratio

'''D''' : cycle deinterlace filters

'''E''' : next frame (1.0 and over)

'''F''' : toggle fullscreen

'''G''' : subdelay down

'''H''' : subdelay up

'''I''' : 

'''J''' : audiodelay down

'''K''' : audiodelay up

'''L''' : 

'''M''' : mute

'''N''' : next track

'''O''' :

'''P''' : previous track

'''Q''' :

'''R''' : 

'''S''' : stop

'''T''' : 

'''U''' :

'''V''' : subtitle track cycle

'''W''' : wallpaper (does only work with video output DirectX)

'''X''' :

'''Y''' :

'''Z''' : cycle zoom

== Core hotkeys ==

'''shift + A''' : cycle audio device

'''Shift + B''' : title next

'''Shift + G''' : history back

'''Shift + H''' : history forward

'''Shift + N''' : chapter next

'''Shift + O''' : title prev

'''Shift + P''' : chapter prev

'''Shift + M''' : disc menu

'''Shift + S''' : Snapshot

'''Alt + A''' : Audio menu (en translation)

'''Alt + B''' :

'''Alt + C''' : crop / (+shift) uncrop bottom

'''Alt + D''' : crop / (+shift) uncrop left

'''Alt + E''' :

'''Alt + F''' : crop / (+shift) uncrop right

'''Alt + G''' :

'''Alt + H''' : Help menu (en translation)

'''Alt + I''' :

'''Alt + J''' :

'''Alt + K''' :

'''Alt + L''' : Playback menu (en translation)

'''Alt + M''' : Media menu (en translation)

'''Alt + N''' :

'''Alt + O''' :

'''Alt + P''' :

'''Alt + Q''' :

'''Alt + R''' : crop / (+shift) uncrop top

'''Alt + S''' :

'''Alt + T''' : Tools menu (en translation)

'''Alt + U''' :

'''Alt + V''' : Video menu (en translation)

'''Alt + W''' :

'''Alt + X''' :

'''Alt + Y''' :

'''Alt + Z''' :

'''Alt + Left Arrow''' : jump 10 sec. in the past

QtHotkeys

2008-12-26T15:46:03Z

Materthron: /* Main Interface Shortcuts */ tested and updated appropriately

This page is just a reminder of what the hotkeys are in the Qt4 Interface.

== Main Interface Shortcuts ==

'''Ctrl + A''' : Advanced controls

'''Ctrl + B''' : Bookmarks

'''Ctrl + C''' : Open capture device

'''Ctrl + D''' : Open disc

'''Ctrl + E''' : Extended settings

'''Ctrl + F''' : Open Folder/Directory

'''Ctrl + G''' :

'''Ctrl + H''' : hide/show menus (a.k.a Minimal view)

'''Ctrl + I''' : Media Information

'''Ctrl + J''' : Codecs Information

'''Ctrl + K''' : 

'''Ctrl + L''' : Hide/Show playlist

'''Ctrl + M''' : Messages

'''Ctrl + N''' : Open network stream

'''Ctrl + O''' : Open File

'''Ctrl + P''' : Preferences

'''Ctrl + Q''' : Quit

'''Ctrl + R''' : Convert/Save

'''Ctrl + S''' : Streaming

'''Ctrl + T''' : Goto Time

'''Ctrl + U''' : Dock/Undock playlist

'''Ctrl + V''' :

'''Ctrl + W''' : VLM configurator

'''Ctrl + X''' : Load playlist

'''Ctrl + Y''' : Save playlist

'''Ctrl + Z''' : Switch to skins (requires restart)

== Core hotkeys ==

'''+''' : faster

'''-''' : slower

'''ESC''' : leave fullscreen

'''space''' : play/pause

'''Enter''' : Navigation activation (dvd)

'''Arrows''' : Navigation (dvd)

'''A''' : aspect ratio

'''B''' : cycle audio track

'''C''' : cropping ratio

'''D''' : deinterlace

'''E''' : next frame (1.0 and over)

'''F''' : Fullscreen

'''G''' : subdelay down

'''H''' : subdelay up

'''I''' : interface show

'''J''' : audiodelay down

'''K''' : audiodelay up

'''L''' : loop

'''M''' : mute

'''N''' : next track

'''O''' :

'''P''' : previous track

'''Q''' :

'''R''' : random

'''S''' : stop

'''T''' : position/time

'''U''' :

'''V''' : subtitle track cycle

'''W''' : wallpaper

'''X''' :

'''Y''' :

'''Z''' : zoom

== Core hotkeys ==

'''shift + A''' : cycle audio device

'''Shift + B''' : title next

'''Shift + G''' : history back

'''Shift + H''' : history forward

'''Shift + N''' : chapter next

'''Shift + O''' : title prev

'''Shift + P''' : chapter prev

'''Shift + M''' : disc menu

'''Shift + S''' : Snapshot

'''Alt + A''' : Audio menu (en translation)

'''Alt + B''' :

'''Alt + C''' : crop / (+shift) uncrop bottom

'''Alt + D''' : crop / (+shift) uncrop left

'''Alt + E''' :

'''Alt + F''' : crop / (+shift) uncrop right

'''Alt + G''' :

'''Alt + H''' : Help menu (en translation)

'''Alt + I''' :

'''Alt + J''' :

'''Alt + K''' :

'''Alt + L''' : Playback menu (en translation)

'''Alt + M''' : Media menu (en translation)

'''Alt + N''' :

'''Alt + O''' :

'''Alt + P''' :

'''Alt + Q''' :

'''Alt + R''' : crop / (+shift) uncrop top

'''Alt + S''' :

'''Alt + T''' : Tools menu (en translation)

'''Alt + U''' :

'''Alt + V''' : Video menu (en translation)

'''Alt + W''' :

'''Alt + X''' :

'''Alt + Y''' :

'''Alt + Z''' :

'''Alt + Left Arrow''' : jump 10 sec. in the past

User:Materthron

2008-12-05T14:27:50Z

Materthron: + updates

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. My primary field of interest is HCI and i18n; to a lesser extent more technical things like coding.

I've joined the VideoLAN project like 1 year ago, but haven't been very active. I've been helping [[User:Fkuehne|Felix Kühne]] with the German translation and I'm trying to improve the wiki in as many ways I can.
Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]] to which I'm also fairly new).
From time to time I'm getting the latest nighties to see if everything (still) works fine.
See [[Special:Contributions/Materthron|my contributions]] if you're more curious.



'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
** Ha! Free version [http://www.qtrac.eu/C++-GUI-Programming-with-Qt-4-1st-ed.zip here].
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
** Supports:
*** [http://doc.trolltech.com/4.4/stylesheet-examples.html#customizing-a-qpushbutton-using-the-box-model Round corners]
*** Transparency (specify <tt>background-color</tt> as a rgba color)
*** More things to ponder on?
* Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''

== Getting in touch ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (materthron ÄT users DOT sourceforge DOT com).

Documentation:Streaming HowTo/Streaming, Muxers and Codecs

2008-10-24T16:13:38Z

Materthron: /* VLC Media Player */ spelling

{{RightMenu|documentation streaming howto toc}}

==Introduction==

===Overview===

VideoLAN is a complete software solution for video streaming, developed by students of the [http://www.ecp.fr Ecole Centrale Paris] and developers from all over the world, under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License] (GPL). VideoLAN is designed to stream MPEG videos on high bandwidth networks.

The VideoLAN solution includes:
* VLS (VideoLAN Server), which can stream MPEG-1, MPEG-2 and MPEG-4 files, DVDs, digital satellite channels, digital terrestial television channels and live videos on the network in unicast or multicast
* VLC (initially VideoLAN Client), which can be used as a server to stream MPEG-1, MPEG-2 and MPEG-4 files, DVDs and live videos on the network in unicast or multicast ; or used as a client to receive, decode and display MPEG streams under multiple operating systems

Here is an illustration of the complete VideoLAN solution:

http://www.videolan.org/doc/streaming-howto/en/images/global-diagram.jpg Global VideoLAN solution

More details about the project can be found on the [http://www.videolan.org VideoLAN Web site].

===VideoLAN software===

====VLC Media Player====

VLC works on many platforms: Linux, Windows, Mac OS X, BeOS, *BSD, Solaris, Familiar Linux, Yopy/Linupy and QNX. It can read:
* MPEG-1, MPEG-2 and MPEG-4 / DivX files from a hard disk, a CD-ROM drive, ...
* DVDs and VCDs
* from a satellite card (DVB-S)
* from a camcorder (DV)
* MPEG-1, MPEG-2 and MPEG-4 streams from the network sent by VLS or VLC's stream output

VLC can also be used as a server to stream:
* MPEG-1, MPEG-2 and MPEG-4 / DivX files,
* DVDs,
* from an MPEG encoding card,
* from a camcorder DV,
to:
* one machine (i.e. to one IP address): this is called ''unicast'',
* a dynamic group of machines that the clients can join or leave (i.e. to a multicast IP address): this is called ''multicast'',
in IPv4 or IPv6.

To get the complete list of VLC's possibilities on each platform supported, see the [http://www.videolan.org/vlc/features.html VLC features page].

Note: VLC doesn't work on Mac OS 9, and will probably never do.

====Mini-SAP-server====

You can add a channel information service based on the SAP/SDP standard to the VideoLAN solution. The mini-SAP-server sends announces about the multicast programs on the network in IPv4 or IPv6, and VLCs receive these annouces and automatically add the programs announced to their playlist.

The mini-SAP-server works under Linux and Mac OS X.

==Muxers and codecs==

===What is a codec ?===

To fully understand the VideoLAN solution, you must understand the difference between a ''codec'' and a ''container format''.

A ''codec'' is a compression algorithm, used to reduce the size of a stream. There are audio codecs and video codecs. MPEG-1, MPEG-2, MPEG-4, Vorbis, DivX, ... are codecs.

===What is a container format ?===

To start off, think of a ''container format'' as a standard shipping box. You get a box in the mail and you think, "Cool! What's inside." You don't really care about the box itself, you care about what's in that box. The problem? You can't see into the box. So what do you do? You get a knife and cut it open.

A ''container format'' follows this same basic idea. It contains one or several streams already encoded by codecs. Very often, there is an audio stream and a video one. AVI, Ogg, MOV, ASF, MP4 ... are container formats. The streams contained can be encoded using different codecs. In a perfect world, you could put any codec in any container format. Unfortunately, there are some incompatibilities. You can find a matrix of possible codecs and container formats on the [http://www.videolan.org/streaming/features.html features page].

===Encoding a video===

This is the first step where you are going to create the shipping box.

First you need to encode your file. That means that a file, wheter it is an audio, video file, is compressed to another format that normally takes up less physical drive space than the previous format. Common video encoding methods are DivX, MPEG-1, MPEG-2, MPEG-4 ... most common audio encoding method is MP3 or ogg-vorbis.

Then you have to mux (or multiplex). This means basically a process where separate parts of the video (or streams) are joined together into one file.

===Playing a video===

Now that you have your box, you need to open it before to see the content. That's exactly what VLC will do. To decode a stream, VLC first ''demuxes'' it. This means that it reads the container format and separates audio, video, and subtitles, if any. Demuxing files doesn't weaken the video nor audio quality, it doesn't do anything for these data streams, it justs simply saves them into separate files, each containing one element of the original file. Then, each of these are passed ''decoders'' that do the mathematical processing to decompress the streams.

There is a particular thing about MPEG:
* MPEG is a codec. There are several versions of it, called MPEG-1, MPEG-2, MPEG-4, ...
* MPEG is also a container format, sometimes refered to as MPEG System. There are several types of MPEG: ES, PS, and TS.
When you play an MPEG video from a DVD, for instance, the MPEG stream is actually composed of several streams (called Elementary Streams, ES): there is one stream for video, one for audio, another for subtitles, and so on. These different streams are mixed together into a single Program Stream (PS). So, the .VOB files you can find in a DVD are actually MPEG-PS files. But this PS format is not adapted for streaming video through a network or by satellite, for instance. So, another format called Transport Stream (TS) was designed for streaming MPEG videos through such channels.

{{Documentation}}

User:Materthron

2008-10-11T09:54:47Z

Materthron:

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine. See [[Special:Contributions/Materthron|my contributions]] if you so please.

Find me also on the [http://wiki.services.openoffice.org/wiki/User:Materthron OpenOffice.org's Wiki].

'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
* Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for. '''[DONE!]'''
:''Nice, but Problem is that you can't export to one file without help from the admin.''

== Getting in touch ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

User:Materthron

2008-10-06T10:48:15Z

Materthron: + Pootle

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine. See [[Special:Contributions/Materthron|my contributions]] if you so please.

Find me also on the [http://wiki.services.openoffice.org/wiki/User:Materthron OpenOffice.org's Wiki].

'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].
* Get in touch with the polish translators what the heck [http://translate.sourceforge.net/wiki/decathlon/mainpage?redirect=1 Pootle] is good for.

== Getting in touch ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

User:Materthron

2008-10-06T10:35:31Z

Materthron: + Fullscreen Controller Improvements

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine. See [[Special:Contributions/Materthron|my contributions]] if you so please.

Find me also on the [http://wiki.services.openoffice.org/wiki/User:Materthron OpenOffice.org's Wiki].

'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''
* Style the fullscreen controller with [http://doc.trolltech.com/4.4/stylesheet.html Qt Style Sheet] to make it look more like [http://download.videolan.org/vlc/screenshots/0.8.6/VLC-mac-Fullscreen.jpg the one on OS X].

== Getting in touch ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

Documentation:Modules/rc

2008-07-20T13:12:53Z

Materthron: /* Command line options */ + how to get the list using vlc

== Introduction ==
The remote control interface (rc for short) is one of the three console interfaces provided by VLC. The other two being [[Documentation:Modules/ncurses|ncurses]] and [[Documentation:Modules/telnet|telnet]].

To force VLC into using this interface, do the following:

vlc -I rc

This interface is operated through textual commands typed into the invoking terminal window.

This is the default interface if no GUI environment is available.

== Command reference ==
Type <tt>help</tt> followed by enter for a terse list of commands or <tt>longhelp</tt> for the complete list.



== Command line options ==
There are several options you can use in conjunction with the rc interface:

{|
| '''Option'''
| '''Description'''
| '''Enabled by default'''
|-
| <tt>--rc-show-pos</tt>
| Show stream position
| No
|-
| <tt>--no-rc-show-pos</tt>
| Show the current position in seconds within the stream from time to time.
| No
|-
| <tt>--rc-fake-tty</tt>
| Fake TTY
| No
|-
| <tt>--no-rc-fake-tty</tt>
| Force the rc module to use stdin as if it was a TTY.
| No
|-
| <tt>--rc-unix=<string></tt>
| UNIX socket command input. Accept commands over a Unix socket rather than stdin.
| <nowiki>-</nowiki>
|-
| <tt>--rc-host=<string></tt>
| TCP command input. Accept commands over a socket rather than stdin. You can set the address and port the interface will bind to.
| <nowiki>-</nowiki>
|-
| <tt>--rc-quiet</tt>
| Do not open a DOS command box interface
|-
| <tt>--no-rc-quiet</tt>
| By default the rc interface plugin will start a DOS command box. Enabling the quiet mode will not bring this command box but can also be pretty annoying when you want to stop VLC and no video window is open.
| No
|}

To get this list run
vlc -p rc --advanced --help-verbose

== Miscellaneous ==
Starting with VLC 0.8.0 you can access this interface through a network with a telnet-client by using the <tt>--rc-host localhost:port</tt> option.

Documentation:Modules/ncurses

2008-07-20T13:07:20Z

Materthron: fixed typo

== Introduction ==
This is one of the three command line interfaces (besides [[Documentation:Modules/rc|remote control (rc)]] and [[Documentation:Modules/telnet|telnet]]).
To force vlc into using this interface, do the following:
vlc -I ncurses

This interface is operated through a set of shortcuts which are listed in the next section.

== Shortcuts ==
To get the following list of all available shortcuts in the interface press 'h'. Use the up and down arrow keys to scroll.

[Display]
h,H Show/Hide help box
i Show/Hide info box
L Show/Hide messages box
P Show/Hide playlist box
B Show/Hide filebrowser

[Global]
q, Q Quit
s Stop
<space> Pause/Play
f Toggle Fullscreen
n, p Next/Previous playlist item
[, ] Next/Previous title
<, > Next/Previous chapter
<right> Seek +1%
<left> Seek -1%
a Volume Up
z Volume Down

[Playlist]
r Random
l Loop Playlist
R Repeat item
o Order Playlist by title
O Reverse order Playlist by title
/ Look for an item
A Add an entry
D, <nowiki><del></nowiki> Delete an entry
<backspace> Delete an entry

[Filebrowser]
<enter> Add the selected file to the playlist
<space> Add the selected directory to the playlist
. Show/Hide hidden files

[Boxes]
<up>,<down> Navigate through the box line by line
<pgup>,<pgdown> Navigate through the box page by page

[Player]
<up>,<down> Seek +/-5%

[Miscellaneous]
Ctrl-l Refresh the screen

[[Category:Interfaces]]

Documentation:Modules/rc

2008-07-14T12:04:10Z

Materthron: created

== Introduction ==
The remote control interface (rc for short) is one of the three console interfaces provided by VLC. The other two being [[Documentation:Modules/ncurses|ncurses]] and [[Documentation:Modules/telnet|telnet]].

To force VLC into using this interface, do the following:

vlc -I rc

This interface is operated through textual commands typed into the invoking terminal window.

This is the default interface if no GUI environment is available.

== Command reference ==
Type <tt>help</tt> followed by enter for a terse list of commands or <tt>longhelp</tt> for the complete list.



== Command line options ==
There are several options you can use in conjunction with the rc interface:

{|
| '''Option'''
| '''Description'''
| '''Enabled by default'''
|-
| <tt>--rc-show-pos</tt>
| Show stream position
| No
|-
| <tt>--no-rc-show-pos</tt>
| Show the current position in seconds within the stream from time to time.
| No
|-
| <tt>--rc-fake-tty</tt>
| Fake TTY
| No
|-
| <tt>--no-rc-fake-tty</tt>
| Force the rc module to use stdin as if it was a TTY.
| No
|-
| <tt>--rc-unix=<string></tt>
| UNIX socket command input. Accept commands over a Unix socket rather than stdin.
| <nowiki>-</nowiki>
|-
| <tt>--rc-host=<string></tt>
| TCP command input. Accept commands over a socket rather than stdin. You can set the address and port the interface will bind to.
| <nowiki>-</nowiki>
|-
| <tt>--rc-quiet</tt>
| Do not open a DOS command box interface
|-
| <tt>--no-rc-quiet</tt>
| By default the rc interface plugin will start a DOS command box. Enabling the quiet mode will not bring this command box but can also be pretty annoying when you want to stop VLC and no video window is open.
| No
|}

== Miscellaneous ==
Starting with VLC 0.8.0 you can access this interface through a network with a telnet-client by using the <tt>--rc-host localhost:port</tt> option.

Qt Interface

2008-07-07T19:46:14Z

Materthron: + no wx anymore

== Introduction ==

Qt / Qt4 is the default, plain, graphical, [[interface]] to VLC, made using the [http://www.trolltech.org/qt Qt] library (Linux users may need to have this installed). It is used as the default interface on the [[Windows]] and [[Linux]] versions of {{VLC}} from version 0.9.0 and above.

Unless you change the [[preferences]], {{VLC}} will start up in the Qt4 interface, but you can force this by running
vlc '''-I qt'''
or
qvlc

If Qt4 is not avaliable, it will probably revert to using the [[Console|rc]] (console) interface, even if you force it. The most likely reason for this is if Qt4 hasn't been installed, or if it wasn't linked in (using the ./configure). See [[compiling VLC]] [http://developers.videolan.org/vlc/] for information on compiling.

Please note that the pre 0.9.0 wxWidgets interface is replaced by the Qt interface and will thus not be further developed.

== Using ==

=== Launching Modes ===

=== Video Modes ===

=== Other options ===

== Main interface Description ==

=== Menu Bar ===

=== Status Bar ===

The Status Bar has three distinctive portions displaying information.
* Name label
* Speed label
* Time label

Here are the actions you can do on the status bar:

{| class="wikitable" style="text-align:center"
!
! Select !! Left Click !! Right Click !! Middle Click !! Double Click
|-
! Name label
|| Prepare for copy || Give focus for arrows selection || Copy menu || - || Word selection
|-
! Speed label
|| - || - || Show fine rate speed adjusting || - || reset to normal 1.00x speed
|-
! Time label
|| - || Switch remaining/elasped time || Switch remaining/elasped time || Switch remaining/elasped time || Open the "Go To Time" dialog

|}

==== Time label ====
The timeLabel shows mm:ss/nn:tt in the statusBar.

If the time is longer that one hour, it shows hh:mm:ss/ii:nn:tt.

If you click on it, it shows remaining time instead of elapsed time.
If you double click on it, it opens the open the GOTOTime dialog in order to skip easily.

If vlc doesn't know the total time, like in avi/http, it shows the elapsed time only, and --:-- instead of total time.

=== System Tray Icon ===

=== Controller ===

==== Main Slider ====

The main slider does control the timeline.

When you click somewhere on the timeline, it skips the movie to that place.
When you drag the slider of the timeline, it follows the position on the movie.

When you hover it with your mouse, it shows you where it would go if you click.

==== Sound Slider ====

The sound slider does control the volume.

When you click somewhere on the soundSlider, it changes the volume.
When you click and drag on the soundSlider, it changes the volume too. If you release the click really outside of the volume slider, it will reset to your old value

When you hover it with your mouse, it shows you the volume it would be if you click it.

==== Sound range ====
The sound goes from 0% to 200% and can go up to 400%

100% means normal output of the file without amplification.
Above 100% means that it may use software amplification, and it could distort sound (it usually doesn't, but it could).

=== Video Widget ===

=== Background Widget ===

== Playlist ==

== Dialogs description ==

=== Open Dialog ===

=== Sout Dialog ===

=== Extended Dialog ===
The Extended settings dialog box can be brought up by selected the ''Ex'' button on the main window. Alternatively it can be found in ''Tools'' menu under ''Extended settings...'' (Ctrl+E). The extended settings allow effects to be enabled and adjusted in realtime whilst media is playing.
==== Audio Effects ====
===== Graphic Equalizer =====
The Graphic equalizer enables the equalization of the sound output to be enabled and adjusted. Tick the ''Enable'' tickbox to enable it. Ticking the ''2 pass'' will mean the sound is reprocessed through the equalizer again, thus amplifying the changes. Slide the sliders to adjust the output levels for the preamp and each frequency range. There are a number of presets which can be selected from the drop-down box.
===== Spatializer =====
The Spatializer contain several adjustable audio filters to change the perceived environment such as room size and humidity. Tick the ''Enable spatializer'' tickbox to enable and adjust the sliders.
==== Video Effects ====
===== Basic =====
===== Color fun =====
===== Some random name =====
===== Image modification =====
===== Find a name =====
===== Overlay =====
===== Advanced video filter controls =====
A colon separated list will be generated when filters and effects in the other video tabs are enabled. The list of effect can be modified. Press the ''Update'' button to apply the changes.

=== VLM Dialog ===

== Interface Hotkeys ==

[[QtHotkeys | Qt Interface Hotkeys]]

== Work ==
[[QtIntfTODO]]

[[Category:Interfaces]]

Documentation:Documentation

2008-07-07T18:57:43Z

Materthron: /* VLC for dummies: an introduction to VLC */ corr. spelling

__NOTOC__


{|style="width:100%;margin-top:0px;background-color:#fcfcfc;border:1px solid #ccc"
|style="width:56%;color:#000"|
{|style="width:280px;border:solid 0px;background:none"
|-
|style="width:280px;text-align:center;white-space:nowrap;color:#000" |
<div style="font-size:162%;border:none;margin: 0;padding:.1em;color:#000">Welcome to [[Documentation:Documentation|VideoLAN's Documentation]],</div>
<div style="top:+0.2em;font-size: 95%">The reference documentation on VideoLAN's projects.</div>
<div id="articlecount" style="width:100%;text-align:center;font-size:85%;">Articles under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License] only.</div>
|}
|style="width:11%;font-size:95%;color:#000" valign="top"|
*[[VideoLAN|VideoLAN]]
*[[VLC|VLC media player]]
*[[Documentation:Documentation|Documentation]]
|style="width:14%;font-size:95%" valign="top"|
*[http://www.videolan.org Main Site]
*[http://forum.videolan.org Forum]
*[http://planet.videolan.org News from developers]
|style="width:18%;font-size:95%" valign="top"|
*[http://www.videolan.org/developers/ Developer's website]
*[http://nightlies.videolan.org Latest builds]
*[http://trac.videolan.org Trac, Bugs, SVN and roadmap]
|}


''Pages in the "Documentation" namespace are part of the "Official" VLC media player documentation.''

''All pages in this namespace are licensed under the [http://www.gnu.org/copyleft/gpl.html GNU General Public License].''

'''Note: many parts of this documentation are currently outdated / obsolete. If you have good knowledge of a particular subject and feel that it could be documented better, please update the appropriate wiki page.'''

== [[Documentation:VLC for dummies| VLC for dummies: an introduction to VLC]] ==
This document will be an introduction to VLC from version 0.9.0 and above. '''UNDER CONSTRUCTION'''

== [[Documentation:Play HowTo|VLC Play HowTo]] ==

This document is the complete user guide for the VLC media player. '''OUTDATED'''

== [[Documentation:Streaming HowTo|VLC Streaming HowTo]] ==

This document explains how to stream, transcode and save streams using the VideoLAN solution. '''OUTDATED'''

== [[Documentation:Hacker's Guide|The Hacker's Guide to VLC]] ==

This document will detail the inner workings of VLC and its source code. '''UNDER CONTRUCTION'''

== [[Documentation:Modules|The VLC Modules Index]] ==

This document references most of the VLC modules and their options as well as some example uses. '''UNDER CONSTRUCTION (available content is up to date)'''

{{Documentation}}

User:Materthron

2008-07-07T10:27:45Z

Materthron:

My name is Philipp Weissenbacher, I'm a second semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine. See [[Special:Contributions/Materthron|my contributions]] if you so please.

Find me also on the [http://wiki.services.openoffice.org/wiki/User:Materthron OpenOffice.org's Wiki].

'''TODO'''
* <s>Think about applying for [[SoC 2008]]. [[SoC 2008#Fullscreen_Controller|Fullscreen Controller]] looks tasty!<s> Gone! Resort to wiki editing
* <s>Read ''C++ Primer''</s> Bad choice; read TC++PL instead
* Get and read ''C++ GUI Programming with Qt 4''

== Getting in contact ==
Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

Documentation:Modules/ncurses

2008-07-04T14:50:57Z

Materthron: created

== Introduction ==
This is one of the three command line interfaces (besides , [[Documentation:Modules/rc|remote control (rc)]] and [[Documentation:Modules/telnet|telnet]]).
To force vlc into using this interface, do the following:
vlc -I ncurses

This is interface is operated through a set of shortcuts which are listed in the next section.

== Shortcuts ==
To get the following list of all available shortcuts in the interface press 'h'. Use the up and down arrow keys to scroll.

[Display]
h,H Show/Hide help box
i Show/Hide info box
L Show/Hide messages box
P Show/Hide playlist box
B Show/Hide filebrowser

[Global]
q, Q Quit
s Stop
<space> Pause/Play
f Toggle Fullscreen
n, p Next/Previous playlist item
[, ] Next/Previous title
<, > Next/Previous chapter
<right> Seek +1%
<left> Seek -1%
a Volume Up
z Volume Down

[Playlist]
r Random
l Loop Playlist
R Repeat item
o Order Playlist by title
O Reverse order Playlist by title
/ Look for an item
A Add an entry
D, <nowiki><del></nowiki> Delete an entry
<backspace> Delete an entry

[Filebrowser]
<enter> Add the selected file to the playlist
<space> Add the selected directory to the playlist
. Show/Hide hidden files

[Boxes]
<up>,<down> Navigate through the box line by line
<pgup>,<pgdown> Navigate through the box page by page

[Player]
<up>,<down> Seek +/-5%

[Miscellaneous]
Ctrl-l Refresh the screen

[[Category:Interfaces]]

UnixCompile

2008-06-23T18:08:47Z

Materthron: spell-checking, polish and removed outdated link

==Prepare your environment==
VLC uses gcc, automake, autoconf and friends for compilation. Make sure they are up to date and usable for your system.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.

If your are using the release, download source code and extract the archive and go into your VLC directory.
cd /path/to/your/vlc/folder/

If you are using the [[Git]] version, start by bootstrapping your VLC.
cd /path/to/your/vlc/folder/
./bootstrap

== Get the 3rd party libs ==
Now you can start to configure VLC. Remember to first take a look at <tt>./configure --help</tt>. Take a good look at that enormous list of options.

=== General info ===
It is very important that you install and enable all the 3rd party libraries that you will be needing and let me tell you that that are a lot. If you don't install them you will end up with an application that well..... essentially doesn't do anything.
See [[Contrib_Status|here]] for a complete list.

There are some very important dependencies: gettext (nls) for international support (required), libdvbpsi for mpeg files and streams support, libmad for mp3 decoding, libmpeg2 for mpeg 1 and 2 video support, ffmpeg for support of mpeg4 and many other types of video, liba52 for dolby (AC3) sound, alsa for proper audio output, xvideo for proper video output, wxWidgets (wxGTK) for proper GUI support and libdvd* for DVD support.

'''Be careful!''' Some of the libraries are better not to be installed (at all, beware of old installations) and should be linked to directly. These are mostly ffmpeg and liveMedia.

There are also some libraries that are no longer being maintained and which we advise not to use. These include the gtk, gnome and kde GUIs, the glide and mga modules.

===Get'em===
There are a few ways to get those libs. You should use only one method at a time:

* Using your distribution or portage system, in order to get all the needed libs (this is the preferred way):
For example on Debian or Ubuntu:
# sudo apt-get build-dep vlc

* Using the contribs system in VLC's sources
% cd extras/contrib;
% ./bootstrap;
% make;

This should download and build a lot of those libs for you.

* Read the [[Contrib_Status|list]], download them and build by hand.

== Configuration ==

You need to tweak your configure line.

<tt>./configure</tt> is used to check whether your system is able to compile VLC.
Also you choose the functionalities of your build.
% ./configure --help
will show you the various options

===Special libs ===
Use <tt>--with-ffmpeg-tree=path/to/ffmpeg/source/tree</tt> and <tt>--with-livedotcom-path=path/to/livemedia/source/tree</tt> in connection with <tt>--enable-ffmpeg and --enable-livedotcom</tt>.
For ffmpeg it is also important to tell VLC if you compiled ffmpeg with faac and/or lame support. Use the <tt>--with-ffmpeg-faac</tt> and <tt>--with-ffmpeg-mp3lame</tt> configure flags.

=== Final configuration ===
If you want to install VLC into another directory, run
% ./configure --prefix=/path/to/install/folder/

This is an example of a typical VLC configure line:
% ./configure --enable-x11 --enable-xvideo --disable-gtk --enable-sdl --enable-ffmpeg --with-ffmpeg-mp3lame --enable-mad --enable-libdvbpsi --enable-a52 --enable-libmpeg2 --enable-dvdnav --enable-faad --enable-vorbis --enable-ogg --enable-theora --enable-faac --enable-mkv --enable-freetype --enable-fribidi --enable-speex --enable-flac --enable-live555 --with-live555-tree=/usr/lib/live --enable-caca --enable-skins --enable-skins2 --enable-alsa --disable-kde --enable-qt --enable-wxwindows --enable-ncurses --enable-release

[[User:J-b#VLC_configure_line|Here]] is another.

== Compilation ==
Compile VLC:
% make

As root (type "su" to change to root account):
# make install

To remove files created during the compile (optional) type:
% make clean

== Notes ==
=== Cygwin ===
Compiling on [[Win32CompileCygwin|Cygwin]] may be broken from time to time.

=== Debian ===
Debian users who want to compile VLC should install the packages below.
Note: If you just want to ''use'' VLC media player then simply install the package vlc (<tt>sudo apt-get install vlc</tt>) - the unstable version is normally very up-to-date (and stable is, er, stable ;-)
* [http://packages.debian.org/unstable/libdevel/libavcodec-dev libavcodec-dev]
* [http://packages.debian.org/unstable/libdevel/libpostproc-dev libpostproc-dev]
* [http://packages.debian.org/unstable/libdevel/libmpeg2-4-dev libmpeg2-4-dev]

== Version ==
This HOWTO has been originally written by [mailto:hartman_at_videolan_dot_org Derk-Jan Hartman].

It has been modified and updated by [[User:J-b| Jean-Baptiste Kempf]].

It was spelled-checked and sudoed by [[User:materthron|materthron]].

[[Category:Building]]

User:Materthron

2008-03-25T11:18:09Z

Materthron:

SoC 2008

2008-03-15T20:17:10Z

Materthron: /* Assembly optimizations in VLC */ spelling

Google Summer of Code 2008.

''VideoLAN tries to be a mentoring organization'' for VLC and x264.

== 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]].

=== 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 ==

=== 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.

''Proposed mentor: [[User:J-b|jb]]'' (backup atmo)

=== 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...

''Proposed mentor: funman'' (backup jb)

=== QuickTimeVR Playing ===
This project deals with integration QuickTimeVR inside VLC using work from FreePV (SoC 2007).

This project will require some modification on image handling inside VLC, before starting.

''Proposed mentor: dionoea'' (backup Yuval Levy)

=== UPnP media service ===
This project involves adding support for advertizing the stream on the LAN using Universal Plug'n'Play A/V / DLNA.

''Proposed mentor: funman''

== Other Ideas SoC 2008 ==

=== 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)

=== 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.''

=== 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''

=== 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''

=== 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''

=== Mini Projects - More ideas ===

We have a more general page for ideas for Project in {{VLC}}, that could give you ideas: [[Mini_Projects]].

== 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

=== Administrators ===
* jb
* xtophe

[[Category:Activities]]

OldFAQ

2008-03-15T20:02:17Z

Materthron: /* WMV files */ spelling

{{stub}}
Answers to some common problems people encounter with VLC. More help is available in the
* [http://www.videolan.org/doc/ Documentation]
* [http://www.videolan.org/doc/faq/en/videolan-faq-en.html FAQ]
* [[Forum]]

== Installing VLC ==

=== On Mac OS 9 ===

{{faqlink|239006}}
* Sorry, VLC will not work on OS 9, and probably never will. However, Mac OS X is supported - [[Unsupported|Find out Why]]

=== Compiling VLC ===

==== How do I compile VLC? ====

* Look at [http://developers.videolan.org/vlc/ how to compile VLC]. There are pre-compiled (binary / executable) versions [http://www.videolan.org/vlc/ here].

==== Mozilla Firefox Plugin ====

* ''Debian:'' All you need is to download the vlc plugin package - mozilla-plugin-vlc ([http://packages.debian.org/stable/graphics/mozilla-plugin-vlc stable release])
* ''All Linux:'' To make the firefox plugin with the vlc player, you will first need the Firefox Development package (from: [http://packages.ubuntu.com/breezy/devel/firefox-dev ubuntu] ...). Then, when you compile, run ./configure with --enable-mozilla, and if needed with --with-mozilla-sdk-path=''/path_to_firefox_sdk''

==== "Missing header file ffmpeg/avcodec.h" and "Missing header file postproc/postprocess.h" Errors ====

* Make sure that you have all the libraries you need.
** '''on ubuntu''': "apt-get install libavcodec-dev libpostproc-dev" will install the needed files (worked on edgy).
* When you run ./configure for [[ffmpeg]], make sure that at least the following flags are set (descriptions of these avaliable from ./configure --help )
./configure --enable-shared --enable-shared-pp --enable-pp --enable-gpl
* The path of ffmpeg is not set. Check if you can locate the file '''libavcodec.pc''' on your computer, and export PKG_CONFIG_PATH to where you found it before running ./configure. For example
export PKG_CONFIG_PATH=/home/you/ffmpeg/

==== "cc1: error: invalid option `tune=opteron'" Error on 64-bit systems ====

* One user writes: "From what I can see, the -mtune flag is not available for this type of processor in man gcc. I had to change the configure options comment out all the lines where they set mcpu or mtune flags.) I don't know if this is the correct way to proceed but was the only way for me to get results fast."

==== "/usr/bin/ld: cannot find -lX11" Error on 64-bit systems ====

* In configure, there is an x_libraries variable there that is set to "/usr/X11R6/lib" (around line 16371). Because it is a 64 bit system, this variable needs to be /usr/X11R6/lib64. After changing that, it should continue compiling.

==== "syntax error before "pthread_spinlock_t"" on debian-Etch or CentOS ====

* If you have errors about ''pthread_spin*'' in the file ''vlc_threads_funcs.h'', try this fix :
su
sed -e 's/define\s*_POSIX_SPIN_LOCKS\s*/define _POSIX_SPIN_LOCKS -1 \/\/ wrong: /g' -i /usr/include/bits/posix_opt.h
exit
source : [http://forum.videolan.org/viewtopic.php?f=13&t=43930#p139570 this post] from Rémi Denis-Courmont.

=== Installing Skins ===

* Although all information is given on the [http://www.videolan.org/vlc/skins.php VLC Download skin site], you may miss the note to change preferences to ''skinnable interface''. There is an [http://forum.videolan.org/viewtopic.php?p=85603#p85603 article on the forum] which describes the how-to. In short: there is a drop-down option (interface module) in the settings dialog (Interface → General) which defaults to ''Standard''. Change this and restart.

== Problems Starting VLC ==

=== VLC does not launch on my Mac anymore. What to do? ===

* Please have a look at the [[FAQ_on_MacOSX_only_issues|specific FAQ]], which covers multiple solutions to this issue.

== Error Messages ==

Error messages can be viewed by selecting Messages from the View menu.

=== main private error: no sout mux module matched "ts" ===

* This can be an error if '''libdvbpsi''' was not installed when vlc was compiled. To fix this error, install libdvbpsi; then re-compile vlc. [http://developers.videolan.org/libdvbpsi/ libdvbpsi]

=== main dialogs provider error: no dialogs provider module matched "any" ===

* The solution is found in [http://forum.videolan.org/viewtopic.php?t=14733 the forum]

== Problems playing types of files ==

=== WMV files ===

* Starting with VLC media player 0.8.6, the playback of WMV3-encoded videos is available on all platforms. Please note, that encrypted / DRM-protected video-clips still cannot be played. That is due to the nature of DRM and is not about to change, so please do not ask.

=== Real Media files ===

* Realmedia files (.rm, .rpm, etc) are proprietary (ie, copyrighted) file formats, created by RealNetworks. Because of this, VLC can't support them at present.

=== QuickTime Files (.mov) ===

* Mov file doesn't play, but plays ok in QuickTime
** open the url in QuickTime player
** let it decide which datarate is best for your connection
** let it play for a few seconds, then pause it
** open the stream info, copy the url
** open & save that one in VLC

=== Flash Video Files (.flv) ===

* Flash Video support has recently been added (provided through ffmpeg) - to view .flv files you will need version 0.8.4a. Download and install the latest version [http://www.videolan.org/vlc/ here].
* VLC still has problems with a few .flv files. If you have problems playing a file in VLC you might be able to change it to an avi using [[ffmpeg]]. See [[Fixing .flv to .avi with Ffmpeg]].
* VLC 0.8.6 provided enhanced Flash Video support on all platforms, so it is probably worth to update if you experience problems with prior releases.

=== Other Files ===

{{faqlink|238663}}
* Make sure that VLC supports that file - look at the [http://www.videolan.org/vlc/features.html list of supposted formats]

* Make sure that the file isn't corrupted

== VLC and Other Programs ==

=== AMR ===

* To use [http://en.wikipedia.org/wiki/Adaptive_Multi-Rate AMR], you'll need to compile vlc and ffmpeg with amr support yourself. This is because the amr license is not compatible with the vlc license.

=== ratDVD ===

* VLC does not support [http://en.wikipedia.org/wiki/RatDVD ratDVD] and is not going to be, both for political and technical reasons.

== Problems Playing DVDs ==

===Unable to play any DVDs===

{{faqlink|239006}}
* ''Linux:'' To play DVDs with VLC in linux, you need to install the libdvdcss package
* ''Linux:'' Make sure you have access rigths to your DVD player. In linux, you can use chmod to edit access rights to your DVD block device:
** <nowiki>#</nowiki> chmod 666 /dev/dvd
** The videolan FAQ seems to suggest you need write access to this device - is this true? If you know, please edit this entry.
* ''Linux:'' Make sure VLC knows where your DVD drive is located (/dev/dvd usually). Go to Settings | Preferences | Input/Codecs | General and under "Default devices" make sure your dvd drive path is entered in the "Default DVD" box. When you go to open a DVD, you should see something like "dvd:///dev/dvd" as the [[media resource locator]] in the "Open:" box near the top of the Open dialog.

=== Playing DVDs from other Region Codes ===

{{faqlink|239426}}
* The ability to play DVDs from all regions depends mostly on your DVD drive, and testing it is usually the quickest way to find out if your DVD drive can do it. Most newer DVD drives are RPC2 drives, which don't allow raw access to the drive untill the drive firmware has done a regioncheck. VLC uses libdvdcss and it needs raw access to the DVD drive to crack the encryption key. So with these drives it is impossible to circumvent the region protection. (This goes for all software. You will need to flash your drives firmware, but sometimes there is no alternate firmware available for your drive). On other RPC2 drives that DO allow raw access, it might take VLC a long time to crack the key. So just pop the disc in your drive and try it out, while you get a coffee. RPC1 drives should 'always' work regardless of the regioncode.

== Poor Quality Video and Audio ==

=== The video runs but the picture is distorted ===

{{faqlink|238431}}
* ''Linux:'' There is probably a problem with the output layer. There are several ways of troubleshooting it.
** First, try with another output plugin, for instance:
**: % vlc -V sdl
**: % vlc -V x11
** Second, change your screen depth and/or definition. It quite often helps.
** Lastly, if running Unix, have a look at your XFree86 video driver.

=== Video is choppy ===

{{faqlink|238474}}
* Your system may be too slow to decode all pictures. Sometimes, your CPU (computer) really isn't fast enough, but often the situation can be improved by changing your system configuration to be a bit kinder to VLC.
** Quit other programs running in the background
** Turn on DMA on your DVD device:
*** ''Linux:''
***: <nowiki>#</nowiki> hdparm -d1 /dev/dvd
*** ''Windows:'' go to the System section of the control panel, and go to the Hardware manager (it is sometimes in a separate tab, and sometimes, you have to go to the Advanced tab. Then, right-click on your DVD player, and check the DMA checkbox.
** Upgrade to the latest driver for your video board.
** ''Linux:'' you can additionally upgrade your drivers to the latest XFree86 version. If supported, check that the xvideo plug-in is effectively used with:
**: % vlc -vvvv

=== Audio and video are out of sync ===

{{faqlink|238571}}
* If you are [[transcoding]] a file, use the [[audio-sync]] option.
* You can manually set the audio offset while playing (so you can put the audio back in sync). The default keys to increase/decrease the offset are Ctrl+K and Ctrl+L in Windows, and f and g in Mac.
* ''Linux/Unix:'' Try using another audio output plugin and, under Unix, kill esd or artsd if they are running. If the problem is due to the input file, have a look at the "Audio desynchronization compensation" option.

== Problems with Streaming ==

==="main input error: no suitable access module for `rtsp://...'"===

vlc needs livemedia from '''live555.com''' to read rtsp stream this way.

You can check you have it by :

vlc -l | grep live

It should read

livedotcom live.com (RTSP/RTP/SDP) demuxer
livedotcom RTSP/RTP access and demux

If not, you have to install '''livemedia''' and point your compilation to this lib directory :

./configure '''--enable-livedotcom --with-livedotcom-tree=/usr/local/lib/live/'''

===Streaming playlist continuously between files (sout-keep not working)===

you should add gather-module sout-chain, example
vlc *mpeg --sout-keep --sout '#gather:transcode{plapla}:rtp{plapla}'

===Streaming 1 playlist item continuously and change input without stream break===

you can use this kinda vlm.conf file and --sout-keep option
new output1 broadcast enabled loop
setup output1 input "inputfile1.mpeg"
setup output1 input "inputfile2.mpeg"
setup output1 input "/path/to/inputfile3.mpeg"
setup output1 option sout-keep=1
setup output1 option input-repeat=-1
setup output1 output #gather:transcode{etc...}:std{plapal}

control output1 play 2

you then chan telnet into vlm and just command
control output1 play <playlistnumber>
to change streamed input.

===Streaming to Windows Media Player===

See [[Windows Media Player]] for details.

== Problems converting between file formats (transcoding) ==

=== Missing Audio and/or Video ===

* Certain containers (aka muxers) can only hold certain types of video and audio - look at [http://www.videolan.org/streaming/features.html Streaming features]

== Streaming/Transcoding Wizard ==

=== Transcode / Save to file ===

* Partial Extract "From" "To" does not work, allone "To" don´t too.

== VLC Crashes ==

=== General ===

{{faqlink|238592}}
* If VLC crashes, the following steps will help determine the cause.
** Increase the verbosity level (either in the preferences or with a -vvvv command line option) and look at the debug messages (in the terminal or in the Messages window).
* If you are convinced that it is a bug in VLC, have a look at the [http://www.videolan.org/support/bug-reporting.html bug reporting page].

=== When using DirectShow (eg Webcam) ===

{{forum|12394}}
* There was a bug a while back when you tried to stream using a directshow/webcam it would reboot the computer. The fix was to specify the resolution on the command line or in the "Advanced" section when opening the directshow.

== Other Problems ==

=== I only want one VLC player! ===

* To use the same VLC player for all the media files, go to Settings, Preferences, Advanced. The following options should give behavior similar to WMP: minimize # of threads, allow only one running instance, VLC is started from file association, allow only "on" running instance when started from file (typo in v0.8.5).

=== Licensing, legal issues and logo use ===

* Information on this is avaliable on the main videolan website, [http://videolan.org videolan.org]. Also read the [http://www.videolan.org/doc/faq/en/index.html#id238663 Legal concerns] section of the [http://www.videolan.org/doc/faq/en/index.html FAQ].
* This is a wiki site: it is editable by all, so it is best to check to official website.

=== Fixing Strange Behaviour ===

{{faqlink|238992}}
* The first thing to do is to reset the VLC preferences in the preferences dialog of the application and restart VLC. If VLC doesn't even start anymore, delete VLC's configuration file ([[#Configuration File|where is it?]]). Then restart VLC. If it does not get any better, read the rest of this page or FAQ page, or ask for help at the [[forum]].

=== Subtitles Problem ===

* In the File | Open File dialog, select "Use a subtitles file", and enter both the video's filename and the video's subtitle filename.
* If you are having displaying the subtitles, the problem might be an encoding problem. Choose the right encoding for your language and it should fix your problem. You'll find the ISOs here: [http://alis.isoc.org/codage/iso8859/jeuxiso.en.htm]. Once you find a text encoding method that works well for you enter it in Preferences, Input / Codecs, Other codecs, Subtitles then press Save and restart VLC. If you have a specialized language like Hebrew, Arabic, Chinese or Japanese changing the font to a Unicode font will be helpful. For Polish subtitles choose CP 1250 ISO code.

=== No Sound on DirectShow Capture ===

* As odd as it sounds, try setting the sound device to 'none'. See also [http://forum.videolan.org/viewtopic.php?t=2859].

=== VLC hangs when opening Matroska (mkv) files ===

* This might occur when using VLC to view an mkv file in a directory that has a large number of mkv files. (eg. in an Azureus download directory)
VLC will attempt to preload all the mkv files in the directory and will hang, especially if some mkv files are not fully downloaded yet (thus seem to be broken).
* The solution is to set the mkv option: --mkv-preload-local-dir to false
Preferences -> Input / Codecs -> Demuxers -> Matroska -> Preload Directory (uncheck the checkbox)
(See also http://wiki.videolan.org/Matroska)

Code Conventions

2008-03-13T13:20:46Z

Materthron: /* Qt interface added conventions */ no trunk anymore

== Code conventions ==
Here you find conventions about how the {{VLC}} developers write their code.

=== Function naming ===

All functions are named accordingly: ''module name'' (in lower case) + _ + ''function name'' (in mixed case, without underscores). For instance: <tt>intf_FooFunction</tt>. Static functions don't need the module name.

=== Variable naming ===

We use Hungarian notation. That is, we have the following prefixes:

*<tt>i_</tt> for integers (sometimes <tt>l_</tt> for long integers)
*<tt>b_</tt> for booleans
*<tt>d_</tt> for doubles
*<tt>f_</tt> for floats
*Generally, we add a <tt>p</tt> when the variable is a pointer to a type
**<tt>pf_</tt> for function pointers
**<tt>psz_</tt> for a pointer to a string terminated by a zero (C-string)

If a variable has no basic type (for instance a complex structure), don't put any prefix (except <tt>p_</tt> if it's a pointer). After one prefix, put an explicit variable name in lower case. If several words are required, join them with an underscore (no mixed case).

Examples:

*<tt>data_packet_t * p_buffer</tt>
*<tt>char psz_msg_date[42]</tt>
*<tt>int pi_es_refcount[MAX_ES];</tt>
*<tt>void (* pf_next_data_packet)( int * )</tt>

=== Macro usage ===

Static inline is preferred over macros, for example:

<code>
static inline void change_val(int * var, int val)
{
*var = val;
}
</code>
is preferred to
<code>
#define CHANGE_VAL(var_name, val) var_name = val;
</code>

=== A few words about white space ===
==== Indentation ====

'''Never''' use tabs in the source (nevertheless you're entitled to use them in the Makefile :-).

Use <tt>set expandtab</tt> under vim or the equivalent under emacs.

Indents are 4 spaces long.

==== Spaces ====

Put spaces before and after operators, and inside brackets. For instance:

<code>
for( i = 0; i < 12; i++, j += 42 );
</code>

==== Braces ====

Leave braces alone on their lines (GNU style). For instance:

<code>
if( i_es == 42 )
{
p_buffer[0] = 0x12;
}
</code>

=== Comments ===

ANSI C-style comments /* ... */ are more commonly used for historical reasons, though C++/C99 comments are tolerated, but please don't mix both in the same file.

== Qt interface added conventions ==
'''''See [http://trac.videolan.org/vlc/browser/modules/gui/qt4/HACKING HACKING]'''''

[[Category:Coding]]

User:Materthron

2008-03-04T18:57:03Z

Materthron: + oo.o

Hi! My name is Philipp Weissenbacher and I'm a first semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine.

Find me also on the [http://wiki.services.openoffice.org/wiki/User:Materthron OpenOffice.org Wiki]

Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

Getting Started At Coding

2008-02-25T20:21:54Z

Materthron: /* Code */ lnk to HACKING, mentioned Report bugs

== VLC Devel ==

VLC media player is a very fast changing and ever evolving project.

It is very important to keep up to date with the latest developments. Therefore we advise everyone who makes changes to the VLC sourcecode, to sign up with the [http://www.videolan.org/support/lists.html | vlc-devel mailing-list] so you can keep up with the latest changes and developments.

Please try to keep to our [[Code_Conventions|code conventions]]. They are very simple and help to keep all code readable. When you write new stuff, especially core stuff (in the "src" or "include" folders), please comment it heavily or add doxygen documentation for your sources.

== Code ==

Start by building VLC and use [[Subversion]] to get the full source code.

Before you start be sure to read the '''[http://trac.videolan.org/vlc/browser/trunk/HACKING HACKING]''' file in the main VLC source directory.

Before sending a patch be sure to read [[Sending Patch]]. To correctly report a bug see [[Report bugs]].

[[Category:Coding]]

Code Conventions

2008-02-25T19:28:47Z

Materthron: /* Qt interface added conventions */ just refer to HACKING

== Code conventions ==
Here you find conventions about how the {{VLC}} developers write their code.

=== Function naming ===

All functions are named accordingly: ''module name'' (in lower case) + _ + ''function name'' (in mixed case, without underscores). For instance: <tt>intf_FooFunction</tt>. Static functions don't need the module name.

=== Variable naming ===

We use Hungarian notation. That is, we have the following prefixes:

*<tt>i_</tt> for integers (sometimes <tt>l_</tt> for long integers)
*<tt>b_</tt> for booleans
*<tt>d_</tt> for doubles
*<tt>f_</tt> for floats
*Generally, we add a <tt>p</tt> when the variable is a pointer to a type
**<tt>pf_</tt> for function pointers
**<tt>psz_</tt> for a pointer to a string terminated by a zero (C-string)

If a variable has no basic type (for instance a complex structure), don't put any prefix (except <tt>p_</tt> if it's a pointer). After one prefix, put an explicit variable name in lower case. If several words are required, join them with an underscore (no mixed case).

Examples:

*<tt>data_packet_t * p_buffer</tt>
*<tt>char psz_msg_date[42]</tt>
*<tt>int pi_es_refcount[MAX_ES];</tt>
*<tt>void (* pf_next_data_packet)( int * )</tt>

=== Macro usage ===

Static inline is preferred over macros, for example:

<code>
static inline void change_val(int * var, int val)
{
*var = val;
}
</code>
is preferred to
<code>
#define CHANGE_VAL(var_name, val) var_name = val;
</code>

=== A few words about white space ===
==== Indentation ====

'''Never''' use tabs in the source (nevertheless you're entitled to use them in the Makefile :-).

Use <tt>set expandtab</tt> under vim or the equivalent under emacs.

Indents are 4 spaces long.

==== Spaces ====

Put spaces before and after operators, and inside brackets. For instance:

<code>
for( i = 0; i < 12; i++, j += 42 );
</code>

==== Braces ====

Leave braces alone on their lines (GNU style). For instance:

<code>
if( i_es == 42 )
{
p_buffer[0] = 0x12;
}
</code>

=== Comments ===

ANSI C-style comments /* ... */ are more commonly used for historical reasons, though C++/C99 comments are tolerated, but please don't mix both in the same file.

== Qt interface added conventions ==
'''''See [http://trac.videolan.org/vlc/browser/trunk/modules/gui/qt4/HACKING HACKING]'''''

[[Category:Coding]]

Talk:VLC Developers Corner

2008-02-22T17:46:28Z

Materthron: New section: Broken link

== Strategy for main page ==
The main page is very busy. Intimidating for the early contributor. I suggest having a newbie page as an early link or making the main page less busy. For example you can get rid of or move done the talk about deprecated projects.
Also the page is very similar to the main wiki intro page. One might get confused which one they are on.
[[User:Daniel.Cardenas|Daniel.Cardenas]] 00:59, 22 April 2007 (CEST)

== Streaming Profiles ==

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. This section will document the design as it progresses.

The various steps in the process will be:
- Identification of the feature set
- Transforming the features into requirements
- Developing the Analysis Model
- Developing the Design Model

The Feature-based Object-Orieted Methodology (FOOM) [http://www.tierney.ca/patrick/thesis/FOOM_Thesis_PTierney.pdf], an extension of the Unified Software Process will be followed.

== Broken link ==

Hi!
The link "Translation information and stats" in the Code VLC box is broken.

Best Regards,
--[[User:Materthron|materthron]] 18:46, 22 February 2008 (CET)

Code Conventions

2008-02-20T21:22:10Z

Materthron: minor improvements

== Code conventions ==
Here you find conventions about how the {{VLC}} developers write their code.

=== Function naming ===

All functions are named accordingly: ''module name'' (in lower case) + _ + ''function name'' (in mixed case, without underscores). For instance: <tt>intf_FooFunction</tt>. Static functions don't need the module name.

=== Variable naming ===

We use Hungarian notation. That is, we have the following prefixes:

*<tt>i_</tt> for integers (sometimes <tt>l_</tt> for long integers)
*<tt>b_</tt> for booleans
*<tt>d_</tt> for doubles
*<tt>f_</tt> for floats
*Generally, we add a <tt>p</tt> when the variable is a pointer to a type
**<tt>pf_</tt> for function pointers
**<tt>psz_</tt> for a pointer to a string terminated by a zero (C-string)

If a variable has no basic type (for instance a complex structure), don't put any prefix (except <tt>p_</tt> if it's a pointer). After one prefix, put an explicit variable name in lower case. If several words are required, join them with an underscore (no mixed case).

Examples:

*<tt>data_packet_t * p_buffer</tt>
*<tt>char psz_msg_date[42]</tt>
*<tt>int pi_es_refcount[MAX_ES];</tt>
*<tt>void (* pf_next_data_packet)( int * )</tt>

=== Macro usage ===

Static inline is preferred over macros, for example:

<code>
static inline void change_val(int * var, int val)
{
*var = val;
}
</code>
is preferred to
<code>
#define CHANGE_VAL(var_name, val) var_name = val;
</code>

=== A few words about white space ===
==== Indentation ====

'''Never''' use tabs in the source (nevertheless you're entitled to use them in the Makefile :-).

Use <tt>set expandtab</tt> under vim or the equivalent under emacs.

Indents are 4 spaces long.

==== Spaces ====

Put spaces before and after operators, and inside brackets. For instance:

<code>
for( i = 0; i < 12; i++, j += 42 );
</code>

==== Braces ====

Leave braces alone on their lines (GNU style). For instance:

<code>
if( i_es == 42 )
{
p_buffer[0] = 0x12;
}
</code>

=== Comments ===

ANSI C-style comments /* ... */ are more commonly used for historical reasons, though C++/C99 comments are tolerated, but please don't mix both in the same file.

== Qt interface added conventions ==

=== Switch statements ===

Case labels are on the same column as the <tt>switch</tt> keyword.

Example:
<code>
switch( p_item->i_type )
{
case blabla:
break;
default:
break;
}
</code>

[[Category:Coding]]

Contrib Status

2008-02-16T14:23:18Z

Materthron: better English, reference to building VLC

This page lists the libraries needed to have a fully featured {{VLC}}. <br />
The additional information in the table refers to the VLC contrib build system (located in extras/contrib). These versions are against the trunk version.

For information on how to compile {{VLC}} on your platform see the [[Developers_Corner|Build VLC media player]] box on the Developer Corner's page.

=== Codecs ===

{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Where ? !! Comment
|-
! libvorbis
|| 1.2.0 || 1.2.0 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.xiph.org/downloads/ Xiph.org] ||
|-
! libogg
|| 1.1.3 || 1.1.3 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || [http://www.xiph.org/downloads/ Xiph.org]||
|-
! libtheora
|| 1.0beta2 || 1.0beta2 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.xiph.org/downloads/ Xiph.org] ||
|-
! speex
|| 1.2beta2 || 1.2beta3 || {{untested}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.speex.org/downloads/ Speex.org]||
|-
! flac
|| 1.2.1 || 1.2.1 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://flac.sourceforge.net/ flac.sf] ||
|-
! x264
|| svn || svn || {{up-to-date}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} ||{{unNeeded}} || SVN ||
|-
! a52
|| 0.7.4 || 0.7.4 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} ||{{unNeeded}} || [http://liba52.sf.net liba52.sf] || Not likely to be updated
|-
! MPEG2DEC
|| 0.4.1 || 0.4.1 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} ||{{unNeeded}} || [http://libmpeg2.sf.net libmpeg2.sf] || Not likely to be updated
|-
! faad2
|| 2.6.1 || 2.6.1 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || [http://www.audiocoding.com/faad2.html audiocoding] ||
|-
! faac
|| 1.26 || 1.26 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.audiocoding.com/faac.html audiocoding] ||
|-
! lame
|| 3.97 || 3.97 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://sourceforge.net/project/showfiles.php?group_id=290&package_id=309 sf.net] ||Not likely to be updated
|-
! FFmpeg
|| SVN || SVN || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || SVN ||
|-
! libmad
|| 0.15.1b || 0.15.1b || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://sourceforge.net/project/showfiles.php?group_id=12349&package_id=86999 SF] ||
|-
! dirac
|| 0.9.0 || 0.9.0 || {{up-to-date}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://dirac.sf.net dirac.sf] ||
|-
! libdca
|| SVN || SVN || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || SVN ||
|-
! twolame
|| 0.3.12 || 0.3.12 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.twolame.org/ twolame.org] ||
|-
! libmpcdec
|| 1.2.6 || 1.2.6 || {{Up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.musepack.net/index.php?pg=src musepack] ||
|-
! Tremor
|| SVN || SVN || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || SVN ||
|-
|}

=== Muxers ===
{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Where !! Comment
|-
! libebml
|| 0.7.7 || 0.7.7 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.matroska.org/downloads/linux.html matroska.org] ||
|-
! libmatroska
|| 0.8.1 || 0.8.1 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.matroska.org/downloads/linux.html matroska.org] ||
|-
! libdvbpsi
|| 0.1.6 || 0.1.6 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || [http://www.videolan.org/developers/libdvbpsi.html libdvbpsi] ||
|-
|}

=== Access ===

{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Where ? !! Comment
|-
! shout
|| 2.2.2 || 2.2.2 || {{up-to-date}} || {{Needed}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://downloads.us.xiph.org/releases/libshout/ xiph.org] ||
|-
! libdvdcss
|| 1.2.9 || 1.2.9 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://download.videolan.org/pub/libdvdcss/?C=N;O=D libdvdcss on v.o] ||
|-
! libdvdnav
|| CVS || CVS || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://dvd.sourceforge.net/] ||
|-
! livedotcom
|| latest trunk || latest trunk || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.live555.com/mediaServer/#downloading live555]||
|-
! libcddb
|| 1.3.0 || 1.3.0 || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://libcddb.sourceforge.net/download.html libcddb.sf.net] ||
|-
! libcdio
|| 0.79 || 0.79 || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://ftp.gnu.org/gnu/libcdio/?M=D gnu.org] ||
|-
! VCDimager
|| 0.7.23 || 0.7.23 || {{Up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://www.vcdimager.org/pub/vcdimager/vcdimager-0.7/ vcdimager] ||
|-
! libgpg-error
|| 1.6 || 1.6 || {{Up-to-date}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://ftp.gnupg.org/gcrypt/libgpg-error/ gnupg.org] ||
|-
! libgcrypt
|| 1.2.3 || 1.4.0 || {{untested}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [ftp://ftp.gnupg.org/gcrypt/libgcrypt/ gnupg.org] || Does not seem to compile on MingW32
|-
! gnuTLS
|| 1.6.3 || 2.2.1 || {{untested}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.gnu.org/software/gnutls/news.html gnu.org] ||
|-
! Opendaap
|| 0.4.0 || 0.4.0 || {{Up-to-date}}||{{unNeeded}} ||{{unNeeded}} ||{{Needed}} ||{{unNeeded}} || {{unNeeded}} || ||
|-
! libxml2
|| 2.6.31 || 2.6.31 || {{Up-to-date}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || [ftp://xmlsoft.org/libxml2/ xmlsoft ftp] ||
|-
|}

=== Images ===
{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Where !! Comment
|-
! libpng
|| 1.2.23 || 1.2.24 || {{untested}} ||{{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.libpng.org/pub/png/libpng.html libpng.org]
|-
! libjpeg
|| 6b || 6b || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://www.ijg.org/files/ ijg.org] || Rare updates
|-
! libtiff
|| 3.8.2 || 3.8.2 || {{up-to-date}} ||{{Needed}} || {{unNeeded}}|| {{Needed}}|| {{unNeeded}}|| {{unNeeded}}|| [ftp://ftp.remotesensing.org/pub/libtiff/ Main libtiff ftp] || Rare updates
|-
! SDL
|| 1.2.13 || 1.2.13 || {{up-to-date}} || {{Needed}} || {{unNeeded}}|| {{Needed}}|| {{unNeeded}}|| {{unNeeded}}|| [http://www.libsdl.org/download-1.2.php libdsl.org] ||
|-
! SDL_image
|| 1.2.6 || 1.2.6 || {{up-to-date}} || {{Needed}} || {{unNeeded}}|| {{Needed}}|| {{unNeeded}}|| {{unNeeded}}|| [http://www.libsdl.org/projects/SDL_image/ libdsl.org] ||
|-
|}

=== Tools ===
{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Where ! || Comment
|-
! Autoconf
| 2.61 || 2.61 || {{up-to-date}} || {{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://ftp.gnu.org/gnu/autoconf/?M=D Gnu(slow)] ||
|-
! automake
| 1.9.6 || 1.10.1 || {{untested}} || {{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://ftp.gnu.org/gnu/automake/?M=D Gnu(slow)] ||
|-
! Pkgconfig
| 0.20.0 || 0.23 || {{untested}} ||{{unNeeded}} || {{unNeeded}}|| {{Needed}}|| {{unNeeded}}|| {{unNeeded}} || [http://pkgconfig.freedesktop.org/wiki/ fd.org] || Don't update [http://trac.videolan.org/vlc/changeset/17486 Rev.17486]
|-
! Perl
| 5.8.8 || 5.10.0 || {{untested}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || [http://www.perl.org Perl] ||
|-
! libtool
| 1.5.24 || 1.5.26 || {{untested}} || {{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || [http://www.gnu.org/software/libtool/ GNU-libtool] || Not tested yet and not usefull.
|-
! libiconv
| 1.9.2 || 1.12 || {{untested}} || {{Needed}} || {{Needed}} || {{unNeeded}}|| {{Needed}} || {{unNeeded}} || [http://www.gnu.org/software/libiconv/#downloading Gnu] || Not tested yet and not usefull.
|-
! gettext
|| 0.16.1 || 0.17 || {{untested}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://ftp.gnu.org/gnu/gettext/ Gnu(slow)] ||
|-
! freetype2
|| 2.3.5 || 2.3.5 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://freetype.org/index2.html freetype.org] ||
|-
! fribidi
|| 0.10.9 || 0.10.9 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} || [http://fribidi.org/wiki/ fribidi.org] ||
|-
! libunicows
|| 1.1.1 || 1.1.1 || {{up-to-date}} ||{{Needed}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || [http://libunicows.sourceforge.net/ libunicows] ||
|-
! zlib
|| 1.2.3 || 1.2.3 || {{Up-to-date}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{Needed}} || [http://www.zlib.net/ zlib] ||
|-
|}

=== Others ===
{| class="wikitable" style="font-size: smaller; text-align: center; width: 100%; margin: 1em auto 1em auto; border : 1px"
|+ '''Contrib Status'''
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Comment
|-
!libid3tag
|| 0.15.1b || 0.15.1b || {{up-to-date}} || {{Needed}} || {{Needed}} || {{Needed}} || {{Needed}} || {{unNeeded}} ||
|-
!taglib
|| 1.4 || 1.4 || {{up-to-date}} || {{Needed}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} ||http://developer.kde.org/~wheeler/taglib.html
|-
! goom2k4
|| 2k4-0 || 2k4-0 || {{up-to-date}} || {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} ||
|-
! libcaca
|| 0.9 || 0.9 || {{up-to-date}}|| {{Needed}} ||{{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} || 0.99-beta2 is not a release version ?
|-
! libmodplug
|| 0.8 || 0.8 || {{up-to-date}} || {{Needed}} || {{unNeeded}} || {{Needed}} || {{Needed}} || {{unNeeded}} ||
|-
! glib
|| 1.2.10 || 1.2.10 || {{Up-to-date}}||{{unNeeded}} ||{{unNeeded}} ||{{Needed}} ||{{unNeeded}} || {{unNeeded}} ||v. gtk 1.2+
|-
! libidl
|| 0.6.8 || 0.8.6 || {{Up-to-date}} ||{{unNeeded}} ||{{unNeeded}}||{{Needed}} ||{{unNeeded}} || {{unNeeded}} || ''Not up-to-date, but We don't need about new versions'', since we don't really build it. Mirror has changed. It is now on gnome site
|-
! glib-win32
|| 19990228 ~ 1.2.0 || 1.2.10 || {{Up-to-date}} || {{Needed}} ||{{unNeeded}} ||{{unNeeded}} ||{{unNeeded}} || {{unNeeded}} || ''Not up-to-date, but We don't need about new versions'', since we don't really build it.
|-
! libidl-win32
|| 0.6.3 || 0.8.6 || {{Up-to-date}} ||{{Needed}} ||{{unNeeded}} ||{{unNeeded}} ||{{unNeeded}} || {{unNeeded}} || ''Not up-to-date, but We don't need about new versions'', since we don't really build it. Mirror has changed. It is now on gnome site
|-
! gecko
|| 1.7.5 || 1.8b1 || {{Up-to-date}} ||{{unNeeded}} ||{{unNeeded}} ||{{Needed}} ||{{unNeeded}} || {{unNeeded}} ||''Not up-to-date, but We don't need about new versions'', since we don't really build it.
|-
! gecko-win32
|| 1.8b1 || 1.8b1 || {{Up-to-date}} || {{Needed}} ||{{unNeeded}} ||{{unNeeded}} ||{{unNeeded}} || {{unNeeded}} ||''Not up-to-date, but We don't need about new versions'', since we don't really build it.
|-
! wxWidgets
|| 2.6.3 || 2.6.3 || {{Up-to-date}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} ||
|-
! Qt
|| 4.2.3 || 4.2.3|| {{up-to-date}} || {{Needed}} || {{unNeeded}} || {{unNeeded}} || {{Needed}} || {{unNeeded}} ||
|-
! portaudio
|| 19 || 19 || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} ||Commented for Win32
|-
! Clinkcc
|| 171 || 171 || {{up-to-date}}|| {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || Commented for MacOSX
|-
! Upnp
|| 1.3.1 || 1.3.1 || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || Commented
|-
! expat
|| 2.0.0 || 2.0.1 || {{untested}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} ||Commented for MacOSX
|-
! NASM
|| Cvs 2006-01 || CVS || {{up-to-date}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || {{unNeeded}} || For MacTels. Need to update cvs ???
|-
! Contrib lib !! VLC version !! Most recent version !! Compile !! Win32 !! BeOS !! MacOSX !! *Nix !! WinCE !! Comment
|}

[[Category:Coding]] [[Category:Building]] [[Category:Libraries]]

Hacker Guide/VLC source tree/src

2008-02-07T11:23:17Z

Materthron: adding a means of going to VLC source tree

Note: Data taken verbatim from the API. To get an overview see [[VLC source tree]].

LibVLC is the core part of VLC. It is a library providing an interface for programs such as VLC to a lot of functionalities such as stream access, audio and video output, plugin handling, a thread system. All the LibVLC source files are located in the src/ directory and its subdirectories:

{| class="wikitable"

|-
! Directory Name
! Directory Explanation

|-
|interface/
|contains code for user interaction such as key presses and device ejection.
|-
|playlist/
|manages playlist interaction such as stop, play, next, or random playback.
|-
|input/
|opens an input module, reads packets, parses them and passes reconstituted elementary streams to the decoder(s).
|-
|video_output/
|initializes the video display, gets all pictures and subpictures (ie. subtitles) from the decoder(s), optionally converts them to another format (such as YUV to RGB), and displays them.
|-
|audio_output/
|initializes the audio mixer, ie. finds the right playing frequency, and then resamples audio frames received from the decoder(s).
|-
|stream_output
|TODO
|-
|misc/
|miscellaneous utilities used in other parts of libvlc, such as the thread system, the message queue, CPU detection, the object lookup system, or platform-specific code.
|}

[[Category:Building]]

Hacker Guide/Modules source tree

2008-02-07T11:21:08Z

Materthron: adding a means of going back to VLC source tree

This page lists the content of the Modules directory in the [[VLC source tree|source tree of VLC]], aimed at giving new beginners an overview of the code.

The directories are listed in alphabetical order, with an overview of their contents on the right. Any first level subdirectories are shown as well.

'''''Note:''''' This table is by no means exhaustive. Note that only plugins with their own subdirectories are listed; plugins inside the parent directories are not emphasized unless they are too important. A comprehensive list of the plugins VLC makes use of can be found [http://trac.videolan.org/vlc/browser/trunk/modules/LIST here].

{| class="wikitable"
|-
! Directory Name
! Subdirectory Name
! Directory Explanation
|-
|access
|
|protocols to access streams through network (http,ftp,fake,tcp,udp etc.), access to physical media like cd's and dvd's
|-
|
|cdda
|input module to read audio CDs
|-
|
|dshow
|DirectShow access plugin for encoding cards under Windows
|-
|
|dvb
|input module for DVB-S/C/T streaming using v4l2 API
|-
|
|mms
|MMS over TCP, UDP and HTTP access module
|-
|
|rtsp
|
|-
|
|screen
|an input module that takes screenshots of the primary monitor
|-
|
|vcd
|input module for accessing Video CDs.
|-
|
|vcdx
|input module for accessing Video CDs with navigation & stills
|-
|
|
|
|-
|access-filter
|
|Includes the following filters: [[Documentation:Modules/timeshift|timeshift]], [[Documentation:Modules/record|record]], [[Documentation:Modules/dump|dump]], which are used for ?????
|-
|
|
|
|-
|access-output
|
|
|-
|
|
|
|-
|audio-filter
|
|Various audio filters like decoders, equalizers, converters.

|-
|
|channel-mixer
|Various mixers and decoders like Dolby decoder
|-
|
|converter
|Fixed and floating-point audio format conversions such as AC/3 or MPEG I-II Audio Layer 1, 2, 3 decoding
|-
|
|resampler
|Various audio resampler
|-
|
|
|
|-
|audio-mixer
|
|Mixer plugins.
|-
|
|
|
|-
|audio-output
|
|Audio output plugins like ALSA, OSS and DirectX audio.
|-
|
|
|
|-
|codec
|
|This directory includes various codecs, notably ''ffmpeg'' which is used for encoding and decoding various formats.
|-
|
|cmml
|Continuous Media Markup Language annotations/hyperlinks decoder
|-
|
|dmo
|a DirectMediaObject decoder that uses DirectMedia to decode video (WMV3)
|-
|
|ffmpeg
|Video decoder using the ffmpeg library
|-
|
|spudec
|RLE DVD subtitles decoder
|-
|
|xvmc
|XVMC video output and decoder
|-
|
|
|
|-
|control
|
|Various interfaces to control the player: gestures, hotkeys, lirc, remote control (rc) and telnet
|-
|
|[[Documentation:Modules/http inft|http]]
|HTTP remote control webinterface
|-
|
|
|
|-
|demux
|
|Various demuxers
|-
|
|asf
|ASF demuxer
|-
|
|avi
|AVI File stream demuxer
|-
|
|mp4
|MP4 file input module
|-
|
|mpeg
|
|-
|
|playlist
|playlist import module???
|-
|
|
|
|-
|gui
|
|GUI's for different platforms and the [[Documentation:Modules/ncurses|ncurses ]] interface
|-
|
|[[Documentation:Modules/beos|beos]]
|Audio output, video output and interface module for BeOS.
|-
|
||[[Documentation:Modules/macosx gui|macosx]]
|Video output, and interface module for Mac OS X.
|-
|
|pda
|interface for iPaq using the Gtk2+ widget set.
|-
|
|qnx
|QNX RTOS plugin
|-
|
||[[Documentation:Modules/Qt4|qt4]]
|interface module using the cross-platform Qt4 library: Multi-platform. This interface will be the default one upon subsequent releases.
|-
|
||[[Documentation:Modules/skins2|skins2]]
|Skinnable interface, new generation
|-
|
|wince
|Pocket PC interface
|-
|
|wxwidgets
|interface module using the cross-platform wxWindows library: Multi-platform. The default interface as of VLC 0.86a.
|-
|
|
|
|-
| meta-engine
|
|
|-
|
|
|
|-
|misc
|
|
|-
|
|dummy
|Dummy (no GUI) audio output, video output, interface and input modules.
|-
|
|memcpy
|memory chunk copying module.
|-
|
|notify
|notifications using libnotify
|-
|
|playlist
|
|-
|
|probe
|
|-
|
|testsuite
|
|-
|
|xml
|LibXML and xtag xml parsers
|-
|
|
|
|-
|mux
|Various Muxers
|
|-
|
|mpeg
|
|-
|
|rtp
|
|-
|packetizer
|
|Packetizers for H264/AVC and MPEG 4 audio and video streams.
|-
|
|
|
|-
|services-discovery
|
|
|-
|
|
|
|-
|stream-out
|
|-
|
|transrate
|
|-
|
|
|
|-
| video-chroma
|
|Image conversions such as YUV to RGB
|-
|
|
|
|-
| video-filter
|
|Various video filters like [[Documentation:Modules/deinterlace|Deinterlace]], [[Documentation:Modules/transform|Transform]], [[Documentation:Modules/wall|Wall]], [[Documentation:Modules/crop|Crop]], [[Documentation:Modules/panoramix|Panoramix]] etc.
|-
|
|
|
|-
| video-output
|
|-
|
|directx
|Video output module using the [[Documentation:Modules/direct3d|Direct3D]] and [[Documentation:Modules/directx vout|Direct X]] API's ; [[Documentation:Modules/glwin32|OpenGL]] for Windows.
|-
|
|qte
|video output module for Qt Embedded.
|-
|
|[[Documentation:Modules/x11|x11]]
|video output module using the X11 API.
|-
|
|
|
|-
|visualization
|
|Several visualizations, including [[Documentation:Modules/goom|goom]]
|-
|
|galaktos
|a visualization module that outputs OpenGL
|-
|
|visual
|visualisation system
|}

See Also: [http://www.videolan.org/doc/vlc-user-guide/en/ch02.html VLC User Guide - Chapter 2. Modules and options for VLC ]
[[Category:Building]]

Hacker Guide/VLC source tree

2008-02-07T11:20:20Z

Materthron: applied some polish

This page lists the directories in the source tree of VLC to give an overview of the code. Because VLC has evolved with not so much accumulation in mind, when a new coder looks at the code, s/he is terrified by the abundance of directories. This page was prepared to remedy that situation.

The directories are listed in alphabetical order, with an overview of their contents on the right.
{| class="wikitable"

|-
! Directory Name
! Directory Explanation
|-
|bindings
|Java, CIL and Python bindings
|-
|doc
|Documentation (not up-to-date)
|-
|extras
| See below
|-
|include
|Header files for VLC
|-
|libs
|Contains the loader (win32 dmo codec loading on Linux) and a SRTP library
|-
|lxdialog
| Make menuconfig files
|-
|m4
|Macro files needed for automake and autoconf
|-
|modules
|The most important directory besides src/. ''See [[Modules source tree]].''
|-
|po
|i18n files
|-
|projects
| Projects based on libvlc, Mozilla plugin, ActiveX plugin and MacOS FrameWork
|-
|share
|icons, scripts to make VLC the default player etc.
|-
|src
|The most important directory besides modules/. ''See [[src source tree]].''
|-
|test
|scripts to see if everything is OK

|}

== Contents of extras ==
{| class="wikitable"
| extras/analyser
| contains some code style editor (vim, emacs) macro and some valgrind suppressions
|-
| extras/buildsystem
| contains alternative buildsystems
|-
| extras/contrib
| for required libraries (contains Makefiles to automatically download and compile (or cross-compile) and patch those). Please first attempt to get the development headers precompiled for your distribution.
|-
| extras/deprecated
| contains deprecated files
|-
| extras/misc
| contains files that don't fit into any other category
|-
| extras/package
| contains distribution specific files such as ipkg, different rpm spec files, win32 and Mac OS X installation files.
|-
|}

[[Category:Building]]

VideolanStringGuidelines

2008-02-04T16:33:21Z

Materthron: + Apple Style Guide, Qt translation functions and some clean up

'''Draft 0.1.1'''

The goal of this guide is to ensure that all configuration and interface strings will be consistent, well-written and well-translated, providing a better user experience.

= Developers =

== Write correct English ==

Many VLC developers are not native English speakers, which often leads to badly written strings.

Please always have your strings proofread, preferably by a native English speaker (even if you are one yourself).

== Avoid technical jargon as much as possible ==

If some terms sound common to you, they may be impossible to understand for others. If you cannot avoid using them, try explaining them (for configuration options, use the extended descriptions, for interfaces, use tool tips). Try not being too verbose either.

Of course, some advanced concepts are quite hard to explain. Don't try too much explaining things, and don't hesitate to ask the user to read the documentation.

== Make your string translatable if needed ==

Only strings that are visible in the GUI must be translated, such as:
* interface description
* module descriptions / longnames / shortnames
* configuration options
* "mms://", "http://", "UDP", "RTP" don't need to be translated
* module shortcuts and shortnames must not be made translatable
* Debug messages must not be made translatable.

* _("") makes a string translatable and also actually does translation (calls gettext)
* _NS("") is the macosx variant of _(""). It's short for <nowiki>[NSApp localizedString: ""]</nowiki>.
There is also a <nowiki>[NSApp delocalizeString:@""]</nowiki>. Note that OS X is entirely UTF-8 native.
* N_() only makes a string translatable. It is safe to use it in #defines and in arrays. Also use this when translating strings during the creation of config variables.
* Try to keep strings UTF-8 where possible, to make sure a string can be displayed in Chinese just as easily as in English.
* wxU is used for c UTF-8 strings to Unicode conversion. wxL2U transforms from current locale to Unicode.

Since 0.9.0 use qfu(), qtr(), qtu(). See [http://trac.videolan.org/vlc/browser/trunk/modules/gui/qt4/qt4.hpp modules/gui/qt4/qt4.hpp] for more.

== Use correct syntax ==
* Sentences must end with a period.
* All GUI strings, such as the following, should start with a capital letter:
** module names
** short and long descriptions
** menu items
* Debug messages don't start with a capital and don't end with a point
* For menu items, put a Capital At Each Word.
* Put a space after ',' ';' ':' '.' '?' and '!'. There is no space before these characters.
* ...

== Configuration option descriptions ==

Configuration option descriptions consist of a short and a long description.

=== The short description ===

The short description must be kept short (40 characters maximum). Keep in mind that translations are often longer than the English version.

The short description should be easily understandable for an advanced user. It must not be a full sentence, must not contain question marks or words like "setting". Because as it is in the preferences it's a setting.

=== The long description ===

The long description should not just repeat the short description (and in most cases, not repeat it at all). This is pointless and probably proves that your descriptions are not properly thought.

The extended description should ''generally'' use complete sentences. Use of paragraphs is encouraged to improve readability and separate ideas.

Don't be too verbose. This clutters the help output and the interfaces.

Avoid using structures like "Please choose", "select" or "specify".
Passive voice should be preferred over second person: Use "When this option is enabled" rather "If you enable this option".

Bad: "Please specify an integer for foo"
Good: "An integer for foo, which is ..."

=== Specifics ===

* ''String, integer, float'': The short description should be a prompt, never a question.
** Bad : "IP Address ?" or "Which channel ?"
** Good: "IP Address " or "Channel "
*:The short description must include range and unit, if available. Example: "Frequency (1000-20000 Hz)"
*:The long description should rather explain what the user should enter rather than merely rephrasing the short description.

* Multi-select choices: Use a prompt. Do not use "please choose" or "please select", the user can guess that...

* Booleans: The short description should not be a direct question
** Bad : "Video overlay ?"
** Good : "Video overlay"
*:For the long description, please prefer "Enable foo to get bar" rather than "If you enable foo, you will get bar" (which produces long heavy sentences)

== Miscellaneous ==

* msg_Dbg can be quite cryptic. msg_Warn, msg_Info and msg_Err MUST be explicit and understandable.
* All strings in all languages should be gender-neutral.
* You should never use the first person (neither "I" nor "we"). Computers don't speak and our strings don't speak for the VideoLAN team.
* Try reusing strings. This avoids translation efforts and improves consistency.
* Don't make assumptions on the way interfaces are organized. Don't forget your strings should apply to the command line and to the GUI likewise. So don't use "If you choose yes", "If you tick this checkbox" etc.

== Common translations ==

[TODO: Gather them here!]

= Translators =

All user-visible strings are translated. Debug messages are not.

== Don't desperately try to translate ==

Many video specific terms have no equivalent in other languages. Don't desperately try to translate them. This often leads to quite ridiculous expressions.

What you can do is quote the English word in the short description / menu item and explain it in your own words in the long description / tool tip, without trying to translate word for word.

== Test your translation ==

Compile your translation and enable it (this is explained on the developers page). You should particularly look for overflows (too long translated strings).

If you feel you can't reduce the size of your string, you should contact the developer(s) so that the problem can be solved smoothly

== Consistency ==

It is recommended to choose translations for command terms and to use them everywhere. You should probably use the wiki [TODO].

== External Links ==
*[http://developer.apple.com/documentation/UserExperience/Conceptual/APStyleGuide/AppleStyleGuide2006.pdf Apple Style Guide] - Quite useful guide on strings (not limited to Mac OS X)

[[Category:Coding]]

User talk:Dionoea

2008-01-28T13:24:51Z

Materthron: New section: Editing Guidelines

== The thing ==

Hello! I'd like to suggest [[User:The thing|The thing]] is considered for sysop status. His [[Special:Contributions/The_thing|contributions]] have lots of reverts to previous versions (ie, spam removed), and this task is a million times easier with the ability to rollback pages. His user page is a bit strange, but other than that he's doing a great job. --[[User:H2g2bob|H2g2bob]] 16:32, 28 May 2006 (CEST)
:Well, uh of course I 2nd that. [[User:The thing|The thing]] 18:40, 28 May 2006 (CEST)
::Done :) Thanks for the help -- [[User:Dionoea|Dionoea]] 21:20, 2 June 2006 (CEST)
:::Your Welcome. [[User:The thing|The thing]] 20:40, 3 June 2006 (CEST)

== Google map ==

I know you posted ages ago (sorry, was doing my dissertation like a crazy fool over easter) but if you still want to add me to Google map thing, I'm at:
:<marker username="h2g2bob" fullname="David Batley" location="Exeter, UK" blurb="" lat="50.749056" lon="-3.530045" title="Developer"/>
I can't edit /team/team.xml myself - no SVN access :( It's interesting to see how many Europeans there are. Plus Xtophe is just (well 100km) down the road - how cool! --[[User:H2g2bob|h2g2bob]] 18:08, 24 April 2007 (CEST)
:Done. Thanks. [[User:Dionoea|Dionoea]] 18:05, 30 April 2007 (CEST)

== demux ==

Hi,

On [[Demuxdump]] the following example is given :

vlc <nowiki>http://example.org/shoutcast.mp3</nowiki> :demux=dump :demuxdump-file=output.mp3

You say that the ":" syntax is correct (by the way I didn't get anything out of you explantion in the Edit page). If it is, then can you explain to me why this actually does ''not'' work on my mac:

vlc <nowiki>http://213.205.96.91:9915</nowiki> :demux=dump :demuxdump-file=output.mp3

giving the following errors:

[00000278] access_http access: Raw-audio server found, mp3 demuxer selected<br>
[00000281] demuxdump demuxer: dumping raw stream to file `/Volumes/Proton/output.mp3'<br>
[00000281] demuxdump demuxer: closing /Volumes/Proton/output.mp3 (0 Kbytes dumped)<br>
libdvdnav: Using dvdnav version 0.2.0cvs from http://dvd.sf.net<br>
libdvdread: Using libdvdcss version 1.2.9 for DVD access<br>
libdvdread: Can't stat demuxdump-file=output.mp3<br>
No such file or directory<br>
libdvdnav: vm: failed to open/read the DVD<br>
[00000283] main input error: no suitable access module for `:demuxdump-file=output.mp3'<br>
[00000271] main playlist: nothing to play<br>

while this one works:

vlc <nowiki>http://213.205.96.91:9915</nowiki> --demux=dump --demuxdump-file=output.mp3

Thanks.

== Editing Guidelines ==

Hi Dionea!
Sorry for that one. I just oversaw the Editing Guidelines.
As I've got some spare time the next month, I'd love to contribute to VLC. As I'm (by now) not that good a coder, I thought I'd start with the wiki (which is a rather easy field). So, are there any tasks which are of high priority? Also, as I'm not that very familiar with the inner workings VLC, is there any particular developer I can contact when I stumble upon something I don't understand (j-b?)?

Regards, Salut,
--[[User:Materthron|materthron]] 14:24, 28 January 2008 (CET)

User:Materthron

2008-01-27T15:15:17Z

Materthron:

Hi! My name is Philipp Weissenbacher and I'm a first semester cs student at the University of Vienna. I'm interested in GUIs and User Interface (Centred) Design.

I've just recently joined the VideoLAN project, helping [[User:Fkuehne|Felix Kühne]] with the German translation. Also I'm trying to improve the wiki in as many ways I can. Although still being a C++ newbie, I'm looking forward to contribute to VLC media player itself soon (especially to it's brand new [[Qt Interface]]).
Also, I'm regularly getting the latest nighties to test and see if everything works fine.

Feel free to contact me via ICQ (220627791), Skype (materthron) or email (philipp_DOT_weissenbacher_AT_gmail_DOT_com).

Documentation:Modules/directx vout

2008-01-26T17:40:31Z

Materthron: typos, language

{{Module|name=directx|type=Video output|description=DirectDraw video output|os=Windows}}

'''Note:''' This stopped being default on Windows Vista since VLC 0.8.6. It is likely to not be default for all Windows versions starting with VLC 0.9.0. See [[Documentation:Modules/direct3d|Direct3D]] for more.

{{Stub}}

{{Documentation}}

Documentation:EditingGuidelines

2008-01-26T17:34:02Z

Materthron: fixed some typos and improved language

This pages lists rules that should apply to '''all''' pages in the Official Documentation (ie the Documentation:* namespace in this wiki). Feel free to discuss additions to this list on the [[Documentation_Talk:EditingGuidelines|discussion page]].

== Editing ==

If you are unsure about something you'd like to add to the documentation, please discuss it first in the page's discussion page before adding it. We want to keep this documentation as accurate as possible. (People often review the wiki so you're likely to get feedback in a few days time)

== Structure ==

All docs (Play HowTo, Streaming HowTo, Hacker's Guide, etc.) should start by defining base concepts and gradually cover more advanced topics. The user should be able to read it sequentially (like any other online documentation, but unlike most wikis).

One exception to this rule is the Documentation:Modules/* space. Each of these pages is to focus on a specific module, containing greater detail than the basic documentation.

== Formatting ==

Page formatting needs to be kept consistent. Check existing pages to see what that means.

== Links between different docs ==

These are of course allowed. Just keep in mind the "Structure" rule :)

== Links to other wiki pages and websites ==

The documentation needs to be self-contained. Definitions of important concepts should be in the documentation. This makes it possible to export it as a PDF and keep it understandable. <br/>
Links to advanced topics, like what you have in the "SEE ALSO" section in Unix man-pages, are of course OK.

== Images ==

Some parts of the documentation will need images, illustrations. Unfortunately, image uploading is currently disabled in the VideoLAN wiki. If you are a VideoLAN developer and have an account on people.videolan.org, please upload images there. If you're not a VideoLAN developer, just link to an image hosted somewhere else on the web and we'll download a copy and change the content to point there.

Documentation:EditingGuidelines

2008-01-26T17:20:35Z

Materthron: /* Images */ typo

This pages lists rules that should apply to '''all''' pages in the Official Documentation (ie the Documentation:* namespace in this wiki). Feel free to discuss additions to this list on the [[Documentation_Talk:EditingGuidelines|discussion page]].

== Editing ==

If you are unsure about something you'd like to add to the documentation, please discuss it first in the page's discussion page before adding it. We want to keep this documentation as accurate as possible. (People often review the wiki so you're likely to get a confirmation in a few days time)

== Structure ==

The docs (Play HowTo, Streaming HowTo, Hacker's Guide, etc.) should start by defining base concepts and gradually cover more advanced topics. The user should be able to read it sequentially (like any other online documentation, but unlike most wikis).

One exception to this rule is the Documentation:Modules/* space. Each of these pages should focus on a specific modules, with greater detail than what can be put in the basic documentation.

== Formatting ==

Page formatting needs to be kept consistent. Check existing pages to see what that means.

== Links between different docs ==

These are of course allowed. Just keep in mind the "Structure" rule :)

== Links to other wiki pages and websites ==

The documentation needs to be self contained. Definitions of important concepts should be in the documentation. This makes it possible to export it as a PDF and keep it understandable.
Links to advanced topics, like what you have in the "SEE ALSO" section in Unix man-pages, would of course be OK.

== Images ==

Some parts of the documentation will need images, illustrations. Unfortunately, image uploading is currently disabled in the VideoLAN wiki. If you are a VideoLAN developper and have an account on people.videolan.org, please upload images there. If you aren't a VideoLAN developer, just link to an image hosted somewhere else on the web and we'll download a copy and change the content to point there.

Documentation:Streaming HowTo/Easy Streaming

2008-01-23T14:57:55Z

Materthron: /* Intro */ cleanup + links

{{RightMenu|documentation streaming howto toc}}

==Intro==

The easier way to start streaming with VLC is by using one of the graphical user interfaces. These are the [[WxWidgets Interface|wxWindows]] and [[Skins|skinnable]] interfaces for Windows and GNU/Linux and the [[MacOSX|Mac OS X]] native interface.

==Streaming using the Wizard==

The ''Streaming/Transcoding Wizard'' leads you step by step through the process of streaming your media on a network or saving it to your hard drive. This ''Wizard'' offers easy to use menus but provides a restricted set of options.

Note: The wizard is only available on the wxWindows interface.

===Launching the wizard===

To launch the ''Streaming/Transcoding Wizard'' open the "File" menu, and select the Wizard menu item.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard.jpg Launching the Wizard

===Wizard dialog===

First select the type of task:
*''Stream to network'': Choose this option if you want to stream media on network.
*''Transcode/Save to file'': Choose this option if you want to change a file's audio codec and/or video codec, its bitrate, and/or encapsulation method.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-first.jpg The Wizard Dialog

===Input selection===

Select a stream (such as a file, a network stream, a disk, a capture device ...) by selecting the ''Choose...'' dialog or an existing item in your playlist, using the ''Existing playlist item'' option.

''Partial Extract'': To read only part of the stream, check the "Enable" checkbox and choose a start and end date (in seconds). This option should only be used with streams you can control such as files or discs but not network streams or capture devices.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-input.jpg Wizard input selection

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-input-playlist.jpg Wizard input selection from playlist

===Streaming methods===

If you chose ''Stream to network'' option, you can now specify the streaming method. Available methods are:
*''RTP/UDP Unicast'': Stream to a single computer. Enter the client's IP address (in the 0.0.0.0 - 223.255.255.255 range).
*''RTP/UDP Multicast'': Stream to multiple computers using multicast. Enter the IP address of the multicast group (in the 224.0.0.0 to 239.255.255.255 range).
*''HTTP'': Stream by using the HTTP protocol. If you leave the ''Destination'' text box empty, VLC will listen on all the network interfaces of the server on port 8080. Specify an address, port and path on which to listen using the following syntax [ip][:port][/path]. For instance, ''192.168.0.1:80/stream'' will make VLC listen on the interface carrying the 192.168.0.1 IP address, on the 80 TCP port, in the /stream ''virtual file''.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-stream.jpg Wizard streaming method

===Transcoding options===

If you chose the ''Transcode/Save to file'' option, you can now specify the new audio and video codecs and bitrates you want you input converted to.

(See <xref linkend="smc" endterm="tsmc" />)

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-transcode.jpg Wizard transcode

===Encapsulation method===

Choose the method format. The UDP streaming methods require MPEG TS encapsulation. The HTTP streaming method can be used with the MPEG PS, MPEG TS, MPEG 1, OGG, RAW or ASF encapsulation. Saving to a file can be done using any encapsulation format compatible with the chosen codecs.

(See <xref linkend="smc" endterm="tsmc" />)

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-mux.jpg Wizard encapsulation method

===Streaming options===

If you chose to ''Stream to network'' you can now specify several options.

*''Time To Live (TTL)'' This sets the numbers of routers your stream can go through, for UDP unicast and unicast access methods. If you do not know what this means, you should leave the default value. Note: With UDP multicast, the default TTL is set to 1, meaning that your stream won't get accross any router. You may want to increase it if you want to route your multicast stream.
* ''SAP Announce'' To advertise your stream over the network when using the UDP streaming method, using the SAP protocol, enter the name of the stream in the text input and check the checkbox. This is NOT available for the HTTP streaming method.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-streaming-options.jpg Wizard streaming options

===Save to file destination===

If you chose ''Transcode/Save to file'' you can now specify the file you want to save the stream to.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-wizard-save.jpg Wizard save file - wxWindows interface

You can now select the ''Finish'' button to start streaming/converting the source.

==Streaming using the GUI==

===Introduction===

A second way to set up a streaming instance using VLC is using ''Stream Output'' panel in the ''Open...'' dialog of the wxWindows (Windows / GNU Linux), skinnable (Windows / GNU Linux) and MacOS X interfaces. Streaming methods and options used 99% of time should be available in this panel.

To stream the opened media, check the "Stream output" checkbox in the "Open File/Disc/Network Stream/Capture Device" dialog and click on the "Settings" button.

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-open-file.jpg Open file dialog - wxWindows interface

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-osx-open-file.jpg Open file dialog - Mac OS X interface

===The Stream Output dialog===

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-wx-stream-output.jpg Stream output dialog - wxWindows interface

http://www.videolan.org/doc/streaming-howto/en/images/streaming-howto/intf-osx-stream-output.jpg Stream output dialog - wxWindows interface

====Stream Output MRL====

On the wxWindows interface, a text box displays the ''Stream Output MRL'' (Media Ressource Locator). This is updated as you change options in the Stream output dialog. For more information on how to edit the ''Stream Output MRL'' read <xref linkend="cmdline" endterm="tcmdline" />.

====Output methods====

*''Play localy'': display the stream on your screen. This allows to display the stream you are actually streaming. Effects of transcoding, rescaling, etc... can be monitored locally using this function.
*''File'': Save the stream to a file. The ''Dump raw input'' option allows to save the input stream as it read by VLC, without any processing.
*''HTTP'': Use the HTTP streaming method. Specify the IP address and TCP port number on which to listen.
*''MMSH'': This access method allows to stream to Microsoft Windows Media Player. Specify the IP address and TCP port number on which to listen. Note: This will only work with the ''ASF'' enacpsulation method.
*''UDP'': Stream in unicast by providing an address in the 0.0.0.0 - 223.255.255.255 range or in multicast by providing an address in the 224.0.0.0 - 239.255.255.255 range. It is also possible to stream to IPv6 addresses. Note: This will only work with the ''TS'' encapsulation method.
*''RTP'': Use the Real-Time Transfer Protocol. Like UDP, it can use both unicast and multicast addresses.

Note: UDP, HTTP, MMSH and RTP methods require to select the ''Stream'' option on the MacOS X interface.

(See <xref linkend="smc" endterm="tsmc" />)

====Encapsulation method====

Select an encapsulation method that fits the codecs and access method of your stream, among MPEG TS, MPEG PS, MPEG 1, OGG, Raw, ASF, AVI, MP4 and MOV. (See <xref linkend="smc" endterm="tsmc" />)

====Transcoding options====

Enable video transcoding by checking the "Video Codec" checkbox. Choose a codec from the list. You can also specify an average bitrate and scale the input. (See <xref linkend="smc" endterm="tsmc" />)

Enable audio transcoding by checking the "Audio Codec" checkbox. Choose a codec from the list. You can also specify an average bitrate and the number of audio channels to encode. (See <xref linkend="smc" endterm="tsmc" />)

====Miscellaneous options====

Select methods to announce your stream. You can use SAP (Service Announce Protocol) or SLP (Service Location Protocol). You must also specify a channel name. The Mac OS X interface also allows you to export the description (SDP) file of a RTP session using the internal HTTP or RTSP server of VLC, or as a file. This can be done using the according checkboxes. The ''SDP URL'' text box allows to give the url or destination where the SDP file will be available.

{{Documentation}}

V6F

2008-01-23T14:48:31Z

Materthron: created; because this is what you find under info->codec

#REDIRECT [[Flash Video]]

Web Interface

2008-01-23T11:28:21Z

Materthron: make it work

#REDIRECT [[Documentation:Modules/http intf]]