VideoLAN Wiki - User contributions [en]

Hacker Guide/Access

2010-11-11T17:04:12Z

Geal:

== Description ==

The modules of ''''access'''' capability are designed to be the first and last elements of a modules chain.

Access [[Documentation:Hacker's Guide/Access|input]] and [[Documentation:Hacker's Guide/Access output|output]] handles most of the basic '''I/O''' for VLC. They are usually '''protocols''' implementations (http, ftp,...) or '''devices''' access (Webcams, Capture cards).

We will discuss about ''''input access'''' in this page.

== Write an access module ==

To write an access module, read the [[Documentation:Hacker's Guide/Module Writers Guide|introduction to module writing]].

Then, you should specify your module of being of access type:

set_capability( "access", 60 )
set_category( CAT_INPUT )
set_subcategory( SUBCAT_INPUT_ACCESS )

Your module can be of either a ''''Block'''' or a ''''Read'''' type, depending on what you need to access.

== Functions to implement ==

After implementing Open() and Close() functions, you will need to implement a few majors features that will be implemented by your functions.

As you can see {{VLCSourceFile|name=include/vlc_access.h}}, you should define:

*Seek, as in pf_seek
*Control, as in pf_control
*Read or Block, depending on your module type

After implementing those functions, you should assign them to the corresponding pf_ function.

== Seek ==

''Prototype'':

int (*pf_seek) ( access_t *, uint64_t );

The seeking function will be called whenever a seek is requested.

The arguments are a ''pointer'' to the module structure, and the requested '''position'''.

'''NB:''' Seeking function can be NULL, if it isn't possible to seek in the protocol or device.

''Return:''<br>

If the seek has succeeded, it should return VLC_SUCCESS, else it should return VLC_EGENERIC. <br>

== Control ==

''Prototype'':

int (*pf_control)( access_t *, int i_query, va_list args);

Control function is quite easy, the input core will query the module using this function with:

*A pointer to the module structure.
*An '''i_query''' parameter that can be of several type. We will cover afterward the most important on.
*A list of arguments, that depends on the '''i_query''' type.

''Return'':

If the query has succeeded, it should return VLC_SUCCESS. Else it should return VLC_EGENERIC (''fail'').

=== Control Query types ===

The first ones are request to know what the module supports. They are all of '''boolean''' type and should always succeed.

ACCESS_CAN_SEEK,
ACCESS_CAN_FASTSEEK,
ACCESS_CAN_PAUSE,
ACCESS_CAN_CONTROL_PACE,

<br> The following one is a request for the '''PTS delay'''. It must always succeed.

ACCESS_GET_PTS_DELAY,

<br> The following ones are for '''requesting''' various '''info''' about the input, like Metadata, Titles and Chapters or device signal strength. All of them can fail.

ACCESS_GET_TITLE_INFO,
ACCESS_GET_META,
ACCESS_GET_CONTENT_TYPE,
ACCESS_GET_SIGNAL,

<br> Depending to the answer of the CAN_ requests, the core can '''set''' a few things, like pausing or changing '''title''' or '''chapter'''

ACCESS_SET_PAUSE_STATE,
ACCESS_SET_TITLE,
ACCESS_SET_SEEKPOINT,

You can find the list of arguments corresponding to query types in the comments of access_query_e definition in vlc_access.h

== Read ==

''Prototype'':

ssize_t (*pf_read) ( access_t *, uint8_t *, size_t );

''Return'':

Return -1 if no data yet, 0 if no more data, else actual data read on the medium.

== Block ==

''Prototype'':

block_t *(*pf_block)( access_t * );

''Return:''

Returns a block of data in his 'natural' size. It will return NULL if not yet data or eof.

Win32Compile

2010-05-03T21:19:46Z

Geal: pkgconfig files also contain absolute paths

From http://developers.videolan.org/vlc/vlc/INSTALL.win32

$Id: INSTALL.win32 15707 2006-05-22 09:42:08Z xtophe $
INSTALL file for the Windows9x/Me/NT4/2k/XP version of the VLC media player

==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 GNU/Linux
| None
| '''Preferred''' method (uses cross compilation)
|-
| Native-compile with [http://www.mingw.org MSYS+MINGW]
| [[Win32CompileMSYSNew]]
| '''Preferred''' 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).
|-
| Native-compile with [http://www.cygwin.com Cygwin]
| [[Win32CompileCygwinNew]]
| '''Working''' native compilation method
|-
| Native-compile with Microsoft Visual C++
| None
|
'''Not advised.''' <P>
Even though VLC includes some MSVC project files, this method is advised only if you just want to experiment/play with some basic functionality in VLC. VLC depends on a lot of third-party libraries and building them in MSVC is inconvenient (and in some cases, impossible). <BR>
If you want to run VLC under the MSVC debugger, use <CODE>--fast-mutex --win9x-cv-method=1</CODE> because the debugger usually loses signals sent by PulseEvent().
|}

==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 mingw32 mingw32-binutils</CODE>, however building FFmpeg now requires mingw32-runtime >= 3.15 and w32api >= 3.13 so these will have to be updated manually.
*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]]
|-

|}

==Saving time by using pre-built libraries==

VLC requires other open source projects to provide some features (like AC3 audio decoding and MPEG-4 video decoding). A complete list of required libraries from these projects can be found at http://developers.videolan.org/vlc/. Depending on your needs, you must either build your own versions of these libraries or use VLC's convenient pre-built versions.

If you feel you must build these libraries from source, the blessed source code may be found at http://download.videolan.org/pub/testing/contrib/. An automated way of building the contrib libraries is provided in extra/contrib. It will download, configure, and build the libraries. See the extras/contrib/README for more info.

If you want to save yourself time and energy by using 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 . The pre-built versions will ''only work with MINGW or Cygwin''. Note that the version you download must match that of the MINGW compiler, <CODE>i586-mingw32msvc-gcc</CODE>, which you can verify by typing <CODE>'i586-mingw32msvc-gcc --ver'</CODE>.

There are two installation strategies:

