/usr/bin/build-lives-rfx-plugin is in lives-data 1.6.1~ds1-1.
This file is owned by root:root, with mode 0o755.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 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 | #!/usr/bin/perl
# build-lives-rfx-plugin - Copyright G. Finch (salsaman) 2005 - 2009
# Released under the GPL 3 or later - see file COPYING or www.gnu.org for details
#usage : build-lives-rfx-plugin <script_file> <output_directory>
# if <output_directory> is omitted, plugins will be generated in /tmp
########################################################
# this will auto-generate a LiVES-Perl plugin from the info in $file
$rfx_version="1.7";
if ($ARGV[0] eq "-get") {
$section=$ARGV[1];
$file=$ARGV[2];
my @result=&rc_read($section,$file);
foreach (@result) {
print "$_\n";
}
exit 0;
}
$file=$ARGV[0];
my $define=(&rc_read("define",$file))[0];
if ($define eq "") {
print " - <define> section missing from script file.\n";
exit 5;
}
my $version=substr($define,1);
unless ($version eq $rfx_version) {
print "\n\n - Invalid script RFX version $version, this builder is for $rfx_version\n";
exit 4;
}
my $delim=substr($define,0,1);
my $delimit=$delim;
if ($delim =~ /[\^\$\.\*\+\?\|\(\)\[\]\{\}\\]/) {
$delim="\\".$delim;
}
my $plugin_name=(&rc_read("name",$file))[0];
my $author_name=(&rc_read("author",$file))[0];
my $lang_code=(&rc_read("language_code",$file))[0];
unless ($lang_code eq "240"||hex($lang_code)==240) {
print " - Invalid language code for this builder !\n";
exit 3;
}
my $plugin_version=(&rc_read("version",$file))[0];
my $description=(&rc_read("description",$file))[0];
my @requires=&rc_read("requires",$file);
my @params=&rc_read("params",$file);
my @param_window=&rc_read("param_window",$file);
my $properties=(&rc_read("properties",$file))[0];
my @pre=&rc_read("pre",$file);
my @loop=&rc_read("loop",$file);
my @post=&rc_read("post",$file);
my @onchange=&rc_read("onchange",$file);
$properties=hex($properties)|0x8000; # mark as built with build-plugin
my $min_frames=(split(/$delim/,$description))[2];
my $in_channels=(split(/$delim/,$description))[3];
if ($min_frames==-1) {
$is_util=1;
}
else {
$is_util=0;
}
$builder_version="1.6.1";
if ($in_channels==0&&$properties&0x0004) {
#batch mode generator
$is_batch_gen=1;
}
else {
$is_batch_gen=0;
}
if ($in_channels>0) {
push(@requires,"convert");
}
#########################################################
# generate into /tmp
# LiVES will call this to generate in plugins/effects/rendered/test
if (!defined($ARGV[1])) {
$prefix_dir="/tmp";
}
else {
$prefix_dir=$ARGV[1];
}
my $plugin_file="$prefix_dir/$plugin_name";
if (defined($DEBUG)) {
print "Creating plugin file $plugin_file\n";
}
########################################################
open OUT,"> $plugin_file";
print OUT "#!/usr/bin/perl\n\n";
print OUT "#######################################################################\n";
print OUT "# LiVES $plugin_name plugin, version $version\n";
print OUT "# RFX version $rfx_version\n";
print OUT "# autogenerated from script by $author_name\n\n";
print OUT "# rendered plugins should accept:\n";
print OUT "# <plugin_name> version (return <plugin_name> version <version>)\n";
print OUT "# <plugin_name> get_define\n";
print OUT "# <plugin_name> get_capabilities\n";
print OUT "# <plugin_name> get_description (e.g. \"Edge detect|Edge detecting|1|1|\")\n";
print OUT "# <plugin_name> clear (clean up any plugin generated temp files)\n";
print OUT "# and optionally any of: \n";
print OUT "# <plugin_name> get_parameters\n";
print OUT "# <plugin_name> get_param_window\n";
print OUT "# <plugin_name> get_onchange\n";
print OUT "# <plugin_name> onchange_<when> (for any triggers, e.g. onchange_init)\n";
print OUT "#\n";
print OUT "# they must accept:\n";
print OUT "# <plugin_name> process <parameters>\n\n";
print OUT "# You should not skip any frames, if a frame is not changed you must do:\n";
print OUT "# `cp \$in \$out`\n";
print OUT "#\n";
print OUT "# for *non-Perl* plugins, LiVES will call:\n";
print OUT "# <plugin_name> process \"<dir>\" <in_ext> <out_ext> <start> <end>\n";
print OUT "# <width> <height> <parameters>\n";
print OUT "# first you should chdir to <dir>\n";
print OUT "# then you should create all output frames %8d\$out_ext in numerical \n";
print OUT "# from start to end inclusive,\n";
print OUT "# each time calling sig_progress (see smogrify) - writes current frame number to \n";
print OUT "# <dir>/.status\n";
print OUT "# and checking for pause\n";
print OUT "#\n";
print OUT "# Any errors should be transmitted as in sig_error - \n";
print OUT "# write \"error|msg1|msg2|msg3|\" to <dir>/.status\n";
print OUT "# msgn must not contain \"\\n\", but can be omitted\n\n";
print OUT "# output frames should be named %8d\$out_ext in the same directory\n";
print OUT "# after processing, you should leave no gaps in out frames, you should not resize\n";
print OUT "# or change the palette from RGB24 (LiVES will check and autocorrect this soon)\n\n";
print OUT "# Also you must implement your own: &sig_error and &sig_progress\n\n\n";
print OUT "#######################################################################\n\n";
print OUT "use POSIX;\n\n";
print OUT "my \$command=\$ARGV[0];\n\n";
print OUT "if (\$command eq \"get_capabilities\") {\n";
print OUT " # capabilities is a bitmap field\n";
print OUT " # 0x0001 == slow (hint to GUI)\n";
print OUT " # 0x0002 == may resize (all frames to $nwidth x $nheight)\n";
print OUT " # 0x0004 == block mode generator\n";
print OUT " # 0x8000 == reserved\n";
print OUT " print \"$properties\\n\";\n";
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "if (\$command eq \"version\") {\n";
print OUT " print \"$plugin_name version $plugin_version : builder version $builder_version\\n\";\n";
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "if (\$command eq \"get_define\") {\n";
print OUT " print \"$delimit$version\\n\";\n";
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "if (\$command eq \"get_description\") {\n";
print OUT " #format here is \"Menu entry|Action description|min_frames|number_of_in_channels|\"\n";
print OUT " # min_frames==-1 indicates a special \"no processing\" effect. This allows more\n";
print OUT " #general parameter windows which are not really effects (e.g. frame_calculator)\n";
print OUT " print \"$description\\n\";\n";
print OUT " exit 0;\n";
print OUT "}\n\n\n";
print OUT "if (\$command eq \"get_parameters\") {\n";
print OUT " # \"name|label|type|other fields...\"\n";
print OUT " # eg. print \"radius|_radius|num0|1|1|100|\";\n";
print OUT " # types can be numx,colRGB24,bool,string or string_list\n";
foreach (@params) {
unless ($_ eq "") {
@bits=split(/$delim/);
# note: ARGV[0]=="process"
if ($bits[2] eq "string") {
$bits[3]="escape (&escape($bits[3]));
}
print OUT " print \"".join($delimit,@bits)."$delimit\\n\";\n";
}
}
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "if (\$command eq \"get_param_window\") {\n";
foreach (@param_window) {
unless ($_ eq "") {
$_ =~ s/\"/\\\"/g;
print OUT " print \"$_$delimit\\n\";\n";
}
}
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "if (\$command eq \"get_onchange\") {\n";
if (@onchange) {
&gen_onchange(0);
}
print OUT " exit 0;\n";
print OUT "}\n\n";
print OUT "#######################################################\n\n";
print OUT "if (\$command eq \"process\") {\n\n";
print OUT "# in case of error, you should do:\n";
print OUT "# &sig_error(\"msg1\",\"msg2\",\"msg3\",\"msg4\"); [ msg's are optional, but must not\n";
print OUT "# contain newlines (\\n) ]\n\n";
if (@requires) {
&gen_requires(0);
}
if (@params) {
print OUT "\n###### handle parameters #############\n";
print OUT "# autogenerated from get_parameters\n\n";
&gen_get_params;
&gen_param_checks;
}
for ($i=0;$i<@params;$i++) {
unless ($params[$i] eq "") {
if (¶m_get_type($i) eq "colRGB24") {
$pname=¶m_get_name($i);
print OUT "\$p$i=int(\$p$i);\n";
print OUT "if (\$p$i>0xFFFFFF||\$p$i<0) {\n";
print OUT " &sig_error(\"Invalid colour for $pname.\");\n";
print OUT " exit 1;\n";
print OUT "}\n";
print OUT "\$p$i"."_red=int(\$p$i/65536);\n";
print OUT "\$p$i"."-=\$p$i"."_red*65536;\n";
print OUT "\$p$i"."_green=int(\$p$i/256);\n";
print OUT "\$p$i"."-=\$p$i"."_green*256;\n";
print OUT "\$p$i"."_blue=\$p$i;\n";
}
}
}
if ($in_channels==2) {
print OUT " \$nwidth=\$width;\n\$nheight=\$height;\n";
}
print OUT "\n";
if ($in_channels==0&&!$is_batch_gen) {
# script writer MUST set this themselves
print OUT " \$end=0;\n";
}
if (@pre) {
&gen_pre;
}
unless ($is_batch_gen) {
print OUT "\n################# loop through frames #################\n";
if ($in_channels==2) {
print OUT " \$frame2=\$start2;\n";
print OUT " unless (defined(\$img_ext2)) {\n";
print OUT " \$img_ext2=\$img_ext;\n";
print OUT " }\n";
print OUT " if (!(\$img_ext2 eq \$img_ext) && &location(\"convert\") eq \"\") {\n";
print OUT " &sig_error(\"'convert' is required by this plugin.\",\"Please install imagemagick and try again.\");\n";
print OUT " exit 1;\n";
print OUT " }\n";
}
print OUT " for (\$frame=\$start;\$frame<=\$end;\$frame++) {\n";
print OUT " # sig progress will update the progress bar from \$start->\$end\n";
print OUT " \$name=&mkname(\$frame);\n";
unless ($in_channels==0) {
print OUT " \$in=\"\$name\$img_ext\";\n";
}
if ($in_channels==2) {
print OUT " \$name2=&mkname(\$frame2);\n";
print OUT " \$in2=\"\$clipboard/\$name2\$img_ext2\";\n";
print OUT " unless (-f \$in2) {\n";
print OUT " # end of clipboard reached, loop back to start\n";
print OUT " \$frame2=\$start2;\n";
print OUT " \$name2=&mkname(\$frame2);\n";
print OUT " \$in2=\"\$clipboard/\$name2\$img_ext2\";\n";
print OUT " }\n";
print OUT " unless (\$img_ext2 eq \$img_ext) {\n";
print OUT " system(\"\$convert_command \$in2 \$clipboard/\$name2\$img_ext\");\n";
print OUT " \$in2=\"\$clipboard/\$name2\$img_ext\";\n";
print OUT " }\n";
}
print OUT " \$out=\"\$name\$out_ext\";\n\n";
if ($in_channels>0) {
print OUT "# wait for front end to create $in\n";
print OUT " while (!-f \$in) {\n";
print OUT " sleep 1;\n";
print OUT " }\n\n";
}
}
print OUT "##################### the all-important bit #######################\n\n";
&gen_loop;
print OUT "\n###################################################################\n";
unless ($is_batch_gen) {
if ($in_channels==2) {
print OUT " unless (\$img_ext2 eq \$img_ext) {\n";
print OUT " unlink \$in2;\n";
print OUT " }\n";
print OUT " \$frame2++;\n";
}
print OUT " \$opfailed=0;\n";
print OUT " if (! -f \$out) {\n";
print OUT " print STDERR \"Warning: effect plugin $plugin_name skipped frame \$frame !\n\";\n";
print OUT " print STDERR \"Retrying\n\";\n";
print OUT " \$frame--;\n";
print OUT " \$opfailed=1;\n";
print OUT " }\n";
print OUT " unless (\$opfailed) {\n";
if ($in_channels==0) {
print OUT " &sig_progress(\$frame,\$nwidth,\$nheight,\$fps,\$end);\n";
}
else {
print OUT " &sig_progress(\$frame);\n";
}
print OUT " }\n";
for ($i=0;$i<@params;$i++) {
unless ($params[$i] eq "") {
if (¶m_get_type($i) eq "colRGB24") {
# clamp RGB values
print OUT " if (\$p$i"."_red>255) {\n";
print OUT " \$p$i"."_red=255;\n";
print OUT " }\n";
print OUT " elsif (\$p$i"."_red<0) {\n";
print OUT " \$p$i"."_red=0;\n";
print OUT " }\n";
print OUT " if (\$p$i"."_green>255) {\n";
print OUT " \$p$i"."_green=255;\n";
print OUT " }\n";
print OUT " elsif (\$p$i"."_green<0) {\n";
print OUT " \$p$i"."_green=0;\n";
print OUT " }\n";
print OUT " if (\$p$i"."_blue>255) {\n";
print OUT " \$p$i"."_blue=255;\n";
print OUT " }\n";
print OUT " elsif (\$p$i"."_blue<0) {\n";
print OUT " \$p$i"."_blue=0;\n";
print OUT " }\n";
}
}
}
print OUT " }\n";
}
print OUT " return 1;\n";
print OUT "}\n\n\n";
print OUT "\n########## Post loop code ############\n";
print OUT "if (\$command eq \"clear\") {\n";
print OUT " \$start=\$ARGV[1];\n";
print OUT " \$end=\$ARGV[2];\n";
print OUT " \$img_ext=\$ARGV[3];\n";
print OUT "\n";
if (@post) {
&gen_post;
}
print OUT "}\n";
if (@onchange) {
print OUT "\n########## Triggers ############\n";
&gen_onchange(1);
}
close OUT;
system ("chmod 755 $plugin_file");
####################################3
sub gen_requires {
my ($type)=@_;
print OUT "##### check requirements first #######\n";
foreach (@requires) {
unless ($_ eq "") {
print OUT " if (&location(\"$_\") eq \"\") {\n";
if ($type==0) {
print OUT " &sig_error(\"You must install '$_' before you can use this effect.\");\n";
}
else {
print OUT " print \"You must install '$_' before you can use this utility.\";\n";
}
print OUT " exit 1;\n";
print OUT " }\n";
}
}
}
sub gen_get_params {
my $i=0;
my (@bits,$type);
foreach (@params) {
unless ($_ eq "") {
@bits=split (/$delim/,$_);
# note: ARGV[0]=="process"
$def=($bits[3]);
if ($bits[2] eq "string") {
$def="\""."escape($def)."\"";
}
print OUT " unless (defined(\$ARGV[".($i+1)."])) {\n";
print OUT " \$p$i=$def;\n";
print OUT " }\n";
print OUT " else {\n";
print OUT " \$p$i=\$ARGV[".($i+1)."];\n";
print OUT " }\n";
$i++;
}
}
}
sub gen_param_checks {
# generate some errors if params are out of range
# fix decimal places and booleans
# TODO - check for valid colours
my ($pname,$min,$max,$type,$dp,@bits,$fix);
my $i=0;
foreach (@params) {
unless ($_ eq "") {
@bits=split(/$delim/);
$type=$bits[2];
if (substr($type,0,3) eq "num") {
$pname=$bits[0];
$min=$bits[4];
$max=$bits[5];
$dp=substr($type,3);
$fix=10**$dp;
if ($dp>0) {
$fix.=".";
}
print OUT " \$!=0;\n";
#use POSIX::strtod to account for locales LC_NUMERIC
print OUT " \$p$i=int(POSIX::strtod(\$p$i)*$fix+.5)/$fix;\n";
print OUT " if (\$p$i<$min) {\n";
print OUT " &sig_error(\"$pname must be >= $min\");\n";
print OUT " exit 1;\n";
print OUT " }\n";
print OUT " if (\$p$i>$max) {\n";
print OUT " &sig_error(\"$pname must be <= $max\");\n";
print OUT " exit 1;\n";
print OUT " }\n";
}
if ($type eq "bool") {
print OUT " \$p$i=~(~\$p$i);\n";
}
$i++;
}
}
}
sub gen_pre {
foreach (@pre) {
print OUT " ".$_."\n";
}
}
sub gen_loop {
foreach (@loop) {
print OUT " ".$_."\n";
}
}
sub gen_post {
foreach (@post) {
print OUT " ".$_."\n";
}
}
sub rc_read {
# return an array value from our .rc file
my ($key,$rcfile)=@_;
my $string="";
my (@result,$part);
unless (defined(open IN,"$rcfile")) {
print " - Unable to read values from script file, $rcfile\n";
exit 2;
}
$part=0;
while (<IN>) {
if ($_=~ /(.*)(<\/$key>)/) {
return @result;
}
if ($part==1||$_=~ /(<$key>)(.*)/) {
if ($part==1) {
chomp($_);
$string=$_;
@result=(@result,$string);
}
else {
$part=1;
}
}
}
return @result;
}
sub gen_onchange {
my ($pass)=@_;
my ($i,$acount,$which,$code,$type);
my (%hash)=();
foreach (@onchange) {
unless ($_ eq "") {
$which=(split(/$delim/))[0];
if ($which>@params||($which>0&&$params[$which-1] eq "")) {
print " - onchange value $which > num parameters.\n";
exit 1;
}
if ($pass==0) {
if (!defined($hash{$which})) {
print OUT " print \"$which$delimit\\n\";\n";
$hash{$which}=1;
}
}
else {
$code=substr($_,length($which)+1);
push(@{ $hash{$which} }, $code);
}
}
}
if ($pass==1) {
foreach $which (keys %hash) {
print OUT "\nif (\$command eq \"onchange_$which\") {\n";
if (@requires&&$is_util&&$which eq "init") {
# for utilities, we generate requires here, since there is no process
&gen_requires(1);
}
$acount=1;
for ($i=0;$i<@params;$i++) {
unless ($params[$i] eq "") {
$type=¶m_get_type($i);
if ($type eq "colRGB24") {
# with RGBA we would also have _alpha
print OUT " \$p$i"."_red=\@ARGV[".$acount++."];\n";
print OUT " \$p$i"."_green=\@ARGV[".$acount++."];\n";
print OUT " \$p$i"."_blue=\@ARGV[".$acount++."];\n";
}
else {
print OUT " \$p$i"."=\@ARGV[".$acount++."];\n";
unless ($type eq "bool" || $type eq "string" || $type eq "string_list") {
print OUT " \$p$i"."_min=\@ARGV[".$acount++."];\n";
print OUT " \$p$i"."_max=\@ARGV[".$acount++."];\n";
}
}
}
}
print OUT " \$width=\@ARGV[".$acount++."];\n";
print OUT " \$height=\@ARGV[".$acount++."];\n";
print OUT " \$start=\@ARGV[".$acount++."];\n";
print OUT " \$end=\@ARGV[".$acount++."];\n";
print OUT " \$last=\@ARGV[".$acount++."];\n";
print OUT " \$length=\$end-\$start+1;\n";
if ($in_channels==2) {
print OUT " \$width2=\@ARGV[".$acount++."];\n";
print OUT " \$height2=\@ARGV[".$acount++."];\n";
}
print OUT "\n";
foreach (@{$hash{$which}}) {
print OUT " $_\n";
}
my ($has_params)=0;
for ($i=0;$i<@params;$i++) {
unless ($params[$i] eq "") {
$type=¶m_get_type($i);
if (!$has_params) {
&escquotes(@params);
print OUT "\n print \"";
$has_params=1;
}
if ($type eq "colRGB24") {
print OUT "\$p$i"."_red ";
print OUT "\$p$i"."_green ";
print OUT "\$p$i"."_blue ";
}
else {
if ($type eq "string") {
print OUT "\\\"\$p$i\\\" ";
}
else {
print OUT "\$p$i ";
}
unless ($type eq "bool" || $type eq "string" || $type eq "string_list") {
print OUT "\$p$i"."_min ";
print OUT "\$p$i"."_max ";
}
}
}
}
if ($has_params) {
print OUT "\";\n";
}
print OUT " exit 0;\n";
print OUT "}\n";
}
}
}
sub param_get_type {
(split(/$delim/,$params[$_[0]]))[2];
}
sub param_get_name {
(split(/$delim/,$params[$_[0]]))[0];
}
sub escape {
my ($string)=$_[0];
$string=~ s/\\/\\\\/g;
return $string;
}
sub quotescape {
my ($string)=$_[0];
$string=~ s/([\"\$\@])/\\$1/g;
return $string;
}
sub escquotes {
for ($i=0;$i<@params;$i++) {
unless ($params[$i] eq "") {
$type=¶m_get_type($i);
if ($type eq "string") {
print OUT " \$p$i=~ s/\\\"/\\\\\\\"/g;\n";
}
}
}
}
|