VideoLAN Wiki - User contributions [en]

SoC 2011

2011-03-07T20:48:41Z

Ivoire: /* Key ideas for VLC */

'''Google Summer of Code 2011.'''

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}}, [[X264]], the H.264 video encoder, and VLMC.

 

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

[[VideoLAN]] was a mentoring organization in [[SoC 2007|2007]], [[SoC 2008|2008]], [[SoC 2009|2009]] and [[SoC 2010|2010]].

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

If you are a '''student''', please read [[SoC 2011 Rules|the rules and advice]].

=== VLC media player ===

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

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

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

=== x264 ===

{{x264}} is probably the most popular open source video compression software, used worldwide for applications such as web video, television broadcast, and Blu-ray authoring. It outclasses practically all commercial implementations both speed and compression-wise. While not actually part of VLC or ffmpeg, it is a major library used by both, licensed under the GPL. Due to its popularity in the commercial world (for example, Youtube and Facebook rely on it), many companies have offered bounties in the past for features and improvements that they found useful.

=== Summer of Code ===

If selected and developed, SoC projects for VLC will be included in later releases; SoC projects for x264 will be included in the main tree of the project.

All projects are covered by the GPL licence. (v2+)

=== Ideas for VLC and VLMC ===

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

This page is split in three lists of ideas:

#The ''main ideas'' are what seem to be ''key projects'' for VLC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
#Phonon ideas, for KDE/Phonon work.
#The other ideas are less detailed but could be good ideas too.
#VLMC ideas
#[[Mini Projects]] are short-span projects which can be given as Qualification tasks or extended to be Full Summer of Code project.

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

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

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

=== Ideas for x264 ===

For x264 ideas, please see [[SoC x264 2011]].

== Key ideas for VLC ==

=== Audio Filters ===

We are looking for a skilled audiophile that knows a lot about audio theory and practice:

*to create or implement new algorithms, like SRS WoW or other 3D effects
*to work on channels mixing,
*to work on tracks mixing,
*to create scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script.
*LADSPA or other libraries integration will be interesting.

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

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

 

=== UPNP DLNA Server and Client ===

