VideoLAN Wiki - User contributions [en]

Documentation:Play HowTo/Basic Use/Interface Windows

2011-11-28T18:14:01Z

Chrisberov:

'''VLC 1.2 Windows 7 Interface Documentation'''

'''The first look when you open VLC player, showing the functions of the buttons:'''
*Play/pause - Plays or Pauses the VLC
*Backward - Previous media or skip backward when key-pressed
*Stop - Stops the playback
*Forward - Next media or skip forward when key-pressed
*Toggle Fullscreen - Switch to Fullscreen
*Extended settings - Opens the adjustments and effects menu
*Playlist - Opens the playlist
*Repeat - Turn on/off the repeat function
*Random - Turn on/off the random playback
*Volume - You can control the volume of the sound

[[File:VLC_first_look2.jpg]]

'''The next screenshot shows how does the Fullscreen looks like:'''
*Slower - Slowers the playback
*Faster - Fasters the playback
*Exit Fullscreen - press Esc to exit Fullscreen
*Elapsed Time - You can switch beside elapsed time and remaining time

[[File:VLC_Fullscr2.jpg]]

'''In that image you can see what you can do in the Playlist(called with Ctrl+L or View/Playlist):'''
Add media into the playlist with the Drag-and-drop function right where you want it to be!
Some quick places you can browse directly from the player.
Change the view of your playlist however you want by picking one of the views.

[[File:VLC_Playlist2.jpg]]

'''You can change the settings the way you like it from Interface to some usefull hotkeys:'''
Everything you want to change or configure is placed in the Preferences menu (Ctrl + P or Tools/Preferences).

[[File:VLC_Preferences2.jpg]]

'''This image shows an example for the visualizations that you can turn on:'''
When playing music you can turn on the visualizations from Audio/Visualizations and pick the one you like:

[[File:VLC_Visualization2.jpg]]

Documentation:Play HowTo/Basic Use/Interface Windows

2011-11-28T18:12:54Z

Chrisberov:

'''VLC 1.2 Windows 7 Interface Documentation'''

'''The first look when you open VLC player, showing the functions of the buttons:'''
Play/pause - Plays or Pauses the VLC
Backward - Previous media or skip backward when key-pressed
Stop - Stops the playback
Forward - Next media or skip forward when key-pressed
Toggle Fullscreen - Switch to Fullscreen
Extended settings - Opens the adjustments and effects menu
Playlist - Opens the playlist
Repeat - Turn on/off the repeat function
Random - Turn on/off the random playback
Volume - You can control the volume of the sound

[[File:VLC_first_look2.jpg]]

'''The next screenshot shows how does the Fullscreen looks like:'''
Slower - Slowers the playback
Faster - Fasters the playback
Exit Fullscreen - press Esc to exit Fullscreen
Elapsed Time - You can switch beside elapsed time and remaining time

[[File:VLC_Fullscr2.jpg]]

'''In that image you can see what you can do in the Playlist(called with Ctrl+L or View/Playlist):'''
Add media into the playlist with the Drag-and-drop function right where you want it to be!
Some quick places you can browse directly from the player.
Change the view of your playlist however you want by picking one of the views.

[[File:VLC_Playlist2.jpg]]

'''You can change the settings the way you like it from Interface to some usefull hotkeys:'''
Everything you want to change or configure is placed in the Preferences menu (Ctrl + P or Tools/Preferences).

[[File:VLC_Preferences2.jpg]]

'''This image shows an example for the visualizations that you can turn on:'''
When playing music you can turn on the visualizations from Audio/Visualizations and pick the one you like:

[[File:VLC_Visualization2.jpg]]

File:VLC Visualization2.jpg

2011-11-28T17:54:29Z

Chrisberov:

File:VLC Preferences2.jpg

2011-11-28T17:54:16Z

Chrisberov:

File:VLC Playlist2.jpg

2011-11-28T17:54:03Z

Chrisberov:

File:VLC Fullscr2.jpg

2011-11-28T17:53:51Z

Chrisberov:

File:VLC first look2.jpg

2011-11-28T17:53:36Z

Chrisberov:

Documentation:Play HowTo/Basic Use/Interface Windows

2011-11-28T17:53:19Z

Chrisberov:

'''VLC 1.2 Windows 7 Interface Documentation'''

The first look when you open VLC player, showing the functions of the buttons:
[[File:VLC_first_look2.jpg]]

The next screenshot shows how does the Fullscreen looks like:
[[File:VLC_Fullscr2.jpg]]

In that image you can see what you can do in the Playlist(called with Ctrl+L or View/Playlist):
[[File:VLC_Playlist2.jpg]]

You can change the settings the way you like it from Interface to some usefull hotkeys:
[[File:VLC_Preferences2.jpg]]

This image shows an example for the visualizations that you can turn on:
[[File:VLC_Visualization2.jpg]]

Documentation:Play HowTo/Basic Use/Interface Windows

2011-11-28T17:38:24Z

Chrisberov:

'''VLC 1.2 Windows 7 Interface Documentation'''

The first look when you open VLC player, showing the functions of the buttons:
[[File:VLC_first_look.jpg]]

The next screenshot shows how does the Fullscreen looks like:
[[File:VLC_Fullscr.jpg]]

In that image you can see what you can do in the Playlist(called with Ctrl+L or View/Playlist):
[[File:VLC_Playlist.jpg]]

You can change the settings the way you like it from Interface to some usefull hotkeys:
[[File:VLC_Preferences.jpg]]

This image shows an example for the visualizations that you can turn on:
[[File:VLC_Visualization.jpg]]

File:VLC Visualization.jpg

2011-11-28T17:34:40Z

Chrisberov:

File:VLC Preferences.jpg

2011-11-28T17:34:29Z

Chrisberov:

File:VLC Playlist.jpg

2011-11-28T17:34:15Z

Chrisberov:

File:VLC Fullscr.jpg

2011-11-28T17:34:04Z

Chrisberov:

Documentation:Play HowTo/Basic Use/Interface Windows

2011-11-28T17:33:49Z

Chrisberov: Created page with "VLC 1.2 Windows 7 Interface Documentation The first look when you open VLC player, showing the functions of the buttons: File:VLC_first_look.jpg The next screenshot shows h…"

VLC 1.2 Windows 7 Interface Documentation

The first look when you open VLC player, showing the functions of the buttons:
[[File:VLC_first_look.jpg]]

The next screenshot shows how does the Fullscreen looks like:
[[File:VLC_Fullscr.jpg]]

In that image you can see what you can do in the Playlist(called with Ctrl+L or View/Playlist):
[[File:VLC_Playlist.jpg]]

You can change the settings the way you like it from Interface to some usefull hotkeys:
[[File:VLC_Preferences.jpg]]

This image shows an example for the visualizations that you can turn on:
[[File:VLC_Visualization.jpg]]

File:VLC first look.jpg

2011-11-28T17:23:44Z

Chrisberov:

Documentation:User Guide

2011-11-28T17:21:52Z

Chrisberov:

{{RightMenu|documentation play howto toc}}

'''This document is the complete user guide for the VLC media player.'''

'' '''Note''' that most of the documentation is for versions older than 0.9''

User documentation for everyone.

*[[Documentation:Play HowTo/Introduction to VLC|Introduction to VideoLAN and VLC]]

'''       Overview and history of the VideoLAN project.'''

*[[Documentation:Play HowTo/Installing VLC|Installation]]

'''       Installation instructions for a variety of computers.''' 

