source: roaraudio/include/roaraudio.h @ 5334:db2143126930

Last change on this file since 5334:db2143126930 was 5334:db2143126930, checked in by phi, 12 years ago

added header for license stuff

File size: 9.0 KB
Line 
1//roaraudio.h:
2
3/*
4 *      Copyright (C) Philipp 'ph3-der-loewe' Schafft - 2008-2011
5 *
6 *  This file is 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 Lesser General Public License version 3
12 *  as published by the Free Software Foundation.
13 *
14 *  RoarAudio 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 Lesser General Public License for more details.
18 *
19 *  You should have received a copy of the GNU Lesser 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: Even though this file is LGPLed it (may) include GPLed files
25 *  so the license of this file is/may therefore downgraded to GPL.
26 *  See HACKING for details.
27 */
28
29#ifndef _ROARAUDIO_H_
30#define _ROARAUDIO_H_
31
32#define  _ROAR_MKVERSION(a,b,c) (((uint32_t)(a) << 16) + ((uint32_t)(b) << 8) + (uint32_t)(c))
33
34#include <roaraudio/config.h>
35#include <roaraudio/compilerhacks.h>
36#include <roaraudio/targethacks.h>
37#include <roaraudio/muconthacks.h>
38#include <roaraudio/win32hacks.h> // we include this at the beginning of the file
39                                  // so we can define well known standard types known to everyone
40                                  // and everywhere but win32 here
41
42#define ROAR_VERSION _ROAR_MKVERSION(ROAR_VERSION_MAJOR, ROAR_VERSION_MINOR, ROAR_VERSION_REV)
43
44#if defined(DEBUG) && !defined(ROAR_SUPPORT_TRAP)
45#define ROAR_SUPPORT_TRAP
46#endif
47
48// consts we need to set depending on the OS and features:
49#if defined(ROAR_NEED_GNU_SOURCE) && !defined(_GNU_SOURCE)
50#define _GNU_SOURCE
51#endif
52
53#if defined(ROAR_NEED_BSD_VISIBLE) && !defined(__BSD_VISIBLE)
54#define __BSD_VISIBLE 1
55#endif
56
57#ifdef ROAR_HAVE_H_STDINT
58#include <stdint.h>
59#endif
60
61#include <stdlib.h>
62
63#ifdef ROAR_HAVE_H_UNISTD
64#include <unistd.h>
65#endif
66
67#include <stdio.h>
68#include <string.h>
69#include <errno.h>
70
71#ifdef ROAR_HAVE_H_SYS_TYPES
72#include <sys/types.h>
73#endif
74
75#include <limits.h>
76#if !defined(ROAR_TARGET_WIN32) && !defined(ROAR_TARGET_MICROCONTROLLER)
77#include <sys/mman.h>
78#endif
79
80// TODO: can we move the next block into roard specific includes?
81#if !defined(ROAR_TARGET_WIN32) && !defined(ROAR_TARGET_MICROCONTROLLER)
82#include <grp.h>
83#include <pwd.h>
84#endif
85
86#ifdef ROAR_HAVE_H_SYS_STAT
87#include <sys/stat.h>
88#endif
89
90#ifdef ROAR_TARGET_WIN32
91#include <winsock2.h>
92#else /* ROAR_TARGET_WIN32 */
93#ifdef ROAR_HAVE_BSDSOCKETS
94
95#if defined(ROAR_HAVE_IPV4) || defined(ROAR_HAVE_IPV6)
96#include <arpa/inet.h>
97#endif
98
99#ifdef ROAR_HAVE_H_SYS_SOCKET
100#include <sys/socket.h>
101#endif
102
103#ifdef ROAR_HAVE_IPV4
104#include <netinet/in.h>
105#include <netinet/tcp.h>
106#endif
107#ifdef ROAR_HAVE_UNIX
108#include <sys/un.h>
109#endif
110
111#endif /* ROAR_HAVE_BSDSOCKETS */
112#endif /* ROAR_TARGET_WIN32 */
113
114#ifdef __NetBSD__
115#include <netinet/in_systm.h>
116#endif
117
118#if !defined(ROAR_TARGET_WIN32) && !defined(ROAR_TARGET_MICROCONTROLLER)
119#include <netdb.h>
120#endif
121
122// NOTE: we need this macro in some of our header files.
123// TODO: This is oubslute, we will remove it soon.
124#if INT_MAX >= 32767
125#define roar_intm16  int
126#define roar_uintm16 unsigned int
127#else
128#define roar_intm16  int16_t
129#define roar_uintm16 uint16_t
130#endif
131
132// this is to avoid warning messages on platforms
133// where sizeof(void*) == 8 and szeof(int) == 4
134#ifdef __LP64__
135#define ROAR_INSTINT long int
136#else
137#define ROAR_INSTINT int
138#endif
139
140#ifndef __BEGIN_DECLS
141#ifdef __cplusplus
142# define __BEGIN_DECLS extern "C" {
143# define __END_DECLS }
144#else
145# define __BEGIN_DECLS
146# define __END_DECLS
147#endif
148#endif
149
150__BEGIN_DECLS
151
152#include <roaraudio/license.h>
153#include <roaraudio/proto.h>
154#include <roaraudio/caps.h>
155#include <roaraudio/error.h>
156#include <roaraudio/audio.h>
157#include <roaraudio/stream.h>
158#include <roaraudio/client.h>
159#include <roaraudio/sample.h>
160#include <roaraudio/beep.h>
161#include <roaraudio/meta.h>
162#include <roaraudio/genre.h>
163#include <roaraudio/acl.h>
164#include <roaraudio/misc.h>
165#include <roaraudio/byteorder.h>
166#include <roaraudio/socket.h>
167#include <roaraudio/ltm.h>
168#include <roaraudio/notify.h>
169
170#include <libroar/libroar.h>
171
172// Some settings for roard:
173#ifndef ROAR_ROARD_BITS
174#define ROAR_ROARD_BITS 32
175#endif
176
177// Some glocal network defaults:
178#ifndef ROAR_NET_INET4_LOCALHOST
179#define ROAR_NET_INET4_LOCALHOST "localhost"
180#endif
181#ifndef ROAR_NET_INET4_ANYHOST
182#define ROAR_NET_INET4_ANYHOST   "0.0.0.0"
183#endif
184
185#ifndef ROAR_NET_INET6_LOCALHOST
186#define ROAR_NET_INET6_LOCALHOST "ipv6-localhost"
187#endif
188#ifndef ROAR_NET_INET6_ANYHOST
189#define ROAR_NET_INET6_ANYHOST   "::"
190#endif
191
192// IP:
193#define ROAR_DEFAULT_PORT        16002
194
195// IPv4
196#define ROAR_DEFAULT_INET4_PORT  ROAR_DEFAULT_PORT
197#define ROAR_DEFAULT_INET4_HOST  ROAR_NET_INET4_LOCALHOST
198// aliases:
199#define ROAR_DEFAULT_HOST        ROAR_DEFAULT_INET4_HOST
200
201// IPv6:
202#define ROAR_DEFAULT_INET6_PORT  ROAR_DEFAULT_PORT
203#define ROAR_DEFAULT_INET6_HOST  ROAR_NET_INET6_LOCALHOST
204
205// UNIX Domain Sockets
206#define ROAR_DEFAULT_SOCK_GLOBAL "/tmp/roar"
207#define ROAR_DEFAULT_SOCK_USER   ".roar"
208
209// DECnet
210#define ROAR_DEFAULT_OBJECT      "roar"
211#define ROAR_DEFAULT_NUM         0
212#define ROAR_DEFAULT_LISTEN_OBJECT "::" ROAR_DEFAULT_OBJECT
213
214// now handled by configure:
215//#define ROAR_DEFAULT_SOCKGRP     "audio"
216
217
218// defines for emulations:
219// ESD:
220#define ROAR_DEFAULT_ESD_GSOCK   "/tmp/.esd/socket"
221#define ROAR_DEFAULT_ESD_PORT    16001
222// RSound:
223#define ROAR_DEFAULT_RSOUND_GSOCK  "/tmp/rsound"
224#define ROAR_DEFAULT_RSOUND_PORT   12345
225#define ROAR_DEFAULT_RSOUND_OBJECT "::rsound"
226// PulseAudio:
227#define ROAR_DEFAULT_PA_PORT     4712
228// RPlay:
229#define ROAR_DEFAULT_RPLAY_PORT  5556
230// Gopher:
231#define ROAR_DEFAULT_GOPHER_PORT 70
232// WWW/HTTP:
233#define ROAR_DEFAULT_HTTP_PORT   80
234
235#if defined(ROAR_HAVE_LIBWSOCK32) && defined(ROAR_HAVE_LIBWS2_32)
236#define ROAR_LIBS_WIN32          " -lwsock32 -lws2_32"
237#else
238#define ROAR_LIBS_WIN32          ""
239#endif
240
241#ifdef ROAR_HAVE_LIBSOCKET
242#define ROAR_LIBS_LIBSOCKET      " -lsocket"
243#else
244#define ROAR_LIBS_LIBSOCKET      ""
245#endif
246
247#ifdef ROAR_HAVE_LIBSENDFILE
248#define ROAR_LIBS_LIBSENDFILE    " -lsendfile"
249#else
250#define ROAR_LIBS_LIBSENDFILE    ""
251#endif
252
253#define ROAR_LIBS_NET_LIBS       ROAR_LIBS_LIBSOCKET ROAR_LIBS_WIN32
254
255#define ROAR_LIBS                "-lroar"       ROAR_LIBS_LIBSENDFILE ROAR_LIBS_NET_LIBS
256#define ROAR_LIBS_DSP            "-lroardsp "   ROAR_LIBS
257#define ROAR_LIBS_MIDI           "-lroarmidi "  ROAR_LIBS_DSP
258#define ROAR_LIBS_LIGHT          "-lroarlight " ROAR_LIBS
259#define ROAR_LIBS_EIO            "-lroareio "   ROAR_LIBS
260#define ROAR_CFLAGS              ""
261
262// comp libs:
263#define ROAR_LIBS_C_ESD          "-lroaresd "   ROAR_LIBS
264#define ROAR_LIBS_C_ARTSC        "-lroarartsc " ROAR_LIBS
265#define ROAR_LIBS_C_PULSE        "-lroarpulse " ROAR_LIBS
266#define ROAR_LIBS_C_PULSE_SIMPLE "-lroarpulse-simple " ROAR_LIBS_C_PULSE
267#define ROAR_LIBS_C_SNDIO        "-lroarsndio " ROAR_LIBS
268#define ROAR_LIBS_C_YIFF         "-lroaryiff "  ROAR_LIBS
269
270//some basic macros:
271#define ROAR_STDIN  0
272#define ROAR_STDOUT 1
273#define ROAR_STDERR 2
274
275#define ROAR_DEBUG_OUTFH stderr
276
277#ifndef ROAR_DBG_PREFIX
278#define ROAR_DBG_PREFIX "roaraudio"
279#endif
280
281#define ROAR_DBG_FULLPREFIX "(" ROAR_DBG_PREFIX ": " __FILE__ ":%i): "
282
283// some default info levels:
284#define ROAR_DBG_INFO_NONE             0
285#define ROAR_DBG_INFO_NOTICE           1
286#define ROAR_DBG_INFO_INFO             2
287#define ROAR_DBG_INFO_VERBOSE          3
288
289#if !defined(__GNUC__)
290 #define ROAR_DBG(format, ...)
291 #define ROAR_ERR(format, ...)
292 #define ROAR_WARN(format, ...)
293 #define ROAR_INFO(format, level, ...)
294#elif __GNUC__ < 3
295 #define ROAR_DBG(format, args...)
296 #define ROAR_ERR(format, args...)
297 #define ROAR_WARN(format, args...)
298 #define ROAR_INFO(format, level, args...)
299#else
300
301#ifdef DEBUG
302 #define ROAR_DBG(format, args...)  roar_debug_msg(ROAR_DEBUG_TYPE_DEBUG, __LINE__, __FILE__, ROAR_DBG_PREFIX, format, ## args)
303#else
304 #define ROAR_DBG(format, args...)
305#endif
306
307#define ROAR_ERR(format, args...)  roar_debug_msg(ROAR_DEBUG_TYPE_ERROR, __LINE__, __FILE__, ROAR_DBG_PREFIX, format, ## args)
308#define ROAR_WARN(format, args...) roar_debug_msg(ROAR_DEBUG_TYPE_WARNING, __LINE__, __FILE__, ROAR_DBG_PREFIX, format, ## args)
309
310// INFO function:
311#ifdef DEBUG
312 #define ROAR_INFO(format, level, args...) roar_debug_msg(ROAR_DEBUG_TYPE_INFO, __LINE__, __FILE__, ROAR_DBG_PREFIX, format, ## args)
313#elif defined(ROAR_DBG_INFOVAR)
314 #define ROAR_INFO(format, level, args...) if ( (ROAR_DBG_INFOVAR) >= (level) ) roar_debug_msg(ROAR_DEBUG_TYPE_INFO, __LINE__, __FILE__, ROAR_DBG_PREFIX, format, ## args)
315#else
316 #define ROAR_INFO(format, level, args...)
317#endif
318
319#endif
320
321#ifdef ROAR_HAVE_SAFE_OVERFLOW
322#define ROAR_MATH_OVERFLOW_ADD(a, b) ((a)+(b))
323#else
324#define ROAR_MATH_OVERFLOW_ADD(a, b) ((4294967295U - (a)) + 1 + (b))
325#endif
326
327#ifdef ROAR_HAVE_STRCASESTR
328#define _roar_strcasestr(a,b) strcasestr((a), (b))
329#else
330#define _roar_strcasestr(a,b) NULL
331#endif
332
333__END_DECLS
334
335#endif
336
337//ll
Note: See TracBrowser for help on using the repository browser.