al_OSC.hpp

#ifndef INCLUDE_AL_OSC_HPP
#define INCLUDE_AL_OSC_HPP
 
/*  Allocore --
        Multimedia / virtual environment application class library
 
        Copyright (C) 2009. AlloSphere Research Group, Media Arts & Technology,
   UCSB. Copyright (C) 2012. The Regents of the University of California. All
   rights reserved.
 
        Redistribution and use in source and binary forms, with or without
        modification, are permitted provided that the following conditions are
   met:
 
                Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
 
                Redistributions in binary form must reproduce the above
   copyright notice, this list of conditions and the following disclaimer in the
                documentation and/or other materials provided with the
   distribution.
 
                Neither the name of the University of California nor the names
   of its contributors may be used to endorse or promote products derived from
                this software without specific prior written permission.
 
        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
   IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
        IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
   CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
   EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
   PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
   OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
   WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
   OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
   ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
        File description:
        Objects for reading, writing, sending, and receiving
        OSC (Open Sound Control) packets.
 
        File author(s):
        Lance Putnam, 2010, putnam.lance@gmail.com
        Graham Wakefield, 2010, grrrwaaa@gmail.com
        Keehong Youn, 2017, younkeehong@gmail.com
*/
 
#include <memory>
#include <string>
#include <vector>
 
#include "al/system/al_Thread.hpp"
#include "al/system/al_Time.hpp"
 
namespace al {
 
namespace osc {
 
struct Blob {
  Blob() {}
  explicit Blob(const void *data_, unsigned long size_)
      : data(data_), size(size_) {}
  const void *data;
  unsigned long size;
};
 
 
typedef unsigned long long TimeTag;
 
class Packet {
public:
  Packet(int size = 1024);
 
  Packet(const char *contents, size_t size);
 
  ~Packet();
 
  const char *data() const; 
  bool isMessage() const;   
  bool isBundle() const;    
 
  void printRaw() const;
 
  size_t size() const;
 
  Packet &beginBundle(TimeTag timeTag = 1);
 
  Packet &endBundle();
 
  Packet &beginMessage(const std::string &addressPattern);
 
  Packet &endMessage();
 
  Packet &addMessage(const std::string &addr) {
    beginMessage(addr);
    return endMessage();
  }
 
  template <class A> Packet &addMessage(const std::string &addr, const A &a) {
    beginMessage(addr);
    (*this) << a;
    return endMessage();
  }
 
  template <class A, class B>
  Packet &addMessage(const std::string &addr, const A &a, const B &b) {
    beginMessage(addr);
    (*this) << a << b;
    return endMessage();
  }
 
  template <class A, class B, class C>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c) {
    beginMessage(addr);
    (*this) << a << b << c;
    return endMessage();
  }
 
  template <class A, class B, class C, class D>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c, const D &d) {
    beginMessage(addr);
    (*this) << a << b << c << d;
    return endMessage();
  }
 
  template <class A, class B, class C, class D, class E>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c, const D &d, const E &e) {
    beginMessage(addr);
    (*this) << a << b << c << d << e;
    return endMessage();
  }
 
  template <class A, class B, class C, class D, class E, class F>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c, const D &d, const E &e, const F &f) {
    beginMessage(addr);
    (*this) << a << b << c << d << e << f;
    return endMessage();
  }
 
  template <class A, class B, class C, class D, class E, class F, class G>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c, const D &d, const E &e, const F &f,
                     const G &g) {
    beginMessage(addr);
    (*this) << a << b << c << d << e << f << g;
    return endMessage();
  }
 
  template <class A, class B, class C, class D, class E, class F, class G,
            class H>
  Packet &addMessage(const std::string &addr, const A &a, const B &b,
                     const C &c, const D &d, const E &e, const F &f, const G &g,
                     const H &h) {
    beginMessage(addr);
    (*this) << a << b << c << d << e << f << g << h;
    return endMessage();
  }
 
  Packet &operator<<(int v);                
  Packet &operator<<(unsigned v);           
  Packet &operator<<(float v);              
  Packet &operator<<(double v);             
  Packet &operator<<(char v);               
  Packet &operator<<(const char *v);        
  Packet &operator<<(const std::string &v); 
  Packet &operator<<(const Blob &v);        
 
  Packet &clear();
 
protected:
  class Impl;
  Impl *mImpl;
  std::vector<char> mData;
};
 
class Message {
public:
  Message(const char *message, int size, const TimeTag &timeTag = 1,
          const char *senderAddr = nullptr);
  ~Message();
 
  void print() const;
 
 
  const TimeTag &timeTag() const { return mTimeTag; }
 
