Csound API  6.09
csdl.h File Reference

Declares the Csound plugin opcode interface. More...

#include "interlocks.h"
#include "csoundCore.h"

Macros

#define Str(x)   (csound->LocalizeString(x))
 
#define LINKAGE
 The LINKAGE macro sets up linking of opcode list. More...
 
#define LINKAGE_BUILTIN(name)
 The LINKAGE_BUILTIN macro sets up linking of opcode list for builtin opcodes which must have unique function names. More...
 
#define FLINKAGE
 LINKAGE for f-table plugins. More...
 
#define FLINKAGE_BUILTIN(name)
 

Functions

PUBLIC int64_t csound_opcode_init (CSOUND *, OENTRY **)
 
PUBLIC NGFENScsound_fgen_init (CSOUND *)
 
PUBLIC int csoundModuleCreate (CSOUND *)
 
PUBLIC int csoundModuleInit (CSOUND *)
 
PUBLIC int csoundModuleDestroy (CSOUND *)
 
PUBLIC const char * csoundModuleErrorCodeToString (int)
 
PUBLIC int csoundModuleInfo (void)
 

Detailed Description

Declares the Csound plugin opcode interface.

Author
John P. ffitch, Michael Gogins, Matt Ingalls, John D. Ramsdell, Istvan Varga, Victor Lazzarini.

Plugin opcodes can extend the functionality of Csound, providing new functionality that is exposed as opcodes in the Csound language. Plugins need to include this header file only, as it will bring all necessary data structures to interact with Csound. It is not necessary for plugins to link to the libcsound library, as plugin opcodes will always receive a CSOUND* pointer (to the CSOUND_ struct) which contains all the API functions inside.

This is the basic template for a plugin opcode. See the manual for further details on accepted types and function call rates. The use of the LINKAGE macro is highly recommended, rather than calling the functions directly.

#include "csdl.h"
typedef struct {
OPDS h;
MYFLT *out;
MYFLT *in1, *in2;
static int op_init(CSOUND *csound, OPCODE *p)
{
// Intialization code goes here
return OK;
}
static int op_k(CSOUND *csound, OPCODE *p)
{
// code called at k-rate goes here
return OK;
}
// You can use these functions if you need to prepare and cleanup things on
// loading/unloading the library, but they can be absent if you don't need them
{
return 0;
}
{
OENTRY *ep = (OENTRY *) &(localops[0]);
int err = 0;
while (ep->opname != NULL) {
err |= csound->AppendOpcode(csound,
ep->opname, ep->dsblksiz, ep->thread,
ep->outypes, ep->intypes,
(int (*)(CSOUND *, void *)) ep->iopadr,
(int (*)(CSOUND *, void *)) ep->kopadr,
(int (*)(CSOUND *, void *)) ep->aopadr);
ep++;
}
return err;
}
{
// Called when the plugin opcode is unloaded, usually when Csound terminates.
return 0;
}
static OENTRY localops[] =
{
{ "opcode", sizeof(OPCODE), 0, 3, "i", "ii", (SUBR)op_init, (SUBR)op_k }}
};
LINKAGE(localops)
Declares the Csound plugin opcode interface.
PUBLIC int csoundModuleInit(CSOUND *)
PUBLIC int csoundModuleDestroy(CSOUND *)
PUBLIC int csoundModuleCreate(CSOUND *)
#define LINKAGE
The LINKAGE macro sets up linking of opcode list.
Definition: csdl.h:149
#define OK
Definition: csoundCore.h:96
#define OPCODE
Definition: csoundCore.h:781
int(* SUBR)(CSOUND *, void *)
Definition: csoundCore.h:600
#define PUBLIC
Definition: csound.h:277
Contains all function pointers, data, and data pointers required to run one instance of Csound.
Definition: csoundCore.h:1018
int(* AppendOpcode)(CSOUND *, const char *opname, int dsblksiz, int flags, int thread, const char *outypes, const char *intypes, int(*iopadr)(CSOUND *, void *), int(*kopadr)(CSOUND *, void *), int(*aopadr)(CSOUND *, void *))
Definition: csoundCore.h:1332
Definition: csoundCore.h:291
int(* kopadr)(CSOUND *, void *p)
Definition: csoundCore.h:299
char * intypes
Definition: csoundCore.h:297
char * opname
Definition: csoundCore.h:292
uint16 dsblksiz
Definition: csoundCore.h:293
int(* aopadr)(CSOUND *, void *p)
Definition: csoundCore.h:300
int(* iopadr)(CSOUND *, void *p)
Definition: csoundCore.h:298
uint8_t thread
Definition: csoundCore.h:295
char * outypes
Definition: csoundCore.h:296
This struct holds the info for one opcode in a concrete instrument instance in performance.
Definition: csoundCore.h:606

Macro Definition Documentation

◆ FLINKAGE

#define FLINKAGE
Value:
{ (void) csound; return localfgens; } \
PUBLIC int csoundModuleInfo(void) \
{ return ((CS_APIVERSION << 16) + (CS_APISUBVER << 8) + (int) sizeof(MYFLT)); }
PUBLIC NGFENS * csound_fgen_init(CSOUND *)
PUBLIC int csoundModuleInfo(void)
Definition: csoundCore.h:702

LINKAGE for f-table plugins.

◆ FLINKAGE_BUILTIN

#define FLINKAGE_BUILTIN (   name)
Value:
{ (void) csound; return name; } \
PUBLIC int csoundModuleInfo(void) \
{ return ((CS_APIVERSION << 16) + (CS_APISUBVER << 8) + (int) sizeof(MYFLT)); }

◆ LINKAGE

#define LINKAGE
Value:
PUBLIC int64_t csound_opcode_init(CSOUND *csound, OENTRY **ep) \
{ (void) csound; *ep = localops; return (int64_t) sizeof(localops); } \
PUBLIC int csoundModuleInfo(void) \
{ return ((CS_APIVERSION << 16) + (CS_APISUBVER << 8) + (int) sizeof(MYFLT)); }
PUBLIC int64_t csound_opcode_init(CSOUND *, OENTRY **)

The LINKAGE macro sets up linking of opcode list.

◆ LINKAGE_BUILTIN

#define LINKAGE_BUILTIN (   name)
Value:
PUBLIC int64_t csound_opcode_init(CSOUND *csound, OENTRY **ep) \
{ (void) csound; *ep = name; return (int64_t) (sizeof(name)); } \
PUBLIC int csoundModuleInfo(void) \
{ return ((CS_APIVERSION << 16) + (CS_APISUBVER << 8) + (int) sizeof(MYFLT)); }

The LINKAGE_BUILTIN macro sets up linking of opcode list for builtin opcodes which must have unique function names.

◆ Str

#define Str (   x)    (csound->LocalizeString(x))

Function Documentation

◆ csound_fgen_init()

PUBLIC NGFENS* csound_fgen_init ( CSOUND )

◆ csound_opcode_init()

PUBLIC int64_t csound_opcode_init ( CSOUND ,
OENTRY **   
)

◆ csoundModuleCreate()

PUBLIC int csoundModuleCreate ( CSOUND )

◆ csoundModuleDestroy()

PUBLIC int csoundModuleDestroy ( CSOUND )

◆ csoundModuleErrorCodeToString()

PUBLIC const char* csoundModuleErrorCodeToString ( int  )

◆ csoundModuleInfo()

PUBLIC int csoundModuleInfo ( void  )

◆ csoundModuleInit()

PUBLIC int csoundModuleInit ( CSOUND )