source: roaraudio/include/libroar/basic.h @ 5237:9dad2e237a34

Last change on this file since 5237:9dad2e237a34 was 5237:9dad2e237a34, checked in by phi, 12 years ago

Removed roar_connect_raw() and roar_connect().

File size: 5.0 KB
Line 
1//basic.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2011
5 *
6 *  This file is part of libroar a part of RoarAudio,
7 *  a cross-platform sound system for both, home and professional use.
8 *  See README for details.
9 *
10 *  This file is free software; you can redistribute it and/or modify
11 *  it under the terms of the GNU General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  libroar is distributed in the hope that it will be useful,
15 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
16 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 *  GNU General Public License for more details.
18 *
19 *  You should have received a copy of the GNU General Public License
20 *  along with this software; see the file COPYING.  If not, write to
21 *  the Free Software Foundation, 51 Franklin Street, Fifth Floor,
22 *  Boston, MA 02110-1301, USA.
23 *
24 *  NOTE for everyone want's to change something and send patches:
25 *  read README and HACKING! There a addition information on
26 *  the license of this document you need to read before you send
27 *  any patches.
28 *
29 *  NOTE for uses of non-GPL (LGPL,...) software using libesd, libartsc
30 *  or libpulse*:
31 *  The libs libroaresd, libroararts and libroarpulse link this lib
32 *  and are therefore GPL. Because of this it may be illigal to use
33 *  them with any software that uses libesd, libartsc or libpulse*.
34 */
35
36#ifndef _LIBROARBASIC_H_
37#define _LIBROARBASIC_H_
38
39#include "libroar.h"
40
41#define LIBROAR_BUFFER_SMALL   80
42#define LIBROAR_BUFFER_MSGDATA LIBROAR_BUFFER_SMALL
43#define _ROAR_MESSAGE_VERSION 0
44
45#if ROAR_MAX_CHANNELS > (LIBROAR_BUFFER_SMALL - 10)
46#error ROAR_MAX_CHANNELS too large change ROAR_MAX_CHANNELS or LIBROAR_BUFFER_SMALL
47#endif
48
49#define ROAR_CON_FLAGS_NONE        0x00
50#define ROAR_CON_FLAGS_FH          0x01 /* obsoleted */
51#define ROAR_CON_FLAGS_VIO         0x02 /* mandatory */
52#define ROAR_CON_FLAGS_ISCLIENT    0x04
53#define ROAR_CON_FLAGS_SUPPORT_V2  0x08 /* mandatory if con.version == 2 */
54#define ROAR_CON_FLAGS_SUPPORT_EF  0x10 /* Both peers support error frames */
55
56struct roar_message {
57 int cmd;
58 unsigned int stream;
59 uint32_t pos;
60 int datalen;
61 char data[LIBROAR_BUFFER_MSGDATA];
62 int16_t seq;
63 int32_t flags;
64 int32_t crc;
65 int version;
66 uint64_t pos64;
67};
68
69struct roar_connection {
70 size_t refc;
71 uint32_t flags;
72 int version;
73 struct roar_vio_calls viocon;
74 struct roar_error_frame errorframe;
75 void * cb_userdata;
76 void (*cb)(struct roar_connection * con, struct roar_message * mes, void * data, void * userdata);
77};
78
79
80int roar_connect_raw  (const char * server, int flags, uint_least32_t timeout);
81
82int roar_connect      (struct roar_connection * con, const char * server, int flags, uint_least32_t timeout);
83int roar_connect_fh   (struct roar_connection * con, int fh);
84int roar_get_connection_fh  (struct roar_connection * con);
85struct roar_vio_calls * roar_get_connection_vio2 (struct roar_connection * con);
86int roar_disconnect   (struct roar_connection * con);
87
88int roar_set_connection_callback(struct roar_connection * con,
89                                 void (*cb)(struct roar_connection * con,
90                                            struct roar_message    * mes,
91                                            void                   * data,
92                                            void                   * userdata),
93                                 void * userdata);
94
95int roar_sync         (struct roar_connection * con);
96int roar_wait_msg     (struct roar_connection * con, int16_t seq, int16_t seqmask);
97
98int roar_noop         (struct roar_connection * con);
99
100int roar_identify     (struct roar_connection * con, const char * name);
101
102int roar_send_message (struct roar_connection * con, struct roar_message * mes, char *  data);
103int roar_recv_message (struct roar_connection * con, struct roar_message * mes, char ** data);
104int roar_req          (struct roar_connection * con, struct roar_message * mes, char ** data);
105int roar_recv_message2 (struct roar_connection * con, struct roar_message * mes, char ** data,
106                        struct roar_error_frame * errorframe);
107int roar_req2          (struct roar_connection * con, struct roar_message * mes, char ** data,
108                        struct roar_error_frame * errorframe);
109#define roar_req3(con,mes,data) roar_req2((con), (mes), (data), roar_err_errorframe())
110
111int roar_vsend_message(struct roar_vio_calls  * vio, struct roar_message * mes, char *  data);
112int roar_vrecv_message(struct roar_vio_calls  * vio, struct roar_message * mes, char ** data);
113int roar_vreq         (struct roar_vio_calls  * vio, struct roar_message * mes, char ** data);
114int roar_vrecv_message2(struct roar_vio_calls  * vio, struct roar_message * mes, char ** data,
115                        struct roar_error_frame * errorframe);
116int roar_vreq2         (struct roar_vio_calls  * vio, struct roar_message * mes, char ** data,
117                        struct roar_error_frame * errorframe);
118
119int roar_debug_audio_info_print (struct roar_audio_info * info) _LIBROAR_ATTR_DEPRECATED;
120
121#endif
122
123//ll
Note: See TracBrowser for help on using the repository browser.