VideoLAN Wiki - User contributions [en]

VLCKit

2015-01-20T14:19:04Z

ConfusedVorlon: /* Are there apps actually deploying VLCKit on OS X and iOS? */

This page provides a brief overview on the [[LibVLC]] binding for Objective-C.

== Introduction ==
VLCKit is an Objective-C wrapper for libvlc's external interface, on '''Mac OS X''' and '''iOS'''.

It includes basic classes for playback, playlists, streaming and transcoding. Doing simple media players (comparable to QuickTime Player or MPlayer OS X) is as hard as doing a QuickTime-based one; thus, it is really easy.
MobileVLCKit is a subset specifically targeting the iOS platform, enabling a full playback experience with playlists, metadata handling and network streaming. If you require a media database, MediaLibraryKit will get you going within minutes.

== Building the framework for OS X ==

* Clone git://git.videolan.org/vlc-bindings/VLCKit.git
* open <code>VLCKit.xcodeproj</code>
* make sure the "Build Everything" target is selected
* build the project

This will automatically fetch and build libvlc as well as accompanying classes.

== Building the framework for iOS ==

* Clone git://git.videolan.org/vlc-bindings/VLCKit.git
* open your favorite terminal application such as Terminal.app or iTerm 2 and navigate to your checkout.
* execute <code>./buildMobileVLCKit.sh</code>
* check <code>-h</code> for available options such as <code>-s</code> to compile for the simulator

This will automatically fetch and build libvlc as well as its dependencies and accompanying classes.

If you want to build a library that will work for both the simulator and devices:
* execute <code>./buildMobileVLCKit.sh</code>, then <code>./buildMobileVLCKit.sh -s</code>
* use xcode command line tools to build a universal library: <code>lipo -create Release-iphoneos/libMobileVLCKit.a Release-iphonesimulator/libMobileVLCKit.a -o libMobileVLCKit.a</code>

'''Dependencies warning:''' The built script fetches dependencies automatically and builds them locally; beware that system-wide installations through Homebrew may interfere with the local build scripts. If you get autoconf-related errors, try removing /usr/local from your PATH, wiping the source tree, and starting the build over.

== Basic usage in your application ==
The code should speak by itself
// Set up a videoView by hand. You can also do that in the nib file
videoView = [[VLCVideoView alloc] initWithFrame:[[window contentView] bounds]];
[[window contentView] addSubview:videoView];
[videoView setAutoresizingMask: NSViewHeightSizable|NSViewWidthSizable];

// Init the player object
player = [[VLCMediaPlayer alloc] initWithVideoView:videoView];

[player setMedia:[VLCMedia mediaWithPath:@"/to/my/movie"]];
[player play];

== Sample code ==
We offer sample code both for iOS and OS X.

<code>Examples_OSX</code> includes 3 different projects.
* ''BasicPlayerWithPlaylist'': this sum's it up pretty well. drag and drop files, hit play / pause, see them play in the same window in the order you want them to.
[[File:List based vlckit player sample.png|center|Basic Player with Playlist]]
* ''FlashVideoDownloader'': this exemplifies the basics on how to deploy VLC's URL parsing mechanisms to gain access to the actually played media and how to store it.
[[File:Flash video downloader vlckit sample project.png|center|Flash Video Downloader]]
* ''iPodConverter'': VLCKit includes streaming and transcoding features including a few pre-defined profiles. In this sample, you see how to use them. Drop a file in the designated area. Hit convert. See the file being converted including a progress bar.
[[File:Convert for ipad osx sample project.png|center|iPodConverter]]

<code>Examples_iOS</code> includes 2 different projects developed using Xcode 5 and with iOS 7 in mind. With minor modifications, they will also work on iOS 5 and 6.
* ''SimplePlayback'': it's as simple as it sounds. Launch the app to watch a file being streamed live over http from one of our servers to your iOS Simulator or device.
[[File:Simple playback iOS sample project.png|center|Simple Playback]]
* ''DropIn-Player'': this is a more advanced sample project implementing a basic view controller, which could be embedded in your own app. It allows any kind of media playback, subtitles handling, multiple audio track handling, aspect ratio customizations, playback position manipulation and display, volume. All of that, implemented in a self-contained class and a single xib file.
[[File:Drop-in player sample project ios.png|center|Drop-In player]]

== Are there apps actually deploying VLCKit on OS X and iOS? ==
This is a selection of apps we are aware of.

* [https://www.amahi.org/ios Amahi for iOS] by [https://www.amahi.org Amahi]
* [http://www.rotapp.com/app/blackbox/ Blackbox] by Rotapp
* [http://www.rotapp.com/app/dreambox-live/ Dreambox-Live] by Rotapp (discontinued)
* [http://fleex.tv Fleex player] by fleex.tv
* [http://imagneto.sourceforge.net/ iMagneto]
* [http://www.korrisoft.com/references/references.php Korri player] by [http://www.korrisoft.com Korrisoft]
* [[Lunettes]] by the VideoLAN team
* [http://www.korrisoft.com/references/references.php Ma TV Star] by [http://www.korrisoft.com Korrisoft]
* [http://www.domzilla.net/iphone-apps/movieplayer2/ Movie Player 2] by Dominic Rodemer Online Media
* [http://www.korrisoft.com/references/references.php Player multimédia TNT] by [http://www.korrisoft.com Korrisoft]
* [[iOS|VLC for iOS]] by the VideoLAN team
* [http://hobbyistsoftware.com/vlcstreamer-more VLC Streamer] by [http://www.HobbyistSoftware.com HobbyistSoftware]
Feel free to add your application above in alphabetical order. Note that we don't list apps violating VLCKit's licensing terms - regrettably, there are quite a few.

== Compilation tips ==
* If you do not care about the latest, try using the stable branch, e.g. 2.1-stable
* The build tree has what could be described as "git submodules" and they sometimes can fall out of sync. If the code inside <code>MobileVLCKit/ImportedSources/vlc</code> falls out of sync or you need to force a rebuild you may want to remove <code>contrib/iPhoneOS-armv7*/</code>
* In some situations your libtoolize may interfere with the build tools. You may want to add <code>$PATH/MobileVLCKit/ImportedSources/vlc/extras/tools/build/bin</code> towards the beginning of your PATH and build with it

== Related ==
* [[OSXCompile|Compiling VLC on MacOS X]]

==External Links==

* [http://developer.apple.com/documentation/Cocoa/Conceptual/ObjectiveC/Introduction/introObjectiveC.html Introduction to The Objective-C 2.0 Programming Language]
* [http://developer.apple.com/documentation/developertools/Conceptual/IB_UserGuide/Introduction/Introduction.html Interface Builder]

[[Category:LibVLC]]
[[Category:Mac OS X]]
[[Category:iOS]]

SoC 2013

2013-02-14T10:11:02Z

ConfusedVorlon: /* Other Ideas for VLC */

'''SoC 2013 ideas. This is an ideas page only.'''

This wiki page covers the work of the [[VideoLAN]] project as a mentoring organization for [http://code.google.com/soc/ Google Summer of Code], in order to improve {{VLC}}.

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

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

*This page list the ideas for VLC

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

All projects are covered by the GPL (v2+) or LGPL (v2.1+) licenses depending on the module and student wishes.

== Ideas ==
=== 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]] are short-span projects which can be given as Qualification tasks or extended to be Full Summer of Code project.

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

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

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve the current VLC for [http://git.videolan.org/?p=vlc/vlc-ports/android.git;a=summary Android].

''Proposed mentors: ?''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirPlay streaming ===

We need to be able to stream everything to your Apple TV.

'''Proposed mentor'''

== Other Ideas for VLC ==

=== Improve messages display ===
When VLC has a problem opening or playing files it shows a messages window on top of the player with the error. This can be annoying if the screen is being controlled remotely as the user has to manually dismiss the message. There are various ways this could be improved:
#Update UI so that messages window will auto-dismiss after x seconds unless it is clicked on (this could be optional behaviour). Clicking on the window would cancel the countdown. If the window was selected from the menu, it would not auto-dismiss.
#Mac OS: Display messages using notification system (if available). Clicking on the notification would open the messages window.
''Suggested by : Confused Vorlon. Proposed mentor: ?''

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

=== VLM UI for the Mac OS X interface ===
Implement an easy-to-use, yet customizable and complete UI for the VideoLAN Media Manager, which allows VLC to stream multiple unicast, multicast and Video-on-Demand streams within a single instance.
You will need a Mac running OS X 10.6 or later and Cocoa programming experience. A basic understanding of media streams is definitely preferable.
Note that this task is too small for an entire summer and should be combined with another topic.
''Proposed mentor: feepk''

== Ideas for VLMC ==

=== VLMC port fixes ===
Fix VLMC building and basic features for Mac OSX, Windows and GNU/Linux. The present code is not in sync with current libvlc, for example it has build failures in some cases and vout is broken on OSX. It's been more than two years since last VLMC release. The task is to fix major blockers and help release version:

- Understand the code, learn about the community and get started (proposed time: 2-3 weeks)
- Fix build system and port specific issues on OSX and GNU/Linux (and Windows as well) (proposed time: 2-3 weeks)
- Fix vout and aout issues for both project and preview rendering (proposed time: 2 weeks)
- Fix blockers for video editing workflow: importing, editing, applying effects (basic ones), project management, saving/reading projects, exporting video as file and to YouTube (proposed time: rest of the time)
''Proposed mentor: bhaisaab''

{{GSoC}}

MacOSCompile

2012-04-06T13:29:40Z

ConfusedVorlon: /* added xcode select */

This is an '''howto''' to compile {{VLC}} on ''Mac OS X'', focused on '''VLC 2.0''' and newer.

= Pre-requisites =

=== Apple Software ===

*You need at least MacOSX 10.5. '''10.6''', '''Snow Leopard''' or later is strongly recommended, though.
*'''Developer Tools from Apple''' from http://developer.apple.com/technology/xcode.html Both ''Xcode3'' and ''Xcode4'' should be fine. Note: If using [https://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/WhatsNewXcode/Articles/xcode_4_3.html Xcode 4.3] or later, the command line tools must be installed manually through preferences. Additionally, [https://trac.videolan.org/vlc/ticket/6305 Xcode 4.3 will require changes to VLC's build system] which are currently pending and may require patching until resolved.

=== GCC 4.2 on Xcode 4.2 or above ===

If you are on Xcode 4.2 or above with no previous Xcode installation, you probably '''NEED''' gcc-4.2 that isn't installed anymore.

Please install it from [https://github.com/kennethreitz/osx-gcc-installer/downloads OSX-GCC installer].

$ gcc-4.2 --version

=== Xcode select on Xcode 4.3 ===

If you are on Xcode 4.3 with no previous Xcode installation , you probably need to run xcode select to point to your xcode developer directory.

$ xcrun clang

If this outputs 'Error: No developer directory...', then use xcode-select to select the developer directory within the Xcode package.

something like:

$ sudo /usr/bin/xcode-select -switch /Applications/Xcode.app/Contents/Developer

=== Git ===

If you have XCode 4, Git is already installed
You just need to point your Terminal to it:

$ export PATH=/Developer/usr/bin:$PATH

If you have Xcode 3, [http://git-scm.com/ get Git from their website].

= [[GetTheSource|Get the source code]] =

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

= Build VLC with a single command =

Setup a build folder:
$ cd vlc && mkdir build && cd build

And run the build:
$ ../extras/package/macosx/build.sh

Wait and you are finished

You can see more options for this build (change arch or sdk):
$ ../extras/package/macosx/build.sh -h

= Build steps =
Now, if you prefer, you can read the following detailed information on how the build internally works:

== Additional development tools ==

You need development tools, notably all the autotools, to build VLC correctly.

Here is how:
$ cd vlc/extras/tools
$ ./bootstrap && make
$ cd ../..

'''Important''': set the new PATH.
$ export PATH=$PWD/extras/tools/build/bin:$PATH

== SDK selection and 32/64 bits ==

=== SDK selection ===

If you want to use the 10.6 SDK (your VLC will only run on 10.6 and more recent computers):

$ export OSX_VERSION=10.6

You can do the same for '''10.5''', but please check that you have ''MacOSX10.5.sdk'' installed in ''/Developer/SDKs/'' . If you are using Xcode 4.2, you can [http://stackoverflow.com/a/6293605 install the 10.5 sdk] with the .dmg from Xcode3.

=== 32/64bits selection ===

The instructions below will build a 64 bits binary using 10.6 (Snow Leopard) SDK. This is reflected by using host and build variables '''x86_64-apple-darwin10'''.

This "triplet" is ARCHITECTURE-apple-SYSTEM.

'''ARCHITECTURE'''

*<code>x86_64</code> represents Intel 64bits.
*<code>i686</code> represents Intel 32bits.
*<code>powerpc</code> represents PowerPC 32bits.

'''SDK SYSTEM'''

*<code>darwin9</code> represents MacOSX 10.5.
*<code>darwin10</code> represents MacOSX 10.6.

So to make a PowerPC build, you would use '''powerpc-apple-darwin9'''. So to make a intel32 build for 10.5+, you would use '''i686-apple-darwin9'''. So to make a intel64 build for 10.6+, you would use '''x86_64-apple-darwin10'''.

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

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

$ cd contrib
$ mkdir -p osx && cd osx
$ ../bootstrap --host=x86_64-apple-darwin10 --build=x86_64-apple-darwin10

=== Prebuilt libraries (recommended) ===

If you want to download a prebuilt package of all the needed libraries.

$ make prebuilt

And then skip to [[OSXCompile#Bootstrap_VLC|bootstrap section of this page]].

=== Build your own libraries (not for the faint-hearted) ===

If you want to build from source a package in the contribs:

$ make -j4 .gettext
$ export PATH=$PWD/../x86_64-apple-darwin10/bin:$PATH

Then:

$ make -j4

If you had no errors, the 3rd party libraries (contrib) are built correctly and you can proceed to the next step.

=== Go Back ===

Go back to the VLC source directory:

$ cd ../..

== Bootstrap VLC ==

This will create the configure script:

$ ./bootstrap

== Configure the VLC build ==

Create a build folder:

$ mkdir -p build && cd build

To list the different options of configure:

$ ../extras/package/macosx/configure.sh --help

To build a 64 bits binary:

$ ../extras/package/macosx/configure.sh --enable-debug --host=x86_64-apple-darwin10 --build=x86_64-apple-darwin10

== Build VLC ==

Just do:
$ make -j4

and wait...

== Package VLC Application for Mac ==

If you want to share the application with another user or another computer:

$ make VLC.app

If you want a disk-image:

$ make package-macosx

Respectively <code>make package-macosx-plugin</code> for the Safari/Mozilla plugin.

= What's wrong: troubleshooting =

=== Xcode path ===

Starting with Leopard, Xcode may be installed to a custom location on the administrator's choice. While this is non-problematic for ordinary Xcode projects, VLC needs a little help. You have to place extra symbolic links in /Developer pointing to your custom location for these folders:

<code>usr, Headers, Private, SDKs, Tools, Makefiles</code>

You can easily create these links by executing the following command for each folder (whereas theFolder is one of these six):

<code>ln -s /full/path/to/Developer/theFolder /Developer/theFolder</code>

=== Xcode version ===

Please make sure that you are using the latest Xcode3 or the latest version of Xcode4 to compile VLC

=== 3rd party packagers and PATH ===

'''Pay careful attention to remove any reference to 3rd party package managersfrom your environment.''' This is important to avoid conflicts between your package manager (homebrew, fink, macports...) and the contrib package manager we use to build our contrib.

It shouldn't be necessary, but it can happen.

'''git must still be accessible though!'''

$ unset PKG_CONFIG_PATH
$ unset PKG_CONFIG_LIBDIR
$ export PATH=$PWD/build/bin:/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin

=== QTsound compilation on X.5 ===

MacOS X.5.SDK is broken - 2 options exist:

Option 1:

*Download the MacOS10.6.sdk and get QTCaptureDecompressedAudioOutput.h from ''/Developer/SDKs/MacOSX10.6.sdk/System/Library/Frameworks/QTKit.framework/Headers/'' and move it to ''/Developer/SDKs/MacOSX10.5.sdk/System/Library/Frameworks/QTKit.framework/Headers/''

*Edit ''/Developer/SDKs/MacOSX10.5.sdk/System/Library/Frameworks/QTKit.framework/Headers/QTKit.h'' and add the

#import <QTKit/QTCaptureDecompressedAudioOutput.h> where needed.

Option 2:

*Configure the VLC build to explicitly use the MacOS10.6.sdk by adding the following flag:
--with-macosx-sdk=/Developer/SDKs/MacOSX10.6.sdk

=== Cross-Compilation to PPC from X.6 intel ===
If you want to compile VLC for PPC, based on a X.6 intel, you need to tweak a few things since Apple broke it.

'''This is VERY advanced stuff!'''

==== Pre-requisites ====
Be sure to:
* have X.6.8
* Xcode 4.2 installed in the normal ''/Developers'' location
* Xcode 3 installed in ''/Xcode3'' location
* MacOS X.6 and X.5 SDK installed in ''/Developers/SDKs/'' , as explained above (SDK selection).

==== GNU AS ====
Using this out of the box will not work because '''AS''' for ppc is broken on the default setup. Here is how to fix it:
cd /usr/libexec/as
sudo mkdir ppc
cd ppc
sudo ln -sf /Xcode3/usr/bin/as as

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

MacOSCompile

2012-04-06T13:07:19Z

ConfusedVorlon: /* GCC 4.2 on Xcode 4.3 */

This is an '''howto''' to compile {{VLC}} on ''Mac OS X'', focused on '''VLC 2.0''' and newer.

= Pre-requisites =

=== Apple Software ===

*You need at least MacOSX 10.5. '''10.6''', '''Snow Leopard''' or later is strongly recommended, though.
*'''Developer Tools from Apple''' from http://developer.apple.com/technology/xcode.html Both ''Xcode3'' and ''Xcode4'' should be fine. Note: If using [https://developer.apple.com/library/mac/#documentation/DeveloperTools/Conceptual/WhatsNewXcode/Articles/xcode_4_3.html Xcode 4.3] or later, the command line tools must be installed manually through preferences. Additionally, [https://trac.videolan.org/vlc/ticket/6305 Xcode 4.3 will require changes to VLC's build system] which are currently pending and may require patching until resolved.

=== GCC 4.2 on Xcode 4.2 or above ===

If you are on Xcode 4.2 or above with no previous Xcode installation, you probably '''NEED''' gcc-4.2 that isn't installed anymore.

Please install it from [https://github.com/kennethreitz/osx-gcc-installer/downloads OSX-GCC installer].

$ gcc-4.2 --version

=== Git ===

If you have XCode 4, Git is already installed
You just need to point your Terminal to it:

$ export PATH=/Developer/usr/bin:$PATH

If you have Xcode 3, [http://git-scm.com/ get Git from their website].

= [[GetTheSource|Get the source code]] =

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

= Build VLC with a single command =

Setup a build folder:
$ cd vlc && mkdir build && cd build

And run the build:
$ ../extras/package/macosx/build.sh

Wait and you are finished

You can see more options for this build (change arch or sdk):
$ ../extras/package/macosx/build.sh -h

= Build steps =
Now, if you prefer, you can read the following detailed information on how the build internally works:

== Additional development tools ==

You need development tools, notably all the autotools, to build VLC correctly.

Here is how:
$ cd vlc/extras/tools
$ ./bootstrap && make
$ cd ../..

'''Important''': set the new PATH.
$ export PATH=$PWD/extras/tools/build/bin:$PATH

== SDK selection and 32/64 bits ==

=== SDK selection ===

If you want to use the 10.6 SDK (your VLC will only run on 10.6 and more recent computers):

$ export OSX_VERSION=10.6

You can do the same for '''10.5''', but please check that you have ''MacOSX10.5.sdk'' installed in ''/Developer/SDKs/'' . If you are using Xcode 4.2, you can [http://stackoverflow.com/a/6293605 install the 10.5 sdk] with the .dmg from Xcode3.

=== 32/64bits selection ===

The instructions below will build a 64 bits binary using 10.6 (Snow Leopard) SDK. This is reflected by using host and build variables '''x86_64-apple-darwin10'''.

This "triplet" is ARCHITECTURE-apple-SYSTEM.

'''ARCHITECTURE'''

*<code>x86_64</code> represents Intel 64bits.
*<code>i686</code> represents Intel 32bits.
*<code>powerpc</code> represents PowerPC 32bits.

'''SDK SYSTEM'''

*<code>darwin9</code> represents MacOSX 10.5.
*<code>darwin10</code> represents MacOSX 10.6.

So to make a PowerPC build, you would use '''powerpc-apple-darwin9'''. So to make a intel32 build for 10.5+, you would use '''i686-apple-darwin9'''. So to make a intel64 build for 10.6+, you would use '''x86_64-apple-darwin10'''.

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

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

$ cd contrib
$ mkdir -p osx && cd osx
$ ../bootstrap --host=x86_64-apple-darwin10 --build=x86_64-apple-darwin10

=== Prebuilt libraries (recommended) ===

If you want to download a prebuilt package of all the needed libraries.

$ make prebuilt

And then skip to [[OSXCompile#Bootstrap_VLC|bootstrap section of this page]].

=== Build your own libraries (not for the faint-hearted) ===

If you want to build from source a package in the contribs:

$ make -j4 .gettext
$ export PATH=$PWD/../x86_64-apple-darwin10/bin:$PATH

Then:

$ make -j4

If you had no errors, the 3rd party libraries (contrib) are built correctly and you can proceed to the next step.

=== Go Back ===

Go back to the VLC source directory:

$ cd ../..

== Bootstrap VLC ==

This will create the configure script:

$ ./bootstrap

== Configure the VLC build ==

Create a build folder:

$ mkdir -p build && cd build

To list the different options of configure:

$ ../extras/package/macosx/configure.sh --help

To build a 64 bits binary:

$ ../extras/package/macosx/configure.sh --enable-debug --host=x86_64-apple-darwin10 --build=x86_64-apple-darwin10

== Build VLC ==

Just do:
$ make -j4

and wait...

== Package VLC Application for Mac ==

If you want to share the application with another user or another computer:

$ make VLC.app

If you want a disk-image:

$ make package-macosx

Respectively <code>make package-macosx-plugin</code> for the Safari/Mozilla plugin.

= What's wrong: troubleshooting =

=== Xcode path ===

Starting with Leopard, Xcode may be installed to a custom location on the administrator's choice. While this is non-problematic for ordinary Xcode projects, VLC needs a little help. You have to place extra symbolic links in /Developer pointing to your custom location for these folders:

<code>usr, Headers, Private, SDKs, Tools, Makefiles</code>

You can easily create these links by executing the following command for each folder (whereas theFolder is one of these six):

<code>ln -s /full/path/to/Developer/theFolder /Developer/theFolder</code>

=== Xcode version ===

Please make sure that you are using the latest Xcode3 or the latest version of Xcode4 to compile VLC

=== 3rd party packagers and PATH ===

'''Pay careful attention to remove any reference to 3rd party package managersfrom your environment.''' This is important to avoid conflicts between your package manager (homebrew, fink, macports...) and the contrib package manager we use to build our contrib.

It shouldn't be necessary, but it can happen.

'''git must still be accessible though!'''

$ unset PKG_CONFIG_PATH
$ unset PKG_CONFIG_LIBDIR
$ export PATH=$PWD/build/bin:/bin:/sbin:/usr/bin:/usr/sbin:/usr/local/bin

=== QTsound compilation on X.5 ===

MacOS X.5.SDK is broken - 2 options exist:

Option 1:

*Download the MacOS10.6.sdk and get QTCaptureDecompressedAudioOutput.h from ''/Developer/SDKs/MacOSX10.6.sdk/System/Library/Frameworks/QTKit.framework/Headers/'' and move it to ''/Developer/SDKs/MacOSX10.5.sdk/System/Library/Frameworks/QTKit.framework/Headers/''

*Edit ''/Developer/SDKs/MacOSX10.5.sdk/System/Library/Frameworks/QTKit.framework/Headers/QTKit.h'' and add the

#import <QTKit/QTCaptureDecompressedAudioOutput.h> where needed.

Option 2:

*Configure the VLC build to explicitly use the MacOS10.6.sdk by adding the following flag:
--with-macosx-sdk=/Developer/SDKs/MacOSX10.6.sdk

=== Cross-Compilation to PPC from X.6 intel ===
If you want to compile VLC for PPC, based on a X.6 intel, you need to tweak a few things since Apple broke it.

'''This is VERY advanced stuff!'''

==== Pre-requisites ====
Be sure to:
* have X.6.8
* Xcode 4.2 installed in the normal ''/Developers'' location
* Xcode 3 installed in ''/Xcode3'' location
* MacOS X.6 and X.5 SDK installed in ''/Developers/SDKs/'' , as explained above (SDK selection).

==== GNU AS ====
Using this out of the box will not work because '''AS''' for ppc is broken on the default setup. Here is how to fix it:
cd /usr/libexec/as
sudo mkdir ppc
cd ppc
sudo ln -sf /Xcode3/usr/bin/as as

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

SoC 2011/Web Interface Improvements

2011-07-07T14:54:20Z

ConfusedVorlon:

{{SoCProject|year=2011|student=[[User:Akashm1990|Akash Mehrotra]]|mentor=confusedvorlon}}

 

== Abstract ==

The primary aim of this project is to improve upon the luahttp interface and to add functions which are currently missing in the luahttp interface as compared to the qt interface.
An additional aim is to redesign the http frontend and to create a lightweight http frontend for mobile devices.

== Tentative list of improvements ==

*enable playlist re-ordering
*enable selection of a subtitle file (by path)
*add 'unminimise' command to the fullscreen command
*add ability to control picture controls (brightness, contrast, etc)
*allow user to get drives list on windows

===in progress===

*enable access to the graphical equaliser

===done===

*speed control
*subtitle delay control
*audio delay control
*get the album art working(working already in luahttp)
*implement pl_delete on luahttp

== Suggestions for possible incorporation ==

-I'm adding this section as a place to store ideas that we might incorporate into the project, but which are still at the discussion stage.

* create status.json and playlist.json - update: in progress by CV
* update web interface pages to request and use json requests - update: probably not relevant with new interface by elminster
* use bonjour to advertise when http interface is live
* expose aspect ratio
* expose dvd info (chapter title)

SoC 2011/Web Interface Improvements

2011-07-03T17:15:04Z

ConfusedVorlon: /* Suggestions for possible incorporation */

{{SoCProject|year=2011|student=[[User:Akashm1990|Akash Mehrotra]]|mentor=confusedvorlon}}

 

== Abstract ==

The primary aim of this project is to improve upon the luahttp interface and to add functions which are currently missing in the luahttp interface as compared to the qt interface.
An additional aim is to redesign the http frontend and to create a lightweight http frontend for mobile devices.

== Tentative list of improvements ==

*enable playlist re-ordering
*enable selection of a subtitle file (by path)
*add 'unminimise' command to the fullscreen command
*add ability to control picture controls (brightness, contrast, etc)
*allow user to get drives list on windows

===in progress===

*enable access to the graphical equaliser
*implement pl_delete on luahttp

===done===

*speed control
*subtitle delay control
*audio delay control
*get the album art working(working already in luahttp)

== Suggestions for possible incorporation ==

-I'm adding this section as a place to store ideas that we might incorporate into the project, but which are still at the discussion stage.

* create status.json and playlist.json - update: in progress by CV
* update web interface pages to request and use json requests - update: probably not relevant with new interface by elminster
* use bonjour to advertise when http interface is live

SoC 2011/Web Interface Improvements

2011-06-29T11:07:08Z

ConfusedVorlon: /* Tentative list of improvements */

{{SoCProject|year=2011|student=[[User:Akashm1990|Akash Mehrotra]]|mentor=confusedvorlon}}

 

== Abstract ==

The primary aim of this project is to improve upon the luahttp interface and to add functions which are currently missing in the luahttp interface as compared to the qt interface.
An additional aim is to redesign the http frontend and to create a lightweight http frontend for mobile devices.

== Tentative list of improvements ==

*enable playlist re-ordering
*enable selection of a subtitle file (by path)
*add 'unminimise' command to the fullscreen command
*add ability to control picture controls (brightness, contrast, etc)
*allow user to get drives list on windows

===in progress===

*enable access to the graphical equaliser
*implement pl_delete on luahttp

===done===

*speed control
*subtitle delay control
*audio delay control
*get the album art working(working already in luahttp)

== Suggestions for possible incorporation ==

-I'm adding this section as a place to store ideas that we might incorporate into the project, but which are still at the discussion stage.

* create status.json and playlist.json
* update web interface pages to request and use json requests

SoC 2011/Web Interface Improvements

2011-06-16T09:36:28Z

ConfusedVorlon:

{{SoCProject|year=2011|student=[[User:Akashm1990|Akash Mehrotra]]|mentor=confusedvorlon}}

 

== Abstract ==

The primary aim of this project is to improve upon the luahttp interface and to add functions which are currently missing in the luahttp interface as compared to the qt interface.
An additional aim is to redesign the http frontend and to create a lightweight http frontend for mobile devices.

== Tentative list of improvements ==

get the album art working
enable playlist re-ordering
enable access to the graphical equaliser
speed control
subtitle delay control
audio delay control
enable selection of a subtitle file (by path)
add 'unminimise' command to the fullscreen command
add ability to control picture controls (brightness, contrast, etc)
implement pl_delete on luahttp
allow user to get drives list on windows

== Suggestions for possible incorporation ==

-I'm adding this section as a place to store ideas that we might incorporate into the project, but which are still at the discussion stage.

* create status.json and playlist.json
* update web interface pages to request and use json requests

SoC 2011

2011-04-26T18:20:12Z

ConfusedVorlon: /* Http interface improvements */

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

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

 

== Introduction & Information ==

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

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

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

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

=== VLC media player ===

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

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

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

=== x264 ===

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

=== Summer of Code ===

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

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

== Ideas ==
=== VLC and VLMC ===

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

This page is split in three lists of ideas:

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

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

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

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

=== Ideas for x264 ===

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve current VLC [http://git.videolan.org/?p=vlc/vlc-android.git;a=summary android port], improve/add native/java interfaces and design and implement a GUI.
The project can be broken into:

* Build libvlc jni, understand LibVlc.
* Design and implement a cool GUI with gestures and using LibVlc implement callbacks, map user events etc.

''Proposed mentors: ivoire''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== VLC for Anime ===

We are looking for a skilled '''anime fan''' that knows a lot about anime theory and practice to work on the optimisation of VLC for anime.
Ideas include:

* Improvement of MKV demuxer for special anime needs
* Subtitles display improvements
* video filters that make sense for anime
* metadata and extensions.

''Proposed mentor: jb''

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

Proposed mentor: "fenrir"

=== Automatic LibVLC bindings generation ===

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

''Proposed mentor: ivoire''

=== OMA/Atrac improvements ===

We need to improve the oma demuxer to support more features and work on the ATRAC3+ decoder in libavcodec, so people can play their files from MiniDiscs.

''Proposed mentors: Adrian, Michael or other people from linux-minidisc''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirTune streaming ===

We need to be able to stream everything to your iPhone.

'''Proposed mentor'''

=== BD-J / BD-Live ===

This is a project to go on the work of last year on Blu-Ray Menus

This project requires Java knowledge

''Proposed mentor: jb'''

