1WEBPMUX(1)                  General Commands Manual                 WEBPMUX(1)
2
3
4

NAME

6       webpmux - create animated WebP files from non-animated WebP images, ex‐
7       tract frames from animated WebP images, and  manage  XMP/EXIF  metadata
8       and ICC profile.
9

SYNOPSIS

11       webpmux -get GET_OPTIONS INPUT -o OUTPUT
12       webpmux -set SET_OPTIONS INPUT -o OUTPUT
13       webpmux -strip STRIP_OPTIONS INPUT -o OUTPUT
14       webpmux -frame FRAME_OPTIONS [ -frame ... ] [ -loop LOOP_COUNT ]
15               [ -bgcolor BACKGROUND_COLOR ] -o OUTPUT
16       webpmux -duration DURATION OPTIONS [ -duration ... ] INPUT -o OUTPUT
17       webpmux -info INPUT
18       webpmux [-h|-help]
19       webpmux -version
20       webpmux argument_file_name
21

DESCRIPTION

23       This manual page documents the webpmux command.
24
25       webpmux can be used to create/extract from animated WebP files, as well
26       as to add/extract/strip XMP/EXIF metadata and ICC profile.  If a single
27       file  name (not starting with the character '-') is supplied as the ar‐
28       gument, the command line arguments are  actually  tokenized  from  this
29       file.   This allows for easy scripting or using a large number of argu‐
30       ments.
31

OPTIONS

33   GET_OPTIONS (-get):
34       icc    Get ICC profile.
35
36       exif   Get EXIF metadata.
37
38       xmp    Get XMP metadata.
39
40       frame n
41              Get nth frame from an animated image. (n = 0 has a special mean‐
42              ing: last frame).
43
44
45   SET_OPTIONS (-set)
46       loop loop_count
47              Set loop count on an animated file.
48
49       Where: 'loop_count' must be in range [0, 65535].
50
51       bgcolor A,R,G,B
52              Set the background color of the canvas on an animated file.
53
54       where:  'A', 'R', 'G' and 'B' are integers in the range 0 to 255 speci‐
55       fying the Alpha, Red, Green and Blue component values respectively.
56
57       icc file.icc
58              Set ICC profile.
59
60       Where: 'file.icc' contains the ICC profile to be set.
61
62       exif file.exif
63              Set EXIF metadata.
64
65       Where: 'file.exif' contains the EXIF metadata to be set.
66
67       xmp file.xmp
68              Set XMP metadata.
69
70       Where: 'file.xmp' contains the XMP metadata to be set.
71
72
73   STRIP_OPTIONS (-strip)
74       icc    Strip ICC profile.
75
76       exif   Strip EXIF metadata.
77
78       xmp    Strip XMP metadata.
79
80
81   DURATION_OPTIONS (-duration)
82       Amend the duration of a specific interval of  frames.  This  option  is
83       only  effective  on  animated  WebP and has no effect on a single-frame
84       file.
85
86       duration[,start[,end]]
87              Where:
88              duration is  the  duration  for  the  interval  in  milliseconds
89              (mandatory).  Must be non-negative.
90              start is the starting frame index of the interval (optional).
91              end  is  the ending frame index (inclusive) of the interval (op‐
92              tional).
93
94       The three typical usages of this option are:
95              -duration d
96                   set the duration to 'd' for the whole animation.
97              -duration d,f
98                   set the duration of frame 'f' to 'd'.
99              -duration d,start,end
100                   set the duration to 'd' for the whole [start,end] interval.
101
102
103              Note that the frames outside of the [start, end]  interval  will
104              remain untouched.
105              The  'end'  value '0' has the special meaning 'last frame of the
106              animation'.
107
108       Reminder:
109              frame indexing starts at '1'.
110
111
112   FRAME_OPTIONS (-frame)
113       Create an animated WebP file from multiple (non-animated) WebP images.
114
115       file_i +di[+xi+yi[+mi[bi]]]
116              Where: 'file_i' is the i'th frame (WebP format), 'xi','yi' spec‐
117              ify  the image offset for this frame, 'di' is the pause duration
118              before next frame, 'mi' is the dispose method for this frame  (0
119              for  NONE  or  1 for BACKGROUND) and 'bi' is the blending method
120              for this frame (+b for BLEND or -b for NO_BLEND).  Argument 'bi'
121              can  be  omitted and will default to +b (BLEND).  Also, 'mi' can
122              be omitted if 'bi' is omitted and will default to 0 (NONE).  Fi‐
123              nally,  if  'mi'  and 'bi' are omitted then 'xi' and 'yi' can be
124              omitted and will default to +0+0.
125
126       -loop n
127              Loop the frames n number of times. 0 indicates the frames should
128              loop  forever.   Valid  range  is  0 to 65535 [Default: 0 (infi‐
129              nite)].
130
131       -bgcolor A,R,G,B
132              Background color of the canvas.
133              where: 'A', 'R', 'G' and 'B' are integers in the range 0 to  255
134              specifying  the  Alpha, Red, Green and Blue component values re‐
135              spectively [Default: 255,255,255,255].
136
137
138   INPUT
139       Input file in WebP format.
140
141
142   OUTPUT (-o)
143       Output file in WebP format.
144
145
146   Note:
147       The nature of EXIF, XMP and ICC data is not checked and is  assumed  to
148       be valid.
149
150