Provide SD module for DLNA shares being compliant with DLNA specification as well as software (say, mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients.

Be smart enough to provide "presets" for known DLNA media clients with limited features (PS3, for instance) which require additional quirks or hacks or items to be transcoded.

''Proposed mentor: ivoire or Meuuh''

=== Assembly optimizations in VLC ===

If you are fond of writing ASM and you are fluent in MMX/SSE2/SSE4, there are many interesting things in VLC to speed up.

*Profiling VLC.
*memcpy implementations in SSE* and MMX (see modules/misc/memcpy/fastmemcpy.h)
*video filters ASM speedups (see modules/video_filter/blend.c)
*audio filters ASM speedups (see modules/audio_filter/equalizer.c)
*Porting other ASM video filters to VLC.

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

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

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

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

The personal cloud project is a simple project to allow people to play their media files anywhere in the world.

Through the http interface of VLC, a user can:

*list the medias from the Media Library,
*play those medias,
*those medias get transcoded and streamed in:
**Flash
**Silverlight
**iPhone format
**Android format
**html5
**A VLC webplugin

A good example of the aim is http://www.vodobox.c.la/

This project has to work on the configuration and NAT traversal.

This projects needs knowledge in HTML and JS; it might require C coding.

''Proposed mentor: dionoea''

 

=== VLC for Anime ===

''Proposed mentor: jb''

 

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

 

=== Automatic LibVLC bindings generation ===

LibVLC can be used from several programming languages like Java or python to embbed VLC feature inside another application. Anyway, maintaining these binding is power consuming.
VLC needs a way to automatically generate theses binding for a large set of programming languages and keep them up-to-date easily.
We advice to use Swig (from http://www.swig.org/) but any other tool is accepted too.

''Proposed mentor: ivoire''

== VLC Student Proposals ==

 

=== Mobile Remote Control ===

(proposed by akashm1990) 

The aim is to make a mobile remote control application for VLC running on the PC. This would be a native application. 

The application will run on a mobile phone connected to the local network over WiFi.(probably using the http interface) 

In addition to the usual remote control functionalities such as play,pause, open new file,volume control,etc. the application aims to implement 2 specific functionalities: 

*On receiving an incoming call, if a video is playing on the PC, it will pause, or if music is playing, the volume may reduce. (user configurable) 
*On receiving an incoming text message, the video playing on screen is paused and the text is displayed onscreen. After a predetermined period of time, the video starts playing again. 

Target Platforms: Android, Symbian(QT) 

A video showing the auto pause functionality using Android emulators and the VLC Python API is shown here: 

http://www.youtube.com/watch?v=ou5prh-EoBs

== VLMC ==

VLMC is a non-linear cross-platform video editor based on VLC. We're looking for student(s) with good C++ skills and some experience with Qt with lots of passion of hacking.

Hang with us at #vlmc or #videolan on irc.freenode.net and talk to the developers directly!

To get selected:

1. [http://wiki.videolan.org/Building_VLMC Download and build] VLMC and start playing with it.

2. Implement some feature(s) or fix some bug(s), search VLMC's [http://trac.videolan.org/vlmc/report bug tracker].

3. Send your patch to vlmc-devel@videolan.org for evaluation and work on your GSoC proposal.

4. Get selected and work on your project!

 You'll be greatly appreciated if you complete any of the proposed qualification tasks: (in increasing level of difficulty)

1. [http://trac.videolan.org/vlmc/ticket/134 Bug 134]: Update labels and strings when locale is changed.

2. [http://trac.videolan.org/vlmc/ticket/61 Bug 61]: Improve project timeline widget to have clip thumbnail.

3. [http://trac.videolan.org/vlmc/ticket/237 Bug 237]: Fix Detached Video Widget on Mac OS when a file is played.

4. [http://trac.videolan.org/vlmc/ticket/145 Bug 145]: Project preview has no sound on Windows.

5. [http://trac.videolan.org/vlmc/ticket/196 Bug 196]: Fix distorted audio playback in project preview.

6. [http://trac.videolan.org/vlmc/ticket/144 Bug 144]: On some platforms, rendered video file has no sound. Identify the problem and fix it.

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

VLMC needs a GUI make over, using Qt APIs such as graphics view, animation, states etc. Correcting those widgets such as the import window, provide alternative widget so VLMC better fits with the video editing needs.

Many widgets can be rewritten : Import, Library, Clip property... be creative !

=== Quality Improvements: Writing Tests and fixing LibVLC APIs ===

Difficulty: Hard

Proposed mentor: ? (needs a VLC developer to mentor this one)

While rendering preview and project, VLMC may sometimes crash due to bugs in the libVLC. The project will consist of; writing (unit) tests/test-cases for VLMC/libVLC APIs, and identify what's causing the crashes and fixing the bugs. The major area is rendering. Testing should be verified on at least two of the OSs: Linux, Windows and Mac. This project can help VLMC have stable releases and better quality control.

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

VLMC uses frei0r plugins to add special effects. The project consists of designing and implementing a plugin architecture that can take in lua/python/compiled-plugins(.so) plugins.

Git

2009-10-24T16:30:44Z

Ivoire: /* Convert your tree to use your ssh push commit access */

= Basic Git usage =

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== List your commits ==
$ git log

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

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

Now you can just type:
$ git up

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

== Submitting patches to the vlc-devel or x264-devel ==

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

[[Category:Building]]

SoC 2009/p2p projectM

2009-06-17T12:21:59Z

Ivoire:

{{SoCProject|year=2009|student=[[User:ivoire|Rémi Duraffort]]|mentor=[[User:thresh|Pavlov Konstantin]]}}

== Abstract ==
The goal of this Google Summer of Code is to implement two feature that are missing in vlc:
* visualisations using libprojectM librairie.
* p2p access capability

== Timeline ==

{|class="wikitable"
|-
! May 26
| Begining of the GSoC but work mainly on vlc next release (a lot of bugs fixed)
|-
| June 17
| libprojectM module mostly finished, code the p2p access
|-
| July 6-12
| Mid-term evaluation
|-
| August 24
| Final evaluation
|}

== Actually ==
The projectM module is mostly finished and give good results. You can try it (tested only under linux for the moment) from [http://git.videolan.org/?p=vlc-ivoire.git my git repository] and compiling vlc with the --enable-projectm configure option. You will need libprojectm-dev and an opengl provider module.

SoC 2009 projects

2009-05-31T14:44:41Z

Ivoire:

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.

==Qt Interface Improvements==

* '''Project page: [[SoC 2009/Qt Interface Improvements]]'''
* '''Student''': [[User:cyril7|Cyril Nikolaev]]
* '''Mentor''': [[User:J-b|Jean-Baptiste Kempf]]
* '''Abstract''':

:Though existing Qt interface offers the user extensive control over VLC functionality, there is much to do from a usability point of view. The project aims to streamline the interface, deliver it from pointless elements and integrate neatly the uncoordinated dilog boxes (like Adjustments or Playlist) into main interface. Reorganization of the interface would reduce user efforts (and mouse click) needed to access desired feature.

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

==RTMP Flash Streaming==

* '''Project page: [[SoC 2009/RTMP Flash Streaming]]'''
* '''Student''': [[User:zhigang|Zhigang Wang]]
* '''Mentor''': [[User:Courmisch|Remi Denis-Courmont]]
* '''Abstract''':

:This project is about to implement the RTMP Streaming function for VLC media player. It includes RTMP input and output parts(Fix bugs in RTMP input module and total rewrite the RTMP output module). while Adobe is about to publish the RTMP protocol spec in the first half of this year, It's the time to do this job.

== Audio Filters in lua ==

* '''Project page: [[SoC_2009/Audio_Filter_Improvement]]'''
* '''Student''': Xiang Wang
* '''Mentor''': [[User:Dionoea|Antoine Cellerier]]
* '''Abstract''':

:Lua script language has been used successfully to VLC.First I'll try to create scriptable new audio filters in lua and enable users to create whatever audio filtering function they want in a Lua script. The second task is to implement new algorithm for 3D effects of VLC filters.

== GPU Decoding ==

* '''Project page: [[SoC_2009/GPU_Decoding_Support]]'''
* '''Student''': [[User:Sterops|Etienne Membrives]]
* '''Mentor''': [[User:jpsaman|Jean-Paul Saman]]
* '''Abstract''':

:The Video Acceleration API is an API designed to provide hardware acceleration for graphic application using the processing power of graphic cards. Drivers exists for Intel graphic cards. This project aims to implement a decoder and the corresponding video output for VLC, using the power of VA API to reduce CPU consumption while reading h.264, VC-1 and MPEG-4 videos.

== libprojectM and p2p access ==

* '''Project page: [[SoC_2009/p2p_projectM]]'''
* '''Student''': [[User:ivoire|Rémi Duraffort]]
* '''Mentor''': [[User:thresh|Pavlov Konstantin]]
* '''Abstract''':
:The first goal of this project is to integrate libprojectM, an audio visualization library, into VLC. The second goal is to make VLC able to directly access to p2p content. This approach is a first step for the intagration of on-demand p2p streaming into VLC media player.

= List of current x264 projects =
...

= List of current VLMC projects =
==Enhancing VLMC==

* '''Project page: [[SoC 2009/Enhancing VLMC]]'''
* '''Student''': [[User:chouquette|Hugo Beauzee-Luyssen]]
* '''Mentor''': Ludovic 'etix' Fauvet
* '''Abstract''':

:The aim of this student project is to provide a functionnal video generation workflow for the video editing tool 'VLMC'. It includes an effect and a transition API, in order to allow developpers to create new modules for this application. This project will be developped closely with VLMC team, so they can add required features, such as the timeline, a previsualisation widget, and many others...

[[Category:SoC_2009_Project]][[Category:SoC]]

SoC 2009/p2p projectM

2009-05-16T20:39:45Z

Ivoire: New page: {{SoCProject|year=2009|student=Rémi Duraffort|mentor=Pavlov Konstantin}} == Abstract == The goal of this Google Summer of Code is to implement two featur...

SoC 2009

2009-03-23T20:14:43Z

Ivoire: I'm a student not a mentor

'''Google Summer of Code 2009.'''

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.

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

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

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

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

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

=== Summer of Code ===

If selected and developed, SoC projects for VLC will be included in the VLC 1.1 or any later version release.

SoC projects for x264 will be included in the main tree of the project.

All projects are covered by the GPL licence. (v2+)

=== Ideas for VLC ===

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

This page is split in three lists of ideas:
# The ''main ideas'' are what seem to be ''key projects'' for VLC and should be more ''thrilling'' than the other ones; we have assigned a potential mentor to each of these.
# The other ideas are less detailed but could be good ideas too.
# [[Mini_Projects]] has some ideas too.

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

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

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

===Ideas for x264===
For x264 ideas, please see [[SoC x264 2009]].

== Main ideas ==

=== Qt pimping ===

Improve Qt interface, used on linux and windows with use of Qt-Kinetic or plasma.

The basic interface is good but could be improved in many ways.

Try to borrow the best ideas for amarok, iTunes, WMP and integrate them into VLC.

Look at other Qt applications or KDE applications.

* You need some Qt and C++ knowlegde and a lot of creativity.

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

=== QuickTimeVR Playback ===
This project deals with integration QuickTimeVR inside VLC using work from [http://freepv.sf.net FreePV] (SoC 2007).

Other panoramic data inputs include video surveillance cameras with a 360° lens, regular images, etc.

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

* Interests in photography is strongly suggested.

''Proposed mentor: dionoea''

=== 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: [[User:J-b|jb]]''

=== Audio Filters ===

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

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

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

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

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

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

''Proposed mentor: Rémi''

=== Media Library work ===
This project is about working on the media library in SQL.

Modern media applications deal with a lot of huge quantity of data, and it can be difficult to deal with it.
This can mean:
* Smart Folders
* Smart Playlists
* IMDB integration
* Integrated and saved bookmarks
* MetaData searching and editing
* Voting and external data integration

See http://jpeg.dinauz.org/VideoLAN/gsoc/

Proposed mentor: ''jpeg''

=== Services Discovery, like Jamendo integration ===

Jamendo, Last.fm and other online music and video services would be great to integrate into VLC.

This project deals with this integration.

* This needs lua, C and C++ programming skills.

''Proposed mentor: ?''

== More Ideas ==

=== QTKit access ===
Build 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 component GUI.

This project requires knowlege of C and preferably also Objective C, 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: thedj''

=== 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. A right-click context menu with basic commands might be a nice way to get started.

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. There is a proof of concept and a better design can be added later on.

''Proposed mentor: jpsaman and jpd''

=== Qt embedded interface ===

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

''Proposed mentor: ILEoo''

=== 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: Rémi''

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

=== Linux GPU Acceleration Integration ===
Some nice APIs are available like VAAPI and like XvBA, and you can do fun things like GPU-based decoding.

''Proposed mentor: jpsaman''

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

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

== 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:
* jpeg
* remi
* xtophe
* jb
* dionoea
* jpsaman
* jpd

=== Administrators ===
* jb
* xtophe

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

DirectFB Compile

2008-03-09T09:12:46Z

Ivoire:

This HOWTO explains howto build and install DirectFB for use with the VLC directfb plugin.

For more details on DirectFB and its requirements you need to check the Internet site of [http://www.directfb.org/ DirectFB].

== Building DirectFB on Linux ==

=== Download ===
Download the following DirectFB tarballs:

* Mandatory tarballs:
** DirectFB-0.9.24.tar.gz
** linux-fusion-1.1.tar.gz

* Optional tarballs:
** DirectFBGL-0.9.23.tar.gz
** FusionSound-0.9.23.tar.gz

Read the DirectFB documentation carefully. You will need it to properly configure your system for use with DirectFB.

Unpack DirectFB-0.9.24.tar.gz:
$> tar -xzvf DirectFB-0.9.24.tar.gz -C directory_where_to_unpack

=== Build Driver ===
Build Fusion DirectFB driver

To build the fusion device driver the source for the Linux kernel your system is running must be installed.
If this is the case then continue with the following sequence of actions. If not then skip this chapter and continue with building DirectFB itself.

Unpack Linux Fusion driver (linux-fusion-1.1.tar.gz):
$> tar -xzvf linux-fusion-1.1.tar.gz -C directory_where_to_unpack

Build the DirectFB's fusion driver:
$> cd /linux-fusion-1.1/
$> make

And as root (hint: su - root):
$> make install

Copy fusion.h into /usr/include/linux directory:
$> cp linux/include/linux/fusion.h /usr/include/linux

=== Build DirectFB ===

Unpack DirectFB-0.9.24.tar.gz:
$> tar -xzvf DirectFB-0.9.24.tar.gz -C directory_where_to_unpack

Configure DirectFB:
$> cd /DirectFB-0.9.24/

If the Fusion DirectFB driver has been compiled and installed against your running version of the Linux kernel, then the DirectFB configure-line looks like this: (If not the --enable-multi can be omitted.)
$> ./configure --enable-multi
$> make

== Compiling VideoLAN VLC ==

Checkout the [[Git]] version from the trunk directory or download one of the nightly snapshots. Then configure VLC using the following commandline:
$> ./bootstrap
$> ./configure --prefix=/usr --enable-directfb --with-directfb=directory_where_to_unpack/DirectFB-0.9.24
$> make

== History ==
This HOWTO has been written by [mailto:jpsaman_at_videolan_dot_org Jean-Paul Saman].
It has been adapted to this wiki by [[User:J-b| Jean-Baptiste Kempf]].

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

Configure

2008-03-09T09:07:28Z

Ivoire: We now use git instead of svn

'''configure''' (also known as '''./configure''') is a [[wikipedia:bash|BASH script]] used to gather information about your computer and select options on what to link to and how. Before running [[make]] (which compiles vlc), you should run configure.

If you are compiling source from [[Git]], then you should run ./bootstrap before running configure.

You can run configure like this:
./configure --options

== Options ==
Below are some common options for configure:
{|
! option !! meaning
|-
| --prefix=''/home/user/vlc/'' || Sets the location of where to install vlc
|-
| --enable-flac || Turns on support for [[FLAC]] audio files
|-
| --enable-ffmpeg || Links with [[ffmpeg]]
|-
| --with-ffmpeg-tree=''/home/user/ffmpeg'' || Location of ffmpeg source code
|}

See `./configure --help' for more information.
== Examples ==

=== Linux ===
./configure --enable-x11 --enable-xvideo --disable-gtk \
--enable-sdl --enable-ffmpeg --with-ffmpeg-mp3lame \
--enable-mad --enable-libdvbpsi --enable-a52 --enable-dts \
--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-livedotcom \
--with-livedotcom-tree=/usr/lib/live --enable-caca \
--enable-skins --enable-skins2 --enable-alsa --disable-kde\
--disable-qt --enable-wxwindows --enable-ncurses \
--enable-release

=== Windows ===
''From http://developers.videolan.org/vlc/vlc/INSTALL.win32''

If you are cross-compiling from Debian, you can use something along those lines:

./bootstrap && \
PKG_CONFIG_LIBDIR=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/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=/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]]

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 about a year or so. So to build without the emulation layer, use something like this:

./bootstrap && \
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 \
--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

If you want to use the emulation layer, then just omit the CC="gcc -mno-cygwin" CXX="g++ -mno-cygwin" line. You're on your own though.

If you are compiling with MSYS/MINGW, then you can use something along those lines:
./bootstrap && \
PKG_CONFIG_PATH=/usr/win32/lib/pkgconfig \
CPPFLAGS="-I/usr/win32/include -I/usr/win32/include/ebml" \
LDFLAGS=-L/usr/win32/lib \
./configure \
--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-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 \
--disable-[[mkv]] \
--enable-debug

If you have used the "extras/contrib" way, you don't need to precise the CFLAGS, LDFLAGS and --with-foo-config-path=.
./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

[[Category:Building]]

UnixCompile

2008-03-09T09:03:04Z

Ivoire: We now use git instead of svn

==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 bootstraping 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 ./configure --help. 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 a thing.
You can have the full list [[Contrib_Status|here]].

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

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

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

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

* Using your distribution or portage system, in order to get all the needed libs (preferred method) :
By example on Debian or Ubuntu:
# 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]], then and do it by hand.

== Configuration ==

You need to tweak your configure line.

./configure is used to check that your system is able to compile VLC.
It's also now that you choose the functionalities of your build of VLC.
% ./configure --help
will show you the various options

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

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

This is an example of a typical VLC configure line.
% ./configure --enable-x11 --enable-xvideo --disable-gtk --enable-sdl --enable-ffmpeg --with-ffmpeg-mp3lame --enable-mad --enable-libdvbpsi --enable-a52
--enable-dts --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-livedotcom --with-livedotcom-tree=/usr/lib/live --enable-caca --enable-skins --enable-skins2
--enable-alsa --disable-kde --enable-qt --enable-wxwindows --enable-ncurses --enable-release

[[User:J-b#My VLC|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 (apt-get install vlc) - 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]].

== See also ==
* http://www.slacky.eu/repository/slackware-11.0/multimedia/vlc/0.8.6a/src/vlc.SlackBuild
[[Category:Building]]