#!/usr/bin/perl

#######################################################################
# LiVES blank_frames plugin, version 1
# 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 "blank_frames version 1 : 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 "Blank frames|Blanking|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 "bcol|Blank _Colour|colRGB24|0|0|0|\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("convert") eq "") {
      &sig_error("You must install 'convert' 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 = 0;
    }
    else {
      $p0 = $ARGV[1];
    }
    $p0 = int($p0);
    if ($p0 > 0xFFFFFF || $p0 < 0) {
        &sig_error("Invalid colour for bcol.");
        exit 1;
    }
    $p0_red = int($p0 / 65536);
    $p0 -= $p0_red * 65536;
    $p0_green = int($p0 / 256);
    $p0 -= $p0_green * 256;
    $p0_blue = $p0;
    if ($img_ext eq ".png") {
        $img_prefix = "PNG32:";
    } else {
        $img_prefix = "";
    }

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

    $bgcol=&RGB24_to_string($p0_red,$p0_green,$p0_blue);
    $cver_new=(&get_convert_version_hash>=5005004);

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

        if ($cver_new) {
           system("$convert_command $img_prefix$in -fill $bgcol -colorize 100/100/100 $out_prefix$out");
        }
        else {
             system("$mogrify_command -pen $bgcol -colorize 100/100/100 $img_prefix$in $out_prefix$out");
        }

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

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

        &sig_progress($frame);

        if ($p0_red > 255) {
            $p0_red = 255;
        }
        elsif ($p0_red < 0) {
            $p0_red = 0;
        }
        if ($p0_green > 255) {
            $p0_green = 255;
        }
        elsif ($p0_green < 0) {
            $p0_green = 0;
        }
        if ($p0_blue > 255) {
            $p0_blue = 255;
        }
        elsif ($p0_blue < 0) {
            $p0_blue = 0;
        }
        }
    return 1;
}



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