Networking with osc

configure.ac

@@ -212,6 +212,14 @@ PKG_CHECK_MODULES([LIBXML], [libxml-2.0 >= 2.0],
   LIBS="$LIBS $LIBXML_LIBS"
 ])
 
+dnl Checking for liblo
+PKG_CHECK_MODULES([LIBLO], [liblo >= 0.28],
+  [
+  PKG_FLAGS="$PKG_FLAGS $LIBLO_CFLAGS"
+  LIBS="$LIBS $LIBLO_LIBS"
+  ]
+)
+
 dnl by the way, AC_HELP_STRING is deprecated, use AS_HELP_STRING instead!
 
 ENABLE_EXPLICIT([debugging],[debugging symbols, asserts, ...])
@@ -521,6 +529,20 @@ ENABLE_FORCED([ip-interface], [network (TCP/IP) interface (needs Asio, https://t
   AC_CHECK_HEADER([asio.hpp], , [have_ip_interface=no])
 ])
 
+ENABLE_FORCED([osc-interface], [network OSC interface],
+[
+  AC_CHECK_HEADER([lo/lo.h], , [have_osc_interface=no])
+  AC_CHECK_HEADER([lo/lo_cpp.h], , [have_osc_interface=no])
+  AC_MSG_RESULT([$have_osc_interface])
+])
+
+ENABLE_FORCED([osc-interface], [network OSC interface],
+[
+  AC_CHECK_HEADER([lo/lo.h], , [have_osc_interface=no])
+  AC_CHECK_HEADER([lo/lo_cpp.h], , [have_osc_interface=no])
+  AC_MSG_RESULT([$have_osc_interface])
+])
+
 ENABLE_FORCED([ecasound], [Ecasound soundfile playback/recording],
 [
   dnl Checking for libecasoundc. It does not provide pkg-config and installs
@@ -763,6 +785,7 @@ echo "|    VRPN ................................ : $have_vrpn"
 echo "|"
 echo "| Build with Ecasound support ............ : $have_ecasound"
 echo "| Build with IP interface ................ : $have_ip_interface"
+echo "| Build with OSC interface ............... : $have_osc_interface"
 echo "| Build with GUI ......................... : $gui_string"
 echo "|"
 echo "| Enable debugging/optimization .......... : $have_debugging/$have_optimization"

data/ssr.conf.example

@@ -95,6 +95,17 @@
 # carriage return: 13)
 #END_OF_MESSAGE_CHARACTER = 10
 
+############################ Networking configuration ##########################
+
+# networking mode: client, server (default: client)
+#NETWORK_MODE = server
+
+# networking port for sending (default: 50001)
+#OSC_PORT = 50001
+
+# networking clients, comma-separated by hostname:port
+#NETWORK_CLIENTS = "client:50001, client:50001"
+
 ############################## Verbosity Level #################################
 
 # Set the level of system information

src/Makefile.am

@@ -182,6 +182,20 @@ SSRSOURCES += \
 	network/server.h
 endif
 
+if ENABLE_OSC_INTERFACE
+AM_CPPFLAGS += -I$(srcdir)/networking
+
+SSRSOURCES += \
+	networking/oscclient.cpp \
+	networking/oscclient.h \
+	networking/oschandler.cpp \
+	networking/oschandler.h \
+	networking/oscreceiver.cpp \
+	networking/oscreceiver.h \
+	networking/oscsender.cpp \
+	networking/oscsender.h
+endif
+
 if ENABLE_GUI
 AM_CPPFLAGS += -I$(srcdir)/gui
 

src/configuration.cpp

@@ -38,6 +38,7 @@
 #include <stdio.h>
 #include <thread>   // std::this_thread::sleep_for
 #include <chrono>   // std::chrono::seconds
+#include <sstream>  // for parse_network_clients
 
 #include "configuration.h"
 #include "posixpathtools.h"
@@ -108,6 +109,100 @@ namespace // anonymous
   }
 }
 
+/**
+ * Function to retrieve a valid port from a char.
+ * Returns an ephemeral port according to IANA suggestions
+ * @param port a const char* holding a number
+ * @return An ephemeral port according to IANA suggestions
+ */
+int ssr::get_valid_network_port(const char* port)
+{
+  int port_number = atoi(port);
+  bool valid_port = true;
+  if (port_number < 1024 && port_number > 0)
+  {
+    ERROR("Port number is in the range of well-known ports!");
+    valid_port = false;
+  }
+  else if(port_number < 0)
+  {
+    ERROR("Port number must not be negative!");
+    valid_port = false;
+  }
+  else if (port_number < 49152 || port_number > 65535)
+  {
+    ERROR("Port number is not in the range of ephemeral ports suggested by IANA!");
+    valid_port = false;
+  }
+  if (!valid_port)
+  {
+    WARNING("Using standard port.");
+    port_number = 50001;
+  }
+  return port_number;
+}
+
+/* Function to remove all whitespaces from a string.
+ * If the string is " " it will return an empty string.
+ * @param str a reference to a std::string
+ * @return a std::string without whitespaces
+ */
+std::string ssr::remove_whitespace(const std::string& str)
+{
+  if (str == " ") return "";
+  size_t first = str.find_first_not_of(' ');
+  if (std::string::npos == first)
+  {
+    return str;
+  }
+  size_t last = str.find_last_not_of(' ');
+  return str.substr(first, (last - first + 1));
+}
+
+/**
+ * Function to retrieves tuples of key value pairs from a comma-separated
+ * string and stores it in a multimap. The tuples should be of the form
+ * client:port, client2:port2, etc..
+ * @param input a const char* holding a comma-separated list of clients:port
+ * tuples
+ * @param clients reference to a std::multimap<std::string, int> to store
+ * information on client and port in.
+ * @return CONFIG_SUCCESS on successful completion
+ */
+static int parse_network_clients(const char* input,
+    std::multimap<std::string, int>& clients)
+{
+  std::istringstream iss(input);
+  std::string name;
+  int port;
+  std::string token;
+
+  while (std::getline(iss, token, ',')) {
+    size_t pos = token.find(':');
+    std::string port_temp = ssr::remove_whitespace(token.substr(pos+1));
+    name = ssr::remove_whitespace(token.substr(0, pos));
+
+    if (!name.empty())
+    {
+      // if no port supplied, insert standard
+      if ( port_temp.empty() || port_temp == name )
+      {
+        port = 50001;
+      }
+      else
+      {
+        port = std::stoi(port_temp);
+      }
+      clients.insert(make_pair(name, port));
+    }
+  }
+  VERBOSE("Read the following clients:");
+  for (const auto& client: clients) {
+    VERBOSE(client.first << ":" << client.second);
+  }
+  return CONFIG_SUCCESS;
+}
+
 /** parse command line options and configuration file(s)
  * @param argc number of command line arguments.
  * @param argv the arguments themselves.
@@ -157,6 +252,10 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
   conf.renderer_params.set("decay_exponent", 1.0f);  // 1 / r^1
   conf.renderer_params.set("amplitude_reference_distance", 3.0f);  // meters
 
+  // default network settings, also stated in data/ssr.conf.example
+  conf.network_mode = "client";
+  conf.osc_port = 50001;
+
   conf.auto_rotate_sources = true;
 
   // for WFS renderer
@@ -240,6 +339,14 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
 "      --no-auto-rotation\n"
 "                      Don't auto-rotate sound sources' orientation toward "
                                                                "the reference\n"
+"  -N  --network-mode=VALUE\n"
+"                      Which network mode to use: client or server "
+                                                           "(default: client)\n"
+"  -C  --network-clients=VALUE\n"
+"                      List of network clients and their ports (e.g. "
+                                               "client1:50001, client2:50001)\n"
+"  -p  --osc-port=VALUE\n"
+"                      Port to use for OSC communication (default: 50001)\n"
 
 #ifdef ENABLE_IP_INTERFACE
 "  -i, --ip-server[=PORT]\n"
@@ -323,6 +430,9 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
     {"master-volume-correction", required_argument, nullptr, 0},
     {"auto-rotation", no_argument,      nullptr,  0 },
     {"no-auto-rotation", no_argument,   nullptr,  0 },
+    {"network-mode", required_argument, nullptr, 'N'},
+    {"network-clients", required_argument, nullptr, 'C'},
+    {"osc-port", required_argument, nullptr, 'p'},
     {"ip-server",    optional_argument, nullptr, 'i'},
     {"no-ip-server", no_argument,       nullptr, 'I'},
     {"end-of-message-character", required_argument, nullptr, 0},
@@ -341,7 +451,7 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
   };
   // one colon: required argument; two colons: optional argument
   // if first character is '-', non-option arguments return 1 (see case 1 below)
-  const char *optstring = "-c:fgGhi::In:o:r:s:t:TvV?";
+  const char *optstring = "-c:C:fgGhi::IN:n:o:p:r:s:t:TvV?";
 
   int opt;
   int longindex = 0;
@@ -441,6 +551,9 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
               + std::string(optarg) + "\"!");
         }
         break;
+      case 'C':
+        parse_network_clients(optarg, conf.network_clients);
+        break;
 
       case 'f':
         conf.freewheeling = true;
@@ -478,13 +591,26 @@ ssr::conf_struct ssr::configuration(int& argc, char* argv[])
         conf.ip_server = false;
         break;
 
+      case 'N':
+        //TODO: check if correct string
+        if (!strcasecmp(optarg, "client") || !strcasecmp(optarg, "server"))
+        {
+          conf.network_mode = optarg;
+        }
+        else {
+          ERROR("'"<< optarg << "' is not understood as option for network-mode.");
+        }
+        break;
       case 'n':
         conf.renderer_params.set("name", optarg);
         break;
 
       case 'o':
         conf.renderer_params.set("ambisonics_order", atoi(optarg));
         break;
+      case 'p':
+        conf.osc_port = get_valid_network_port(optarg);
+        break;
 
       case 'r':
         conf.audio_recorder_file_name = optarg;
@@ -558,6 +684,7 @@ static int is_comment_or_empty(const char *line){
   return (*line == '#') || (!*line);
 }
 
+
 /******************************************************************************/
 
 /* This function takes a line from the configuration file and splits
@@ -790,6 +917,24 @@ int ssr::load_config_file(const char *filename, conf_struct& conf){
       if (!strcasecmp(value, "on")) conf.gui = true;
       else conf.gui = false;
     }
+    else if (!strcmp(key, "NETWORK_MODE"))
+    {
+      if (!strcasecmp(value, "client") || !strcasecmp(value, "server"))
+      {
+        conf.network_mode = value;
+      }
+      else {
+        ERROR("'"<< value << "' is not understood as option for network-mode.");
+      }
+    }
+    else if (!strcmp(key, "NETWORK_CLIENTS"))
+    {
+      parse_network_clients(value, conf.network_clients);
+    }
+    else if (!strcmp(key, "OSC_PORT"))
+    {
+      conf.osc_port = get_valid_network_port(value);
+    }
     else if (!strcmp(key, "NETWORK_INTERFACE"))
     {
       #ifdef ENABLE_IP_INTERFACE

src/configuration.h

@@ -30,6 +30,7 @@
 #ifndef SSR_CONFIGURATION_H
 #define SSR_CONFIGURATION_H
 
+#include <map>
 #include <string>
 
 #include "apf/parameter_map.h"
@@ -57,6 +58,10 @@ struct conf_struct
   std::string output_port_prefix;       ///< e.g. "alsa_pcm:playback"
   std::string path_to_gui_images;       ///< dto.
   std::string path_to_scene_menu;       ///< path to scene_menu.conf
+  std::string network_mode;             ///< network mode (client or server)
+  ///< list of network clients and ports
+  std::multimap<std::string, int> network_clients;
+  int osc_port;                         ///< osc communication port
   int end_of_message_character;         ///< ASCII
   bool auto_rotate_sources;             ///< Automatic orientation of sources
 
@@ -79,6 +84,8 @@ conf_struct configuration(int& argc, char* argv[]);
 // static int parse(const char *line, char *key, char *value);
 // static int is_comment_or_empty(const char *line);
 int load_config_file(const char *filename, conf_struct& conf);
+std::string remove_whitespace(const std::string& str);
+int get_valid_network_port(const char* port);
 
 }  // namespace ssr
 

src/controller.h

@@ -61,6 +61,10 @@
 #include "server.h"
 #endif
 
+#ifdef ENABLE_OSC_INTERFACE
+#include "oschandler.h"
+#endif
+
 #include "tracker.h"
 #ifdef ENABLE_INTERSENSE
 #include "trackerintersense.h"
@@ -253,6 +257,11 @@ class Controller : public Publisher
 #ifdef ENABLE_IP_INTERFACE
     std::unique_ptr<Server> _network_interface;
 #endif
+
+#ifdef ENABLE_OSC_INTERFACE
+    std::unique_ptr<OscHandler> _osc_interface;
+#endif
+
     std::unique_ptr<Tracker> _tracker;
 
     /// check if audio player is running and start it if necessary
@@ -331,6 +340,16 @@ Controller<Renderer>::Controller(int argc, char* argv[])
   }
 #endif
 
+// throw error, if OSC interface is about to be used, but not compiled in
+#ifndef ENABLE_OSC_INTERFACE
+  if (_conf.network_mode == "client" || _conf.network_mode == "server")
+  {
+    throw std::logic_error(_conf.exec_name
+        + " was compiled without OSC support!\n"
+        "Type '" + _conf.exec_name + " --help' for more information.");
+  }
+#endif
+
 #ifndef ENABLE_GUI
   if (_conf.gui)
   {
@@ -403,6 +422,19 @@ Controller<Renderer>::Controller(int argc, char* argv[])
     _network_interface->start();
   }
 #endif // ENABLE_IP_INTERFACE
+
+// if OSC is compiled in and network-mode set, start OSC handler
+#ifdef ENABLE_OSC_INTERFACE
+  if (_conf.network_mode == "client" || _conf.network_mode == "server")
+  {
+    VERBOSE2("Starting OSC interface as "<< _conf.network_mode <<
+        " on port " <<
+        std::to_string(_conf.osc_port) << ".");
+    _osc_interface.reset(new OscHandler(*this, _conf.osc_port,
+          _conf.network_mode, _conf.network_clients));
+    _osc_interface->start();
+  }
+#endif
 }
 
 template<typename Renderer>