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
|
#!/usr/bin/env python3
#
# requires Python LXML (sudo apt-get install python-lxml)
#
# When adding new fixtures, regenerate the fixtures map with:
# ./scripts/fixtures-tool.py --validate --map
#
import sys
import os
import re
import argparse
import lxml.etree as etree
singleCapCount = 0
namespace = "http://www.qlcplus.org/FixtureDefinition"
# please see https://github.com/mcallegari/qlcplus/wiki/Fixture-definition-presets when changing this list
def getPresetsArray():
return [
"Custom",
"IntensityMasterDimmer", "IntensityMasterDimmerFine", "IntensityDimmer", "IntensityDimmerFine",
"IntensityRed", "IntensityRedFine", "IntensityGreen", "IntensityGreenFine", "IntensityBlue", "IntensityBlueFine",
"IntensityCyan", "IntensityCyanFine", "IntensityMagenta", "IntensityMagentaFine", "IntensityYellow", "IntensityYellowFine",
"IntensityAmber", "IntensityAmberFine", "IntensityWhite", "IntensityWhiteFine", "IntensityUV", "IntensityUVFine",
"IntensityIndigo", "IntensityIndigoFine", "IntensityLime", "IntensityLimeFine", "IntensityHue", "IntensityHueFine",
"IntensitySaturation", "IntensitySaturationFine", "IntensityLightness", "IntensityLightnessFine",
"IntensityValue", "IntensityValueFine",
"PositionPan", "PositionPanFine", "PositionTilt", "PositionTiltFine", "PositionXAxis", "PositionYAxis",
"SpeedPanSlowFast", "SpeedPanFastSlow", "SpeedTiltSlowFast", "SpeedTiltFastSlow", "SpeedPanTiltSlowFast", "SpeedPanTiltFastSlow",
"ColorMacro", "ColorWheel", "ColorWheelFine", "ColorRGBMixer", "ColorCTOMixer", "ColorCTCMixer", "ColorCTBMixer",
"GoboWheel", "GoboWheelFine", "GoboIndex", "GoboIndexFine",
"ShutterStrobeSlowFast", "ShutterStrobeFastSlow", "ShutterIrisMinToMax", "ShutterIrisMaxToMin", "ShutterIrisFine"
"BeamFocusNearFar", "BeamFocusFarNear", "BeamFocusFine", "BeamZoomSmallBig", "BeamZoomBigSmall", "BeamZoomFine",
"PrismRotationSlowFast", "PrismRotationFastSlow",
"NoFunction" ]
def printPresets(group):
presets = getPresetsArray()
pMin = 1
pMax = presets.index("NoFunction")
if group == "Intensity":
pMin = presets.index("IntensityMasterDimmer")
pMax = presets.index("IntensityValueFine")
elif group == "Pan":
pMin = presets.index("PositionPan")
pMax = presets.index("PositionPanFine")
elif group == "Tilt":
pMin = presets.index("PositionTilt")
pMax = presets.index("PositionTiltFine")
elif group == "Speed":
pMin = presets.index("SpeedPanSlowFast")
pMax = presets.index("SpeedPanTiltFastSlow")
elif group == "Colour":
pMin = presets.index("ColorMacro")
pMax = presets.index("ColorCTBMixer")
elif group == "Gobo":
pMin = presets.index("GoboWheel")
pMax = presets.index("GoboIndexFine")
elif group == "Shutter":
pMin = presets.index("ShutterStrobeSlowFast")
pMax = presets.index("ShutterIrisFine")
elif group == "Beam":
pMin = presets.index("BeamFocusNearFar")
pMax = presets.index("BeamZoomFine")
elif group == "Prism":
pMin = presets.index("PrismRotationSlowFast")
pMax = presets.index("PrismRotationFastSlow")
for i in range(pMin, pMax + 1):
sys.stdout.write("[" + str(i) + "] " + presets[i] + " ")
sys.stdout.flush()
print("")
###########################################################################################
# update_fixture
#
# Convert an 'old' syntax definition to the 'new' syntax, which includes:
# - single capability channels
# - global physical dimension
#
# path: the source path with the fixtures to convert
# filename: the relative file name
# destpath: the destination folder where to save the converted fixture
###########################################################################################
def update_fixture(path, filename, destpath):
absname = os.path.join(path, filename)
parser = etree.XMLParser(ns_clean=True, recover=True)
xmlObj = etree.parse(absname, parser=parser)
root = xmlObj.getroot()
fxSingleCapCount = 0
global namespace
################################## PHYSICAL PROCESSING ################################
global_phy = {}
gphy_tag = etree.Element("Physical")
for mode in root.findall('{' + namespace + '}Mode'):
phy_dict = {}
phy_tag = mode.find('{' + namespace + '}Physical')
if not phy_tag:
# Mode already processed. Skip
continue
bulb_tag = phy_tag.find('{' + namespace + '}Bulb')
dim_tag = phy_tag.find('{' + namespace + '}Dimensions')
lens_tag = phy_tag.find('{' + namespace + '}Lens')
focus_tag = phy_tag.find('{' + namespace + '}Focus')
tech_tag = phy_tag.find('{' + namespace + '}Technical')
phy_dict.update(phy_tag.attrib)
phy_dict.update(bulb_tag.attrib)
phy_dict.update(dim_tag.attrib)
phy_dict.update(lens_tag.attrib)
phy_dict.update(focus_tag.attrib)
if tech_tag:
phy_dict.update(tech_tag.attrib)
if not global_phy:
global_phy = phy_dict
gphy_tag = phy_tag
mode.remove(phy_tag)
print("Moving mode " + mode.attrib['Name'] + " to global")
elif phy_dict == global_phy:
mode.remove(phy_tag)
print("Mode " + mode.attrib['Name'] + " is identical to global")
root.append(gphy_tag)
##################################### CHANNELS PROCESSING #################################
for channel in root.findall('{' + namespace + '}Channel'):
locCapCount = 0
if 'Preset' in channel.attrib:
# Channel already converted. Skip
continue
for cap in channel.findall('{' + namespace + '}Capability'):
locCapCount += 1
if locCapCount < 2:
print("Single capability found in " + filename)
fxSingleCapCount += 1
preset = ""
name = ""
group = ""
color = ""
controlByte = 0
fineWord = ""
# Modes have a <Channel> tag too, but they don't have a name
if 'Name' not in channel.attrib:
continue
name = channel.attrib['Name']
grpNode = channel.find('{' + namespace + '}Group')
if grpNode is not None:
group = grpNode.text
controlByte = int(grpNode.attrib['Byte'])
if controlByte == 1:
fineWord = "Fine"
if group == "Intensity":
colNode = channel.find('{' + namespace + '}Colour')
if colNode is not None:
color = colNode.text
if color == "Red":
preset = "IntensityRed" + fineWord
elif color == "Green":
preset = "IntensityGreen" + fineWord
elif color == "Blue":
preset = "IntensityBlue" + fineWord
elif color == "Cyan":
preset = "IntensityCyan" + fineWord
elif color == "Magenta":
preset = "IntensityMagenta" + fineWord
elif color == "Yellow":
preset = "IntensityYellow" + fineWord
elif color == "Amber":
preset = "IntensityAmber" + fineWord
elif color == "White":
preset = "IntensityWhite" + fineWord
elif color == "UV":
preset = "IntensityUV" + fineWord
elif color == "Lime":
preset = "IntensityLime" + fineWord
elif color == "Indigo":
preset = "IntensityIndigo" + fineWord
elif color == "Hue":
preset = "IntensityHue" + fineWord
elif color == "Saturation":
preset = "IntensitySaturation" + fineWord
elif color == "Lightness":
preset = "IntensityLightness" + fineWord
elif color == "Value":
preset = "IntensityValue" + fineWord
elif group == "Pan":
preset = "PositionPan" + fineWord
elif group == "Tilt":
preset = "PositionTilt" + fineWord
#print("Found group " + group + ", control byte: " + str(controlByte))
print(chr(27) + "[2J") # clear screen
print("File: " + filename)
print(etree.tostring(channel))
if not preset:
printPresets(group)
select = ""
# wait for user input until a preset can be resolved
while 1:
select = raw_input("Replacement preset code (0 = keep) (enter = " + preset + "): ")
if select == "":
if preset == "":
print("Select an option!")
else:
break
else:
presets = getPresetsArray()
preset = presets[int(select)]
break
# perform the XML Channel node replacement
if preset != "Custom":
channel.clear()
channel.set("Name", name)
channel.set("Preset", preset)
channel.tail = "\n "
newfile = os.path.join(destpath, filename)
xmlFile = open(newfile, "w")
if (sys.version_info >= (3, 0)):
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixtureDefinition>").decode('utf8'))
else:
# python 2.x
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixtureDefinition>"))
xmlFile.close()
return fxSingleCapCount
def check_physical(absname, node, hasPan, hasTilt, hasZoom, errNum):
phy_tag = node.find('{' + namespace + '}Physical')
if phy_tag is not None:
dim_tag = phy_tag.find('{' + namespace + '}Dimensions')
lens_tag = phy_tag.find('{' + namespace + '}Lens')
focus_tag = phy_tag.find('{' + namespace + '}Focus')
tech_tag = phy_tag.find('{' + namespace + '}Technical')
width = int(dim_tag.attrib.get('Width', 0))
height = int(dim_tag.attrib.get('Height', 0))
depth = int(dim_tag.attrib.get('Depth', 0))
panDeg = int(focus_tag.attrib.get('PanMax', 0))
tiltDeg = int(focus_tag.attrib.get('TiltMax', 0))
zoomMinDeg = float(lens_tag.attrib.get('DegreesMin', 0))
zoomMaxDeg = float(lens_tag.attrib.get('DegreesMax', 0))
if width == 0 or height == 0 or depth == 0:
print(absname + ": Invalid physical dimensions detected")
errNum += 1
if hasPan and panDeg == 0:
print(absname + ": Invalid PAN degrees")
errNum += 1
if hasTilt and tiltDeg == 0:
print(absname + ": Invalid TILT degrees")
errNum += 1
if hasZoom and (zoomMinDeg == 0 or zoomMaxDeg == 0):
print(absname + ": Invalid ZOOM degrees")
errNum += 1
if tech_tag is not None:
connectorsArray = [ "3-pin", "5-pin", "3-pin and 5-pin", "3-pin IP65", "5-pin IP65", "3.5 mm stereo jack", "Wireless", "Other" ]
power = int(tech_tag.attrib.get('PowerConsumption', 0))
if power == 0:
print(absname + ": Invalid power consumption")
errNum += 1
dmxConnector = tech_tag.attrib.get('DmxConnector', "")
if dmxConnector not in connectorsArray:
print(absname + ": Invalid DMX connector")
errNum += 1
return errNum
###########################################################################################
# getDefinitionVersion
#
# Get the version with which the definition was created
#
# xmlObj The fixture XML object
###########################################################################################
def getDefinitionVersion(xmlObj):
global namespace
root = xmlObj.getroot()
qlc_version = 0
creator_tag = root.find('{' + namespace + '}Creator')
if creator_tag is None:
print("Creator tag not found")
else:
version_tag = creator_tag.find('{' + namespace + '}Version')
numversion_tok = re.findall('\d+', version_tag.text)
#print("Definition version: " + version_tag.text)
# extract a unified number from the QLC version string
if len(numversion_tok) == 3:
qlc_version = (int(numversion_tok[0]) * 10000) + (int(numversion_tok[1]) * 100) + int(numversion_tok[2])
else:
qlc_version = (int(numversion_tok[0]) * 10000) + (int(numversion_tok[1]) * 100)
return qlc_version
###########################################################################################
# validate_fx_creator
#
# Validate the fixture creator field
#
# absname: the absolute file path
# xmlObj The fixture XML object
###########################################################################################
def validate_fx_creator(absname, xmlObj, errNum):
global namespace
root = xmlObj.getroot()
##################################### CHECK CREATOR #################################
creator_tag = root.find('{' + namespace + '}Creator')
if creator_tag is None:
print("Creator tag not found")
else:
author_tag = creator_tag.find('{' + namespace + '}Author')
name_tag = creator_tag.find('{' + namespace + '}Name')
version_tag = creator_tag.find('{' + namespace + '}Version')
if author_tag is None:
print(absname + ": Author tag not found")
errNum += 1
else:
# pre QLC+ definition didn't have the Author tag. Let's do
# the following check only for newer defs
if name_tag.text == "Q Light Controller Plus":
if not author_tag.text:
print(absname + ": Empty author name detected")
errNum += 1
else:
authName = author_tag.text
if "@" in authName or "://" in authName or "www" in authName:
print(absname + ": URLs or emails not allowed in author tag")
errNum += 1
if version_tag is None:
print(absname + ": Version tag not found")
errNum += 1
else:
qlc_version = getDefinitionVersion(xmlObj)
if (qlc_version == 0):
print(absname + ": Version tag not in version semantics")
errNum += 1
return errNum
###########################################################################################
# validate_fx_generals
#
# Validate the fixture general fields
#
# absname: the absolute file path
# xmlObj The fixture XML object
###########################################################################################
def validate_fx_generals(absname, xmlObj, errNum):
global namespace
root = xmlObj.getroot()
manuf_tag = root.find('{' + namespace + '}Manufacturer')
model_tag = root.find('{' + namespace + '}Model')
type_tag = root.find('{' + namespace + '}Type')
if manuf_tag is None or not manuf_tag.text:
print(absname + ": Invalid manufacturer detected")
errNum += 1
if model_tag is None or not model_tag.text:
print(absname + ": Invalid model detected")
errNum += 1
if type_tag is None or not type_tag.text:
print(absname + ": Invalid type detected")
errNum += 1
return errNum
###########################################################################################
# validate_fx_modes
#
# Validate the fixture modes
#
# absname: the absolute file path
# xmlObj The fixture XML object
# hasPan True if the fixture has a PAN mode
# hasTilt True if the fixture has a TILT mode
# channelNames List of channel names
###########################################################################################
def validate_fx_modes(absname, xmlObj, hasPan, hasTilt, channelNames, colorRgb):
global namespace
root = xmlObj.getroot()
errNum = 0
hasPan = False
hasTilt = False
hasZoom = False
modeCount = 0
global_phy_tag = root.find('{' + namespace + '}Physical')
for mode in root.findall('{' + namespace + '}Mode'):
modeCount += 1
modeName = ""
if 'Name' not in mode.attrib:
print(absname + ": mode name attribute not found")
errNum += 1
else:
modeName = mode.attrib['Name']
if not modeName:
print(absname + ": Empty mode name detected")
errNum += 1
# better to skip this for now. Still too many errors
qlc_version = getDefinitionVersion(xmlObj)
if qlc_version >= 41207 and 'mode' in modeName.lower():
print(absname + ":" + modeName + ": word 'mode' found in mode name (version " + str(qlc_version) +")")
errNum += 1
modeChanCount = 0
modeHeadsCount = 0
for mchan in mode.findall('{' + namespace + '}Channel'):
mchan_no = "0"
if 'Number' not in mchan.attrib:
print(absname + ": mode channel number attribute not found")
errNum += 1
else:
mchan_no = mchan.attrib['Number']
#print(absname + ":" + modeName + ": Channel " + mchan_no + "): " + mchan.text)
if mchan.text is None:
print(absname + ":" + modeName + ": Empty channel name found. This definition won't work.")
errNum += 1
else:
if mchan.text not in channelNames:
print(absname + ":" + modeName + ":" + mchan_no + ": Channel " + mchan.text + " doesn't exist. This definition won't work.")
errNum += 1
if 'ActsOn' in mchan.attrib:
if mchan.attrib["ActsOn"] is mchan_no:
print(absname + ":" + modeName + ":" + mchan_no + ": Channel cannot act on itself. Leave it blank.")
errNum += 1
modeChanCount += 1
if modeChanCount == 0:
print(absname + ":" + modeName + ": No channel found in mode")
errNum += 1
for mchan in mode.findall('{' + namespace + '}Head'):
modeHeadsCount += 1
if modeHeadsCount == 1:
print(absname + ":" + modeName + ": Single head found. Not allowed")
errNum += 1
# if modeHeadsCount > 3:
# print(absname + ":" + modeName + ": Heads found: " + str(modeHeadsCount))
phy_tag = mode.find('{' + namespace + '}Physical')
if phy_tag is None and global_phy_tag is None:
print(absname + ":" + modeName + ": No physical data found")
errNum += 1
errNum = check_physical(absname, mode, hasPan, hasTilt, hasZoom, errNum)
if modeCount == 0:
print(absname + ": Invalid fixture. No modes found!")
errNum += 1
return errNum
###########################################################################################
# validate_color_codes
#
# Validate color codes for given color names
#
# propName: Reference to the property for error messages
# fxColorName: the TX color name
# fxColorCode: the TX color code
# qlc_version: Version of the ficture file
# errNum: Current number of errors
# colorRgb: Hash array with names mapping to color codes
###########################################################################################
def validate_color_codes(propName, fxColorName, fxColorCode, qlc_version, errNum, colorRgb):
targetCode = ""
# Normalize name and code
fxSearchName = fxColorName.title()
fxSearchCode = fxColorCode.lower()
# Try to find the code for the given name
if fxSearchName in colorRgb["nameToRgb"]:
targetCode = colorRgb["nameToRgb"][fxSearchName]
else:
# Search for alternative color name from potential list
if fxSearchName in colorRgb["nameToRgb"]:
targetCode = colorRgb["nameToRgb"][fxSearchName + " 1"]
# else the string cannot be aligned to a known color code.
if targetCode != "":
# Name could be mapped to a code.
if fxSearchCode != targetCode:
# try to find alternative color code for color name
alternativeMsg = ""
if fxSearchCode in colorRgb["rgbToName"]:
alternativeMsg = ", the name for given FX color code is " + colorRgb["rgbToName"][fxSearchCode]
if qlc_version >= 41206 or alternativeMsg != "":
print(propName + ": FX color " + fxColorName + " (" + fxColorCode + ") should have color code " + targetCode + alternativeMsg)
errNum += 1
return errNum
###########################################################################################
# validate_fx_channels
#
# Validate the fixture channels
#
# absname: the absolute file path
# xmlObj The fixture XML object
###########################################################################################
def validate_fx_channels(absname, xmlObj, errNum, colorRgb):
global namespace
root = xmlObj.getroot()
hasPan = False
hasTilt = False
hasZoom = False
needSave = False
chCount = 0
channelNames = []
qlc_version = getDefinitionVersion(xmlObj)
for channel in root.findall('{' + namespace + '}Channel'):
chName = ""
chPreset = ""
if 'Name' not in channel.attrib:
print(absname + ": Invalid channel. No name specified")
errNum += 1
else:
chName = channel.attrib['Name']
channelNames.append(chName)
if 'Preset' in channel.attrib:
chPreset = channel.attrib['Preset']
childrenCount = len(channel.getchildren())
group_tag = channel.find('{' + namespace + '}Group')
groupByte = -1
if not chPreset and childrenCount == 0:
print(absname + ":" + chName + ": Invalid channel. Not a preset and no capabilities found")
errNum += 1
if not chPreset and group_tag is None:
print(absname + ":" + chName + ": Invalid channel. Not a preset and no group tag found")
errNum += 1
if group_tag is not None:
if not group_tag.text:
print(absname + ":" + chName + ": Invalid channel. Empty group tag detected")
errNum += 1
else:
if group_tag.text == 'Pan':
hasPan = True
if group_tag.text == 'Tilt':
hasTilt = True
if 'Byte' not in group_tag.attrib:
print(absname + ":" + chName + ": Invalid channel. Group byte attribute not found")
errNum += 1
else:
groupByte = group_tag.attrib['Byte']
if chPreset:
if chPreset == "PositionPan" or chPreset == "PositionPanFine" or chPreset == "PositionXAxis":
hasPan = True
if chPreset == "PositionTilt" or chPreset == "PositionTiltFine" or chPreset == "PositionYAxis":
hasTilt = True
if chPreset == "BeamZoomSmallBig" or chPreset == "BeamZoomBigSmall" or chPreset == "BeamZoomFine":
hasZoom = True
# no need to go further if this is a preset
chCount += 1
continue
# check the word 'fine' against control byte
if groupByte == 0 and 'fine' in chName:
print(absname + ":" + chName + ": control byte should be set to Fine (LSB)")
errNum += 1
################################# CHECK CAPABILITIES ##############################
lastMax = -1
capCount = 0
for capability in channel.findall('{' + namespace + '}Capability'):
newResSyntax = False
capName = capability.text
if not capName:
print(absname + ":" + chName + ": Capability with no description detected")
errNum += 1
# check capabilities overlapping
currMin = int(capability.attrib['Min'])
currMax = int(capability.attrib['Max'])
#print("Min: " + str(currMin) + ", max: " + str(currMax))
if currMin <= lastMax:
print(absname + ":" + chName + "/" + capName + ": Overlapping values detected " + str(currMin) + "/" + str(lastMax))
errNum += 1
if currMin > currMax:
print(absname + ":" + chName + "/" + capName + ": Min larger than Max " + str(currMin) + "/" + str(currMax))
errNum += 1
# Evaluate contiguous ranges
if currMin != lastMax + 1:
print(absname + ":" + chName + "/" + capName + ": Non contiguous range detected " + str(lastMax) + "/" + str(currMin))
errNum += 1
lastMax = currMax
resource = capability.attrib.get('Res', "")
# try and see if new sytax is on
if not resource:
resource = capability.attrib.get('Res1', "")
newResSyntax = True
if resource.startswith('/'):
print(absname + ":" + chName + "/" + capName + ": Absolute paths not allowed in resources")
errNum += 1
# check the actual existence of a gobo. If possible, migrate to SVG
if resource and '/' in resource:
goboPath = os.getcwd() + "/../gobos/" + resource
#print("GOBO path: " + goboPath)
if not os.path.isfile(goboPath):
# check if a SVG version of the gobo exists
resource = resource.replace('png', 'svg')
goboPath = os.getcwd() + "/../gobos/" + resource
if not os.path.isfile(goboPath):
print(absname + ":" + chName + "/" + capName + ": Non existing gobo file detected (" + resource + ")")
errNum += 1
else:
needSave = True
if newResSyntax:
capability.set('Res1', resource)
else:
capability.set('Res', resource)
# Check for consistent color codes for given color names
hexPattern = re.compile(r'^#([0-9a-fA-F]){6}$')
capPreset = capability.attrib.get('Preset', "")
if capPreset == "ColorMacro" or capPreset == "ColorDoubleMacro":
res = capability.attrib.get('Res1', "")
if not re.search(hexPattern, res):
alternativeMsg = ""
if capability.text in colorRgb["nameToRgb"]:
alternativeMsg = " (" + colorRgb["nameToRgb"][capability.text] + ")"
print(absname + ":" + chName + "/" + capName + ": Res1 (" + res + ") required to start with '#' in Preset=ColorMacro and ColorDoubleMacro" + alternativeMsg)
errNum += 1
errNum = validate_color_codes(
absname + ":" + chName + "/" + capName + "/Res1",
capability.text,
res,
qlc_version,
errNum,
colorRgb)
if capPreset == "ColorDoubleMacro":
res = capability.attrib.get('Res2', "")
if not re.search(hexPattern, res):
print(absname + ":" + chName + "/" + capName + ": Res2 (" + res + ") required to start with '#' in ColorDoubleMacro")
errNum += 1
errNum = validate_color_codes(
absname + ":" + chName + "/" + capName + "/Res2",
capability.text,
res,
qlc_version,
errNum,
colorRgb)
elif capPreset == "":
res = capability.attrib.get('Res1', "__.NOT._.SET.___")
if res != "__.NOT._.SET.___":
print(absname + ":" + chName + "/" + capName + ": Res1 not evaluated withour Preset=")
errNum += 1
res = capability.attrib.get('Res2', "__.NOT._.SET.___")
if res != "__.NOT._.SET.___":
print(absname + ":" + chName + "/" + capName + ": Res2 not evaluated withour Preset=")
errNum += 1
if capPreset == "ColorMacro" and capability.attrib.get('Res2', "") != "":
print(absname + ":" + chName + "/" + capName + ": Res2 not evaluated in Preset=ColorMacro")
errNum += 1
capCount += 1
# Evaluate completeness of ranges
if 255 != lastMax:
print(absname + ":" + chName + ": Incomplete range detected " + str(currMax) + "/255")
errNum += 1
if capCount == 0:
print(absname + ":" + chName + ": Channel has no capabilities")
errNum += 1
chCount += 1
if chCount == 0:
print(absname + ": Invalid fixture. No channels found!")
errNum += 1
###################################### CHECK MODES ###################################
errNum += validate_fx_modes(absname, xmlObj, hasPan, hasTilt, channelNames, colorRgb)
if needSave:
print("Saving back " + absname + "...")
xmlFile = open(absname, "w")
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixtureDefinition>").decode('utf8'))
if (sys.version_info >= (3, 0)):
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixtureDefinition>"))
else:
# python 2.x
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixtureDefinition>"))
xmlFile.close()
return errNum, hasPan, hasTilt, hasZoom
###########################################################################################
# validate_fixture
#
# Check the syntax of a definition and reports errors if found
#
# absname: the absolute file path
###########################################################################################
def validate_fixture(absname, colorRgb):
parser = etree.XMLParser(ns_clean=True, recover=True)
xmlObj = etree.parse(absname, parser=parser)
root = xmlObj.getroot()
global namespace
errNum = 0
hasPan = False
hasTilt = False
hasZoom = False
##################################### CHECK CREATOR #################################
errNum = validate_fx_creator(absname, xmlObj, errNum)
################################ CHECK FIXTURE GENERALS ##############################
errNum = validate_fx_generals(absname, xmlObj, errNum)
##################################### CHECK CHANNELS #################################
errNum, hasPan, hasTilt, hasZoom = validate_fx_channels(absname, xmlObj, errNum, colorRgb)
################################ CHECK GLOBAL PHYSICAL ################################
errNum = check_physical(absname, root, hasPan, hasTilt, hasZoom, errNum)
return errNum
###########################################################################################
# createFixtureMap
#
# Creates the Fixture definition map read by QLC+ at startup
#
###########################################################################################
def createFixtureMap():
global namespace
count = 0
manufacturer = ""
xmlFile = open("FixturesMap.xml", "w")
root = etree.Element("FixturesMap")
root.set('xmlns', 'http://www.qlcplus.org/FixturesMap')
for dirname in sorted(os.listdir('.'), key=lambda s: s.lower()):
if not os.path.isdir(dirname): continue
if dirname != "scripts" and dirname != manufacturer:
mfTag = etree.SubElement(root, "M")
mfTag.set('n', dirname)
manufacturer = dirname
for filename in sorted(os.listdir(dirname), key=lambda s: s.lower()):
if not filename.endswith('.qxf'): continue
parser = etree.XMLParser(ns_clean=True, recover=True)
xmlObj = etree.parse(os.path.join(dirname, filename), parser=parser)
fxRoot = xmlObj.getroot()
manufacturer = fxRoot.find('{' + namespace + '}Manufacturer')
model = fxRoot.find('{' + namespace + '}Model')
fxTag = etree.SubElement(mfTag, "F")
fxTag.set('n', os.path.splitext(filename)[0])
#fxTag.set('m', manufacturer.text)
fxTag.set('m', model.text)
#print(manufacturer.text + ", " + model.text)
count += 1
if (sys.version_info >= (3, 0)):
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixturesMap>").decode('utf8'))
else:
# python 2.x
xmlFile.write(etree.tostring(root, pretty_print=True, xml_declaration=True, encoding="UTF-8", doctype="<!DOCTYPE FixturesMap>"))
xmlFile.close()
print("Fixtures in map: " + str(count))
###########################################################################################
# get_validation_files
#
# Get the files in the path to check the syntax of a definition and reports errors if found
#
# path: the source path with the fixtures to validate
###########################################################################################
def get_validation_files(path):
files = []
#print("Processing path " + path)
if os.path.isdir(path):
for direntry in sorted(os.listdir(path), key=lambda s: s.lower()):
files += get_validation_files(os.path.join(path, direntry))
else:
if os.path.isfile(path) and path.endswith('.qxf'):
files.append(path)
return files
###########################################################################################
#
# MAIN
#
###########################################################################################
parser = argparse.ArgumentParser(description='Unified Fixture tool.')
parser.add_argument('--map', help='Create the Fixture map', action='store_true')
parser.add_argument('--convert <source> <destination>', help='Convert an "old" syntax Fixture definition',
nargs='*', dest='convert')
parser.add_argument('--validate [<path> ...]', help='Validate fixtures in the specified path',
nargs='*', dest='validate')
args = parser.parse_args()
print(args)
if args.convert is not None:
print("Starting conversion")
if len(args.convert) < 2:
print("Usage " + sys.argv[0] + "--convert <source folder> <destination folder>")
sys.exit()
path = sys.args.convert[1]
destpath = args.convert[2]
print("Converting fixtures in " + path + "...")
for filename in os.listdir(path):
if not filename.endswith('.qxf'):
continue
print("Processing file " + filename)
singleCapCount += update_fixture(path, filename, destpath)
print("Scan done. Single cap found: " + str(singleCapCount))
if args.map:
createFixtureMap()
if args.validate is not None:
print("Starting validation")
rgbAbsname = os.path.join("..", "colorfilters", "namedrgb.qxcf")
rgbParser = etree.XMLParser(ns_clean=True, recover=True)
rgbObj = etree.parse(rgbAbsname, parser=rgbParser)
rgbRoot = rgbObj.getroot()
colorRgb = {}
colorRgb["nameToRgb"] = {}
colorRgb["rgbToName"] = {}
for colorEntry in rgbRoot.findall('{http://www.qlcplus.org/ColorFilters}Color'):
rgbCode = colorEntry.attrib['RGB'].lower()
colorName = colorEntry.attrib['Name'].title()
colorRgb["nameToRgb"][colorName] = rgbCode
colorRgb["rgbToName"][rgbCode] = colorName
paths = ["."]
if len(args.validate) >= 1:
paths = args.validate
fileCount = 0
errorCount = 0
files = []
for path in paths:
files += get_validation_files(path)
for file in files:
#print("Processing file " + file)
if (' ' in file) == True:
print("Error - space in filename: " + file)
sys.exit(1)
errorCount += validate_fixture(file, colorRgb)
print(str(len(files)) + " definitions processed. " + str(errorCount) + " errors detected")
if errorCount != 0:
sys.exit(1)
|