Kipi

What is it?

Kipi (KDE Image Plugin Interface) is an effort to develop a common plugin structure for Digikam, KimDaBa, Showimg and Gwenview. Its aim is to share image plugins among graphic applications. Kipi is based on the old digiKam plugins implementation and is maintened by digiKam team.

Table of contents

• Status
• Documentation
• Releases
• SVN
• Compilation
• Screenshots
• Contact
• TODO

Status

libKipi core is stable and has been released as libkipi 0.1.4.

The most stable KipiPlugins tarball is version 0.1.0-rc2.
Currently implemented plugins are:

• NEW FlickrExport: export images to a remote Flickr web service.
• NEW SimpleviewerExport: export your images in a nice flash movie.
• NEW HTMLGallery: export your images to HTML
• RawConverter: A raw image converter for digital cameras.
• SlideShow: Slideshow with effects ripped out from kslideshow and 3D effects using OpenGL.
• MpegEncoder: Create an MPEG slideshow from your images.
• PrintWizard: A wizard to print images in various format.
• JpegLossLess: Batch process your JPEG images without losing meta information and compression.
• CdArchiving: Archive your albums on CD or DVD using K3b.
• ScanImages: Scanner management using Kooka.
• ScreenshotImages: Snap screen based on KSnapshot and adapted to Kipi.
• Calendar: A plugin to create calendars.
• SendImages: A plugin to send images by email, allowing resizing and recompressing before sending.
• RenameImages: Batch image renamer.
• ConvertImages: Batch image converter.
• BorderImages: Add border to your images in batch.
• FilterImages: Batch image enhancer using digital filters.
• ColorImages: Batch image color enhancer.
• EffectImages: Batch image transformation effects.
• ResizeImages: Batch image resizer.
• RecompressImages: Batch image recompressor.
• FindDuplicateImages: Find duplicate images in albums.
• WallPaper: Set your image as wallpaper.
• TimeAdjust: Adjust image file time and date.
• GalleryExport: Interface for export images collections to remote Gallery web server.
• KameraKlient: Digikam 0.6.2 Gphoto2 interface ported as a Kipi plugin. Note: this plugin is disabled in digiKam release >= 0.7.x because this part have been re-written from scratch using KIO Slaves.

Documentation

The current kipi plugins handbook from SVN can be consulted here.
If you want to use libKipi in your application, the API documentation generated by Doxygen is available online from developer.kde.org.
Jesper K. Pedersen wrote a KIPI presentation, which you can find here.

Releases

Latest versions are:

• libkipi: 0.1.4
• kipi-plugins: 0.1.2
• libkexif: 0.2.5

Latest releases are listed below. You can find older releases from here.

Source

• kipi-plugins-0.1.2.tar.bz2
• libkexif-0.2.5.tar.bz2
• libkipi-0.1.4.tar.bz2

Mandriva 2006

By Angelo Naselli

• kipi-plugins-0.1.2-0.1.20060mdk.i586.rpm
• libkexif0-0.2.4-0.1.20060mdk.i586.rpm
• libkexif0-devel-0.2.4-0.1.20060mdk.i586.rpm
• libkipi0-0.1.4-0.1.20060mdk.i586.rpm
• libkipi0-devel-0.1.4-0.1.20060mdk.i586.rpm

Slackware 10.2

By Mark Tucker

• kipi_plugins-0.1.0_rc1-i486-1mht.tgz
• libkexif-0.2.2-i486-1mht.tgz
• libkipi-0.1.2-i486-1mht.tgz

SuSE 10.0

Links2Linux.de has KIPI packages for SuSE:

• kipi-plugins
• libkipi
• libkexif

SVN

If you want to try the latest development version, you need to grab Kipi from the KDE SVN. It's located in the kdeextragear-libs module.

You can either download the latest daily SVN snapshot from here, or get the source code using SVN like this:

% svn co svn://anonsvn.kde.org/home/kde/trunk/extragear/libs
% cd libs
% svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kde-common/admin

If you want to test a single module, kipi-plugins for instance, you can:

% svn co -N svn://anonsvn.kde.org/home/kde/trunk/extragear/libs
% cd libs
% svn co svn://anonsvn.kde.org/home/kde/trunk/extragear/libs/kipi-plugins
% svn co svn://anonsvn.kde.org/home/kde/branches/KDE/3.5/kde-common/admin

The current KDE SVN tarballs of the host applications which support Kipi can be downloaded from this link

Compilation and installation

Kipi must be compiled and installed before compiling the host applications.

Compiling libKipi

The dependencies are:

• Common:
  • AutoConf >= 2.5
  • AutoMake >= 1.6.0
  • KDE 3.x
• libkexif:
  • libexif >= 0.5.7
• kipi-plugins:
  • gphoto2 2.x
  • imlib2 >= 1.1.0
  • ImageMagick >= 5.5.4
  • MJPEGTools >= 1.6.0
  • dcRAW >= 5.02

The procedure is listed below:

export WANT_AUTOCONF_2_5=1
export KDEDIR=KDE_installation_dir_on_your_system
make -f Makefile.cvs
./configure --enable-debug=full
make
su
make install

Enabling Kipi support in host applications

The host application compilation options to use Kipi are:

