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

Developing XBMC for Linux, HOW-TO:Compile XBMC for Linux

From Kodi
(Difference between pages)
Jump to: navigation, search
m (Can non-Linux developers also help?)
 
(take advantage of <source> tag for syntax highlighting)
 
Line 1: Line 1:
'''NOTE! This article documents a [[current event]]. Information may change rapidly as the event progresses.'''
+
<div class="messagebox merge">[[Image:Merge-arrow.gif|left]] It has been suggested that the ''[[:{{NAMESPACE}}HOW-TO compile XBMC for Linux on Fedora Red Hat Enterprise Linux CentOS]]'' article should be merged into this article ([[{{{2|:{{NAMESPACE}} Talk:HOW-TO compile XBMC for Linux on Fedora Red Hat Enterprise Linux CentOS}}}|discuss]]).</div>
 +
<div class="messagebox merge">[[Image:Merge-arrow.gif|left]] It has been suggested that the ''[[:{{NAMESPACE}}HOW-TO compile XBMC for Linux on Debian/Ubuntu]]'' article should be merged into this article ([[{{{2|:{{NAMESPACE}} Talk:HOW-TO compile XBMC for Linux on Debian/Ubuntu}}}|discuss]]).</div>
 +
<div class="messagebox merge">[[Image:Merge-arrow.gif|left]] It has been suggested that the ''[[:{{NAMESPACE}}HOW-TO compile XBMC for Linux on openSUSE Linux]]'' article should be merged into this article ([[{{{2|:{{NAMESPACE}} Talk:HOW-TO compile XBMC for Linux on openSUSE Linux}}}|discuss]]).</div>
 +
<div class="messagebox merge">[[Image:Merge-arrow.gif|left]] It has been suggested that the ''[[:{{NAMESPACE}}HOW-TO compile XBMC for Linux on Moblin v2]]'' article should be merged into this article ([[{{{2|:{{NAMESPACE}} Talk:HOW-TO compile XBMC for Linux on Moblin v2}}}|discuss]]).</div>
  
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]
 
  
:'''Note to XBMC end-users!''' Please understand that this Linux port project is not yet mature enough for you as an end-user to play with, no media can even be played back yet. 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. If you as end-users have any questions or need to get something of 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]
+
{{Current event}}
 +
{{GoToParent|Parent=Installing XBMC for Linux}}
 +
__NOTOC__
 +
''This is only a copy and paste from the [http://xbmc.svn.sourceforge.net/viewvc/*checkout*/xbmc/branches/linuxport/XBMC/README.linux README.linux] just to get this article started. Please refer to the SVN version of [http://xbmc.svn.sourceforge.net/viewvc/*checkout*/xbmc/branches/linuxport/XBMC/README.linux README.linux] to be sure you got the latest edition!''
 +
----
 +
;'''Note:''' This is an initial Linux port. It does not yet include all the features of XBMC. Don't expect too much. For more information read the [[XBMC for Linux port project]] article in this wiki.
 +
;'''Note:''' XBMC is open source (GPL) software and as so the source code is available for anyone to modify and/or compile (under the rules of the GPL).
  
=What is XBMC and why port it to Linux?=
 
For the developers who does not know this; '''XBMC''' (short for '''XB'''ox '''M'''edia '''C'''enter, not to be confused with [http://en.wikipedia.org/wiki/Windows_Media_Center_Extender Microsoft's Windows Media Center Extender for the Xbox]) is an award-winning free and [http://en.wikipedia.org/wiki/Open_source open source] media player, originally designed to run on the [http://en.wikipedia.org/wiki/Xbox Xbox game-console]. The GPL/LGPL licensed source code basically consist of a [http://en.wikipedia.org/wiki/Application_framework GUI framework] that has been written from scratch by [[Team-XBMC]], this GUI acts as a [http://en.wikipedia.org/wiki/Front-end 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 [[XBMC Features and Supported Formats/Codecs|all of XBMC multimedia handling functions such as databases and sorting, etc.]]. [http://sourceforge.net/projects/xbmc 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 [[XBMC_Features_and_Supported_Formats/Codecs|features or functions]], improve on existing ones, or fix bugs.
 
  
The difference this time is that we are not asking for new [[XBMC_Features_and_Supported_Formats/Codecs|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 [[XBMC_Features_and_Supported_Formats/Codecs|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 [[XBMC_Features_and_Supported_Formats/Codecs|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 [http://en.wikipedia.org/wiki/H.264 H.264] or [http://en.wikipedia.org/wiki/VC-1 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 closly matches the Xbox hardware, at 733Mhz Intel Pentium III CPU and only 64MB shared memory).
+
==Prerequisites==
 +
*Supported Linux Operating-System installed on a supported computer, currently the officially supported OS are:
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/desktopedition Ubuntu Desktop Edition 8.04 (Hardy Heron) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/desktopedition Ubuntu Desktop Edition 8.10 (Intrepid Ibex) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/desktopedition Ubuntu Desktop Edition 9.04 (Jaunty Jackalope) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/serveredition Ubuntu Server Edition 8.04 (Hardy Heron) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/serveredition Ubuntu Server Edition 8.10 (Intrepid Ibex) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/WhatIsUbuntu/serveredition Ubuntu Server Edition 9.04 (Jaunty Jackalope) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/mobile Ubuntu Mobile and Embedded Edition 8.04 (UME) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/mobile Ubuntu Mobile and Embedded Edition 8.10 (UME) 32-bit for x86]
 +
**[http://www.ubuntu.com/products/mobile Ubuntu Mobile and Embedded Edition 9.04 (UME) 32-bit for x86]
 +
***Note that it is also possible to compile and run 32-bit XBMC under 64-bit (AMD64/EMT64) Ubuntu if you run it in a 32bit chroot.
  
=Skill requirements and where to start=
+
* Other working distributions (but officially unsupported) are:
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/softwares in order to take part - XBMC development is well underway on [http://www.ubuntu.com Linux (Ubuntu 7.04)].
+
**[[HOW-TO compile XBMC for Linux on Fedora Red Hat Enterprise Linux CentOS|Fedora RedHat Enterprise Linux, and CentOS]]
 +
**[[HOW-TO compile XBMC for Linux on openSUSE Linux|OpenSUSE]]
 +
**[[HOW-TO compile XBMC for Linux on Debian/Ubuntu|Debian]]
 +
**[[HOW-TO compile XBMC for Linux on Moblin v2|Moblin]]
  
==Where do I start (Linux)?==
+
*[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 [http://xbmc.svn.sourceforge.net/viewvc/*checkout*/xbmc/branches/linuxport/XBMC/README.linux|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 smootly 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).
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 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.
+
===Hardware requirements===
+
*[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] (that features 24bpp or 32bpp for 3D hardware-acceleration support, which XBMC GUI need to run smootly 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] alternativly [http://en.wikipedia.org/wiki/Intel_graphics_media_accelerator Intel GMA X3000 (G965) or later] graphics-controllers as those two manufacturers currently offer better device-drivers for Linux than other graphic-adapter manufacturers).
+
  
==Can non-Linux developers also help?==
+
*Correctly installed graphics device-drivers which supports 24bpp or 32bpp for 3D hardware-acceleration, ([[Team-XBMC]] recommends that you run [http://www.albertomilone.com/nvidia_scripts1.html Envy] which is a application that automaticly downloads and installs the correct proprietary device-driver for your ATI or NVIDIA graphic chip).
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 concentrating 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 developement 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 preperation for possible future cross-platform versions of XBMC.
+
* [[HOW-TO: Compile XBMC for Win32 from source code]] (to come soon!)
+
  
=Other tools and resources=
+
==Getting the source code==
Though any other tools or resources are not required they can possible help make in development.
+
For the first time:<br>
===Development Tools===
+
<source lang="bash">
* [http://valgrind.org Valgrind] (for Linux) - a free Linux programming tool for memory debugging, memory leak detection, and profiling.
+
$ sudo apt-get install subversion
* [http://www.daimi.au.dk/~sandmann/sysprof/ Sysprof] (for Linux) - a free System-wide Linux Profiler for tracking CPU usage
+
$ cd $HOME
* [http://en.wikipedia.org/wiki/HLSL2GLSL HLSL2GLSL] - library and tool that converts HLSL (High Level Shader Language) shaders to GLSL (OpenGL Shading Language)
+
$ svn checkout http://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk
* [http://www.linuxpowertop.org PowerTOP] - utility by Intel for detecting what Linux programs and kernel tunables are resulting in the most power consumption.  
+
</source>
* [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 file.
+
  
===Development Resources===
+
In order to update the source code (and clean old make files):<br>
* [http://gameprogrammer.com/fastevents/fastevents1.html Fast Event Processing in SDL] - Using threads to speed up the SDL event loop (only meant as an example).
+
<source lang="bash">
* [http://gameprogrammer.com/net2/net2-0.html NET2] - A fast threaded event based networking library for SDL (only meant as an example).
+
$ cd $HOME/XBMC
* [http://olofson.net/mixed.html SDL programming examples] (including glSDL - a proof of concept implementation of SDL on top of OpenGL)
+
$ svn up
* [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).
+
$ make clean
 +
</source>
  
===Third-party libraries===
+
==Installing required Ubuntu packages==
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:
+
The current list of required packages for each supported version is located in the [http://xbmc.svn.sourceforge.net/viewvc/*checkout*/xbmc/branches/linuxport/XBMC/README.linux README.linux] file in the SVN
* [http://www.antigrain.com Anti-Grain Geometry] - A High Quality Rendering Engine (High Fidelity 2D Graphics Renderer) for C++ (GPL licenced)
+
* [http://cmil.sourceforge.net CMIL (Common Media Input Layer)] C++ OO framework designed to improve the state of cross-platform input handling
+
**CMIL is (or will be soon) compatible with both SDL and DirectX (GPL licenced)
+
* [http://hkn.berkeley.edu/~mcmartin/vcontrol/ VControl] - a flexible library for unifying keyboard and joystick input.
+
*[http://libmousetrap.sourceforge.net libmousetrap (The Mousetrap Library)] - C library for SDL (LGPL licenced), also see [http://pymousetrap.sourceforge.net Pymousetrap]
+
* [http://gentoo-wiki.com/HOWTO_Xbox_360_controller_on_Linux Xbox 360 controller on Linux] - experimental device driver for Xbox360 Wireless/Wired controller on Linux computers.
+
**Interesting fact is that [http://gentoo-wiki.com/HOWTO_Xbox_360_controller_on_Linux#DDR_Pads Linux kernel 2.6.19 supports for the original XBOX DDR pads (not Xbox360) out-of-the-box].
+
*[http://www.lirc.org Lirc] (or alternative library implementation) for IR/IrDA (infrared) remote controls support under Linux
+
**Possible also add [http://winlirc.sourceforge.net Wlirc] for IR/IrDA (infrared) remote support under Win32 for consistency.
+
* [http://www.libsdl.org/projects/SDL_net SDL_net] - a simple cross-platform network library
+
*[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://members.cox.net/dolsen6/resize.zip SDL_Resize] - basic image resizing library, high quality output suited for prerendering images.
+
*[http://sdl-cfg.sourceforge.net SDL_Config] - Library designed for reading and writing configuration (.ini) files in an easy, cross-platform way.
+
*[http://www.crusaderky.altervista.org//?s=downloads navfs] - Hard drive abstraction layer C library, allowing easy directory navigation.
+
* [http://www.ferzkopp.net/~aschiffler/Software/SDL_bgrab/index.html SDL_bgrab] - SDL convertion of libbgrab (a framegrabber lib from the same author).
+
  
=Technical summary of XBMC=
+
'''''Use a single command to get all build dependencies'''''
==The basics==
+
The XBMC code structure uses a fairly [http://en.wikipedia.org/wiki/Module_%28programming%29 modular design] (with [http://en.wikipedia.org/wiki/Library_%28computing%29 libraries] and [http://en.wikipedia.org/wiki/Dynamic-link_library DLL]s), 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 futher 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 completly abandoning the Xbox hardware any time soon - XBMC will be a [http://en.wikipedia.org/wiki/Cross-platform 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).
+
  
==Detailed technical information==
+
For this, you need to specify the PPA in your apt sources. Please find them [http://forum.xbmc.org/showthread.php?t=33327 on the forum].
For more details please visit the [[Development Notes]] section of this manual.
+
  
==The XBMC source code==
+
Update apt :
The XBMC source code is in our SVN repository on sourceforge.net. Full instructions for compiling/builing XBMC under Linux is available here:
+
<source lang="bash">
* [[HOW-TO compile XBMC for Linux from source code]]
+
$ sudo apt-get update
 +
</source>
  
=Linux porting=
+
Here is the magic command to get the build dependencies (used to compile the version on the PPA).
==The Linux port plan==
+
<source lang="bash">
''Disclaimer: The XBMC Linux port of course excludes all Xbox exclusive functionality (like for example [[Using Trainers|Trainers]], launching Xbox Games, and such)'':
+
$ sudo apt-get build-dep xbmc
* Milestone 1 - Get [[XBMC Features and Supported Formats/Codecs|all existing XBMC functionality (features/functions)]] working as it works on the XBOX
+
</source>
**this also includes all audio/video player cores ([[MPlayer]], [[DVDPlayer]], [[PAPlayer]], and [[MODPlayer]])
+
* Milestone 2 - Add linux specific items (network settings, multiple input-device support,  packaging, etc.)
+
  
==What has already been done==
+
==How to compile==
*[http://en.wikipedia.org/wiki/Kdevelop Kdevelop]] project file available in SVN
+
===Default compile and install===
**Linux development and debug environment
+
Requires 3D GPU that has supported OpenGL 3D hardware acceleration, set bitdepth to 24bpp or 32bpp<br>
*Code fully compiles on Ubuntu 7.04
+
<source lang="bash">
*GUI implementation of [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL]
+
$ cd $HOME/XBMC
**OpenGL/SDL - using the GPU, working but relies on an accelerated OpenGL version
+
$ ./bootstrap
**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')
+
$ ./configure
*Picture viewing working (including slideshow and it's effects)
+
$ make
*SMB network shares
+
$ sudo make install
*[[PAPlayer]] and its audio decoder DLL codecs - ''in progress''
+
</source>
**(checkout [[HOW-TO: Debug Dynamic Link Libraries]])
+
  
=To-Do=
+
===./configure command line switches===
This is a '''To-Do list''' of thing that still need to be done, you are more than welcome to help out with any of these tasks:
+
These switches are possible when running configure:
===Major To-Do tasks with high priority===
+
* [MAJOR - HIGH PRIORITY] PAPlayer porting to Linux (port DLLs to SO, support ALSA) - in progress
+
* [MAJOR - HIGH PRIORITY] [[MPlayer]] porting to Linux
+
* [MAJOR - HIGH PRIORITY] [[DVDPlayer]] porting to Linux
+
* [MAJOR - HIGH PRIORITY] [[Rendering|Pixel Shader video renderer(s)]] (possibly also hardware overlay via [http://en.wikipedia.org/wiki/X_video_extension Xv])
+
* [MAJOR - HIGH PRIORITY] Python interpreter (and python scripts/libraries] - ''in early stages''
+
* [MAJOR - HIGH PRIORITY] CD-ROM/DVD-ROM support (ripping, ISO 9660, UDF, etc.) - possibly via [http://www.gnu.org/software/libcdio/ libcdio]
+
===Major To-Do tasks with medium priority===
+
* [MAJOR - MEDIUM PRIORITY] WMA aduio decoder codecs for [[PAPlayer]] (port from [http://ffmpeg.mplayerhq.hu FFmpeg]?)
+
* [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 platform-independent wrapper interface to SDL / DirectX / ALSA /OSS / OpenAL audio backend interfaces.
+
* [MAJOR - MEDIUM PRIORITY] Network: Servers (FTP, Web, UPnP), Clients (FTP, UPnP, Time), Network settings
+
* [MAJOR - MEDIUM PRIORITY] Support USB disks dynamically (meaning, inserted/removed after boot)
+
* [MAJOR - MEDIUM PRIORITY] Port milkdrop and possibly other XBMC visualizations to also support OpenGL
+
* [MAJOR - MEDIUM PRIORITY] Screen savers. Possibly use GNOME or other open source ones, (OpenGL).
+
===Major To-Do tasks with low priority===
+
* [MAJOR - LOW PRIORITY] [[Hardware Accelerated Video Decoding]] on the GPU in some shape or form.
+
**([[Hardware Accelerated Video Decoding|possible metods are XvMC, GLSL or Cg Pixel Shader (Shader Model 3.0), and/or GPGPU]])
+
* [MAJOR - LOW PRIORITY] Credits (port to also support OpenGL and detect platform)
+
* [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.
+
* [MAJOR - LOW PRIORITY] Suspend and Resume support - Suspend to RAM (STR) (not to share code with STD)
+
  
===Minor To-Do Tasks with high priority===
+
* '''--prefix=/path'''
* [MINOR - HIGH PRIORITY] Fix hacks which might not work on some platforms (improve cross-platform code)
+
** Install XBMC to /path rather than default (/usr/local)
===Minor To-Do Tasks with medium priority===
+
* '''--disable-gl'''
* [MINOR - MEDIUM PRIORITY] [http://www.lirc.org Lirc] or alternative implementation for IR/IrDA (infrared) remote support under Linux
+
** Much much slower GUI rendering but works on all adapters and bitdepths. For development purposes only.
**Also add [http://winlirc.sourceforge.net Wlirc] for IR/IrDA (infrared) remote support under Win32 for consistency.
+
* '''--disable-debug'''
**Though probably not possible, it would be great if could be added via [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL] for platform-independence.
+
** <nowiki>No debug information (smaller executable, no FreeMem text in screens)</nowiki>
===Cleanup To-Do Tasks===
+
** <nowiki>open issue: FreeMem is still shown even with --disable-debug</nowiki>
* [CLEANUP - ALWAYS AN ONGOING PROCESS] Document all of the current/existing code (DocBook, rst, or [http://www.doxygen.org doxygen], preferably the latter)
+
* [CLEANUP - ALWAYS AN ONGOING PROCESS] [http://valgrind.org/ Valgrid] debugging under Linux (and back-port any fixes to the Xbox and Win32 code)
+
  
=XBMC programming and code formatting convention guidelines=
+
It is also possible to combine these options, for example:
:'''Note!''' More specifica to come based on ongoing discussions, see [http://www.xboxmediacenter.com/forum/showthread.php?t=5238 Proposed code formatting conventions for XBMC]
+
  
==General guide-lines==
+
<source lang="bash">
* Code documentation (DocBook, rst, or [http://www.doxygen.org doxygen] for the code documentation steps, preferably the latter, [http://www.doxygen.org doxygen])
+
$ ./configure --disable-debug --disable-gl
* Self-containment - XBMC should be as little dependent as possible on operating-system and third-party services/deamons/libraries
+
</source>
**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 [http://en.wikipedia.org/wiki/LiveDistro 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
+
  
==User-friendliness is next to godlyness==
+
===Quicker compilation===
One of [[Team-XBMC]] major ongoing goal have always been to make XBMC and its [http://en.wikipedia.org/wiki/user_interface user interface] even more [http://en.wikipedia.org/wiki/intuitive intuitive] and [http://en.wikipedia.org/wiki/user-friendliness user-friendly] for its [http://en.wikipedia.org/wiki/End-user end-users], based on the '''KISS''' ('''K'''eep '''I'''t '''S'''imple '''S'''tupid) philosophy. We think that [http://en.wikipedia.org/wiki/Usability usability] is very important for media players like XBMC. Many user interface decisions 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 fro 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).
+
By adding -j<number> to the make command, you describe how many cores will be used. So for dualcore the commands are:<br>
===XBMC as a whole must...===
+
<source lang="bash">
*Be easy to install, set up, and maintain, (so that the end-users do not get fed up with it and quit).
+
$ make -j2
*Have an user interface simple and intuitive enough so that less geek-savvy people are not intimidated by it.
+
</source>
**Make common usage easy, simple '[http://en.wikipedia.org/wiki/Human-computer_interaction Human–Computer Interaction (HCI)]', from the viewpoint of an ordinary user.
+
or
*Be able to play audio and video files that have been compressed using divx, xvid, etc. directly out-of-the-box
+
<source lang="bash">
*Be able to and organize audio and video files in an easy and user-friendly way.
+
$ make -j2 sdl_2d
*Use standards and be consistant, (the music section can for example not use complly different controls from the video section)
+
</source>
*Preform 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.
+
  
=Mentors=
+
Exprimental: You could add [http://distcc.samba.org/ distcc] if you have more than one computer networked. This will run make on several computers sharing the workload between them.
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:==
+
==How to run==
* [[User:Yuvalt|Yuvalt]]: Everything Linux
+
Everything is now taken care of by the install script. Simply run the xbmc command from anywhere:
* [[User:Vulkanr|Vulkanr]]: Everything Linux
+
<source lang="bash">
* [[User:Elupus|Elupus]]: DllLoader, Mplayer and DVDPlayer
+
$ xbmc
* [[User:Spiff|Spiff]]: Anything other than DllLoader/MPlayer/DVDPlayer internals.
+
</source>
* [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
+
  
 +
==Fullscreen==
 +
Toggle FS with \ key while XBMC is running.
  
'''Note!''' If you are a C/C++ porting guru/expert and like volunteer as a ''''third-party developer mentor'''' then please let us know.
+
==Multi-monitor Fullscreen==
 +
If you have a multi-monitor setup and you want to use fullscreen, make sure to set the env variable
 +
SDL_VIDEO_FULLSCREEN_HEAD to the display no. which you want SDL to use for the fullscreen mode.
  
=Contact methods=
+
For e.g. "SDL_VIDEO_FULLSCREEN_HEAD=1 ./xbmc.bin -fs" to tell SDL to use display no.1
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-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])
+
* [http://www.xboxmediacenter.com/forum/forumdisplay.php?f=10 XBMC Development Community-Forum]
+
**Not for posting Feature Requests or end-user support requests!
+
* [[HOW-TO submit a patch]] (where and how to submit source code)
+
  
 
+
[[category:How To|Linux]]
 
+
[[category:Linux]]
[[category:Current events]]
+
[[category:Development]]
 
[[category:Inner Workings]]
 
[[category:Inner Workings]]
[[category:Development]]
+
[[category:OpenGL]]
[[category:Skin Development]]
+
[[category:Linux]]
+
 
[[category:To-Do]]
 
[[category:To-Do]]

Revision as of 22:29, 22 September 2009

Merge-arrow.gif
It has been suggested that the HOW-TOHOW-TO compile XBMC for Linux on Fedora Red Hat Enterprise Linux CentOS article should be merged into this article (discuss).
Merge-arrow.gif
It has been suggested that the HOW-TOHOW-TO compile XBMC for Linux on Debian/Ubuntu article should be merged into this article (discuss).
Merge-arrow.gif
It has been suggested that the HOW-TOHOW-TO compile XBMC for Linux on openSUSE Linux article should be merged into this article (discuss).
Merge-arrow.gif
It has been suggested that the HOW-TOHOW-TO compile XBMC for Linux on Moblin v2 article should be merged into this article (discuss).


Template:Current event

Goto: Installing XBMC for Linux

This is only a copy and paste from the README.linux just to get this article started. Please refer to the SVN version of README.linux to be sure you got the latest edition!


Note: This is an initial Linux port. It does not yet include all the features of XBMC. Don't expect too much. For more information read the XBMC for Linux port project article in this wiki.
Note: XBMC is open source (GPL) software and as so the source code is available for anyone to modify and/or compile (under the rules of the GPL).


1 Prerequisites

  • Correctly installed graphics device-drivers which supports 24bpp or 32bpp for 3D hardware-acceleration, (Team-XBMC recommends that you run Envy which is a application that automaticly downloads and installs the correct proprietary device-driver for your ATI or NVIDIA graphic chip).

2 Getting the source code

For the first time:

$ sudo apt-get install subversion
$ cd $HOME
$ svn checkout http://xbmc.svn.sourceforge.net/svnroot/xbmc/trunk

In order to update the source code (and clean old make files):

$ cd $HOME/XBMC
$ svn up
$ make clean

3 Installing required Ubuntu packages

The current list of required packages for each supported version is located in the README.linux file in the SVN

Use a single command to get all build dependencies

For this, you need to specify the PPA in your apt sources. Please find them on the forum.

Update apt :

$ sudo apt-get update

Here is the magic command to get the build dependencies (used to compile the version on the PPA).

$ sudo apt-get build-dep xbmc

4 How to compile

4.1 Default compile and install

Requires 3D GPU that has supported OpenGL 3D hardware acceleration, set bitdepth to 24bpp or 32bpp

$ cd $HOME/XBMC
$ ./bootstrap
$ ./configure
$ make
$ sudo make install

4.2 ./configure command line switches

These switches are possible when running configure:

  • --prefix=/path
    • Install XBMC to /path rather than default (/usr/local)
  • --disable-gl
    • Much much slower GUI rendering but works on all adapters and bitdepths. For development purposes only.
  • --disable-debug
    • No debug information (smaller executable, no FreeMem text in screens)
    • open issue: FreeMem is still shown even with --disable-debug

It is also possible to combine these options, for example:

$ ./configure --disable-debug --disable-gl

4.3 Quicker compilation

By adding -j<number> to the make command, you describe how many cores will be used. So for dualcore the commands are:

$ make -j2

or

$ make -j2 sdl_2d

Exprimental: You could add distcc if you have more than one computer networked. This will run make on several computers sharing the workload between them.

5 How to run

Everything is now taken care of by the install script. Simply run the xbmc command from anywhere:

$ xbmc

6 Fullscreen

Toggle FS with \ key while XBMC is running.

7 Multi-monitor Fullscreen

If you have a multi-monitor setup and you want to use fullscreen, make sure to set the env variable SDL_VIDEO_FULLSCREEN_HEAD to the display no. which you want SDL to use for the fullscreen mode.

For e.g. "SDL_VIDEO_FULLSCREEN_HEAD=1 ./xbmc.bin -fs" to tell SDL to use display no.1

Personal tools
Namespaces

Variants
Actions
Navigation
Wiki help
Toolbox