{| class="wikitable"
! Location
! Command
! Advantages
! Disadvantages
|-
| Install the pre-built libraries into the Cygwin standard directories (/usr/win32/*)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /</CODE> (Note the <CODE>"-C /"</CODE>!)
|
*Shorter initial setup time
|
*May conflict with other headers/libraries in the standard directories
*Difficult to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries (Installing over the top of older versions is highly discouraged!)
|-
| Install the pre-built libraries into a project-specific directory (e.g., <CODE>D:\VLC</CODE>)
| <CODE>tar jxf contrib-20061122-win32-bin-gcc-3.4.5-only.tar.bz2 -C /cygdrive/d/VLC</CODE>
|
*No conflicts with other projects built under Cygwin
*Easy to get rid of if you want to free up space or to upgrade to the next version of the pre-built libraries
*For multi-person projects, easy to put under revision control to ensure all project members are using the correct pre-built versions
|
*Requires that you set <CODE>CPPFLAGS</CODE>, <CODE>LDFLAGS</CODE> appropriately when building
*Requires that you modify hard-coded paths in the pre-built libraries (see below)
|}

If installing into a project-specific directory, you must modify some hard-coded paths in the pre-build libraries as follows:
<PRE>
CONTRIBS=/cygdrive/d/VLC
for file in $CONTRIBS/bin/*-config $CONTRIBS/lib/*.la $CONTRIBS/lib/pkgconfig/*.pc ; do
perl -i.bak -p -e 's|/usr/win32|$ENV{"CONTRIBS"}|g' $file
done
</PRE>

==Configuring the build==

Once you've got all the files you need in place, you need to configure the build with the <CODE>configure</CODE> script. In the following examples, assume that the third-party libraries are installed in <CODE>$CONTRIBS</CODE>. If installed in the Cygwin standard directories, use <CODE>export CONTRIBS=/usr/win32</CODE>. Otherwise use <CODE>export CONTRIBS=/cygdrive/d/VLC</CODE>.

If you are cross-compiling under GNU/Linux, you can use something along these lines:

./bootstrap && \
export PKG_CONFIG_LIBDIR=$CONTRIBS/lib/pkgconfig PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=i586-mingw32msvc-cpp \
LDFLAGS=-L$CONTRIBS/lib \
CC=i586-mingw32msvc-gcc CXX=i586-mingw32msvc-g++
./configure --host=i586-mingw32msvc --build=i386-linux \
--disable-[[gtk]] \
--enable-[[nls]] --enable-[[sdl]] --with-sdl-config-path=$CONTRIBS/bin \
--enable-[[ffmpeg]] --with-ffmpeg-mp3lame --with-ffmpeg-[[faac]] \
--with-ffmpeg-[[zlib]] --enable-[[faad]] --enable-[[flac]] --enable-[[theora]] \
--with-[[wx]]-config-path=$CONTRIBS/bin \
--with-[[freetype]]-config-path=$CONTRIBS/bin \
--with-[[fribidi]]-config-path=$CONTRIBS/bin \
--with-[[libgcrypt]]-prefix=$CONTRIBS \
--enable-[[live555]] --with-live555-tree=$CONTRIBS/live.com \
--enable-[[caca]] --with-caca-config-path=$CONTRIBS/bin \
--with-[[xml2]]-config-path=$CONTRIBS/bin \
--with-[[dvdnav]]-config-path=$CONTRIBS/bin \
--disable-[[cddax]] --disable-[[vcdx]] --enable-[[goom]] \
--enable-[[twolame]] --enable-[[dvdread]] \
--enable-[[debug]]

If you are using cygwin, you can build VLC with or without the POSIX emulation layer. Without is usually better and with POSIX emulation hasn't been tested in over a year. So to build without the emulation layer, use something like this:

./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
CC='gcc -mno-cygwin' CXX='g++ -mno-cygwin' \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-live555 --with-live555-tree=$CONTRIBS/live.com \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug

If you want to use the emulation layer, then just omit <CODE>CFLAGS</CODE> and <CODE>CXXFLAGS</CODE>. You're on your own, though.

If you are compiling with MSYS/MINGW, then you can use something along those lines:
./bootstrap && \
export PKG_CONFIG_PATH=$CONTRIBS/lib/pkgconfig \
CPPFLAGS="-I$CONTRIBS/include -I$CONTRIBS/include/ebml" CXXCPP=$CPPFLAGS \
LDFLAGS=-L$CONTRIBS/lib \
./configure \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=$CONTRIBS/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=$CONTRIBS/bin \
--with-freetype-config-path=$CONTRIBS/bin \
--with-fribidi-config-path=$CONTRIBS/bin \
--enable-caca --with-caca-config-path=$CONTRIBS/bin \
--with-xml2-config-path=$CONTRIBS/bin \
--with-dvdnav-config-path=$CONTRIBS/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--disable-[[mkv]] \
--enable-debug

If you have used the "extras/contrib" way, you don't need to specify <CODE>CFLAGS</CODE>, <CODE>LDFLAGS</CODE> and <CODE>--with-foo-config-path=</CODE>.
./bootstrap && \
./configure \
--disable-gtk \
--enable-nls --enable-sdl \
--enable-ffmpeg --enable-faad --enable-flac --enable-theora \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-mkv --enable-caca --enable-live555\
--enable-debug

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-base</CODE>
| 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-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 Dev Projects

2010-01-30T19:37:30Z

Geal: /* Normal small projects */

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

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

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

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

= Easy projects =

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

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

== Code Janitorial ==

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

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

== Video Filters ==

You can do video filters for {{VLC}}.

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

You can start the code [http://git.videolan.org/?p=vlc.git;a=tree;f=modules/video_filter here].

== Audio Filters ==

You can do audio filters for {{VLC}}

You can start the code [http://git.videolan.org/?p=vlc.git;a=tree;f=modules/audio_filter here].

== Lua Playlist parsers for websites ==

VLC already supports youtube, dailymotion or other websites using the .lua scripts! Add new sites and new URLs support!

== Close bugs ==

Go to our bugtracker on http://trac.videolan.org/vlc/ and close a bug !

= Normal small projects =

== Windows Media Center (WMC) IR Remote Control ==

Basic Controls work (e.g. Volume, Mute etc), but I would like to get Play/Pause/Stop/DVD Menu etc to work!

Contact: [[User:Some1|some1]]

== DirectX 9 video output ==

DirectX 9 features some improvements that we could use in our video output

Contact: [[User:Geal|Geal]]

== Direct2D video output ==

Direct2D is a new API introduced in Windows 7. VLC could use a a Direct2D vout.

Contact: [[User:Geal|Geal]]

== DirectWrite support ==

DirectWrite is another API introduced in Windows 7, used to write nicely shaped characters to screen. Someone should look into it, to see what could be done (like subtitles display).

Contact: [[User:Geal|Geal]]

== Pixel shaders in OpenGL video output ==

It would be nice to have a small proof of concept video output which takes care of chroma conversion using pixel shaders.

Contact: [[User:Dionoea|dionoea]]

== mozila and activex javascript api ==

Add a callback to signal playlist state changes such as item started, item ended, next item started, last item ended, and so on.

Contact: [[User:Jpsaman|jpsaman]]

== Improved Podcast support ==

Our current podcast support is very weak. We can read them, but that's all. We need a real infrastructure to handle them correctly. This will require some changes to the playlist code, so you will need to work closely with existing developers.

Contacts: [[User:Dionoea|Dionoea]] [[User:Zorglub|Zorglub]]

== WTV support ==

We would love to have a .wtv demuxer for the new wtv files from Windows Media center

Contact [[User:J-b|jb]]

== Improved ASX support ==

ASX is a playlist format used by Microsoft stuff. We can read it but we could do much better. More information is available at https://trac.videolan.org/vlc/ticket/20

Contact: [[User:Dnumgis|Dnumgis]]

== Hint MP4/MOV Files ==

Add video and audio hint tracks as the output file is muxed. Resulting files can be streamed from RTSP server with trickplay, like DSS/QTSS. Probably requires use of GPAC libraries.

== LastFM radios ==

http://gabistapler.de/blog/index.php?/archives/268-Play-last.fm-streams-without-the-player.html

Talk to dionoea or funman

== ASM optims ==

If you know how to code in x86 ASM, we have a few tasks for you

Contact [[User:J-b|jb]]

== DVD Audio ==

If you are a coder and fan of DVD-Audio, you can help to improve the support of DVD-Audio playback. Especially decryption.

Contact [[User:J-b|jb]]

== Performant VLC streaming server ==

There are many bottlenecks currently limiting the performance and scalability of VLC as a streaming server:

*The I/O blocks are linear, which implies lots of avoidable memory copying and dynamic memory allocations (particularly in the streaming output).
*mdate() (the timestamping function) is invoked in too many places to count them; but it is not a cheap operation on modern systems and should be avoided on the fast path. Ideally, a single thread would only need to call mdate() at most once per wake-up. In some case, mdate() is only used for debugging purpose which is really inefficient.
*The HTTP/RTSP core is single-threaded. This prevents scaling to SMP systems (which are the norm on server-side nowadays) properly. This also implies not very scalable I/O event polling. Finally, this gets problematic if one HTTP/RTSP client triggers a computationally intensive operation (such as establishing a TLS context if HTTP/SSL is used).
*There are many dynamic memory allocations that could be avoided. Video filters and codecs are very careful about this, but the stream output plugins are not. In many case, a stack-based buffer can be used (stack buffer, has constant time fast lock-less allocation, and needs not be freed explicitly) instead.
*The messaging subsystems might be adding more locking (needs checking); this should be avoided particularly if the message is anyway ignord (e.g. debug message in non-debug mode).

Other improvements that would be particularly benefitial on the server side:

*Memory allocation failure are not always duly handled. In some cases, that could potentially be leveraged by a client to crash a VLC server by causing a very large allocation attempt.
*Rewrite and revive the root wrapper to allow VLC to bind to the RTSP (554) port while not retaining root privileges.

Contact: [[User:Courmisch|Courmisch]]

= Finished projects =

== Audioscrobbler ==

An [http://www.audioscrobbler.net/ Audioscrobbler] VLC Plug-in for the social music network [http://www.last.fm Last.Fm]<br>

Plugin is finished, now part of vlc 0.9.0 (development version). Done by [[User:Funman|funman]]

== DVB support for Windows / BDA Drivers ==

DVB is the norm for :

*Digital Terrestrial TV (aka DVB-T)
*Digital Cable TV (aka DVB-C)
*Digital Satellite TV (aka DVB-S)

Several DVB input cards exist. We support these on Linux, but not on Windows. For Windows, we need to support so-called BDA drivers.

The problem is that we don't have both the time and the required hardware on Windows comps.

This project is probably not terribly complex, but you need the hardware.

Plugin is done and availabe in the current Git version. Code by kenS

== DBus Integration ==

[[DBus]] is a communication mechanism for Linux (mainly).

We would like VLC to be able to use it so that other programs can interact with vlc (start/stop, know what is being played, ...)

Work is well advanced, see [[DBus]], by funman and Mr_Mirsal

Contact: [[User:Xtophe|Xtophe]], [[User:Funman|funman]]

== V4L2 support ==

VLC currently has a pvr module and a v4l (video for linux) module. However

*some cards are only supported in the new v4l2 API
*The linux kernel will soon drop v4l support

So if someone could update VLC's current modules to work with V4L2 and the new ivtv api, this would be a welcome addition. This is not a very difficult project, but you will need to have the hardware to test against. The code has been began, so it should not be too difficult.

Plugin is done and available in the current Git version. Code by Richard Hosking, [[User:Dionoea|dionoea]] and Dennis Lou.

== RTCP support ==

Our RTSP implementation (for broadcasting and video on demand) does not support the RTCP protocol. This is a must to have a real support for RTSP. Some work has already been started, but there is still much to do.

Contact: [[User:JPSaman|JPSaman]]

== Windows port ==

Finish port libcddb and libcdio for Windows.

Port libzvbi for Windows

Contact [[User:J-b|jb]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

[[Category:Coding]] [[Category:Activities]]

== Subtitles improvements ==

{{VLC}} does not support all the styles for a lot of subtitles type. Take a look at [http://trac.videolan.org/vlc/browser/trunk/modules/codec/subtitles/subsdec.c here] to start coding.

Contact bitmap

Win32CompileMSYSNew

2009-05-16T10:14:42Z

Geal: yes, it works

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=PKG-CONFIG=
pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...
Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it too.

=Contribs=
Take the precompiled contribs:
http://people.videolan.org/~jb/Contribs/contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

Copy them in your ~
tar xvjf contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /
rm /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

=Gcrypt=
You need gcrypt to bootstrap VLC. It might be stupid, but deal with it.
cd extras/contrib
./bootstrap
cd src
make .gcrypt

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Configure=
vim extras/package/win32/configure-msys.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-msys.sh

=Compile=
make

SoC 2009/DXVA integration

2009-05-09T15:06:50Z

Geal: New page: {{SoCProject|year=2009|student=Geoffroy Couprie|mentor=Jérôme Decoodt}} =DXVA Integration= ==Abstract== The Windows DXVA API gives access to video decoding and processin...

{{SoCProject|year=2009|student=[[User:Geal|Geoffroy Couprie]]|mentor=Jérôme Decoodt}}

=DXVA Integration=

==Abstract==

The Windows DXVA API gives access to video decoding and processing in the graphic card. Decoding with the GPU will reduce the load on the CPU and (hopefully) speed up the decoding. This project aims at creating a MPEG2 and H.264 decoder for VLC using this API.

==Calendar==
'''May 23 :''' Beginning of SoC

'''July 13 :''' Mid-term evaluations deadline

'''August 24 :''' Final evaluation deadline

==TODO list==

{| class="wikitable"
! What !! WHAT!? !! When !! Status
|-
| Writing headers || The DXVA headers are not provided by the w32api project, so I have to write down the headers files for all the interfaces I will use. This is the very boring part of the project... || May-August || style="background: #ffffdd"|in progress
|-
| Create test programs || I have to test the API and the headers, so I need test cases. I can use the samples from the Platform SDK, but there are not many examples, and the ones provided won't compile at the beginning of the project, because they use part of the API I have still not written || May-June || style="background: #ffffdd"|in progress
|-
| Create the codec plugin || Using my test code, I'll be able to build a small codec plugin. Then, I'll use it to do all the further tests, and write the final part of the project || June-August || not started
|}

SoC 2009 projects

2009-05-09T14:51:34Z

Geal: /* List of current VLC projects */

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

= List of current VLC projects =

== QuickTimeVR Playback ==

* '''Project page: [[SoC 2009/QuickTimeVR Playback]]'''
* '''Student''': [[User:Leonox|León Moctezuma]]
* '''Mentor''': [[User:Dionoea|Antoine Cellerier]]
* '''Comentor''': Yuval Levy
* '''Abstract''':

: VLC is a cross platform media player widely used and FreePV is a panoramic viewer that was initially developed due to the lack of an implementation of QuickTime and Shockwave for Linux, both work with QuickTime files and the problem arise from that, since video and vr share the mime type, to solve this, the main goal is to integrate the FreePV library into VLC to enable it to play QuickTimeVR contents, the second goal is to explore the use of wiimote as an advance interaction method.

==Media Library==

* '''Project page: [[SoC 2009/Media Library]]'''
* '''Student''': [[User:jetru|Srikanth Raju]]
* '''Mentor''': [[User:J-Peg|Jean-Philippe Andre]]
* '''Abstract''':

: The project is about extending the Media Library(ML) for VLC Player. The media library will allow users to manage all their local and network media. The project will use the basic structure that already exists for the ML and will focus on extending the features. New features include Search, Smart playlists, Annotations and "Just play music".

==Lua Services Discovery==

* '''Project page: [[SoC 2009/Lua Services Discovery]]'''
* '''Student''': [[User:Sephiroth87|Fabio Ritrovato]]
* '''Mentor''': [[User:J-Peg|Jean-Philippe Andre]]
* '''Abstract''':

:The main goal of this project will be giving VideoLAN a Lua framework to load scriptable services discovery, to make them easier to write, if they don't require C complexity.
:Second goal will be giving VideoLAN access to a great number of online music and video services, like Jamendo, Magnatune, youtube, Dailymotion, etc..., using the new Lua modules.

==A Media Center Interface for VLC==

* '''Project page: [[SoC 2009/Media Center Interface for VLC]]'''
* '''Student''': [[User:barrywardell|Barry Wardell]]
* '''Mentor''': [[User:ILEoo|Ilkka Ollakka]]
* '''Abstract''':

:While it is easy to use and functional, the existing default, Qt based GUI for VLC is quite minimal and basic. I propose to develop a new "Media Center" style GUI. This GUI will be based on Qt/OpenGL and will aim to be aesthetically pleasing, while remaining easy to use and functional. It will draw on many nice features of other popular media center software such as Front Row, Windows Media Center and XBMC.

==DXVA integration==

* '''Project page: [[SoC 2009/DXVA integration]]'''
* '''Student''': [[User:Geal|Geoffroy Couprie]]
* '''Mentor''': Jérôme Decoodt
* '''Abstract''':

:The Windows DXVA API gives access to video decoding and processing in the graphic card. Decoding with the GPU will reduce the load on the CPU and (hopefully) speed up the decoding. This project aims at creating a MPEG2 and H.264 decoder for VLC using this API.

SoC 2009 Rules

2009-03-28T16:42:36Z

Geal: /* VLC selection tasks */

Those rules are mostly for x264 and VLC.

Those rules are quite flexible for any situation.

= Rules =
''We don't like rules.''

''We like freedom and having fun with software programming.''

However, we have no choice, seeing past experiences and issues. :'(

== Summer Generalities ==
If you are a student, we expect that:
* You don't have a full-time job during your summer if you are doing SoC at the same time,
* You are of good will to work within VideoLAN team.

If you are a mentor, we expect that:
* You are willing to work with one student and answers his questions.

== Selection ==

To be selected, students should:
* Select an idea,
* Post a proposal on Google website,
* Show on IRC,
* Join the mailing lists (x264-devel or vlc-devel, according to your project),
* Say hello to the potential mentor and admin.

* Learn about the code you should modify (where in the source, what is the idea...),
* Be able to compile a VLC or x264 for your platform and learn how to use [[Git]].
* Show the team that you compiled VLC and x264, by probably provide a small patch and a build. You can send the patch to an admin or to vlc-devel@ or x264-devel@

* Do one of the slection task (can be done after proposing the proposal)
* Complete the Google admission and give a planning idea.

=== VLC selection tasks ===
* Examples of small patches:
** QtCoverFlow integration (mandatory for any Qt related project),
** ASX playlists improvements (see [http://trac.videolan.org/vlc/ticket/20 ticket 20] [http://trac.videolan.org/vlc/ticket/2178 ticket 2178] and the code there) (easy)
** <span style="text-decoration: line-through;">RAM playlists support (easy),</span>
** <span style="text-decoration: line-through;">WPL and ZPL playlists support (easy too),</span>
** Close a VLC bug on trac,
** Add RMI (RIFF MIDI) support to the SMF demux,
** libsox based module,
** port a demuxer from mplayer or ffmpeg,
** Extend the DBus control to activate a video filter on the fly on an already playing video,
** Add new audio effects like chorus, reverb or phasing,
** Fix warnings,
** Add some simple feature that sounds nice to you.

== During the summer ==

=== Student expectations ===
* Student should explain his planning to his mentor and to an admin (not everyone has the same vacations)
* Student should report with a small mail once a week to both mentor and admin during the time agreed (failure to do that will fail the application)
* Student should commit on his personal ''git branch'' once a week, except the first week of your schedule (or more if your project is complex).
'''Explaining why you can't work one week is fine. Disappearing without notice is not.'''
* Update wiki status page.

=== Student rights ===
* Ask questions and stupid questions to anyone
* Bother the mentor with questions
* Ask the admin for another mentor if the mentor doesn't answer or doesn't fit.

Students will be considered as '''full-right''' developers.

=== Mentor expectations ===
* Mentor should report to admins any problems as soon as noticed,
* Mentor should tell admins if they can't make it in order to have another mentor for the student.

=== Mentor rights ===
* Fail a student :D

= Advice =

== To get selected ==

* Be nice.
* Show us basic skills with checking out and compiling the VLC code base.
* Show us that you understand the VLC architecture. Code samples are good.
* Come on IRC. Hang out, talk to us.

== During the SoC ==
'''''COMMIT EARLY, COMMIT OFTEN'''''

* Please do check that your commits compile. This makes it much easier to find problems later on, as searching for one problem doesn't stumble into broken commits that relate to something else entirely.
* Ask questions. Don't sit on problems until the GSoC is over.
* Don't be afraid to start researching your question yourself then check whether you are on the right track with your mentor. He (or others on the mailinglist or in the irc channel) will be happier to answer you if you can show you have done the groundwork. It tends to make explanations shorter and more meaningful, too.
* Finishing the GSoC project in time is pretty cool too. It's your show! Make it something nice.

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

Win32CompileMSYSNew

2009-03-05T17:43:24Z

Geal: untar contribs before bootstrapping

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=PKG-CONFIG=
pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...
Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it too.

=Contribs=
Take the precompiled contribs:
http://people.videolan.org/~jb/Contribs/contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

Copy them in your ~
tar xvjf contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /
rm /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Configure=
vim extras/package/win32/configure-msys.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-msys.sh

=Compile=
make

Win32CompileMSYSNew

2009-03-05T17:39:50Z

Geal: Undo revision 13588 by Geal (Talk)

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=GCrypt=
You need gcrypt to bootstrap VLC. It might be stupid, but deal with it.
cd extras/contrib
./bootstrap
cd src
make .gcrypt

=PKG-CONFIG=
pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...
Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it too.

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Contribs=
Take the precompiled contribs:
http://people.videolan.org/~jb/Contribs/contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

Copy them in your ~
tar xvjf contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /
rm /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

=Configure=
vim extras/package/win32/configure-msys.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-msys.sh

=Compile=
make

SoC 2009

2009-03-03T16:03:06Z

Geal: /* More Ideas */ Add DXVA

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

=== Lua audio filters ===

VLC currently uses Lua as an interface, to handle specific URLs, and to fetch media information. This project aims at creating an audio filter in Lua, and enabling users to create whatever audio filtering function they want in a Lua script.

''Proposed mentor: Geal''

=== Qt embedded interface ===

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

''Proposed mentor: ?''

=== OpenMAX AL bindings for LibVLC ===

OpenMAX is a portable framework for handling audio, video and pictures. OpenMAX AL is an API designed to create and control media players, and make them communicate with devices such as audio inputs and outputs, cameras, LEDs, etc. In this project, the student would integrate LibVLC, the VLC framework with OpenMAX.

''Proposed mentor: ?''

=== DXVA Integration ===
Since Windows Vista, some nice APIs are available, and you can do fun things like GPU-based decoding. Some good work could be done here.

'Proposed mentor: ?''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

Win32CompileMSYSNew

2009-03-02T17:22:03Z

Geal: replace gcrypt and pkg-config hack by contribs building

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=Contribs=
Build the third-party libs needed by VLC.
cd extras/contrib
./bootstrap
cd src
make

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Configure=
vim extras/package/win32/configure-msys.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-msys.sh

=Compile=
make

Win32CompileMSYSNew

2009-03-02T17:19:00Z

Geal: /* Configure */

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=GCrypt=
You need gcrypt to bootstrap VLC. It might be stupid, but deal with it.
cd extras/contrib
./bootstrap
cd src
make .gcrypt

=PKG-CONFIG=
pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...
Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it too.

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Contribs=
Take the precompiled contribs:
http://people.videolan.org/~jb/Contribs/contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

Copy them in your ~
tar xvjf contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /
rm /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

=Configure=
vim extras/package/win32/configure-msys.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-msys.sh

=Compile=
make

Win32CompileMSYSNew

2009-03-02T17:13:08Z

Geal: New MSYS build tutorial

=Introduction=
MSYS is a helper environment for MinGW, the compiler chain for Windows based on GCC. It is the fastest way to build VLC natively on Windows.

=Install MinGW=
Use the main installer 5.1.4 found at
http://sourceforge.net/project/showfiles.php?group_id=2435&package_id=240780

Use the candidate release, and select gcc, g++ and MinGW make. It should download:
*mingwrt-3.15
*w32api-3.12
*binutils-2.18
*gcc-core-3.4.5
*gcc-g++-3.4.5
*mingw32-make-3.81

=Install MSYS=
* Install MSys 1.0.10 with the exe: http://downloads.sourceforge.net/mingw/MSYS-1.0.10.exe
* Install MSys Developer Tooltkit: http://downloads.sourceforge.net/mingw/msysDTK-1.0.1.exe
* Update to 1.0.11, untar it in your msys install:
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-2007.01.19-1.tar.bz2
or
http://downloads.sourceforge.net/mingw/msysCORE-1.0.11-20080826.tar.gz (recommended on 64bits)

* Update your autoconf, automake and libtool by downloading and installing them.
http://downloads.sourceforge.net/mingw/autoconf2.5-2.61-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/automake1.10-1.10-1-bin.tar.bz2
http://downloads.sourceforge.net/mingw/libtool1.5-1.5.25a-1-bin.tar.bz2

You can also compile them according to:
http://wiki.enlightenment.org/index.php/EFL_Windows_XP
http://www.mingw.org/wiki/msys

=Install other tools=

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

Installation of wget too: http://prdownloads.sourceforge.net/mingw/wget-1.9.1-mingwPORT.tar.bz2

Although this is a mingwPORT package it already has a precompiled wget on board.
Extract the .tar.bz2 file. It contains wget.exe in the bin subfolder, extract it to mingw/bin.

=Install Git and checkout VLC=

Download Git on http://code.google.com/p/msysgit/

Launch Git bash:
cd /c
mkdir VLC
cd VLC
git clone git://git.videolan.org/vlc.git

launch MSys again
cd /c/VLC/vlc

=GCrypt=
You need gcrypt to bootstrap VLC. It might be stupid, but deal with it.
cd extras/contrib
./bootstrap
cd src
make .gcrypt

=PKG-CONFIG=
pkg-config is a mess, this is not NEWS... And you cannot compile it from Windows because of a few bugs...
Get Glib from GNOME: http://ftp.gnome.org/pub/GNOME/binaries/win32/glib/2.18/glib_2.18.2-1_win32.zip
Unzip it.

Get PKG-CONFIG from GNOME: http://ftp.gnome.org/pub/gnome/binaries/win32/dependencies/pkg-config-0.23-2.zip
Unzip it too.

=Bootstrap VLC=
This is a HACK. Don't do this at HOME.
cp extras/contrib/share/aclocal/* m4/
cp /usr/share/aclocal/* m4/
./bootstrap
It should warn about gettext... Just ignore.

=Contribs=
Take the precompiled contribs:
http://people.videolan.org/~jb/Contribs/contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

Copy them in your ~
tar xvjf contrib-20090219-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2 -C /
rm /usr/win32/bin/moc /usr/win32/bin/uic /usr/win32/bin/rcc

=Configure=
vim extras/package/win32/configure-mingw.sh
Change CC to gcc and CXX to g++, I recommend to --disable-nls too
sh extras/package/win32/configure-mingw.sh

=Compile=
make

SoC 2009

2009-02-27T17:41:58Z

Geal: /* Qt embedded interface */

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

=== Lua audio filters ===

VLC currently uses Lua as an interface, to handle specific URLs, and to fetch media information. This project aims at creating an audio filter in Lua, and enabling users to create whatever audio filtering function they want in a Lua script.

''Proposed mentor: Geal''

=== Qt embedded interface ===

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

''Proposed mentor: ?''

=== OpenMAX AL bindings for LibVLC ===

OpenMAX is a portable framework for handling audio, video and pictures. OpenMAX AL is an API designed to create and control media players, and make them communicate with devices such as audio inputs and outputs, cameras, LEDs, etc. In this project, the student would integrate LibVLC, the VLC framework with OpenMAX.

''Proposed mentor: ?''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

SoC 2009

2009-02-27T17:29:16Z

Geal: /* Lua audio filters */

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

=== Lua audio filters ===

VLC currently uses Lua as an interface, to handle specific URLs, and to fetch media information. This project aims at creating an audio filter in Lua, and enabling users to create whatever audio filtering function they want in a Lua script.

''Proposed mentor: Geal''

=== Qt embedded interface ===

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

''Proposed mentor: ?''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

SoC 2009

2009-02-25T10:51:40Z

Geal: removing IPhone port idea (already exists)

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

=== Lua audio filters ===

VLC currently uses Lua as an interface, to handle specific URLs, and to fetch media information. This project aism at creating an audio filter in Lua, and enabling users to create whatever audio filtering function they want in a Lua script.

''Proposed mentor: Geal''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

SoC 2009

2009-02-21T15:29:12Z

Geal:

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== iPhone / iPod touch port ===
Port VLC to the iPhone / iPod touch platform.

The student is not required to own such a device due to the availability of a simulator as part of the official SDK, although it may be helpful.

This project requires good C, preferably Obj-C, knowledge and basic skills in shell programming (autotools, ...). Previous experience with development for embedded devices is a strong plus.

''Proposed mentor: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

=== Lua audio filters ===

VLC currently uses Lua as an interface, to handle specific URLs, and to fetch media information. This project aism at creating an audio filter in Lua, and enabling users to create whatever audio filtering function they want in a Lua script.

''Proposed mentor: Geal''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

SoC 2009

2009-02-21T15:16:01Z

Geal: New page: Google Summer of Code 2009. == Introduction & Information == This wiki page covers the attempt by the VideoLAN project to act as a mentoring organization for [http://code.google.com/...

Google Summer of Code 2009.

== Introduction & Information ==

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

* This page list the ideas for VLC.
* There is also a separate page for project ideas for the [[x264]]: [[SoC x264]].

If you are a '''student''', please read the [[SoC_2008_Rules|rules]] and [[SoC_2008_Rules#Advices|advices]].

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

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

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

=== Summer of Code ===

If selected and developed, SoC ideas will be included in the VLC 1.1 or any later version release, and covered by the GPL licence.

=== Ideas ===

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

This page is split in three lists of ideas:
* The ''main ideas'' are the ones we would like to focus on, and seem to be key projects for VLC and a lot more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
* The other ideas are less detailed but could be good ideas too.
* Original good ideas will be valued. Last year, half of the ideas were given by students. [[Mini_Projects]] has some ideas too.

We don't want to impose anything. This is free and Open Source software. Last year, many projects were external ideas.

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

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

===x264===
For x264 ideas, please see [[SoC_x264]].

== Main ideas ==

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

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

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

''Proposed mentor: ?''

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).
Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

This project is likely to require some modification of the VLC image handling code.

''Proposed mentor: ?''

=== GUI interfaces for the browsers plug-ins ===
This project focuses on adding interfaces to our browser plug-ins, in order to have, in the web pages embedded mode, buttons to control {{VLC}} as in WMP or Youtube player. These buttons need to be cross-platform and cross-browsers.

The second part of this project aims to provide a replacement for all preconfigured media players embedded in web pages, if possible.

For example, when a webpage asks for WMP embedded plugin, youtube player, quicktime player or any other, VLC would detect the stream and display it. This would mean less CPU needed than Flash based players...

This project may need to work in concert with some improvements on the cache handling module access.

The look of the interface should not be a problem (it can be added later on).

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
This project means to deal with building a QTKit-based access module for OS X (allowing input from USB / FireWire cameras, audio devices, camcorders, tape recorders [, ...your favourite here] ).

This access module will also need a nice GUI Integration.

This project requires C, preferably Obj-C, knowledge and interest in video/audio capture devices. Obviously, the student is required to own at a least a Mac with a (embedded) webcam and an audio input facility for development. Knowledge of the QuickTime APIs and previous experience with Cocoa are strong pluses.

''Proposed mentor: ?''

=== Leopard integration ===
* a QuickLook-plugin for OS X Leopard
* Video Output animations
* VLC_app (VLCKit based) improvements.
* VLCKit oneclick-Streaming Server implementation.

This project requires C, preferably Obj-C, knowledge and interest in GUI programming. Previous experience with Cocoa preferred. Basic Core Animation knowledge is a plus, but far from being absolutely necessary.

''Proposed mentors: ?''

=== iPhone / iPod touch port ===
Port VLC to the iPhone / iPod touch platform.

The student is not required to own such a device due to the availability of a simulator as part of the official SDK, although it may be helpful.

This project requires good C, preferably Obj-C, knowledge and basic skills in shell programming (autotools, ...). Previous experience with development for embedded devices is a strong plus.

''Proposed mentor: ?''

=== Automated threading error detection ===
VLC is heavily multithreaded.

This project would involve extending the VLC threading APIs to provide better run-time consistency checks, and possibly proof of correctness.

This could be similar to the lock consistency checking in the Linux kernel, albeit more simple - VLC does not have to deal with interruptions neither atomic operation and has fewer thread and synchronisation constructs.

This project requires working knowledge of the C programming language and POSIX threads.

''proposed mentor: ?''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2, there are many interesting things in VLC to speed up.
* memcpy implementations in SSE2
* video filters ASM speedups
* audio filters ASM speedups
* Porting other ASM video filters to VLC.
* Profiling VLC.

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

''Proposed mentor: ?''

=== Matroska (mkv) muxing ===

This project is about writing a mkv muxer for VLC with advanced support (chapters, multiple audio and multiple subtitles, etc...) like when you need to rip or archive a DVD.

FFMPEG project has a similar project, and we could use the libavformat muxer and adapt ourselves, but we are not sure if we will be able to use therefore all the advanced features.

''Proposed mentor: ?''

=== Skins improvements ===

Better video output integration.

Better skin support.

''Proposed mentor: ?''

=== SVCD handling ===

Make SVCD's work. Menu selection, navigation and hot spots.

''Proposed mentor: ?''

== Mini Projects - More ideas ==

'''Original''' ideas will be '''rewarded.'''

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

* Visualisation improvements (libprojectM implementation ? )
* Video rework.

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

=== Mentors ===
The proposed mentors are:
* ?

=== Administrators ===
* jb
* xtophe

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

WinCECompile

2009-02-18T10:49:12Z

Geal: /* Configuration */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use Mingw32CE, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge].

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine with ActiveSync installed and download your fresh new VLC build.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

This GDB will upload vlc.exe to /gdb/ on the device. Make sure you uploaded all the VLC directory on your device.

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:46:34Z

Geal: /* Using and Debugging VLC */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use Mingw32CE, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge].

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine with ActiveSync installed and download your fresh new VLC build.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

This GDB will upload vlc.exe to /gdb/ on the device. Make sure you uploaded all the VLC directory on your device.

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:44:13Z

Geal: /* Running VLC */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use Mingw32CE, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge].

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine with ActiveSync installed and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:42:57Z

Geal: /* Interacting with your device */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use Mingw32CE, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge].

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine with ActiveSync installed and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device, and add in its root mingwm10.dll. This the mingw runtime for Windows CE, and VLC won't work without it. You can find it in /opt/mingw32ce/arm-wince-mingw32ce/bin.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:42:16Z

Geal: /* Get mingw32ce */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use Mingw32CE, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge].

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device, and add in its root mingwm10.dll. This the mingw runtime for Windows CE, and VLC won't work without it. You can find it in /opt/mingw32ce/arm-wince-mingw32ce/bin.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:40:24Z

Geal: /* Configuration */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use CeGCC, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge]. There are two environments: CeGCC and Mingw32ce. We use Mingw32ce.

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="arm-wince-mingw32ce-gcc" \
CXX="arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --disable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale --disable-telnet

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device, and add in its root mingwm10.dll. This the mingw runtime for Windows CE, and VLC won't work without it. You can find it in /opt/mingw32ce/arm-wince-mingw32ce/bin.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

WinCECompile

2009-02-18T10:37:25Z

Geal: /* Get the source */

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use CeGCC, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge]. There are two environments: CeGCC and Mingw32ce. We use Mingw32ce.

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.
If your are using the release, download source code and extract the archive and go into your VLC directory.
% cd /path/to/your/vlc/folder/

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="/opt/mingw32ce/bin/arm-wince-mingw32ce-gcc" \
CXX="/opt/mingw32ce/bin/arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --enable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --disable-optimize-memory --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device, and add in its root mingwm10.dll. This the mingw runtime for Windows CE, and VLC won't work without it. You can find it in /opt/mingw32ce/arm-wince-mingw32ce/bin.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

Hacker Guide/Audio Filters

2008-12-21T15:04:55Z

Geal: /* Module descriptor */ fix macros

=Overview=

=Writing an audio filter=

==Module descriptor==
static int Open ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void Close ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void DoWork ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__instance__t.html aout_instance_t] *p_aout, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__filter__t.html aout_filter_t] *p_filter, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_in_buf, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_out_buf );

vlc_module_begin()
set_description( N_("audio filter x") )
set_shortname( N_("audio filter x") )
set_category( CAT_AUDIO )
set_subcategory( SUBCAT_AUDIO_AFILTER )
add_shortcut( "afx" )
set_capability( "audio filter", 0 )
set_callbacks( Open, Close )
vlc_module_end()

==Mandatory structures==
*aout_filter_sys_t

==I/O Buffers==
Data comes in and out the plugin in an [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t], one sample at a time, and in each sample, one block by channel.

{|border="1" cellpadding="5" cellspacing="0" align="center"
|-
|data stream
| ch 1
| ch 2
| ch 1
| ch 2
| ch 1
| ch 2
| ...
|-
|
| colspan="2" | Sample 1
| colspan="2" | Sample 2
| colspan="2" | Sample 3
| ...
|}

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

==Note==

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Talk:SoC 2008/WinCE Port

2008-09-22T10:30:49Z

Geal:

I'll be watching this as I've always used the WinCE port for my Dell Axim x3 Windows Mobile 2003 device. Good luck ;)

