VideoLAN Wiki - User contributions [en]

SoC 2009/Media Center Interface for VLC

2009-08-05T16:12:39Z

Barrywardell: Added instructions for compiling

{{SoCProject|year=2009|student=[[User:barrywardell|Barry Wardell]]|mentor=[[User:ILEoo|Ilkka Ollakka]]}}

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

There was a Summer of Code project last year by Dylan Yudaken to work on PVR improvements. This project included some work on a PVR-style interface using OpenGL. My project could potentially build on this work to develop a fully fledged media center interface.

== Compiling the GUI ==
The media center GUI was created with the intention of being able to make use of the many cutting edge improvements that have come to Qt in recent versions, some of which are not yet available in the most recent Qt release. As a result, compiling it is a bit more involved than compiling the standard version of VLC. These instructions assume that you are already able to compile the VLC master branch and will just discuss the extra steps required for compiling the Media Center GUI. Once Qt 4.6 is released, some of this will become redundant.

=== Dependencies ===

==== Recent version of SQLite 3 ====
The media library requires a recent version of SQLite (I think 3.6 or newer). Ubuntu 9.04 (Jaunty) already includes a sufficiently recent version, although older operating systems may not.

In particular, the version of SQLite included in the latest version of OS X Leopard is 3.4.0, which is too old. It's relatively straightforward to install a more recent version using [http://www.macports.org MacPorts]. Just install MacPorts and then do <code>'sudo port install sqlite3'</code>.

