#!/usr/bin/perl

#######################################################################
# LiVES textover plugin, version 1.7
# RFX version 1.7
# autogenerated from script by Salsaman|

# rendered plugins should accept:
# <plugin_name> version (return <plugin_name> version <version>)
# <plugin_name> get_define
# <plugin_name> get_capabilities
# <plugin_name> get_description (e.g. "Edge detect|Edge detecting|1|1|")
# <plugin_name> clear (clean up any plugin generated temp files)
# and optionally any of: 
# <plugin_name> get_parameters
# <plugin_name> get_param_window
# <plugin_name> get_onchange
# <plugin_name> onchange_<when> (for any triggers, e.g. onchange_init)
#
# they must accept:
# <plugin_name> process <parameters>

# You should not skip any frames, if a frame is not changed you must do:
# `cp $in $out`
#
# for *non-Perl* plugins, LiVES will call:
# <plugin_name> process "<dir>" <in_ext> <out_ext> <start> <end>
#  <width> <height> <parameters>
# first you should chdir to <dir>
# then you should create all output frames %8d$out_ext in numerical 
# from start to end inclusive,
# each time calling sig_progress (see smogrify) - writes current frame number to 
# <dir>/.status
# and checking for pause
#
# Any errors should be transmitted as in sig_error - 
# write "error|msg1|msg2|msg3|" to <dir>/.status
# msgn must not contain "\n", but can be omitted

# output frames should be named %8d$out_ext in the same directory
# after processing, you should leave no gaps in out frames, you should not resize
# or change the palette from RGB24 (LiVES will check and autocorrect this soon)

# Also you must implement your own: &sig_error and &sig_progress


#######################################################################

use POSIX;

my $command=$ARGV[0];

if ($command eq "get_capabilities") {
    # capabilities is a bitmap field
    # 0x0001 == slow (hint to GUI)
    # 0x0002 == may resize (all frames to  x )
    # 0x0004 == block mode generator
    # 0x8000 == reserved
    print "32768\n";
    exit 0;
}

if ($command eq "version") {
    print "textover version 4 : builder version 1.0.10\n";
    exit 0;
}

if ($command eq "get_define") {
    print "|1.7\n";
    exit 0;
}

if ($command eq "get_description") {
    #format here is "Menu entry|Action description|min_frames|number_of_in_channels|"
    # min_frames==-1 indicates a special "no processing" effect. This allows more
    #general parameter windows which are not really effects (e.g. frame_calculator)
    print "Text Overlay|Overlaying text on|1|1|\n";
    exit 0;
}


if ($command eq "get_parameters") {
    # "name|label|type|other fields..."
    # eg. print "radius|_radius|num0|1|1|100|";
    # types can be numx,colRGB24,bool,string or string_list
    print "text|_Text|string|LiVES|1024|\n";
    print "xoffs|_X offset|num0|0|0|10000|\n";
    print "yoffs|_Y offset|num0|0|0|10000|\n";
    print "fcol|_Fill colour|colRGB24|0|0|0|\n";
    print "scol|_Stroke colour|colRGB24|0|0|0|\n";
    print "psize|_Point size|num0|32|10|120|\n";
    exit 0;
}

if ($command eq "get_param_window") {
    print "layout|p1|fill|p2|fill|p5||\n";
    exit 0;
}

if ($command eq "get_onchange") {
    print "init|\n";
    print "3|\n";
    exit 0;
}

#######################################################

