source: roaraudio/doc/new-cmds @ 4527:4b92f68e8956

Last change on this file since 4527:4b92f68e8956 was 4526:e33f746c1713, checked in by phi, 13 years ago

added quality setting for pos

File size: 7.5 KB
Line 
1#($Revision$)
2!SECTION: Commands
3+DEVCTL = 33
4 +:version (uint8)
5 +:type (uint8)
6 +:vendor (uint8)
7 +VENDOR_ROARAUDIO = 0
8 +VENDOR_BASICDEV  = 1
9 +:subtype (uint8)
10 +:flags (uint8)
11 +:ot (uint8)
12 +:(id) (uint16) #(if not UNIID or SID)
13 +:data... (vardata)
14+CAPS = 34
15 +:version (uint8)
16 +:type (uint8)
17 +:flags (uint16)
18 +CF_REQUEST   = 0x0001
19 +CT_CAPS      = 0
20 +::data... (dataarray)
21 +:::captype (TODO)
22 +:::... (TODO)
23 +CT_STANDARDS = 1
24 +::data... (dataarray)
25 +:::stdvendor (uint8)
26 +STDV_ROARAUDIO = 0
27 +STDV_PROTO     = 1
28 +STDV_RFC       = 2
29 +:::stdversion (uint8)
30 +:::standard (uint16)
31+WAIT = 35
32 +:version (TODO)
33 +:flags (TODO)
34 :(TODO)
35+NOTIFY = 36
36 +=structof(WAIT)
37+SEEK = 37
38 +:version (TODO)
39 +:flags (TODO)
40 +:destination possition (TODO)
41 +:destination possition whence (TODO)
42 +:destination possition quality (TODO)
43 +:hint pos (TODO)
44 +:hint whence (TODO)
45 +:hint quality (TODO)
46 +:seek at (TODO)
47 +:seek to (TODO)
48 +:seek whence (TODO)
49 +SF_CONT_WHILE_SEEK = 0x01
50 +SF_CONT_ON_ERROR   = 0x02
51 +SF_HINT            = 0x04
52 +SF_SEEK            = 0x08
53 +HQ_BAD       = 0
54 +HQ_BAD_NB    = 1 #(bad, not before this possition)
55 +HQ_NEAR      = 2
56 +HQ_NEAR_NB   = 3 #(Near, not before this possition)
57 +HQ_GOOD      = 4
58 +HQ_GOOD_NB   = 5 #(good, not before this possition)
59 +HQ_EXACT     = HQ_EXACT_NB #(ID 6 is skiped here)
60 +HQ_EXACT_NB  = 7
61 +WHENCE_BEGIN = 0
62 +WHENCE_CUR   = 1
63 +WHENCE_END   = 2
64+CLIENTCTL = 38
65 +:version (uint8)
66 +:subcmd (uint8)
67 +:flags (uint16)
68 +:data (vardata)
69 +CC_HASHTABLE = PARA_HASHTABLE
70 +CC_WININFO   = PARA_WININFO
71 +CC_PROPTABLE = PARA_PROPTABLE
72+LOOKUP = 39
73 +:version (uint8)
74 +:flags (uint8)
75 +:extflags (uint8)
76 +:ot (uint8)
77 +:ht (uint32) #(hash type)
78 +:hash... (vardata)
79+CONCTL = 40
80 +:version (uint8)
81 +:flags (uint8)
82 +:session (uint8)
83 +:type (uint8)
84 +:stdvendor (uint8)
85 +:stdversion (uint8)
86 +:standard (uint16)
87 +CCT_NONE       = 0 #(This is the same like a NOOP-Command)
88 +CCT_CRYPTMSG   = 1 #(This request contains zero or more crypto packages according to given standard)
89 +CCT_OPENSESS   = 2 #(This opens a crypto session)
90 +:hash (uint32)
91 +:comp (uint16)
92 +COMPT_NONE  = 0
93 +COMPT_ZLIB  = 1
94 +COMPT_GZIP  = 2
95 +COMPT_BZIP2 = 3
96 +:complevel (uint8)
97 +:compflags (uint8)
98 +:data... (dataarray)
99 +CCT_CLOSESESS  = 3 #(This closes a opend cryto session)
100 +:hashlen (uint16)
101 +:hash (dataarray(:hashlen))
102 +:data... (dataarray)
103 +CCT_SESSDATA   = 4 #(This is some kind of data used in the session)
104 +:data... (dataarray)
105*SERVER_INFO
106 +IT_SERVER   = 1
107  +:version (uint8)
108  +:reserved (uint8)
109  +:indexlen (uint16)
110  +::reserved (uint8)
111  +::type (uint8)
112  +ITST_VERSION     = 0
113  #(Format: Product/Version <VendorID/VendorName> (comments))
114  #(Example: roard/0.4 <0/RoarAudio> (Debian build))
115  +ITST_LOCATION    = 1
116  #(freeform)
117  +ITST_DESCRIPTION = 2
118  #(freeform)
119  +ITST_CONTACT     = 3
120  #(Format: first ["']nick["'] last (comment) <email>/OpenPGPkey/Phone/Room)
121  +ITST_UN_SYSNAME  = 4 #(uname -s)
122  +ITST_UN_NODENAME = 5 #(uname -n)
123  +ITST_UN_RELEASE  = 6 #(uname -r)
124  +ITST_UN_MACHINE  = 7 #(uname -m)
125  +ITST_SERIAL      = 8
126  +ITST_ADDRESS     = 9
127  +ITST_UIURL       = 10
128  +::len (uint16)
129  +:strings (dataarray)
130 +IT_COUNTERS = 2
131  +:version (uint8)
132  +:reserved (uint24)
133  +:data... (dataarray)
134  +::type (uint8)
135  +::flags (uint8)
136  +::reserved (uint16)
137  +::counter (uint32)
138  +CF_CURRENT = 0x01 #(Current value if set, sum if unset)
139  +CF_OTTYPE  = 0x02 #(Type is a OT_* type if set, or other if unset)
140 +IT_LISTEN   = 3
141  +:version (uint8)
142  +:reserved (uint24)
143  +:listensocks... (dataarray)
144  +::id (uint16)
145  +::flags (uint8)
146  +::socktype (uint8)
147  +::proto (uint16)
148  +::byteorder (uint16)
149  +::dir (uint32)
150  +::auinfo (packed-audioinfo) #(4*4*8 = 128bit)
151  +::addrlen (uint16)
152  +::addr (padded-string(:addrlen))
153  +LF_HAVEDIR = 0x01
154  +LF_HAVEAI  = 0x02
155*[GS]ET_STREAM_PARA
156 *PARA_INFO
157  +STREAMSTATE_ERROR    = 5 #(Stream is in some error condition, parent client should close or kick it)
158  +STREAMSTATE_NEEDSEEK = 6 #(like Error but stream can become usable again if you do a seek)
159 +PARA_HASHTABLE  = 6   #(GTN, UUID, ...)
160  +:htsettertype (uint32)
161  +:htsettersize (uint16)
162  +:htsetterdata (vardata)
163  +:hashtable... (dataarray)
164  +::httype (uint32)
165  +::htsize (uint16)
166  +::htfunction (uint16)
167  +::htdata (vardata)
168  +HT_NONE       = 0
169  +HT_MD5        = 1
170  +HT_SHA1       = 2
171  +HT_RIPEMD160  = 3
172  +HT_MD2        = 5
173  +HT_TIGER      = 6
174  +HT_HAVAL      = 7
175  +HT_SHA256     = 8
176  +HT_SHA384     = 9
177  +HT_SHA512     = 10
178  +HT_SHA224     = 11
179  +HT_MD4        = 301
180  +HT_CRC32      = 302 #(ISO 3309, ITU-T V.42, IEEE 802.3)
181  +HT_RFC1510    = 303 #(HT_CRC32 as modified by RFC 1510)
182  +HT_RFC2440    = 304 #(poly=0x1864CFBL, init=0xB704CEL, OpenPGP)
183  +HT_WHIRLPOOL  = 305
184  +HT_UUID       = 70000
185#(GTN is the Global Track Number as used by for example the RoarAudio PlayList Daemon (rpld))
186#(It is a creator-runtime-unique number to identify the object.)
187  +HT_GTN8       = 70001
188  +HT_GTN16      = 70002
189  +HT_GTN32      = 70004 #("Short Global Track Number")
190  +HT_GTN64      = 70008 #("Long  Global Track Number")
191  +HT_CLIENTID   = 71000 + OT_CLIENT   = 71001
192  +HT_STREAMID   = 71000 + OT_STREAM   = 71002
193  +HT_SOURCEID   = 71000 + OT_SOURCE   = 71003
194  +HT_SAMPLEID   = 71000 + OT_SAMPLE   = 71004
195  +HT_MIXERID    = 71000 + OT_MIXER    = 71005
196  +HT_BRIDGEID   = 71000 + OT_BRIDGE   = 71006
197  +HT_LISTENID   = 71000 + OT_LISTEN   = 71007
198  +HT_ACTIONID   = 71000 + OT_ACTION   = 71008
199  +HT_MSGQUEUEID = 71000 + OT_MSGQUEUE = 71009
200  +HT_MSGBUSID   = 71000 + OT_MSGBUS   = 71010
201#(Next are article and book numers. They may be ued with HF_DISK and HF_WORK)
202  +HT_GTIN8      = 72001
203  +HT_GTIN13     = 72002
204  +HT_ISBN10     = 72003
205  +HT_ISBN13     = HT_GTIN13 #(ISBN-13 and GTIN/EAN-13 are the same)
206  +HF_NONE       =  0 #(This entry does not have anything to do with the object...)
207  +HF_OBJECT     =  1 #(This is an entry for exacltly this object)
208  +HF_PARENT     =  2 #(This is the parent object)
209  +HF_LOGIC      =  3 #(This is a logic group of this object)
210  +HF_PERMANENT  =  4 #(This can be used to acces exactly this object with a premanent address)
211  +HF_DEVICE     =  5 #(The device this is on or the device itself if this is a device)
212  +HF_DISK       =  6 #(The disk this is on, if this is a disk the same as HF_DEVICE)
213  +HF_SONG       =  7 #(This identifys the Song. This may for example be used with Tantalos)
214  +HF_APP        =  8 #(The application, device or other source generating this object)
215  +HF_FILE       =  9 #(The source file for this object)
216  +HF_ARTIST     = 10 #(This identifies any kind of artist/composer/interpret, to be used with Tantalos)
217  +HF_WORK       = 11 #(This identifies any kind of work/album/compilation, to be used with Tantalos)
218 +PARA_WININFO   = 7
219  +:wsystype (uint8)
220  +:socktype (uint8)
221  +:display (uint8)
222  +:screen (uint8)
223  +:addrlen (uint16)
224  +:addr (padded-string(:addrlen))
225  +:wins (dataarray)
226  +::window (uint32)
227 +PARA_PROPTABLE = 8
228  :(TODO)
229 +PARA_LTM       = 9
230*KICK,...
231 +OT_OUTPUT   =  5
232 +OT_MIXER    =  6
233 +OT_BRIDGE   =  7
234 +OT_LISTEN   =  8
235 +OT_ACTION   =  9
236 +OT_MSGQUEUE = 10 #(Message queue, message is gone as soon as one client took it)
237 +OT_MSGBUS   = 11 #(Message bus, message is gone as soon as all listening clients got it)
238*ATTACH
239 *ATTACH_SOURCE
240  :(TODO)
241 *ATTACH_OUTPUT
242  :(TODO)
243 +ATTACH_MIXER    = 4
244  :(TODO)
245 +ATTACH_BRIDGE   = 5
246  :(TODO)
247*SET_VOL
248 +SET_VOL_MS      = 3
249 +SET_VOL_UNMAPED = 4 #(like roarctls mono/stereo...)
250!SECTIONEND
251!SECTION: Codecs
252+AUTLAW  = NEEDS_CONST
253+MUUTLAW = NEEDS_CONST
254!SECTIONEND
Note: See TracBrowser for help on using the repository browser.