Midi In
|
Ce code est un template permettant de donner des commandes à Godot via MIDI
Ce code lié à godot marche avec absolument tout type de capteur, tant que celui-ci envoie un float ou un integer via midi !!!
Le code est susceptible d'être updaté voici donc le lien vers la repo github
Et voici la documentation offcielle concernant l'utilisation d'input midi dans godot
Egalement, j'ai fait un petit visualiseur de signal midi sur godot.
Ce projet a été fait pour être un moyen très abordable d'intégrer des signaux MIDI dans godot 4.3+ pour celles et ceux qui n'en n'ont pas l'habitude, surtout le MIDI provenant de capteurs.
Le projet est pensé pour être utilisé avec des capteurs envoyant des integers via le signal MIDI.
Ici la documentation officielle concernant l'uilisation d'input MIDI dans l'engine.
Pour faire des outputs MIDI, voir le plugin de NullMembers ci-dessous.
| Code | Explication |
|---|---|
| extends Node2D | Ce code est utilisable avec tout type de noeud !! Pas que le Node2d :D |
| @onready var sprite = $Sprite2D | Ici on garde le sprite posé dans la scène sous forme de variable pour pouvoir ensuite l'utiliser comme exemple |
| var raw_controller_number := 1 | Cette variable est faite pour garder en mémoire les numéros des ports du control change, pour savoir quel capteur est en train d'être utilisé |
| var raw_midi_value := 1.0 | Cette variable est faite pour garder l'integer envoyé par le capteur, sa valeur va de 0 à 127 |
| var pc_midi_value := 0.0 | Cette variable est faite pour garder la valeur raw_midi_value, mais sous une forme plus utilisable dans le reste du code, sous forme d'un float allant de 0 à 1 |
| var pc_controller_number := 1 | Cette variable est optionnelle, et est faite pour les jeux et programmes ayant besoin d'être exportés vers d'autres systèmes, qui n'ont pas forcément la même configuration. Plus sur cette variable à la function _adaptable_controller_number_picker() plus bas. |
| var known_raw_controller_numbers := [] | Cette variable est un array pour garder les valeurs raw_controller_numbers connues et leur assigner une nouvelle valeur, liée à leur indexe. Pour plus d'infos, voir la function _adaptable_controller_number_picker() plus bas. Faites gaffe !! Les valeurs de cette fonction commencent à 0, et non à 1 !! (La première valeur que vous stockerez aura l'indexe "0"). |
| func _ready() -> void: | Cette fonction se lance au début de l'exécution du programme |
| OS.open_midi_inputs() | Choppe l'input MIDI et fait fonctionner le reste du script |
| print(OS.get_connected_midi_inputs()) | Cette ligne print la source du signal MIDI connecté dans la console |
| func _input(input_event): | Cette fonction se lance quand un évènement est activé |
| if input_event is InputEventMIDI: | Ce bout de code se lance quand quelque chose relatif aux capteurs/au signal MIDI se lance. Par exemple, quand un capteur capacitif est touché, le reste du code se lancera. |
| _print_midi_info(input_event) | Cela print beaucoup d'infos sur la source MIDI (instrument, touche, pression). Quand vous n'êtes pas en train de tester si le setup de hardware marche correctement, n'hésitez pas à hashtagger cette fonction pour debloater votre console :D De plus, si comme moi vous utilisez des capteurs, n'hésitez pas à toucher à cette fonction, et à enlever les infos qui ne vous intéressent pas ;D |
| _assign_variables(input_event) | Cette fonction vous permet de changer la valeur des variables évoquées plus haut, et ainsi de stocker les valeurs de l'input MIDI, pour les utiliser plus tard dans le code |
| _do_thingies() | Cette fonction est la partie la plus fun !! En gros c'est juste là qu'on pourra faire s'éxecuter le code en utilisant les valeurs récupérées avant !! :D |
| func _print_midi_info(midi_event): print(midi_event) print("Channel ", midi_event.channel) print("Message ", midi_event.message) print("Pitch ", midi_event.pitch) print("Velocity ", midi_event.velocity) print("Instrument ", midi_event.instrument) print("Pressure ", midi_event.pressure) print("Controller number: ", midi_event.controller_number) print("Controller value: ", midi_event.controller_value) |
Cette function print un maximum d'infos sur la source MIDI. Quand vous n'êtes pas en période de débuggage // de setup intense, je vous conseille de commenter cette fonction, pour debloat votre console :D |
| func _assign_variables(midi_event): | Cette fonction vous permet d'assigner des informations à propos de l'input MIDI pour un usage ultérieur. Ici, concentrons-nous sur le fait de garder en mémoire quel controller/capteur est utilisé, et quel integer il transmet. |
| raw_controller_number = midi_event.controller_number | Cette variable est faite pour garder en mémoire le numéro du port du control change en train d'être utilisé, et ainsi de savoir quel contrôleur est en train d'être utilisé |
| raw_midi_value = midi_event.controller_value | Cette variable est faite pour garder en mémoire l'integer envoyé par le capteur. La valeur de cette variable va de 0 à 127 |
| pc_midi_value = raw_midi_value / 127 | Cette variable est faite pour garder en mémoire la variable midi_raw_value, mais exprimée sous la forme d'un float allant de 0 à 1. Cette valeur permet d'être utilisée plus facilement dans le reste du code :O |
| _adaptable_controller_number_picker() | C'est une fonction optionnelle, qui aide lorsque l'on veut obtenir un programme exportable à un endroit ne possédant pas la même configuration hardware. Plus d'infos juste en dessous, à la fonction elle-même. |
| func _adaptable_controller_number_picker(): | Cette fonction est complètement optionnelle, mais pourrait être très utile pour certain.e.s. Le problème est, simplement, que lorsqu'on exporte un programme faisant usage de capteurs, le numéro des ports du control change peut changer du tout au tout d'une carte à l'autre. Lorsque l'on essaie d'exporter ce projet à des gens n'ayant pas la même config hardware, avoir un code "adaptable" peut être très utile. Cette fonction vous permet d'assigner des variables adaptableset facilement "configurables" d'un point de vue d'utilisateur lambda, et de manier des valeurs "abstraites" dans la fonction _do_thingies() au lieu des vrais ports MIDI. Par exemple, si on a deux capteurs connectés aux ports 48 et 49 du control change, et que quelqu'un essaie d'utiliser votre programme dans un environnement où iel.le.s ont uniquement accès aux ports 50 et 51, vous pouvez utiliser ce code. Lorsque l'on active un capteur, il sera "sauvegardé" dans l'array known_raw_controller_numbers, puis la variable pc_controller_number sera liée à son index dans ledit array. De cette manière, dans la fonction -do-thingies(), on peut juste appeler l'indexe du capteur nécessaire, et l'utilisateur aura la même expérience que vous si iel utilise les capteurs dans le même ordre que vous. Cette addition au code sera peut-être très chiante dans certains projets, c'est pourquoi elle est tout à fait optionnelle. Je suggère vivement ;D d'open sourcer les projets faits avec la technique du "raw_controller_number" (c'est à dire celleux qui n'utiliseront pas cette fonction), car ainsi il sera plus facile aux usager.e.s de se débugger en cas de configuration non conforme, et ainsi de pouvoir malgré tout apprécier votre travail :D. |
| if not raw_controller_number in known_raw_controller_numbers: | Vérifie si le raw_controller utilisé a déjà été enregistré, et réagit si ce n'est pas le cas |
| known_raw_controller_numbers.append(raw_controller_number) | Ajouter la variable raw_controller_number à la fin de l'array |
| print("new controller number stored !", known_raw_controller_numbers.find(raw_controller_number)) print("known controller numbers : ", known_raw_controller_numbers) |
Ici on appelle quelques prints utiles pour débugger // checker si tout se passe comme prévu. Cette ligne print qu'un nouveau raw_controller_number a été enregistré, et print la valeur de la variable pc_controller_number qui lui est reliée. Elles print le contenu de l'array, c'est-à-dire les numéros des capteurs enregistrés. |
| pc_controller_number = known_raw_controller_numbers.find(raw_controller_number) | "Transforme" la variable raw_controller_number en son équivalent pc_controller_number |
| func _do_thingies(): | Cette funcion est un exemple, vous pouvez changer le contenu de cette fonction, changer son nom, ou même utiliser ce code dans la fonction _process(delta) si le coeur vous en dit :D |
| match raw_controller_number: 48: sprite.rotation_degrees = pc_midi_value * 360 49: sprite.scale = Vector2(pc_midi_value, pc_midi_value) |
Exemple d'un bout de code utilisant la méthode "raw" |
| match pc_controller_number: 0: sprite.rotation_degrees = pc_midi_value * 360 1: sprite.scale = Vector2(pc_midi_value, pc_midi_value) |
Exemple de ce que l'on eut faire en utilisant la fonction optionnelle "_adaptable_controller_number_picker()". Pour éviter les problèmes, il est recommandé de commenter une des deux options pour qu'elles n'entren pas en conflit. |