Google Summer of Code/2017

From Official Kodi Wiki
< Google Summer of Code
Revision as of 11:17, 9 February 2017 by Natethomas (talk | contribs) (Team-Kodi proposal ideas up for discussion)
Jump to: navigation, search
Home icon grey.png   ▶ Google Summer of Code ▶ 2017
GSOC 2016 logo.png
Welcome to the Kodi Google Summer of Code ideas page.

We encourage interested students to review some of the ideas on this page, and then feel free to provide input on any ideas you may have in the Kodi GSoC forum and chat about any project you’d love to cover. To propose a project, see #Students project proposal ideas.

From the 20th of March to the 3rd of April, any interested students may apply at the GSOC home page to work with Kodi. After that, we’ll notify applicants whether we get to work with each other according to the GSOC schedule.

1 About Us

As there may be many students who have landed here as a result of GSOC, but are unfamiliar with the project, here are a few resources that may help explain what we are about.

Kodi (formerly known as XBMC) is an award-winning free and open source (GPL) software media player and entertainment hub for digital media, designed around the 10-foot interface (living room) environment. Created in 2003 by a group of like minded programmers, Kodi is a non-profit project run and developed by volunteers located around the world. More than 500 software developers have contributed to Kodi, and 100-plus translators have worked to expand its reach, making it available in more than 60 languages. For more information, see the page Kodi.


To get an idea of what Kodi is truly capable of, it really must be seen. Check out a few other user-created videos:
Kodi with the default Confluence skin
Kodi with Aeon Nox skin
Kodi on Raspberry Pi
Kodi's new PVR functionality

Kodi is written primarily in c++ and runs on a variety of platforms including Android, iOS, Linux, OS X, and Windows. It has been ported to work on several low-power platforms including the Raspberry Pi and Android.

Kodi was a mentoring organization in 2008, 2012, 2013 and 2015, and had team members involved in GSoC for other projects during 2011.

If Kodi is selected as a mentoring organization for 2017, students will need to review the Overview of a good project proposal, follow the outline for proposals when applying, and review the list of project ideas detailed below. Students are welcome to propose ideas outside the list and are encouraged to be as creative as they like.

1.1 Mentors

All mentors and backup mentors are extremely experienced in the Kodi codebase and will thus be able to assist students in getting to know the codebase and in quickly identifying projects that are both achievable for someone unfamiliar with the internal workings of Kodi and desirable to the wider Kodi community.

2 Prerequisites

C++ coding skills, basic familiarity with Git, solid understanding and interest in programming. Ability to quickly understand existing code is beneficial.

3 Project Proposals

3.1 Overview

Qualifications for a good Summer of Code proposal:

  • Discrete, well-defined, modular
  • Comprised of a series of measurable sub-goals
  • Based on open specs that are available free of charge
  • Based on complete specs

An example of a good proposal is the implementation of a new feature or function that is not yet available in Kodi.

An example of a less desirable proposal is one that's not as measurable, such as refactoring an existing API. Bad proposals tend to be ones that would require touching a lot of core code.

To re-iterate:

  • Localized/isolated code projects = good
  • Global code refactoring = bad
  • A project should have a set of subgoals, so even if the end goal turns out to be too big some of the parts will be of benefit.
  • Not too big! This is an important problem when choosing a project, while it is fun to think about solving a grand project its not always realistic. Its better to finish a smaller project than to start a grand one.

3.2 Where to submit proposals

In addition to submitting to the Google Summer of Code website, you are highly encouraged to submit your idea/proposal to the Kodi forum for discussion. Any proposal not submitted to the forum for discussion will likely not be considered.

3.3 Outline for proposals

4 Team-Kodi proposal ideas up for discussion

4.1 Server Improvement

4.1.1 Add Python3 Support

  • As the title suggests, Kodi currently does not support Python 3, and we'd love to work with a student on getting that support.

4.1.2 UPnP Improvements including File Transfers

  • Support downloading of of media items (the actual file not just the metadata) from another Kodi instance (e.g. through UPnP) into the local library. This could be done in a "send to" way and in a "download" way and it could also be combined with transcoding depending on the target device.
  • UPnP device profiles. there's already a PR that goes in that direction and the problem is that right now we can only really provide device specific MIME type hacks but if we have transcoding we'll definitely need this

4.2 Better Profile Support

Profile support inside Kodi remains extremely hacked together. Improving profile projects would likely be broken down into smaller chunks to make each chunk truly achieveable in a summer.

4.3 Web Browser in Kodi

Initial work on Web Browser implementation already exists, but much is left to do on this project, and many developers are excited to help act as a mentor for this particular project.

4.4 Re-implement Wayland Support

Wayland support has been worked on in the past, but issues with core Kodi made it unmergeable. Now those core pieces have been resolved, but a great deal of work remains to for any inspired student to finally take the plunge.

4.5 Gaming in Kodi

4.5.1 Retroplayer

  • Developer Garbear has broken down the Retroplayer project into manageable pieces including input, core, game addons, peripheral addons, netplay, a game library implementation, and shaders to do things like emulate a CRT monitor. Any one of these pieces could make an excellent summer project depending on your familiarity in the area. Many pieces are currently being worked on or are near completion, but many more could use help from a student familiar with the area. Visit the retroplayer section of the Kodi forum to see all the major projects still to do.

4.6 More

We feel it is important to note that, while we are interested in a focus on the listed three areas, we would like to stress passion, expertise, and creativity above all else. If you would like to do something completely different, definitely send in that proposal. The ideas listed above are, as always, merely suggestions. We will be interested in any idea, so long as you can communicate your interest, your background, and your solution the problem.

5 Students project proposal ideas

Submit your own proposals on the Kodi GSoC forum. They can be as big or as small as you feel you can comfortably accomplish between PROJECT START DATE and PROJECT END DATE. In the end, it's better to have a smaller, completed project, rather than a larger, incomplete project.

To submit a proposal idea:

  1. Copy the text from #Outline for proposals.
  2. Create a new forum post HERE and paste the text.
  3. Fill out everything using your specific proposal.