hsboscil.csd
Written by Iain McCurdy, 2009

<CsoundSynthesizer>

<CsOptions>
;COMMENT/UNCOMMENT AS REQUIRED
;-odac -dm0			;NO MIDI
-odac -dm0 -Ma			;EXTERNAL MIDI
;-odac -dm0 -M0 -+rtmidi=virtual	;VIRTUAL MIDI KEYBOARD
</CsOptions>

<CsInstruments>

sr 		= 	44100	;SAMPLE RATE
ksmps 		= 	32	;NUMBER OF AUDIO SAMPLES IN EACH CONTROL CYCLE
nchnls 		= 	2	;NUMBER OF CHANNELS (2=STEREO)
0dbfs		=	1	;MAXIMUM AMPLITUDE

;FLTK INTERFACE CODE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
FLcolor	255, 255, 255, 0, 0, 0
;					LABEL      | WIDTH | HEIGHT | X | Y
				FLpanel	"hsboscil",   500,    345,    0,  0

;SWITCHES  	                                  		ON | OFF | TYPE | WIDTH | HEIGHT | X | Y | OPCODE | INS | STARTTIM | DUR
;gkOnOff,ihOnOff			FLbutton	"On/Off",	1,    0,    2,     150,     30,    0,  0,     0,     2,      0,       -1

gkMIDItoFLTK,ihMIDItoFLTK	FLbutton	"Update FLTK from MIDI",1,    0,    22,    200,     25,  295,  5,   -1
FLsetColor2	255, 255, 50, ihMIDItoFLTK	;SET SECONDARY COLOUR TO YELLOW

;VALUE DISPLAY BOXES			LABEL  | WIDTH | HEIGHT | X | Y
idShepFreq			FLvalue	" ",       70,    17,   210,  54
idamp				FLvalue	" ",       80,    20,     5, 105
idtone				FLvalue	" ",       80,    20,     5, 155
idbrite				FLvalue	" ",       80,    20,     5, 205
idbasfreq			FLvalue	" ",       80,    20,     5, 255
idphs				FLvalue	" ",       80,    20,   135, 305

;COUNTERS								MIN | MAX | STEP1 | STEP2 | TYPE | WIDTH | HEIGHT | X | Y | OPCODE
gkoctcnt, ihoctcnt		FLcount  "Blending Range (octaves)", 	2,    10,     1,      1,      2,    120,     25,    0, 280,   -1

;SLIDERS					            			MIN | MAX | EXP | TYPE |   DISP   | WIDTH | HEIGHT | X | Y
gkShepFreq,ihShepFreq		FLslider 	"Rate (Hz):",			-1,      1,  0,    23,   idShepFreq,  150,     15,  130,  40
gkamp,ihamp			FLslider 	"Amplitude",			0,       1,  0,    23,       idamp,   490,     25,    5,  80
gktone,gihtone			FLslider 	"Tone (pitch bend)",		0,       1,  0,    23,      idtone,   490,     25,    5, 130
gkbrite,gihbrite		FLslider 	"Brightness (CC#1)",		-7,      7,  0,    23,     idbrite,   490,     25,    5, 180
gkbasfreq,gihbasfreq		FLslider 	"Base Frequency (i-rate)",	20,  20000, -1,    23,    idbasfreq,  490,     25,    5, 230
gkphs,ihphs			FLslider 	"Initial Phase (i-rate)",	-1,      1,  0,    23,        idphs,  350,     25,  135, 280

FLsetAlign	8, ihShepFreq	;ALIGN LABEL BOTTOM LEFT

;GENERAL_TEXT_SETTINGS			SIZE | FONT |  ALIGN | RED | GREEN | BLUE
			FLlabel		13,      4,      1,    255,   255,   255		;LABELS MADE INVISIBLE (I.E. SAME COLOR AS PANEL)

FLcolor2	255, 255, 50	;SET SECONDARY COLOUR TO YELLOW
;BUTTON BANKS			 	TYPE | NUMX | NUMY | WIDTH | HEIGHT | X | Y | OPCODE | INS | STARTTIM | DUR
gkinput, ihinput	FLbutBank	2,      1,      3,     30,     60,    0,  0,    0,     2,      0,      0.01

;GENERAL_TEXT_SETTINGS			SIZE | FONT |  ALIGN | RED | GREEN | BLUE
			FLlabel		13,      4,      1,     0,     0,     0			;LABELS MADE VISIBLE AGAIN

;TEXT BOXES						TYPE | FONT | SIZE | WIDTH | HEIGHT | X |  Y
ih		 	FLbox  	"MIDI/(Off)    ", 	1,       5,    12,    100,      20,   30,   0
ih		 	FLbox  	"No MIDI       ", 	1,       5,    12,    100,      20,   30,  20
ih		 	FLbox  	"Shepard Gliss.", 	1,       5,    12,    100,      20,   30,  40