I too will be keeping an eye on this project. I can't get the old port to run at all on my WM2003SE iPaq - it just does nothing. It's a shame really. I absolutely ''need'' a video player that does OGG Theora! [[User:KevinLange|KevinLange]] 17:05, 31 May 2008 (CEST) (update: I got the even more unofficial port to open, but it doesn't play videos and is just plain "not good".)

Thank you, I'll work hard to get a working version soon :) --[[User:Geal|Geal]] 13:56, 2 June 2008 (CEST)

== Progress? ==

Midterm evaluations have come and gone. Any progress to report?
[[User:KevinLange|KevinLange]] 21:59, 16 July 2008 (CEST)

Now the LibVLC compiles without any problem, and I'm adding plugins. I could play some music on my phone, it's beginning to work :)
For now, I work on the interface, but I'm not really changing the look and feel. That will be for the end of the summer. I'll soon add the video output, and then, I may need some intensive testing :) --[[User:Geal|Geal]] 10:54, 23 July 2008 (CEST)

Anything new? It's almost final evaluation time. [[User:KevinLange|KevinLange]] 21:16, 20 August 2008 (CEST)

I have timing issues: it doesn't play more than a few seconds. There are recents commits to the main tree that may fix this bug, but I didn't update my tree yet. You can see what external libs were ported on [[Contrib_Status]]. Many others will come :)
VLC on WinCE won't be released this week, and I don't think this will be for next release. But I'll make test binaries when this timing bug will be fixed, and then, patches and bug reports will be welcomed :) I'm sorry I didn't finish it in time... I'll go on contributing to VLC, so I won't drop my project right now! --[[User:Geal|Geal]] 10:29, 26 August 2008 (CEST)

