Blame ld10k1/doc/lo10k1_usage

Packit 427e91
lo10k1 is loader.
Packit 427e91
Packit 427e91
Parameters:
Packit 427e91
Packit 427e91
-h or --help
Packit 427e91
    Prints short help message
Packit 427e91
    
Packit 427e91
-l patch_name or --list path_name
Packit 427e91
    List some usefull informations about patch in file patch_name. lo10k1 uses patch produced by as10k1 from
Packit 427e91
    alsatools package.
Packit 427e91
    
Packit 427e91
-p name or --pipe_name name
Packit 427e91
    lo10k1 will use local named pipe with name name to communication with linker. Default is /tmp/.ld10k1_port
Packit 427e91
Packit 427e91
-i or --info
Packit 427e91
    Prints some info about card - not wery usefull
Packit 427e91
    
Packit 427e91
-a patch_name or --add patch_name
Packit 427e91
    Loads patch from file patch_name to DSP
Packit 427e91
Packit 427e91
-d num or --del num
Packit 427e91
    Unloads patch with number num from DSP. Use option --debug 4 to obtain patch numbers.
Packit 427e91
    
Packit 427e91
--conadd conn_string
Packit 427e91
    Connects patches between each others or to inputs or outputs.
Packit 427e91
    Format of conn_string:
Packit 427e91
	FX buses:
Packit 427e91
	FX(f1, ...) - specify fx bus register f1 can be number or fx bus register name
Packit 427e91
		Names can be optained by lo10k1 --debug 7
Packit 427e91
	    FX(1)
Packit 427e91
	    FX(1,2)
Packit 427e91
	    FX(FX_PCM_Left,FX_PCM_Right)
Packit 427e91
	    
Packit 427e91
	Inputs:
Packit 427e91
	IN(i1, ...) - specify input register i1 can be number or input register name
Packit 427e91
		Names can be optained by lo10k1 --debug 8
Packit 427e91
	    IN(1)
Packit 427e91
	    IN(1,2)
Packit 427e91
	    IN(IN_AC97_Left,IN_AC97_Right)
Packit 427e91
Packit 427e91
	Outputs:
Packit 427e91
	OUT(o1, ...) - specify input register o1 can be number or input register name
Packit 427e91
		Names can be optained by lo10k1 --debug 9
Packit 427e91
	    OUT(1)
Packit 427e91
	    OUT(1,2)
Packit 427e91
	    OUT(OUT_AC97_Front_Left,OUT_AC97_Front_Right)
Packit 427e91
	    
Packit 427e91
	Patch inputs:
Packit 427e91
	PIN(p, i1, ...) - p is patch number or patch name, i1 is input register i1 can be number or input register name
Packit 427e91
		Patch numbers and names can be optained by lo10k1 --debug 5
Packit 427e91
		Names can be optained by lo10k1 --debug patch_num
Packit 427e91
	    PIN(1) - all patch inputs for patch 1
Packit 427e91
	    PIN(Volume,IL,IL) - inputs IL and IR for patch Volume
Packit 427e91
	    PIN(2,0,1,2,3,4,5) - inputs 0,1,2,3,4,5 patch 2
Packit 427e91
	    
Packit 427e91
	Patch outputs:
Packit 427e91
	POUT(p, o1, ...) - p is patch number or patch name, o1 is output register o1 can be number or outpur register name
Packit 427e91
		Patch numbers and names can be optained by lo10k1 --debug 5
Packit 427e91
		Names can be optained by lo10k1 --debug patch_num
Packit 427e91
	    POUT(1) - all patch outputs for patch 1
Packit 427e91
	    POUT(Volume,OL,OL) - outputs OL and OR for patch Volume
Packit 427e91
	    POUT(2,0,1,2,3,4,5) - outputs 0,1,2,3,4,5 patch 2
Packit 427e91
Packit 427e91
	
Packit 427e91
	- connecting two patches:
Packit 427e91
	    something1=something2
Packit 427e91
	    or
Packit 427e91
		something1:something2
Packit 427e91
	    or
Packit 427e91
	    something1>something2
Packit 427e91
		something1,something2 - strings specify fx bus, input, output, patch input or patch output
Packit 427e91
		something1 - must be patch input or output
Packit 427e91
Packit 427e91
	    Difference between = and > is that = connect only two patches > enables connecting more
Packit 427e91
	    patches together. If you have three patches p1,p2,p3 - p1 with output o1, p2 with input i2,
