You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

README 3.3KB


LiquidRescale library
=====================

Table of contents
-----------------
* Introduction
+ Library features
* Installation
+ Requirements
+ Normal setup
* Using the library
* References
* Copyright


+ Introduction
--------------

The LiquidRescale (lqr) library provides a C/C++ API for
performing non-uniform resizing of images by the seam-carving
technique.

++ Library features

The library takes images in plain array format as input
and converts them to a multi-size representation.
Following is a list of features:

* Easy to use API
* Areas in the image can be marked for preservation or
discard
* Once the image has been fully processed, the scaling can
be done in real-time. In fact, the information can be saved
and read out later without any further processing
* The resizing is done with a single function which
automatically performs all the necessary operations; it
can also work in successive steps without wasting
computational time
* Possibility to tune the carving operation by letting the
seams be less connected, or more rigid, or both
* Can export and import the visibility map (the seams)
* Other images can be attached and undergo the same carving
process as the parent image
* The automatic feature detection algorithm can be tuned
by selecting among different energy gradient functions
* Reports progress through a customizable interface
* A signalling system permits to cleanly handle errors



+ Installation
--------------

++ Requirements

The lqr library requires the glib-2.0 libraries

++ Normal setup

The build package uses autotools and libtool, so the installation
commands on Unix systems are simply

./configure --prefix=/usr && make && sudo make install

The last step requires administrative privileges.
(If the dynamic linker path includes /usr/local/lib, the --prefix
option is not needed.)

See the INSTALL file for a full description.



+ Using the library
------------------------

In order to use the library functions and structures from
a C or C++ program, you have to add this include line in
your program:

#include <lqr.h>

At compile time, you can take advantage of pkg-config to set
the proper flags.

In the `examples' directory you can find a basic example program,
`liquidrescale-basic', and a full-featured demo program,
`liquidrescale', toghether with a simple Makefile. Both
programs are fully commented.

The "basic" version demonstrates how to use the strictly-needed
library functions, while the full version uses almost all of the
API methods provided. The Makefile shows how to set the compilation
flags.

See the README file in that directory for more information.

The complete description of the library functions, together with
some additional notes, can be found in the `docs' directory in
docbook format. The makefile in that directory (hopefully)
generates the html version, using docbook2html;
you'll find the index named after `liblqr_manual_index.html'



+ References
------------

The library implements the algorithm described in the paper
"Seam Carving for Content-Aware Image Resizing"
by Shai Avidan and Ariel Shamir, which can be found at
http://www.faculty.idc.ac.il/arik/imret.pdf



+ Copyright
-----------

Copyright (C) 2007 Carlo Baldassi <carlobaldassi@gmail.com>