Merge "README updates" into 0.3.0

This commit is contained in:
pascal massimino 2013-03-17 02:40:44 -07:00 committed by Gerrit Code Review
commit 7d9fdc2389
2 changed files with 21 additions and 32 deletions

16
README
View File

@ -49,7 +49,7 @@ will build the binaries examples/cwebp and examples/dwebp, along
with the static library src/libwebp.a. No system-wide installation with the static library src/libwebp.a. No system-wide installation
is supplied, as this is a simple alternative to the full installation is supplied, as this is a simple alternative to the full installation
system based on the autoconf tools (see below). system based on the autoconf tools (see below).
Please refer to the makefile.unix for additional details and customizations. Please refer to makefile.unix for additional details and customizations.
Using autoconf tools: Using autoconf tools:
--------------------- ---------------------
@ -71,10 +71,11 @@ should be all you need to have the following files
installed. installed.
Note: The encoding and decoding libraries are compiled separately Note: A decode-only library, libwebpdecoder, is available using the
(as src/dec/libwebpdecode.* and src/dec/libwebpencode.*). They '--enable-libwebpdecoder' flag. The encode library is built separately and can
can be installed independently using a minor modification in the be installed independently using a minor modification in the corresponding
corresponding Makefile.am configure files (see comments there). Makefile.am configure files (see comments there). See './configure --help' for
more options.
SWIG bindings: SWIG bindings:
-------------- --------------
@ -263,9 +264,8 @@ Visualization tool:
There's a little self-serve visualization tool called 'vwebp' under the There's a little self-serve visualization tool called 'vwebp' under the
examples/ directory. It uses OpenGL to open a simple drawing window and show examples/ directory. It uses OpenGL to open a simple drawing window and show
a decoded WebP file. It's not yet integrated in the automake or makefile.unix a decoded WebP file. It's not yet integrated in the automake build system, but
build system, but you can try to manually compile it using the recommendations you can try to manually compile it using the recommendations below.
at the top of the source file.
Usage: vwebp in_file [options] Usage: vwebp in_file [options]

View File

@ -9,9 +9,9 @@ Description:
WebPMux: set of two libraries 'Mux' and 'Demux' for creation, extraction and WebPMux: set of two libraries 'Mux' and 'Demux' for creation, extraction and
manipulation of an extended format WebP file, which can have features like manipulation of an extended format WebP file, which can have features like
color profile, metadata, animation and fragmented images. Reference color profile, metadata and animation. Reference command-line tools 'webpmux'
command-line tools 'webpmux' and 'vwebp' as well as the WebP container and 'vwebp' as well as the WebP container specification
specification 'doc/webp-container-spec.txt' are also provided in this package. 'doc/webp-container-spec.txt' are also provided in this package.
WebP Mux tool: WebP Mux tool:
============== ==============
@ -45,7 +45,7 @@ SET_OPTIONS:
exif file.exif Set EXIF metadata. exif file.exif Set EXIF metadata.
xmp file.xmp Set XMP metadata. xmp file.xmp Set XMP metadata.
where: 'file.icc' contains the ICC profile to be set, where: 'file.icc' contains the ICC profile to be set,
'file.exif' contains the EXIF metadata to be set and 'file.exif' contains the EXIF metadata to be set
'file.xmp' contains the XMP metadata to be set 'file.xmp' contains the XMP metadata to be set
STRIP_OPTIONS: STRIP_OPTIONS:
@ -78,29 +78,18 @@ INPUT & OUTPUT are in WebP format.
Note: The nature of EXIF, XMP and ICC data is not checked and is assumed to be Note: The nature of EXIF, XMP and ICC data is not checked and is assumed to be
valid. valid.
WebP viewer tool: Visualization tool:
================ ===================
The examples/ directory also contains a tool (vwebp) for viewing WebP files. The examples/ directory also contains a tool (vwebp) for viewing WebP files.
It decodes the image and visualizes it using OpenGL. It decodes the image and visualizes it using OpenGL. See the libwebp README
for details on building and running this program.
A list of options is available using the -h command line flag:
> vwebp -h
Decodes the WebP image file and visualize it using OpenGL
Options are:
-version .... print version number and exit.
-nofancy ..... don't use the fancy YUV420 upscaler.
-nofilter .... disable in-loop filtering.
-mt .......... use multi-threading
-info ........ print info.
-h ....... this help message.
Mux API: Mux API:
======== ========
The Mux API contains methods for adding data to and reading data from WebP The Mux API contains methods for adding data to and reading data from WebP
files. This API currently supports XMP/EXIF metadata, ICC profile, animation files. This API currently supports XMP/EXIF metadata, ICC profile and animation.
and fragmented images. Other features may be added in subsequent releases. Other features may be added in subsequent releases.
Example#1 (pseudo code): Creating a WebPMux object with image data, color Example#1 (pseudo code): Creating a WebPMux object with image data, color
profile and XMP metadata. profile and XMP metadata.
@ -137,11 +126,11 @@ For a detailed Mux API reference, please refer to the header file
(src/webp/mux.h). (src/webp/mux.h).
Demux API: Demux API:
========= ==========
The Demux API enables extraction of images and extended format data from The Demux API enables extraction of images and extended format data from
WebP files. This API currently supports reading of XMP/EXIF metadata, ICC WebP files. This API currently supports reading of XMP/EXIF metadata, ICC
profile, animation and fragmented images. Other features may be added in profile and animated images. Other features may be added in subsequent
subsequent releases. releases.
Code Example: Demuxing WebP data to extract all the frames, ICC profile Code Example: Demuxing WebP data to extract all the frames, ICC profile
and EXIF/XMP metadata. and EXIF/XMP metadata.