/usr/include/faust/gui/APIUI.h is in faust-common 0.9.95~repack1-2.
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 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 | /************************************************************************
FAUST Architecture File
Copyright (C) 2003-2016 GRAME, Centre National de Creation Musicale
---------------------------------------------------------------------
This Architecture section is free software; you can redistribute it
and/or modify it under the terms of the GNU General Public License
as published by the Free Software Foundation; either version 3 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 General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; If not, see <http://www.gnu.org/licenses/>.
EXCEPTION : As a special exception, you may create a larger work
that contains this FAUST architecture section and distribute
that work under terms of your choice, so long as this FAUST
architecture section is not modified.
************************************************************************
************************************************************************/
#ifndef API_UI_H
#define API_UI_H
#include "faust/gui/meta.h"
#include "faust/gui/UI.h"
#include "faust/gui/PathBuilder.h"
#include "faust/gui/ValueConverter.h"
#include <sstream>
#include <string>
#include <vector>
#include <iostream>
#include <map>
enum { kLin = 0, kLog = 1, kExp = 2 };
class APIUI : public PathBuilder, public Meta, public UI
{
protected:
int fNumParameters;
std::vector<std::string> fName;
std::map<std::string, int> fPathMap;
std::map<std::string, int> fLabelMap;
std::vector<ValueConverter*> fConversion;
std::vector<FAUSTFLOAT*> fZone;
std::vector<FAUSTFLOAT> fInit;
std::vector<FAUSTFLOAT> fMin;
std::vector<FAUSTFLOAT> fMax;
std::vector<FAUSTFLOAT> fStep;
std::vector<std::string> fUnit;
std::vector<ZoneControl*> fAcc[3];
std::vector<ZoneControl*> fGyr[3];
// Screen color control
// "...[screencolor:red]..." etc.
bool fHasScreenControl; // true if control screen color metadata
ZoneReader* fRedReader;
ZoneReader* fGreenReader;
ZoneReader* fBlueReader;
// Current values controlled by metadata
std::string fCurrentUnit;
int fCurrentScale;
std::string fCurrentAcc;
std::string fCurrentGyr;
std::string fCurrentColor;
// Add a generic parameter
virtual void addParameter(const char* label,
FAUSTFLOAT* zone,
FAUSTFLOAT init,
FAUSTFLOAT min,
FAUSTFLOAT max,
FAUSTFLOAT step)
{
std::string path = buildPath(label);
fPathMap[path] = fLabelMap[label] = fNumParameters++;
fName.push_back(path);
fZone.push_back(zone);
fInit.push_back(init);
fMin.push_back(min);
fMax.push_back(max);
fStep.push_back(step);
//handle unit metadata
fUnit.push_back(fCurrentUnit);
fCurrentUnit = "";
//handle scale metadata
switch (fCurrentScale) {
case kLin : fConversion.push_back(new LinearValueConverter(0,1, min, max)); break;
case kLog : fConversion.push_back(new LogValueConverter(0,1, min, max)); break;
case kExp : fConversion.push_back(new ExpValueConverter(0,1, min, max)); break;
}
fCurrentScale = kLin;
// handle acc metadata "...[acc : <axe> <curve> <amin> <amid> <amax>]..."
if (fCurrentAcc.size() > 0) {
std::istringstream iss(fCurrentAcc);
int axe, curve;
double amin, amid, amax;
iss >> axe >> curve >> amin >> amid >> amax;
if ((0 <= axe) && (axe < 3) &&
(0 <= curve) && (curve < 4) &&
(amin < amax) && (amin <= amid) && (amid <= amax))
{
fAcc[axe].push_back(new CurveZoneControl(zone, curve, amin, amid, amax, min, init, max));
} else {
std::cerr << "incorrect acc metadata : " << fCurrentAcc << std::endl;
}
}
fCurrentAcc = "";
// handle gyr metadata "...[gyr : <axe> <curve> <amin> <amid> <amax>]..."
if (fCurrentGyr.size() > 0) {
std::istringstream iss(fCurrentGyr);
int axe, curve;
double amin, amid, amax;
iss >> axe >> curve >> amin >> amid >> amax;
if ((0 <= axe) && (axe < 3) &&
(0 <= curve) && (curve < 4) &&
(amin < amax) && (amin <= amid) && (amid <= amax))
{
fGyr[axe].push_back(new CurveZoneControl(zone, curve, amin, amid, amax, min, init, max));
} else {
std::cerr << "incorrect gyr metadata : " << fCurrentGyr << std::endl;
}
}
fCurrentGyr = "";
// handle screencolor metadata "...[screencolor:red|green|blue]..."
if (fCurrentColor.size() > 0) {
if ((fCurrentColor == "red") && (fRedReader == 0)) {
fRedReader = new ZoneReader(zone, min, max);
fHasScreenControl = true;
} else if ((fCurrentColor == "green") && (fGreenReader == 0)) {
fGreenReader = new ZoneReader(zone, min, max);
fHasScreenControl = true;
} else if ((fCurrentColor == "blue") && (fBlueReader == 0)) {
fBlueReader = new ZoneReader(zone, min, max);
fHasScreenControl = true;
} else if ((fCurrentColor == "white") && (fRedReader == 0) && (fGreenReader == 0) && (fBlueReader == 0)) {
fRedReader = new ZoneReader(zone, min, max);
fGreenReader = new ZoneReader(zone, min, max);
fBlueReader = new ZoneReader(zone, min, max);
fHasScreenControl = true;
} else {
std::cerr << "incorrect screencolor metadata : " << fCurrentColor << std::endl;
}
}
fCurrentColor = "";
}
int getZoneIndex(std::vector<ZoneControl*>* table, int p, int val)
{
FAUSTFLOAT* zone = fZone[p];
for (int i = 0; i < table[val].size(); i++) {
if (zone == table[val][i]->getZone()) return i;
}
return -1;
}
void setConverter(std::vector<ZoneControl*>* table, int p, int val, int curve, double amin, double amid, double amax)
{
int id1 = getZoneIndex(table, p, 0);
int id2 = getZoneIndex(table, p, 1);
int id3 = getZoneIndex(table, p, 2);
// Deactivates everywhere..
if (id1 != -1) table[0][id1]->setActive(false);
if (id2 != -1) table[1][id2]->setActive(false);
if (id3 != -1) table[2][id3]->setActive(false);
if (val == -1) { // Means: no more mapping...
// So stay all deactivated...
} else {
int id4 = getZoneIndex(table, p, val);
if (id4 != -1) {
// Reactivate the one we edit...
table[val][id4]->setMappingValues(curve, amin, amid, amax, fMin[p], fInit[p], fMax[p]);
table[val][id4]->setActive(true);
} else {
// Allocate a new CurveZoneControl which is 'active' by default
FAUSTFLOAT* zone = fZone[p];
table[val].push_back(new CurveZoneControl(zone, curve, amin, amid, amax, fMin[p], fInit[p], fMax[p]));
}
}
}
void getConverter(std::vector<ZoneControl*>* table, int p, int& val, int& curve, double& amin, double& amid, double& amax)
{
int id1 = getZoneIndex(table, p, 0);
int id2 = getZoneIndex(table, p, 1);
int id3 = getZoneIndex(table, p, 2);
if (id1 != -1) {
val = 0;
curve = fAcc[val][id1]->getCurve();
table[val][id1]->getMappingValues(amin, amid, amax);
} else if (id2 != -1) {
val = 1;
curve = fAcc[val][id2]->getCurve();
table[val][id2]->getMappingValues(amin, amid, amax);
} else if (id3 != -1) {
val = 2;
curve = fAcc[val][id3]->getCurve();
table[val][id3]->getMappingValues(amin, amid, amax);
} else {
val = -1; // No mapping
curve = 0;
amin = -100.;
amid = 0.;
amax = 100.;
}
}
public:
APIUI() : fNumParameters(0), fHasScreenControl(false), fRedReader(0), fGreenReader(0), fBlueReader(0)
{}
virtual ~APIUI()
{
std::vector<ValueConverter*>::iterator it1;
for (it1 = fConversion.begin(); it1 != fConversion.end(); it1++) {
delete(*it1);
}
std::vector<ZoneControl*>::iterator it2;
for (int i = 0; i < 3; i++) {
for (it2 = fAcc[i].begin(); it2 != fAcc[i].end(); it2++) {
delete(*it2);
}
for (it2 = fGyr[i].begin(); it2 != fGyr[i].end(); it2++) {
delete(*it2);
}
}
delete fRedReader;
delete fGreenReader;
delete fBlueReader;
}
// -- widget's layouts
virtual void openTabBox(const char* label) { fControlsLevel.push_back(label); }
virtual void openHorizontalBox(const char* label) { fControlsLevel.push_back(label); }
virtual void openVerticalBox(const char* label) { fControlsLevel.push_back(label); }
virtual void closeBox() { fControlsLevel.pop_back(); }
// -- active widgets
virtual void addButton(const char* label, FAUSTFLOAT* zone)
{
addParameter(label, zone, 0, 0, 1, 1);
}
virtual void addCheckButton(const char* label, FAUSTFLOAT* zone)
{
addParameter(label, zone, 0, 0, 1, 1);
}
virtual void addVerticalSlider(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step)
{
addParameter(label, zone, init, min, max, step);
}
virtual void addHorizontalSlider(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step)
{
addParameter(label, zone, init, min, max, step);
}
virtual void addNumEntry(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT init, FAUSTFLOAT min, FAUSTFLOAT max, FAUSTFLOAT step)
{
addParameter(label, zone, init, min, max, step);
}
// -- passive widgets
virtual void addHorizontalBargraph(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT min, FAUSTFLOAT max)
{
addParameter(label, zone, min, min, max, (max-min)/1000.0);
}
virtual void addVerticalBargraph(const char* label, FAUSTFLOAT* zone, FAUSTFLOAT min, FAUSTFLOAT max)
{
addParameter(label, zone, min, min, max, (max-min)/1000.0);
}
// -- metadata declarations
virtual void declare(FAUSTFLOAT* zone, const char* key, const char* val)
{
if (strcmp(key, "scale") == 0) {
if (strcmp(val, "log") == 0) {
fCurrentScale = kLog;
} else if (strcmp(val, "exp") == 0) {
fCurrentScale = kExp;
} else {
fCurrentScale = kLin;
}
} else if (strcmp(key, "unit") == 0) {
fCurrentUnit = val;
} else if (strcmp(key, "acc") == 0) {
fCurrentAcc = val;
} else if (strcmp(key, "gyr") == 0) {
fCurrentGyr = val;
} else if (strcmp(key, "screencolor") == 0) {
fCurrentColor = val; // val = "red", "green" or "blue"
}
}
virtual void declare(const char* key, const char* val)
{}
//-------------------------------------------------------------------------------
// Simple API part
//-------------------------------------------------------------------------------
int getParamsCount() { return fNumParameters; }
int getParamIndex(const char* path)
{
if (fPathMap.find(path) != fPathMap.end()) {
return fPathMap[path];
} else if (fLabelMap.find(path) != fLabelMap.end()) {
return fLabelMap[path];
} else {
return -1;
}
}
const char* getParamAddress(int p) { return fName[p].c_str(); }
const char* getParamUnit(int p) { return fUnit[p].c_str(); }
FAUSTFLOAT getParamMin(int p) { return fMin[p]; }
FAUSTFLOAT getParamMax(int p) { return fMax[p]; }
FAUSTFLOAT getParamStep(int p) { return fStep[p]; }
FAUSTFLOAT* getParamZone(int p) { return fZone[p]; }
FAUSTFLOAT getParamValue(int p) { return *fZone[p]; }
void setParamValue(int p, FAUSTFLOAT v) { *fZone[p] = v; }
double getParamRatio(int p) { return fConversion[p]->faust2ui(*fZone[p]); }
void setParamRatio(int p, double r) { *fZone[p] = fConversion[p]->ui2faust(r); }
double value2ratio(int p, double r) { return fConversion[p]->faust2ui(r); }
double ratio2value(int p, double r) { return fConversion[p]->ui2faust(r); }
/**
* Set a new value coming from an accelerometer, propagate it to all relevant float* zones.
*
* @param acc - 0 for X accelerometer, 1 for Y accelerometer, 2 for Z accelerometer
* @param value - the new value
*
*/
void propagateAcc(int acc, double value)
{
for (int i = 0; i < fAcc[acc].size(); i++) {
fAcc[acc][i]->update(value);
}
}
/**
* Used to edit accelerometer curves and mapping. Set curve and related mapping for a given UI parameter.
*
* @param p - the UI parameter index
* @param acc - 0 for X accelerometer, 1 for Y accelerometer, 2 for Z accelerometer (-1 means "no mapping")
* @param curve - between 0 and 3
* @param amin - mapping 'min' point
* @param amid - mapping 'middle' point
* @param amax - mapping 'max' point
*
*/
void setAccConverter(int p, int acc, int curve, double amin, double amid, double amax)
{
setConverter(fAcc, p, acc, curve, amin, amid, amax);
}
/**
* Used to edit gyroscope curves and mapping. Set curve and related mapping for a given UI parameter.
*
* @param p - the UI parameter index
* @param acc - 0 for X gyroscope, 1 for Y gyroscope, 2 for Z gyroscope (-1 means "no mapping")
* @param curve - between 0 and 3
* @param amin - mapping 'min' point
* @param amid - mapping 'middle' point
* @param amax - mapping 'max' point
*
*/
void setGyrConverter(int p, int gyr, int curve, double amin, double amid, double amax)
{
setConverter(fGyr, p, gyr, curve, amin, amid, amax);
}
/**
* Used to edit accelerometer curves and mapping. Get curve and related mapping for a given UI parameter.
*
* @param p - the UI parameter index
* @param acc - the acc value to be retrieved (-1 means "no mapping")
* @param curve - the curve value to be retrieved
* @param amin - the amin value to be retrieved
* @param amid - the amid value to be retrieved
* @param amax - the amax value to be retrieved
*
*/
void getAccConverter(int p, int& acc, int& curve, double& amin, double& amid, double& amax)
{
getConverter(fAcc, p, acc, curve, amin, amid, amax);
}
/**
* Used to edit gyroscope curves and mapping. Get curve and related mapping for a given UI parameter.
*
* @param p - the UI parameter index
* @param gyr - the gyr value to be retrieved (-1 means "no mapping")
* @param curve - the curve value to be retrieved
* @param amin - the amin value to be retrieved
* @param amid - the amid value to be retrieved
* @param amax - the amax value to be retrieved
*
*/
void getGyrConverter(int p, int& gyr, int& curve, double& amin, double& amid, double& amax)
{
getConverter(fGyr, p, gyr, curve, amin, amid, amax);
}
/**
* Set a new value coming from an gyroscope, propagate it to all relevant float* zones.
*
* @param gyr - 0 for X gyroscope, 1 for Y gyroscope, 2 for Z gyroscope
* @param value - the new value
*
*/
void propagateGyr(int gyr, double value)
{
for (int i = 0; i < fGyr[gyr].size(); i++) {
fGyr[gyr][i]->update(value);
}
}
// getScreenColor() : -1 means no screen color control (no screencolor metadata found)
// otherwise return 0x00RRGGBB a ready to use color
int getScreenColor()
{
if (fHasScreenControl) {
int r = (fRedReader) ? fRedReader->getValue() : 0;
int g = (fGreenReader) ? fGreenReader->getValue() : 0;
int b = (fBlueReader) ? fBlueReader->getValue() : 0;
return (r<<16) | (g<<8) | b;
} else {
return -1;
}
}
};
#endif
|