Creating a new Zynthian Synth Engine - Revision history

Jofemodo: Jofemodo moved page Zynthian Devel Engine to Creating a new Zynthian Synth Engine

2018-11-29T02:08:05Z

Jofemodo moved page Zynthian Devel Engine to Creating a new Zynthian Synth Engine

Jofemodo: /* How to get the software into Zynthian(-master) */

2018-11-27T14:16:32Z

How to get the software into Zynthian(-master)

Jofemodo: /* How to get the software into Zynthian(-master) */

2018-11-27T14:01:05Z

How to get the software into Zynthian(-master)

Jofemodo: /* How to test */

2018-04-13T12:32:40Z

How to test

Jofemodo: /* How to test */

2018-04-13T12:28:04Z

How to test

Jofemodo: /* How to get the software into Zynthian(-master) */

2018-04-13T12:21:56Z

How to get the software into Zynthian(-master)

Jofemodo: /* Files to touch/create */

2018-02-18T19:59:45Z

Files to touch/create

Jofemodo: /* Files to touch/create */

2018-02-17T02:44:10Z

Files to touch/create

Wirtz: /* Prerequirements */

2018-02-14T10:26:48Z

Prerequirements

Wirtz: /* Prerequirements */

2018-02-14T10:26:32Z

Prerequirements

← Older revision		Revision as of 14:16, 27 November 2018
Line 80:		Line 80:

	If it's your first development for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.		If it's your first development for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.
		+
		+	See also: [[Zynthian_Devel_General\|How to contribute to Zynthian development?]]

← Older revision		Revision as of 14:01, 27 November 2018
Line 79:		Line 79:
	=== How to get the software into Zynthian(-master) ===		=== How to get the software into Zynthian(-master) ===

−	If it's your first ~~developiment~~ for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.	+	If it's your first development for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.

@@ Line 68: / Line 68: @@
   ZYNTHIN_RAISE_EXCEPTIONS=1
 === How to get the software into Zynthian(-master) ===
 If it's your first developiment for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.

@@ Line 55: / Line 55: @@
 === How to test ===
 === How to get the software into Zynthian(-master) ===
 If it's your first developiment for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.

← Older revision		Revision as of 12:21, 13 April 2018
Line 57:		Line 57:

	=== How to get the software into Zynthian(-master) ===		=== How to get the software into Zynthian(-master) ===
		+
		+	If it's your first developiment for zynthian, you should get familiar with git and github. I recommend start "forking" in github the repository you want to work in (zynthian-ui) and creating a "branch" for your development. When you have a stable version of your work, you should make a "pull request" from your forked github repository.

← Older revision	Revision as of 02:08, 29 November 2018
(No difference)

@@ Line 32: / Line 32: @@
 Implementing a new engine is not too difficult, but the details are a little bit tricky. Try studing the ''setBfree'' implementation. Probably it's the most simple. ''ZynAddSubFX'' is quite straightforward too.
-- If you need to start the engine after knowing the MIDI channel, you should implement the add_layer function and "start" the engine there. In that case, don't call the "start" function from the constructor.
+* If you need to start the engine after knowing the MIDI channel, you should implement the add_layer function and "start" the engine there. In that case, don't call the "start" function from the constructor.
-- If you want the layer can be moved to a different channel, you should implement the '''set_midi_chan'''. If your synth engine must be started with a fixed MIDI channel, you should restart the engine in the specified MIDI channel.
+* If you want the layer can be moved to a different channel, you should implement the '''set_midi_chan'''. If your synth engine must be started with a fixed MIDI channel, you should restart the engine in the specified MIDI channel.
-- For getting the presets, implement the '''get_preset_list''' function. It should return a list of "sets". Every preset "set" have this format:
+* For getting the presets, implement the '''get_preset_list''' function. It should return a list of "sets". Every preset "set" have this format:
   (preset_file_path, (bank_msb, bank_lsb, program),  title, extra)
@@ Line 42: / Line 42: @@
 The file path is a string that will be used by set_preset for loading the preset. No need to be a real file path. The second element is a set that can be used by '''set_preset''' for loading the preset using MIDI messages (bank, program). If not used, it should be None. The title is the preset name as shown by the UI. The 4th parameter is optional. Use it for storing whatever you need, related with the preset.
-- If there is no banks, you should return an empty list in the **get_bank_list** function. The UI will ignore the bank screen and go directly to the presets screen.
+* If there is no banks, you should return an empty list in the **get_bank_list** function. The UI will ignore the bank screen and go directly to the presets screen.
 ==== zyngui/zynthian_gui_engine.py ====
@@ Line 48: / Line 48: @@
 For getting the new engine listed in the engine selection screen, you need to add some lines to '''zyngui/zynthian_gui_engine.py'''.
-- Probably you also want (in a first approach) to avoid the possibility of starting more than one Pianoteq layer. For getting this, you would need to tune the '''zyngui/zynthian_gui_engine::fill_list''' function.
+* Probably you also want (in a first approach) to avoid the possibility of starting more than one Pianoteq layer. For getting this, you would need to tune the '''zyngui/zynthian_gui_engine::fill_list''' function.
 ==== zyngui/zynthian_gui_layer.py ====

@@ Line 16: / Line 16: @@
 * Think about that a Raspberry Pi is not a high tuned PC! It's really markable what a Raspberry Pi 3 is able to do with Zynthians engines - but the CPU is limited - so you should try to start your software without Zynthian for a first try. Check if you get audio-drops or not. Perhaps some tweaking of the compiler options can help - but this is not the topic of this article.
-Ok, if you have read until this line and you are not already shocked from the prerequirements, it's time to share your idea with the [https://discourse.zynthian.org/ Zynthian-Forum]. You are not alone - and don't forget: [ https://en.wikipedia.org/wiki/Don%27t_Panic_(The_Hitchhiker%27s_Guide_to_the_Galaxy) Don't panic!]. Perhaps some more hints and spoilers from others can help for your project.
+Ok, if you have read until this line and you are not already shocked from the prerequirements, it's time to share your idea with the [https://discourse.zynthian.org/ Zynthian-Forum]. You are not alone - and don't forget: [https://en.wikipedia.org/wiki/Don%27t_Panic_(The_Hitchhiker%27s_Guide_to_the_Galaxy) Don't panic!]. Perhaps some more hints and spoilers from others can help for your project.
 === LV2 plugins ===