OS X development: Difference between revisions

From Official Kodi Wiki
Jump to navigation Jump to search
>NedBot
m (Bot: Removing from Category:Inner Workings)
m (Text replacement - "Team-Kodi" to "Team Kodi")
 
(27 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{XBMC faq toc Inline}}
{{mininav|[[Development]]}}
__TOC__
 


You should read about [[XBMC development]] before reading this page.
<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" />


= Introduction =
[[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.


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.
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]
== What is XBMC and why was it ported to Mac OS X? ==
'''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? =
== End-users (non-programmers) ==
== End-users (non-programmers) ==
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.
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.


== Developers (programmers) ==
== Developers (programmers) ==
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)]].
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.


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.
The '''Mac OS X development platform''' is [[Compiling Kodi]].


== Hardware requirements ==
== 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).
* [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).
 
== 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? ===
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:'''
== Detailed technical information ==
* Any deinterlacing that is not linear blending (which FFmpeg does in software)
For more details please visit the [[Development]] section of this manual.
* 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)


== 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]]




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


[[Category:Development]]
[[Category:Apple]]
[[Category:Skin Development]]
[[Category:Mac OS X]]
[[Category:Apple TV 1]]
[[Category:OpenGL]]
[[Category:To-Do]]
[[Category:Google Summer of Code]]

Latest revision as of 20:22, 7 December 2020

Home icon grey.png   ▶ Development ▶ OS X development


Cleanup.png This page or section may require cleanup, updating, spellchecking, reformatting and/or updated images. Please improve this page if you can. The discussion page may contain suggestions.


Development:

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.


End-users (non-programmers)

You can help too by downloading Kodi for OS X, testing it, and 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.

Developers (programmers)

You should be proficient in C/C++ programming language, and although not really required knowledge of OpenGL or other multimedia programming is a plus, as well as prior cross-platform or porting development experience.

The Mac OS X development platform is Compiling Kodi.

Hardware requirements

Detailed technical information

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

Source code

The Kodi source code is in the XBMC Foundation git repository on github.com. Full instructions for compiling/builing Kodi under Mac is available here: