>Gamester17 |
|
| (37 intermediate revisions by 10 users not shown) |
| Line 1: |
Line 1: |
| {{Current event}} | | {{mininav|[[Development]]}} |
| {{XBMC faq toc Inline}}
| |
| __TOC__
| |
| __NOEDITSECTION__
| |
|
| |
|
| [[Team-XBMC]] have [http://en.wikipedia.org/wiki/Porting ported] the [http://en.wikipedia.org/wiki/XBMC XBMC Media Center] software to [http://en.wikipedia.org/wiki/Mac_OS_X Mac OS X] over a year ago (for [http://en.wikipedia.org/wiki/OpenGL OpenGL] using the [http://en.wikipedia.org/wiki/Simple_DirectMedia_Layer SDL toolkit]), this port is almost as feature complete as XBMC for any other platform and it is currently running very well and stable enough for all people to enjoy using it. The long term goal of [[Team-XBMC]] is that [http://xbmc.org/download downloading XBMC for Mac] will become a full port of XBMC with [[XBMC Features and Supported Formats/Codecs|all the features and functions that are available on all other XBMC platforms]] ''(with the exception of Xbox exclusive functionality such as [[Using Trainers|Trainers]], Xbox Game-Save Manager, launching Xbox Games, etc.)'', so [http://xbmc.org/download downloading XBMC for Mac] will be one version of a multi-platform software.
| | <br /> |
| | {{cleanup}} |
| | {{Kodi_development_nav}} |
| | <section begin="intro" />Team Kodi (formerly called Team-XBMC) first ported XBMC Media Center software to Mac OS X in 2008, and the whole project cross-platform application was renamed to Kodi in 2014. Kodi itself is a huge open source project and it takes loads of people working together to maintain it for all platforms, that is why Team Kodi is always on the lookout for C/C++ programmers to volunteer in assisting us with the development of Kodi. Whether you have contributed to the Kodi/XBMC project in the past or not, please consider doing so now.<section end="intro" /> |
|
| |
|
| XBMC is a huge open source project and it takes loads of people working together to maintain it for all platforms, that is why [[Team-XBMC]] is always on the lookout for [http://en.wikipedia.org/wiki/Programming_language C/C++ programmers] to volunteer in assisting us with the development of XBMC. Whether you have contributed to [http://sourceforge.net/projects/xbmc The XBMC Project] in the past or not, please consider doing so now.
| |
|
| |
|
| :'''Note to XBMC end-users!''' You can help too by [http://xbmc.org/download downloading XBMC for Mac], testing it, and [[HOW-TO Submit a Proper Bug Report|reporting bugs and issues]]. Also, spread the word about [http://xbmc.org/download XBMC for Mac] to your friends and family, we are sure they will enjoy it too. XBMC is free and do not contain any spy-ware nor add-ware.
| | == End-users (non-programmers) == |
| | You can help too by downloading Kodi for OS X, testing it, and [[HOW-TO:Submit_a_bug_report|reporting bugs and issues]]. Also, spread the word about Kodi for OS X (and other platforms) to your friends and family, we are sure they will enjoy it too. |
|
| |
|
| Those of you who are completely unfamiliar with XBMC can get a good overview of the features and functions that 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]
| | == Developers (programmers) == |
| | You should be proficient in [http://en.wikipedia.org/wiki/Programming_language C/C++ programming language], and although not really required knowledge of [http://en.wikipedia.org/wiki/OpenGL OpenGL] or other [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. |
|
| |
|
| =What is XBMC and why was it ported to Mac OS X?=
| | The '''Mac OS X development platform''' is [[Compiling Kodi]]. |
| '''XBMC''' (formerly called "XBox Media Center", 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 center and audio/video player, originally designed to run on the [http://en.wikipedia.org/wiki/Xbox Xbox game-console]. The GPL 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.
| |
|
| |
|
| =Where to start helping out?= | | == Hardware requirements == |
| ==End-users (non-programmers)==
| | * [http://en.wikipedia.org/wiki/X86 32-bit Intel (x86-processor) with Mac OS X 10.7 (Leon), and a ATI Radeon 9200/X1600, Intel GMA950, or NVIDIA 6-Series [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)], or later, (Kodi GUI requires at least OpenGL 1.3 support to run smoothly at an acceptable frame-rate in standard-definition, to run Kodi high-definition a more modern GPU is recommended). |
| You can help too by [http://xbmc.org/download downloading XBMC for Windows], testing it, and [[HOW-TO Submit a Proper Bug Report|reporting bugs and issues]]. Also, spread the word about [http://xbmc.org/download XBMC for Windows] to your friends and family, we are sure they will enjoy it too.
| |
|
| |
|
| ==Developers (programmers)== | | == Detailed technical information == |
| You should be proficient in [http://en.wikipedia.org/wiki/Programming_language C/C++ programming language], and allthough not really required knowledge of [http://en.wikipedia.org/wiki/OpenGL OpenGL] 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 will not need to have access to an Xbox game-console or any costly special software in order to take part. XBMC development of this port is well underway for [[HOW-TO compile XBMC for Mac OS X from source code|Mac OS X 10.5 (Leopard) and Mac OS X 10.4 (Tiger) 32-bit x86-Intel or PPC (PowerPC)]].
| | For more details please visit the [[Development]] section of this manual. |
|
| |
|
| The '''Mac OS X development platform''' is [[HOW-TO compile XBMC for Mac OS X from source code|Mac OS X 10.5 (Leopard) and Mac OS X 10.4 (Tiger) 32-bit x86-Intel or PPC (PowerPC)]]. There are [http://en.wikipedia.org/wiki/Xcode Xcode] (and [http://en.wikipedia.org/wiki/Eclipse_%28software%29 Eclipse]) project files 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 Mac OS X from source code|README.osx]]) 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. | | == Source code == |
| | The Kodi source code is in the XBMC Foundation [https://github.com/xbmc/xbmc git repository on github.com]. Full instructions for compiling/builing Kodi under Mac is available here: |
| | * [[Compiling Kodi]] |
|
| |
|
| ==Hardware requirements==
| |
| *[http://en.wikipedia.org/wiki/X86 32-bit Intel (x86-processor) or PPC (PowerPC) based computer] with Mac OS X 10.5 (Leopard) or Mac OS X 10.4 (Tiger), and a ATI Radeon 9200/X1600, Intel GMA950, or NVIDIA 6-Series [http://en.wikipedia.org/wiki/Graphics_Processing_Unit 3D GPU (Graphics Processing Unit)], or later, (XBMC GUI requires at least OpenGL 1.3 support to run smoothly at an acceptable frame-rate in standard-definition, to run XBMC high-definition a more modern GPU is recommended).
| |
|
| |
|
| ==XBMC for Mac OS X port project FAQ for developers==
| |
| ===Can non-Mac OS X developers also help?===
| |
| XBMC can also be compiled for [[HOW-TO compile XBMC for Linux from source code|Linux]] and [[HOW-TO compile XBMC for Windows from source code|Microsoft Windows]] operating-systems.
| |
| * [[XBMC for Linux port project]]
| |
| ** [[HOW-TO compile XBMC for Linux from source code]]
| |
| * [[XBMC for Windows port project]]
| |
| ** [[HOW-TO compile XBMC for Windows from source code]]
| |
|
| |
|
| ===Why is OpenGL 2.0 recommended for XBMC?===
| | [[Category:Apple]] |
| OpenGL 2.0 is not the current minimum requirement to run XBMC for Mac OS X, as XBMC will today run with only OpenGL 1.3 + [http://en.wikipedia.org/wiki/GLSL GLSL] support (everything else has fall-backs to be runned in software on the CPU, slower than GPU hardware though), however if the future XBMC might be able to take futher advantage of OpenGL 2.0 to speed up video decoding and such.
| |
| | |
| :'''Currently OpenGL 2.0 hardware is only needed for:'''
| |
| * Any deinterlacing that is not linear blending (which FFmpeg does in software)
| |
| * 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 a few GPU hardware implementations as low as OpenGL 1.3 does 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=
| |
| Though any other tools or resources are not required they can possibly help in development.
| |
| * [[HOW-TO compile XBMC for Mac OS X from source code]]
| |
| * [[Eclipse CDT Setup For XBMC Development]]
| |
| ==Development Tools==
| |
| * [http://www.stack.nl/~dimitri/doxygen/ Doxygen] - Source code documentation generator tool.
| |
| | |
| =Technical summary of XBMC=
| |
| ==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 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 [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 more details please visit the [[Development Notes]] section of this manual.
| |
| | |
| ==The XBMC source code==
| |
| The XBMC source code is in our SVN repository on sourceforge.net. Full instructions for compiling/builing XBMC under Mac is available here:
| |
| * [[HOW-TO compile XBMC for Mac OS X from source code]]
| |
| | |
| =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:
| |
| ====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)
| |
| | |
| =XBMC programming and code formatting convention guidelines=
| |
| :'''Note!''' More specifics to come based on ongoing discussions, see [http://forum.xbmc.org/showthread.php?t=5238 Proposed code formatting conventions for XBMC]
| |
| | |
| ==General guidelines==
| |
| * Code documentation (DocBook, rst, or [http://www.doxygen.org doxygen] for the code documentation steps, preferably the latter, [http://www.doxygen.org 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 (with less than 1Ghz Intel Pentium III 32-bit x86 processor)
| |
| **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).
| |
| * 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 [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 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, 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.
| |
| **Make common usage easy, simple '[http://en.wikipedia.org/wiki/Human-computer_interaction Human–Computer Interaction (HCI)]', from the viewpoint of an ordinary user.
| |
| *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.
| |
| ===XBMC developers should always strive to===
| |
| * '''Promote open source''' - XBMC is based on the ideas of FOSS (free open source software), licensed under the GPL and builds partly on other open source projects which we do our best to support. The GPL should be respected at all times. All code should be committed to the XBMC project’s SVN before any public binaries are released.
| |
| * '''Promote the sharing of knowledge and collaboration''' - Through the use of information sharing tools and practices XBMC is a collaborative environment.
| |
| * '''Understand that development is a team effort''' - Treating our users as co-developers has proven to be the most effective option for rapid development. Always strive to work as a team at all times. Actively promote discussion on new features and bug fixes, and respect others comments and criticisms with replies in a timely fashion.
| |
| * '''Apply the Law of Diminishing Return''' - The majority of the effort should be invested in implementing features which have the most benefit and widest general usage by the community.
| |
| * '''Try to make all code, feature, and functions to be platform agnostic''' - XBMC is a multi-platform software, thus any single platform specific features should be discussed with other team members before implemented. Major features should be developed in a separate branch or committed in small increments so that other members have the opportunity to review the code and comment on it during development.
| |
| | |
| =Mentors=
| |
| 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.
| |
| | |
| ==Mac OS X, Linux, and Windows 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.
| |
| ====Mac OS X Mentors (also lead developers)====
| |
| * [[User:Davilla|Davilla]]: Everything Mac OS X
| |
| * [[User:D4rk|D4rk]]: OpenGL, other Mac OS X and Linux stuff
| |
| * [[User:malloc|malloc]]: Everything Mac OS X and Linux
| |
| * [[User:Vulkanr|Vulkanr]]: Everything Mac OS X and Linux
| |
| ===Linux Mentors (also lead developers)===
| |
| * [[User:Yuvalt|Yuvalt]]: Everything Linux
| |
| * [[User:Vulkanr|Vulkanr]]: Everything Linux and Mac OS X
| |
| * [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
| |
| * [[User:D4rk|D4rk]]: OpenGL, other Linux and Mac OS X 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
| |
| * [[User:malloc|malloc]]: Everything Linux and Mac OS X
| |
| ====Windows Mentors====
| |
| * [[User:WiSo|WiSo]]: Everything Win32 (SDL, not DirectX)
| |
| * [[User:Chadoe|Chadoe (a.k.a. Charly)]] - Everything Win32 (SDL, not DirectX)
| |
| * [[User:Jmarshall|JMarshall]]: Anything GUI related, Music Library, Video Library, PAPlayer, etc.
| |
| | |
| =Contact methods=
| |
| These are developers forums for XBMC development, (programmers/coders only!).<br>
| |
| Respect, these are not for posting feature-requests or end-user support requests!
| |
| * IRC: [irc://irc.freenode.net/xbmc-osx #xbmc-osx on freenode] official [http://freenode.net IRC network channel] for the XBMC Mac OS X port
| |
| * 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://forum.xbmc.org/forumdisplay.php?f=57 XBMC for Mac OS X port Community-Forum for developers only]
| |
| ** [http://forum.xbmc.org/forumdisplay.php?f=56 XBMC for Mac OS X port Community-Forum for end-users (unmoderated so far)]
| |
| * [http://forum.xbmc.org/forumdisplay.php?f=41 XBMC for Linux port Community-Forum for developers only]
| |
| ** [http://forum.xbmc.org/forumdisplay.php?f=52 XBMC for Linux port Community-Forum for end-users (unmoderated so far)]
| |
| * [http://forum.xbmc.org/forumdisplay.php?f=58 XBMC for Windows port Community-Forum for developers only]
| |
| ** [http://forum.xbmc.org/forumdisplay.php?f=59 XBMC for Windows port Community-Forum for end-users (unmoderated so far)]
| |
| | |
| * [[HOW-TO submit a patch]] (where and how to submit source code)
| |
| | |
| [[category:Inner Workings]]
| |
| [[category:Development]]
| |
| [[category:Skin Development]]
| |
| [[category:Mac OS X]]
| |
| [[category:Apple TV]]
| |
| [[category:OpenGL]]
| |
| [[category:To-Do]]
| |
| [[category:Google Summer of Code]]
| |
Development