source: roaraudio/doc/new-cmds @ 5414:2b852fd3712c

Last change on this file since 5414:2b852fd3712c was 5414:2b852fd3712c, checked in by phi, 12 years ago

Typos (Closes: #192) (pr2)

File size: 11.4 KB
Line 
1#($Revision$)
2!SECTION: Commands
3+DEVCTL = 33
4 +:version (uint8)
5 +:type (uint8)
6 +DEVCTL_TYPE_GET = 0x01
7 +DEVCTL_TYPE_SET = 0x02
8 +DEVCTL_TYPE_RUN = 0x03
9 +DEVCTL_TYPE_SYSCONF = 0x04 #(System config)
10 +DEVCTL_TYPE_SYSCONF_GET = DEVCTL_TYPE_SYSCONF + DEVCTL_TYPE_GET
11 +DEVCTL_TYPE_SYSCONF_SET = DEVCTL_TYPE_SYSCONF + DEVCTL_TYPE_SET
12 +DEVCTL_TYPE_SYSCONF_RUN = DEVCTL_TYPE_SYSCONF + DEVCTL_TYPE_RUN
13 +DEVCTL_TYPE_CONFIG  = 0x08 #(Application config)
14 +DEVCTL_TYPE_CONFIG_GET  = DEVCTL_TYPE_CONFIG  + DEVCTL_TYPE_GET
15 +DEVCTL_TYPE_CONFIG_SET  = DEVCTL_TYPE_CONFIG  + DEVCTL_TYPE_SET
16 +DEVCTL_TYPE_CONFIG_RUN  = DEVCTL_TYPE_CONFIG  + DEVCTL_TYPE_RUN
17 +DEVCTL_TYPE_OPMODE  = 0x0c #(Mode of operation)
18 +DEVCTL_TYPE_OPMODE_GET  = DEVCTL_TYPE_OPMODE  + DEVCTL_TYPE_GET
19 +DEVCTL_TYPE_OPMODE_SET  = DEVCTL_TYPE_OPMODE  + DEVCTL_TYPE_SET
20 +DEVCTL_TYPE_OPMODE_RUN  = DEVCTL_TYPE_OPMODE  + DEVCTL_TYPE_RUN
21 +DEVCTL_TYPE_UI      = 0x10 #(User Interface)
22 +DEVCTL_TYPE_UI_GET  = DEVCTL_TYPE_UI + DEVCTL_TYPE_GET
23 +DEVCTL_TYPE_UI_SET  = DEVCTL_TYPE_UI + DEVCTL_TYPE_SET
24 +DEVCTL_TYPE_UI_RUN  = DEVCTL_TYPE_UI + DEVCTL_TYPE_RUN
25 +DEVCTL_TYPE_POWER   = 0x14 #(Power management)
26 +DEVCTL_TYPE_POWER_GET   = DEVCTL_TYPE_POWER + DEVCTL_TYPE_GET
27 +DEVCTL_TYPE_POWER_SET   = DEVCTL_TYPE_POWER + DEVCTL_TYPE_SET
28 +DEVCTL_TYPE_POWER_RUN   = DEVCTL_TYPE_POWER + DEVCTL_TYPE_RUN
29 +DEVCTL_TYPE_DATA    = 0x18 #(Runtime data)
30 +DEVCTL_TYPE_DATA_GET    = DEVCTL_TYPE_DATA  + DEVCTL_TYPE_GET
31 +DEVCTL_TYPE_DATA_SET    = DEVCTL_TYPE_DATA  + DEVCTL_TYPE_SET
32 +DEVCTL_TYPE_DATA_RUN    = DEVCTL_TYPE_DATA  + DEVCTL_TYPE_RUN
33 +DEVCTL_TYPE_USER0   = 0xf0 #(User defined commands Assigned by DeviceVendor)
34 +DEVCTL_TYPE_USER0_GET   = DEVCTL_TYPE_USER0 + DEVCTL_TYPE_GET
35 +DEVCTL_TYPE_USER0_SET   = DEVCTL_TYPE_USER0 + DEVCTL_TYPE_SET
36 +DEVCTL_TYPE_USER0_RUN   = DEVCTL_TYPE_USER0 + DEVCTL_TYPE_RUN
37 +DEVCTL_TYPE_USER1   = 0xf4 #(User defined commands Assigned by DeviceVendor)
38 +DEVCTL_TYPE_USER1_GET   = DEVCTL_TYPE_USER1 + DEVCTL_TYPE_GET
39 +DEVCTL_TYPE_USER1_SET   = DEVCTL_TYPE_USER1 + DEVCTL_TYPE_SET
40 +DEVCTL_TYPE_USER1_RUN   = DEVCTL_TYPE_USER1 + DEVCTL_TYPE_RUN
41 +DEVCTL_TYPE_USER2   = 0xf8 #(User defined commands Assigned by DeviceVendor)
42 +DEVCTL_TYPE_USER2_GET   = DEVCTL_TYPE_USER2 + DEVCTL_TYPE_GET
43 +DEVCTL_TYPE_USER2_SET   = DEVCTL_TYPE_USER2 + DEVCTL_TYPE_SET
44 +DEVCTL_TYPE_USER2_RUN   = DEVCTL_TYPE_USER2 + DEVCTL_TYPE_RUN
45 +DEVCTL_TYPE_USER3   = 0xfc #(User defined commands Assigned by DeviceVendor)
46 +DEVCTL_TYPE_USER3_GET   = DEVCTL_TYPE_USER3 + DEVCTL_TYPE_GET
47 +DEVCTL_TYPE_USER3_SET   = DEVCTL_TYPE_USER3 + DEVCTL_TYPE_SET
48 +DEVCTL_TYPE_USER3_RUN   = DEVCTL_TYPE_USER3 + DEVCTL_TYPE_RUN
49 +:vendor (uint8)
50 +VENDOR_ROARAUDIO = 0
51 +VENDOR_BASICDEV  = 1
52 +:subtype (uint8)
53 +:flags (uint8)
54 +:ot (uint8)
55 +:(id) (uint16) #(if not UNIID or SID)
56 +:data... (vardata)
57+CAPS = 34
58 +:version (uint8)
59 +:type (uint8)
60 +:flags (uint16)
61 +CF_REQUEST   = 0x0001
62 +CT_CAPS      = 0
63 +::data... (dataarray)
64 +:::captype (TODO)
65 +:::... (TODO)
66 +CT_STANDARDS = 1
67 +::data... (dataarray)
68 +:::stdvendor (uint8)
69 +STDV_ROARAUDIO = 0
70 +STDV_PROTO     = 1
71 +STDV_RFC       = 2
72 +:::standard (uint16)
73 +:::stdversion (uint8)
74+WAIT = 35
75 +:version (TODO)
76 +:flags (TODO)
77 :(TODO)
78+NOTIFY = 36
79 #(+=structof(WAIT))
80 #(Notify Types)
81 +NT_PROTO = NEEDS_CONST
82 +NT_SOCKET = NEEDS_CONST
83 +NT_SIGNAL = NEEDS_CONST
84 +NT_MSGQUEUE = NEEDS_CONST
85 +NT_FLOCK = NEEDS_CONST
86 +NT_FUTEX = NEEDS_CONST
87+SEEK = 37
88 +:version (TODO)
89 +:flags (TODO)
90 +:destination position (TODO)
91 +:destination position whence (TODO)
92 +:destination position quality (TODO)
93 +:hint pos (TODO)
94 +:hint whence (TODO)
95 +:hint quality (TODO)
96 +:seek at (TODO)
97 +:seek to (TODO)
98 +:seek whence (TODO)
99 +SF_CONT_WHILE_SEEK = 0x01
100 +SF_CONT_ON_ERROR   = 0x02
101 +SF_HINT            = 0x04
102 +SF_SEEK            = 0x08
103 +HQ_BAD       = 0
104 +HQ_BAD_NB    = 1 #(bad, not before this position)
105 +HQ_NEAR      = 2
106 +HQ_NEAR_NB   = 3 #(Near, not before this position)
107 +HQ_GOOD      = 4
108 +HQ_GOOD_NB   = 5 #(good, not before this position)
109 +HQ_EXACT     = HQ_EXACT_NB #(ID 6 is skiped here)
110 +HQ_EXACT_NB  = 7
111 +WHENCE_BEGIN = 0
112 +WHENCE_CUR   = 1
113 +WHENCE_END   = 2
114+CLIENTCTL = 38
115 +:version (uint8)
116 +:subcmd (uint8)
117 +:flags (uint16)
118 +:data (vardata)
119 +CC_HASHTABLE = PARA_HASHTABLE
120 +CC_WININFO   = PARA_WININFO
121 +CC_PROPTABLE = PARA_PROPTABLE
122+LOOKUP = 39
123 +:version (uint8)
124 +:flags (uint8)
125 +:extflags (uint8)
126 +:ot (uint8)
127 +:ht (uint32) #(hash type)
128 +:hash... (vardata)
129+CONCTL = 40
130 +:version (uint8)
131 +:flags (uint8)
132 +:session (uint8)
133 +:type (uint8)
134 +:stdvendor (uint8)
135 +:standard (uint16)
136 +:stdversion (uint8)
137 +CCT_NONE       = 0 #(This is the same like a NOOP-Command)
138 +CCT_CRYPTMSG   = 1 #(This request contains zero or more crypto packages according to given standard)
139 +CCT_OPENSESS   = 2 #(This opens a crypto session)
140 +:hash (uint32)
141 +:comp (uint16)
142 +COMPT_NONE  = 0
143 +COMPT_ZLIB  = 1
144 +COMPT_GZIP  = 2
145 +COMPT_BZIP2 = 3
146 +:complevel (uint8)
147 +:compflags (uint8)
148 +:data... (dataarray)
149 +CCT_CLOSESESS  = 3 #(This closes a opend cryto session)
150 +:hashlen (uint16)
151 +:hash (dataarray(:hashlen))
152 +:data... (dataarray)
153 +CCT_SESSDATA   = 4 #(This is some kind of data used in the session)
154 +:data... (dataarray)
155+LIST = NEEDS_CONST
156+GET_OBJ = NEEDS_CONST
157+OBJCTL = NEEDS_CONST
158*SERVER_INFO
159 +IT_SERVER   = 1
160  +:version (uint8)
161  +:reserved (uint8)
162  +:indexlen (uint16)
163  +::reserved (uint8)
164  +::type (uint8)
165  +ITST_VERSION     = 0
166  #(Format: Product/Version <VendorID/VendorName> (comments))
167  #(Example: roard/0.4 <0/RoarAudio> (Debian build))
168  +ITST_LOCATION    = 1
169  #(freeform)
170  +ITST_DESCRIPTION = 2
171  #(freeform)
172  +ITST_CONTACT     = 3
173  #(Format: first ["']nick["'] last (comment) <email>/OpenPGPkey/Phone/Room)
174  +ITST_UN_SYSNAME  = 4 #(uname -s)
175  +ITST_UN_NODENAME = 5 #(uname -n)
176  +ITST_UN_RELEASE  = 6 #(uname -r)
177  +ITST_UN_MACHINE  = 7 #(uname -m)
178  +ITST_SERIAL      = 8
179  +ITST_ADDRESS     = 9
180  +ITST_UIURL       = 10
181  +ITST_HOSTID      = 11
182  #(UNIX hostid in hex (%.8x), with leading zeros (8 or 16 hex-digits), This is returned by gethostid())
183  +ITST_LICENSE     = 12
184  #(Format: LicenseName-Version (options))
185  #(Example: GPL-3.0, LGPL-2.1, LGPL-3.0 (or later))
186  +ITST_BUILD       = 13
187  #(Manufacturing/compiling date and worker, all times in UTC)
188  #(Format: YYYY-MM-DD HH:MM:SS (worker))
189  #(Example: 2011-12-01 (build cluster 3))
190  +::len (uint16)
191  +:strings (dataarray)
192 +IT_COUNTERS = 2
193  +:version (uint8)
194  +:reserved (uint24)
195  +:data... (dataarray)
196  +::type (uint8)
197  +::flags (uint8)
198  +::reserved (uint16)
199  +::counter (uint32)
200  +CF_CURRENT = 0x01 #(Current value if set, sum if unset)
201  +CF_OTTYPE  = 0x02 #(Type is a OT_* type if set, or other if unset)
202 +IT_LISTEN   = 3
203  +:version (uint8)
204  +:reserved (uint24)
205  +:listensocks... (dataarray)
206  +::id (uint16)
207  +::flags (uint8)
208  +::socktype (uint8)
209  +::proto (uint16)
210  +::byteorder (uint16)
211  +::dir (uint32)
212  +::auinfo (packed-audioinfo) #(4*4*8 = 128bit)
213  +::addrlen (uint16)
214  +::addr (padded-string(:addrlen))
215  +LF_HAVEDIR = 0x01
216  +LF_HAVEAI  = 0x02
217*[GS]ET_STREAM_PARA
218 *PARA_INFO
219  +STREAMSTATE_ERROR    = 5 #(Stream is in some error condition, parent client should close or kick it)
220  +STREAMSTATE_NEEDSEEK = 6 #(like Error but stream can become usable again if you do a seek)
221 *PARA_FLAGS
222  +FLAG_SINGLESINK = 0x00040000
223  +TOGGLE_FLAG     = 2
224  +NOOP_FLAG       = 3
225  +PROTECT_FLAG    = 0x8000 #(flag to mark flags in changed by this protected)
226 +PARA_HASHTABLE  = 6   #(GTN, UUID, ...)
227  +:htsettertype (uint32)
228  +:htsettersize (uint16)
229  +:htsetterdata (vardata)
230  +:hashtable... (dataarray)
231  +::httype (uint32)
232  +::htsize (uint16)
233  +::htfunction (uint16)
234  +::htdata (vardata)
235  +HT_NONE       = 0
236  +HT_MD5        = 1
237  +HT_SHA1       = 2
238  +HT_RIPEMD160  = 3
239  +HT_MD2        = 5
240  +HT_TIGER      = 6
241  +HT_HAVAL      = 7
242  +HT_SHA256     = 8
243  +HT_SHA384     = 9
244  +HT_SHA512     = 10
245  +HT_SHA224     = 11
246  +HT_MD4        = 301
247  +HT_CRC32      = 302 #(ISO 3309, ITU-T V.42, IEEE 802.3)
248  +HT_RFC1510    = 303 #(HT_CRC32 as modified by RFC 1510)
249  +HT_RFC2440    = 304 #(poly=0x1864CFBL, init=0xB704CEL, OpenPGP)
250  +HT_WHIRLPOOL  = 305
251  +HT_UUID       = 70000
252#(GTN is the Global Track Number as used by for example the RoarAudio PlayList Daemon (rpld))
253#(It is a creator-runtime-unique number to identify the object.)
254  +HT_GTN8       = 70001
255  +HT_GTN16      = 70002
256  +HT_GTN32      = 70004 #("Short Global Track Number")
257  +HT_GTN64      = 70008 #("Long  Global Track Number")
258  +HT_CLIENTID   = 71000 + OT_CLIENT   = 71001
259  +HT_STREAMID   = 71000 + OT_STREAM   = 71002
260  +HT_SOURCEID   = 71000 + OT_SOURCE   = 71003
261  +HT_SAMPLEID   = 71000 + OT_SAMPLE   = 71004
262  +HT_MIXERID    = 71000 + OT_MIXER    = 71005
263  +HT_BRIDGEID   = 71000 + OT_BRIDGE   = 71006
264  +HT_LISTENID   = 71000 + OT_LISTEN   = 71007
265  +HT_ACTIONID   = 71000 + OT_ACTION   = 71008
266  +HT_MSGQUEUEID = 71000 + OT_MSGQUEUE = 71009
267  +HT_MSGBUSID   = 71000 + OT_MSGBUS   = 71010
268#(Next are article and book numers. They may be ued with HF_DISK and HF_WORK)
269  +HT_GTIN8      = 72001
270  +HT_GTIN13     = 72002
271  +HT_ISBN10     = 72003
272  +HT_ISBN13     = HT_GTIN13 #(ISBN-13 and GTIN/EAN-13 are the same)
273  +HT_ADLER32    = 73001 #(RFC1950)
274  +HF_NONE       =  0 #(This entry does not have anything to do with the object...)
275  +HF_OBJECT     =  1 #(This is an entry for exacltly this object)
276  +HF_PARENT     =  2 #(This is the parent object)
277  +HF_LOGIC      =  3 #(This is a logic group of this object)
278  +HF_PERMANENT  =  4 #(This can be used to acces exactly this object with a premanent address)
279  +HF_DEVICE     =  5 #(The device this is on or the device itself if this is a device)
280  +HF_DISK       =  6 #(The disk this is on, if this is a disk the same as HF_DEVICE)
281  +HF_SONG       =  7 #(This identifys the Song. This may for example be used with Tantalos)
282  +HF_APP        =  8 #(The application, device or other source generating this object)
283  +HF_FILE       =  9 #(The source file for this object)
284  +HF_ARTIST     = 10 #(This identifies any kind of artist/composer/interpret, to be used with Tantalos)
285  +HF_WORK       = 11 #(This identifies any kind of work/album/compilation, to be used with Tantalos)
286 +PARA_WININFO   = 7
287  +:wsystype (uint8)
288  +:socktype (uint8)
289  +:display (uint8)
290  +:screen (uint8)
291  +:addrlen (uint16)
292  +:addr (padded-string(:addrlen))
293  +:wins (dataarray)
294  +::window (uint32)
295 +PARA_PROPTABLE = 8
296  :(TODO)
297 +PARA_LTM       = 9
298 +PARA_USAGE     = 10 #(Used by RAUM)
299 +PARA_RADIO     = 11 #(Used by RDTCS)
300*KICK,...
301 +OT_OUTPUT   =  5
302 +OT_MIXER    =  6
303 +OT_BRIDGE   =  7
304 +OT_LISTEN   =  8
305 +OT_ACTION   =  9
306 +OT_MSGQUEUE = 10 #(Message queue, message is gone as soon as one client took it)
307 +OT_MSGBUS   = 11 #(Message bus, message is gone as soon as all listening clients got it)
308*ATTACH
309 *ATTACH_SOURCE
310  :(TODO)
311 *ATTACH_OUTPUT
312  :(TODO)
313 +ATTACH_MIXER    = 4
314  :(TODO)
315 +ATTACH_BRIDGE   = 5
316  :(TODO)
317*SET_VOL
318 +SET_VOL_MS       = 3
319 +SET_VOL_UNMAPPED = 4 #(like roarctls mono/stereo...)
320*AUTHCTL = GET_ACL
321*ACLCTL  = SET_ACL
322-GET_ACL #(reasignmened)
323-SET_ACL #(reasignmened)
324+SHIFT_DATA   = 40  #(get data from a stream)
325+RAUM_PICTURE = 202 #(Used by RAUM to store pictures)
326+RAUM_SYNC    = 203 #(Used by RAUM for raw seeking)
327!SECTIONEND
328!SECTION: Codecs
329+AUTLAW_LE  = 0x31
330+AUTLAW_BE  = 0x32
331+AUTLAW     = AUTLAW_BE
332+MUUTLAW_LE = 0x35
333+MUUTLAW_BE = 0x36
334+MUUTLAW    = MUUTLAW_BE
335+BRR        = 0x3c
336+OGG_OPUS   = 0x18
337+ROAR_OPUS  = 0x19
338!SECTIONEND
339!SECTION: Network
340+SOCKET_TYPE_LAT_SERVICE      = 12
341+SOCKET_TYPE_LAT_REVERSE_PORT = 13
342!SECTIONEND
Note: See TracBrowser for help on using the repository browser.