Cscore
Précédent | Partie III. Référence | Suivant

## Cscore

Cscore est une API (interface de programmation d'application) pour générer et manipuler des fichiers de partition numérique. Elle fait partie de l'API plus grande de Csound et elle comprend un certain nombre de fonctions appelables depuis un programme écrit par l'utilisateur en langage C. Cscore peut étre invoquée comme un préprocesseur de partition autonome ou comme élément d'une exécution de Csound en incluant l'option -C dans ses arguments :

`cscore` [`fichier_partition_entree`] [`> fichier_partition_sortie`]

(où cscore est le nom du programme que vous avez écrit), ou

`csound` [-C] [`autresoptions`] [`nomorch`] [`nompartition`]

Les fonctions de l'API disponibles augmentent la bibliothèque de fonctions du langage C ; elles peuvent lire des fichiers de partition numérique standard ou pré-triée, modifier et étendre les données de différentes manières, et ensuite les rendre disponibles pour une exécution par un orchestre de Csound.

Le programme écrit par l'utilisateur dans le langage C est compilé et lié à la bibliothèque de Csound (ou au programme de ligne de commande csound) par l'utilisateur. Il n'est pas indispensable de bien connaître le langage C pour écrire ce programme, car les appels de fonction ont une syntaxe simple, et sont suffisamment puissants pour faire la plus grande partie du travail compliqué. C pourra apporter plus de puissance par la suite selon les besoins.

Les sections suivantes expliquent toutes les étapes de l'utilisation de Cscore :

- Evènements, Listes et Opérations - Explique la syntaxe des fonctions de Cscore et les structures de données.
- Ecrire un Programme de Contrôle Cscore - Montre par l'exemple comment écrire votre propre programme de contrôle.
- Compiler un Programme Cscore - Décrit les étapes de la compilation et de l'édition des liens avec la bibliothèque de Csound.
- Exemples Plus Avancés - Traite de questions avancées comme plusieurs partitions en entrée et les détails de l'exécution de Cscore au sein d'une exécution de Csound.

## Evénements, listes et opérations

Un évènement dans Cscore est équivalent à une instruction d'une partition numérique standard ou d'une partition résolue en temps (le format dans lequel Csound écrit une partition triée -- consultez n'importe quel fichier score.srt), et il est stocké en interne en format de temps résolu. Il est important de noter que lorsque Cscore est utilisé en mode autonome, il est incapable de comprendre les « commodités » non numériques que Csound permet dans le format de partition en entrée. C'est pourquoi, les partitions utilisant des fonctionnalités telles que le report (carry), les rampes, les expressions et autres devront être triées au préalable avec l'utilitaire scsort ou bien utilisées avec un exécutable Csound modifié contenant le programme Cscore de l'utilisateur. Les opcodes de partition avec des argument macros (r, m, n, and {}) ne sont pas interprétés.

Les évènements de partition sont lus à partir d'un fichier de partition existant et stockés chacun dans une structure C. Les principaux composants de ces structures sont un opcode et un tableau de valeurs de p-champs. Cscore gère la lecture des évènements et leur mise en mémoire pour vous. Le format de la structure commence comme suit :

    typedef struct {
         CSHDR h;        /* en-tête pour la gestion de l'espace */
         char  *strarg;  /* adresse d'un argument chaîne faculatif */
         char  op;       /* opcode-t, w, f, i, a, s ou e */
         short pcnt;
         MYFLT p2orig;   /* p2, p3 non résolus */
         MYFLT p3orig;
         MYFLT p[1];     /* tableau des p-champs p0, p1, p2 ... */
    } EVENT;

MYFLT est l'un des types C float ou double selon la manière dont votre copie de la bibliothèque de Csound a été compilée. Vous avez juste à déclarer les variables en virgule flottante de votre programme avec le type MYFLT pour être compatible.

Toute fonction de Cscore qui crée, lit ou copie un évènement retournera un pointeur sur la structure dans laquelle les données de l'évènement sont stockées. Ce pointeur d'évènement peut être utilisé pour accéder aux composants de la structure, de la forme e->op ou e->p[n]. Chaque évènement nouvellement stocké provoquera la création d'un nouveau pointeur, et une séquence de nouveaux évènements générera une séquence de pointeurs distincts qu'il faudra stocker. Les groupes de pointeurs d'évènement sont stockés dans une liste d'évènements qui a sa propre structure :

    typedef struct {
         CSHDR  h;
         int nslots;    /* nombre maximal d'évènements dans cette liste */
         int nevents;   /* nombre d'évènements présents */
         EVENT *e[1];   /* tableau de pointeurs d'évènement e0, e1, e2.. */
    } EVLIST;

Toute fonction qui crée ou modifie une liste retournera un pointeur sur la nouvelle liste. Ce pointeur de liste peut être utilisé pour accéder à ses composants pointeurs d'évènement, de la forme a->e[n]. Les pointeurs d'évènement et les pointeurs de liste sont ainsi les outils de base pour manipuler les données d'un fichier de partition. Les pointeurs et les listes de pointeurs peuvent être copiés et réordonnés sans modifier les valeurs des données auxquelles ils font référence. Cela signifie que l'on peut copier et manipuler les notes et les phrases depuis un niveau de contrôle élevé. Alternativement, les données d'un évènement ou d'un groupe d'évènements peuvent être modifiées sans changer les pointeurs d'évènement ou de liste. Les fonctions de l'API Cscore permettent de créer et de manipuler des partitions de cette manière.

Avec Csound 5, les noms de toutes les fonctions de l'API Cscore ont été changés pour être plus explicites. De plus, chaque fonction nécessite maintenant un pointeur sur un objet CSOUND en premier argument. La structure de l'objet CSOUND n'a pas d'importance (en fait il ne peut pas être modifié dans un programme utilisateur). Le moyen d'obtenir ce pointeur sur un objet CSOUND sera montré dans la section suivante. Les fonctions de Cscore et ses structures de données sont déclarées dans le fichier d'en-tête `cscore.h` que vous devez inclure dans le code de votre programme avant leur utilisation.

Les noms des fonctions de Cscore spécifient si elles opèrent sur des évènements ou sur des listes d'évènements. Dans le sommaire suivant des appels de fonction disponibles, on utilise quelques conventions de nommage :

    Le symbole cs est un pointeur vers un objet CSOUND (CSOUND *);
    Les symboles e, f sont des pointeurs sur des évènements (notes);
    Les symboles a, b sont des pointeurs sur des listes (arrays) de tels évènements;
    Le symbole n est un paramètre entier de type int;
    "..." indique un paramètre chaîne (soit une constante soit une variable de type char *);
    Le symbole fp est un pointeur sur un fichier (FILE *) en flot d'entrée de partition;

    syntaxe d'appel                                 description
    ---------------                                 -----------
    /* Fonctions pour travailler avec des évènements */
    e = cscoreCreateEvent(cs, n);                   crée un évènement vide avec n pchamps
    e = cscoreDefineEvent(cs, "...");               définit un évènement par la chaîne de caractères ...
    e = cscoreCopyEvent(cs, f);                     fait une nouvelle copie de l'évènement f
    e = cscoreGetEvent(cs);                         lit l'évènement suivant dans le fichier de partition en entrée
        cscorePutEvent(cs, e);                      écrit l'évènement e dans le fichier de partition en sortie
        cscorePutString(cs, "...");                 écrit l'évènement défini par la chaîne dans la partition
                                                      en sortie

    /* Fonctions pour travailler avec des listes d'évènements */
    a = cscoreListCreate(cs, n);                    crée une liste d'évènements vide avec n emplacements
    a = cscoreListAppendEvent(cs, a, e);            ajoute l'évènement e à la fin de la liste a
    a = cscoreListAppendStringEvent(cs, a, "...");  ajoute l'évènement défini par la chaîne à la liste a
    a = cscoreListCopy(cs, b);                      copie la liste b (mais pas les évènements)
    a = cscoreListCopyEvents(cs, b);                copie les évènements de b, en créant une nouvelle liste
    a = cscoreListGetSection(cs);                   lit tous les évènements de la partition en entrée, jusqu'au
                                                      prochain s ou e
    a = cscoreListGetNext(cs, nbeats);              lit les prochaines nbeats pulsations de la partition en entrée
                                                      (nbeats est un MYFLT)
    a = cscoreListGetUntil(cs, beatno);             lit tous les évènements de la partition en entrée jusqu'à la
                                                      pulsation beatno (MYFLT)
    a = cscoreListSeparateF(cs, b);                 sépare les instructions f de la liste b vers la liste a
    a = cscoreListSeparateTWF(cs, b);               sépare les instructions t,w & f de la liste b vers la liste a
    a = cscoreListAppendList(cs, a, b);             ajoute la liste b à la liste a
    a = cscoreListConcatenate(cs, a, b);            concaténation des listes a et b (identique au précédent)
        cscoreListSort(cs, a);                      trie la liste a en ordre chronologique selon p[2]
    n = cscoreListCount(cs, a);                     retourne le nombre d'évènements dans la liste a
    a = cscoreListExtractInstruments(cs, b, "..."); extrait les notes des instruments ... (pas de nouveaux
                                                      évènements)
    a = cscoreListExtractTime(cs, b, from, to);     extrait les notes d'une période de temps, en créant de
                                                      nouveaux évènements (from et to sont des MYFLT)
        cscoreListPut(cs, a);                       écrit les évènements de la liste a dans le fichier de partition en
                                                      sortie
        cscoreListPlay(cs, a);                      envoie les évènements de la liste a vers l'orchestre de Csound pour
                                                    une exécution immédiate (ou les imprime s'il n'y a pas d'orchestre)

    /* Fonctions pour réclamer de la mémoire */
        cscoreFreeEvent(cs, e);                     libère l'espace de l'évènement e
        cscoreListFree(cs, a);                      libère l'espace de la liste a (mais pas les évènements)
        cscoreListFreeEvents(cs, a);                libère les évènements de la liste a, et l'espace de la liste

    /* Fonctions pour travailler avec plusieurs fichiers de partition en entrée */
    fp = cscoreFileGetCurrent(cs);                  récupère le pointeur du fichier de partition en entrée actuellement
                                                      actif (au départ trouve le pointeur du fichier de partition en
                                                      entrée de la ligne de commande)
    fp = cscoreFileOpen(cs, "filename");            ouvre un autre fichier de partition en entrée (5 au maximum)
         cscoreFileSetCurrent(cs, fp);              fait de fp le pointeur sur le fichier de partition
                                                      actuellement actif
         cscoreFileClose(cs, fp);                   ferme le fichier de partition en relation avec FILE *fp

Sous Csound 4, les noms des fonctions et leurs paramètres étaient les suivants :

      syntaxe d'appel                          description
      ---------------                          -----------
      e = createv(n);          crée un évènement vide avec n pchamps
      e = defev("...");        définit un évènement par la chaîne de caractères ...
      e = copyev(f);           fait une nouvelle copie de l'évènement f
      e = getev();             lit l'évènement suivant dans le fichier de partition en entrée
      putev(e);                écrit l'évènement e dans le fichier de partition en sortie
      putstr("...");           écrit l'évènement défini par la chaîne dans la partition en sortie
      a = lcreat(n);           crée une liste d'évènements vide avec n emplacements
           int  n;
      a = lappev(a,e);         ajoute l'évènement e à la fin de la liste a
      a = lappstrev(a,"...");  ajoute l'évènement défini par la chaîne à la liste a
      a = lcopy(b);            copie la liste b (mais pas les évènements)
      a = lcopyev(b);          copie les évènements de b, en créant une nouvelle liste
      a = lget();              lit tous les évènements de la partition en entrée, jusqu'au
                                 prochain s ou e
      a = lgetnext(nbeats);    lit les prochaines nbeats pulsations de la partition en entrée
           float  nbeats;
      a = lgetuntil(beatno);   lit tous les évènements de la partition en entrée jusqu'à la
                                 pulsation beatno
           float  beatno;
      a = lsepf(b);            sépare les instructions f de la liste b vers la liste a
      a = lseptwf(b);          sépare les instructions t,w & f de la liste b vers la liste a
      a = lcat(a,b);           concaténation (ajout) de la liste b à la liste a
      lsort(a);                trie la liste a en ordre chronologique selon p[2]
      a = lxins(b,"...");      extrait les notes des instruments ... (pas de nouveaux évènements)
      a = lxtimev(b,from,to);  extrait les notes d'une période de temps, en créant de nouveaux
           float  from, to;      évènements
      lput(a);                 écrit les évènements de la liste a dans le fichier de partition en sortie
      lplay(a);                envoie les évènements de la liste a vers l'orchestre de Csound pour
                               une exécution immédiate (ou les imprime s'il n'y a pas d'orchestre)
      relev(e);                libère l'espace de l'évènement e
      lrel(a);                 libère l'espace de la liste a (mais pas les évènements)
      lrelev(a);               libère les évènements de la liste a, et l'espace de la liste
      fp = getcurfp();         récupère le pointeur du fichier de partition en entrée actuellement
                               actif (au départ trouve le pointeur du fichier de partition en entrée
                               de la ligne de commande)
      fp = filopen("filename"); ouvre un autre fichier de partition en entrée (5 au maximum)
      setcurfp(fp);            fait de fp le pointeur sur le fichier de partition actuellement actif
      filclose(fp);            ferme le fichier de partition en relation avec FILE *fp

Précédent | Niveau supérieur | Suivant
Autres utilitaires de Csound (CS, CSB64ENC, ENVEXT, EXTRACTOR, MAKECSD, MIXER, SCALE, MKDB) | Sommaire | Ecrire un programme de contrôle Cscore