=== Http interface improvements ===

This is a project to fix and extend the http inteface (also called oldhttp)

The http interface is used by many remote control apps on various platforms. This project would improve the capability of the interface - and thus enable more features in the various remotes that use it.

* get the album art working
**the interface is supposed to return the current album art at /art (assuming 'export album art' is enabled)
**at the moment, this simply doesn't work.
*enable playlist re-ordering
**at the moment, there is no way in the http interface for the playlist order to be changed
*enable access to the graphical equaliser
**should provide a list of presets available
**should provide info on each slider
**should allow user to select a preset
**should allow user to adjust a slider
*speed control
**allow speed to be set in the form host:8080/requests/status.xml?command=speed&val=<someVal>
**show current speed as part of the status.xml response
*subtitle delay control
**(similar to speed control)
*audio delay control
**(similar to speed control)
*enable selection of a subtitle file (by path)
*add 'unminimise' command to the fullscreen command
**the current fullscreen command just sets the bool value of fullscreen in VLC. However if vlc is minimised on Ubuntu (possibly windows), then fullscreen does nothing. To work as the user would expect, the command=fullscreen should a) set fullscreen b) unminimise VLC
*add ability to control picture controls (brightness, contrast, etc)
*implement pl_delete on luahttp
*allow user to get drives list on windows (in oldHttp, user can browse to c:/..)

