-
Notifications
You must be signed in to change notification settings - Fork 18
/
GUIInfoManager.cpp
11761 lines (11589 loc) · 509 KB
/
GUIInfoManager.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
/*
* Copyright (C) 2005-2018 Team Kodi
* This file is part of Kodi - https://kodi.tv
*
* SPDX-License-Identifier: GPL-2.0-or-later
* See LICENSES/README.md for more information.
*/
#include "GUIInfoManager.h"
#include "FileItem.h"
#include "ServiceBroker.h"
#include "URL.h"
#include "Util.h"
#include "application/ApplicationComponents.h"
#include "application/ApplicationPlayer.h"
#include "cores/DataCacheCore.h"
#include "filesystem/File.h"
#include "games/tags/GameInfoTag.h"
#include "guilib/guiinfo/GUIInfo.h"
#include "guilib/guiinfo/GUIInfoHelper.h"
#include "guilib/guiinfo/GUIInfoLabels.h"
#include "input/WindowTranslator.h"
#include "interfaces/AnnouncementManager.h"
#include "interfaces/info/InfoExpression.h"
#include "messaging/ApplicationMessenger.h"
#include "playlists/PlayListTypes.h"
#include "settings/SkinSettings.h"
#include "utils/ArtUtils.h"
#include "utils/CharsetConverter.h"
#include "utils/FileUtils.h"
#include "utils/StringUtils.h"
#include "utils/URIUtils.h"
#include "utils/log.h"
#include <algorithm>
#include <array>
#include <charconv>
#include <cmath>
#include <functional>
#include <iterator>
#include <memory>
#include <mutex>
using namespace KODI;
using namespace KODI::GUILIB;
using namespace KODI::GUILIB::GUIINFO;
using namespace INFO;
bool InfoBoolComparator(const InfoPtr &right, const InfoPtr &left)
{
return *right < *left;
}
CGUIInfoManager::CGUIInfoManager(void)
: m_currentFile(new CFileItem),
m_bools(&InfoBoolComparator)
{
}
CGUIInfoManager::~CGUIInfoManager(void)
{
delete m_currentFile;
}
void CGUIInfoManager::Initialize()
{
CServiceBroker::GetAppMessenger()->RegisterReceiver(this);
}
/// \brief Translates a string as given by the skin into an int that we use for more
/// efficient retrieval of data. Can handle combined strings on the form
/// Player.Caching + VideoPlayer.IsFullscreen (Logical and)
/// Player.HasVideo | Player.HasAudio (Logical or)
int CGUIInfoManager::TranslateString(const std::string &condition)
{
// translate $LOCALIZE as required
std::string strCondition(CGUIInfoLabel::ReplaceLocalize(condition));
return TranslateSingleString(strCondition);
}
typedef struct
{
const char *str;
int val;
} infomap;
/// \page modules__infolabels_boolean_conditions Infolabels and Boolean conditions
/// \tableofcontents
///
/// \section modules__infolabels_boolean_conditions_Description Description
/// Skins can use boolean conditions with the <b>\<visible\></b> tag or with condition
/// attributes. Scripts can read boolean conditions with
/// <b>xbmc.getCondVisibility(condition)</b>.
///
/// Skins can use infolabels with <b>$INFO[infolabel]</b> or the <b>\<info\></b> tag. Scripts
/// can read infolabels with <b>xbmc.getInfoLabel('infolabel')</b>.
///
/// @todo [docs] Improve the description and create links for functions
/// @todo [docs] Separate boolean conditions from infolabels
/// @todo [docs] Order items alphabetically within subsections for a better search experience
/// @todo [docs] Order subsections alphabetically
/// @todo [docs] Use links instead of bold values for infolabels/bools
/// so we can use a link to point users when providing help
///
/// \page modules__infolabels_boolean_conditions
/// \section modules_list_infolabels_booleans List of Infolabels and Boolean conditions
/// \subsection modules__infolabels_boolean_conditions_GlobalBools Global
/// \table_start
/// \table_h3{ Labels, Type, Description }
/// \table_row3{ <b>`true`</b>,
/// \anchor Global_True
/// _boolean_,
/// @return Always evaluates to **true**.
/// <p>
/// }
/// \table_row3{ <b>`false`</b>,
/// \anchor Global_False
/// _boolean_,
/// @return Always evaluates to **false**.
/// <p>
/// }
/// \table_row3{ <b>`yes`</b>,
/// \anchor Global_Yes
/// _boolean_,
/// @return same as \link Global_True `true` \endlink.
/// <p>
/// }
/// \table_row3{ <b>`no`</b>,
/// \anchor Global_No
/// _boolean_,
/// @return same as \link Global_False `false` \endlink.
/// <p>
/// }
/// \table_end
///
/// -----------------------------------------------------------------------------
/// \page modules__infolabels_boolean_conditions
/// \subsection modules__infolabels_boolean_conditions_Addon Addon
/// \table_start
/// \table_h3{ Labels, Type, Description }
/// \table_row3{ <b>`Addon.SettingStr(addon_id\,setting_id)`</b>,
/// \anchor Addon_SettingString
/// _string_,
/// @return The string value of the setting `setting_id` belonging to the addon with the id `addon_id`.
/// @param addon_id - the id of the addon
/// @param setting_id - the addon setting
/// <p><hr>
/// @skinning_v20 **[New Infolabel]** \link Addon_SettingString `Addon.SettingStr(addon_id\,setting_id)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Addon.SettingBool(addon_id\,setting_id)`</b>,
/// \anchor Addon_SettingBool
/// _boolean_,
/// @return **True** if the setting `setting_id` belonging to the addon with the id `addon_id` is **True**\, **False** otherwise.
/// @note The provided setting with `setting_id` must be a boolean setting type. Otherwise it will return the boolean info
/// default value (which is **False**).
/// @param addon_id - the id of the addon
/// @param setting_id - the addon setting
/// <p><hr>
/// @skinning_v20 **[New Boolean Condition]** \link Addon_SettingBool `Addon.SettingBool(addon_id\,setting_id)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Addon.SettingInt(addon_id\,setting_id)`</b>,
/// \anchor Addon_SettingInt
/// _integer_,
/// @return The integer value of the setting `setting_id` belong to the addon with the id `addon_id`.
/// @note The provided setting with `setting_id` must be an integer setting type. Otherwise it will return the integer info
/// default value (which is 0).
/// @param addon_id - the id of the addon
/// @param setting_id - the addon setting
/// <p><hr>
/// @skinning_v20 **[New Integer Info]** \link Addon_SettingInt `Addon.SettingInt(addon_id\,setting_id)`\endlink
/// <p>
/// }
/// \table_end
///
/// -----------------------------------------------------------------------------
const infomap addons[] = {
{"settingstr", ADDON_SETTING_STRING},
{"settingbool", ADDON_SETTING_BOOL},
{"settingint", ADDON_SETTING_INT},
};
/// \page modules__infolabels_boolean_conditions
/// \subsection modules__infolabels_boolean_conditions_String String
/// \table_start
/// \table_h3{ Labels, Type, Description }
/// \table_row3{ <b>`String.IsEmpty(info)`</b>,
/// \anchor String_IsEmpty
/// _boolean_,
/// @return **True** if the info is empty.
/// @param info - infolabel
/// @note **Example of info:** \link ListItem_Title `ListItem.Title` \endlink \,
/// \link ListItem_Genre `ListItem.Genre` \endlink.
/// Please note that string can also be a `$LOCALIZE[]`.
/// Also note that in a panelview or similar this only works on the focused item
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link String_IsEmpty `String.IsEmpty(info)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`String.IsEqual(info\,string)`</b>,
/// \anchor String_IsEqual
/// _boolean_,
/// @return **True** if the info is equal to the given string.
/// @param info - infolabel
/// @param string - comparison string
/// @note **Example of info:** \link ListItem_Title `ListItem.Title` \endlink \,
/// \link ListItem_Genre `ListItem.Genre` \endlink.
/// Please note that string can also be a `$LOCALIZE[]`.
/// Also note that in a panelview or similar this only works on the focused item
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link String_IsEqual `String.IsEqual(info\,string)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`String.StartsWith(info\,substring)`</b>,
/// \anchor String_StartsWith
/// _boolean_,
/// @return **True** if the info starts with the given substring.
/// @param info - infolabel
/// @param substring - substring to check
/// @note **Example of info:** \link ListItem_Title `ListItem.Title` \endlink \,
/// \link ListItem_Genre `ListItem.Genre` \endlink.
/// Please note that string can also be a `$LOCALIZE[]`.
/// Also note that in a panelview or similar this only works on the focused item
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link String_StartsWith `String.StartsWith(info\,substring)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`String.EndsWith(info\,substring)`</b>,
/// \anchor String_EndsWith
/// _boolean_,
/// @return **True** if the info ends with the given substring.
/// @param info - infolabel
/// @param substring - substring to check
/// @note **Example of info:** \link ListItem_Title `ListItem.Title` \endlink \,
/// \link ListItem_Genre `ListItem.Genre` \endlink.
/// Please note that string can also be a `$LOCALIZE[]`.
/// Also note that in a panelview or similar this only works on the focused item
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link String_EndsWith `String.EndsWith(info\,substring)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`String.Contains(info\,substring)`</b>,
/// \anchor String_Contains
/// _boolean_,
/// @return **True** if the info contains the given substring.
/// @param info - infolabel
/// @param substring - substring to check
/// @note **Example of info:** \link ListItem_Title `ListItem.Title` \endlink \,
/// \link ListItem_Genre `ListItem.Genre` \endlink.
/// Please note that string can also be a `$LOCALIZE[]`.
/// Also note that in a panelview or similar this only works on the focused item
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link String_Contains `String.Contains(info\,substring)`\endlink
/// <p>
/// }
/// \table_end
///
/// -----------------------------------------------------------------------------
const infomap string_bools[] = {{ "isempty", STRING_IS_EMPTY },
{ "isequal", STRING_IS_EQUAL },
{ "startswith", STRING_STARTS_WITH },
{ "endswith", STRING_ENDS_WITH },
{ "contains", STRING_CONTAINS }};
/// \page modules__infolabels_boolean_conditions
/// \subsection modules__infolabels_boolean_conditions_Integer Integer
/// \table_start
/// \table_h3{ Labels, Type, Description }
/// \table_row3{ <b>`Integer.ValueOf(number)`</b>,
/// \anchor Integer_ValueOf
/// _integer_,
/// @return An integer info label that represents the provided number
/// @param number - the number to compute
/// @note **Example:** `Integer.ValueOf(4)` will be evaluated to 4.
/// @note Will return -1 if not able to convert the provided value to an integer. **Example**: `Integer.ValueOf(some string)` will evaluate to -1
/// as the provided argument is not an integer.
/// <p><hr>
/// @skinning_v20 **[New InfoLabel]** \link Integer_ValueOf `Integer.ValueOf(number)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsEqual(info\,number)`</b>,
/// \anchor Integer_IsEqual
/// _boolean_,
/// @return **True** if the value of the infolabel is equal to the supplied number.
/// @param info - infolabel
/// @param number - number or integer infolabel to compare
/// @note **Example:** `Integer.IsEqual(ListItem.Year\,2000)`
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Integer_IsEqual `Integer.IsEqual(info\,number)`\endlink
/// @skinning_v20 \link Integer_IsEqual `Integer.IsEqual(info\,number)`\endlink now supports comparisons against other integer infos
/// and not just fixed number values.
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsGreater(info\,number)`</b>,
/// \anchor Integer_IsGreater
/// _boolean_,
/// @return **True** if the value of the infolabel is greater than to the supplied number.
/// @param info - infolabel
/// @param number - number or integer infolabel to compare
/// @note **Example:** `Integer.IsGreater(ListItem.Year\,2000)`
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Integer_IsGreater `Integer.IsGreater(info\,number)`\endlink
/// @skinning_v20 \link Integer_IsGreater `Integer.IsGreater(info\,number)`\endlink now supports comparisons against other integer infos
/// and not just fixed number values.
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsGreaterOrEqual(info\,number)`</b>,
/// \anchor Integer_IsGreaterOrEqual
/// _boolean_,
/// @return **True** if the value of the infolabel is greater or equal to the supplied number.
/// @param info - infolabel
/// @param number - number or integer infolabel to compare
/// @note **Example:** `Integer.IsGreaterOrEqual(ListItem.Year\,2000)`
/// @note **Example2:** `Integer.IsGreaterOrEqual(Container(x).ListItem(1).Year\,Container(x).ListItem(2).Year)`
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Integer_IsGreaterOrEqual `Integer.IsGreaterOrEqual(info\,number)`\endlink
/// @skinning_v20 \link Integer_IsGreaterOrEqual `Integer.IsGreaterOrEqual(info\,number)`\endlink now supports comparisons against other integer infos
/// and not just fixed number values.
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsLess(info\,number)`</b>,
/// \anchor Integer_IsLess
/// _boolean_,
/// @return **True** if the value of the infolabel is less than the supplied number.
/// @param info - infolabel
/// @param number - number or integer infolabel to compare
/// @note **Example:** `Integer.IsLess(ListItem.Year\,2000)`
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Integer_IsLess `Integer.IsLess(info\,number)`\endlink
/// @skinning_v20 \link Integer_IsLess `Integer.IsLess(info\,number)`\endlink now supports comparisons against other integer infos
/// and not just fixed number values.
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsLessOrEqual(info\,number)`</b>,
/// \anchor Integer_IsLessOrEqual
/// _boolean_,
/// @return **True** if the value of the infolabel is less or equal to the supplied number.
/// @param info - infolabel
/// @param number - number or integer infolabel to compare
/// @note **Example:** `Integer.IsLessOrEqual(ListItem.Year\,2000)`
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Integer_IsLessOrEqual `Integer.IsLessOrEqual(info\,number)`\endlink
/// @skinning_v20 \link Integer_IsLessOrEqual `Integer.IsLessOrEqual(info\,number)`\endlink now supports comparisons against other integer infos
/// and not just fixed number values.
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsEven(info)`</b>,
/// \anchor Integer_IsEven
/// _boolean_,
/// @return **True** if the value of the infolabel is odd
/// @param info - infolabel
/// @note **Example:** `Integer.IsEven(ListItem.CurrentItem)`
/// <p><hr>
/// @skinning_v19 **[New Boolean Condition]** \link Integer_IsEven `Integer.IsEven(info)`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Integer.IsOdd(info)`</b>,
/// \anchor Integer_IsOdd
/// _boolean_,
/// @return **True** if the value of the infolabel is odd
/// @param info - infolabel
/// @note **Example:** `Integer.IsOdd(ListItem.CurrentItem)`
/// <p><hr>
/// @skinning_v19 **[New Boolean Condition]** \link Integer_IsOdd `Integer.IsOdd(info)`\endlink
/// <p>
/// }
/// \table_end
///
/// -----------------------------------------------------------------------------
const infomap integer_bools[] = {{ "isequal", INTEGER_IS_EQUAL },
{ "isgreater", INTEGER_GREATER_THAN },
{ "isgreaterorequal", INTEGER_GREATER_OR_EQUAL },
{ "isless", INTEGER_LESS_THAN },
{ "islessorequal", INTEGER_LESS_OR_EQUAL },
{ "iseven", INTEGER_EVEN },
{ "isodd", INTEGER_ODD }};
/// \page modules__infolabels_boolean_conditions
/// \subsection modules__infolabels_boolean_conditions_Player Player
/// \table_start
/// \table_h3{ Labels, Type, Description }
/// \table_row3{ <b>`Player.HasAudio`</b>,
/// \anchor Player_HasAudio
/// _boolean_,
/// @return **True** if the player has an audio file.
/// <p>
/// }
/// \table_row3{ <b>`Player.HasGame`</b>,
/// \anchor Player_HasGame
/// _boolean_,
/// @return **True** if the player has a game file (RETROPLAYER).
/// <p><hr>
/// @skinning_v18 **[New Boolean Condition]** \link Player_HasGame `Player.HasGame`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.HasMedia`</b>,
/// \anchor Player_HasMedia
/// _boolean_,
/// @return **True** if the player has an audio or video file.
/// <p>
/// }
/// \table_row3{ <b>`Player.HasVideo`</b>,
/// \anchor Player_HasVideo
/// _boolean_,
/// @return **True** if the player has a video file.
/// <p>
/// }
/// \table_row3{ <b>`Player.Paused`</b>,
/// \anchor Player_Paused
/// _boolean_,
/// @return **True** if the player is paused.
/// <p>
/// }
/// \table_row3{ <b>`Player.Playing`</b>,
/// \anchor Player_Playing
/// _boolean_,
/// @return **True** if the player is currently playing (i.e. not ffwding\,
/// rewinding or paused.)
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding`</b>,
/// \anchor Player_Rewinding
/// _boolean_,
/// @return **True** if the player is rewinding.
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding2x`</b>,
/// \anchor Player_Rewinding2x
/// _boolean_,
/// @return **True** if the player is rewinding at 2x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding4x`</b>,
/// \anchor Player_Rewinding4x
/// _boolean_,
/// @return **True** if the player is rewinding at 4x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding8x`</b>,
/// \anchor Player_Rewinding8x
/// _boolean_,
/// @return **True** if the player is rewinding at 8x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding16x`</b>,
/// \anchor Player_Rewinding16x
/// _boolean_,
/// @return **True** if the player is rewinding at 16x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Rewinding32x`</b>,
/// \anchor Player_Rewinding32x
/// _boolean_,
/// @return **True** if the player is rewinding at 32x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding`</b>,
/// \anchor Player_Forwarding
/// _boolean_,
/// @return **True** if the player is fast forwarding.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding2x`</b>,
/// \anchor Player_Forwarding2x
/// _boolean_,
/// @return **True** if the player is fast forwarding at 2x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding4x`</b>,
/// \anchor Player_Forwarding4x
/// _boolean_,
/// @return **True** if the player is fast forwarding at 4x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding8x`</b>,
/// \anchor Player_Forwarding8x
/// _boolean_,
/// @return **True** if the player is fast forwarding at 8x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding16x`</b>,
/// \anchor Player_Forwarding16x
/// _boolean_,
/// @return **True** if the player is fast forwarding at 16x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Forwarding32x`</b>,
/// \anchor Player_Forwarding32x
/// _boolean_,
/// @return **True** if the player is fast forwarding at 32x.
/// <p>
/// }
/// \table_row3{ <b>`Player.Caching`</b>,
/// \anchor Player_Caching
/// _boolean_,
/// @return **True** if the player is current re-caching data (internet based
/// video playback).
/// <p>
/// }
/// \table_row3{ <b>`Player.DisplayAfterSeek`</b>,
/// \anchor Player_DisplayAfterSeek
/// _boolean_,
/// @return **True** for the first 2.5 seconds after a seek.
/// <p>
/// }
/// \table_row3{ <b>`Player.Seekbar`</b>,
/// \anchor Player_Seekbar
/// _integer_,
/// @return The percentage of one seek to other position.
/// <p>
/// }
/// \table_row3{ <b>`Player.Seeking`</b>,
/// \anchor Player_Seeking
/// _boolean_,
/// @return **True** if a seek is in progress.
/// <p>
/// }
/// \table_row3{ <b>`Player.ShowTime`</b>,
/// \anchor Player_ShowTime
/// _boolean_,
/// @return **True** if the user has requested the time to show (occurs in video
/// fullscreen).
/// <p>
/// }
/// \table_row3{ <b>`Player.ShowInfo`</b>,
/// \anchor Player_ShowInfo
/// _boolean_,
/// @return **True** if the user has requested the song info to show (occurs in
/// visualisation fullscreen and slideshow).
/// <p>
/// }
/// \table_row3{ <b>`Player.Title`</b>,
/// \anchor Player_Title
/// _string_,
/// @return The Musicplayer title for audio and the Videoplayer title for
/// video.
/// <p>
/// }
/// \table_row3{ <b>`Player.offset(number).Title`</b>,
/// \anchor Player_Offset_Title
/// _string_,
/// @return The title of audio or video which has an offset `number` with respect to the currently playing item.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Offset_Title `Player.offset(number).Title`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.position(number).Title`</b>,
/// \anchor Player_Position_Title
/// _string_,
/// @return The title of the audio or video which has an offset `number` with respect to the start of the playlist.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Position_Title `Player.position(number).Title`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Muted`</b>,
/// \anchor Player_Muted
/// _boolean_,
/// @return **True** if the volume is muted.
/// <p>
/// }
/// \table_row3{ <b>`Player.HasDuration`</b>,
/// \anchor Player_HasDuration
/// _boolean_,
/// @return **True** if Media is not a true stream.
/// <p>
/// }
/// \table_row3{ <b>`Player.Passthrough`</b>,
/// \anchor Player_Passthrough
/// _boolean_,
/// @return **True** if the player is using audio passthrough.
/// <p>
/// }
/// \table_row3{ <b>`Player.CacheLevel`</b>,
/// \anchor Player_CacheLevel
/// _string_,
/// @return The used cache level as a string with an integer number.
/// <p>
/// }
/// \table_row3{ <b>`Player.Progress`</b>,
/// \anchor Player_Progress
/// _integer_ / _string_,
/// @return The progress position as percentage.
/// <p><hr>
/// @skinning_v19 \link Player_Progress `Player.Progress`\endlink infolabel
/// also exposed as a string.
/// <p>
/// }
/// \table_row3{ <b>`Player.ProgressCache`</b>,
/// \anchor Player_ProgressCache
/// _integer_ / _string_,
/// @return How much of the file is cached above current play percentage
/// <p><hr>
/// @skinning_v19 \link Player_ProgressCache `Player.ProgressCache`\endlink
/// infolabel also exposed as a string.
/// <p>
/// }
/// \table_row3{ <b>`Player.Volume`</b>,
/// \anchor Player_Volume
/// _string_,
/// @return The current player volume with the format `%2.1f` dB
/// <p>
/// }
/// \table_row3{ <b>`Player.SubtitleDelay`</b>,
/// \anchor Player_SubtitleDelay
/// _string_,
/// @return The used subtitle delay with the format `%2.3f` s
/// <p>
/// }
/// \table_row3{ <b>`Player.AudioDelay`</b>,
/// \anchor Player_AudioDelay
/// _string_,
/// @return The used audio delay with the format `%2.3f` s
/// <p>
/// }
/// \table_row3{ <b>`Player.Chapter`</b>,
/// \anchor Player_Chapter
/// _integer_,
/// @return The current chapter of current playing media.
/// <p>
/// }
/// \table_row3{ <b>`Player.ChapterCount`</b>,
/// \anchor Player_ChapterCount
/// _integer_,
/// @return The total number of chapters of current playing media.
/// <p>
/// }
/// \table_row3{ <b>`Player.ChapterName`</b>,
/// \anchor Player_ChapterName
/// _string_,
/// @return The name of currently used chapter if available.
/// <p>
/// }
/// \table_row3{ <b>`Player.Folderpath`</b>,
/// \anchor Player_Folderpath
/// _string_,
/// @return The full path of the currently playing song or movie
/// <p>
/// }
/// \table_row3{ <b>`Player.offset(number).Folderpath`</b>,
/// \anchor Player_Offset_Folderpath
/// _string_,
/// @return The full path of the audio or video file which has an offset `number` with respect to the currently playing item.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Offset_Folderpath `Player.offset(number).Folderpath`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.position(number).Folderpath`</b>,
/// \anchor Player_Position_Folderpath
/// _string_,
/// @return The full path of the audio or video file which has an offset `number` with respect to the start of the playlist.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Position_Folderpath `Player.position(number).Folderpath`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.FilenameAndPath`</b>,
/// \anchor Player_FilenameAndPath
/// _string_,
/// @return The full path with filename of the currently
/// playing song or movie
/// <p>
/// }
/// \table_row3{ <b>`Player.offset(number).FilenameAndPath`</b>,
/// \anchor Player_Offset_FilenameAndPath
/// _string_,
/// @return The full path with filename of audio or video file which has an offset `number` with respect to the currently playing item.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Offset_FilenameAndPath `Player.offset(number).FilenameAndPath`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.position(number).FilenameAndPath`</b>,
/// \anchor Player_Position_FilenameAndPath
/// _string_,
/// @return The full path with filename of the audio or video file which has an offset `number` with respect to the start of the playlist.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Position_FilenameAndPath `Player.position(number).FilenameAndPath`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Filename`</b>,
/// \anchor Player_Filename
/// _string_,
/// @return The filename of the currently playing media.
/// <p><hr>
/// @skinning_v13 **[New Infolabel]** \link Player_Filename `Player.Filename`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.offset(number).Filename`</b>,
/// \anchor Player_Offset_Filename
/// _string_,
/// @return The filename of audio or video file which has an offset `number` with respect to the currently playing item.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Offset_Filename `Player.offset(number).Filename`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.position(number).Filename`</b>,
/// \anchor Player_Position_Filename
/// _string_,
/// @return The filename of the audio or video file which has an offset `number` with respect to the start of the playlist.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Position_Filename `Player.position(number).Filename`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.IsInternetStream`</b>,
/// \anchor Player_IsInternetStream
/// _boolean_,
/// @return **True** if the player is playing an internet stream.
/// <p>
/// }
/// \table_row3{ <b>`Player.PauseEnabled`</b>,
/// \anchor Player_PauseEnabled
/// _boolean_,
/// @return **True** if played stream is paused.
/// <p>
/// }
/// \table_row3{ <b>`Player.SeekEnabled`</b>,
/// \anchor Player_SeekEnabled
/// _boolean_,
/// @return **True** if seek on playing is enabled.
/// <p>
/// }
/// \table_row3{ <b>`Player.ChannelPreviewActive`</b>,
/// \anchor Player_ChannelPreviewActive
/// _boolean_,
/// @return **True** if PVR channel preview is active (used
/// channel tag different from played tag)
/// <p>
/// }
/// \table_row3{ <b>`Player.TempoEnabled`</b>,
/// \anchor Player_TempoEnabled
/// _boolean_,
/// @return **True** if player supports tempo (i.e. speed up/down normal
/// playback speed)
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Player_TempoEnabled `Player.TempoEnabled`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.IsTempo`</b>,
/// \anchor Player_IsTempo
/// _boolean_,
/// @return **True** if player has tempo (i.e. is playing with a playback speed higher or
/// lower than normal playback speed)
/// <p><hr>
/// @skinning_v17 **[New Boolean Condition]** \link Player_IsTempo `Player.IsTempo`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.PlaySpeed`</b>,
/// \anchor Player_PlaySpeed
/// _string_,
/// @return The player playback speed with the format `%1.2f` (1.00 means normal
/// playback speed).
/// @note For Tempo\, the default range is 0.80 - 1.50 (it can be changed
/// in advanced settings). If \ref Player_PlaySpeed "Player.PlaySpeed" returns a value different from 1.00
/// and \ref Player_IsTempo "Player.IsTempo" is false it means the player is in ff/rw mode.
/// <p>
/// }
/// \table_row3{ <b>`Player.HasResolutions`</b>,
/// \anchor Player_HasResolutions
/// _boolean_,
/// @return **True** if the player is allowed to switch resolution and refresh rate
/// (i.e. if whitelist modes are configured in Kodi's System/Display settings)
/// <p><hr>
/// @skinning_v18 **[New Boolean Condition]** \link Player_HasResolutions `Player.HasResolutions`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.HasPrograms`</b>,
/// \anchor Player_HasPrograms
/// _boolean_,
/// @return **True** if the media file being played has programs\, i.e. groups of streams.
/// @note Ex: if a media file has multiple streams (quality\, channels\, etc) a program represents
/// a particular stream combo.
/// <p>
/// }
/// \table_row3{ <b>`Player.FrameAdvance`</b>,
/// \anchor Player_FrameAdvance
/// _boolean_,
/// @return **True** if player is in frame advance mode.
/// @note Skins should hide seek bar in this mode
/// <p><hr>
/// @skinning_v18 **[New Boolean Condition]** \link Player_FrameAdvance `Player.FrameAdvance`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Icon`</b>,
/// \anchor Player_Icon
/// _string_,
/// @return The thumbnail of the currently playing item. If no thumbnail image exists\,
/// the icon will be returned\, if available.
/// <p><hr>
/// @skinning_v18 **[New Infolabel]** \link Player_Icon `Player.Icon`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Editlist`</b>,
/// \anchor Player_Editlist
/// _string_,
/// @return The editlist of the currently playing item as csv in the format start1\,end1\,start2\,end2\,...
/// Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.
/// @note This infolabel does not contain EDL cuts. Edits start and end times are ajusted according to cuts
/// defined for the media item.
/// <p><hr>
/// @skinning_v20 **[New Infolabel]** \link Player_Editlist `Player.Editlist`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Cuts`</b>,
/// \anchor Player_Cuts
/// _string_,
/// @return The EDL cut markers of the currently playing item as csv in the format start1\,end1\,start2\,end2\,...
/// Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.
/// <p><hr>
/// @skinning_v20 **[New Infolabel]** \link Player_Cuts `Player.Cuts`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.SceneMarkers`</b>,
/// \anchor Player_SceneMarkers
/// _string_,
/// @return The EDL scene markers of the currently playing item as csv in the format start1\,end1\,start2\,end2\,...
/// Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.
/// <p><hr>
/// @skinning_v20 **[New Infolabel]** \link Player_SceneMarkers `Player.SceneMarkers`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.HasSceneMarkers`</b>,
/// \anchor Player_HasSceneMarkers
/// _boolean_,
/// @return **True** if the item being played has scene markers\, **False** otherwise
/// <p><hr>
/// @skinning_v20 **[New Infolabel]** \link Player_HasSceneMarkers `Player.HasSceneMarkers`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.Chapters`</b>,
/// \anchor Player_Chapters
/// _string_,
/// @return The chapters of the currently playing item as csv in the format start1\,end1\,start2\,end2\,...
/// Tokens must have values in the range from 0.0 to 100.0. end token must be less or equal than start token.
/// <p><hr>
/// @skinning_v19 **[New Infolabel]** \link Player_Chapters `Player.Chapters`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.IsExternal`</b>,
/// \anchor Player_IsExternal
/// _boolean_,
/// @return **True** if the playing player is an external player\, **False** otherwise
/// <p><hr>
/// @skinning_v21 **[New Boolean Condition]** \link Player_IsExternal `Player.IsExternal`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.IsRemote`</b>,
/// \anchor Player_IsRemote
/// _boolean_,
/// @return **True** if the playing player is a remote player (e.g. UPnP)\, **False** otherwise
/// <p><hr>
/// @skinning_v21 **[New Boolean Condition]** \link Player_IsRemote `Player.IsRemote`\endlink
/// <p>
/// }
const infomap player_labels[] = {{"hasmedia", PLAYER_HAS_MEDIA},
{"hasaudio", PLAYER_HAS_AUDIO},
{"hasvideo", PLAYER_HAS_VIDEO},
{"hasgame", PLAYER_HAS_GAME},
{"isexternal", PLAYER_IS_EXTERNAL},
{"isremote", PLAYER_IS_REMOTE},
{"playing", PLAYER_PLAYING},
{"paused", PLAYER_PAUSED},
{"rewinding", PLAYER_REWINDING},
{"forwarding", PLAYER_FORWARDING},
{"rewinding2x", PLAYER_REWINDING_2x},
{"rewinding4x", PLAYER_REWINDING_4x},
{"rewinding8x", PLAYER_REWINDING_8x},
{"rewinding16x", PLAYER_REWINDING_16x},
{"rewinding32x", PLAYER_REWINDING_32x},
{"forwarding2x", PLAYER_FORWARDING_2x},
{"forwarding4x", PLAYER_FORWARDING_4x},
{"forwarding8x", PLAYER_FORWARDING_8x},
{"forwarding16x", PLAYER_FORWARDING_16x},
{"forwarding32x", PLAYER_FORWARDING_32x},
{"caching", PLAYER_CACHING},
{"seekbar", PLAYER_SEEKBAR},
{"seeking", PLAYER_SEEKING},
{"showtime", PLAYER_SHOWTIME},
{"showinfo", PLAYER_SHOWINFO},
{"muted", PLAYER_MUTED},
{"hasduration", PLAYER_HASDURATION},
{"passthrough", PLAYER_PASSTHROUGH},
{"cachelevel", PLAYER_CACHELEVEL},
{"title", PLAYER_TITLE},
{"progress", PLAYER_PROGRESS},
{"progresscache", PLAYER_PROGRESS_CACHE},
{"volume", PLAYER_VOLUME},
{"subtitledelay", PLAYER_SUBTITLE_DELAY},
{"audiodelay", PLAYER_AUDIO_DELAY},
{"chapter", PLAYER_CHAPTER},
{"chaptercount", PLAYER_CHAPTERCOUNT},
{"chaptername", PLAYER_CHAPTERNAME},
{"folderpath", PLAYER_PATH},
{"filenameandpath", PLAYER_FILEPATH},
{"filename", PLAYER_FILENAME},
{"isinternetstream", PLAYER_ISINTERNETSTREAM},
{"pauseenabled", PLAYER_CAN_PAUSE},
{"seekenabled", PLAYER_CAN_SEEK},
{"channelpreviewactive", PLAYER_IS_CHANNEL_PREVIEW_ACTIVE},
{"tempoenabled", PLAYER_SUPPORTS_TEMPO},
{"istempo", PLAYER_IS_TEMPO},
{"playspeed", PLAYER_PLAYSPEED},
{"hasprograms", PLAYER_HAS_PROGRAMS},
{"hasresolutions", PLAYER_HAS_RESOLUTIONS},
{"frameadvance", PLAYER_FRAMEADVANCE},
{"icon", PLAYER_ICON},
{"editlist", PLAYER_EDITLIST},
{"cuts", PLAYER_CUTS},
{"scenemarkers", PLAYER_SCENE_MARKERS},
{"hasscenemarkers", PLAYER_HAS_SCENE_MARKERS},
{"chapters", PLAYER_CHAPTERS}};
/// \page modules__infolabels_boolean_conditions
/// \table_row3{ <b>`Player.Art(type)`</b>,
/// \anchor Player_Art_type
/// _string_,
/// @return The Image for the defined art type for the current playing ListItem.
/// @param type - The art type. The type is defined by scripts and scrappers and can have any value.
/// Common example values for type are:
/// - fanart
/// - thumb
/// - poster
/// - banner
/// - clearlogo
/// - tvshow.poster
/// - tvshow.banner
/// - etc
/// @todo get a way of centralize all random art strings used in core so we can point users to them
/// while still making it clear they can have any value.
/// <p>
/// }
/// \table_row3{ <b>`Player.HasPerformedSeek(interval)`</b>,
/// \anchor Player_HasPerformedSeek
/// _boolean_,
/// @return **True** if the Player has performed a seek operation in the last provided second `interval`\, **False** otherwise.
/// @param interval - the time interval (in seconds)
/// <p><hr>
/// @skinning_v20 **[New Boolean Condition]** \link Player_HasPerformedSeek `Player.HasPerformedSeek(interval)`\endlink
/// <p>
/// }
const infomap player_param[] = {{"art", PLAYER_ITEM_ART},
{"hasperformedseek", PLAYER_HASPERFORMEDSEEK}};
/// \page modules__infolabels_boolean_conditions
/// \table_row3{ <b>`Player.SeekTime`</b>,
/// \anchor Player_SeekTime
/// _string_,
/// @return The time to which the user is seeking.
/// <p>
/// }
/// \table_row3{ <b>`Player.SeekOffset([format])`</b>,
/// \anchor Player_SeekOffset_format
/// _string_,
/// @return The seek offset after a seek press in a given format.
/// @param format [opt] The format of the return time value.
/// See \ref TIME_FORMAT for the list of possible values.
/// <p>
/// @note **Example:** user presses BigStepForward\, player.seekoffset returns +10:00
/// <p>
/// }
/// \table_row3{ <b>`Player.SeekStepSize`</b>,
/// \anchor Player_SeekStepSize
/// _string_,
/// @return The seek step size.
/// <p>
/// <hr>
/// @skinning_v15 **[New Infolabel]** \link Player_SeekStepSize `Player.SeekStepSize`\endlink
/// <p>
/// }
/// \table_row3{ <b>`Player.TimeRemaining([format])`</b>,
/// \anchor Player_TimeRemaining_format
/// _string_,
/// @return The remaining time of current playing media in a given format.
/// @param format [opt] The format of the return time value.
/// See \ref TIME_FORMAT for the list of possible values.
/// <p>
/// }
/// \table_row3{ <b>`Player.TimeSpeed`</b>,
/// \anchor Player_TimeSpeed
/// _string_,
/// @return The time and the playspeed formatted: "1:23 (2x)".
/// <p>
/// }
/// \table_row3{ <b>`Player.Time([format])`</b>,
/// \anchor Player_Time_format
/// _string_,
/// @return The elapsed time of current playing media in a given format.
/// @param format [opt] The format of the return time value.
/// See \ref TIME_FORMAT for the list of possible values.
/// <p>
/// }
/// \table_row3{ <b>`Player.Duration([format])`</b>,
/// \anchor Player_Duration_format
/// _string_,