VideoLAN Wiki - User contributions [en]

Win32CompileMSYSNew

2012-02-28T08:40:46Z

Smowton: /* Glib and PKG-CONFIG */ Note yet more missing build instructions

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

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/msysdev/autoconf/autoconf-2.68-1/autoconf-2.68-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/automake/automake-1.11.1-1/automake-1.11.1-1-msys-1.0.13-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/libtool/libtool-2.4-1/libtool-2.4-1-msys-1.0.15-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/Extension/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/Extension/m4/m4-1.4.14-1/m4-1.4.14-1-msys-1.0.13-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

'''Note''': I found that compiling 2.1.0 requires xgettext, msgmerge, msgfmt and so on. These in turn require libiconv. I'm not sure if that suffices as at this point I gave up.

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

== New contrib system ==

'''This is the preferred way, especially if using a source version >= 2.1'''

* Go into vlc_dir/contrib

'''Important note here''': i586-mingw32msvc is just an example, the actual name must match your target system triplet, as printed by /vlc/source/root/autotools/config.guess. For example, I needed to name this 'i686-pc-mingw32'. You can also see this test near the top of config.log: if your contrib/ directory is wrongly named, configure will not find any of your prebuilt contrib libraries (the first failure will be Lua, in my case).

$ mkdir win32 && cd win32
$ ../bootstrap --build=i586-mingw32msvc
$ make prebuilt

'''Note''': it used to say "if tar complains, just ignore it" here. For me tar didn't just complain but died, because it was trying to unpack symlinks to non-existent absolute paths. I had to manually execute the rest of the prebuilt target, which consists of

$ mv i586-pc-something ..
$ cd ../i586-pc-something
$ change_prefix.sh

I also found that change_prefix.sh, which rewrites .pc files to deal with their chosen location, used the -i option which is not supported by MSYS-shipped sed. I rewrote the sed script to write changes $file.new then mv $file.new $file.

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

'''Note''': Any of these paths that mention '''/usr/win32''' are assuming you're using the OLD contribs method. If you're using the new method, the appropriate path will be more like /path/to/vlc/source/contrib/i686-pc-mingw32/...

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

'''Note''': for version 2.1.0 at least this file is called configure.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

2012-02-28T07:07:33Z

Smowton: /* New contrib system */ Note more MSYS install errata

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

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/msysdev/autoconf/autoconf-2.68-1/autoconf-2.68-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/automake/automake-1.11.1-1/automake-1.11.1-1-msys-1.0.13-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/libtool/libtool-2.4-1/libtool-2.4-1-msys-1.0.15-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/Extension/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/Extension/m4/m4-1.4.14-1/m4-1.4.14-1-msys-1.0.13-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 =

== New contrib system ==

'''This is the preferred way, especially if using a source version >= 2.1'''

* Go into vlc_dir/contrib

'''Important note here''': i586-mingw32msvc is just an example, the actual name must match your target system triplet, as printed by /vlc/source/root/autotools/config.guess. For example, I needed to name this 'i686-pc-mingw32'. You can also see this test near the top of config.log: if your contrib/ directory is wrongly named, configure will not find any of your prebuilt contrib libraries (the first failure will be Lua, in my case).

$ mkdir win32 && cd win32
$ ../bootstrap --build=i586-mingw32msvc
$ make prebuilt

'''Note''': it used to say "if tar complains, just ignore it" here. For me tar didn't just complain but died, because it was trying to unpack symlinks to non-existent absolute paths. I had to manually execute the rest of the prebuilt target, which consists of

$ mv i586-pc-something ..
$ cd ../i586-pc-something
$ change_prefix.sh

I also found that change_prefix.sh, which rewrites .pc files to deal with their chosen location, used the -i option which is not supported by MSYS-shipped sed. I rewrote the sed script to write changes $file.new then mv $file.new $file.

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

'''Note''': Any of these paths that mention '''/usr/win32''' are assuming you're using the OLD contribs method. If you're using the new method, the appropriate path will be more like /path/to/vlc/source/contrib/i686-pc-mingw32/...

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

'''Note''': for version 2.1.0 at least this file is called configure.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

2012-02-28T06:51:46Z

Smowton: /* Build VLC */ Note MSYS install errata

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

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/msysdev/autoconf/autoconf-2.68-1/autoconf-2.68-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/automake/automake-1.11.1-1/automake-1.11.1-1-msys-1.0.13-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/msysdev/libtool/libtool-2.4-1/libtool-2.4-1-msys-1.0.15-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/Extension/perl/perl-5.8.8-1/perl-5.8.8-1-msys-1.0.17-bin.tar.lzma/download
*http://sourceforge.net/projects/mingw/files/MSYS/Extension/m4/m4-1.4.14-1/m4-1.4.14-1-msys-1.0.13-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 =

== New contrib system ==

