documentation_fr.md

   1 [TOC]
   2
   3 # Music Sampler
   4
   5 ## Description
   6
   7 Music Sampler est un lecteur de musique qui permet de pré-programmer des transitions musicales, qui peuvent ensuite être lancées à l'aide d'un simple appui sur une touche.
   8
   9 ## Pré-requis et installation
  10
  11 Il faut avoir ffmpeg d'installé. Pour cela, il faut installer le paquet `libav-tools` :
  12
  13     :::bash
  14     sudo apt-get install libav-tools
  15
  16 Si vous utilisez la version compilée de Music Sampler, il n'y a pas d'installation nécessaire.
  17
  18 ## Utilisation
  19
  20 Tout le travail consiste à préparer les transitions dans le fichier de configuration config.yml.
  21
  22 Lancer ensuite le programme dans le dossier où se situe le fichier de configuration (voir plus bas pour une utilisation avancée). 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é, ou rouge en cas de problème.
  23
  24 Appuyer 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.
  25
  26 Un exemple de fichier de configuration est fourni, avec un certain nombre de touches et de transitions programmées (pour les trois musiques fournies), la syntaxe du fichier (expliquée plus bas) se comprend aisément en le regardant. De plus, certaines touches (par exemple 'ÉCHAP' pour tout arrêter) peuvent être gardées d'une fois sur l'autre.
  27
  28 En cas d'appui répété sur une touche, music_sampler ne relance pas les actions associées à cette touche si ces actions ne sont pas terminées ; cela pour éviter les "accidents".
  29
  30 ### Options disponibles au lancement
  31
  32 Toutes les options au lancement sont facultatives ; la plupart du temps lancer le programme dans le bon dossier suffit.
  33
  34   * `-h, --help` : affiche une liste des options disponibles.
  35   * `-c CONFIG, --config CONFIG` : précise le fichier de configuration à charger (par défaut, config.yml qui se trouve dans le dossier où est lancé music_sampler).
  36   * `-d, --debug` : Affiche les informations de déboggage (désactivé par défaut)
  37   * `-V, --version` : affiche la version courante et quitte (utilisable uniquement pour la version compilée).
  38
  39 Les options suivantes sont plutôt réservées à un usage avancé de music_sampler, ou en cas de problème avec la configuration standard :
  40
  41   * `-m, --builtin-mixing` Effectue en interne le mixage des sons. Par défaut, music_sampler confie le mixage au système : n'activer cette option que si le système n'y parvient pas.
  42   * `-l LATENCY, --latency LATENCY` : latence. Préciser "low", "high" ou un nombre de secondes (par défaut, "high")
  43   * `-b BLOCKSIZE, --blocksize BLOCKSIZE` : taille des blocs. Nombre de frames pour chaque étape du mixeur. 0 (par défaut) signifie que le programme choisit lui-même le nombre qui lui convient.
  44   * `-f FRAME_RATE, --frame-rate FRAME_RATE` : fréquence d'échantillonnage pour jouer les musiques. Par défaut : 44100
  45   * `-x CHANNELS, --channels CHANNELS` : nombre de canaux par musique (2 par défaut, pour une écoute stéréo)
  46   * `-s SAMPLE_WIDTH, --sample-width SAMPLE_WIDTH` : largeur d'échantillonnage (nombre d'octets pour chaque frame). Par défaut : 2.
  47   * `--device DEVICE` : sélectionne le périphérique de son.
  48   * `--list-devices` : Affiche la liste des périphériques de son disponibles.
  49   * `-- ARGS` : Arguments à passer à la librairie Kivy.
  50
  51 ## Configurer les touches
  52
  53 Le 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 !).
  54 le `#` est un symbole de commentaire : tout ce qui suit ce symbole sur une ligne est ignoré.
  55
  56 En cas d'erreur dans le fichier de configuration, un message d'erreur s'affiche dans le terminal. Selon la "gravité" de l'erreur, music_sampler se lance en ignorant les actions erronées (en colorant éventuellement la touche en noir), ou ne se lance pas du tout.
  57
  58 Le fichier contient plusieurs sections :
  59
  60     :::yaml
  61     aliases:
  62       ...
  63
  64     music_properties:
  65       ...
  66
  67     key_properties:
  68       ...
  69
  70     keys:
  71       ...
  72
  73
  74 ### `music_properties` : propriétés des musiques
  75
  76 Cette section sert à définir des propriétés globales des musiques.
  77
  78 #### Exemples
  79
  80     :::yaml
  81       "music1.mp3":
  82         name: My favorite music
  83         gain: 1.4
  84 La musique "music1.mp3" est désignée par le nom "My favorite music". Elle est chargée à 140% de son volume normal.
  85
  86     :::yaml
  87       "music2.mp3":
  88         gain: 0.7
  89
  90 La musique "music2.mp3" est chargée à 70% de son volume normal.
  91
  92 #### Liste des options possibles
  93 - `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*).
  94 - `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.
  95
  96 ### `key_properties` : affichage des touches
  97
  98 Cette 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.
  99
 100 #### Exemples
 101
 102     :::yaml
 103       'ESC':
 104         description:
 105           -
 106           - STOP !
 107         color: [255, 0, 0]
 108
 109 La touche échap est de couleur rouge, et le texte "STOP !" est affiché sur la deuxième ligne.
 110
 111 #### Liste des options possibles
 112 - `description` : le texte qui s'affiche, à côté du "nom" de la touche. Il faut mettre un tiret 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 vaut mieux souvent la laisser vide, ou ne mettre que très peu de texte (voir l'exemple ci-dessus). Sur un écran de taille raisonnable, on peut compter 3 lignes (incluant la première) pour une touche "standard".
 113 - `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.
 114
 115
 116 ### `keys` : actions sur les touches
 117
 118 Cette section sert à décrire, pour chaque touche, la liste des actions successives. Notez que la plupart des actions (hors `wait` et quelques cas particuliers, voir plus bas) sont quasi-instantannées.
 119
 120
 121 #### Exemples
 122
 123     :::yaml
 124     'a':
 125       - play:
 126           file: "music1.mp3"
 127           volume: 70
 128           start_at: 10
 129       - wait:
 130           duration: 5
 131       - stop:
 132           file: "music1.mp3"
 133           fade_out: 2
 134
 135 Lance la musique "music1.mp3" à 70% de son volume max, à 10 secondes du début, puis au bout de 5 secondes coupe la musique avec un fondu de 2 secondes.
 136
 137     :::yaml
 138     'b':
 139       - stop:
 140           file: "music1.mp3"
 141           fade_out: 5
 142           wait: false
 143       - play:
 144           file: "music2.mp3"
 145           fade_in: 5
 146
 147 Effectue un fondu enchaîné de 5 secondes entre "music1.mp3" et "music2.mp3"
 148
 149     :::yaml
 150     'c':
 151       - stop:
 152           file: "music1.mp3"
 153           fade_out: 5
 154           wait: true
 155       - wait:
 156           duration: 2
 157       - play:
 158           file: "music2.mp3"
 159       - seek:
 160           file: "music2.mp3"
 161           delta: false
 162           value: 60
 163 Coupe la musique "music1.mp3" avec un fondu de 5 secondes, attend la fin du fondu, puis attend encore deux secondes et lance la musique "music2.mp3", au temps d'une minute.
 164
 165     :::yaml
 166     'd':
 167       - volume:
 168           file: "music1.mp3"
 169           value: 50
 170       - play:
 171           file: "noise.mp3"
 172           loop: 1
 173       - wait:
 174           file: "noise.mp3"
 175       - volume:
 176           file: "music1.mp3"
 177           value: 100
 178
 179 Baisse le volume de "music1.mp3" pendant que le son "noise.mp3" est joué par dessus (deux fois). Le volume revient à la normale une fois que les deux écoutes du son "noise" sont terminées.
 180
 181     :::yaml
 182     'e':
 183       - pause:
 184           file: "music1.mp3"
 185       - wait:
 186           duration: 10
 187       - unpause:
 188           file: "music1.mp3"
 189       - seek:
 190           file: "music1.mp3"
 191           delta: true
 192           value: 5
 193
 194 Met en pause la musique "music1.mp3" pour 10 secondes et la relance après, en avançant de 5 secondes dans la musique.
 195
 196 #### Liste des actions possibles:
 197 - `play` : joue une musique. music_sampler ne joue qu'une musique à la fois : si la musique demandée est déjà en train d'être jouée, elle n'est pas relancée ou jouée "par dessus". Paramètres :
 198     * `file: "music.mp3"` précise la musique jouée (chemin relatif).
 199     * `fade_in: x` (facultatif) lance la musique avec un fondu au départ de x secondes.
 200     * `volume: x` (facultatif, défaut : 100) la musique doit être jouée à x% de son volume max.
 201     * `loop: x` (facultatif, défaut : 0) 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`.
 202     * `start_at: x` (facultatif, défaut : 0) la musique démarre à x secondes du début.
 203     * `restart_if_running: true/false` (facultatif, défaut : false) la musique est éventuellement stoppée et redémarrée si nécessaire
 204 - `stop` : arrête une musique donnée. Paramètres :
 205     * `file: "music.mp3"` (facultatif) précise la musique à stopper. Si aucune musique n'est précisée, le `stop` s'applique à toutes les musiques.
 206     * `fade_out: x` (facultatif) stoppe la musique avec un fondu de x secondes.
 207     * `wait: true/false` (facultatif, 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. Lorsque plusieurs musiques sont stoppées en fondu, le `wait` n'attend que la dernière musique de la playlist (qui peut se terminer naturellement avant les autres).
 208     * `set_wait_id: name` (facultatif, inutile lorsque `wait` est à false) donne l'identifiant `name` à l'attente de fin du fondu (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne de caractère.
 209 - `volume` : change le volume d'une musique donnée. Paramètres :
 210     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, la modification s'applique au volume global.
 211     * `delta: true/false` (facultatif, par défaut : false) le volume doit il être précisé en absolu (false), ou en relatif (true), voir plus bas.
 212     * `value: x` Si delta est à false, met le volume à x% du volume max (x doit être entre 0 et 100).
 213 Ce 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.
 214 Si delta est à true, applique un modificateur de x% au volume (x doit être un entier signé).
 215 Notez qu'une action "+10%" relative ne correspond pas à un pourcentage du volume actuel, mais du volume "de référence" 100%. Ainsi, effectuer +10% et -10% en relatif revient bien à 100%.
 216     * `fade: x` (facultatif) le changement de volume est appliqué en fondu sur x secondes. Il n'y a pas d'attente de la fin du fondu pour lancer les actions suivantes : au besoin, rajouter un `wait` à la main.
 217 - `pause` : met en pause une musique. Paramètres :
 218     * `file: "music.mp3"` (facultatif) précise la musique à mettre en pause. Si non précisé, s'applique à toutes les musiques.
 219 - `unpause` : relance une musique mise en pause (là où elle en était). Paramètres :
 220     * `file: "music.mp3"` (facultatif) précise la musique à relancer. Si non précisé, s'applique à toutes les musiques.
 221 - `wait` : attend un temps donné. Paramètres :
 222     * `file: "music.mp3"` (facultatif) attend la fin de la musique "music.mp3"
 223     * `duration: x` (facultatif) attend x secondes. Si `file` et `duration` sont précisés, l'attente dure jusqu'à la fin de la musique PUIS la durée donnée par `duration`.
 224     * `set_wait_id: name` (facultatif) donne l'identifiant `name` à l'attente (voir `interrupt_wait`). L'identifiant peut être n'importe quelle chaîne de caractère.
 225 Notez une fois encore que `wait` est quasiment la seule action qui attend d'avoir terminé pour lancer la commande suivante, toutes les autres sont lancées successivement mais sans attendre (donc presque simultanément) : ne pas hésiter à rajouter des commandes d'attente partout où c'est nécessaire.
 226 - `seek` : permet d'aller à un endroit précis dans une musique. Paramètres :
 227     * `file: "music.mp3"` (facultatif) précise la musique. Si aucune musique n'est précisée, l'action s'applique à toutes les musiques.
 228     * `delta: true/false` (facultatif, défaut : false) Si delta est true, le temps est relatif. Si delta est false, le temps est absolu, voir plus bas.
 229     * `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 à partir du début. Si la musique est en train de faire un fondu (au départ, ou changement de volume), le fondu se "termine automatiquement" : et la musique est immédiatement au volume final voulu. Si la musique est en train de se terminer en fondu, le "seek" est ignoré (un fondu de fin considère la musique comme déjà terminée). En cas de `loop`, si le déplacement est relatif la musique peut éventuellement passer à la répétition suivante / précédente; sinon, le déplacement se fait dans la répétition courante.
 230 - `stop_all_actions:` Interrompt toutes les actions en cours et à faire. Notez qu'une musique lancée (y compris avec une option `loop`) est considérée comme une action "déjà terminée", et ne sera donc pas interrompue (utiliser `stop` sans arguments pour stopper toutes les musiques en écoute). La commande interrompt également les options à faire de cette même touche, il est donc inutile de programmer des actions à la suite de celle-ci.
 231 - `interrupt_wait`: Interrompt l'attente (de `wait` ou fin d'un fondu avec attente) et passe directement à l'action suivante. Paramètre :
 232     * `wait_id: name` : précise l'identifiant du `wait` à stopper (défini par `set_wait_id`, voir les actions `wait` et `stop`). Pour interrompre plusieurs `wait` d'un seul coup, il faut mettre plusieurs `interrupt_wait`.
 233
 234 ### `aliases` : définir des alias
 235
 236 Il est possible de définir des alias pour les différents paramètres. Ces alias sont internes au fichier de configuration ; pour afficher un "joli" nom d'une musique, voir plutôt "music_properties".
 237
 238 La syntaxe est la suivante:
 239
 240     :::yaml
 241     aliases:
 242       alias1:
 243         param: value
 244       alias2:
 245         param1: value1
 246         param2: value2
 247
 248 On utilise ensuite, dans le fichier de configuration, `include: alias1` ou `include: [alias1, alias2]` à la place de `param: value`. Dans le cas de plusieurs aliases inclus contenant des éléments identiques, seul le dernier est pris en compte. Dans tous les cas, les alias ne sont *pas* prioritaires par rapport aux éventuels paramètres définis là où ils sont inclus. Voir les exemples ci-dessous.
 249
 250 #### Exemples
 251
 252     :::yaml
 253     aliases:
 254       music1:
 255         file: "path/to/my/favourite/music.mp3"
 256
 257     keys:
 258       'a':
 259         play:
 260           include: music1
 261
 262 `music1` est désormais un alias pour `"path/to/my/favourite/music.mp3"`. À chaque fois qu'on veut écrire `file: "path/to/my/favourite/music.mp3"`, on peut écrire à la place `include: music1`. Attention, dans la section "music_properties", les alias ne fonctionnent pas, et il faut écrire le nom du fichier complet.
 263
 264     :::yaml
 265     aliases:
 266       blue:
 267         color: [0, 0, 255]
 268
 269     keys_properties:
 270       'a':
 271         description:
 272           -
 273           - blue key
 274         include: blue
 275
 276 `blue` est un alias pour la couleur `[0, 0, 255]`. À chaque fois qu'on veut écrire `color: [0, 0, 255]`, on peut écrire `include: blue` à la place.
 277
 278     :::yaml
 279     aliases:
 280       long_time:
 281         duration: 42
 282
 283     keys:
 284       'b':
 285         wait:
 286           include: long_time
 287         play:
 288           file: "music1.mp3"
 289
 290 `long_time` est un alias pour la durée 42 secondes. Au lieu d'écrire `duration: 42`, on peut écrire `include: long_time`.
 291
 292 ## Problèmes possibles
 293
 294 Sont listés ci-dessous une liste de problèmes rencontrés, avec des solutions proposées. Si vous en découvrez d'autre, contactez l'auteur pour les ajouter à la liste.
 295
 296  * Le programme se lance et s'arrête tout de suite.
 297
 298 Il s'agit généralement d'une erreur de syntaxe dans le fichier de config. Dans ce cas, le terminal doit afficher quelques détails sur l'erreur en question (au moins la ligne correspondante).
 299
 300  * La musique "grésille" affreusement.
 301
 302 Il peut s'agir d'un problème de latence (avec certains ordinateurs un peu lents). Essayez de changer la latence (par exemple, 0.1 seconde)
 303
 304   * Impossible de jouer plus d'une musique à la fois.
 305
 306 Le système n'arrive pas à mixer les musiques par lui-même. Vous pouvez essayer de regarder la liste des périphériques de son (`--list-devices`) puis en sélectionner un autre si disponible. Vous pouvez aussi essayer le mixeur intégré à music_sampler, mais les résultats ne sont pas toujours très fluides (ne pas hésiter à jouer avec les paramètres avancés comme latency et blocksize).
 307
 308 ## Divers
 309
 310 Les extraits de musiques proposés en exemples proviennent de [Jamendo](https://jamendo.com). Les musiques (complètes) sont disponibles en libre téléchargement pour un usage non commercial :
 311
 312 [Short Blues](https://www.jamendo.com/track/340173/short-blues)
 313
 314 [To the Fantasy war](https://www.jamendo.com/track/778560/to-the-fantasy-war)
 315
 316 Le bruit de crocodile provient de [Universal-Soundbank](http://www.universal-soundbank.com/).
 317
 318 Cet outil a été développé à l'origine pour faciliter la gestion du son pour les spectacles de la compagnie circassienne [Les pieds jaloux](http://piedsjaloux.fr/). N'ayant pas d'ingénieur son, les artistes eux-mêmes peuvent alors gérer leur musique lorsqu'ils ne sont pas sur scène : d'où la nécessité de préparer les transitions à l'avance et, au moment de la représentation, de réduire l'interaction avec la machine au minimum (une touche).