source: roaraudio/libroar.ckport @ 4031:e6c67ed99dab

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

documented VIOs

File size: 14.2 KB
Line 
1#ckport(1) database for RoarAudio core librarys:
2!NAME: RoarAudio core librarys
3!TYPE: func
4
5!TARGET: libroar0
6# VIO:
7roar_vio_close                  ok
8
9roar_vio_read                   ok
10roar_vio_write                  ok
11
12roar_vio_lseek                  ok
13
14roar_vio_sync                   ok
15roar_vio_nonblock               ok
16roar_vio_ctl                    ok
17
18roar_vio_accept                 ok
19roar_vio_shutdown               ok
20
21roar_vio_select                 ok
22
23# VIO String functions:
24roar_vio_fgets                  ok
25roar_vio_getc                   ok
26roar_vio_printf                 ok
27roar_vio_putc                   ok
28
29# VIO other ops:
30roar_vio_copy_data              ok
31roar_vio_open_tee               wip     Does not yet work
32roar_vio_open_split             wip     Does not yet work
33
34# VIO Open functions:
35# very basic:
36roar_vio_open_pass              ok
37roar_vio_open_re                ok
38
39# basic:
40roar_vio_open_fh                maybe
41roar_vio_open_file              maybe
42
43# network:
44roar_vio_open_fh_socket         maybe
45roar_vio_open_socket            ok
46roar_vio_open_socket_listen     ok
47
48# stdio:
49roar_vio_open_stdio             maybe   Not supported by all archs
50roar_vio_to_stdio               maybe   Not supported by all archs
51
52roar_vio_stdio_read             internal
53roar_vio_stdio_write            internal
54roar_vio_stdio_lseek            internal
55roar_vio_stdio_sync             internal
56roar_vio_stdio_ctl              internal
57roar_vio_stdio_close            internal
58
59# VIO based streams:
60roar_vio_simple_stream          ok
61roar_vio_simple_new_stream_obj  ok
62
63# VIO internals:
64roar_vio_init_calls     internal
65roar_vio_set_inst       internal
66roar_vio_set_fh         legacy
67roar_vio_get_fh         legacy
68
69roar_vio_basic_read     internal
70roar_vio_basic_write    internal
71roar_vio_basic_lseek    internal
72roar_vio_basic_nonblock internal
73roar_vio_basic_sync     internal
74roar_vio_basic_ctl      internal
75roar_vio_basic_close    internal
76
77roar_vio_null_rw        internal
78roar_vio_null_sync      internal
79
80roar_vio_pass_read      internal
81roar_vio_pass_write     internal
82roar_vio_pass_lseek     internal
83roar_vio_pass_nonblock  internal
84roar_vio_pass_sync      internal
85roar_vio_pass_ctl       internal
86roar_vio_pass_close     internal
87
88roar_vio_re_read        internal
89roar_vio_re_write       internal
90roar_vio_re_lseek       internal
91
92# VIO for Winsock:
93roar_vio_winsock_read   internal
94roar_vio_winsock_write  internal
95roar_vio_winsock_nonblock       internal
96roar_vio_winsock_sync   internal
97roar_vio_winsock_ctl    internal
98roar_vio_winsock_close  internal
99
100# VIO OpenSSL BIO:
101roar_vio_open_bio       maybe   requires OpenSSL support to be compiled in
102roar_vio_to_bio         maybe   requires OpenSSL support to be compiled in
103
104roar_vio_bio_read       internal
105roar_vio_bio_write      internal
106roar_vio_bio_lseek      internal
107roar_vio_bio_nonblock   internal
108roar_vio_bio_sync       internal
109roar_vio_bio_close      internal
110
111# VIO buffer:
112roar_vio_open_buffer            wip
113roar_vio_buffer_read            internal
114roar_vio_buffer_write           internal
115roar_vio_buffer_lseek           internal
116roar_vio_buffer_nonblock        internal
117roar_vio_buffer_sync            internal
118roar_vio_buffer_ctl             internal
119roar_vio_buffer_close           internal
120
121# VIO Buffer Store:
122roar_vio_open_buffer_store      wip
123roar_vio_buffer_store_read      internel
124roar_vio_buffer_store_write     internal
125roar_vio_buffer_store_lseek     internal
126roar_vio_buffer_store_nonblock  internal
127roar_vio_buffer_store_sync      internal
128roar_vio_buffer_store_ctl       internal
129roar_vio_buffer_store_close     internal
130
131# VIO Commands:
132roar_vio_open_cmd               likely  This requires forking processes
133roar_vio_cmd_close              internal
134roar_vio_cmd_fork               internal
135roar_vio_cmd_wait               internal
136
137roar_vio_open_2popen            likely  This requires forking processes
138roar_vio_2popen_close           internal
139
140roar_vio_cmd_read               internal
141roar_vio_cmd_write              internal
142roar_vio_cmd_nonblock           internal
143roar_vio_cmd_sync               internal
144roar_vio_cmd_ctl                internal
145
146roar_vio_open_gzip              wip     Currently requires cmd vio
147roar_vio_open_gpg               wip     Currently requires cmd vio
148roar_vio_open_pgp_decrypt       wip     Currently requires cmd vio
149roar_vio_open_pgp_store         wip     Currently requires cmd vio
150roar_vio_open_pgp_encrypt_sym   wip     Currently requires cmd vio
151roar_vio_open_pgp_encrypt_pub   wip     Currently requires cmd vio
152
153# VIO DSTR:
154roar_vio_dstr_get_type          ok
155roar_vio_dstr_get_name          ok
156roar_vio_dstr_register_type     wip
157
158roar_vio_dstr_init_defaults     ok
159roar_vio_dstr_init_defaults_c   ok
160
161roar_vio_open_default           ok
162
163roar_vio_open_dstr              ok
164roar_vio_open_dstr_vio          ok
165
166roar_vio_dstr_parse_opts        internal
167roar_vio_dstr_set_defaults      internal
168roar_vio_dstr_build_chain       internal
169
170# VIO Jumbo (frames):
171roar_vio_open_jumbo             ok
172
173roar_vio_jumbo_read             internal
174roar_vio_jumbo_write            internal
175roar_vio_jumbo_lseek            internal
176roar_vio_jumbo_nonblock         internal
177roar_vio_jumbo_sync             internal
178roar_vio_jumbo_ctl              internal
179roar_vio_jumbo_close            internal
180
181# VIO Magic:
182roar_vio_open_magic             wip     Does not yet work
183roar_vio_magic_read             internal
184roar_vio_magic_write            internal
185roar_vio_magic_lseek            internal
186roar_vio_magic_nonblock         internal
187roar_vio_magic_sync             internal
188roar_vio_magic_close            internal
189
190# VIO pipe:
191roar_vio_open_pipe              wip     No support for buffer based pipes
192roar_vio_pipe_init              internal
193
194roar_vio_pipe_read              internal
195roar_vio_pipe_write             internal
196roar_vio_pipe_nonblock          internal
197roar_vio_pipe_sync              internal
198roar_vio_pipe_ctl               internal
199roar_vio_pipe_close             internal
200
201# VIO proto:
202roar_vio_proto_init_def         internal
203
204roar_vio_open_proto             likely  use DSTR interface
205
206roar_vio_proto_read             internal
207roar_vio_proto_write            internal
208roar_vio_proto_lseek            internal
209roar_vio_proto_nonblock         internal
210roar_vio_proto_sync             internal
211roar_vio_proto_ctl              internal
212roar_vio_proto_close            internal
213
214roar_vio_open_proto_http        internal
215roar_vio_open_proto_gopher      internal
216
217# VIO RTP:
218roar_vio_open_rtp               wip     Does not always work correctly
219roar_vio_rtp_read               internal
220roar_vio_rtp_write              internal
221roar_vio_rtp_lseek              internal
222roar_vio_rtp_nonblock           internal
223roar_vio_rtp_sync               internal
224roar_vio_rtp_ctl                internal
225roar_vio_rtp_close              internal
226
227# VIO Socket:
228roar_vio_open_def_socket        internal        use DSTR interface
229roar_vio_socket_init_socket_def internal
230roar_vio_socket_init_dstr_def   internal
231
232roar_vio_socket_conv_def        internal
233
234roar_vio_socket_get_port        internal
235
236roar_vio_socket_init_unix_def           internal
237
238roar_vio_socket_init_decnetnode_def     internal
239roar_vio_socket_init_decnet_def         internal
240
241roar_vio_socket_init_inet4host_def      internal
242roar_vio_socket_init_inet4_def          internal
243roar_vio_socket_init_tcp4_def           internal
244roar_vio_socket_init_udp4_def           internal
245roar_vio_socket_init_inet6host_def      internal
246roar_vio_socket_init_inet6_def          internal
247roar_vio_socket_init_tcp6_def           internal
248roar_vio_socket_init_udp6_def           internal
249
250# VIO Stack:
251roar_vio_open_stack             ok
252roar_vio_stack_add              ok
253
254roar_vio_stack_read             internal
255roar_vio_stack_write            internal
256roar_vio_stack_lseek            internal
257roar_vio_stack_nonblock         internal
258roar_vio_stack_sync             internal
259roar_vio_stack_ctl              internal
260roar_vio_stack_close            internal
261
262# VIO Tantalos:
263roar_vio_open_tantalos          ok
264
265
266# Buffer:
267roar_buffer_add                 ok
268roar_buffer_delete              ok
269roar_buffer_duplicate           ok
270roar_buffer_free                ok
271roar_buffer_get_data            ok
272roar_buffer_get_flag            ok
273roar_buffer_get_len             ok
274roar_buffer_get_meta            ok
275roar_buffer_get_meta_i32        ok
276roar_buffer_get_next            ok
277roar_buffer_new                 ok
278roar_buffer_new_data            ok
279roar_buffer_new_no_ma           ok
280roar_buffer_ring_new            ok
281roar_buffer_ring_read           ok
282roar_buffer_ring_stats          ok
283roar_buffer_ring_write          ok
284roar_buffer_set_flag            ok
285roar_buffer_set_len             ok
286roar_buffer_set_meta            ok
287roar_buffer_set_meta_i32        ok
288roar_buffer_set_offset          ok
289roar_buffer_shift_out           ok
290
291# Some internal functions:
292roar_debug_msg                  internal
293roar_debug_message_print        internal
294roar_debug_audio_info_print     internal
295
296# Connection handling:
297roar_connect_raw                internal
298roar_connect                    ok
299roar_connect_fh                 likely
300roar_get_connection_fh          critical
301roar_get_connection_vio         legacy
302roar_get_connection_vio2        ok
303roar_disconnect                 ok
304#roar_set_connection_callback
305roar_sync                       ok
306roar_wait_msg                   wip
307#roar_wait_msg
308roar_noop                       ok
309roar_identify                   internal
310
311# Messages:
312#roar_send_message
313#roar_recv_message
314#roar_req
315#roar_vsend_message
316#roar_vrecv_message
317#roar_vreq
318
319# Client handling:
320roar_client_new                 ok
321roar_client_set_fh              maybe   Using FHs directly may not work on all systems
322roar_client_set_proto           ok
323roar_client_pass                ok
324
325# Streams:
326roar_stream_connect             ok
327roar_stream_new                 ok
328roar_stream_set_rel_id          ok
329roar_stream_get_rel_id          ok
330roar_stream_new_by_id           ok
331roar_stream_new_empty           ok
332roar_stream_set_id              ok
333roar_stream_get_id              ok
334roar_stream_set_fh              likely
335roar_stream_get_fh              likely
336roar_stream_set_dir             ok
337roar_stream_get_dir             ok
338
339roar_stream_exec                ok
340roar_stream_connect_to          maybe
341roar_stream_connect_to_ask      internal
342roar_stream_passfh              likely
343
344roar_stream_attach_simple       ok
345roar_stream_add_data            likely  does not work most of the time
346
347#roar_stream_send_data
348
349roar_stream_get_info            ok
350roar_stream_get_name            ok
351
352#roar_stream_get_chanmap
353#roar_stream_set_chanmap
354
355roar_stream_set_flags           ok
356roar_stream_set_role            ok
357
358roar_stream_s2m                 likely  mostly for internal use only
359roar_stream_m2s                 likely  mostly for internal use only
360
361# Accessing name database:
362roar_dir2str                    ok
363roar_str2dir                    ok
364roar_str2codec                  ok
365roar_codec2str                  ok
366roar_streamstate2str            ok
367roar_str2role                   ok
368roar_role2str                   ok
369roar_str2proto                  ok
370roar_proto2str                  ok
371roar_str2byteorder              ok
372roar_byteorder2str              ok
373roar_str2autht                  ok
374roar_autht2str                  ok
375roar_meta_strtype               ok
376roar_meta_inttype               ok
377roar_meta_strgenre              ok
378roar_meta_intgenre              ok
379
380# Audio info:
381roar_info2samplesize            ok
382roar_info2framesize             ok
383roar_info2bitspersec            ok
384
385roar_profile2info               ok
386roar_profiles_list              ok
387
388# Config:
389roar_libroar_set_server         ok
390roar_libroar_get_server         ok
391roar_libroar_nowarn             internal
392roar_libroar_warn               internal
393roar_libroar_get_config_ptr     fail
394roar_libroar_get_config         internal
395roar_libroar_config_codec_get   internal
396roar_libroar_config_parse       likely  Why do you want to parse additional config?
397
398# Controling the server:
399roar_get_clientid               ok
400roar_get_standby                ok
401roar_set_standby                ok
402roar_exit                       legacy  use roar_terminate
403roar_terminate                  ok
404roar_server_oinfo               legacy  depends on mixer
405
406roar_list                       ok
407
408roar_get_client                 ok
409roar_get_stream                 ok
410
411roar_kick                       ok
412
413roar_set_vol                    ok
414roar_get_vol                    ok
415
416roar_ctl_f2m                    internal
417roar_ctl_m2f                    internal
418
419roar_ctl_ia2m                   internal
420roar_ctl_m2ia                   internal
421
422roar_ctl_c2m                    likely  mostly for internal use only
423roar_ctl_m2c                    likely  mostly for internal use only
424
425# Env:
426roar_env_set                    ok
427roar_env_get_home               likely  use roar_env_get_home_r
428roar_env_get_home_r             ok
429roar_env_render_path_r          maybe   Why do you want to use this?
430
431# File handlung:
432roar_file_codecdetect           ok
433roar_file_send_raw              legacy  use roar_vio_copy_data
434roar_file_play                  ok
435roar_file_play_full             ok
436roar_file_map                   likely  not supported on all systems
437roar_file_unmap                 likely  not supported on all systems
438
439roar_cdromdevice                maybe
440
441# KeyVal:
442roar_keyval_lookup              ok
443roar_keyval_split               ok
444
445# ACL:
446roar_acl_rule_chk_connect       wip
447
448# Auth:
449roar_auth                       wip
450
451# Beep:
452roar_beep                       ok
453
454# CDRum / CDDA:
455roar_cdrom_open                 wip
456roar_cdrom_close                wip
457roar_cdrom_stop                 wip
458roar_cdrom_play                 wip
459
460# Debug:
461roar_debug_warn_sysio_real      internal
462roar_debug_warn_obsolete_real   internal
463
464roar_debug_set_stderr_fh        likely  use roar_debug_set_stderr_vio
465roar_debug_set_stderr_vio       ok
466roar_debug_set_stderr_mode      ok
467
468roar_debug_get_stderr           ok
469
470roar_debug_msg_simple           legacy
471roar_debug_msg                  ok
472
473# Error handling:
474roar_err_int                    wip
475roar_err_buildmsg               wip
476roar_err_parsemsg               wip
477
478# MemMgr:
479roar_mm_calloc                  wip
480roar_mm_malloc                  wip
481roar_mm_free                    wip
482roar_mm_realloc                 wip
483roar_mm_strdup                  wip
484
485# Meta Data:
486roar_stream_meta_set            ok
487roar_stream_meta_get            ok
488roar_stream_meta_list           ok
489roar_meta_free                  ok
490roar_meta_parse_audioinfo       ok
491
492# NNode:
493roar_nnode_new                  ok
494roar_nnode_new_from_af          ok
495roar_nnode_new_from_sockaddr    maybe   not supported on all systems
496roar_nnode_new_from_fh          likely  not supported on all systems
497
498roar_nnode_free                 ok
499
500roar_nnode_get_socktype         ok
501roar_nnode_to_str               ok
502roar_nnode_from_blob            internal        mostly for internal use
503roar_nnode_to_blob              internal        mostly for internal use
504roar_nnode_cmp                  ok
505
506# Password API:
507roar_pinentry_open              internal
508roar_pinentry_simple_open       internal
509roar_pinentry_close             internal
510roar_pinentry_send              internal
511roar_pinentry_recv              internal
512roar_pinentry_req               internal
513roar_pinentry_set_desc          internal
514roar_pinentry_set_prompt        internal
515roar_pinentry_set_yes           internal
516roar_pinentry_set_no            internal
517roar_pinentry_set               internal
518roar_pinentry_getpin            internal
519roar_pinentry_confirm           internal
520
521roar_sshaskpass_getpass         internal
522
523# RoarDL:
524roar_dl_open                    ok
525roar_dl_close                   ok
526roar_dl_getsym                  ok
527roar_dl_ra_init                 ok
528roar_dl_errstr                  ok
529
530# RoarSLP:
531roar_slp_url_callback           internal
532roar_slp_search                 internal
533roar_slp_cookie_init            internal
534# Those may be more public in futur:
535roar_slp_find_roard             internal
536roar_slp_find_roard_r           internal
537
538# RoarX11:
539roar_x11_connect                ok
540roar_x11_connect_display        maybe   not supported on all systems
541roar_x11_disconnect             ok
542roar_x11_flush                  ok
543roar_x11_set_prop               ok
544roar_x11_delete_prop            ok
545roar_x11_get_prop               ok
546
547# (old) Simple API:
548roar_simple_connect             ok
549
550roar_simple_stream              legacy  use VIO based streams
551roar_simple_stream_obj          legacy  use VIO based streams
552roar_simple_new_stream_attachexeced_obj internal
553
554roar_simple_new_stream          legacy
555roar_simple_new_stream_obj      legacy
556
557roar_simple_play_file           ok
558
559roar_simple_play                legacy
560roar_simple_monitor             legacy
561roar_simple_record              legacy
562roar_simple_filter              legacy
563
564roar_simple_connect_virtual     ok
565
566roar_simple_close               legacy  use roar_vio_close
567
568roar_simple_get_standby         legacy  use roar_get_standby
569
570# (old) Socket API:
571roar_socket_listen              legacy  use roar_vio_open_socket_listen
572roar_socket_connect             legacy  use roar_vio_open_socket
573
574roar_socket_new_tcp             internal
575roar_socket_new_udp             internal
576roar_socket_new_tcp6            internal
577roar_socket_new_udp6            internal
578roar_socket_new_unix            internal
579roar_socket_new_decnet_seqpacket        internal
580roar_socket_new_decnet_stream   internal
581roar_socket_new_ipxspx          internal
582roar_socket_new_ipx             internal
583
584roar_socket_open                legacy  use roar_vio_open_socket or roar_vio_open_socket_listen
585roar_socket_open_fork           internal
586roar_socket_open_file           internal
587roar_socket_open_proxy          internal
588roar_socket_listen_decnet       internal
589roar_socket_get_local_nodename  internal
590roar_socket_nonblock            internal        use roar_vio_nonblock
591roar_socket_decnet_set_timeout  internal
592roar_socket_recvbuf             internal
593roar_socket_dup_udp_local_end   internal
594
595roar_socket_send_fh             internal
596roar_socket_recv_fh             internal
597
598roar_socket_open_socks4         internal
599roar_socket_open_socks4a        internal
600roar_socket_open_socks4d        internal
601roar_socket_open_socks4x        internal
602
603roar_socket_open_http           internal
604roar_socket_open_ssh            internal
605
606# Stack:
607roar_stack_new                  ok
608roar_stack_newalloc             ok
609roar_stack_free                 ok
610roar_stack_set_free             ok
611roar_stack_set_flag             ok
612roar_stack_push                 ok
613roar_stack_pop                  ok
614roar_stack_get_cur              ok
615
616
617!TARGET: libroardsp0
618!TARGET: libroareio0
619!TARGET: libroarlight0
620!TARGET: libroarmidi0
621
622#ll
Note: See TracBrowser for help on using the repository browser.