*and lots more...

''Proposed mentor: confusedVorlon''

== Other Ideas for VLC ==

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

== VLC Student Proposals ==

=== Mobile Remote Control ===

(proposed by akashm1990) 

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

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

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

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

Target Platforms: Android(primary), Symbian-QT (If time permits) 

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

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

== VLMC ==

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

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

To get selected:

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

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

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

4. Get selected and work on your project!

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

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

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

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

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

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

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

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

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

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

Difficulty: Hard

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

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

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

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

SoC 2011

2011-04-06T15:32:06Z

ConfusedVorlon: /* Http interface improvements */

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

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

 

== Introduction & Information ==

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

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

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

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

=== VLC media player ===

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

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

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

=== x264 ===

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

=== Summer of Code ===

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

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

== Ideas ==
=== VLC and VLMC ===

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

This page is split in three lists of ideas:

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

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

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

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

=== Ideas for x264 ===

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve current VLC [http://git.videolan.org/?p=vlc/vlc-android.git;a=summary android port], improve/add native/java interfaces and design and implement a GUI.
The project can be broken into:

* Build libvlc jni, understand LibVlc.
* Design and implement a cool GUI with gestures and using LibVlc implement callbacks, map user events etc.

''Proposed mentors: MagSoft, ivore''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== VLC for Anime ===

We are looking for a skilled '''anime fan''' that knows a lot about anime theory and practice to work on the optimisation of VLC for anime.
Ideas include:

* Improvement of MKV demuxer for special anime needs
* Subtitles display improvements
* video filters that make sense for anime
* metadata and extensions.

''Proposed mentor: jb''

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

Proposed mentor: "fenrir"

=== Automatic LibVLC bindings generation ===

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

''Proposed mentor: ivoire''

=== OMA/Atrac improvements ===

We need to improve the oma demuxer to support more features and work on the ATRAC3+ decoder in libavcodec, so people can play their files from MiniDiscs.

''Proposed mentors: Adrian, Michael or other people from linux-minidisc''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirTune streaming ===

We need to be able to stream everything to your iPhone.

'''Proposed mentor'''

=== BD-J / BD-Live ===

This is a project to go on the work of last year on Blu-Ray Menus

This project requires Java knowledge

''Proposed mentor: jb'''

=== Http interface improvements ===

This is a project to fix and extend the http inteface (also called oldhttp)

The http interface is used by many remote control apps on various platforms. This project would improve the capability of the interface - and thus enable more features in the various remotes that use it.

* get the album art working
**the interface is supposed to return the current album art at /art (assuming 'export album art' is enabled)
**at the moment, this simply doesn't work.
*enable playlist re-ordering
**at the moment, there is no way in the http interface for the playlist order to be changed
*enable access to the graphical equaliser
**should provide a list of presets available
**should provide info on each slider
**should allow user to select a preset
**should allow user to adjust a slider
*speed control
**allow speed to be set in the form host:8080/requests/status.xml?command=speed&val=<someVal>
**show current speed as part of the status.xml response
*subtitle delay control
**(similar to speed control)
*audio delay control
**(similar to speed control)
*enable selection of a subtitle file (by path)

*and lots more...

''Proposed mentor: confusedVorlon''

== Other Ideas for VLC ==

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

== VLC Student Proposals ==

=== Mobile Remote Control ===

(proposed by akashm1990) 

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

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

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

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

Target Platforms: Android(primary), Symbian-QT (If time permits) 

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

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

== VLMC ==

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

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

To get selected:

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

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

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

4. Get selected and work on your project!

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

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

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

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

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

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

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

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

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

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

Difficulty: Hard

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

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

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

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

SoC 2011

2011-03-24T12:35:30Z

ConfusedVorlon: /* Http interface improvements */

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

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

 

== Introduction & Information ==

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

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

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

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

=== VLC media player ===

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

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

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

=== x264 ===

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

=== Summer of Code ===

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

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

== Ideas ==
=== VLC and VLMC ===

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

This page is split in three lists of ideas:

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

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

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

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

=== Ideas for x264 ===

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve current VLC [http://git.videolan.org/?p=vlc/vlc-android.git;a=summary android port], improve/add native/java interfaces and design and implement a GUI.
The project can be broken into:

* Build libvlc jni, understand LibVlc.
* Design and implement a cool GUI with gestures and using LibVlc implement callbacks, map user events etc.

''Proposed mentors: MagSoft, ivore''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== VLC for Anime ===

We are looking for a skilled '''anime fan''' that knows a lot about anime theory and practice to work on the optimisation of VLC for anime.
Ideas include:

* Improvement of MKV demuxer for special anime needs
* Subtitles display improvements
* video filters that make sense for anime
* metadata and extensions.

''Proposed mentor: jb''

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

Proposed mentor: "fenrir"

=== Automatic LibVLC bindings generation ===

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

''Proposed mentor: ivoire''

=== OMA/Atrac improvements ===

We need to improve the oma demuxer to support more features and work on the ATRAC3+ decoder in libavcodec, so people can play their files from MiniDiscs.

''Proposed mentors: Adrian, Michael or other people from linux-minidisc''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirTune streaming ===

We need to be able to stream everything to your iPhone.

'''Proposed mentor'''

=== BD-J / BD-Live ===

This is a project to go on the work of last year on Blu-Ray Menus

This project requires Java knowledge

''Proposed mentor: jb'''

=== Http interface improvements ===

This is a project to fix and extend the http inteface (also called oldhttp)

The http interface is used by many remote control apps on various platforms. This project would improve the capability of the interface - and thus enable more features in the various remotes that use it.

* get the album art working
**the interface is supposed to return the current album art at /art (assuming 'export album art' is enabled)
**at the moment, this simply doesn't work.
*enable playlist re-ordering
**at the moment, there is no way in the http interface for the playlist order to be changed
*enable access to the graphical equaliser
**should provide a list of presets available
**should provide info on each slider
**should allow user to select a preset
**should allow user to adjust a slider
*speed control
**allow speed to be set in the form host:8080/requests/status.xml?command=speed&val=<someVal>
**show current speed as part of the status.xml response
*subtitle delay control
**(similar to speed control)
*audio delay control
**(similar to speed control)
*and lots more...

''Proposed mentor: confusedVorlon''

== Other Ideas for VLC ==

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

== VLC Student Proposals ==

=== Mobile Remote Control ===

(proposed by akashm1990) 

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

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

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

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

Target Platforms: Android(primary), Symbian-QT (If time permits) 

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

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

== VLMC ==

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

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

To get selected:

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

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

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

4. Get selected and work on your project!

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

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

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

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

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

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

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

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

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

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

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

Difficulty: Hard

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

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

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

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

SoC 2011

2011-03-24T12:34:49Z

ConfusedVorlon: /* Http interface improvements */

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

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

 

== Introduction & Information ==

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

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

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

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

=== VLC media player ===

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

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

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

=== x264 ===

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

=== Summer of Code ===

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

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

== Ideas ==
=== VLC and VLMC ===

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

This page is split in three lists of ideas:

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

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

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

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

=== Ideas for x264 ===

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve current VLC [http://git.videolan.org/?p=vlc/vlc-android.git;a=summary android port], improve/add native/java interfaces and design and implement a GUI.
The project can be broken into:

* Build libvlc jni, understand LibVlc.
* Design and implement a cool GUI with gestures and using LibVlc implement callbacks, map user events etc.

''Proposed mentors: MagSoft, ivore''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== VLC for Anime ===

We are looking for a skilled '''anime fan''' that knows a lot about anime theory and practice to work on the optimisation of VLC for anime.
Ideas include:

* Improvement of MKV demuxer for special anime needs
* Subtitles display improvements
* video filters that make sense for anime
* metadata and extensions.

''Proposed mentor: jb''

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

Proposed mentor: "fenrir"

=== Automatic LibVLC bindings generation ===

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

''Proposed mentor: ivoire''

=== OMA/Atrac improvements ===

We need to improve the oma demuxer to support more features and work on the ATRAC3+ decoder in libavcodec, so people can play their files from MiniDiscs.

''Proposed mentors: Adrian, Michael or other people from linux-minidisc''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirTune streaming ===

We need to be able to stream everything to your iPhone.

'''Proposed mentor'''

=== BD-J / BD-Live ===

This is a project to go on the work of last year on Blu-Ray Menus

This project requires Java knowledge

''Proposed mentor: jb'''

=== Http interface improvements ===

This is a project to fix and extend the http inteface (also called oldhttp)

The http interface is used by many remote control apps on various platforms. This project would improve the capability of the interface - and thus enable more features in the various remotes that use it.

* get the album art working
**the interface is supposed to return the current album art at /art (assuming 'export album art' is enabled)
**at the moment, this simply doesn't work.
*enable playlist re-ordering
**at the moment, there is no way in the http interface for the playlist order to be changed
*enable access to the graphical equaliser
**should provide a list of presets available
**should provide info on each slider
**should allow user to select a preset
**should allow user to adjust a slider
*speed control
**allow speed to be set in the form host:8080/requests/status.xml?command=speed&val=<someVal>
**show current speed as part of the status.xml response
*subtitle delay control
**(similar to speed control)
*audio delay control
**(similar to speed control)
*and lots more...

''Proposed mentor: confusedVorlon'''

== Other Ideas for VLC ==

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

== VLC Student Proposals ==

=== Mobile Remote Control ===

(proposed by akashm1990) 

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

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

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

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

Target Platforms: Android(primary), Symbian-QT (If time permits) 

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

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

== VLMC ==

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

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

To get selected:

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

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

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

4. Get selected and work on your project!

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

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

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

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

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

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

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

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

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

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

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

Difficulty: Hard

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

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

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

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

SoC 2011

2011-03-24T12:34:02Z

ConfusedVorlon: /* Key ideas for VLC */

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

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

 

== Introduction & Information ==

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

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

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

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

=== VLC media player ===

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

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

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

=== x264 ===

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

=== Summer of Code ===

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

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

== Ideas ==
=== VLC and VLMC ===

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

This page is split in three lists of ideas:

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

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

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

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

=== Ideas for x264 ===

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

== Key ideas for VLC ==

=== New Audio Filters ===

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

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

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

''Qualification task'': port any audio filter from MPlayer

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

=== Porting Audio Filters ===

We are looking for a skilled '''audiophile''' that knows a lot about audio theory and practice:
* to port open source algorithm for audio filters to VLC.

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

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

=== UPNP DLNA Server and Client ===

Test and fix service discovery module for UPNP/DLNA shares done by software (mediatomb, xbmc, etc) and hardware implementations.

Provide DLNA plugin for DLNA server compliant with opensource (xbmc, djmount, etc) and proprietary (PS3, xbox360, etc) DLNA clients. Some of the work is already done by previous SoC students.

The plugin must be smart enough to provide "presets" for known DLNA media clients with limited features (PS3 or XBOX360 for starters) which require additional quirks or hacks or items to be transcoded or streamed.

Requires some VLC knowledge as the project will involve using Media Library (arriving in vlc 1.2) and transcoding with VLC API.

''Proposed mentor: thresh''

=== Assembly optimizations in VLC ===

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

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

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

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

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

=== VLC Android Port ===

Improve current VLC [http://git.videolan.org/?p=vlc/vlc-android.git;a=summary android port], improve/add native/java interfaces and design and implement a GUI.
The project can be broken into:

* Build libvlc jni, understand LibVlc.
* Design and implement a cool GUI with gestures and using LibVlc implement callbacks, map user events etc.

''Proposed mentors: MagSoft, ivore''

=== VLC Test Suite ===

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

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

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

''Proposed mentor: Rémi''

=== VLC Personnal Cloud Project 2.0 ===

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

Through the http interface of VLC, a user can:

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

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

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

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

''Proposed mentor: jb''

=== VLC for Anime ===

We are looking for a skilled '''anime fan''' that knows a lot about anime theory and practice to work on the optimisation of VLC for anime.
Ideas include:

* Improvement of MKV demuxer for special anime needs
* Subtitles display improvements
* video filters that make sense for anime
* metadata and extensions.

''Proposed mentor: jb''

=== SVCD/VCD improvements ===

Menus and such needs to be improvements and fixed.

Proposed mentor: "fenrir"

=== Automatic LibVLC bindings generation ===

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

''Proposed mentor: ivoire''

=== OMA/Atrac improvements ===

We need to improve the oma demuxer to support more features and work on the ATRAC3+ decoder in libavcodec, so people can play their files from MiniDiscs.

''Proposed mentors: Adrian, Michael or other people from linux-minidisc''

=== Playlist improvements ===

We need to reinforce the media library capabilities and its integration with external metadata sources, notably for TV shows.

''Proposed mentor: jetru''

=== AirTune streaming ===

We need to be able to stream everything to your iPhone.

'''Proposed mentor'''

=== BD-J / BD-Live ===

This is a project to go on the work of last year on Blu-Ray Menus

This project requires Java knowledge

''Proposed mentor: jb'''

=== Http interface improvements ===

This is a project to fix and extend the http inteface (also called oldhttp)

The http interface is used by many remote control apps on various platforms. This project would improve the capability of the interface - and thus enable more features in the various remotes that use it.

# get the album art working
##the interface is supposed to return the current album art at /art (assuming 'export album art' is enabled)
##at the moment, this simply doesn't work.
# enable playlist re-ordering
##at the moment, there is no way in the http interface for the playlist order to be changed
# enable access to the graphical equaliser
##should provide a list of presets available
##should provide info on each slider
##should allow user to select a preset
##should allow user to adjust a slider
# speed control
##allow speed to be set in the form host:8080/requests/status.xml?command=speed&val=<someVal>
##show current speed as part of the status.xml response
# subtitle delay control
##(similar to speed control)
# audio delay control
##(similar to speed control)
# and lots more...

''Proposed mentor: confusedVorlon'''

== Other Ideas for VLC ==

=== WTV support ===
Wtv format support
''Proposed mentor: Laurent''

=== DVD audio support ===
Very difficult project for Audio fans
''Proposed mentor: jb''

=== Device synchronisation===
Sync your mp3 player with the media library
''Proposed mentor: jetru''

=== HD DVD support ===
Very difficult project for someone having the right hardware
''Proposed mentor: jb''

=== Multi-Angle DVD support ===
We need multi-angle DVD support
''Proposed mentor: Meuuh''

== VLC Student Proposals ==

=== Mobile Remote Control ===

(proposed by akashm1990) 

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

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

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

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

Target Platforms: Android(primary), Symbian-QT (If time permits) 

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

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

== VLMC ==

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

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

To get selected:

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

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

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

4. Get selected and work on your project!

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

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

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

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

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

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

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

=== GUI Improvements ===

Difficulty: Medium

Proposed mentor: etix

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

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

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

Difficulty: Hard

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

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

=== Plugin Architecture for VLMC ===

Difficulty: Hard

Proposed mentor: ?

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

Documentation:Streaming HowTo/Streaming for the iPhone

2010-06-05T14:12:41Z

ConfusedVorlon: /* Possible improvements/fixes */

{{RightMenu|documentation streaming howto toc}}

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

== Streaming for the iPhone ==

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

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

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

=== Instructions ===

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

=== Options ===

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

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

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

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

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

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

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

rate-control=(default: false)
*If set to false the there is no rate control (the muxer sends the data as fast/slow as it can to the streamer). If set to true the muxer should do rate-control to control the speed to muxed audio/video is sent to the streamer. I'm a little unsure what the "best" setting for this parameter is when re-streaming an existing video stream. I've been leaving it at false...

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

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

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

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

===Possible improvements/fixes===

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

{{Documentation}}

Documentation:Streaming HowTo/Streaming for the iPhone

2010-06-05T14:12:02Z

ConfusedVorlon: added documentation link at bottom

{{RightMenu|documentation streaming howto toc}}

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

== Streaming for the iPhone ==

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

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

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

=== Instructions ===

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

=== Options ===

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

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

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

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

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

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

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

rate-control=(default: false)
*If set to false the there is no rate control (the muxer sends the data as fast/slow as it can to the streamer). If set to true the muxer should do rate-control to control the speed to muxed audio/video is sent to the streamer. I'm a little unsure what the "best" setting for this parameter is when re-streaming an existing video stream. I've been leaving it at false...

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

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

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

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

===Possible improvements/fixes===
Have the module auto-detect audio only streams, so the splitanywhere option is not required.

I'm not sure I am doing the right thing with the Win32 rename function. Linux (I believe) allows me to rename a file over an existing file, even if the existing file is in use. Win32 is not so friendly. This ability is useful for updating the index file at same time it may be currently being read by the HTTP server serving the files.

Break the dst= and index= parameter into seperate filename/directory entries, so you only need to specify the filename format once. (instead of once for the dst= parameter, and once for the index-url= parameter)

{{Documentation}}

Documentation:Streaming HowTo

2010-06-05T14:09:07Z

ConfusedVorlon: added link to streaming for the iphone

{{RightMenu|documentation streaming howto toc}}

Authors:
* Alexis de Lattre
* Johan Bilien
* Anil Daoud
* Clément Stenac
* Antoine Cellerier
* Jean-Paul Saman

Copyright (c) 2002-2006 the VideoLAN project

{{GPL}}

'''This document explains how to stream, transcode and save streams using the VideoLAN solution'''

[[Documentation:Streaming HowTo/Streaming, Muxers and Codecs|Streaming, Muxers and Codecs]]

[[Documentation:Streaming HowTo/Easy Streaming|Easy Streaming]]

[[Documentation:Streaming HowTo/Advanced Streaming Using the Command Line|Advanced Streaming Using the Command Line]]

[[Documentation:Streaming HowTo/Command Line Examples|Command Line Examples]]

[[Documentation:Streaming HowTo/VLM|VLM - Multiple Streaming and Video on Demand]]

[[Documentation:Streaming HowTo/Receive and Save a Stream|Receive and Save a Stream]]

[[Documentation:Streaming HowTo New|Convert files to other formats]]

[[Documentation:Streaming HowTo/Stream a File|Stream a File]]

[[Documentation:Streaming HowTo/Stream a DVD|Stream a DVD]]

[[Documentation:Streaming HowTo/Stream a DVB Channel|Stream a DVB Channel]]

[[Documentation:Streaming HowTo/Stream from Encoding Cards and Other Capture Devices|Stream from Encoding Cards and Other Capture Devices]]

[[Documentation:Streaming HowTo/Stream from a DV Camcorder|Stream from a DV Camcorder]]

[[Documentation:Streaming HowTo/Streaming over IPv6|Streaming over IPv6]]

[[Documentation:Streaming HowTo/Advanced streaming with samples, multiple files streaming, using multicast in streaming|Advanced streaming with samples, multiple files streaming, using multicast in streaming]]

[[Documentation:Streaming HowTo/Streaming a live video feed to Darwin Streaming Server for Mobile Phones|Streaming a live video feed to Darwin Streaming Server for Mobile Phones]]

[[Documentation:Streaming_HowTo/Streaming_for_the_iPhone|Streaming for the iPhone with live http]]

{{Documentation}}

Documentation:Streaming HowTo/Streaming for the iPhone

2010-06-05T14:07:39Z

ConfusedVorlon: documentation for the live_http module. Taken with permission from http://techblog.unwiredappeal.com/2010/03/vlc-http-live-streaming-module-patch.html

{{RightMenu|documentation streaming howto toc}}

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

== Streaming for the iPhone ==

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

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

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

=== Instructions ===

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

=== Options ===

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

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

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

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

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

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

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

rate-control=(default: false)
*If set to false the there is no rate control (the muxer sends the data as fast/slow as it can to the streamer). If set to true the muxer should do rate-control to control the speed to muxed audio/video is sent to the streamer. I'm a little unsure what the "best" setting for this parameter is when re-streaming an existing video stream. I've been leaving it at false...

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

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

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

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

===Possible improvements/fixes===
Have the module auto-detect audio only streams, so the splitanywhere option is not required.

I'm not sure I am doing the right thing with the Win32 rename function. Linux (I believe) allows me to rename a file over an existing file, even if the existing file is in use. Win32 is not so friendly. This ability is useful for updating the index file at same time it may be currently being read by the HTTP server serving the files.

Break the dst= and index= parameter into seperate filename/directory entries, so you only need to specify the filename format once. (instead of once for the dst= parameter, and once for the index-url= parameter)

Sending Patches VLC

2010-06-05T13:45:34Z

ConfusedVorlon:

== How to produce a Patch ==
* Get the latest [[Git]] revision
* Make your changes and commit them
* Produce a patch according to [[Git#Submitting_patches_to_the_vlc-devel|the Git page]], '''don't send it yet''', read the following before sending.

== Writing an appropriate description ==
* The patch email's subject should be prefixed by "[PATCH]".
* You should include a description that will be the commit log message of your patch
* A more '''exhaustive explanation''' is also welcomed along with your patch. This should be the '''second paragraph''' of your commit log.

== Check List ==
When you send a patch make sure that:
* it mostly '''complies''' to the [[Code Conventions]]
* Make sure that it does not add more failure to '''`make check`'''
* Make sure that your patch is produced against the latest '''master branch''' and not 1.0-bugfix. [1]
* Make sure your patch doesn't introduce '''trailing spaces''' (''git show --colored'' show them in red)
* Make sure '''your name is correctly set'''. That is, that you are using your fullname, which is correctly capitalized and so on.
* Read your patch one more time using '''''git show''''', and check that it looks ok

[1] Most of the time patches are against branches version such as 1.0.x series which is not a development version. If this is a bugfix it may be backported to 1.0-bugfix, but should go in master branch first. Translations are one exception to this rule.

== Sending it to the vlc-devel ==
Now you can send it to the [http://mailman.videolan.org/listinfo/vlc-devel vlc-devel]. Please subscribe to it before sending your patch, or else it may not got through the list's spam filters. You will be able to unsubscribe later easily if needed.
Don't send patch bigger than 30kB on the mailing list. If the patch is that big, it's likely that it does too much at once and should be splitted in several logical patches. If you really need a big patch, put it online and send vlc-devel@ the URL.

== Following your patch ==

You can check if your patch was received by the list at the [http://mailman.videolan.org/pipermail/vlc-devel/ list archive]

if the patch is approved, then there will normally be a post to the vlc-devel list to say "patch applied". There will also be a post to the [http://mailman.videolan.org/pipermail/vlc-commits/ vlc-commits] list ([http://mailman.videolan.org/listinfo/vlc-commits subscribe here])

== Getting your patch merged ==
* Don't hesitate to ask for review if after a week there is no replies.
* If there are comments, please answer to those and eventually correct your patch if possible.
That should ensure that your patch gets merged.

Sending Patches VLC

2010-06-05T13:34:35Z

ConfusedVorlon: /* Sending it to the vlc-devel */ added link to list archive

== How to produce a Patch ==
* Get the latest [[Git]] revision
* Make your changes and commit them
* Produce a patch according to [[Git#Submitting_patches_to_the_vlc-devel|the Git page]], '''don't send it yet''', read the following before sending.

== Writing an appropriate description ==
* The patch email's subject should be prefixed by "[PATCH]".
* You should include a description that will be the commit log message of your patch
* A more '''exhaustive explanation''' is also welcomed along with your patch. This should be the '''second paragraph''' of your commit log.

== Check List ==
When you send a patch make sure that:
* it mostly '''complies''' to the [[Code Conventions]]
* Make sure that it does not add more failure to '''`make check`'''
* Make sure that your patch is produced against the latest '''master branch''' and not 1.0-bugfix. [1]
* Make sure your patch doesn't introduce '''trailing spaces''' (''git show --colored'' show them in red)
* Make sure '''your name is correctly set'''. That is, that you are using your fullname, which is correctly capitalized and so on.
* Read your patch one more time using '''''git show''''', and check that it looks ok

[1] Most of the time patches are against branches version such as 1.0.x series which is not a development version. If this is a bugfix it may be backported to 1.0-bugfix, but should go in master branch first. Translations are one exception to this rule.

== Sending it to the vlc-devel ==
Now you can send it to the [http://mailman.videolan.org/listinfo/vlc-devel vlc-devel]. Please subscribe to it before sending your patch, or else it may not got through the list's spam filters. You will be able to unsubscribe later easily if needed.
Don't send patch bigger than 30kB on the mailing list. If the patch is that big, it's likely that it does too much at once and should be splitted in several logical patches. If you really need a big patch, put it online and send vlc-devel@ the URL.

You can check if your patch was received by the list at the [http://mailman.videolan.org/pipermail/vlc-devel/ list archive]

== Getting your patch merged ==
* Don't hesitate to ask for review if after a week there is no replies.
* If there are comments, please answer to those and eventually correct your patch if possible.
That should ensure that your patch gets merged.

Git

2010-05-28T14:49:20Z

ConfusedVorlon: changed git-send-email to git send-email

= Basic Git usage =

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

== List your commits ==
$ git log

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

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

Now you can just type:
$ git up

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

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

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

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

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


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

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

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

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

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

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

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

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

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

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

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

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

=== Normal simple case ===

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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



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

[[Category:Building]]

Documentation:Streaming HowTo/Command Line Examples

2010-05-25T14:15:41Z

ConfusedVorlon: /* Keeping the stream open */ -adjusted to command line syntax

{{RightMenu|documentation streaming howto toc}}

Examples for advanced use of VLC's stream output (transcoding, multiple streaming, etc...)

==Transcoding==

Transcode the input stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}' '''

Display the input stream, transcode it and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}"}' '''

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}}' '''

==Multiple streaming==

Send a stream to a multicast IP address and a unicast IP address:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the stream and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst=rtp{mux=ts,dst=192.168.1.12},dst=rtp{mux=ts,dst=192.168.1.42}}' '''

Send parts of a multiple program input stream:
% '''vlc -vvv multiple_program_input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42},select="program=12345",dst=rtp{mux=ts,dst=239.255.12.43}, select="video,program=1234-2345"}' '''
This command sends the program of the input stream which id is 12345 to 239.255.12.42 and all video programs with id between 1234 and 2345 to 239.255.12.43.

==Transcoding and multiple streaming==

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce and an unicast IP address:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the input stream, transcode it and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:duplicate{dst=rtp{mux=ts,dst=192.168.1.2},dst=rtp{mux=ts,dst=192.168.1.12}"}' '''

Send the input stream to a multicast IP address and the transcoded stream to another multicast IP address with the associated SAP announces:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.1.2,sdp=sap,name="OriginalStream"},dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:rtp{mux=ts,dst=239.255.1.3,sdp=sap,name="TranscodedStream"}"}' '''

==HTTP streaming==

Stream in HTTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#standard{access=http,mux=ogg,dst=server.example.org:8080}' '''
*on the client(s), run:
% '''vlc http://server.example.org:8080'''

Transcode and stream in HTTP:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

Recording a live video stream:
% '''vlc http://example.com/live.asf --sout="#duplicate{dst=std{access=file,mux=asf,url='C:\test\test.asf'},dst=nodisplay}" '''

For example, if you want to stream an audio CD in Ogg/Vorbis over HTTP:
% '''vlc -vvv cdda:/dev/cdrom --sout '#transcode{acodec=vorb,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

==RTSP live streaming==

Stream with RTSP and RTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#rtp{dst=192.168.0.12,port=1234,sdp=rtsp://server.example.org:8080/test.sdp}' '''
*on the client(s), run:
% '''vlc rtsp://server.example.org:8080/test.sdp'''

==RTSP on-demand streaming==

See [[Documentation:Streaming HowTo/VLM]].

==MMS / MMSH streaming to Windows Media Player==

% '''vlc -vvv input_stream --sout '#transcode{vcodec=DIV3,vb=256,scale=1,acodec=mp3,ab=32,channels=2}:std{access=mmsh,mux=asfh,dst=:8080}' '''

VLC media player can connect to this by using the following url: '''mmsh://server_ip_address:8080'''.
Windows Media Player can connect to this by using the following url: '''mms://server_ip_address:8080'''.

==Use the ''es'' module==

Separate audio and video in two PS files:
% '''vlc -vvv input_stream --sout '#es{access=file,mux=ps,url_audio=audio-%c.%m,url_video=video-%c.%m}' '''

Extract the audio track of the input stream to a TS file:
% '''vlc -vvv input_stream --sout '#es{access_audio=file,mux_audio=ts,url_audio=audio-%c.%m}' '''

Stream in unicast the audio track on a port and the video track on another port (NOTE: This will not only work with VLC 0.8.6 or older - FIXME?):
*on the server side:
% '''vlc -vvv input_stream --sout '#es{access=rtp,mux=ts,url_audio=192.168.1.2:1212,url_video=192.168.1.2:1213}' '''
*on the client side:
**to receive the audio:
% '''vlc udp://@:1212'''
**to receive the video:
% '''vlc udp://@:1213'''

Stream in multicast the video and dump the audio in a file:
% '''vlc -vvv input_stream --sout '#es{access-video=udp,mux-video=ts,dst-video=239.255.12.42,access-audio=file,mux-audio=ps,dst-audio=audio-%c.%m}' '''

Note: You can also combine the ''es'' module with the other modules to set-up even more complex solution.

==Keeping the stream open==

% '''% vlc -vvv input_stream -sout-keep -sout=#transcode{acodec=mp3}:duplicate{dst=display{delay=6000},dst=gather:std{mux=mpeg1,dst=:8080/stream.mp3,access=http},select="novideo"} '''

The basic transcoding is an mp3 stream from the file you select (if it is a video file, then the video is ignored). It is streamed via http to localhost:8080/stream.mp3

The combination of :sout-keep and dst=gather:std mean that the stream is kept open and subsequent items are played through the same stream.

{{Documentation}}

Documentation:Streaming HowTo/Command Line Examples

2010-05-25T14:11:00Z

ConfusedVorlon: /* Keeping the stream open */ -fixed link to http interface

{{RightMenu|documentation streaming howto toc}}

Examples for advanced use of VLC's stream output (transcoding, multiple streaming, etc...)

==Transcoding==

Transcode the input stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}' '''