• digiKam : no option. Native support.
• KimDaBa : use "--enable-libkipi" option with the ./configure script in kdeextragear-2 CVS module.
• ShowImg : use "--enable-libkipi" option with the ./configure script in kdeextragear-2 CVS module.
• Gwenview : use "--enable-kipi" option with the ./configure script in kdeextragear-1 CVS module.

Screenshots

Digikam
KimDaBa
Showimg
Gwenview

Contacts

Mailing list

If you want to implement a new plugin, add Kipi support to a new graphic application, or just speak about it, you're welcome to join the kde-imaging@kde.org mailing list.

The mailing-list archives can be consulted at this url.

Bug reports and Wishes

For bug reports and wishes, please use the KDE Bug Tracking System.
The current bugs/wishes list is available at this url.

Team

Main developers:

• Gilles Caulier from digiKam project.
• Renchi Raju from digiKam project.
• Joern Ahrens: developer from digiKam project.
• Tom Albers: developer from digiKam project.

Contributors:

• Angelo Naselli: bug fixing.
• Gerhard Kulzer: handbooks writer from digiKam project.
• Jesper K. Pedersen from Kimdaba project.
• Aurélien Gâteau from Gwenview project.
• Ralf Hoelzer: developer from digiKam project.
• Todd Shoemaker: developer from digiKam project.
• Tudor Calin: developer .

Roadmap to 0.1.0 release

Completed

Library core Added new Collection selection widget 'ImageCollectionWidget'. (Aurélien, Renchi, and Gilles) Added new progress dialog for threaded plugins. (Gilles) Added new dialog for files selection in images collection . (Aurélien) Added new widget for to set the plugins in the application hosts. (Jesper) Added new widget for to select an images collection. (Aurélien) Added new method fileExtensions(). (Gilles) Improved plugin categories. (Gilles) Creating Doxygen documentation library. (Jesper, Aurélien, Gilles) Creating libkipi core. (Jesper, Aurélien, Gilles, Renchi) Porting DigikamPlugins from SF.net to KDE CVS. (Jesper, Aurélien, Gilles) Created API documentation Web page. (Gilles) Added private class 'd' pointers. (Aurélien) Common plugins tasks Added 'Tip of day'. (Gilles) Kipi Web page on KdeExtragear web site. (Gilles) Basic plugins handbooks based on Kate architecture. (Gilles) Added KAbout data on all plugins with a full KDE bugs tracking support. (Gilles) Improved batch operations in FindDuplicateImages plugin with using batch progress dialog. (Gilles) Added threading support in CDArchiving, ImagesGallery, and SendImages plugins. (Gilles) Fixed menu action in according with current selection on host apps. (Gilles) Fixed plugins menu icons rendering in the host apps. (Gilles) Added namespace for all plugins (Gilles). Specific plugin tasks GalleryExport : New plugin for remote Gallery export. (Renchi) SendImages : Thunderbird binary file name option. (Gilles) Added Exif data restoring in ImageGallery and SendImages plugins. (Gilles) Added support of ImageCollectionSelector widget in FindDuplicateImage plugin. (Gilles) ImageGallery : Support new ImageCollectionSelector Widget. (Renchi and Aurélien) CDArchiving : Support new ImageCollectionSelector Widget. (Gilles) BatchProcessImages : Fixed bug #89720. (Gilles) SendImages : Fixed bug #87188. (Gilles) JPEGLossLess : option for rotate according to the EXIF orientation. (Ralf) JPEGLossLess : Improved rotation/flipping based on EXIF orientation tag. (Ralf) JPEGLossLess : support libexif 0.6.x. (Ralf) SlideShow : Exif auto-rotate. (Ralf) New plugin 'TimeAdjust'. (Jesper) SlideShow : added spacebar interruption. Fixed timer implementations (Joern) SlideShow : fixed OpenGl dependencies. (Renchi) SlideShow : ported to imlib2. (Renchi) PrintWizard : Thumbnail layouts added to Letter, A4 and A6: 20 per sheet and smaller, 30 per sheet. (Tood) PrintWizard : Added captions (filenames only, for now) to lower left of images. (Tood) Fixed time adjustment implementation in BatchRenameImages plugin. (Gilles) Bug #89541 : fixed threading implementation in CDArchiving and ImageGallery. (Gilles) Bug #88939 : fixed resize image operations in ImageGallery plugin. (Gilles) Added Exif informations support for resized JPEG images in Imagegallery and SendImages plugins. (Gilles)

Wishlists (mostly for Post 0.1.0 release)

Library core Completed and fixed Doxygen documentation. Common plugins tasks Full plugins handbooks (need contributors). Specific plugin tasks MPEGEncoder : add image file name in MPEG slideshow. MPEGEncoder : add target video preview. MPEGEncoder : new encoder core using C++ implementation. CDArchiving : add DVD 9Gb support. PrintWizard : add font face and size options. (Tood) PrintWizard : add a black border around white lettering, so it will be visible for all photos. (Tood) PrintWizard : possibly add a font color option. (Tood) PrintWizard : replace the thumbnail code, so the preview is faster. (Tood) PrintWizard : add option to print comments if available on the image. (Tood) PrintWizard : add more photo sizes and paper sizes. (Tood)

[ Edit ]