Google Summer of Code

What is Google Summer of Code?

GSoC is a global program that offers students stipends to write code for free software and open source projects during the summer. For three months students work to complete a given task as part of the project’s community and under the guidance of experienced mentors. The program is an excellent opportunity for students to gain experience with real-world software development and make a contribution that benefits everyone. It brings new contributors to LilyPond and enables students who are already involved to become more involved. LilyPond participates in GSoC as part of the GNU project.

We have had GSoC participants in 2012, 2015, 2016 and 2017. This site is current for the 2018 program.

Project Ideas List

Below is a list of GSoC project ideas (last update: May 2017), but if you have other ideas for a project you may complete within the three months of the program you’re welcome to make a suggestion on our developer mailing list (see Contact). There are a number of areas where LilyPond could be improved, and our development team is always willing to help those who would like to tackle a project similar to those listed below. As mentor availability varies from project to project and from year to year it is wise to get in touch with us as early as possible.

Per 2018 we have installed the new role of “Community Mentor”. We aim at assigning one Community Mentor to each active project who is not responsible for discussing the implementation or reviewing the code. Instead they will on the one hand discuss the design of the planned features from the (power) user perspective, and they will look after the communication between student and mentor, and between the two and the community.

A full list of all the current open issues can be found here.

Adopt the SMuFL music font encoding standard

For several years now a new standard for music fonts has been around: SMuFL, which is also discussed as becoming part of a future W3C standard for music encoding. As a FLOSS tool LilyPond should adhere to such an open standard instead of using an isolated solution like it does today. Adopting SMuFL will help integrating LilyPond with the world of music notation software and eventually give LilyPond users access to a wider selection of notation fonts.

Making LilyPond compliant to SMuFL includes remapping of the glyphs that are built from METAFONT sources, adjusting the glyphs’ metrics to SMuFL’s specifications, and finally updating the way LilyPond looks up and positions the glyphs. As an optional part of this project LilyPond’s font loading mechanism could be modified to use notation fonts installed as system fonts instead of inside the LilyPond installation.

Difficulty: Easy/medium

Requirements: C++ and willingness to get familiar with LilyPond internals.

Recommended: Interest and experience in working with font files. A little bit of METAFONT.

Mentors: Werner Lemberg, Abraham Lee

Adding variants of font glyphs

  • Adding ‘on’ and ‘between’ staff-line variants.
  • Shorter and narrower variants of some glyphs for example, accidentals. Another, more specific example could be an ancient notation breve notehead coming in two variants one with a small or big ‘hole’ within it.

Difficulty: easy

Requirements: MetaFont, C++, good eye for details

Recommended knowledge: basic LilyPond knowledge

Mentor: Werner Lemberg

Rewrite LibreOffice LilyPond Extension with Python

The OOoLilyPond extension made it possible to conveniently include LilyPond score snippets in OpenOffice.org/LibreOffice Writer, Draw and Impress documents while keeping source and image together. After many years without development an initial effort has started to make the extension compatible again with current versions of LibreOffice and LilyPond.

However, as the LibreOffice ecosystem has changed substantially it is now possible to rewrite the extension with Python and PyQt. This will not only be more powerful in general but will allow the integration of functionality from Frescobaldi, such as for example syntax highlighting, entry helpers, score wizards or musical transformations.

Difficulty: easy/medium

Requirements: Python, PyQt, LilyPond basics, LibreOffice extension basics

Recommended knowledge: Familiarity with Frescobaldi code based or willingness to learn during bonding period

Mentor(s): Joram Berger, Urs Liska, (Thorsten Behrens/LibreOffice)

Fix Beaming Patterns/Beam Subdivisions and Tuplets

Subdivision is an important way to improve the readability of beamed music. However, despite several attempts at fixing it LilyPond still does not always produce correct results. In order to properly fix this issue it seems necessary to rewrite the responsible code from the ground up. Much work has already been done assessing the issue (see this discussion and this work-in-progress document).

In the course of this assessment it has been found that LilyPond’s conception of tuplets is somewhat flawed as well (see this discussion), and that this has to be fixed as well.

Difficulty: medium

Requirements: C++

Recommended knowledge: Good musical and mathematical understanding of timing issues

Mentors: Urs Liska, Carl Sorensen

Support for Style Sheets

LilyPond’s engraving output can be tweaked to the least detail, and one important addition in recent years was the ability to use alternative notation fonts. It is possible to create reusable modules for “house styles”, but this project aims at bringing this to a new level by creating a convenient extension package with support for creating, applying, and sharing modular style sheets. We are looking for a hierarchical structure that allows to mix and match style elements for “house” (e.g. “my-personal-style”, “client-a”, “client-b” etc.), score type, paper size etc.

Work can be built upon the existing notation-fonts openLilyLib package. We would like to see a further improvement of the loading mechanism for notation fonts (for example a better separation of loading notation and text fonts) as part of the project, and optionally (this would involve working on Lilypond’s C++ code) support for notation fonts that are installed system-wide.

Difficulty: medium

Requirements: Scheme, aesthetic competence

Recommended: sense of building hierarchical frameworks

Optional: C++ (for font loading internals)

Mentor: Abraham Lee

Community Mentor: Kieren MacMillan

Contemporary Notation

LilyPond is very good at creating non-standard notation. Having to code every graphical element instead of simply drawing it may seem cumbersome but is in fact a strong asset. New notational functionality can be provided with consistent appearance, automatic layout and a natural syntactic interface.

Within the openLilyLib library system the student will create a fundamental infrastructure and building blocks to make creating contemporary notation easier. Additionally (at least) one concrete package is developed to cover specific contemporary notation, such as for example the style of a given composer, extended playing techniques for a specific instrument or a certain category of effects.

Difficulty: medium

Requirements: Scheme (interaction with LilyPond internals), contemporary notation techniques

Recommended: sense of building hierarchical frameworks

Mentors: NN, Urs Liska

Extending scholarly editing features

The scholarLY extension package provides a powerful infrastructure for scholarly editions. With this package it is possible to encode annotations, to export them for critical reports, or to produce editorial highlighting in the score (e.g. dashing, parenthesizing etc.), footnotes etc.

As a GSoC project substantial enhancements can be made to the package. Our suggestion is an infrastructure to encode variants (alternative readings, corrections, regularizations), as outlined in this issue. It could naturally be extended by the ability to produce music examples from annotations, to be used in footnotes or reports.

Difficulty: medium

Requirements: Scheme, ability to assess an extensive existing package

Recommended: familiarity with scholarly editing

Mentors: Jeffery Shivers, Urs Liska

Information for Applicants/Participants

In order to have a satisfying experience with GSoC applicants are strongly advised to thoroughly read the following recommendations. Some of these are relevant for the application process, others for the time within the project.

There is a list of inactive projects in the Attic. We list projects there that are still considered valuable but for which there are currently no mentors available.