BUGS

152       Please     report     all     bugs     to     the     issue    tracker:
153       https://bugs.chromium.org/p/webp
154       Patches welcome! See this page  to  get  started:  https://www.webmpro
155       ject.org/code/contribute/submitting-patches/
156
157

EXAMPLES

159       Add ICC profile:
160       webpmux -set icc image_profile.icc in.webp -o icc_container.webp
161
162       Extract ICC profile:
163       webpmux -get icc icc_container.webp -o image_profile.icc
164
165       Strip ICC profile:
166       webpmux -strip icc icc_container.webp -o without_icc.webp
167
168       Add XMP metadata:
169       webpmux -set xmp image_metadata.xmp in.webp -o xmp_container.webp
170
171       Extract XMP metadata:
172       webpmux -get xmp xmp_container.webp -o image_metadata.xmp
173
174       Strip XMP metadata:
175       webpmux -strip xmp xmp_container.webp -o without_xmp.webp
176
177       Add EXIF metadata:
178       webpmux -set exif image_metadata.exif in.webp -o exif_container.webp
179
180       Extract EXIF metadata:
181       webpmux -get exif exif_container.webp -o image_metadata.exif
182
183       Strip EXIF metadata:
184       webpmux -strip exif exif_container.webp -o without_exif.webp
185
186       Create an animated WebP file from 3 (non-animated) WebP images:
187       webpmux -frame 1.webp +100 -frame 2.webp +100+50+50
188               -frame 3.webp +100+50+50+1+b -loop 10 -bgcolor 255,255,255,255
189               -o anim_container.webp
190
191       Get the 2nd frame from an animated WebP file:
192       webpmux -get frame 2 anim_container.webp -o frame_2.webp
193
194       Using -get/-set/-strip with input file name starting with '-':
195       webpmux -set icc image_profile.icc -o icc_container.webp -- ---in.webp
196       webpmux -get icc -o image_profile.icc -- ---icc_container.webp
197       webpmux -strip icc -o without_icc.webp -- ---icc_container.webp
198
199

AUTHORS

201       webpmux is a part of libwebp and was written by the WebP team.
202       The   latest  source  tree  is  available  at  https://chromium.google
203       source.com/webm/libwebp
204
205       This manual page was written by Vikas  Arora  <vikaas.arora@gmail.com>,
206       for the Debian project (and may be used by others).
207
208

SEE ALSO

210       cwebp(1), dwebp(1), gif2webp(1)
211       Please  refer  to  https://developers.google.com/speed/webp/  for addi‐
212       tional information.
213
214
215
216                               November 17, 2021                    WEBPMUX(1)
Impressum