if ($command eq "process") {

# in case of error, you should do:
# &sig_error("msg1","msg2","msg3","msg4"); [ msg's are optional, but must not
# contain newlines (\n) ]

##### check requirements first #######
    if (&location("convert") eq "") {
      &sig_error("You must install 'convert' before you can use this effect.");
      exit 1;
    }

###### handle parameters #############
# autogenerated from get_parameters

    unless (defined($ARGV[1])) {
      $p0="LiVES";
    }
    else {
      $p0=$ARGV[1];
    }
    unless (defined($ARGV[2])) {
      $p1=0;
    }
    else {
      $p1=$ARGV[2];
    }
    unless (defined($ARGV[3])) {
      $p2=0;
    }
    else {
      $p2=$ARGV[3];
    }
    unless (defined($ARGV[4])) {
      $p3=0;
    }
    else {
      $p3=$ARGV[4];
    }
    unless (defined($ARGV[5])) {
      $p4=0;
    }
    else {
      $p4=$ARGV[5];
    }
    unless (defined($ARGV[6])) {
      $p5=32;
    }
    else {
      $p5=$ARGV[6];
    }
    $!=0;
    $p1=int(POSIX::strtod($p1)*1+.5)/1;
    if ($p1<0) {
       &sig_error("xoffs must be >= 0");
       exit 1;
    }
    if ($p1>10000) {
       &sig_error("xoffs must be <= 10000");
       exit 1;
    }
    $!=0;
    $p2=int(POSIX::strtod($p2)*1+.5)/1;
    if ($p2<0) {
       &sig_error("yoffs must be >= 0");
       exit 1;
    }
    if ($p2>10000) {
       &sig_error("yoffs must be <= 10000");
       exit 1;
    }
    $!=0;
    $p5=int(POSIX::strtod($p5)*1+.5)/1;
    if ($p5<10) {
       &sig_error("psize must be >= 10");
       exit 1;
    }
    if ($p5>120) {
       &sig_error("psize must be <= 120");
       exit 1;
    }
$p3=int($p3);
if ($p3>0xFFFFFF||$p3<0) {
    &sig_error("Invalid colour for fcol.");
    exit 1;
}
$p3_red=int($p3/65536);
$p3-=$p3_red*65536;
$p3_green=int($p3/256);
$p3-=$p3_green*256;
$p3_blue=$p3;
$p4=int($p4);
if ($p4>0xFFFFFF||$p4<0) {
    &sig_error("Invalid colour for scol.");
    exit 1;
}
$p4_red=int($p4/65536);
$p4-=$p4_red*65536;
$p4_green=int($p4/256);
$p4-=$p4_green*256;
$p4_blue=$p4;


################# loop through frames #################
    for ($frame=$start;$frame<=$end;$frame++) {
	# sig progress will update the progress bar from $start->$end
	$name=&mkname($frame);
	$in="$name$img_ext";
	$out="$name$out_ext";

 while (! -f $in) {
     sleep 1;
 }

##################### the all-important bit #######################

        $cstring1=&RGB24_to_string($p3_red,$p3_green,$p3_blue);
        $cstring2=&RGB24_to_string($p4_red,$p4_green,$p4_blue);
        system("$convert_command $in -fill $cstring1 -stroke $cstring2 -pointsize $p5 -draw 'text $p1 $p2 \"$p0\"' $out");

###################################################################
        if (! -f $out) {
            print STDERR "Warning: effect plugin textover skipped frame $frame !";
            `cp $in $out`;
        }
	&sig_progress($frame);
        if ($p3_red>255) {
            $p3_red=255;
        }
        elsif ($p3_red<0) {
            $p3_red=0;
        }
        if ($p3_green>255) {
            $p3_green=255;
        }
        elsif ($p3_green<0) {
            $p3_green=0;
        }
        if ($p3_blue>255) {
            $p3_blue=255;
        }
        elsif ($p3_blue<0) {
            $p3_blue=0;
        }
        if ($p4_red>255) {
            $p4_red=255;
        }
        elsif ($p4_red<0) {
            $p4_red=0;
        }
        if ($p4_green>255) {
            $p4_green=255;
        }
        elsif ($p4_green<0) {
            $p4_green=0;
        }
        if ($p4_blue>255) {
            $p4_blue=255;
        }
        elsif ($p4_blue<0) {
            $p4_blue=0;
        }
    }
    return 1;
}



########## Post loop code ############
if ($command eq "clear") {
}

########## Triggers ############

if ($command eq "onchange_3") {
    $p0=@ARGV[1];
    $p1=@ARGV[2];
    $p1_min=@ARGV[3];
    $p1_max=@ARGV[4];
    $p2=@ARGV[5];
    $p2_min=@ARGV[6];
    $p2_max=@ARGV[7];
    $p3_red=@ARGV[8];
    $p3_green=@ARGV[9];
    $p3_blue=@ARGV[10];
    $p4_red=@ARGV[11];
    $p4_green=@ARGV[12];
    $p4_blue=@ARGV[13];
    $p5=@ARGV[14];
    $p5_min=@ARGV[15];
    $p5_max=@ARGV[16];
    $width=@ARGV[17];
    $height=@ARGV[18];
    $start=@ARGV[19];
    $end=@ARGV[20];
    $last=@ARGV[21];
    $length=$end-$start+1;

    $p4_red=$p3_red;$p4_green=$p3_green;$p4_blue=$p3_blue;
    $p0=~ s/\"/\\\"/g;

    print "\"$p0\" $p1 $p1_min $p1_max $p2 $p2_min $p2_max $p3_red $p3_green $p3_blue $p4_red $p4_green $p4_blue $p5 $p5_min $p5_max ";
    exit 0;
}

if ($command eq "onchange_init") {
    $p0=@ARGV[1];
    $p1=@ARGV[2];
    $p1_min=@ARGV[3];
    $p1_max=@ARGV[4];
    $p2=@ARGV[5];
    $p2_min=@ARGV[6];
    $p2_max=@ARGV[7];
    $p3_red=@ARGV[8];
    $p3_green=@ARGV[9];
    $p3_blue=@ARGV[10];
    $p4_red=@ARGV[11];
    $p4_green=@ARGV[12];
    $p4_blue=@ARGV[13];
    $p5=@ARGV[14];
    $p5_min=@ARGV[15];
    $p5_max=@ARGV[16];
    $width=@ARGV[17];
    $height=@ARGV[18];
    $start=@ARGV[19];
    $end=@ARGV[20];
    $last=@ARGV[21];
    $length=$end-$start+1;

    $p1_max=$width; $p2_max=$height;
    $p0=~ s/\"/\\\"/g;

    print "\"$p0\" $p1 $p1_min $p1_max $p2 $p2_min $p2_max $p3_red $p3_green $p3_blue $p4_red $p4_green $p4_blue $p5 $p5_min $p5_max ";
    exit 0;
}
