source: roaraudio/doc/new-cmds @ 4104:4a8cfdb359c4

Last change on this file since 4104:4a8cfdb359c4 was 4104:4a8cfdb359c4, checked in by phi, 14 years ago

added section for codecs

File size: 6.0 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 +::dataarray (dataarray)
20 +:::captype (TODO)
21 +:::... (TODO)
22 +CT_STANDARDS = 1
23 +::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*SERVER_INFO
78 +IT_SERVER   = 1
79  :(TODO)
80 +IT_COUNTERS = 2
81  +:version (uint8)
82  +:reserved (uint24)
83  +:data... (dataarray)
84  +::type (uint8)
85  +::flags (uint8)
86  +::reserved (uint16)
87  +::counter (uint32)
88  +CF_CURRENT = 0x01 #(Current value if set, sum if unset)
89  +CF_OTTYPE  = 0x02 #(Type is a OT_* type if set, or other if unset)
90 +IT_LISTEN   = 3
91  +:version (uint8)
92  +:reserved (uint24)
93  +:listensocks... (dataarray)
94  +::id (uint16)
95  +::flags (uint8)
96  +::socktype (uint8)
97  +::proto (uint16)
98  +::byteorder (uint16)
99  +::dir (uint32)
100  +::auinfo (packed-audioinfo) #(4*4*8 = 128bit)
101  +::addrlen (uint16)
102  +::addr (padded-string(:addrlen))
103  +LF_HAVEDIR = 0x01
104  +LF_HAVEAI  = 0x02
105*[GS]ET_STREAM_PARA
106 *PARA_INFO
107  +STREAMSTATE_ERROR    = 5 #(Stream is in some error condition, parent client should close or kick it)
108  +STREAMSTATE_NEEDSEEK = 6 #(like Error but stream can become usable again if you do a seek)
109 +PARA_HASHTABLE  = 6   #(GTN, UUID, ...)
110  +:htsettertype (uint32)
111  +:htsettersize (uint16)
112  +:htsetterdata (vardata)
113  +:hashtable... (dataarray)
114  +::httype (uint32)
115  +::htsize (uint16)
116  +::htfunction (uint16)
117  +::htdata (vardata)
118  +HT_NONE       = 0
119  +HT_MD5        = 1
120  +HT_SHA1       = 2
121  +HT_RIPEMD160  = 3
122  +HT_MD2        = 5
123  +HT_TIGER      = 6
124  +HT_HAVAL      = 7
125  +HT_SHA256     = 8
126  +HT_SHA384     = 9
127  +HT_SHA512     = 10
128  +HT_SHA224     = 11
129  +HT_MD4        = 301
130  +HT_CRC32      = 302 #(ISO 3309, ITU-T V.42, IEEE 802.3)
131  +HT_RFC1510    = 303 #(HT_CRC32 as modified by RFC 1510)
132  +HT_RFC2440    = 304 #(poly=0x1864CFBL, init=0xB704CEL, OpenPGP)
133  +HT_WHIRLPOOL  = 305
134  +HT_UUID       = 70000
135#(GTN is the Global Track Number as used by for example the RoarAudio PlayList Daemon (rpld))
136#(It is a creator-runtime-unique number to identify the object.)
137  +HT_GTN8       = 70001
138  +HT_GTN16      = 70002
139  +HT_GTN32      = 70004 #("Short Global Track Number")
140  +HT_GTN64      = 70008 #("Long  Global Track Number")
141  +HT_CLIENTID   = 71000 + OT_CLIENT   = 71001
142  +HT_STREAMID   = 71000 + OT_STREAM   = 71002
143  +HT_SOURCEID   = 71000 + OT_SOURCE   = 71003
144  +HT_SAMPLEID   = 71000 + OT_SAMPLE   = 71004
145  +HT_MIXERID    = 71000 + OT_MIXER    = 71005
146  +HT_BRIDGEID   = 71000 + OT_BRIDGE   = 71006
147  +HT_LISTENID   = 71000 + OT_LISTEN   = 71007
148  +HT_ACTIONID   = 71000 + OT_ACTION   = 71008
149  +HT_MSGQUEUEID = 71000 + OT_MSGQUEUE = 71009
150  +HT_MSGBUSID   = 71000 + OT_MSGBUS   = 71010
151#(Next are article and book numers. They may be ued with HF_DISK and HF_WORK)
152  +HT_GTIN8      = 72001
153  +HT_GTIN13     = 72002
154  +HT_ISBN10     = 72003
155  +HT_ISBN13     = HT_GTIN13 #(ISBN-13 and GTIN/EAN-13 are the same)
156  +HF_NONE       =  0 #(This entry does not have anything to do with the object...)
157  +HF_OBJECT     =  1 #(This is an entry for exacltly this object)
158  +HF_PARENT     =  2 #(This is the parent object)
159  +HF_LOGIC      =  3 #(This is a logic group of this object)
160  +HF_PERMANENT  =  4 #(This can be used to acces exactly this object with a premanent address)
161  +HF_DEVICE     =  5 #(The device this is on or the device itself if this is a device)
162  +HF_DISK       =  6 #(The disk this is on, if this is a disk the same as HF_DEVICE)
163  +HF_SONG       =  7 #(This identifys the Song. This may for example be used with Tantalos)
164  +HF_APP        =  8 #(The application, device or other source generating this object)
165  +HF_FILE       =  9 #(The source file for this object)
166  +HT_ARTIST     = 10 #(This identifies any kind of artist/composer/interpret, to be used with Tantalos)
167  +HT_WORK       = 11 #(This identifies any kind of work/album/compilation, to be used with Tantalos)
168 +PARA_WININFO   = 7
169  +:wsystype (uint8)
170  +:socktype (uint8)
171  +:display (uint8)
172  +:screen (uint8)
173  +:addrlen (uint16)
174  +:addr (padded-string(:addrlen))
175  +:wins (dataarray)
176  +::window (uint32)
177 +PARA_PROPTABLE = 8
178  :(TODO)
179*KICK,...
180 +OT_OUTPUT   =  5
181 +OT_MIXER    =  6
182 +OT_BRIDGE   =  7
183 +OT_LISTEN   =  8
184 +OT_ACTION   =  9
185 +OT_MSGQUEUE = 10 #(Message queue, message is gone as soon as one client took it)
186 +OT_MSGBUS   = 11 #(Message bus, message is gone as soon as all listening clients got it)
187*ATTACH
188 *ATTACH_SOURCE
189  :(TODO)
190 *ATTACH_OUTPUT
191  :(TODO)
192 +ATTACH_MIXER    = 4
193  :(TODO)
194 +ATTACH_BRIDGE   = 5
195  :(TODO)
196*SET_VOL
197 +SET_VOL_MS      = 3
198 +SET_VOL_UNMAPED = 4 #(like roarctls mono/stereo...)
199!SECTIONEND
200!SECTION: Codecs
201+AUTLAW  = NEEDS_CONST
202+MUUTLAW = NEEDS_CONST
203!SECTIONEND
Note: See TracBrowser for help on using the repository browser.