Skip to content

GSoC2022

john edited this page Feb 10, 2022 · 2 revisions

Project Description

SRS is a simple, high efficiency and realtime video server, supports RTMP/WebRTC/HLS/HTTP-FLV/SRT.

This is our ideas page for ​Google Summer of Code 2022. See the ​GSoC Timeline for important dates.

Information for Students

Getting Started

Get to know SRS. If you are a student interested in contributing to SRS, it is recommended to start by join in the discord SRS channel, visiting our discord channel (https://discord.gg/yZ4BnPmHAd), and exploring both the codebase and the development workflow. Feel free to contact us if you have any questions. Also do not hesitate to answer questions from other students on our discord channel if you know the answer to something. Find a project. Listed on this page are mentored and un-mentored projects. Mentored projects are well-defined and mentor(s) have already volunteered. Un-mentored projects are additional ideas you may want to consider, but you will have to contact us to find a mentor. You can also propose your own project, if you can think of one that better fits your interest and skill level. If a project description is unclear or you have any questions, please get in touch with its mentor and/or join our discord channel at https://discord.gg/yZ4BnPmHAd. Contact us. If you decide on a project, get in touch with the community and let us know. If you want to work on a qualification task, let the respective mentor know so we can avoid duplicated efforts. Apply. Students should apply definitely before deadline on April 13th. The "work" period begins on June 7th and ends in August. Take a look at ​GSoC timeline for additional information. Note, make sure you apply to Google before April 13th, even if you have not yet finished your qualification task. Please apply as soon as possible: Applications can be improved until the 13th but not afterwards! Note: A friendly reminder that while the application to GSoC is important for you and GSoC, SRS mentors will not base their decision solely on the GSoC application. We will judge applicants based on their qualification tasks to understand their abilities in coding, learning the tools, communication skills etc. So please do not worry about your application being perfect for us. Although it is very important to follow GSoC's application rules so they can pay you.

Qualification Tasks

In order to get accepted you have to complete a small qualification task which in all cases include sending pull request to the ossrs github. SRS development can be quite challenging and the qualification task helps us figure out whether you are motivated enough and have the potential to deliver successfully.

The qualification tasks are usually shown in the project description. Contact the respective mentor(s) for assistance on getting a related qualification task or if you want to propose your own. You can also browse the SRS issues for qualification task ideas. In general qualification tasks should include submitting pull request to the ​ossrs github which passes review and is accepted into the SRS codebase. It will be common for such pull request to need multiple iterations of submissions and reviews, so don't wait too long with the first submission! Note, please avoid picking a qualification task which another student is already working on, each student should work on a different qualification task.

Development

If you are selected for a particular project then you are not only expected to present a working implementation but you should also submit your work for inclusion for the SRS codebase. This should be done at least 2-3 weeks before the end of the second work period by sending pull request to the ossrs github where the SRS community and your mentor will review your work. You will likely be asked to make some changes and resend improved versions. If you feel that no consensus is reached about how something should be done then follow the advice of your mentor.

In order to create good quality patches make sure to read the ​Developer Documentation.

Contacting SRS

If you have questions or comments feel free to contact us via our discord, IRC channel, or e-mail one of the SRS GSoC admins:

Discord: https://discord.gg/yZ4BnPmHAd SRS GSoC Admins:

You may also contact a mentor directly if you have questions specifically related to one of the projects listed on this page.

New project template

Name of project:

Mentor name:

Mentor email:

Subcomponent of SRS (ex: etc.):

Description of project (1-2 paragraphs):

Skills needed (python, c++):

Difficulty (beginner, intermediate, advance)

Standup/weekly call mentee could attend?:

Steps to evaluate an applicant for the project:

1-2 short pararaphs about what first 2 weeks of work would look like during the internship:

Welcome to SRS wiki!

SRS 5.0 wiki

Please select your language:

SRS 4.0 wiki

Please select your language:

SRS 3.0 wiki

Please select your language:

SRS 2.0 wiki

Please select your language:

SRS 1.0 wiki

Please select your language:

Clone this wiki locally