]> git.sesse.net Git - vlc/blobdiff - include/vlc_network.h
wasapi: audio capture client module (fixes #7205)
[vlc] / include / vlc_network.h
index 9506ef5af46a519225a4f39e6d0bea8f2e112615..70281a229d0acf031b71e0d22ac0a08be0712c68 100644 (file)
@@ -1,7 +1,7 @@
 /*****************************************************************************
  * vlc_network.h: interface to communicate with network plug-ins
  *****************************************************************************
- * Copyright (C) 2002-2005 the VideoLAN team
+ * Copyright (C) 2002-2005 VLC authors and VideoLAN
  * Copyright © 2006-2007 Rémi Denis-Courmont
  * $Id$
  *
  *          Laurent Aimar <fenrir@via.ecp.fr>
  *          Rémi Denis-Courmont <rem # videolan.org>
  *
- * This program is free software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or
+ * This program is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation; either version 2.1 of the License, or
  * (at your option) any later version.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- * GNU General Public License for more details.
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU Lesser General Public License for more details.
  *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
  *****************************************************************************/
 
-#if !defined( __LIBVLC__ )
-  #error You are not libvlc or one of its plugins. You cannot include this file
-#endif
+#ifndef VLC_NETWORK_H
+# define VLC_NETWORK_H
 
-#ifndef __VLC_NETWORK_H
-# define __VLC_NETWORK_H
+/**
+ * \file
+ * This file defines interface to communicate with network plug-ins
+ */
 
-#if defined( WIN32 )
-#   if defined(UNDER_CE) && defined(sockaddr_storage)
-#       undef sockaddr_storage
-#   endif
-#   if defined(UNDER_CE)
-#       define HAVE_STRUCT_ADDRINFO
-#   else
-#       define _NO_OLDNAMES 1
-#       include <io.h>
-#   endif
+#if defined( _WIN32 )
+#   define _NO_OLDNAMES 1
+#   include <io.h>
 #   include <winsock2.h>
 #   include <ws2tcpip.h>
-#   define ENETUNREACH WSAENETUNREACH
 #   define net_errno (WSAGetLastError())
-extern const char *net_strerror( int val );
+
+struct iovec
+{
+    void  *iov_base;
+    size_t iov_len;
+};
+
+struct msghdr
+{
+    void         *msg_name;
+    size_t        msg_namelen;
+    struct iovec *msg_iov;
+    size_t        msg_iovlen;
+    void         *msg_control;
+    size_t        msg_controllen;
+    int           msg_flags;
+};
+
 #   ifndef IPV6_V6ONLY
-#       define IPV6_V6ONLY FIXME_FIXME_FIXME
+#       define IPV6_V6ONLY 27
 #   endif
 #else
-#   if HAVE_SYS_SOCKET_H
-#      include <sys/socket.h>
-#   endif
-#   if HAVE_NETINET_IN_H
-#      include <netinet/in.h>
-#   endif
-#   if HAVE_ARPA_INET_H
-#      include <arpa/inet.h>
-#   elif defined( SYS_BEOS )
-#      include <net/netdb.h>
-#   endif
+#   include <sys/types.h>
+#   include <unistd.h>
+#   include <sys/socket.h>
+#   include <netinet/in.h>
 #   include <netdb.h>
 #   define net_errno errno
-#   define net_strerror strerror
 #endif
 
+#if defined( __SYMBIAN32__ )
+#   undef AF_INET6
+#   undef IN6_IS_ADDR_MULTICAST
+#   undef IPV6_V6ONLY
+#   undef IPV6_MULTICAST_HOPS
+#   undef IPV6_MULTICAST_IF
+#   undef IPV6_TCLASS
+#   undef IPV6_JOIN_GROUP
+#endif
+
+VLC_API int vlc_socket (int, int, int, bool nonblock) VLC_USED;
+
+struct sockaddr;
+VLC_API int vlc_accept( int, struct sockaddr *, socklen_t *, bool ) VLC_USED;
+
 # ifdef __cplusplus
 extern "C" {
 # endif
 
 /* Portable networking layer communication */
 int net_Socket (vlc_object_t *obj, int family, int socktype, int proto);
-int net_SetupSocket (int fd);
 
-#define net_Connect(a, b, c, d, e) __net_Connect(VLC_OBJECT(a), b, c, d, e)
-VLC_EXPORT( int, __net_Connect, (vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol) );
+VLC_API int net_Connect(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
+#define net_Connect(a, b, c, d, e) net_Connect(VLC_OBJECT(a), b, c, d, e)
 
-VLC_EXPORT( int *, net_Listen, (vlc_object_t *p_this, const char *psz_host, int i_port, int family, int socktype, int protocol) );
+VLC_API int * net_Listen(vlc_object_t *p_this, const char *psz_host, int i_port, int socktype, int protocol);
 
-#define net_ListenTCP(a, b, c) __net_ListenTCP(VLC_OBJECT(a), b, c)
-#define net_ConnectTCP(a, b, c) __net_ConnectTCP(VLC_OBJECT(a), b, c)
+#define net_ListenTCP(a, b, c) net_Listen(VLC_OBJECT(a), b, c, \
+                                          SOCK_STREAM, IPPROTO_TCP)
 
-static inline int *__net_ListenTCP (vlc_object_t *obj, const char *host, int port)
+static inline int net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
 {
-    return net_Listen (obj, host, port, AF_UNSPEC, SOCK_STREAM, IPPROTO_TCP);
+    return net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
 }
+#define net_ConnectTCP(a, b, c) net_ConnectTCP(VLC_OBJECT(a), b, c)
 
-static inline int __net_ConnectTCP (vlc_object_t *obj, const char *host, int port)
-{
-    return __net_Connect (obj, host, port, SOCK_STREAM, IPPROTO_TCP);
-}
+VLC_API int net_AcceptSingle(vlc_object_t *obj, int lfd);
 
-#define net_Accept(a, b, c) __net_Accept(VLC_OBJECT(a), b, c)
-VLC_EXPORT( int, __net_Accept, ( vlc_object_t *, int *, mtime_t ) );
+VLC_API int net_Accept( vlc_object_t *, int * );
+#define net_Accept(a, b) \
+        net_Accept(VLC_OBJECT(a), b)
 
-#define net_ConnectDgram(a, b, c, d, e ) __net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
-VLC_EXPORT( int, __net_ConnectDgram, ( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto ) );
+VLC_API int net_ConnectDgram( vlc_object_t *p_this, const char *psz_host, int i_port, int hlim, int proto );
+#define net_ConnectDgram(a, b, c, d, e ) \
+        net_ConnectDgram(VLC_OBJECT(a), b, c, d, e)
 
 static inline int net_ConnectUDP (vlc_object_t *obj, const char *host, int port, int hlim)
 {
     return net_ConnectDgram (obj, host, port, hlim, IPPROTO_UDP);
 }
 
-#define net_OpenDgram( a, b, c, d, e, g, h ) __net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g, h)
-VLC_EXPORT( int, __net_OpenDgram, ( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int family, int proto ) );
+VLC_API int net_OpenDgram( vlc_object_t *p_this, const char *psz_bind, int i_bind, const char *psz_server, int i_server, int proto );
+#define net_OpenDgram( a, b, c, d, e, g ) \
+        net_OpenDgram(VLC_OBJECT(a), b, c, d, e, g)
 
 static inline int net_ListenUDP1 (vlc_object_t *obj, const char *host, int port)
 {
-    return net_OpenDgram (obj, host, port, NULL, 0, 0, IPPROTO_UDP);
+    return net_OpenDgram (obj, host, port, NULL, 0, IPPROTO_UDP);
 }
 
-VLC_EXPORT( void, net_ListenClose, ( int *fd ) );
+VLC_API void net_ListenClose( int *fd );
 
-VLC_EXPORT( int, net_SetDSCP, ( int fd, uint8_t dscp ) );
 int net_Subscribe (vlc_object_t *obj, int fd, const struct sockaddr *addr,
                    socklen_t addrlen);
 
+VLC_API int net_SetCSCov( int fd, int sendcov, int recvcov );
+
 /* Functions to read from or write to the networking layer */
 struct virtual_socket_t
 {
     void *p_sys;
-    int (*pf_recv) ( void *, void *, int );
-    int (*pf_send) ( void *, const void *, int );
+    int (*pf_recv) ( void *, void *, size_t );
+    int (*pf_send) ( void *, const void *, size_t );
 };
 
-#define net_Read(a,b,c,d,e,f) __net_Read(VLC_OBJECT(a),b,c,d,e,f)
-VLC_EXPORT( ssize_t, __net_Read, ( vlc_object_t *p_this, int fd, const v_socket_t *, uint8_t *p_data, size_t i_data, vlc_bool_t b_retry ) );
-
-#define net_Select(a,b,c,d,e) __net_Select(VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( ssize_t, __net_Select, ( vlc_object_t *p_this, const int *pi_fd, int i_fd, uint8_t *p_data, size_t i_data ) );
+VLC_API ssize_t net_Read( vlc_object_t *p_this, int fd, const v_socket_t *, void *p_data, size_t i_data, bool b_retry );
+#define net_Read(a,b,c,d,e,f) net_Read(VLC_OBJECT(a),b,c,d,e,f)
+VLC_API ssize_t net_Write( vlc_object_t *p_this, int fd, const v_socket_t *, const void *p_data, size_t i_data );
+#define net_Write(a,b,c,d,e) net_Write(VLC_OBJECT(a),b,c,d,e)
+VLC_API char * net_Gets( vlc_object_t *p_this, int fd, const v_socket_t * );
+#define net_Gets(a,b,c) net_Gets(VLC_OBJECT(a),b,c)
 
-#define net_Write(a,b,c,d,e) __net_Write(VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( ssize_t, __net_Write, ( vlc_object_t *p_this, int fd, const v_socket_t *, const uint8_t *p_data, size_t i_data ) );
 
-#define net_Gets(a,b,c) __net_Gets(VLC_OBJECT(a),b,c)
-VLC_EXPORT( char *, __net_Gets, ( vlc_object_t *p_this, int fd, const v_socket_t * ) );
+VLC_API ssize_t net_Printf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) VLC_FORMAT( 4, 5 );
+#define net_Printf(o,fd,vs,...) net_Printf(VLC_OBJECT(o),fd,vs, __VA_ARGS__)
+VLC_API ssize_t net_vaPrintf( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args );
+#define net_vaPrintf(a,b,c,d,e) net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
 
-VLC_EXPORT( ssize_t, net_Printf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, ... ) );
-
-#define net_vaPrintf(a,b,c,d,e) __net_vaPrintf(VLC_OBJECT(a),b,c,d,e)
-VLC_EXPORT( ssize_t, __net_vaPrintf, ( vlc_object_t *p_this, int fd, const v_socket_t *, const char *psz_fmt, va_list args ) );
-
-
-#ifndef HAVE_INET_PTON
-/* only in core, so no need for C++ extern "C" */
-VLC_EXPORT (int, inet_pton, (int af, const char *src, void *dst) );
-#endif
-
-#ifndef HAVE_INET_NTOP
-#ifdef WIN32
-/* only in core, so no need for C++ extern "C" */
-VLC_EXPORT (const char *, inet_ntop, (int af, const void *src, 
-                                      char *dst, socklen_t cnt) );
-#endif
-#endif
-
-#ifndef HAVE_POLL
-enum
-{
-    POLLIN=1,
-    POLLOUT=2,
-    POLLPRI=4,
-    POLLERR=8,  // unsupported stub
-    POLLHUP=16, // unsupported stub
-    POLLNVAL=32 // unsupported stub
-};
-
-struct pollfd
-{
-    int fd;
-    int events;
-    int revents;
-};
-
-int poll (struct pollfd *fds, unsigned nfds, int timeout);
-#endif
-
-#ifdef WIN32
+#ifdef _WIN32
 /* Microsoft: same semantic, same value, different name... go figure */
 # define SHUT_RD SD_RECEIVE
 # define SHUT_WR SD_SEND
 # define SHUT_RDWR SD_BOTH
 # define net_Close( fd ) closesocket ((SOCKET)fd)
 #else