Display the input stream, transcode it and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}"}' '''

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}}' '''

==Multiple streaming==

Send a stream to a multicast IP address and a unicast IP address:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the stream and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst=rtp{mux=ts,dst=192.168.1.12},dst=rtp{mux=ts,dst=192.168.1.42}}' '''

Send parts of a multiple program input stream:
% '''vlc -vvv multiple_program_input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42},select="program=12345",dst=rtp{mux=ts,dst=239.255.12.43}, select="video,program=1234-2345"}' '''
This command sends the program of the input stream which id is 12345 to 239.255.12.42 and all video programs with id between 1234 and 2345 to 239.255.12.43.

==Transcoding and multiple streaming==

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce and an unicast IP address:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the input stream, transcode it and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:duplicate{dst=rtp{mux=ts,dst=192.168.1.2},dst=rtp{mux=ts,dst=192.168.1.12}"}' '''

Send the input stream to a multicast IP address and the transcoded stream to another multicast IP address with the associated SAP announces:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.1.2,sdp=sap,name="OriginalStream"},dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:rtp{mux=ts,dst=239.255.1.3,sdp=sap,name="TranscodedStream"}"}' '''

==HTTP streaming==

Stream in HTTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#standard{access=http,mux=ogg,dst=server.example.org:8080}' '''
*on the client(s), run:
% '''vlc http://server.example.org:8080'''

