aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDenise sur Lya <sekhmet@lya>2016-06-27 12:52:11 +0200
committerIsmaël Bouya <ismael.bouya@normalesup.org>2016-07-21 14:51:09 +0200
commitd0d235e5312997a1b7ad1fccc6f24026b68fb642 (patch)
tree3d7568684b5e56720517892635f0cdafda75873a
parenta8340c5d43bcfc3d78c2e00ab26c0596d7ffe85e (diff)
downloadMusicSampler-d0d235e5312997a1b7ad1fccc6f24026b68fb642.tar.gz
MusicSampler-d0d235e5312997a1b7ad1fccc6f24026b68fb642.tar.zst
MusicSampler-d0d235e5312997a1b7ad1fccc6f24026b68fb642.zip
Documentation file
-rw-r--r--documentation_fr.md207
1 files changed, 207 insertions, 0 deletions
diff --git a/documentation_fr.md b/documentation_fr.md
new file mode 100644
index 0000000..83b50c6
--- /dev/null
+++ b/documentation_fr.md
@@ -0,0 +1,207 @@
1# Music Sampler
2
3
4## Description
5
6Music Sampler permet de pré-programmer des transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple appui sur une touche.
7
8
9## Pré-requis et installation
10
11Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
12
13```
14sudo apt-get install libav-tools
15```
16
17Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installation nécessaire.
18
19## Utilisation
20
21Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml
22
23Lancer ensuite le programme dans le dossier où se situe le fichier. Une fenêtre représentant un clavier apparaît. Les touches programmées apparaissent d'abord légèrement grisées, lorsque les musiques associées sont en cours de chargement, ou pas encore chargées. Le rond orange dans le coin du clavier devient vert lorsque tout est chargé.
24
25Appuyer sur une touche déclenche les actions associées à cette touche (affichées dans le cadre en bas à gauche). Cliquer sur la touche affiche les actions associées à la touche mais ne les déclenche pas. Les deux autres cadres montrent respectivement un historique des touches appuyées et la liste des musiques en train d'être jouées.
26
27## Configurer les touches
28
29Le fichier config.yml utilise la syntaxe yaml. Les catégories et sous-catégories sont gérées par l'indentation par des espaces (mais PAS par des tabulations !).
30le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré.
31
32Le fichier contient plusieurs sections :
33```
34aliases:
35...
36
37music_properties:
38...
39
40
41key_properties:
42...
43
44
45keys:
46...
47```
48
49
50### `music_properties` : propriétés des musiques
51
52Cette section sert à définir des propriétés globales des musiques.
53
54#### Exemples
55
56```
57 "music1.mp3":
58 name: My favorite music
59 gain: 1.4
60```
61La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal.
62
63```
64 "music2.mp3":
65 gain: 0.7
66```
67La musique "music2.mp3" est chargée à 70% de son volume normal.
68
69#### Liste des options possibles
70- `name: My music` La musique sera désignée (dans les actions, dans le terminal) comme "My music" au lieu du chemin du fichier. Par exemple le cadre des actions affichera "starting « My music » at volume 100%". Attention, cela ne fait pas office d'alias dans le fichier de configuration (voir la section *aliases*).
71- `gain: x` Charge la musique avec un gain de x (multiplicatif). Utiliser la commande "volume" pour changer ponctuellement le volume (0 à 100%) au cours de l'écoute.
72
73### `key_properties` : affichage des touches
74
75Cette section sert à décrire l'affichage à l'écran des touches : couleur et texte. Par défaut, une touche "attribuée" à une ou plusieurs actions s'affiche en vert.
76
77#### Exemples
78
79```
80 'ESC':
81 description:
82 -
83 - STOP !
84 color: [255, 0, 0]
85```
86La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne
87
88#### Liste des options possibles
89- `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tirer pour une ligne de texte (pas de retour à la ligne automatique). La première ligne correspond à celle de la lettre associée à la touche, aussi il n'est pas absurde de la laisser vide (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
90- `color: [r,g,b]` : la couleur de la touche. r, g et b sont les proportions de rouge, vert et bleu, et doivent être des entiers entre 0 et 255.
91
92
93### `keys` : actions sur les touches
94
95Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez qu'à l'exception de `wait` (voir plus bas), les actions sont exécutées les unes à la suite des autres, sans attendre que la précédente soit terminée.
96
97
98#### Exemples
99
100```
101'a':
102 - play:
103 file: "music1.mp3"
104 volume: 70
105 - wait:
106 duration: 5
107 - stop:
108 file: "music1.mp3"
109 fade_out 2
110```
111Lance la musique "music1.mp3" à 70% de son volume max, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
112
113```
114'b':
115 - stop:
116 file "music1.mp3"
117 fade_out 5
118 wait: false
119 - play:
120 file "music2.mp3"
121 fade_in 5
122```
123Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
124
125```
126'c':
127 - stop:
128 file "music1.mp3"
129 fade_out 5
130 wait: true
131 - wait:
132 duration: 2
133 - play:
134 file "music2.mp3"
135 - seek:
136 file "music2.mp3"
137 delta: false
138 value: 60
139```
140Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend deux secondes et lance la musique "music2.mp3", au temps d'une minute.
141
142```
143'd':
144 - volume:
145 file "music1.mp3"
146 value: 50
147 - play:
148 file "noise.mp3"
149 loop: 1
150 - wait:
151 duration 2
152 - volume:
153 file "music1.mp3"
154 value: 100
155```
156Baisse temporairement (pour 2 secondes) le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (joué deux fois).
157
158```
159'e':
160 - pause:
161 file: "music1.mp3"
162 - wait:
163 duration: 10
164 - unpause:
165 file: "music1.mp3"
166 - seek:
167 file: "music1.mp3"
168 delta: true
169 value: 5
170```
171Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique.
172
173#### Liste des actions possibles:
174- `play` : joue une musique. Paramètres :
175 * `file: "music.mp3"` précise la musique jouée (chemin relatif).
176 * `fade_in x` (facultatif) lance la musique avec un fade in de x secondes.
177 * `volume x` (facultatif) la musique doit être jouée à x% de son volume max (x doit être entre 0 et 100, 100 par défaut)
178 * `loop: x` (facultatif) la musique doit être répétée x fois. Indiquer -1 pour la répéter indéfiniment. Attention, x est le nombre de répétitions, donc pour lire trois fois la musique, mettre `loop: 2`
179- `stop` : arrête une musique donnée. Paramètres :
180 * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
181 * `fade_out x` (facultatif) stoppe la musique avec un fondu de x secondes.
182 * `wait: true/false` (par défaut : false) dans le cas d'un fondu, attendre la durée du fondu pour faire les actions suivantes. Si la musique s'arrêtait naturellement avant la fin du fondu, l'attente se termine lorsque la musique se termine naturellement. FIXME
183- `volume` : change le volume d'une musique donnée. Paramètres :
184 * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
185 * `delta: true/false` le volume doit il être précisé en absolu (false, option par défaut), ou en relatif (true), voir plus bas.
186 * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100).
187Ce facteur est appliqué à la musique déjà chargée en mémoire (voir section "propriétés"), donc le 100% fait référence au volume de chargement.
188Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé).
189- `pause` : met en pause une musique. Paramètres :
190 * `file: "music.mp3"` précise la musique à mettre en pause.
191- `unpause` : relance une musique mise en pause (là où elle en était). Paramètres :
192 * `file: "music.mp3"` précise la musique à relancer.
193- `wait` : attend un temps donné. Paramètres :
194 * `duration: x` attend x secondes
195Notez une fois enore que `wait` est la seule action qui attend d'avoir terminé pour lancer la commane suivante, toutes les autres sont lancées successivement mais sans attendre (donc quasiment simultanément).
196- `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
197 * `file: "music.mp3"` précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
198 * `delta: true/false` Si delta est true, le temps est relatif. Si delta est false (par défaut ?), le temps est absolu, voir plus bas.
199 * `value: x` Si delta est true, alors fait avancer de x secondes dans la musique (reculer si x est négatif). Si delta est false, alors la lecture se place à x secondes du début. Si la musique est en train de faire un fondu au départ, le fondu est oublié et la musique est jouée au volume normal. Si la musique est en train de se terminer en fondu, le "seek" est ignoré.
200
201### `aliases` : définir des alias
202
203Il est possible de définir des alias pour les différents objets du fichier yml.
204
205#### Exemples
206
207``