Toby Harris
An Open Sound Control library for the mbed, created to be compatible with Recotana's OSCClass library (http://recotana.com) for the Arduino with Ethernet shield. It also uses parts of the OSC Transceiver(Sender/Receiver) code by xshige written by: Alvaro Cassinelli, October 2011 tweaked by: Toby Harris / *spark audio-visual, March 2012
Dependencies: NetServices mbed
mbedOSC.h@2:acfd0090c8e7, 2012-04-15 (annotated)
- Committer:
- tobyspark
- Date:
- Sun Apr 15 12:14:45 2012 +0000
- Revision:
- 2:acfd0090c8e7
- Parent:
- 1:ab7dc9550de6
- Child:
- 3:2b56849146d8
Who changed what in which revision?
| User | Revision | Line number | New contents of line |
|---|---|---|---|
| tobyspark | 2:acfd0090c8e7 | 1 | /* mbed OSC Library |
| tobyspark | 2:acfd0090c8e7 | 2 | This is an Open Sound Control library for the mbed, created to be compatible with Recotana's OSCClass library (http://recotana.com) for the |
| tobyspark | 0:49cdaebd52d5 | 3 | Arduino with Ethernet shield. I have also used parts of the OSC Transceiver(Sender/Receiver) code by xshige |
| tobyspark | 0:49cdaebd52d5 | 4 | written by: Alvaro Cassinelli, 7.10.2011 |
| tobyspark | 0:49cdaebd52d5 | 5 | tweaked by: Toby Harris / *spark audio-visual, 13.4.2012 |
| tobyspark | 0:49cdaebd52d5 | 6 | |
| tobyspark | 0:49cdaebd52d5 | 7 | This library is free software; you can redistribute it and/or |
| tobyspark | 0:49cdaebd52d5 | 8 | modify it under the terms of the GNU Lesser General Public |
| tobyspark | 0:49cdaebd52d5 | 9 | License version 2.1 as published by the Free Software Foundation. |
| tobyspark | 0:49cdaebd52d5 | 10 | Open Sound Control http://opensoundcontrol.org/ |
| tobyspark | 0:49cdaebd52d5 | 11 | |
| tobyspark | 0:49cdaebd52d5 | 12 | mbedOSC version 0.1 Specification (similar to Recotana's OSCClass library) |
| tobyspark | 0:49cdaebd52d5 | 13 | |
| tobyspark | 0:49cdaebd52d5 | 14 | ******** |
| tobyspark | 0:49cdaebd52d5 | 15 | Address : max 2 |
| tobyspark | 0:49cdaebd52d5 | 16 | "/ard" |
| tobyspark | 0:49cdaebd52d5 | 17 | "/ard/output" --address[0]="/ard" :max 15character |
| tobyspark | 0:49cdaebd52d5 | 18 | --address[1]="/output" :max 15character |
| tobyspark | 0:49cdaebd52d5 | 19 | |
| tobyspark | 0:49cdaebd52d5 | 20 | ******* |
| tobyspark | 0:49cdaebd52d5 | 21 | TypeTag : max 2 |
| tobyspark | 0:49cdaebd52d5 | 22 | |
| tobyspark | 0:49cdaebd52d5 | 23 | "i" - long or unsigned long |
| tobyspark | 0:49cdaebd52d5 | 24 | "f" - double |
| tobyspark | 0:49cdaebd52d5 | 25 | |
| tobyspark | 0:49cdaebd52d5 | 26 | ******* |
| tobyspark | 0:49cdaebd52d5 | 27 | arg : max 2 |
| tobyspark | 0:49cdaebd52d5 | 28 | |
| tobyspark | 0:49cdaebd52d5 | 29 | ******* |
| tobyspark | 0:49cdaebd52d5 | 30 | Example of an OSC message: "/mbed/test1, if 50 32.4" (Note: this is not the byte string |
| tobyspark | 0:49cdaebd52d5 | 31 | sent as UDP packet - there are no spaces, and arguments are in binary, BIG ENDIAN) |
| tobyspark | 0:49cdaebd52d5 | 32 | */ |
| tobyspark | 0:49cdaebd52d5 | 33 | |
| tobyspark | 0:49cdaebd52d5 | 34 | #ifndef mbedOSC_h |
| tobyspark | 0:49cdaebd52d5 | 35 | #define mbedOSC_h |
| tobyspark | 0:49cdaebd52d5 | 36 | |
| tobyspark | 0:49cdaebd52d5 | 37 | #include "mbed.h" |
| tobyspark | 0:49cdaebd52d5 | 38 | #include "EthernetNetIf.h" |
| tobyspark | 0:49cdaebd52d5 | 39 | #include "UDPSocket.h" |
| tobyspark | 0:49cdaebd52d5 | 40 | |
| tobyspark | 0:49cdaebd52d5 | 41 | // setup IP of destination (computer): |
| tobyspark | 0:49cdaebd52d5 | 42 | #define DEFAULT_SEND_PORT 12000 |
| tobyspark | 0:49cdaebd52d5 | 43 | //Host sendHost(IpAddr(10, 0, 0, 1), DEFAULT_SEND_PORT, NULL); // Send Port |
| tobyspark | 0:49cdaebd52d5 | 44 | // set IP of origin of UDP packets - the mbed acts as a SERVER here, and needs to bind the socket to the "client" (the computer) |
| tobyspark | 0:49cdaebd52d5 | 45 | #define DEFAULT_RECEIVE_PORT 57130 |
| tobyspark | 0:49cdaebd52d5 | 46 | //Host recHost(IpAddr(10, 0, 0, 1), DEFAULT_RECEIVE_PORT, NULL); // Receive Port |
| tobyspark | 0:49cdaebd52d5 | 47 | //UDPSocket udpRec,udpSend; |
| tobyspark | 0:49cdaebd52d5 | 48 | |
| tobyspark | 0:49cdaebd52d5 | 49 | |
| tobyspark | 0:49cdaebd52d5 | 50 | #define MAX_ADDRESS 2 |
| tobyspark | 0:49cdaebd52d5 | 51 | #define MAX_ARG 2 |
| tobyspark | 0:49cdaebd52d5 | 52 | |
| tobyspark | 0:49cdaebd52d5 | 53 | #define TYPE_INT 1 |
| tobyspark | 0:49cdaebd52d5 | 54 | #define TYPE_FLOAT 2 |
| tobyspark | 0:49cdaebd52d5 | 55 | |
| tobyspark | 0:49cdaebd52d5 | 56 | |
| tobyspark | 2:acfd0090c8e7 | 57 | /** |
| tobyspark | 2:acfd0090c8e7 | 58 | * Container class for OSC messages (receiving or sending) |
| tobyspark | 2:acfd0090c8e7 | 59 | */ |
| tobyspark | 0:49cdaebd52d5 | 60 | class OSCMessage{ |
| tobyspark | 0:49cdaebd52d5 | 61 | |
| tobyspark | 0:49cdaebd52d5 | 62 | private: |
| tobyspark | 0:49cdaebd52d5 | 63 | |
| tobyspark | 0:49cdaebd52d5 | 64 | char *address[MAX_ADDRESS]; // these are strings (as char*) |
| tobyspark | 0:49cdaebd52d5 | 65 | uint8_t addressNum; // current number of addresses in the message (ex: "/ard/test" --> the number of the addresses is 2) |
| tobyspark | 0:49cdaebd52d5 | 66 | |
| tobyspark | 0:49cdaebd52d5 | 67 | char typeTag[MAX_ARG]; |
| tobyspark | 0:49cdaebd52d5 | 68 | |
| tobyspark | 0:49cdaebd52d5 | 69 | void *arg[MAX_ARG]; |
| tobyspark | 0:49cdaebd52d5 | 70 | uint8_t argNum; |
| tobyspark | 0:49cdaebd52d5 | 71 | |
| tobyspark | 0:49cdaebd52d5 | 72 | // Information about the connection: |
| tobyspark | 0:49cdaebd52d5 | 73 | //uint8_t ip[4]; |
| tobyspark | 0:49cdaebd52d5 | 74 | //uint16_t port; |
| tobyspark | 0:49cdaebd52d5 | 75 | Host host; |
| tobyspark | 0:49cdaebd52d5 | 76 | |
| tobyspark | 0:49cdaebd52d5 | 77 | public: |
| tobyspark | 1:ab7dc9550de6 | 78 | /** A container for an OSC message to receive or send */ |
| tobyspark | 0:49cdaebd52d5 | 79 | OSCMessage(); |
| tobyspark | 1:ab7dc9550de6 | 80 | |
| tobyspark | 1:ab7dc9550de6 | 81 | /** Return the IpAddr object */ |
| tobyspark | 1:ab7dc9550de6 | 82 | const IpAddr& getIp(); |
| tobyspark | 1:ab7dc9550de6 | 83 | /** Return the port */ |
| tobyspark | 1:ab7dc9550de6 | 84 | const int& getPort(); |
| tobyspark | 0:49cdaebd52d5 | 85 | |
| tobyspark | 2:acfd0090c8e7 | 86 | /** Gets the address string of the OSC message |
| tobyspark | 2:acfd0090c8e7 | 87 | * |
| tobyspark | 2:acfd0090c8e7 | 88 | * @param [in] <-- _index is the index of the address string (byte) |
| tobyspark | 2:acfd0090c8e7 | 89 | * return pointer of the address string (char *) |
| tobyspark | 2:acfd0090c8e7 | 90 | * @note ex. "/ard/test"<br> |
| tobyspark | 2:acfd0090c8e7 | 91 | * getAddress(0) = "/ard"<br> |
| tobyspark | 2:acfd0090c8e7 | 92 | * getAddress(1) = "/test" |
| tobyspark | 2:acfd0090c8e7 | 93 | * @attention It is maximum number of the addresses is 2<br> |
| tobyspark | 2:acfd0090c8e7 | 94 | * In this case "/ard/test1/test2"<br> |
| tobyspark | 2:acfd0090c8e7 | 95 | * ignore it after "/test2" |
| tobyspark | 1:ab7dc9550de6 | 96 | */ |
| tobyspark | 0:49cdaebd52d5 | 97 | char *getAddress(uint8_t _index); //retturn address |
| tobyspark | 1:ab7dc9550de6 | 98 | |
| tobyspark | 2:acfd0090c8e7 | 99 | /** Gets the TopAddress string of the OSC message (this is just the address with index 0) |
| tobyspark | 2:acfd0090c8e7 | 100 | |
| tobyspark | 1:ab7dc9550de6 | 101 | param[in] None |
| tobyspark | 1:ab7dc9550de6 | 102 | return pointer of the TopAddress string (char *), i.e. address[0] |
| tobyspark | 1:ab7dc9550de6 | 103 | Example: In the case "/ard/test", getTopAddress() = "/ard" (WITH the slash "/") |
| tobyspark | 1:ab7dc9550de6 | 104 | *//* |
| tobyspark | 1:ab7dc9550de6 | 105 | Gets the TopAddress string of the OSC message (this is just the address with index 0) |
| tobyspark | 1:ab7dc9550de6 | 106 | param[in] None |
| tobyspark | 1:ab7dc9550de6 | 107 | return pointer of the TopAddress string (char *), i.e. address[0] |
| tobyspark | 1:ab7dc9550de6 | 108 | Example: In the case "/ard/test", getTopAddress() = "/ard" (WITH the slash "/") |
| tobyspark | 1:ab7dc9550de6 | 109 | */ |
| tobyspark | 0:49cdaebd52d5 | 110 | char *getTopAddress(); //return address[0] :"/ard" |
| tobyspark | 1:ab7dc9550de6 | 111 | |
| tobyspark | 2:acfd0090c8e7 | 112 | /** |
| tobyspark | 1:ab7dc9550de6 | 113 | Gets the "SubAddress" string of the OSC message (this is just the address with index 1) |
| tobyspark | 1:ab7dc9550de6 | 114 | param[in] None |
| tobyspark | 1:ab7dc9550de6 | 115 | return pointer of the SubAddress string (char *), i.e. address[1] |
| tobyspark | 1:ab7dc9550de6 | 116 | Example: in the case "/ard/test", getSubAddress() = "/test" (WITH the slash "/") |
| tobyspark | 1:ab7dc9550de6 | 117 | */ |
| tobyspark | 0:49cdaebd52d5 | 118 | char *getSubAddress(); //return address[1] :"/test" |
| tobyspark | 1:ab7dc9550de6 | 119 | |
| tobyspark | 2:acfd0090c8e7 | 120 | /** |
| tobyspark | 1:ab7dc9550de6 | 121 | Gets the number of the OSC message address |
| tobyspark | 1:ab7dc9550de6 | 122 | param[in] None |
| tobyspark | 1:ab7dc9550de6 | 123 | return number of the OSC message address (byte) |
| tobyspark | 1:ab7dc9550de6 | 124 | Examples: "/ard" --> the number of the addresses is 1 |
| tobyspark | 1:ab7dc9550de6 | 125 | "/ard/test" --> the number of the addresses is 2 |
| tobyspark | 1:ab7dc9550de6 | 126 | Attention: the maximum number of addresses is 2 (MAX_ADDRESS) |
| tobyspark | 1:ab7dc9550de6 | 127 | */ |
| tobyspark | 0:49cdaebd52d5 | 128 | uint8_t getAddressNum(); //return 2 |
| tobyspark | 0:49cdaebd52d5 | 129 | |
| tobyspark | 2:acfd0090c8e7 | 130 | /** |
| tobyspark | 1:ab7dc9550de6 | 131 | Gets the TypeTag string (with index) of the OSC message |
| tobyspark | 1:ab7dc9550de6 | 132 | param[in] <--_index is the index of the TypeTag string (byte) |
| tobyspark | 1:ab7dc9550de6 | 133 | return: TypeTag char (char) |
| tobyspark | 1:ab7dc9550de6 | 134 | Example: in the case of a total typetag string equal to "if", getTypeTag(0) = 'i' and getTypeTag(1) = 'f' |
| tobyspark | 1:ab7dc9550de6 | 135 | Attention: MAX_ARG is maximum number of the args, if the index argument is larger, it will be constrained to this max. |
| tobyspark | 1:ab7dc9550de6 | 136 | */ |
| tobyspark | 0:49cdaebd52d5 | 137 | char getTypeTag(uint8_t _index); //_index=0 ->'i' |
| tobyspark | 0:49cdaebd52d5 | 138 | //_index=1 ->'f' |
| tobyspark | 0:49cdaebd52d5 | 139 | |
| tobyspark | 2:acfd0090c8e7 | 140 | /** |
| tobyspark | 1:ab7dc9550de6 | 141 | Gets the number of the OSC message args |
| tobyspark | 1:ab7dc9550de6 | 142 | param[in] None |
| tobyspark | 1:ab7dc9550de6 | 143 | return number of the args (byte) |
| tobyspark | 1:ab7dc9550de6 | 144 | Example: "i" 123 --> number of the OSC message args is 1 |
| tobyspark | 1:ab7dc9550de6 | 145 | "if" 123 54.24 --> number of the OSC message args is 2 |
| tobyspark | 1:ab7dc9550de6 | 146 | Attention: the maximum number of args is 2 (MAX_ARG) |
| tobyspark | 1:ab7dc9550de6 | 147 | */ |
| tobyspark | 0:49cdaebd52d5 | 148 | uint8_t getArgNum(); //return 2 |
| tobyspark | 0:49cdaebd52d5 | 149 | |
| tobyspark | 2:acfd0090c8e7 | 150 | /** |
| tobyspark | 1:ab7dc9550de6 | 151 | Get the args of the OSC message with an integer value |
| tobyspark | 1:ab7dc9550de6 | 152 | param[in] <--_index is (an int, or uint8_t), corresponding to the index of the args (byte) |
| tobyspark | 1:ab7dc9550de6 | 153 | return: integer value (long, or int32_t) |
| tobyspark | 1:ab7dc9550de6 | 154 | Example: in the case "if" 123 54.24, getArgInt(0) = 123 |
| tobyspark | 1:ab7dc9550de6 | 155 | Noe: "i" is integer, but the return type is "long" |
| tobyspark | 1:ab7dc9550de6 | 156 | Note: When a index is bigger than the number of the args, it is set to the number of the args |
| tobyspark | 1:ab7dc9550de6 | 157 | */ |
| tobyspark | 0:49cdaebd52d5 | 158 | int32_t getArgInt(uint8_t _index); //_index=0 -> 123 |
| tobyspark | 1:ab7dc9550de6 | 159 | |
| tobyspark | 2:acfd0090c8e7 | 160 | /** |
| tobyspark | 1:ab7dc9550de6 | 161 | Get the args of the OSC message with a float value |
| tobyspark | 1:ab7dc9550de6 | 162 | param[in] <--_index is the index of the args |
| tobyspark | 1:ab7dc9550de6 | 163 | return: float value (double) |
| tobyspark | 1:ab7dc9550de6 | 164 | note: In this case "if" 123 54.24, getArgFloat(1) = 54.24 |
| tobyspark | 1:ab7dc9550de6 | 165 | attention: arg declared as float, but return value cast as "double" |
| tobyspark | 1:ab7dc9550de6 | 166 | attention: When index is bigger than the number of the args, it is set to the number of the args |
| tobyspark | 1:ab7dc9550de6 | 167 | */ |
| tobyspark | 0:49cdaebd52d5 | 168 | double getArgFloat(uint8_t _index); //_index=1 -> 54.21 |
| tobyspark | 0:49cdaebd52d5 | 169 | |
| tobyspark | 0:49cdaebd52d5 | 170 | |
| tobyspark | 2:acfd0090c8e7 | 171 | /** |
| tobyspark | 1:ab7dc9550de6 | 172 | Set TopAddress string of OSC Message |
| tobyspark | 1:ab7dc9550de6 | 173 | param[in] <-- _address is a string pointer for the TopAddress String (char *). NOTE: is this a good idea? why not pass as const, and do allocation here? |
| tobyspark | 1:ab7dc9550de6 | 174 | return: None |
| tobyspark | 1:ab7dc9550de6 | 175 | Example: if the complete address string is "/ard/test", we set the topaddress as follows: char top[]="/ard" (allocation done here!), then setTopAddress(top) |
| tobyspark | 1:ab7dc9550de6 | 176 | */ |
| tobyspark | 0:49cdaebd52d5 | 177 | void setTopAddress(char *_address); //set address[0] |
| tobyspark | 1:ab7dc9550de6 | 178 | |
| tobyspark | 2:acfd0090c8e7 | 179 | /** |
| tobyspark | 1:ab7dc9550de6 | 180 | Set SubAddress string of the OSC Message |
| tobyspark | 1:ab7dc9550de6 | 181 | param[in] <-- _address is a string pointer for the SubAddress String (char *) |
| tobyspark | 1:ab7dc9550de6 | 182 | return: None |
| tobyspark | 1:ab7dc9550de6 | 183 | Example: if the complete address string is "/ard/test", we set the subaddress as follows: char sub[]="/test" (allocation done here!), then setSubAddress(sub) |
| tobyspark | 1:ab7dc9550de6 | 184 | Attention: we should call first setTopAddress, and then setSubAddress. The order is important. This does not seems like a good idea... |
| tobyspark | 1:ab7dc9550de6 | 185 | */ |
| tobyspark | 0:49cdaebd52d5 | 186 | void setSubAddress(char *_address); //set address[1] |
| tobyspark | 1:ab7dc9550de6 | 187 | |
| tobyspark | 2:acfd0090c8e7 | 188 | /** |
| tobyspark | 1:ab7dc9550de6 | 189 | Set the complete Address string of the OSC Message (top and sub addresses) |
| tobyspark | 1:ab7dc9550de6 | 190 | param[in] <-- _topAddress and _subAddress are the string pointers to top and sub addresses (char *) |
| tobyspark | 1:ab7dc9550de6 | 191 | return: None |
| tobyspark | 1:ab7dc9550de6 | 192 | Example: in the case "/ard/test", we need to do: char top[]="/ard", char sub[]="/test", and then setAddress(top,sub) |
| tobyspark | 1:ab7dc9550de6 | 193 | Reminder: in this implementation, the maximum number of addresses is MAX_ADDRESS=2 |
| tobyspark | 1:ab7dc9550de6 | 194 | */ |
| tobyspark | 0:49cdaebd52d5 | 195 | void setAddress(char *_topAddress, |
| tobyspark | 0:49cdaebd52d5 | 196 | char *_subAddress); |
| tobyspark | 1:ab7dc9550de6 | 197 | |
| tobyspark | 2:acfd0090c8e7 | 198 | /** |
| tobyspark | 1:ab7dc9550de6 | 199 | Set address string using index (here 0 or 1) |
| tobyspark | 1:ab7dc9550de6 | 200 | Example: "/ard/test", char adr[]="/ard", setAddress(0,adr), char adr2[]="/test", setAddress(1,adr) |
| tobyspark | 1:ab7dc9550de6 | 201 | */ |
| tobyspark | 0:49cdaebd52d5 | 202 | void setAddress(uint8_t _index, //set 0,address[0] |
| tobyspark | 0:49cdaebd52d5 | 203 | char *_address); |
| tobyspark | 0:49cdaebd52d5 | 204 | //set 1,address[1] |
| tobyspark | 1:ab7dc9550de6 | 205 | |
| tobyspark | 2:acfd0090c8e7 | 206 | /** |
| tobyspark | 1:ab7dc9550de6 | 207 | Set IP Address of the OSC Message (for SENDING messages - for receiving this will be done when receiving something ) |
| tobyspark | 1:ab7dc9550de6 | 208 | param[in] <-- _ip pointer of IP Address array (byte *) |
| tobyspark | 1:ab7dc9550de6 | 209 | Example: IP=192.168.0.99, then we have to do: ip[]={192,168,0,1}, then setIp(ip) |
| tobyspark | 1:ab7dc9550de6 | 210 | */ |
| tobyspark | 0:49cdaebd52d5 | 211 | void setIp( uint8_t *_ip ); //set ip |
| tobyspark | 1:ab7dc9550de6 | 212 | |
| tobyspark | 1:ab7dc9550de6 | 213 | /*! |
| tobyspark | 1:ab7dc9550de6 | 214 | Set IP Address to the OSC Message container (not through pointer) |
| tobyspark | 1:ab7dc9550de6 | 215 | Example: IP=192.168.0.99 => setIp(192,168,0,99) |
| tobyspark | 1:ab7dc9550de6 | 216 | */ |
| tobyspark | 0:49cdaebd52d5 | 217 | void setIp(uint8_t _ip1, //set(192, |
| tobyspark | 0:49cdaebd52d5 | 218 | uint8_t _ip2, // 168, |
| tobyspark | 0:49cdaebd52d5 | 219 | uint8_t _ip3, // 0, |
| tobyspark | 0:49cdaebd52d5 | 220 | uint8_t _ip4); // 100) |
| tobyspark | 1:ab7dc9550de6 | 221 | |
| tobyspark | 1:ab7dc9550de6 | 222 | /* |
| tobyspark | 1:ab7dc9550de6 | 223 | Set PortNo for the OSC Message |
| tobyspark | 1:ab7dc9550de6 | 224 | @param[in] _port PortNo (unsigned int) |
| tobyspark | 1:ab7dc9550de6 | 225 | @return None |
| tobyspark | 1:ab7dc9550de6 | 226 | */ |
| tobyspark | 0:49cdaebd52d5 | 227 | void setPort( uint16_t _port ); |
| tobyspark | 0:49cdaebd52d5 | 228 | |
| tobyspark | 1:ab7dc9550de6 | 229 | /* |
| tobyspark | 1:ab7dc9550de6 | 230 | Set TypeTag and args to the OSC Message container |
| tobyspark | 1:ab7dc9550de6 | 231 | @param[in] types TypeTag string "i"(integer) or"f"(float) (char *) |
| tobyspark | 1:ab7dc9550de6 | 232 | @param[in] ... Pointer of the Args(variable argument) .. |
| tobyspark | 1:ab7dc9550de6 | 233 | @return None |
| tobyspark | 1:ab7dc9550de6 | 234 | @Example: |
| tobyspark | 1:ab7dc9550de6 | 235 | (1) integer 123: (NOTE: integers are LONG) |
| tobyspark | 1:ab7dc9550de6 | 236 | long v1=123; sendMes.setArgs("i",&v1) |
| tobyspark | 1:ab7dc9550de6 | 237 | (2)integer:123 and float:52.14 |
| tobyspark | 1:ab7dc9550de6 | 238 | long v1=123; double v2=52.14; sendMes.setArgs("if",&v1,&v2) |
| tobyspark | 1:ab7dc9550de6 | 239 | Attention: in this implementation, the maximum number of the args is 2 |
| tobyspark | 1:ab7dc9550de6 | 240 | (if setArgs("iff",&v1,&v2,&v3), data is ignored after &v3) |
| tobyspark | 1:ab7dc9550de6 | 241 | */ |
| tobyspark | 0:49cdaebd52d5 | 242 | void setArgs( char *types , ... ); //set ("if",&v1,&v2) |
| tobyspark | 0:49cdaebd52d5 | 243 | |
| tobyspark | 0:49cdaebd52d5 | 244 | friend class OSCClass; |
| tobyspark | 0:49cdaebd52d5 | 245 | |
| tobyspark | 0:49cdaebd52d5 | 246 | }; |
| tobyspark | 0:49cdaebd52d5 | 247 | |
| tobyspark | 0:49cdaebd52d5 | 248 | |
| tobyspark | 0:49cdaebd52d5 | 249 | |
| tobyspark | 0:49cdaebd52d5 | 250 | /* ==================================== OSCClass for sending and receiving OSC messages using UDP protocol ===================================== */ |
| tobyspark | 0:49cdaebd52d5 | 251 | |
| tobyspark | 0:49cdaebd52d5 | 252 | #include "UDPSocket.h" |
| tobyspark | 0:49cdaebd52d5 | 253 | |
| tobyspark | 0:49cdaebd52d5 | 254 | class OSCClass { |
| tobyspark | 0:49cdaebd52d5 | 255 | |
| tobyspark | 0:49cdaebd52d5 | 256 | private: |
| tobyspark | 0:49cdaebd52d5 | 257 | |
| tobyspark | 0:49cdaebd52d5 | 258 | UDPSocket udpRec,udpSend; |
| tobyspark | 0:49cdaebd52d5 | 259 | char rcvBuff[256]; // raw buffer for UDP packets (udpRec.recvfrom( buf, 256, &host ) )) |
| tobyspark | 0:49cdaebd52d5 | 260 | int buflength; |
| tobyspark | 0:49cdaebd52d5 | 261 | |
| tobyspark | 0:49cdaebd52d5 | 262 | OSCMessage *receiverMessage; |
| tobyspark | 0:49cdaebd52d5 | 263 | OSCMessage *sendContainer; |
| tobyspark | 0:49cdaebd52d5 | 264 | |
| tobyspark | 0:49cdaebd52d5 | 265 | char tempAddress[MAX_ADDRESS][16]; |
| tobyspark | 0:49cdaebd52d5 | 266 | uint8_t tempArg[MAX_ARG][4]; |
| tobyspark | 0:49cdaebd52d5 | 267 | |
| tobyspark | 0:49cdaebd52d5 | 268 | void decodePacket( OSCMessage *_mes); // makes OSC message from packet |
| tobyspark | 0:49cdaebd52d5 | 269 | |
| tobyspark | 0:49cdaebd52d5 | 270 | public: |
| tobyspark | 0:49cdaebd52d5 | 271 | |
| tobyspark | 1:ab7dc9550de6 | 272 | /** Wraps the UDP functions to send and receive OSC messages */ |
| tobyspark | 0:49cdaebd52d5 | 273 | OSCClass(); |
| tobyspark | 1:ab7dc9550de6 | 274 | |
| tobyspark | 1:ab7dc9550de6 | 275 | /* |
| tobyspark | 1:ab7dc9550de6 | 276 | This sets "binds" the received message to the receiver container of the communication object |
| tobyspark | 1:ab7dc9550de6 | 277 | @param[in]<--_mes is a pointer to the "receiveing" OSC message (OSCMessage *) |
| tobyspark | 1:ab7dc9550de6 | 278 | */ |
| tobyspark | 0:49cdaebd52d5 | 279 | OSCClass(OSCMessage *_mes); // set the receiver message container |
| tobyspark | 1:ab7dc9550de6 | 280 | |
| tobyspark | 1:ab7dc9550de6 | 281 | /* |
| tobyspark | 1:ab7dc9550de6 | 282 | Ignore: See messageReceivedCallback instead. This is called by the UDPSocket... and should be a protected function and we friend UDPSocket? |
| tobyspark | 1:ab7dc9550de6 | 283 | */ |
| tobyspark | 0:49cdaebd52d5 | 284 | void onUDPSocketEvent(UDPSocketEvent e); |
| tobyspark | 0:49cdaebd52d5 | 285 | |
| tobyspark | 1:ab7dc9550de6 | 286 | /* |
| tobyspark | 1:ab7dc9550de6 | 287 | This initializes the OSC communication object with default receiving port (DEFAULT_REC_PORT) |
| tobyspark | 1:ab7dc9550de6 | 288 | param[in]: None |
| tobyspark | 1:ab7dc9550de6 | 289 | return: None |
| tobyspark | 1:ab7dc9550de6 | 290 | */ |
| tobyspark | 0:49cdaebd52d5 | 291 | void begin(); |
| tobyspark | 1:ab7dc9550de6 | 292 | |
| tobyspark | 1:ab7dc9550de6 | 293 | /* |
| tobyspark | 1:ab7dc9550de6 | 294 | Initialize an OSC object with arbitrary listening port |
| tobyspark | 1:ab7dc9550de6 | 295 | param[in] <-- _recievePort, is the listening ("receiving") Port No (unsigned int) |
| tobyspark | 1:ab7dc9550de6 | 296 | return: None |
| tobyspark | 1:ab7dc9550de6 | 297 | */ |
| tobyspark | 0:49cdaebd52d5 | 298 | void begin(uint16_t _recievePort); |
| tobyspark | 1:ab7dc9550de6 | 299 | |
| tobyspark | 1:ab7dc9550de6 | 300 | /* |
| tobyspark | 1:ab7dc9550de6 | 301 | Stop OSC communication (in fact, only the receiver - the server side) |
| tobyspark | 1:ab7dc9550de6 | 302 | */ |
| tobyspark | 0:49cdaebd52d5 | 303 | void stop(); |
| tobyspark | 0:49cdaebd52d5 | 304 | |
| tobyspark | 0:49cdaebd52d5 | 305 | //new OSC data in the receiver message container: |
| tobyspark | 0:49cdaebd52d5 | 306 | bool newMessage; |
| tobyspark | 0:49cdaebd52d5 | 307 | |
| tobyspark | 1:ab7dc9550de6 | 308 | /* |
| tobyspark | 1:ab7dc9550de6 | 309 | Set a OSC receive message container |
| tobyspark | 1:ab7dc9550de6 | 310 | param[in] _mes Pointer to the OSC receive message container (OSCMessage *) |
| tobyspark | 1:ab7dc9550de6 | 311 | return None |
| tobyspark | 1:ab7dc9550de6 | 312 | */ |
| tobyspark | 0:49cdaebd52d5 | 313 | void setReceiveMessage( OSCMessage *_mes ); //set receive OSCmessage container (note: the message has a "host" object from which we get the upd packets) |
| tobyspark | 1:ab7dc9550de6 | 314 | |
| tobyspark | 1:ab7dc9550de6 | 315 | /* |
| tobyspark | 1:ab7dc9550de6 | 316 | Get the received OSC message (note: this is another way to access the message directly from the OSCClass object). |
| tobyspark | 1:ab7dc9550de6 | 317 | The advantage is that we will signal that we read the message, and will be able to query if a NEW message arrived |
| tobyspark | 1:ab7dc9550de6 | 318 | (Alternatively, one could have a function pointer to pass to the OSC object, that will be called each time a new packet is received: TO DO) |
| tobyspark | 1:ab7dc9550de6 | 319 | */ |
| tobyspark | 0:49cdaebd52d5 | 320 | OSCMessage *getMessage(); //return received OSCmessage |
| tobyspark | 0:49cdaebd52d5 | 321 | |
| tobyspark | 0:49cdaebd52d5 | 322 | //buffer clear |
| tobyspark | 0:49cdaebd52d5 | 323 | //void flush(); |
| tobyspark | 0:49cdaebd52d5 | 324 | |
| tobyspark | 1:ab7dc9550de6 | 325 | /* |
| tobyspark | 1:ab7dc9550de6 | 326 | Send an OSC Message (message contain the host ip and port where the message data has to be sent) |
| tobyspark | 1:ab7dc9550de6 | 327 | param[in] _mes Pointer to the OSC message container (OSCMessage *) |
| tobyspark | 1:ab7dc9550de6 | 328 | return None |
| tobyspark | 1:ab7dc9550de6 | 329 | */ |
| tobyspark | 0:49cdaebd52d5 | 330 | void sendOsc( OSCMessage *_mes ); //set&send OSCmessage (note: it will be sent to the host defined in the message container) |
| tobyspark | 0:49cdaebd52d5 | 331 | |
| tobyspark | 0:49cdaebd52d5 | 332 | //to be set by host program, will be called on receipt of an OSC message |
| tobyspark | 0:49cdaebd52d5 | 333 | FunctionPointer messageReceivedCallback; |
| tobyspark | 0:49cdaebd52d5 | 334 | }; |
| tobyspark | 0:49cdaebd52d5 | 335 | |
| tobyspark | 0:49cdaebd52d5 | 336 | #endif |