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

Developing XBMC for Linux

From XBMC
(Difference between revisions)
Jump to: navigation, search
(Major To-Do tasks with high priority)
(To-Do list for Mac OS X)
(46 intermediate revisions by 4 users not shown)
Line 1: Line 1:
 
{{Current event}}
 
{{Current event}}
  
Currently, a few developers on [[Team-XBMC]] have begun the [http://en.wikipedia.org/wiki/Porting porting] of XBMC to Linux (and [http://en.wikipedia.org/wiki/OpenGL OpenGL] using the [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL toolkit]). The goal is for this to become a full port of XBMC with [[XBMC Features and Supported Formats/Codecs|all the features and functions that are available on the Xbox version of XBMC]] ''(with the exception of Xbox exclusive functionality as [[Using Trainers|Trainers]], launching Xbox Games, and such)''. This is a huge task which is why we are now making this public request, seeking [http://en.wikipedia.org/wiki/Programming_language C/C++ programmers] to volunteer in assisting us with this Linux porting development project. Whether you have contributed to [http://sourceforge.net/projects/xbmc The XBMC Project] in the past or not, please consider doing so now. Those of you who are completely unfamiliar with XBMC can get a good overview of what XBMC offers for its [http://en.wikipedia.org/wiki/End-user end-users] by reading through the [http://en.wikipedia.org/wiki/XBMC XBMC article on wikipedia.org]
+
Currently, a few developers on [[Team-XBMC]] have begun the [http://en.wikipedia.org/wiki/Porting porting] of XBMC to Linux (and [http://en.wikipedia.org/wiki/OpenGL OpenGL] using the [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL toolkit]). The goal is for this to become a full port of XBMC with [[XBMC Features and Supported Formats/Codecs|all the features and functions that are available on the Xbox version of XBMC]] ''(with the exception of Xbox exclusive functionality such as [[Using Trainers|Trainers]], launching Xbox Games, etc)''. This is a huge task, which is why we are now making this public request, seeking [http://en.wikipedia.org/wiki/Programming_language C/C++ programmers] to volunteer in assisting us with this Linux porting development project. Whether you have contributed to [http://sourceforge.net/projects/xbmc The XBMC Project] in the past or not, please consider doing so now. Those of you who are completely unfamiliar with XBMC can get a good overview of what XBMC offers for its [http://en.wikipedia.org/wiki/End-user end-users] by reading through the [http://en.wikipedia.org/wiki/XBMC XBMC article on wikipedia.org]
  
 
:'''Note to XBMC end-users!''' Please understand that this Linux port project is not yet mature enough for a regular end-user to play with. We can not yet give you an ETA as to when it will be useful for end-users. Respect that we can not accept any bug-reports or feature/function-requests for this Linux port yet, nor do we offer support to end-users. If you are an end-user and have any general questions or need to get something off your chest about this then please direct that towards the existing [http://www.xboxmediacenter.com/forum/showthread.php?t=26097 XBMC Linux port end-user discussion topic-thread in our community-forum]. If, however, you are a developer or have Linux expertise, we encourage you to keep reading to find out how you can help.
 
:'''Note to XBMC end-users!''' Please understand that this Linux port project is not yet mature enough for a regular end-user to play with. We can not yet give you an ETA as to when it will be useful for end-users. Respect that we can not accept any bug-reports or feature/function-requests for this Linux port yet, nor do we offer support to end-users. If you are an end-user and have any general questions or need to get something off your chest about this then please direct that towards the existing [http://www.xboxmediacenter.com/forum/showthread.php?t=26097 XBMC Linux port end-user discussion topic-thread in our community-forum]. If, however, you are a developer or have Linux expertise, we encourage you to keep reading to find out how you can help.
Line 11: Line 11:
  
 
=Skill requirements and where to start=
 
=Skill requirements and where to start=
Proficient in [http://en.wikipedia.org/wiki/Programming_language C/C++ programming language], and though not required knowledge of [http://en.wikipedia.org/wiki/DirectX DirectX], [http://en.wikipedia.org/wiki/Direct3D Direct3D], [http://en.wikipedia.org/wiki/OpenGL OpenGL] and/or [http://en.wikipedia.org/wiki/Multimedia multimedia] programming is a plus, as well as prior [http://en.wikipedia.org/wiki/Multi-platform cross-platform] or [http://en.wikipedia.org/wiki/Porting porting] development experience. You do not need to have access to an Xbox game-console or any special tools/software in order to take part - XBMC development is well underway on [http://www.ubuntu.com Linux (Ubuntu 7.04)].
+
Proficient in [http://en.wikipedia.org/wiki/Programming_language C/C++ programming language], and though not required knowledge of [http://en.wikipedia.org/wiki/DirectX DirectX], [http://en.wikipedia.org/wiki/Direct3D Direct3D], [http://en.wikipedia.org/wiki/OpenGL OpenGL] and/or [http://en.wikipedia.org/wiki/Multimedia multimedia] programming is a plus, as well as prior [http://en.wikipedia.org/wiki/Multi-platform cross-platform] or [http://en.wikipedia.org/wiki/Porting porting] development experience. You do not need to have access to an Xbox game-console or any special tools/software in order to take part - XBMC development is well underway on [[HOW-TO compile XBMC for Linux from source code|Linux (32-bit Ubuntu for x86)]].
  
 
==Where do I start (Linux)?==
 
==Where do I start (Linux)?==
The recommended '''Linux development platform''' is currently [http://www.ubuntu.com Ubuntu 7.04 (Feisty Fawn)]. There is a [http://en.wikipedia.org/wiki/Kdevelop Kdevelop] project file available in our [http://sourceforge.net/svn/?group_id=87054 SVN (Subversion revision control system)]. After you've done a [http://sourceforge.net/svn/?group_id=87054 SVN checkout], follow the install guide in the SVN ([[HOW-TO compile XBMC for Linux from source code|README.linux]]) to setup the required packages and so on. Team-XBMC developers think that the best thing to start with is just to take a look through the source code and try to understand how it all fits together. Test things out, find what works and what does not, then try and track down why.
+
The recommended '''Linux development platform''' is currently [[HOW-TO compile XBMC for Linux from source code|32-bit Ubuntu (for x86)]]. There is a [http://en.wikipedia.org/wiki/Kdevelop Kdevelop] project file available in our [http://sourceforge.net/svn/?group_id=87054 SVN (Subversion revision control system)]. After you've done a [http://sourceforge.net/svn/?group_id=87054 SVN checkout], follow the install guide in the SVN ([[HOW-TO compile XBMC for Linux from source code|README.linux]]) to setup the required packages and so on. Team-XBMC developers think that the best thing to start with is just to take a look through the source code and try to understand how it all fits together. Test things out, find what works and what does not, then try and track down why.
  
Alternatively, you can download a finished VMware Virtual Machine (VM) and run that in the free [http://www.vmware.com/products/free_virtualization.html VMware Player] (or use in VMware Workstation, or VMware Server). The VM available for download below is based on Ubuntu 7.0.4 Desktop, and all the pre-requisite software is installed (including KDevelop). Performance is not great using this, as there is no 3D hardware acceleration support under a virtual machine, however it should work good enough to get a lot of development tasks done without you having to bother with install of Ubuntu yourself. Nice is also that you can install/run [http://www.vmware.com/products/free_virtualization.html VMware Player 2.0 and later] under Linux as well as Microsoft Windows (including Windows Vista), 32-bit and 64-bit operating-system. The free [http://www.vmware.com/products/free_virtualization.html VMware Player 2.0 and later] also enables you to share data seamlessly between the virtual machine and host computer, and also allows you to directly access USB 2.0 devices from within the virtual machine, (experimental support for 2-way Virtual SMP to assign more than a single CPU to a virtual machine is also available for testing purposes).
+
Alternatively, you can download a finished VMware Virtual Machine (VM) and run that in the free [http://www.vmware.com/products/free_virtualization.html VMware Player] (or use in VMware Workstation, or VMware Server). The VM available for download below is based on [[HOW-TO compile XBMC for Linux from source code|Ubuntu Desktop (32-bit for x86)]], and all the prerequisite software is installed (including KDevelop). Performance is not great using this, as there is no 3D hardware acceleration support under a virtual machine, however it should work good enough to get a lot of development tasks done without you having to bother with install of Ubuntu yourself. Nice is also that you can install/run [http://www.vmware.com/products/free_virtualization.html VMware Player 2.0 and later] under Linux as well as Microsoft Windows (including Windows Vista), 32-bit and 64-bit operating-system. The free [http://www.vmware.com/products/free_virtualization.html VMware Player 2.0 and later] also enables you to share data seamlessly between the virtual machine and host computer, and also allows you to directly access USB 2.0 devices from within the virtual machine, (experimental support for 2-way Virtual SMP to assign more than a single CPU to a virtual machine is also available for testing purposes).
  
 
:*Download: [http://www.aceshome.com/xbmcdev.zip VMware Virtual Machine (VM) with Ubuntu 7.0.4 Desktop and KDevelop] (userid/password is: xbmc/xbmc).
 
:*Download: [http://www.aceshome.com/xbmcdev.zip VMware Virtual Machine (VM) with Ubuntu 7.0.4 Desktop and KDevelop] (userid/password is: xbmc/xbmc).
Line 26: Line 26:
 
*[http://en.wikipedia.org/wiki/X86 x86-based computer]. No other special hardware is required for development, as developers can compile using the "''make sdl_2d option''" (see [[HOW-TO compile XBMC for Linux from source code|README.linux]]). However for end-users the minimum requirement is a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which XBMC GUI need to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0).
 
*[http://en.wikipedia.org/wiki/X86 x86-based computer]. No other special hardware is required for development, as developers can compile using the "''make sdl_2d option''" (see [[HOW-TO compile XBMC for Linux from source code|README.linux]]). However for end-users the minimum requirement is a [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)] that at least supports [http://en.wikipedia.org/wiki/Shader_model Shader Model 3.0] and [http://en.wikipedia.org/wiki/OpenGL OpenGL 2.0] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which XBMC GUI need to run smoothly at an acceptable frame-rate). Graphic adapters that support [http://en.wikipedia.org/wiki/DirectX DirectX version 9.0c] or later usually meet all of those mentioned requirements, ([[Team-XBMC]] recommends [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] as NVIDIA are currently the manufacturer that offers [http://en.wikipedia.org/wiki/Graphics_hardware_and_FOSS good device-drivers for Linux] (and [http://en.wikipedia.org/wiki/Nvidia NVIDIA GeForce 6150 or later] supports OpenGL 2.0).
  
==Can non-Linux developers also help?==
+
==XBMC Linux port FAQ for developers==
XBMC can also be compiled for [http://www.xboxmediacenter.com/forum/showthread.php?t=23235 Win32 (Microsoft Windows) operating-systems] with [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio Microsoft Visual Studio .NET 2003 (7.1) or higher], so even though Team-XBMC will be focusing on the Linux port of XBMC, it will not hurt if some people who prefer and feel comfortable with [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio Microsoft Visual Studio] as a development platform also volunteer to help with getting the [http://www.xboxmediacenter.com/forum/showthread.php?t=23235 Win32 port of XBMC] up to par with the Linux and Xbox versions, this as a preparation for possible future cross-platform versions of XBMC.
+
===Can non-Linux developers also help?===
* [[HOW-TO: Compile XBMC for Win32 from source code]] (to come soon!)
+
XBMC can also be compiled for [http://www.xboxmediacenter.com/forum/showthread.php?t=23235 Win32 (Microsoft Windows) operating-systems] with [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio Microsoft Visual Studio .NET 2003 (7.1) or higher], or for [http://xboxmediacenter.com/forum/showthread.php?p=162341#post162341 Mac OS X] with Eclipse, so even though Team-XBMC will be focusing on the Linux port of XBMC, it will not hurt if some people who prefer and feel comfortable with [http://en.wikipedia.org/wiki/Microsoft_Visual_Studio Microsoft Visual Studio] or Eclipse as a development platform also volunteer to help with getting the [http://www.xboxmediacenter.com/forum/showthread.php?t=23235 Win32 port of XBMC] and [http://xboxmediacenter.com/forum/showthread.php?p=162341#post162341 Mac OS X] builds up to par with the Linux and Xbox versions, this as a preparation for possible future cross-platform versions of XBMC.
 +
* [[HOW-TO: Compile XBMC for Win32 from source code]]
 +
* [[HOW-TO compile XBMC for Mac OS X from source code]]
 +
 
 +
===Why is OpenGL 2.0 needed for XBMC?===
 +
Currently OpenGL 2.0 is needed for:
 +
* Any deinterlacing that is not linear blending which FFmpeg does
 +
* Video [http://en.wikipedia.org/wiki/Video_post-processing video post-processing filtering] (bicubic upscaling, etc.)
 +
* Non-power of two textures for the GUI (using NPOT saves a lot of texture memory)
 +
* Hardware accelerated YUV 2 RGB conversion (actually GLSL is needed for this, and some OpenGL 1.5 implementations provide GLSL as an extension. OpenGL 2.0 guarantees availability of GLSL).
 +
In the future OpenGL 2.0 might also be needed for:
 +
* More [http://en.wikipedia.org/wiki/Video_post-processing video post-processing filters] to improve visual quality perception.
 +
* [[Hardware Accelerated Video Decoding]] (using the GPU hardware to assist with video decoding)
  
 
=Other tools and resources=
 
=Other tools and resources=
Line 37: Line 49:
 
* [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage.
 
* [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage.
 
* [https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=889 VTune Analyzer] Intel® VTune™ Performance Analyzer for Linux (free for non-Commercial use)
 
* [https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=889 VTune Analyzer] Intel® VTune™ Performance Analyzer for Linux (free for non-Commercial use)
* [http://www.linuxpowertop.org PowerTOP] - utility by Intel for detecting what Linux programs and kernel tunables are resulting in the most power consumption.
+
* [http://www.lesswatts.org LessWatts.org] - Projects for saving power with Linux on intel-based platforms.
 +
** [http://www.linuxpowertop.org PowerTOP] - utility by Intel for detecting what Linux programs and kernel tunables are resulting in the most power consumption.
 +
** [http://www.lesswatts.org/projects/tickless/ Tickless Idle] - eliminats the periodic timer tick when the CPU is idle.  
 
* [https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=957 Intel® Threading Building Blocks (Intel® TBB) for Linux] - Threading Analysis Tool by Intel (free for non-Commercial use)
 
* [https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=957 Intel® Threading Building Blocks (Intel® TBB) for Linux] - Threading Analysis Tool by Intel (free for non-Commercial use)
 
**[https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=960 Intel Threading Building Blocks for Windows] - same as above but for Win32 (free for non-Commercial use)
 
**[https://registrationcenter.intel.com/RegCenter/NcomForm.aspx?productid=960 Intel Threading Building Blocks for Windows] - same as above but for Win32 (free for non-Commercial use)
Line 44: Line 58:
 
* [http://en.wikipedia.org/wiki/Dependency_walker Dependency walker] (for Microsoft Windows) - a free program used to list the imported and exported functions of a portable executable.
 
* [http://en.wikipedia.org/wiki/Dependency_walker Dependency walker] (for Microsoft Windows) - a free program used to list the imported and exported functions of a portable executable.
 
* [http://en.wikipedia.org/wiki/HLSL2GLSL HLSL2GLSL] - library and tool that converts HLSL (High Level Shader Language) shaders to GLSL (OpenGL Shading Language)
 
* [http://en.wikipedia.org/wiki/HLSL2GLSL HLSL2GLSL] - library and tool that converts HLSL (High Level Shader Language) shaders to GLSL (OpenGL Shading Language)
 +
* [http://dxshark.sourceforge.net SHARK (Shader Assembly Compiler)] - a tool to perform conversion from DirectX 9 pixel shader assembly language into C++ code
 +
* [http://ati.amd.com/developer/ AMD/ATI GPU ShaderAnalyzer] - Support for both Open GL GLSL and DirectX HLSL
 +
* [http://www.gremedy.com gDEBugger] - OpenGL debugger and Profiler (helping to find bugs and optimize performance)
 +
* [http://christian.helmich.free.fr/kirin/kagefx/index.php KAGEfx] - a framework to load shader programs based on the OpenGL Shading Language contained within an XML file that holds descriptive metadata about the shader and to replace shader modules on-the-fly with respect to their level-of-detail metadata.
  
 
==Development Resources==
 
==Development Resources==
Line 49: Line 67:
 
* [http://gameprogrammer.com/net2/net2-0.html NET2] - A fast threaded event based networking library for SDL (only meant as an example).
 
* [http://gameprogrammer.com/net2/net2-0.html NET2] - A fast threaded event based networking library for SDL (only meant as an example).
 
* [http://olofson.net/mixed.html SDL programming examples] (including glSDL - a proof of concept implementation of SDL on top of OpenGL)
 
* [http://olofson.net/mixed.html SDL programming examples] (including glSDL - a proof of concept implementation of SDL on top of OpenGL)
* [http://sourceforge.net/projects/opencvlibrary OpenCV (Open Computer Vision Library)] - a collection of algorithms and sample code for various computer vision problems. The library is compatible with [http://www.intel.com/cd/software/products/asmo-na/eng/perflib/ipp/302910.htm Intel Image Processing Library (IPL) and utilizes Intel Integrated Performance Primitives] for better performance. Features a bi-linear interpolation and color space conversion functions in IPL, (I also read that motion estimation with block matching and Hough transform is on the roadmap so you might want to check out their CVS).
+
* [http://sourceforge.net/projects/opencvlibrary OpenCV (Open Computer Vision Library)] - a collection of algorithms and sample code for various computer vision problems. The library is compatible with [http://www.intel.com/cd/software/products/asmo-na/eng/perflib/ipp/302910.htm Intel Image Processing Library (IPL) and utilizes Intel Integrated Performance Primitives] for better performance. Features a bi-linear interpolation and color space conversion functions in IPL, (I also read that motion estimation with block matching and Hough transform is on the road-map so you might want to check out their CVS).
  
 
==Third-party libraries==
 
==Third-party libraries==
Line 56: Line 74:
 
* [http://glew.sourceforge.net GLEW (The OpenGL Extension Wrangler Library)] for OpenGL hardware support version detection
 
* [http://glew.sourceforge.net GLEW (The OpenGL Extension Wrangler Library)] for OpenGL hardware support version detection
 
* [http://www.antigrain.com Anti-Grain Geometry] - High Quality Rendering Engine (High Fidelity 2D Graphics Renderer) for C++
 
* [http://www.antigrain.com Anti-Grain Geometry] - High Quality Rendering Engine (High Fidelity 2D Graphics Renderer) for C++
* [http://sourceforge.net/projects/dxglwrap/ DirectX OpenGL Wrapper] - emulates API calls thru OpenGL commands and other platform specific commands in order to run DirectX 8 application running on other platform than Windows.
+
* [http://sourceforge.net/projects/dxglwrap/ DirectX OpenGL Wrapper] - emulates API calls through OpenGL commands and other platform specific commands in order to run DirectX 8 application running on other platform than Windows.
 
* [http://www.intel.com/technology/computing/opencv/ Intel Open Source Computer Vision (OpenCV) Library] Intel's Image Processing Library
 
* [http://www.intel.com/technology/computing/opencv/ Intel Open Source Computer Vision (OpenCV) Library] Intel's Image Processing Library
 
* [http://www.cs.unc.edu/~walk/software/glvu/ GLVU] - cross-platform C++/OpenGL/[http://www.opengl.org/resources/libraries/glut.html GLUT] based 3D OpenGL viewer and collection of utility libraries  
 
* [http://www.cs.unc.edu/~walk/software/glvu/ GLVU] - cross-platform C++/OpenGL/[http://www.opengl.org/resources/libraries/glut.html GLUT] based 3D OpenGL viewer and collection of utility libraries  
 
**You can use all these components together, or just take bits and pieces that do what you need
 
**You can use all these components together, or just take bits and pieces that do what you need
* [http://www.freedesktop.org/wiki/Software/glitz Glitz] - OpenGL image compositing library (enabling features like convolution filters and color gradients)
+
* [http://www.freedesktop.org/wiki/Software/glitz Glitz] - OpenGL image composting library (enabling features like convolution filters and color gradients)
*[http://www.crusaderky.altervista.org//?s=downloads SDL_buffer] - a SDL extention library that is useful when you have to resize an image multiple times.
+
*[http://www.crusaderky.altervista.org//?s=downloads SDL_buffer] - a SDL extension library that is useful when you have to re-size an image multiple times.
* [http://members.cox.net/dolsen6/resize.zip SDL_Resize] - basic image resizing library, high quality output suited for prerendering images.
+
* [http://members.cox.net/dolsen6/resize.zip SDL_Resize] - basic image resizing library, high quality output suited for pre-rendering images.
* [http://www.ferzkopp.net/~aschiffler/Software/SDL_bgrab/index.html SDL_bgrab] - SDL convertion of libbgrab (a framegrabber lib from the same author).
+
* [http://www.ferzkopp.net/~aschiffler/Software/SDL_bgrab/index.html SDL_bgrab] - SDL conversion of libbgrab (a framegrabber lib from the same author).
  
 
====Interactive interface====
 
====Interactive interface====
Line 114: Line 132:
 
**The idea being that XBMC should be installed onto any [http://en.wikipedia.org/wiki/USB_flash_drive USB flash drive] using this [http://en.wikipedia.org/wiki/LiveDistro LiveDistro (a.k.a. Live CD)] on the target device.
 
**The idea being that XBMC should be installed onto any [http://en.wikipedia.org/wiki/USB_flash_drive USB flash drive] using this [http://en.wikipedia.org/wiki/LiveDistro LiveDistro (a.k.a. Live CD)] on the target device.
 
**Though a custom version of the [http://en.wikipedia.org/wiki/Linux_distribution Linux distribution] (stripped for XBMC use only) the plan is still to use a vanilla kernel (if possible).
 
**Though a custom version of the [http://en.wikipedia.org/wiki/Linux_distribution Linux distribution] (stripped for XBMC use only) the plan is still to use a vanilla kernel (if possible).
* '''Milestone ?''' - After XBMC Linux port reached a certain maturity the "linuxport" branch in SVN will be merged into the "main SVN trunk" ''--[[User:Pikestaff|pike]] 06:00, 14 June 2007 (CEST)yet to be decided''
+
* '''Milestone 4''' - Native 64-bit support (AMD64/EMT64), XBMC and all its libraries to be compiled on and for 64-bit.
** At this point in time it is impossible to say exactly at what stage or when/if this merger will happen.
+
* '''Milestone ?''' - Yet to be decided; after XBMC Linux port reached a certain maturity the "linuxport" branch in SVN might be merged into the "main SVN trunk.
 +
** At this point in time it is impossible to say exactly when and at what stage or even if this merger will ever happen.
  
 
==What has already been done==
 
==What has already been done==
 
*[http://en.wikipedia.org/wiki/Kdevelop Kdevelop] project file available in SVN
 
*[http://en.wikipedia.org/wiki/Kdevelop Kdevelop] project file available in SVN
 
**Linux development and debug environment
 
**Linux development and debug environment
*Code fully compiles on Ubuntu 7.04
+
*Code fully compiles on [HOW-TO compile XBMC for Linux from source code|Ubuntu Deskop Linux (32-bit x86)]
 
*GUI implementation of [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL]
 
*GUI implementation of [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL]
 
**OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
 
**OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
Line 137: Line 156:
 
*Gamepad/joystick support
 
*Gamepad/joystick support
  
=To-Do=
+
==To-Do==
This is a '''To-Do list''' of things that still need to be done, you are more than welcome to help out with any of these tasks:
+
This is a '''To-Do list''' of things that still need to be done, anyone is more than welcome to help out with any of these tasks:
===Major To-Do tasks with high priority===
+
====Major To-Do tasks with high priority====
* [MAJOR - HIGH PRIORITY] [[DVDPlayer]] porting to Linux - ''work in progress''. Open Issues:
+
* [[DVDPlayer]] porting to Linux - ''work in progress''. Open Issues:
 
** Partial support for external subtitles (SRT and DVD-Video/VobSub subtitles are currently supported)
 
** Partial support for external subtitles (SRT and DVD-Video/VobSub subtitles are currently supported)
 
** No good support for streaming video from the internet (HTTP/HTTPS/UDP/RTSP/RTP/RTCP/RDT/SDP/MMS)
 
** No good support for streaming video from the internet (HTTP/HTTPS/UDP/RTSP/RTP/RTCP/RDT/SDP/MMS)
** Deinterlacing
+
** Deinterlacing (software and hardware)
* [MAJOR - HIGH PRIORITY] Python interpreter (and python scripts/libraries) - ''work in progress (in early stages)''. Open Issues:
+
* Python interpreter (and python scripts/libraries) - ''work in progress (in early stages)''. Open Issues:
 
** Start the same script a few times and it crashes
 
** Start the same script a few times and it crashes
 
** Some crashes in TransformMatrix
 
** Some crashes in TransformMatrix
* [MAJOR - HIGH PRIORITY] Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time)
+
* Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time)
 
**Also all network settings needed available to the end-user from the the XBMC GUI settings section.
 
**Also all network settings needed available to the end-user from the the XBMC GUI settings section.
* [MAJOR - HIGH PRIORITY] Filesystem support is partial (local, SMB, UPnP, RTV, DAAP. TuxBox and XBMSP is currently supported)
+
* Filesystem support is partial (local, SMB, UPnP, RTV, DAAP. TuxBox and XBMSP is currently supported)
  
===Major To-Do tasks with medium priority===
+
====Major To-Do tasks with medium priority====
* [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / OpenGL /  graphic backend interfaces, particularly with respect to how this interface should be exported to visualisations (.vis) and screensavers (.xscr), etc.
+
* [MAJOR - MEDIUM PRIORITY] Development of a [[OpenGL_DirectX_Interface|platform-independent wrapper interface]] to SDL / DirectX / OpenGL /  graphic backend interfaces, particularly with respect to how this interface should be exported to visualisations (.vis) and screensavers (.xscr), etc.
 
* [MAJOR - MEDIUM PRIORITY] NTSC and PAL-50/PAL-60 TV-out settings for composite, S-Video and standard-definition component
 
* [MAJOR - MEDIUM PRIORITY] NTSC and PAL-50/PAL-60 TV-out settings for composite, S-Video and standard-definition component
 
* [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / ALSA /OSS / OpenAL audio backend interfaces.
 
* [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / ALSA /OSS / OpenAL audio backend interfaces.
Line 164: Line 183:
 
* [MAJOR - MEDIUM PRIORITY] [[MPlayer]] porting to Linux
 
* [MAJOR - MEDIUM PRIORITY] [[MPlayer]] porting to Linux
  
===Major To-Do tasks with low priority===
+
====Major To-Do tasks with low priority====
 
* [MAJOR - LOW PRIORITY] [[Hardware Accelerated Video Decoding]] offloading to the GPU in some shape or form.
 
* [MAJOR - LOW PRIORITY] [[Hardware Accelerated Video Decoding]] offloading to the GPU in some shape or form.
 
**[[Hardware Accelerated Video Decoding|The possible methods are XvMC, GLSL or Cg Pixel Shader (Shader Model 3.0), and/or GPGPU technology]]
 
**[[Hardware Accelerated Video Decoding|The possible methods are XvMC, GLSL or Cg Pixel Shader (Shader Model 3.0), and/or GPGPU technology]]
 
* [MAJOR - LOW PRIORITY] Credits (make it support DirectX and OpenGL, detect platform. Plus add some [http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html eye-candy])
 
* [MAJOR - LOW PRIORITY] Credits (make it support DirectX and OpenGL, detect platform. Plus add some [http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html eye-candy])
 
* [MAJOR - LOW PRIORITY] Hibernation - Suspend to Disk (STD) (code should be completly different from STR)
 
* [MAJOR - LOW PRIORITY] Hibernation - Suspend to Disk (STD) (code should be completly different from STR)
**Hibernation (Suspend to Disk), only if could somehow be used to speed up the initial boot-time.
+
**Hibernation (Suspend to Disk), only if could somehow be used to speed up the initial boot-time. See [http://kerneltrap.org/kexec_hibernation kexec]
 
* [MAJOR - LOW PRIORITY] Suspend and Resume support - Suspend to RAM (STR) (not to share code with STD)
 
* [MAJOR - LOW PRIORITY] Suspend and Resume support - Suspend to RAM (STR) (not to share code with STD)
 
* [MAJOR - LOW PRIORITY] Sysinfo section under Linux for x86 computers (CPU, GPU, chipset, and HDD temperature, etc.)
 
* [MAJOR - LOW PRIORITY] Sysinfo section under Linux for x86 computers (CPU, GPU, chipset, and HDD temperature, etc.)
 
* [MAJOR - LOW PRIORITY] [http://lcdsmartie.sourceforge.net LCD/VFD External Display Panel] support (USB/RS323/I2C connections) via [http://ssl.bulix.org/projects/lcd4linux/ LCD4Linux] or [http://lcdproc.omnipotent.net/index.php3 LCDproc]
 
* [MAJOR - LOW PRIORITY] [http://lcdsmartie.sourceforge.net LCD/VFD External Display Panel] support (USB/RS323/I2C connections) via [http://ssl.bulix.org/projects/lcd4linux/ LCD4Linux] or [http://lcdproc.omnipotent.net/index.php3 LCDproc]
 +
* [MAJOR - LOW PRIORITY] Native 64-bit support (AMD64/EMT64), XBMC and all its libraries to compile on and for 64-bit.
  
===Minor To-Do Tasks with high priority===
+
====Minor To-Do Tasks with high priority====
 
* [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)
 
* [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)
* [MINOR - HIGH PRIORITY] Support anti-aliased text rendering via [http://www.freetype.org FreeType] (FreeType2 to be precise)
 
  
===Minor To-Do Tasks with medium priority===
+
====Minor To-Do Tasks with medium priority====
 +
* [MINOR - MEDIUM PRIORITY] Video adapter / graphic controller settings inside XBMC GUI settings:
 +
** [http://dri.freedesktop.org/wiki/ConfigurationInfrastructure DRI configuration] settings
 +
** xorg.conf configuration settings
 +
** VSYNC enabling/disabling setting
 
* [MINOR - MEDIUM PRIORITY] Complete missing codecs for PAPlayer:
 
* [MINOR - MEDIUM PRIORITY] Complete missing codecs for PAPlayer:
 
** ADPlug
 
** ADPlug
 
** SHN
 
** SHN
* [MINOR - MEDIUM PRIORITY] [http://www.lirc.org Lirc] or alternative implementation for IR/IrDA (infrared) remote support under Linux - ''work in progress''
+
* [MINOR - MEDIUM PRIORITY] [http://www.lirc.org LIRC] or alternative implementation for IR/IrDA (infrared) remote support under Linux - ''work in progress''
 
**Though maybe not possible/best, it might be smart if "IR/IrDA" could be added to [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL] via [http://cmil.sourceforge.net CMIL] for platform-independence(?).
 
**Though maybe not possible/best, it might be smart if "IR/IrDA" could be added to [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL] via [http://cmil.sourceforge.net CMIL] for platform-independence(?).
**Add default mappings to "Lircmap.xml" of the most popular HTPC-remotes (like Microsoft RC6 MCE control-Done, Meedio X10 remote).
+
**Add [http://lirc.sourceforge.net/remotes/ default configurations mappings] to "Lircmap.xml" of the most popular HTPC-remotes (like Microsoft RC6 MCE control-Done, Meedio X10 remote, ATI Remote Wonder, SnapStream Firefly).
 
**Also add [http://winlirc.sourceforge.net WinLIRC] for IR/IrDA (infrared) remote support support under XBMC's Win32 (Microsoft Windows) build for consistency.
 
**Also add [http://winlirc.sourceforge.net WinLIRC] for IR/IrDA (infrared) remote support support under XBMC's Win32 (Microsoft Windows) build for consistency.
  
===Minor To-Do Tasks with low priority===
+
====Minor To-Do Tasks with low priority====
 
* [MINOR - LOW PRIORITY] make sure .AAC plays gapless with PAPlayer
 
* [MINOR - LOW PRIORITY] make sure .AAC plays gapless with PAPlayer
 +
* [MINOR - LOW PRIORITY] Support better anti-aliased text (subpixel accuracy via vertex/pixel shaders) rendering. Basic idea is to cache the characters to an 8 bit texture at 3 times the horizontal resolution, and have that texture loaded into the 3 texture slots, and use a pixel shader/vertex shader to compute the texcoords for each component of the pixel (RGB) to get 1/3rd pixel positioning and antialiasing.  This can probably be extended to even more precise location by increasing the size of the texture cache (eg 2x vertical, 6x horizontal)
  
===Cleanup To-Do Tasks===
+
====Cleanup To-Do Tasks====
 
* [CLEANUP - ALWAYS AN ONGOING PROCESS] Document (doxygenize) all of the current/existing code (using [http://www.doxygen.org doxygen])
 
* [CLEANUP - ALWAYS AN ONGOING PROCESS] Document (doxygenize) all of the current/existing code (using [http://www.doxygen.org doxygen])
 
* [CLEANUP - ALWAYS AN ONGOING PROCESS] [http://valgrind.org/ Valgrind] debugging (also back-port any fixes to the Xbox and Win32 code branch)
 
* [CLEANUP - ALWAYS AN ONGOING PROCESS] [http://valgrind.org/ Valgrind] debugging (also back-port any fixes to the Xbox and Win32 code branch)
===Post-trunk-merger To-Do Tasks===
+
====Post-trunk-merger To-Do Tasks====
After XBMC Linux port reached a certain maturity the "linuxport" branch in SVN will be merged into the "main SVN trunk" which requires:
+
After XBMC Linux port reached a maturity the "linuxport" branch in SVN may be merged into the "main SVN trunk" which will require:
 +
*Merge dllLoader (DLL loader) and soLoader (SO loader), and rename to just "loader", (similar to [http://svn.mplayerhq.hu/mplayer/trunk/loader/ MPlayer cross-platform loader library])
 +
*Merge "Lircmap.xml" into "Keymap.xml" (creating a sub-section in Keymap.xml for LIRC)
 +
 
 +
=Mac OS X porting=
 +
==Mac OS X port plan==
 +
''Disclaimer: This XBMC for Mac OS X port of course excludes all Xbox exclusive functionality (like for example [[Using Trainers|Trainers]], launching Xbox Games, etc.)'':
 +
* '''Milestone 1''' - Get [[XBMC Features and Supported Formats/Codecs|all existing XBMC functionality (features/functions)]] working as they already work on the Xbox version of XBMC.
 +
**During this first phase XBMC will only need to be running under Mac OS X as a third-party application.
 +
* '''Milestone 2''' - Port of Python scripting support, add support for the official Apple Remote with all keymap to fully support XBMC control, AC3 and DTS downmix support, port all of XBMC Virtual File System features (SMB, FTP, UPnP, XBMSP, etc.).
 +
* '''Milestone 3''' - Add Mac OS X specific items (hardware configuration, network settings, multiple input-device support, driver packaging, etc.)
 +
**XBMC package will need to have all the built-in settings for mouse, keyboard, joystick, etc. to act as a shell (without third-party dependencies).
 +
* '''Milestone 4''' - Native 64-bit support, XBMC and all its libraries to be compiled on and for 64-bit.
 +
* '''Milestone ?''' - Yet to be decided.
 +
 
 +
==What has already been done==
 +
*Code fully compiles on [[HOW-TO compile XBMC for Mac OS X from source code|Mac OS X Leopard (32-bit x86)]]
 +
*Full GUI implementation using [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL] (minus on-screen keyboard weirdness)
 +
*Full-screen support (XBMC with 1080p output support that just works!)
 +
**OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
 +
*Picture viewing working (including slideshow and it's effects)
 +
*Video playback using XBMC's own [[DVDPlayer]] core (including DVD-Video menus support)
 +
**AC3/DTS digital passthrough is supported, (analog downmixing is not yet working)
 +
*[[PAPlayer]] and its major audio decoder DLL codecs. Some codecs have still not been ported. See To-Do list below.
 +
**(checkout [[HOW-TO: Debug Dynamic Link Libraries]])
 +
**Hardware accelerated pixel shader (RGB->YUV) with NVIDEA and AMD/ATI graphics
 +
**Software conversion from RGB->YUV on other graphics cards due to lack of proper OpenGL support (tested on Intel)
 +
*Weather
 +
*Visualization - Project M OpenGL vis (some issues need to be worked out)
 +
*Networking (though some small issues still need to be sorted out)
 +
*Video thumbnails, IMDb, TheTVDB, AllMusic lookups, etc.
 +
 
 +
==To-Do list for the Mac OS X port==
 +
This is a '''To-Do list''' of things that still need to be done in XBMC for '''Mac OS X''', anyone is more than welcome to help out with any of these tasks:
 +
====Major To-Do tasks with high priority====
 +
* [MAJOR - MAJOR PRIORITY] DVDPlayer porting to Mac OS X - work in progress. Open Issues:
 +
** Partial support for external subtitles (SRT and DVD-Video/VobSub subtitles are currently supported)
 +
** No good support for streaming video from the internet (HTTP/HTTPS/UDP/RTSP/RTP/RTCP/RDT/SDP/MMS)
 +
** Deinterlacing (software and hardware)
 +
* [MAJOR - MAJOR PRIORITY] AC3 and DTS downmix support in software (for analog stereo output)
 +
* [MAJOR - MAJOR PRIORITY] Python interpreter (and python scripts/libraries)
 +
* [MAJOR - MAJOR PRIORITY] Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time)
 +
** Also all network settings needed available to the end-user from the the XBMC GUI settings section.
 +
* [MAJOR - MAJOR PRIORITY] Virtual File System support (work on SMB, UPnP, RTV, DAAP. TuxBox and XBMSP has not yet begun)
 +
* [MAJOR - MAJOR PRIORITY] Apple Remote control support using LIRC (from macports).
 +
* [MAJOR - MAJOR PRIORITY] Gamepad/joystick support (Xbox orginal wired gamepad, Xbox 360 wireless and wired gamepad).
 +
*[MAJOR - MAJOR PRIORITY] More OpenGL visualization - Spectrum Analyzer and Waveform.
 +
 
 +
====Major To-Do tasks with medium priority====
 +
* [MAJOR - MEDIUM PRIORITY] Development of a [[OpenGL_DirectX_Interface|platform-independent wrapper interface]] to SDL / DirectX / OpenGL /  graphic backend interfaces, particularly with respect to how this interface should be exported to visualisations (.vis) and screensavers (.xscr), etc.
 +
* [MAJOR - MEDIUM PRIORITY] NTSC and PAL-50/PAL-60 TV-out settings for composite, S-Video and standard-definition component.
 +
* [MAJOR - MEDIUM PRIORITY] Audio-output hardware settings (and if user got AC3 / DTS capable reciever or not)
 +
**Stereo, head-phones, 4.1, 5.1, 6.1, 7.1, SPDIF pass-through, etc.
 +
* [MAJOR - MEDIUM PRIORITY] Support [[USB Mass Storage support in XBMC|USB Mass Storage]] disks dynamically (meaning, inserted/removed after boot)
 +
* [MAJOR - MEDIUM PRIORITY] [http://www.xboxmediacenter.com/forum/showthread.php?t=137 Visualisations]: Port all existing XBMC visualizations to also support OpenGL
 +
* [MAJOR - MEDIUM PRIORITY] [http://www.xboxmediacenter.com/forum/showthread.php?t=7552 Screensavers]: Port all existing XBMC screensavers to also support OpenGL
 +
**Some kind of detection code and tags will have to be added so only supported .vis is listed under system platform
 +
* [MAJOR - MEDIUM PRIORITY] "My Programs" section for Mac OS X (to launch other Mac OS X games/applications/emulators)
 +
* [MAJOR - MEDIUM PRIORITY] [[MPlayer]] porting to Mac OS X
 +
 
 +
====Major To-Do tasks with low priority====
 +
* [MAJOR - LOW PRIORITY] [[Hardware Accelerated Video Decoding]] offloading to the GPU in some shape or form.
 +
**[[Hardware Accelerated Video Decoding|The possible methods are GLSL or Cg Pixel Shader (Shader Model 3.0), and/or GPGPU technology]]
 +
* [MAJOR - LOW PRIORITY] Credits (make it support DirectX and OpenGL, detect platform. Plus add some [http://developer.download.nvidia.com/shaderlibrary/webpages/shader_library.html eye-candy])
 +
* [MAJOR - LOW PRIORITY] Sysinfo section under Mac OS X for x86 computers (CPU, GPU, chipset, and HDD temperature, etc.)
 +
* [MAJOR - LOW PRIORITY] [http://lcdsmartie.sourceforge.net LCD/VFD External Display Panel] support (USB/RS323/I2C connections)
 +
* [MAJOR - LOW PRIORITY] Native 64-bit support (AMD64/EMT64), XBMC and all its libraries to compile on and for 64-bit.
 +
 
 +
====Minor To-Do Tasks with high priority====
 +
* [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)
 +
 
 +
====Minor To-Do Tasks with medium priority====
 +
* [MINOR - MEDIUM PRIORITY] Video adapter / graphic controller settings inside XBMC GUI settings:
 +
** VSYNC enabling/disabling setting
 +
* [MINOR - MEDIUM PRIORITY] Complete missing codecs for PAPlayer:
 +
** ADPlug
 +
** SHN
 +
* [MINOR - MEDIUM PRIORITY] [http://www.lirc.org LIRC] or alternative implementation for IR/IrDA (infrared) remote support under Mac OS X
 +
**Though maybe not possible/best, it might be smart if "IR/IrDA" could be added to [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL] via [http://cmil.sourceforge.net CMIL] for platform-independence(?).
 +
**Add [http://lirc.sourceforge.net/remotes/ default configurations mappings] to "Lircmap.xml" of the most popular HTPC-remotes (like Apple Remote, Microsoft RC6 MCE control-Done, Meedio X10 remote, ATI Remote Wonder, SnapStream Firefly).
 +
 
 +
====Minor To-Do Tasks with low priority====
 +
* [MINOR - LOW PRIORITY] make sure .AAC plays gapless with PAPlayer
 +
* [MINOR - LOW PRIORITY] Support better anti-aliased text (subpixel accuracy via vertex/pixel shaders) rendering. Basic idea is to cache the characters to an 8 bit texture at 3 times the horizontal resolution, and have that texture loaded into the 3 texture slots, and use a pixel shader/vertex shader to compute the texcoords for each component of the pixel (RGB) to get 1/3rd pixel positioning and antialiasing.  This can probably be extended to even more precise location by increasing the size of the texture cache (eg 2x vertical, 6x horizontal)
 +
 
 +
====Cleanup To-Do Tasks====
 +
* [CLEANUP - ALWAYS AN ONGOING PROCESS] Document (doxygenize) all of the current/existing code (using [http://www.doxygen.org doxygen])
 +
* [CLEANUP - ALWAYS AN ONGOING PROCESS] debugging (also back-port any fixes to the Xbox branch)
 +
====Post-trunk-merger To-Do Tasks====
 +
After this XBMC for Mac OS X port reached a maturity the "linuxport" branch in SVN may or may not be merged into the "main SVN trunk" and if so would require:
 
*Merge dllLoader (DLL loader) and soLoader (SO loader), and rename to just "loader", (similar to [http://svn.mplayerhq.hu/mplayer/trunk/loader/ MPlayer cross-platform loader library])
 
*Merge dllLoader (DLL loader) and soLoader (SO loader), and rename to just "loader", (similar to [http://svn.mplayerhq.hu/mplayer/trunk/loader/ MPlayer cross-platform loader library])
 
*Merge "Lircmap.xml" into "Keymap.xml" (creating a sub-section in Keymap.xml for LIRC)
 
*Merge "Lircmap.xml" into "Keymap.xml" (creating a sub-section in Keymap.xml for LIRC)
Line 231: Line 344:
 
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. Initial [[HOW-TO submit a patch|patches are welcome]], and can and will be merged by the team. If you wish to [[Apply to join the Official XBMC Development-Team|join the team in an official capacity]], please let us know.
 
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. Initial [[HOW-TO submit a patch|patches are welcome]], and can and will be merged by the team. If you wish to [[Apply to join the Official XBMC Development-Team|join the team in an official capacity]], please let us know.
  
==Linux port mentors and developers==
+
==Linux and Mac OS X port mentors and developers==
If you are a C/C++ porting expert, specialist or guru and like to volunteer as a ''''third-party'''' mentor and/or developer then please let us know.
+
If you are a C/C++ programmer expert, porting specialist or guru and like to volunteer as a ''''third-party'''' mentor and/or developer then please let us know.
 
===Linux Mentors (also lead developers)===
 
===Linux Mentors (also lead developers)===
 
* [[User:Yuvalt|Yuvalt]]: Everything Linux
 
* [[User:Yuvalt|Yuvalt]]: Everything Linux
 
* [[User:Vulkanr|Vulkanr]]: Everything Linux
 
* [[User:Vulkanr|Vulkanr]]: Everything Linux
* [[User:Elupus|Elupus]]: DllLoader, Mplayer and DVDPlayer
 
* [[User:Spiff|Spiff]]: Anything other than DllLoader/MPlayer/DVDPlayer internals.
 
 
* [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
 
* [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
 
* [[User:D4rk|D4rk]]: OpenGL, other Linux stuff
 
* [[User:D4rk|D4rk]]: OpenGL, other Linux stuff
 +
* [[User:Elupus|Elupus]]: DllLoader, Mplayer and DVDPlayer
 +
* [[User:Spiff|Spiff]]: Anything other than DllLoader/MPlayer/DVDPlayer internals.
 +
* [[User:monkeyman 67156|monkeyman 67156]]: Everything Linux
 +
* [[User:Topfs2|Topfs2]]: Everything Linux
 +
====Mac OS X Mentors (also lead developers)====
 +
* [[User:elan|elan (a.k.a. leafmuncher)]]: Everything Mac OS X
  
 
=Contact methods=
 
=Contact methods=
Line 245: Line 362:
 
Respect, these are not for posting feature-requests or end-user support requests!
 
Respect, these are not for posting feature-requests or end-user support requests!
 
* IRC: [irc://irc.freenode.net/xbmc-linux #xbmc-linux on freenode] official [http://freenode.net IRC network channel] for the XBMC Linux port project
 
* 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])
+
**(You may also sometimes find developers hanging out at [irc://irc.freenode.net/xbmc #xbmc on freenode])
* [http://www.xboxmediacenter.com/forum/forumdisplay.php?f=41 XBMC Linuxport Community-Forum]
+
* 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://www.xboxmediacenter.com/forum/forumdisplay.php?f=41 XBMC for Linux port Community-Forum for developers only]
 +
** [http://xboxmediacenter.com/forum/forumdisplay.php?f=52 XBMC for Linux port Community-Forum for end-users (unmoderated so far)]
 +
* [http://www.xboxmediacenter.com/forum/forumdisplay.php?f=57 XBMC for Mac OS X port Community-Forum for developers only]
 +
** [http://www.xboxmediacenter.com/forum/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)
 
* [[HOW-TO submit a patch]] (where and how to submit source code)
  

Revision as of 09:24, 7 February 2008

Template:Current event

Currently, a few developers on Team-XBMC have begun the porting of XBMC to Linux (and OpenGL using the SDL toolkit). The goal is for this to become a full port of XBMC with all the features and functions that are available on the Xbox version of XBMC (with the exception of Xbox exclusive functionality such as Trainers, launching Xbox Games, etc). This is a huge task, which is why we are now making this public request, seeking C/C++ programmers to volunteer in assisting us with this Linux porting development project. Whether you have contributed to The XBMC Project in the past or not, please consider doing so now. Those of you who are completely unfamiliar with XBMC can get a good overview of what XBMC offers for its end-users by reading through the XBMC article on wikipedia.org

Note to XBMC end-users! Please understand that this Linux port project is not yet mature enough for a regular end-user to play with. We can not yet give you an ETA as to when it will be useful for end-users. Respect that we can not accept any bug-reports or feature/function-requests for this Linux port yet, nor do we offer support to end-users. If you are an end-user and have any general questions or need to get something off your chest about this then please direct that towards the existing XBMC Linux port end-user discussion topic-thread in our community-forum. If, however, you are a developer or have Linux expertise, we encourage you to keep reading to find out how you can help.

Contents

1 What is XBMC and why port it to Linux?

For the developers who does not know this; XBMC (short for XBox Media Center, not to be confused with Microsoft's Windows Media Center Extender for the Xbox) is an award-winning free and open source media player, originally designed to run on the Xbox game-console. The GPL/LGPL licensed source code basically consist of a GUI framework that has been written from scratch by Team-XBMC, this GUI acts as a front-end control interface for several audio/video players designed for specific purposes (and those are loaded when needed as DLLs), the GUI is also the user interface to all of XBMC multimedia handling functions such as databases and sorting, etc.. The XBMC Project, (who's members maintain XBMC source code), is a non-profit open source hobby project that is developed by volunteers in their spare-time without any monetary gain. The team of developers working on XBMC have always encouraged anyone to submit your own source code patches for new features or functions, improve on existing ones, or fix bugs.

The difference this time is that we are not asking for new features/functions, what we are asking is for the existing code to be ported so it will compile and run under a Linux operating-system (with the same features/functions that are already available on the Xbox version of XBMC). The main reasons for porting XBMC to Linux are non-technical, (so it is not that the Xbox hardware is too slow or to old for the XBMC GUI or its existing features/functions), the real reasons are that we want XBMC to get a larger end-user and developer-base, because the more people who use XBMC and help maintain the code (and skins) the longer the project will grow and stay alive. The main reason from an end-user point of view is that the Xbox can not playback native high-definition video (at 720p and 1080i/1080p), especially not if the video is encoded with a H.264 or VC-1 codec. Nevertheless, note that we will still keep the old Xbox as the reference platform for standard-definition resolution video for some time (possibly a few more years), which means that the same GUI (and skins) that runs smooth under Linux on a relatively new computer must also run just as smooth on the old Xbox hardware (or a old computer that closely matches the Xbox hardware, at 733Mhz Intel Pentium III CPU and only 64MB shared memory with supported 3D accelerator).

2 Skill requirements and where to start

Proficient in C/C++ programming language, and though not required knowledge of DirectX, Direct3D, OpenGL and/or multimedia programming is a plus, as well as prior cross-platform or porting development experience. You do not need to have access to an Xbox game-console or any special tools/software in order to take part - XBMC development is well underway on Linux (32-bit Ubuntu for x86).

2.1 Where do I start (Linux)?

The recommended Linux development platform is currently 32-bit Ubuntu (for x86). There is a Kdevelop project file available in our SVN (Subversion revision control system). After you've done a SVN checkout, follow the install guide in the SVN (README.linux) to setup the required packages and so on. Team-XBMC developers think that the best thing to start with is just to take a look through the source code and try to understand how it all fits together. Test things out, find what works and what does not, then try and track down why.

Alternatively, you can download a finished VMware Virtual Machine (VM) and run that in the free VMware Player (or use in VMware Workstation, or VMware Server). The VM available for download below is based on Ubuntu Desktop (32-bit for x86), and all the prerequisite software is installed (including KDevelop). Performance is not great using this, as there is no 3D hardware acceleration support under a virtual machine, however it should work good enough to get a lot of development tasks done without you having to bother with install of Ubuntu yourself. Nice is also that you can install/run VMware Player 2.0 and later under Linux as well as Microsoft Windows (including Windows Vista), 32-bit and 64-bit operating-system. The free VMware Player 2.0 and later also enables you to share data seamlessly between the virtual machine and host computer, and also allows you to directly access USB 2.0 devices from within the virtual machine, (experimental support for 2-way Virtual SMP to assign more than a single CPU to a virtual machine is also available for testing purposes).

  • Download: VMware Virtual Machine (VM) with Ubuntu 7.0.4 Desktop and KDevelop (userid/password is: xbmc/xbmc).
    • Besides from KDevelop, additional development tools included are Subcommander, Doxygen, Sysprof, and PowerTop.
      • Note! In order for the PowerTop tool to actually show data, a new kernel needs to be built by yourself.
    • Our thanks goes out to tssgery for creating and hosting this first VM for the XBMC Linux port development effort.

2.1.1 Hardware requirements

2.2 XBMC Linux port FAQ for developers

2.2.1 Can non-Linux developers also help?

XBMC can also be compiled for Win32 (Microsoft Windows) operating-systems with Microsoft Visual Studio .NET 2003 (7.1) or higher, or for Mac OS X with Eclipse, so even though Team-XBMC will be focusing on the Linux port of XBMC, it will not hurt if some people who prefer and feel comfortable with Microsoft Visual Studio or Eclipse as a development platform also volunteer to help with getting the Win32 port of XBMC and Mac OS X builds up to par with the Linux and Xbox versions, this as a preparation for possible future cross-platform versions of XBMC.

2.2.2 Why is OpenGL 2.0 needed for XBMC?

Currently OpenGL 2.0 is needed for:

  • Any deinterlacing that is not linear blending which FFmpeg does
  • Video video post-processing filtering (bicubic upscaling, etc.)
  • Non-power of two textures for the GUI (using NPOT saves a lot of texture memory)
  • Hardware accelerated YUV 2 RGB conversion (actually GLSL is needed for this, and some OpenGL 1.5 implementations provide GLSL as an extension. OpenGL 2.0 guarantees availability of GLSL).

In the future OpenGL 2.0 might also be needed for:

3 Other tools and resources

Though any other tools or resources are not required they can possibly help in development.

3.1 Development Tools

  • Doxygen - Source code documentation generator tool.
  • Valgrind (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling.
  • Sysprof (for Linux) - a free System-wide Linux Profiler for tracking CPU usage.
  • VTune Analyzer Intel® VTune™ Performance Analyzer for Linux (free for non-Commercial use)
  • LessWatts.org - Projects for saving power with Linux on intel-based platforms.
    • PowerTOP - utility by Intel for detecting what Linux programs and kernel tunables are resulting in the most power consumption.
    • Tickless Idle - eliminats the periodic timer tick when the CPU is idle.
  • Intel® Threading Building Blocks (Intel® TBB) for Linux - Threading Analysis Tool by Intel (free for non-Commercial use)
  • Intel® Thread Checker for Linux - Another Threading Analysis Tool by Intel (free for non-Commercial use)
  • Dependency walker (for Microsoft Windows) - a free program used to list the imported and exported functions of a portable executable.
  • HLSL2GLSL - library and tool that converts HLSL (High Level Shader Language) shaders to GLSL (OpenGL Shading Language)
  • SHARK (Shader Assembly Compiler) - a tool to perform conversion from DirectX 9 pixel shader assembly language into C++ code
  • AMD/ATI GPU ShaderAnalyzer - Support for both Open GL GLSL and DirectX HLSL
  • gDEBugger - OpenGL debugger and Profiler (helping to find bugs and optimize performance)
  • KAGEfx - a framework to load shader programs based on the OpenGL Shading Language contained within an XML file that holds descriptive metadata about the shader and to replace shader modules on-the-fly with respect to their level-of-detail metadata.

3.2 Development Resources

3.3 Third-party libraries

This is a list of third-party cross-platform libraries that you may or may not want to use in the porting process, you decide:

3.3.1 Graphics and image

  • GLEW (The OpenGL Extension Wrangler Library) for OpenGL hardware support version detection
  • Anti-Grain Geometry - High Quality Rendering Engine (High Fidelity 2D Graphics Renderer) for C++
  • DirectX OpenGL Wrapper - emulates API calls through OpenGL commands and other platform specific commands in order to run DirectX 8 application running on other platform than Windows.
  • Intel Open Source Computer Vision (OpenCV) Library Intel's Image Processing Library
  • GLVU - cross-platform C++/OpenGL/GLUT based 3D OpenGL viewer and collection of utility libraries
    • You can use all these components together, or just take bits and pieces that do what you need
  • Glitz - OpenGL image composting library (enabling features like convolution filters and color gradients)
  • SDL_buffer - a SDL extension library that is useful when you have to re-size an image multiple times.
  • SDL_Resize - basic image resizing library, high quality output suited for pre-rendering images.
  • SDL_bgrab - SDL conversion of libbgrab (a framegrabber lib from the same author).

3.3.2 Interactive interface

3.3.3 Networking

  • SDL_net - a simple cross-platform network library

3.3.4 Performance

3.3.5 Convenience

  • SDL_Config - Library designed for reading and writing configuration (.ini) files in an easy, cross-platform way.
  • navfs - Hard drive abstraction layer C library, allowing easy directory navigation.
  • GLVU - cross-platform C++/OpenGL/GLUT based 3D OpenGL viewer and collection of utility libraries
    • You can use all these components together, or just take bits and pieces that do what you need:
      • File libs (glvu/fileutils) -C ross-platform routines for searching directories, and manipulating filenames
      • Thread lib (glvu/thread) - An OK thread library that works cross-platform
      • Timer class (glvu/timer) - Time your code to see how long stuff is taking!
      • GL Utilities (glvu/glutils) - Functions for managing textures and doing framebuffer readback and stuff
      • Other stuff . Various other handy things that may or may not be useful

4 Technical summary of XBMC

4.1 The basics

The XBMC code structure uses a fairly modular design (with libraries and DLLs), and we think that there are enough modules/libraries to keep a wide skill-level range of developers busy for a while in the porting of them all. So please, take a look at the source code, then with the help of our To-Do list (see further down in this article) assess where the porting stage is today and think about where and how you can try to help out. Note that we are not planning on completely abandoning the Xbox hardware any time soon - XBMC will be a cross-platform software application, using the same code on multiple hardware platforms, (the 'old' Xbox still have a good amount of years to live we hope).

4.2 Detailed technical information

For more details please visit the Development Notes section of this manual.

4.3 The XBMC source code

The XBMC source code is in our SVN repository on sourceforge.net. Full instructions for compiling/builing XBMC under Linux is available here:

5 Linux porting

5.1 The Linux port plan

Disclaimer: XBMC Linux port of course excludes all Xbox exclusive functionality (like for example Trainers, launching Xbox Games, etc.):

  • Milestone 1 - Get all existing XBMC functionality (features/functions) working as they already work on the Xbox version of XBMC.
  • Milestone 2 - Add Linux specific items (hardware configuration, network settings, multiple input-device support, driver packaging, etc.)
    • During this phase support will be added to also run XBMC as its own Window Manager / Windowing system (without KDE/GNOME)
    • XBMC will need to have all the built-in settings for mouse, keyboard, joystick, etc. to act as a shell (without third-party dependencies)
  • Milestone 3 - Package XBMC with a stripped version of an existing Linux distribution as a bootable LiveDistro (a.k.a. Live CD) (alternatively our own custom Distribution)
  • Milestone 4 - Native 64-bit support (AMD64/EMT64), XBMC and all its libraries to be compiled on and for 64-bit.
  • Milestone ? - Yet to be decided; after XBMC Linux port reached a certain maturity the "linuxport" branch in SVN might be merged into the "main SVN trunk.
    • At this point in time it is impossible to say exactly when and at what stage or even if this merger will ever happen.

5.2 What has already been done

  • Kdevelop project file available in SVN
    • Linux development and debug environment
  • Code fully compiles on [HOW-TO compile XBMC for Linux from source code|Ubuntu Deskop Linux (32-bit x86)]
  • GUI implementation of SDL
    • OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
    • SDL using 2D blitting, working but relies on computer CPU, not recommended (XBMC requires 24bpp to run, so if your graphic card doesn't have 3D accel for 24bpp -as i810 ones- then you have to compile using the option 'make sdl_2d')
  • Picture viewing working (including slideshow and it's effects)
  • SMB network shares
  • PAPlayer and its major audio decoder DLL codecs. Some codecs have still not been ported. See To-Do list below.
  • Video playback using our DVDPlayer core
    • Hardware accelerated pixel shader (RGB->YUV) with Nvidia and ATI
    • Software conversion from RGB->YUV on other graphics cards due to lack of proper OpenGL support (tested on Intel)
  • Weather
  • Basic python scripting
  • Visualization - OpenGL spectrum analyzer, Waveform, ProjectM (some issues need to be worked out)
  • Remote control support using LIRC
  • Gamepad/joystick support

5.3 To-Do

This is a To-Do list of things that still need to be done, anyone is more than welcome to help out with any of these tasks:

5.3.1 Major To-Do tasks with high priority

  • DVDPlayer porting to Linux - work in progress. Open Issues:
    • Partial support for external subtitles (SRT and DVD-Video/VobSub subtitles are currently supported)
    • No good support for streaming video from the internet (HTTP/HTTPS/UDP/RTSP/RTP/RTCP/RDT/SDP/MMS)
    • Deinterlacing (software and hardware)
  • Python interpreter (and python scripts/libraries) - work in progress (in early stages). Open Issues:
    • Start the same script a few times and it crashes
    • Some crashes in TransformMatrix
  • Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time)
    • Also all network settings needed available to the end-user from the the XBMC GUI settings section.
  • Filesystem support is partial (local, SMB, UPnP, RTV, DAAP. TuxBox and XBMSP is currently supported)

5.3.2 Major To-Do tasks with medium priority

  • [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / OpenGL / graphic backend interfaces, particularly with respect to how this interface should be exported to visualisations (.vis) and screensavers (.xscr), etc.
  • [MAJOR - MEDIUM PRIORITY] NTSC and PAL-50/PAL-60 TV-out settings for composite, S-Video and standard-definition component
  • [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / ALSA /OSS / OpenAL audio backend interfaces.
  • [MAJOR - MEDIUM PRIORITY] Audio-output hardware settings (and if user got AC3 / DTS capable reciever or not)
    • Stereo, head-phones, 4.1, 5.1, 6.1, 7.1, S/PDIF pass-through, etc.
  • [MAJOR - MEDIUM PRIORITY] Support USB Mass Storage disks dynamically (meaning, inserted/removed after boot)
  • [MAJOR - MEDIUM PRIORITY] Visualisations: Port all existing XBMC visualizations to also support OpenGL/Linux
  • [MAJOR - MEDIUM PRIORITY] Screensavers: Port all existing XBMC screensavers to also support OpenGL/Linux
    • Some kind of detection code and tags will have to be added so only supported .vis is listed under system platform
  • [MAJOR - MEDIUM PRIORITY] "My Programs" section for Linux (to launch Linux games/applications/emulators)
  • [MAJOR - MEDIUM PRIORITY] MPlayer porting to Linux

5.3.3 Major To-Do tasks with low priority

  • [MAJOR - LOW PRIORITY] Hardware Accelerated Video Decoding offloading to the GPU in some shape or form.
  • [MAJOR - LOW PRIORITY] Credits (make it support DirectX and OpenGL, detect platform. Plus add some eye-candy)
  • [MAJOR - LOW PRIORITY] Hibernation - Suspend to Disk (STD) (code should be completly different from STR)
    • Hibernation (Suspend to Disk), only if could somehow be used to speed up the initial boot-time. See kexec
  • [MAJOR - LOW PRIORITY] Suspend and Resume support - Suspend to RAM (STR) (not to share code with STD)
  • [MAJOR - LOW PRIORITY] Sysinfo section under Linux for x86 computers (CPU, GPU, chipset, and HDD temperature, etc.)
  • [MAJOR - LOW PRIORITY] LCD/VFD External Display Panel support (USB/RS323/I2C connections) via LCD4Linux or LCDproc
  • [MAJOR - LOW PRIORITY] Native 64-bit support (AMD64/EMT64), XBMC and all its libraries to compile on and for 64-bit.

5.3.4 Minor To-Do Tasks with high priority

  • [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)

5.3.5 Minor To-Do Tasks with medium priority

  • [MINOR - MEDIUM PRIORITY] Video adapter / graphic controller settings inside XBMC GUI settings:
    • DRI configuration settings
    • xorg.conf configuration settings
    • VSYNC enabling/disabling setting
  • [MINOR - MEDIUM PRIORITY] Complete missing codecs for PAPlayer:
    • ADPlug
    • SHN
  • [MINOR - MEDIUM PRIORITY] LIRC or alternative implementation for IR/IrDA (infrared) remote support under Linux - work in progress
    • Though maybe not possible/best, it might be smart if "IR/IrDA" could be added to SDL via CMIL for platform-independence(?).
    • Add default configurations mappings to "Lircmap.xml" of the most popular HTPC-remotes (like Microsoft RC6 MCE control-Done, Meedio X10 remote, ATI Remote Wonder, SnapStream Firefly).
    • Also add WinLIRC for IR/IrDA (infrared) remote support support under XBMC's Win32 (Microsoft Windows) build for consistency.

5.3.6 Minor To-Do Tasks with low priority

  • [MINOR - LOW PRIORITY] make sure .AAC plays gapless with PAPlayer
  • [MINOR - LOW PRIORITY] Support better anti-aliased text (subpixel accuracy via vertex/pixel shaders) rendering. Basic idea is to cache the characters to an 8 bit texture at 3 times the horizontal resolution, and have that texture loaded into the 3 texture slots, and use a pixel shader/vertex shader to compute the texcoords for each component of the pixel (RGB) to get 1/3rd pixel positioning and antialiasing. This can probably be extended to even more precise location by increasing the size of the texture cache (eg 2x vertical, 6x horizontal)

5.3.7 Cleanup To-Do Tasks

  • [CLEANUP - ALWAYS AN ONGOING PROCESS] Document (doxygenize) all of the current/existing code (using doxygen)
  • [CLEANUP - ALWAYS AN ONGOING PROCESS] Valgrind debugging (also back-port any fixes to the Xbox and Win32 code branch)

5.3.8 Post-trunk-merger To-Do Tasks

After XBMC Linux port reached a maturity the "linuxport" branch in SVN may be merged into the "main SVN trunk" which will require:

  • Merge dllLoader (DLL loader) and soLoader (SO loader), and rename to just "loader", (similar to MPlayer cross-platform loader library)
  • Merge "Lircmap.xml" into "Keymap.xml" (creating a sub-section in Keymap.xml for LIRC)

6 Mac OS X porting

6.1 Mac OS X port plan

Disclaimer: This XBMC for Mac OS X port of course excludes all Xbox exclusive functionality (like for example Trainers, launching Xbox Games, etc.):

  • Milestone 1 - Get all existing XBMC functionality (features/functions) working as they already work on the Xbox version of XBMC.
    • During this first phase XBMC will only need to be running under Mac OS X as a third-party application.
  • Milestone 2 - Port of Python scripting support, add support for the official Apple Remote with all keymap to fully support XBMC control, AC3 and DTS downmix support, port all of XBMC Virtual File System features (SMB, FTP, UPnP, XBMSP, etc.).
  • Milestone 3 - Add Mac OS X specific items (hardware configuration, network settings, multiple input-device support, driver packaging, etc.)
    • XBMC package will need to have all the built-in settings for mouse, keyboard, joystick, etc. to act as a shell (without third-party dependencies).
  • Milestone 4 - Native 64-bit support, XBMC and all its libraries to be compiled on and for 64-bit.
  • Milestone ? - Yet to be decided.

6.2 What has already been done

  • Code fully compiles on Mac OS X Leopard (32-bit x86)
  • Full GUI implementation using SDL (minus on-screen keyboard weirdness)
  • Full-screen support (XBMC with 1080p output support that just works!)
    • OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
  • Picture viewing working (including slideshow and it's effects)
  • Video playback using XBMC's own DVDPlayer core (including DVD-Video menus support)
    • AC3/DTS digital passthrough is supported, (analog downmixing is not yet working)
  • PAPlayer and its major audio decoder DLL codecs. Some codecs have still not been ported. See To-Do list below.
    • (checkout HOW-TO: Debug Dynamic Link Libraries)
    • Hardware accelerated pixel shader (RGB->YUV) with NVIDEA and AMD/ATI graphics
    • Software conversion from RGB->YUV on other graphics cards due to lack of proper OpenGL support (tested on Intel)
  • Weather
  • Visualization - Project M OpenGL vis (some issues need to be worked out)
  • Networking (though some small issues still need to be sorted out)
  • Video thumbnails, IMDb, TheTVDB, AllMusic lookups, etc.

6.3 To-Do list for the Mac OS X port

This is a To-Do list of things that still need to be done in XBMC for Mac OS X, anyone is more than welcome to help out with any of these tasks:

6.3.1 Major To-Do tasks with high priority

  • [MAJOR - MAJOR PRIORITY] DVDPlayer porting to Mac OS X - work in progress. Open Issues:
    • Partial support for external subtitles (SRT and DVD-Video/VobSub subtitles are currently supported)
    • No good support for streaming video from the internet (HTTP/HTTPS/UDP/RTSP/RTP/RTCP/RDT/SDP/MMS)
    • Deinterlacing (software and hardware)
  • [MAJOR - MAJOR PRIORITY] AC3 and DTS downmix support in software (for analog stereo output)
  • [MAJOR - MAJOR PRIORITY] Python interpreter (and python scripts/libraries)
  • [MAJOR - MAJOR PRIORITY] Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time)
    • Also all network settings needed available to the end-user from the the XBMC GUI settings section.
  • [MAJOR - MAJOR PRIORITY] Virtual File System support (work on SMB, UPnP, RTV, DAAP. TuxBox and XBMSP has not yet begun)
  • [MAJOR - MAJOR PRIORITY] Apple Remote control support using LIRC (from macports).
  • [MAJOR - MAJOR PRIORITY] Gamepad/joystick support (Xbox orginal wired gamepad, Xbox 360 wireless and wired gamepad).
  • [MAJOR - MAJOR PRIORITY] More OpenGL visualization - Spectrum Analyzer and Waveform.

6.3.2 Major To-Do tasks with medium priority

  • [MAJOR - MEDIUM PRIORITY] Development of a platform-independent wrapper interface to SDL / DirectX / OpenGL / graphic backend interfaces, particularly with respect to how this interface should be exported to visualisations (.vis) and screensavers (.xscr), etc.
  • [MAJOR - MEDIUM PRIORITY] NTSC and PAL-50/PAL-60 TV-out settings for composite, S-Video and standard-definition component.
  • [MAJOR - MEDIUM PRIORITY] Audio-output hardware settings (and if user got AC3 / DTS capable reciever or not)
    • Stereo, head-phones, 4.1, 5.1, 6.1, 7.1, SPDIF pass-through, etc.
  • [MAJOR - MEDIUM PRIORITY] Support USB Mass Storage disks dynamically (meaning, inserted/removed after boot)
  • [MAJOR - MEDIUM PRIORITY] Visualisations: Port all existing XBMC visualizations to also support OpenGL
  • [MAJOR - MEDIUM PRIORITY] Screensavers: Port all existing XBMC screensavers to also support OpenGL
    • Some kind of detection code and tags will have to be added so only supported .vis is listed under system platform
  • [MAJOR - MEDIUM PRIORITY] "My Programs" section for Mac OS X (to launch other Mac OS X games/applications/emulators)
  • [MAJOR - MEDIUM PRIORITY] MPlayer porting to Mac OS X

6.3.3 Major To-Do tasks with low priority

6.3.4 Minor To-Do Tasks with high priority

  • [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)

6.3.5 Minor To-Do Tasks with medium priority

  • [MINOR - MEDIUM PRIORITY] Video adapter / graphic controller settings inside XBMC GUI settings:
    • VSYNC enabling/disabling setting
  • [MINOR - MEDIUM PRIORITY] Complete missing codecs for PAPlayer:
    • ADPlug
    • SHN
  • [MINOR - MEDIUM PRIORITY] LIRC or alternative implementation for IR/IrDA (infrared) remote support under Mac OS X
    • Though maybe not possible/best, it might be smart if "IR/IrDA" could be added to SDL via CMIL for platform-independence(?).
    • Add default configurations mappings to "Lircmap.xml" of the most popular HTPC-remotes (like Apple Remote, Microsoft RC6 MCE control-Done, Meedio X10 remote, ATI Remote Wonder, SnapStream Firefly).

6.3.6 Minor To-Do Tasks with low priority

  • [MINOR - LOW PRIORITY] make sure .AAC plays gapless with PAPlayer
  • [MINOR - LOW PRIORITY] Support better anti-aliased text (subpixel accuracy via vertex/pixel shaders) rendering. Basic idea is to cache the characters to an 8 bit texture at 3 times the horizontal resolution, and have that texture loaded into the 3 texture slots, and use a pixel shader/vertex shader to compute the texcoords for each component of the pixel (RGB) to get 1/3rd pixel positioning and antialiasing. This can probably be extended to even more precise location by increasing the size of the texture cache (eg 2x vertical, 6x horizontal)

6.3.7 Cleanup To-Do Tasks

  • [CLEANUP - ALWAYS AN ONGOING PROCESS] Document (doxygenize) all of the current/existing code (using doxygen)
  • [CLEANUP - ALWAYS AN ONGOING PROCESS] debugging (also back-port any fixes to the Xbox branch)

6.3.8 Post-trunk-merger To-Do Tasks

After this XBMC for Mac OS X port reached a maturity the "linuxport" branch in SVN may or may not be merged into the "main SVN trunk" and if so would require:

  • Merge dllLoader (DLL loader) and soLoader (SO loader), and rename to just "loader", (similar to MPlayer cross-platform loader library)
  • Merge "Lircmap.xml" into "Keymap.xml" (creating a sub-section in Keymap.xml for LIRC)

7 XBMC programming and code formatting convention guidelines

Note! More specifics to come based on ongoing discussions, see Proposed code formatting conventions for XBMC

7.1 General guidelines

  • Code documentation (DocBook, rst, or doxygen for the code documentation steps, preferably the latter, doxygen)
  • Self-containment - XBMC should be as little dependent as possible on operating-system and third-party services/deamons/libraries
    • XBMC should for example contain all file-system and network-client (like samba) support built-into the XBMC package
  • Modular design - independent modules made up by localized/isolated code libraries without dependencies
    • XBMC should still compile and run if a non-essencial module/library is disabled or removed
  • Aim for the GUI/interface to run smoothly on a low spec computer (less than 1Ghz)
    • 3D graphic controller (GPU) will always be required hardware for XBMC so try to utilize the GPU as much as possible
  • Avoid harddisk trashing (excess read/write/erase cycles), so no harddrive paging, (utilize RAM memory intead).
    • End-users will be running XBMC and the operating-system on Solid-State memory as a Live CD (LiveDistro) of a USB-key
  • Fast load and boot times for end-user perception (other thing can still run/start in the background without the user knowledge)
    • 15-seconds or less from when the end user press the power-button on the computer till he/she can browse the GUI --pike 06:00, 14 June 2007 (CEST)unrealistic goal for Linux, isn't it?

7.2 User-friendliness is next to godlyness

One of Team-XBMC major ongoing goal have always been to make XBMC and its user interface even more intuitive and user-friendly for its end-users, based on the KISS (Keep It Simple Stupid) philosophy. We think that usability is very important for media players like XBMC. Many user interface deciscions are being made by developers who often have little experience in user interface design, in order to improve this, we try to listen to XBMC's end-users for how XBMC is actually being used and how we can improve the user experience. We also aim to do regular overhauls, improving existing features/functions, and scrapping outdated code and features/functions (as "to much stuff" can also be a bad thing).

7.2.1 XBMC as a whole must...

  • Be easy to install, set up, and maintain, (so that the end-users do not get fed up with it and quit).
  • Have an user interface simple and intuitive enough so that less geek-savvy people are not intimidated by it.
  • Be able to play audio and video files that have been compressed using divx, xvid, etc. directly out-of-the-box
  • Be able to and organize audio and video files in an easy and user-friendly way.
  • Use standards and be consistant, (the music section can for example not use completely different controls from the video section)
  • Perform actions in the GUI with as few 'clicks' as possible
  • Require little to none non-GUI configuration (and all such non-GUI config should be via AdvancedSettings.xml)
    • There is still a little work to be done here, for example RSS-feeds settings need to moved to the GUI
  • Look nice.

8 Mentors

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. Initial patches are welcome, and can and will be merged by the team. If you wish to join the team in an official capacity, please let us know.

8.1 Linux and Mac OS X port mentors and developers

If you are a C/C++ programmer expert, porting specialist or guru and like to volunteer as a 'third-party' mentor and/or developer then please let us know.

8.1.1 Linux Mentors (also lead developers)

  • Yuvalt: Everything Linux
  • Vulkanr: Everything Linux
  • JMarshall: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
  • D4rk: OpenGL, other Linux stuff
  • Elupus: DllLoader, Mplayer and DVDPlayer
  • Spiff: Anything other than DllLoader/MPlayer/DVDPlayer internals.
  • monkeyman 67156: Everything Linux
  • Topfs2: Everything Linux

8.1.1.1 Mac OS X Mentors (also lead developers)

9 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