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 NGFENS *	csound_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;
} OPCODE;

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

PUBLIC int csoundModuleCreate(CSOUND *csound)
{
    return 0;
}

PUBLIC int csoundModuleInit(CSOUND *csound)
{
    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;
}

PUBLIC int csoundModuleDestroy(CSOUND *csound)
{
    // 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)

Macro Definition Documentation

FLINKAGE

#define FLINKAGE

Value:

PUBLIC NGFENS *csound_fgen_init(CSOUND *csound)                         \
{   (void) csound; return localfgens;                               }   \
PUBLIC int csoundModuleInfo(void)                                       \
{ return ((CS_APIVERSION << 16) + (CS_APISUBVER << 8) + (int) sizeof(MYFLT)); }

LINKAGE for f-table plugins.

FLINKAGE_BUILTIN

#define FLINKAGE_BUILTIN

(

name

)

Value:

PUBLIC NGFENS *csound_fgen_init(CSOUND *csound)                         \
{   (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)); }

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 *

)