Transcode and stream in HTTP:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

Recording a live video stream:
% '''vlc http://example.com/live.asf --sout="#duplicate{dst=std{access=file,mux=asf,url='C:\test\test.asf'},dst=nodisplay}" '''

For example, if you want to stream an audio CD in Ogg/Vorbis over HTTP:
% '''vlc -vvv cdda:/dev/cdrom --sout '#transcode{acodec=vorb,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

==RTSP live streaming==

Stream with RTSP and RTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#rtp{dst=192.168.0.12,port=1234,sdp=rtsp://server.example.org:8080/test.sdp}' '''
*on the client(s), run:
% '''vlc rtsp://server.example.org:8080/test.sdp'''

==RTSP on-demand streaming==

See [[Documentation:Streaming HowTo/VLM]].

==MMS / MMSH streaming to Windows Media Player==

% '''vlc -vvv input_stream --sout '#transcode{vcodec=DIV3,vb=256,scale=1,acodec=mp3,ab=32,channels=2}:std{access=mmsh,mux=asfh,dst=:8080}' '''

VLC media player can connect to this by using the following url: '''mmsh://server_ip_address:8080'''.
Windows Media Player can connect to this by using the following url: '''mms://server_ip_address:8080'''.

==Use the ''es'' module==

Separate audio and video in two PS files:
% '''vlc -vvv input_stream --sout '#es{access=file,mux=ps,url_audio=audio-%c.%m,url_video=video-%c.%m}' '''

