source: roaraudio/doc/new-cmds @ 4106:bdd9f733942f

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

some changes

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