'''This is the preferred way, especially if using a source version >= 2.1'''

* Go into vlc_dir/contrib

$ mkdir win32 && cd win32
$ ../bootstrap --build=i586-mingw32msvc
$ make prebuilt

If tar complains, just ignore it.

Now wait...

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

'''Note''': Any of these paths that mention '''/usr/win32''' are assuming you're using the OLD contribs method. If you're using the new method, the appropriate path will be more like /path/to/vlc/source/contrib/i686-pc-mingw32/...

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

'''Note''': for version 2.1.0 at least this file is called configure.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:Streaming HowTo/Streaming for the iPhone

2012-02-27T02:31:18Z

Smowton:

{{RightMenu|documentation streaming howto toc}}

Note: this functionality is intended to be part of the 1.2 release, so at the time of writing it is only available in nightly builds.

== Streaming for the iPhone ==

This functionality allows you to link VLC's transcoding capability with a segmenter which will in turn create the series of files needed for http live streaming to the iPhone.

Unlike most of VLC's streaming, it doesn't actually stream the files, but assumes that you have your own webserver which will do that job.

Notes from the developer:
*This has only been tested using H.264 w/MP3 or AAC audio using mux=ts, and raw MP3 using mux=raw
*I've been mostly an FFMPEG guy till now, so forgive me if my VLC understanding/terminology is somewhat off.
*This plug-in should support both Live and non-live HTTP Live streaming feeds, depending on the options passed to the module.

Notes from the community:
*The user running vlc needs to have read/write/delete permissions on the directory where the .m3u8 playlist and .ts file segments will be created and deleted on the webserver.

=== Instructions ===

The name of the module is livehttp, and is specified by specifying "access=livehttp"

=== Options ===

