add new manual page that explains manual conventions

[tjingboem]

creating a new manual page that explains why and how certain choices were made regarding the manual pages and the examples and the samples used.

• all examples work from the terminal on platforms OSX, Windows, Linux and Android.

• in principle, same header for all the examples are implemented. These values have a good balance in CPU / performance.

  sr = 44100
  ksmps = 32
  nchnls = 2
  0dbfs = 1

  but, of course other values for sr and ksmps are OK. However a (slightly) different result from the one found on the manual pages may occur.

• all the examples that use live input - that use the -adc flag, make source a mono one, for one mic. nchnls_i = 1

• musical example: link to special folder in the examples folder where long musical examples are stored. On the manual page a link to the folder will be found.

• examples for FLTK plugin opcodes are no longer supported as these opcodes are not available on the Mac.

• The name of samples "drumSlp.wav" and "drumMlp.wav" stands for: the "S" for stereo the "M" for mono the "lp" stands for loop points that can be recognized by loscil and friends. Only wav can have embedded loop points (IS THIS TRUE??)

• The name of sample MathewsN.wav stands for: the "N" for noise

• list of mono samples:

  Mathews.wav
  fox.wav
  beats.wav
  singFemale.aif
  marimba.aif
  Church.wav
  drumsMlp.wav
  MathewsN.wav
  MathewsNoise.wav
  MSjungleMid.wav
  MSjungleSide.wav
  oboe.aiff
  saxophone-alto-C-octave0.wav
  sing.wav
  wave.wav

• list of stereo samples:

  drumSlp.wav
  MSjungle_interleaved.wav
  stereoJungle.wav

• A few samples are meant to function as impulse files:

  ahh.aiff
  eee.aiff
  flute.aiff
  flutec3.wav
  flute-C-octave0.wav
  fwavblnk.aiff 
  impuls20.aiff 
  ir.wav
  mandpluk.aiff
  marmstk1.wav
  ooo.aiff
  rv_mono.wav 
  rv_stereo.wav
  twopeaks.aiff

• word on the plugin opcodes being a separate repo, and their manual pages and some links to a few other plugin repos (Rory, Eduardo) :

  Abelton Link opcodes
  CUDA - other issue: not much information --> new issue
  Chua
  Faust opcodes
  Fluid opcodes
  HDF5 opcodes
  Image opcodes
  Jack opcodes
  Linear Algebra
  mp3out - no manual page so no mentioning of it being a plugin
  opencl - no manual pages so no mentioning of it being a plugin
  p5glove
  Python opcodes
  STK opcodes
  Websocket
  FLTK widgets
  Wiimote opcodes

Gesselkammer: https://github.com/csound-plugins/csound-plugins Csound plugin repo: https://github.com/csound/plugins Rory Walsh: https://rorywalsh.github.io/csoundPluginOpcodes/#/ Michael Gogins: https://github.com/gogins/csound-vst3-opcodes Michael Gogins:: https://github.com/gogins/csound-extended

• scan matrices and their extensions explained

128,8-cylinder.XmatrxT
128,8-grid.XmatrxT
128,8-torus.XmatrxT
128-left_right.XmatrxT
128-string.XmatrxT
128-stringcircular.XmatrxT

xscan opcodes and their matrices 'XmatrxT' are deprecated.

128,8-torus.matrxB
128-stringcircular.matrxB

128-spiral-8,16,128,2,1over2.traj

• image opcodes can read png format only

  image.png
  imageOpcode01.png
  imageOpcode02.png
  imageOpcode03.png
  test1.png
  test2.png

• Linear Predictive opcodes:

  fox_nopoles.lpc
  fox_poles.lpc

  explain difference between poles and no_poles files.

• hrtf opcodes explain

  HRTFcompact
  hrtf-44100-left.dat
  hrtf-44100-right.dat
  hrtf-48000-left.dat
  hrtf-48000-right.dat
  hrtf-96000-left.dat
  hrtf-96000-right.dat

  HRTFcompact is deprecated. The new data files are to be found in /csound/samples

• new universal midi file explained with screenshot of all channels

  midichn_advanced.mid
  midiChords.mid
  MIDIpad.mid
  pgmassign_advanced.mid
  polyaft.mid

• soundfonts

  01hpschd.sf2
  07AcousticGuitar.sf2
  19Trumpet.sf2
  22Bassoon.sf2
  sf_GMbank.sf2

• ATS opcodes

  beats.ats
  cage.ats
  fox.ats

• hetro file kickroll.het

• sdif & Loris opcodes:

  clarinet.sdif
  meow.sdif

• compressed sound files

  beats.mp3
  ahhc.aiff
  beats.ogg
  eeec.aiff
  finneganswake1.flac

• html websocket.html

• other manual conventions i do not know yet

[csounder]

a good plan.

- Dr.B

Dr. Richard Boulanger

Professor

Electronic Production and Design

Berklee College of Music

Professional Writing & Technology Division

On Wed, Aug 10, 2022 at 4:23 AM Menno Knevel @.***> wrote:

creating a new manual page that explains why and how certain choices were made regarding the manual pages and the examples and the samples used.

• all examples work from the terminal on the 3 main platforms OSX, Windows and Linux -same header for all the examples

sr = 44100 ksmps = 32 nchnls = 2 0dbfs = 1

but, of course values are OK but may result in slightly different result from the one as found on the manual page

-

musical example ?? link to special folder in the examples folder where musical examples are stored, so not visible on the manual page (too long)

FLTK is not always available on the Mac

The name of samples "drumSlp.wav" and "drumMlp.wav" stands for: the "S" for stereo the "M" for mono the "lp" stands for loop points that can be recognized by loscil and other opcodes.

word on the plugins and some links

other manual conventions i do not know yet

— Reply to this email directly, view it on GitHub https://us-west-2.protection.sophos.com?d=github.com&u=aHR0cHM6Ly9naXRodWIuY29tL2Nzb3VuZC9tYW51YWwvaXNzdWVzLzYzMQ==&i=NWYxNzBkMDNiNTVmZGEwZmIyNjczYmRm&t=SldzZWdyb2lNUjFDbnpLemxHc29iRXRtRHNPNG1KUU90bTRid3dva2pnbz0=&h=bbe063e7c0334c13bf72c30a60f48b42, or unsubscribe https://us-west-2.protection.sophos.com?d=github.com&u=aHR0cHM6Ly9naXRodWIuY29tL25vdGlmaWNhdGlvbnMvdW5zdWJzY3JpYmUtYXV0aC9BQUxXWUZXTDRGSUlHWk1HQ0VSUlZPRFZZTlJITEFOQ05GU001NkRTU1dMQQ==&i=NWYxNzBkMDNiNTVmZGEwZmIyNjczYmRm&t=N1ZGbStNazRmZGlxL3o5WXIvOENpd1BaNVBMVDRuNDlidCswd0c1dE5GUT0=&h=bbe063e7c0334c13bf72c30a60f48b42 . You are receiving this because you are subscribed to this thread.Message ID: @.***>