-#ifdef HAVE_UNISTD_H
-#include <unistd.h>
-#endif
+# ifdef __OS2__
+#  define SHUT_RD    0
+#  define SHUT_WR    1
+#  define SHUT_RDWR  2
+# endif
 # define net_Close( fd ) (void)close (fd)
 #endif
 
@@ -237,6 +218,19 @@ int poll (struct pollfd *fds, unsigned nfds, int timeout);
 # endif
 # define NI_MAXNUMERICHOST 64
 
+#ifndef AI_NUMERICSERV
+# define AI_NUMERICSERV 0
+#endif
+#ifndef AI_IDN
+# define AI_IDN 0 /* GNU/libc extension */
+#endif
+
+#ifdef _WIN32
+# undef gai_strerror
+# define gai_strerror gai_strerrorA
+#endif
+
+#ifdef __OS2__
 # ifndef NI_NUMERICHOST
 #  define NI_NUMERICHOST 0x01
 #  define NI_NUMERICSERV 0x02
@@ -245,30 +239,48 @@ int poll (struct pollfd *fds, unsigned nfds, int timeout);
 #  define NI_DGRAM       0x10
 # endif
 
-# ifndef HAVE_STRUCT_ADDRINFO
-struct addrinfo
+# define AI_PASSIVE     1
+# define AI_CANONNAME   2
+# define AI_NUMERICHOST 4
+
+VLC_API const char *gai_strerror( int errnum );
+
+VLC_API int  getaddrinfo ( const char *, const char *,
+                           const struct addrinfo *, struct addrinfo ** );
+VLC_API void freeaddrinfo( struct addrinfo * );
+VLC_API int  getnameinfo ( const struct sockaddr *, socklen_t,
+                           char *, int, char *, int, int );
+#endif
+
+VLC_API int vlc_getnameinfo( const struct sockaddr *, int, char *, int, int *, int );
+VLC_API int vlc_getaddrinfo (const char *, unsigned,
+                             const struct addrinfo *, struct addrinfo **);
+
+
+#ifdef __OS2__
+/* OS/2 does not support IPv6, yet. But declare these only for compilation */
+struct in6_addr
 {
-    int ai_flags;
-    int ai_family;
-    int ai_socktype;
-    int ai_protocol;
-    size_t ai_addrlen;
-    struct sockaddr *ai_addr;
-    char *ai_canonname;
-    struct addrinfo *ai_next;
+    uint8_t s6_addr[16];
 };
