From 1e67e8ef9e12b0498658513b4654bcb5e77a4bf1 Mon Sep 17 00:00:00 2001 From: James Zern Date: Sat, 16 Mar 2013 12:35:49 -0700 Subject: [PATCH] README updates * build related notes * merge vwebp descriptions * miscellaneous cosmetics Change-Id: Ic4e580127bd2c4dff8e5a81ccb10b15a3568f8b1 --- README | 16 ++++++++-------- README.mux | 37 +++++++++++++------------------------ 2 files changed, 21 insertions(+), 32 deletions(-) diff --git a/README b/README index 3bfccff9..c70d234b 100644 --- a/README +++ b/README @@ -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 is supplied, as this is a simple alternative to the full installation 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: --------------------- @@ -71,10 +71,11 @@ should be all you need to have the following files installed. -Note: The encoding and decoding libraries are compiled separately -(as src/dec/libwebpdecode.* and src/dec/libwebpencode.*). They -can be installed independently using a minor modification in the -corresponding Makefile.am configure files (see comments there). +Note: A decode-only library, libwebpdecoder, is available using the +'--enable-libwebpdecoder' flag. The encode library is built separately and can +be installed independently using a minor modification in the corresponding +Makefile.am configure files (see comments there). See './configure --help' for +more options. SWIG bindings: -------------- @@ -263,9 +264,8 @@ Visualization tool: 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 -a decoded WebP file. It's not yet integrated in the automake or makefile.unix -build system, but you can try to manually compile it using the recommendations -at the top of the source file. +a decoded WebP file. It's not yet integrated in the automake build system, but +you can try to manually compile it using the recommendations below. Usage: vwebp in_file [options] diff --git a/README.mux b/README.mux index 3c58c56c..a1491bb9 100644 --- a/README.mux +++ b/README.mux @@ -9,9 +9,9 @@ Description: WebPMux: set of two libraries 'Mux' and 'Demux' for creation, extraction and manipulation of an extended format WebP file, which can have features like -color profile, metadata, animation and fragmented images. Reference -command-line tools 'webpmux' and 'vwebp' as well as the WebP container -specification 'doc/webp-container-spec.txt' are also provided in this package. +color profile, metadata and animation. Reference command-line tools 'webpmux' +and 'vwebp' as well as the WebP container specification +'doc/webp-container-spec.txt' are also provided in this package. WebP Mux tool: ============== @@ -45,7 +45,7 @@ SET_OPTIONS: exif file.exif Set EXIF metadata. xmp file.xmp Set XMP metadata. 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 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 valid. -WebP viewer tool: -================ +Visualization tool: +=================== The examples/ directory also contains a tool (vwebp) for viewing WebP files. -It decodes the image and visualizes it using OpenGL. - -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. +It decodes the image and visualizes it using OpenGL. See the libwebp README +for details on building and running this program. Mux API: ======== 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 -and fragmented images. Other features may be added in subsequent releases. +files. This API currently supports XMP/EXIF metadata, ICC profile and animation. +Other features may be added in subsequent releases. Example#1 (pseudo code): Creating a WebPMux object with image data, color profile and XMP metadata. @@ -137,11 +126,11 @@ For a detailed Mux API reference, please refer to the header file (src/webp/mux.h). Demux API: -========= +========== The Demux API enables extraction of images and extended format data from WebP files. This API currently supports reading of XMP/EXIF metadata, ICC -profile, animation and fragmented images. Other features may be added in -subsequent releases. +profile and animated images. Other features may be added in subsequent +releases. Code Example: Demuxing WebP data to extract all the frames, ICC profile and EXIF/XMP metadata.