== Anything new? ==

After using the new 0.9.2 of the regular VLC, I have to ask: For the interface, why not write one with QT? QT is available for the Pocket PC in the form of QT Embedded. The same interface could also be used on the Familiar port of VLC.

And while I'm here, anything new? Anything you'd like help with (this is something I'd really like to see happen, and I have plenty of programming experience and the tools required to help out)? [[User:KevinLange|KevinLange]] 01:46, 21 September 2008 (CEST)

The Qt interface for WinCE could be a good idea, but I don't know anything about Qt... Feel free to do it ;)

Nothing really new about the WinCE port: I wait for some big changes of LibVLC to be done, to adapt my code. And I've been a bit busy with the Windows version.

You can try to build it by reading the [[WinCECompile]] page. It can really help me to improve the port, because I did some ugly things to make it compile, and I don't remember everything I did :P --[[User:Geal|Geal]] 12:30, 22 September 2008 (CEST)

UnixCompile

2008-09-20T16:58:05Z

Geal: /* Final configuration */ --enable-ffmpeg doesn't exist anymore

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== Configuration ==

You need to tweak your configure line.

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

===Special libs ===
Use <tt>--with-live555-path=path/to/livemedia/source/tree</tt> in connection with --enable-live555</tt>.
For ffmpeg, the only reliable way for VLC's configure to know how your ffmpeg's libs were compiled is to use pkg-config. So you need to set PKG_CONFIG_PATH correctly if your ffmpeg is not installed at the default place or you want to use static linking.

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

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

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

== Compilation ==
Compile VLC:
% make

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

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

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

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

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

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

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

[[Category:Building]]

Win32CompileCygwinNew

2008-09-20T16:55:36Z

Geal: /* Configure script for compiling VLC */ --enable-ffmpeg doesn't exist anymore

This is a new version of the Win32CompileCygwin written by [[User:J-b|Jean-Baptiste Kempf]]
'''This version ONLY works for 0.9.x.'''

'''WARNING''': building VLC on Cygwin has ever been a failure-prone task. It is also very slow. You should really consider cross-compiling from Linux (on a virtual machine, via dual-boot or from another computer). 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
expat
gcc
gcc-core
gcc-g++
gcc-mingw
gcc-mingw-core
gcc-mingw-g++
gdb
gettext
gettext-devel
git
libiconv
libgcrypt-devel
libtool
make
mingw-runtime
nasm
patchutils
pkg-config
subversion

Editor
vim

Libs
libgcrypt

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

'''Note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''

Applies to:

Windows XP Service Pack 2 with Security Update '''KB925902''' installed
Windows XP Service Pack 3

There is a problem on Windows XP (and possibly on other Microsoft Operating Systems) with 'git clone' which aborts unexpectedly with a Cygwin error during the 'checking out files' (reproducable every time and at the same percentage) at the end of the clone procedure:

$ 2 [main] git 4012 D:\cygwin\bin\git.exe:
*** fatal error - '''could not load shell32, Win32 error 487'''

This has been verified (May 22, 2008) against the currently available Cygwin 1.5.25-12 with git package versions 1.5.5.1-1 and 1.5.4-1 and is a generic problem which also affects cloning from other git repositories (although x264.git seems unaffected).

The issue is referred to in the mail archives of the Cygwin project mailing list here
[http://sourceware.org/ml/cygwin/2007-07/msg00858.html Git error on Cygwin].

By eliminating the impossible, whatever remained, however improbable, it is the following Windows Security Update (April 3, 2007) which is actually the cause of the Cygwin issue: [http://www.microsoft.com/technet/security/bulletin/ms07-017.mspx Microsoft Security Bulletin MS07-017 - Vulnerabilities in GDI Could Allow Remote Code Execution (925902)]

Even though the same Security Update applies to the following systems, these are reported not to be affected:

Windows Vista Service Pack 1
Windows 2003 Server Standard Service Pack 2

''It is possible to get 'git clone' working again on the affected systems by removing the Security Update (KB925902) but this is obviously not recommended for security reasons.''

'''Second note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''
If you get following error messages

fatal: pack has bad object at offset 98737692: inflate returned -3
fatal: index-pack failed
fetch-pack from 'git://git.videolan.org/vlc.git' failed.

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

== Snapshots ==

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

=Bootstrap=

Open the '''configure.ac''' file, and modify the requirement for gettext 0.17 to 0.15 (so replace line '''AM_GNU_GETTEXT_VERSION(0.17)''' with line '''AM_GNU_GETTEXT_VERSION(0.15)'''), and then run bootstrap.

cd vlc
./bootstrap

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

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

contrib-20060730-win32-bin-gcc-3.4.5-only.tar.bz2 (example)

Those days, you should use
http://people.videolan.org/~jb/Contribs/contrib-20080702-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

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

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:

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.

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

For maintenance purposes periodically check:

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

=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 \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-avcodec --enable-avformat --enable-swscale \
--enable-faad --enable-flac --enable-theora \
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
--enable-live555 --with-live555-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug --enable-dca \
--disable-mkv --disable-taglib

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

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

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 either run VLC directly from the source tree or 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 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

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

Win32CompileCygwinNew

2008-09-13T23:04:39Z

Geal: /* Configure script for compiling VLC */ pkg_config_LIBDIR

This is a new version of the Win32CompileCygwin written by [[User:J-b|Jean-Baptiste Kempf]]
'''This version ONLY works for 0.9.x.'''

'''WARNING''': building VLC on Cygwin has ever been a failure-prone task. It is also very slow. You should really consider cross-compiling from Linux (on a virtual machine, via dual-boot or from another computer). 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
expat
gcc
gcc-core
gcc-g++
gcc-mingw
gcc-mingw-core
gcc-mingw-g++
gdb
gettext
gettext-devel
git
libiconv
libgcrypt-devel
libtool
make
mingw-runtime
nasm
patchutils
pkg-config
subversion

Editor
vim

Libs
libgcrypt

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

'''Note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''

Applies to:

Windows XP Service Pack 2 with Security Update '''KB925902''' installed
Windows XP Service Pack 3

There is a problem on Windows XP (and possibly on other Microsoft Operating Systems) with 'git clone' which aborts unexpectedly with a Cygwin error during the 'checking out files' (reproducable every time and at the same percentage) at the end of the clone procedure:

$ 2 [main] git 4012 D:\cygwin\bin\git.exe:
*** fatal error - '''could not load shell32, Win32 error 487'''

This has been verified (May 22, 2008) against the currently available Cygwin 1.5.25-12 with git package versions 1.5.5.1-1 and 1.5.4-1 and is a generic problem which also affects cloning from other git repositories (although x264.git seems unaffected).

The issue is referred to in the mail archives of the Cygwin project mailing list here
[http://sourceware.org/ml/cygwin/2007-07/msg00858.html Git error on Cygwin].

By eliminating the impossible, whatever remained, however improbable, it is the following Windows Security Update (April 3, 2007) which is actually the cause of the Cygwin issue: [http://www.microsoft.com/technet/security/bulletin/ms07-017.mspx Microsoft Security Bulletin MS07-017 - Vulnerabilities in GDI Could Allow Remote Code Execution (925902)]

Even though the same Security Update applies to the following systems, these are reported not to be affected:

Windows Vista Service Pack 1
Windows 2003 Server Standard Service Pack 2

''It is possible to get 'git clone' working again on the affected systems by removing the Security Update (KB925902) but this is obviously not recommended for security reasons.''

'''Second note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''
If you get following error messages

fatal: pack has bad object at offset 98737692: inflate returned -3
fatal: index-pack failed
fetch-pack from 'git://git.videolan.org/vlc.git' failed.

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

== Snapshots ==

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

=Bootstrap=

Open the '''configure.ac''' file, and modify the requirement for gettext 0.17 to 0.15 (so replace line '''AM_GNU_GETTEXT_VERSION(0.17)''' with line '''AM_GNU_GETTEXT_VERSION(0.15)'''), and then run bootstrap.

cd vlc
./bootstrap

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

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

contrib-20060730-win32-bin-gcc-3.4.5-only.tar.bz2 (example)

Those days, you should use
http://people.videolan.org/~jb/Contribs/contrib-20080702-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

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

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:

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.

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

For maintenance purposes periodically check:

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

=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 \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
--enable-live555 --with-live555-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug --enable-dca \
--disable-mkv --disable-taglib

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'' cofigure-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 \
...

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

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 either run VLC directly from the source tree or 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 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

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

Hacker Guide/Audio Filters

2008-09-13T21:01:38Z

Geal:

=Overview=

=Writing an audio filter=

==Module descriptor==
static int Open ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void Close ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void DoWork ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__instance__t.html aout_instance_t] *p_aout, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__filter__t.html aout_filter_t] *p_filter, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_in_buf, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_out_buf );

