Zum Ende der Metadaten springen
Zum Anfang der Metadaten

General

Version

Plug-ins have been introduced in PicApport 4.0.0. So all you need as a picapport.jar or picapport.exe with Version 4.0 or later.

Available Plug-ins

Currently (Feb 2015) we offer the following plug-ins. Please check http://picapport.de/plugins.php for updates.

Download filenameSupported
file types
RemarksHow to install

PicApportJava
ImagePlugin-1.0.zip
http://picapport.de/
plugins.php

Simple plug-in based
on Java imageIO and
TwelveMonkeys.

The following meta-data
is supported:

  • title (set to
    original filename)
  • .bmp
  • .gif
  • .png
  • .psd
  • .tif
  • .tiff
 
  • As an option from
    the Windows-Installer

    or

  • Copy the zip-file
    to the plug-in directory
  • Restart PicApport

PicApport
PdfPlugin.zip
http://picapport.de/
plugins.php

Based on Apaches
PDFBox, this plug-in
takes the first page
of the pdf-dokument
and adds the following
meta-data from the pdf:

  • title (set to
    original filename)
  • creation date
  • creator / author
  • title
  • keywords (tags)
  • description
    (subject)
  • pdf
 
  • As an option from
    the Windows-Installer

    or

  • Copy the zip-file
    to the plug-in directory
  • Restart PicApport

PicApportDc
RawPlugin.zip
http://picapport.de/
plugins.php

Based on Dave
Coffin's work on dcraw 
https://www.cybercom.net/
~dcoffin/dcraw/

and Mozillas mozjpeg
https://github.com/
mozilla/mozjpeg
this plug-in
provides support for
almost every RAW format

The following
meta-data is supported:

  • title (set to
    original filename)
  • creation date
  • Camera
  • ISO speed
  • Shutter
  • Aperture
  • Focal length

 

  • .3fr
    Hasselblad RAW

  • .arw
    Sony RAW

  • .cr2
    Canon RAW

  • .crw
    Canon RAW

  • .dcr
    Kodak RAW

  • .dng
    Adobe DNG

  • .erf
    Epson RAW

  • .kdc
    Kodak RAW

  • .mef
    Mamiya RAW

  • .mos
    Leaf Mosaic RAW

  • .mrw
    Minolta RAW

  • .nef
    Nikon RAW

  • .nrw
    Nikon RAW

  • .orf
    Olympus RAW

  • .pef
    Pentax RAW

  • .raf
    Fuji RAW

  • .raw
    Panasonic RAW

  • .rw2
    Panasonic RAW

  • .sr2
    Sony RAW

  • .srf
    Sony RAW

  • .srw
    Samsung RAW

  • .x3f
    Sigma RAW

For Linux users:
make sure that dcraw is
installed.
Also CJPEG (part of the
standard JPEG library libjpeg)
must be installed.

Example for Debian:

  • apt-get install dcraw
  • apt-get install libjpeg-progs
  • As an option from
    the Windows-Installer

    or

    Copy the zip-file to
    the plug-in directory
  • Restart PicApport

PicApportOpenCv
VideoPluginWindows.zip
PicApportOpen
CvVideoPluginLinux.zip
http://picapport.de/
plugins.php

Currently, only the
Windows version is available.
(Linux version planned)