-#  define AI_PASSIVE     1
-#  define AI_CANONNAME   2
-#  define AI_NUMERICHOST 4
-# endif /* if !HAVE_STRUCT_ADDRINFO */
 
-VLC_EXPORT( const char *, vlc_gai_strerror, ( int ) );
-VLC_EXPORT( int, vlc_getnameinfo, ( const struct sockaddr *, int, char *, int, int *, int ) );
-VLC_EXPORT( int, vlc_getaddrinfo, ( vlc_object_t *, const char *, int, const struct addrinfo *, struct addrinfo ** ) );
-VLC_EXPORT( void, vlc_freeaddrinfo, ( struct addrinfo * ) );
+struct sockaddr_in6
+{
+    uint8_t         sin6_len;
+    uint8_t         sin6_family;
+    uint16_t        sin6_port;
+    uint32_t        sin6_flowinfo;
+    struct in6_addr sin6_addr;
+    uint32_t        sin6_scope_id;
+};
 
+# define IN6_IS_ADDR_MULTICAST(a)   (((__const uint8_t *) (a))[0] == 0xff)
 
-static inline vlc_bool_t
+static const struct in6_addr in6addr_any =
+    { { 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0 } };
+#endif
+
+static inline bool
 net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 {
     switch (addr->sa_family)
@@ -276,9 +288,9 @@ net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 #ifdef IN_MULTICAST
         case AF_INET:
         {
-            struct sockaddr_in *v4 = (struct sockaddr_in *)addr;
+            const struct sockaddr_in *v4 = (const struct sockaddr_in *)addr;
             if ((size_t)len < sizeof (*v4))
-                return VLC_FALSE;
+                return false;
             return IN_MULTICAST (ntohl (v4->sin_addr.s_addr)) != 0;
         }
 #endif
@@ -286,46 +298,18 @@ net_SockAddrIsMulticast (const struct sockaddr *addr, socklen_t len)
 #ifdef IN6_IS_ADDR_MULTICAST
         case AF_INET6:
         {
-            struct sockaddr_in6 *v6 = (struct sockaddr_in6 *)addr;
+            const struct sockaddr_in6 *v6 = (const struct sockaddr_in6 *)addr;
             if ((size_t)len < sizeof (*v6))
-                return VLC_FALSE;
+                return false;
             return IN6_IS_ADDR_MULTICAST (&v6->sin6_addr) != 0;
         }
 #endif
     }
 