;SET INITIAL VALUES OF FLTK VALUATORS		VALUE | HANDLE
				FLsetVal_i	0.1, 	ihamp
				FLsetVal_i	0, 	gihtone
				FLsetVal_i	0, 	gihbrite
				FLsetVal_i	200, 	gihbasfreq
				FLsetVal_i	0.1, 	ihShepFreq
				FLsetVal_i	3, 	ihoctcnt
				FLsetVal_i	0, 	ihphs
				FLsetVal_i	1, 	ihMIDItoFLTK
			
				FLpanel_end

;INSTRUCTIONS AND INFO PANEL
				FLpanel	" ", 500, 760, 512, 0
;TEXT BOXES												TYPE | FONT | SIZE | WIDTH | HEIGHT | X | Y
ih		 	FLbox  	"                         hsboscil                            ", 	1,      5,     14,    490,    15,     5,  0
ih		 	FLbox  	"-------------------------------------------------------------", 	1,      5,     14,    490,    15,     5,  20
ih		 	FLbox  	"hsboscil generates a tone composed of partials derived from  ", 	1,      5,     14,    490,    15,     5,  40
ih		 	FLbox  	"a stack of octaves.                                          ", 	1,      5,     14,    490,    15,     5,  60
ih		 	FLbox  	"'Brightness' (gkbrite) controls the weighting of these       ", 	1,      5,     14,    490,    15,     5,  80
ih		 	FLbox  	"partials: negative values favouring lower partials, positive ", 	1,      5,     14,    490,    15,     5, 100
ih		 	FLbox  	"values favouring higher partials.                            ", 	1,      5,     14,    490,    15,     5, 120
ih		 	FLbox  	"'Blending Range' (ioctcnt) defines the number of partials    ", 	1,      5,     14,    490,    15,     5, 140
ih		 	FLbox  	"in the tone.                                                 ", 	1,      5,     14,    490,    15,     5, 160
ih		 	FLbox  	"'Tone' shifts partials up or down in parallel. At the same   ", 	1,      5,     14,    490,    15,     5, 180
ih		 	FLbox  	"time the entire spectrum is enveloped according to a         ", 	1,      5,     14,    490,    15,     5, 200
ih		 	FLbox  	"windowing function created in a function table. The range of ", 	1,      5,     14,    490,    15,     5, 220
ih		 	FLbox  	"this spectral window is dependent upon the value given for   ", 	1,      5,     14,    490,    15,     5, 240
ih		 	FLbox  	"'Blending Range'. If 'Tone' is modulated such that partials  ", 	1,      5,     14,    490,    15,     5, 260
ih		 	FLbox  	"disappear beyond the edge of spectral window they are        ", 	1,      5,     14,    490,    15,     5, 280
ih		 	FLbox  	"replaced by new partials at the opposite edge of the window. ", 	1,      5,     14,    490,    15,     5, 300
ih		 	FLbox  	"It is this behaviour that allows us to create the Shepard    ", 	1,      5,     14,    490,    15,     5, 320
ih		 	FLbox  	"glissando effect in which a tone appears to simultaneously   ", 	1,      5,     14,    490,    15,     5, 340
ih		 	FLbox  	"be constantly rising (or falling) but never actually get any ", 	1,      5,     14,    490,    15,     5, 360
ih		 	FLbox  	"higher (lower) in pitch. A visual analogue is that of the    ", 	1,      5,     14,    490,    15,     5, 380
ih		 	FLbox  	"spinning barber-pole.                                        ", 	1,      5,     14,    490,    15,     5, 400
ih		 	FLbox  	"hsboscil's octave spaced partials tends to produce organ-like", 	1,      5,     14,    490,    15,     5, 420
ih		 	FLbox  	"tones.                                                       ", 	1,      5,     14,    490,    15,     5, 440
ih		 	FLbox  	"This example offers three methods of activating hsboscil.    ", 	1,      5,     14,    490,    15,     5, 460
ih		 	FLbox  	"Firstly, via MIDI (in which case 'Base Frequency' is         ", 	1,      5,     14,    490,    15,     5, 480
ih		 	FLbox  	"determined by the MIDI note number with the 'Base Frequency' ", 	1,      5,     14,    490,    15,     5, 500
ih		 	FLbox  	"slider becoming inoperative). Secondly, without MIDI (slider ", 	1,      5,     14,    490,    15,     5, 520
ih		 	FLbox  	"becomes operative again) and thirdly, a method which produces", 	1,      5,     14,    490,    15,     5, 540
ih		 	FLbox  	"the Shepard glissando effect by modulating the 'Tone'        ", 	1,      5,     14,    490,    15,     5, 560
ih		 	FLbox  	"control using an LFO.                                        ", 	1,      5,     14,    490,    15,     5, 580
ih		 	FLbox  	"In the original Roger Shepard experiment the tones moved     ", 	1,      5,     14,    490,    15,     5, 600
ih		 	FLbox  	"stepwise. Jean-Claude Risset introduced the idea of the      ", 	1,      5,     14,    490,    15,     5, 620
ih		 	FLbox  	"tone moving smoothly leading to the name Shepard Glissando or", 	1,      5,     14,    490,    15,     5, 640
ih		 	FLbox  	"Shepard-Risset Glissando.                                    ", 	1,      5,     14,    490,    15,     5, 660
ih		 	FLbox  	"In MIDI mode the modulation wheel can be used to control     ", 	1,      5,     14,    490,    15,     5, 680
ih		 	FLbox  	"'Brightness'                                                 ", 	1,      5,     14,    490,    15,     5, 700
ih		 	FLbox  	"This opcode was written by Peter Neubacker who is also the   ", 	1,      5,     14,    490,    15,     5, 720
ih		 	FLbox  	"author of the Melodyne software.                             ", 	1,      5,     14,    490,    15,     5, 740

				FLpanel_end

				FLrun	;RUN THE FLTK WIDGET THREAD