  const std::string &addressPattern() const { return mAddressPattern; }
 
  const std::string senderAddress() const { return std::string(mSenderAddr); }
 
  const std::string &typeTags() const { return mTypeTags; }
 
  Message &resetStream();
 
  Message &operator>>(int &v);    
  Message &operator>>(float &v);  
  Message &operator>>(double &v); 
  Message &operator>>(char &v);   
  Message &
  operator>>(const char *&v); 
  Message &
  operator>>(std::string &v);   
  Message &operator>>(Blob &v); 
 
protected:
  class Impl;
  Impl *mImpl;
  std::string mAddressPattern;
  std::string mTypeTags;
  TimeTag mTimeTag;
  char mSenderAddr[32];
};
 
class PacketHandler {
public:
  virtual ~PacketHandler() {}
 
  virtual void onMessage(Message &m) = 0;
};
 
class MessageConsumer {
public:
  virtual ~MessageConsumer() {}
  virtual bool consumeMessage(Message &m, std::string rootOSCPath) = 0;
};
 
class Send : public Packet {
  class SocketSender;
  std::unique_ptr<SocketSender> socketSender;
  std::string mAddress = "";
  uint16_t mPort = 0;
 
public:
  Send();
  Send(int size);
 
  Send(uint16_t port, const char *address = "localhost", al_sec timeout = 0,
       int size = 1024);
 
  ~Send();
 
  bool open(uint16_t port, const char *address);
 
  const std::string &address() const { return mAddress; }
  uint16_t port() const { return mPort; }
 
  size_t send();
 
  size_t send(const Packet &p);
 
  size_t send(const std::string &addr) {
    addMessage(addr);
    return send();
  }
 
  template <class A> size_t send(const std::string &addr, const A &a) {
    addMessage(addr, a);
    return send();
  }
 
  template <class A, class B>
  size_t send(const std::string &addr, const A &a, const B &b) {
    addMessage(addr, a, b);
    return send();
  }
 
  template <class A, class B, class C>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c) {
    addMessage(addr, a, b, c);
    return send();
  }
 
  template <class A, class B, class C, class D>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c,
              const D &d) {
    addMessage(addr, a, b, c, d);
    return send();
  }
 
  template <class A, class B, class C, class D, class E>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c,
              const D &d, const E &e) {
    addMessage(addr, a, b, c, d, e);
    return send();
  }
 
  template <class A, class B, class C, class D, class E, class F>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c,
              const D &d, const E &e, const F &f) {
    addMessage(addr, a, b, c, d, e, f);
    return send();
  }
 
  template <class A, class B, class C, class D, class E, class F, class G>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c,
              const D &d, const E &e, const F &f, const G &g) {
    addMessage(addr, a, b, c, d, e, f, g);
    return send();
  }
  template <class A, class B, class C, class D, class E, class F, class G,
            class H>
  size_t send(const std::string &addr, const A &a, const B &b, const C &c,
              const D &d, const E &e, const F &f, const G &g, const H &h) {
    addMessage(addr, a, b, c, d, e, f, g, h);
    return send();
  }
};
 
 
class Recv {
  class SocketReceiver;
  std::unique_ptr<SocketReceiver> socketReceiver;
 
public:
  Recv();
 
  Recv(uint16_t port, const char *address = "", al_sec timeout = 0);
 
  virtual ~Recv();
 
  bool open(uint16_t port, const char *address = "", al_sec timeout = 0);
 
  bool isOpen() { return mOpen; }
 
  const std::string &address() const { return mAddress; }
  uint16_t port() const { return mPort; }
 
  bool background() const { return mBackground; }
 
  const char *data() const { return &mBuffer[0]; }
 
  void bufferSize(int n) { mBuffer.resize(n); }
 
  Recv &handler(PacketHandler &v) {
    mHandlers.clear();
    return appendHandler(v);
  }
 
  Recv &appendHandler(PacketHandler &v) {
    mHandlers.push_back(&v);
    return *this;
  }
 
  int recv();
 
 
  bool start();
 
  void stop();
 
  void parse(const char *packet, int size, const char *senderAddr);
  void loop();
 
  static bool portAvailable(uint16_t port, const char *address = "");
 
  static std::vector<std::shared_ptr<Message>>
  parse(const char *packet, int size, TimeTag timeTag = 1,
        const char *senderAddr = nullptr);
 
protected:
  std::vector<PacketHandler *> mHandlers;
  std::vector<char> mBuffer;
  al::Thread mThread;
  bool mBackground;
  std::string mAddress = "";
  uint16_t mPort = 0;
  bool mOpen{false};
};
 
} // namespace osc
} // namespace al
 
#endif