OpusContributing - Revision history

MarkH: /* How to report bugs */ trac issues have been migrated to gitlab.xiph.org

2018-09-26T03:41:30Z

How to report bugs: trac issues have been migrated to gitlab.xiph.org

← Older revision		Revision as of 03:41, 26 September 2018
Line 28:		Line 28:
	== How to report bugs ==		== How to report bugs ==

	~~You can report bugs in~~ '''[https://~~trac~~.xiph.org/~~report/25 trac~~]'''. Please also notify developers on the [mailto:opus@xiph.org mailing list].		The '''[https://gitlab.xiph.org/ Xiph.Org GitLab]''' may be used to report bugs in [https://gitlab.xiph.org/xiph/opus/issues opus], [https://gitlab.xiph.org/xiph/opusfile/issues opusfile], [https://gitlab.xiph.org/xiph/libopusenc/issues libopusenc], or [https://gitlab.xiph.org/xiph/opus-tools/issues opus-tools]. Please also notify developers on the [mailto:opus@xiph.org mailing list].

	For sensitive (security-related) bugs, please '''[https://www.opus-codec.org/contact/ contact the developers]''' directly.		For sensitive (security-related) bugs, please '''[https://www.opus-codec.org/contact/ contact the developers]''' directly.

MrZeus: /* How To Contribute */ add Opus within Mpeg-TS link

2016-11-15T11:28:15Z

How To Contribute: add Opus within Mpeg-TS link

← Older revision		Revision as of 11:28, 15 November 2016
Line 21:		Line 21:
	* Optimizations (assembly/intrinsics)		* Optimizations (assembly/intrinsics)
	* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions		* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions
	* Mapping to new containers - see '''[[MatroskaOpus]]''', '''[[Mp4Opus]]''' and '''[[OggOpus]]''' (on Standards Track as '''[https://tools.ietf.org/html/rfc7845 RFC 7845]''')		* Mapping to new containers - see Opus within '''[[MatroskaOpus\|Matroska]]''', '''[[Mp4Opus\|MP4]]''', '''[[OpusTS\|Mpeg-TS]]''' and '''[[OggOpus\|Ogg]]''' containers (Ogg spec is on Standards Track as '''[https://tools.ietf.org/html/rfc7845 RFC 7845]''').

	It is generally advisable to contact the developers on the mailing list or the IRC channel before taking on new work on Opus,		It is generally advisable to contact the developers on the mailing list or the IRC channel before taking on new work on Opus,

MrZeus: /* How To Contribute */

2016-11-14T17:32:01Z

How To Contribute

← Older revision		Revision as of 17:32, 14 November 2016
Line 18:		Line 18:
	* Reporting and fixing bugs		* Reporting and fixing bugs
	* Improving tools		* Improving tools
	* Improving testing framework		* Improving testing framework - see the '''[https://github.com/xiph/opus/tree/master/tests test code]''' and the '''[[Opus_testvectors\|Opus Test Vectors]]''' page
	* Optimizations (assembly/intrinsics)		* Optimizations (assembly/intrinsics)
	* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions		* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions

MrZeus: /* How To Contribute */ add links to MatroskaOpus, Mp4Opus, OggOpus and its RFC 7845

2016-11-14T16:50:02Z

How To Contribute: add links to MatroskaOpus, Mp4Opus, OggOpus and its RFC 7845

← Older revision		Revision as of 16:50, 14 November 2016
Line 21:		Line 21:
	* Optimizations (assembly/intrinsics)		* Optimizations (assembly/intrinsics)
	* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions		* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions
	* Mapping to new containers		* Mapping to new containers - see '''[[MatroskaOpus]]''', '''[[Mp4Opus]]''' and '''[[OggOpus]]''' (on Standards Track as '''[https://tools.ietf.org/html/rfc7845 RFC 7845]''')

	It is generally advisable to contact the developers on the mailing list or the IRC channel before taking on new work on Opus,		It is generally advisable to contact the developers on the mailing list or the IRC channel before taking on new work on Opus,

MrZeus: /* How To Contribute */ add link to Opus tuning page

2016-11-14T16:44:40Z

How To Contribute: add link to Opus tuning page

← Older revision		Revision as of 16:44, 14 November 2016
Line 15:		Line 15:

	There are many ways to contribute to Opus development:		There are many ways to contribute to Opus development:

	* Reporting and fixing bugs		* Reporting and fixing bugs
	* Improving tools		* Improving tools
	* Improving testing framework		* Improving testing framework
	* Optimizations (assembly/intrinsics)		* Optimizations (assembly/intrinsics)
	* Encoding quality improvements ~~(listening/~~tuning)		* Encoding quality improvements - see the '''[[Opus tuning]]''' page for suggestions
	* Mapping to new containers		* Mapping to new containers

	It is generally advisable to contact the developers on the mailing list or the IRC channel		It is generally advisable to contact the developers on the mailing list or the IRC channel before taking on new work on Opus,
	before taking on new work on Opus, to avoid duplicating work and to		to avoid duplicating work and to make sure you're doing things the right way from the start.
	make sure you're doing things the right way from the start.

	== How to report bugs ==		== How to report bugs ==

Jmspeex at 20:51, 1 November 2016

2016-11-01T20:51:53Z

← Older revision		Revision as of 20:51, 1 November 2016
Line 48:		Line 48:
	* '''Do not''' reformat the code in your "functional change" patches, as it mostly makes it harder to review changes.		* '''Do not''' reformat the code in your "functional change" patches, as it mostly makes it harder to review changes.
	* '''Do''' send separate "format-fixing" patches, making sure they don't change Opus' functionality at all.		* '''Do''' send separate "format-fixing" patches, making sure they don't change Opus' functionality at all.

			== Testing ==

			For any new feature, it is strongly suggested to also include tests for the new code to make sure it works and keeps working in the future.

	== Language ==		== Language ==

MrZeus: mini tidy-up

2016-07-08T11:02:30Z

mini tidy-up

← Older revision		Revision as of 11:02, 8 July 2016
Line 1:		Line 1:
	== Community ==		== Community ==

	Development discussions and questions take place on the Xiph.Org Opus mailing list (opus@xiph.org). ~~Discussion~~ related to the IETF process happen on the IETF codec working group mailing list (codec@ietf.org).		Development discussions and questions take place on the Xiph.Org Opus mailing list ([mailto:opus@xiph.org opus@xiph.org]).

			Discussions related to the IETF process happen on the IETF codec working group mailing list ([mailto:codec@ietf.org codec@ietf.org]).

	For archives of recent discussions, try:		For archives of recent discussions, try:
Line 8:		Line 10:
	* IETF [https://www.ietf.org/mail-archive/web/codec/current/maillist.html codec mailing list archives]		* IETF [https://www.ietf.org/mail-archive/web/codec/current/maillist.html codec mailing list archives]

	Informal development chat and support happens in #opus on irc.freenode.net. You can join the chat room through a web interface if you don't have an IRC client.		Informal development chat and support happens in #opus on irc.freenode.net. You can join the chat room through a '''[https://webchat.freenode.net/ web interface]''' if you don't have an IRC client.

	== How ~~to contribute~~ ==		== How To Contribute ==

	There are many ways to contribute to Opus development:		There are many ways to contribute to Opus development:
Line 20:		Line 22:
	* Mapping to new containers		* Mapping to new containers

	It is generally advisable to contact the developers on the mailing list or		It is generally advisable to contact the developers on the mailing list or the IRC channel
	~~on IRC~~ before taking on new work on Opus to avoid duplicating work and to		before taking on new work on Opus, to avoid duplicating work and to
	make sure you're doing things the right way from the start.		make sure you're doing things the right way from the start.

	== How to report bugs ==		== How to report bugs ==

	You can report bugs in [https://trac.xiph.org/report/25 trac]. Please also notify developers on the mailing list.		You can report bugs in '''[https://trac.xiph.org/report/25 trac]'''. Please also notify developers on the [mailto:opus@xiph.org mailing list].

	For sensitive (security-related) bugs, please [https://www.opus-codec.org/contact/ contact] the developers		For sensitive (security-related) bugs, please '''[https://www.opus-codec.org/contact/ contact the developers]''' directly.
	directly.

	== How to submit a patch ==		== How to submit a patch ==

	If you have a patch you would like to contribute, just send it to the mailing		If you have a patch you would like to contribute, just send it to the mailing list.
	list. We can also take [https://github.com/xiph/opus/ Github] pull requests, but please send a note to the mailing		We can also take [https://github.com/xiph/opus/ Github] pull requests,
	list since the ~~Github~~ Opus repository is only a mirror.		but please send a note to the mailing list since the GitHub Opus repository is only a mirror.

	== Coding style ==		== Coding style ==
Line 42:		Line 43:
	have a consistent coding style. For example, the SILK code uses 4-space		have a consistent coding style. For example, the SILK code uses 4-space
	indentation, while the rest of the code is mostly 3-space, except the entropy		indentation, while the rest of the code is mostly 3-space, except the entropy
	coder, which is 2-space. The general rule is that you should follow the		coder, which is 2-space.
	style of the code you're modifying. Do '''not''' reformat the code in your
	patches, as it mostly makes it harder to review changes.		The general rule is that you should follow the style of the code you're modifying.
			* '''Do not''' reformat the code in your "functional change" patches, as it mostly makes it harder to review changes.
			* '''Do''' send separate "format-fixing" patches, making sure they don't change Opus' functionality at all.

	== Language ==		== Language ==

Jmspeex at 20:42, 5 July 2016

2016-07-05T20:42:15Z

← Older revision		Revision as of 20:42, 5 July 2016
Line 12:		Line 12:
	== How to contribute ==		== How to contribute ==

			There are many ways to contribute to Opus development:
	* Reporting and fixing bugs		* Reporting and fixing bugs
	* Improving tools		* Improving tools
Line 20:		Line 21:

	It is generally advisable to contact the developers on the mailing list or		It is generally advisable to contact the developers on the mailing list or
	IRC before taking on new work on Opus to avoid duplicating work and to		on IRC before taking on new work on Opus to avoid duplicating work and to
	make sure you're doing things the right way from the start.		make sure you're doing things the right way from the start.

Line 33:		Line 34:

	If you have a patch you would like to contribute, just send it to the mailing		If you have a patch you would like to contribute, just send it to the mailing
	list. We can also take pull requests, but please send a note to the mailing		list. We can also take [https://github.com/xiph/opus/ Github] pull requests, but please send a note to the mailing
	list since the ~~github~~ repository is only a mirror.		list since the Github Opus repository is only a mirror.

	== Coding style ==		== Coding style ==
Line 42:		Line 43:
	indentation, while the rest of the code is mostly 3-space, except the entropy		indentation, while the rest of the code is mostly 3-space, except the entropy
	coder, which is 2-space. The general rule is that you should follow the		coder, which is 2-space. The general rule is that you should follow the
	style of the code you're modifying. Do not reformat the code in your		style of the code you're modifying. Do '''not''' reformat the code in your
	patches, as it mostly makes it harder to review changes.		patches, as it mostly makes it harder to review changes.

Line 53:		Line 54:
	To reduce the risk of exploitable memory errors, we do not use any function		To reduce the risk of exploitable memory errors, we do not use any function
	pointers in the code unless they are declared as static const. We also		pointers in the code unless they are declared as static const. We also
	have "flat" objects, which can be copied using a "shallow copy".		have "flat" objects, which can be copied using a "shallow copy", so do not add
			pointers to non-static data in the data structures.

Jmspeex at 20:38, 5 July 2016

2016-07-05T20:38:03Z

← Older revision		Revision as of 20:38, 5 July 2016
Line 25:		Line 25:
	== How to report bugs ==		== How to report bugs ==

	You can report bugs in ~~trac at this address~~ https://trac.xiph.org/report/25		You can report bugs in [https://trac.xiph.org/report/25 trac]. Please also notify developers on the mailing list.
	Please also notify developers on the mailing list.

	For sensitive (security-related) bugs, please contact the developers		For sensitive (security-related) bugs, please [https://www.opus-codec.org/contact/ contact] the developers
	directly ~~<link to contacts>~~.		directly.

	== How to submit a patch ==		== How to submit a patch ==

Jmspeex at 20:36, 5 July 2016

2016-07-05T20:36:19Z

← Older revision		Revision as of 20:36, 5 July 2016
Line 6:		Line 6:

	* Xiph.Org [http://lists.xiph.org/pipermail/opus/ Opus mailing list archives]		* Xiph.Org [http://lists.xiph.org/pipermail/opus/ Opus mailing list archives]
	* [https://www.ietf.org/mail-archive/web/codec/current/maillist.html ~~IETF~~ codec mailing list archives]		* IETF [https://www.ietf.org/mail-archive/web/codec/current/maillist.html codec mailing list archives]

	Informal development chat and support happens in #opus on irc.freenode.net. You can join the chat room through a web interface if you don't have an IRC client.		Informal development chat and support happens in #opus on irc.freenode.net. You can join the chat room through a web interface if you don't have an IRC client.