VideoLAN Wiki - User contributions [en]

Chroma

2016-08-16T13:15:34Z

Rogerdpack: add note

Greek for color, the part of a video file or signal that encodes the color portion.

== List of Video Chromas ==

* I420

* I411

* I422

* YUYV

* UYVY

* RV24 (basically this is RGB24, 3 bytes, one for R, G, B)

* RV32

* I42N

* I41N

* GRAW

See also [[YUV]].

[[Category:Glossary]]
[[Category:Stubs]]

VLC HowTo/Use a capture card

2015-12-29T17:04:19Z

Rogerdpack: mention caveat

{{howto|use video from a TV or Video card}}
{{stub}}

----

=== The following describes how to watch TV with your DVB-Card ===
(tested with DVB-T and the Windows-Version of VLC)

* find out the frequencies of your location
* go to File/Open CaptureCard
* choose DVB DirectShow
* check your kind of card (DVB-S -C -T)
* choose first frequency and bandwidth
* click on play

If your stream has "multiple" (for instance multiple sub channels, or you want to programmatically select a particular audio stream):

* when the channel plays, select playlist
* rightclick on the item, which is playing and select information
* go to stream
* here you can find all broadcast-channels with their service-ID
* write them down
* go to File/Open CaptureCard
* in the option-line at the bottom append a space (if not there) a : and the keyword "program=", followed by one of the service-IDs
* it should look like: ...300ms :program=16214
* click on play
* that's your channel
* now you can rename this playing item of the playlist to your station-name
* and the same with the next service-ID
* and so on with the next frequency

'''Don't forget to save your playlist!'''

Have fun!

Spielmops

----

The minimal command to transcode from a capture card to
a portable MPEG file (this example includes trancoding which may be lessly, be careful) is thus:
vlc v4l:// :v4l-norm=1: '--sout=#transcode{vcodec=mp1v,vb=2030,audio-sync,acodec=mpga,ab=192,channels=2}:std{access=file,mux=mpeg1,url="out_file.mpg"}'

These MPEG files have been verified to work with:

* Windows Media Player 10
* Apple QuickTime Player 7
* XINE 1.0
* ffplay
* xanim 2.80 (no audio)

VLC HowTo/Use a capture card

2015-12-29T17:03:21Z

Rogerdpack:

{{howto|use video from a TV or Video card}}
{{stub}}

----

=== The following describes how to watch TV with your DVB-Card ===
(tested with DVB-T and the Windows-Version of VLC)

* find out the frequencies of your location
* go to File/Open CaptureCard
* choose DVB DirectShow
* check your kind of card (DVB-S -C -T)
* choose first frequency and bandwidth
* click on play

If your stream has "multiple" (for instance multiple sub channels, or you want to programmatically select the audio stream):

* when the channel plays, select playlist
* rightclick on the item, which is playing and select information
* go to stream
* here you can find all broadcast-channels with their service-ID
* write them down
* go to File/Open CaptureCard
* in the option-line at the bottom append a space (if not there) a : and the keyword "program=", followed by one of the service-IDs
* it should look like: ...300ms :program=16214
* click on play
* that's your channel
* now you can rename this playing item of the playlist to your station-name
* and the same with the next service-ID
* and so on with the next frequency

'''Don't forget to save your playlist!'''

Have fun!

Spielmops

----

The minimal command to transcode from a capture card to
a portable MPEG file is thus:
vlc v4l:// :v4l-norm=1: '--sout=#transcode{vcodec=mp1v,vb=2030,audio-sync,acodec=mpga,ab=192,channels=2}:std{access=file,mux=mpeg1,url="out_file.mpg"}'

These MPEG files have been verified to work with:

* Windows Media Player 10
* Apple QuickTime Player 7
* XINE 1.0
* ffplay
* xanim 2.80 (no audio)

Git

2014-03-24T17:10:39Z

Rogerdpack: add some more git http protocol options

[http://git-scm.com/ Git] is a free and open source [[wikipedia:Revision_control|version control system]]. It is used by programmers to keep track of the different versions of the files composing a software.

= Basic Git usage =

If you are using '''Windows''', please read the [[Git_Windows]] page.

== Getting VLC or x264 source code via Git ==

$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/.

$ git clone git://git.videolan.org/x264.git
Voilà! The full x264 history should be on your hard disk in x264/.

If you want only the last 3 VLC revisions:
$ git clone git://git.videolan.org/vlc.git --depth 3

Clones without the full revision set (--depth) can't be used for backporting (or to make sure that you're including at least commits up to the common fork point).

You can also have the VLC stable branch, here:
$ git clone git://git.videolan.org/vlc/vlc-2.0.git
Voilà! You got the stable branch repository.

Or via http protocol from the main site:
$ git clone http://git.videolan.org/git/vlc.git
See http://git.videolan.org/?p=vlc.git;a=summary

Or via http protocol from github (github can sometimes be a bit behind as a mirror):
https://github.com/videolan/vlc.git
See https://github.com/videolan/vlc

You can also clone using http via our repo.or.cz mirror.
$ git clone http://repo.or.cz/r/vlc.git
See http://repo.or.cz/w/vlc.git (a mirror).

=== After cloning ===

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

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

== Configure your global git config ==
May need to use
$ git repo-config {various options}
1.4.4.2 Requires the repo-config command rather than just config

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

=== Mail Setup ===
To send patches you'll need a working git-send-email configuration.

'''MSMTP'''

