NAME

Jail - SGIPerl extension for grabbing video, modifying images and display images

SYNOPSIS

use Jail;

$font = openBDF Font ("helvetica50.bdf"); if ($font->getStatus) { print $font->getErrorString() . "\n"; exit(1); }

$dateStr = localtime(time); $glArray = $font->getText("$dateStr",$count); $glyph = merge Glyph ($glArray, $count);

$glyph->setForeground(255,255,255,0);

$jg = new JailGlyph(); $jg->addGlyph($glyph); if ($jg->getStatus()) { print $jg->getErrorString() . "\n"; exit(1); }

$imgStream = new JailArray(); if (!$imgStream->getVideoStream(2)) { $imgStream->printError(); exit(1); }

$image = $imgStream->pop();

$wi = $image->getWidth(); $hi = $image->getHeight(); $wg = $jg->getWidth(); $hg = $jg->getHeight();

if (!$jg->blittInImage($image, $wi - $wg, $hi - $hg)) { print "BLITT1: "; print $jg->getErrorString() . "\n"; print $image->getErrorString() . "\n"; exit(1); } $image->blur(180,5,5); $image->rotateZoom(45, 0.6, 0.6); if (!$image->save("/tmp/jail_2.sgi","SGI")) { $image->printError(); exit(1); }

$image = $imgStream->pop(); $image->sharp(2.5); $wi = $image->getWidth(); $hi = $image->getHeight();

if (!$jg->blittInImage($image, $wi - $wg, $hi - $hg)) { print "BLITT2: "; print $jg->getErrorString() . "\n"; print $image->getErrorString() . "\n"; exit(1); } if (!$image->save("/tmp/jail_1.gif","GIF")) { $image->printError(); exit(1); }

DESCRIPTION

  Jail - Just an_other Image Library

  This extension is running _only_ on SGI IRIX systems. You need the 
  Image Vision Library, Video Library and STL.
  You need a X11 Display _only_ if you want to display an image.

  The newest version you can get under http://www.artcom.net/~karo/Jail/.
  You can get there also a precompiled version.

CLASS INTERFACE

A 'better' documentation are may be the examples.

Exported functions and flags

 The package C<Jail> exports the following functions

Jail Object

new Jail(...)

load(filename)

Load an existing image. The method guesses the right file type.

save(filename, imgFormat)

Save this image with a given filename. The imgFormat is one of the supported file formats from the Image Vision Library. Have a look under File Formats or execute the imgformats command.

saveFile(filehandle, imgFormat)

Save this image to a already opened filehandle. For the imgFormat see above. This function works only for the GIF format. The IL seeks during saving on the filedescriptor, I try to get the IL output over a pipe. That does not work. YET

getWidth()

Returns the width of the image in pixels.

getHeight()

Returns the height of the image in pixels.

getChannels()

Returns for the image the amount of channels.

getImageFormatName()

This method is usefull if you have loaded an image. So you can get the file format for that image.

copyTile(destX, destY, width, height, srcImage, srcX, srcY)

Copy a tile from srcImage with the given coord. to this image.

add(addImg, [bias])

Add a image logical to this image.

setPixel(x,y, r,g,b,[a])

Set a pixel with the given color

duplicate()

Get a copy of this image.

getVideoSnapshot()

Get a image from the default video input. See also videoin(1) and videopanel(1).

rotateZoom(angle, zoomX, zoomY, [resample])

Rotate this image with a given angle. And/Or zoom this image. 0 <= angle < 360 0.0 < zoomFactor <= 1.0 See also ilRotZoomImg(3)

blur(blur, width, height, [bias], [edgeMode])

This method blurs an image by convolving it with a 2D gaussian kernel. Parameter: blur : the degree of blur width,height : the kernel size

JailArray Object

new JailArray

size()

Returns the amount of images.

push(Jail)

Push an image to the end of the array.

Jail pop()

Pops and returns the last image in the array.

Jail shift()

Shifts the first image of the array off and returns it.

unshift(Jail)

Prepends an other image to the front of the array.

loadIndexed(prefix,startSuffix,suffix,amount)

Loads images with a given prefix, an additional number and a given suffix. For Example: prefix: blub startSuffix: 23 suffix: .gif amount: 3

  So the method would load 3 images: blub23.gif, blub24.gif and blub25.gif

saveIndexed(prefix,startSuffix,suffix)

Saves images with the same name convention as loadIndexed.

getVideoStream(amount)

Get a videostream of amount images.

printError()

getStatus()

getErrorString()

Font Object

openBDF(filename): This static factory method loads a BDF font with the given filename and returns a Font Object. BDF stands for Glyph Bitmap Distribution Format. See: http://www.adobe.com/supportservice/devrelations/typeforum/ftypes.html You can get BDF fonts from the X source or get them from your X server, have a look: fstobdf(1), xfontsel(1)
getText(text, countVar): This methods builds a GlyphArray Object from a given text. In the countVar Variable will be the amount of found Glyphs returned.
getCharsetEncoding(): Returns the encoding value for the font.
getName(): Returns the name.
getStatus()
getErrorString()

Glyph Object