splitanywhere= (default: false)
*Tells livehttp to split the stream anywhere, not just on video keyframes. Currently required to be set to true for audio-only streams and not recommended (probably won't work) for video streams.

seglen= (default: 10)
*How many seconds of audio/video each segment should contain. Apple recommends 10, I have been using 5.

numsegs=(default: 0)
*The number of segments to keep in the index file. The default of 0 keeps all segments in the index (which you would want for non-live streaming). For live streaming the specification require at least 3.

delsegs= (default: true)
*Delete segments as they are no longer needed. If numsegs=0 this parameter is ignored (as all segments are assumed to be needed)

dst=
*This is actually an option to the access std module. The path of the segment files to write. The # characters get replaced with the segment number. So a path of "seg-###.ts" will end up with files called "seg-001.ts, seg-002.ts, seg-003.ts" etc.

index=
*The path of the index file to write, which will contain the "playlist" of video/audio segments to stream. Recommended to end in .m3u8 by specifications. This is the file the <video> tag should be pointed to.

index-url=
*This is the URL that corresponds to the dst above (how a browser would access the dst file). The # characters get replaced same as in the dst parameter. Note: The filename portion of this URL will most likely need to be in the exact same format as the dst parameter. So for example if dst=/www/seg-##.ts then the index-url should be something like index-url=http://mydomain.com/streams/seg-##.ts (Note the same number of # characters)

ratecontrol=(default: false)
*If set to false the there is no rate control (the muxer sends the data as fast/slow as it can to the streamer). If set to true the muxer should do rate-control to control the speed to muxed audio/video is sent to the streamer. Recommended setting is false in most cases. The only time I've needed this set to true is while doing a live sliding window stream of a local media file.

=== Examples ===
All examples assume the following:
*The Web Server root directory is /var/www
*The domain name of the web server is mydomain.com
*The stream segments & index files will be written into /var/www/streaming/ and will be accessed via http://mydomain.com/streaming/...
*The destination stream name index file will be called "mystream.m3u8"
*The following HTML will allow you to view the video based on the above on an iPhone:

Re-stream a live video feed:
% '''vlc -I dummy --mms-caching 0 http://www.nasa.gov/55644main_NASATV_Windows.asx vlc://quit --sout='#transcode{width=320,height=240,fps=25,vcodec=h264,vb=256,venc=x264{aud,profile=baseline,level=30,keyint=30,ref=1},acodec=mp3,ab=96}:std{access=livehttp{seglen=10,delsegs=true,numsegs=5,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.ts},mux=ts{use-key-frames},dst=/var/www/streaming/mystream-########.ts}' '''

Create a VOD stream:
(Non-live. When this command finishes, all the segments should have been created and the index file contain pointers to all of them)
% '''vlc -I dummy /var/myvideos/video.mpg vlc://quit --sout='#transcode{width=320,height=240,fps=25,vcodec=h264,vb=256,venc=x264{aud,profile=baseline,level=30,keyint=30,ref=1},acodec=mp3,ab=96}:std{access=livehttp{seglen=10,delsegs=false,numsegs=0,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.ts},mux=ts{use-key-frames},dst=/var/www/streaming/mystream-########.ts}' '''

Re-stream a live audio feed:
% '''vlc -I dummy --mms-caching 0 http://www.nasa.gov/55644main_NASATV_Windows.asx vlc://quit --sout='#transcode{acodec=mp3,ab=96}:duplicate{dst=std{access=livehttp{seglen=10,delsegs=true,numsegs=5,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.mp3},mux=raw,dst=/var/www/streaming/mystream-########.mp3},select=audio}' '''

'''Note:''' I found that these example don't work as written here; I won't edit them in place as they might work in different circumstances. I found two problems using the released version of VLC 2.0.0 on WinXP:

1. All examples need to have the single quotes surrounding the --sout parameter removed. Otherwise VLC complains "stream_out_standard stream out error: no mux specified or found by extension".

2. The final example is audio-only, but does not specify the splitanywhere=true flag. As a result it writes one massive chunk waiting for a keyframe that never comes.

Example commandline that did work for me:
% vlc -I dummy x:\some\audio\here.ogg vlc://quit --sout=#transcode{acodec=mp3,ab=96}:duplicate{dst=std{access=livehttp{seglen=10,splitanywhere=true,delsegs=true,numsegs=5,index=c:\temp\mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.mp3},mux=raw,dst=c:\temp\mystream-########.mp3},select=audio}

[[User:Smowton|Smowton]] 03:23, 27 February 2012 (CET)

===Formats supported by the iOS===
See the [[iPhone]] article for a list of supported codecs as well as [http://developer.apple.com/iphone/library/documentation/networkinginternet/conceptual/streamingmediaguide/FrequentlyAskedQuestions/FrequentlyAskedQuestions.html Apple's HTTP Live Streaming FAQ].

===Possible improvements/fixes===

from the developer:
*Have the module auto-detect audio only streams, so the splitanywhere option is not required.
*I'm not sure I am doing the right thing with the Win32 rename function. Linux (I believe) allows me to rename a file over an existing file, even if the existing file is in use. Win32 is not so friendly. This ability is useful for updating the index file at same time it may be currently being read by the HTTP server serving the files.
*Break the dst= and index= parameter into seperate filename/directory entries, so you only need to specify the filename format once. (instead of once for the dst= parameter, and once for the index-url= parameter)

from the community:
*Have the module detect the codecs used and warn the end user if they are not compatible with the iPhone/iPod Touch/iPad.
*Possible multibitrate implementation that meets the iPhone SDK specs so app developers can use VLC to host streams for their apps.

fixes:
*Audio only streams do not validate with Apple's mediastreamvalidator. Audio streams are missing id3tags and timestamps. Check with command, "mediastreamvalidator validate --timeout=60 [url]"

{{Documentation}}

Documentation:Streaming HowTo/Streaming for the iPhone

2012-02-27T02:23:28Z

Smowton: Note possible error in documented command-line

{{RightMenu|documentation streaming howto toc}}

Note: this functionality is intended to be part of the 1.2 release, so at the time of writing it is only available in nightly builds.

== Streaming for the iPhone ==

This functionality allows you to link VLC's transcoding capability with a segmenter which will in turn create the series of files needed for http live streaming to the iPhone.

Unlike most of VLC's streaming, it doesn't actually stream the files, but assumes that you have your own webserver which will do that job.

Notes from the developer:
*This has only been tested using H.264 w/MP3 or AAC audio using mux=ts, and raw MP3 using mux=raw
*I've been mostly an FFMPEG guy till now, so forgive me if my VLC understanding/terminology is somewhat off.
*This plug-in should support both Live and non-live HTTP Live streaming feeds, depending on the options passed to the module.

Notes from the community:
*The user running vlc needs to have read/write/delete permissions on the directory where the .m3u8 playlist and .ts file segments will be created and deleted on the webserver.

=== Instructions ===

The name of the module is livehttp, and is specified by specifying "access=livehttp"

=== Options ===

splitanywhere= (default: false)
*Tells livehttp to split the stream anywhere, not just on video keyframes. Currently required to be set to true for audio-only streams and not recommended (probably won't work) for video streams.

seglen= (default: 10)
*How many seconds of audio/video each segment should contain. Apple recommends 10, I have been using 5.

numsegs=(default: 0)
*The number of segments to keep in the index file. The default of 0 keeps all segments in the index (which you would want for non-live streaming). For live streaming the specification require at least 3.

delsegs= (default: true)
*Delete segments as they are no longer needed. If numsegs=0 this parameter is ignored (as all segments are assumed to be needed)

dst=
*This is actually an option to the access std module. The path of the segment files to write. The # characters get replaced with the segment number. So a path of "seg-###.ts" will end up with files called "seg-001.ts, seg-002.ts, seg-003.ts" etc.

index=
*The path of the index file to write, which will contain the "playlist" of video/audio segments to stream. Recommended to end in .m3u8 by specifications. This is the file the <video> tag should be pointed to.

index-url=
*This is the URL that corresponds to the dst above (how a browser would access the dst file). The # characters get replaced same as in the dst parameter. Note: The filename portion of this URL will most likely need to be in the exact same format as the dst parameter. So for example if dst=/www/seg-##.ts then the index-url should be something like index-url=http://mydomain.com/streams/seg-##.ts (Note the same number of # characters)

ratecontrol=(default: false)
*If set to false the there is no rate control (the muxer sends the data as fast/slow as it can to the streamer). If set to true the muxer should do rate-control to control the speed to muxed audio/video is sent to the streamer. Recommended setting is false in most cases. The only time I've needed this set to true is while doing a live sliding window stream of a local media file.

=== Examples ===
All examples assume the following:
*The Web Server root directory is /var/www
*The domain name of the web server is mydomain.com
*The stream segments & index files will be written into /var/www/streaming/ and will be accessed via http://mydomain.com/streaming/...
*The destination stream name index file will be called "mystream.m3u8"
*The following HTML will allow you to view the video based on the above on an iPhone:

Re-stream a live video feed:
% '''vlc -I dummy --mms-caching 0 http://www.nasa.gov/55644main_NASATV_Windows.asx vlc://quit --sout='#transcode{width=320,height=240,fps=25,vcodec=h264,vb=256,venc=x264{aud,profile=baseline,level=30,keyint=30,ref=1},acodec=mp3,ab=96}:std{access=livehttp{seglen=10,delsegs=true,numsegs=5,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.ts},mux=ts{use-key-frames},dst=/var/www/streaming/mystream-########.ts}' '''

Create a VOD stream:
(Non-live. When this command finishes, all the segments should have been created and the index file contain pointers to all of them)
% '''vlc -I dummy /var/myvideos/video.mpg vlc://quit --sout='#transcode{width=320,height=240,fps=25,vcodec=h264,vb=256,venc=x264{aud,profile=baseline,level=30,keyint=30,ref=1},acodec=mp3,ab=96}:std{access=livehttp{seglen=10,delsegs=false,numsegs=0,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.ts},mux=ts{use-key-frames},dst=/var/www/streaming/mystream-########.ts}' '''

Re-stream a live audio feed:
% '''vlc -I dummy --mms-caching 0 http://www.nasa.gov/55644main_NASATV_Windows.asx vlc://quit --sout='#transcode{acodec=mp3,ab=96}:duplicate{dst=std{access=livehttp{seglen=10,delsegs=true,numsegs=5,index=/var/www/streaming/mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.mp3},mux=raw,dst=/var/www/streaming/mystream-########.mp3},select=audio}' '''

'''Note:''' I found that these example don't work as written here, but need to have the single quotes surrounding the --sout parameter removed. Otherwise VLC complains "stream_out_standard stream out error: no mux specified or found by extension". This was using the released version of VLC 2.0.0 on WinXP.

Example commandline that did work for me:
% vlc -I dummy x:\some\audio\here.ogg vlc://quit --sout=#transcode{acodec=mp3,ab=96}:duplicate{dst=std{access=livehttp{seglen=10,delsegs=true,numsegs=5,index=c:\temp\mystream.m3u8,index-url=http://mydomain.com/streaming/mystream-########.mp3},mux=raw,dst=c:\temp\mystream-########.mp3},select=audio}

[[User:Smowton|Smowton]] 03:23, 27 February 2012 (CET)

===Formats supported by the iOS===
See the [[iPhone]] article for a list of supported codecs as well as [http://developer.apple.com/iphone/library/documentation/networkinginternet/conceptual/streamingmediaguide/FrequentlyAskedQuestions/FrequentlyAskedQuestions.html Apple's HTTP Live Streaming FAQ].

===Possible improvements/fixes===

from the developer:
*Have the module auto-detect audio only streams, so the splitanywhere option is not required.
*I'm not sure I am doing the right thing with the Win32 rename function. Linux (I believe) allows me to rename a file over an existing file, even if the existing file is in use. Win32 is not so friendly. This ability is useful for updating the index file at same time it may be currently being read by the HTTP server serving the files.
*Break the dst= and index= parameter into seperate filename/directory entries, so you only need to specify the filename format once. (instead of once for the dst= parameter, and once for the index-url= parameter)

from the community:
*Have the module detect the codecs used and warn the end user if they are not compatible with the iPhone/iPod Touch/iPad.
*Possible multibitrate implementation that meets the iPhone SDK specs so app developers can use VLC to host streams for their apps.

fixes:
*Audio only streams do not validate with Apple's mediastreamvalidator. Audio streams are missing id3tags and timestamps. Check with command, "mediastreamvalidator validate --timeout=60 [url]"

{{Documentation}}