XBMC will be renamed to Kodi for v14. Read here for more details

XBMC Online Manual, Google Summer of Code/2008

From XBMC
(Difference between pages)
Jump to: navigation, search
m
 
(Applying)
 
Line 1: Line 1:
{{XBMC wiki toc Inline}}
+
'''XBMC has been accepted in to the Google Summer of Code 2008!'''
__NOEDITSECTION__
+
{{Current event}}
__NOTOC__
+
Google is sponsoring their forth annual [http://code.google.com/soc/ Summer of Code (GSoC)] in the summer of 2008, this entail sponsoring students to work on assorted open source projects as well as sponsoring mentors in those same projects, everyone wins! XBMC has been selected as one of the approved mentoring organizations for this year's GSoC. This page will be used for possible project ideas for the [http://code.google.com/soc/2008 Google Summer of Code 2008 season], and also track the status of each project and how well each student is doing.
The '''XBMC Online Manual''' is composed solely of contributions by the members of the XBMC community, and so remains incomplete. This manual may document functionality that appears only in the XBMC [[SVN]], and not yet in point releases. If your version seems to be missing a feature, check the full [http://xbmc.svn.sourceforge.net/viewvc/xbmc/trunk/XBMC/?view=log changelog] to see whether the feature is newer than the build of XBMC that you are currently running.  Note that as of April 3, 2011, the current build of XBMC is version 10.1 (Dharma).
+
  
XBMC always has been and always will be a community effort, and so with its documentation. Created to consolidate vast amounts of information accrued over the years, this manual was created and is updated through the perspiration of many. Feel free to contribute in any way that you can. If something's missing, add it. If something's jacked up, fix it.  
+
The administrator for this year's XBMC Summer of Code is [[User:Gamester17|Andreas Setterlind (a.k.a. Gamester17)]]
  
We have disabled anonymous editing and creating of wiki articles because of vandalism. Please register to edit existing pages, then follow our editing and formatting standards, as described in the [[Help:Contents|wiki help section]]. Editors may want to keep an eye on the [[Special:Recentchanges|Recent Changes]] and [[Special:Newpages|Newest Pages]] articles. Check the [[Special:Wantedpages|Wanted Pages]] to see what is most needed. If you are unsure whether you should put some information in here, feel free to drop by [irc://irc.freenode.net/xbmc #xbmc on freenode] [http://www.zbsports.com/ Five Fingers].  
+
:NOTE! '''If you are a student''' who wishes to be '''involved with an XBMC GSoC project''', one of the first and best steps you can take is to register an account on [http://forum.xbmc.org XBMC community forum], (sooner rather than later), and indicate your interest. Also, make sure that you '''complete''' a qualification task as soon as possible to be eligible for a XBMC SoC project, (no qualification task = no project, that is Team-XBMC policy, not Google).
  
This manual was written using the default skin, Confluence, and uses the default keymapping for consistency.
+
==Introduction to XBMC==
 +
XBMC (formerly "XBox Media Center") is a free and open source (GPL) cross-platform media player and entertainment hub software. XBMC was originally established in 2002 and in the beginning developed as XBox Media Player (XBMP) for the first-generation Xbox game-console. XBMC has since been ported to also run natively under Linux, Mac OS X, and Microsoft Windows operating-system. XBMC has so far been translated to over 30 languages, won two SourceForge Community Choice Awards, (Best Multimedia Project and Best Game Project back in 2006), and today XBMC has a very broad international community of active developers, graphic artists, and devoted users.
  
'''Questions, comments, insults? See the [[Team XBMC and Others|Management]].'''
+
*'''[[HOW-TO compile XBMC for Linux from source code|XBMC for Linux]]''' (see the [[XBMC for Linux port project]] for more information)
 +
*'''[[HOW-TO compile XBMC for Mac OS X from source code|XBMC for Mac OS X]]''' (see the [[XBMC for Mac OS X port project]] for more information)
 +
*'''[[HOW-TO compile XBMC for Windows from source code|XBMC for Windows]]''' (see the [[XBMC for Windows port project]] for more information)
 +
*'''[[HOW-TO compile XBMC for Xbox from source code|XBMC for Xbox]]'''
  
The following table of contents is duplicated on the right side of each page.
+
===Developing XBMC===
 +
The XBMC code structure uses a fairly modular design (with libraries and DLLs) who's structure is large, though relatively easy to grasp. XBMC's source code is predominantly C++, though there is a small splattering of C libraries and assembler for good measure. XBMC for uses the Microsoft DirectX multimedia framework (Direct3D) on the Xbox, and the [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL (Simple DirectMedia Layer) framework with OpenGL rendering] for other operating-system platforms versions of XBMC, (ie. [[XBMC for Linux port project|Linux]], [[XBMC for Mac OS X port project|Mac OS X]], and [[XBMC for Windows port project|Microsoft Windows]]).
  
==[[Introduction]]==
+
The main XBMC program is developed using [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio Microsoft Visual Studio] for the Xbox and win32 builds, and there are [http://en.wikipedia.org/wiki/KDevelop KDevelop] project files for Linux, and [http://en.wikipedia.org/wiki/Eclipse_%28software%29 Eclipse]/[http://en.wikipedia.org/wiki/Xcode Xcode] project files for Mac OS X).  For the Xbox version a copy of the latest Microsoft Xbox SDK (a.k.a. XDK) is also required, though obviously this is not required for all other platforms.
*[[Introduction|About XBMC and The XBMC Project]]
+
*[[XBMC Features and Supported Formats/Codecs|XBMC Features and Supported Formats/Codecs]]
+
*[[XBMC Quick Start Guide]]
+
*[[Team XBMC and Others|Team-XBMC (The people behind XBMC)]]
+
==[[Setting Up XBMC]]==
+
*[[Install XBMC|Install XBMC]]
+
**[[Supported hardware]]
+
**[[Installing XBMC for Linux]]
+
**[[XBMC Live|Installing XBMC Live]]
+
***[[Installing Gentoo-XBMC on AppleTV]]
+
**[[Installing XBMC for Mac]]
+
**[[XBMC for Mac on Apple TV|Installing XBMC for Mac on Apple TV]]
+
**[[Install XBMC on ATV2|Installing XBMC for iOS on 2nd gen Apple TV]]
+
**[[Install XBMC on iPhone/iPad|Installing XBMC for iOS on iPhone/iPad]]
+
**[[Installing XBMC for Windows]]
+
*[[Media Sources]]
+
**[[Adding Media Sources|Add Media Sources]]
+
**[[Types of Media Sources|Types of Media Sources]]
+
**[[Configuring PC Shares|Sharing Media from Your PC]]
+
*[[Profiles|User Profiles]]
+
*[[The UserData Folder]]
+
*[[Advanced Configuration]]
+
*[[Add-ons]]
+
**[[HOW-TO install and use plugins in XBMC|Installing Plugins]]
+
**[[HOW-TO install and use scripts in XBMC|Installing Scripts]]
+
**[[HOW-TO install and switch between skins in XBMC|Installing Skins]]
+
==[[General Usage]]==
+
*[[Default Controls]]
+
*[[The User Interface]]
+
**[[General]]
+
**[[Programs]]
+
**[[Pictures]]
+
**[[Videos]]
+
**[[Music]]
+
**[[Weather]]
+
**[[Settings]]
+
**[[Plugins]]
+
**[[Scripts]]
+
**[[Filemanager]]
+
*[[The Web Interface]]
+
==[[Frequently Asked Questions]]==
+
*[[What is XBMC & What Can it Do?|What is XBMC and what can XBMC do?]]
+
*[[Obtaining XBMC]]
+
*[[Installing/Running/Updating/Uninstalling XBMC]]
+
*[[Using XBMC]]
+
*[[Troubleshooting|Troubleshooting problems in XBMC]]
+
*[[XBMC Forum FAQ]]
+
**[[Forum Usage Guidelines]]
+
*[[XBMC Live specific FAQ]]
+
*[[XBMC for Linux specific FAQ]]
+
*[[XBMC for Mac OS X specific FAQ]]
+
*[[XBMC for iOS specific FAQ]]
+
*[[XBMC for Windows specific FAQ]]
+
*[[XBMC for Xbox specific FAQ]]
+
==[[XBMC's Inner Workings]]==
+
*[[XBMC development|XBMC development (in general)]]
+
*[[XBMC for Linux|XBMC for Linux development]]
+
*[[XBMC for Mac|XBMC for Mac development]]
+
*[[XBMC for Windows|XBMC for Windows development]]
+
*[[Python Development|XBMC Python Development]]
+
**[[HOW-TO write plugins for XBMC|Creating Plugins]]
+
**[[HOW-TO write Python Scripts|Creating Scripts]]
+
**[[HOW-TO_debug_Python_Scripts_with_Eclipse|Debugging Python Scripts with Eclipse (multi-platform)]]
+
**[[HOW-TO_debug_Python_Scripts|Debugging Python Scripts on Linux with WinPDB]]
+
*[[Skinning XBMC|Skinning XBMC (making or modifying GUI skins)]]
+
*[[WebServerHTTP-API|The HTTP API (XBMC's Web Server HTTPAPI)]]
+
*[[EventServer|The EventServer API (and EventClients for it)]]
+
*[[The XBMC Database|XBMC's SQL databases (database libraries)]]
+
*[[Audio Players|Audio Players (and audio codecs/demuxers)]]
+
*[[Video Players|Video Players (and video codecs/demuxers)]]
+
==[[Appendices]]==
+
*[[Appendix A: References|References]]
+
*[[Appendix B: Troubleshooting|Troubleshooting]]
+
*[[Tips And Tricks|HOW-TOs / Tips & Tricks]]
+
*[[Appendix D: Development Notes|Development Notes]]
+
*[[Remote Control Reviews]]
+
*[[List of XBMC Addons]]
+
*[[Disclaimer]]
+
*[[Thanks]]
+
  
=[[Current events]]=
+
XBMC's code also contains three player cores: One core based on [[MPlayer]] that is only available to the Xbox version of XBMC, another [[DVDPlayer|in-house developed (FFmpeg-based) dedicated video-player core]] (which also supports DVD-Video movies with menus), and an [[PAPlayer|in-house developed dedicated music-player core]].
Actively ongoing sub-projects. Note that the information in these articles may change rapidly as the events progresses.
+
*[[Google Summer of Code 2010|Google Summer of Code 2010 (GSoC 2010)]]
+
**[[GSoC Qualification Tasks]]
+
**[[GSoC Proposal Ideas from Team-XBMC]]
+
*[[Google Summer of Code 2008]]
+
**[[GSoC - Unified PVR Frontend|GSoC - Unified PVR front-end with EPG]]
+
**[[GSoC - GPU Assisted Video Decoding]]
+
*[[Hardware Accelerated Video Decoding|GPU Hardware Accelerated Video Decoding]]
+
*[[Games Library Ideas|Games Library Ideas (Emulator Launcher)]]
+
  
[[category:XBMC Manual]]
+
:'''NOTE!''' For more detailed information on where to get started with XBMC development please see [[Appendix D: Development Notes|Appendix D (Development_Notes)]] in this wiki.
[[category:Introduction]]
+
 
 +
:'''TIP!''' [http://www.microsoft.com/Presspass/press/2008/feb08/02-18GSDPR.mspx Microsoft DreamSpark student program is currently (and over this summer) giving free access to their development software].
 +
 
 +
== How To Apply as a Student ==
 +
 
 +
===Before you can apply===
 +
Before you can apply make sure you are qualified to apply:
 +
* You have to know how to program in C++ (and know C) fairly well.
 +
* We would like you to first submit a small patch that fixes a bug or adds a feature to XBMC. By doing that we will know if you are qualified for the task or not. At the bottom of this page there will be a list of possible [[Google Summer of Code 2008#Qualification_tasks|Qualification Tasks]], specific ideas that could be performed to show your skill, however you are free to submit anything you feel might be of value to XBMC. The qualification task can be done after you have filed you application.
 +
* Submit a good application through the formal Google Summer of Code process during the application time frame.
 +
* You have to have >35 hours per week to put into the project.
 +
* You can not have another job at the same time as the SoC project.
 +
 
 +
===Applying===
 +
If you are interested in participating in the Google Summer of Code you will need to register at the official SoC site linked below and file an official application. Traditionally, the top applications are fairly detailed - you really need to sell yourself as well as your idea proposal. Look for example at this application [http://vfer.sourceforge.net/cgi-bin/index.cgi?page=writeup here] for inspiration. The official guide from Google can be found here:
 +
* [http://groups.google.com/group/google-summer-of-code-announce/web/guide-to-the-gsoc-web-app-for-student-applicants Guide to the Google Summer of Code Web Application for Student Applicants]
 +
* [http://code.google.com/soc/2008/student_step1.html Google Summer of Code - Student Signup]
 +
 
 +
:'''TIP!''' The [http://www.drupal.org/ Drupal] project has also prepared a couple of good guidelines that might be useful, see:
 +
* http://drupal.org/node/59037
 +
* http://drupal.org/node/59963
 +
 
 +
The application could have similar sections as in the following:
 +
Name:
 +
E-mail Address:
 +
Project Title:
 +
Project Goals:
 +
Project Benefits:  How does your project benefit XBMC and its community?
 +
Project Tasks and Deliverables: Break your project into tasks or pieces.
 +
    Describe in detail what you plan to accomplish and what the results will be.
 +
 
 +
Project Schedule:  Estimate how long your project will take and how much time you
 +
    have to dedicate on it. Try to establish a timed roadmap of the tasks to do.
 +
 
 +
Personal Statement:  Tell us about yourself.  Describe why you are better than any
 +
    other applicant for this project.
 +
 
 +
===Google SoC Development Process===
 +
Each accepted project will be developed in its own sandbox (SVN branch), separate from the main XBMC codebase. Naturally, the end goal of each of the accepted XBMC projects ought to be to have that code in shape for acceptance into the production codebase. This page will track the status of each project and how well each student are doing.
 +
 
 +
== Current Status ==
 +
* '''Next Big Date:''' March 24, 2008: Students may begin to submit applications through Google
 +
* March 17, 2008: Google is scheduled to announce selected projects; ''XBMC is selected''
 +
* March 11, 2008: Submitted XBMC project application
 +
* February 29, 2008: Created this wiki article
 +
 
 +
=== Schedule ===
 +
Official timeline: http://code.google.com/soc/2008/faqs.html#0.1_timeline
 +
* March 31, 2008: Student application deadline, students must have submitted their proposals through Google.
 +
* March 24-31, 2008: Students may submit applications for various Google Summer of Code projects.
 +
* March 17, 2008: Google announces accepted organizations at: http://code.google.com/soc/
 +
* March 3-12, 2008: Open source organizations may apply to the Google Summer of Code program.
 +
 
 +
== Project Proposals ==
 +
=== Overview ===
 +
Qualifications for a good Summer of Code proposal:
 +
* Discrete, well-defined, modular
 +
* Comprised of a series of measurable sub-goals
 +
* Based on open specs that are available free of charge
 +
* Based on complete specs
 +
An example of a good proposal is the implementation of a new feature or function that is not yet available in XBMC.
 +
 
 +
An example of a less desirable proposal is one that's not as measurable, such as refactoring an existing API. Bad proposals tend to be ones that would require touching a lot of core code.
 +
 
 +
To re-iterate:
 +
* Localized/isolated code projects = ''good''
 +
* Global code refactoring = ''bad''
 +
 
 +
=== Students Project Proposals ===
 +
Feel free to enter a link to your proposal here if you are a college student and you will apply to Google Summer of Code this year:
 +
 
 +
* [[GSoC Project - One common GUI front-end that can control multiple PVR/DVR/HTPC back-ends|One common GUI front-end that can control multiple PVR/DVR/HTPC back-ends]]
 +
**Proposed by student: '''Alcoheca'''
 +
**Proposed mentor: JMarshall
 +
 
 +
=== Projects with Mentors (official approved projects) ===
 +
* To come if and when Google accept the Students Project Proposals
 +
 
 +
=== Team-XBMC proposal ideas up for discussion ===
 +
Most of the proposals in this list are just some project ideas that we have been kicking around, (which, by no means, limits any prospective proposals). So you are more than welcome to come up with a new idea that you think falls into the scope of XBMC and the Google Summer of Code spirit. Since XBMC is cross-platform software most of these ideas are platform-independent, meaning that if you implement the feature/function on one operating-system platform then someone else will be able to port that feature/function to the other operating-system platforms that XBMC runs on.
 +
 
 +
'''NOTE!''' THIS LIST IS NOT THE FINAL PROPOSALS THAT WILL BE SUBMITTED. THESE ARE ONLY CONCEPTS THAT IDEAS COULD BE BASED UPON, IN THE END YOU AS THE STUDENT WILL BE PRESENTING THE IDEA AS YOUR '''OWN''', SO IT IS NOT ONLY THE IDEA BUT HOW '''YOU''' PRESENT IT, SO BE CREATIVE!
 +
 
 +
* [http://forum.xbmc.org/showthread.php?t=28918  PVR front-end GUI that is skinnable and a API can can support multiple HTPC/DVR/PVR-backend clients]
 +
* Skinnable [http://forum.xbmc.org/showthread.php?t=12948 XMLTV GUI (TV-Guide)] frontend in XBMC and a method of downloading new [http://xmltv.org listings.xml]
 +
** Suggest that either extend XBMC's [[Scraper.xml|Scraper API]] or use [[Python Scripts]] for downloading
 +
* PVR software support (API to control channel-swapping and stream Live-TV of a third-party backend)
 +
** [http://forum.xbmc.org/showthread.php?t=951 Linux VDR (Video Disk Recorder) client that can control a LinVDR server]
 +
** [http://forum.xbmc.org/showthread.php?t=5376 MediaPortal client to control MediaPortal back-end (TV-Server)]
 +
** [http://forum.xbmc.org/showthread.php?t=6636&highlight=mce+extender Windows Media Center Extender client that can control Microsoft Windows MCE]
 +
* Native DVB television in XBMC for Linux via [http://www.linuxtv.org/ v4l/v4l2 library] and FFmpeg (added to [[DVDPlayer|XBMC's in-house video-player]])
 +
**This would enable XBMC for Linux to display Live-TV and record TV without third-party backend.
 +
**[http://www.ffmpeg.org Latest FFmpeg SVN] already have [http://www.linuxtv.org/ v4l/v4l2] support, but no tuning or channel-swapping features
 +
* [[Hardware Accelerated Video Decoding]] of H.264 encoded video (in [[DVDPlayer|XBMC's FFmpeg-based in-house video player]])
 +
**Off-loading some decoding processing parts to a OpenGL 2.0 GPU for assisted decoding
 +
**[[Hardware Accelerated Video Decoding|The possible methods are GLSL or Cg Pixel Shader (Shader Model 3.0), and/or GPGPU technology]]
 +
* [http://forum.xbmc.org/showthread.php?t=22407 Pictures database; scan EXIF (and IPTC) tags into a SQL db and add a library-mode view]
 +
* Extend XBMC's [[Scraper.xml|Scraper API]] to also download [http://forum.xbmc.org/showthread.php?t=28953 games] metadata, (and maybe also  [http://forum.xbmc.org/showthread.php?t=28376 weather-forecasts])
 +
**For [http://forum.xbmc.org/showthread.php?t=28953 games this will require a new SQL database and library view-mode in the "Programs" section]
 +
* [http://forum.xbmc.org/showthread.php?t=27298 Unified Subtitle Parser / Display Filter Library for XBMC's in-house DVDPlayer video-player core]
 +
**Create a Unified Subtitle Parser Library for external and embedded subtitle, plus a [http://wiki.multimedia.cx/index.php?title=Libavfilter FFmpeg libavfilter filter] for it
 +
* [http://forum.xbmc.org/showthread.php?t=6169 Audio Equalizer in XBMC for music playback] with [[PAPlayer]], (and as a [http://wiki.multimedia.cx/index.php?title=Libavfilter FFmpeg libavfilter filter] for video)
 +
* Add full [https://sourceforge.net/tracker/index.php?func=detail&aid=816621&group_id=87054&atid=581841 VCD/SVCD menu support to XBMC] (possibly via xine-vcdnav/vcdx from [http://www.xinehq.hu Xine])
 +
* Add [http://forum.xbmc.org/showthread.php?t=181&highlight=karaoke native support for text-display from CDG Karaoke Audio-CD]s (possibly via [http://www.gnu.org/software/libcdio/ libcdio])
 +
**As this would otherwise be a small task (since XBMC already uses libcdio for other features such as ISO/IMG images reader and ISO 9660 reader on the Xbox), one would also expect this proposal to also include additional karaoke functions and features under XBMC for Linux, such as microphone support (with recording and enabling the use of those microphones under both audio and video playback, and maybe even voice-mask filters), and possibly [http://forum.xbmc.org/showthread.php?t=19157 Lyrics3v2 display] on top of visualizations and screensavers.
 +
* Rewrite the thumbnail caching system so that it can store multiple resolution thumbs.
 +
**Essentially the "CacheThumb" routine should cache the thumb, cache information about the thumb (info on date, source, aspectratio, packed as small as feasible) and store both full size and scaled versions of the thumbs. The meta info would be stored in a separate file for fast assigning of thumbs (this could be kept in memory based on the thumb hash in a lookup table, and the ListItem.Thumb infoimage could be extended to specify what size of thumb it needs (to limit memory usage for xbox/lowmem devices).
 +
* Rewrite XBMC's existing picture slideshow engine to be more like a normal player (see [[DVDPlayer]], [[PAPlayer]], and [[MODPlayer]] as examples).
 +
**Utilize GUILargeImage to handle the loading, and the animation engine for the effects (pan/zoom/rotate, etc.)
 +
* [http://forum.xbmc.org/showthread.php?t=1399&highlight=bittorrent BitTorrent GUI-frontend and a BiTorrent client-backend, a with download manager running in the background].
 +
**This could allow XBMC user to search track RSS feeds and download items by filter.
 +
**Separating the GUI-frontend from the client-backend makes it more portable and easier to replace client-backend.
 +
* [http://forum.xbmc.org/showthread.php?t=25 Integrate a web-browser into XBMC GUI] using either [http://en.wikipedia.org/wiki/KHTML KHTML] or [http://en.wikipedia.org/wiki/WebKit WebKit] as the backend [http://en.wikipedia.org/wiki/Layout_engine HTML layout engine rendering backend] (as those are memory efficient and have few dependencies). Ideally it should be a GUI component that could be used throughout the XBMC GUI to properly display HTML code and pages. Noted should be that [http://forum.xbmc.org/showthread.php?t=11640 a web-browser called LinksBoks which is based on Links2Browser HTML layout engine rendering backend but with a custom frontend GUI was integreted into XBMC for Xbox once] however it was not kept maintained by its initial developer so it was never merged into the main SVN trunk (it is [https://xbmc.svn.sourceforge.net/svnroot/xbmc/branches/linksbrowser still branched in the SVN though]), so in theory it could be possible to update the [https://xbmc.svn.sourceforge.net/svnroot/xbmc/branches/linksbrowser linksbrowser SVN branch] but instead of Links2Browser integrate a new more memory efficient cross-portable [http://en.wikipedia.org/wiki/Layout_engine HTML layout engine rendering backend] with few dependencies and smaller footprint, such as [http://en.wikipedia.org/wiki/KHTML KHTML] or [http://en.wikipedia.org/wiki/WebKit WebKit].
 +
* Simple RSS reader that supports text, video and pictures, (supporting multiple RSS feeds)
 +
** Should be simple enough, like the RSS readers on mobile devices, suited for TV.
 +
* Generic App Support - a very non-trivial much more generalized implementation would be an application / component that is able to capture the output and control an external application through a process pipe, shared memory, events, etc and have XBMC render it inside its own window. Such an implementation would mean we could more easily swap out browsers and also integrate other applications into XBMC. Of course this is highly non-trivial and many parts of it would be platform dependent. In terms of performance, such a technique will probably(?) not function too well for applications that require high fps. [http://people.freedesktop.org/~davidr/GLX_EXT_texture_from_pixmap.txt This OpenGL extension to convert a pixmap to a texture (used by compiz)] might prove useful.
 +
* Port <u>all</u> of the existing [http://forum.xbmc.org/showthread.php?t=137 visualisations] and [http://forum.xbmc.org/showthread.php?t=7552 screensavers] available in XBMC for Xbox from DirectX to OpenGL, (doing so in a unified way that they are combined with the existing DirectX version so that they each supports both DirectX and OpenGL).
 +
* [http://wiki.linuxmce.org/index.php/Home_Automation Home Automation Control: Control lighting, climate/heating, security, camera surveillance, and more].
 +
**Implemented into XBMC via the same [http://plutohome.com/index.php?section=get_pluto Pluto] core libraries/code that [http://wiki.linuxmce.org/index.php/History LinuxMCE] uses.
 +
* Implement [http://www.fireflymediaserver.org/ Firefly Media Server (previously known as "mt-daapd")] built-in DAAP-server into XBMC for Mac OS X
 +
**Make it possible for XBMC for Mac OS X to use iTunes library (XBMC already have a DAAP-client)
 +
**Note! No mentor has yet volunteered to help with Mac OS X specific coding!
 +
* Fully port XBMC for Mac OS X to compile and run Mac OS X 10.4.x (Tiger)
 +
**Note! No mentor has yet volunteered to help with Mac OS X specific coding!
 +
* Fully port XBMC for Mac OS X to compile and run on PowerPC (PPC) architecture
 +
**Maybe with the help of [http://www.finkproject.org The Fink Project] and/or [http://llvm.org The LLVM Compiler Infrastructure]?
 +
**Note! No mentor has yet volunteered to help with Mac OS X specific coding!
 +
 
 +
== Qualification tasks ==
 +
Please add a note here if you choose to work on a qualification task to avoid duplicate work. (To do so you need to register an account on this wiki and request 'ninja status' from a Team-XBMC member for that account).
 +
 
 +
Many students will probably apply for the Google Summer of Code and wish to work on a sexy multimedia project such as XBMC. All students will probably also claim to be hard workers, but we need a real method of determining which students have a higher probability for success. Thus, we will use this qualification system (adopted from FFmpeg SoC 2007 season). A student must successfully first complete a qualification task in order to be considered for an XBMC SoC project. In doing so, a student demonstrates that they:
 +
* Are willing to commit some time during the Summer of Code application review period in order to prove that they can code C++ satisfactorily in a clean, well-documented style.
 +
* Can effectively navigate the XBMC codebase.
 +
* Can communicate well with the XBMC development-team and community via the forum and IRC.
 +
* Can accept feedback and revise code after review until it is suitable for inclusion in the main XBMC codebase.
 +
 
 +
:'''TIP!''' Do not be shy, speak your mind, and get involved with the public community!
 +
 
 +
'''Frequent Objection #1:''' "''But I don't have time to do a qualification task!''" Then how do we know you will have time to work on your task during the summer? The qualification tasks are selected to be fairly trivial by XBMC standards and should not be too difficult for a prospective XBMC contributor. If they are too difficult, maybe XBMC is not the project for you. Also, be encouraged by the fact that the application review period comes after the application submission deadline; i.e., you can work on a qualification task after you submit an application to XBMC. But you will not be considered for an SoC project slot unless you have satisfactorily completed a qualification task.
 +
 
 +
'''Process:''' If you are truly interested in applying for XBMC's Summer of Code and, by extension, interested in working on a qualification task, the first step is to register a XBMC Community Forum Account, a SourceForge.NET Account and a XBMC Wiki Account (plus apply to get 'ninja status' for the Wiki by contacting a Team-XBMC member), and then publicly indicate that your interest and which project you plan to work on.
 +
 
 +
====Platform independent====
 +
*FFmpeg wrapper for [http://forum.xbmc.org/showthread.php?t=21926 Libnemesi (the RTSP/RTP client library)] to use inside [[DVDPlayer|XBMC's in-house video-player (DVDPlayer)]]
 +
** -- I'm willing to try this out - '''Alcoheca' - 27/2/2008
 +
*FFmpeg wrapper for [http://forum.xbmc.org/showthread.php?t=21926 Libnemesi (the RTSP/RTP client library)] to use inside [[PAPlayer|XBMC's in-house audio-player (PAPlayer)]]
 +
*Add [http://forum.xbmc.org/showthread.php?t=6982 libass library (Advanced SSA/ASS subtitle support)] to [[DVDPlayer|XBMC's in-house video-player (DVDPlayer)]]
 +
* Implement a slow-cache system for the infomanager for those items that do not need to be retrieved more than about once a second, such as the proposed "Library.HasContent()" stuff which hits the db.
 +
 
 +
:'''Legacy Tasks''' - There is a growing back-log of 'interesting patches' and 'bug-reports' for XBMC on our patch-tracker and our bug-tracker which are both hosted on the XBMC SourceForge.net project site. Many of the patches have been abandoned by the original submitter, thus now requires volunteers to take the initiative to clean up each patch to the satisfaction of the project leaders and resubmit it for new review, so that it can be approved for SVN inclusion. As for the bugs, please try to fix enough bugs to show of your skill. See:
 +
:* XBMC patch-tracker: [http://sourceforge.net/tracker/?group_id=87054&atid=581840 http://sourceforge.net/tracker/?group_id=87054&atid=581840]
 +
:* XBMC bug-tracker: https://sourceforge.net/tracker/?group_id=87054&atid=581838
 +
 
 +
:'''Note!''' If you have an idea for a other simple task, come and discuss it on the development forums and the devs might approve it.
 +
 
 +
====XBMC for Linux====
 +
*Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
 +
* Complete the missing audio codecs (ADPlug and SHN) for [[PAPlayer|XBMC's in-house audio-player (PAPlayer)]]
 +
 
 +
====XBMC for Mac OS X====
 +
*Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
 +
*Mac OS X 64-bit x86 running: Patches to make XBMC for Mac OS X closer to running on 64-bit x86 architecture. Should be easier now that it's working on AMD64 Linux.  E-mail malloc@xbmc.org with questions.
 +
*Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
 +
 
 +
====XBMC for Windows====
 +
*Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
 +
*XBMC for Windows (Win32) compiling:
 +
** Patches to make XBMC for Windows (SDL/OpenGL-based from the linuxport branch) closer to fully working on a Windows XP (32-bit x86) architecture.
 +
 
 +
====XBMC for Xbox====
 +
*Update a few third-party library/module that XBMC for Xbox depends on and submit a patch for the update
 +
**For example: libCDIO, CxImage, libcurl, libshout, libsamba, libPython, libSQLite, FileZilla (server), libDAAP, libfreetype (FreeType2)
 +
* Fix enough bugs to show skill https://sourceforge.net/tracker/?func=browse&group_id=87054&atid=581838
 +
 
 +
=Mentors and Contact methods=
 +
Mentors are developers from [[Team XBMC and Others|Team-XBMC]] and members of [http://sourceforge.net/projects/xbmc The XBMC Project] that have volunteered to assist and mentor non-official XBMC developers in any non-trivial way they can, helping you by checking, commenting and committing your code patches to our SVN source code tree. These mentors have chosen an area they prefer to specialize in, usually this is an area in which they feel they have most interest, knowledge, and expertise in.
 +
 
 +
* [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
 +
* [[User:Spiff|Spiff]]: Anything other than DllLoader/MPlayer/DVDPlayer internals.
 +
* [[User:Yuvalt|Yuvalt]]: Everything Linux
 +
* [[User:D4rk|D4rk]]: OpenGL, other Linux stuff
 +
* [[User:malloc|malloc]]: Everything Linux
 +
 
 +
:'''NOTE!''' All GSoC students should feel comfortable to not only approach your assigned mentors but also to approach ANY mentor and ANY [[Team-XBMC|Team-XBMC member]] with your questions and problems, [[Team-XBMC|Team-XBMC]] is not only a team by name but we do our best to work as a team as well.
 +
 
 +
==Contact methods==
 +
These are developers forums for XBMC development, (programmers/coders only!).<br>
 +
Respect, these are not for posting feature-requests or end-user support requests!
 +
* IRC: [irc://irc.freenode.net/xbmc-gsoc #xbmc-gsoc on freenode] temporary [http://freenode.net IRC network channel] used for the GSoC qualification/proposal stage.
 +
**This [irc://irc.freenode.net/xbmc-gsoc #xbmc-gsoc] IRC-channel will be used for students and mentors until the [http://code.google.com/opensource/gsoc/2008/faqs.html#0.1_timeline 14th of April]
 +
* IRC: [irc://irc.freenode.net/xbmc-linux #xbmc-linux on freenode] official [http://freenode.net IRC network channel] for the XBMC Linux port project
 +
**(You may also sometimes find developers hanging out at [irc://irc.freenode.net/xbmc #xbmc on freenode])
 +
* IRC: [irc://irc.freenode.net/xbmc-osx #xbmc-osx on freenode] official [http://freenode.net IRC network channel] for the XBMC Mac OS X port
 +
* [http://forum.xbmc.org/forumdisplay.php?f=41 XBMC for Linux port Community-Forum for developers only]
 +
** [http://forum.xbmc.org/forumdisplay.php?f=52 XBMC for Linux port Community-Forum for end-users (unmoderated so far)]
 +
* [http://forum.xbmc.org/forumdisplay.php?f=57 XBMC for Mac OS X port Community-Forum for developers only]
 +
** [http://forum.xbmc.org/forumdisplay.php?f=56 XBMC for Mac OS X port Community-Forum for end-users (unmoderated so far)]
 +
* [[HOW-TO submit a patch]] (where and how to submit source code)
 +
 
 +
 
 +
[[category:Google Summer of Code]]
 +
[[category:Development]]
 +
[[category:Inner Workings]]
 +
[[category:Linux]]
 +
[[category:Mac OS X]]
 +
[[category:Microsoft Windows]]
 +
[[category:OpenGL]]
 +
[[category:To-Do]]

Revision as of 19:50, 17 March 2008

XBMC has been accepted in to the Google Summer of Code 2008! Template:Current event Google is sponsoring their forth annual Summer of Code (GSoC) in the summer of 2008, this entail sponsoring students to work on assorted open source projects as well as sponsoring mentors in those same projects, everyone wins! XBMC has been selected as one of the approved mentoring organizations for this year's GSoC. This page will be used for possible project ideas for the Google Summer of Code 2008 season, and also track the status of each project and how well each student is doing.

The administrator for this year's XBMC Summer of Code is Andreas Setterlind (a.k.a. Gamester17)

NOTE! If you are a student who wishes to be involved with an XBMC GSoC project, one of the first and best steps you can take is to register an account on XBMC community forum, (sooner rather than later), and indicate your interest. Also, make sure that you complete a qualification task as soon as possible to be eligible for a XBMC SoC project, (no qualification task = no project, that is Team-XBMC policy, not Google).

Contents

1 Introduction to XBMC

XBMC (formerly "XBox Media Center") is a free and open source (GPL) cross-platform media player and entertainment hub software. XBMC was originally established in 2002 and in the beginning developed as XBox Media Player (XBMP) for the first-generation Xbox game-console. XBMC has since been ported to also run natively under Linux, Mac OS X, and Microsoft Windows operating-system. XBMC has so far been translated to over 30 languages, won two SourceForge Community Choice Awards, (Best Multimedia Project and Best Game Project back in 2006), and today XBMC has a very broad international community of active developers, graphic artists, and devoted users.

1.1 Developing XBMC

The XBMC code structure uses a fairly modular design (with libraries and DLLs) who's structure is large, though relatively easy to grasp. XBMC's source code is predominantly C++, though there is a small splattering of C libraries and assembler for good measure. XBMC for uses the Microsoft DirectX multimedia framework (Direct3D) on the Xbox, and the SDL (Simple DirectMedia Layer) framework with OpenGL rendering for other operating-system platforms versions of XBMC, (ie. Linux, Mac OS X, and Microsoft Windows).

The main XBMC program is developed using Microsoft Visual Studio for the Xbox and win32 builds, and there are KDevelop project files for Linux, and Eclipse/Xcode project files for Mac OS X). For the Xbox version a copy of the latest Microsoft Xbox SDK (a.k.a. XDK) is also required, though obviously this is not required for all other platforms.

XBMC's code also contains three player cores: One core based on MPlayer that is only available to the Xbox version of XBMC, another in-house developed (FFmpeg-based) dedicated video-player core (which also supports DVD-Video movies with menus), and an in-house developed dedicated music-player core.

NOTE! For more detailed information on where to get started with XBMC development please see Appendix D (Development_Notes) in this wiki.
TIP! Microsoft DreamSpark student program is currently (and over this summer) giving free access to their development software.

2 How To Apply as a Student

2.1 Before you can apply

Before you can apply make sure you are qualified to apply:

  • You have to know how to program in C++ (and know C) fairly well.
  • We would like you to first submit a small patch that fixes a bug or adds a feature to XBMC. By doing that we will know if you are qualified for the task or not. At the bottom of this page there will be a list of possible Qualification Tasks, specific ideas that could be performed to show your skill, however you are free to submit anything you feel might be of value to XBMC. The qualification task can be done after you have filed you application.
  • Submit a good application through the formal Google Summer of Code process during the application time frame.
  • You have to have >35 hours per week to put into the project.
  • You can not have another job at the same time as the SoC project.

2.2 Applying

If you are interested in participating in the Google Summer of Code you will need to register at the official SoC site linked below and file an official application. Traditionally, the top applications are fairly detailed - you really need to sell yourself as well as your idea proposal. Look for example at this application here for inspiration. The official guide from Google can be found here:

TIP! The Drupal project has also prepared a couple of good guidelines that might be useful, see:

The application could have similar sections as in the following:

Name:
E-mail Address:
Project Title:
Project Goals:
Project Benefits:  How does your project benefit XBMC and its community?
Project Tasks and Deliverables: Break your project into tasks or pieces.
    Describe in detail what you plan to accomplish and what the results will be.
Project Schedule:  Estimate how long your project will take and how much time you
    have to dedicate on it. Try to establish a timed roadmap of the tasks to do.
Personal Statement:  Tell us about yourself.  Describe why you are better than any
    other applicant for this project.

2.3 Google SoC Development Process

Each accepted project will be developed in its own sandbox (SVN branch), separate from the main XBMC codebase. Naturally, the end goal of each of the accepted XBMC projects ought to be to have that code in shape for acceptance into the production codebase. This page will track the status of each project and how well each student are doing.

3 Current Status

  • Next Big Date: March 24, 2008: Students may begin to submit applications through Google
  • March 17, 2008: Google is scheduled to announce selected projects; XBMC is selected
  • March 11, 2008: Submitted XBMC project application
  • February 29, 2008: Created this wiki article

3.1 Schedule

Official timeline: http://code.google.com/soc/2008/faqs.html#0.1_timeline

  • March 31, 2008: Student application deadline, students must have submitted their proposals through Google.
  • March 24-31, 2008: Students may submit applications for various Google Summer of Code projects.
  • March 17, 2008: Google announces accepted organizations at: http://code.google.com/soc/
  • March 3-12, 2008: Open source organizations may apply to the Google Summer of Code program.

4 Project Proposals

4.1 Overview

Qualifications for a good Summer of Code proposal:

  • Discrete, well-defined, modular
  • Comprised of a series of measurable sub-goals
  • Based on open specs that are available free of charge
  • Based on complete specs

An example of a good proposal is the implementation of a new feature or function that is not yet available in XBMC.

An example of a less desirable proposal is one that's not as measurable, such as refactoring an existing API. Bad proposals tend to be ones that would require touching a lot of core code.

To re-iterate:

  • Localized/isolated code projects = good
  • Global code refactoring = bad

4.2 Students Project Proposals

Feel free to enter a link to your proposal here if you are a college student and you will apply to Google Summer of Code this year:

4.3 Projects with Mentors (official approved projects)

  • To come if and when Google accept the Students Project Proposals

4.4 Team-XBMC proposal ideas up for discussion

Most of the proposals in this list are just some project ideas that we have been kicking around, (which, by no means, limits any prospective proposals). So you are more than welcome to come up with a new idea that you think falls into the scope of XBMC and the Google Summer of Code spirit. Since XBMC is cross-platform software most of these ideas are platform-independent, meaning that if you implement the feature/function on one operating-system platform then someone else will be able to port that feature/function to the other operating-system platforms that XBMC runs on.

NOTE! THIS LIST IS NOT THE FINAL PROPOSALS THAT WILL BE SUBMITTED. THESE ARE ONLY CONCEPTS THAT IDEAS COULD BE BASED UPON, IN THE END YOU AS THE STUDENT WILL BE PRESENTING THE IDEA AS YOUR OWN, SO IT IS NOT ONLY THE IDEA BUT HOW YOU PRESENT IT, SO BE CREATIVE!

5 Qualification tasks

Please add a note here if you choose to work on a qualification task to avoid duplicate work. (To do so you need to register an account on this wiki and request 'ninja status' from a Team-XBMC member for that account).

Many students will probably apply for the Google Summer of Code and wish to work on a sexy multimedia project such as XBMC. All students will probably also claim to be hard workers, but we need a real method of determining which students have a higher probability for success. Thus, we will use this qualification system (adopted from FFmpeg SoC 2007 season). A student must successfully first complete a qualification task in order to be considered for an XBMC SoC project. In doing so, a student demonstrates that they:

  • Are willing to commit some time during the Summer of Code application review period in order to prove that they can code C++ satisfactorily in a clean, well-documented style.
  • Can effectively navigate the XBMC codebase.
  • Can communicate well with the XBMC development-team and community via the forum and IRC.
  • Can accept feedback and revise code after review until it is suitable for inclusion in the main XBMC codebase.
TIP! Do not be shy, speak your mind, and get involved with the public community!

Frequent Objection #1: "But I don't have time to do a qualification task!" Then how do we know you will have time to work on your task during the summer? The qualification tasks are selected to be fairly trivial by XBMC standards and should not be too difficult for a prospective XBMC contributor. If they are too difficult, maybe XBMC is not the project for you. Also, be encouraged by the fact that the application review period comes after the application submission deadline; i.e., you can work on a qualification task after you submit an application to XBMC. But you will not be considered for an SoC project slot unless you have satisfactorily completed a qualification task.

Process: If you are truly interested in applying for XBMC's Summer of Code and, by extension, interested in working on a qualification task, the first step is to register a XBMC Community Forum Account, a SourceForge.NET Account and a XBMC Wiki Account (plus apply to get 'ninja status' for the Wiki by contacting a Team-XBMC member), and then publicly indicate that your interest and which project you plan to work on.

5.1 Platform independent

Legacy Tasks - There is a growing back-log of 'interesting patches' and 'bug-reports' for XBMC on our patch-tracker and our bug-tracker which are both hosted on the XBMC SourceForge.net project site. Many of the patches have been abandoned by the original submitter, thus now requires volunteers to take the initiative to clean up each patch to the satisfaction of the project leaders and resubmit it for new review, so that it can be approved for SVN inclusion. As for the bugs, please try to fix enough bugs to show of your skill. See:
Note! If you have an idea for a other simple task, come and discuss it on the development forums and the devs might approve it.

5.2 XBMC for Linux

5.3 XBMC for Mac OS X

  • Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
  • Mac OS X 64-bit x86 running: Patches to make XBMC for Mac OS X closer to running on 64-bit x86 architecture. Should be easier now that it's working on AMD64 Linux. E-mail malloc@xbmc.org with questions.
  • Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL

5.4 XBMC for Windows

  • Port an existing XBMC (for Xbox) DirectX/HLSL screensaver or visualisation to OpenGL/GLSL
  • XBMC for Windows (Win32) compiling:
    • Patches to make XBMC for Windows (SDL/OpenGL-based from the linuxport branch) closer to fully working on a Windows XP (32-bit x86) architecture.

5.5 XBMC for Xbox

6 Mentors and Contact methods

Mentors are developers from Team-XBMC and members of The XBMC Project that have volunteered to assist and mentor non-official XBMC developers in any non-trivial way they can, helping you by checking, commenting and committing your code patches to our SVN source code tree. These mentors have chosen an area they prefer to specialize in, usually this is an area in which they feel they have most interest, knowledge, and expertise in.

  • JMarshall: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
  • Spiff: Anything other than DllLoader/MPlayer/DVDPlayer internals.
  • Yuvalt: Everything Linux
  • D4rk: OpenGL, other Linux stuff
  • malloc: Everything Linux
NOTE! All GSoC students should feel comfortable to not only approach your assigned mentors but also to approach ANY mentor and ANY Team-XBMC member with your questions and problems, Team-XBMC is not only a team by name but we do our best to work as a team as well.

6.1 Contact methods

These are developers forums for XBMC development, (programmers/coders only!).
Respect, these are not for posting feature-requests or end-user support requests!

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox