Development: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>Gamester17
>Gamester17
Line 52: Line 52:
==XBMC platform-independent HOW-TO guides==
==XBMC platform-independent HOW-TO guides==
*[[HOW-TO Submit a Proper Bug Report|HOW-TO submit a proper bug report]]
*[[HOW-TO Submit a Proper Bug Report|HOW-TO submit a proper bug report]]
*[[HOW-TO help with Quality Assurance]]
*[[HOW-TO submit a patch|HOW-TO submit a patch (contribute source code)]]
*[[HOW-TO submit a patch|HOW-TO submit a patch (contribute source code)]]
*[[Basic overview of the XBMC source code]]
*[[Basic overview of the XBMC source code]]
Line 58: Line 59:
*[[HOW-TO debug Dynamic Link Libraries|HOW-TO debug Dynamic Link Libraries (DLL)]]
*[[HOW-TO debug Dynamic Link Libraries|HOW-TO debug Dynamic Link Libraries (DLL)]]
*[[Building Scripts|Creating Python Scripts (widget plugins)]]
*[[Building Scripts|Creating Python Scripts (widget plugins)]]
*[[Apply to join the Official XBMC Development-Team]]  
*[[Apply to join the Official XBMC Development-Team]]


==XBMC for Linux==
==XBMC for Linux==

Revision as of 07:18, 29 September 2008

XBMC (formerly named "XBox Media Center") is a free and open source software (GPL) Cross-platform media player and media center entertainment hub. Originally developed as XBox Media Player (XBMP) for the first-generation Xbox game console in 2002, XBMC eventually have became a complete graphical user interface replacement for the Xbox Dashboard and more, as it has also been ported to also run natively under Linux, Mac OS X, and Microsoft Windows operating-system.

Contributing to the XBMC project

Third-party developers/programmers can make and submit source code patches/modules with new features, functions, or bug-fixes to us via our Tracker (Trac) on this site.

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

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

XBMC's code also contains three player cores: One core based on MPlayer that is only available to the Xbox version of XBMC, another in-house developed (FFmpeg-based) dedicated video-player core that is used for video playback on all other platforms, and an in-house developed dedicated music-player core which works on all platforms.

Some of the XBMC libraries are in the C programming-languages but those then uses a C++ wrapper and are loaded via XBMC's own DLL loader. The Xbox Operating-System/BIOS is kind of Win32-based however it does have all of the resources or capabilities of a full Microsoft Windows Operating-System, (for example: DirectShow, registry, nor DLL are nativly supported on the Xbox). Because of the constraints on the hardware (like only 64MB shared memory and a 733Mhz PIII CPU) and the XDK environment of the Xbox, all software development for XBMC is highly focused on reserving the limited resourses that exist, the main hindrance of which is the amount of available random access memory at any one time, (which is why XBMC code structure is built so modular, enabling libraries to be unloaded when they are not in active use). For more detailed information about XBMC inner working please follow these links and the categories at the end of this article:

XBMC programming and code formatting convention guidelines

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

General guidelines

  • Code documentation (DocBook, rst, or doxygen for the code documentation steps, preferably the latter, doxygen).
    • Like for example every field of public API structures should have a doxygen comment.
  • 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)

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

XBMC as a whole must...

  • Be easy to install, set-up, configure, 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.

Development Catagory Sections

Development HOW-TO

If you are a programmer/developer but not have access to VS.NET and the XDK then you can work on XBMC for Linux, XBMC for Mac OS X, or XBMC for Windows (Win32), (or you can contribute indirectly by helping the FFmpeg project as all XBMC versions uses FFmpeg open source codec-libraries). See bellow for more information.

XBMC platform-independent HOW-TO guides

XBMC for Linux

FYI; XBMC for Linux is a port of XBMC for Xbox:

XBMC for Mac OS X

FYI; XBMC for Mac OS X is a sub-project of the *XBMC for Linux port project:

XBMC for Windows (Win32)

FYI; XBMC for Windows (Win32) is a sub-project of the *XBMC for Linux port project:

XBMC for Xbox

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!

Retrieved from "https://kodi.wiki/index.php?title=Development&oldid=26601"