;END OF FLTK INTERFACE CODE;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;

giwfn	ftgen	0, 0, 131072, 10, 1			;A SINE WAVE
gioctfn	ftgen	0, 0, 1024, -19, 1, 0.5, 270, 0.5	;A HANNING-TYPE WINDOW

instr	1	;MIDI ACTIVATED HSBOSCIL INSTRUMENT
        ;MIDI INPUT============================================================================================================================================================
        ;OUTPUT                 OPCODE          CHANNEL | CC.NUMBER | MIN | MAX
        kbrite                  ctrl7           1,            1,       0,    1
        ktrig                   changed         kbrite  ;IF THE VARIABLE 'kptr' CHANGES FROM ITS PREVIOUS VALUE,
                                                        ;I.E. IF THE MIDI SLIDER IS MOVED THEN THE VARIABLE ktrig WILL ASSUME THE VALUE '1', OTHERWISE IT WILL BE ZERO.
        kbrite          	scale           kbrite, 7, -7      ;VARIBALE HAS TO BE RESCALED HERE, DOING IT IN THE ctrl7 LINE UPSETS THE WORKING OF THE changed OPCODE ABOVE
;                       OPCODE      |   TRIGGER | VALUE | HANDLE
                                FLsetVal        ktrig*gkMIDItoFLTK,   kbrite,  gihbrite
	if ktrig==1 then
	 gkbrite	=	kbrite
	endif
	;======================================================================================================================================================================
	iporttime	=	0.1				;PORTAMENTO TIME (CONSTANT) 
	kporttime	linseg	0,0.001,iporttime,1,iporttime	;PORTAMENTO TIME (AN ENVELOPE FUNCTION THAT RAMPS UP FROM ZERO) 
	kamp		portk		gkamp, kporttime	;APPLY PORTAMENTO
	kbrite		portk		gkbrite, kporttime      ;APPLY PORTAMENTO
	kbend		pchbend		0,2
	ktone		portk		gktone+kbend, kporttime	;APPLY PORTAMENTO
	ibasfreq	cpsmidi					;READ MIDI NOTE VALUES (IN HERTZ/CPS) FROM MIDI INPUT
	FLsetVal_i	ibasfreq, gihbasfreq			;SEND MIDI NOTE VALUES TO 'BASE FREQUENCY' SLIDER
	kSwitch	changed	gkoctcnt, gkphs	;GENERATE A MOMENTARY '1' PULSE IN OUTPUT 'kSwitch' IF ANY OF THE SCANNED INPUT VARIABLES CHANGE. (OUTPUT 'kSwitch' IS NORMALLY ZERO)
	if	kSwitch=1	then
		reinit	START
	endif
	START:
		ares 		hsboscil	kamp, ktone, kbrite, ibasfreq, giwfn, gioctfn, i(gkoctcnt), i(gkphs)	;CREATE AN hsboscil TONE
	rireturn
	aenv	linsegr		0,0.01,1,3600,1,0.01,0	;CREATE A BASIC ENVELOPE TO PREVENT CLICKS AT THE START AND ENDS OF NOTES
	outs	ares*aenv, ares*aenv	;SEND AUDIO TO OUTPUTS, APPLY ENVELOPE
