Google Summer of Code/2021: Difference between revisions
(Remove entries that only had garbear as possible Mentor since he's not joining this year) |
No edit summary |
||
| Line 3: | Line 3: | ||
[[File:GSOC_2016_logo.png|left|150px]]Welcome to the Kodi [http://summerofcode.withgoogle.com Google Summer of Code] ideas page. <!--We are pleased to announce that we have been accepted as an official [http://www.google-melange.com/gsoc/org/google/gsoc2016/Kodi GSoC mentor organization this year].--> | [[File:GSOC_2016_logo.png|left|150px]]Welcome to the Kodi [http://summerofcode.withgoogle.com Google Summer of Code] ideas page. <!--We are pleased to announce that we have been accepted as an official [http://www.google-melange.com/gsoc/org/google/gsoc2016/Kodi GSoC mentor organization this year].--> | ||
'''This page is currently work in progress.''' | '''This page is currently work in progress. Kodi has applied as mentoring organization for GSoC 2021. Accepted organizations will be announced on March 9.''' | ||
We encourage interested students of all ethnicities and genders to review some of the ideas on this page, and then feel free to provide input on any ideas you may have in the '''[https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi GSoC 2021 forum]''' and chat about any project you’d love to cover. To propose a project, see '''[[#Students project proposal ideas]]'''. | |||
From the 29th March to the 13th of April, any interested students may apply at the [http://g.go/gsoc GSoC home page] to work with Kodi. After that, Google will notify applicants whether we get to work with each other according to the [https://developers.google.com/open-source/gsoc/timeline GSoC schedule]. | |||
<!-- From the 29th March to the 13th of April, any interested students may apply at the [http://g.go/gsoc GSoC home page] to work with Kodi. After that, Google will notify applicants whether we get to work with each other according to the [https://developers.google.com/open-source/gsoc/timeline GSoC schedule]. --> | |||
== About Us == | == About Us == | ||
| Line 49: | Line 53: | ||
* Global code refactoring = ''bad'' | * 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. | * 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. | * 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. It's better to finish a smaller project than to start a grand one. | ||
{{Warning |1='''GSoC 2021 is different from the years before. All projects should have a workload of ~175 hours (previously: 350 hours). Project applications that do not fit this scope will be rejected.'''|title= }} | |||
=== Where to submit proposals === | === Where to submit proposals === | ||
In addition to submitting to the [https://g.go/gsoc Google Summer of Code] website, you are highly encouraged to submit your idea/proposal to the [https://forum.kodi.tv/forumdisplay.php?fid= | In addition to submitting to the [https://g.go/gsoc Google Summer of Code] website, you are highly encouraged to submit your idea/proposal to the [https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi forum] for discussion. Any proposal not submitted to the forum for discussion will likely not be considered. | ||
=== Outline for proposals === | === Outline for proposals === | ||
| Line 98: | Line 104: | ||
'''Type:''' Webinterface development | '''Type:''' Webinterface development | ||
<!-- | |||
=== Better profile support === | === Better profile support === | ||
'''Description:''' Profile support inside Kodi remains extremely hacked together. Improving profile projects would likely be broken down into smaller chunks to make each chunk truly achievable in a summer. Database handling for profiles needs to be reviewed and changed so that the user experience is more streamlined. It should also be possible to better guard code paths that need to check for specific profile rights. | '''Description:''' Profile support inside Kodi remains extremely hacked together. Improving profile projects would likely be broken down into smaller chunks to make each chunk truly achievable in a summer. Database handling for profiles needs to be reviewed and changed so that the user experience is more streamlined. It should also be possible to better guard code paths that need to check for specific profile rights. | ||
| Line 110: | Line 117: | ||
'''Type:''' Core development | '''Type:''' Core development | ||
--> | |||
<!-- | |||
=== Replacing depends with a CMake-based system === | === Replacing depends with a CMake-based system === | ||
| Line 124: | Line 133: | ||
'''Type:''' Infrastructure/Automation | '''Type:''' Infrastructure/Automation | ||
--> | |||
===Add-ons=== | ===Add-ons=== | ||
| Line 140: | Line 150: | ||
===Using fuzz testing to fuzz test Kodi=== | ===Using fuzz testing to fuzz test Kodi=== | ||
'''Description:''' Adding fuzz testing to Kodi would be very valuable to find problems in the current code base. Especially security problems. First step would be choosing a framework either American fuzzy lop, libFuzzer or other similar projects. After we decided on that it would be time to start to fuzz different methods that are widely used in Kodi and try to expose flaws in those. If this leads to success, it should be documented and made repeatable. | '''Description:''' Adding fuzz testing to Kodi would be very valuable to find problems in the current code base. Especially security problems. First step would be choosing a framework either American fuzzy lop, libFuzzer or other similar projects. After we decided on that it would be time to start to fuzz different methods that are widely used in Kodi and try to expose flaws in those. If this leads to success, it should be documented and made repeatable. | ||
| Line 153: | Line 162: | ||
'''Type:''' Risky/Exploratory | '''Type:''' Risky/Exploratory | ||
<!-- | |||
===inputstream.adaptive binary addon=== | ===inputstream.adaptive binary addon=== | ||
| Line 185: | Line 195: | ||
'''Type:''' Media playback | '''Type:''' Media playback | ||
--> | |||
===Other ideas=== | ===Other ideas=== | ||
These ideas still need expanding and/or assigned a potential mentor. If one of these ideas interests you, feel free to ask for more info in the GSoC 2020 forum area. We may be able to assign a mentor if enough interest is shown | These ideas still need expanding and/or assigned a potential mentor. If one of these ideas interests you, feel free to ask for more info in the GSoC 2020 forum area. We may be able to assign a mentor if enough interest is shown | ||
*Improvements to Retroplayer (retro gaming integrated in Kodi core) (possible mentors: gusandrianos) | |||
*Visual Studio Code addon to validate/syntax highlight Kodi Addons | *Visual Studio Code addon to validate/syntax highlight Kodi Addons | ||
*Using fruit or similar to use DI in Kodi and write tests | <!--*Using fruit or similar to use DI in Kodi and write tests--> | ||
*High quality scalers for OpenGL(GLSL). Scale Y and UV plane separately (possible mentors: velocity) | *High quality scalers for OpenGL(GLSL). Scale Y and UV plane separately (possible mentors: velocity) | ||
*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. | <!--*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 | <!--*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--> | ||
*Implementing a performance critical element of kodi in rust | *Implementing a performance critical element of kodi in rust | ||
| Line 200: | Line 212: | ||
== Students project proposal ideas == | == Students project proposal ideas == | ||
Submit your own proposals on the '''[https://forum.kodi.tv/forumdisplay.php?fid= | Submit your own proposals on the '''[https://forum.kodi.tv/forumdisplay.php?fid=315 Kodi GSoC forum]'''. They can be as big or as small as you feel you can comfortably accomplish between '''June 7''' and '''August 23'''. In the end, it's better to have a smaller, completed project, rather than a larger, incomplete project. | ||
To submit a proposal idea: | To submit a proposal idea: | ||
# Copy the text from '''[[#Outline for proposals]]'''. | # Copy the text from '''[[#Outline for proposals]]'''. | ||
# Create a new forum post '''[https://forum.kodi.tv/forumdisplay.php?fid= | # Create a new forum post '''[https://forum.kodi.tv/forumdisplay.php?fid=315 HERE]''' and paste the text. | ||
# Fill out everything using your specific proposal. | # Fill out everything using your specific proposal. | ||
[[Category:Google Summer of Code]] | [[Category:Google Summer of Code]] | ||
Revision as of 16:12, 18 February 2021
| Google Summer of Code |
|---|
| - GSOC 2021 |
| - GSOC 2022 |
| - GSOC 2023 |
| All GSOC Pages |
|
 Google Summer of Code |
2021
|
Welcome to the Kodi Google Summer of Code ideas page.
This page is currently work in progress. Kodi has applied as mentoring organization for GSoC 2021. Accepted organizations will be announced on March 9.
We encourage interested students of all ethnicities and genders 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 2021 forum and chat about any project you’d love to cover. To propose a project, see #Students project proposal ideas.
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, 2015, 2017, 2018, 2019 and 2020 and had team members involved in GSoC for other projects during 2011.
If Kodi is selected as a mentoring organization for 2021, 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.
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.
Prerequisites
Some coding skills, basic familiarity with Git, solid understanding and interest in programming. Ability to quickly understand existing code is beneficial.
Project Proposals
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. It's better to finish a smaller project than to start a grand one.
|
GSoC 2021 is different from the years before. All projects should have a workload of ~175 hours (previously: 350 hours). Project applications that do not fit this scope will be rejected. |
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.
Outline for proposals
Team-Kodi proposal ideas up for discussion
Explore building binary addons in rust
Description: While Kodi has python addons, it can also handle binary addons. But these need to be build one by one for each platform and also might fail on errors. Rust might help with both of those problems and more. The idea is to use the api we have but via rust ffi and see where that leads us.
Expected outcome: Documentation and templates on how to use rust with kodi. In the best case also one or two example addons.
Skills preferred: C++, Rust, C
Possible mentors: spiff, Razze
Difficulty: Hard
Type: Binary addon development
Finish the new web interface
Description: Kodi has a in development webinterface by the name of elm-chorus (https://github.com/xbmc/elm-chorus) which is written in Elm and is still missing some features of Chorus2 (the old interface). So the idea would be to bring it up to speed and do some additional styling and packaging work.
Expected outcome: Finished shipable version of the webinterface
Skills preferred: HTML, CSS, Elm
Possible mentors: Razze
Difficulty: Medium
Type: Webinterface development
Add-ons
Automatic add-on checker for binary add-ons
Description: Kodis add-on checker checks each Kodi add-on PR on GitHub for certain problems, which ultimately makes reviewing Python add-ons easier for the team. But the other type of add-ons, binary add-ons is not being checked so far, which makes reviews and coding guidelines hard to handle. Thus it would be nice to also check those add-ons, either via the current checker written in Python or a new binary add-on specific checker. Goals would include checking the addon.xml, the C++ code and a check for potentially malicious code.
Expected outcome: Being able to run the checker against all binary repo PRs on GitHub.
Skills preferred: Python, C++
Possible mentors: Razze
Difficulty: Hard
Type: Low-hanging fruit
Using fuzz testing to fuzz test Kodi
Description: Adding fuzz testing to Kodi would be very valuable to find problems in the current code base. Especially security problems. First step would be choosing a framework either American fuzzy lop, libFuzzer or other similar projects. After we decided on that it would be time to start to fuzz different methods that are widely used in Kodi and try to expose flaws in those. If this leads to success, it should be documented and made repeatable.
Expected outcome: Being able to easily add more fuzz tests and having the process to do this documented.
Skills preferred: C++, CMake
Possible mentors: Razze
Difficulty: Medium
Type: Risky/Exploratory
Other ideas
These ideas still need expanding and/or assigned a potential mentor. If one of these ideas interests you, feel free to ask for more info in the GSoC 2020 forum area. We may be able to assign a mentor if enough interest is shown
- Improvements to Retroplayer (retro gaming integrated in Kodi core) (possible mentors: gusandrianos)
- Visual Studio Code addon to validate/syntax highlight Kodi Addons
- High quality scalers for OpenGL(GLSL). Scale Y and UV plane separately (possible mentors: velocity)
- Implementing a performance critical element of kodi in rust
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.
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 June 7 and August 23. In the end, it's better to have a smaller, completed project, rather than a larger, incomplete project.
To submit a proposal idea:
- Copy the text from #Outline for proposals.
- Create a new forum post HERE and paste the text.
- Fill out everything using your specific proposal.