webpmux.1 (6877B)
1 .\" Hey, EMACS: -*- nroff -*- 2 .TH WEBPMUX 1 "July 18, 2024" 3 .SH NAME 4 webpmux \- create animated WebP files from non\-animated WebP images, extract 5 frames from animated WebP images, and manage XMP/EXIF metadata and ICC profile. 6 .SH SYNOPSIS 7 .B webpmux \-get 8 .I GET_OPTIONS 9 .I INPUT 10 .B \-o 11 .I OUTPUT 12 .br 13 .B webpmux \-set 14 .I SET_OPTIONS 15 .I INPUT 16 .B \-o 17 .I OUTPUT 18 .br 19 .B webpmux \-strip 20 .I STRIP_OPTIONS 21 .I INPUT 22 .B \-o 23 .I OUTPUT 24 .br 25 .B webpmux \-frame 26 .I FRAME_OPTIONS 27 .B [ \-frame ... ] [ \-loop 28 .I LOOP_COUNT 29 .B ] 30 .br 31 .RS 8 32 .B [ \-bgcolor 33 .I BACKGROUND_COLOR 34 .B ] \-o 35 .I OUTPUT 36 .RE 37 .br 38 .B webpmux \-duration 39 .I DURATION OPTIONS 40 .B [ \-duration ... ] 41 .I INPUT 42 .B \-o 43 .I OUTPUT 44 .br 45 .B webpmux \-info 46 .I INPUT 47 .br 48 .B webpmux [\-h|\-help] 49 .br 50 .B webpmux \-version 51 .br 52 .B webpmux argument_file_name 53 .SH DESCRIPTION 54 This manual page documents the 55 .B webpmux 56 command. 57 .PP 58 \fBwebpmux\fP can be used to create/extract from animated WebP files, as well as 59 to add/extract/strip XMP/EXIF metadata and ICC profile. 60 If a single file name (not starting with the character '\-') is supplied as 61 the argument, the command line arguments are actually tokenized from this file. 62 This allows for easy scripting or using a large number of arguments. 63 .SH OPTIONS 64 .SS GET_OPTIONS (\-get): 65 .TP 66 .B icc 67 Get ICC profile. 68 .TP 69 .B exif 70 Get EXIF metadata. 71 .TP 72 .B xmp 73 Get XMP metadata. 74 .TP 75 .BI frame " n 76 Get nth frame from an animated image. (n = 0 has a special meaning: last frame). 77 78 .SS SET_OPTIONS (\-set) 79 .TP 80 .BI loop " loop_count 81 Set loop count on an animated file. 82 .P 83 Where: 'loop_count' must be in range [0, 65535]. 84 .TP 85 .BI bgcolor " A,R,G,B 86 Set the background color of the canvas on an animated file. 87 .P 88 where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the 89 Alpha, Red, Green and Blue component values respectively. 90 .TP 91 .BI icc " file.icc 92 Set ICC profile. 93 .P 94 Where: 'file.icc' contains the ICC profile to be set. 95 .TP 96 .BI exif " file.exif 97 Set EXIF metadata. 98 .P 99 Where: 'file.exif' contains the EXIF metadata to be set. 100 .TP 101 .BI xmp " file.xmp 102 Set XMP metadata. 103 .P 104 Where: 'file.xmp' contains the XMP metadata to be set. 105 106 .SS STRIP_OPTIONS (\-strip) 107 .TP 108 .B icc 109 Strip ICC profile. 110 .TP 111 .B exif 112 Strip EXIF metadata. 113 .TP 114 .B xmp 115 Strip XMP metadata. 116 117 .SS DURATION_OPTIONS (\-duration) 118 Amend the duration of a specific interval of frames. This option is only 119 effective on animated WebP and has no effect on a single-frame file. 120 .TP 121 .I duration[,start[,end]] 122 Where: 123 .br 124 .B duration 125 is the duration for the interval in milliseconds (mandatory). 126 Must be non-negative. 127 .br 128 .B start 129 is the starting frame index of the interval (optional). 130 .br 131 .B end 132 is the ending frame index (inclusive) of the interval (optional). 133 .TP 134 The three typical usages of this option are: 135 .br 136 .B -duration d 137 set the duration to 'd' for the whole animation. 138 .br 139 .B -duration d,f 140 set the duration of frame 'f' to 'd'. 141 .br 142 .B -duration d,start,end 143 set the duration to 'd' for the whole [start,end] interval. 144 .TP 145 .P 146 Note that the frames outside of the [start, end] interval will remain untouched. 147 The 'end' value '0' has the special meaning 'last frame of the animation'. 148 .TP 149 .I Reminder: 150 frame indexing starts at '1'. 151 .br 152 153 .SS FRAME_OPTIONS (\-frame) 154 Create an animated WebP file from multiple (non\-animated) WebP images. 155 .TP 156 .I file_i +di[+xi+yi[+mi[bi]]] 157 Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' specify the image 158 offset for this frame, 'di' is the pause duration before next frame, 'mi' is 159 the dispose method for this frame (0 for NONE or 1 for BACKGROUND) and 'bi' is 160 the blending method for this frame (+b for BLEND or \-b for NO_BLEND). 161 Argument 'bi' can be omitted and will default to +b (BLEND). 162 Also, 'mi' can be omitted if 'bi' is omitted and will default to 0 (NONE). 163 Finally, if 'mi' and 'bi' are omitted then 'xi' and 'yi' can be omitted and will 164 default to +0+0. 165 .TP 166 .BI \-loop " n 167 Loop the frames n number of times. 0 indicates the frames should loop forever. 168 Valid range is 0 to 65535 [Default: 0 (infinite)]. 169 .TP 170 .BI \-bgcolor " A,R,G,B 171 Background color of the canvas. 172 .br 173 where: 'A', 'R', 'G' and 'B' are integers in the range 0 to 255 specifying the 174 Alpha, Red, Green and Blue component values respectively 175 [Default: 255,255,255,255]. 176 177 .SS INPUT 178 .TP 179 Input file in WebP format. 180 181 .SS OUTPUT (\-o) 182 .TP 183 Output file in WebP format. 184 185 .SS Note: 186 .TP 187 The nature of EXIF, XMP and ICC data is not checked and is assumed to be valid. 188 189 .SH EXIT STATUS 190 If there were no problems during execution, \fBwebpmux\fP exits with the value 191 of the C constant \fBEXIT_SUCCESS\fP. This is usually zero. 192 .PP 193 If an error occurs, \fBwebpmux\fP exits with the value of the C constant 194 \fBEXIT_FAILURE\fP. This is usually one. 195 196 .SH EXAMPLES 197 .P 198 Add ICC profile: 199 .br 200 webpmux \-set icc image_profile.icc in.webp \-o icc_container.webp 201 .P 202 Extract ICC profile: 203 .br 204 webpmux \-get icc icc_container.webp \-o image_profile.icc 205 .P 206 Strip ICC profile: 207 .br 208 webpmux \-strip icc icc_container.webp \-o without_icc.webp 209 .P 210 Add XMP metadata: 211 .br 212 webpmux \-set xmp image_metadata.xmp in.webp \-o xmp_container.webp 213 .P 214 Extract XMP metadata: 215 .br 216 webpmux \-get xmp xmp_container.webp \-o image_metadata.xmp 217 .P 218 Strip XMP metadata: 219 .br 220 webpmux \-strip xmp xmp_container.webp \-o without_xmp.webp 221 .P 222 Add EXIF metadata: 223 .br 224 webpmux \-set exif image_metadata.exif in.webp \-o exif_container.webp 225 .P 226 Extract EXIF metadata: 227 .br 228 webpmux \-get exif exif_container.webp \-o image_metadata.exif 229 .P 230 Strip EXIF metadata: 231 .br 232 webpmux \-strip exif exif_container.webp \-o without_exif.webp 233 .P 234 Create an animated WebP file from 3 (non\-animated) WebP images: 235 .br 236 webpmux \-frame 1.webp +100 \-frame 2.webp +100+50+50 237 .br 238 .RS 8 239 \-frame 3.webp +100+50+50+1+b \-loop 10 \-bgcolor 255,255,255,255 240 .br 241 \-o anim_container.webp 242 .RE 243 .P 244 Get the 2nd frame from an animated WebP file: 245 .br 246 webpmux \-get frame 2 anim_container.webp \-o frame_2.webp 247 .P 248 Using \-get/\-set/\-strip with input file name starting with '\-': 249 .br 250 webpmux \-set icc image_profile.icc \-o icc_container.webp \-\- \-\-\-in.webp 251 .br 252 webpmux \-get icc \-o image_profile.icc \-\- \-\-\-icc_container.webp 253 .br 254 webpmux \-strip icc \-o without_icc.webp \-\- \-\-\-icc_container.webp 255 256 .SH AUTHORS 257 \fBwebpmux\fP is a part of libwebp and was written by the WebP team. 258 .br 259 The latest source tree is available at 260 https://chromium.googlesource.com/webm/libwebp 261 .PP 262 This manual page was written by Vikas Arora <vikaas.arora@gmail.com>, 263 for the Debian project (and may be used by others). 264 265 .SH REPORTING BUGS 266 Please report all bugs to the issue tracker: 267 https://issues.webmproject.org 268 .br 269 Patches welcome! See this page to get started: 270 https://www.webmproject.org/code/contribute/submitting\-patches/ 271 272 .SH SEE ALSO 273 .BR cwebp (1), 274 .BR dwebp (1), 275 .BR gif2webp (1) 276 .br 277 Please refer to https://developers.google.com/speed/webp/ for additional 278 information.