You can use [http://msmtp.sourceforge.net/ msmtp] to achieve this. Install it with tls and ssl activated and place the following config file (.msmtprc) in your home directory
# msmtp configuration file

# Set default values for all following accounts.
defaults
tls on
tls_starttls on
tls_trust_file /certificates/EquifaxSecureCertificateAuthority.crt
logfile /log/.msmtp.log

# GMAIL
account gmail
host smtp.gmail.com
port 587
protocol smtp
from user.name@gmail.com
auth on
user user.name@gmail.com

# Set a default account
account default : gmail
Then configure git to use msmtp. The password will be asked for upon sending mail.
$ git config --global sendemail.smtpserver /usr/local/bin/msmtp
The certificate for gmail can be found here: [http://www.geotrust.com/resources/extended-validation-ssl/certs/Equifax%20Secure%20Certificate%20Authority.crt EquifaxSecureCertificateAuthority.crt]

'''Mac OS X'''

Setup info with e.g. gmail account
$ git config --global sendemail.smtpserver smtp.gmail.com
$ git config --global sendemail.smtpuser your-gmail-address-here
$ git config --global sendemail.smtpencryption tls
$ git config --global sendemail.smtpserverport 587

If errors occur telling you something like perl's SMTP::SSL package is not there. Do the following
$ sudo -H cpan Net::SMTP::SSL

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

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

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

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

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

== Set up Hooks (Tip) ==
If you are using Qt-creator and want to keep your files listing in sync,
just set up a post-checkout hook accordingly.
#!/bin/sh
# this file as .git/hooks/post-checkout
if test -f vlc.files
then
echo "Updating Qt files list"
git ls-files > vlc.files
fi

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

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

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

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

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

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

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

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

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

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

If you wish to give credit to someone else's work (e.g. you are applying a third party patch):
$ git commit <specific files> --author "Name Surname <user@domain.com>"

== List your commits ==
$ git log

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

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

Now you can just type:
$ git up

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

== Submitting patches ==

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

If you have been developing on vlc locally and (still) don't have write access, you can submit all your commits in one shot using:
$ rm -Rf patches
$ git format-patch -o patches origin
$ git send-email --to vlc-devel@videolan.org patches
If you want to create a cover letter for multiple patches use:
$ git format-patch -o patches origin -n --cover-letter
$ git send-email --annotate --cover-letter --to vlc-devel@videolan.org patches
If you have multiple patch consider using:
$ git send-email --compose --no-chain-reply-to --to vlc-devel@videolan.org patches
This will produce the patches for each local commit in the directory "patches" and send them.
Use --no-chain-reply-to make sure it doesn't reply.

For x264, do the same with x264-devel@videolan.org


Don't do:
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...
But do:
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

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

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

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

If warnings appear that files still need updating:
$ include/libvlc_internal.h: needs update
include/mediacontrol_internal.h: needs update
include/vlc/libvlc.h: needs update
include/vlc_update.h: needs update
modules/access/mms/mms.c: needs update
...

Then do a checkout -f to revert non committed local changes
$ git checkout -f

To stay up-to-date another
$ git pull --rebase
Should give no more warnings.

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

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

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

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

== Backporting commits ==
It is possible to "backport" commit between the master branch and a -bugfix branch. However since VDD'09, the bugfix branches have been splitted to their own git repositories. This leaves us with 2 cases.

=== Normal simple case ===

Go to your -bugfix branch:
$ git checkout 1.0-bugfix

Backport the commit:
$ git cherry-pick -x -s <sha-id of commit>

If git fails to do the backport by itself, you'll be presnted with the usual options in case of a failed merge or patching. Use "git status", your favorite editor or "git mergetool" to resolve the situation. Then use "git add" and "git commit -c <sha-id of backported commit>".
Then push your commit as usual.

=== Case of VLC bugfix branches ===
Due to the number of commits in vlc.git and the amount of divergence between the master and 1.0-bugfix branches, they have been separated into two different git repositories. But that doesn't block you from backporting.

Get the -bugfix git:
$ git clone git://git.videolan.org/vlc/vlc-1.0.git vlc-bugfix
Add vlc.git as an additional remote:
$ git remote add vlc-master git://git.videolan.org/vlc.git
Update the information from vlc-master
$ git fetch vlc-master
Backport as normal
$ git cherry-pick -x -s <sha-id of commit>

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

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

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

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

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

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

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

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

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

== Patch-ing ==
* You can apply patches using
$ git apply <patch>

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

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

= Using Git to push to VideoLAN git =
== Initial requirements ==
* You must have credentials to push commits into the repository. For other contributors, please read upper [[Git#Submitting_patches_to_the_vlc-devel_or_x264-devel|Submitting patches to the vlc-devel or x264-devel]] paragraph.
* Make sure you've set your name and email in your commits
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

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

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

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

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

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



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

[[Category:Coding]]

Contrib Status

2013-09-17T20:47:34Z

Rogerdpack: /* Others */

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

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

 

=== Codecs ===

{| class="wikitable" style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where ?
! License
! Comment
|-
! libvorbis
| 1.3.3
| 1.3.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.xiph.org/downloads/ Xiph.org]
| BSD-like 
| 
|-
! libogg
| 1.3.1
| 1.3.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| [http://www.xiph.org/downloads/ Xiph.org]
| BSD-like 
| 
|-
! libtheora
|
1.1.1

| 1.1.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.xiph.org/downloads/ Xiph.org]
| BSD-like 
| 
|-
! speex
| 1.2rc1
| 1.2rc1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.xiph.org/downloads/ Xiph.org]
| BSD-like 
| 
|-
! flac
| 1.3.0
| 1.3.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://xiph.org/flac/ xiph.org]
| BSD-like 
| 
|-
! x264
| svn
| svn
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| SVN
| GPLv2+ 
| 
|-
! a52
| 0.7.4
| 0.7.4
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://liba52.sf.net liba52.sf]
| GPLv2+ 
| Not likely to be updated
|-
! MPEG2DEC
| 0.5.1
| 0.5.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| [http://libmpeg2.sf.net libmpeg2.sf]
| GPLv2+ 
| Not likely to be updated
|-
! faad2
| 2.7
| 2.7
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.audiocoding.com/faad2.html audiocoding]
| GPLv2+ 
| 
|-
! faac
| 1.28
| 1.28
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.audiocoding.com/faac.html audiocoding]
| LGPL for modifications 
| 
|-
! lame
| 3.99.5
| 3.99.5
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://sourceforge.net/projects/lame/files/lame/ sf.net]
| LGPLv2+ 
| 
|-
! FFmpeg
| SVN
| SVN
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| SVN
| GPLv2/3/LGPL 
| 
|-
! libmad
| 0.15.1b
| 0.15.1b
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://sourceforge.net/project/showfiles.php?group_id=12349&package_id=86999 SF]
| GPLv2+ 
| 
|-
! orc
| 0.4.18
| 0.4.18
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://code.entropywave.com/download/orc/ orc ]
| Two-Clause BSD
|
|-
! schroedinger
| 1.0.11
| 1.0.11
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.diracvideo.org/download/schroedinger/ diracvideo.org]
| GPLv2/LGPL 2.1/MIT 
| 
|-
! libdca
| SVN
| SVN
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| SVN
| GPLv2+
|
|-
! twolame
| 0.3.13
| 0.3.13
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.twolame.org/ twolame.org]
| LGPL 2.1+
|
|-
! libmpcdec
| r481
| r481
| {{Up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.musepack.net/index.php?pg=src musepack]
| BSD
|
|-
! Tremor
| SVN
| SVN
| {{up-to-date}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| SVN
| BSD-like
|
|-
! libass
| 0.10.1
| 0.10.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://code.google.com/p/libass/downloads/list Google Code] 
| Simplified 2-clause BSD license
|
|-
! libgsm
| 1.0.13
| 1.0.13
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://libgsm.sourcearchive.com/ SourceArchive]
| Simplified 2-clause BSD license
|
|-
! libzvbi
| 0.2.35
| 0.2.35
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://sourceforge.net/projects/zapping/files/zvbi/ SF]
| ???
|
|-
! mfx_dispatch
| ?.?
| ?.?
| {{up-to-date}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| [http://git.videolan.org/?p=mfx_dispatch.git;a=summary videolan.org]
| ???
|
|-
! Opus
| 1.0.3
| 1.0.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.opus-codec.org/downloads/ opus-codec.org]
| three-clause BSD
|
|}

=== Demuxers and Muxers ===

{| style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;" class="wikitable"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where
! License 
! Comment
|-
! libebml
| 1.3.0
| 1.3.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.matroska.org/downloads/linux.html matroska.org]
| LGPLv2.1+ 
| 
|-
! libmatroska
| 1.4.0
| 1.4.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.matroska.org/downloads/linux.html matroska.org]
| LGPLv2.1+ 
| 
|-
! libdvbpsi
| 0.2.2
| 0.2.2
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| [http://www.videolan.org/developers/libdvbpsi.html libdvbpsi]
| LGPLv2.1+
|
|-
! libmodplug
| 0.8.8.4
| 0.8.8.4
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://modplug-xmms.sourceforge.net/ modplug sur sf.net]
| Public domain
|
|-
! GME
| 0.6.0
| 0.6.0
| {{up-to-date}}
| {{Needed}}
|
|
|
| [http://code.google.com/p/game-music-emu/downloads/list GME on Google]
| LGPLv2.1+
|
|}

=== Access ===

{| class="wikitable" style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where ?
! License
! Comment
|-
! shout
| 2.3.1
| 2.3.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://www.icecast.org/download.php icecast.org]
| LGPLv2.1+
|
|-
! libdvdcss
| 1.2.13
| 1.2.13
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://download.videolan.org/pub/libdvdcss/?C=N;O=D libdvdcss on v.o]
| GPLv2+
|
|-
! libdvdread
| 4.2.0
| 4.2.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://dvdnav.mplayerhq.hu/ dvd.sf.net]
| GPLv2+
|
|-
! libdvdnav
| 4.2.0
| 4.2.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://dvdnav.mplayerhq.hu/ dvd.sf.net]
| GPLv2+
|
|-
! libbluray
| 0.2.2
| 0.2.2
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.videolan.org/developers/libbluray.html videolan.org]
| LGPLv2.1+
|
|-
! livedotcom
| latest trunk
| latest trunk
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| [http://www.live555.com/mediaServer/#downloading live555]
| LGPLv2.1+
|
|-
! libcddb
| 1.3.2
| 1.3.2
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://libcddb.sourceforge.net/download.html libcddb.sf.net]
| LGPLv2+
|
|-
! libcdio
| 0.80
| 0.82
| {{Untested}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://ftp.gnu.org/gnu/libcdio/?M=D gnu.org]
| GPLv2+
|
|-
! VCDimager
| 0.7.23
| 0.7.23
| {{Up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://www.vcdimager.org/pub/vcdimager/vcdimager-0.7/ vcdimager]
| GPLv2+
|
|-
! libgpg-error
| 1.12
| 1.12
| {{Up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [ftp://ftp.gnupg.org/gcrypt/libgpg-error/ gnupg.org]
| LGPLv2.1+
|
|-
! libgcrypt
| 1.5.3
| 1.5.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [ftp://ftp.gnupg.org/gcrypt/libgcrypt/ gnupg.org]
| LGPLv2.1+
|
|-
! gnuTLS
| 3.1.12
| 3.1.13
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://gnutls.org/ gnutls.org]
| LGPLv2.1+(lib)/GPLv3(extra)
|
|-
! Opendaap
| 0.4.0
| 0.4.0
| {{Up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
|
|
|
|-
! libxml2
| 2.9.1
| 2.9.1
| {{Up-to-date}}
| {{Needed}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| [ftp://xmlsoft.org/libxml2/ xmlsoft ftp]
| MIT License
|
|-
! VNCServer
| 0.9.9
| 0.9.9
| {{Up-to-date}}
| {{Needed}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| [http://libvncserver.sourceforge.net/ sf.net]
| GPLv2+
|
|}

=== Images ===

{| class="wikitable" style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where
! License 
! Comment
|-
! libpng
| 1.5.17
| 1.6.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.libpng.org/pub/png/libpng.html libpng.org]
| Very open license, approaching BSD 2-clause
|
|-
! libjpeg
| 9
| 9
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.ijg.org/files/ ijg.org]
| 1. We don't promise that this software works.
2. You can use this software for whatever you want. You don't have to pay us. 3. You may not pretend that you wrote this software. If you use it in a program, you must acknowledge somewhere in your documentation that you've used the IJG code.

|
|-
! libtiff
| 4.0.3
| 4.0.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [ftp://ftp.remotesensing.org/pub/libtiff/ Main libtiff ftp]
| BSD with Copyright attribution
|
|-
! SDL
| 1.2.15
| 1.2.15
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://www.libsdl.org/download-1.2.php libsdl.org]
| LGPLv2.1+ 
| 
|-
! SDL_image
| 1.2.12
| 1.2.12
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://www.libsdl.org/projects/SDL_image/ libsdl.org]
| LGPLv2.1+ 
| 
|}

=== Tools ===

{| style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;" class="wikitable"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where !
! License 
! Comment
|-
! Autoconf
| 2.68
| 2.68
| {{up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://ftp.gnu.org/gnu/autoconf/?M=D Gnu(slow)]
| We don't care 
| 
|-
! automake
| 1.11
| 1.11
| {{up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://ftp.gnu.org/gnu/automake/?M=D Gnu(slow)]
| We don't care 
| 
|-
! Pkgconfig
| 0.26
| 0.26
| {{up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://pkgconfig.freedesktop.org/wiki/ fd.org]
| We don't care 
|
|-
! libtool
| 2.2.10
| 2.2.10
| {{up-to-date}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| [http://www.gnu.org/software/libtool/ GNU-libtool]
| We don't care 
| 
|-
! libiconv
| 1.14
| 1.14
| {{up-to-date}}
| {{Needed}}
| {{unNeeded}}
| {{Needed}}
| {{Needed}}
| [http://www.gnu.org/software/libiconv/#downloading Gnu]
| LGPLv2.0+ 
|
|-
! gettext
| 0.18.3
| 0.18.3
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://ftp.gnu.org/gnu/gettext/ Gnu(slow)]
| LGPLv2.1+ 
| 
|-
! zlib
| 1.2.8
| 1.2.8
| {{Up-to-date}}
| {{Needed}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| [http://www.zlib.net/ zlib]
| Free
|
|-
! freetype2
| 2.4.12
| 2.5.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://sourceforge.net/projects/freetype/files/freetype2/ freetype.org]
| dual FreeType (BSD+advertisement) or GPLv2 
| 
|-
! fribidi
| 0.19.5
| 0.19.5
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://fribidi.org/download/ fribidi.org]
| LGPLv2.1+
|

|-
! fontconfig
| 2.10.2
| 2.10.2
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| [http://www.freedesktop.org/software/fontconfig/release/?C=M;O=D fd.o]
| BSD
|
|}

=== Others ===

{| style="margin: 1em auto; font-size: smaller; text-align: center; width: 100%;" class="wikitable"
|+ '''Contrib Status'''
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! Where
! License
! Comment
|-
! taglib
| 1.8.0
| 1.8.0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| http://developer.kde.org/~wheeler/taglib.html
| 
| 
|-
! goom2k4
| 2k4-0
| 2k4-0
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| 
| 
| 
|-
! projectM
| 2.0.1
| 2.0.1
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| http://sourceforge.net/projects/projectm/files/
| LGPLv2.1+
| 
|-
! libcaca
| 0.99-beta17
| 0.99-beta17
| {{up-to-date}}
| {{Needed}}
| {{Needed}}
| {{Needed}}
| {{unNeeded}}
| 
| 
| 
|-
! Qt
| 4.8.5
| 5.1
| {{up-to-date}} for 4.x
| {{Needed}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| [http://qt-project.org/ qt-project.org]
| 
| 
|-
! portaudio
| 19
| 19
| {{up-to-date}}
| {{Yes}} 
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| 
| 
| Commented for Win32
|-
! Upnp
| 1.6.18
| 1.6.18
| {{up-to-date}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| http://pupnp.sourceforge.net/
| 
| 
|-
! expat
| 2.0.0
| 2.0.1
| {{untested}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| {{unNeeded}}
| 
| 
| Commented for MacOSX
|-
! yasm
| 1.1.0
| 1.1.0
| {{untested}}
| {{unNeeded}}
| {{Needed}}
| {{unNeeded}}
| {{unNeeded}}
| 
| 
| For Intel-based Macs
|-

! SQLite
| 3.6
| 3.6
| 
| 
| 
| 
| 
| 
| 
| 
|-
! Contrib lib
! VLC version
! Most recent version
! Compile
! Win32
! MacOSX
! *Nix
! WinCE
! 
! 
! Comment
|}

=== Single command installation in Ubuntu 11.10 ===

Note:
* no longer available and not needed libebml2 libdvbpsi6 libmatroska2
* added libxcb-composit0-dev

$ sudo apt-get -y install libvorbis-dev libogg-dev libtheora-dev speex libspeex-dev flac libflac-dev \
x264 libx264-dev a52-0.7.4 liba52-0.7.4-dev mpeg2dec libmpeg2-4-dev faad libfaad-dev faac libfaac-dev \
lame libmp3lame-dev ffmpeg libavdevice-dev libmad0 libmad0-dev dirac libdirac-dev liboil-dev libschroedinger-dev \
libebml-dev libdca-dev twolame libtwolame-dev libmpcdec-dev libvorbisidec1 libvorbisidec-dev libass-dev libass4 \
libmatroska-dev libdvbpsi-dev libmodplug1 libmodplug-dev libshout3 libshout3-dev libdvdread4 libdvdnav4 \
libdvdnav-dev livemedia-utils liblivemedia-dev libcddb2 libcddb2-dev libcdio10 libcdio-dev libxcb-composite0-dev\
libcdio-utils vcdimager libvcdinfo0 libvcdinfo-dev libgpg-error0 libgpg-error-dev libgcrypt11 libgcrypt11-dev \
gnutls-bin libgnutls26 libgnutls-dev libdap10 libdap-bin libdap-dev libxml2 libxml2-dev libpng12-0 libpng12-dev \
libjpeg8 libtiff4 libsdl1.2-dev libsdl-image1.2 libsdl-image1.2-dev libc-bin gettext libfreetype6 libfreetype6-dev \
libfribidi-dev libfribidi0 zlib1g zlib1g-dev libtag1-dev libcaca0 libcaca-dev caca-utils libqt4-core libqt4-dev \
libportaudio2 libportaudio-dev libupnp-dev libupnp4 libupnp3 libexpat1 libexpat1-dev yasm libxcb-xv0 libxcb-xv0-dev \
libx11-xcb1 libx11-xcb-dev
=== Single command installation in Ubuntu ===

$ sudo apt-get -y install libvorbis-dev libogg-dev libtheora-dev speex libspeex-dev flac libflac-dev \
x264 libx264-dev a52-0.7.4 liba52-0.7.4-dev mpeg2dec libmpeg2-4-dev faad libfaad-dev faac libfaac-dev \
lame libmp3lame-dev ffmpeg libavdevice-dev libmad0 libmad0-dev dirac libdirac-dev liboil-dev libschroedinger-dev \
libdca-dev twolame libtwolame-dev libmpcdec-dev libvorbisidec1 libvorbisidec-dev libass-dev libass4 libebml2 \
libebml-dev libmatroska2 libmatroska-dev libdvbpsi6 libdvbpsi-dev libmodplug1 libmodplug-dev libshout3 libshout3-dev \
libdvdread4 libdvdnav4 libdvdnav-dev livemedia-utils liblivemedia-dev libcddb2 libcddb2-dev libcdio10 libcdio-dev \
libcdio-utils vcdimager libvcdinfo0 libvcdinfo-dev libgpg-error0 libgpg-error-dev libgcrypt11 libgcrypt11-dev \
gnutls-bin libgnutls26 libgnutls-dev libdap10 libdap-bin libdap-dev libxml2 libxml2-dev libpng12-0 libpng12-dev \
libjpeg8 libtiff4 libsdl1.2-dev libsdl-image1.2 libsdl-image1.2-dev libc-bin gettext libfreetype6 libfreetype6-dev \
libfribidi-dev libfribidi0 zlib1g zlib1g-dev libtag1-dev libcaca0 libcaca-dev caca-utils libqt4-core libqt4-dev \
libportaudio2 libportaudio-dev libupnp-dev libupnp4 libupnp3 libexpat1 libexpat1-dev yasm libxcb-xv0 libxcb-xv0-dev \
libx11-xcb1 libx11-xcb-dev libswscale-dev lua libxcb-composite0-dev

=== Single command installation on Fedora ===
$ yum install a52dec a52dec-devel caca-utils dirac dirac-devel expat expat-devel faac faac-devel faad2 faad2-devel ffmpeg \
ffmpeg-libs flac flac-devel fribidi-devel gettext gnutls gnutls-devel gnutls-utils lame lame-devel live555 live555-devel \
libass libass-devel libcaca libcaca-devel libcddb libcddb-devel libcdio libcdio-devel libdap libdap-devel libdca-devel \
libdvbpsi libdvbpsi-devel libdvdnav libdvdnav-devel libdvdread libebml libebml-devel freetype freetype-devel fribidi \
libgcrypt libgcrypt-devel libgpg-error libgpg-error-devel libjpeg-turbo libmad libmad-devel libmatroska libmatroska-devel \
libmodplug libmodplug-devel libmpcdec-devel libmpeg2-devel libogg-devel liboil-devel libpng libpng-devel libshout \
libshout-devel libtheora-devel libtiff libupnp libupnp-devel libvorbis-devel libX11 libX11-devel libxcb libxcb-devel \
libxml2 libxml2-devel mpeg2dec portaudio-devel qt4 qt4-devel schroedinger-devel SDL-devel SDL_image SDL_image-devel speex \
speex-devel taglib-devel twolame twolame-devel vcdimager vcdimager-devel vcdimager-libs x264 x264-devel yasm zlib \
lua xcb-util-devel libsamplerate-devel

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

{{Documentation}}

Win32Compile

2012-09-05T17:38:00Z

Rogerdpack: add link

How to compile {{VLC}} for [[Windows]].

== Building Methods ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| '''Cross-compile with Mingw on Linux'''
| This page
| '''Preferred''' method (uses cross compilation). On Windows, you should do it in a virtual machine.
|-
| '''Native compilation''' with '''[http://www.mingw.org MSYS+MINGW]'''
| [[Win32CompileMSYSNew]]
| '''Native''' compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows.
|-
| '''Native compilation''' with '''cygwin'''
| [[Win32CompileCygwinNew]]
| Build using cygwin as your compile environment. '''Error''' prone, and '''slow'''.
|}

== Obtaining the toolchain ==

=== Compiler and binary toolchain ===

To compile VLC for Windows (32-bits or 64-bits), the Mingw-w64 toolchain is required:

* '''Debian/Ubuntu''': run <code>apt-get install gcc-mingw-w64-i686</code>
(on Debian you must be on wheezy or above to find this package)

Up to versions 2.0.x, VLC was compiled with the older mingw32 toolchain, which only supports 32-bits Windows. If you have problems with mingw-w64, you can try mingw32 instead:

* '''Debian/Ubuntu''': run <code>apt-get install gcc-mingw32 mingw32-binutils</code>. Note that at least version 3.17 of Mingw32 is required, which Debian does not provide. You may obtain mingw32-runtime-3.17 [http://people.videolan.org/~jb/debian/mingw32-runtime_3.17.0-0videolan_all.deb here].
* '''Gentoo''' users can <code>emerge crossdev && crossdev mingw32</code>
* '''ArchLinux''' users can <code>pacman -S mingw32-gcc</code>
* '''Fedora''' users should read [[Win32Compile Under Fedora]]
* Other '''Linux''' systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
* Native-compile with '''[http://www.mingw.org MSYS+MINGW]''', should read the [[Win32CompileMSYSNew|documentation]]
* Native-compile with '''[http://www.cygwin.com Cygwin]''', should read the [[Win32CompileCygwinNew|documentation]]

=== Development tools ===
You will also need:
* lua5.1
* all autotools: libtool, automake, autoconf, autopoint, make, gettext
* pkg-config
* git
* subversion
* cmake, cvs if you want to rebuild contribs
* zip [for creating .zip package], p7zip [for .7z package], nsis [for .exe auto-installer], bzip2 [for 'make prebuild]

=== Host triplet ===
A number of example commands below include the identifier of the toolchain. This value is '''essential''': it instructs the build system to use the correct toolchain and compile the program for Windows. Without the value, the build system will perform a native compilation for Linux (or whatever your computer runs). With an incorrect value, the build will fail.

This is known as the ''host triplet'', although it's more of a pair than a triplet in the case of Mingw. The exact value depends on your installation of the toolchain. Notably on Debian/Ubuntu, these values must be used:

* ''i686-w64-mingw32'' for Windows 32-bits, using the Mingw-w64 toolchain
* ''x86_64-w64-mingw32'' for Windows 64-bits, using the Mingw-w64 toolchain
* ''i586-mingw32msvc'' for Windows 32-bits, using the Mingw32 toolchain

Again, you '''MUST''' substitute the value in the following command snippets.

== Get the source code ==
$ git clone git://git.videolan.org/vlc.git vlc

See [[Git]] for more information.

== Go into the VLC directory ==
$ cd vlc

== Prepare [[Contrib Status|3rd party libraries]] ==

Before compiling VLC, you need lots of other libraries. Here is how to get them:

$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i586-mingw32msvc
$ make prebuilt

or, if you want to compile the contribs yourself and are feeling adventurous and have lots of time to burn,
# apt-get install subversion yasm cvs cmake

$ mkdir -p contrib/win32
$ cd contrib/win32
$ ../bootstrap --host=i586-mingw32msvc
$ make fetch
$ make

=== Linux 64-bit ===

If you are on Linux '''64-bit''', you '''SHOULD''' remove some files, or install the lib32 packages (ia32-libs, multilibs, etc...)

$ rm -f ../i586-mingw32msvc/bin/moc ../i586-mingw32msvc/bin/uic ../i586-mingw32msvc/bin/rcc

In addition, install the ''qt4-tools'' package.

=== Fix your contrib path ===

If your Mingw prefix is not ''i586-mingw32msvc'' (you are NOT on Debian or Ubuntu), create a symlink to contribs:
$ ln -sf ../i586-mingw32msvc ../i486-mingw32

=== Go Back ===

Go back to the VLC source directory:

$ cd -

== Configuring the build ==

=== Bootstrap ===
First, prepare the tree:
$ ./bootstrap

=== Configure ===
Then you can to configure the build with the <code>./configure</code> script.

Create a subfolder:
$ mkdir win32 && cd win32

Use the standard configuration:
$ ../extras/package/win32/configure.sh --host=i586-mingw32msvc
'''NB''': use '''YOUR''' Xcompiling prefix here, like ''i486-mingw32''

Alternatively, you can run configure manually:
$ ../configure --host=i586-mingw32msvc
See <code>'../configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run:
$ make

== Packaging VLC ==
Once the compilation is done, you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win-common</code>
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries. You can run VLC directly from this directory.
|-
| <code>make package-win-strip</code> (might be package-win32-strip)
| Same as above but will create 'stripped' binaries (that is, smallest size, unusable with a debugger).
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Java bindings

2012-04-11T18:36:06Z

Rogerdpack: all the JVLC links are dead, remove it. It's dead, jim!

''At the moment the JVLC project is dead, as there is no maintainer for it. If you want information on it, see the wiki history ''
'''At the moment the VLCJ project is active, please look there instead.'''

= VLCJ =

VLCJ are Java bindings for VLC. It is managed as an external project at: http://code.google.com/p/vlcj/
There is an thread about it at: http://forum.videolan.org/viewtopic.php?f=32&t=56939&start=15
Though it has its own forums for asking questions.

= Java control of VLC =
See this [[https://forum.videolan.org/viewtopic.php?f=14&t=85347 forum topic]] for information on controlling VLC via its RC interface from a separate java program.

[[Category:Bindings]]

VLC Source code

2011-12-01T22:09:42Z

Rogerdpack: /* Latest source packages */

Check the [http://www.videolan.org/developers/vlc/NEWS News].

== Releases Sources ==

=== Latest Source ===

{{VLC}} Source Code can be downloaded here ({{VLC:latest version}})
: '''http://www.videolan.org/vlc/download-sources.html'''

=== Older Source ===

You can get all the versions of VLC, using the [http://download.videolan.org/pub/vlc/ VLC FTP Archive].

You can also get it with the tags from the VLC's [[Git]].

== Development Sources ==

=== Latest source packages ===
If you want to get the latest bleeding edge development source package then go to this link:
[http://repo.or.cz/w/vlc.git http://repo.or.cz/w/vlc.git]
and download the first listed tar.gz or .zip file. Or you can check it out by using [[Git]].

If you want the entire source tree then look under '''How to get VLC media player's latest source tree'''.

=== How to get {{VLC}}'s latest source tree ===

'''This is the recommended way if you are working on {{VLC}}'''

You need to use [[Git]] to download the latest, live snapshot of the development tree.

Start by reading the [[Git]] page and then use the repository located at:
git://git.videolan.org/vlc.git

Please note that this will download the entire git repository. If you are only interested in the latest development build then use the link under '''Latest source packages'''.

=== Get the nightly snapshots ===

You can download nightly source snapshots from the [http://nightlies.videolan.org/build/source/?C=M;O=D nightlies website].

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

Win32Compile

2011-12-01T19:06:23Z

Rogerdpack: /* Configuring the build */

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation). If on windows you can do it on a virtual machine, via dual-boot or from another computer. ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|-
| Cross-compile with cygwin
| [[Win32CompileCygwinNew]]
| Build using cygwin as your cross compile environment. Error prone, and slow.
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, [[GetTheSource]] then run <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good configure examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory you could run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code>
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code>
or just run configure manually, like
*<code>./configure --with-contrib=/usr/win32 --host=i586-mingw32msvc</code>

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

VLC Source code

2011-12-01T17:24:35Z

Rogerdpack: /* Get the nightly snapshots */

Check the [http://www.videolan.org/developers/vlc/NEWS News].

== Releases Sources ==

=== Latest Source ===

{{VLC}} Source Code can be downloaded here ({{VLC:latest version}})
: '''http://www.videolan.org/vlc/download-sources.html'''

=== Older Source ===

You can get all the versions of VLC, using the [http://download.videolan.org/pub/vlc/ VLC FTP Archive].

You can also get it with the tags from the VLC's [[Git]].

== Development Sources ==

=== Latest source packages ===
If you want to get the latest bleeding edge development source package then go to this link:
[http://repo.or.cz/w/vlc.git http://repo.or.cz/w/vlc.git]
and download the first listed tar.gz or .zip file.

If you want the entire source tree then look under '''How to get VLC media player's latest source tree'''.

=== How to get {{VLC}}'s latest source tree ===

'''This is the recommended way if you are working on {{VLC}}'''

You need to use [[Git]] to download the latest, live snapshot of the development tree.

Start by reading the [[Git]] page and then use the repository located at:
git://git.videolan.org/vlc.git

Please note that this will download the entire git repository. If you are only interested in the latest development build then use the link under '''Latest source packages'''.

=== Get the nightly snapshots ===

You can download nightly source snapshots from the [http://nightlies.videolan.org/build/source/?C=M;O=D nightlies website].

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

VLC Source code

2011-12-01T17:22:21Z

Rogerdpack: /* Get the nightly snapshots */

Check the [http://www.videolan.org/developers/vlc/NEWS News].

== Releases Sources ==

=== Latest Source ===

{{VLC}} Source Code can be downloaded here ({{VLC:latest version}})
: '''http://www.videolan.org/vlc/download-sources.html'''

=== Older Source ===

You can get all the versions of VLC, using the [http://download.videolan.org/pub/vlc/ VLC FTP Archive].

You can also get it with the tags from the VLC's [[Git]].

== Development Sources ==

=== Latest source packages ===
If you want to get the latest bleeding edge development source package then go to this link:
[http://repo.or.cz/w/vlc.git http://repo.or.cz/w/vlc.git]
and download the first listed tar.gz or .zip file.

If you want the entire source tree then look under '''How to get VLC media player's latest source tree'''.

=== How to get {{VLC}}'s latest source tree ===

'''This is the recommended way if you are working on {{VLC}}'''

You need to use [[Git]] to download the latest, live snapshot of the development tree.

Start by reading the [[Git]] page and then use the repository located at:
git://git.videolan.org/vlc.git

Please note that this will download the entire git repository. If you are only interested in the latest development build then use the link under '''Latest source packages'''.

=== Get the nightly snapshots ===

You can download the nightly snapshot binaries on the [http://nightlies.videolan.org/build/source/?C=M;O=D nightlies website].

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

Win32Compile

2011-12-01T17:21:11Z

Rogerdpack: /* Building VLC from source */

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation). If on windows you can do it on a virtual machine, via dual-boot or from another computer. ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|-
| Cross-compile with cygwin
| [[Win32CompileCygwinNew]]
| Build using cygwin as your cross compile environment. Error prone, and slow.
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, [[GetTheSource]] then run <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> helper script for cross compiling with mingw32 with the known contribs
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code> same for compiling with msys or cygwin
*<code>./configure --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> might work as well

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32CompileCygwinNew

2011-12-01T17:20:43Z

Rogerdpack:

This is a new version of the Win32CompileCygwin written by [[User:J-b|Jean-Baptiste Kempf]]

'''This version ONLY works for 0.9.x, for 1.0.x and for 1.1.x.'''

'''WARNING''': building VLC on Cygwin has ever been a failure-prone task. It is also very slow (specially if you enable debug and optimizations). If you want to build on windows, [[Win32CompileMSYSNew]] is a much better option. Otherwise, you should strongly consider cross-compiling from Linux (on a virtual machine, via dual-boot or from another computer, see [[Win32Compile]]). You were warned.

=Introduction=

This is a guide for Windows users with a step-by-step instruction to download, install, configure and build your VLC.

This guide uses [http://www.cygwin.com '''Cygwin'''] a Linux-like environment for Windows used for compilation of the VLC source code.

Start off by creating a VLC and a download folder on your hard drive where you can put all the installation files:

C:\VLC\
C:\VLC\Downloads

For further reference, the assumption is made that the local user will be 'Administrator'.

=Cygwin=

Download the latest [http://www.cygwin.com/cygwin/setup.exe Cygwin setup] and save it in your download location:

C:\VLC\Downloads\

More info about Cygwin can be found at http://www.cygwin.com or http://sourceware.org/cygwin

==Selecting Cygwin packages to install==

Run the setup program with the following options:

Installation type : Install from Internet (default)

Root directory : C:\cygwin (default)

Local Package directory : C:\VLC\Downloads\cygwin (your download location)

Internet Connection : Direct Connection (preferred, if it fails try another)

Download Site : Choose a download site closest to you (FTP preferred)

At the "Select Packages" section of the installation process you can select packages by clicking the button with the rotating 2 arrows. (This is under the "New" section). It shows "Skip" next to the button if the package isn't selected yet.

Clicking the button a few times will rotate through the possible package versions including "Skip" (meaning do not install or remove if installed) and "Keep" (meaning keep using the current installed version). If a package was already installed it will also show the "Current" version just to the left of it.

Select the following packages (some others will automatically be selected as well):

Archive
unzip
zip

Devel
autoconf
automake
binutils
cvs (optional: for building extras/contrib)
gcc
gcc-core
gcc-g++
gcc-mingw
gcc-mingw-core
gcc-mingw-g++
gdb
gettext
gettext-devel
git
libgcrypt-devel
libiconv
libtool
make
mingw-runtime
nasm
patchutils
pkg-config
subversion (optional: for building extras/contrib)

Editor
vim

Libs
expat
libgcrypt

Utils
ncurses

Web
curl (optional: for building extras/contrib)
wget (optional: for building extras/contrib)

==Cygwin environment==

Start Cygwin from the icon on your desktop (With Windows Vista run it with admin rights, so right click and select "Run as administrator"). If it runs for the first time it will automatically create a home\"username" folder in the Cygwin environment; user being the currently logged on Windows user. Assuming this is the 'Administrator' user it will create the following folder:

C:\cygwin\home\Administrator (example)

NOTE: On your desktop, you can rightclick the Cygwin icon and (in the Options field of the Cygwin Properties) set the Command history Buffer size to as large as possible: 999. This setting will make it possible to scroll back further in the Cygwin environment.

=VLC source code=

== Git ==
The very latest VLC source code can be obtained through a tool called [[Git]]. The Cygwin package we're about to install comes with an internal git component.

cd /cygdrive/c/VLC/

git clone git://git.videolan.org/vlc.git

or if you just want to download latest VLC revision (saves bandwidth)

git clone git://git.videolan.org/vlc.git --depth 1

or if your proxy denies git protocol connections use:

git clone http://git.videolan.org/git/vlc.git

In this case you need to set the proxy address first:

export http_proxy = <proxy>:<port>

If git fails for some reason, then please try to use git from basic Windows command prompt (Start -> Run -> cmd), not from Cygwin shell.

Please note that the very latest VLC sources ("master" branch) does not necessary build fine all the time. So if you need something stable, better is to use a git tag or a version snapshot archive.

== Snapshots ==

You can do the same by using the snapshots in the [http://nightlies.videolan.org/ nightly builds] site.

== Specific Version ==

You can get a specific version of VLC source code from the [http://download.videolan.org/pub/videolan/vlc/ source ftp] directory.

Another option is to sync specific version represented by a tag in git:

git checkout <version>

where <version> is one like: 1.0.1, 1.0.2, ..

=Bootstrap=
First move to vlc folder, if you aren't already there

cd vlc

and then run bootstrap.

dos2unix botstrap
./bootstrap

You should go through dos2unix for every script which produces errors related to '\r'

It might fail with some '''unable to remap error <some_dll_file_name>'''. It seems you need to rebase all Cygwin DLLs: close all your cygwin applications and launch 'ash' from basic windows command prompt (Start -> Run -> cmd), from there run rebaseall (so start e.g. C:\cygwin\bin\ash.exe and type there text below).

/bin/rebaseall -v

= External libraries to the source code=

VLC depends on other libraries (code) to provide some features like AC3 audio or MPEG-4 video encoding/decoding etc.

Depending on your needs you will have to install and compile some or all of these external libraries.

== Get the Win32 "contrib" package ==

A package with most of these libraries already compiled so it's actually really easy to compile a full-featured version of vlc can be found here:

http://download.videolan.org/pub/testing/win32/
or
http://people.videolan.org/~jb/Contribs/
or take
ftp://ftp.videolan.org/pub/vlc/1.0.0/win32/contrib-1.0.0.tar.bz2

Download the latest version of a "contrib" package for win32:

contrib-20080702-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 (this is an '''example''' so '''DON'T''' download packages this old, unless you really have to!)

It's a good idea to check the INSTALL.Win32 file in the VLC source directory for the appropriate contrib download file if you build older VLC versions.

Save it into your download location:

C:\VLC\Downloads\

==Installing the Win32 "contrib" package in Cygwin==

Start Cygwin and enter the following command in your shell:

rm -rf /usr/win32
cd /cygdrive/c/VLC/Downloads
tar xf contrib-20080702-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /

Replace with your version of the "contrib" file and DON'T FORGET THE / (slash)
at the end.

This will extract the contents of the file into usr/win32 folder within your Cygwin environment.

NOTE: Make sure to DELETE your old version (/usr/win32 folder) instead of extracting a new version on top of it.

Version 1.0.2 of VLC source code has been tested and found working with contrib-20091020-win32-bin-gcc-4.2.1-sjlj-runtime-3.15.2-only.tar.bz2

==Keeping the Win32 "contrib" package up-to-date==

For maintenance purposes periodically check:

http://download.videolan.org/pub/testing/win32/

==Qt4 issues==
There are some Qt4 and winapi issues (like '''InterlockedCompareExchange''' error) which you can work out with information you get from http://forum.videolan.org/viewtopic.php?f=14&t=50360&p=164758&hilit=win32api#p164219 and http://forum.videolan.org/viewtopic.php?f=14&p=175301#p175301 threads. If you don't plan to compile Qt4 or skins2 interface, you can skip this.

=Configure=

In order to make our lives just a bit easier the following section describes what commandline options should be used for compiling and those commands will then be put into a "script" that can be executed (rather than having to copy and paste all the time).

==Configure script for compiling VLC==

Create a new text document with the following lines:

PATH=/usr/win32/bin:$PATH \
PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" \
./configure \
--host=i686-pc-mingw32 \
--enable-nls \
--enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-faad --enable-flac --enable-theora \
--enable-live555 --with-live555-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--enable-goom \
--enable-dvdread \
--enable-debug --disable-optimizations \
--disable-mkv --disable-taglib --disable-zvbi --disable-dirac --disable-x264 --disable-fluidsynth

This command is tested and configures VLC 1.0.2 properly so that it builds fine.

NOTE: The following options are added for debug purposes and makes the final package a bit larger but the advantage is it's easier to debug in case of crash reports:

--disable-optimizations
--enable-debug

If you want to report a crash bug to the VLC team, it is necessary that you provide a stack backtrace. Unfortunately, Windows automatic crash reporter cannot generate such a backtrace as debug symbols used by GCC compiler aren't understood by Windows, therefore we suggest that you install Dr. MinGW (http://jrfonseca.dyndns.org/projects/gnu-win32/software/drmingw/) which will extend Windows Just-In-Time Debugger and provide the necessary debug information.

NOTE: The following options is needed for Qt4 support:

--enable-qt4

As of version 0.9.0 VLC will include the Qt interface. More information can be found about QT here: http://www.trolltech.com

The "Win32 contrib package" at present includes the linux and Windows equivalents of uic, moc and roc executables which are required for building this interface.

The linuxs executables have to be '''deleted''' from the contrib folder:

C:\cygwin\usr\win32\bin\moc (example)
C:\cygwin\usr\win32\bin\rcc (example)
C:\cygwin\usr\win32\bin\uic (example)

Save as filename in your "scripts" folder at your download/install location:

configure-vlc.sh

NOTE: Save using "All files" and not "Text files" otherwise Windows might append the extension .txt

Copy the file into your home directory:

C:\cygwin\home\Administrator

Start Cygwin and enter the following command in your shell:

dos2unix configure-vlc.sh

After your configure-vlc.sh is completed, copy it to your vlc directory and run it:

./configure-vlc.sh

If it complains about permissions, use chmod and try again:

chmod 777 configure-vlc.sh

NOTE. (If you plan to use JVLC) To make vlc-control.dll accessible by Java on ''Windows'' configure-vlc.sh should be modified to include "-Wl,--add-stdcal-alias". Example:

...
CC="gcc -mno-cygwin -Wl,--add-stdcall-alias" CXX="g++ -mno-cygwin -Wl,--add-stdcall-alias" \
./configure \
...

===Mozilla plugin===

If you want to build Mozilla plugin, add this to your configure-vlc.sh

--enable-mozilla --with-mozilla-sdk-path=/usr/win32/gecko-sdk

If configure-vlc.sh goes correctly, you should see '''plugins/bindings : activex mozilla'''

===POSIX emulation layer===

VLC can be built with or without the so called POSIX emulation layer. Without is the default and is usually better (and with hasn't been tested for quite some time). If you do want to use the emulation layer, then just leave out the line with the following options:

CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin"

=Compiling source code=

It's time to start Cygwin again...

==Compiling VLC==

Enter the following commands in your Cygwin shell:

cd vlc

NOTE: Open /cygdrive/c/VLC/libtool in text editor and if "global_symbol_pipe =" line is blank, replace it with :

global_symbol_pipe="sed -n -e 's/^.*[ ]\$[ABCDGIRSTW][ABCDGIRSTW]*\$[ ][ ]*\$\$\$[_A-Za-z][_A-Za-z0-9]*\$\$/\\1\\2\\3 \\3/p'"

Build it! (remember to run configure-vlc.sh before first build)

make

Cross your fingers and wait... because it might take few hours before compilation is done.
If you have multicore CPU or multi CPU box, you can use -j2 switch (or maybe -j3 or -j4 etc.) to speed up make process

make -j2

==Creating self contained packages==

Once the compilation is done, you can build self-contained VLC packages with the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

* If you have permissions problems running make package-*, chmod 777 -R the vlc folder.
* If you have permissions problems running vlc.exe after packaging, rename or delete vlc.exe.manifest

=Advanced usage=

==Updating Cygwin package versions==

If you need to update or install additional packages you can just run the Cygwin setup.exe from your download location:

C:\Downloads\cygwin\setup.exe (example)

==GDB (Gnu Debugger)==

This section requires that you installed the gdb (Gnu Debugger) in Cygwin.

This is a typical example of creating a crashlog:

cd vlc-trunk

gdb --args vlc.exe --fast-mutex --reset-config --reset-plugins-cache

NOTE: vlc-0.9.0 uses libtool for building sources, if you want to debug from the source tree, you should type the following command instead:

libtool --mode=execute gdb --args vlc --reset-config --reset-plugins-cache

In the debugger mode run the program and make sure you reset the preferences!

(gdb) run

NOTE: the (gdb) is just a prompt which means you are in the debugger mode, please note that ''--fast-mutex'' option is no longer supported in vlc-0.9.0

It will now take a lot longer than usual for VLC to start :)

Now operate VLC as you would normally do. As soon as a crash issue occurs
you'll notice a line like this:

Program received signal SIGSEGV, Segmentation fault.
0x0041394c in playlist_ItemGetById (p_playlist=0x19ec4f8, i_id=29)
at src/playlist/item-ext.c:459
---Type <return> to continue, or q <return> to quit---
459 i = i_bottom + ( i_top - i_bottom ) / 2;

Now you can do a "backtrace" by using the bt command:

(gdb) bt

And output similar to this will be created:

#0 0x0041394c in playlist_ItemGetById (p_playlist=0x19ec4f8, i_id=29)
at src/playlist/item-ext.c:459
#1 0x0b26bbf7 in wxvlc::Playlist::CountItems (this=0x1822e288, root=
{m_pItem = 0x29fef8}) at playlist.cpp:695
#2 0x0b26bc83 in wxvlc::Playlist::CountItems (this=0x1822e288, root=
{m_pItem = 0x29e8b0}) at playlist.cpp:689
#3 0x0b26bc83 in wxvlc::Playlist::CountItems (this=0x1822e288, root=
{m_pItem = 0x29a818}) at playlist.cpp:689
#4 0x0b26bc83 in wxvlc::Playlist::CountItems (this=0x1822e288, root=
{m_pItem = 0x299718}) at playlist.cpp:689
#5 0x0b26bc83 in wxvlc::Playlist::CountItems (this=0x1822e288, root=
{m_pItem = 0xffff0000}) at playlist.cpp:689
#6 0x0b26bf49 in wxvlc::Playlist::AppendItem (this=0x1822e288,
event=@0x1827afd0) at playlist.cpp:564
#7 0x0b2757fc in wxvlc::Playlist::OnPlaylistEvent (this=0x1822e288,
event=@0x1827afd0) at playlist.cpp:1438
#8 0x0b3771b8 in wxEvtHandler::ProcessEventIfMatches ()
at /usr/win32/include/wx-2.6/wx/event.h:2183
#9 0x0b376a1c in wxEventHashTable::HandleEvent ()
at /usr/win32/include/wx-2.6/wx/event.h:2183
#10 0x0b37730d in wxEvtHandler::ProcessEvent ()
at /usr/win32/include/wx-2.6/wx/event.h:2183
#11 0x0b37711b in wxEvtHandler::ProcessPendingEvents ()
at /usr/win32/include/wx-2.6/wx/event.h:2183
---Type <return> to continue, or q <return> to quit---
#12 0x0b376017 in wxAppConsole::ProcessPendingEvents ()
at /usr/win32/include/wx-2.6/wx/event.h:2183
#13 0x0b3ec75a in wxIdleWakeUpModule::MsgHookProc ()
at /usr/win32/include/wx-2.6/wx/bmpbuttn.h:81
#14 0x773aca2d in USER32!GetScrollRange ()
from /cygdrive/c/WINDOWS/system32/user32.dll
#15 0x00000000 in ?? () from
(gdb)

To backtrace all the running threads use:

(gdb) thread apply all bt

These are the log outputs that are more usefull to developers than just mentioning "it crashes"!

NOTE: In GDB mode there are sometimes situations where GDB initially "crashes" on certain network activity (opening network shares, network traffic) which in normal operation does not occur. Just select c for continue until "normal" operation continues.

== Common errors ==
===vlc.exe: Permission denied===

A make finished successfully and produced vlc.exe, but running the executable returns the following:

bash: ./vlc.exe: Permission denied

The permissions on both vlc.exe & vlc.exe.manifest must be set to executable.

FIX: Type the following:

chmod 755 vlc.exe vlc.exe.manifest

===error: parse error before '(' token===

A make (compile) of FFmpeg results in the following error:

/usr/include/sys/unistd.h:203: error: parse error before '(' token
make[1]: *** [ffm.o] Error 1

It's very likely you are usix the POSIX emulater which you shouldn't...

FIX: compile with the option

-mno-cygwin

===error: expected primary-expression before '<<' token===

In file included from /usr/lib/gcc/i686-pc-mingw32/3.4.4/../../../../include/w32
api/windows.h:52,
from ../../../include/vlc_common.h:459,
from ../../../include/vlc/vlc.h:153,
from dshow.cpp:31:
/usr/lib/gcc/i686-pc-mingw32/3.4.4/../../../../include/w32api/wingdi.h:3:1: warn
ing: this is the location of the previous definition
In file included from /usr/win32/include/dshow.h:35,
from common.h:45,
from dshow.cpp:35:
/usr/win32/include/ddraw.h:14: warning: ignoring #pragma warning
In file included from /usr/win32/include/dshow.h:35,
from common.h:45,
from dshow.cpp:35:
/usr/win32/include/ddraw.h:5552: warning: ignoring #pragma warning
In file included from /usr/win32/include/dshow.h:45,
from common.h:45,
from dshow.cpp:35:
/usr/win32/include/strmif.h:2: warning: ignoring #pragma warning
In file included from /usr/win32/include/dsound.h:13,
from /usr/win32/include/amaudio.h:18,
from /usr/win32/include/dshow.h:47,
from common.h:45,
from dshow.cpp:35:
/usr/win32/include/d3dtypes.h:22: warning: ignoring #pragma warning
/usr/win32/include/d3dtypes.h:1813: warning: ignoring #pragma warning
In file included from /usr/win32/include/dshow.h:48,
from common.h:45,
from dshow.cpp:35:
/usr/win32/include/control.h:2: warning: ignoring #pragma warning
dshow.cpp: In function `int CommonOpen(vlc_object_t*, access_sys_t*, vlc_bool_t)
':
dshow.cpp:456: error: expected primary-expression before '<<' token
dshow.cpp:456: error: expected primary-expression before '<<' token
dshow.cpp:456: error: expected primary-expression before '<<' token
dshow.cpp:456: error: expected primary-expression before '<' token
dshow.cpp:456: error: expected primary-expression before '.' token
dshow.cpp:470: error: expected primary-expression before '==' token
dshow.cpp:470: error: expected primary-expression before '==' token
dshow.cpp:470: error: expected primary-expression before '==' token
dshow.cpp:470: error: expected primary-expression before '=' token
dshow.cpp:484: error: expected primary-expression before '>>' token
dshow.cpp:484: error: expected primary-expression before '>>' token
dshow.cpp:484: error: expected primary-expression before '>>' token
dshow.cpp:484: error: expected primary-expression before '>' token
dshow.cpp:484: error: expected primary-expression before '.' token
dshow.cpp:485: error: expected `;' before "IAMCrossbar"
dshow.cpp:491: error: `pXbar' undeclared (first use this function)
dshow.cpp:491: error: (Each undeclared identifier is reported only once for each
function it appears in.)
make[6]: *** [libdshow_plugin_a-dshow.o] Error 1
make[6]: Leaving directory `/home/Administrator/vlc-trunk/modules/access/dshow'
make[5]: *** [all-modules] Error 1
make[5]: Leaving directory `/home/Administrator/vlc-trunk/modules/access/dshow'
make[4]: *** [all-recursive] Error 1
make[4]: Leaving directory `/home/Administrator/vlc-trunk/modules/access'
make[3]: *** [all] Error 2

Basically in case of conflict svn adds "<<< mine" and "=======" and ">>>> r1242" which makes gcc complain.

FIX: revert the offending file

===Objective C source seen but `OBJC' is undefined===

The configure process stops halfway.

+ aclocal-1.9 -I m4
+ autoconf
+ autoheader
+ automake-1.9 --add-missing --copy -Wall
configure.ac: installing `autotools/install-sh'
configure.ac: installing `autotools/missing'
activex/Makefile.am:143: shell $(VLC_CONFIG: non-POSIX variable name
activex/Makefile.am:143: (probably a GNU make extension)
activex/Makefile.am: installing `autotools/compile'
activex/Makefile.am: installing `autotools/depcomp'
modules/gui/macosx/Makefile.am: Objective C source seen but `OBJC' is undefined
modules/misc/testsuite/Makefile.am: Objective C source seen but `OBJC' is undefi
ned
src/Makefile.am: Objective C source seen but `OBJC' is undefined
Makefile.am:282: user target `vlc$(EXEEXT)' defined here...
/usr/share/automake-1.9/am/program.am: ... overrides Automake target `vlc$(EXEEX
T)' defined here
Makefile.am:230: while processing program `vlc'
make: *** No targets specified and no makefile found. Stop.

This problem is related to a warning earlier on and only occured in a few revisions where a built-in workaround wasn't working properly:

+ echo 'Enabling provisional autoconf 2.59 work-around. Update autoconf ASAP.'
Enabling provisional autoconf 2.59 work-around. Update autoconf ASAP.

FIX: update autoconf to 2.60 or newer. If Cygwin doesn't provide this version yet then build it yourself from extras/contrib.

Enter the following commands in your Cygwin shell:

cd vlc-trunk/extras/contrib

./bootstrap

cd src

make .autoconf

There should now be compiled autoconf version (probably 2.60 or newer) in extras/contrib that the bootstrap process will use.

Now start the whole "Compile VLC" process from the start again.

===Error: cannot create temporary file for diversion: Permission denied===

If the above error appears, it might mean you don't have the TMPDIR defined in cygwin. You will need to define it and have its value point to your temporary directory. You can use '''export TMPDIR="/cygdrive/c/temp"''' or any directory for it (/cygdrive/c/temp is same as C:\temp). If this doesn't help, make sure you run cygwin with admin rights (With Windows Vista, right click cygwin shortcut and select "Run as administrator"). Avira AntiVir might also cause issues to m4, so disabling it while ./bootstrap might help.

==Compiling faster==
Building VLC on Cygwin is really slow, but you can spend less time recompiling by using [http://ccache.samba.org/ ccache]. This software saves the files compiled with their compilation command, and output them if they were not changed and if the compilation command is the same as last build. It is really useful for frequent make clean && make. To use it, change the CC line in your configure script to:

CC="ccache gcc -mno-cygwin" CXX="ccache g++ -mno-cygwin" \

The first build after reconfiguring will be as slow as ever, but the following builds will be faster.

=Version=

20050627 Initial version

20050628 Updated some more exceptions

20050628 Some info added about FFmpeg compiling with AMR

20050629 Finalized FFmpeg compiling

20050630 Cross-compiling

20050724 Some extra compile explanations

20050726 Removed cross-compiling (was for linux -> win32) Patching source code with .diff files

20050823 Added zlib error

20050923 --enable-sdl --with-sdl-config-path=/usr/win32/bin added to configure. Added debug section

20051102 Changed FFmpeg lib names

20051128 Detailed Cygwin upgrade/downgrade for gcc 3.3. Renamed some update scripts. Added FFmpeg CVS update. --disable-gnomevfs added to configure (only used on linux)

20060121 PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig added to configure

20060128 Added curl and libtool to Cygwin for those that want to be able to build extras/contrib themselves

20060217 Added make install-libs install-headers to FFmpeg compile

20060222 Remark about missing "gettext" libs for Cygwin during install

20060225 ./bootstrap: you need libtool

20060618 Updated GCC to 3.4 version and added FFmpeg SVN and DTS support

20060805 Added note about using older binutils and gdb for Cygwin!

20060915 Added note about updating autoconf from extras/contrib for an OBJC problem during configure

20061108 Added note this document is no longer usable since Cygwin has been unusable probably related to some bash/dos2unix change

20070612 Added note about --enable-dca

20080228 New version by [[User:J-b|jb]]

20080307 Added --host=i686-pc-mingw32 option to the configure script

20080311 Simplification

20080323 Added some tips for Vista

20081001 git should now work from Cygwin again

20081010 expat has moved to under Libs

20081020 QT4 problems part added and new contrib suggestion

20081110 Mozilla plugin addition

20090104 sed command for gettext version change

20090210 JB contrib location added.

20090303 ranlib removed, it is a OPTIONAL STEP!

20090623 Mention 1.1.x support

20090926 Remove sed line (not needed anymore), add tips to 'ash', tell that version tools are optional, change lib order to alphabets

20091023 Add some more details how to checkout with git

20091028 Update the configure command to work fine for recent version 1.0.2

= See also =
*[[Win32CompileCygwinOld]] - deprecated documentation

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

Win32Compile

2011-12-01T17:18:42Z

Rogerdpack: /* Building VLC from source */

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation). If on windows you can do it on a virtual machine, via dual-boot or from another computer. ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, [[GetTheSource]] then run <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> helper script for cross compiling with mingw32 with the known contribs
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code> same for compiling with msys or cygwin
*<code>./configure --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> might work as well

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32Compile

2011-12-01T17:17:01Z

Rogerdpack: add link

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation) ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, [[GetTheSource]] then run <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> helper script for cross compiling with mingw32 with the known contribs
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code> same for compiling with msys or cygwin
*<code>./configure --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> might work as well

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32Compile

2011-12-01T03:29:16Z

Rogerdpack: /* Configuring the build */

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation) ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> helper script for cross compiling with mingw32 with the known contribs
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code> same for compiling with msys or cygwin
*<code>./configure --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> might work as well

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32Compile

2011-12-01T02:22:42Z

Rogerdpack: /* Building VLC */

How to compile VLC for Windows

== Before you start ==

One common desire that leads people to want to rebuild VLC is to "rebuild a debug version" or "add printf()s", but this is not strictly necessary, as VLC includes a debug logging feature by default. If you are using a binary release (or have already built VLC), just run <code>'vlc.exe'</code> and select "Messages..." from the "Tools" menu.

You can also run VLC from the Windows command-line interpreter, <code>cmd.exe</code> (a.k.a. "DOS window"), in which case you'll be able to use the command-line arguments. You can obtain a list of these command line arguments by typing <code>'vlc --help'</code> or <code>'vlc --help --advanced'</code>.

To store a debug log of the current VLC session, you can use <code>'vlc -vvv --extraintf=logger'</code>. You will end-up with a <code>vlc-log.txt</code> file in your current directory.

== Building VLC from source ==

If you want to build VLC from source, you have several choices:

{| class="wikitable"
|-
! Method
! Documentation
! Notes
|-
| Cross-compile with Mingw32 on Linux
| None: read this page
| '''Preferred''' method (uses cross compilation) ''Note: read [[Win32CompileFedora13]] if building on Fedora 13''
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Not recommanded''' native compilation method. MSYS is a minimal build environment to compile Unixish projects under Microsoft Windows. It provides all the commonly-required Unix tools (like sh, gmake, and so forth).
|}

== Obtaining the build tools ==

Each build method requires its own toolchain:

{| class="wikitable"
|-
! Method
! Notes
|-
| Cross-compile with mingw32 on GNU/Linux
|
*Debian/Ubuntu users can <code>apt-get install gcc-mingw32 mingw32-binutils</code>. <code>apt-get build-dep vlc</code> should download most of the needed libraries (according to the vlc version in the repositories), however building FFmpeg now requires mingw32-runtime >= 3.17 and w32api >= 3.13 so these might have to be updated manually. Install the lua compiler with <code>apt-get install lua5.1</code>.
*Gentoo users can <code>emerge crossdev && crossdev mingw32</code>
*Other systems may attempt http://www.mingw.org/wiki/LinuxCrossMinGW
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| Read the [[Win32CompileMSYSNew|documentation]]
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| Read the [[Win32CompileCygwinNew|documentation]]
|}

== 3rd party libraries. ==

VLC modules requires numerous open source projects to work (like AC3 audio decoding or MPEG-4 video decoding).

If you feel you must build these libraries from source, go to extras/contrib and read the README. 

If you want to save yourself a lot of time and energy, use the pre-built versions of these libraries. You may download them from http://people.videolan.org/~jb/Contribs/, named in fashion of contrib-'''yyyymmdd'''-win32-'''version'''-bin-gcc-'''gccversion'''-only.tar.bz2. 

Install the pre-built libraries into the standard directories (/usr/win32/*) by using 
<pre>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /
</pre>
(Note the <code>"-C /"</code>!)

== Configuring the build ==

First of all, <code>./bootstrap</code>.

Once you've got all the files you need in place, you need to configure the build with the <code>./configure</code> script.

Good examples can be found in some files (in [http://git.videolan.org/gitweb.cgi?p=vlc.git;a=tree git]). From the vlc source base directory run: 

*<code>extras/package/win32/configure.sh --with-contrib=/usr/win32 --host=i586-mingw32msvc</code> for cross compiling with mingw32
*<code>extras/package/win32/configure.sh --with-contrib=/path/to/folder/containing/contribs</code> for compiling with msys or cygwin

See <code>'./configure --help'</code> for more information.

== Building VLC ==

Once configured, to build VLC, just run <code>'make'</code>.

Once the compilation is done, you can either run VLC directly from the source tree or you can build self-contained VLC packages with the following <code>make</code> rules:

{| class="wikitable"
|-
! Command
! Description
|-
| <code>make package-win32-strip</code> (might be package-win-strip)
| Creates a subdirectory named <code>vlc-x.x.x</code> with all the binaries 'stripped' (that is, smallest size, unusable with a debugger)
|-
| <code>make package-win32-7zip</code>
| Same as above but will package the directory in a 7z file.
|-
| <code>make package-win32-zip</code>
| Same as above but will package the directory in a zip file.
|-
| <code>make package-win32</code>
| Same as above but will also create an auto-installer package. You must have NSIS installed in its default location for this to work.
|}

'''''Well done—you're ready to use VLC!'''''

[[Category:Building]]

Win32CompileMSYSNew

2011-12-01T01:52:05Z

Rogerdpack: no longer preferred I doubt...

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It can build VLC natively on Windows. Note that you could also [[Win32Compile|cross compile]] VLC from Linux, if desired (it is faster, and feels easier).

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

You can look at [http://sourceforge.net/projects/notepad2/ notepad2]. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

Or you can look at [http://notepad-plus-plus.org/ notepad++].

== Unzip Utility (7-zip) ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''the old version of mingw GCC (3.4.5) worked with VLC, because it uses SjLj exception unwinding. Any "vanilla" version 4.0+ by default uses dwarf2 exception unwinding, so isn't compatible with the contribs. So recommend installing TDM, below.''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.5.2.exe/download

Go through the wizard:

*uncheck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings

*afterwards check that C:\MinGW\bin is added to windows PATH (http://www.computerhope.com/issues/ch000549.htm)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma
*http://sourceforge.net/projects/mingw/files/MSYS/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

Note* Download the latest version inside this folders (Last tested to be OK is glib 2.28, non-dev version)):

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip
*http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime_0.18.1.1-2_win32.zip

=== Add pkg config path variable ===

Add the following line to the *top* of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run MSys
*type the following commands:

cd /home/<username>/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe *.dll /bin
cd ..

Alternatively you could download some "full lua" package, as long as it puts a luac.exe in your path you are good to go, for instance http://code.google.com/p/luaforwindows binaries.

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

Contribs are basically some precompiled 3rd party library (Here's a [[Contrib_Status|list]] of what they all are).

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page (just download the VLC repository--you don't need the x264 one) then skip the next section "Last Change"''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.x only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common (1.1.x only) ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by doing the following steps:
# ''download coreutils from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/coreutils, selecting any version (latter is normally better) then the file named like coreutils-5.97-2-msys-1.0.11-ext.tar.lzma (note '-ext' in file name) and extracting who.exe, whoami.exe, hostname.exe to C:/MSys/1.0/bin''
# ''download libintl dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/libiconv, selecting any version (latter is normally better) then the file named like libiconv-1.13.1-2-msys-1.0.13-dll-2.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''
# ''download libiconv dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/gettext, selecting any version (latter is normally better) then the file named like libintl-0.17-2-msys-dll-8.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto search button:
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

If you want any custom options, like "--disable-lua" or anything of that nature, you'll need to edit that file directly instead of passing them in as parameters (at least currently that is required).

== Make (compile) ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

If this step fails, try the following
* Go back to "Precompiled contribs" section, and obtain the latest compiled contrib (under "Note for the brave")
* In the configure script section (configure-msys.sh), open that file and add --disable-upnp

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

Note that with the 1.2 branch these names have changed slightly. Run '
grep ':' Makefile | grep package-win32
to see what they are now.

= Troubleshooting =

See [[Win32CompileMSYSTroubleShooting]].

= See also =
*[[Win32CompileMSYSOld]] - deprecated documentation

Win32CompileMSYSNew

2011-12-01T01:50:22Z

Rogerdpack: /* LUA tools */

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the '''fastest''' and '''recommended '''way to build VLC natively on Windows. Note that you could also [[Win32Compile|cross compile]] VLC from Linux, if desired (it is faster).

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

You can look at [http://sourceforge.net/projects/notepad2/ notepad2]. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

Or you can look at [http://notepad-plus-plus.org/ notepad++].

== Unzip Utility (7-zip) ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''the old version of mingw GCC (3.4.5) worked with VLC, because it uses SjLj exception unwinding. Any "vanilla" version 4.0+ by default uses dwarf2 exception unwinding, so isn't compatible with the contribs. So recommend installing TDM, below.''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.5.2.exe/download

Go through the wizard:

*uncheck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings

*afterwards check that C:\MinGW\bin is added to windows PATH (http://www.computerhope.com/issues/ch000549.htm)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma
*http://sourceforge.net/projects/mingw/files/MSYS/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

Note* Download the latest version inside this folders (Last tested to be OK is glib 2.28, non-dev version)):

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip
*http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime_0.18.1.1-2_win32.zip

=== Add pkg config path variable ===

Add the following line to the *top* of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run MSys
*type the following commands:

cd /home/<username>/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe *.dll /bin
cd ..

Alternatively you could download some "full lua" package, as long as it puts a luac.exe in your path you are good to go, for instance http://code.google.com/p/luaforwindows binaries.

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

Contribs are basically some precompiled 3rd party library (Here's a [[Contrib_Status|list]] of what they all are).

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page (just download the VLC repository--you don't need the x264 one) then skip the next section "Last Change"''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.x only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common (1.1.x only) ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by doing the following steps:
# ''download coreutils from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/coreutils, selecting any version (latter is normally better) then the file named like coreutils-5.97-2-msys-1.0.11-ext.tar.lzma (note '-ext' in file name) and extracting who.exe, whoami.exe, hostname.exe to C:/MSys/1.0/bin''
# ''download libintl dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/libiconv, selecting any version (latter is normally better) then the file named like libiconv-1.13.1-2-msys-1.0.13-dll-2.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''
# ''download libiconv dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/gettext, selecting any version (latter is normally better) then the file named like libintl-0.17-2-msys-dll-8.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto search button:
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

If you want any custom options, like "--disable-lua" or anything of that nature, you'll need to edit that file directly instead of passing them in as parameters (at least currently that is required).

== Make (compile) ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

If this step fails, try the following
* Go back to "Precompiled contribs" section, and obtain the latest compiled contrib (under "Note for the brave")
* In the configure script section (configure-msys.sh), open that file and add --disable-upnp

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

Note that with the 1.2 branch these names have changed slightly. Run '
grep ':' Makefile | grep package-win32
to see what they are now.

= Troubleshooting =

See [[Win32CompileMSYSTroubleShooting]].

= See also =
*[[Win32CompileMSYSOld]] - deprecated documentation

Win32CompileMSYSNew

2011-11-30T20:52:30Z

Rogerdpack: I think this is right :P

= Introduction =

== About ==

MSys is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the '''fastest''' and '''recommended '''way to build VLC natively on Windows. Note that you could also [[Win32Compile|cross compile]] VLC from Linux, if desired (it is faster).

VLC is a complex program with many dependencies, so minimal command-line experience is required. Also, don't be in a hurry (2 hours is a minimum for the whole process) and don't despair if it doesn't work first time.

== On the edge vs Conservative ==

This update aims at building versions from the 1.1.0 branch natively in the most straightforward way.

Of course, if you want to live on the edge, feel free to select more recent versions of the proposed tools, contribs or sources, but the build has only been thoroughly validated with the versions indicated in the main text flow.

:''Such alternative ways are indented, italicized and marked "Note for the brave" :-). Your mileage may vary''

== Acknowledgements ==

This howto was re-created by [[User:J-b|Jean-Baptiste Kempf]] and updated in June 2009, September 2009, December 2009 and March 2010.

It was updated in June 2010 by Vicne with the help of J-b, gnosygnu and MichaelMc

= Windows tools needed =

== Text editor ==

To edit unix-style text documents you need a suitable editor.

You can look at [http://sourceforge.net/projects/notepad2/ notepad2]. You can set File - Line endings - Default to "Unix (LF)", but it always saves opened files in the ending style they have.

Or you can look at [http://notepad-plus-plus.org/ notepad++].

== Unzip Utility (7-zip) ==

Many files to downloaded will have to be uncompressed. As most of them use Linux-originated formats (.tar.gz, .tar.bz2, .tar.lzma), you will need a versatile unzipping utility. A recent version of [http://www.7-zip.org/ 7-zip] is therefore strongly advised.

Please note that most archives contain directory structures. Unless otherwise stated, you have to merge the contents with the existing dirs

= GNU Windows Environment =

Before installing, ensure your Windows user name does not contain spaces (VLC will not build in a folder with spaces in it). If it does, please create another user on your system.

In the following text, we'll refer to this user name as "<username>". Replace it appropriately where needed of course.

== MinGW ==

:''the old version of mingw GCC (3.4.5) worked with VLC, because it uses SjLj exception unwinding. Any "vanilla" version 4.0+ by default uses dwarf2 exception unwinding, so isn't compatible with the contribs. So recommend installing TDM, below.''

=== TDM/MinGW Setup ===

Use the installer found at http://sourceforge.net/projects/tdm-gcc/files/TDM-GCC%20Installer/tdm-gcc-4.5.2.exe/download

Go through the wizard:

*uncheck "Check for updated files..."
*Select "Create"
*install to C:\MinGW
*keep default settings

*afterwards check that C:\MinGW\bin is added to windows PATH (http://www.computerhope.com/issues/ch000549.htm)

=== MinGW utils ===

Installing mingw-utils is recommended: http://prdownloads.sourceforge.net/mingw/mingw-utils-0.3.tar.gz

Extract contents to c:\MinGW

== MSys ==

=== MSys Setup ===

Use the installer found at http://sourceforge.net/project/downloading.php?group_id=2435&filename=MSYS-1.0.11.exe

Go through the wizard and install to to default C:\Msys\1.0

In the command window that opens, answer questions as follows:

Accept Post Install: [y]
MinGW Installed? : [y]
path to MinGW: [c:/MinGW]

=== MSys Developer Toolkit ===

Use the installer found at http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe

Go through the wizard, keeping default values

=== AutoTools and libcrypt ===

Update autoconf, automake, libtool as well as libcrypt by downloading the following files and extracting them to C:\Msys\1.0:

*http://sourceforge.net/projects/mingw/files/MSYS/autoconf/autoconf-2.63-1/autoconf-2.63-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/automake/automake-1.11-1/automake-1.11-1-msys-1.0.11-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/libtool/libtool-2.2.7a-1/libtool-2.2.7a-1-msys-1.0.11-bin.tar.lzma/download
*http://prdownloads.sourceforge.net/mingw/libcrypt-1.1_1-2-msys-1.0.11-dll-0.tar.lzma
*http://sourceforge.net/projects/mingw/files/MSYS/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download

=== Glib and PKG-CONFIG ===

Similarly, download the following files and extract them to C:\MSys\1.0:

Note* Download the latest version inside this folders (Last tested to be OK is glib 2.28, non-dev version)):

*http://ftp.gnome.org/pub/GNOME/binaries/win32/glib
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config_0.23-3_win32.zip
*ftp://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-dev_0.23-3_win32.zip
*http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/gettext-runtime_0.18.1.1-2_win32.zip

=== Add pkg config path variable ===

Add the following line to the *top* of C:\MSys\1.0\msys.bat:

set PKG_CONFIG_PATH=/win32/lib/pkgconfig

=== Fix libtool search dirs ===

Open C:\MSys\1.0\bin\libtool and change line 9926 by appending ' /mingw/lib' to the end of 'compiler_lib_search_dirs'. The line should then read :

compiler_lib_search_dirs="/usr/lib /usr/lib /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1 /bin/../lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /usr/lib/gcc-lib/i686-pc-msys/2.95.3-1/../../../../i686-pc-msys/lib /mingw/lib"

== LUA tools ==

VLC uses the LUA scripting language (See [http://www.lua.org lua.org]). Unfortunately, no binaries are provided so you need to compile them.

*Download the lua tools package from http://www.lua.org/ftp/lua-5.1.4.tar.gz
*Uncompress it in your home folder (C:\MSys\1.0\home\<username>)
*run MSys
*type the following commands:

cd /home/<username>/lua-5.1.4
make mingw

This should produce lua.exe, luac.exe and lua51.dll in the src directory. Put these in your /bin with the commands:

cd src
cp *.exe *.dll /bin
cd ..

Alternatively you could download some "full lua" package, as long as it puts lua.exe in your path you are good to go.

= Precompiled contribs =

:''Note for the brave : Alternatively, you can get the latest contrib from :http://people.videolan.org/~jb/Contribs/''

*download the file http://people.videolan.org/~jb/Contribs/contrib-20100608-win32-bin-gcc-4.4.4-runtime-3.17-only.tar.bz2
*extract it to C:\MSys\1.0 '''but without the /usr path'''. For example, one of the resulting files should be:

C:\MSys\1.0\win32\lib\libdvdnav.a

Contribs are basically some precompiled 3rd party library (Here's a [[Contrib_Status|list]] of what they all are).

= VLC sources =

:''Note for the brave : This section lists the steps for VLC version 1.1.0rc3. Alternatively, you could get the latest sources from the development tree using GIT. It's not as difficult as it looks to do so. If you want chose that route, please follow instructions on the [[Git Windows]] page (just download the VLC repository--you don't need the x264 one) then skip the next section "Last Change"''

== Base: VLC version 1.1.0rc3 ==

*download the file http://download.videolan.org/pub/videolan/testing/vlc-1.1.0-rc3/vlc-1.1.0-rc3.tar.bz2
*extract it to C:\MSys\1.0\home\<username>
*rename the vlc-1.1.0rc3 dir to vlc

== add missing configure-msys (1.1.x only)==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-msys.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-msys.sh

== add missing configure-common (1.1.x only) ==
* Download http://git.videolan.org/?p=vlc.git;a=blob_plain;f=extras/package/win32/configure-common.sh;hb=HEAD
* Save it (not using proposed name) as C:\msys\1.0\home\<username>\vlc\extras\package\win32\configure-common.sh

= Last change : whoami and hostname =

Whoami is not available on Windows, and hostname doesn't support the -f option used by the build process. These utilities are used to show the name and computer of the person who compiled VLC in the 'About' box.

:''Note for the brave : the steps below are file changes so that compile works, but an alternative is to download and install GNU whoami and hostname functionality. This can be achieved by doing the following steps:
# ''download coreutils from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/coreutils, selecting any version (latter is normally better) then the file named like coreutils-5.97-2-msys-1.0.11-ext.tar.lzma (note '-ext' in file name) and extracting who.exe, whoami.exe, hostname.exe to C:/MSys/1.0/bin''
# ''download libintl dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/libiconv, selecting any version (latter is normally better) then the file named like libiconv-1.13.1-2-msys-1.0.13-dll-2.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''
# ''download libiconv dll from http://sourceforge.net/projects/mingw/files/MSYS/BaseSystem/gettext, selecting any version (latter is normally better) then the file named like libintl-0.17-2-msys-dll-8.tar.lzma (note '-dll' in file name) and extracting dll in C:/MSys/1.0/bin''

== Whoami ==

Create a new file containing the single line:

echo '<username>'

and save it as C:\MSys\1.0\bin\whoami (without any extension)

== Hostname ==

Modify configure.ac so that it doesn't call 'hostname -f' as follows:

*open C:\MSys\1.0\home\<username>\vlc\configure.ac
*goto search button:
*change it as follows:

old: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])
new: AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])

= Build VLC =

The build is made exclusively from the command line, so if you closed the prompt at the LUA step, re-execute C:\MSys\1.0\msys.bat, then type the commands as mentioned

== Bootstrap ==

cd vlc
cp -v /usr/win32/share/aclocal/* m4/
cp -v /usr/share/aclocal/* m4/
PATH=/usr/win32/bin:$PATH ./bootstrap

== Configure ==

sh extras/package/win32/configure-msys.sh

If you want any custom options, like "--disable-lua" or anything of that nature, you'll need to edit that file directly instead of passing them in as parameters (at least currently that is required).

== Make (compile) ==

Note : If your <username> starts with the "u" or "x" character, change C:\MSys\1.0\home\<username>\config.h and double all backslashes in VLC_COMPILED_BY constant.

Type the following command :

PATH=/usr/win32/bin:$PATH make

If this step fails, try the following
* Go back to "Precompiled contribs" section, and obtain the latest compiled contrib (under "Note for the brave")
* In the configure script section (configure-msys.sh), open that file and add --disable-upnp

== Create self-contained packages ==

Once the compilation is done, build self-contained VLC packages with one of the following "make" commands:

make package-win32-base

(This will create a subdirectory named vlc-x.x.x with all the binaries "stripped" without any debugging symbols).

make package-win32-zip

(Same as above but will package the directory in a zip file).

make package-win32

(Same as above but will also create an auto-installer package. You will need to have NSIS installed in its default location for this to work).

make package-win32-base-debug

(This will create a subdirectory named vlc-x.x.x with all the binaries containing debug info usable by gdb).

Note that with the 1.2 branch these names have changed slightly. Run '
grep ':' Makefile | grep package-win32
to see what they are now.

= Troubleshooting =

See [[Win32CompileMSYSTroubleShooting]].

= See also =
*[[Win32CompileMSYSOld]] - deprecated documentation

Documentation:Modules/logo

2011-08-12T03:18:29Z

Rogerdpack:

{{Module|name=logo|type=Video subfilter|description=Overlays a logo on the video}}
{{Module|name=logo|type=Video output filter|description=Overlays a logo on the video}}

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

== Options ==

{{Option
|name=logo-file
|value=string
|description=Image to display. The full format is <image>[,<delay in ms>[,<alpha>]][;<image>[,<delay>[,<alpha>]]][;...]}}

{{Option
|name=logo-x
|value=integer
|default=0 (0.8.6d and prior: -1)
|description=X offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
}}

{{Option
|name=logo-y
|value=integer
|default=0
|description=Y offset from upper left corner. (0.8.6d and prior: This is only if both logo-x and logo-y are positive)
}}

{{Option
|name=logo-position
|value=integer
|default=5
|description=Logo position: 0=center, 1=left, 2=right, 4=top, 8=bottom, you can also use combinations of these values, eg 6 = top-right. (0.8.6d and prior: This is only used if logo-x or logo-y are negative)
}}

{{Option
|name=logo-opacity
|value=integer
|default=255
|description=Logo opacity. 0 is transparent, 255 is fully opaque.
}}

{{Option
|name=logo-delay
|value=integer
|default=1000
|description=Global delay in ms. Sets the duration each image will be displayed for in a loop iteration unless specified otherwise in the --logo-file option.
}}

{{Option
|name=logo-repeat
|value=integer
|default=-1
|description=Number of loops for the logo animation. -1 for continuous, 0 to disable.
}}

== Examples ==

Example command line use '''(VLC 0.9.0 and above)''':
% '''vlc --sub-filter "logo{file=cone.png,transparency=128}" somevideo.avi'''
: This command will display image cone.png in the video's upper right corner with 50% transparency.

% '''vlc --sub-filter "logo{file='cone1.png,2000,128;cone2.png,3000'}" somevideo.avi'''
: This command will display image cone1.png for 2 seconds with 50% transparency followed by image cone2.png for 3 seconds at default transparency and loop.

Example command line '''(All versions including VLC 8.6d and prior)''':
% '''vlc --sub-filter=logo --logo-file=cone.png --logo-transparency=128 somevideo.avi'''

See also [[How_to_add_logo]]

{{Stub}}

{{Documentation}}

[[Category:Video Filters]]

VLC HowTo/Add a logo

2011-08-12T03:17:51Z

Rogerdpack:

{{howto|add a logo on your video using the logo filter}}

= Idea =
This How To just explains how to use the logo filter in order to add a logo on your videos, like a TV.

== Local ==
vlc --sub-filter logo --logo-file ''logo.png'' ''video.avi''

== Stream ==
vlc --logo-file ''logo.png'' ''video.avi'' --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:std{...}"

Make sure you do not specify --sub-filter logo, and that you specify a vcodec= value in the transcode part.

== Save the new video locally ==
vlc --logo-file ''logo.png'' ''video.avi'' --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:std{access=file,dst=''new_video.avi'' }

== Dynamically change logo using [[Console | RC]], then send output to stream and local debugging display ==

vlc -I rc --logo-file nonexistent_dummy.png --sout "#transcode{vcodec=...,vb=...,sfilter=logo}:duplicate{dst=display,dst=std{...}}"

# Once the program has started
add ''video.avi''
# If using VLC 0.8.6 or older:
logo-file ''logo.png''
# If using VLC 0.9.0 or newer (see NEWS for details about the new syntax):
@logo logo-file ''logo.png''

This requires a <code>--logo-file</code>, but for some reason it won't work if you specify "<code>--sub-filter logo</code>". Nor does it apparently work if the <code>transcode</code> doesn't specify <code>[[Codec#Video_Codecs | vcodec=]]</code>.

A non-existent logo-file currently removes any logos from the video, and does not result in an error. Since you must specify one on the command-line, "<code>nonexistent_dummy.png</code>" was used.

= Troubleshooting =

== My text doesn't look right! It's sort of pixellated or has artifacts. ==

Sounds like a stretching or deinterlacing problem. One possible solution is to set your "<code>--aspect-ratio</code>" to the right setting. For instance, I got this when I ran VLC with "<code>-vvv</code>" (for verbose verbose verbose output):

[00000372] main video output debug: picture in 704x576 (0,0,704x576), chroma I420, ar 4:3, sar 12:11
[00000372] main video output debug: picture user 704x576 (0,0,704x576), chroma I420, ar 4:3, sar 12:11
[00000372] main video output debug: picture out 768x576 (0,0,768x576), chroma RV32, ar 4:3, sar 1:1

Here, the input was 704x576 resolution and VLC outputted it to 768x576. My text was added before this stretching occurred, and so the text looked awful. Forcing it back to the normal resolution using "<code>--aspect-ratio 11:9</code>" worked. (Because 704/576 = 11:9.)

See also [[Documentation:Modules/logo]].

Note also that setting the logo on the command line appears to be a "global" option and not available as stream specific.

WAVE

2011-08-05T00:37:35Z

Rogerdpack:

{{mux|id=wav|encoder=y}}

'''WAVE''' is a way of storing audio, which is normally uncompressed. It is based on [[RIFF]]. Note that wav isn't a streamable audio format, so you can only stream it using rtp (to stream it otherwise, transcode it to something that's streamable).

== Accepted audio codecs ==
* [[dummy]]: Uncompressed audio of various types, based on storing integer values of the amplitude of the sound (see [[wikipedia:PCM|PCM]]).
* [[fl32]]: Floating point 32-bit uncompressed audio, also based on PCM but allowing the values to be stored as floating point data types. This can give better quality audio when the sound becomes quiet.

== Converting to WAVE ==

The commandline for converting any readable input file to a WAVE audio file is the following:

vlc -I dummy -vvv "input.mp3" --sout=#transcode{acodec=s16l,channels=2,ab=128,samplerate=44100}:standard{access=file,mux=wav,dst="output.wav"} vlc://quit

Where on Windows you need to add installation directory in front of vlc (e.g. "C:\Program Files\VideoLAN\VLC\vlc").

As audio codec (acodec) you can specify one of the above mentioned ones. The bitrate of the output file is specified by the ab parameter.

== Source code ==
{{file|modules/mux/wav.c|output muxer}}
{{file|modules/demux/wav.c|input demuxer}}

Transcode

2011-08-05T00:27:36Z

Rogerdpack: /* Compatibility issues */

Transcoding is the process of taking a video file and changing it to a different format or bitrate.

Transcoding in VLC copies the movie to a new file in a different format, so you end up with both the original and new files. This means you need to have enough space on your hard drive to store this extra file. You should also have a reasonably fast computer, as transcoding can be very slow.

In VLC, transcoding is exactly the same as [[streaming]] accross a network, except that the output is sent to a file instead of a network.

== Compatibility issues ==

If your input streams already matches the encoding that you desire for your output stream, then you don't have to transcode at all (just leave out the transcode settings on the command line, and it will thence not transcode). In the GUI this is called "keep the original track" (I think).

Note that when you decide your transcoding settings, only some container formats (muxers) can support some codecs - look at [http://www.videolan.org/streaming/features.html streaming features] compatibility matrix to see which supports what. If your current format is incompatible with the muxer you desire, then you must transcode it to something compatible, or choose a different muxer. If you choose an incompatible stream for a given muxer, it may silently fail. You can look for error messages in the [[Basic_Troubleshooting|messages window]] to help you debug the failures.

== Transcoding with the Wizard ==

VLC includes a transcoding and streaming wizard. To transcode a file, just select the transcode option. You will then be asked what format to convert to: you can give a video [[codec]], an audio codec and a [[container]] format.

See also {{doc|http://www.videolan.org/doc/streaming-howto/en/ch02.html}}

== Transcoding with the Command Prompt ==

The most flexible way to transcode with vlc is using a [[command prompt]] to start vlc. Transcoding works the same as [[streaming]]. For example, the following command changes an [[asf]] file to an [[MPEG-2]] file:
:vlc "C:\Movies\Your File.asf" :sout='#transcode{vcodec=mp2v,vb=4096,acodec=mp2a,ab=192,scale=1,channels=2,deinterlace,audio-sync}:std{access=file, mux=ps,dst="C:\Movies\Your File Output.ps.mpg"}'
The access=file instructs vlc to store the output in a file (and not stream it), and the dst is the location of the new (output) file.

* Note 1: If you are running VLC on [[Mac OS X]], you should use clivlc instead of VLC to avoid possible Bus error problems.
* Note 2: old VLC releases, maybe up to 0.8.6* included, use "url" instead of "dst".

Transcoding takes quite a while, so it's advisable to use an option like '''--stop-time=30''' to only encode the first 30 seconds - this means you can check the file has transcoded correctly, and that the output is of a suitable quality. (Note: On [[Mac OS X]] this trick doesn't seem to work. Just press ctrl-c after a while, VLC will properly write out the already transcoded segment)

The transcode statement can contain '''vcodec''' and '''vb''' to change the video codec and '''acodec''' and '''ab''' to change the audio codec. If vcodec is missing, the video codec will stay the same (same for acodec).

Common additional options to use are '''audio-sync''' (to make sure the audio is in sync correctly) and '''deinterlace''' (to increase quality slightly on interlaced video).
===Under MS Windows===
the syntax on windows is slightly different:

:C:\Program Files\VideoLAN\VLC>vlc -vvv "D:\688497.flv" --sout=#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:standard{access=file,mux=ts,dst="D:\asd.mpg"}
(Note: old VLC releases, maybe up to 0.8.6* included, use "url" instead of "dst")

(Note: due to command line parsing, at times, especially within single and double quote blocks, a backslash may have to be escaped by using a double backslash so that a filename would be D:\\path\\to\\file.mpg)

===Completely non-interactive transcoding===
For completely non-interactive transcoding (such as the case necessary when running under [[Mac OS X]]), the above example could be rewritten as
:vlc -I dummy "C:\Movies\Your File.asf" :sout='#transcode{vcodec=mp2v,vb=4096,acodec=mp2a,ab=192,scale=1,channels=2,deinterlace,audio-sync}:std{access=file, mux=ps,dst="C:\Movies\Your File Output.ps.mpg"}' vlc://quit
The two extra options are
;-I dummy: Disables the graphical interface
;<nowiki>vlc://quit</nowiki>: Quit VLC after transcoding
If transcoding from a DVD, it is also necessary to use the dvdsimple:// notation instead of the dvd:// notation, in order to avoid interacting with the DVD menu system. You can use this in the GUI by choosing 'no DVD menus' option when opening the disc. See [[Rip_DVD]]

{{doc|http://www.videolan.org/doc/streaming-howto/en/ch03.html}}

== Canvas and Padding ==
'''The canvas and padding options changed since Version 0.9. Most examples in the wiki are broken.'''

<pre>transcode{vcodec=mp2v,vfilter=canvas{width=640,height=480}}</pre>

Other options:
* aspect=4:3 : Aspect ratio
* padd:
** true: Pad with black bars
** false: crop video

<pre>transcode{vcodec=mp2v,vfilter=croppadd{cropttop=20,cropbottom=30,paddleft=100}}</pre>

crop or pad top, left, right or bottom in pixels.

Avoid using width and hight parameters! These are apllied before the vfilter and might result in unwanted results.

== Non-Interactive Batch Transcoding (Windows)==
=== Batch File ===
To transcode several files without user interaction create a batch file in the folder where the files are contained and this line to the batch file:

<pre>
for %%a in (*.FILE_EXT) do cmd /c "PATH_TO_VLC" -I dummy -vvv %%a --sout=#transcode{vcodec=VIDEO_CODEC,vb=VIDEO_BITRATE,scale=1,acodec=AUDIO_CODEC,ab=AUDIO_BITRATE,channels=6}:standard{access=file,mux=MUXER,dst=%%a.OUTPUT_EXT} vlc://quit
</pre>

* note: if the line above creates "double file name extensions" like<tt> *.FILE_EXT.OUTPUT_EXT </tt>(e.g.<tt> *.mp3.wav </tt>when converting mp3 to wav), try:
<pre>... dst=OUTPUT_PATH\%%~na.OUTPUT_EXT ...</pre>
<tt>%%~na </tt>is the file name of <tt>%%a</tt> only without extension.

<tt>Cmd /c </tt>makes the script wait to finish transcoding before starting the next transcode.

* Example: to convert all mp3-files in the current directory to standard uncompressed wav-files (PCM; may be suitable if you want to burn audio-cds and your player is unable to play *.mp3-files), type

<pre> for %%a in (*.mp3) do cmd /c "C:\Programme\VideoLAN\VLC\vlc.exe" -I dummy -vvv %%a --sout #transcode{acodec=s16l,channels=2,samplerate=44100}:standard{access=file,mux=wav,dst=g:\_audio_conv\%%a.wav} vlc://quit</pre>

=== VB Script ===
An alternative method is to use VB Script. This example will transcode all files from one folder to another. It will also wait for each file to finish transcoding before starting the next. Create the script transcode.vbs, in the VLC installation folder, default "C:\Program Files\VideoLAN\VLC". Change the strSource and strTarget in the example to match your requirements. Start a "DOS Box", Start - Run - cmd then change to the VLC folder and run the script "cscript transcode.vbs".

This example was tested on Microsoft Windows Script host 5.6 running on XP Pro SP2

<pre>
'
' based on code from:http://episteme.arstechnica.com/eve/forums/a/tpc/f/12009443/m/516001349831
'
'
'
Dim objFSO, objShell, strSource, strTarget, strOldName, strNewName
'
set objFSO = CreateObject("Scripting.FileSystemObject")
'
' Set up starting folders
'
strSource = "O:\"
strTarget = "N:\"
'
call RecurseDir(strSource, strTarget)
'
' // Recursively copy all files and folders
'
Sub RecurseDir(strSource, strTarget)
wscript.echo "source: " & strSource & " target: "& strTarget
'
Dim strTempSource, strTempTarget
'
Set strTempSource = objFSO.GetFolder(strSource)
'
Wscript.Echo "Begin Value: " & strTarget
'
If Not objFSO.FolderExists(strTarget) Then
' Wscript.Echo "No Folder! Creating folder [" & strTarget & "]"
objFSO.CreateFolder(strTarget)
Else
Wscript.Echo "Folder exists! " & strTempTarget
End If
'
Set strTempTarget = objFSO.GetFolder(strTarget)
' ** Copy files from current directory to target
For each file in strTempSource.files
strOldName = strSource & "\" & file.name
strNewName = strTempTarget & "\" & Mid(file.name, 1, InstrRev(file.name, ".")) & "ts"
'
If Not objFSO.FileExists(strNewName) Then
Set objShell = CreateObject("WScript.Shell")
'
Wscript.Echo "Transcoding file: " & strOldName & " to " & strNewName
'
Select Case Right(strOldName, 3)
Case "avi"
wscript.echo "vlc file://""" & strOldName & """ :sout=#duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit"
objShell.Run "vlc file://""" & strOldName & """ :sout=#duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit", 1, True
Case "mp4"
wscript.echo "vlc file://""" & strOldName & """ :sout=#transcode{vcodec=mp2v,vb=1024,scale=1,acodec=mp2a,ab=192,channels=2}:duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit"
objShell.Run "vlc file://""" & strOldName & """ :sout=#transcode{vcodec=mp2v,vb=1024,scale=1,acodec=mp2a,ab=192,channels=2}:duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit", 1, True
End Select
'
Set objShell = Nothing
End If
Next
' ** For each subfolder of current dir, copy files to target and recurse its subdirs
For each subdir in strTempSource.subfolders
Wscript.Echo subdir.path
call RecurseDir(subdir.path, strTempTarget & "\" & subdir.name)
Next
End Sub
</pre>

== Non-Interactive Batch Transcoding (Linux)==
To transcode several files without user interaction create a bash script in the folder where the files are contained and add these lines to the bash script:

<pre>
#!/bin/bash
vcodec="VIDEO_CODEC"
acodec="AUDIO_CODEC"
bitrate="VIDEO_BITRATE"
arate="AUDIO_BITRATE"
ext="OUTPUT_EXT"
mux="MUXER"
vlc="PATH_TO_VLC"
fmt="INPUT_EXT"

for a in *$fmt; do
$vlc -I dummy -vvv "$a" --sout "#transcode{vcodec=$vcodec,vb=$bitrate,acodec=$acodec,ab=$arate,channels=6}:standard{mux=$mux,dst=\"$a.$ext\",access=file}" vlc://quit
done
</pre>

===Non-Interactive Merge/Transcode (Windows)===

If you have more than one source files that need to be merged and transcoded resulting in a single out put file, see [[How_to_Merge_and_Transcode_Multiple_Videos]]

===Example script===
'''The canvas and cropping must be adjusted for VLC versions newer then 0.9.'''

As an example, here is a bash script that will take a <tt>.mpg</tt> file as generated by an DVB capture device and transcode it into an MPEG4 file using the h.264 codec. Copy it to a file, for example <tt>dvb2mp4</tt>, and make it executable. It should work on any operating system that has bash, including windows if [http://www.cygwin.com Cygwin] is installed. It uses the cropping parameters proposed at [[Wikipedia:Overscan_amounts]] adapted so that the dimensions are divisible by 16 for better encoding.

<pre>
#!/bin/bash
#
# Transcode DVB TV signals to h.264-encoded MP4 files using VLC
# Wout.Mertens@gmail.com

#### Defaults, please edit for your settings ####

# VLC location, here is the Mac OS X example
VLC=/Applications/VLC.app/Contents/MacOS/clivlc
# Other possibilities: (Remove the # to activate)
#VLC=/usr/bin/vlc
#VLC=/usr/local/bin/vlc

# 16:9 or 4:3
aspect=16:9

# PAL (Europe) or NTSC (US)
src=PAL

# video bitrate
bitrate=1024

# audio bitrate
arate=128

# cropping?
crop=yes

# Deinterlace?
deint=yes

#### Program, do not change below this line ####
usage() {
cat 1>&2 <<EOF
Usage: $0 [-swpncC] [-b <rate>] [-a <rate>] <DVB source .mpg> <MP4 output file>
-s 4:3 aspect ratio (default=$aspect)
-w 16:9 aspect ratio
-p PAL (720x576) input (default=$src)
-n NTSC (720x480) input
-c Crop borders (default=$crop)
-C Do not crop borders
-d Perform de-interlacing (default=$deint)
-D Do not perform de-interlacing
-b video bitrate kb/s (default=$bitrate)
-a audio bitrate kb/s (default=$arate)
EOF
exit 1
}

error() {
echo "ERROR: $*" 1>&2
exit 2
}

while getopts 'swpncCb:a:h' opt; do
case $opt in
s) aspect=4:3 ;;
w) aspect=16:9 ;;
p) src=PAL ;;
n) src=NTSC ;;
c) crop=yes ;;
C) crop=no ;;
d) deint=yes ;;
D) deint=no ;;
b) bitrate=$OPTARG ;;
a) arate=$OPTARG ;;
h) usage ;;
*) echo "Unknown option $opt" 1>&2; usage ;;
esac
done
shift $(( $OPTIND - 1 ))

[ $# -ne 2 ] && usage

infile="$1"
outfile="$2"
case $outfile in
*.mp4|*.MP4) : ;;
*) outfile="$outfile.mp4" ;;
esac

[ -r "$infile" ] || error "Can't read from $infile"

case "$src,$aspect,$crop" in
PAL,16:9,yes) sizestr="cropleft=31,cropright=31,croptop=16,cropbottom=16,width=960,height=544" ;;
PAL,4:3,yes) sizestr="cropleft=31,cropright=31,croptop=16,cropbottom=16,width=720,height=544" ;;
NTSC,16:9,yes) sizestr="cropleft=30,cropright=30,croptop=17,cropbottom=17,width=800,height=448" ;;
NTSC,4:3,yes) sizestr="cropleft=26,cropright=26,croptop=17,cropbottom=17,width=608,height=448" ;;
PAL,16:9,no) sizestr="width=1024,height=576" ;;
PAL,4:3,no) sizestr="width=768,height=576" ;;
NTSC,16:9,no) sizestr="width=800,height=448" ;;
NTSC,4:3,no) sizestr="width=608,height=448" ;;
*) error "Could not handle $src,$aspect,$crop. This shouldn't happen!" ;;
esac

if [ "$deint" = "yes" ]; then
deintstr=",deinterlace=enable"
else
deintstr=
fi

# Let's do it
echo "Input file: $infile"
echo "Output file: $outfile"
echo "Encoding at $bitrate+$arate kb/s, input $src, $aspect, cropping $crop, de-interlace $deint"
echo
echo '>>>' $VLC -I dummy "$infile" --sout "#transcode{$sizestr$deintstr,vcodec=h264,vb=$bitrate,acodec=mp4a,ab=$arate}:standard{mux=mp4,dst=\"$outfile\",access=file}" vlc://quit
echo
$VLC -I dummy "$infile" --sout "#transcode{$sizestr$deintstr,vcodec=h264,vb=$bitrate,acodec=mp4a,ab=$arate}:standard{mux=mp4,dst=\"$outfile\",access=file}" vlc://quit
</pre>

[[Category:Glossary]]

Subversion

2011-07-22T15:35:08Z

Rogerdpack: /* Projects on VideoLAN's SVN */

== Introduction to SVN ==
Some VideoLAN's repositories are using [http://subversion.tigris.org/ Subversion], which is a classical VCS, like CVS.
It also provides a better control over the repository compared to CVS.

Note that some project, like {{VLC}} or x264 are using Git. You can read more about VideoLAN's git repository in our [[Git|Git wiki page]].

Currently the Subversion repositories are hosted on one of the [[VideoLAN Servers]].

=== How to use it ===
To use it, you have to download the [http://subversion.tigris.org/ official command line Subversion client]. You can also use alternative clients, such as the graphical [http://tortoisesvn.tigris.org/ TortoiseSVN] for Windows.

When using [[Cygwin]] as compilation environment it is recommended to use the SVN package that comes with it (using the Cygwin setup). Using an "external" SVN application might otherwise cause problems with so called DOS versus UNIX "line endings" when creating files.

Subversion's command-line interface is generally pretty similar to CVS. This is a '''basic''' and partial guide of the most useful commands. For a complete guide, use the book [http://svnbook.red-bean.com/en/1.2/index.html Version Control with Subversion]. If you have a write access to the server, it's very recommended that you read it and know about the advanced features of Subversion, because you might use them sooner or later.

== Anonymous use ==
If you don't have a write access to the repository, you have to access it anonymously, via regular SVN. However, most of the techniques shown here may be useful also for developer use, so please read it even if you don't have to access the server anonymously.

=== Check out ===
First, you have to check out the code of libdvbpsi. Use the following syntax:
{{%}} <nowiki>svn checkout svn://svn.videolan.org/libdvbpsi/trunk libdvbpsi-trunk</nowiki>

You can browse the code structure using on the [http://svn.videolan.org SVN webviewer]
Use the three folders there for different purposes:
* {{SVNSourceFile|name=trunk|repo=libdvbpsi}} is the main development branch.
* The {{SVNSourceFile|name=branches|repo=libdvbpsi}} are used for stable versions and for the development of complex features.
* The {{SVNSourceFile|name=tags|repo=libdvbpsi}} are used to track the released versions.

The URL structure is:

; transport : svn://svn.videolan.org
; project repository : /libdvbpsi
; branch/tag : /trunk, or /branches/0.8.6, or /tags/0.8.5
; files : /README

You can also checkout a portion of the SVN using the URL.

'''Don't leave off the "trunk" or branch part!''' If you leave that off you check out every revision of every file in the repo, which is pretty silly.

=== Projects on VideoLAN's SVN ===

* '''svn://svn.videolan.org/vls''': VideoLAN Server (deprecated and unmaintained : {{VLC}} can now do the same);
* '''svn://svn.videolan.org/libdvdcss''': library for decrypting DVDs, used by {{VLC}} and VLS;
* '''svn://svn.videolan.org/libdvdplay''': library for DVD navigation, (deprecated) once used by {{VLC}}, not it uses libdvdnav from mplayer, with a few internal patches;
* '''svn://svn.videolan.org/libdvbpsi''': library for parsing Program Specific Information from MPEG and DVB streams, used by VLC and VLS;
* '''svn://svn.videolan.org/videolan/www.videolan.org''': the website (no trunk or branches);
* '''svn://svn.videolan.org/libmpeg2''': MPEG2 library.
* '''svn://svn.videolan.org/liba52''': A52/AC3 decoder library.
* '''svn://svn.videolan.org/libdvbcsa''': DVB Common Scrambling Algorithm library

=== Updating the working copy ===
To update your working copy and get the latest files, use the following command:

{{%}} svn update

Note that SVN, unlike CVS, doesn't need to be told to prune removed files or create new directories. This is automagic.

=== Making a diff ===
Diffs, or patches, are text files which include all the changes done in the working copy.
If you suggest a new feature or like to suggest a change, send a patch to the mailing-list with [PATCH] in the subject.

To create a diff from the current repository, use the following command:

{{%}} svn diff

Normally, unlike CVS, you don't have to tell SVN which files you changed; however, you may like to diff only a part of the repository. To do that, specify the files to diff:

{{%}} svn diff modules/gui/qt4/qt4.hpp

Note that SVN defaults to the "unified" diff format, so the "-u" option doesn't have to be passed.

=== Applying a diff ===
Subversion does not contain a built in command to apply diffs to the current working copy (for example, to review or commit diffs published in Bugzilla); instead, you can use the regular [[:en:Patch (Unix)|patch]] unix utility:
{{%}} patch -p0 < patch

TortoiseSVN has a built-in support for applying a diff.

=== .cvsignore / Ignoring files ===
You can ignore some files, using metadata:
{{%}} svn propedit svn:ignore mydirectory

=== Changing file structure ===

==== Add a file ====
You can add files or folders to the working copy, to be included in the next diff or commit, using the command:
{{%}} svn add file.name

If file.name is a text-based document, you should do
{{%}} svn propset svn:eol-style native file.name

If you add a folder, it will add all the files included in the folder, except for files in the ignored list.

==== Delete a file ====
You can delete files or folders from the working copy, to be deleted in the next commit or marked as such in the next diff, using the command (which will automatically '''delete''' the files from the working copy, but won't delete folders in such way):
{{%}} svn delete file.name

Make sure the file or folder do not have local modifications, else they won't be deleted unless you force the deletion.

==== Move a file ====
You no longer create new files from scratch when moving files!
{{%}} svn mv file1 file2

You can also do it with entire folders.

=== Reverting your changes ===
If your changes in the working copy are not useful in your opinion, you can revert them using the following command:
{{%}} svn revert

You must use parameters for this command. To revert all your changes in the working copy, use:
{{%}} svn revert -R .

To revert the changes in a specific file, use:
{{%}} svn revert file.name

Reverting can also remove added files (they won't be deleted, just removed and considered "unknown files", just like you didn't use <code>svn add</code> at first), and restore deleted files (both deleted by hand and deleted by <code>svn delete</code>).

=== Checking the status of the working copy ===
You can check the status of your working copy using the following command:
{{%}} svn status

These are several important letters in the first column of the item, which show the status:
* M = the item was modified by you
* A = the item was added by you (using <code>svn add</code>)
* D = the item was deleted by you (using <code>svn delete</code>)
* ? = the item is not under the version control, but exist
* ! = the item is missing (under the version control, but not exist - probably deleted without using <code>svn delete</code>) or incomplete

=== Checking out specific revision number ===
You can check specific repository revision using following command :
{{%}} svn checkout -r 12345 svn://svn.videolan.org/libdvbpsi/trunk libdvbpsi-trunk

== Developer use ==
If you have a write access for the server, you can use an SSH access instead of HTTP access.

=== Commits ===
Commits, or check ins, are the action of applying your changes from the working copy to the web repository. Use the following command to do that:
{{%}} svn commit

Using the command without the parameters will fail, unless you've configured an editor, because you have to enter a comment for the file logs. You can use one of the following forms:
{{%}} svn commit --message="This is the log comment."
{{%}} svn commit --file=file_with_log_comment

=== Other commands ===

{{%}} svn export
{{%}} svn propedit

Are documented in the [http://svnbook.red-bean.com/en/1.2/index.html SVN Book] that you should definitively read.

== External links ==
* [http://svn.videolan.org Subversion Web access]
* [http://svnbook.red-bean.com/en/1.2/index.html Version Control with Subversion] book (SVN version 1.2)

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

XSPF

2011-07-14T15:53:24Z

Rogerdpack: split examples

{{website|XPSF|http://www.xspf.org/}}
'''XSPF''', pronounced "spiff", is a [[playlist]] in [[XML]] format, which is supported by [[Xiph]]. It is a free and open format so can be easily, freely used for sharing playlists.

== Sample ==
A very simple document looks like this:
<?xml version="1.0" encoding="UTF-8"?>
<playlist version="1" xmlns="http://xspf.org/ns/0/">
<trackList>
<track><location>file:///mp3s/song_1.mp3</location></track>
<track><location>file:///mp3s/song_2.mp3</location></track>
<track><location>file:///mp3s/song_3.mp3</location></track>
</trackList>
</playlist>

== Compatability ==
{{compat}}

== VLC Extensions ==
XSPF supports extensions to allow applications to add special data. These extensions can appear in the following entries:
* playlist
* track

The extension format is defined in the namespace <code>xmlns:vlc="http://www.videolan.org/vlc/playlist/ns/0/"</code>:
<playlist version="1" xmlns="http://xspf.org/ns/0/" xmlns:vlc="http://www.videolan.org/vlc/playlist/ns/0/">
...
<extension application="http://www.videolan.org/vlc/playlist/0">
...
</extension>
</playlist>

Currently, extensions support the following elements:
* vlc:node
* vlc:item
* vlc:id
* vlc:option

The extensions vlc:node and vlc:item are used to specify how to display the playlist tree, which is not supported by standard XSPF.

=== vlc:node ===
This element will be displayed as a node in the playlist. It appears as an extension of the '''playlist''' block (under playlist/extension). Only its name can be specified:
<vlc:node title="Node title">
[list of vlc:item or vlc:node]
</vlc:node>

=== vlc:item ===
This element represents a playlist item (not a node). It appears as an extension of the '''playlist''' block (under playlist/extension). It contains only a track id (see below, vlc:id):
<vlc:item tid="42" />

=== vlc:id ===
This element specifies a track's id. It appears as an extension of the '''track''' block (under playlist/trackList/track/extension).
<vlc:id>42</vlc:id>
The value of the id corresponds to the value of the attribute tid of vlc:item.
Note that each vlc:id has to be different, per entry, or it will not show them all.

=== vlc:option ===
This element allows you to add options to the input item. It appears as an extension of the '''track''' block (under playlist/trackList/track/extension).
<vlc:option>option-name</vlc:option>
Or, if the option has a value:
<vlc:option>option-name=option-value</vlc:option>

=== Example of XSPF with VLC extensions ===

Let's summarize these as an example. This one shows passing VLC options per specified entry in the playlist.

<?xml version="1.0" encoding="UTF-8"?>
<playlist version="1" xmlns="http://xspf.org/ns/0/" xmlns:vlc="http://www.videolan.org/vlc/playlist/ns/0/">
<title>Playlist</title>
<location>D:/media/example.xspf</location>
<trackList>
<track>
<title>DVD seconds 42 to 45 muted</title>
<location>dvd://d:\@1</location>
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>3</vlc:id>
<vlc:option>start-time=42</vlc:option>
<vlc:option>stop-time=45</vlc:option>
<vlc:option>no-audio</vlc:option>
<vlc:option>some-option=100</vlc:option>
</extension>
</track>
<track>
<title>DVD seconds 49-55 unmuted (normal)</title>
<location>dvd://d:\@1</location>
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>4</vlc:id>
<vlc:option>start-time=49</vlc:option>
<vlc:option>stop-time=55</vlc:option>
</extension>
</track>
</trackList>
</playlist>

Here is an example that shows how you can have it show nested entries within the playlist window:

<?xml version="1.0" encoding="UTF-8"?>
<playlist version="1" xmlns="http://xspf.org/ns/0/" xmlns:vlc="http://www.videolan.org/vlc/playlist/ns/0/">
<title>Playlist</title>
<location>D:/media/example.xspf</location>
<trackList>
<track>
<title>Track 1</title>
...
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>0</vlc:id>
</extension>

</track>
<track>
<title>Track 2</title>
...
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>1</vlc:id>
</extension>
</track>
<track>
<title>Track 3</title>
...
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>2</vlc:id>
</extension>
</track>
<track>
<title>Track 4</title>
<location>dvd://e:\@1</location>
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:id>3</vlc:id>
<vlc:option>my-option=100</vlc:option>
<vlc:option>start-time=42</vlc:option>
<vlc:option>stop-time=45</vlc:option>
<vlc:option>no-audio</vlc:option>
</extension>
</track>
</trackList>
<extension application="http://www.videolan.org/vlc/playlist/0">
<vlc:node title="Node 1">
<vlc:item tid="0" />
<vlc:item tid="1" />
<vlc:node title="Node 2">
<vlc:item tid="2" />
<vlc:item tid="3" />
</vlc:node>
</vlc:node>
</extension>
</playlist>

This playlist example will be displayed as:
Playlist
`- Node 1
|- Track 1
|- Track 2
`- Node 2
|- Track 3
`- Track 4

The input for ''Track 4'' will be created with the option ''my-option'' set to 42.

== See also ==
* [[Media Library]] a function built into VLC media player
There are many advantages to using XML as the format.
More information is available at
* [http://www.xiph.org/ Xiph.org]
* [http://www.xspf.org/quickstart/ XSPF project website].

== Unsafe operations ==
Some operations, like setting volume, setting sout destination, etc. are deemed "unsafe" to be in the playlist, so you'll have to add those settings to the command line instead.
You'll get the error message:
'''unsafe option "sout-audio" has been ignored for security reasons)''' or the like.

http://forum.videolan.org/viewtopic.php?f=14&t=78945

[[Category:Playlist]]

VLC HowTo/Rip a DVD

2011-07-02T21:54:04Z

Rogerdpack: mplayer

{{howto|create a video file from a DVD using VLC}}

You can use VLC to rip a "raw" video file from a DVD, or you can use VLC to create a condensed "transcoded" video file from a DVD. This page mostly deals with using it to rip a raw video file from the command line.

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw" video from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg, from drive dvd:\

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to exit after ripping. You can also add a --qt-start-minimized, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive. In comparison with other ripping programs, this is sometimes lacking a few frames from the original (up to 10), but is typically pretty accurate. If you want one that is even more accurate, use mplayer's dumpstream or makemkv.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may help if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. Recommend using handbrake if you want to do transcoding too. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your request to convert the stream on the DVD, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops but loops back to the main menu forever so you will have to stop it manually by monitoring it. Recommend mplayer's dumpstream in this case.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

OS X example (you may be able to use dvdsimple:///Volumes/volumeName as well).

$ /Applications/VLC.app/Contents/MacOS/VLC dvdsimple:///dev/disk1@1 --sout #standard{access=file,mux=ts,dst=dvdout.dvdsimple.vlc.mpg}

== Related ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's and simultaneously transcoding (condensing) the output file. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can also use VLC's libdvdcss if you first [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

=== mplayer ===
Mplayer is another excellent option for ripping a raw mpeg stream from a DVD. See [http://en.wikibooks.org/w/index.php?title=Mplayer&stable=0#Rip_DVD_to_raw_video some instructions] for it.

=== makemkv ===

MakeMKV is also good for ripping DVD or blu-ray to a raw mpeg file. To select specific titles, count down from the top of the checked title options. The first one at the top is "title 1." After ripping, you could then convert it (to condense/transcode it) by using handbrake or VLC.

If you want to convert makemkv's output to an mpeg file (mpeg-ts) then you could use tsmuxer. OS X users will need a [http://instantitunes.wordpress.com/2010/02/26/use-tsmuxer-on-snow-leopard/ special version] of tsmuxer, however.

VLC HowTo/Rip a DVD

2011-06-27T23:49:28Z

Rogerdpack: /* mplayer */

{{howto|create a video file from a DVD using VLC}}

You can use VLC to rip a "raw" video file from a DVD, or you can use VLC to create a condensed "transcoded" video file from a DVD. This page mostly deals with using it to rip a raw video file from the command line.

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw" video from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg, from drive dvd:\

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to exit after ripping. You can also add a --qt-start-minimized, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive. In comparison with other ripping programs, this is sometimes lacking a few frames from the original (up to 10), but is typically pretty accurate. If you want one that is even more accurate, use mplayer's dumpstream or makemkv.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may help if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. Recommend using handbrake if you want to do transcoding too. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your request to convert the stream on the DVD, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops but loops back to the main menu forever so you will have to stop it manually by monitoring it. Recommend mplayer's dumpstream in this case.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

OS X example (you may be able to use dvdsimple:///Volumes/volumeName as well).

$ /Applications/VLC.app/Contents/MacOS/VLC dvdsimple:///dev/disk1@1 --sout #standard{access=file,mux=ts,dst=dvdout.dvdsimple.vlc.mpg}

== Related ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's and simultaneously transcoding (condensing) the output file. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can also use VLC's libdvdcss if you first [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

=== mplayer ===
Mplayer is another excellent option for ripping a raw mpeg stream from a DVD. Here's an example (title 1, dvd on d:\):

$ mplayer -dumpstream dvdnav://1 -nocache -dvd-device d: -dumpfile dvdout.mpg

If you're on windows, you may need to replace "mplayer", above, with something like "C:\Program Files (x86)\MPlayer for WindowsUI\mplayer\mplayer.exe" to get it to run. You may need to install "mulder's mplayer for windows" first.

=== makemkv ===

MakeMKV is also good for ripping a DVD or blu-ray to a raw mpeg file. To select certain titles, count down from the top of the checked title options. The first one at the top is "title 1." You could then convert it (condense/transcode it) after using handbrake or VLC.

If you want to convert makemkv's output to an mpeg file (mpeg-ts) then you could use tsmuxer. OS X users will need a [http://instantitunes.wordpress.com/2010/02/26/use-tsmuxer-on-snow-leopard/ special version] of tsmuxer, however.

VLC HowTo/Rip a DVD

2011-06-27T23:40:40Z

Rogerdpack: /* makemkv */

{{howto|create a video file from a DVD using VLC}}

You can use VLC to rip a "raw" video file from a DVD, or you can use VLC to create a condensed "transcoded" video file from a DVD. This page mostly deals with using it to rip a raw video file from the command line.

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw" video from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg, from drive dvd:\

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to exit after ripping. You can also add a --qt-start-minimized, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive. In comparison with other ripping programs, this is sometimes lacking a few frames from the original (up to 10), but is typically pretty accurate. If you want one that is even more accurate, use mplayer's dumpstream or makemkv.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may help if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. Recommend using handbrake if you want to do transcoding too. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your request to convert the stream on the DVD, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops but loops back to the main menu forever so you will have to stop it manually by monitoring it. Recommend mplayer's dumpstream in this case.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

OS X example (you may be able to use dvdsimple:///Volumes/volumeName as well).

$ /Applications/VLC.app/Contents/MacOS/VLC dvdsimple:///dev/disk1@1 --sout #standard{access=file,mux=ts,dst=dvdout.dvdsimple.vlc.mpg}

== Related ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's and simultaneously transcoding (condensing) the output file. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can also use VLC's libdvdcss if you first [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

=== mplayer ===
Mplayer is another excellent option for ripping a raw mpeg stream from a DVD. Here's an example (title 1, dvd on d:\):

$ mplayer -dumpstream dvdnav://1 -nocache -dvd-device d: -dumpfile dvdout.mpg

If you're on windows, you may need to replace "mplayer", above, with something like "C:\Program Files (x86)\MPlayer for WindowsUI\mplayer\mplayer.exe" to get it to work.

=== makemkv ===

MakeMKV is also good for ripping a DVD or blu-ray to a raw mpeg file. To select certain titles, count down from the top of the checked title options. The first one at the top is "title 1." You could then convert it (condense/transcode it) after using handbrake or VLC.

If you want to convert makemkv's output to an mpeg file (mpeg-ts) then you could use tsmuxer. OS X users will need a [http://instantitunes.wordpress.com/2010/02/26/use-tsmuxer-on-snow-leopard/ special version] of tsmuxer, however.

VLC HowTo/Rip a DVD

2011-06-27T23:31:47Z

Rogerdpack: /* Related */

{{howto|create a video file from a DVD using VLC}}

You can use VLC to rip a "raw" video file from a DVD, or you can use VLC to create a condensed "transcoded" video file from a DVD. This page mostly deals with using it to rip a raw video file from the command line.

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw" video from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg, from drive dvd:\

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to exit after ripping. You can also add a --qt-start-minimized, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive. In comparison with other ripping programs, this is sometimes lacking a few frames from the original (up to 10), but is typically pretty accurate. If you want one that is even more accurate, use mplayer's dumpstream or makemkv.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may help if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. Recommend using handbrake if you want to do transcoding too. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your request to convert the stream on the DVD, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops but loops back to the main menu forever so you will have to stop it manually by monitoring it. Recommend mplayer's dumpstream in this case.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

OS X example (you may be able to use dvdsimple:///Volumes/volumeName as well).

$ /Applications/VLC.app/Contents/MacOS/VLC dvdsimple:///dev/disk1@1 --sout #standard{access=file,mux=ts,dst=dvdout.dvdsimple.vlc.mpg}

== Related ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's and simultaneously transcoding (condensing) the output file. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can also use VLC's libdvdcss if you first [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

=== mplayer ===
Mplayer is another excellent option for ripping a raw mpeg stream from a DVD. Here's an example (title 1, dvd on d:\):

$ mplayer -dumpstream dvdnav://1 -nocache -dvd-device d: -dumpfile dvdout.mpg

If you're on windows, you may need to replace "mplayer", above, with something like "C:\Program Files (x86)\MPlayer for WindowsUI\mplayer\mplayer.exe" to get it to work.

=== makemkv ===

MakeMKV is also good for ripping a DVD or blu-ray to a raw mpeg file. To select certain titles, count down from the top of the checked title options. The first one at the top is "title 1." You could then convert it (condense/transcode it) after using handbrake or VLC.

If you want to convert makemkv's output to an mpeg file (mpeg-ts) then you could use tsmuxer. OS X users will need a [http://instantitunes.wordpress.com/2010/02/26/use-tsmuxer-on-snow-leopard/ special version] of tsmuxer.

VLC HowTo/Rip a DVD

2011-06-06T17:36:00Z

Rogerdpack:

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw mpg" from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to start, complete the rip, then exit. You can also add a --qt-start-minimized to that, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may be easier for if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your desire to convert, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops it loops back to the main menu forever so you will have to stop it manually by watching it.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

OS X

$ /Applications/VLC.app/Contents/MacOS/VLC dvdsimple:///dev/disk1@1 --sout #standard{access=file,mux=ts,dst=dvdout.dvdsimple.vlc.mpg}

== Further reading ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's. Unfortunately it only transcodes from DVD to a file (not a raw rip), but it does it well. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can use VLC's libdvdcss if you [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

MakeMKV is also good for ripping a DVD or blu-ray to raw mpeg. You can then convert it using handbrake or VLC. VLC is not fine tuned for accurate ripping, though it does pretty well, these other tools may be better.

VLC HowTo/Rip a DVD

2011-06-04T19:39:22Z

Rogerdpack:

VLC HowTo/Rip a DVD

2011-06-03T19:03:11Z

Rogerdpack: ok :P

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw mpg" from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to start, complete the rip, then exit. You can also add a --qt-start-minimized to that, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may be easier for if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your desire to convert, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but this is probably not a good option as it never stops it loops back to the main menu forever so you will have to stop it manually by watching it.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

== Further reading ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's. Unfortunately it only transcodes from DVD to a file (not a raw rip), but it does it well. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can use VLC's libdvdcss if you [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

Transcode

2011-06-03T18:59:58Z

Rogerdpack: /* Completely non-interactive transcoding */

Transcoding is the process of taking a video file and changing it to a different format or bitrate.

Transcoding in VLC copies the movie to a new file in a different format, so you end up with both the original and new files. This means you need to have enough space on your hard drive to store this extra file. You should also have a reasonably fast computer, as transcoding can be very slow.

In VLC, transcoding is exactly the same as [[streaming]] accross a network, except that the output is sent to a file instead of a network.

== Compatibility issues ==

If your input streams already matches the encoding that you desire for your output stream, then you don't have to transcode at all (just leave out the transcode settings on the command line, and it will thence not transcode). In the GUI this is called "keep the original track" (I think).

Note that when you decide your transcoding settings, only some container formats (muxers) can support some codecs - look at [http://www.videolan.org/streaming/features.html streaming features] to see which supports what. If your current format is incompatible with the muxer you desire, then you must transcode it to something compatible, or choose a different muxer. If you choose an incompatible stream for a given muxer, it may silently fail. You can look for error messages in the [[Basic_Troubleshooting|messages window]] to help you debug the failures.

== Transcoding with the Wizard ==

VLC includes a transcoding and streaming wizard. To transcode a file, just select the transcode option. You will then be asked what format to convert to: you can give a video [[codec]], an audio codec and a [[container]] format.

See also {{doc|http://www.videolan.org/doc/streaming-howto/en/ch02.html}}

== Transcoding with the Command Prompt ==

The most flexible way to transcode with vlc is using a [[command prompt]] to start vlc. Transcoding works the same as [[streaming]]. For example, the following command changes an [[asf]] file to an [[MPEG-2]] file:
:vlc "C:\Movies\Your File.asf" :sout='#transcode{vcodec=mp2v,vb=4096,acodec=mp2a,ab=192,scale=1,channels=2,deinterlace,audio-sync}:std{access=file, mux=ps,dst="C:\Movies\Your File Output.ps.mpg"}'
The access=file instructs vlc to store the output in a file (and not stream it), and the dst is the location of the new (output) file.

* Note 1: If you are running VLC on [[Mac OS X]], you should use clivlc instead of VLC to avoid possible Bus error problems.
* Note 2: old VLC releases, maybe up to 0.8.6* included, use "url" instead of "dst".

Transcoding takes quite a while, so it's advisable to use an option like '''--stop-time=30''' to only encode the first 30 seconds - this means you can check the file has transcoded correctly, and that the output is of a suitable quality. (Note: On [[Mac OS X]] this trick doesn't seem to work. Just press ctrl-c after a while, VLC will properly write out the already transcoded segment)

The transcode statement can contain '''vcodec''' and '''vb''' to change the video codec and '''acodec''' and '''ab''' to change the audio codec. If vcodec is missing, the video codec will stay the same (same for acodec).

Common additional options to use are '''audio-sync''' (to make sure the audio is in sync correctly) and '''deinterlace''' (to increase quality slightly on interlaced video).
===Under MS Windows===
the syntax on windows is slightly different:

:C:\Program Files\VideoLAN\VLC>vlc -vvv "D:\688497.flv" --sout=#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:standard{access=file,mux=ts,dst="D:\asd.mpg"}
(Note: old VLC releases, maybe up to 0.8.6* included, use "url" instead of "dst")

(Note: due to command line parsing, at times, especially within single and double quote blocks, a backslash may have to be escaped by using a double backslash so that a filename would be D:\\path\\to\\file.mpg)

===Completely non-interactive transcoding===
For completely non-interactive transcoding (such as the case necessary when running under [[Mac OS X]]), the above example could be rewritten as
:vlc -I dummy "C:\Movies\Your File.asf" :sout='#transcode{vcodec=mp2v,vb=4096,acodec=mp2a,ab=192,scale=1,channels=2,deinterlace,audio-sync}:std{access=file, mux=ps,dst="C:\Movies\Your File Output.ps.mpg"}' vlc://quit
The two extra options are
;-I dummy: Disables the graphical interface
;<nowiki>vlc://quit</nowiki>: Quit VLC after transcoding
If transcoding from a DVD, it is also necessary to use the dvdsimple:// notation instead of the dvd:// notation, in order to avoid interacting with the DVD menu system. You can use this in the GUI by choosing 'no DVD menus' option when opening the disc. See [[Rip_DVD]]

{{doc|http://www.videolan.org/doc/streaming-howto/en/ch03.html}}

== Canvas and Padding ==
'''The canvas and padding options changed since Version 0.9. Most examples in the wiki are broken.'''

<pre>transcode{vcodec=mp2v,vfilter=canvas{width=640,height=480}}</pre>

Other options:
* aspect=4:3 : Aspect ratio
* padd:
** true: Pad with black bars
** false: crop video

<pre>transcode{vcodec=mp2v,vfilter=croppadd{cropttop=20,cropbottom=30,paddleft=100}}</pre>

crop or pad top, left, right or bottom in pixels.

Avoid using width and hight parameters! These are apllied before the vfilter and might result in unwanted results.

== Non-Interactive Batch Transcoding (Windows)==
=== Batch File ===
To transcode several files without user interaction create a batch file in the folder where the files are contained and this line to the batch file:

<pre>
for %%a in (*.FILE_EXT) do cmd /c "PATH_TO_VLC" -I dummy -vvv %%a --sout=#transcode{vcodec=VIDEO_CODEC,vb=VIDEO_BITRATE,scale=1,acodec=AUDIO_CODEC,ab=AUDIO_BITRATE,channels=6}:standard{access=file,mux=MUXER,dst=%%a.OUTPUT_EXT} vlc://quit
</pre>

* note: if the line above creates "double file name extensions" like<tt> *.FILE_EXT.OUTPUT_EXT </tt>(e.g.<tt> *.mp3.wav </tt>when converting mp3 to wav), try:
<pre>... dst=OUTPUT_PATH\%%~na.OUTPUT_EXT ...</pre>
<tt>%%~na </tt>is the file name of <tt>%%a</tt> only without extension.

<tt>Cmd /c </tt>makes the script wait to finish transcoding before starting the next transcode.

* Example: to convert all mp3-files in the current directory to standard uncompressed wav-files (PCM; may be suitable if you want to burn audio-cds and your player is unable to play *.mp3-files), type

<pre> for %%a in (*.mp3) do cmd /c "C:\Programme\VideoLAN\VLC\vlc.exe" -I dummy -vvv %%a --sout #transcode{acodec=s16l,channels=2,samplerate=44100}:standard{access=file,mux=wav,dst=g:\_audio_conv\%%a.wav} vlc://quit</pre>

=== VB Script ===
An alternative method is to use VB Script. This example will transcode all files from one folder to another. It will also wait for each file to finish transcoding before starting the next. Create the script transcode.vbs, in the VLC installation folder, default "C:\Program Files\VideoLAN\VLC". Change the strSource and strTarget in the example to match your requirements. Start a "DOS Box", Start - Run - cmd then change to the VLC folder and run the script "cscript transcode.vbs".

This example was tested on Microsoft Windows Script host 5.6 running on XP Pro SP2

<pre>
'
' based on code from:http://episteme.arstechnica.com/eve/forums/a/tpc/f/12009443/m/516001349831
'
'
'
Dim objFSO, objShell, strSource, strTarget, strOldName, strNewName
'
set objFSO = CreateObject("Scripting.FileSystemObject")
'
' Set up starting folders
'
strSource = "O:\"
strTarget = "N:\"
'
call RecurseDir(strSource, strTarget)
'
' // Recursively copy all files and folders
'
Sub RecurseDir(strSource, strTarget)
wscript.echo "source: " & strSource & " target: "& strTarget
'
Dim strTempSource, strTempTarget
'
Set strTempSource = objFSO.GetFolder(strSource)
'
Wscript.Echo "Begin Value: " & strTarget
'
If Not objFSO.FolderExists(strTarget) Then
' Wscript.Echo "No Folder! Creating folder [" & strTarget & "]"
objFSO.CreateFolder(strTarget)
Else
Wscript.Echo "Folder exists! " & strTempTarget
End If
'
Set strTempTarget = objFSO.GetFolder(strTarget)
' ** Copy files from current directory to target
For each file in strTempSource.files
strOldName = strSource & "\" & file.name
strNewName = strTempTarget & "\" & Mid(file.name, 1, InstrRev(file.name, ".")) & "ts"
'
If Not objFSO.FileExists(strNewName) Then
Set objShell = CreateObject("WScript.Shell")
'
Wscript.Echo "Transcoding file: " & strOldName & " to " & strNewName
'
Select Case Right(strOldName, 3)
Case "avi"
wscript.echo "vlc file://""" & strOldName & """ :sout=#duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit"
objShell.Run "vlc file://""" & strOldName & """ :sout=#duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit", 1, True
Case "mp4"
wscript.echo "vlc file://""" & strOldName & """ :sout=#transcode{vcodec=mp2v,vb=1024,scale=1,acodec=mp2a,ab=192,channels=2}:duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit"
objShell.Run "vlc file://""" & strOldName & """ :sout=#transcode{vcodec=mp2v,vb=1024,scale=1,acodec=mp2a,ab=192,channels=2}:duplicate{dst=std{access=file,mux=ts,dst=""" & strNewName & """}} vlc://quit", 1, True
End Select
'
Set objShell = Nothing
End If
Next
' ** For each subfolder of current dir, copy files to target and recurse its subdirs
For each subdir in strTempSource.subfolders
Wscript.Echo subdir.path
call RecurseDir(subdir.path, strTempTarget & "\" & subdir.name)
Next
End Sub
</pre>

== Non-Interactive Batch Transcoding (Linux)==
To transcode several files without user interaction create a bash script in the folder where the files are contained and add these lines to the bash script:

<pre>
#!/bin/bash
vcodec="VIDEO_CODEC"
acodec="AUDIO_CODEC"
bitrate="VIDEO_BITRATE"
arate="AUDIO_BITRATE"
ext="OUTPUT_EXT"
mux="MUXER"
vlc="PATH_TO_VLC"
fmt="INPUT_EXT"

for a in *$fmt; do
$vlc -I dummy -vvv "$a" --sout "#transcode{vcodec=$vcodec,vb=$bitrate,acodec=$acodec,ab=$arate,channels=6}:standard{mux=$mux,dst=\"$a.$ext\",access=file}" vlc://quit
done
</pre>

===Non-Interactive Merge/Transcode (Windows)===

If you have more than one source files that need to be merged and transcoded resulting in a single out put file, see [[How_to_Merge_and_Transcode_Multiple_Videos]]

===Example script===
'''The canvas and cropping must be adjusted for VLC versions newer then 0.9.'''

As an example, here is a bash script that will take a <tt>.mpg</tt> file as generated by an DVB capture device and transcode it into an MPEG4 file using the h.264 codec. Copy it to a file, for example <tt>dvb2mp4</tt>, and make it executable. It should work on any operating system that has bash, including windows if [http://www.cygwin.com Cygwin] is installed. It uses the cropping parameters proposed at [[Wikipedia:Overscan_amounts]] adapted so that the dimensions are divisible by 16 for better encoding.

<pre>
#!/bin/bash
#
# Transcode DVB TV signals to h.264-encoded MP4 files using VLC
# Wout.Mertens@gmail.com

#### Defaults, please edit for your settings ####

# VLC location, here is the Mac OS X example
VLC=/Applications/VLC.app/Contents/MacOS/clivlc
# Other possibilities: (Remove the # to activate)
#VLC=/usr/bin/vlc
#VLC=/usr/local/bin/vlc

# 16:9 or 4:3
aspect=16:9

# PAL (Europe) or NTSC (US)
src=PAL

# video bitrate
bitrate=1024

# audio bitrate
arate=128

# cropping?
crop=yes

# Deinterlace?
deint=yes

#### Program, do not change below this line ####
usage() {
cat 1>&2 <<EOF
Usage: $0 [-swpncC] [-b <rate>] [-a <rate>] <DVB source .mpg> <MP4 output file>
-s 4:3 aspect ratio (default=$aspect)
-w 16:9 aspect ratio
-p PAL (720x576) input (default=$src)
-n NTSC (720x480) input
-c Crop borders (default=$crop)
-C Do not crop borders
-d Perform de-interlacing (default=$deint)
-D Do not perform de-interlacing
-b video bitrate kb/s (default=$bitrate)
-a audio bitrate kb/s (default=$arate)
EOF
exit 1
}

error() {
echo "ERROR: $*" 1>&2
exit 2
}

while getopts 'swpncCb:a:h' opt; do
case $opt in
s) aspect=4:3 ;;
w) aspect=16:9 ;;
p) src=PAL ;;
n) src=NTSC ;;
c) crop=yes ;;
C) crop=no ;;
d) deint=yes ;;
D) deint=no ;;
b) bitrate=$OPTARG ;;
a) arate=$OPTARG ;;
h) usage ;;
*) echo "Unknown option $opt" 1>&2; usage ;;
esac
done
shift $(( $OPTIND - 1 ))

[ $# -ne 2 ] && usage

infile="$1"
outfile="$2"
case $outfile in
*.mp4|*.MP4) : ;;
*) outfile="$outfile.mp4" ;;
esac

[ -r "$infile" ] || error "Can't read from $infile"

case "$src,$aspect,$crop" in
PAL,16:9,yes) sizestr="cropleft=31,cropright=31,croptop=16,cropbottom=16,width=960,height=544" ;;
PAL,4:3,yes) sizestr="cropleft=31,cropright=31,croptop=16,cropbottom=16,width=720,height=544" ;;
NTSC,16:9,yes) sizestr="cropleft=30,cropright=30,croptop=17,cropbottom=17,width=800,height=448" ;;
NTSC,4:3,yes) sizestr="cropleft=26,cropright=26,croptop=17,cropbottom=17,width=608,height=448" ;;
PAL,16:9,no) sizestr="width=1024,height=576" ;;
PAL,4:3,no) sizestr="width=768,height=576" ;;
NTSC,16:9,no) sizestr="width=800,height=448" ;;
NTSC,4:3,no) sizestr="width=608,height=448" ;;
*) error "Could not handle $src,$aspect,$crop. This shouldn't happen!" ;;
esac

if [ "$deint" = "yes" ]; then
deintstr=",deinterlace=enable"
else
deintstr=
fi

# Let's do it
echo "Input file: $infile"
echo "Output file: $outfile"
echo "Encoding at $bitrate+$arate kb/s, input $src, $aspect, cropping $crop, de-interlace $deint"
echo
echo '>>>' $VLC -I dummy "$infile" --sout "#transcode{$sizestr$deintstr,vcodec=h264,vb=$bitrate,acodec=mp4a,ab=$arate}:standard{mux=mp4,dst=\"$outfile\",access=file}" vlc://quit
echo
$VLC -I dummy "$infile" --sout "#transcode{$sizestr$deintstr,vcodec=h264,vb=$bitrate,acodec=mp4a,ab=$arate}:standard{mux=mp4,dst=\"$outfile\",access=file}" vlc://quit
</pre>

[[Category:Glossary]]

VLC HowTo/Rip a DVD

2011-06-03T18:59:33Z

Rogerdpack: GUI cleanup

Here is an example. You'll need to type this at the command prompt (windows) or terminal (linux), all on one line. You may also need to give the full path to vlc (ie, replace vlc with "C:\Program Files\VideoLAN\vlc\vlc.exe", or wherever you installed vlc)

This is how to rip the "raw mpg" from a DVD, assuming you want to rip your DVD's title "1" to filename dvdout.mpg

$ vlc dvdsimple://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

the vlc://quit at the end just tells it to start, complete the rip, then exit. You can also add a --qt-start-minimized to that, if desired.

Note that the above doesn't do any transcoding on the video stream, it just basically dumps a verbatim copy to your hard drive.

You may have some luck ripping the DVD from [http://www.howtogeek.com/howto/2696/how-to-rip-dvds-with-vlc the GUI], as well, though this is a bit tricky [1]. See also note at bottom. Using the GUI may be easier for if you want to both rip and [transcode] simultaneously, as the above commands only do a raw copy. NB that if you use the GUI you will need to name your output filename with the correct extension for your mux type or VLC will silently ignore your desire to convert, and just display the video instead. Silently, mind you. (If it is working right it won't show you a video by default). You will also need to check the 'no DVD menus' option, which instructs it to use dvdsimple:// instead of dvd:// which [http://forum.videolan.org/viewtopic.php?f=2&t=52748 loops back] to the main menu after playing the title.

If it stops halfway through, cleaning your disc might help. If it still fails half-way through, it may work better to use dvd:// (in the GUI, that's not check 'no DVD menus') instead of dvdsimple:// but it will loop back to the main menu forever so you will have to stop it manually.

$ vlc dvd://d:\@1 --sout "#standard{access=file,mux=ts,dst=dvdout.mpg}" vlc://quit

It might also help to set the cacheing value either higher or to 0 (in the GUI: under advanced options).

== Further reading ==

http://wiki.videolan.org/WindowsFAQ-1.1.x#Some_DVD_movies_don.27t_work_at_all_or_they_crash.2Ffreeze_to_menu_or_playback

[http://handbrake.fr Handbrake] is a free user friendly open source tool for ripping DVD's. Unfortunately it only transcodes from DVD to a file (not a raw rip), but it does it well. It uses VLC by default for ripping if installed on OS X. For windows users handbrake can use VLC's libdvdcss if you [https://forum.handbrake.fr/viewtopic.php?f=11&t=16670#p78021 install it].

VLC HowTo

2011-06-03T18:50:15Z

Rogerdpack:

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[Crop|Crop video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Control VLC from an Android Phone]]
* [[Control VLC from a Palm Web OS Phone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[Transcode]]
*: This explains converting (transcoding) a file.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.
* [[Extract Audio From File]]
*: This explains how to extract the audio track from a file.
* [[Extract_audio]]
*: This explains how to extract the audio track from a DVD.
* [[Rip DVD]]
*: This explains how to rip a DVD using VLC

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[LibVLC|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...
* [[How to make VLC the default player]]
* [[How to use VLC for transcription in linux]]

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

VLC HowTo/Rip a DVD

2011-06-03T18:15:48Z

Rogerdpack:

VLC HowTo/Rip a DVD

2011-06-03T18:04:08Z

Rogerdpack:

VLC HowTo/Rip a DVD

2011-06-03T18:02:17Z

Rogerdpack: initial commit

VLC HowTo

2011-06-03T17:52:04Z

Rogerdpack: /* Transcoding and Streaming */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[Crop|Crop video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Control VLC from an Android Phone]]
* [[Control VLC from a Palm Web OS Phone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.
* [[Extract Audio From File]]
*: This explains how to extract the audio track from a file.
* [[Extract_audio]]
*: This explains how to extract the audio track from a DVD.
* [[Rip DVD]]
*: This explains how to rip a DVD using VLC

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[LibVLC|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...
* [[How to make VLC the default player]]
* [[How to use VLC for transcription in linux]]

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

VLC HowTo

2011-06-03T17:51:36Z

Rogerdpack: /* Transcoding and Streaming */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[Crop|Crop video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Control VLC from an Android Phone]]
* [[Control VLC from a Palm Web OS Phone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.
* [[Extract Audio From File]]
*: This explains how to extract the audio track from a file.
* [[Extract_audio]]
*: This explains how to extract the audio track from a DVD.
* [[rip_dvd]]
*: This explains how to rip a DVD using VLC

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[LibVLC|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...
* [[How to make VLC the default player]]
* [[How to use VLC for transcription in linux]]

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

Python bindings

2011-05-04T19:55:03Z

Rogerdpack:

= Python bindings =

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

== Features ==

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

== Download ==

You can download the [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=generated;b=HEAD vlc.py] module from the Git repository. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

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

== Usage ==

The vlc.py file also contains a runnable example player application (see code at the end of the file, starting from the line "if __name__ == '__main__').

A set of helper examples [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=examples;hb=HEAD examples] provide a pyGtk, a pyQt and a pyWx player to ease integration.

There is also a [http://git.videolan.org/?p=vlc/bindings/python.git;a=blob;f=README README]

== Projects using this binding ==

http://code.google.com/p/movie-content-editor/ See also [[LibVLC_Users]]

== FAQ ==

=== Win32 initialization ===

If the vlc modules are not installed in their standard location (e.g. c:\\Program Files\\Videolan on Windows, or /usr/lib/vlc on linux), the VLC module cannot find them. Add the location of libvlc.dll to your PATH first.

When instanciating vlc.Instance() with no parameter, it tries to guess the location of the modules. However, if you pass any argument to vlc.Instance(), you will need to supply the appropriate "--plugin-path=/path/to/the/modules" yourself.

LibVLC Tutorial

2011-05-02T19:07:24Z

Rogerdpack: /* LibVLC C Tutorial */

== LibVLC C Tutorial ==

=== Installing the SDK ===
This code is written for [[LibVLC]] version 1.1.0 or later. It '''cannot''' be compiled with older versions.

==== Windows ====
VLC binary installers for Windows do not include the LibVLC SDK. It would be a waste of bandwidth and space for most users.

You can find the SDK files, i.e. development headers and import libraries, from the plain ZIP packages in the <code>sdk</code> directory. Alternatively, you can build VLC from source.

See [[LibVLC_Tutorial_086c]] for some more instructions on getting the build working.

==== Linux ====
You should find the necessary files (libvlc.so, libvlc.pc, header files...) in a binary package called libvlc-dev (Debian, Ubuntu...), libvlc-devel (RPM distros) or similar. Make sure that the version is recent enough before going forward.

=== Linking against LibVLC ===

<pre>
cc example.c -lvlc -o example
</pre>

On Linux/BSD, you may prefer to use pkg-config:
<pre>
pkg-config --print-errors 'libvlc >= 1.1.0'
cc -c example.c -o example.o $(pkg-config --cflags libvlc)
cc example.o -o example $(pkg-config --libs libvlc)
</pre>

=== Sample LibVLC Code ===
This sample code will (try to) play back an URL.
There is also an [[LibVLC SampleCode SDL|example using SDL for video output]].
<pre>
#include <stdio.h>
#include <stdlib.h>
#include <vlc/vlc.h>

int main(int argc, char* argv[])
{
libvlc_instance_t * inst;
libvlc_media_player_t *mp;
libvlc_media_t *m;

/* Load the VLC engine */
inst = libvlc_new (0, NULL);

/* Create a new item */
m = libvlc_media_new_path (inst, "http://mycool.movie.com/test.mov");

/* Create a media player playing environement */
mp = libvlc_media_player_new_from_media (m);

/* No need to keep the media now */
libvlc_media_release (m);

#if 0
/* This is a non working code that show how to hooks into a window,
* if we have a window around */
libvlc_media_player_set_xdrawable (mp, xdrawable);
/* or on windows */
libvlc_media_player_set_hwnd (mp, hwnd);
/* or on mac os */
libvlc_media_player_set_nsobject (mp, view);
#endif

/* play the media_player */
libvlc_media_player_play (mp);

sleep (10); /* Let it play a bit */

/* Stop playing */
libvlc_media_player_stop (mp);

/* Free the media_player */
libvlc_media_player_release (mp);

libvlc_release (inst);

return 0;
}
</pre>

LibVLC Tutorial

2011-05-02T19:07:07Z

Rogerdpack:

== LibVLC C Tutorial ==

=== Installing the SDK ===
This code is written for LibVLC version 1.1.0 or later. It '''cannot''' be compiled with older versions.

==== Windows ====
VLC binary installers for Windows do not include the LibVLC SDK. It would be a waste of bandwidth and space for most users.

You can find the SDK files, i.e. development headers and import libraries, from the plain ZIP packages in the <code>sdk</code> directory. Alternatively, you can build VLC from source.

See [[LibVLC_Tutorial_086c]] for some more instructions on getting the build working.

==== Linux ====
You should find the necessary files (libvlc.so, libvlc.pc, header files...) in a binary package called libvlc-dev (Debian, Ubuntu...), libvlc-devel (RPM distros) or similar. Make sure that the version is recent enough before going forward.

=== Linking against LibVLC ===

<pre>
cc example.c -lvlc -o example
</pre>

On Linux/BSD, you may prefer to use pkg-config:
<pre>
pkg-config --print-errors 'libvlc >= 1.1.0'
cc -c example.c -o example.o $(pkg-config --cflags libvlc)
cc example.o -o example $(pkg-config --libs libvlc)
</pre>

=== Sample LibVLC Code ===
This sample code will (try to) play back an URL.
There is also an [[LibVLC SampleCode SDL|example using SDL for video output]].
<pre>
#include <stdio.h>
#include <stdlib.h>
#include <vlc/vlc.h>

int main(int argc, char* argv[])
{
libvlc_instance_t * inst;
libvlc_media_player_t *mp;
libvlc_media_t *m;

/* Load the VLC engine */
inst = libvlc_new (0, NULL);

/* Create a new item */
m = libvlc_media_new_path (inst, "http://mycool.movie.com/test.mov");

/* Create a media player playing environement */
mp = libvlc_media_player_new_from_media (m);

/* No need to keep the media now */
libvlc_media_release (m);

#if 0
/* This is a non working code that show how to hooks into a window,
* if we have a window around */
libvlc_media_player_set_xdrawable (mp, xdrawable);
/* or on windows */
libvlc_media_player_set_hwnd (mp, hwnd);
/* or on mac os */
libvlc_media_player_set_nsobject (mp, view);
#endif

/* play the media_player */
libvlc_media_player_play (mp);

sleep (10); /* Let it play a bit */

/* Stop playing */
libvlc_media_player_stop (mp);

/* Free the media_player */
libvlc_media_player_release (mp);

libvlc_release (inst);

return 0;
}
</pre>

Python bindings

2011-05-02T19:06:44Z

Rogerdpack: /* Projects using this binding */

= Python bindings =

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

== Features ==

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

== Download ==

You can download the [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=generated;b=HEAD vlc.py] module from the Git repository. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

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

== Usage ==

The vlc.py module also contains a runnable example player application (see code at the end of the module, starting from the line "if __name__ == '__main__').

A set of helper examples [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=examples;hb=HEAD examples] provide a pyGtk, a pyQt and a pyWx player to ease integration.

There is also a [http://git.videolan.org/?p=vlc/bindings/python.git;a=blob;f=README README]

== Projects using this binding ==

http://code.google.com/p/movie-content-editor/ See also [[LibVLC_Users]]

== FAQ ==

=== Win32 initialization ===

If the vlc modules are not installed in their standard location (e.g. c:\\Program Files\\Videolan on Windows, or /usr/lib/vlc on linux), the VLC module cannot find them.

When instanciating vlc.Instance() with no parameter, it tries to guess the location of the modules. However, if you pass any argument to vlc.Instance(), you will need to supply the appropriate "--plugin-path=/path/to/the/modules" yourself.

To run the file "vlc.py" from the command line, you'll need to pass it an argument, like "python vlc.py e:\" for it to play something.

Git

2011-02-21T21:11:29Z

Rogerdpack: /* Getting VLC or x264 source code via Git */

[http://git-scm.com/ Git] is a free and open source [[wikipedia:Revision_control|version control system]]. It is used by programmers to keep track of the different versions of the files composing a software.

= Basic Git usage =

If you are using '''Windows''', please read the [[Git_Windows]] page.

== Getting VLC or x264 source code via Git ==

$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/.

$ git clone git://git.videolan.org/x264.git
Voilà! The full x264 history should be on your hard disk in x264/.

If you want only the last 3 VLC revisions:
$ git clone git://git.videolan.org/vlc.git --depth 3

Clones without the full revision set (--depth) can't be used for backporting (or make sure to that you're including at least commits up to the common fork point).

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

See http://repo.or.cz/w/vlc.git (it's a mirror)

=== After cloning ===

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

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

== Configure your global git config ==
May need to use
$ git repo-config {various options}
1.4.4.2 Requires the repo-config command rather than just config

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If you wish to give credit to someone else's work (e.g. you are applying a third party patch):
$ git commit <specific files> --author "Name Surname <user@domain.com>"

== List your commits ==
$ git log

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

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

Now you can just type:
$ git up

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

== Submitting patches to the vlc-devel or x264-devel ==

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

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

For x264, do the same with x264-devel@videolan.org


Don't do:
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...
But do:
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

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

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

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

If warnings appear that files still need updating:
$ include/libvlc_internal.h: needs update
include/mediacontrol_internal.h: needs update
include/vlc/libvlc.h: needs update
include/vlc_update.h: needs update
modules/access/mms/mms.c: needs update
...

Then do a checkout -f to revert non committed local changes
$ git checkout -f

To stay up-to-date another
$ git pull --rebase
Should give no more warnings.

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

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

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

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

== Backporting commits ==
It is possible to "backport" commit between the master branch and a -bugfix branch. However since VDD'09, the bugfix branches have been splitted to their own git repositories. This leaves us with 2 cases.

=== Normal simple case ===

Go to your -bugfix branch:
$ git checkout 1.0-bugfix

Backport the commit:
$ git cherry-pick -x -s <sha-id of commit>

If git fails to do the backport by itself, you'll be presnted with the usual options in case of a failed merge or patching. Use "git status", your favorite editor or "git mergetool" to resolve the situation. Then use "git add" and "git commit -c <sha-id of backported commit>".
Then push your commit as usual.

=== Case of VLC bugfix branches ===
Due to the number of commits in vlc.git and the amount of divergence between the master and 1.0-bugfix branches, they have been separated into two different git repositories. But that doesn't block you from backporting.

Get the -bugfix git:
$ git clone git://git.videolan.org/vlc/vlc-1.0.git vlc-bugfix
Add vlc.git as an additional remote:
$ git remote add vlc-master git://git.videolan.org/vlc.git
Update the information from vlc-master
$ git fetch vlc-master
Backport as normal
$ git cherry-pick -x -s <sha-id of commit>

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

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

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

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

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

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

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

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

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

== Patch-ing ==
* You can apply patches using
$ git apply <patch>

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

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

= Using Git to push to VideoLAN git =
== Initial requirements ==
* You must have credentials to push commits into the repository. For other contributors, please read upper [[Git#Submitting_patches_to_the_vlc-devel_or_x264-devel|Submitting patches to the vlc-devel or x264-devel]] paragraph.
* Make sure you've set your name and email in your commits
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

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

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

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

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

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



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

[[Category:Building]]

Git

2011-02-21T21:08:30Z

Rogerdpack: /* Getting VLC or x264 source code via Git */

[http://git-scm.com/ Git] is a free and open source [[wikipedia:Revision_control|version control system]]. It is used by programmers to keep track of the different versions of the files composing a software.

= Basic Git usage =

If you are using '''Windows''', please read the [[Git_Windows]] page.

== Getting VLC or x264 source code via Git ==

$ git clone git://git.videolan.org/vlc.git
Voilà! The full VLC history should be on your hard disk in vlc/.

$ git clone git://git.videolan.org/x264.git
Voilà! The full x264 history should be on your hard disk in x264/.

If you want only the last 3 VLC revisions:
$ git clone git://git.videolan.org/vlc.git --depth 3

Clones without the full revision set (--depth) can't be used for backporting (or make sure to that you're including at least commits up to the common fork point).

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

=== After cloning ===

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

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

== Configure your global git config ==
May need to use
$ git repo-config {various options}
1.4.4.2 Requires the repo-config command rather than just config

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

If you wish to give credit to someone else's work (e.g. you are applying a third party patch):
$ git commit <specific files> --author "Name Surname <user@domain.com>"

== List your commits ==
$ git log

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

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

Now you can just type:
$ git up

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

== Submitting patches to the vlc-devel or x264-devel ==

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

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

For x264, do the same with x264-devel@videolan.org


Don't do:
* [PATCH 0/m]
** [PATCH 1/m]
*** [PATCH 2/m]
**** ...
But do:
* [PATCH 0/m]
** [PATCH 1/m]
** [PATCH 2/m]
** ..

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

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

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

If warnings appear that files still need updating:
$ include/libvlc_internal.h: needs update
include/mediacontrol_internal.h: needs update
include/vlc/libvlc.h: needs update
include/vlc_update.h: needs update
modules/access/mms/mms.c: needs update
...

Then do a checkout -f to revert non committed local changes
$ git checkout -f

To stay up-to-date another
$ git pull --rebase
Should give no more warnings.

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

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

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

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

== Backporting commits ==
It is possible to "backport" commit between the master branch and a -bugfix branch. However since VDD'09, the bugfix branches have been splitted to their own git repositories. This leaves us with 2 cases.

=== Normal simple case ===

Go to your -bugfix branch:
$ git checkout 1.0-bugfix

Backport the commit:
$ git cherry-pick -x -s <sha-id of commit>

If git fails to do the backport by itself, you'll be presnted with the usual options in case of a failed merge or patching. Use "git status", your favorite editor or "git mergetool" to resolve the situation. Then use "git add" and "git commit -c <sha-id of backported commit>".
Then push your commit as usual.

=== Case of VLC bugfix branches ===
Due to the number of commits in vlc.git and the amount of divergence between the master and 1.0-bugfix branches, they have been separated into two different git repositories. But that doesn't block you from backporting.

Get the -bugfix git:
$ git clone git://git.videolan.org/vlc/vlc-1.0.git vlc-bugfix
Add vlc.git as an additional remote:
$ git remote add vlc-master git://git.videolan.org/vlc.git
Update the information from vlc-master
$ git fetch vlc-master
Backport as normal
$ git cherry-pick -x -s <sha-id of commit>

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

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

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

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

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

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

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

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

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

== Patch-ing ==
* You can apply patches using
$ git apply <patch>

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

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

= Using Git to push to VideoLAN git =
== Initial requirements ==
* You must have credentials to push commits into the repository. For other contributors, please read upper [[Git#Submitting_patches_to_the_vlc-devel_or_x264-devel|Submitting patches to the vlc-devel or x264-devel]] paragraph.
* Make sure you've set your name and email in your commits
$ git config --global user.name "Your Name"
$ git config --global user.email "me@example.com"

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

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

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

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

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



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

[[Category:Building]]

Python bindings

2010-09-30T16:48:54Z

Rogerdpack: add ext. link

= Python bindings =

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

== Features ==

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

== Download ==

You can download the [http://git.videolan.org/?p=vlc/bindings/python.git;a=tree;f=generated;b=HEAD vlc.py] module from the Git repository. It only depends on ctypes (standard module in python >= 2.5). Put the module in some place accessible by python (either next to your application, or in a directory from sys.path).

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

== Usage ==

The vlc.py module also contains a runnable example player application (see code at the end of the module, starting from the line "if __name__ == '__main__').

A helper module [http://git.videolan.org/?p=vlc.git;a=blob;f=bindings/python-ctypes/vlcwidget.py;hb=HEAD vlcwidget.py] provides a pygtk VLCWidget() to ease integration.

Note that you'll need to pass it an argument, like "e:\" for it to play.

== Projects using this binding ==

http://code.google.com/p/movie-content-editor/

== FAQ ==

=== Win32 initialization ===

If the vlc modules are not installed in their standard location (e.g. c:\\Program Files\\Videolan on Windows, or /usr/lib/vlc on linux), the VLC module cannot find them.

When instanciating vlc.Instance() with no parameter, it tries to guess the location of the modules. However, if you pass any argument to vlc.Instance(), you will need to supply the appropriate "--plugin-path=/path/to/the/modules" yourself.

Win32CompileMSYSTroubleShooting

2010-09-23T16:16:35Z

Rogerdpack:

This is a list of various errors that have occurred "over the years" during [[Win32CompileMSYSNew|building VLC with windows]], with their resolutions. Of course, if it's not here, google is your friend.

"unix2dos" command not found: this meant "you forgot to install mingw-utils"

*It doesn't link, and complains about missing gcc symbols: You missed this line in the instructions:

Use text editor to change MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la file (line should be library_names='') due to bug in latest MinGW.''

Originally, there was apparently a bug with 4.4.0 GCC (not 4.4.1), fixed thus (except that in reality, you must use TDM, not vanilla GCC, because you need sljl exception handling):

''Then, update Mingw GCC to 4.4.0 by downloading http://sourceforge.net/projects/mingw/files/GCC%20Version%204/gcc-full-4.4.0-mingw32-bin-2.tar.lzma/download and extracting it to C:\Mingw (replacing files when asked). Finally, you'll gave to fix the file C:\MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la by opening it and changing the line defining library_names so that it reads <code><nowiki>library_names=''</nowiki></code>''

*Compilation stops early, after configure was complaining about mismatched quotes:

Check the VLC_COMPILE_HOST variable in your config.h - if it's ''Option f is not valid'' then ''hostname -f'' fails (on Windows, there is no such option as -f). In configure.ac change
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])</pre>
to
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])</pre>
*If compile complains about a config.h and pthread.h not found problem, just delete config.h
*If building self-contained packages fails with ''make: zip: Command not found'' then download the following file and extract it to C:\Msys\1.0 :
*http://www.mirrorservice.org/sites/download.sourceforge.net/pub/sourceforge/m/project/mi/mingw/MSYS/zip/zip-3.0-1/zip-3.0-1-msys-1.0.14-bin.tar.lzma
*If building self-contained packages fails with ''make: 7z: Command not found'' then copy 7z.exe from C:\Program Files\7-Zip in to C:\Msys\1.0\bin
*If building self-contained packages fails with ''Error: cannot locate makensis tool'' then use:
<pre>PATH=/c/Program\ Files/NSIS/:$PATH make package-win32</pre>

Win32CompileMSYSTroubleShooting

2010-09-22T22:55:09Z

Rogerdpack:

This is a list of various errors that have occurred "over the years" during [[Win32CompileMSYSNew|building VLC with windows]], with their resolutions. Of course, if it's not here, google is your friend.

*It doesn't link, and complains about missing gcc symbols: You missed this line in the instructions:

Use text editor to change MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la file (line should be library_names='') due to bug in latest MinGW.''

Originally, there was apparently a bug with 4.4.0 GCC, fixed thus (except that in reality, you must use TDM, not vanilla GCC, because you need sljl exception handling):

''Then, update Mingw GCC to 4.4.0 by downloading http://sourceforge.net/projects/mingw/files/GCC%20Version%204/gcc-full-4.4.0-mingw32-bin-2.tar.lzma/download and extracting it to C:\Mingw (replacing files when asked). Finally, you'll gave to fix the file C:\MinGW\lib\gcc\mingw32\4.4.0\libstdc++.la by opening it and changing the line defining library_names so that it reads <code><nowiki>library_names=''</nowiki></code>''

*Compilation stops early, after configure was complaining about mismatched quotes:

Check the VLC_COMPILE_HOST variable in your config.h - if it's ''Option f is not valid'' then ''hostname -f'' fails (on Windows, there is no such option as -f). In configure.ac change
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname -f 2> /dev/null || hostname`", [host which ran configure])</pre>
to
<pre>AC_DEFINE_UNQUOTED(VLC_COMPILE_HOST, "`hostname`", [host which ran configure])</pre>
*If compile complains about a config.h and pthread.h not found problem, just delete config.h
*If building self-contained packages fails with ''make: zip: Command not found'' then download the following file and extract it to C:\Msys\1.0 :
*http://www.mirrorservice.org/sites/download.sourceforge.net/pub/sourceforge/m/project/mi/mingw/MSYS/zip/zip-3.0-1/zip-3.0-1-msys-1.0.14-bin.tar.lzma
*If building self-contained packages fails with ''make: 7z: Command not found'' then copy 7z.exe from C:\Program Files\7-Zip in to C:\Msys\1.0\bin
*If building self-contained packages fails with ''Error: cannot locate makensis tool'' then use:
<pre>PATH=/c/Program\ Files/NSIS/:$PATH make package-win32</pre>