Packit 427e91
	    and p3 with input i3.
Packit 427e91
	    PIN(p2,i2)=POUT(p1,o1) - will connect p1 with p2
Packit 427e91
	    then next connect
Packit 427e91
	    PIN(p3,i3)=POUT(p1,o1) - will disconnect p1 and p2 and connect p1 with p2
Packit 427e91
	    but
Packit 427e91
	    PIN(p3,i3)>POUT(p1,o1) - will connect p1 and p2 - p2 input i2 and p3 input i3 will be connected
Packit 427e91
	    to p1 output o1
Packit 427e91
Packit 427e91
		Diffrence between = and : is that = allocate extra instructions and register to properly add
Packit 427e91
		sources. : uses same register for all sources and patches must care about this register.
Packit 427e91
Packit 427e91
	    Counts of connected inputs and outputs must be same.
Packit 427e91
Packit 427e91
	    FX busses, inputs and outputs can have multiple patches connected to them.
Packit 427e91
	    Examples:
Packit 427e91
	    lo10k1 --conadd "PIN(1)=FX(0,1)"
Packit 427e91
		- connect to patch 1 input to fx bus 0 and 1
Packit 427e91
Packit 427e91
	    lo10k1 --conadd "PIN(2)=POUT(PCM)"
Packit 427e91
		- connect to all patch 2 inputs all outputs from patch PCM
Packit 427e91
Packit 427e91
Packit 427e91
--condel conndel_string
Packit 427e91
    Disconnects patch register.
Packit 427e91
    Format of conndel_string:
Packit 427e91
	something
Packit 427e91
		something - strings specify patch input or patch output
Packit 427e91
		
Packit 427e91
	Examples:
Packit 427e91
	    lo10k1 --condel "PIN(1)"
Packit 427e91
		- disconnect all inputs of patch 1
Packit 427e91
		
Packit 427e91
	    lo10k1 --condel "POUT(PCM1,1,Center))"
Packit 427e91
		- disconnect output 1 and Center from patch PCM
Packit 427e91
Packit 427e91
--debug num
Packit 427e91
    Prints on console some debug information. 
Packit 427e91
    mum = 1 - prints registers information
Packit 427e91
    mum = 2 - prints consts information
Packit 427e91
    mum = 3 - prints instruction information
Packit 427e91
    mum = 4 - prints information about TRAM
Packit 427e91
    mum = 5 - prints loaded patch names and numbers
Packit 427e91
    mum = 6 - prints patch order in DSP instruction memory
Packit 427e91
    mum = 7 - prints fx information
Packit 427e91
    mum = 8 - prints input information
Packit 427e91
    mum = 9 - prints output information
Packit 427e91
    mum = 100 and more - prints informations about loaded patches (--debug 100 - about patch number 0,
Packit 427e91
	-- debug 101 about patch number 1, and so on)
Packit 427e91
	
Packit 427e91
--defionames
Packit 427e91
    When patch is loaded, this assign default names for patch input and output registers.
Packit 427e91
    Input/Output count:
Packit 427e91
	1/1 - In/Out
Packit 427e91
	2/2 - IL,IR/OL,OR
Packit 427e91
	4/4 - IL,IR,IRL,IRR/OL,OR,ORL,ORR
Packit 427e91
	6/6 - IL,IR,IRL,IRR,IC,ILFE/OL,OR,ORL,ORR,OC,OLFE
Packit 427e91
    where:
Packit 427e91
	In = Input
Packit 427e91
	On = Output
Packit 427e91
	IL = Input Left
Packit 427e91
	OL = Output Left
Packit 427e91
	IR = Input Right
Packit 427e91
	OR = Output Right
Packit 427e91
	IRL = Input Rear Left
Packit 427e91
	ORL = Output Rear Left
Packit 427e91
	IRR = Input Rear Right
Packit 427e91
	ORR = Output Rear Right
Packit 427e91
	IC = Input Center
Packit 427e91
	OC = Output Center
Packit 427e91
	ILFE = Input LFE
Packit 427e91
	OLFE = Output LFE
Packit 427e91
	
Packit 427e91
--ctrl string
Packit 427e91
    This options is used to concate, rename controls and sets various parameters for controls
Packit 427e91
    String format:
Packit 427e91
Packit 427e91
	c-name1,name2,...namen:outname
Packit 427e91
Packit 427e91
	This concate controls with names name1, name2, ..namen to one control with name outname
Packit 427e91
	Input controls must have same range and are single channel (this is limitation of as10k1).