Extract the audio track of the input stream to a TS file:
% '''vlc -vvv input_stream --sout '#es{access_audio=file,mux_audio=ts,url_audio=audio-%c.%m}' '''

Stream in unicast the audio track on a port and the video track on another port (NOTE: This will not only work with VLC 0.8.6 or older - FIXME?):
*on the server side:
% '''vlc -vvv input_stream --sout '#es{access=rtp,mux=ts,url_audio=192.168.1.2:1212,url_video=192.168.1.2:1213}' '''
*on the client side:
**to receive the audio:
% '''vlc udp://@:1212'''
**to receive the video:
% '''vlc udp://@:1213'''

Stream in multicast the video and dump the audio in a file:
% '''vlc -vvv input_stream --sout '#es{access-video=udp,mux-video=ts,dst-video=239.255.12.42,access-audio=file,mux-audio=ps,dst-audio=audio-%c.%m}' '''

Note: You can also combine the ''es'' module with the other modules to set-up even more complex solution.

==Keeping the stream open==

This example uses the syntax for the [[Control_VLC_via_a_browser | http interface]]. To use this code, press the streaming button (looks like three arrows) and enter the string below in the 'Destination (MRL)' box

% ''':sout-keep :sout=#transcode{acodec=mp3}:duplicate{dst=display{delay=6000},dst=gather:std{mux=mpeg1,dst=:8080/stream.mp3,access=http},select="novideo"} '''

The basic transcoding is an mp3 stream from the file you select (if it is a video file, then the video is ignored). It is streamed via http to localhost:8080/stream.mp3

The combination of :sout-keep and dst=gather:std mean that the stream is kept open and subsequent items are played through the same stream.

Once you have opened a single file with this option, then you can add additional files to the playlist (even without specifying the stream) and they'll continue to stream.

{{Documentation}}

Documentation:Streaming HowTo/Command Line Examples

2010-05-25T14:09:51Z

ConfusedVorlon: added 'Keeping the stream open' example

{{RightMenu|documentation streaming howto toc}}

Examples for advanced use of VLC's stream output (transcoding, multiple streaming, etc...)

==Transcoding==

Transcode the input stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}' '''

Display the input stream, transcode it and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}"}' '''

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"}}' '''

==Multiple streaming==

Send a stream to a multicast IP address and a unicast IP address:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the stream and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst=rtp{mux=ts,dst=192.168.1.12},dst=rtp{mux=ts,dst=192.168.1.42}}' '''

Send parts of a multiple program input stream:
% '''vlc -vvv multiple_program_input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.12.42},select="program=12345",dst=rtp{mux=ts,dst=239.255.12.43}, select="video,program=1234-2345"}' '''
This command sends the program of the input stream which id is 12345 to 239.255.12.42 and all video programs with id between 1234 and 2345 to 239.255.12.43.

==Transcoding and multiple streaming==

Transcode the input stream, display the transcoded stream and send it to a multicast IP address with the associated SAP announce and an unicast IP address:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128,deinterlace}:duplicate{dst=display,dst=rtp{mux=ts,dst=239.255.12.42,sdp=sap,name="TestStream"},dst=rtp{mux=ts,dst=192.168.1.2}}' '''

Display the input stream, transcode it and send it to two unicast IP addresses:
% '''vlc -vvv input_stream --sout '#duplicate{dst=display,dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:duplicate{dst=rtp{mux=ts,dst=192.168.1.2},dst=rtp{mux=ts,dst=192.168.1.12}"}' '''

Send the input stream to a multicast IP address and the transcoded stream to another multicast IP address with the associated SAP announces:
% '''vlc -vvv input_stream --sout '#duplicate{dst=rtp{mux=ts,dst=239.255.1.2,sdp=sap,name="OriginalStream"},dst="transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:rtp{mux=ts,dst=239.255.1.3,sdp=sap,name="TranscodedStream"}"}' '''

==HTTP streaming==

Stream in HTTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#standard{access=http,mux=ogg,dst=server.example.org:8080}' '''
*on the client(s), run:
% '''vlc http://server.example.org:8080'''

Transcode and stream in HTTP:
% '''vlc -vvv input_stream --sout '#transcode{vcodec=mp4v,acodec=mpga,vb=800,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

Recording a live video stream:
% '''vlc http://example.com/live.asf --sout="#duplicate{dst=std{access=file,mux=asf,url='C:\test\test.asf'},dst=nodisplay}" '''

For example, if you want to stream an audio CD in Ogg/Vorbis over HTTP:
% '''vlc -vvv cdda:/dev/cdrom --sout '#transcode{acodec=vorb,ab=128}:standard{access=http,mux=ogg,dst=server.example.org:8080}' '''

==RTSP live streaming==

Stream with RTSP and RTP:
*on the server, run:
% '''vlc -vvv input_stream --sout '#rtp{dst=192.168.0.12,port=1234,sdp=rtsp://server.example.org:8080/test.sdp}' '''
*on the client(s), run:
% '''vlc rtsp://server.example.org:8080/test.sdp'''

==RTSP on-demand streaming==

See [[Documentation:Streaming HowTo/VLM]].

==MMS / MMSH streaming to Windows Media Player==

% '''vlc -vvv input_stream --sout '#transcode{vcodec=DIV3,vb=256,scale=1,acodec=mp3,ab=32,channels=2}:std{access=mmsh,mux=asfh,dst=:8080}' '''

VLC media player can connect to this by using the following url: '''mmsh://server_ip_address:8080'''.
Windows Media Player can connect to this by using the following url: '''mms://server_ip_address:8080'''.

==Use the ''es'' module==

Separate audio and video in two PS files:
% '''vlc -vvv input_stream --sout '#es{access=file,mux=ps,url_audio=audio-%c.%m,url_video=video-%c.%m}' '''

Extract the audio track of the input stream to a TS file:
% '''vlc -vvv input_stream --sout '#es{access_audio=file,mux_audio=ts,url_audio=audio-%c.%m}' '''

Stream in unicast the audio track on a port and the video track on another port (NOTE: This will not only work with VLC 0.8.6 or older - FIXME?):
*on the server side:
% '''vlc -vvv input_stream --sout '#es{access=rtp,mux=ts,url_audio=192.168.1.2:1212,url_video=192.168.1.2:1213}' '''
*on the client side:
**to receive the audio:
% '''vlc udp://@:1212'''
**to receive the video:
% '''vlc udp://@:1213'''

Stream in multicast the video and dump the audio in a file:
% '''vlc -vvv input_stream --sout '#es{access-video=udp,mux-video=ts,dst-video=239.255.12.42,access-audio=file,mux-audio=ps,dst-audio=audio-%c.%m}' '''

Note: You can also combine the ''es'' module with the other modules to set-up even more complex solution.

==Keeping the stream open==

This example uses the syntax for the [Control_VLC_via_a_browser | http interface]. To use this code, press the streaming button (looks like three arrows) and enter the string below in the 'Destination (MRL)' box