vlc_module_begin();
set_description( N_("audio filter x") );
set_shortname( N_("audio filter x") );
set_category( CAT_AUDIO );
set_subcategory( SUBCAT_AUDIO_AFILTER );
add_shortcut( "afx" );
set_capability( "audio filter", 0 );
set_callbacks( Open, Close );
vlc_module_end();

==Mandatory structures==
*aout_filter_sys_t

==I/O Buffers==
Data comes in and out the plugin in an [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t], one sample at a time, and in each sample, one block by channel.

{|border="1" cellpadding="5" cellspacing="0" align="center"
|-
|data stream
| ch 1
| ch 2
| ch 1
| ch 2
| ch 1
| ch 2
| ...
|-
|
| colspan="2" | Sample 1
| colspan="2" | Sample 2
| colspan="2" | Sample 3
| ...
|}

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

==Note==

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Hacker Guide/Audio Filters

2008-09-13T19:24:18Z

Geal: /* Module descriptor */

=Overview=

=Writing an audio filter=

==Module descriptor==
static int Open ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void Close ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t] *p_this );
static void DoWork ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__instance__t.html aout_instance_t] *p_aout, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__filter__t.html aout_filter_t] *p_filter, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_in_buf, [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t] *p_out_buf );

vlc_module_begin();
set_description( N_("audio filter x") );
set_shortname( N_("audio filter x") );
set_category( CAT_AUDIO );
set_subcategory( SUBCAT_AUDIO_AFILTER );
add_shortcut( "afx" );
set_capability( "audio filter", 0 );
set_callbacks( Open, Close );
vlc_module_end();

==Mandatory structures==
*aout_filter_sys_t

==Input Data==

==Output Data==

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

==Note==

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Hacker Guide/Audio Filters

2008-09-13T17:58:10Z

Geal: /* Audio filters */

=Overview=

=Writing an audio filter=

