Difference between revisions of "Summer Of Code"

From WineHQ Wiki
Jump to: navigation, search
(→‎VFW - Implement Indeo codecs: this needs legal review; we may want to call out to some library anyway)
(Get rid of the shader reflection API idea)
Line 110: Line 110:
* The most notable missing features are geometry and texture handling, state management and actual 3D draws.
* The most notable missing features are geometry and texture handling, state management and actual 3D draws.
Applicants should have understanding of how 3D APIs work, and specific knowledge in old Direct3D / DirectDraw versions will be of an advantage. You will have to work with file formats for 3D geometry and textures, fixed function transformation and the really awful Direct3D 1 interface.
Applicants should have understanding of how 3D APIs work, and specific knowledge in old Direct3D / DirectDraw versions will be of an advantage. You will have to work with file formats for 3D geometry and textures, fixed function transformation and the really awful Direct3D 1 interface.
=== VKD3D/Direct3D 10 - shader reflection ===
Possible Mentors: Józef Kucia
Difficulty: Medium
* [https://source.winehq.org/git/vkd3d.git/ VKD3D] contains libvkd3d-shader library which has a parser for shaders in the DXBC format.
* The goal of project would be to introduce shader reflection API to libvkd3d-shader. In the long-term, the API could be used to implement Direct3D 10 shader reflection - [https://msdn.microsoft.com/en-us/library/windows/desktop/bb173835(v=vs.85).aspx ID3D10ShaderReflection].
* ID3D11ShaderReflection is already, at least partially, implemented in Wine. The current implementation should be moved to libvkd3d-shader and extended.
* The following WineHQ bugs are related: [https://bugs.winehq.org/show_bug.cgi?id=39816 39816] and [https://bugs.winehq.org/show_bug.cgi?id=43042 43042].

Revision as of 16:45, 14 January 2020

Wine and the Google Summer of Code

This page collects some tips for students who want to work on Wine during the Summer of Code, and provides a few ideas for projects.

To apply, go to the Google Summer of Code home page.

Important notes!

  • Applicants MUST have submitted a patch or testcase to wine-devel (see Submitting Patches) to be considered for acceptance.
  • Please first send a draft proposal and discuss it with us, don't send the final one directly.
  • We cannot accept ReactOS proposals, so please only make proposals that will benefit Wine.

To apply, go to the Google Summer of Code home page.

Beware of Legal Requirements

You must state that you will follow these minimal legal requirements during the SoC (and have done so in the past):

  • You are not allowed to read or reuse Windows source code (leaked source / Windows Research Kernel* / ...)

(* we are following the SFLC's advice)

  • You are not allowed to reverse engineer Windows files by disassembling or decompiling them
  • You are not allowed to analyze Windows files with the trace functions of Wine
  • People who work or have worked for Microsoft should probably not participate

Other Outreach Programs

In addition to Google Summer of Code Wine also participates in:

  • Outreachy is a program similar to GSoC organized by the Software Freedom Conservancy. The goal of Outreachy is to provide encouragement, experience, and networking opportunities for minorities that are underrepresented in tech. Unlike GSoC, it is not limited to students; you can read the Wine Wiki's Outreachy page for more information.
  • Google Code-In is aimed at pre-university students and doesn't require any previous coding experience. As a result, the tasks for Code-In participants are more focused, smaller, and have a gentler learning curve. Some aren't even programming tasks but related to other aspects of an open-source project, such as market research, user-support, or documentation. For more details, see the Wine Wiki's Code-In page.


Your own idea

Possible mentors: We'll provide you with the appropriate mentor

  • If you have an idea, please post it on Wine Developers mailing list so we can help you with your idea and find out if it's realistic or not. Showing initiative and willing to discuss your idea greatly improves your chances of getting accepted. Even more so than taking one of the ideas below.
  • As long as you work hard and interact with the community and your mentor in a positive and constructive way you don't have to worry about not meeting all your goals.

Direct3D 10 Effects

Possible Mentors: Józef Kucia

Difficulty: Medium

  • Direct3D 10 implements effects in d3d10.dll. Native d3d10.dll cannot be used in Wine; thus, it would be quite valuable to have a better support for Direct3D 10 effects.
  • The work would consists of writing more tests for Direct3D 10 effects and implementing missing functionality.
  • The project goal could be set to fix/improve Steam Big Picture rendering in Wine, see bug 44120.

VKD3D - Write more tests for Direct3D 12

Possible Mentors: Józef Kucia

Knowledge prerequisite: C, knowledge of Direct3D 11, 12 or any 3D graphics API is helpful

Difficulty: Easy

  • VKD3D is a D3D12 to Vulkan translation library. It has a test suite which verifies behavior of Direct3D 12 API.
  • The work would consists of writing more tests for Direct3D 12 API.
  • Direct3D 11 tests from Wine conformance tests are good candidates to be ported to Direct3D 12 tests.

Direct3D - Microbenchmarks

Possible Mentors: Stefan Dösinger

Knowledge prerequisite: C, Direct3D, OpenGL

Difficulty: Medium

Debugging performance problems in full games is a challenge. Small test programs that test the performance of single operations can help to locate performance problems and fix them. Once fixed, those test programs can be used as regression tests to detect regressions that are hidden inside the margin of error in games. With an equivalent test case in OpenGL it is possible to separate problems in wined3d from problems in the driver.

Stefan Dösinger has already written test programs for draws, buffer uploads, clears and a few other operations and is testing them on a daily basis. More tests need to be written. The test programs will probably be maintained outside the Wine source tree.

A good application should contain a list of d3d operations to test, a rationale why those operations are good candidates and a short description how each of the tests will be implemented.

Make explorer.exe more useful

Possible Mentors: We'll provide you with the appropriate mentor

Knowledge prerequisite: C, Win32

Difficulty: Medium

Wine's file explorer allows a user to browse files but many features are missing. In particular, there is no support for drag & drop copying and moving of files and directories.

On many platforms, using a native file browser is a more natural alternative. However, on Android (and Chrome OS) machines, improving Wine's file browser could be better than using a native file browser. This is because of the Android security model and file system structure. Wine, when installed on Android, lives in a sandbox running as its own user, and on a non-rooted device, a native file browser will not have access to the files inside the Wine prefix. A user who wants to copy files from the limited areas of shared storage (i.e., the Downloads folder) into the c: drive, or vice versa, basically has to use a wine command prompt. Adding move / copy features to Wine's file explorer would provide a more user-friendly mechanism (which could also be used on other Wine platforms if desired).

Not being able to interact easily with the wineprefix is a major and basic usability issue with Wine on Android and Chrome OS. You can fix it!

Direct3DRM - Implement rendering for D3DRM

Possible Mentors: Stefan Dösinger, André Hentschel

Knowledge prerequisite: C, DirectDraw, Direct3D

Difficulty: Hard

  • D3DRM (Direct3D Retained Mode) is partially implemented, it needs to interact with ddraw to actually display something.
  • Even if it's an old library and has been removed in Vista, there are small Games based on it.
  • There may be value in making this work on Windows / native ddraw as well.
  • Some bugs with games that use d3drm: 12851, 19733, 21670. There are more of them.
  • Basic object creation, ddraw initialization and stand-alone math functions are implemented. Very rudimentary display functionality exists.
  • The most notable missing features are geometry and texture handling, state management and actual 3D draws.

Applicants should have understanding of how 3D APIs work, and specific knowledge in old Direct3D / DirectDraw versions will be of an advantage. You will have to work with file formats for 3D geometry and textures, fixed function transformation and the really awful Direct3D 1 interface.

D3DX9 - Implement missing D3DX9 APIs

Possible Mentors: Stefan Dösinger, Matteo Bruni

Knowledge prerequisite: C, maybe some domain-specific knowledge related to the APIs you want to implement

Difficulty: Easy to medium, depending on the functions you want to work on

  • D3DX9 dlls contain various utility functions related to common 3D graphics tasks. For instance they contain math functions, functions for loading textures, compiling shaders and much more.
  • A good chunk of those APIs has been implemented but a lot is still missing, such as:
    • some math functions (what's left is mostly about spherical harmonics and precomputed radiance transfer)
    • some mesh functions (D3DXComputeNormals(), D3DXOptimizeVertices(), ...)
    • a few texture functions
    • quite a few ID3DXConstantTable methods
    • effect framework bits and pieces
    • drawing text in ID3DXFont
  • The project would choose a reasonable subset of the missing functions and the work would consist of writing behavioral tests for those functions and actually implementing the functions themselves. We will help you in selecting a reasonably-sized subset of the API, suitable for a GSoC project.

Tools - Winetest Scripting Interface

Possible mentors: Stefan Dösinger

Knowledge prerequisite: C, scripting language of your choice

Difficulty: Easy

Wine has an extensive set of regression tests. These tests can be helpful for projects Wine depends on. E.g. the developers of 3D drivers may want to run our d3d tests and our d3d implementation to test their OpenGL implementations.

One obstacle Mesa developers reported is that the default way to run tests (run "make test") only reports success or failure. That's OK when all tests are passing, but it is a problem when there are known test failures and you want to make sure you don't introduce additional failures. In this case users have to manually check the output written to stdout, which is a terrible task.

The Wine testbot has some scripts to ignore known failures. It might help developers of dependency libraries if we made them available outside the testbot environment somehow. On the other hand we do not want to make the existing test code more complicated than it is. Ideally the tests themselves would not be modified.

For your proposal please think about what the API of such a scripting interface would look like and which information it provides to its callers.

DirectWrite: Implement vertical text layout support

Possible mentors: Nikolay Sivov

Knowledge prerequisite: C

Difficulty: Medium

DirectWrite is a text layout and rendering library available on recent Windows releases, starting with Vista. It provides several API layers to manage font file, process text, render it, and interact with GDI subsystem. A lot of basic functionality is already supported in Wine, this proposal is however about specific feature to process and render text in vertical mode. This touches every layer mentioned above, brief summary on what needs to be done follows:

  • AnalyzeVerticalGlyphOrientation - this method analyzes input text and returns orientation for every part of the text;
  • GetVerticalGlyphVariants - returns vertical glyphs for specified nominal glyphs, if font has any;
  • vertical glyph metrics should be properly returned, that includes GetDesignGlyphAdvances;
  • layout part has to support vertical direction when building lines, this implies baseline calculation, alignment logic changes, maybe something else;
  • IDWriteBitmapRenderTarget1 and IDWriteGlyphRunAnalysis have to support sideways mode too.

crypt32: Implement DSS (digital signature standard) Provider

Possible mentors: Hans Leidekker

Knowledge prerequisite: C

Difficulty: Medium

Many .NET applications fail to run, because currently the DSS and enhanced DSS provider are missing in crypt32.dll. There are already some tests for that, but more might be necessary. See also Bug 10506

AppDB improvements

Possible mentors: Jeremy Newman, Rosanne DiMesio

Knowledge prerequisite: PHP, HTML, MySQL

Wine's Application Database (https://appdb.winehq.org/) is old and could use improvements. If you have ideas for improvements and new features please step forward!

Uniscribe: Improve Indic language support

Possible mentors: Aric Stewart

Knowledge prerequisite: C, familiarity with fonts and opentype a plus, familiarity/fluency in Devanagari, Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada or Malayalam not required but a big plus.

Difficulty: Medium

Uniscribe is the text layout and rendering system for earlier versions of windows and much of the Wine UI. The frameworks is mostly in place as well as a first pass implementation for many languages including the Indic languages. However nobody with more than a passing knowledge of the languages has dug into the details and issues in properly displaying these complicated languages. Including issues around separate Indic matras. Ideally the student working on this will also be fluent enough to at least start doing some translation of the Wine strings into the target language as well, so that Wine's usability in those languages greatly improves.

Implement Windows Media Player control

Possible mentors: We'll provide you with the appropriate mentor

Knowledge prerequisite: C, COM+, OLE32, DirectShow?

Difficulty: Medium

A lot of apps and libraries use Windows Media Player COM/ActiveX control to implement media playback (Including MS .Net's System.Windows.Media.MediaPlayer class). Users can usually workaround this by just installing windows media player 9 or 10. However this technically requires a Windows license. Wine currently has a stub-only implementation of WMP. WMP can be used in a headless mode for media playback or could be used as a full UI component with full controls. For the purpose of GSoC scope could be limited to headless parts.

It would be nice to have a builtin implementation. Potentially media playback could be implemented using DirectShow.

This project should most likely have an end goal of "Have <insert app/game here> work with builtin WMP implementation and have audio/video media playback working".

Winecfg / winemenubuilder - enhance MIME type handling

Possible Mentors: Michael Müller, Sebastian Lackner

Knowledge prerequisite: C

Difficulty: Medium

Wine tries to integrate Windows programs as much as possible into your unix/linux system and provides ways to directly assign MIME types to programs running in Wine. This makes it possible to open Word when you click on a .docx file in your file browser. However, this kind of integration is not always desirable, especially if there are native programs which support the same MIME type. At the moment a user can only decide to disable this kind of integration completely or Wine will automatically forward all MIME type registrations of Windows programs, resulting in questionable ones like .txt -> notepad and .png -> Wine Internet Explorer. If a user wants to remove such MIME type registration again, it is necessary to manually delete the according files.

The idea of this task is to provide a GUI (most probably as part of winecfg) to control the creation of such MIME type assignments and therefore making Wine more user friendly. You can find ideas how such a GUI could look like in the Forum or in the Bug Tracker. This task is also suitable for new Wine developers as no deep knowledge about the Wine source code is required. It might help though to have some knowledge about Win32 Dialogs.

XMLLite: Implement fully compatible xmllite parser

Possible mentors: Nikolay Sivov

Knowledge prerequisite: C

Difficulty: Medium

  • There shoudn't be any external dependencies for parsing functionality
  • The main focus should be on the Reader
  • Full parser resuming functionality for pending reads
  • Unit tests
  • Support for external entities to allow nested parser inputs

Tools - Implement resource editor and / or dialog editor

Possible Mentors: Marcus Meissner

Knowledge prerequisite: C, some UI programming perhaps

Difficulty medium, might be bit large for a student project

  • We currently have no graphical dialog / resource editor
  • Free external ones are AdWare infected or Payware

CMD - implement more robust parser

Possible Mentors: We'll provide you with the appropriate mentor

Knowledge prerequisite: C, bison, flex, CMD commands

Difficulty: Medium

  • http://kegel.com/wine/sweng/2010/ is a project to fix a number of small bugs in Wine's cmd.exe and friends, and to write testcases for it. It has helped bring to light certain flaws in cmd.exe's parsing of if/then/else and () blocks.
  • Somebody could quite usefully spend a summer bulking up the test cases for cmd and friends, fixing any remaining reported bugs, and improving the parser.

Portability - Port WineLib to a new architecture

Possible mentors: André Hentschel

Knowledge prerequisite: Assembler for the target

Difficulty: Medium, depending on the target

  • Wine can run WineLib applications on different CPU architectures, but needs at least some assembler code for that.
  • Suggested architectures: PowerPC64 (maybe POWER8?), Sparc64, RISC-V.
  • You will also need a test system. Qemu should be possible.

mspatcha - implement patch parser

Possible mentors: Zebediah Figura

Knowledge prerequisite: C

Difficulty: Medium

  • Many MSI installers ship patch files to update or install programs; see bug 12501. These patch files are in an undocumented binary format.
  • Project would consist of reverse-engineering the patch format and implementing a parser. Ultimate goal is a working ApplyPatchToFile() implementation.
  • A way to create new patch files (i.e. mspatchc.dll / mpatch.exe) could also be useful.

Unsorted further ideas

Further cmd.exe improvements

Further work on the cmd.exe implementation. We need to scope / find out what is missing before offering.

Fix Windows theming / implement themes

After we fix Windows theming in Wine (project 1) we could implement themes (project 2).

Improve Wine's fonts

Improve our own fonts and/ or add new fonts. (This is not for GSOC usually, more for Outreachy)

Improve accessibility of Wine

Wines accessibility for e.g. blind people is lacking and can use improvements.

winetest improvements

Improve the server and/or client side of the wine test framework. (?)


A tool to verify signatures on MSI packages / EXEs(?)

(Need to evaluate if effort matches GSOC effort scope.)


A tool to list currently running programs.

(Need to evaluate if effort matches GSOC effort scope.)

See, e.g., https://bugs.winehq.org/show_bug.cgi?id=43990

DPI Resolution handling

We have some DPI resolution issues, some work in this area is needed.


Is there any work needed on DirectPlay... Identify missing things.

Common Item Dialog Box improvements

Ask Vincent Povirk about details / ideas.

Improvements of this dialog box framework.

Improvements of specific Windows applications

Hard to scope the effort for specific applications beforehand to meet the GSOC effort range.

(brainstorm: Perhaps select some "known" apps that might be in the range?)

Tools - implement a wine diagnostic tool

Collect data about the current installation that can be used for AppDB or bugreporting. Things like wine version, operating system, native dlls versions, etc.