/usr/include/lo/lo.h is in liblo-dev 0.28-3.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 | /*
* Copyright (C) 2014 Steve Harris et al. (see AUTHORS)
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public License
* as published by the Free Software Foundation; either version 2.1
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Lesser General Public License for more details.
*
* $Id$
*/
#ifndef LO_H
#define LO_H
#ifdef __cplusplus
extern "C" {
#endif
/**
* \file lo.h The liblo main headerfile and high-level API functions.
*/
#include "lo/lo_endian.h"
#include "lo/lo_types.h"
#include "lo/lo_osc_types.h"
#include "lo/lo_errors.h"
#include "lo/lo_lowlevel.h"
#if 1
#include "lo/lo_serverthread.h"
#endif
/**
* \defgroup liblo High-level OSC API
*
* Defines the high-level API functions necessary to implement OSC support.
* Should be adequate for most applications, but if you require lower level
* control you can use the functions defined in lo_lowlevel.h
* @{
*/
/**
* \brief Declare an OSC destination, given IP address and port number.
* Same as lo_address_new_with_proto(), but using UDP.
*
* \param host An IP address or number, or NULL for the local machine.
* \param port a decimal port number or service name.
*
* The lo_address object may be used as the target of OSC messages.
*
* Note: if you wish to receive replies from the target of this
* address, you must first create a lo_server_thread or lo_server
* object which will receive the replies. The last lo_server(_thread)
* object craeted will be the receiver.
*/
lo_address lo_address_new(const char *host, const char *port);
/**
* \brief Declare an OSC destination, given IP address and port number,
* specifying protocol.
*
* \param proto The protocol to use, must be one of LO_UDP, LO_TCP or LO_UNIX.
* \param host An IP address or number, or NULL for the local machine.
* \param port a decimal port number or service name.
*
* The lo_address object may be used as the target of OSC messages.
*
* Note: if you wish to receive replies from the target of this
* address, you must first create a lo_server_thread or lo_server
* object which will receive the replies. The last lo_server(_thread)
* object created will be the receiver.
*/
lo_address lo_address_new_with_proto(int proto, const char *host, const char *port);
/**
* \brief Create a lo_address object from an OSC URL.
*
* example: \c "osc.udp://localhost:4444/my/path/"
*/
lo_address lo_address_new_from_url(const char *url);
/**
* \brief Free the memory used by the lo_address object
*/
void lo_address_free(lo_address t);
/**
* \brief Set the Time-to-Live value for a given target address.
*
* This is required for sending multicast UDP messages. A value of 1
* (the usual case) keeps the message within the subnet, while 255
* means a global, unrestricted scope.
*
* \param t An OSC address.
* \param ttl An integer specifying the scope of a multicast UDP message.
*/
void lo_address_set_ttl(lo_address t, int ttl);
/**
* \brief Get the Time-to-Live value for a given target address.
*
* \param t An OSC address.
* \return An integer specifying the scope of a multicast UDP message.
*/
int lo_address_get_ttl(lo_address t);
/**
* \brief Send a OSC formatted message to the address specified.
*
* \param targ The target OSC address
* \param path The OSC path the message will be delivered to
* \param type The types of the data items in the message, types are defined in
* lo_osc_types.h
* \param ... The data values to be transmitted. The types of the arguments
* passed here must agree with the types specified in the type parameter.
*
* example:
* \code
* lo_send(t, "/foo/bar", "ff", 0.1f, 23.0f);
* \endcode
*
* \return -1 on failure.
*/
int lo_send(lo_address targ, const char *path, const char *type, ...);
/**
* \brief Send a OSC formatted message to the address specified,
* from the same socket as the specified server.
*
* \param targ The target OSC address
* \param from The server to send message from (can be NULL to use new socket)
* \param ts The OSC timetag timestamp at which the message will be processed
* (can be LO_TT_IMMEDIATE if you don't want to attach a timetag)
* \param path The OSC path the message will be delivered to
* \param type The types of the data items in the message, types are defined in
* lo_osc_types.h
* \param ... The data values to be transmitted. The types of the arguments
* passed here must agree with the types specified in the type parameter.
*
* example:
* \code
* serv = lo_server_new(NULL, err);
* lo_server_add_method(serv, "/reply", "ss", reply_handler, NULL);
* lo_send_from(t, serv, LO_TT_IMMEDIATE, "/foo/bar", "ff", 0.1f, 23.0f);
* \endcode
*
* \return on success, the number of bytes sent, or -1 on failure.
*/
int lo_send_from(lo_address targ, lo_server from, lo_timetag ts,
const char *path, const char *type, ...);
/**
* \brief Send a OSC formatted message to the address specified, scheduled to
* be dispatch at some time in the future.
*
* \param targ The target OSC address
* \param ts The OSC timetag timestamp at which the message will be processed
* \param path The OSC path the message will be delivered to
* \param type The types of the data items in the message, types are defined in
* lo_osc_types.h
* \param ... The data values to be transmitted. The types of the arguments
* passed here must agree with the types specified in the type parameter.
*
* example:
* \code
* lo_timetag now;<br>
* lo_timetag_now(&now);<br>
* lo_send_timestamped(t, now, "/foo/bar", "ff", 0.1f, 23.0f);
* \endcode
*
* \return on success, the number of bytes sent, or -1 on failure.
*/
int lo_send_timestamped(lo_address targ, lo_timetag ts, const char *path,
const char *type, ...);
/**
* \brief Return the error number from the last failed lo_send() or
* lo_address_new() call
*/
int lo_address_errno(lo_address a);
/**
* \brief Return the error string from the last failed lo_send() or
* lo_address_new() call
*/
const char *lo_address_errstr(lo_address a);
/**
* \brief Create a new OSC blob type.
*
* \param size The amount of space to allocate in the blob structure.
* \param data The data that will be used to initialise the blob, should be
* size bytes long.
*/
lo_blob lo_blob_new(int32_t size, const void *data);
/**
* \brief Free the memory taken by a blob
*/
void lo_blob_free(lo_blob b);
/**
* \brief Return the amount of valid data in a lo_blob object.
*
* If you want to know the storage size, use lo_arg_size().
*/
uint32_t lo_blob_datasize(lo_blob b);
/**
* \brief Return a pointer to the start of the blob data to allow contents to
* be changed.
*/
void *lo_blob_dataptr(lo_blob b);
/**
* \brief Get information on the version of liblo current in use.
*
* All parameters are optional and can be given the value of 0 if that
* information is not desired. For example, to get just the version
* as a string, call lo_version(str, size, 0, 0, 0, 0, 0, 0, 0);
*
* The "lt" fields, called the ABI version, corresponds to libtool's
* versioning system for binary interface compatibility, and is not
* related to the library version number. This information is usually
* encoded in the filename of the shared library.
*
* Typically the string returned in 'verstr' should correspond with
* $major.$minor$extra, e.g., "0.28rc". If no 'extra' information is
* present, e.g., "0.28", extra will given the null string.
*
* \param verstr A buffer to receive a string describing the
* library version.
* \param verstr_size Size of the buffer pointed to by string.
* \param major Location to receive the library major version.
* \param minor Location to receive the library minor version.
* \param extra Location to receive the library version extra string.
* \param extra_size Size of the buffer pointed to by extra.
* \param lt_major Location to receive the ABI major version.
* \param lt_minor Location to receive the ABI minor version.
* \param lt_bug Location to receive the ABI 'bugfix' version.
*/
void lo_version(char *verstr, int verstr_size,
int *major, int *minor, char *extra, int extra_size,
int *lt_major, int *lt_minor, int *lt_bug);
/** @} */
#include "lo/lo_macros.h"
#ifdef __cplusplus
}
#endif
#endif
|