#!/usr/bin/perl

#######################################################################
# LiVES tunnel plugin, version 2
# Compiled with Builder version 3.2.0
# 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 [<in2_prefix> [<in_prefix>]] <out_prefix> <out_ext> <start> <end>
#  <width> <height> <img_ext> <fps> [<img2_ext> <start2> <handle2>]  <parameters>
# you should create all output frames $out_prefix%08d$out_ext in numerical 
# from start to end inclusive,
# using $in_prefix%08d$in_ext and $in2_prefix%08d$img2_ext as applicable.
# in / out images are in current dir, In2 images can be located in ../handle2 and numbered from 
# Each time calling sig_progress (see smogrify) - writes current frame number to 
# <dir>/.status
# and checking for pause (test for a file of that name in current dir - if present just sleep until deleted)
#
# Any errors - 
# write "error|msg1|msg2|msg3|" to .status
# msgn must not contain "\n", but can be omitted

# 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;
setlocale(LC_NUMERIC, "C");

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 "tunnel version 2 : builder version 3.2.0\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 "Tunnel|Tunneling|2|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 "diffmax|_Diffmax|num0|10|1|100|\n";
    print "rand|_Randomness|num0|5|0|100|\n";
    print "fade|_Fade level|num0|90|0|100|\n";
    exit 0;
}

if ($command eq "get_param_window") {
    exit 0;
}

if ($command eq "get_onchange") {
    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("composite") eq "") {
      &sig_error("You must install 'composite' before you can use this effect.");
      exit 1;
    }
    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 = 10;
    }
    else {
      $p0 = $ARGV[1];
    }
    unless (defined($ARGV[2])) {
      $p1 = 5;
    }
    else {
      $p1 = $ARGV[2];
    }
    unless (defined($ARGV[3])) {
      $p2 = 90;
    }
    else {
      $p2 = $ARGV[3];
    }
    $! = 0;
    if ($p0 >= 0) {
        $p0 = int(POSIX::strtod($p0) * 1 + .5) / 1;
    } else {
        $p0 = int(POSIX::strtod($p0) * 1 - .5) / 1;
    }
    if ($p0 < 1) {
       &sig_error("diffmax must be >= 1");
       exit 1;
    }
    if ($p0 > 100) {
       &sig_error("diffmax must be <= 100");
       exit 1;
    }
    $! = 0;
    if ($p1 >= 0) {
        $p1 = int(POSIX::strtod($p1) * 1 + .5) / 1;
    } else {
        $p1 = int(POSIX::strtod($p1) * 1 - .5) / 1;
    }
    if ($p1 < 0) {
       &sig_error("rand must be >= 0");
       exit 1;
    }
    if ($p1 > 100) {
       &sig_error("rand must be <= 100");
       exit 1;
    }
    $! = 0;
    if ($p2 >= 0) {
        $p2 = int(POSIX::strtod($p2) * 1 + .5) / 1;
    } else {
        $p2 = int(POSIX::strtod($p2) * 1 - .5) / 1;
    }
    if ($p2 < 0) {
       &sig_error("fade must be >= 0");
       exit 1;
    }
    if ($p2 > 100) {
       &sig_error("fade must be <= 100");
       exit 1;
    }
    if ($img_ext eq ".png") {
        $img_prefix = "PNG32:";
    } else {
        $img_prefix = "";
    }

    if ($out_ext eq ".png") {
        $out_prefix = "PNG32:";
    } else {
        $out_prefix="";
    }

    $diff=0;
    
    # all for merge
    $oheight=$height;
    $owidth=$width;
    $x=int($width/8)+1;
    $y=int($height/8)+1;
    $width-=$x*2;
    $height-=$y*2;
    $pc_start=$p2; # fade amount

    if ($start == 0) {$start = 1;}


################# 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";

        if (!defined($end) || $end == 0) {
            print STDERR "WARNING: generator plugin did not set $end !";
            &sig_error("Generator plugin did not set $end.");
        }
        $out = "$name$out_ext";

        # wait for front end to create 
        while (! -s $in) {
            sleep 1;
        }

        `flock $in true`;
##################### the all-important bit #######################

        # merge frame from diff frames ago at 90%
        $from=&mkname(int($frame-$diff));
        if (-f "$from$out_prefix$out_ext") {
            $fromimg="$out_prefix$from$out_ext";
        }
        else {
            if (-f "$from$img_ext") {
                $fromimg="$img_prefix$from$img_ext";
            }
            else {
                # must make sure we have an input image
                $fromimg="$img_prefix$in";
            }
        }
        
        `$composite_command -compose plus -dissolve $pc_start -geometry $width!x$height!+$x!+$y! $fromimg -size $owidth!x$oheight! $img_prefix$in $out_prefix$out >/dev/null 2>&1`;
        
        # make the diff grow at the beginning and shrink at the end
        $diff+=(rand ($p1*2+1))-$p1+1;
        
        if ($diff<1) {
            $diff+=$p1/2+1;
        }
        if ($frame-$diff<$start||$diff+$frame>$end||$diff>$p0) {
            $diff-=$p1/2+1;
        }

###################################################################
        for (my $i = 0; $i < 5; $i++) {
            if (! -s $out) {
                sleep 1;
            }
        }

        if (! -s $out) {
            print STDERR "Warning: effect plugin tunnel skipped frame $frame !\n";
            return 1;
        }

        &sig_progress($frame);

        }
    return 1;
}



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