R/getHeaderInfo.R

In csound: Accessing Csound functionality through R

##' Get the header specifications of a Csound instance
##'
##' The header of the csound orchestra declares various important
##' variables including the sample rate, the number of audio samples
##' per control period, the number of output channels, and the maximum
##' amplitude value. This function queries a Csound instance and
##' returns the information in a list.
##' 
##' @return \code{getHeaderInfo()} returns a list with the following
##' elements:
##'
##' \code{$sample rate}, abbreviated as \preformatted{sr} in
##' the orchestra header. is the number of data points
##' (\sQuote{samples}) per second used to represent a sound. The
##' default is 44100 Hz, which is CD-quality.
##'
##' \code{$ksmps} is the number of samples in a control period,
##' which must be an integer. Csound allows one to control an audio
##' signal at a rate below that of the audio rate (i.e. the
##' \dfn{control rate} or \code{$kr}), useful for things such
##' as creating an envelope for sounds; using a lower-than-audio rate
##' uses less processing power for what is often the same audio
##' effect. Higher values of \preformatted{ksmps} indicate a slower
##' control rate; \preformatted{ksmps=1} means audio rate. A typical
##' \preformatted{ksmps} is 10.
##'
##' \code{$x0dbfs} is the maximum amplitude value--specified amplitude
##' values are scaled between 0 and this number. \preformatted{0dbfs}
##' is short for Zero Decibels at Full-Scale Amplitude. A common value
##' is 1; if not specified in the file, the default is 32768.
##'
##' \code{$nchnls} is the number of output channels specified; 1 is
##' mono output, 2 stereo, etc.
##'
##' If the orchestra has been compiled, these should match the header
##' in the orchestra; if no orchestra has been compiled,
##' \code{getHeaderInfo()} simply returns the defaults.
##' 
##' @rdname getHeaderInfo
##' @param csInstance An instance of Csound, created by \code{\link{csoundCreate}}.
##' @export
getHeaderInfo <- function(csInstance) {
  list(sr=csoundGetSr(csInstance),
       ksmps=csoundGetKsmps(csInstance),
       kr=csoundGetKr(csInstance),
       x0dbfs=csoundGet0dBFS(csInstance),
       nchnls=csoundGetNchnls(csInstance))
}
       

csoundGetKr <- function(csInstance) {
  symptr <- .dynsym(getCsoundLibrary(), "csoundGetKr")
  return(.dyncall(symptr, "*<CSOUND>)f", csInstance))
}

csoundGetKsmps <- function(csInstance) {
 symptr <- .dynsym(getCsoundLibrary(), "csoundGetKsmps")
 return(.dyncall(symptr, "*<CSOUND>)i", csInstance))
}


csoundGetSr <- function(csInstance) {
  symptr <- .dynsym(getCsoundLibrary(), "csoundGetSr")
  return(.dyncall(symptr, "*<CSOUND>)f", csInstance))
}


csoundGetSampleSize <- function(csInstance) {
  symptr <- .dynsym(getCsoundLibrary(), "csoundGetSampleSize")
  return(.dyncall(symptr, "*<CSOUND>)i", csInstance))
}

csoundGetNchnls <- function(csInstance) {
  symptr <- .dynsym(getCsoundLibrary(), "csoundGetNchnls")
  return(.dyncall(symptr, "*<CSOUND>)i", csInstance))
}

csoundGet0dBFS <- function(csInstance) {
  symptr <- .dynsym(getCsoundLibrary(), "csoundGet0dBFS")
  return(.dyncall(symptr, "*<CSOUND>)f", csInstance))
}