==== Qt 4.6 ====
The Media Center GUI makes use of the Qt [http://doc.trolltech.com/4.6-snapshot/animation-overview.html animation] and [http://doc.trolltech.com/4.6-snapshot/statemachine-api.html state machine] frameworks from the [http://labs.trolltech.com/page/Projects/Graphics/Kinetic Kinetic] project. These frameworks were previously available as Qt solutions ([http://www.qtsoftware.com/products/appdev/add-on-products/catalog/4/Utilities/qtanimationframework/ animation], [http://www.qtsoftware.com/products/appdev/add-on-products/catalog/4/Utilities/qt-state-machine-framework/ state machine]), were recently [http://labs.trolltech.com/blogs/2009/05/25/animations-and-state-machine-apis-in-qtmaster/ merged] into Qt's master branch and are scheduled for inclusion in the next version, Qt 4.6, scheduled for release later this year. It also requires the QtOpenGL and QtSVG modules, which are already included in Qt 4.5 and above.

To get a sufficiently recent Qt version, you need to checkout the code from their Git repository and compile it yourself. This isn't as difficult as expected, but does it take some time to compile. The basic steps are:

* Checkout the git repository: <code>git clone git://gitorious.org/qt/qt.git</code>
* (optional) Switch to the master-stable branch: <code>git checkout -b master-stable origin/master-stable</code>. This branch was designed to give you code that is guaranteed to at least compile, whereas the master branch doesn't guarantee anything. See [http://labs.trolltech.com/blogs/2009/07/28/getting-the-best-out-of-two-worlds/ this] blog post for more details.
* <code>./configure</code>
* <code>make</code>
* <code>sudo make install</code>

This will install Qt into <code>/usr/local/Trolltech/Qt-4.6.0/</code>.

==== OpenGL ====
It is required that OpenGL be working on your system. Any OpenGL implementation that works with Qt's OpenGL module (which I think most do) should be fine.

=== Getting the code ===
All of the code for this project is available in the [http://git.videolan.org/?p=vlc-barry.git;a=shortlog;h=refs/heads/qtmc qtmc] branch of [http://git.videolan.org/?p=vlc-barry.git my git repository]. The code can be checked out using:

<code>git clone git://git.videolan.org/vlc-barry.git</code>

and then switching to the qtmc branch:

<code>
cd vlc-barry

git checkout -b qtmc origin/qtmc
</code>

=== Compiling ===
Compiling follows the normal VLC compilation process, but we need to make sure the new version of Qt gets used:

<code>
export PATH=/usr/local/Trolltech/Qt-4.6.0/bin:${PATH}

export PKG_CONFIG_PATH=/usr/local/Trolltech/Qt-4.6.0/lib/pkgconfig/
</code>

and also need to give a few extra options to configure (the last two are optional):

<code>../configure --enable-qtmc --enable-media-library --enable-sqlite --enable-debug --disable-nls</code>

If SQLite has been installed in a non-standard place (as is the case in OS X), you also need to direct configure to that location:

<code>../configure --enable-qtmc --enable-media-library --enable-sqlite --enable-debug --disable-nls --with-sqlite=/opt/local/</code>

=== Running ===
The code is run in the usual way, but you specify that the media center interface and opengl vout should be used:

<code>./vlc -Iqtmc -Vopengl</code>

or on OS X

<code>./VLC.app/Contents/MacOS/VLC -Iqtmc</code>

Before any media will appear in the browsing screens, make sure to configure the Media Library search paths in the settings.

== Status ==
I will post regular status updates to [http://www.barrywardell.net/gsoc/gsoc-blog my blog].

== Projected Timeline ==
April 20
Accepted for summer of code!

April 20 - May 23
Familiarise myself with the VLC code and the PVR code in the vlc-dylanza git repository. Meet with my mentor and the developers on IRC and the mailing list to discuss plans for the project. Determine a realistic set of goals to aim towards.

May 23 - June 6
Begin planning of the interface. Collect the best ideas from other media centers and determine what will be involved to implement each of these ideas. Start writing code to implement the GUI, either building on top of the existing PVR code or starting anew.

June 7 - June 15
I will aim to have some initial code incorporating VLC into a full screen window. This will allow for basic control of playback of audio and video.

June 15 - June 21
I will be attending the conference "12th Capra Meeting on Radiation Reaction" and will take a break from Summer of Code.

June 21 - July 6
I will aim to have at least a minimal Qt/OpenGL Media Center GUI fully up and running with at least basic functionality of video playback and playlist support. I will then continue to refine the interface, adding functionality and documentation.

July 6 - July 13
I will prepare for the mid term review and will aim to have completed any tasks my mentor has deemed necessary for me to pass.

July 12 - July 18
I will attend the conference "Twelfth Marcel Grossmann Meeting".

July 20 - Aug 7
I will aim towards a functioning Media Center GUI running on at least one Operating System (ideally, the code will be written in a cross-platform way since it will make use of Qt/OpenGL). It may not be as fully featured as existing media center software, but will provide a good base for future work to build on. It will support browsing for media and playing back of video and audio.

Aug 8
I will aim to have my project completed ahead of the suggested pencils down date and will take a holiday.

SoC 2009/Media Center Interface for VLC

2009-08-05T13:57:24Z

Barrywardell: /* Project Abstract */

LibVLC SampleCode Qt

2009-05-24T22:14:15Z

Barrywardell:

This sample code will render a video into a Qt QWidget.

This was tested with vlc-0.9.9 and Qt 4.5.1 on WinXP and Linux

== How to use? ==

Take those 3 files, put them in a folder.
Run
qmake -project

Edit the .pro file and add
LIBS += -lvlc

Run
qmake
and then
make

== Files ==

main.cpp:
<pre>
/* libVLC and Qt sample code
* Copyright © 2009 Alexander Maringer <maringer@maringer-it.de>
*/

#include "vlc_on_qt.h"
#include <QtGui/QApplication>

int main(int argc, char *argv[])
{
QApplication a(argc, argv);
Player p;
p.resize(640,480);
p.playFile("rtp://@:2626"); // Replace with what you want to play
p.show();
return a.exec();
}
</pre>

vlc_on_qt.h:
<pre>
/* libVLC and Qt sample code
* Copyright © 2009 Alexander Maringer <maringer@maringer-it.de>
*/
#ifndef VLC_ON_QT_H
#define VLC_ON_QT_H

#include <vlc/vlc.h>

#include <QWidget>

class QProcess;
class QVBoxLayout;
class QWidget;
class QSizePolicy;
class QPushButton;
class QTextEdit;
class QCloseEvent;
class QTimer;
class QDebug;
class QFrame;
class QSlider;

#define POSITION_RESOLUTION 10000

class Player : public QWidget
{
Q_OBJECT
QSlider *_positionSlider;
QSlider *_volumeSlider;
QFrame *_videoWidget;
QTimer *poller;
bool _isPlaying;
libvlc_exception_t _vlcexcep;
libvlc_instance_t *_vlcinstance;
libvlc_media_player_t *_mp;
libvlc_media_t *_m;
libvlc_media_list_t *_ml;
libvlc_media_list_player_t * _mlp;

public:
Player();
~Player();
void raise(libvlc_exception_t * ex);

public slots:
void playFile(QString file);
void updateInterface();
void changeVolume(int newVolume);
void changePosition(int newPosition);

};
#endif
</pre>

vlc_on_qt.cpp:
<pre>
/* libVLC and Qt sample code
* Copyright © 2009 Alexander Maringer <maringer@maringer-it.de>
*/
#include "vlc_on_qt.h"

#include <QVBoxLayout>
#include <QWidget>
#include <QSizePolicy>
#include <QPushButton>
#include <QTextEdit>
#include <QSlider>
#include <QCloseEvent>
#include <QTimer>
#include <QDebug>

Player::Player()
: QWidget()
{
//preparation of the vlc command
const char * const vlc_args[] = {
"-I", "dummy", /* Don't use any interface */
"--ignore-config", /* Don't use VLC's config */
"--extraintf=logger", //log anything
"--verbose=2", //be much more verbose then normal for debugging purpose
"--plugin-path=C:\\vlc-0.9.9-win32\\plugins\\" };

_videoWidget=new QFrame(this);

_volumeSlider=new QSlider(Qt::Horizontal,this);
_volumeSlider->setMaximum(100); //the volume is between 0 and 100
_volumeSlider->setToolTip("Audio slider");

// Note: if you use streaming, there is no ability to use the position slider
_positionSlider=new QSlider(Qt::Horizontal,this);
_positionSlider->setMaximum(POSITION_RESOLUTION);

QVBoxLayout *layout = new QVBoxLayout;
layout->addWidget(_videoWidget);
layout->addWidget(_positionSlider);
layout->addWidget(_volumeSlider);
setLayout(layout);

_isPlaying=false;
poller=new QTimer(this);

//Initialize an instance of vlc
//a structure for the exception is neede for this initalization
libvlc_exception_init(&_vlcexcep);

//create a new libvlc instance
_vlcinstance=libvlc_new(sizeof(vlc_args) / sizeof(vlc_args[0]), vlc_args,&_vlcexcep); //tricky calculation of the char space used
raise (&_vlcexcep);

// Create a media player playing environement
_mp = libvlc_media_player_new (_vlcinstance, &_vlcexcep);
raise (&_vlcexcep);

//connect the two sliders to the corresponding slots (uses Qt's signal / slots technology)
connect(poller, SIGNAL(timeout()), this, SLOT(updateInterface()));
connect(_positionSlider, SIGNAL(sliderMoved(int)), this, SLOT(changePosition(int)));
connect(_volumeSlider, SIGNAL(sliderMoved(int)), this, SLOT(changeVolume(int)));

poller->start(100); //start timer to trigger every 100 ms the updateInterface slot
}

//desctructor
Player::~Player(){}

void Player::playFile(QString file)
{
//the file has to be in one of the following formats /perhaps a little bit outdated)
/*
[file://]filename Plain media file
http://ip:port/file HTTP URL
ftp://ip:port/file FTP URL
mms://ip:port/file MMS URL
screen:// Screen capture
[dvd://][device][@raw_device] DVD device
[vcd://][device] VCD device
[cdda://][device] Audio CD device
udp:[[<source address>]@[<bind address>][:<bind port>]]
*/

/* Create a new LibVLC media descriptor */
_m = libvlc_media_new (_vlcinstance, file.toAscii(), &_vlcexcep);
raise(&_vlcexcep);

libvlc_media_player_set_media (_mp, _m, &_vlcexcep);
raise(&_vlcexcep);

// /!\ Please note /!\
//
// passing the widget to the lib shows vlc at which position it should show up
// vlc automatically resizes the video to the ´given size of the widget
// and it even resizes it, if the size changes at the playing

/* Get our media instance to use our window */
#ifdef Q_OS_WIN
libvlc_media_player_set_drawable( _mp, reinterpret_cast<unsigned int>(_videoWidget->winId()), &_vlcexcep );
#else
libvlc_media_player_set_drawable( _mp, _videoWidget->winId(), &_vlcexcep );
#endif
raise(&_vlcexcep);

/* Play */
libvlc_media_player_play (_mp, &_vlcexcep );
raise(&_vlcexcep);

_isPlaying=true;
}

void Player::changeVolume(int newVolume)
{
libvlc_exception_clear(&_vlcexcep);
libvlc_audio_set_volume (_vlcinstance,newVolume , &_vlcexcep);
raise(&_vlcexcep);
}

void Player::changePosition(int newPosition)
{
libvlc_exception_clear(&_vlcexcep);
// It's possible, that the vlc doesn't play anything
// so check before
libvlc_media_t *curMedia = libvlc_media_player_get_media (_mp, &_vlcexcep);
libvlc_exception_clear(&_vlcexcep);
if (curMedia == NULL)
return;

float pos=(newPosition)/POSITION_RESOLUTION;
libvlc_media_player_set_position (_mp, pos, &_vlcexcep);
raise(&_vlcexcep);
}

void Player::updateInterface()
{
if(!_isPlaying)
return;

// It's possible, that the vlc doesn't play anything
// so check before
libvlc_media_t *curMedia = libvlc_media_player_get_media (_mp, &_vlcexcep);
libvlc_exception_clear(&_vlcexcep);
if (curMedia == NULL)
return;

float pos=libvlc_media_player_get_position (_mp, &_vlcexcep);
int siderPos=(int)(pos*(float)(POSITION_RESOLUTION));
_positionSlider->setValue(siderPos);
int volume=libvlc_audio_get_volume (_vlcinstance,&_vlcexcep);
_volumeSlider->setValue(volume);
}
void Player::raise(libvlc_exception_t * ex)
{
if (libvlc_exception_raised (ex))
{
fprintf (stderr, "error: %s\n", libvlc_exception_get_message(ex));
exit (-1);
}
}
</pre>

SoC 2009/Media Center Interface for VLC

2009-05-11T22:19:51Z

Barrywardell: /* Projected Timeline */

SoC 2009/Media Center Interface for VLC

2009-05-06T19:45:17Z

Barrywardell:

User:Barrywardell

2009-04-30T19:07:29Z

Barrywardell:

Currently I'm working on the [[SoC_2009/Media Center Interface for VLC|Media Center Interface for VLC]] project for Google Summer of Code 2009. I'm known as barrywardell on IRC.

User:Barrywardell

2009-04-30T19:04:24Z

Barrywardell: New page: Currently I'm working on the Media Center Interface for VLC project for Google Summer of Code 2009. I'm known as barrywardell on IRC.

Currently I'm working on the Media Center Interface for VLC project for Google Summer of Code 2009. I'm known as barrywardell on IRC.

SoC 2009/Media Center Interface for VLC

2009-04-30T19:01:10Z

Barrywardell:

SoC 2009/Media Center Interface for VLC

2009-04-30T18:57:21Z

Barrywardell: New page: {{SoCProject|year=2009|student=Barry Wardell|mentor=Ilkka Ollakka}} == Project Abstract == While it is easy to use and functional, the existing defaul...

SoC 2009 projects

2009-04-30T18:52:12Z

Barrywardell: /* List of current VLC projects */

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

= List of current VLC projects =

== QuickTimeVR Playback ==

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

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

==Media Library==

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

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

==Lua Services Discovery==

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

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

==A Media Center Interface for VLC==

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

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