% ''':sout-keep :sout=#transcode{acodec=mp3}:duplicate{dst=display{delay=6000},dst=gather:std{mux=mpeg1,dst=:8080/stream.mp3,access=http},select="novideo"} '''

The basic transcoding is an mp3 stream from the file you select (if it is a video file, then the video is ignored). It is streamed via http to localhost:8080/stream.mp3

The combination of :sout-keep and dst=gather:std mean that the stream is kept open and subsequent items are played through the same stream.

Once you have opened a single file with this option, then you can add additional files to the playlist (even without specifying the stream) and they'll continue to stream.

{{Documentation}}

Control VLC from an iPhone

2010-05-14T09:43:44Z

ConfusedVorlon: /* Options that communicate directly with VLC */

{{howto|Control VLC from an iPhone}}

There are various options to control VLC from the iPhone. These broadly break down between methods that require a seperate application to run alongside VLC and applications that communicate directly with VLC using the [[Web_Interface | http interface]]

==Options that communicate directly with VLC==

*It is possible to use the http interface directly from Safari although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://hobbyistsoftware.com/VLC-more Hobbyist Software] have produced two native applications which allow control of VLC from within a normal iPhone app. They also provide [http://www.hobbyistsoftware.com/VLCSetup setup helper applications] for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://itunes.com/apps/vlcremotefree VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://itunes.com/apps/vlcremote VLC Remote] is a paid version which additionally allows selecting of files and playlist management as well as more advanced features like aspect ratio, subtitles, audio delays, etc

==Options that communicate via an intermediate connection==

*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=288765964&mt=8 Intelliremote] is a free iPhone client for Intelliremote's [http://melloware.com/products/intelliphone/ PC Server] (produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=292947868&mt=8 EventGhost] is a paid iPhone client for the [http://www.eventghost.org/wiki/EventGhost:About Event Ghost] open source home automation server for Windows. (The iPhone client is also produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=289687093&mt=8i RedTouch] is a paid iPhone client for an ethernet-connected infrared transceiver produced by [http://irtrans.com IRTrans]

Control VLC from an iPhone

2010-05-14T09:43:10Z

ConfusedVorlon: /* Options that communicate directly with VLC */

{{howto|Control VLC from an iPhone}}

There are various options to control VLC from the iPhone. These broadly break down between methods that require a seperate application to run alongside VLC and applications that communicate directly with VLC using the [[Web_Interface | http interface]]

==Options that communicate directly with VLC==

*It is possible to use the http interface directly from Safari although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://hobbyistsoftware.com/VLC-more Hobbyist Software] have produced two native applications which allow control of VLC from within a normal iPhone app. They also provide [http://www.hobbyistsoftware.com/VLCSetup setup helper applications] for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://itunes.com/apps/vlcremotefree VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://itunes.com/apps/vlcremote VLC Remote] is a paid version which additionally allows selecting of files and playlist management.

==Options that communicate via an intermediate connection==

*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=288765964&mt=8 Intelliremote] is a free iPhone client for Intelliremote's [http://melloware.com/products/intelliphone/ PC Server] (produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=292947868&mt=8 EventGhost] is a paid iPhone client for the [http://www.eventghost.org/wiki/EventGhost:About Event Ghost] open source home automation server for Windows. (The iPhone client is also produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=289687093&mt=8i RedTouch] is a paid iPhone client for an ethernet-connected infrared transceiver produced by [http://irtrans.com IRTrans]

Control VLC from a webOS phone

2010-05-14T09:41:58Z

ConfusedVorlon: Created page with '==Options that communicate directly with VLC== *It is possible to use the http interface directly from Browser although is is somewhat cumbersome as it isn't designed for such a…'

==Options that communicate directly with VLC==

*It is possible to use the http interface directly from Browser although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://www.hobbyistsoftware.com/pre/vlc-more Hobbyist Software] have produced two native applications which allow control of VLC from within a normal Web OS app. They also provide [http://www.hobbyistsoftware.com/VLCSetup setup helper applications] for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://developer.palm.com/appredirect/?packageid=com.hobbyistsoftware.vlcremotefree VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://developer.palm.com/appredirect/?packageid=com.hobbyistsoftware.vlcremote VLC Remote] is a paid version which additionally allows selecting of files and playlist management as well as more advanced features such as aspect ratio, subtitles, etc.

VLC HowTo

2010-05-14T09:38:52Z