==Module descriptor==
static int Open ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t *] );
static void Close ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structvlc__object__t.html vlc_object_t *] );
static void DoWork ( [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__instance__t.html aout_instance_t *], [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__filter__t.html aout_filter_t *], [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t *], [http://www.videolan.org/developers/vlc/doc/doxygen/html/structaout__buffer__t.html aout_buffer_t *] );

vlc_module_begin();
set_description( N_("audio filter x") );
set_shortname( N_("audio filter x") );
set_category( CAT_AUDIO );
set_subcategory( SUBCAT_AUDIO_AFILTER );
add_shortcut( "afx" );
set_capability( "audio filter", 0 );
set_callbacks( Open, Close );
vlc_module_end();

==Mandatory structures==
*aout_filter_sys_t

==Input Data==

==Output Data==

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

==Note==

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Hacker Guide/Audio Filters

2008-09-13T17:45:24Z

Geal: /* Writing an audio filter */

=Audio filters=
==Overview==

==Writing an audio filter==

===Module descriptor===
vlc_module_begin();
set_description( N_("audio filter x") );
set_shortname( N_("audio filter x") );
set_category( CAT_AUDIO );
set_subcategory( SUBCAT_AUDIO_AFILTER );
add_shortcut( "afx" );
set_capability( "audio filter", 0 );
set_callbacks( Open, Close );
vlc_module_end();

===Mandatory functions===

static int Open ( vlc_object_t * );
static void Close ( vlc_object_t * );
static void DoWork ( aout_instance_t *, aout_filter_t *, aout_buffer_t *, aout_buffer_t * );

===Mandatory structures===
*aout_filter_sys_t

===Input Data===

===Output Data===

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

===Note===

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Hacker Guide/Audio Output

2008-09-13T17:25:46Z

Geal: /* The audio output layer */

=The audio output layer=

==Audio output overview==

This chapter documents the audio output layer known under the "audio output 3" codename. It has first been released with VLC version 0.5.0. Previous versions use an antic API, which is no longer documented nor supported. You definitely should write new code only for aout3 and later.

The audio output's main purpose is to take sound samples from one or several decoders (called "input streams" in this chapter), to mix them and write them to an output device (called "output stream"). During this process, transformations may be needed or asked by the user, and they will be performed by audio filters.

(insert here a schematic of the data flow in aout3)

==Terminology==

*Sample : A sample is an elementary piece of audio information, containing the value for all channels. For instance, a stream at 44100 Hz features 44100 samples per second, no matter how many channels are coded, nor the coding type of the coefficients.
*Frame : A set of samples of arbitrary size. Codecs usually have a fixed frame size (for instance an A/52 frame contains 1536 samples). Frames do not have much importance in the audio output, since it can manage buffers of arbitrary sizes. However, for undecoded formats, the developer must indicate the number of bytes required to carry a frame of n samples, since it depends on the compression ratio of the stream.
*Coefficient : A sample contains one coefficient per channel. For instance a stereo stream features 2 coefficients per sample. Many audio items (such as the float32 audio mixer) deal directly with the coefficients. Of course, an undecoded sample format doesn't have the notion of "coefficient", since a sample cannot be materialized independantly in the stream.
*Resampling : Changing the number of samples per second of an audio stream.
*Downmixing/upmixing : Changing the configuration of the channels (see below).

==Audio sample formats==

The whole audio output can viewed as a pipeline transforming one audio format to another in successive steps. Consequently, it is essential to understand what an audio sample format is.

The audio_sample_format_t structure is defined in include/audio_output.h. It contains the following members :

*i_format : Define the format of the coefficients. This is a FOURCC field. For instance 'fl32' (float32), 'fi32' (fixed32), 's16b' (signed 16-bit big endian), 's16l' (signed 16-bit little endian), AOUT_FMT_S16_NE (shortcut to either 's16b' or 's16l'), 'u16b', 'u16l','s8 ', 'u8 ', 'ac3 ', 'spdi' (S/PDIF). Undecoded sample formats include 'a52 ', 'dts ', 'spdi', 'mpga' (MPEG audio layer I and II), 'mpg3' (MPEG audio layer III). An audio filter allowing to go from one format to another is called, by definition, a "converter". Some converters play the role of a decoder (for instance a52tofloat32.c), but are in fact "audio filters".
*i_rate : Define the number of samples per second the audio output will have to deal with. Common values are 22050, 24000, 44100, 48000. i_rate is in Hz.
*i_physical_channels : Define the channels which are physically encoded in the buffer. This field is a bitmask of values defined in audio_output.h, for instance AOUT_CHAN_CENTER, AOUT_CHAN_LEFT, etc. Beware : the numeric value doesn't represent the number of coefficients per sample, see aout_FormatNbChannels() for that. The coefficients for each channel are always stored interleaved, because it is much easier for the mixer to deal with interleaved coefficients. Consequently, decoders which output planar data must implement an interleaving function. Coefficients must be output in the following order (WG-4 specification) : left, right, left surround, right surround, center, LFE.
*i_original_channels : Define the channels from the original stream which have been used to constitute a buffer. For instance, imagine your output plug-ins only has mono output (AOUT_CHAN_CENTER), and your stream is stereo. You can either use both channels of the stream (i_original_channels == AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT), or select one of them. i_original_channels uses the same bitmask as i_physical_channels, and also features special bits AOUT_CHAN_DOLBYSTEREO, which indicates whether the input stream is downmixed to Dolby surround sound, and AOUT_CHAN_DUALMONO, which indicates that the stereo stream is actually constituted of two mono streams, and only one of them should be selected (for instance, two languages on one VCD).

===Note===

For 16-bit integer format types, we make a distinction between big-endian and little-endian storage types. However, floats are also stored in either big endian or little endian formats, and we didn't make a difference. The reason is, samples are hardly stored in float32 format in a file, and transferred from one machine to another ; so we assume float32 always use the native endianness.

Yet, samples are quite often stored as big-endian signed 16-bit integers, such as in DVD's LPCM format. So the LPCM decoder allocates an 's16b' input stream, and on little-endian machines, an 's16b'->'s16l' converter is automatically invoked by the input pipeline.

In most cases though, AOUT_FMT_S16_NE and AOUT_FMT_U16_NE should be used.

The aout core provides macros to compare two audio sample formats. AOUT_FMTS_IDENTICAL() tests if i_format, i_rate, i_physical_channels and i_original_channels are identical. AOUT_FMTS_SIMILAR tests if i_rate and i_channels are identical (useful to write a pure converter filter).

The audio_sample_format_t structure then contains two additional parameters, which you are not supposed to write directly, except if you're dealing with undecoded formats. For PCM formats they are automatically filled in by aout_FormatPrepare(), which is called by the core functions when necessary.

*i_frame_length : Define the number of samples of the "natural" frame. For instance for A/52 it is 1536, since 1536 samples are compressed in an undecoded buffer. For PCM formats, the frame size is 1, because every sample in the buffer can be independantly accessed.
*i_bytes_per_frame : Define the size (in bytes) of a frame. For A/52 it depends on the bitrate of the input stream (read in the sync info). For instance for stereo float32 samples, i_bytes_per_frame == 8 (i_frame_length == 1).

These last two fields (which are always meaningful as soon as aout_FormatPrepare() has been called) make it easy to calculate the size of an audio buffer : i_nb_samples * i_bytes_per_frame / i_frame_length.

==Typical runcourse==

The input spawns a new audio decoder, say for instance an A/52 decoder. The A/52 decoder parses the sync info for format information (eg. it finds 48 kHz, 5.1, 196 kbi/s), and creates a new aout "input stream" with aout_InputNew(). The sample format is :

*i_format = 'a52 '
*i_rate = 48000
*i_physical_channels = i_original_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT | AOUT_CHAN_CENTER | AOUT_CHAN_REARLEFT | AOUT_CHAN_REARRIGHT | AOUT_CHAN_LFE
*i_frame_length = 1536
*i_bytes_per_frame = 24000

This input format won't be modified, and will be stored in the aout_input_t structure corresponding to this input stream : p_aout->pp_inputs[0]->input. Since it is our first input stream, the aout core will try to configure the output device with this audio sample format (p_aout->output.output), to avoid unnecessary transformations.

The core will probe for an output module in the usual fashion, and its behavior will depend. Either the output device has the S/PDIF capability, and then it will set p_aout->output.output.i_format to 'spdi', or it's a PCM-only device. It will thus ask for the native sample format, such as 'fl32' (for Darwin CoreAudio) or AOUT_FMT_S16_NE (for OSS). The output device may also have constraints on the number of channels or the rate. For instance, the p_aout->output.output structure may look like :

*i_format = AOUT_FMT_S16_NE
*i_rate = 44100
*i_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
*i_frame_length = 1
*i_bytes_per_frame = 4

Once we have an output format, we deduce the mixer format. It is strictly forbidden to change the audio sample format between the mixer and the output (because all transformations happen in the input pipeline), except for i_format. The reason is that we have only developed three mixers (float32 and S/PDIF, plus fixed32 for embedded devices which do not feature an FPU), so all other types must be cast into one of those. Still with our example, the p_aout->mixer.mixer structure looks like :

*i_format = 'fl32'
*i_rate = 44100
*i_channels = AOUT_CHAN_LEFT | AOUT_CHAN_RIGHT
*i_frame_length = 1
*i_bytes_per_frame = 8

The aout core will thus allocate an audio filter to convert 'fl32' to AOUT_FMT_S16_NE. This is the only audio filter in the output pipeline. It will also allocate a float32 mixer. Since only one input stream is present, the trivial mixer will be used (only copies samples from the first input stream). Otherwise it would have used a more precise float32 mixer.

The last step of the initialization is to build an input pipeline. When several properties have to be changed, the aout core searches first for an audio filter capable of changing :

#All parameters ;
#i_format and i_physical_channels/i_original_channels ;
#i_format ;

If the whole transformation cannot be done by only one audio filter, it will allocate a second and maybe a third filter to deal with the rest. To follow up on our example, we will allocate two filters : a52tofloat32 (which will deal with the conversion and the downmixing), and a resampler. Quite often, for undecoded formats, the converter will also deal with the downmixing, for efficiency reasons.

When this initialization is over, the "decoder" plug-in can run its main loop. Typically the decoder requests a buffer of length i_nb_samples, and copies the undecoded samples there (using GetChunk()). The buffer then goes along the input pipeline, which will do the decoding (to 'fl32'), and downmixing and resampling. Additional resampling will occur if complex latency issues in the output layer impose us to go temporarily faster or slower to achieve perfect lipsync (this is decided on a per-buffer basis). At the end of the input pipeline, the buffer is placed in a FIFO, and the decoder thread runs the audio mixer.

The audio mixer then calculates whether it has enough samples to build a new output buffer. If it does, it mixes the input streams, and passes the buffer to the output layer. The buffer goes along the output pipeline (which in our case only contains a converter filter), and then it is put in the output FIFO for the device.

Regularly, the output device will fetch the next buffer from the output FIFO, either through a callback of the audio subsystem (Mac OS X' CoreAudio, SDL), or thanks to a dedicated audio output thread (OSS, ALSA...). This mechanism uses aout_OutputNextBuffer(), and gives the estimated playing date of the buffer. If the computed playing date isn't equal to the estimated playing date (with a small tolerance), the output layer changes the date of all buffers in the audio output module, triggering some resampling at the beginning of the input pipeline when the next buffer will come from the decoder. That way, we shall resynchronize audio and video streams. When the buffer is played, it is finally released.

==Mutual exclusion mechanism==

The access to the internal structures must be carefully protected, because contrary to other objects in the VLC framework (input, video output, decoders...), the audio output doesn't have an associated thread. It means that parts of the audio output run in different threads (decoders, audio output IO thread, interface), and we do not control when the functions are called. Thus, much care must be taken to avoid concurrent access on the same part of the audio output, without creating a bottleneck which would cause latency problems at the output layer.

Consequently, we have set up a locking mechanism in five parts :

#p_aout->mixer_lock : This lock is taken when the audio mixer is entered. The decoder thread in which the mixer runs must hold the mutex during the mixing, until the buffer comes out of the output pipeline. Without holding this mutex, the interface thread cannot change the output pipeline, and a decoder cannot add a new input stream.
#p_input->lock : This lock is taken when a decoder calls aout_BufferPlay(), as long as the buffer is in the input pipeline. The interface thread cannot change the input pipeline without holding this lock.
#p_aout->output_fifo_lock : This lock must be taken to add or remove a packet from the output FIFO, or change its dates.
#p_aout->input_fifos_lock : This lock must be taken to add or remove a packet from one of the input FIFOs, or change its dates.

Having so many mutexes makes it easy to fall into deadlocks (ie. when a thread has the mixer lock and wants the input fifos lock, and the other has the input fifos lock and wants the mixer lock). We could have worked with fewer locks (and even one global_lock), but for instance when the mixer is running, we do not want to block the audio output IO thread from picking up the next buffer. So for efficiency reasons we want to keep that many locks.

So we have set up a strong discipline in taking the locks. If you need several of the locks, you must take them in the order indicated above. For instance if you already the hold input fifos lock, it is strictly forbidden to try and take the mixer lock. You must first release the input fifos lock, then take the mixer lock, and finally take again the input fifos lock.

It might seem a big constraint, but the order has been chosen so that in most cases, it is the most natural order to take the locks.

==Internal structures==

===Buffers===

The aout_buffer_t structure is only allocated by the aout core functions, and goes from the decoder to the output device. A new aout buffer is allocated in these circumstances :

*Whenever the decoder calls aout_BufferNew().
*In the input and output pipeline, when an audio filter requests a new output buffer (ie. when b_in_place == 0, see below).
*In the audio mixer, when a new output buffer is being prepared.

====Note====

Most audio filters are able to place the output result in the same buffer as the input data, so most buffers can be reused that way, and we avoid massive allocations. However, some filters require the allocation of an output buffer.

The core functions are smart enough to determine if the buffer is ephemer (for instance if it will only be used between two audio filters, and disposed of immediately therafter), or if it will need to be shared among several threads (as soon as it will need to stay in an input or output FIFO).

In the first case, the aout_buffer_t structure and its associated buffer will be allocated in the thread's stack (via the alloca() system call), whereas in the latter in the process's heap (via malloc()). You, codec or filter developer, don't have to deal with the allocation or deallocation of the buffers.

The fields you'll probably need to use are : p_buffer (pointer to the raw data), i_nb_bytes (size of the significative portion of the data), i_nb_samples, start_date and end_date.

===Date management===

On the first impression, you might be tempted to think that to calculate the starting date of a buffer, it might be enough to regularly fetch the PTS i_pts from the input, and then : i_pts += i_nb_past_samples * 1000000 / i_rate. Well, I'm sorry to deceive you, but you'll end up with rounding problems, resulting in a crack every few seconds.

Indeed, if you have 1536 samples per buffer (as is often the case for A/52) at 44.1 kHz, it gives : 1536 * 1000000 / 44100 = 34829.9319727891. The decimal part of this figure will drive you mad (note that with 48 kHz samples it is an integral digit, so it will work well in many cases).

One solution could have been to work in nanoseconds instead of milliseconds, but you'd only be making the problem 1000 times less frequent. The only exact solution is to add 34829 for every buffer, and keep the remainder of the division somewhere. For every buffer you add the remainders, and when it's greater than 44100, you add 34830 instead of 34829. That way you don't have the rounding error which would occur in the long run (this is called the Bresenham algorithm).

The good news is, the audio output core provides a structure (audio_date_t) and functions to deal with it :

*aout_DateInit( audio_date_t * p_date, u32 i_divider ) : Initialize the Bresenham algorithm with the divider i_divider. Usually, i_divider will be the rate of the stream.
*aout_DateSet( audio_date_t * p_date, mtime_t new_date ) : Initialize the date, and set the remainder to 0. You will usually need this whenever you get a new PTS from the input.
*aout_DateMove( audio_date_t * p_date, mtime_t difference ) : Add or subtract microseconds from the stored date (used by the aout core when the output layer reports a lipsync problem).
*aout_DateGet( audio_date_t * p_date ) : Return the current stored date.
*aout_DateIncrement( audio_date_t * p_date, u32 i_nb_samples ) : Add i_nb_samples * 1000000 to the stored date, taking into account rounding errors, and return the result.

===FIFOs===

FIFOs are used at two places in the audio output : at the end of the input pipeline, before entering the audio mixer, to store the buffers which haven't been mixed yet ; and at the end of the output pipeline, to queue the buffers for the output device.

FIFOs store a chained list of buffers. They also keep the ending date of the last buffer, and whenever you pass a new buffer, they will enforce the time continuity of the stream by changing its start_date and end_date to match the FIFO's end_date (in case of stream discontinuity, the aout core will have to reset the date). The aout core provides functions to access the FIFO. Please understand than none of these functions use mutexes to protect exclusive access, so you must deal with race conditions yourself if you want to use them directly !

*aout_FifoInit( aout_instance_t * p_aout, aout_fifo_t * p_fifo, u32 i_rate ) : Initialize the FIFO pointers, and the aout_date_t with the appropriate rate of the stream (see above for an explanation of aout dates).
*aout_FifoPush( aout_instance_t * p_aout, aout_fifo_t * p_fifo, aout_buffer_t * p_buffer ) : Add p_buffer at the end of the chained list, update its start_date and end_date according to the FIFO's end_date, and update the internal end_date.
*aout_FifoSet( aout_instance_t * p_aout, aout_fifo_t * p_fifo, mtime_t date ) : Trash all buffers, and set a new end_date. Used when a stream discontinuity has been detected.
*aout_FifoMoveDates( aout_instance_t * p_aout, aout_fifo_t * p_fifo, mtime_t difference ) : Add or subtract microseconds from end_date and from start_date and end_date of all buffers in the FIFO. The aout core will use this function to force resampling, after lipsync issues.
*aout_FifoNextStart( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) : Return the start_date which will be given to the next buffer passed to aout_FifoPush().
*aout_FifoPop( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) : Return the first buffer of the FIFO, and remove it from the chained list.
*aout_FifoDestroy( aout_instance_t * p_aout, aout_fifo_t * p_fifo ) : Free all buffers in the FIFO.

==API for the decoders==

The API between the audio output and the decoders is quite simple. As soon as the decoder has the required information to fill in an audio_sample_format_t, it can call : p_dec->p_aout_input = aout_InputNew( p_dec->p_fifo, &p_dec->p_aout, &p_dec->output_format ).

In the next operations, the decoder will need both p_aout and p_aout_input. To retrieve a buffer, it calls : p_buffer = aout_BufferNew( p_dec->p_aout, p_dec->p_aout_input, i_nb_frames ).

The decoder must at least fill in start_date (using an audio_date_t is recommended), and then it can play the buffer : aout_BufferPlay( p_dec->p_aout, p_dec->p_aout_input, p_buffer ). In case of error, the buffer can be deleted (without being played) with aout_BufferDelete( p_dec->p_aout, p_dec->p_aout_input, p_buffer ).

When the decoder dies, or the sample format changes, the input stream must be destroyed with : aout_InputDelete( p_dec->p_aout, p_dec->p_aout_input ).

==API for the output module==

An output module must implement a constructor, an optional destructor, and a p_aout->output.pf_play function. The constructor is the function which will be called when the module is loaded, and returns 0 if, and only if the output device could be open. The function may perform specific allocation in p_aout->output.p_sys, provided the structure is deallocated in the destructor.

In most cases, the p_aout->output.pf_play function does nothing (the only exception is when the samples can be processed immediately, without caring about dates, as in the file output). The job is then done by the IO callback which you are supposed to provide.

On modern sound architectures (such as Mac OS X CoreAudio or SDL), when the audio buffer starves, the operating system automatically calls a function from your application. On outdated sound architectures (such as OSS), you have to emulate this behavior. Then your constructor must spawn a new audio IO thread, which periodically calls the IO callback to transfer the data.

When it is called, the first job of the IO callback will be determine the date at which the next samples will be played. Again, on modern platforms this information is given by the operating system, whereas on others you have to deduce it from the state of the internal buffer. Then you call aout_OutputNextBuffer( p_aout, next_date, b_can_sleek ), which will return a pointer to the next buffer to write, or NULL if none was available. In the latter case, it is advised to write zeros to the DSP.

The value of the last parameter (b_can_sleek) changes the behavior of the function. When it is set to 0, aout_OutputNextBuffer() will run an internal machinery to compensate for possible drift. For instance if the PTS of the next buffer is 40 ms earlier than the date you ask, it means we are very late. So it will ask the input stage to downsample the incoming buffers, so that we can come back in sync. No specific behavior is thus expected from your module.

On the contrary, when b_can_sleek is set to 1, you tell the output layer not to take any actions to compensate a drift. You will typically use this when you've just played silence, and you can deal with buffers which are too early by inserting zeros (zeros in this case will not break the audio continuity, since you were playing nothing before). Another case of use is with S/PDIF output. S/PDIF packets cannot be resampled for obvious reasons, so you must use b_can_sleek = 1.

Once you have a buffer, you just have to transfer it to the DSP, for instance : memcpy( dsp_buffer, p_buffer->p_buffer, p_buffer->i_nb_bytes ).

Documentation:Hacker's Guide/Audio Mixers

2008-09-13T17:25:34Z

Geal: New page: =Writing an audio mixer= Writing an audio mixer is very similar to writing an audio filter. The only difference is that you have to deal with the input buffers yourself, and request for n...

=Writing an audio mixer=

Writing an audio mixer is very similar to writing an audio filter. The only difference is that you have to deal with the input buffers yourself, and request for new buffers when you need to. Between two calls to pf_do_work, the position in the buffer is remembered in p_input->p_first_byte_to_mix (it isn't always the start of the buffer, since input and output buffers can be of different length). It is your job to set this pointer at the end of pf_do_work.

For more details, please have a look at the float32 mixer. It's much more understandable than lines of documentation.

Hacker Guide/Audio Filters

2008-09-13T17:24:59Z

Geal: New page: =Writing an audio filter= An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it...

=Writing an audio filter=

An audio filter module is constituted of a constructor, a destructor, and a p_filter->pf_do_work function. The constructor is passed a p_filter structure, and it returns 0 if it is able to do the whole transformation between p_filter->input and p_filter->output. If you can do only part of the transformation, say you can't do it (if the aout core doesn't find a fitting filter, it will split the transformation and ask you again).

==Note==

Audio filters can be of three types :

*Converters : change i_format (for instance from float32 to s16).
*Resamplers : change i_rate (for instance from 48 kHz to 44.1 kHz).
*Channel mixers : change i_physical_channels/i_original_channels (for instance from 5.1 to stereo).

Audio filters can also combine any of these types. For instance you can have an audio filter which transforms A/52 5.1 to float32 stereo.

The constructor must also set p_filter->b_in_place. If it's 0, the aout core will allocate a new buffer for the output. If it's 1, when you write a byte in the output buffer, it destroys the same byte in the input buffer (they share the same memory area). Some filters can work in place because they just do a linear transformation (like float32->s16), but most filters will want b_in_place = 0. The filter can allocate private data in p_filter->p_sys. Do not forget to deallocate it in the destructor.

The p_filter->pf_do_work gets an input and an output buffer as arguments, and process them. At the end of the processing, do not forget to set p_out_buf->i_nb_samples and p_out_buf->i_nb_bytes, since they aren't inited by the aout core (their values can change between input and output and it's not quite predictible).

Hacker Guide

2008-09-13T17:20:41Z

Geal: /* The many layers of VLC */

<div style="background:red;">
This guide is still being constructed. Please see http://www.videolan.org/developers/vlc.html for the current information
</div>
===Authors===
* Derk-Jan Hartman
*Christophe Massiot
*Samuel Hocevar
*Geoffroy Couprie

==Introduction==
* [[Documentation:Hacker's Guide/Introduction| What is this?]]
* What you need to know about VLC

==The many layers of VLC==
* [[Documentation:Hacker's Guide/Core| Core]]
* [[Documentation:Hacker's Guide/VLM Internals| VLM Internals]]
===Plugins===
* [[Documentation:Hacker's Guide/Interfaces| Interfaces]]
* [[Documentation:Hacker's Guide/Access| Access]]
* [[Documentation:Hacker's Guide/Access Filters| Access Filters]]
* [[Documentation:Hacker's Guide/Input| Input]]
* [[Documentation:Hacker's Guide/Demux| Demux]]
* [[Documentation:Hacker's Guide/Decoder| Decoder]]
* [[Documentation:Hacker's Guide/Audio Filters| Audio Filters]]
* [[Documentation:Hacker's Guide/Video Filters| Video Filters]]
* [[Documentation:Hacker's Guide/Audio Mixers| Audio Mixers]]
* [[Documentation:Hacker's Guide/Audio Output| Audio Output]]
* [[Documentation:Hacker's Guide/Video Output| Video Output]]
* [[Documentation:Hacker's Guide/Visualization| Visualization]]
* [[Documentation:Hacker's Guide/Encoder| Encoder]]
* [[Documentation:Hacker's Guide/Mux| Mux]]
* [[Documentation:Hacker's Guide/Packetizers| Packetizers]]
* [[Documentation:Hacker's Guide/Stream Output| Stream Output]]
* [[Documentation:Hacker's Guide/Access Output| Access Output]]

==VLC source code overview==
* [[VLC source tree]]
* [[Documentation:Hacker's Guide/Module Writers Guide|VLC modules]] (also see [[Modules source tree]] )
* [[Documentation:Hacker's Guide/Object Management|VLC Object Management]]
* [[Documentation:Hacker's Guide/Preferences|VLC Preferences]]
* [[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]
* VLC variables
* [[Doxygen Documentation]]

==Coding for VLC==
* [[Sending Patches]]
* [[Code Conventions]]
* Adding a module
* Using [[Documentation:Hacker's Guide/libvlc|libvlc]]
* Bindings

{{Documentation}}

Hacker Guide

2008-09-13T17:13:28Z

Geal: /* The many layers of VLC */

<div style="background:red;">
This guide is still being constructed. Please see http://www.videolan.org/developers/vlc.html for the current information
</div>
===Authors===
* Derk-Jan Hartman
*Christophe Massiot
*Samuel Hocevar
*Geoffroy Couprie

==Introduction==
* [[Documentation:Hacker's Guide/Introduction| What is this?]]
* What you need to know about VLC

==The many layers of VLC==
* [[Documentation:Hacker's Guide/Core| Core]]
* [[Documentation:Hacker's Guide/Interfaces| Interfaces]]
* [[Documentation:Hacker's Guide/Input| Input]]
* Access
* Demux
* [[Documentation:Hacker's Guide/Decoder| Decoder]]
* Packetizers
* Codec
* Stream Output
* [[Documentation:Hacker's Guide/Audio Output| Audio Output]]
* [[Documentation:Hacker's Guide/Video Output| Video Output]]
* [[Documentation:Hacker's Guide/VLM Internals| VLM Internals]]
* [[Documentation:Hacker's Guide/Audio Filters| Audio Filters]]
* [[Documentation:Hacker's Guide/Video Filters| Video Filters]]

==VLC source code overview==
* [[VLC source tree]]
* [[Documentation:Hacker's Guide/Module Writers Guide|VLC modules]] (also see [[Modules source tree]] )
* [[Documentation:Hacker's Guide/Object Management|VLC Object Management]]
* [[Documentation:Hacker's Guide/Preferences|VLC Preferences]]
* [[Documentation:Hacker's Guide/Playlist|VLC Playlist and Media Library]]
* VLC variables
* [[Doxygen Documentation]]

==Coding for VLC==
* [[Sending Patches]]
* [[Code Conventions]]
* Adding a module
* Using [[Documentation:Hacker's Guide/libvlc|libvlc]]
* Bindings

{{Documentation}}

Win32CompileCygwinNew

2008-09-10T09:50:50Z

Geal: /* Advanced usage */ use ccache

This is a new version of the Win32CompileCygwin written by [[User:J-b|Jean-Baptiste Kempf]]
'''This version ONLY works for 0.9.x.'''

'''WARNING''': building VLC on Cygwin has ever been a failure-prone task. It is also very slow. You should really consider cross-compiling from Linux (on a virtual machine, via dual-boot or from another computer). 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
expat
gcc
gcc-core
gcc-g++
gcc-mingw
gcc-mingw-core
gcc-mingw-g++
gdb
gettext
gettext-devel
git
libiconv
libgcrypt-devel
libtool
make
mingw-runtime
nasm
patchutils
pkg-config
subversion

Editor
vim

Libs
libgcrypt

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

'''Note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''

Applies to:

Windows XP Service Pack 2 with Security Update '''KB925902''' installed
Windows XP Service Pack 3

There is a problem on Windows XP (and possibly on other Microsoft Operating Systems) with 'git clone' which aborts unexpectedly with a Cygwin error during the 'checking out files' (reproducable every time and at the same percentage) at the end of the clone procedure:

$ 2 [main] git 4012 D:\cygwin\bin\git.exe:
*** fatal error - '''could not load shell32, Win32 error 487'''

This has been verified (May 22, 2008) against the currently available Cygwin 1.5.25-12 with git package versions 1.5.5.1-1 and 1.5.4-1 and is a generic problem which also affects cloning from other git repositories (although x264.git seems unaffected).

The issue is referred to in the mail archives of the Cygwin project mailing list here
[http://sourceware.org/ml/cygwin/2007-07/msg00858.html Git error on Cygwin].

By eliminating the impossible, whatever remained, however improbable, it is the following Windows Security Update (April 3, 2007) which is actually the cause of the Cygwin issue: [http://www.microsoft.com/technet/security/bulletin/ms07-017.mspx Microsoft Security Bulletin MS07-017 - Vulnerabilities in GDI Could Allow Remote Code Execution (925902)]

Even though the same Security Update applies to the following systems, these are reported not to be affected:

Windows Vista Service Pack 1
Windows 2003 Server Standard Service Pack 2

''It is possible to get 'git clone' working again on the affected systems by removing the Security Update (KB925902) but this is obviously not recommended for security reasons.''

'''Second note for Windows users using [http://www.cygwin.com Cygwin] (linux-like build environment):'''
If you get following error messages

fatal: pack has bad object at offset 98737692: inflate returned -3
fatal: index-pack failed
fetch-pack from 'git://git.videolan.org/vlc.git' failed.

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

== Snapshots ==

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

=Bootstrap=

Open the '''configure.ac''' file, and modify the requirement for gettext 0.17 to 0.15 (so replace line '''AM_GNU_GETTEXT_VERSION(0.17)''' with line '''AM_GNU_GETTEXT_VERSION(0.15)'''), and then run bootstrap.

cd vlc
./bootstrap

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

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

contrib-20060730-win32-bin-gcc-3.4.5-only.tar.bz2 (example)

Those days, you should use
http://people.videolan.org/~jb/Contribs/contrib-20080702-win32-bin-gcc-4.2.1-sjlj-runtime-3.13-only.tar.bz2

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

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:

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.

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

For maintenance purposes periodically check:

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

=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_PATH=/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 \
--disable-gtk \
--enable-nls --enable-sdl --with-sdl-config-path=/usr/win32/bin \
--enable-ffmpeg --with-ffmpeg-mp3lame --with-ffmpeg-faac \
--with-ffmpeg-zlib --enable-faad --enable-flac --enable-theora \
--with-wx-config-path=/usr/win32/bin \
--with-freetype-config-path=/usr/win32/bin \
--with-fribidi-config-path=/usr/win32/bin \
--enable-live555 --with-live555-tree=/usr/win32/live.com \
--enable-caca --with-caca-config-path=/usr/win32/bin \
--with-xml2-config-path=/usr/win32/bin \
--with-dvdnav-config-path=/usr/win32/bin \
--disable-cddax --disable-vcdx --enable-goom \
--enable-twolame --enable-dvdread \
--enable-debug --enable-dca \
--disable-mkv --disable-taglib

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'' cofigure-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 \
...

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

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 either run VLC directly from the source tree or 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 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

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

WinCECompile

2008-09-02T08:37:14Z

Geal: New page: =Introduction= This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC. = Building VLC = ==Pre...

=Introduction=

This is a guide for cross-compiling VLC for Windows CE on Linux with a step-by-step instruction to download, install, configure and build your VLC.

= Building VLC =

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

===Get mingw32ce===
To compile VLC, we use CeGCC, a cross-development environment for Windows CE. Get it on [http://downloads.sourceforge.net/cegcc/mandriva-cegcc-mingw32ce-0.51.0.tar.gz?modtime=1196987404&big_mirror=0 Sourceforge]. There are two environments: CeGCC and Mingw32ce. We use Mingw32ce.

Go the the directory where you dowloaded CeGCC, and untar it:
% tar xzf mandriva-cegcc-mingw32ce-0.51.0.tar.gz -C /

You should now see the folder /opt/mingw32ce.

==Get the source==
Start by [[GetTheSource|getting the source]], using FTP for releases, or using [[Git]] for development.'''The patches for the WinCE port have not yet been added to the main tree. Right now, you should get the tree on git.videolan.org/vlc-geal.git and use the wince2 branch.'''

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

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

==Get the contribs==
There is a package which contains some external libraries, and some hacks with header files. Get [http://eleves.ec-lille.fr/~couprieg/divers/wince.tar.gz it] and uncompress it in /usr/wince.

== Configuration ==

You need to tweak your configure line.

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

Create a new file named conf-vlc.sh and add in it:

PATH=/opt/mingw32ce/bin:/opt/mingw32ce/arm-wince-mingw32ce/bin:$PATH \
CC="/opt/mingw32ce/bin/arm-wince-mingw32ce-gcc" \
CXX="/opt/mingw32ce/bin/arm-wince-mingw32ce-g++" \
CFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
CPPFLAGS="-I/usr/wince/include -I/opt/mingw32ce/arm-wince-mingw32ce/include -mwin32 -D __COREDLL__ -D _WIN32_WCE=0x0500" \
LDFLAGS="-L/opt/mingw32ce/arm-wince-mingw32ce/lib -L/usr/wince/lib -lws2" \

./configure --host=arm-wince-mingw32ce \
--disable-sdl --disable-gtk \
--disable-dvdnav --disable-dvdread --disable-avformat \
--disable-postproc --disable-hal --disable-nls \
--enable-sout --enable-vlm --disable-wxwindows \
--disable-a52 --enable-libmpeg2 --disable-freetype \
--disable-libgcrypt --disable-fribidi --disable-mad \
--disable-optimize-memory --disable-audioscrobbler \
--disable-tremor --disable-faad --enable-ffmpeg --enable-avcodec \
--enable-vlc --disable-activex --disable-testsuite --disable-skins2 \
--disable-qt4 --disable-notify --disable-httpd --disable-dbus-control \
--disable-growl --disable-telepathy --disable-lua --disable-vlm \
--disable-gnutls --disable-bonjour --disable-x11 --disable-glx \
--disable-xvideo --disable-remoteosd --disable-schroedinger \
--disable-dshow --enable-wingdi --disable-real --disable-realrtsp \
--disable-optimizations --disable-optimize-memory --enable-debug \
--enable-wince --enable-waveout --disable-directx --disable-x264 \
--disable-live555 --disable-pulse --disable-swscale

Save it and make it executable:
% chmod u+x conf-vlc.sh

== Compiling source code ==
Now run your configuration script and build VLC:
% ./conf-vlc.sh
% make

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

(Creates the same subdirectory, but with debug symbols).

There is not (yet) an option to build a .cab file.

= Using and Debugging VLC =

== Interacting with your device ==

Use [http://www.synce.org SynCE] to synchronize your device with Linux. Or find an Windows machine and download your fresh new VLC build.

== Running VLC ==

Upload the VLC directory on your Windows CE device, and add in its root mingwm10.dll. This the mingw runtime for Windows CE, and VLC won't work without it. You can find it in /opt/mingw32ce/arm-wince-mingw32ce/bin.

== Debugging VLC ==

CeGCC provides a stub for GDB to permit remote debugging on Windows CE. To use it, go in the vlc folder:
% cd vlc-1.0.0
% arm-wince-mingw32ce-gdb vlc.exe

Then, follow the [http://cegcc.sourceforge.net/docs/debugging.html demo of a debugging session] for Windows CE.

== Common errors ==

Well... I don't remember right now all the weird errors I encountered, but if you find one, I may have seen it before, so contact me, I'll help you and add it here. --[[User:Geal|Geal]] 10:37, 2 September 2008 (CEST)

Talk:SoC 2008/WinCE Port

2008-08-26T08:29:00Z

Geal: /* Progress? */

Contrib Status

2008-08-06T12:35:00Z

Geal: /* Tools */

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

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

=== Codecs ===

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

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

=== Access ===

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

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

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

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

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

Contrib Status

2008-08-06T12:31:04Z

Geal: /* Muxers */

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

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

=== Codecs ===

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

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

=== Access ===

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

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

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

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

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

Contrib Status

2008-08-06T12:29:59Z

Geal: /* Codecs */

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

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

=== Codecs ===

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

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

=== Access ===

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

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

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

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

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

Hacker Guide/Input

2008-08-01T08:55:34Z

Geal: /* What happens to a file */

=The complex multi-layer input=

The idea behind the input module is to treat packets, without knowing at all what is in it. It only takes a packet, reads its ID, and delivers it to the decoder at the right time indicated in the packet header (SCR and PCR fields in MPEG). All the basic browsing operations are implemented without peeking at the content of the elementary stream.

Thus it remains very generic. This also means you can't do stuff like "play 3 frames now" or "move forward 10 frames" or "play as fast as you can but play all frames". It doesn't even know what a "frame" is. There is no privileged elementary stream, like the video one could be (for the simple reason that, according to MPEG, a stream may contain several video ES).

==What happens to a file==

An input thread is spawned for every file read. Indeed, input structures and decoders need to be reinitialized because the specificities of the stream may be different. input_CreateThread is called by the interface thread (playlist module).

At first, vlc looks for an access or access_demux module to open the stream, by calling the function module->pf_activate. If it succeeds, the module thread is started, and vlc can start looking for a demux module to demultiplex the output of the access module.

==Stream Management==

The function which has opened the input socket must specify two properties about it :

p_input->stream.b_pace_control : Whether or not the stream can be read at our own pace (determined by the stream's frequency and the host computer's system clock). For instance a file or a pipe (including TCP/IP connections) can be read at our pace, if we don't read fast enough, the other end of the pipe will just block on a write() operation. On the contrary, UDP streaming (such as the one used by VideoLAN Server) is done at the server's pace, and if we don't read fast enough, packets will simply be lost when the kernel's buffer is full. So the drift introduced by the server's clock must be regularly compensated. This property controls the clock management, and whether or not fast forward and slow motion can be done.

Subtilities in the clock management : With a UDP socket and a distant server, the drift is not negligible because on a whole movie it can account for seconds if one of the clocks is slightly fucked up. That means that presentation dates given by the input thread may be out of sync, to some extent, with the frequencies given in every Elementary Stream. Output threads (and, anecdotically, decoder threads) must deal with it.

The same kind of problems may happen when reading from a device (like video4linux's /dev/video ) connected for instance to a video encoding board. There is no way we could differentiate it from a simple cat foo.mpg | vlc - , which doesn't imply any clock problem. So the Right Thing (c) would be to ask the user about the value of b_pace_control , but nobody would understand what it means (you are not the dumbest person on Earth, and obviously you have read this paragraph several times to understand it :-). Anyway, the drift should be negligible since the board would share the same clock as the CPU, so we chose to neglect it.

p_input->stream.b_seekable : Whether we can do lseek() calls on the file descriptor or not. Basically whether we can jump anywhere in the stream (and thus display a scrollbar) or if we can only read one byte after the other. This has less impact on the stream management than the previous item, but it is not redundant, because for instance cat foo.mpg | vlc - is b_pace_control = 1 but b_seekable = 0. On the contrary, you cannot have b_pace_control = 0 along with b_seekable = 1. If a stream is seekable, p_input->stream.p_selected_area->i_size must be set (in an arbitrary unit, for instance bytes, but it must be the same as p_input->i_tell which indicates the byte we are currently reading from the stream).

===Offset to time conversions===
Functions managing clocks are located in src/input/input_clock.c. All we know about a file is its start offset and its end offset (p_input->stream.p_selected_area->i_size), currently in bytes, but it could be plugin-dependant. So how the hell can we display in the interface a time in seconds ? Well, we cheat. PS streams have a mux_rate property which indicates how many bytes we should read in a second. This is subject to change at any time, but practically it is a constant for all streams we know. So we use it to determine time offsets.

==Structures exported to the interface==

Let's focus on the communication API between the input module and the interface. The most important file is include/input_ext-intf.h, which you should know almost by heart. This file defines the input_thread_t structure, the stream_descriptor_t and all programs and ES descriptors included (you can view it as a tree).

Update: input_thread_t is now defined in include/vlc_input.h

First, note that the input_thread_t structure features two void * pointers, p_method_data and p_plugin_data, which you can respectivly use for buffer management data and plugin data.

Second, a stream description is stored in a tree featuring program descriptors, which themselves contain several elementary stream descriptors. For those of you who don't know all MPEG concepts, an elementary stream, aka ES, is a continuous stream of video or (exclusive) audio data, directly readable by a decoder, without decapsulation.

This tree structure is illustrated by the following figure, where one stream holds two programs. In most cases there will only be one program (to my knowledge only TS streams can carry several programs, for instance a movie and a football game at the same time - this is adequate for satellite and cable broadcasting).

===Warning===

For all modifications and accesses to the p_input->stream structure, you must hold the p_input->stream.stream_lock.

ES are described by an ID (the ID the appropriate demultiplexer will look for), a stream_id (the real MPEG stream ID), a type (defined in ISO/IEC 13818-1 table 2-29) and a litteral description. It also contains context information for the demultiplexer, and decoder information p_decoder_fifo we will talk about in the next chapter. If the stream you want to read is not an MPEG system layer (for instance AVI or RTP), a specific demultiplexer will have to be written. In that case, if you need to carry additional information, you can use void * p_demux_data at your convenience. It will be automatically freed on shutdown.

===Why ID and not use the plain MPEG stream_id ?===

When a packet (be it a TS packet, PS packet, or whatever) is read, the appropriate demultiplexer will look for an ID in the packet, find the relevant elementary stream, and demultiplex it if the user selected it. In case of TS packets, the only information we have is the ES PID, so the reference ID we keep is the PID. PID don't exist in PS streams, so we have to invent one. It is of course based on the stream_id found in all PS packets, but it is not enough, since private streams (ie. AC3, SPU and LPCM) all share the same stream_id (0xBD). In that case the first byte of the PES payload is a stream private ID, so we combine this with the stream_id to get our ID (if you did not understand everything, it isn't very important - just remember we used our brains before writing the code :-).

The stream, program and ES structures are filled in by the plugin's pf_init() using functions in src/input/input_programs.c, but are subject to change at any time. The DVD plugin parses .ifo files to know which ES are in the stream; the TS plugin reads the PAT and PMT structures in the stream; the PS plugin can either parse the PSM structure (but it is rarely present), or build the tree "on the fly" by pre-parsing the first megabyte of data.

===Warning===

In most cases we need to pre-parse (that is, read the first MB of data, and go back to the beginning) a PS stream, because the PSM (Program Stream Map) structure is almost never present. This is not appropriate, though, but we don't have the choice. A few problems will arise. First, non-seekable streams cannot be pre-parsed, so the ES tree will be built on the fly. Second, if a new elementary stream starts after the first MB of data (for instance a subtitle track won't show up during the credits), it won't appear in the menu before we encounter the first packet. We cannot pre-parse the entire stream because it would take hours (even without decoding it).

It is currently the responsibility of the input plugin to spawn the necessary decoder threads. It must call input_SelectES ( input_thread_t * p_input, es_descriptor_t * p_es ) on the selected ES.

The stream descriptor also contains a list of areas. Areas are logical discontinuities in the stream, for instance chapters and titles in a DVD. There is only one area in TS and PS streams, though we could use them when the PSM (or PAT/PMT) version changes. The goal is that when you seek to another area, the input plugin loads the new stream descriptor tree (otherwise the selected ID may be wrong).

==Methods used by the interface==

Besides, input_ext-intf.c provides a few functions to control the reading of the stream :

*input_SetStatus ( input_thread_t * p_input, int i_mode ) : Changes the pace of reading. i_mode can be one of INPUT_STATUS_END, INPUT_STATUS_PLAY, INPUT_STATUS_PAUSE, INPUT_STATUS_FASTER, INPUT_STATUS_SLOWER.

===Note===
Internally, the pace of reading is determined by the variable p_input->stream.control.i_rate. The default value is DEFAULT_RATE. The lower the value, the faster the pace is. Rate changes are taken into account in input_ClockManageRef. Pause is accomplished by simply stopping the input thread (it is then awaken by a pthread signal). In that case, decoders will be stopped too. Please remember this if you do statistics on decoding times (like src/video_parser/vpar_synchro.c does). Don't call this function if p_input->b_pace_control == 0.

*input_Seek ( input_thread_t * p_input, off_t i_position ) : Changes the offset of reading. Used to jump to another place in a file. You mustn't call this function if p_input->stream.b_seekable == 0. The position is a number (usually long long, depends on your libc) between p_input->p_selected_area->i_start and p_input->p_selected_area->i_size (current value is in p_input->p_selected_area->i_tell).

===Note===
Multimedia files can be very large, especially when we read a device like /dev/dvd, so offsets must be 64 bits large. Under a lot of systems, like FreeBSD, off_t are 64 bits by default, but it is not the case under GNU libc 2.x. That is why we need to compile VLC with -D_FILE_OFFSET_BITS=64 -D__USE_UNIX98.

===Escaping stream discontinuities===

Changing the reading position at random can result in a messed up stream, and the decoder which reads it may segfault. To avoid this, we send several NULL packets (ie. packets containing nothing but zeros) before changing the reading position. Indeed, under most video and audio formats, a long enough stream of zeros is an escape sequence and the decoder can exit cleanly.

*input_OffsetToTime ( input_thread_t * p_input, char * psz_buffer, off_t i_offset ) : Converts an offset value to a time coordinate (used for interface display). [currently it is broken with MPEG-2 files]
*input_ChangeES ( input_thread_t * p_input, es_descriptor_t * p_es, u8 i_cat ) : Unselects all elementary streams of type i_cat and selects p_es. Used for instance to change language or subtitle track.
*input_ToggleES ( input_thread_t * p_input, es_descriptor_t * p_es, boolean_t b_select ) : This is the clean way to select or unselect a particular elementary stream from the interface.

==Buffers management==

Input plugins must implement a way to allocate and deallocate packets (whose structures will be described in the next chapter). We basically need four functions :

*pf_new_packet ( void * p_private_data, size_t i_buffer_size ) : Allocates a new data_packet_t and an associated buffer of i_buffer_size bytes.
*pf_new_pes ( void * p_private_data ) : Allocates a new pes_packet_t.
*pf_delete_packet ( void * p_private_data, data_packet_t * p_data ) : Deallocates p_data.
*pf_delete_pes ( void * p_private_data, pes_packet_t * p_pes ) : Deallocates p_pes.

All functions are given p_input->p_method_data as first parameter, so that you can keep records of allocated and freed packets.

===Buffers management strategies===

Buffers management can be done in three ways :

#Traditional libc allocation : For a long time we have used in the PS plugin malloc() and free() every time we needed to allocate or deallocate a packet. Contrary to a popular belief, it is not that slow.
#Netlist : In this method we allocate a very big buffer at the beginning of the problem, and then manage a list of pointers to free packets (the "netlist"). This only works well if all packets have the same size. It is used for long for the TS input. The DVD plugin also uses it, but adds a refcount flag because buffers (2048 bytes) can be shared among several packets. It is now deprecated and won't be documented.
#Buffer cache : We are currently developing a new method. It is already in use in the PS plugin. The idea is to call malloc() and free() to absorb stream irregularities, but re-use all allocated buffers via a cache system. We are extending it so that it can be used in any plugin without performance hit, but it is currently left undocumented.

==Demultiplexing the stream==

After being read by pf_read , your plugin must give a function pointer to the demultiplexer function. The demultiplexer is responsible for parsing the packet, gathering PES, and feeding decoders.

Demultiplexers for standard MPEG structures (PS and TS) have already been written. You just need to indicate input_DemuxPS and input_DemuxTS for pf_demux. You can also write your own demultiplexer.

It is not the purpose of this document to describe the different levels of encapsulation in an MPEG stream. Please refer to your MPEG specification for that.

Hacker Guide

2008-08-01T08:42:42Z

Geal: add pages for prefs and playlist

FFmpeg

2008-07-31T09:18:11Z

Geal:

{{website|FFmpeg|http://ffmpeg.sourceforge.net/}}
{{open}}

'''FFmpeg''' is an [[open source]] library for [[encoding]] and [[decoding]] different types of media files, generally [[MPEG]] and MPEG-based files.

FFmpeg supports lots of [[codec]]s: the main ones are included on the codecs page. If you want the full list, (including different spellings for the same codec), the [[source code]] lists them all (theres way to many to list them all here ;-). In [http://trac.videolan.org/vlc/browser/modules/codec/avcodec/fourcc.h modules/codec/avcodec/fourcc.h] look under ''Codec fourcc -> ffmpeg_id mapping'' (that bit changes the codecs you type in to vlc to ffmpeg's internal codec names).

==Source code==
{{file|modules/codec/avcodec/fourcc.h|codec}}

[[Category:Libraries]]

FFmpeg

2008-07-31T09:17:10Z

Geal:

{{website|FFmpeg|http://ffmpeg.sourceforge.net/}}
{{open}}

'''FFmpeg''' is an [[open source]] library for [[encoding]] and [[decoding]] different types of media files, generally [[MPEG]] and MPEG-based files.

FFmpeg supports lots of [[codec]]s: the main ones are included on the codecs page. If you want the full list, (including different spellings for the same codec), the [[source code]] lists them all (theres way to many to list them all here ;-). In [http://trac.videolan.org/vlc/file/trunk/modules/codec/avcodec/fourcc.h modules/codec/avcodec/fourcc.h] look under ''Codec fourcc -> ffmpeg_id mapping'' (that bit changes the codecs you type in to vlc to ffmpeg's internal codec names).

==Source code==
{{file|modules/codec/avcodec/fourcc.h|codec}}

[[Category:Libraries]]

Talk:SoC 2008/WinCE Port

2008-07-23T08:54:07Z

Geal: