Difference between revisions of "SoC 2011/OpenGL Interface for VLC"

From VideoLAN Wiki
Jump to navigation Jump to search
(Video description, add screenshot)
 
(15 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
==Abstract==
 
==Abstract==
  
−
A nice looking, intuitive, effect-oriented OpenGL interface for the VLC Media Player. It should combine the utility of the current Qt interface with the graphics of media centers. OpenGL will be used for all rendering operations for the interface, bringing a wide range of possibilities to develop pretty graphics. All the user interface elements will be specialized according to the needs of the VLC interface.  
+
A nice looking, intuitive, effect-oriented OpenGL interface for the VLC Media Player. It should combine the utility of the current Qt interface with the graphics of media centers. OpenGL will be used for all rendering operations for the interface, bringing a wide range of possibilities to develop pretty graphics. All the user interface elements will be specialized according to the needs of the VLC interface.
 +
 
 +
==Progress==
 +
{|
 +
|-
 +
! scope="col" width="500" | Task
 +
! Progress
 +
|-
 +
| Establish a primitive working interface module.
 +
| style="color: green" | Done
 +
|-
 +
| Create a basic OpenGL "engine" for the interface.
 +
| style="color: green" | Done
 +
|-
 +
| Additional planning and design
 +
| style="color: green" | Done
 +
|-
 +
| Work on the layout system.
 +
| style="color: green" | Done
 +
|-
 +
| Develop basic widgets and basic input
 +
| style="color: green" | Done
 +
|-
 +
| Basic play functionality (primitive playlist)
 +
| style="color: green" | Done
 +
|-
 +
| Selector / navigation, media library
 +
| style="color: green" | Done
 +
|-
 +
| More work on the media library + playlist view (current item, tree view)
 +
| style="color: green" | Done
 +
|-
 +
| Ensure scrolling around the playlist without problems
 +
| style="color: green" | Done
 +
|-
 +
| Open media dialogs, use a dialog provider
 +
| style="color: green" | Done
 +
|-
 +
| Text rendering using a VLC text renderer module
 +
| style="color: green" | Done
 +
|-
 +
| Play video, ensure layout transitions work smoothly
 +
| style="color: green" | Done
 +
|-
 +
| Implement basic effects for everything
 +
| style="color: green" | Done
 +
|-
 +
| Improve playlist item, add details
 +
| Planned
 +
|-
 +
| Add more effects as much as possible
 +
| No time
 +
|-
 +
| Nice play button, volume slider, stop, next, prev buttons
 +
| style="color: green" | Done
 +
|-
 +
| Further improvements on the playlist, display more meta-data
 +
| Planned
 +
|-
 +
| Lirc input
 +
| Planned
 +
|-
 +
| Extra buttons, improve media library
 +
| Planned
 +
|-
 +
| Fullscreen mode and search / filter
 +
| Planned
 +
|-
 +
| Implement missing features and general improvements
 +
| style="color: green" | Done
 +
|}
 +
 
 +
== Planning and Design ==
 +
 
 +
The interface has 3 main parts - user input, GUI (widgets in OpenGL), functionality (interaction with VLC).
 +
 
 +
User -> user input -> GUI <-> VLC
 +
 
 +
User <- GUI <-> VLC
 +
 
 +
For video, a vout display submodule is provided. It uses helpers from vout display opengl. But all the drawing must be done by the run thread, the one with the OpenGL context. It looks like it works okay, but there are some problems with it's responsiveness on display requests - needs to be improved.
 +
 
 +
===Classes===
 +
Main:
 +
* GLIntf (module code, create main things) (not a class, it's like C code)
 +
* MainInterface (centralizes the others, issues drawing and updates)
 +
 
 +
User Input:
 +
* UserInputMonitor (handles input from multiple possible sources)
 +
* AbstractUserInput (base class for an input type)
 +
* SDLUserInput (input from SDL events - touch / mouse, keys)
 +
* LircInput (buttons from remote control) - planned
 +
 
 +
Widgets:
 +
* Widget (base class for every widget)
 +
* Layout (sets positions, sizes of multiple widgets)
 +
* DynamicLayout (layout that can transition smoothly)
 +
* Container (a widget that can contain other widgets and has a layout)
 +
* ScrollableContainer (a container with scrolling possibilities)
 +
* ScrollBar
 +
* PlaylistBrowser (the playlist)
 +
* PlaylistItem (an item from the playlist)
 +
* SelectorPanel (choose Media Library, Internet, etc.)
 +
* SelectorItem (item for selecting media sources ^)
 +
* Button (base class for a button)
 +
* Label (draws text)
 +
* MenuPanel
 +
* PlayPanel
 +
* PlayButton, VolumeWidget, StopButton, PrevButton, NextButton
 +
* SeekSlider
 +
* VideoWidget ("holds" the video)
 +
* FilterEdit - planned
 +
 
 +
Functionality:
 +
* PlaylistManager (like MainInputManager from Qt interface)
 +
* InputManager (like InputManager from Qt interface)
 +
* Dialogs (to handle showing dialogs using a dialog provider)
 +
 
 +
Effects:
 +
* AbstractEffect (a generic effect)
 +
* LinTransitionEffect
 +
* ExpTransitionEffect
 +
* ColorTransitionEffect
 +
 
 +
Other:
 +
* TextCache
 +
* TexPicture
 +
* EventQueue
 +
 
 +
===GUI Sketches===
 +
* [http://img13.imageshack.us/img13/2203/glvlc.png Normal layout, nothing special. Large playlist items]
 +
* [http://img218.imageshack.us/img218/774/glvlcvideo.png Video playing layout]
 +
* [http://img35.imageshack.us/img35/6305/glvlcvideofull.png Fullscreen layout]
 +
* [http://img35.imageshack.us/img35/6703/glvlcscale.png Normal layout, small items]
 +
 
 +
===Screenshots===
 +
* [http://img812.imageshack.us/img812/9286/glintf1.png Basic media library view]
  
 
==Repository==
 
==Repository==

Latest revision as of 12:33, 22 August 2011

This project is part of Google Summer of Code 2011.
Student: Casian Andrei
Mentor: Ludovic Fauvet

Abstract

A nice looking, intuitive, effect-oriented OpenGL interface for the VLC Media Player. It should combine the utility of the current Qt interface with the graphics of media centers. OpenGL will be used for all rendering operations for the interface, bringing a wide range of possibilities to develop pretty graphics. All the user interface elements will be specialized according to the needs of the VLC interface.

Progress

Task Progress
Establish a primitive working interface module. Done
Create a basic OpenGL "engine" for the interface. Done
Additional planning and design Done
Work on the layout system. Done
Develop basic widgets and basic input Done
Basic play functionality (primitive playlist) Done
Selector / navigation, media library Done
More work on the media library + playlist view (current item, tree view) Done
Ensure scrolling around the playlist without problems Done
Open media dialogs, use a dialog provider Done
Text rendering using a VLC text renderer module Done
Play video, ensure layout transitions work smoothly Done
Implement basic effects for everything Done
Improve playlist item, add details Planned
Add more effects as much as possible No time
Nice play button, volume slider, stop, next, prev buttons Done
Further improvements on the playlist, display more meta-data Planned
Lirc input Planned
Extra buttons, improve media library Planned
Fullscreen mode and search / filter Planned
Implement missing features and general improvements Done

Planning and Design

The interface has 3 main parts - user input, GUI (widgets in OpenGL), functionality (interaction with VLC).

User -> user input -> GUI <-> VLC

User <- GUI <-> VLC

For video, a vout display submodule is provided. It uses helpers from vout display opengl. But all the drawing must be done by the run thread, the one with the OpenGL context. It looks like it works okay, but there are some problems with it's responsiveness on display requests - needs to be improved.

Classes

Main:

  • GLIntf (module code, create main things) (not a class, it's like C code)
  • MainInterface (centralizes the others, issues drawing and updates)

User Input:

  • UserInputMonitor (handles input from multiple possible sources)
  • AbstractUserInput (base class for an input type)
  • SDLUserInput (input from SDL events - touch / mouse, keys)
  • LircInput (buttons from remote control) - planned

Widgets:

  • Widget (base class for every widget)
  • Layout (sets positions, sizes of multiple widgets)
  • DynamicLayout (layout that can transition smoothly)
  • Container (a widget that can contain other widgets and has a layout)
  • ScrollableContainer (a container with scrolling possibilities)
  • ScrollBar
  • PlaylistBrowser (the playlist)
  • PlaylistItem (an item from the playlist)
  • SelectorPanel (choose Media Library, Internet, etc.)
  • SelectorItem (item for selecting media sources ^)
  • Button (base class for a button)
  • Label (draws text)
  • MenuPanel
  • PlayPanel
  • PlayButton, VolumeWidget, StopButton, PrevButton, NextButton
  • SeekSlider
  • VideoWidget ("holds" the video)
  • FilterEdit - planned

Functionality:

  • PlaylistManager (like MainInputManager from Qt interface)
  • InputManager (like InputManager from Qt interface)
  • Dialogs (to handle showing dialogs using a dialog provider)

Effects:

  • AbstractEffect (a generic effect)
  • LinTransitionEffect
  • ExpTransitionEffect
  • ColorTransitionEffect

Other:

  • TextCache
  • TexPicture
  • EventQueue

GUI Sketches

Screenshots

Repository

Repo

http://git.videolan.org/?p=vlc/vlc-skelet.git;a=summary

git://git.videolan.org/vlc/vlc-skelet.git

Backup Repo

git://repo.or.cz/vlc/vlc-skelet.git

http://repo.or.cz/r/vlc/vlc-skelet.git

Contact

You can reach me at skeletk13 at gmail or as skelet on IRC. Any suggestions are welcome.

Retrieved from "https://wiki.videolan.org/index.php?title=SoC_2011/OpenGL_Interface_for_VLC&oldid=19541"