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
|
/****************************************************************************
**
** Copyright (C) 2014 Robin Burchell <robin.burchell@viroteck.net>
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the QtCore module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 3 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL3 included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 3 requirements
** will be met: https://www.gnu.org/licenses/lgpl-3.0.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 2.0 or (at your option) the GNU General
** Public license version 3 or any later version approved by the KDE Free
** Qt Foundation. The licenses are as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-2.0.html and
** https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qoscbundle_p.h"
#include "qtuio_p.h"
#include <QtEndian>
#include <QDebug>
#include <QLoggingCategory>
QT_BEGIN_NAMESPACE
Q_LOGGING_CATEGORY(lcTuioBundle, "qt.qpa.tuio.bundle")
QOscBundle::QOscBundle() {}
// TUIO packets are transmitted using the OSC protocol, located at:
// http://opensoundcontrol.org/specification
// Snippets of this specification have been pasted into the source as a means of
// easily communicating requirements.
QOscBundle::QOscBundle(const QByteArray &data)
: m_isValid(false)
, m_immediate(false)
, m_timeEpoch(0)
, m_timePico(0)
{
// 8 16 24 32 40 48 56 64
// # b u n d l e \0
// 23 62 75 6e 64 6c 65 00 // OSC string bundle identifier
// 00 00 00 00 00 00 00 01 // osc time-tag, "immediately"
// 00 00 00 30 // element length
// => message or bundle(s), preceded by length each time
qCDebug(lcTuioBundle) << data.toHex();
quint32 parsedBytes = 0;
// "An OSC Bundle consists of the OSC-string "#bundle""
QByteArray identifier;
if (!qt_readOscString(data, identifier, parsedBytes) || identifier != "#bundle")
return;
// "followed by an OSC Time
// Tag, followed by zero or more OSC Bundle Elements. The OSC-timetag is a
// 64-bit fixed point time tag whose semantics are described below."
if (parsedBytes > (quint32)data.size() || data.size() - parsedBytes < sizeof(quint64))
return;
// "Time tags are represented by a 64 bit fixed point number. The first 32
// bits specify the number of seconds since midnight on January 1, 1900,
// and the last 32 bits specify fractional parts of a second to a precision
// of about 200 picoseconds. This is the representation used by Internet NTP
// timestamps."
//
// (editor's note: one may wonder how a 64bit big-endian number can also be
// two 32bit numbers, without specifying in which order they occur or
// anything, and one may indeed continue to wonder.)
quint32 oscTimeEpoch = qFromBigEndian<quint32>(data.constData() + parsedBytes);
parsedBytes += sizeof(quint32);
quint32 oscTimePico = qFromBigEndian<quint32>(data.constData() + parsedBytes);
parsedBytes += sizeof(quint32);
bool isImmediate = false;
if (oscTimeEpoch == 0 && oscTimePico == 1) {
// "The time tag value consisting of 63 zero bits followed by a
// one in the least signifigant bit is a special case meaning
// "immediately.""
isImmediate = true;
}
while (parsedBytes < (quint32)data.size()) {
// "An OSC Bundle Element consists of its size and its contents. The size is an
// int32 representing the number of 8-bit bytes in the contents, and will
// always be a multiple of 4."
//
// in practice, a bundle can contain multiple bundles or messages,
// though, and each is prefixed by a size.
if (data.size() - parsedBytes < sizeof(quint32))
return;
quint32 size = qFromBigEndian<quint32>((const uchar*)data.constData() + parsedBytes);
parsedBytes += sizeof(quint32);
if (data.size() - parsedBytes < size)
return;
if (size == 0) {
// empty bundle; these are valid, but should they be allowed? the
// spec is unclear on this...
qCWarning(lcTuioBundle, "Empty bundle?");
m_isValid = true;
m_immediate = isImmediate;
m_timeEpoch = oscTimeEpoch;
m_timePico = oscTimePico;
return;
}
// "The contents are either an OSC Message or an OSC Bundle.
// Note this recursive definition: bundle may contain bundles."
QByteArray subdata = data.mid(parsedBytes, size);
parsedBytes += size;
// "The contents of an OSC packet must be either an OSC Message or an OSC Bundle.
// The first byte of the packet's contents unambiguously distinguishes between
// these two alternatives."
//
// we're not dealing with a packet here, but the same trick works just
// the same.
QByteArray bundleIdentifier = QByteArray("#bundle\0", 8);
if (subdata.startsWith('/')) {
// starts with / => address pattern => start of a message
QOscMessage subMessage(subdata);
if (subMessage.isValid()) {
m_isValid = true;
m_immediate = isImmediate;
m_timeEpoch = oscTimeEpoch;
m_timePico = oscTimePico;
m_messages.append(subMessage);
} else {
qCWarning(lcTuioBundle, "Invalid sub-message");
return;
}
} else if (subdata.startsWith(bundleIdentifier)) {
// bundle identifier start => bundle
QOscBundle subBundle(subdata);
if (subBundle.isValid()) {
m_isValid = true;
m_immediate = isImmediate;
m_timeEpoch = oscTimeEpoch;
m_timePico = oscTimePico;
m_bundles.append(subBundle);
}
} else {
qCWarning(lcTuioBundle, "Malformed sub-data!");
return;
}
}
}
QT_END_NAMESPACE
|
