#!/usr/bin/perl

#######################################################################
# LiVES frame_calculator plugin v0.1

# rendered plugins should accept:
# <plugin_name> version (return <plugin_name> version <version>)
# <plugin_name> get_capabilities
# <plugin_name> get_description (e.g. "Edge detect|Edge detecting|1|1|")
# 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


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

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 )
    # 0x8000 == reserved
    print "32770\n";
    exit 0;
}

if ($command eq "version") {
    print "frame_calculator version 1.1 : builder version 0.9.5\n";
    exit 0;
}

if ($command eq "get_description") {
    #format here is "Menu entry|Action description|min_frames|script_file_name|"
    # 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 "Frame Calculator|fc|-1|0||\n";
    exit 0;
}


if ($command eq "get_parameters") {
    # "name|group|type|default|min|max|"
    # eg. print "Radius|0|num0|1|1|100|";
    # types can be numx,colRGB24,bool,string or string_list
    print "_Calculate|1|bool|0|\n";
    print "_Calculate|1|bool|0|\n";
    print "_Calculate|1|bool|1|\n";
    print "_Frames|0|num0|0|0|1000000|\n";
    print "Frames _per second (FPS)|0|num3|0|0|1000000|\n";
    print "_Time (seconds)|0|num2|0|0|1000000|\n";
    exit 0;
}

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

if ($command eq "get_onchange") {
    print "1|\n";
    print "2|\n";
    print "3|\n";
    print "4|\n";
    print "5|\n";
    print "6|\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) ]

    $livesexitcode=1;
    $SIG{'HUP'}="dopost";


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

    unless (defined($ARGV[1])) {
      $p1=0;
    }
    else {
      $p1=$ARGV[1];
    }
    unless (defined($ARGV[2])) {
      $p2=0;
    }
    else {
      $p2=$ARGV[2];
    }
    unless (defined($ARGV[3])) {
      $p3=1;
    }
    else {
      $p3=$ARGV[3];
    }
    unless (defined($ARGV[4])) {
      $p4=0;
    }
    else {
      $p4=$ARGV[4];
    }
    unless (defined($ARGV[5])) {
      $p5=0;
    }
    else {
      $p5=$ARGV[5];
    }
    unless (defined($ARGV[6])) {
      $p6=0;
    }
    else {
      $p6=$ARGV[6];
    }
    $p1=~(~$p1);
    $p2=~(~$p2);
    $p3=~(~$p3);
    $p4=int($p4*1+.5)/1;
    if ($p4<0) {
       &sig_error("_Frames must be >= 0");
    }
    if ($p4>1000000) {
       &sig_error("_Frames must be <= 1000000");
    }
    $p5=int($p5*1000.+.5)/1000.;
    if ($p5<0) {
       &sig_error("Frames _per second (FPS) must be >= 0");
    }
    if ($p5>1000000) {
       &sig_error("Frames _per second (FPS) must be <= 1000000");
    }
    $p6=int($p6*100.+.5)/100.;
    if ($p6<0) {
       &sig_error("_Time (seconds) must be >= 0");
    }
    if ($p6>1000000) {
       &sig_error("_Time (seconds) must be <= 1000000");
    }


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

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


###################################################################
        if (! -f $out) {
            print "Warning: effect plugin frame_calculator skipped frame $frame !";
            `cp $in $out`;
        }
    }
    $livesexitcode=0;
    &dopost;
    return 1;
}



########## Post loop code ############
sub dopost {
    if ($livesexitcode) {
        exit $livesexitcode;
    }
}

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

if ($command eq "onchange_6") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p1) {$p4=$p5*$p6;} elsif ($p2&&$p6>0.) {$p5=int($p4/$p6*1000.+.5)/1000.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}

if ($command eq "onchange_4") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p2&&$p6>0.) {$p5=int($p4/$p6*1000.+.5)/1000.;} elsif ($p5>0.) {$p6=int($p4/$p5*100.+.5)/100.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}

if ($command eq "onchange_1") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p1) {$p4=$p5*$p6;} elsif ($p2&&$p6>0.) {$p5=int($p4/$p6*1000.+.5)/1000.;} elsif ($p5>0.) {$p6=int($p4/$p5*100.+.5)/100.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}

if ($command eq "onchange_3") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p1) {$p4=$p5*$p6;} elsif ($p2&&$p6>0.) {$p5=int($p4/$p6*1000.+.5)/1000.;} elsif ($p5>0.) {$p6=int($p4/$p5*100.+.5)/100.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}

if ($command eq "onchange_2") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p1) {$p4=$p5*$p6;} elsif ($p2&&$p6>0.) {$p5=int($p4/$p6*1000.+.5)/1000.;} elsif ($p5>0.) {$p6=int($p4/$p5*100.+.5)/100.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}

if ($command eq "onchange_5") {
    $p1=@ARGV[1];
    $p2=@ARGV[2];
    $p3=@ARGV[3];
    $p4=@ARGV[4];
    $p4_min=@ARGV[5];
    $p4_max=@ARGV[6];
    $p5=@ARGV[7];
    $p5_min=@ARGV[8];
    $p5_max=@ARGV[9];
    $p6=@ARGV[10];
    $p6_min=@ARGV[11];
    $p6_max=@ARGV[12];
    $width=@ARGV[13];
    $height=@ARGV[14];
    $start=@ARGV[15];
    $end=@ARGV[16];
    $last=@ARGV[17];
    $length=$end-$start+1;

    if ($p1) {$p4=$p5*$p6;} elsif ($p5>0.) {$p6=int($p4/$p5*100.+.5)/100.;}

    print "$p1 $p2 $p3 $p4 $p4_min $p4_max $p5 $p5_min $p5_max $p6 $p6_min $p6_max ";
    exit 0;
}