ConfusedVorlon: /* Remote Control for VLC */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[Crop|Crop video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Control VLC from an Android Phone]]
* [[Control VLC from a Palm Web OS Phone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...
* [[How to make VLC the default player]]

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

Control VLC from an Android Phone

2010-05-14T09:33:45Z

==Options that communicate directly with VLC==

*It is possible to use the http interface directly from Browser although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://www.hobbyistsoftware.com Hobbyist Software] have produced two native applications which allow control of VLC from within a normal Android app. They also provide [http://www.hobbyistsoftware.com/VLCSetup setup helper applications] for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://hobbyistsoftware.com/android/vlc-remote-free VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://hobbyistsoftware.com/android/vlc-remote VLC Remote] is a paid version which additionally allows selecting of files and playlist management as well as more advanced features such as aspect ratio, subtitles, etc.

VLC HowTo

2010-05-14T09:23:47Z

ConfusedVorlon: /* Remote Control for VLC */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[Crop|Crop video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Control VLC from an Android Phone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...
* [[How to make VLC the default player]]

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

What can VLC do?

2008-12-11T15:00:19Z

ConfusedVorlon:

This area of the wiki contains a list with the possibilities {{VLC}} gives you. It was made to help people better realize the potential {{VLC}} has. Some entries will simply mention the possibility, others try to explain how to do it as well. Let me start by apologising for my horrible spelling, but I hope you will be able to decipher the texts anyway.

== Mediaplayer ==

=== Compact Disc (CD) Images ===
If you have a [[CD-DA]] (audio CD), [[SVCD]], or [[VCD]] packaged inside a CD-image, in some cases [[VLC media player]] can play this without you having to mount it or extract it. You can simply choose "open file" and pick the CD-image. For CD-image support vlc has to be [[compile]]d using [[libcdio]] (<tt>--enable-libcdio</tt>) and the various plugins which use libcdio need to be selected (<tt>--enable-cddax</tt>, <tt>--enable-vcdx</tt>). Some of these enablements may not be the default for your OS.

The kinds of Compact Disc formats supported are CDRWIN's BIN/CUE format, cdrdao's TOC format, and a limited set of Nero (NRG) formats.

(''[[libcdio]] also supports ISO-9660 image reading but at present there is no VLC access plugin which uses it. DVD's images follow the UDF format and at present there is no support in libcdio for that, although some limited progress has been made in that direction. It is possible that will get added in the future; volunteers are most welcome).

=== How to enable/use subtitles ===
Before you try to enable [[subtitle]]s make sure the subtitles you have are in a format that VLC can read! You can find the list of compatible subtitle formats [http://www.videolan.org/vlc/features.html here].
If VLC has detected any sort of subtitles available, you will be able to turn them on under the menu: ''Video->Subtitles track->Track 1''

Auto detection of subtitle files uses a 'fuzzy' logic which you can specify. If this is wrongly specified you may end up with more subtitle file options than really exist or miss some that are provided. By default it allows any file in the right place which exactly matches the video name, and may have some extra characters. If you are not seeing the number of subtitle options you expect you might want to allow more 'fuzziness' by changing the preference in video/subtitles/subtitle autodetection where help is available if you 'hover' over the field.

If you mainly use .srt subtitles or .sub, you can get them turned on automatically when they are detected, by setting the ''Input/Codecs->Advanced->Choose subtitle track'' to 0, it will automatically turn on the subtitle track. You can also experiment with the ''Choose subtitle language'' on the same page. But if you experiment a bit with the settings you should be able to get subtitles turned on automatically.

'''Note:''' On Mac OS X, the "Video->Subtitles track" menu item is permanently disabled for some reason. You must manually specify the location of the subtitles file in the "Subpictures" pane of the preferences.

=== Playing windows media files ===
VLC should be able to succesfully play both audio and video in wma and wmv 1 and 2, for the newest version (wmv3) only the windows version of vlc will be able to play it, since no opensource implementation of wmv3 have been made so far, so the windows vlc plays it by using the windows api. DRM files however can not be played on any OS.

=== How to adjust picture brightness/colors/contrast.. ===
'''If you are using the wxwindows userinterface:'''
You can adjust the typical values to tweak the picture of your video source by turning on the extended GUI. This is done in the menu: ''Settings->Extended GUI''. That will give you some extended control options for the video picture as well as an equalizer for the audio. Before it actual works though, you have to enable the filters under the preferences->video

'''If you use Mac OS X or a skinned version of VLC:'''
You need to enter the preference menu: ''Settings->Preferences''. Once you have the preferences window open you go to: Video->Filters->Image adjust. Here you can adjust the different values. Note before they take effect you need to turn on the "Image adjust" filter in: Video->Filters

=== How to control the aspect ratio of the video ===
Using VLC, you can override the source aspect ratio. This is available both as a command line option and as an option in the Preference dialog in the graphical interface. The aspect ratio can be specified both in ratio format (16:9) or as a decimal number (1.33).

'''Command Line'''

When invoking VLC from the command line, use the option --aspect-ratio. For instance,

vlc --aspect-ratio 1:5

'''Graphical Interface'''

If using the graphical interface, the setting is In the Video section of the Preferences dialog. You may specify the aspect ratio in the field labeled "Source aspect ratio."

Here is a list of the more common aspect ratios.

* Fullscreen: 1.33 or 4:3
* Widescreen: 1.78 or 16:9
* Typical DVD: 1.85
* Cinemascope: 2.35

===Be remotely controlled===
VLC provides a series of interfaces which allow it to be controlled in various ways such as via a web browser, an several iPhone apps desktop widgets and more. [[How_to#Remote_Control_for_VLC | Details are here]].

=== Announce What's Playing to IRC ===
Announce the currently playing track to mirc (an irc client). This is often referred to as a "now playing" script. To be able to get this functionality with vlc one approach would be to use the HTTP interface. With it you can create a simple file which will display "'Artist' with the song 'Title' from the album 'Album' the genre is 'Genre'" on a page in ur browser. You can then pull that page from mirc with standard sockets and thereby use the text in a script in mirc. Below I will provide some VERY simple and very ugly examples on how you could use this. The examples are tested with vlc 0.8.5 and mirc 6.12. I can't guarantee the code work with any other versions (although it most likely will). Ok so here we go. You start with create a test.html file in the http interface directory (C:\Program Files\VideoLAN\VLC\http) inside this file paste the following to ONE line or it will not work:

<pre>
ANNOUNCE <vlc id="value" param1="'ARTIST' vlc_get_meta"/>
with the song <vlc id="value" param1="'TITLE' vlc_get_meta"/>
from the album <vlc id="value" param1="'ALBUM' vlc_get_meta"/>
, The genre is <vlc id="value" param1="'Genre' vlc_get_meta"/>
</pre>

Remember to leave an empty line behind the actual line of code, vlc/mirc seems to want this.
Then you must create a script in mirc under remote (alt+r) and paste in the following:

<pre>
alias now {
sockopen vlc_meta_info 127.0.0.1 8082
}

on *:SOCKOPEN:vlc_meta_info: {
sockwrite -n $sockname GET /test.html HTTP/1.1
sockwrite -n $sockname Host: localhost
;sockwrite -n $sockname Connection: Keep-Alive
sockwrite -n $sockname $crlf
sockwrite -n $sockname $null
}

on *:sockread:vlc_meta_info: {
if ($sockerr > 0) return
:nextread
sockread %temp
if ($sockbr == 0) return
if (%temp == $null) %temp = ---
if (ANNOUNCE isin %temp) {
%temp = $remove(%temp,ANNOUNCE )
describe $active is listening to %temp
}
goto nextread

sockclose vlc_meta_info
}
</pre>

Only things u might want to change is the port the http interface listens on, thats the first line and is port 8082 in my case. You might also want some other text than "is listening to" just change as you see fit.

Thats pretty much it. You should enable the http interface in vlc by default if u wanna use this on a regular basis. This is done under preferences in "Interface->Main interfaces"

Then with all this done (and vlc restarted) you can type /now in mirc and it will display ur currently playing track.

This was made for mp3 tracks, so if it doesn't work with other types of media let me know.
You can reach me at: jonas (at) vrt.dk
(Im also regularly in the freenode videolan channel, nickname E-bola)

== Now Playing Script for mIRC by Inf3rn0 (now Jckf) ==
Script and help for Inf3rn0's Now Playing script here: [http://frv.mine.nu/videolan/NowPlaying/ NowPlaying]
(webadress updated as previous had gotten lost)

Based on E-Bola's Now Playing script.

Note: If anybody still uses this and wants to contact me, don't look for anyone named Inf3rn0. Look for Jckf ;)

== Streaming - client ==

=== Listen to online radio ===
You can of course always simply find a link to a radiostream and then open it as you would any other network stream in VLC. But if you would like to browse a list of online radios, you can try the list of shoutcast radio stations VLC can download for you. First you need top open the playlist window: View->Playlist. Once you have the playlist window open chose: ''Manage->Service discovery->Shoutcast radio listings''. After 10 seconds or so the playlist should have become populated by radio station entries. You obviously require internet access for this to work! If you want the stations sorted alphabetically, you can chose: ''Sort->Sort by title''. Also note shoutcast have many thousands stream availeble, per default in 0.8.2 250 stations are downloaded, this can be changed in the preferences under: Playlist->Service discovery->Shoutcast. Note that the more stations u want to add, the longer delay u will see when the station list is downloaded parsed and added to the playlist. Also note you should see 2 "Folder nodes" in the playlist under shoutcast called Genres and bitrate where the stations will be listed under their respective areas. Note that most stations claim to be multi genre, so a station might be listed under both Top40, pop and rock.

== Streaming - server ==

=== VLM ===

The VLM is the Video On Demand part of the VLC streaming server features. It lets you setup a bunch of entries and then let users ask for those streams and it then gives them to the users, it has A LOT of possibilities and I will try to cover them all here.

You can divide VLM entries into 2 general categories VOD and broadcast entries.

== More ==
[[timeshift|Timeshifting]]

VLC HowTo

2008-12-11T14:50:24Z

ConfusedVorlon:

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Remote Control for VLC===
;How to...
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

VLC HowTo

2008-12-11T14:47:08Z

ConfusedVorlon: /* Other Stuff */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to shut down computer]] when VLC playback is over...

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

VLC HowTo

2008-12-11T14:46:35Z

ConfusedVorlon: /* Other Stuff */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control VLC via a widget]] on the Mac desktop
* [[Control VLC from an iPhone]]
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls
* [[How to shut down computer]] when VLC playback is over...

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

Control VLC from an iPhone

2008-12-11T14:43:23Z

ConfusedVorlon: /* Options that communicate directly with VLC */

{{howto|Control VLC from an iPhone}}

There are various options to control VLC from the iPhone. These broadly break down between methods that require a seperate application to run alongside VLC and applications that communicate directly with VLC using the [[Web_Interface | http interface]]

===Options that communicate directly with VLC===

*It is possible to use the http interface directly from Safari although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://www.hobbyistsoftware.com/iAbout.php Hobbyist Software] have produced two native applications which allow control of VLC from within a normal iPhone app. They also provide [http://www.hobbyistsoftware.com/VLCSetup.php setup helper applications] for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=299344206&mt=8 VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=297244048&mt=8 VLC Remote] is a paid version which additionally allows selecting of files and playlist management.

===Options that communicate via an intermeditate connection===

*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=288765964&mt=8 Intelliremote] is a free iPhone client for Intelliremote's [http://melloware.com/products/intelliphone/ PC Server] (produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=292947868&mt=8 EventGhost] is a paid iPhone client for the [http://www.eventghost.org/wiki/EventGhost:About Event Ghost] open source home automation server for Windows. (The iPhone client is also produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=289687093&mt=8i RedTouch] is a paid iPhone client for an ethernet-connected infrared transceiver produced by [http://irtrans.com IRTrans]

Control VLC from an iPhone

2008-12-11T14:41:35Z

ConfusedVorlon: New page: {{howto|Control VLC from an iPhone}} There are various options to control VLC from the iPhone. These broadly break down between methods that require a seperate application to run alongsid...

{{howto|Control VLC from an iPhone}}

There are various options to control VLC from the iPhone. These broadly break down between methods that require a seperate application to run alongside VLC and applications that communicate directly with VLC using the [[Web_Interface | http interface]]

===Options that communicate directly with VLC===

*It is possible to use the http interface directly from Safari although is is somewhat cumbersome as it isn't designed for such a small screen.
**[[Control VLC via a browser]]
*[http://www.hobbyistsoftware.com/iAbout.php Hobbyist Software] have produced two native applications which allow control of VLC from within a normal iPhone app. They also provide setup helper applications for Windows and Mac OS which simplify the process of enabling the http interface in VLC.
**[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=299344206&mt=8 VLC Remote Free] allows control of basic functions like play, pause, stop, volume, etc
**[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=297244048&mt=8 VLC Remote] is a paid version which additionally allows selecting of files and playlist management.

===Options that communicate via an intermeditate connection===

*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=288765964&mt=8 Intelliremote] is a free iPhone client for Intelliremote's [http://melloware.com/products/intelliphone/ PC Server] (produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=292947868&mt=8 EventGhost] is a paid iPhone client for the [http://www.eventghost.org/wiki/EventGhost:About Event Ghost] open source home automation server for Windows. (The iPhone client is also produced by Melloware). It requires the PC client to be running on the same Windows PC as VLC.
*[http://itunes.apple.com/WebObjects/MZStore.woa/wa/viewSoftware?id=289687093&mt=8i RedTouch] is a paid iPhone client for an ethernet-connected infrared transceiver produced by [http://irtrans.com IRTrans]

VLC HowTo

2008-12-11T14:15:25Z

ConfusedVorlon: /* Other Stuff */

__NOTOC__
Below are some handy guides for using {{VLC}}

===Playing Video and Audio===
;How to...
* [[What can vlc do#How to enable/use subtitles|Use Subtitles]]
*: Playing movies with subtitles
* [[How to Use a Capture Card|Use a Capture Card]]
*: This explains how to watch TV or get video from your capture card.
* [[What can vlc do#Play DVD/SVCD/VCD iso's / Images|Play DVDs and Disks from the image file]]
*: This explains how to use movies encoded onto an ISO file.

===Adjusting Settings===
;How to...
* [[What can vlc do#How to adjust picture brightness/colors/contrast..|Adjust Picture Brightness and Contrast]]
* [[What can vlc do#How to control the aspect ratio of the video|Edit the Aspect Ratio of a video]]
* [[How_to_disable_acceleration_in_Win32|Disable video acceleration in Win32]]
* [[How_to_save_bookmarks | Save bookmarks]]
* [[How_to_play_multiple_instances_of_VLC | How to play multiple instances]]

===Transcoding and Streaming===
;How to...
* [[iPod Video Conversion Guide|Play videos on your iPod]]
*: This explains how to convert your videos so they play on your iPod.
* [[Play_on_Yan Micro|Play videos on your Play-Yan Micro]]
*: This explains how to convert your videos so they play on your Play-Yan Micro.
* [[Play_on_Xbox|Play videos on your XBox and XBox 360 ]]
*: This explains how to convert your videos so they play on your XBox.
* [[Play_on_Zune| Play video on your Zune]]
*: This explains how to convert your videos so they play on your Zune.
* [[Fixing .flv to .avi with Ffmpeg]]
*: This explains how to use ffmpeg to a convert broken .flv files to a perfectly good .avi file '''DEPRECATED'''
* [[Transcode_WM_to_Mov_or_MP4|Convert Windows Media audio/video files to MOV or .MP4]]
*: This explains how to convert Windows Media-encoded files to Quicktime or MPEG-4 files
* [[Streaming_to_ActiveX_for_Windows_Media_Player | Streaming from a webcam to an ActiveX embedded object page]]
* [[How_to_add_logo | Add a logo on your videos]]
* [[Mosaic| Create a Mosaic]]
*: This explains how to set up a mosaic from a few streams like a TV portal.
* [[How to DBox|Set up Video on Demand on a Dreambox]]
* [[How to Batch Encode]]
*: This explains how to set up a batch transcode with all files in a directory of a certain file extension being transcoded to a specified format.
* [[How to merge and transcode multiple videos]]
*: This explains how to take several source videos and merge then transcode resulting in a single file output.

===Using VLC in other Applications===
;How to...
* [[ActiveX]]
*: Specification for ActiveX control
* [[ExternalAPI|Use VLC's External API]]
*: Information for using libvlc
* [[Use in Media Center]]
* [[Useful Firefox Extensions]]
*: Information about extensions to view embedded videos in web pages using VLC
* [[GWT]]
*: Google WebToolkit

===Other Stuff===
;How to...
* [[How to Create a DVD|Create a DVD]]
*: This explains how to make a DVD from your home videos
* [[ActiveX/Delphi|Use the ActiveX control with Borland's Delphi]]
*: Using the VLC ActiveX plug-in in your programs
* [[ActiveX/HTML|Use the ActiveX control within a webpage.]]
* [[HowTo_Integrate_VLC_plugin_in_your_webpage|Integrate ActiveX/Mozilla on your webpage]]
* [[Control VLC via a browser]]
*: This explains how to use the HTTP [[interface]]
* [[Control_VLC_via_a_widget]] on the Mac desktop
* [[Change the brightness or contrast of a video|Change a video]]
*: This explains how to edit a video and save the changes
* [[How to create thumbnails]]
* [[How to Use Lirc]]
* [[How to Use Creative Remote]]
*: Explains how to control {{VLC}} with Creative brand remote controls
* [[How to shut down computer]] when VLC playback is over...

== See also ==
* '''See also [[:Category:How To]]'''
[[Category:How To]]

Control VLC via a widget

2008-12-11T14:13:33Z

ConfusedVorlon: New page: {{howto|Control VLC via a widget on the Mac desktop}} Autopoetic have built a free Mac Desktop widget which allows users to control VLC over the network. *It is a free widget which works...

{{howto|Control VLC via a widget on the Mac desktop}}

Autopoetic have built a free Mac Desktop widget which allows users to control VLC over the network.

*It is a free widget which works using the [[Web_Interface | http interface]]

*You can download the widget at [http://www.autopoetic.com/vlcremote/ Autopoetic]

*Autopoetic provide instructions on installation, however since 0.9.6 there is an additional step required to allow networked control. You have to edit the .hosts file to allow connections to be made on the local network, or from the whole internet.

Control VLC via a browser

2008-12-11T14:06:31Z

ConfusedVorlon:

{{howto|Use the HTTP interface to control VLC from a web browser}}

* Start VLC on the server with the [[Web Interface|http]] [[interface]], in one of two ways:
**Start up VLC normally and go to Settings -> Add interface -> Web interface, OR
**At the terminal
*** type '''vlc -I http'''
*** add '''--extraintf''' if you want to specify more than one interface (see [[interface]] for details)
*** use '''--http-host host:port''' if you want to bind VLC to a specific host and port
* Open your favorite web browser on the client
* Type the IP address (or URL) of the host in the location field (address bar). You may need to specify the port (VLC defalts to using port 8080)
*: An example is http://127.0.0.1:8080 - 127.0.0.1 refers to the local machine.
* If you want to control VLC from a computer that is not the one running VLC then you will need to enable access in the .hosts file (from 0.9.6 onwards)
* Add the files to be streamed to the playlist like /home/file.mpg (unless you use the UI to select the file in the next step)
* Add streaming destination to the server in the sout field udp://<client>:1234, using these steps in the UI:
**Go to File -> Open File
**Click Browse to select the file you want to play
**Select Stream/Save and click Settings
**Optional: Select Play Locally to make sure everything is working correctly
**Select UDP and fill in the client IP address and port number (default: 1234)
**Click OK, OK, and press play
* Open VLC on the client to receive the video stream, in one of two ways:
**At the terminal, with '''vlc udp://@:1234'''
**Start up VLC normally
***Go to File -> Open network stream...
***Leave the default options (Radio button UDP selected, port set to 1234)
***Press OK