The Plug-in is based on
JavaCV (https://github.com/
bytedeco/javacv
)
which uses
OpenCV (http://opencv.org/).

The Plug-in creates
a substitue .jpg file
based on one Frame
from the Video.

The following meta-data
is supported:

  • title (set to
    original filename)
  • .mp4, video/mp4
  • .ts, video/MP2T
  • .3gp, video/3gpp
  • .3g2, video/3gpp2
  • .flv, video/x-flv
  • .ogv, video/ogg
  • .avi, video/x-msvideo
  • .webm, video/webm
  • .mpg, video/mpeg
  • .mpeg, video/mpeg
  • .m2v, video/mpeg
  • .wmv, video/x-ms-wmv
  • .mov, video/quicktime
  • .divx,video/divx
  • .mkv, video/x-matroska
 
  • Copy the zip-file
    to the plug-in directory
  • Restart PicApport

Installation

Before you install a plug-in make sure that you know where your .picapport directory of your installation is located.

During server-startup the plug-in directory will be displayed like this: MSG  @ 14:56:03.268 Search for plugins in C:\Users\username\.picapport\plugins

Copy one ore more the plug-in.zip file(s) to the .picapport/plugins directory and (re)start the PicApport server.

After restarting the server you can check the current logfile in the .picapport/logfiles directory if a plug-in has been installed successfully.
Depending on the plug-in-type the logfile should contain something like this:

........
MSG @ 14:53:18.045 Plugin loaded: PicApport GIF plugin 1.0 (c) 2014 Contecon Software GmbH .gif image/gif (hideSubstitutes=true) implements IOtherFileFormat
MSG @ 14:53:18.045 Plugin loaded: PicApport PNG plugin 1.0 (c) 2014 Contecon Software GmbH .png image/png (hideSubstitutes=true) implements IOtherFileFormat
MSG @ 14:53:18.047 Plugin loaded: PicApport PDF plugin 1.0 (c) 2015 Contecon Software GmbH .pdf application/pdf (hideSubstitutes=true) implements IOtherFileFormat
......

Where red shows the file-extension handled by this plug-in and green the mime-type of the original file.

How it works

If you are not a programmer this is may be not interesting for you

During PicApport startup

  • When PicApport starts it checks the .picapport/plugins directory for existing .zip files.
  • For each .zip file a hidden directory with the same name will be created an the content
    of the .zip file will be copied to this directory. This directory is called plugin-directory.
  • Then for each .jar file in the plugin-directory the Manifest.mf file will be check for a valid PicApport-Plugin: entry

  • The init() method of the plug-in will be called (only one time during server startup)
    The following information is passed to the init() method:
    • File pluginDirectory
      The path to the directory where this plug-in was loaded from. This Information
      may be used by the plug-in to load more configuration data.
      A plug-in should not be dependent on information outside this directory

    • Properties props
      If a .properties file with the same name as the plug-in exists, it will be loaded by PicApport and passed to the init() method.
      Also make sure that props is passed to the constructor method of the OtherFormatsDescriptor created during the init phase.
      The plug-in may use this file to store additional configuration data. See our PicApportPdfPlugin-src.zip plug-in how this can be used.
      Example PicApportPdfPlugin.properties:

      The menudownload.text[.iso language] may be used to set the download text of the original file in the PicApport slideshow.
      If a text for the current language does not exist the default text(menudownload.text) will be used. (Should be English)

    • IPicApportPlugInLogger logger
      The logger should be saved in a private member of the plug-in and should be used for debug output if required.

  • The init() method should return at least one OtherFormatsDescriptor instance element in the  List<OtherFormatsDescriptor> returned.

    Create the descriptor

During scanning of the photo directories

  • When PicApport scans the photo directory's it checks all non-jpg files if a plug-in has been registered.
  • If a plug-in has been registered:
    • PicApport checks if the substitute file exists
      A substitute file is the jpg representation of the original file. PicApport adds .$.jpg to the original file to get the substitute filename.
      If the substitute file does not exist or is older than the original file the createJpegFile() method of the plugin will be called to create the substitute file.
      The following information is passed to the createJpegFile() method:
      • File otherFormatFile
        Path to the original File

      • File jpegFileToCreate
        Path to the substitute file that should be created

      • CcXMPMetaData metaDataIn
        Optional meta-data added to the substitute jpg file. If no meta-data is available createJpegFile() method should return null.
        If meta-data is available it should be added to metaDataIn and  metaDataIn should be returned instead of null.
        see: Javadoc on http://picapport.de/plugins/javadoc/ for more details of CcXMPMetaData .

Programming

Plug-ins are programmed in the Java programming language.

Before you start,make sure that you have downloaded a picapport.jar with at least version 4.0.0. When you compile your plug-in make sure that picapport.jar is in your classpath

Creating a PicApport plug-in is very simple. Basically you just have to implement two Methods in a Java Class:

  • public List<OtherFormatsDescriptor> init(File pluginDirectory, Properties props, IPicApportPlugInLogger logger)

  • public CcXMPMetaData createJpegFile(File otherFormatFile, File jpegFileToCreate, CcXMPMetaData metaDataIn)

 

see: Javadoc on http://picapport.de/plugins/javadoc/ for more details.

 

Sample PicApport plug-in for .gif and .png support

PicApportJavaImagePlugin

 

The Manifest File

A PicApport plug-in is represented and installed by a .jar file. This .jar MUST have a Manifest.mf file with a PicApport-Plugin: entry where the class implementing the de.contecon.picapport.plugins.otherformats.IOtherFileFormat is delared.

 

Manifest.mf

The plug-in  .zip file

The last step is to create a zip file for the plug-in.  The filename should be the classname of the plug-in.

The .zip file should contain at least:

  • The .jar file of the plug-in
  • The.properties-file of the plugin

Optional content can be:

  • Other .jar files required by the plugin
  • License information files
  • Any other files
  • Keine Stichwörter