-    return VLC_FALSE;
+    return false;
 }
 
 
-
-/**
- * net_AddressIsMulticast
- * @return VLC_FALSE iff the psz_addr does not specify a multicast address,
- * or the address is not a valid address.
- */
-static inline vlc_bool_t net_AddressIsMulticast( vlc_object_t *p_object, const char *psz_addr )
-{
-    struct addrinfo hints, *res;
-
-    memset (&hints, 0, sizeof (hints));
-    hints.ai_socktype = SOCK_DGRAM; /* UDP */
-    hints.ai_flags = AI_NUMERICHOST;
-
-    int i = vlc_getaddrinfo (p_object, psz_addr, 0,
-                             &hints, &res);
-    if (i)
-    {
-        msg_Err (p_object, "invalid address \"%s\" for net_AddressIsMulticast (%s)",
-                 psz_addr, vlc_gai_strerror (i));
-        return VLC_FALSE;
-    }
-
-    vlc_bool_t b = net_SockAddrIsMulticast (res->ai_addr, res->ai_addrlen);
-    vlc_freeaddrinfo (res);
-    return b;
-}
-
 static inline int net_GetSockAddress( int fd, char *address, int *port )
 {
     struct sockaddr_storage addr;
@@ -369,13 +353,16 @@ static inline void net_SetPort (struct sockaddr *addr, uint16_t port)
 #ifdef AF_INET6
         case AF_INET6:
             ((struct sockaddr_in6 *)addr)->sin6_port = port;
-           break;
+        break;
 #endif
         case AF_INET:
             ((struct sockaddr_in *)addr)->sin_port = port;
-           break;
+        break;
     }
 }
+
+VLC_API char *vlc_getProxyUrl(const char *);
+
 # ifdef __cplusplus
 }
 # endif