*[[Documentation:Play HowTo/Basic Use|VLC Usage]]
**[[Documentation:Play_HowTo/Basic_Use/Open|Open Media]]
***How to play audio/video materials with the VLC media player. (For versions 0.9 and newer)
**[[Documentation:Play HowTo/Basic Use/Interface|Interface]]
***[[Documentation:Play_HowTo/Basic_Use/Interface_OSX|OSX 1.2 Interface]]
***[[Documentation:Play_HowTo/Basic_Use/Interface_Windows|Windows 7 1.2 Interface]]
***Short introduction to the interface of the VLC Media Player
**[[Documentation:Play HowTo/Basic Use/Audio|Audio]]
***Playing audio (e.g. visualization, selection of devices)
**[[Documentation:Play HowTo/Basic Use/Video|Video]]
***Playing video (e.g. cropping, screen-/snapshots)
**[[Documentation:Play HowTo/Basic Use/Playback|Playback]]
***Navigation through media files (e.g. chapters, bookmarks)
**[[Documentation:Play HowTo/Basic Use/Playlist|Playlist]]
***Creating and managing playlists
**[[Documentation:Play HowTo/Basic Use/Subtitles|Subtitles]]
***Selection of subtitles
**[[Documentation:Play HowTo/Basic Use/Video and Audio Filters|Video and Audio Filters]]
***Usage of VLC's filters (equalizer, video filters)
**[[Documentation:Play HowTo/Basic Use/Snapshots|Snapshots]]
***How to create snap-/screenshots
**[[Documentation:Play HowTo/Basic Use/Hotkeys|Hotkeys]]
***Configuration of VLC's hotkeys
**[[Documentation:Play HowTo/Basic Use/Basic troubleshooting|Troubleshooting]]
***Solutions for some common problems
*[[Documentation:Play HowTo/Advanced Use of VLC|Advanced Use]]
**Advanced instruction on streams, filters, plug-ins and more.
*[[Documentation:WebPlugin|Using VLC inside a webpage]]
**How to build webpages that use the VLC Web plugin.
*[[VLC Uninstall|Uninstallation]]
**Uninstallation instructions.

*[[Documentation:Play HowTo/Basic Use 0.8| VLC Usage 0.8]]. (versions older than 0.9)

===Authors===
* Alexis de Lattre
* Johan Bilien
* Anil Daoud
* Clément Stenac
* Jean-Paul Saman
* Jean-Baptiste Kempf

Copyright (c) 2002-2009 the VideoLAN project

{{GPL}}

==See also==

*[[Documentation:Play_HowTo/Building Pages for the HTTP Interface|Building Pages for the HTTP Interface]]
*[[Documentation:Play_HowTo/Format String|Format String]]
*[[Documentation:Play_HowTo/Building Lua Playlist Scripts|Building Lua Playlist Scripts]]

{{Documentation}}

Copyright © 2002-2009 the VideoLAN project.

LibVLC Users

2011-11-28T12:40:56Z

Chrisberov:

What applications use [[LibVLC|LibVLC]]?

