source: roaraudio/include/libroar/basic.h @ 5505:a39728598a5f

Last change on this file since 5505:a39728598a5f was 5467:30f989510eb4, checked in by phi, 12 years ago

make use of seq-numbers in v2 messages

File size: 5.6 KB
Line 
1//basic.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2012
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        0x00000000UL
50#define ROAR_CON_FLAGS_FH          0x00000001UL /* obsoleted */
51#define ROAR_CON_FLAGS_VIO         0x00000002UL /* mandatory */
52#define ROAR_CON_FLAGS_ISCLIENT    0x00000004UL
53#define ROAR_CON_FLAGS_SUPPORT_V2  0x00000008UL /* mandatory if con.version == 2 */
54#define ROAR_CON_FLAGS_SUPPORT_EF  0x00000010UL /* Both peers support error frames */
55#define ROAR_CON_FLAGS_FREESELF    0x00000020UL /* Free the connection object */
56
57struct roar_message {
58 int cmd;
59 unsigned int stream;
60 uint32_t pos;
61 size_t datalen;
62 char data[LIBROAR_BUFFER_MSGDATA];
63 int16_t seq;
64 int32_t flags;
65 int32_t crc;
66 int version;
67 uint64_t pos64;
68};
69
70struct roar_stds; // "caps.h" will be included later.
71
72struct roar_connection {
73 size_t refc;
74 uint32_t flags;
75 int version;
76 struct roar_vio_calls * viocon;
77 struct roar_vio_calls   viocon_store;
78 struct roar_error_frame errorframe;
79 void * cb_userdata;
80 void (*cb)(struct roar_connection * con, struct roar_message * mes, void * data, void * userdata);
81 struct roar_stds * server_stds;
82 char * server_name;
83};
84
85
86int roar_connect      (struct roar_connection * con, const char * server, int flags, uint_least32_t timeout);
87int roar_connect_none (struct roar_connection * con);
88int roar_connect_vio  (struct roar_connection * con, struct roar_vio_calls * vio);
89int roar_connect_fh   (struct roar_connection * con, int fh);
90int roar_get_connection_fh  (struct roar_connection * con);
91struct roar_vio_calls * roar_get_connection_vio2 (struct roar_connection * con);
92const char * roar_get_connection_server(struct roar_connection * con);
93int roar_connectionref(struct roar_connection * con);
94int roar_connectionunref(struct roar_connection * con);
95#define roar_disconnect(x) roar_connectionunref((x))
96
97int roar_set_connection_callback(struct roar_connection * con,
98                                 void (*cb)(struct roar_connection * con,
99                                            struct roar_message    * mes,
100                                            void                   * data,
101                                            void                   * userdata),
102                                 void * userdata);
103
104int roar_set_connection_version(struct roar_connection * con, int version);
105
106int16_t roar_message_genseq(struct roar_connection * con, int is_client);
107
108int roar_sync         (struct roar_connection * con);
109int roar_wait_msg     (struct roar_connection * con, int16_t seq, int16_t seqmask);
110
111int roar_noop         (struct roar_connection * con);
112
113int roar_identify     (struct roar_connection * con, const char * name);
114
115int roar_send_message (struct roar_connection * con, struct roar_message * mes, char *  data);
116int roar_recv_message (struct roar_connection * con, struct roar_message * mes, char ** data);
117int roar_req          (struct roar_connection * con, struct roar_message * mes, char ** data);
118int roar_recv_message2 (struct roar_connection * con, struct roar_message * mes, char ** data,
119                        struct roar_error_frame * errorframe);
120int roar_req2          (struct roar_connection * con, struct roar_message * mes, char ** data,
121                        struct roar_error_frame * errorframe);
122#define roar_req3(con,mes,data) roar_req2((con), (mes), (data), roar_err_errorframe())
123
124int roar_vsend_message(struct roar_vio_calls  * vio, struct roar_message * mes, char *  data);
125int roar_vrecv_message(struct roar_vio_calls  * vio, struct roar_message * mes, char ** data);
126int roar_vreq         (struct roar_vio_calls  * vio, struct roar_message * mes, char ** data);
127int roar_vrecv_message2(struct roar_vio_calls  * vio, struct roar_message * mes, char ** data,
128                        struct roar_error_frame * errorframe);
129int roar_vreq2         (struct roar_vio_calls  * vio, struct roar_message * mes, char ** data,
130                        struct roar_error_frame * errorframe);
131#endif
132
133//ll
Note: See TracBrowser for help on using the repository browser.