/* RetroArch - A frontend for libretro. * Copyright (C) 2010-2014 - Hans-Kristian Arntzen * Copyright (C) 2011-2017 - Daniel De Matteis * * RetroArch 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 Found- * ation, either version 3 of the License, or (at your option) any later version. * * RetroArch 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. * * You should have received a copy of the GNU General Public License along with RetroArch. * If not, see . */ /* RSound - A PCM audio client/server * Copyright (C) 2010 - Hans-Kristian Arntzen * * RSound 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 Found- * ation, either version 3 of the License, or (at your option) any later version. * * RSound 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. * * You should have received a copy of the GNU General Public License along with RSound. * If not, see . */ #include "drivers/rsound.h" #if defined(__CELLOS_LV2__) #include #include #include /* Network headers */ #include #include #define NETWORK_COMPAT_HEADERS 1 #elif defined(GEKKO) #include #else #define NETWORK_COMPAT_HEADERS 1 #endif #ifdef NETWORK_COMPAT_HEADERS #include #include #include #include #include #include #endif #include #ifdef _WIN32 #include #else #include #endif #include #include #include #include #include #include #include #include #include #include /* **************************************************************************** Naming convention. Functions for use in API are called rsd_*(), * internal function are called rsnd_*() * **************************************************************************** */ // Internal enumerations enum rsd_logtype { RSD_LOG_DEBUG = 0, RSD_LOG_WARN, RSD_LOG_ERR }; enum rsd_conn_type { RSD_CONN_TCP = 0x0000, RSD_CONN_UNIX = 0x0001, RSD_CONN_DECNET = 0x0002, RSD_CONN_PROTO = 0x100 }; // Some logging macros. #define RSD_WARN(fmt, args...) #define RSD_ERR(fmt, args...) #define RSD_DEBUG(fmt, args...) #if defined(__CELLOS_LV2__) static int init_count = 0; #define pollfd_fd(x) x.fd #define net_send(a,b,c,d) send(a,b,c,d) #define net_socket(a,b,c) socket(a,b,c) #define net_connect(a,b,c) connect(a,b,c) #define net_shutdown(a,b) shutdown(a,b) #define net_socketclose(x) socketclose(x) #define net_recv(a,b,c,d) recv(a,b,c,d) #elif defined(GEKKO) #define SHUT_RD 0 #define socketpoll(x, y, z) net_poll(x, y, z) #define pollfd pollsd #define pollfd_fd(x) x.socket #define gethostbyname net_gethostbyname #define getsockopt net_getsockopt #define setsockopt net_setsockopt #define net_send(a,b,c,d) net_send(a,b,c,d) #define net_socket(a,b,c) net_socket(a,b,c) #define net_connect(a,b,c) net_connect(a,b,c) #define net_shutdown(a,b) net_shutdown(a,b) #define net_socketclose(x) net_close(x) #define net_recv(a,b,c,d) net_recv(a,b,c,d) #else #define pollfd_fd(x) x.fd #define net_socket(a,b,c) socket(a,b,c) #define socketpoll(x, y, z) poll(x, y, z) #define net_send(a,b,c,d) send(a,b,c,d) #define net_connect(a,b,c) connect(a,b,c) #define net_shutdown(a,b) shutdown(a,b) #define net_socketclose(x) close(x) #define net_recv(a,b,c,d) recv(a,b,c,d) #endif static ssize_t rsnd_send_chunk(int socket, const void *buf, size_t size, int blocking); static ssize_t rsnd_recv_chunk(int socket, void *buf, size_t size, int blocking); static int rsnd_start_thread(rsound_t *rd); static int rsnd_stop_thread(rsound_t *rd); static size_t rsnd_get_delay(rsound_t *rd); static size_t rsnd_get_ptr(rsound_t *rd); static int rsnd_reset(rsound_t *rd); // Protocol functions static int rsnd_send_identity_info(rsound_t *rd); static int rsnd_close_ctl(rsound_t *rd); static int rsnd_send_info_query(rsound_t *rd); static int rsnd_update_server_info(rsound_t *rd); static int rsnd_poll(struct pollfd *fd, int numfd, int timeout); static void rsnd_cb_thread(void *thread_data); static void rsnd_thread(void *thread_data); /* Determine whether we're running big- or little endian */ static INLINE int rsnd_is_little_endian(void) { uint16_t i = 1; return *((uint8_t*)&i); } /* Simple functions for swapping bytes */ static INLINE void rsnd_swap_endian_16 ( uint16_t * x ) { *x = (*x>>8) | (*x<<8); } static INLINE void rsnd_swap_endian_32 ( uint32_t * x ) { *x = (*x >> 24 ) | ((*x<<8) & 0x00FF0000) | ((*x>>8) & 0x0000FF00) | (*x << 24); } static INLINE int rsnd_format_to_samplesize ( uint16_t fmt ) { switch(fmt) { case RSD_S32_LE: case RSD_S32_BE: case RSD_S32_NE: case RSD_U32_LE: case RSD_U32_BE: case RSD_U32_NE: return 4; case RSD_S16_LE: case RSD_U16_LE: case RSD_S16_BE: case RSD_U16_BE: case RSD_S16_NE: case RSD_U16_NE: return 2; case RSD_U8: case RSD_S8: case RSD_ALAW: case RSD_MULAW: return 1; default: return -1; } } int rsd_samplesize( rsound_t *rd ) { retro_assert(rd != NULL); return rd->samplesize; } /* Creates sockets and attempts to connect to the server. Returns -1 when failed, and 0 when success. */ static int rsnd_connect_server( rsound_t *rd ) { struct sockaddr_in addr; struct pollfd fd; int i = 1; (void)i; memset(&addr, 0, sizeof(addr)); addr.sin_family = AF_INET; addr.sin_port = htons(atoi(rd->port)); if (!isdigit(rd->host[0])) { struct hostent *host = gethostbyname(rd->host); if (host == NULL) return -1; addr.sin_addr.s_addr = inet_addr(host->h_addr_list[0]); } else addr.sin_addr.s_addr = inet_addr(rd->host); rd->conn_type = RSD_CONN_TCP; rd->conn.socket = net_socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); if ( rd->conn.socket < 0 ) goto error; rd->conn.ctl_socket = net_socket(AF_INET, SOCK_STREAM, IPPROTO_TCP); if ( rd->conn.ctl_socket < 0 ) goto error; /* Uses non-blocking IO since it performed more deterministic with poll()/send() */ #ifdef __CELLOS_LV2__ setsockopt(rd->conn.socket, SOL_SOCKET, SO_NBIO, &i, sizeof(int)); setsockopt(rd->conn.ctl_socket, SOL_SOCKET, SO_NBIO, &i, sizeof(int)); #else fcntl(rd->conn.socket, F_SETFL, O_NONBLOCK); fcntl(rd->conn.ctl_socket, F_SETFL, O_NONBLOCK); #endif /* Nonblocking connect with 3 second timeout */ net_connect(rd->conn.socket, (struct sockaddr*)&addr, sizeof(addr)); pollfd_fd(fd) = rd->conn.socket; fd.events = POLLOUT; rsnd_poll(&fd, 1, 3000); if (!(fd.revents & POLLOUT)) goto error; net_connect(rd->conn.ctl_socket, (struct sockaddr*)&addr, sizeof(addr)); pollfd_fd(fd) = rd->conn.ctl_socket; rsnd_poll(&fd, 1, 3000); if (!(fd.revents & POLLOUT)) goto error; return 0; /* Cleanup for errors. */ error: RSD_ERR("[RSound] Connecting to server failed. \"%s\"", rd->host); return -1; } /* Conjures a WAV-header and sends this to server. Returns -1 when failed, and 0 when success. */ static int rsnd_send_header_info(rsound_t *rd) { /* Defines the size of a wave header */ #define HEADER_SIZE 44 char *header = calloc(1, HEADER_SIZE); if (header == NULL) { RSD_ERR("[RSound] Could not allocate memory."); return -1; } uint16_t temp16; uint32_t temp32; /* These magic numbers represent the position of the elements in the wave header. We can't simply send a wave struct over the network since the compiler is allowed to pad our structs as they like, so sizeof(waveheader) might not be similar on two different systems. */ #define RATE 24 #define CHANNEL 22 #define FRAMESIZE 34 #define FORMAT 42 uint32_t temp_rate = rd->rate; uint16_t temp_channels = rd->channels; uint16_t temp_bits = 8 * rsnd_format_to_samplesize(rd->format); uint16_t temp_format = rd->format; // Checks the format for native endian which will need to be set properly. switch ( temp_format ) { case RSD_S16_NE: if ( rsnd_is_little_endian() ) temp_format = RSD_S16_LE; else temp_format = RSD_S16_BE; break; case RSD_U16_NE: if ( rsnd_is_little_endian() ) temp_format = RSD_U16_LE; else temp_format = RSD_U16_BE; break; case RSD_S32_NE: if ( rsnd_is_little_endian() ) temp_format = RSD_S32_LE; else temp_format = RSD_S32_BE; break; case RSD_U32_NE: if ( rsnd_is_little_endian() ) temp_format = RSD_U32_LE; else temp_format = RSD_U32_BE; break; default: break; } /* Since the values in the wave header we are interested in, are little endian (>_<), we need to determine whether we're running it or not, so we can byte swap accordingly. Could determine this compile time, but it was simpler to do it this way. */ // Fancy macros for embedding little endian values into the header. #define SET32(buf,offset,x) (*((uint32_t*)(buf+offset)) = x) #define SET16(buf,offset,x) (*((uint16_t*)(buf+offset)) = x) #define LSB16(x) if ( !rsnd_is_little_endian() ) { rsnd_swap_endian_16(&(x)); } #define LSB32(x) if ( !rsnd_is_little_endian() ) { rsnd_swap_endian_32(&(x)); } /* Here we embed in the rest of the WAV header for it to be somewhat valid */ strlcpy(header, "RIFF", sizeof(header)); SET32(header, 4, 0); strlcpy(header+8, "WAVE", sizeof(header)); strlcpy(header+12, "fmt ", sizeof(header)); temp32 = 16; LSB32(temp32); SET32(header, 16, temp32); temp16 = 0; // PCM data switch( rd->format ) { case RSD_S16_LE: case RSD_U8: temp16 = 1; break; case RSD_ALAW: temp16 = 6; break; case RSD_MULAW: temp16 = 7; break; } LSB16(temp16); SET16(header, 20, temp16); // Channels here LSB16(temp_channels); SET16(header, CHANNEL, temp_channels); // Samples per sec LSB32(temp_rate); SET32(header, RATE, temp_rate); temp32 = rd->rate * rd->channels * rsnd_format_to_samplesize(rd->format); LSB32(temp32); SET32(header, 28, temp32); temp16 = rd->channels * rsnd_format_to_samplesize(rd->format); LSB16(temp16); SET16(header, 32, temp16); // Bits per sample LSB16(temp_bits); SET16(header, FRAMESIZE, temp_bits); strlcpy(header+36, "data", sizeof(header)); /* Do not care about cksize here (impossible to know beforehand). * It is used by the server for format. */ LSB16(temp_format); SET16(header, FORMAT, temp_format); /* End static header */ if ( rsnd_send_chunk(rd->conn.socket, header, HEADER_SIZE, 1) != HEADER_SIZE ) { free(header); return -1; } free(header); return 0; } /* Recieves backend info from server that is of interest to the client. (This mini-protocol might be extended later on.) */ static int rsnd_get_backend_info ( rsound_t *rd ) { #define RSND_HEADER_SIZE 8 #define LATENCY 0 #define CHUNKSIZE 1 // Header is 2 uint32_t's. = 8 bytes. uint32_t rsnd_header[2] = {0}; if ( rsnd_recv_chunk(rd->conn.socket, rsnd_header, RSND_HEADER_SIZE, 1) != RSND_HEADER_SIZE ) { RSD_ERR("[RSound] Couldn't receive chunk.\n"); return -1; } /* Again, we can't be 100% certain that sizeof(backend_info_t) is equal on every system */ if ( rsnd_is_little_endian() ) { rsnd_swap_endian_32(&rsnd_header[LATENCY]); rsnd_swap_endian_32(&rsnd_header[CHUNKSIZE]); } rd->backend_info.latency = rsnd_header[LATENCY]; rd->backend_info.chunk_size = rsnd_header[CHUNKSIZE]; #define MAX_CHUNK_SIZE 1024 // We do not want larger chunk sizes than this. if ( rd->backend_info.chunk_size > MAX_CHUNK_SIZE || rd->backend_info.chunk_size <= 0 ) rd->backend_info.chunk_size = MAX_CHUNK_SIZE; /* Assumes a default buffer size should it cause problems of being too small */ if ( rd->buffer_size == 0 || rd->buffer_size < rd->backend_info.chunk_size * 2 ) rd->buffer_size = rd->backend_info.chunk_size * 32; if ( rd->fifo_buffer != NULL ) fifo_free(rd->fifo_buffer); rd->fifo_buffer = fifo_new (rd->buffer_size); if ( rd->fifo_buffer == NULL ) { RSD_ERR("[RSound] Failed to create FIFO buffer.\n"); return -1; } // Only bother with setting network buffer size if we're doing TCP. if ( rd->conn_type & RSD_CONN_TCP ) { #define MAX_TCP_BUFSIZE (1 << 14) int bufsiz = rd->buffer_size; if (bufsiz > MAX_TCP_BUFSIZE) bufsiz = MAX_TCP_BUFSIZE; setsockopt(rd->conn.socket, SOL_SOCKET, SO_SNDBUF, &bufsiz, sizeof(int)); bufsiz = rd->buffer_size; setsockopt(rd->conn.ctl_socket, SOL_SOCKET, SO_SNDBUF, &bufsiz, sizeof(int)); bufsiz = rd->buffer_size; setsockopt(rd->conn.ctl_socket, SOL_SOCKET, SO_RCVBUF, &bufsiz, sizeof(int)); int flag = 1; setsockopt(rd->conn.socket, IPPROTO_TCP, TCP_NODELAY, &flag, sizeof(int)); flag = 1; setsockopt(rd->conn.ctl_socket, IPPROTO_TCP, TCP_NODELAY, &flag, sizeof(int)); } // Can we read the last 8 bytes so we can use the protocol interface? // This is non-blocking. if ( rsnd_recv_chunk(rd->conn.socket, rsnd_header, RSND_HEADER_SIZE, 0) == RSND_HEADER_SIZE ) rd->conn_type |= RSD_CONN_PROTO; else { RSD_DEBUG("[RSound] Failed to get new proto.\n"); } // We no longer want to read from this socket. #ifdef _WIN32 net_shutdown(rd->conn.socket, SD_RECEIVE); #elif !defined(__APPLE__) // OSX doesn't seem to like shutdown() net_shutdown(rd->conn.socket, SHUT_RD); #endif return 0; } /* Makes sure that we're connected and done with wave header handshaking. Returns -1 on error, and 0 on success. This goes for all other functions in use. */ static int rsnd_create_connection(rsound_t *rd) { int rc; /* Are we connected to the server? If not, these values have been set to <0, so we make sure that we connect */ if ( rd->conn.socket <= 0 && rd->conn.ctl_socket <= 0 ) { rc = rsnd_connect_server(rd); if (rc < 0) { RSD_ERR("[RSound] connect server failed.\n"); rsd_stop(rd); return -1; } /* After connecting, makes really sure that we have a working connection. */ struct pollfd fd; pollfd_fd(fd) = rd->conn.socket; fd.events = POLLOUT; if ( rsnd_poll(&fd, 1, 2000) < 0 ) { RSD_ERR("[RSound] rsnd_poll failed.\n"); rsd_stop(rd); return -1; } if ( !(fd.revents & POLLOUT) ) { RSD_ERR("[RSound] Poll didn't return what we wanted.\n"); rsd_stop(rd); return -1; } } /* Is the server ready for data? The first thing it expects is the wave header */ if ( !rd->ready_for_data ) { /* Part of the uber simple protocol. 1. Send wave header. 2. Recieve backend info like latency and preferred packet size. 3. Starts the playback thread. */ rc = rsnd_send_header_info(rd); if (rc < 0) { RSD_ERR("[RSound] Send header failed.\n"); rsd_stop(rd); return -1; } rc = rsnd_get_backend_info(rd); if (rc < 0) { RSD_ERR("[RSound] Get backend info failed.\n"); rsd_stop(rd); return -1; } rc = rsnd_start_thread(rd); if (rc < 0) { RSD_ERR("[RSound] Starting thread failed.\n"); rsd_stop(rd); return -1; } if ( (rd->conn_type & RSD_CONN_PROTO) && strlen(rd->identity) > 0 ) { rsnd_send_identity_info(rd); } rd->ready_for_data = 1; } return 0; } /* Sends a chunk over the network. Makes sure that everything is sent if blocking. Returns -1 if connection is lost, non-negative if success. * If blocking, and not enough data is recieved, it will return -1. */ static ssize_t rsnd_send_chunk(int socket, const void* buf, size_t size, int blocking) { ssize_t rc = 0; size_t wrote = 0; ssize_t send_size = 0; struct pollfd fd; pollfd_fd(fd) = socket; fd.events = POLLOUT; int sleep_time = (blocking) ? 10000 : 0; #define MAX_PACKET_SIZE 1024 while ( wrote < size ) { if ( rsnd_poll(&fd, 1, sleep_time) < 0 ) return -1; if ( fd.revents & POLLHUP ) { RSD_WARN("*** Remote side hung up! ***"); return -1; } if ( fd.revents & POLLOUT ) { /* We try to limit ourselves to 1KiB packet sizes. */ send_size = (size - wrote) > MAX_PACKET_SIZE ? MAX_PACKET_SIZE : size - wrote; rc = net_send(socket, (const char*)buf + wrote, send_size, 0); if ( rc < 0 ) { RSD_ERR("[RSound] Error sending chunk, %s.\n", strerror(errno)); return rc; } wrote += rc; } else { /* If server hasn't stopped blocking after 10 secs, then we should probably shut down the stream. */ if ( blocking ) return -1; else return wrote; } } return (ssize_t)wrote; } /* Recieved chunk. Makes sure that everything is recieved if blocking. Returns -1 if connection is lost, non-negative if success. * If blocking, and not enough data is recieved, it will return -1. */ static ssize_t rsnd_recv_chunk(int socket, void *buf, size_t size, int blocking) { ssize_t rc = 0; size_t has_read = 0; ssize_t read_size = 0; struct pollfd fd; pollfd_fd(fd) = socket; fd.events = POLLIN; int sleep_time = (blocking) ? 5000 : 0; while ( has_read < size ) { if ( rsnd_poll(&fd, 1, sleep_time) < 0 ) { RSD_ERR("[RSound] Poll failed.\n"); return -1; } if ( fd.revents & POLLHUP ) { RSD_ERR("[RSound] Server hung up.\n"); return -1; } if ( fd.revents & POLLIN ) { read_size = (size - has_read) > MAX_PACKET_SIZE ? MAX_PACKET_SIZE : size - has_read; rc = net_recv(socket, (char*)buf + has_read, read_size, 0); if ( rc <= 0 ) { RSD_ERR("[RSound] Error receiving chunk, %s.\n", strerror(errno)); return rc; } has_read += rc; } else { if ( blocking ) { RSD_ERR("[RSound] Block fail.\n"); return -1; } else return has_read; } } return (ssize_t)has_read; } static int rsnd_poll(struct pollfd *fd, int numfd, int timeout) { for(;;) { if ( socketpoll(fd, numfd, timeout) < 0 ) { if ( errno == EINTR ) continue; perror("poll"); return -1; } return 0; } } static int64_t rsnd_get_time_usec(void) { #if defined(_WIN32) static LARGE_INTEGER freq; if (!freq.QuadPart && !QueryPerformanceFrequency(&freq)) // Frequency is guaranteed to not change. return 0; LARGE_INTEGER count; if (!QueryPerformanceCounter(&count)) return 0; return count.QuadPart * 1000000 / freq.QuadPart; #elif defined(__CELLOS_LV2__) return sys_time_get_system_time(); #elif defined(GEKKO) return ticks_to_microsecs(gettime()); #elif defined(__MACH__) // OSX doesn't have clock_gettime ... clock_serv_t cclock; mach_timespec_t mts; host_get_clock_service(mach_host_self(), CALENDAR_CLOCK, &cclock); clock_get_time(cclock, &mts); mach_port_deallocate(mach_task_self(), cclock); return mts.tv_sec * INT64_C(1000000) + (mts.tv_nsec + 500) / 1000; #elif defined(_POSIX_MONOTONIC_CLOCK) || defined(__QNX__) || defined(ANDROID) struct timespec tv; if (clock_gettime(CLOCK_MONOTONIC, &tv) < 0) return 0; return tv.tv_sec * INT64_C(1000000) + (tv.tv_nsec + 500) / 1000; #elif defined(EMSCRIPTEN) return emscripten_get_now() * 1000; #else #error "Your platform does not have a timer function implemented in rsnd_get_time_usec(). Cannot continue." #endif } /* Calculates how many bytes there are in total in the virtual buffer. This is calculated client side. It should be accurate enough unless we have big problems with buffer underruns. This function is called by rsd_delay() to determine the latency. This function might be changed in the future to correctly determine latency from server. */ static void rsnd_drain(rsound_t *rd) { /* If the audio playback has started on the server we need to use timers. */ if ( rd->has_written ) { /* Calculates the amount of bytes that the server has consumed. */ int64_t time = rsnd_get_time_usec(); int64_t delta = time - rd->start_time; delta *= rd->rate * rd->channels * rd->samplesize; delta /= 1000000; /* Calculates the amount of data we have in our virtual buffer. Only used to calculate delay. */ slock_lock(rd->thread.mutex); rd->bytes_in_buffer = (int)((int64_t)rd->total_written + (int64_t)fifo_read_avail(rd->fifo_buffer) - delta); slock_unlock(rd->thread.mutex); } else { slock_lock(rd->thread.mutex); rd->bytes_in_buffer = fifo_read_avail(rd->fifo_buffer); slock_unlock(rd->thread.mutex); } } /* Tries to fill the buffer. Uses signals to determine when the buffer is ready to be filled. Should the thread not be active it will treat this as an error. Crude implementation of a blocking FIFO. */ static size_t rsnd_fill_buffer(rsound_t *rd, const char *buf, size_t size) { /* Wait until we have a ready buffer */ for (;;) { /* Should the thread be shut down while we're running, return with error */ if ( !rd->thread_active ) return 0; slock_lock(rd->thread.mutex); if ( fifo_write_avail(rd->fifo_buffer) >= size ) { slock_unlock(rd->thread.mutex); break; } slock_unlock(rd->thread.mutex); /* Sleeps until we can write to the FIFO. */ slock_lock(rd->thread.cond_mutex); scond_signal(rd->thread.cond); RSD_DEBUG("[RSound] rsnd_fill_buffer: Going to sleep.\n"); scond_wait(rd->thread.cond, rd->thread.cond_mutex); RSD_DEBUG("[RSound] rsnd_fill_buffer: Woke up.\n"); slock_unlock(rd->thread.cond_mutex); } slock_lock(rd->thread.mutex); fifo_write(rd->fifo_buffer, buf, size); slock_unlock(rd->thread.mutex); //RSD_DEBUG("[RSound] fill_buffer: Wrote to buffer.\n"); /* Send signal to thread that buffer has been updated */ //RSD_DEBUG("[RSound] fill_buffer: Waking up thread.\n"); scond_signal(rd->thread.cond); return size; } static int rsnd_start_thread(rsound_t *rd) { if ( !rd->thread_active ) { rd->thread_active = 1; rd->thread.thread = (sthread_t*)sthread_create(rd->audio_callback ? rsnd_cb_thread : rsnd_thread, rd); if ( !rd->thread.thread ) { rd->thread_active = 0; RSD_ERR("[RSound] Failed to create thread."); return -1; } return 0; } else return 0; } /* Makes sure that the playback thread has been correctly shut down */ static int rsnd_stop_thread(rsound_t *rd) { if ( rd->thread_active ) { RSD_DEBUG("[RSound] Shutting down thread.\n"); slock_lock(rd->thread.cond_mutex); rd->thread_active = 0; scond_signal(rd->thread.cond); slock_unlock(rd->thread.cond_mutex); sthread_join(rd->thread.thread); RSD_DEBUG("[RSound] Thread joined successfully.\n"); return 0; } else { RSD_DEBUG("Thread is already shut down.\n"); return 0; } } /* Calculates audio delay in bytes */ static size_t rsnd_get_delay(rsound_t *rd) { int ptr; rsnd_drain(rd); ptr = rd->bytes_in_buffer; /* Adds the backend latency to the calculated latency. */ ptr += (int)rd->backend_info.latency; slock_lock(rd->thread.mutex); ptr += rd->delay_offset; RSD_DEBUG("Offset: %d.\n", rd->delay_offset); slock_unlock(rd->thread.mutex); if ( ptr < 0 ) ptr = 0; return (size_t)ptr; } static size_t rsnd_get_ptr(rsound_t *rd) { int ptr; slock_lock(rd->thread.mutex); ptr = fifo_read_avail(rd->fifo_buffer); slock_unlock(rd->thread.mutex); return ptr; } static int rsnd_send_identity_info(rsound_t *rd) { #define RSD_PROTO_MAXSIZE 256 #define RSD_PROTO_CHUNKSIZE 8 char tmpbuf[RSD_PROTO_MAXSIZE]; char sendbuf[RSD_PROTO_MAXSIZE]; snprintf(tmpbuf, RSD_PROTO_MAXSIZE - 1, " IDENTITY %s", rd->identity); tmpbuf[RSD_PROTO_MAXSIZE - 1] = '\0'; snprintf(sendbuf, RSD_PROTO_MAXSIZE - 1, "RSD%5d%s", (int)strlen(tmpbuf), tmpbuf); sendbuf[RSD_PROTO_MAXSIZE - 1] = '\0'; if ( rsnd_send_chunk(rd->conn.ctl_socket, sendbuf, strlen(sendbuf), 0) != (ssize_t)strlen(sendbuf) ) return -1; return 0; } static int rsnd_close_ctl(rsound_t *rd) { if ( !(rd->conn_type & RSD_CONN_PROTO) ) return -1; struct pollfd fd; pollfd_fd(fd) = rd->conn.ctl_socket; fd.events = POLLOUT; if ( rsnd_poll(&fd, 1, 0) < 0 ) return -1; if ( fd.revents & POLLOUT ) { const char *sendbuf = "RSD 9 CLOSECTL"; if (net_send(rd->conn.ctl_socket, sendbuf, strlen(sendbuf), 0) < 0 ) return -1; } else if ( fd.revents & POLLHUP ) return 0; // Let's wait for reply (or POLLHUP) fd.events = POLLIN; int index = 0; char buf[RSD_PROTO_MAXSIZE*2] = {0}; for(;;) { if ( rsnd_poll(&fd, 1, 2000) < 0 ) return -1; if ( fd.revents & POLLHUP ) break; else if ( fd.revents & POLLIN ) { const char *subchar; // We just read everything in large chunks until we find what we're looking for int rc = net_recv(rd->conn.ctl_socket, buf + index, RSD_PROTO_MAXSIZE*2 - 1 - index, 0); if (rc <= 0 ) return -1; // Can we find it directly? if ( strstr(buf, "RSD 12 CLOSECTL OK") != NULL ) break; else if ( strstr(buf, "RSD 15 CLOSECTL ERROR") != NULL ) return -1; subchar = strrchr(buf, 'R'); if ( subchar == NULL ) index = 0; else { memmove(buf, subchar, strlen(subchar) + 1); index = strlen(buf); } } else return -1; } net_socketclose(rd->conn.ctl_socket); return 0; } // Sends delay info request to server on the ctl socket. This code section isn't critical, and will work if it works. // It will never block. static int rsnd_send_info_query(rsound_t *rd) { char tmpbuf[RSD_PROTO_MAXSIZE]; char sendbuf[RSD_PROTO_MAXSIZE]; snprintf(tmpbuf, RSD_PROTO_MAXSIZE - 1, " INFO %lld", (long long int)rd->total_written); tmpbuf[RSD_PROTO_MAXSIZE - 1] = '\0'; snprintf(sendbuf, RSD_PROTO_MAXSIZE - 1, "RSD%5d%s", (int)strlen(tmpbuf), tmpbuf); sendbuf[RSD_PROTO_MAXSIZE - 1] = '\0'; if ( rsnd_send_chunk(rd->conn.ctl_socket, sendbuf, strlen(sendbuf), 0) != (ssize_t)strlen(sendbuf) ) return -1; return 0; } // We check if there's any pending delay information from the server. // In that case, we read the packet. static int rsnd_update_server_info(rsound_t *rd) { long long int client_ptr = -1; long long int serv_ptr = -1; char temp[RSD_PROTO_MAXSIZE + 1] = {0}; // We read until we have the last (most recent) data in the network buffer. for (;;) { ssize_t rc; const char *substr; char *tmpstr; memset(temp, 0, sizeof(temp)); // We first recieve the small header. We just use the larger buffer as it is disposable. rc = rsnd_recv_chunk(rd->conn.ctl_socket, temp, RSD_PROTO_CHUNKSIZE, 0); if ( rc == 0 ) break; else if ( rc < RSD_PROTO_CHUNKSIZE ) return -1; temp[RSD_PROTO_CHUNKSIZE] = '\0'; if ( (substr = strstr(temp, "RSD")) == NULL ) return -1; // Jump over "RSD" in header substr += 3; // The length of the argument message is stored in the small 8 byte header. long int len = strtol(substr, NULL, 0); // Recieve the rest of the data. if ( rsnd_recv_chunk(rd->conn.ctl_socket, temp, len, 0) < len ) return -1; // We only bother if this is an INFO message. substr = strstr(temp, "INFO"); if ( substr == NULL ) continue; // Jump over "INFO" in header substr += 4; client_ptr = strtoull(substr, &tmpstr, 0); if ( client_ptr == 0 || *tmpstr == '\0' ) return -1; substr = tmpstr; serv_ptr = strtoull(substr, NULL, 0); if ( serv_ptr <= 0 ) return -1; } if ( client_ptr > 0 && serv_ptr > 0 ) { int delay = rsd_delay(rd); int delta = (int)(client_ptr - serv_ptr); slock_lock(rd->thread.mutex); delta += fifo_read_avail(rd->fifo_buffer); slock_unlock(rd->thread.mutex); RSD_DEBUG("[RSound] Delay: %d, Delta: %d.\n", delay, delta); // We only update the pointer if the data we got is quite recent. if ( rd->total_written - client_ptr < 4 * rd->backend_info.chunk_size && rd->total_written > client_ptr ) { int offset_delta = delta - delay; int max_offset = rd->backend_info.chunk_size; if ( offset_delta < -max_offset ) offset_delta = -max_offset; else if ( offset_delta > max_offset ) offset_delta = max_offset; slock_lock(rd->thread.mutex); rd->delay_offset += offset_delta; slock_unlock(rd->thread.mutex); RSD_DEBUG("[RSound] Changed offset-delta: %d.\n", offset_delta); } } return 0; } // Sort of simulates the behavior of pthread_cancel() #define _TEST_CANCEL() \ if ( !rd->thread_active ) \ break /* The blocking thread */ static void rsnd_thread ( void * thread_data ) { /* We share data between thread and callable functions */ rsound_t *rd = thread_data; int rc; char buffer[rd->backend_info.chunk_size]; /* Plays back data as long as there is data in the buffer. Else, sleep until it can. */ /* Two (;;) for loops! :3 Beware! */ for (;;) { for(;;) { _TEST_CANCEL(); // We ask the server to send its latest backend data. Do not really care about errors atm. // We only bother to check after 1 sec of audio has been played, as it might be quite inaccurate in the start of the stream. if ( (rd->conn_type & RSD_CONN_PROTO) && (rd->total_written > rd->channels * rd->rate * rd->samplesize) ) { rsnd_send_info_query(rd); rsnd_update_server_info(rd); } /* If the buffer is empty or we've stopped the stream, jump out of this for loop */ slock_lock(rd->thread.mutex); if ( fifo_read_avail(rd->fifo_buffer) < rd->backend_info.chunk_size || !rd->thread_active ) { slock_unlock(rd->thread.mutex); break; } slock_unlock(rd->thread.mutex); _TEST_CANCEL(); slock_lock(rd->thread.mutex); fifo_read(rd->fifo_buffer, buffer, sizeof(buffer)); slock_unlock(rd->thread.mutex); rc = rsnd_send_chunk(rd->conn.socket, buffer, sizeof(buffer), 1); /* If this happens, we should make sure that subsequent and current calls to rsd_write() will fail. */ if ( rc != (int)rd->backend_info.chunk_size ) { _TEST_CANCEL(); rsnd_reset(rd); /* Wakes up a potentially sleeping fill_buffer() */ scond_signal(rd->thread.cond); /* This thread will not be joined, so detach. */ sthread_detach(rd->thread.thread); return; } /* If this was the first write, set the start point for the timer. */ if ( !rd->has_written ) { slock_lock(rd->thread.mutex); rd->start_time = rsnd_get_time_usec(); rd->has_written = 1; slock_unlock(rd->thread.mutex); } /* Increase the total_written counter. Used in rsnd_drain() */ slock_lock(rd->thread.mutex); rd->total_written += rc; slock_unlock(rd->thread.mutex); /* Buffer has decreased, signal fill_buffer() */ scond_signal(rd->thread.cond); } /* If we're still good to go, sleep. We are waiting for fill_buffer() to fill up some data. */ if ( rd->thread_active ) { // There is a very slim change of getting a deadlock using the cond_wait scheme. // This solution is rather dirty, but avoids complete deadlocks at the very least. slock_lock(rd->thread.cond_mutex); scond_signal(rd->thread.cond); if ( rd->thread_active ) { RSD_DEBUG("[RSound] Thread going to sleep.\n"); scond_wait(rd->thread.cond, rd->thread.cond_mutex); RSD_DEBUG("[RSound] Thread woke up.\n"); } slock_unlock(rd->thread.cond_mutex); RSD_DEBUG("[RSound] Thread unlocked cond_mutex.\n"); } /* Abort request, chap. */ else { scond_signal(rd->thread.cond); return; } } } /* Callback thread */ static void rsnd_cb_thread(void *thread_data) { rsound_t *rd = thread_data; size_t read_size = rd->backend_info.chunk_size; if (rd->cb_max_size != 0 && rd->cb_max_size < read_size) read_size = rd->cb_max_size; uint8_t buffer[rd->backend_info.chunk_size]; while (rd->thread_active) { size_t has_read = 0; while (has_read < rd->backend_info.chunk_size) { size_t will_read = read_size < rd->backend_info.chunk_size - has_read ? read_size : rd->backend_info.chunk_size - has_read; rsd_callback_lock(rd); ssize_t ret = rd->audio_callback(buffer + has_read, will_read, rd->cb_data); rsd_callback_unlock(rd); if (ret < 0) { rsnd_reset(rd); sthread_detach(rd->thread.thread); rd->error_callback(rd->cb_data); return; } has_read += ret; if (ret < (ssize_t)will_read) { if ((int)rsd_delay_ms(rd) < rd->max_latency / 2) { RSD_DEBUG("[RSound] Callback thread: Requested %d bytes, got %d.\n", (int)will_read, (int)ret); memset(buffer + has_read, 0, will_read - ret); has_read += will_read - ret; } else { // The network might do things in large chunks, so it may request large amounts of data in short periods of time. // This breaks when the caller cannot buffer up big buffers beforehand, so do short sleeps inbetween. // This is somewhat dirty, but I cannot see a better solution retro_sleep(1); } } } ssize_t ret = rsnd_send_chunk(rd->conn.socket, buffer, rd->backend_info.chunk_size, 1); if (ret != (ssize_t)rd->backend_info.chunk_size) { rsnd_reset(rd); sthread_detach(rd->thread.thread); rd->error_callback(rd->cb_data); return; } /* If this was the first write, set the start point for the timer. */ if (!rd->has_written) { rd->start_time = rsnd_get_time_usec(); rd->has_written = 1; } rd->total_written += rd->backend_info.chunk_size; if ( (rd->conn_type & RSD_CONN_PROTO) && (rd->total_written > rd->channels * rd->rate * rd->samplesize) ) { rsnd_send_info_query(rd); rsnd_update_server_info(rd); } if (rd->has_written) rsd_delay_wait(rd); } } static int rsnd_reset(rsound_t *rd) { if ( rd->conn.socket != -1 ) net_socketclose(rd->conn.socket); if ( rd->conn.socket != 1 ) net_socketclose(rd->conn.ctl_socket); /* Pristine stuff, baby! */ slock_lock(rd->thread.mutex); rd->conn.socket = -1; rd->conn.ctl_socket = -1; rd->total_written = 0; rd->ready_for_data = 0; rd->has_written = 0; rd->bytes_in_buffer = 0; rd->thread_active = 0; rd->delay_offset = 0; slock_unlock(rd->thread.mutex); scond_signal(rd->thread.cond); return 0; } int rsd_stop(rsound_t *rd) { retro_assert(rd != NULL); rsnd_stop_thread(rd); const char buf[] = "RSD 5 STOP"; // Do not really care about errors here. // The socket will be closed down in any case in rsnd_reset(). rsnd_send_chunk(rd->conn.ctl_socket, buf, strlen(buf), 0); rsnd_reset(rd); return 0; } size_t rsd_write( rsound_t *rsound, const void* buf, size_t size) { size_t max_write, written = 0; retro_assert(rsound != NULL); if ( !rsound->ready_for_data ) return 0; max_write = (rsound->buffer_size - rsound->backend_info.chunk_size)/2; /* Makes sure that we can handle arbitrary large write sizes */ while ( written < size ) { size_t write_size = (size - written) > max_write ? max_write : (size - written); size_t result = rsnd_fill_buffer(rsound, (const char*)buf + written, write_size); if (result == 0) { rsd_stop(rsound); return 0; } written += result; } return written; } int rsd_start(rsound_t *rsound) { retro_assert(rsound != NULL); retro_assert(rsound->rate > 0); retro_assert(rsound->channels > 0); retro_assert(rsound->host != NULL); retro_assert(rsound->port != NULL); if ( rsnd_create_connection(rsound) < 0 ) return -1; return 0; } int rsd_exec(rsound_t *rsound) { retro_assert(rsound != NULL); RSD_DEBUG("[RSound] rsd_exec().\n"); // Makes sure we have a working connection if ( rsound->conn.socket < 0 ) { RSD_DEBUG("[RSound] Calling rsd_start().\n"); if ( rsd_start(rsound) < 0 ) { RSD_ERR("[RSound] rsd_start() failed.\n"); return -1; } } RSD_DEBUG("[RSound] Closing ctl.\n"); if ( rsnd_close_ctl(rsound) < 0 ) return -1; int fd = rsound->conn.socket; RSD_DEBUG("[RSound] Socket: %d.\n", fd); rsnd_stop_thread(rsound); #if defined(__CELLOS_LV2__) int i = 0; setsockopt(rsound->conn.socket, SOL_SOCKET, SO_NBIO, &i, sizeof(int)); #else fcntl(rsound->conn.socket, F_SETFL, O_NONBLOCK); #endif // Flush the buffer if ( fifo_read_avail(rsound->fifo_buffer) > 0 ) { char buffer[fifo_read_avail(rsound->fifo_buffer)]; fifo_read(rsound->fifo_buffer, buffer, sizeof(buffer)); if ( rsnd_send_chunk(fd, buffer, sizeof(buffer), 1) != (ssize_t)sizeof(buffer) ) { RSD_DEBUG("[RSound] Failed flushing buffer.\n"); net_socketclose(fd); return -1; } } RSD_DEBUG("[RSound] Returning from rsd_exec().\n"); rsd_free(rsound); return fd; } /* ioctl()-ish param setting :D */ int rsd_set_param(rsound_t *rd, enum rsd_settings option, void* param) { retro_assert(rd != NULL); retro_assert(param != NULL); int retval = 0; switch(option) { case RSD_SAMPLERATE: if ( *(int*)param > 0 ) { rd->rate = *((int*)param); break; } else retval = -1; break; case RSD_CHANNELS: if ( *(int*)param > 0 ) { rd->channels = *((int*)param); break; } else retval = -1; break; case RSD_HOST: if ( rd->host != NULL ) free(rd->host); rd->host = strdup((char*)param); break; case RSD_PORT: if ( rd->port != NULL ) free(rd->port); rd->port = strdup((char*)param); break; case RSD_BUFSIZE: if ( *(int*)param > 0 ) { rd->buffer_size = *((int*)param); break; } else retval = -1; break; case RSD_LATENCY: rd->max_latency = *((int*)param); break; // Checks if format is valid. case RSD_FORMAT: rd->format = (uint16_t)(*((int*)param)); rd->samplesize = rsnd_format_to_samplesize(rd->format); if ( rd->samplesize == -1 ) { rd->format = RSD_S16_LE; rd->samplesize = rsnd_format_to_samplesize(RSD_S16_LE); *((int*)param) = (int)RSD_S16_LE; } break; case RSD_IDENTITY: strlcpy(rd->identity, param, sizeof(rd->identity)); rd->identity[sizeof(rd->identity)-1] = '\0'; break; default: retval = -1; } return retval; } void rsd_delay_wait(rsound_t *rd) { /* When called, we make sure that the latency never goes over the time designated in RSD_LATENCY. Useful for certain blocking I/O designs where the latency still needs to be quite low. Without this, the latency of the stream will depend on how big the network buffers are. ( We simulate that we're a low latency sound card ) */ /* Should we bother with checking latency at all? */ if ( rd->max_latency > 0 ) { /* Latency of stream in ms */ int latency_ms = rsd_delay_ms(rd); /* Should we sleep for a while to keep the latency low? */ if ( rd->max_latency < latency_ms ) { int64_t sleep_ms = latency_ms - rd->max_latency; RSD_DEBUG("[RSound] Delay wait: %d ms.\n", (int)sleep_ms); retro_sleep((int)sleep_ms); } } } size_t rsd_pointer(rsound_t *rsound) { retro_assert(rsound != NULL); int ptr; ptr = rsnd_get_ptr(rsound); return ptr; } size_t rsd_get_avail(rsound_t *rd) { retro_assert(rd != NULL); int ptr; ptr = rsnd_get_ptr(rd); return rd->buffer_size - ptr; } size_t rsd_delay(rsound_t *rd) { retro_assert(rd != NULL); int ptr = rsnd_get_delay(rd); if ( ptr < 0 ) ptr = 0; return ptr; } size_t rsd_delay_ms(rsound_t* rd) { retro_assert(rd); retro_assert(rd->rate > 0 && rd->channels > 0); return (rsd_delay(rd) * 1000) / ( rd->rate * rd->channels * rd->samplesize ); } int rsd_pause(rsound_t* rsound, int enable) { retro_assert(rsound != NULL); if ( enable ) return rsd_stop(rsound); return rsd_start(rsound); } int rsd_init(rsound_t** rsound) { *rsound = calloc(1, sizeof(rsound_t)); if ( *rsound == NULL ) return -1; retro_assert(rsound != NULL); (*rsound)->conn.socket = -1; (*rsound)->conn.ctl_socket = -1; (*rsound)->thread.mutex = slock_new(); (*rsound)->thread.cond_mutex = slock_new(); (*rsound)->cb_lock = slock_new(); (*rsound)->thread.cond = scond_new(); // Assumes default of S16_LE samples. int format = RSD_S16_LE; rsd_set_param(*rsound, RSD_FORMAT, &format); rsd_set_param(*rsound, RSD_HOST, RSD_DEFAULT_HOST); rsd_set_param(*rsound, RSD_PORT, RSD_DEFAULT_PORT); #ifdef __CELLOS_LV2__ if (init_count == 0) { cellSysmoduleLoadModule(CELL_SYSMODULE_NET); sys_net_initialize_network(); init_count++; } #endif return 0; } int rsd_simple_start(rsound_t** rsound, const char* host, const char* port, const char* ident, int rate, int channels, enum rsd_format format) { if ( rsd_init(rsound) < 0 ) return -1; int fmt = format; if ( host != NULL ) rsd_set_param(*rsound, RSD_HOST, (void*)host); if ( port != NULL ) rsd_set_param(*rsound, RSD_PORT, (void*)port); if ( ident != NULL ) rsd_set_param(*rsound, RSD_IDENTITY, (void*)ident); if ( rsd_set_param(*rsound, RSD_SAMPLERATE, &rate) < 0 || rsd_set_param(*rsound, RSD_CHANNELS, &channels) < 0 || rsd_set_param(*rsound, RSD_FORMAT, &fmt) < 0 ) { rsd_free(*rsound); return -1; } if ( rsd_start(*rsound) < 0 ) { rsd_free(*rsound); return -1; } return 0; } void rsd_set_callback(rsound_t *rsound, rsd_audio_callback_t audio_cb, rsd_error_callback_t err_cb, size_t max_size, void *userdata) { retro_assert(rsound != NULL); rsound->audio_callback = audio_cb; rsound->error_callback = err_cb; rsound->cb_max_size = max_size; rsound->cb_data = userdata; if (rsound->audio_callback) { retro_assert(rsound->error_callback); } } void rsd_callback_lock(rsound_t *rsound) { slock_lock(rsound->cb_lock); } void rsd_callback_unlock(rsound_t *rsound) { slock_unlock(rsound->cb_lock); } int rsd_free(rsound_t *rsound) { retro_assert(rsound != NULL); if (rsound->fifo_buffer) fifo_free(rsound->fifo_buffer); if (rsound->host) free(rsound->host); if (rsound->port) free(rsound->port); slock_free(rsound->thread.mutex); slock_free(rsound->thread.cond_mutex); slock_free(rsound->cb_lock); scond_free(rsound->thread.cond); free(rsound); return 0; }