Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/2bbb/ofxPubSubOsc

bind OSC messages and values with only writing tiny codes on setup once.
https://github.com/2bbb/ofxPubSubOsc

ofxaddons ofxosc openframeworks openframeworks-addon osc

Last synced: 7 days ago
JSON representation

bind OSC messages and values with only writing tiny codes on setup once.

Host: GitHub
URL: https://github.com/2bbb/ofxPubSubOsc
Owner: 2bbb
License: mit
Created: 2015-05-09T19:18:40.000Z (over 9 years ago)
Default Branch: master
Last Pushed: 2024-04-03T14:22:52.000Z (7 months ago)
Last Synced: 2024-08-02T17:35:06.127Z (3 months ago)
Topics: ofxaddons, ofxosc, openframeworks, openframeworks-addon, osc
Language: C++
Homepage:
Size: 446 KB
Stars: 75
Watchers: 8
Forks: 7
Open Issues: 0
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

        # ofxPubSubOsc

easy utility for publish/subscribe OSC message.

## Dependencies

* ofxOsc

## Notice

* this addon is tested with oF0.9.8~

* if you use oF0.9.0~, then you can use `std::function`! detail: [API Reference](API_Reference.md#API_lambda_callback)

* **if you use oF~0.8.4, then you can use [branch:v0_1_x_oF084](../../tree/v0_1_x_oF084)**

* if you have challange spirit, please use dev/vX.Y.Z branch.

* if you want to join development ofxPubSubOsc, open the issue and post the PR for dev/vX.Y.Z.

## TOC

* [How to use](#HowToUse)

* [Simple API Reference](#SimpleAPI)

	* [ofxSubscribeOsc](#SimpleAPI_ofxSubscribeOsc)

	* [ofxPublishOsc](#SimpleAPI_ofxPublishOsc)

	* [ofxRegisterPublishingOsc](#SimpleAPI_ofxRegisterPublishingOsc)

* [Supported types](#SupportedTypes)

	* [Arithmetic](#SupportedTypes_Arithmetic)

	* [String](#SupportedTypes_String)

	* [openframeworks basic types](#SupportedTypes_ofBasic)

	* [ofParameter with supported types](#SupportedTypes_ofParameter)

	* [array/vector of supported types](#SupportedTypes_ArrayVector)

	* [Callback](#SupportedTypes_Callback)

* [Update history](#UpdateHistory)

* [License](#License)

* [Author](#Author)

* [Supporting Contributor](#SuppotingContributor)

* [Special Thanks](#SpecialThanks)

* [At the last](#AtTheLast)

## How to use

```cpp

class ofApp : public ofBaseApp {

	int foo;

	ofColor c;

	ofPoint p;

public:

	void setup() {

		ofxSubscribeOsc(9005, "/foo", foo);

		ofxSubscribeOsc(9005, "/color", c);

		ofxSubscribeOsc(9005, "/p", p);

		

		ofxPublishOsc("localhost", 9006, "/fps", &ofGetFrameRate);

		

		ofxSubscribeOsc(9005, "/lambda", [](const std::string &str){

			ofLogNotice() << "receive " << str;

		});

		ofxSubscribeOsc(9005, "/trigger_event", [](){

			ofLogNotice() << "receive trigger_event";

		});

	}

	

	void update() {

		// do NOTHING about OSC on update!!!

	}

	

	void draw() {

		ofSetColor(c);

		ofDrawCircle(p, 5);

	}

};

```

## Simple API Reference

_API Reference is imperfect now._

#### If you want to use advanced features, see [Advanced](API_Reference.md)

### ofxSubscribeOsc

* void ofxSubscribeOsc(int _port_, const string &_address_, [SupportedType](#SupportedTypes) &_value_);

bind a value to the argument(s) of OSC messages with an address pattern _address_ incoming to _port_.

#### See [more ofxSubscribeOsc](API_Reference.md#API_ofxSubscribeOsc)

* ofxUnsubscribeOsc(int _port_, const string &_address_);

unbind from OSC messages with an address pattern _address_ incoming to _port_.

* ofxUnsubscribeOsc(int _port_);

unbind from OSC messages with any address patterns incoming to _port_.

* if you want to pick up OSCs which do not match the subscribed addresses, see [ofxSetLeadkedOscPicker](API_Reference.md#API_ofxSetLeadkedOscPicker)

#### See [class ofxOscSubscriberManager](API_Reference.md#Advanced_ofxOscSubscriberManager), [class ofxOscSubscriber](API_Reference.md#Advanced_ofxOscSubscriber)

### ofxPublishOsc

* void ofxPublishOsc(const string &_ip_, int _port_, const string &_address_, [SupportedType](#SupportedTypes) &_value_, bool _whenValueIsChanged_ = **true**);

publish _value_ as an OSC message with an address pattern _address_ to _ip:port_ every time the _value_ has changed. If _whenValueIsChanged_ is set to **false**, then the binded value is sent **every frame** after `App::update`.

#### See [more ofxPublishOsc](API_Reference.md#API_ofxPublishOsc), [ofxPublishOscIf](API_Reference.md#API_ofxPublishOscIf)

* void ofxUnpublishOsc(const string &_ip_, int _port_, const string &_address_);

unbind a publisher sending OSC message with an address pattern _address_ to _ip:port_.

* void ofxUnpublishOsc(const string &_ip_, int _port_);

unbind all the publishers sending to _ip:port_.

#### See [class ofxOscPublisherManager](API_Reference.md#Advanced_ofxOscPublisherManager), [class ofxOscPublisher](API_Reference.md#Advanced_ofxOscPublisher)

### ofxRegisterPublishingOsc

* void ofxRegisterPublishingOsc(const string &_ip_, int _port_, const string &_address_, [SupportedType](#SupportedTypes) &_value_)

* void ofxPublishRegisteredOsc(const string &_ip_, int _port_, const string &_address_)

register value as an OSC message with an address pattern _address_ to _ip:port_. and publish when call `ofxPublishRegisteredOsc(ip, port, address)`.

* void ofxUnregisterPublishingOsc(const string &_ip_, int _port_, const string &_address_)

unregister OSC message with an address pattern _address_ to _ip:port_.

* void ofxUnregisterPublishingOsc(const string &_ip_, int _port_)

unregister all the messages sending to _ip:port_.

**NOTE**: registable type is same to `ofxPublishOsc`. see [more ofxPublishOsc](API_Reference.md#API_ofxPublishOsc).

### ofxSendOsc

* void ofxSendOsc(const string &_ip_, int _port_, const string &_address_, Arguments && ... arguments)

## Supported types

* Arithmetic is any type of Int32, Int64 or Float

### Arithmetic (Int32, Int64, Float)

* `bool` (published as _Int32_)

* `unsigned char`, `char` (published as _Int32_)

* `unsigned short`, `short` (published as _Int32_)

* `unsigned int`, `int` (published as _Int32_ or _Int64_ (if `sizeof(int) == 8` then _Int64_))

* `unsigned long`, `long` (published as _Int64_ or _Int64_ (if `sizeof(int) == 8` then _Int64_))

* `unsigned long long`, `long long` (published as _Int64_)

* `float` (published as _Float_)

* `double` (published as _Float_)

**NOTE**: `long double` is not guaranteed

### String (String)

* `string`

### openframeworks basic types

#### Arithmetic\[2\]

* `ofVec2f` (published as _Float_ \* 2)

#### Arithmetic\[3\]

* `ofVec3f` (= `ofPoint`) (published as _Float_ \* 3)

#### Arithmetic\[4\]

* `ofVec4f` (published as _Float_ \* 4)

* `ofColor` (published as _Int32_ \* 4)

* `ofShortColor` (published as _Int32_ \* 4)

* `ofFloatColor` (published as _Float_ \* 4)

* `ofQuaternion` (published as _Float_ \* 4)

* `ofRectangle` (published as _Float_ \* 4)

#### Arithmetic\[9\]

* `ofMatrix3x3`  (published as _Float_ \* 9)

#### Arithmetic\[16\]

* `ofMatrix4x4` (publish as _Float_ \* 16)

#### Blob

* `ofBuffer`

### ofParameter with supported types

* `ofParameter`

**NOTE**: we only support subscribing ofParameterGroup. See [How to subscribe ofParameterGroup](API_Reference.md#Advanced_how_to_subscribe_ofParameterGroup)

### array/vector of supported types

* `SupportedType[size]`

* `vector`

if you use `vector vec;`, when `vec` will be resized every receiving OSC messages.

**NOTE**: do NOT use `vector>`, `vector[size]`

### Callback

#### Subscribe

* `std::function`;

* `std::function`

* pair of `U &that`, `T (U::\*callback)(Arguments ...)`;

* pair of `U \*that`, `T (U::\*callback)(Arguments ...)`;

`Arguments ...` are all of types we can use in 

#### Publish

* `std::function`;

* pair of `U &that`, `T (U::\*callback)()`;

* pair of `U \*that`, `T (U::\*callback)()`;

## Update history

### 2021/09/30 [ver 0.3.3](../../releases/tag/v0_3_3)

* fixed bug on ver 0.3.2  (issued by [hanasaan](https://github.com/hanasaan). thanks!!!)

### 2021/09/26 ver 0.3.2 *[Deprecated!!]*

* fixed constructor of ofxOscMessageEx

* fixed some constness about notify, read

### 2020/04/15 [ver 0.3.1](../../releases/tag/v0_3_1)

* added ofxSubscribeAllOsc, ofxSubscribeAllOscForPort

### 2018/05/08 [ver 0.3.0](../../releases/tag/v0_3_0)

* refactor all for C++11

* add `ofxSendOsc`

* ofxSubscribeOsc got more flexible.

  * multi arguments

  * multi arguments callback

* add `ofxOscMessageEx`

### [Older update histories](Update_History.md)

#### about Versioning

ofxPubSubOsc uses Mood Versioning. maybe, 1.0.0. will not come.

## License

MIT License.

## Author

* ISHII 2bit [ISHII Tsuubito Program Office]

* i[at]2bit.jp

## Supporting Contributor

* [HIEDA Naoto](https://github.com/micuat)

## Special Thanks

* [HIGA Satoru](https://github.com/satoruhiga)

* [SHIMIZU Motoi](https://github.com/motoishmz)

* [IWATANI Nariaki](https://github.com/nariakiiwatani)

* [USAMI Takuto](https://github.com/usm916)

* [HORII Satoshi](https://github.com/satcy)

* [TOMOTO Yusuke](https://github.com/yusuketomoto)

* [HANAI Yuuya](https://github.com/hanasaan)

* [musiko](https://github.com/musiko)

* [TAESU Yuma](https://github.com/yumataesu)

* [HAYASAKA Akira](https://github.com/Akira-Hayasaka)

* [ASAI](https://github.com/asaiyuta)

* [Aris Bezas](https://github.com/igoumeninja)

* [moebiussurfing](https://github.com/moebiussurfing)

## At the last

Please create a new issue if there is a problem.

And please throw a pull request if you have a cool idea!!

If you get happy with using this addon, and you're rich, please donation for support continuous development.

Bitcoin: `17AbtW73aydfYH3epP8T3UDmmDCcXSGcaf`