* [http://code.google.com/p/freetuxtv/ FreeTuxTV]
* [http://www.kde-apps.org/content/show.php?content=111750 Kamoso]
* [http://www.getmiro.com/ Miro]
* [http://code.google.com/p/sopcast-player SopCast Player]
* [http://tdpmedia.tdpe.co.uk/ TDPMedia Player]
* [http://git.videolan.org/?p=MobileVLC.git;a=summary VLC for iOS]
* [http://vlmc.org/ VideoLAN Movie Creator]
* [http://www.sally-project.org/ Sally Project Touchscreen-MediaCenter]

Add your application above in alphabetical order.

LibVLC Tutorial 086c

2011-11-28T12:40:32Z

Chrisberov: /* Compile/link */

=== Tutorial for libVLC for version 0.8.6c ===

Tested on cygwin with gcc 3.4, windows xp; instructions also for linux with small code change.
You will want to change the plugin path to where you actually have vlc installed. And you will want to change the video filename to one which actually exists on your system. This will initialize vlc and play the video for ten seconds. After you get this to work, then you will want to look up the external API documentation to see how to use the other interfaces. Note there are two interfaces documented in the
external API page; the first one is the "old" legacy one using calls such as VLC_Init. The second one
is the "current" one using calls such as libvlc_new, which is used in the following code.

=== Code ===

#include <stdio.h>
#include <windows.h>
#include <vlc/libvlc.h>

static void quit_on_exception (libvlc_exception_t *excp) {
if (libvlc_exception_raised (excp)) {
fprintf(stderr, "error: %s\n", libvlc_exception_get_message(excp));
exit(-1);
}
}

int main(int argc, char **argv) {
libvlc_exception_t excp;
libvlc_instance_t *inst;
int item;
char *myarg0 = "-I"; char *myarg1 = "dummy";
char *myarg2 = "--plugin-path=c:\\program files\\videolan\\plugins";
char *myargs[4] = {myarg0, myarg1, myarg2, NULL};
char *filename = "c:\\video\\main\\Everybody_Hates_Chris_Feb_26.mpg";

libvlc_exception_init (&excp);
inst = libvlc_new (3, myargs, &excp);
quit_on_exception (&excp);
item = libvlc_playlist_add (inst, filename, NULL, &excp);
quit_on_exception (&excp);
libvlc_playlist_play (inst, item, 0, NULL, &excp);
quit_on_exception (&excp);
Sleep (10000);
libvlc_destroy (inst);
return 0;
}

=== Compile/link ===

You can use [[LibVLC|LibVLC]] without compiling your own copy of the VLC source code. You can use the libvlc.dll which comes in the standard end user installation. But, to access the include files, you will need to download and extract the source code. You only need to untar it; you do not even need to run the configure script.
Set your %PATH% to include the directory which contains libvlc.dll and the plugins directory. For example, add "C:\Program files\VideoLAN\VLC" in a relatively standard installation. This way the compiler can find libvlc.dll. Otherwise you have to copy the dll to your current directory.
Use the following Makefile:

VLC_INST = "C:\Program files\VideoLAN\VLC"
VLC_SRC = "C:\tools\vlc-0.8.6c\"
demo: demo.c
gcc -o demo demo.c -I$(VLC_SRC)/include \
-L$(VLC_INST) -llibvlc

=== Code for Linux ===

#include <stdio.h>
#include <stdlib.h>
#include <vlc/libvlc.h>

static void quit_on_exception (libvlc_exception_t *excp) {
if (libvlc_exception_raised (excp)) {
fprintf(stderr, "error: %s\n", libvlc_exception_get_message(excp));
exit(-1);
}
}

int main(int argc, char **argv) {
libvlc_exception_t excp;
libvlc_instance_t *inst;
int item;
char *filename = "/tmp/WorldOfPadman_Intro.avi";

libvlc_exception_init (&excp);
inst = libvlc_new (argc, argv, &excp);
quit_on_exception (&excp);
item = libvlc_playlist_add (inst, filename, NULL, &excp);
quit_on_exception (&excp);
libvlc_playlist_play (inst, item, 0, NULL, &excp);
quit_on_exception (&excp);
usleep (10000000);
libvlc_destroy (inst);
return 0;
}

See [http://files.filefront.com/WorldOfPadman+Introavi/;6089800;/fileinfo.html] for ''WorldOfPadman_Intro.avi''. (You can, of course, substitute any video you like.)

=== Compile/Link/Run for Linux ===

$ export VLC_SRC=/tmp/vlc-0.8.6c
$ gcc -I ${VLC_SRC}/include/ -lvlc -L ${VLC_SRC}/src/.libs/ demo.c -o demo
$ export LD_LIBRARY_PATH=${VLC_SRC}/src/.libs/
$ ./demo --plugin-path ${VLC_SRC}

LibVLC SampleCode Qt

2011-11-28T12:39:22Z

Chrisberov: /* How to use? */

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

You need [[LibVLC|''libvlc headers'']] and ''Qt headers''.Take those 3 files, put them in a folder.
Run
qmake -project

Edit the .pro file and add
LIBS += -L*path to vlc lib* #if you are at windows os
LIBS += -lvlc

Run
qmake
and then
make or mingw32-make under a Windows OS

On win os you have to use the zip file. the lib and the header files are located in the sdk-folder.

== VLC 1.1.5 and Ubutnu Lucid ==
[Ondrej Spilka 20101201] slightly modified for the modest versions...
- tested ok
- X11 embed container have to be used, therefore QX11EmbedContainer rather than QFrame have to be used.

== 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 QVBoxLayout;
class QPushButton;
class QTimer;
class QFrame;
class QSlider;

#define POSITION_RESOLUTION 10000

class Player : public QWidget
{
Q_OBJECT
QSlider *_positionSlider;
QSlider *_volumeSlider;
// [20101201 Ondra Spilka]
// on Linux/Ubuntu Lucid and VLC >= 1.0 (at least 1.1.5 was tested) XWindow handle have to be passed
// therefore QX11EmbedContainer have to be used instead of QFrame
#ifdef Q_WS_X11
QX11EmbedContainer *_videoWidget;
#else
QFrame *_videoWidget;
#endif
QTimer *poller;
bool _isPlaying;
libvlc_exception_t _vlcexcep;
libvlc_instance_t *_vlcinstance;
libvlc_media_player_t *_mp;
libvlc_media_t *_m;

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 <QPushButton>
#include <QSlider>
#include <QTimer>
#include <QFrame>

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\\" };

#ifdef Q_WS_X11
QX11EmbedContainer *_videoWidget;
#else
_videoWidget=new QFrame(this);
#endif

_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()
{
/* Stop playing */
libvlc_media_player_stop (_mp, &_vlcexcep);

/* Free the media_player */
libvlc_media_player_release (_mp);

libvlc_release (_vlcinstance);
raise (&_vlcexcep);
}

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 */
#if defined(Q_OS_WIN)
libvlc_media_player_set_drawable(_mp, reinterpret_cast<unsigned int>(_videoWidget->winId()), &_vlcexcep );
//libvlc_media_player_set_hwnd(_mp, _videoWidget->winId(), &_vlcexcep ); // for vlc 1.0
#elif defined(Q_OS_MAC)
libvlc_media_player_set_drawable(_mp, _videoWidget->winId(), &_vlcexcep );
//libvlc_media_player_set_agl (_mp, _videoWidget->winId(), &_vlcexcep); // for vlc 1.0
#else //Linux
//[20101201 Ondrej Spilka] obsolete call on libVLC >=1.1.5
//libvlc_media_player_set_drawable(_mp, _videoWidget->winId(), &_vlcexcep );
//libvlc_media_player_set_xwindow(_mp, _videoWidget->winId(), &_vlcexcep ); // for vlc 1.0

/* again note X11 handle on Linux is needed
winID() returns X11 handle when QX11EmbedContainer us used */

int windid = _videoWidget->winId();
libvlc_media_player_set_xwindow (mp, windid );

#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=(float)(newPosition)/(float)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>

== VLC 1.2 and OpenSuse 11.3 ==
[Jofre Guevara 20101215] Modifications of original template based on new VLC version.
[Ondrej Spilka 20101201] slightly modified for the modest versions...
- tested ok

== 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 QVBoxLayout;
class QPushButton;
class QTimer;
class QFrame;
class QSlider;

#define POSITION_RESOLUTION 10000

class Player : public QWidget
{
Q_OBJECT
QSlider *_positionSlider;
QSlider *_volumeSlider;
// [20101215 JG]
// Tested on Linux OpenSuse and VLC 1.2.0. This version of VLC is not completely compatible with previous versions of VLC.
// [20101201 Ondra Spilka]
// on Linux/Ubuntu Lucid and VLC >= 1.0 (at least 1.1.5 was tested) XWindow handle have to be passed
// therefore QX11EmbedContainer have to be used instead of QFrame
#ifdef Q_WS_X11
QX11EmbedContainer *_videoWidget;
#else
QFrame *_videoWidget;
#endif
// [20101215 JG] If KDE is used like unique desktop environment, only use QFrame *_videoWidget;
QTimer *poller;
bool _isPlaying;
//libvlc_exception_t _vlcexcep; // [20101215 JG] Used for versions prior to VLC 1.2.0.
libvlc_instance_t *_vlcinstance;
libvlc_media_player_t *_mp;
libvlc_media_t *_m;

public:
Player();
~Player();
//void raise(libvlc_exception_t * ex); // [20101215 JG] Used for versions prior to VLC 1.2.0.

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 <QPushButton>
#include <QSlider>
#include <QTimer>
#include <QFrame>

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\\" };

#ifdef Q_WS_X11
QX11EmbedContainer *_videoWidget;
#else
_videoWidget=new QFrame(this);
#endif
// [20101215 JG] If KDE is used like unique desktop environment, only use _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); // [20101215 JG] Used for versions prior to VLC 1.2.0.

//create a new libvlc instance
_vlcinstance=libvlc_new(sizeof(vlc_args) / sizeof(vlc_args[0]), vlc_args); //tricky calculation of the char space used
//_vlcinstance=libvlc_new(sizeof(vlc_args) / sizeof(vlc_args[0]), vlc_args,&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise (&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

// Create a media player playing environement
_mp = libvlc_media_player_new (_vlcinstance);
//_mp = libvlc_media_player_new (_vlcinstance, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise (&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

//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()
{
/* Stop playing */
libvlc_media_player_stop (_mp);
//libvlc_media_player_stop (_mp, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

/* Free the media_player */
libvlc_media_player_release (_mp);

libvlc_release (_vlcinstance);
//raise (&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
}

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_path(_vlcinstance, file.toAscii());
//_m = libvlc_media_new (_vlcinstance, file.toAscii(), &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

libvlc_media_player_set_media (_mp, _m);
//libvlc_media_player_set_media (_mp, _m, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

// /!\ 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 */
#if defined(Q_OS_WIN)
libvlc_media_player_set_drawable(_mp, reinterpret_cast<unsigned int>(_videoWidget->winId()));
//libvlc_media_player_set_drawable(_mp, reinterpret_cast<unsigned int>(_videoWidget->winId()), &_vlcexcep ); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//libvlc_media_player_set_hwnd(_mp, _videoWidget->winId(), &_vlcexcep ); // for vlc 1.0
#elif defined(Q_OS_MAC)
libvlc_media_player_set_drawable(_mp, _videoWidget->winId());
//libvlc_media_player_set_drawable(_mp, _videoWidget->winId(), &_vlcexcep ); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//libvlc_media_player_set_agl (_mp, _videoWidget->winId(), &_vlcexcep); // for vlc 1.0
#else //Linux
//[20101201 Ondrej Spilka] obsolete call on libVLC >=1.1.5
//libvlc_media_player_set_drawable(_mp, _videoWidget->winId(), &_vlcexcep );
//libvlc_media_player_set_xwindow(_mp, _videoWidget->winId(), &_vlcexcep ); // for vlc 1.0

/* again note X11 handle on Linux is needed
winID() returns X11 handle when QX11EmbedContainer us used */

int windid = _videoWidget->winId();
libvlc_media_player_set_xwindow (_mp, windid );

#endif
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

/* Play */
libvlc_media_player_play (_mp);
//libvlc_media_player_play (_mp, &_vlcexcep ); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.

_isPlaying=true;
}

void Player::changeVolume(int newVolume)
{
//libvlc_exception_clear(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
libvlc_audio_set_volume (_mp,newVolume);
//libvlc_audio_set_volume (_vlcinstance,newVolume , &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
}

void Player::changePosition(int newPosition)
{
//libvlc_exception_clear(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
// It's possible that the vlc doesn't play anything
// so check before
libvlc_media_t *curMedia = libvlc_media_player_get_media (_mp);
//libvlc_media_t *curMedia = libvlc_media_player_get_media (_mp, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//libvlc_exception_clear(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
if (curMedia == NULL)
return;

float pos=(float)(newPosition)/(float)POSITION_RESOLUTION;
libvlc_media_player_set_position (_mp, pos);
//libvlc_media_player_set_position (_mp, pos, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//raise(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
}

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);
//libvlc_media_t *curMedia = libvlc_media_player_get_media (_mp, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
//libvlc_exception_clear(&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
if (curMedia == NULL)
return;

float pos=libvlc_media_player_get_position (_mp);
//float pos=libvlc_media_player_get_position (_mp, &_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
int siderPos=(int)(pos*(float)(POSITION_RESOLUTION));
_positionSlider->setValue(siderPos);
int volume=libvlc_audio_get_volume (_mp);
//int volume=libvlc_audio_get_volume (_vlcinstance,&_vlcexcep); // [20101215 JG] Used for versions prior to VLC 1.2.0.
_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);
}
}*/ // [20101215 JG] Used for versions prior to VLC 1.2.0.
</pre>

LibVLC Memory Management

2011-11-28T12:38:07Z

Chrisberov: /* Reference Counting */

== Reference Counting ==

[[LibVLC|LibVLC]] uses a certain number of objects. Each one maintains a references count, which is used to know when the object must be released. The three related functions are:

* libvlc_object_name_'''new'''() ''Create an object with a refcount equal to 1.''

* libvlc_object_name_'''retain'''() ''Increment the object refcount by 1.''

* libvlc_object_name_'''release'''() ''Decrement the refcount by 1, and release the object if the new refcount is less than zero.''

=== Example ===

libvlc_exception_t e;
libvlc_exception_init( &e );

libvlc_media_list_t * p_ml = libvlc_media_list_new( libvlc_inst, &e)

/* Free the memory used by media_list release */
libvlc_media_list_release( p_ml );

=== Objects that don't follow this rule ===

* libvlc_exception_t: Those are not pointers
* libvlc_event_manager_t: Those are supposed to be accessed only during the life of their parent libvlc_* object.

== Getters and Setters ==

Usually object properties are set through getters and setters.

* Usually getters are in the form:
libvlc_''object_name''_''object''

* Setters are:
libvlc_''object_name''_''set_object''

* Variations:
** Setter: libvlc_media_list_add_media_descriptor
** Getter: libvlc_media_list_item_at_index

For setters and getters the memory management rules are:
* Getters internally '''retain''' the object before returning it, so is means you must '''release''' the object after use.
* Setters internally '''retain''' the object, so basically you never need to keep the object around.
(This also applies to strings where retain is '''strdup''' and release is '''free''')

Notable exceptions to those rules are:
* libvlc_''object_name''_'''event_manager''': This getter never retains the object prior returning it. That means you '''mustn't release''' it.

LibVLC Media List Management

2011-11-28T12:37:15Z

Chrisberov: /* Global Description of the available objects */

== Global Description of the available objects ==
The atomic item that represent a media that you can play is a '''libvlc_media''' in [[LibVLC|LibVLC]].

A '''media_list''' is an object that contains several ''libvlc_media''. You can add items to that media_list.

You can play a media_list using a '''media_list_player'''.

== A media descriptor can contain a media list ==
A playlist downloaded from Google video has a corresponding ''libvlc_media''. This ''libvlc_media'' has several subitems. You can access them through libvlc_media_subitems() which returns a media_list.

This explains how a media_list can be hierarchical. To browse it you'll use libvlc_media_list_hierarchy_view(). To view the all the item without hierarchy use libvlc_media_list_flat_view().

== Sample Code ==

void play_media(libvlc_instance_t *vlc, libvlc_drawable_t window)
{

libvlc_media_list_t *ml;
libvlc_media_list_player_t *mlp;
libvlc_media_player_t *mp;
libvlc_media_descriptor_t *md1, *md2;

ml = libvlc_media_list_new(vlc);

md1 = libvlc_media_new(vlc, "http://mycool.com/movie1.avi");
md2 = libvlc_media_new(vlc, "http://mycool.com/movie2.avi");

libvlc_media_list_add(ml, md1);
libvlc_media_list_add(ml, md2);

libvlc_media_release(md1);
libvlc_media_release(md2);

mlp = libvlc_media_list_player_new(vlc);

mp = libvlc_media_player_new(vlc);

/* Use our media list */
libvlc_media_list_player_set_media_list(mlp, ml);

/* Use a given media player */
libvlc_media_list_player_set_media_player(mlp, p_mp);

/* Get our media instance to use our window */
libvlc_media_player_set_drawable(mlp, window);

/* Play */
libvlc_media_list_player_play(mlp);

/* Let it play forever */
while(1) sleep(300);
}

VSG:ResetPrefs

2011-11-28T12:35:57Z

Chrisberov: /* Deleting the files manually */

Many problems with VLC are due to wrong settings or broken cache. You can solve these through deleting VLC's preferences and cache.

= On Windows =

== Using the shortcut in the start menu ==
If you installed VLC properly you can delete the preferences and cache by simply opening the shortcut you can find in your start menu: ''All programs > VideoLAN > Reset VLC media player preferences and cache files''

== Deleting the files manually ==
Open the explorer and type ''%APPDATA%'' into the address bar and hit enter. This should lead you to the AppData folder of your user. Therein you should find a folder named ''vlc''. Delete that folder and your done.
* More of [[VLC HowTo|VLC HowTo]]

VLC HowTo/Make VLC the default player

2011-11-28T12:35:35Z

Chrisberov: /* References */

In Windows after installation of VLC player(version 1.1) it can be made default by following way,

Open VLC player, Click on Tools in menu, Select "preferences",
single left Click "interface" button,on left side, single left Click on "setup associations"
Select types of files from the list that appears, and anyone need to use with VLC player as default, or "select all"

== Windows ==

[1]

On any folder with a toolbar, click on ''Tools'' then ''Folder Options''. Select the ''File Types'' tab.
One can select and set any default program for any registered file type from that section.

''E.g.'', if there is a "DVD Video" in the list as there is for MS Windows XP, select it then click the ''Advanced'' button.

A new window, ''Edit File Type'', will open and the list of known, compatible executable programs will be presented.

Select the one desired, in this case, ''Play with VLC media player'', and then click the ''Set Default'' button.

Next, click ''OK'' and then ''Close'' to close the ''Edit File Type'' window.

One can repeat that for as many files as needed before clicking the "Close" button. E.g., perhaps the "AudioCD" would be useful to set for VLC.

( Please note that this ''File Types'' location is *'''''not'''''* a place to play. Change what is needed and only that. I.e., one can look but do not touch unless you intend to buy it, :). )

[2]

Perhaps the easiest way is to set the VLC player as the default ''during the installation'' of VLC. As odd as it might sound, removing VLC from programs and then re-installing it will be the safest method for many people. All the file types are automatically selected, which you can change as desired.

During installation just make certain that you clear any box that would cause the installer to delete your preferences and cache.

If for some reason the installer fails to set the correct file types or gets overwritten by MS during an upgrade(or some other program), try [1] to fix it.

== Mac ==
Right click on the type of file you want to always open in VLC. Click 'Get Info'. In the 'Open With' section, select VLC from the drop down menu. To apply this change to all files of this type, click the 'Change All' button. If you're having some problems with it try to search at [http://www.mac-how.net Mac How]

== Linux ==

=== Fedora ===

==== GNOME ====

Gnome uses two lists (located at '''''/usr/share/applications/''''') '''mimeinfo.cache''' and '''defaults.list''', to register applications to file types. 
So you could either edit it manually or use the tools that GNOME has for this. 

===== Instructions on how to do it in GNOME. =====

===== Changing the default application for videos using menus(the easy way): =====

Using Nautilus 2.30.1, from the top menu bar choose Places then Home Folder -> Edit menu -> Preferences -> choose Media tab -> in drop down list next to "DVD Video" choose "Open VLC media player". Voila.

Alternatively try: System -> Preferences -> Personal -> Preferred Applications -> Multimedia -> Custom -> Type this: vlc %U

ps: this alternative not tested yet.

===== Changing the default application for videos using menus(the not so easy way): =====

{| class="wikitable"
| * Right-click on the video file that you want VLC to open. * Choose properties. * Now in the properties window click on the tab named '''''Open With'''''. http://upload.wikimedia.org/wikipedia/commons/thumb/5/59/Properties_window.png/800px-Properties_window.png 
|-
| * In the tab '''''Open With''''' just choose VLC as your player for that type of file. Just remember that you will have to do this for each an every type of video/audio file('''ex:''' mpg, avi, rm, mkv, ogg, mp3 etc) http://upload.wikimedia.org/wikipedia/commons/thumb/6/6b/Open_with_tab.png/800px-Open_with_tab.png 
|-
| * If the VLC icon don't show up on the '''''Open With''''' tab, click on the '''''add''''' button in the lower corner to the right of the window tha has a plus sign, and locate VLC on the window tha pops up that is called Add Application. http://upload.wikimedia.org/wikipedia/commons/5/51/Add_app.png 
|}

===== Changing the default application for videos manually(the hard way): =====

In Fedora 10 the path /usr/share/applications/ will take you to these 2 files that configure what application open a type of file. 
 
'''defaults.list''' 
'''mimeinfo.cache''' 
 
ps:
Both files will point to a Desktop Entry file([name of the file].desktop) that is inside the ''applications'' folder, and the 2 important things inside that file are the configurations for what MIME Types the application can handle and how to launch the application.

A ''Desktop Entry'' file is a data file that provides information about an item in a menu.
The desktop entry specification describes desktop entries as files describing information about an application such as the name, MIME Types it handles, icon, and description. These files are used for application launchers and for creating menus of applications that can be launched. 
If you don't have the VLC ''Desktop Entry'' file or it disapear for some reason you will have to make one. Look [http://library.gnome.org/admin/system-admin-guide/stable/menustructure-desktopentry.html.en here] for some pointers.
 

You only need to modify '''mimeinfo.cache''', I hope. It works here if It don't work for you please edit this. 

So what you have to do is:

# Open ''mimeinfo.cache'' as root.
# Search for the MIME Types for video.
# Change all of them to use VLC.

ex: 
Registry of MIME Type (video/quicktime) in ''mimeinfo.cache'' to use VLC. 
 
video/quicktime=livna-vlc.desktop;totem.desktop;miro.desktop; 
 
The format is: 
[MIME Type]=[Name of the Desktop Entry file] 
 
'''Note:''' You can put more then one ''Desktop Entry'' but they need to be separated by a semi-colon (;), see the example above. 
Those extra entries will appear as options when you right-click on the video file and go to the ''Open With'' submenu. 
'''Tip:''' Nautilus don't show the real names of the ''Desktop Entry'' files. Either drag and drop it on gedit so you see the name on the tab or use '''ls''' to list the files on the command line.

In Ubuntu 11.04, the default applications for different mimes can be defined in ~/.local/share/applications/mimeapps.list as follows. Under [Default Applications] add all the mimes you would like the VLC to be default for:

<pre>
[Default Applications]
application/x-cd-image=vlc.desktop
video/x-flv=vlc.desktop
video/x-avi=vlc.desktop
x-content/video-dvd=vlc.desktop
video/quicktime=vlc.desktop
video/mpeg=vlc.desktop
</pre>

===== References =====

[http://library.gnome.org/admin/system-admin-guide/stable/menustructure-desktopentry.html.en Desktop Entry Files]

[http://library.gnome.org/admin/system-admin-guide/stable/mimetypes-registering.html.en Registering Applications for MIME Types] (Editing defaults.list and mimeinfo.cache)

* More of [[VLC HowTo|VLC HowTo]]

==== KDE ====

VLC HowTo/Use for transcription (Linux)

2011-11-28T12:34:59Z

Chrisberov:

'''OVERVIEW:'''

The purpose of this howto is to show you how to configure vlc and use the script below to enable you to control vlc with scripted commands and, most importantly, take a timestamp from vlc and automatically type it into whatever document you are working on, without ever needing to shift focus away from the document.

 There are other ways to achieve what I've done with this, many of them likely better than what is here. But this works, and works well.  This script was written for linux, but might have some useful information for anyone trying to do this on other platforms. 

 '''PREREQUISITES:'''

First, you need to have [http://www.videolan.org/vlc/ VLC] (obviously), [http://www.python.org/ python] 2 OR 3, [http://hoopajoo.net/projects/xautomation.html xautomation] OR a version of [http://www.semicomplete.com/projects/xdotool/ xdotool] (newer than august 2010), and you need the openbsd implementation of [http://www.openbsd.org/cgi-bin/cvsweb/src/usr.bin/nc/ netcat]--'''Note:''' see below for a version that uses the more readily available [http://www.dest-unreach.org/socat/ socat] package.

 The openbsd version of netcat is in the repositories of most major linux distirbutions these days. This script is written for use in Archlinux, so it's likely that you will need to change the command used by netcat in the script. Arch uses nc.openbsd, just replace it with whatever you need. Unfortunately, the GNU implementation of netcat, which is the default in most distributions, does not seem to support UNIX sockets (the -U switch for nc.openbsd). If you run slackware and can't find it, check [http://www.slackbuilds.org slackbuilds]. 

 xautomation will almost certainly be in your repos, and xdotool might be. xautomation seems to be the better choice if you're only concerned about how quickly it does the job, but xdotool is nice as well if you're doing fancier things with it. However, if you do choose to try xdotool, you'll need a build done later than August 2010, as some of the features used in this script are not in the older versions available in most repositories.

 '''SETUP:'''

This setup is window manager agnostic. It shouldn't make much difference which environment you run it in, the only practical difference will be in how you set up your control keys. I won't go over how to set up window environment here, but I will try to give you a few pointers below.

 To set up vlc to use this script, go to tools->preferences and click on "show settings->all" at the bottom. From that menu, select "Interface->Main Interfaces", and check the "Remote Control Interface" box. Next, select "Interface->Main Interfaces->RC", check the "Fake TTY' box, and enter 'home/YOURNAME/vlc.sock'in the "UNIX socket command input" field.

 You probably also want to adjust the "Very short jump length" located in "Interface->Hotkeys settings". This script assumes that it is set for 5 seconds rather than the default of 3 seconds. It won't affect the script if you don't change this value, as it uses the 'very short jump' command rather than jogging a specific number of seconds. If you poke around the vlc docs, you'll see a seek command, but that is to go to a certain point in a file rather than going forward or backward a certain number of seconds.

 Hit "Save". Restart VLC, and check to see if it creates "vlc.sock" in your home directory. This should be created automatically when vlc starts. If it doesn't, check your socket path and try again.

 Next, you need to set up your control keys for your window environment. Remember to check to make sure that whichever control keys you wish to use are not already used by your window manager. Redefine these control keys or the defaults as necessary. I didn't have any luck with the global hotkeys settings within VLC but, personally, I like having these commands in the script. You may have better results with some experimentation.

 I set my control keys up like this:

F1 = ~/vlccontrol.py jogbackward

F2 = ~/vlccontrol.py pause

F3 = ~/vlccontrol.py pause (no need for two, just habit)

F4 = ~/vlccontrol.py jogforward

F5 = ~/vlccontrol.py timestamp

Shift+F1 = ~/vlccontrol.py slower

Shift+F3 = ~/vlccontrol.py normal

Shift+F4 = ~/vlccontrol.py faster

 If you use gnome+metacity, you can edit your keybindings in gconf-editor. Go to apps->metacity->global_keybindings and assign a command number to control key you want. Then go to app->metacity->keybinding_commands and assign the appropriate commands to the command numbers. So, for my keybindings, in 'global_keybindings' you would set run_command_1 to F1. Then go to 'keybinding_commands' and set command_1 to /home/YOURNAME/vlccontrol.py jogbackward.

 If you use kde4, open system settings, click on 'Shortcuts and Gestures', then choose 'Custom Shortcuts'. In the second pane, under name, choose an appropriate group to put your new bindings (it might be a good idea to create a new group for these under 'Preset Actions', choose 'New Group' from the 'Edit' menu below the second pane.) Click on 'Edit', go to New->Global Shortcut->Command/URL, and name the action. While the new action is selected, click the 'Trigger' tab in the right hand pane, click shortcut box and hit the key you wish to bind to the action (F1). Then go to action and enter in the command for that action (/home/YOURNAME/vlccontrol.py jogbackward.)

 In any window manager which utilizes an rc.xml file for it's keybindings, like OpenBox, edit the rc.xml in a text editor and go down to the 'keybindings' section. Just follow along with the other keybind examples in the file, it's fairly straightfoward, but your first entry should look something like this, although you will need to put in appropriate symbols around the keywords:

<code></code>
<pre> keybind key="F1"
action name="execute"
execute /home/delwin/vlccontrol.py jogbackward /execute
/action
/keybind
</pre>
 

'''VLCCONTROL.PY:'''

 Finally, here is the vlccontrol.py script. Copy the script below and paste it into a file named 'vlccontrol.py'. Save it to your home directory and make it executable with the command 'chmod 700 vlccontrol.py'

 

<code></code>
<pre>#!/usr/bin/env python
#### licensing nonsense - short version: New BSD License
#Copyright (c) 2010, Derek Barnett, Skyehaven Transcription
#Contact: derek at skyehaven.net
#All rights reserved.
#Redistribution and use in source and binary forms, with or
#without modification, are permitted provided that the following
#conditions are met:
#
# * Redistributions of source code must retain the above
#copyright notice, this list of conditions and the following
#disclaimer.
# * Redistributions in binary form must reproduce the above
#copyright notice, this list of conditions and the following
#disclaimer in the documentation and/or other materials provided
#with the distribution.
# * Neither the name of the Skyehaven Transcription nor the
#names of its contributors may be used to endorse or promote
#products derived from this software without specific prior
#written permission.
#
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
#CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
#INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
#MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
#CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
#USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
#AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
#LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
#IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
#THE POSSIBILITY OF SUCH DAMAGE.
#####

##### useful notes
#vlc control script, compatible with python 2 or 3
#
#this script requires the openbsd version of netcat. gnu's version
#does not appear to support unix sockets as of this time. it will
#almost certainly be in the repos of your distribution. you may need
#to adjust this script to change the name of the binary to whatever
#format your distribution uses (change 'nc.openbsd' below to whatever
#you need.)
#
#it also requires either xautomation (for it's xte tool) or xdotool
#xautomation is used by default, as it's currently a bit faster
#if you use xdotool, ensure that it's a version later than aug 2010
#
#to set up vlc to use this script, go to tools->preferences and
#click on "show settings->all" at the bottom. from that menu,
#select "Interface->Main Interfaces", and check the "Remote Control
#Interface" box. Next, select "Interface->Main Interfaces->RC",
#check the "Fake TTY' box, and enter 'home/YOURNAME/vlc.sock'in
#the "UNIX socket command input" field.
#
#You probably also want to adjust the "Very short jump length" located
#in "Interface->Hotkeys settings". This script assumes that it is set
#for 5 seconds rather than the default of 3 seconds. It won't affect the
#script if you don't change this value, as it uses the 'very short jump'
#command rather than jogging a specific number of seconds. If you poke
#around the vlc docs, you'll see a seek command, but that is to go to a
#certain point in a file rather than going forward or backward a certain
#number of seconds.
#
#Hit "Save". Restart VLC, and check to see if it creates "vlc.sock"
#in your home directory. This should be created automatically when vlc
#starts. If it doesn't, check your socket path and try again.
#
#Next, you need to set up your hotkeys for your window environment.
#This should work equally well in any window manger, so pick whichever
#you like. Remember to check to make sure that whichever hotkeys you wish
#to use are not already used by your windowmanager. Redefine these
#hotkeys or the defaults as necessary.
#
#note: vlc supposedly support global hotkeys, but I didn't have any luck
#with them, which is why i went this route with the control script. Your
#mileage may vary.
#
#I personally set it up like this:
#F1 = ~/vlccontrol.py jogbackward
#F2 = ~/vlccontrol.py pause (no need to have this twice, just habit)
#F3 = ~/vlccontrol.py pause
#F4 = ~/vlccontrol.py jogforward
#F5 = ~/vlccontrol.py timestamp
#Shift+F1 = ~/vlccontrol.py slower
#Shift+F3 = ~/vlccontrol.py normal
#Shift+F4 = ~/vlccontrol.py faster
##### end of rambling, on to business

import sys
import os

#feed command to vlc socket to get the time played in seconds
workingdir = os.path.join(os.path.expanduser('~'))
vlcin = os.path.join(workingdir,'vlc.sock')
vlcout = os.path.join(workingdir,'vlc.out')

#accept argument when running script, e.g. './vlctimestamp.py timestamp'
args = sys.argv[1:]
i = "normal"
if args:
i = str.lower(args[0])

#acceptable arguments: help, --help, pause, jogforward, +5, jogbackward, -5,
#faster, slower, normal, timestamp. no argument assumes 'normal'
if i == "help" or i == "-help" or i == "--help":
print("""
'help' or '--help' returns this help
'pause' is a play/pause toggle
'jogforward' or '+5' jumps forward 5 seconds
'jogbackward' or '-5' jumps backward 5 seconds
'faster' increases the tempo without increasing pitch
'slower' decreases the tempo without decreasing pitch
no argument or 'normal' returns vlc to normal speed
'timestamp' types a hh:mm:ss coded timestamp into
active window. see comments within this
script if you need to change the timestamp
string, offset the timestamp for a video
timecode, or if you've made tempo changes
in an audio file outside of vlc
""")

elif i == "jogforward" or i == "+5":
os.system('echo "key key-jump+extrashort" | nc.openbsd -U ' + vlcin)

elif i == "jogbackward" or i == "-5":
os.system('echo "key key-jump-extrashort" | nc.openbsd -U ' + vlcin)

elif i == "pause":
os.system('echo "pause" | nc.openbsd -U ' + vlcin)

elif i == "faster":
os.system('echo "key key-rate-faster-fine" | nc.openbsd -U ' + vlcin)

elif i == "slower":
os.system('echo "key key-rate-slower-fine" | nc.openbsd -U ' + vlcin)

elif i == "normal":
os.system('echo "normal" | nc.openbsd -U ' + vlcin)

elif i == "timestamp":
#have vlc post the time ~/vlc.out
os.system('echo "get_time" | nc.openbsd -U ' + vlcin + ' > ' + vlcout)

#read vlc.out and report time played in seconds
f = open(vlcout, 'r')
f_list = f.read().split("\n")
if len(f_list) > 2:
sec = f_list[1]
else:
sec = f_list[0]
sec = int(sec)

#tempo - if you've adjusted the tempo of an audio file, in
# audacity for instance, then you can use the tempo
# variable to give output for a timestamp postion in
# original file. tempo is the percent playback speed
# of the modified file. 80 = -20% tempo change, etc.
# default is 100
tempo = 100

#don't change this. if you need an offset, take care of it below
offset = 0

#change offsetneeded to True if, for instance, you need to
#use a timecode embedded into a video rather than the playtime
#of the file
offsetneeded = False

if offsetneeded == True:

#If an offset is needed:
#Pick a spot on the video and pause it (not the beginning). Enter the appropriate values below:
#vtch = hours on video time code, vtcm = minutes, vtcs = seconds
vtch = 0
vtcm = 0
vtcs = 0
vtc = (vtch * 3600) + (vtcm * 60) + vtcs
#atch = hours in actual playtime, atcm = minutes,
#atcs = seconds
atch = 0
atcm = 0
atcs = 0
atc = ((((atch * 3600) + (atcm * 60) + atcs) * tempo) / 100)
offset = vtc - atc

#get the values for hh:mm:ss formatting
sec = ((sec * tempo) / 100) + offset
th = sec/3600
tm = (sec % 3600)/60
ts = sec % 60

#format the timestamp, default looks like '##Inaudible 00:01:10## '
#the timestamp in hours:minutes:seconds
t = "%02d:%02d:%02d" % (th,tm,ts)

#string to append before timestamp
#for no prefix, set prefix = ""
prefix = "##Inaudible "
#string to append after timestamp
#for no suffix, set suffix = ""
suffix = "## "

#xdotool command to execute, uncomment next line to use xdotool
#dropstamp = str("xdotool type --delay 0 --clearmodifiers '" + prefix + t + suffix + "'")
#
#drop the timestamp string into active window, uncomment next line to use xdotool
#os.system(dropstamp)
#
#use xte from the xautomation package if you don't have a version of
#xdotool newer than august 2010
os.system('xte "str ' + prefix + t + suffix + '"')

#if we don't feed an argument to the script, normalize the play speed of vlc
else:
os.system('echo "normal" | nc.openbsd -U ' + vlcin)
</pre>
 

'''VLCCONTROL-SOCAT.PY:'''

 Below you'll find a version of the original script that was modified to use socat, instead of the OpenBSD netcat build. This should, hopefully, make the script readily available to more people, quicker. The same instructions--make it executable with the command 'chmod 700 vlccontrol-socat.py'--apply.

 <code></code>
<pre>#!/usr/bin/env python
#### licensing nonsense - short version: New BSD License
#Copyright (c) 2010, Derek Barnett, Skyehaven Transcription
#Contact: derek at skyehaven.net
#All rights reserved.
#Redistribution and use in source and binary forms, with or
#without modification, are permitted provided that the following
#conditions are met:
#
# * Redistributions of source code must retain the above
#copyright notice, this list of conditions and the following
#disclaimer.
# * Redistributions in binary form must reproduce the above
#copyright notice, this list of conditions and the following
#disclaimer in the documentation and/or other materials provided
#with the distribution.
# * Neither the name of the Skyehaven Transcription nor the
#names of its contributors may be used to endorse or promote
#products derived from this software without specific prior
#written permission.
#
#THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND
#CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
#INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
#MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
#DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
#CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
#SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
#LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
#USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
#AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
#LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
#IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
#THE POSSIBILITY OF SUCH DAMAGE.
#####

##### useful notes
#vlc control script, compatible with python 2 or 3
#
#this script requires the openbsd version of netcat. gnu's version
#does not appear to support unix sockets as of this time. it will
#almost certainly be in the repos of your distribution. you may need
#to adjust this script to change the name of the binary to whatever
#format your distribution uses (change 'nc.openbsd' below to whatever
#you need.)
#
#it also requires either xautomation (for it's xte tool) or xdotool
#xautomation is used by default, as it's currently a bit faster
#if you use xdotool, ensure that it's a version later than aug 2010
#
#to set up vlc to use this script, go to tools->preferences and
#click on "show settings->all" at the bottom. from that menu,
#select "Interface->Main Interfaces", and check the "Remote Control
#Interface" box. Next, select "Interface->Main Interfaces->RC",
#check the "Fake TTY' box, and enter 'home/YOURNAME/vlc.sock'in
#the "UNIX socket command input" field.
#
#You probably also want to adjust the "Very short jump length" located
#in "Interface->Hotkeys settings". This script assumes that it is set
#for 5 seconds rather than the default of 3 seconds. It won't affect the
#script if you don't change this value, as it uses the 'very short jump'
#command rather than jogging a specific number of seconds. If you poke
#around the vlc docs, you'll see a seek command, but that is to go to a
#certain point in a file rather than going forward or backward a certain
#number of seconds.
#
#Hit "Save". Restart VLC, and check to see if it creates "vlc.sock"
#in your home directory. This should be created automatically when vlc
#starts. If it doesn't, check your socket path and try again.
#
#Next, you need to set up your hotkeys for your window environment.
#This should work equally well in any window manger, so pick whichever
#you like. Remember to check to make sure that whichever hotkeys you wish
#to use are not already used by your windowmanager. Redefine these
#hotkeys or the defaults as necessary.
#
#note: vlc supposedly support global hotkeys, but I didn't have any luck
#with them, which is why i went this route with the control script. Your
#mileage may vary.
#
#I personally set it up like this:
#F1 = ~/vlccontrol-socat.py jogbackward
#F2 = ~/vlccontrol-socat.py pause (no need to have this twice, just habit)
#F3 = ~/vlccontrol-socat.py pause
#F4 = ~/vlccontrol-socat.py jogforward
#F5 = ~/vlccontrol-socat.py timestamp
#Shift+F1 = ~/vlccontrol-socat.py slower
#Shift+F3 = ~/vlccontrol-socat.py normal
#Shift+F4 = ~/vlccontrol-socat.py faster
##### end of rambling, on to business...

#Not quite... (Anoter quick note from the person who modified the script for socat): If you
#look closely, I've added a couple extra controls to this, namely medium jumps forward
#and backward. VLC actually offers a range of commands for you to play with. If you'd
#like to add additional controls to the script, simply do an on-page search for "Hot Keys"
#here: [http://wiki.videolan.org/VLC_command-line_help]

import sys
import os

#feed command to vlc socket to get the time played in seconds
workingdir = os.path.join(os.path.expanduser('~'))
vlcin = os.path.join(workingdir,'vlc.sock')
vlcout = os.path.join(workingdir,'vlc.out')

#accept argument when running script, e.g. './vlctimestamp.py timestamp'
args = sys.argv[1:]
i = "normal"
if args:
i = str.lower(args[0])

#acceptable arguments: help, --help, pause, jogforward, +5, jogbackward, -5,
#faster, slower, normal, timestamp. no argument assumes 'normal'
if i == "help" or i == "-help" or i == "--help":
print("""
'help' or '--help' returns this help
'pause' is a play/pause toggle
'jogforward' or '+5' jumps forward 5 seconds
'jogbackward' or '-5' jumps backward 5 seconds
'faster' increases the tempo without increasing pitch
'slower' decreases the tempo without decreasing pitch
no argument or 'normal' returns vlc to normal speed
'timestamp' types a hh:mm:ss coded timestamp into
active window. see comments within this
script if you need to change the timestamp
string, offset the timestamp for a video
timecode, or if you've made tempo changes
in an audio file outside of vlc
""")

elif i == "jogforward" or i == "+5":
os.system('echo "key key-jump+extrashort" | socat - unix:' + vlcin)

elif i == "jogbackward" or i == "-5":
os.system('echo "key key-jump-extrashort" | socat - unix:' + vlcin)

elif i == "jumpforward" or i == "+10":
os.system('echo "key key-jump+medium" | socat - unix:' + vlcin)

elif i == "jumpbackward" or i == "-10":
os.system('echo "key key-jump-medium" | socat - unix:' + vlcin)

elif i == "pause":
os.system('echo "pause" | socat - unix:' + vlcin)

elif i == "faster":
os.system('echo "key key-rate-faster-fine" | socat - unix:' + vlcin)

elif i == "slower":
os.system('echo "key key-rate-slower-fine" | socat - unix:' + vlcin)

elif i == "normal":
os.system('echo "normal" | socat - unix:' + vlcin)

elif i == "timestamp":
#have vlc post the time ~/vlc.out
os.system('echo "get_time" | socat - unix:' + vlcin + ' > ' + vlcout)

#read vlc.out and report time played in seconds
f = open(vlcout, 'r')
f_list = f.read().split("\n")
if len(f_list) > 2:
sec = f_list[1]
else:
sec = f_list[0]
sec = int(sec)

#tempo - if you've adjusted the tempo of an audio file, in
# audacity for instance, then you can use the tempo
# variable to give output for a timestamp postion in
# original file. tempo is the percent playback speed
# of the modified file. 80 = -20% tempo change, etc.
# default is 100
tempo = 100

#don't change this. if you need an offset, take care of it below
offset = 0

#change offsetneeded to True if, for instance, you need to
#use a timecode embedded into a video rather than the playtime
#of the file
offsetneeded = False

if offsetneeded == True:

#If an offset is needed:
#Pick a spot on the video and pause it (not the beginning). Enter the appropriate values below:
#vtch = hours on video time code, vtcm = minutes, vtcs = seconds
vtch = 0
vtcm = 0
vtcs = 10
vtc = (vtch * 3600) + (vtcm * 60) + vtcs
#atch = hours in actual playtime, atcm = minutes,
#atcs = seconds
atch = 0
atcm = 0
atcs = 0
atc = ((((atch * 3600) + (atcm * 60) + atcs) * tempo) / 100)
offset = vtc - atc

#get the values for hh:mm:ss formatting
sec = ((sec * tempo) / 100) + offset
th = sec/3600
tm = (sec % 3600)/60
ts = sec % 60

#format the timestamp, default looks like '##Inaudible 00:01:10## '
#the timestamp in hours:minutes:seconds
t = "%02d:%02d:%02d" % (th,tm,ts)

#string to append before timestamp
#for no prefix, set prefix = ""
prefix = "["
#string to append after timestamp
#for no suffix, set suffix = ""
suffix = "] "

#xdotool command to execute, uncomment next line to use xdotool
#dropstamp = str("xdotool type --delay 0 --clearmodifiers '" + prefix + t + suffix + "'")
#
#drop the timestamp string into active window, uncomment next line to use xdotool
#os.system(dropstamp)
#
#use xte from the xautomation package if you don't have a version of
#xdotool newer than august 2010
os.system('xte "str ' + prefix + t + suffix + '"')

#if we don't feed an argument to the script, normalize the play speed of vlc
else:
os.system('echo "normal" | socat - unix:' + vlcin)
</pre>
 

 '''OTHER THINGS YOU MIGHT CARE TO KNOW IF YOU'VE MADE IT THIS FAR:'''

There are a couple of things in the script which you ought to know about if you do transcription regularly enough to care about these sorts of things.

 Within the script, you'll find settings for 'tempo' and 'offset'. Most people aren't going to need to worry about either of these and can just leave them as they sit. However, if you do alot of transcription, it's likely you'll find these to be of some value.

 The tempo setting does not refer to VLC's speed adjustment, rather it's is used if you have edited an audio file in an external editor, like audacity, and changed the tempo of the audio and created a new audio file based on that. The 'tempo' variable is a percentage of the original audio, so at full speed, you'll want 'tempo = 100'. If you slow it down 20%, you'll want 'tempo = 80', or 'tempo = 175' if you've sped it up 75%. By using this, you can get a timestamp for the spot in the full speed audio file, and won't need to go back through it later and correct your timestamps (it's always a good idea to do a couple of spot checks, just in case.) You DO NOT need to change this tempo variable if you are only adjusting the speed within VLC, it takes care of itself.

 The 'offset' section is useful if you are editing a video file which has an OSD timecode which you need to timestamp, rather than the playtime of the file. Again, this is not something you should need to mess with unless you have a specific use for it. If you do have a use for it, keep in mind that occasionally there will be edits that have been made to the video which will throw off your offest, so to speak. Unfortunately there's no real easy way to deal with this problem that I'm aware of, you simply have to keep an eye on the difference and adjust it as needed. Again, spot checks are always a good idea.

 In order to set the script up to properly offset your video, pick a spot somewhere in the video which is not at the beginning, and then enter in the appropriate values. For instance, if we have a video file which at 01:23:45 play time on the file has an OSD timecode of 12:34:56, you'll enter the values like this:

offsetneeded = True
vtch = 12 <--hours on the video timecode
vtcm = 34 <--minutes on the video timecode
vtcs = 56 <--seconds on the video timecode

atch = 1 <---don't use a leading 0, or the script will puke
atcm = 23 <--minutes on the playback time
atcs = 45 <--seconds on the playback time

 You can use offset with the tempo settings. Don't use the video timecode at 00:00:00 on the playback time, or the calculation will be off. Check the difference between the video timecode and the playback time at the beginning and end of your file to see if it's consistent, as that will tell you if there have been any edits made. If there are edits, just change the offset numbers when you get to those points.

 Finally, variable bit rates are a pain for transcription. You'll get files which simply won't behave in a useful manner when you try and jog backward, et cetera. You can try converting those files to ogg format, and that generally solves the problem.

* More of [[VLC HowTo|VLC HowTo]]
 If you have any questions about this, I can be reached at derek at skyehaven.net.

[[Category:How_To]]

HowTo Integrate VLC plugin in your webpage

2011-11-28T12:32:37Z

Chrisberov: /* Embedding the VLC plugin in your webpage */

== Embedding the VLC plugin in your webpage ==

The VLC plugin can be directly embedded in your webpage :

<embed type="application/x-vlc-plugin" name="player" autoplay="no" loop="no" target="udp:@239.255.12.42" />

You then have to use the official Mozilla/ActiveX api documented here : http://wiki.videolan.org/Documentation:WebPlugin

But, if you need '''controls''' (buttons, slidebar...), you have to use the '''open source revolunet VLCcontrols''' library.

* the code resides @github : https://github.com/revolunet/VLCcontrols
* you have some demo here : http://revolunet.github.com/VLCcontrols

Usage exemple :


<script language="javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.4.2/jquery.min.js"></script>
<script language="javascript" src="http://revolunet.github.com/VLCcontrols/src/jquery-vlc.js"></script>
<link rel="stylesheet" type="text/css" href="http://revolunet.github.com/VLCcontrols/src/styles.css" />

<script language="javascript">
var player = VLCobject.embedPlayer('vlc1', 400, 300);
player.play('http://download.blender.org/peach/bigbuckbunny_movies/big_buck_bunny_480p_surround-fix.avi');
</script>

Note the fullscreen is currently broken in VLC plugin itself (VLC>1.1)

* More of [[VLC HowTo|VLC HowTo]]

Hacker Guide/Audio Filters

2011-11-28T12:18:20Z

Chrisberov: /* Overview */

=Overview=
* [[Hacker Guide|Back to Hacker Guide]]

=Writing an audio filter=

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

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

==Mandatory structures==
*aout_filter_sys_t

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

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

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

==Note==

Audio filters can be of three types :

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

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

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

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

=Writing an audio mixer=

Writing an audio mixer is very similar to writing an audio filter. The only difference is that you have to deal with the input buffers yourself, and request for new buffers when you need to. Between two calls to pf_do_work, the position in the buffer is remembered in p_input->p_first_byte_to_mix (it isn't always the start of the buffer, since input and output buffers can be of different length). It is your job to set this pointer at the end of pf_do_work.

For more details, please have a look at the float32 mixer. It's much more understandable than lines of documentation.

Hacker Guide/Audio Filters

2011-11-28T12:16:37Z

Chrisberov: /* Overview */

=Overview=
* [[Hacker Guide|Hacker Guide]]

=Writing an audio filter=

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

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

==Mandatory structures==
*aout_filter_sys_t

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

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

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

==Note==

Audio filters can be of three types :

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

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

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

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

=Writing an audio mixer=

Writing an audio mixer is very similar to writing an audio filter. The only difference is that you have to deal with the input buffers yourself, and request for new buffers when you need to. Between two calls to pf_do_work, the position in the buffer is remembered in p_input->p_first_byte_to_mix (it isn't always the start of the buffer, since input and output buffers can be of different length). It is your job to set this pointer at the end of pf_do_work.

For more details, please have a look at the float32 mixer. It's much more understandable than lines of documentation.

DVD

2011-11-28T12:11:46Z

Chrisberov:

{{wikipedia|DVD}}
'''DVD''' is an acronym for '''Digital Video Disc''', a 12cm plastic disc which contains audio and video content in optically-readable digital form. [[VLC media player|VLC]] has extensive capabilities to read and master DVDs.

SoC 2011

2011-11-28T12:00:59Z

Chrisberov: /* Automatic LibVLC bindings generation */

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

[[Category:SoC_2011_Project|Accepted projects]] can be found on a [[Category:SoC_2011_Project|separate page]].

== 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.
* [[SoC 2011/Generator of libVLC bindings for other languages|Generator of libVLC bindings for other languages]]

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

Talk:Modules source tree

2011-11-28T11:33:48Z

Chrisberov: Redirected page to Talk:Hacker Guide/Modules source tree

#REDIRECT [[Talk:Hacker Guide/Modules source tree]]

Documentation Talk:Hacker's Guide/Module Writers Guide

2011-11-28T11:33:33Z

Chrisberov: Redirected page to Talk:Hacker Guide/How To Write a Module

#REDIRECT [[ Talk:Hacker Guide/How To Write a Module]]

Talk:Hacker Guide/Module Writers Guide

2011-11-28T11:33:14Z

Chrisberov: Redirected page to Talk:Hacker Guide/How To Write a Module

#REDIRECT [[ Talk:Hacker Guide/How To Write a Module]]

Modules source tree

2011-11-28T11:32:55Z

Chrisberov: Redirected page to Hacker Guide/Modules source tree

#REDIRECT [[ Hacker Guide/Modules source tree]]

VLM Internals

2011-11-28T11:32:37Z

Chrisberov: Redirected page to Hacker Guide/VLM Internals

#REDIRECT [[ Hacker Guide/VLM Internals]]

Documentation:Hacker's Guide/Module Writers Guide

2011-11-28T11:32:18Z

Chrisberov: Redirected page to Hacker Guide/How To Write a Module

#REDIRECT [[ Hacker Guide/How To Write a Module]]

Module Writers Guide

2011-11-28T11:31:58Z

Chrisberov: Redirected page to Hacker Guide/How To Write a Module

#REDIRECT [[Hacker Guide/How To Write a Module]]

Plugin Writers Guide

2011-11-28T11:31:43Z

Chrisberov: Redirected page to Hacker Guide/How To Write a Module

#REDIRECT [[Hacker Guide/How To Write a Module]]

LibVLCcore

2011-11-28T11:31:25Z

Chrisberov: Redirected page to Hacker Guide/Core

#redirect[[ Hacker Guide/Core]]

Documentation:Hacker's Guide/Audio Mixers

2011-11-28T11:31:07Z

Chrisberov: Redirected page to Hacker Guide/Audio Filters

#redirect[[Hacker Guide/Audio Filters]]

Documentation:Hackers Guide

2011-11-28T11:30:26Z

Chrisberov: Redirected page to Hacker Guide

#redirect[[ Hacker Guide]]

Documentation:Hacker's Guide/Introduction

2011-11-28T11:30:11Z

Chrisberov: Redirected page to Hacker Guide

#REDIRECT [[ Hacker Guide]]

Talk:Mini Projects

2011-11-28T11:29:39Z

Chrisberov: Redirected page to Talk:VLC Dev Projects

#REDIRECT [[ Talk:VLC Dev Projects]]

Documentation Talk:Hacker's Guide/Module Writers Guide

2011-11-28T11:28:51Z

Chrisberov: Redirected page to Documentation Talk:Hacker's Guide/How To Write a Module

#REDIRECT [[Documentation Talk:Hacker's Guide/How To Write a Module]]

Mini Projects

2011-11-28T11:28:26Z

Chrisberov: Redirected page to VLC Dev Projects

#REDIRECT [[VLC Dev Projects]]

Module

2011-11-28T11:27:45Z

Chrisberov: Redirected page to Documentation:Modules

#redirect[[‎Documentation:Modules]]

Containers

2011-11-28T11:26:47Z