source: roaraudio/doc/new-cmds @ 4496:cdb22264a272

Last change on this file since 4496:cdb22264a272 was 4496:cdb22264a272, checked in by phi, 14 years ago

added a needed flag

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