mirror of
https://github.com/juce-framework/JUCE.git
synced 2026-01-09 23:34:20 +00:00
207 lines
8 KiB
C++
207 lines
8 KiB
C++
/*
|
|
==============================================================================
|
|
|
|
This file is part of the JUCE framework.
|
|
Copyright (c) Raw Material Software Limited
|
|
|
|
JUCE is an open source framework subject to commercial or open source
|
|
licensing.
|
|
|
|
By downloading, installing, or using the JUCE framework, or combining the
|
|
JUCE framework with any other source code, object code, content or any other
|
|
copyrightable work, you agree to the terms of the JUCE End User Licence
|
|
Agreement, and all incorporated terms including the JUCE Privacy Policy and
|
|
the JUCE Website Terms of Service, as applicable, which will bind you. If you
|
|
do not agree to the terms of these agreements, we will not license the JUCE
|
|
framework to you, and you must discontinue the installation or download
|
|
process and cease use of the JUCE framework.
|
|
|
|
JUCE End User Licence Agreement: https://juce.com/legal/juce-8-licence/
|
|
JUCE Privacy Policy: https://juce.com/juce-privacy-policy
|
|
JUCE Website Terms of Service: https://juce.com/juce-website-terms-of-service/
|
|
|
|
Or:
|
|
|
|
You may also use this code under the terms of the AGPLv3:
|
|
https://www.gnu.org/licenses/agpl-3.0.en.html
|
|
|
|
THE JUCE FRAMEWORK IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL
|
|
WARRANTIES, WHETHER EXPRESSED OR IMPLIED, INCLUDING WARRANTY OF
|
|
MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, ARE DISCLAIMED.
|
|
|
|
==============================================================================
|
|
*/
|
|
|
|
namespace juce
|
|
{
|
|
|
|
//==============================================================================
|
|
/**
|
|
An OSC Message.
|
|
|
|
An OSCMessage consists of an OSCAddressPattern and zero or more OSCArguments.
|
|
|
|
OSC messages are the elementary objects that are used to exchange any data
|
|
via OSC. An OSCSender can send OSCMessage objects to an OSCReceiver.
|
|
|
|
@tags{OSC}
|
|
*/
|
|
class JUCE_API OSCMessage
|
|
{
|
|
public:
|
|
|
|
//==============================================================================
|
|
/** Constructs an OSCMessage object with the given address pattern and no
|
|
arguments.
|
|
|
|
@param ap the address pattern of the message. This must be a valid OSC
|
|
address (starting with a forward slash) and may contain
|
|
OSC wildcard expressions. You can pass in a string literal
|
|
or a juce String (they will be converted to an OSCAddressPattern
|
|
automatically).
|
|
*/
|
|
OSCMessage (const OSCAddressPattern& ap) noexcept;
|
|
|
|
|
|
/** Constructs an OSCMessage object with the given address pattern and list
|
|
of arguments.
|
|
|
|
@param ap the address pattern of the message. This must be a valid OSC
|
|
address (starting with a forward slash) and may contain
|
|
OSC wildcard expressions. You can pass in a string literal
|
|
or a juce String (they will be converted to an OSCAddressPattern
|
|
automatically).
|
|
|
|
@param arg1 the first argument of the message.
|
|
@param args an optional list of further arguments to add to the message.
|
|
*/
|
|
template <typename Arg1, typename... Args>
|
|
OSCMessage (const OSCAddressPattern& ap, Arg1&& arg1, Args&&... args);
|
|
|
|
/** Sets the address pattern of the OSCMessage.
|
|
|
|
@param ap the address pattern of the message. This must be a valid OSC
|
|
address (starting with a forward slash) and may contain
|
|
OSC wildcard expressions. You can pass in a string literal
|
|
or a juce String (they will be converted to an OSCAddressPattern
|
|
automatically).
|
|
*/
|
|
void setAddressPattern (const OSCAddressPattern& ap) noexcept;
|
|
|
|
/** Returns the address pattern of the OSCMessage. */
|
|
OSCAddressPattern getAddressPattern() const noexcept;
|
|
|
|
#if JUCE_IP_AND_PORT_DETECTION
|
|
/** Returns the sender's IP Address. */
|
|
String getSenderIPAddress() const noexcept;
|
|
void setSenderIPAddress(const String& ip) noexcept;
|
|
|
|
/** Returns the sender's port number. */
|
|
int getSenderPortNumber() const noexcept;
|
|
void setSenderPortNumber(int port) noexcept;
|
|
#endif
|
|
|
|
/** Returns the number of OSCArgument objects that belong to this OSCMessage. */
|
|
int size() const noexcept;
|
|
|
|
/** Returns true if the OSCMessage contains no OSCArgument objects; false otherwise. */
|
|
bool isEmpty() const noexcept;
|
|
|
|
/** Returns a reference to the OSCArgument at index i in the OSCMessage object.
|
|
This method does not check the range and results in undefined behaviour
|
|
in case i < 0 or i >= size().
|
|
*/
|
|
OSCArgument& operator[] (int i) noexcept;
|
|
const OSCArgument& operator[] (int i) const noexcept;
|
|
|
|
/** Returns a pointer to the first OSCArgument in the OSCMessage object.
|
|
This method is provided for compatibility with standard C++ iteration mechanisms.
|
|
*/
|
|
OSCArgument* begin() noexcept;
|
|
|
|
/** Returns a pointer to the first OSCArgument in the OSCMessage object.
|
|
This method is provided for compatibility with standard C++ iteration mechanisms.
|
|
*/
|
|
const OSCArgument* begin() const noexcept;
|
|
|
|
/** Returns a pointer to the last OSCArgument in the OSCMessage object.
|
|
This method is provided for compatibility with standard C++ iteration mechanisms.
|
|
*/
|
|
OSCArgument* end() noexcept;
|
|
|
|
/** Returns a pointer to the last OSCArgument in the OSCMessage object.
|
|
This method is provided for compatibility with standard C++ iteration mechanisms.
|
|
*/
|
|
const OSCArgument* end() const noexcept;
|
|
|
|
/** Removes all arguments from the OSCMessage. */
|
|
void clear();
|
|
|
|
//==============================================================================
|
|
/** Creates a new OSCArgument of type int32 with the given value,
|
|
and adds it to the OSCMessage object.
|
|
*/
|
|
void addInt32 (int32 value);
|
|
|
|
/** Creates a new OSCArgument of type float32 with the given value,
|
|
and adds it to the OSCMessage object.
|
|
*/
|
|
void addFloat32 (float value);
|
|
|
|
/** Creates a new OSCArgument of type string with the given value,
|
|
and adds it to the OSCMessage object.
|
|
*/
|
|
void addString (const String& value);
|
|
|
|
/** Creates a new OSCArgument of type blob with binary data content copied from
|
|
the given MemoryBlock.
|
|
|
|
Note: If the argument passed is an lvalue, this may copy the binary data.
|
|
*/
|
|
void addBlob (MemoryBlock blob);
|
|
|
|
/** Creates a new OSCArgument of type colour with the given value,
|
|
and adds it to the OSCMessage object.
|
|
*/
|
|
void addColour (OSCColour colour);
|
|
|
|
/** Adds the OSCArgument argument to the OSCMessage object.
|
|
|
|
Note: This method will result in a copy of the OSCArgument object if it is passed
|
|
as an lvalue. If the OSCArgument is of type blob, this will also copy the underlying
|
|
binary data. In general, you should use addInt32, addFloat32, etc. instead.
|
|
*/
|
|
void addArgument (OSCArgument argument);
|
|
|
|
private:
|
|
|
|
//==============================================================================
|
|
template <typename Arg1, typename... Args>
|
|
void addArguments (Arg1&& arg1, Args&&... args)
|
|
{
|
|
addArgument (arg1);
|
|
addArguments (std::forward<Args> (args)...);
|
|
}
|
|
|
|
void addArguments() {}
|
|
|
|
//==============================================================================
|
|
OSCAddressPattern addressPattern;
|
|
Array<OSCArgument> arguments;
|
|
|
|
#if JUCE_IP_AND_PORT_DETECTION
|
|
String senderIPAddress;
|
|
int senderPortNumber = 0;
|
|
#endif
|
|
};
|
|
|
|
|
|
//==============================================================================
|
|
template <typename Arg1, typename... Args>
|
|
OSCMessage::OSCMessage (const OSCAddressPattern& ap, Arg1&& arg1, Args&&... args)
|
|
: addressPattern (ap)
|
|
{
|
|
addArguments (std::forward<Arg1> (arg1), std::forward<Args> (args)...);
|
|
}
|
|
|
|
} // namespace juce
|