-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathPyTypeInterface.cpp
1197 lines (1076 loc) · 33.3 KB
/
PyTypeInterface.cpp
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
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/* -*- c-basic-offset: 8 indent-tabs-mode: t -*- */
/*
* Vampy : This plugin is a wrapper around the Vamp plugin API.
* It allows for writing Vamp plugins in Python.
* Centre for Digital Music, Queen Mary University of London.
* Copyright (C) 2008-2009 Gyorgy Fazekas, QMUL. (See Vamp sources
* for licence information.)
*/
#include <Python.h>
#ifdef HAVE_NUMPY
#define PY_ARRAY_UNIQUE_SYMBOL VAMPY_ARRAY_API
#define NO_IMPORT_ARRAY
#define NPY_NO_DEPRECATED_API NPY_1_7_API_VERSION
#include "numpy/arrayobject.h"
#endif
#include "PyTypeInterface.h"
#include "PyRealTime.h"
#include "PyExtensionModule.h"
#include <math.h>
#include <float.h>
#include <limits.h>
#ifndef SIZE_T_MAX
#define SIZE_T_MAX ((size_t) -1)
#endif
using std::string;
using std::vector;
using std::cerr;
using std::endl;
using std::map;
static std::map<std::string, o::eOutDescriptors> outKeys;
static std::map<std::string, p::eParmDescriptors> parmKeys;
static std::map<std::string, eSampleTypes> sampleKeys;
static std::map<std::string, eFeatureFields> ffKeys;
static bool isMapInitialised = false;
/* Note: NO FUNCTION IN THIS CLASS SHOULD ALTER REFERENCE COUNTS
(EXCEPT FOR TEMPORARY PYTHON OBJECTS)! */
PyTypeInterface::PyTypeInterface() :
m_strict(false),
m_error(false),
m_numpyInstalled(false),
error(m_error) // const public reference for easy access
{
}
PyTypeInterface::~PyTypeInterface()
{
}
/// floating point numbers (TODO: check numpy.float128)
float
PyTypeInterface::PyValue_To_Float(PyObject* pyValue) const
{
// convert float
if (pyValue && PyFloat_Check(pyValue))
//TODO: check for limits here (same on most systems)
return (float) PyFloat_AS_DOUBLE(pyValue);
if (pyValue == NULL)
{
setValueError("Error while converting object " + PyValue_Get_TypeName(pyValue) + " to float. ",m_strict);
return 0.0;
}
// in strict mode we will not try harder
if (m_strict) {
setValueError("Strict conversion error: object" + PyValue_Get_TypeName(pyValue) +" is not float.",m_strict);
return 0.0;
}
// convert other objects supporting the number protocol
if (PyNumber_Check(pyValue))
{
PyObject* pyFloat = PyNumber_Float(pyValue); // new ref
if (!pyFloat)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting " + PyValue_Get_TypeName(pyValue) + " object to float.",m_strict);
return 0.0;
}
float rValue = (float) PyFloat_AS_DOUBLE(pyFloat);
Py_DECREF(pyFloat);
return rValue;
}
/*
// convert other objects supporting the number protocol
if (PyNumber_Check(pyValue))
{
// PEP353: Py_ssize_t is size_t but signed !
// This will work up to numpy.float64
Py_ssize_t rValue = PyNumber_AsSsize_t(pyValue,NULL);
if (PyErr_Occurred())
{
PyErr_Print(); PyErr_Clear();
setValueError("Error while converting integer object.",m_strict);
return 0.0;
}
if (rValue > (Py_ssize_t)FLT_MAX || rValue < (Py_ssize_t)FLT_MIN)
{
setValueError("Overflow error. Object can not be converted to float.",m_strict);
return 0.0;
}
return (float) rValue;
}
*/
// convert string
if (PyString_Check(pyValue))
{
PyObject* pyFloat = PyFloat_FromString(pyValue,NULL);
if (!pyFloat)
{
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
setValueError("String value can not be converted to float.",m_strict);
return 0.0;
}
float rValue = (float) PyFloat_AS_DOUBLE(pyFloat);
if (PyErr_Occurred())
{
PyErr_Print(); PyErr_Clear();
Py_CLEAR(pyFloat);
setValueError("Error while converting float object.",m_strict);
return 0.0;
}
Py_DECREF(pyFloat);
return rValue;
}
// convert the first element of any iterable sequence (for convenience and backwards compatibility)
if (PySequence_Check(pyValue) && PySequence_Size(pyValue) > 0)
{
PyObject* item = PySequence_GetItem(pyValue,0);
if (item)
{
float rValue = this->PyValue_To_Float(item);
if (!m_error) {
Py_DECREF(item);
return rValue;
} else {
Py_CLEAR(item);
std::string msg = "Could not convert sequence element to float. ";
setValueError(msg,m_strict);
return 0.0;
}
}
}
// give up
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
std::string msg = "Conversion from " + PyValue_Get_TypeName(pyValue) + " to float is not possible.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_Float failed. " << msg << endl;
#endif
return 0.0;
}
/// size_t (unsigned integer types)
size_t
PyTypeInterface::PyValue_To_Size_t(PyObject* pyValue) const
{
// convert objects supporting the number protocol
if (PyNumber_Check(pyValue))
{
if (m_strict && !PyInt_Check(pyValue) && !PyLong_Check(pyValue))
setValueError("Strict conversion error: object is not integer type.",m_strict);
// Note: this function handles Bool,Int,Long,Float
// speed is not critical in the use of this type by Vamp
// PEP353: Py_ssize_t is size_t but signed !
Py_ssize_t rValue = PyInt_AsSsize_t(pyValue);
if (PyErr_Occurred())
{
PyErr_Print(); PyErr_Clear();
setValueError("Error while converting integer object.",m_strict);
return 0;
}
// this test is nonsense -- neither part can occur
// owing to range of data types -- size_t is at least
// as big as long, and unsigned is always non-negative
/*
if ((unsigned long)rValue > SIZE_T_MAX || (unsigned long)rValue < 0)
{
setValueError("Overflow error. Object can not be converted to size_t.",m_strict);
return 0;
}
*/
return (size_t) rValue;
}
// in strict mode we will not try harder and throw an exception
// then the caller should decide what to do with it
if (m_strict) {
setValueError("Strict conversion error: object is not integer.",m_strict);
return 0;
}
// convert string
if (PyString_Check(pyValue))
{
PyObject* pyLong = PyNumber_Long(pyValue);
if (!pyLong)
{
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
setValueError("String object can not be converted to size_t.",m_strict);
return 0;
}
size_t rValue = this->PyValue_To_Size_t(pyLong);
if (!m_error) {
Py_DECREF(pyLong);
return rValue;
} else {
Py_CLEAR(pyLong);
setValueError ("Error converting string to size_t.",m_strict);
return 0;
}
}
// convert the first element of iterable sequences
if (PySequence_Check(pyValue) && PySequence_Size(pyValue) > 0)
{
PyObject* item = PySequence_GetItem(pyValue,0);
if (item)
{
size_t rValue = this->PyValue_To_Size_t(item);
if (!m_error) {
Py_DECREF(item);
return rValue;
} else {
Py_CLEAR(item);
setValueError("Could not convert sequence element to size_t. ",m_strict);
return 0;
}
}
}
// give up
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
std::string msg = "Conversion from " + this->PyValue_Get_TypeName(pyValue) + " to size_t is not possible.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_Size_t failed. " << msg << endl;
#endif
return 0;
}
/// long and int
long
PyTypeInterface::PyValue_To_Long(PyObject* pyValue) const
{
// most common case: convert int (faster)
if (pyValue && PyInt_Check(pyValue)) {
// if the object is not NULL and verified, this macro just extracts the value.
return PyInt_AS_LONG(pyValue);
}
// long
if (PyLong_Check(pyValue)) {
long rValue = PyLong_AsLong(pyValue);
if (PyErr_Occurred()) {
PyErr_Print(); PyErr_Clear();
setValueError("Error while converting long object.",m_strict);
return 0;
}
return rValue;
}
if (m_strict) {
setValueError("Strict conversion error: object is not integer or long integer.",m_strict);
return 0;
}
// convert all objects supporting the number protocol
if (PyNumber_Check(pyValue))
{
// Note: this function handles Bool,Int,Long,Float
// PEP353: Py_ssize_t is size_t but signed !
Py_ssize_t rValue = PyInt_AsSsize_t(pyValue);
if (PyErr_Occurred())
{
PyErr_Print(); PyErr_Clear();
setValueError("Error while converting integer object.",m_strict);
return 0;
}
if (rValue > LONG_MAX || rValue < LONG_MIN)
{
setValueError("Overflow error. Object can not be converted to size_t.",m_strict);
return 0;
}
return (long) rValue;
}
// convert string
if (PyString_Check(pyValue))
{
PyObject* pyLong = PyNumber_Long(pyValue);
if (!pyLong)
{
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
setValueError("String object can not be converted to long.",m_strict);
return 0;
}
long rValue = this->PyValue_To_Long(pyLong);
if (!m_error) {
Py_DECREF(pyLong);
return rValue;
} else {
Py_CLEAR(pyLong);
setValueError ("Error converting string to long.",m_strict);
return 0;
}
}
// convert the first element of iterable sequences
if (PySequence_Check(pyValue) && PySequence_Size(pyValue) > 0)
{
PyObject* item = PySequence_GetItem(pyValue,0);
if (item)
{
size_t rValue = this->PyValue_To_Long(item);
if (!m_error) {
Py_DECREF(item);
return rValue;
} else {
Py_CLEAR(item);
setValueError("Could not convert sequence element to long. ",m_strict);
return 0;
}
}
}
// give up
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
std::string msg = "Conversion from " + this->PyValue_Get_TypeName(pyValue) + " to long is not possible.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_Long failed. " << msg << endl;
#endif
return 0;
}
bool
PyTypeInterface::PyValue_To_Bool(PyObject* pyValue) const
{
// convert objects supporting the number protocol
// Note: PyBool is a subclass of PyInt
if (PyNumber_Check(pyValue))
{
if (m_strict && !PyBool_Check(pyValue))
setValueError
("Strict conversion error: object is not boolean type.",m_strict);
// Note: this function handles Bool,Int,Long,Float
Py_ssize_t rValue = PyInt_AsSsize_t(pyValue);
if (PyErr_Occurred())
{
PyErr_Print(); PyErr_Clear();
setValueError ("Error while converting boolean object.",m_strict);
}
if (rValue != 1 && rValue != 0)
{
setValueError ("Overflow error. Object can not be converted to boolean.",m_strict);
}
return (bool) rValue;
}
if (m_strict) {
setValueError ("Strict conversion error: object is not numerical type.",m_strict);
return false;
}
// convert iterables: the rule is the same as in the interpreter:
// empty sequence evaluates to False, anything else is True
if (PySequence_Check(pyValue))
{
return PySequence_Size(pyValue)?true:false;
}
// give up
if (PyErr_Occurred()) { PyErr_Print(); PyErr_Clear(); }
std::string msg = "Conversion from " + this->PyValue_Get_TypeName(pyValue) + " to boolean is not possible.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_Bool failed. " << msg << endl;
#endif
return false;
}
/// string and objects that support .__str__()
/// TODO: check unicode objects
std::string
PyTypeInterface::PyValue_To_String(PyObject* pyValue) const
{
// convert string
if (PyString_Check(pyValue))
{
char *cstr = PyString_AS_STRING(pyValue);
if (!cstr)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting string object.",m_strict);
return std::string();
}
return std::string(cstr);
}
// TODO: deal with unicode here (argh!)
// in strict mode we will not try harder
if (m_strict) {
setValueError("Strict conversion error: object is not string.",m_strict);
return std::string();
}
// accept None as empty string
if (pyValue == Py_None) return std::string();
// convert list or tuple: empties are turned into empty strings conventionally
if (PyList_Check(pyValue) || PyTuple_Check(pyValue))
{
if (!PySequence_Size(pyValue)) return std::string();
PyObject* item = PySequence_GetItem(pyValue,0);
if (item)
{
std::string rValue = this->PyValue_To_String(item);
if (!m_error) {
Py_DECREF(item);
return rValue;
} else {
Py_CLEAR(item);
setValueError("Could not convert sequence element to string.",m_strict);
return std::string();
}
}
}
// convert any other object that has .__str__() or .__repr__()
PyObject* pyString = PyObject_Str(pyValue);
if (pyString && !PyErr_Occurred())
{
std::string rValue = this->PyValue_To_String(pyString);
if (!m_error) {
Py_DECREF(pyString);
return rValue;
} else {
Py_CLEAR(pyString);
std::string msg = "Object " + this->PyValue_Get_TypeName(pyValue) +" can not be represented as string. ";
setValueError (msg,m_strict);
return std::string();
}
}
// give up
PyErr_Print(); PyErr_Clear();
std::string msg = "Conversion from " + this->PyValue_Get_TypeName(pyValue) + " to string is not possible.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_String failed. " << msg << endl;
#endif
return std::string();
}
/* C Values to Py Values */
PyObject*
PyTypeInterface::PyValue_From_CValue(const char* cValue) const
{
// returns new reference
#ifdef _DEBUG
if (!cValue) {
std::string msg = "PyTypeInterface::PyValue_From_CValue: Null pointer encountered while converting from const char* .";
cerr << msg << endl;
setValueError(msg,m_strict);
return NULL;
}
#endif
PyObject *pyValue = PyString_FromString(cValue);
if (!pyValue)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting from char* or string.",m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_From_CValue: Interpreter failed to convert from const char*" << endl;
#endif
return NULL;
}
return pyValue;
}
PyObject*
PyTypeInterface::PyValue_From_CValue(size_t cValue) const
{
// returns new reference
PyObject *pyValue = PyInt_FromSsize_t((Py_ssize_t)cValue);
if (!pyValue)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting from size_t.",m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_From_CValue: Interpreter failed to convert from size_t" << endl;
#endif
return NULL;
}
return pyValue;
}
PyObject*
PyTypeInterface::PyValue_From_CValue(double cValue) const
{
// returns new reference
PyObject *pyValue = PyFloat_FromDouble(cValue);
if (!pyValue)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting from float or double.",m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_From_CValue: Interpreter failed to convert from float or double" << endl;
#endif
return NULL;
}
return pyValue;
}
PyObject*
PyTypeInterface::PyValue_From_CValue(bool cValue) const
{
// returns new reference
PyObject *pyValue = PyBool_FromLong((long)cValue);
if (!pyValue)
{
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
setValueError("Error while converting from bool.",m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_From_CValue: Interpreter failed to convert from bool" << endl;
#endif
return NULL;
}
return pyValue;
}
/* Sequence Types to C++ Types */
//convert Python list to C++ vector of strings
std::vector<std::string>
PyTypeInterface::PyValue_To_StringVector (PyObject *pyList) const
{
std::vector<std::string> Output;
std::string ListElement;
PyObject *pyString = NULL;
if (PyList_Check(pyList)) {
for (Py_ssize_t i = 0; i < PyList_GET_SIZE(pyList); ++i) {
//Get next list item (Borrowed Reference)
pyString = PyList_GET_ITEM(pyList,i);
ListElement = (string) PyString_AsString(PyObject_Str(pyString));
Output.push_back(ListElement);
}
return Output;
}
// #ifdef _DEBUG
// cerr << "PyTypeInterface::PyValue_To_StringVector: Warning: Value is not list of strings." << endl;
// #endif
/// Assume a single value that can be casted as string
/// this allows to write e.g. Feature.label = 5.2 instead of ['5.2']
Output.push_back(PyValue_To_String(pyList));
if (m_error) {
std::string msg = "Value is not list of strings nor can be casted as string. ";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_StringVector failed. " << msg << endl;
#endif
}
return Output;
}
//convert PyFeature.value (typically a list or numpy array) to C++ vector of floats
std::vector<float>
PyTypeInterface::PyValue_To_FloatVector (PyObject *pyValue) const
{
#ifdef HAVE_NUMPY
if (m_numpyInstalled)
{
// there are four types of values we may receive from a numpy process:
// * a python scalar,
// * an array scalar, (e.g. numpy.float32)
// * an array with nd = 0 (0D array)
// * an array with nd > 0
/// check for scalars
if (PyArray_CheckScalar(pyValue) || PyFloat_Check(pyValue)) {
std::vector<float> Output;
// we rely on the behaviour the scalars are either floats
// or support the number protocol
// TODO: a potential optimisation is to handle them directly
Output.push_back(PyValue_To_Float(pyValue));
return Output;
}
/// numpy array
if (PyArray_CheckExact(pyValue))
return PyArray_To_FloatVector(pyValue);
}
#endif
/// python list of floats (backward compatible)
if (PyList_Check(pyValue)) {
return PyList_To_FloatVector(pyValue);
}
std::vector<float> Output;
/// finally assume a single value supporting the number protocol
/// this allows to write e.g. Feature.values = 5 instead of [5.00]
Output.push_back(PyValue_To_Float(pyValue));
if (m_error) {
std::string msg = "Value is not list or array of floats nor can be casted as float. ";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_FloatVector failed. " << msg << endl;
#endif
}
return Output;
}
//convert a list of python floats
std::vector<float>
PyTypeInterface::PyList_To_FloatVector (PyObject *inputList) const
{
std::vector<float> Output;
#ifdef _DEBUG
// This is a low level function normally called from
// PyValue_To_FloatVector(). Checking for list is not required.
if (!PyList_Check(inputList)) {
std::string msg = "Value is not list.";
setValueError(msg,true);
cerr << "PyTypeInterface::PyList_To_FloatVector failed. " << msg << endl;
return Output;
}
#endif
float ListElement;
PyObject *pyFloat = NULL;
PyObject **pyObjectArray = PySequence_Fast_ITEMS(inputList);
for (Py_ssize_t i = 0; i < PyList_GET_SIZE(inputList); ++i) {
// pyFloat = PyList_GET_ITEM(inputList,i);
pyFloat = pyObjectArray[i];
#ifdef _DEBUG
if (!pyFloat) {
if (PyErr_Occurred()) {PyErr_Print(); PyErr_Clear();}
cerr << "PyTypeInterface::PyList_To_FloatVector: Could not obtain list element: "
<< i << " PyList_GetItem returned NULL! Skipping value." << endl;
continue;
}
#endif
// ListElement = (float) PyFloat_AS_DOUBLE(pyFloat);
ListElement = PyValue_To_Float(pyFloat);
#ifdef _DEBUG_VALUES
cerr << "value: " << ListElement << endl;
#endif
Output.push_back(ListElement);
}
return Output;
}
// if numpy is not installed this will not be called,
// therefor we do not check again
#ifdef HAVE_NUMPY
std::vector<float>
PyTypeInterface::PyArray_To_FloatVector (PyObject *pyValue) const
{
std::vector<float> Output;
#ifdef _DEBUG
// This is a low level function, normally called from
// PyValue_To_FloatVector(). Checking the array here is not required.
if (!PyArray_Check(pyValue)) {
std::string msg = "Object has no array interface.";
setValueError(msg,true);
cerr << "PyTypeInterface::PyArray_To_FloatVector failed. " << msg << endl;
return Output;
}
#endif
PyArrayObject* pyArray = (PyArrayObject*) pyValue;
PyArray_Descr* descr = PyArray_DESCR(pyArray);
/// check raw data and descriptor pointers
if (PyArray_DATA(pyArray) == 0 || descr == 0) {
std::string msg = "NumPy array with NULL data or descriptor pointer encountered.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyArray_To_FloatVector failed. Error: " << msg << endl;
#endif
return Output;
}
/// check dimensions
if (PyArray_NDIM(pyArray) != 1) {
std::string msg = "NumPy array must be a one dimensional vector.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyArray_To_FloatVector failed. Error: " << msg << " Dims: " << (int) PyArray_NDIM(pyArray) << endl;
#endif
return Output;
}
#ifdef _DEBUG_VALUES
cerr << "PyTypeInterface::PyArray_To_FloatVector: Numpy array verified." << endl;
#endif
/// check strides (useful if array is not continuous)
size_t strides = *((size_t*) PyArray_STRIDES(pyArray));
/// convert the array
switch (descr->type_num)
{
case NPY_FLOAT : // dtype='float32'
return PyArray_Convert<float,float>(PyArray_DATA(pyArray),PyArray_DIMS(pyArray)[0],strides);
case NPY_DOUBLE : // dtype='float64'
return PyArray_Convert<float,double>(PyArray_DATA(pyArray),PyArray_DIMS(pyArray)[0],strides);
case NPY_INT : // dtype='int'
return PyArray_Convert<float,int>(PyArray_DATA(pyArray),PyArray_DIMS(pyArray)[0],strides);
case NPY_LONG : // dtype='long'
return PyArray_Convert<float,long>(PyArray_DATA(pyArray),PyArray_DIMS(pyArray)[0],strides);
default :
std::string msg = "Unsupported value type in NumPy array object.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyArray_To_FloatVector failed. Error: " << msg << endl;
#endif
return Output;
}
}
#endif
/// FeatureSet (an integer map of FeatureLists)
Vamp::Plugin::FeatureSet
PyTypeInterface::PyValue_To_FeatureSet(PyObject* pyValue) const
{
Vamp::Plugin::FeatureSet rFeatureSet;
/// Convert PyFeatureSet
if (PyFeatureSet_CheckExact(pyValue)) {
Py_ssize_t pyPos = 0;
PyObject *pyKey, *pyDictValue; // Borrowed References
int key;
// bool it_error = false;
m_error = false;
while (PyDict_Next(pyValue, &pyPos, &pyKey, &pyDictValue))
{
key = (int) PyInt_AS_LONG(pyKey);
#ifdef _DEBUG_VALUES
cerr << "key: '" << key << "' value: '" << PyValue_To_String(pyDictValue) << "' " << endl;
#endif
// DictValue -> Vamp::FeatureList
PyValue_To_rValue(pyDictValue,rFeatureSet[key]);
if (m_error) {
// it_error = true;
lastError() << " in output number: " << key;
}
}
// if (it_error) m_error = true;
if (!m_errorQueue.empty()) {
setValueError("Error while converting FeatureSet.",m_strict);
}
return rFeatureSet;
}
/// Convert Python list (backward compatibility)
if (PyList_Check(pyValue)) {
PyObject *pyFeatureList; // This will be borrowed reference
//Parse Output List for each element (FeatureSet)
m_error = false;
for (Py_ssize_t i = 0; i < PyList_GET_SIZE(pyValue); ++i) {
//Get i-th FeatureList (Borrowed Reference)
pyFeatureList = PyList_GET_ITEM(pyValue,i);
PyValue_To_rValue(pyFeatureList,rFeatureSet[i]);
if (m_error) {
lastError() << " in output number: " << i;
}
}
if (!m_errorQueue.empty()) m_error = true;
return rFeatureSet;
}
/// accept None return values
if (pyValue == Py_None) return rFeatureSet;
/// give up
std::string msg = "Unsupported return type. Expected list or vampy.FeatureSet(). ";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_FeatureSet failed. Error: " << msg << endl;
#endif
return rFeatureSet;
}
Vamp::RealTime
PyTypeInterface::PyValue_To_RealTime(PyObject* pyValue) const
{
// We accept integer sample counts (for backward compatibility)
// or PyRealTime objects and convert them to Vamp::RealTime
if (PyRealTime_CheckExact(pyValue))
{
/// just create a copy of the wrapped object
return Vamp::RealTime(*PyRealTime_AS_REALTIME(pyValue));
}
// assume integer sample count
long sampleCount = PyValue_To_Long(pyValue);
if (m_error) {
std::string msg = "Unexpected value passed as RealTime.\nMust be vampy.RealTime type or integer sample count.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_RealTime failed. " << msg << endl;
#endif
return Vamp::RealTime();
}
#ifdef _DEBUG_VALUES
Vamp::RealTime rt =
Vamp::RealTime::frame2RealTime(sampleCount,m_inputSampleRate );
cerr << "RealTime: " << (long)sampleCount << ", ->" << rt.toString() << endl;
return rt;
#else
return Vamp::RealTime::frame2RealTime(sampleCount,m_inputSampleRate );
#endif
}
Vamp::Plugin::OutputDescriptor::SampleType
PyTypeInterface::PyValue_To_SampleType(PyObject* pyValue) const
{
/// convert simulated enum values
/// { OneSamplePerStep,FixedSampleRate,VariableSampleRate }
if (PyInt_CheckExact(pyValue)) {
long lst = PyInt_AS_LONG(pyValue);
if (lst<0 || lst>2) {
setValueError("Overflow error. SampleType has to be one of { OneSamplePerStep,FixedSampleRate,VariableSampleRate }\n(an integer in the range of 0..2) or a string value naming the type.",m_strict);
return Vamp::Plugin::OutputDescriptor::SampleType();
}
return (Vamp::Plugin::OutputDescriptor::SampleType) lst;
}
/// convert string (backward compatible)
if (PyString_CheckExact(pyValue)) {
Vamp::Plugin::OutputDescriptor::SampleType st;
st = (Vamp::Plugin::OutputDescriptor::SampleType) sampleKeys[PyValue_To_String(pyValue)];
if (m_error) {
std::string msg = "Unexpected value passed as SampleType. Must be one of { OneSamplePerStep,FixedSampleRate,VariableSampleRate }\n(an integer in the range of 0..2) or a string value naming the type.";
setValueError(msg,m_strict);
return Vamp::Plugin::OutputDescriptor::SampleType();
}
return st;
}
/// give up
std::string msg = "Unsupported return type. Expected one of { OneSamplePerStep,FixedSampleRate,VariableSampleRate }\n(an integer in the range of 0..2) or a string value naming the type.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_SampleType failed. Error: " << msg << endl;
#endif
return Vamp::Plugin::OutputDescriptor::SampleType();
}
Vamp::Plugin::InputDomain
PyTypeInterface::PyValue_To_InputDomain(PyObject* pyValue) const
{
/// convert simulated enum values { TimeDomain,FrequencyDomain }
if (PyInt_CheckExact(pyValue)) {
long lst = PyInt_AS_LONG(pyValue);
if (lst!=0 && lst!=1) {
setValueError("Overflow error. InputDomain has to be one of { TimeDomain,FrequencyDomain }\n(an integer in the range of 0..1) or a string value naming the type.",m_strict);
return Vamp::Plugin::InputDomain();
}
return (Vamp::Plugin::InputDomain) lst;
}
/// convert string (backward compatible)
if (PyString_CheckExact(pyValue)) {
Vamp::Plugin::InputDomain id;
id = (PyValue_To_String(pyValue) == "FrequencyDomain")?Vamp::Plugin::FrequencyDomain:Vamp::Plugin::TimeDomain;
if (m_error)
{
std::string msg = "Unexpected value passed as SampleType. Must be one of { TimeDomain,FrequencyDomain }\n(an integer in the range of 0..1) or a string value naming the type.";
setValueError(msg,m_strict);
return Vamp::Plugin::InputDomain();
}
return id;
}
/// give up
std::string msg = "Unsupported return type. Expected one of { TimeDomain,FrequencyDomain }\n(an integer in the range of 0..1) or a string value naming the type.";
setValueError(msg,m_strict);
#ifdef _DEBUG
cerr << "PyTypeInterface::PyValue_To_InputDomain failed. Error: " << msg << endl;
#endif
return Vamp::Plugin::InputDomain();
}
/// OutputDescriptor
void
PyTypeInterface::SetValue(Vamp::Plugin::OutputDescriptor& od, std::string& key, PyObject* pyValue) const
{
switch (outKeys[key])
{
case o::not_found:
setValueError("Unknown key in Vamp OutputDescriptor",m_strict);
cerr << "Unknown key in Vamp OutputDescriptor: " << key << endl;
break;
case o::identifier:
_convert(pyValue,od.identifier);
break;
case o::name:
_convert(pyValue,od.name);
break;
case o::description:
_convert(pyValue,od.description);
break;
case o::unit:
_convert(pyValue,od.unit);
break;
case o::hasFixedBinCount:
_convert(pyValue,od.hasFixedBinCount);
break;
case o::binCount:
_convert(pyValue,od.binCount);
break;
case o::binNames:
_convert(pyValue,od.binNames);
break;
case o::hasKnownExtents:
_convert(pyValue,od.hasKnownExtents);
break;
case o::minValue:
_convert(pyValue,od.minValue);
break;
case o::maxValue:
_convert(pyValue,od.maxValue);
break;
case o::isQuantized:
_convert(pyValue,od.isQuantized);
break;
case o::quantizeStep:
_convert(pyValue,od.quantizeStep);
break;
case o::sampleType:
_convert(pyValue,od.sampleType);
break;
case o::sampleRate:
_convert(pyValue,od.sampleRate);
break;
case o::hasDuration:
_convert(pyValue,od.hasDuration);
break;
default:
setValueError("Unknown key in Vamp OutputDescriptor",m_strict);
cerr << "Invalid key in Vamp OutputDescriptor: " << key << endl;
}
}
/// ParameterDescriptor
void
PyTypeInterface::SetValue(Vamp::Plugin::ParameterDescriptor& pd, std::string& key, PyObject* pyValue) const
{
switch (parmKeys[key])
{
case p::not_found :
setValueError("Unknown key in Vamp ParameterDescriptor",m_strict);
cerr << "Unknown key in Vamp ParameterDescriptor: " << key << endl;