VideoLAN Wiki - User contributions [en]

Plugins/Mozilla

2009-08-25T13:35:39Z

Jpd: /* NSPR_LOG_MODULES */

{| align="right"
| __TOC__
|} 

= MDC, the missing manual =

This page contains some hard-won but still incomplete information that the boys at mozilla conveniently forget to tell you and that may be useful for developing mozilla plugins (such as our vlc plugin).

== General structure ==
Netscape Plugin Application Programming Interface (NPAPI) conforming plugins have a number of entry points that vary across platforms a bit in number and precise function per entry point. Those entry points together must mainly do two things: One) tell the browser what MIME-type(s) this plugin supports, and two) setup two function pointer tables.

The first table contains pointers to functions inside the browser that the plugin may call. This table apparently must be copied to local storage, but I haven't found why. The table necessairily will end up as a global for the plugin so it may as well be a statically allocated global, though there is a shutdown entry point to clean up any dynamic allocations after the last instance is destroyed.

The second table contains pointers to functions the plugin exports to the browser to call. The browser will create a new instance by calling the new function pointer for each place in a webpage that the plugin is needed, and all the other functions will be called with a reference to such an instance.

Enabling script interaction with the plugin should be done using the "NPAPI scripting extensions". This can be done by exporting the desired scripting interfaces through implementing NPObject derivates.

<blockquote>"And we've completely removed support for XPCOM plugins from Mozilla 1.9.2 (Firefox 3.6). —<cite>Benjamin Smedberg  posting in mozilla.dev.tech.plugins on news.mozilla.org</cite></blockquote>

"XPCOM plugins" may or may not be different from "xulrunner extensions". Clarification needed.

== development ==