Packit 427e91
	Output control has n channes. This can be used only for as10k1 file format.
Packit 427e91
Packit 427e91
	example:
Packit 427e91
	    c-masterl,masterr:master,t-master:1
Packit 427e91
Packit 427e91
	    Concate two controls masterl and masterr into one stereo control master with translaton table100
Packit 427e91
Packit 427e91
	t-name:type
Packit 427e91
Packit 427e91
	This sets translate function whitch translate range and current value from mixer value to gpr
Packit 427e91
	value for control with name name. This can be used only for as10k1 file format.
Packit 427e91
	Type can be:
Packit 427e91
	    0 - no translation is used
Packit 427e91
	    1 - table 100 - range 0-100 in mixer is translated to range 0-2^31
Packit 427e91
	    2 - bass - range 0-40 in mixer is translated to range 0-2^31 - used for bass control
Packit 427e91
	    3 - treble - range 0-40 in mixer is translated to range 0-2^31 - used for treble control
Packit 427e91
	    4 - on/off - control uses range 0-1
Packit 427e91
Packit 427e91
	v-name:count
Packit 427e91
Packit 427e91
	This sets number off visible channel in mixer. This can be used only for as10k1 file format.
Packit 427e91
	
Packit 427e91
	example:
Packit 427e91
	     v-bass:1
Packit 427e91
Packit 427e91
	     for bass control which has 5 channels is in mixer visible only one
Packit 427e91
Packit 427e91
	s-name:value1#value2# ...
Packit 427e91
Packit 427e91
	This sets initial value for control.
Packit 427e91
	
Packit 427e91
	i-name:value
Packit 427e91
Packit 427e91
	Sets control index value to control
Packit 427e91
	
Packit 427e91
	r-name:outname
Packit 427e91
Packit 427e91
	This rename control with name name to control with name outname. This can be used only for native file format.
Packit 427e91
	
Packit 427e91
	example:
Packit 427e91
	    r-master:PCM Master
Packit 427e91
Packit 427e91
	    Rename control master to control PCM Master
Packit 427e91
	    
Packit 427e91
--patch_name name
Packit 427e91
    Sets name for actualy loaded patch (it is used with -a option). Dafault name comes from patch file.
Packit 427e91
Packit 427e91
--where num
Packit 427e91
    Used with -a option. Actualy loaded path will by loaded before patch with order num.
Packit 427e91
    You can get patch order with --debug 5
Packit 427e91
    
Packit 427e91
--setup
Packit 427e91
    When this option is used DSP on card is cleared.
Packit 427e91
	
Packit 427e91
--renam something=new_name
Packit 427e91
    Same string as in connection add and plus PATCH(p) - specify patch with name p or number p
Packit 427e91
    
Packit 427e91
    Examples:
Packit 427e91
    lo10k1 --renam "IN(5)=CD Left"
Packit 427e91
	- renames input 5 to CD Left
Packit 427e91
	
Packit 427e91
    lo10k1 --renam "PATCH(Volume)=Mic Volume"
Packit 427e91
	- renames patch Volume to Mic Volume
Packit 427e91
	
Packit 427e91
    lo10k1 --renam "PIN(Volume,IC)=Center IN"
Packit 427e91
	- renames patch Volume input IL to Center IN
Packit 427e91
Packit 427e91
--dump file
Packit 427e91
	This will dump dsp instructions and register to file. This file can be loaded with dl10k1 without
Packit 427e91
	ld10k1.
Packit 427e91
Packit 427e91
--host machine:port
Packit 427e91
	ld10k1 default uses named socket, this switch to use network socket.
Packit 427e91
Packit 427e91
-P or --path add effect search paths (default will lo10k1 search in effects dir)
Packit 427e91
Packit 427e91
--store file.ld10k1
Packit 427e91
	Stores DSP config to native ld10k1 file file.ld10k1
Packit 427e91
Packit 427e91
--restore file.ld10k1
Packit 427e91
	Restores DSP config from native ld10k1 file file.ld10k1
Packit 427e91
	
Packit 427e91
--save_patch file.ld10k1
Packit 427e91
	Saves patch specified with --where option to file file.ld10k1
Packit 427e91
	
Packit 427e91
--load_patch file.ld10k1
Packit 427e91
	Loads patch to dsp on position specified with --where option from file file.ld10k1
Packit 427e91
	
Packit 427e91
--wait msec
Packit 427e91
	Wait for ld10k1 for msec mili second.