merge(GlyphArray, count): This static factory method returns a new Glyph Object which is build from the given GlyphArray.
setName(name): You set the Name for the Glyph object.
getName()
getEncoding(): Get the char encoding for the Glyph. For a merged Glyph it is always 0.
getBBXW(): Get the width of the Bounding Box.
getBBXH(): Get the height of the Bounding Box.
getBBXXO(): Get the X coord. of the virtual point Zero of the BBX.
getBBXYO(): Get the Y coord. of the virtual point Zero of the BBX.
setForeground(r,g,b,[a]): Select a color for the foreground of the Glyph. Every '1' in the Glyph will be treated as foreground.If you select for 'a' color a 255, the foreground will not be painted.
setBackground(r,g,b,[a]): Select a color for the background of the Glyph. Every '0' in the Glyph will be treated as background.If you select for 'a' color a 255, the background will not be painted.
getForegroundR()
getForegroundG()
getForegroundB()
getForegroundA()
getBackgroundR()
getBackgroundG()
getBackgroundB()
getBackgroundA()
print(): This is for debuging. This prints the glyph in ascii.

GlyphArray Object

JailGlyph Object

new JailGlyph()
addGlyph(glyph): This method collects Glyph objects.
createImg(): This method returns a Jail object. The returned object depends on the added Glyphs.
blittInImage(img, x, y): This method expect a Jail object and a x and y coord. The added Glyphs will be rendered in the given Jail image.
getWidth(): This returns the witdh, for that the JailGlyph will create a Imgage. Thats the same as: $jailObj = $JailglyphObj->createImg(); -->> $jailObj->getWidth();
getHeight()
getCurX(): Get the X coord of the virtual point zero.
getCurY()
printError()
getStatus()
getErrorString()

Special Parameter

bias: In general, bias is a constant value added to each pixel luminance value to make it scale correctly. If, for example, the raw pixel luminance covers values between 100 and 200, some operators are able to scale the luminance values over the entire depth of pixel luminance values, for example, 0 - 255. When you scale the luminance values in this way, you need a bias value that adjusts the initial, raw luminance value, 100, in this example, to zero.
edgeMode: Specifies how the neighborhood is defined for pixels at the edge of the image. Have look at the EDGE_* Flags.
resample: Determining the procedure used by IL to alter the geometric aspects of an image Have a look under Flags RT_*
kernSize: SGI Docs: The kernel is the group or neighborhood of pixels used in calculations to sharpen or blur an image. Generally, the larger the kernel radius, the more pronounced the effect of either sharpening or blurring the image using the Enhance subpanel. However, using a larger kernel radius also results in a more time-consuming process.
compose: arg, thats heavy to explain shortly please have look at ilBlendImg(3) and in /usr/include/il/ilTypes.h

Flags

EDGE_NOPAD

No padding is done, and the output image shrinks by the size of the kernel minus one in each dimension.

EDGE_PADSRC

The edge of the input image is padded with the input images fill value so that a full-sized output image can be processed.

EDGE_PADDST

Similar to ilNoPad, except that the output, images border is sufficiently padded with its fill value so that the final image is the same size as the source image.

EDGE_WRAP

Sufficient data is taken from the opposite edge of the source image so that a full-sized output image can be processed.

EDGE_REFLECT

Sufficient data near the edge of the image is reflected so that a full-sized output image can be processed without producing artifacts at the image edge. This mode gives the best results for most operators.

RT_NEARNB

Nearest, standing for Nearest Neighbor, works quickly but produces lower-quality results.

RT_BILINEAR

Bilinear uses more complex, time-consuming methods than Nearest Neighbor, but produces higher-quality results.

RT_BIBUBIC

Bicubic is more time-consuming than either Nearest Neighbor or Bilinear, but produces the best results.

If you choose the Bicubic resampling method, you can also choose the specific Bicubic Family, each of which produces a somewhat different effect: B-Spline, which is the default option, produces smoother images. Catmul produces more sharpening. Mitchell results in an effect between that of the other two.

RT_MINIFY

The Minify method produces the best results if you are reducing the magnification of an image. Again, however, it is a more time-consuming process.

Image Formats

Todo

search for memory leaks: There is a small memory leak somewhere in the save routine. Do not know if it is in my or in the SGI IL routines.
thrash hold: add a thrash hold operator
more filter
24->8 Bit dithering
add some primitive geometry painting
Display: The display object is _VERY_ buggy and not finished yet.
Jail::saveFile() can only save GIF\'s and JPG\'s: Thats a SGI IFL Bug.
GIF -> GIF improvement: The Problem is the IL core dumpes if I am trying to copy a GIF. So i have to convert GIF->RGB->GIF.
documentation: Write a better documentation

BUGS

  Oh, yes there are some. Especially in the display routine.
  Please, please, please, send me a short note if you found a bug.

AUTHOR

  This module has been written by Benjamin Pannier (B<karo@artcom.net>).

	Global
`s`	Focus search bar
`?`	Bring up this help dialog

	GitHub
`g` `p`	Go to pull requests
`g` `i`	go to github issues (only if github is preferred repository)

	POD
`g` `a`	Go to author
`g` `c`	Go to changes
`g` `i`	Go to issues
`g` `d`	Go to dist
`g` `r`	Go to repository/SCM
`g` `s`	Go to source
`g` `b`	Go to file browse

	Search terms
module: (e.g. module:Plugin)
distribution: (e.g. distribution:Dancer auth)
author: (e.g. author:SONGMU Redis)
version: (e.g. version:1.00)