Apparently only a few files are really needed for developing plugins. According to [http://colonelpanic.net/2009/05/building-a-firefox-plugin-part-two/ this guy] only 12 files:

* jni.h
* jni_md.h
* jri.h
* jritypes.h
* jri_md.h
* npapi.h
* npruntime.h
* nptypes.h
* npupp.h
* obsolete/protypes.h
* prcpucfg.h
* prtypes.h

So far only two actual includes seem sufficient:

<pre><nowiki>
#include <npapi.h>
#include <npupp.h>
</nowiki></pre>

=== GetValue ===
The NS_GetValue entry point and the getvalue function table pointer apparently may point to the same function as long as it can deal with NULL instance references.

== Compiling ==

Compiling a plugin is a bit sparsely documented but the gist seems to be to use <code>pkg-config mozilla-plugin</code> and to add a few choice flags. Thus on linux I have (which may or may not be correct):

<pre><nowiki>
PKGCONFIG=pkg-config
MOZILLA_PLUGIN_CFLAGS=`$(PKGCONFIG) --cflags mozilla-plugin`
MOZILLA_PLUGIN_LIBS=`$(PKGCONFIG) --libs mozilla-plugin`

CXXFLAGS+=-fno-rtti -fno-exceptions -Wl,-z,defs -shared \
-O2 -g -DXP_UNIX -DMOZILLA_STRICT_API \
$(MOZILLA_PLUGIN_CFLAGS)
LDFLAGS+= -shared -Wl,-Bsymbolic \
$(MOZILLA_PLUGIN_LIBS)

npplugin.so: npplugin.o
$(CXX) $(LDFLAGS) $< -o $@

npplugin.o: npplugin.cpp

</nowiki></pre>

== debugging ==

One way to get more useful output out of nspr-based browsers (firefox, epiphany at least) is to set two environment variables:

export NSPR_LOG_FILE NSPR_LOG_MODULES
NSPR_LOG_FILE=path/to/log/file
NSPR_LOG_MODULES=modulename:level,modulename:level

However, I have failed to find a comprehensive list of modules to choose from.  <code>all:5</code> works but is perhaps a bit too verbose. The default for NSPR_LOG_FILE appears to be stderr. On windows the special ''WinDebug'' which redirects to OutputDebugString().

=== NSPR_LOG_MODULES ===
{| class="wikitable"
|-
! Module name
! function
|-
| all
| enable all log modules
|-
| sync
| enable unbuffered logging
|-
| timestamp
| prefix log messages with an UTC timestamp (NSPR 4.8 or later)
|-
| bufsize'':size''
| set the log buffer size
|-
| nsNativeModuleLoader
| xulrunner/XPCOM component loading
|-
| nsHttp
| What the http layer is up to
|-
| nsSocketTransport
| Socket stuff
|-
| nsHostResolver
| DNS queries
|-
| mime
| rowspan=6|MailNews applications (SeaMonkey/Thunderbird) In debug builds also: imapoffline, bayesianfilter, msgcompose, mapi, nsaboutlookcardlog, nsabwinhelperlog, ldapautocomplete, nswabaddressbook, nsaboutlookdirectorylog, movemail, msgbiff, msgpurge, appleimportlog, import
|-
| imap
|-
| nntp
|-
| smtp
|-
| pop3
|-
| ldap
|-
| nsRDFService
| RDF service
|-
| nsXULTemplateBuilder
| template rule network construction and subsequent use
|-
| InMemoryDataSource
| Assert(), Unassert(), HasAssertion(), etc. for most datasources.
|-
| nsComponentManager
| XPCOM, clarification needed
|-
| MCD
| autoconfig?
|-
| HelperAppService
| ''save as'' related?
|-
| negotiateauth
| Found in modauthkerb documentation
|-
| Plugin
| rowspan=3| plugin related. Apparently verbosity goes up to 9?
|-
| PluginNPP
|-
| PluginNPN
|}

VideoLAN in the news

2009-08-18T10:15:57Z

Jpd: /* 2009 */

{| class="infobox"
| [http://news.google.co.uk/news?as_q=&svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&btnG=Google+Search&as_epq=&as_oq=VLC+VideoLAN&as_eq=&as_nsrc=&as_nloc=&as_occt=any&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10 Search Google News] for the latest on VLC ([http://news.google.co.uk/news?svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10&q=VLC+OR+VideoLAN&output=rss RSS feed])
|}
List of articles related to VideoLAN / VLC media player. Please add those which are missing.

== 2009 ==

{|
|July 22||[http://www.nytimes.com/external/gigaom/2009/07/22/22gigaom-4-free-open-source-tools-for-working-with-video-a-34611.html nytimes/gigaom: 4 Free Open-Source Tools for Working With Video and Audio]
|-
|July 7||[http://news.cnet.com/8301-13505_3-10280845-16.html cnet: VideoLAN releases VLC 1.0.0: Your media will never be the same]
|-
|June 4||[http://www.pcwelt.de/start/software_os/audio_video_foto/praxis/191079/alle_video_formate_mit_vlc_player_abspielen/index.html PCWELT Video und Musik: Alle Video-Formate mit VLC Player abspielen]||(german)
|}

== 2007 ==

[http://articles.techrepublic.com.com/2415-7343_11-175865.html SolutionBase: Overcome multimedia hurdles in Linux]

== 2006 ==

[http://software.newsforge.com/article.pl?sid=06/04/19/1711245&from=rss "NewsForge, Transcoding and streaming DVD films with VLC media player"]

[http://www.lesechos.fr/journal20061004/lec2_innovation/4475889.htm Les Echos (France), "Le lecteur multimédia français VLC téléchargé 18 millions de fois"]

[http://www.m2x.nl/mambo/index.php?option=content&task=view&id=124&Itemid=27 M2X Article and NLUUG talk (Netherlands) "Streaming networks with VLC"]

== 2005 ==
[http://www.01net.com/article/284013.html 01net.com (France)]

[http://blogs.zdnet.fr/index.php/2005/06/28/vlc-un-lecteur-multimedia-tres-courtise/ ZDNet (France), "VLC: un lecteur multimedia très courtisé"]

[http://solutions.journaldunet.com/0506/050613_videolan.shtml solutions.journaldunet.com (France)]

[http://www.theregister.co.uk/2005/09/02/dvd_jon_mediaplayer/ The Register (UK), "DVD Jon hacks Media Player file encryption"]

[http://www.source21.nl/2005/12/27/linuxworld-videolan-en-vlc Source21.nl (Netherlands), "LinuxWorld: VideoLAN en VLC (Interview with Jean-Paul Saman)"]

[http://www.macplus.net/magplus/chronique-9311-interview-de-christophe-massiot MacPlus (France), "Interview de Christophe Massiot"]

[http://home.planet.nl/~jpsaman/linux/downloads/vlc_open_source_multimedia.sxi LinuxWorld (Netherlands), "Open Source multimedia by Jean-Paul Saman"]

== 2004 ==

[http://builder.com.com/5100-6375-5136135.html Builder.com (USA?), "Open Source Awards 2004: VideoLAN"]

[http://www.streamingmedia.com/article.asp?id=9000&page=1&c= streamingmedia.com (USA?), "VideoLAN's Piece de Resistance"]

[http://home.planet.nl/~jpsaman/linux/downloads/videolan-fosdem-2004.pdf FOSDEM (Belgium) "VideoLAN VLC presentation at FOSDEM by Jean-Paul Saman"]

== 2002 ==

[http://download.videolan.org/images/macworld0-doublepage.jpg Mac World, "Les petits princes du MPEG-2"]

[http://www.mac4ever.com/articles/humeur/336/interview_de_christophe_massiot_de_vlc/ Mac4ever (France), "Interview de Christophe Massiot de VLC"]

[[Category:About VideoLAN]]

Plugins/Mozilla

2009-08-11T12:31:47Z

Jpd: cannot drop the first heading from the toc. move toc aside instead.

{| align="right"
| __TOC__
|} 

= MDC, the missing manual =

This page contains some hard-won but still incomplete information that the boys at mozilla conveniently forget to tell you and that may be useful for developing mozilla plugins (such as our vlc plugin).

== General structure ==
Netscape Plugin Application Programming Interface (NPAPI) conforming plugins have a number of entry points that vary across platforms a bit in number and precise function per entry point. Those entry points together must mainly do two things: One) tell the browser what MIME-type(s) this plugin supports, and two) setup two function pointer tables.

The first table contains pointers to functions inside the browser that the plugin may call. This table apparently must be copied to local storage, but I haven't found why. The table necessairily will end up as a global for the plugin so it may as well be a statically allocated global, though there is a shutdown entry point to clean up any dynamic allocations after the last instance is destroyed.

The second table contains pointers to functions the plugin exports to the browser to call. The browser will create a new instance by calling the new function pointer for each place in a webpage that the plugin is needed, and all the other functions will be called with a reference to such an instance.

Enabling script interaction with the plugin should be done using the "NPAPI scripting extensions". This can be done by exporting the desired scripting interfaces through implementing NPObject derivates.

<blockquote>"And we've completely removed support for XPCOM plugins from Mozilla 1.9.2 (Firefox 3.6). —<cite>Benjamin Smedberg  posting in mozilla.dev.tech.plugins on news.mozilla.org</cite></blockquote>

"XPCOM plugins" may or may not be different from "xulrunner extensions". Clarification needed.

== development ==

Apparently only a few files are really needed for developing plugins. According to [http://colonelpanic.net/2009/05/building-a-firefox-plugin-part-two/ this guy] only 12 files:

* jni.h
* jni_md.h
* jri.h
* jritypes.h
* jri_md.h
* npapi.h
* npruntime.h
* nptypes.h
* npupp.h
* obsolete/protypes.h
* prcpucfg.h
* prtypes.h

So far only two actual includes seem sufficient:

<pre><nowiki>
#include <npapi.h>
#include <npupp.h>
</nowiki></pre>

=== GetValue ===
The NS_GetValue entry point and the getvalue function table pointer apparently may point to the same function as long as it can deal with NULL instance references.

== Compiling ==

Compiling a plugin is a bit sparsely documented but the gist seems to be to use <code>pkg-config mozilla-plugin</code> and to add a few choice flags. Thus on linux I have (which may or may not be correct):

<pre><nowiki>
PKGCONFIG=pkg-config
MOZILLA_PLUGIN_CFLAGS=`$(PKGCONFIG) --cflags mozilla-plugin`
MOZILLA_PLUGIN_LIBS=`$(PKGCONFIG) --libs mozilla-plugin`

CXXFLAGS+=-fno-rtti -fno-exceptions -Wl,-z,defs -shared \
-O2 -g -DXP_UNIX -DMOZILLA_STRICT_API \
$(MOZILLA_PLUGIN_CFLAGS)
LDFLAGS+= -shared -Wl,-Bsymbolic \
$(MOZILLA_PLUGIN_LIBS)

npplugin.so: npplugin.o
$(CXX) $(LDFLAGS) $< -o $@

npplugin.o: npplugin.cpp

</nowiki></pre>

== debugging ==

One way to get more useful output out of nspr-based browsers (firefox, epiphany at least) is to set two environment variables:

export NSPR_LOG_FILE NSPR_LOG_MODULES
NSPR_LOG_FILE=path/to/log/file
NSPR_LOG_MODULES=modulename:level,modulename:level

However, I have failed to find a comprehensive list of modules to choose from.  <code>all:5</code> works but is perhaps a bit too verbose. The default for NSPR_LOG_FILE appears to be stderr. On windows the special ''WinDebug'' which redirects to OutputDebugString().

=== NSPR_LOG_MODULES ===
{| class="wikitable"
|-
! Module name
! function
|-
| all
| enable all log modules
|-
| sync
| enable unbuffered logging
|-
| timestamp
| prefix log messages with an UTC timestamp (NSPR 4.8 or later)
|-
| bufsize'':size''
| set the log buffer size
|-
| nsNativeModuleLoader
| xulrunner/XPCOM component loading
|-
| mime
| rowspan=6|MailNews applications (SeaMonkey/Thunderbird) In debug builds also: imapoffline, bayesianfilter, msgcompose, mapi, nsaboutlookcardlog, nsabwinhelperlog, ldapautocomplete, nswabaddressbook, nsaboutlookdirectorylog, movemail, msgbiff, msgpurge, appleimportlog, import
|-
| imap
|-
| nntp
|-
| smtp
|-
| pop3
|-
| ldap
|-
| nsRDFService
| RDF service
|-
| nsXULTemplateBuilder
| template rule network construction and subsequent use
|-
| InMemoryDataSource
| Assert(), Unassert(), HasAssertion(), etc. for most datasources.
|-
| nsComponentManager
| XPCOM, clarification needed
|-
| MCD
| autoconfig?
|-
| HelperAppService
| ''save as'' related?
|-
| negotiateauth
| Found in modauthkerb documentation
|-
| Plugin
| rowspan=3| plugin related. Apparently verbosity goes up to 9?
|-
| PluginNPP
|-
| PluginNPN
|}

Plugins/Mozilla

2009-08-11T12:12:13Z

Jpd:

= MDC, the missing manual =

This page contains some hard-won but still incomplete information that the boys at mozilla conveniently forget to tell you and that may be useful for developing mozilla plugins (such as our vlc plugin).

== General structure ==
Netscape Plugin Application Programming Interface (NPAPI) conforming plugins have a number of entry points that vary across platforms a bit in number and precise function per entry point. Those entry points together must mainly do two things: One) tell the browser what MIME-type(s) this plugin supports, and two) setup two function pointer tables.

The first table contains pointers to functions inside the browser that the plugin may call. This table apparently must be copied to local storage, but I haven't found why. The table necessairily will end up as a global for the plugin so it may as well be a statically allocated global, though there is a shutdown entry point to clean up any dynamic allocations after the last instance is destroyed.

The second table contains pointers to functions the plugin exports to the browser to call. The browser will create a new instance by calling the new function pointer for each place in a webpage that the plugin is needed, and all the other functions will be called with a reference to such an instance.

Enabling script interaction with the plugin should be done using the "NPAPI scripting extensions". This can be done by exporting the desired scripting interfaces through implementing NPObject derivates.

<blockquote>"And we've completely removed support for XPCOM plugins from Mozilla 1.9.2 (Firefox 3.6). —<cite>Benjamin Smedberg  posting in mozilla.dev.tech.plugins on news.mozilla.org</cite></blockquote>

"XPCOM plugins" may or may not be different from "xulrunner extensions". Clarification needed.

== development ==

Apparently only a few files are really needed for developing plugins. According to [http://colonelpanic.net/2009/05/building-a-firefox-plugin-part-two/ this guy] only 12 files:

* jni.h
* jni_md.h
* jri.h
* jritypes.h
* jri_md.h
* npapi.h
* npruntime.h
* nptypes.h
* npupp.h
* obsolete/protypes.h
* prcpucfg.h
* prtypes.h

So far only two actual includes seem sufficient:

<pre><nowiki>
#include <npapi.h>
#include <npupp.h>
</nowiki></pre>

=== GetValue ===
The NS_GetValue entry point and the getvalue function table pointer apparently may point to the same function as long as it can deal with NULL instance references.

== Compiling ==

Compiling a plugin is a bit sparsely documented but the gist seems to be to use <code>pkg-config mozilla-plugin</code> and to add a few choice flags. Thus on linux I have (which may or may not be correct):

<pre><nowiki>
PKGCONFIG=pkg-config
MOZILLA_PLUGIN_CFLAGS=`$(PKGCONFIG) --cflags mozilla-plugin`
MOZILLA_PLUGIN_LIBS=`$(PKGCONFIG) --libs mozilla-plugin`

CXXFLAGS+=-fno-rtti -fno-exceptions -Wl,-z,defs -shared \
-O2 -g -DXP_UNIX -DMOZILLA_STRICT_API \
$(MOZILLA_PLUGIN_CFLAGS)
LDFLAGS+= -shared -Wl,-Bsymbolic \
$(MOZILLA_PLUGIN_LIBS)

npplugin.so: npplugin.o
$(CXX) $(LDFLAGS) $< -o $@

npplugin.o: npplugin.cpp

</nowiki></pre>

== debugging ==

One way to get more useful output out of nspr-based browsers (firefox, epiphany at least) is to set two environment variables:

export NSPR_LOG_FILE NSPR_LOG_MODULES
NSPR_LOG_FILE=path/to/log/file
NSPR_LOG_MODULES=modulename:level,modulename:level

However, I have failed to find a comprehensive list of modules to choose from.  <code>all:5</code> works but is perhaps a bit too verbose. The default for NSPR_LOG_FILE appears to be stderr. On windows the special ''WinDebug'' which redirects to OutputDebugString().

=== NSPR_LOG_MODULES ===
{| class="wikitable"
|-
! Module name
! function
|-
| all
| enable all log modules
|-
| sync
| enable unbuffered logging
|-
| timestamp
| prefix log messages with an UTC timestamp (NSPR 4.8 or later)
|-
| bufsize'':size''
| set the log buffer size
|-
| nsNativeModuleLoader
| xulrunner/XPCOM component loading
|-
| mime
| rowspan=6|MailNews applications (SeaMonkey/Thunderbird) In debug builds also: imapoffline, bayesianfilter, msgcompose, mapi, nsaboutlookcardlog, nsabwinhelperlog, ldapautocomplete, nswabaddressbook, nsaboutlookdirectorylog, movemail, msgbiff, msgpurge, appleimportlog, import
|-
| imap
|-
| nntp
|-
| smtp
|-
| pop3
|-
| ldap
|-
| nsRDFService
| RDF service
|-
| nsXULTemplateBuilder
| template rule network construction and subsequent use
|-
| InMemoryDataSource
| Assert(), Unassert(), HasAssertion(), etc. for most datasources.
|-
| nsComponentManager
| XPCOM, clarification needed
|-
| MCD
| autoconfig?
|-
| HelperAppService
| ''save as'' related?
|-
| negotiateauth
| Found in modauthkerb documentation
|-
| Plugin
| rowspan=3| plugin related. Apparently verbosity goes up to 9?
|-
| PluginNPP
|-
| PluginNPN
|}

Plugins/Mozilla

2009-08-11T10:58:52Z

Jpd: Memory dump of mozilla related stuff

= MDC, the missing manual =

This page contains some hard-won but still incomplete information that the boys at mozilla conveniently forget to tell you and that may be useful for developing mozilla plugins (such as our vlc plugin).

== General structure ==
Netscape Plugin Application Programming Interface (NPAPI) conforming plugins have a number of entry points that vary across platforms a bit in number and precise function per entry point. Those entry points together must mainly do two things: One) tell the browser what MIME-type(s) this plugin supports, and two) setup two function pointer tables.

The first table contains pointers to functions inside the browser that the plugin may call. This table apparently must be copied to local storage and due to the structure will end up as a global for the plugin so it may as well be a statically allocated global, though there is a shutdown entry point to clean up any dynamic allocations after the last instance.

The second table contains pointers to functions the plugin exports to the browser to call. The browser will create a new instance by calling the new function pointer for each place in a webpage that the plugin is needed, and all the other functions will be called with a reference to such an instance.

Enabling script interaction with the plugin should be done using the "NPAPI scripting extensions". This can be done by exporting the desired scripting interfaces through implementing NPObject derivates.

<blockquote>"And we've completely removed support for XPCOM plugins from Mozilla 1.9.2 (Firefox 3.6). —<cite>Benjamin Smedberg  posting in mozilla.dev.tech.plugins on news.mozilla.org</cite></blockquote>

"XPCOM plugins" may or may not be different from "xulrunner extensions". Clarification needed.

== Compiling ==

Compiling a plugin is a bit sparsely documented but the gist seems to be to use <code>pkg-config mozilla-plugin</code> and to add a few choice flags. Thus on linux I have (which may or may not be correct):

<pre><nowiki>
PKGCONFIG=`which pkg-config`
MOZILLA_PLUGIN_CFLAGS=`$(PKGCONFIG) --cflags mozilla-plugin`
MOZILLA_PLUGIN_LIBS=`$(PKGCONFIG) --libs mozilla-plugin`

CXXFLAGS+=-fno-rtti -fno-exceptions -Wl,-z,defs -shared \
-O2 -g -DXP_UNIX -DMOZILLA_STRICT_API \
$(MOZILLA_PLUGIN_CFLAGS)
LDFLAGS+= -shared -Wl,-Bsymbolic \
$(MOZILLA_PLUGIN_LIBS)

npplugin.so: npplugin.o
$(CXX) $(LDFLAGS) $< -o $@

npplugin.o: npplugin.cpp

</nowiki></pre>

== debugging ==

One way to get more useful output out of nspr-based browsers (firefox, epiphany at least) is to set two environment variables:

export NSPR_LOG_FILE NSPR_LOG_MODULES
NSPR_LOG_FILE=path/to/log/file
NSPR_LOG_MODULES=modulename:level,modulename:level

However, I have failed to find a comprehensive list of modules to choose from.  <code>all:5</code> works but is perhaps a bit too verbose. The default for NSPR_LOG_FILE appears to be stderr. On windows the special ''WinDebug'' which redirects to OutputDebugString().

=== NSPR_LOG_MODULES ===
{| class="wikitable"
|-
! Module name
! function
|-
| all
| enable all log modules
|-
| sync
| enable unbuffered logging
|-
| timestamp
| prefix log messages with an UTC timestamp (NSPR 4.8 or later)
|-
| bufsize'':size''
| set the log buffer size
|-
| nsNativeModuleLoader
| xulrunner/XPCOM component loading
|-
| mime
| rowspan=6|MailNews applications (SeaMonkey/Thunderbird) In debug builds also: imapoffline, bayesianfilter, msgcompose, mapi, nsaboutlookcardlog, nsabwinhelperlog, ldapautocomplete, nswabaddressbook, nsaboutlookdirectorylog, movemail, msgbiff, msgpurge, appleimportlog, import
|-
| imap
|-
| nntp
|-
| smtp
|-
| pop3
|-
| ldap
|-
| nsRDFService
| RDF service
|-
| nsXULTemplateBuilder
| template rule network construction and subsequent use
|-
| InMemoryDataSource
| Assert(), Unassert(), HasAssertion(), etc. for most datasources.
|-
| nsComponentManager
| XPCOM, clarification needed
|-
| MCD
| autoconfig?
|-
| HelperAppService
| ''save as'' related?
|-
| negotiateauth
| Found in modauthkerb documentation
|}

Code Janitorial

2009-07-28T13:41:41Z

Jpd:

Here is some samples janitorial task you can pick up:

=== General appearance ===

Keeping the source uniformly less than 78 characters wide so it and patches both fit nicely on a 80 column screen is good general practice but it doesn't always happen. Thus an opportunity to reformat clearly overlong lines.

=== Function header ===
The function header commentary isn't uniformed across files. We suggest you to try to tidy this.

/************************************************************************** |
* Get the Media descriptor associated with the instance * | <- function header commentary
**************************************************************************/ |
libvlc_media_descriptor_t *
libvlc_media_instance_get_media_descriptor(
libvlc_media_instance_t *p_mi,
libvlc_exception_t *p_e )
{
...
}

=== Janitorial commits ===

Please, please do not mix cosmetic (reformatting and so on) changes with changes that alter code behaviour in the same commit. Put them in a separate commit marked with <code>Cosmetic: (description here)</code>. Make sure the changes compile before you commit anyway.

VLC Dev Projects

2009-07-28T13:27:10Z

Jpd: /* VLC.app rewrite using the Mac OS X Framework */ add js api callback

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

== LastFM radios ==

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

Talk to dionoea or funman

= Network =

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

= Inputs =

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

= Video =

== DirectX 9 video output ==

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

Contact: [[User:Quovodis|Quovodis]]

== Improvements to the X11 video output ==

Fullscreen support to improve .

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

= Interfaces =

== VLC.app rewrite using the Mac OS X Framework ==

See [[Mac_OS_X_Framework_VLC_app_Rewrite]]

Contact: [[User:Pdherbemont|Pdherbemont]]

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

= Windows port =

Finish port libcddb and libcdio for Windows.

Port libzvbi for Windows

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

= Playlist =

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

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

== Disc probing ==

We currently have some miscellaneous code to detect discs (DVDs, Audio CDs, ...) but it's a bit scattered and it could be used much better in the playlist.

Contact: [[User:Zorglub|Zorglub]]

== Live folders ==

Some programs support so-called live folders. You add a folder to the playlist, and if the files in the folder are changed, the changes are copied to the playlist.

Having this would of course be great :)

It might require some work to be able to do this in Linux, Windows and OS X, but the current developers will of course be able to help on these.

Contacts: [[User:Zorglub|Zorglub]] [[User:The DJ|The DJ]]

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

= Projects running =

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

= Finished projects =

==Audioscrobbler==

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

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

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

VideoLAN in the news

2009-07-24T08:12:57Z

Jpd: /* 2009 */

{| class="infobox"
| [http://news.google.co.uk/news?as_q=&svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&btnG=Google+Search&as_epq=&as_oq=VLC+VideoLAN&as_eq=&as_nsrc=&as_nloc=&as_occt=any&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10 Search Google News] for the latest on VLC ([http://news.google.co.uk/news?svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10&q=VLC+OR+VideoLAN&output=rss RSS feed])
|}
List of articles related to VideoLAN / VLC media player. Please add those which are missing.

== 2009 ==

[http://news.cnet.com/8301-13505_3-10280845-16.html cnet: VideoLAN releases VLC 1.0.0: Your media will never be the same] 
[http://www.nytimes.com/external/gigaom/2009/07/22/22gigaom-4-free-open-source-tools-for-working-with-video-a-34611.html nytimes/gigaom: 4 Free Open-Source Tools for Working With Video and Audio] 

== 2007 ==

[http://articles.techrepublic.com.com/2415-7343_11-175865.html SolutionBase: Overcome multimedia hurdles in Linux]

== 2006 ==

[http://software.newsforge.com/article.pl?sid=06/04/19/1711245&from=rss "NewsForge, Transcoding and streaming DVD films with VLC media player"]

[http://www.lesechos.fr/journal20061004/lec2_innovation/4475889.htm Les Echos (France), "Le lecteur multimédia français VLC téléchargé 18 millions de fois"]

[http://www.m2x.nl/mambo/index.php?option=content&task=view&id=124&Itemid=27 M2X Article and NLUUG talk (Netherlands) "Streaming networks with VLC"]

== 2005 ==
[http://www.01net.com/article/284013.html 01net.com (France)]

[http://blogs.zdnet.fr/index.php/2005/06/28/vlc-un-lecteur-multimedia-tres-courtise/ ZDNet (France), "VLC: un lecteur multimedia très courtisé"]

[http://solutions.journaldunet.com/0506/050613_videolan.shtml solutions.journaldunet.com (France)]

[http://www.theregister.co.uk/2005/09/02/dvd_jon_mediaplayer/ The Register (UK), "DVD Jon hacks Media Player file encryption"]

[http://www.source21.nl/2005/12/27/linuxworld-videolan-en-vlc Source21.nl (Netherlands), "LinuxWorld: VideoLAN en VLC (Interview with Jean-Paul Saman)"]

[http://www.macplus.net/magplus/chronique-9311-interview-de-christophe-massiot MacPlus (France), "Interview de Christophe Massiot"]

[http://home.planet.nl/~jpsaman/linux/downloads/vlc_open_source_multimedia.sxi LinuxWorld (Netherlands), "Open Source multimedia by Jean-Paul Saman"]

== 2004 ==

[http://builder.com.com/5100-6375-5136135.html Builder.com (USA?), "Open Source Awards 2004: VideoLAN"]

[http://www.streamingmedia.com/article.asp?id=9000&page=1&c= streamingmedia.com (USA?), "VideoLAN's Piece de Resistance"]

[http://home.planet.nl/~jpsaman/linux/downloads/videolan-fosdem-2004.pdf FOSDEM (Belgium) "VideoLAN VLC presentation at FOSDEM by Jean-Paul Saman"]

== 2002 ==

[http://download.videolan.org/images/macworld0-doublepage.jpg Mac World, "Les petits princes du MPEG-2"]

[http://www.mac4ever.com/articles/humeur/336/interview_de_christophe_massiot_de_vlc/ Mac4ever (France), "Interview de Christophe Massiot de VLC"]

[[Category:About VideoLAN]]

VideoLAN in the news

2009-07-24T08:09:04Z

Jpd:

{| class="infobox"
| [http://news.google.co.uk/news?as_q=&svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&btnG=Google+Search&as_epq=&as_oq=VLC+VideoLAN&as_eq=&as_nsrc=&as_nloc=&as_occt=any&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10 Search Google News] for the latest on VLC ([http://news.google.co.uk/news?svnum=10&as_scoring=r&hl=en&tab=wn&ie=UTF-8&as_drrb=q&as_qdr=&as_mind=9&as_minm=9&as_maxd=9&as_maxm=10&q=VLC+OR+VideoLAN&output=rss RSS feed])
|}
List of articles related to VideoLAN / VLC media player. Please add those which are missing.

== 2009 ==

[http://www.nytimes.com/external/gigaom/2009/07/22/22gigaom-4-free-open-source-tools-for-working-with-video-a-34611.html nytimes/gigaom: 4 Free Open-Source Tools for Working With Video and Audio]

== 2007 ==

[http://articles.techrepublic.com.com/2415-7343_11-175865.html SolutionBase: Overcome multimedia hurdles in Linux]

== 2006 ==

[http://software.newsforge.com/article.pl?sid=06/04/19/1711245&from=rss "NewsForge, Transcoding and streaming DVD films with VLC media player"]

[http://www.lesechos.fr/journal20061004/lec2_innovation/4475889.htm Les Echos (France), "Le lecteur multimédia français VLC téléchargé 18 millions de fois"]

[http://www.m2x.nl/mambo/index.php?option=content&task=view&id=124&Itemid=27 M2X Article and NLUUG talk (Netherlands) "Streaming networks with VLC"]

== 2005 ==
[http://www.01net.com/article/284013.html 01net.com (France)]

[http://blogs.zdnet.fr/index.php/2005/06/28/vlc-un-lecteur-multimedia-tres-courtise/ ZDNet (France), "VLC: un lecteur multimedia très courtisé"]

[http://solutions.journaldunet.com/0506/050613_videolan.shtml solutions.journaldunet.com (France)]

[http://www.theregister.co.uk/2005/09/02/dvd_jon_mediaplayer/ The Register (UK), "DVD Jon hacks Media Player file encryption"]

[http://www.source21.nl/2005/12/27/linuxworld-videolan-en-vlc Source21.nl (Netherlands), "LinuxWorld: VideoLAN en VLC (Interview with Jean-Paul Saman)"]

[http://www.macplus.net/magplus/chronique-9311-interview-de-christophe-massiot MacPlus (France), "Interview de Christophe Massiot"]

[http://home.planet.nl/~jpsaman/linux/downloads/vlc_open_source_multimedia.sxi LinuxWorld (Netherlands), "Open Source multimedia by Jean-Paul Saman"]

== 2004 ==

[http://builder.com.com/5100-6375-5136135.html Builder.com (USA?), "Open Source Awards 2004: VideoLAN"]

[http://www.streamingmedia.com/article.asp?id=9000&page=1&c= streamingmedia.com (USA?), "VideoLAN's Piece de Resistance"]

[http://home.planet.nl/~jpsaman/linux/downloads/videolan-fosdem-2004.pdf FOSDEM (Belgium) "VideoLAN VLC presentation at FOSDEM by Jean-Paul Saman"]

== 2002 ==

[http://download.videolan.org/images/macworld0-doublepage.jpg Mac World, "Les petits princes du MPEG-2"]

[http://www.mac4ever.com/articles/humeur/336/interview_de_christophe_massiot_de_vlc/ Mac4ever (France), "Interview de Christophe Massiot de VLC"]

[[Category:About VideoLAN]]

Direct Media Object

2009-04-08T14:29:02Z

Jpd: /* Integration in VLC */ language fixes

{{ mmwiki || Direct Media Object || Microsoft_Direct_Media_Object_API }}

== Description ==

Aka. MS DMO API, it is an API for various codecs and other Direct Media Objects.

== Integration in VLC ==

Using DMO, {{VLC}} can use external codecs to read video it would not be able to without, for example many [[Windows Media]] codecs that vlc has no native plugin for, like Microsoft Screen codecs or Microsoft Image codecs.

=== Windows ===
Use it with the '''--codec dmo''' switch from command-line or activate it in the preferences ('''Tools -> Preferences...''' and '''Show settings: All''' and '''Input/Codecs -> Other codecs''' and tick '''Prefer system plugins over VLC''', press Save and restart VLC after the change).

=== Linux ===

Under linux, you can use them with the --enable-loader switch that uses Wine's emulation.
You have to put the Windows Media dlls in the /usr/win32 folder.

SoC 2009

2009-04-08T08:39:26Z

Jpd: /* Assembly optimizations in VLC */

'''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 [[SoC_2009_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]].

=== 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 the 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, primary interface is reasonable but it could be improved in many ways. The (sub)menus and popups need a lot of (re)design, evaluation, Q&A, tinkering, and so on. For example, adding files is cumbersome and repeated adding even more so. Sorting and other displaying options in the playlist would be nice. Error reporting, presentation, and resolution needs improving. For example, import a few audio streams (one or more m3u/pls playlists, perhaps), try to use them, and see what happens when some urls are not available.

Try to borrow the best ideas from amarok, iTunes, WMP, winamp, freeamp 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: [[User:Dionoea|Dionoea]]''

''Interested student: [[User:Leonox|Leonox]]''

[[SoC 2009/QuickTimeVR Playback|Project proposal]]

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

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

=== Flash Streaming ===

RTMP implementation for streaming to Flash10.

''Proposed mentor: jpsaman''

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

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

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

SoC 2009

2009-04-07T11:08:25Z

Jpd: /* Qt pimping */

'''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 [[SoC_2009_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]].

=== 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 the 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, primary interface is reasonable but it could be improved in many ways. The (sub)menus and popups need a lot of (re)design, evaluation, Q&A, tinkering, and so on. For example, adding files is cumbersome and repeated adding even more so. Sorting and other displaying options in the playlist would be nice. Error reporting, presentation, and resolution needs improving. For example, import a few audio streams (one or more m3u/pls playlists, perhaps), try to use them, and see what happens when some urls are not available.

Try to borrow the best ideas from amarok, iTunes, WMP, winamp, freeamp 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: [[User:Dionoea|Dionoea]]''

''Interested student: [[User:Leonox|Leonox]]''

[[SoC 2009/QuickTimeVR Playback|Project proposal]]

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

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

=== Flash Streaming ===

RTMP implementation for streaming to Flash10.

''Proposed mentor: jpsaman''

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

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

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

SoC 2009

2009-03-27T14:42:47Z

Jpd: /* Qt pimping */

'''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 [[SoC_2009_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]].

=== 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 the 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, primary interface is reasonable but it could be improved in many ways. The (sub)menus and popups need a lot of (re)design, evaluation, Q&A, tinkering, and so on. For example, adding files is cumbersome and repeated adding even more so. Sorting and other displaying options in the playlist would be nice. Error reporting, presentation, and resolution needs improving.

Try to borrow the best ideas from amarok, iTunes, WMP, winamp, freeamp 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: [[User:Dionoea|Dionoea]]''

''Interested student: [[User:Leonox|Leonox]]''

[[SoC 2009/QuickTimeVR Playback|Project proposal]]

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

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

=== Flash Streaming ===

RTMP implementation for streaming to Flash10.

''Proposed mentor: jpsaman''

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

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

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

SoC 2009

2009-03-27T14:37:01Z

Jpd: /* Introduction & Information */

'''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 [[SoC_2009_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]].

=== 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 the 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: [[User:Dionoea|Dionoea]]''

''Interested student: [[User:Leonox|Leonox]]''

[[SoC 2009/QuickTimeVR Playback|Project proposal]]

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

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

=== Flash Streaming ===

RTMP implementation for streaming to Flash10.

''Proposed mentor: jpsaman''

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

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

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

SoC 2009

2009-03-19T09:09:48Z

Jpd: /* GUI interfaces for the browsers plug-ins */

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

Proposed mentor: ''jpeg''

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

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

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

=== Administrators ===
* jb
* xtophe

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

SoC 2009

2009-03-19T08:56:08Z

Jpd: /* QTKit access */

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

Proposed mentor: ''jpeg''

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

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: 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: Sterops''

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

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

=== Administrators ===
* jb
* xtophe

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

SoC 2009 Rules

2009-03-13T11:09:44Z

Jpd: /* During the SoC */

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 will have to:
* Show on IRC,
* Join the mailing lists (x264-devel or vlc-devel, according to your project),
* Select an idea,
* 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
* 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 trac ticket 20),
** RAM playlists support (easy),
** WPL and ZPL playlists support (easy too),
** Close a VLC bug on trac,
** Add RMI (RIFF MIDI) support to the SMF demux,
** libsox based module,
** Extend the DBus control to activate a video filter on the fly on an already playing video,
** 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]]

SoC 2009 Rules

2009-03-13T11:02:55Z

Jpd: /* Advices */

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 will have to:
* Show on IRC,
* Join the mailing lists (x264-devel or vlc-devel, according to your project),
* Select an idea,
* 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
* 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 trac ticket 20),
** RAM playlists support (easy),
** WPL and ZPL playlists support (easy too),
** Close a VLC bug on trac,
** Add RMI (RIFF MIDI) support to the SMF demux,
** libsox based module,
** Extend the DBus control to activate a video filter on the fly on an already playing video,
** 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 other people's unrelated broken commits.
* 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]]

Git

2009-02-11T23:16:50Z

Jpd: Some much needed grammar fixes. Still needs work.

= Basic Git usage =
== Getting VLC 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/.

You can also clone using http with out 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].

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

---

To use git with Cygwin (for WinXP) do this:

[Start][Run] and type "cmd".

Change to the directory where you desire to download x264 to:

cd c:\ffmpeg-SVN\

If you have installed Cygwin in the standard location then type this:

C:\ffmpeg-SVN\>c:\cygwin\bin\git clone git://git.videolan.org/x264.git

Initialized empty Git repository in /cygdrive/c/ffmpeg-SVN/x264/.git/ 
remote: Generating pack... 
remote: Done counting 6710 objects. 
remote: Deltifying 6710 objects... 
remote: 100% (6710/6710) done 
remote: Total 6710 (delta 5345), reused 156 (delta 123) : 
Receiving objects: 100% (6710/6710), 1.63 MiB | 25 KiB/s, done. 
Resolving deltas: 100% (5345/5345), done. 

You can use Cygwin's git under the DOS shell but if you try the same
command under the Cygwin (Bash) shell you get an error message.

---

== 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 stash && git pull --rebase && git stash apply"'

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

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.


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.

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