endin
	
instr	2	;INTERROGATE VALUE OF BUTTON BANK. THIS INSTRUMENT IS ALSO INSTIGATED BY THE BUTTON BANK
	if	gkinput	=1	then	;IF 'NO MIDI' INPUT MODE IS SELECTED...
		turnon 3	;...TURNON INSTRUMENT 4
	elseif	gkinput	=2	then	;IF 'SHEPARD GLISSANDO' INPUT MODE IS SELECTED...
		turnon 4	;...TURNON INSTRUMENT 5
	endif
endin	
	

instr	3	;HSBOSCIL INSTRUMENT - SLIDER CONTROLS BASE FREQUENCY
	if	gkinput!=1	then	;IF SWITCH BANK IS *NOT* 1 THEN...
		turnoff			;TURN THIS INSTRUMENT OFF
	endif				;END OF CONDITIONAL BRANCHING
	iporttime	=	0.1				;PORTAMENTO TIME (CONSTANT)                                    
	kporttime	linseg	0,0.001,iporttime,1,iporttime   ;PORTAMENTO TIME (AN ENVELOPE FUNCTION THAT RAMPS UP FROM ZERO)
	kamp		portk		gkamp, kporttime	;APPLY PORTAMENTO
	kbrite		portk		gkbrite, kporttime      ;APPLY PORTAMENTO
	ktone		portk		gktone, kporttime       ;APPLY PORTAMENTO
	aenv		linsegr		0,0.001,1,3600,1,0.01,0	;CREATE A BASIC ENVELOPE TO PREVENT CLICKS AT THE START AND ENDS OF NOTES
	kSwitch	changed	gkbasfreq, gkoctcnt, gkphs	;GENERATE A MOMENTARY '1' PULSE IN OUTPUT 'kSwitch' IF ANY OF THE SCANNED INPUT VARIABLES CHANGE. (OUTPUT 'kSwitch' IS NORMALLY ZERO)
	if	kSwitch=1	then
		reinit	START
	endif
	START:
	ares 		hsboscil	kamp, ktone, kbrite, i(gkbasfreq), giwfn, gioctfn, i(gkoctcnt), i(gkphs)	;CREATE AN hsboscil TONE
	rireturn
			outs	ares*aenv, ares*aenv	;SEND AUDIO TO OUTPUTS, APPLY ENVELOPE
endin

instr	4	;HSBOSCIL INSTRUMENT - SHEPARD GLISSANDO 
	if	gkinput!=2	then	;IF SWITCH BANK IS *NOT* 2 THEN...
		turnoff			;TURN THIS INSTRUMENT OFF
	endif				;END OF CONDITIONAL BRANCHING
	iporttime	=	0.1				;PORTAMENTO TIME (CONSTANT)                                    
	kporttime	linseg	0,0.001,iporttime,1,iporttime   ;PORTAMENTO TIME (AN ENVELOPE FUNCTION THAT RAMPS UP FROM ZERO)
	kamp		portk		gkamp, kporttime	;APPLY PORTAMENTO                                              
	kbrite		portk		gkbrite, kporttime      ;APPLY PORTAMENTO                                              
	ktone		phasor		gkShepFreq              ;CREATE A MOVING PHASE VALUE THAT WILL BE USED TO MODULATE 'TONE' PARAMETER                                              
	ktrigger	metro	50				;CREATE A METRONIC PULSE OF '1' VALUES. 50 PER SECOND
	FLsetVal	ktrigger, ktone, gihtone		;UPDATE 'TONE; SLIDER (THIS WILL BE FOR VISUAL FEEDBACK ONLY)
	aenv		linsegr		0,0.001,1,3600,1,0.01,0	;CREATE A BASIC ENVELOPE TO PREVENT CLICKS AT THE START AND ENDS OF NOTES
	kSwitch	changed	gkbasfreq, gkoctcnt, gkphs	;GENERATE A MOMENTARY '1' PULSE IN OUTPUT 'kSwitch' IF ANY OF THE SCANNED INPUT VARIABLES CHANGE. (OUTPUT 'kSwitch' IS NORMALLY ZERO)
	if	kSwitch=1	then
		reinit	START
	endif
	START:
	ares 		hsboscil	kamp, ktone, kbrite, i(gkbasfreq), giwfn, gioctfn, i(gkoctcnt), i(gkphs)	;CREATE AN hsboscil TONE
	rireturn
			outs	ares * aenv, ares * aenv	;SEND AUDIO TO OUTPUTS, APPLY ENVELOPE
endin
  	
</CsInstruments>

<CsScore>
f 0 3600
</CsScore>

</CsoundSynthesizer>




























