ViewVC Help
View File | Revision Log | Show Annotations | Download File
/cvs/rxvt-unicode/src/perl/background
(Generate patch)

Comparing rxvt-unicode/src/perl/background (file contents):
Revision 1.38 by root, Fri Jun 8 21:48:07 2012 UTC vs.
Revision 1.79 by root, Tue Sep 4 22:41:11 2012 UTC

1#! perl 1#! perl
2 2
3#:META:X_RESOURCE:%.expr:string:background expression 3#:META:X_RESOURCE:%.expr:string:background expression
4#:META:X_RESOURCE:%.border.:boolean:respect the terminal border 4#:META:X_RESOURCE:%.border:boolean:respect the terminal border
5#:META:X_RESOURCE:%.interval:seconds:minimum time between updates
5 6
6#TODO: once, rootalign 7=head1 NAME
7 8
8=head1 background - manage terminal background 9background - manage terminal background
9 10
10=head2 SYNOPSIS 11=head1 SYNOPSIS
11 12
12 urxvt --background-expr 'background expression' 13 urxvt --background-expr 'background expression'
13 --background-border 14 --background-border
15 --background-interval seconds
14 16
17=head1 QUICK AND DIRTY CHEAT SHEET
18
19Just load a random jpeg image and tile the background with it without
20scaling or anything else:
21
22 load "/path/to/img.jpg"
23
24The same, but use mirroring/reflection instead of tiling:
25
26 mirror load "/path/to/img.jpg"
27
28Load an image and scale it to exactly fill the terminal window:
29
30 scale keep { load "/path/to/img.jpg" }
31
32Implement pseudo-transparency by using a suitably-aligned root pixmap
33as window background:
34
35 rootalign root
36
37Likewise, but keep a blurred copy:
38
39 rootalign keep { blur 10, root }
40
15=head2 DESCRIPTION 41=head1 DESCRIPTION
16 42
17This extension manages the terminal background by creating a picture that 43This extension manages the terminal background by creating a picture that
18is behind the text, replacing the normal background colour. 44is behind the text, replacing the normal background colour.
19 45
20It does so by evaluating a Perl expression that I<calculates> the image on 46It does so by evaluating a Perl expression that I<calculates> the image on
24to be as simple as possible. 50to be as simple as possible.
25 51
26For example, to load an image and scale it to the window size, you would 52For example, to load an image and scale it to the window size, you would
27use: 53use:
28 54
29 urxvt --background-expr 'scale load "/path/to/mybg.png"' 55 urxvt --background-expr 'scale keep { load "/path/to/mybg.png" }'
30 56
31Or specified as a X resource: 57Or specified as a X resource:
32 58
33 URxvt.background-expr: scale load "/path/to/mybg.png" 59 URxvt.background-expr: scale keep { load "/path/to/mybg.png" }
34 60
35=head2 THEORY OF OPERATION 61=head1 THEORY OF OPERATION
36 62
37At startup, just before the window is mapped for the first time, the 63At startup, just before the window is mapped for the first time, the
38expression is evaluated and must yield an image. The image is then 64expression is evaluated and must yield an image. The image is then
39extended as necessary to cover the whole terminal window, and is set as a 65extended as necessary to cover the whole terminal window, and is set as a
40background pixmap. 66background pixmap.
51If any of the parameters that the expression relies on changes (when the 77If any of the parameters that the expression relies on changes (when the
52window is moved or resized, its position or size changes; when the root 78window is moved or resized, its position or size changes; when the root
53pixmap is replaced by another one the root background changes; or when the 79pixmap is replaced by another one the root background changes; or when the
54timer elapses), then the expression will be evaluated again. 80timer elapses), then the expression will be evaluated again.
55 81
56For example, an expression such as C<scale load "$HOME/mybg.png"> scales the 82For example, an expression such as C<scale keep { load "$HOME/mybg.png"
57image to the window size, so it relies on the window size and will 83}> scales the image to the window size, so it relies on the window size
58be reevaluated each time it is changed, but not when it moves for 84and will be reevaluated each time it is changed, but not when it moves for
59example. That ensures that the picture always fills the terminal, even 85example. That ensures that the picture always fills the terminal, even
60after it's size changes. 86after its size changes.
61 87
62=head3 EXPRESSIONS 88=head2 EXPRESSIONS
63 89
64Expressions are normal Perl expressions, in fact, they are Perl blocks - 90Expressions are normal Perl expressions, in fact, they are Perl blocks -
65which means you could use multiple lines and statements: 91which means you could use multiple lines and statements:
66 92
93 scale keep {
67 again 3600; 94 again 3600;
68 if (localtime now)[6]) { 95 if (localtime now)[6]) {
69 return scale load "$HOME/weekday.png"; 96 return load "$HOME/weekday.png";
70 } else { 97 } else {
71 return scale load "$HOME/sunday.png"; 98 return load "$HOME/sunday.png";
99 }
72 } 100 }
73 101
74This expression gets evaluated once per hour. It will set F<sunday.png> as 102This inner expression is evaluated once per hour (and whenever the
103terminal window is resized). It sets F<sunday.png> as background on
75background on sundays, and F<weekday.png> on all other days. 104Sundays, and F<weekday.png> on all other days.
76 105
77Fortunately, we expect that most expressions will be much simpler, with 106Fortunately, we expect that most expressions will be much simpler, with
78little Perl knowledge needed. 107little Perl knowledge needed.
79 108
80Basically, you always start with a function that "generates" an image 109Basically, you always start with a function that "generates" an image
97its result becomes the argument to the C<scale> function. 126its result becomes the argument to the C<scale> function.
98 127
99Many operators also allow some parameters preceding the input image 128Many operators also allow some parameters preceding the input image
100that modify its behaviour. For example, C<scale> without any additional 129that modify its behaviour. For example, C<scale> without any additional
101arguments scales the image to size of the terminal window. If you specify 130arguments scales the image to size of the terminal window. If you specify
102an additional argument, it uses it as a percentage: 131an additional argument, it uses it as a scale factor (multiply by 100 to
132get a percentage):
103 133
104 scale 200, load "$HOME/mypic.png" 134 scale 2, load "$HOME/mypic.png"
105 135
106This enlarges the image by a factor of 2 (200%). As you can see, C<scale> 136This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
107has now two arguments, the C<200> and the C<load> expression, while 137has now two arguments, the C<200> and the C<load> expression, while
108C<load> only has one argument. Arguments are separated from each other by 138C<load> only has one argument. Arguments are separated from each other by
109commas. 139commas.
110 140
111Scale also accepts two arguments, which are then separate factors for both 141Scale also accepts two arguments, which are then separate factors for both
112horizontal and vertical dimensions. For example, this halves the image 142horizontal and vertical dimensions. For example, this halves the image
113width and doubles the image height: 143width and doubles the image height:
114 144
115 scale 50, 200, load "$HOME/mypic.png" 145 scale 0.5, 2, load "$HOME/mypic.png"
116 146
117TODO 147IF you try out these expressions, you might suffer from some sluggishness,
148because each time the terminal is resized, it loads the PNG image again
149and scales it. Scaling is usually fast (and unavoidable), but loading the
150image can be quite time consuming. This is where C<keep> comes in handy:
118 151
119=head3 CYCLES AND CACHING 152 scale 0.5, 2, keep { load "$HOME/mypic.png" }
120 153
121TODO 154The C<keep> operator executes all the statements inside the braces only
155once, or when it thinks the outcome might change. In other cases it
156returns the last value computed by the brace block.
122 157
123Each time the expression is reevaluated, a new cycle is said to have begun. Many operators 158This means that the C<load> is only executed once, which makes it much
124cache their results till the next cycle. For example 159faster, but also means that more memory is being used, because the loaded
160image must be kept in memory at all times. In this expression, the
161trade-off is likely worth it.
125 162
163But back to effects: Other effects than scaling are also readily
164available, for example, you can tile the image to fill the whole window,
165instead of resizing it:
166
167 tile keep { load "$HOME/mypic.png" }
168
169In fact, images returned by C<load> are in C<tile> mode by default, so the
170C<tile> operator is kind of superfluous.
171
172Another common effect is to mirror the image, so that the same edges
173touch:
174
175 mirror keep { load "$HOME/mypic.png" }
176
177Another common background expression is:
178
179 rootalign root
180
181This one first takes a snapshot of the screen background image, and then
182moves it to the upper left corner of the screen (as opposed to the upper
183left corner of the terminal window)- the result is pseudo-transparency:
184the image seems to be static while the window is moved around.
185
186=head2 COLOUR SPECIFICATIONS
187
188Whenever an operator expects a "colour", then this can be specified in one
189of two ways: Either as string with an X11 colour specification, such as:
190
191 "red" # named colour
192 "#f00" # simple rgb
193 "[50]red" # red with 50% alpha
194 "TekHVC:300/50/50" # anything goes
195
196OR as an array reference with one, three or four components:
197
198 [0.5] # 50% gray, 100% alpha
199 [0.5, 0, 0] # dark red, no green or blur, 100% alpha
200 [0.5, 0, 0, 0.7] # same with explicit 70% alpha
201
202=head2 CACHING AND SENSITIVITY
203
204Since some operations (such as C<load> and C<blur>) can take a long time,
205caching results can be very important for a smooth operation. Caching can
206also be useful to reduce memory usage, though, for example, when an image
207is cached by C<load>, it could be shared by multiple terminal windows
208running inside urxvtd.
209
210=head3 C<keep { ... }> caching
211
212The most important way to cache expensive operations is to use C<keep {
213... }>. The C<keep> operator takes a block of multiple statements enclosed
214by C<{}> and keeps the return value in memory.
215
216An expression can be "sensitive" to various external events, such as
217scaling or moving the window, root background changes and timers. Simply
218using an expression (such as C<scale> without parameters) that depends on
219certain changing values (called "variables"), or using those variables
220directly, will make an expression sensitive to these events - for example,
221using C<scale> or C<TW> will make the expression sensitive to the terminal
222size, and thus to resizing events.
223
224When such an event happens, C<keep> will automatically trigger a
225reevaluation of the whole expression with the new value of the expression.
226
227C<keep> is most useful for expensive operations, such as C<blur>:
228
229 rootalign keep { blur 20, root }
230
231This makes a blurred copy of the root background once, and on subsequent
232calls, just root-aligns it. Since C<blur> is usually quite slow and
233C<rootalign> is quite fast, this trades extra memory (for the cached
234blurred pixmap) with speed (blur only needs to be redone when root
235changes).
236
237=head3 C<load> caching
238
239The C<load> operator itself does not keep images in memory, but as long as
240the image is still in memory, C<load> will use the in-memory image instead
241of loading it freshly from disk.
242
243That means that this expression:
244
245 keep { load "$HOME/path..." }
246
247Not only caches the image in memory, other terminal instances that try to
248C<load> it can reuse that in-memory copy.
249
126=head2 REFERENCE 250=head1 REFERENCE
127 251
128=head3 COMMAND LINE SWITCHES 252=head2 COMMAND LINE SWITCHES
129 253
130=over 4 254=over 4
131 255
132=item --background-expr perl-expression 256=item --background-expr perl-expression
133 257
139overwriting borders and any other areas, such as the scrollbar. 263overwriting borders and any other areas, such as the scrollbar.
140 264
141Specifying this flag changes the behaviour, so that the image only 265Specifying this flag changes the behaviour, so that the image only
142replaces the background of the character area. 266replaces the background of the character area.
143 267
268=item --background-interval seconds
269
270Since some operations in the underlying XRender extension can effectively
271freeze your X-server for prolonged time, this extension enforces a minimum
272time between updates, which is normally about 0.1 seconds.
273
274If you want to do updates more often, you can decrease this safety
275interval with this switch.
276
144=back 277=back
145 278
146=cut 279=cut
147 280
148our $EXPR;#d# 281our %_IMG_CACHE;
149#$EXPR = 'move W * 0.1, -H * 0.1, resize W * 0.5, H * 0.5, repeat_none load "opensource.png"';
150$EXPR = 'move -TX, -TY, load "argb.png"';
151#$EXPR = '
152# rotate W, H, 50, 50, counter 1/59.95, repeat_mirror,
153# clip X, Y, W, H, repeat_mirror,
154# load "/root/pix/das_fette_schwein.jpg"
155#';
156#$EXPR = 'solid "red"';
157#$EXPR = 'blur root, 10, 10'
158#$EXPR = 'blur move (root, -x, -y), 5, 5'
159#resize load "/root/pix/das_fette_schwein.jpg", w, h
160
161our $HOME; 282our $HOME;
162our ($self, $old, $new); 283our ($self, $frame);
163our ($x, $y, $w, $h); 284our ($x, $y, $w, $h);
164 285
165# enforce at least this interval between updates 286# enforce at least this interval between updates
166our $MIN_INTERVAL = 1/100; 287our $MIN_INTERVAL = 6/59.951;
167 288
168{ 289{
169 package urxvt::bgdsl; # background language 290 package urxvt::bgdsl; # background language
291
292 sub FR_PARENT() { 0 } # parent frame, if any - must be #0
293 sub FR_CACHE () { 1 } # cached values
294 sub FR_AGAIN () { 2 } # what this expr is sensitive to
295 sub FR_STATE () { 3 } # watchers etc.
296
297 use List::Util qw(min max sum shuffle);
170 298
171=head2 PROVIDERS/GENERATORS 299=head2 PROVIDERS/GENERATORS
172 300
173These functions provide an image, by loading it from disk, grabbing it 301These functions provide an image, by loading it from disk, grabbing it
174from the root screen or by simply generating it. They are used as starting 302from the root screen or by simply generating it. They are used as starting
179=item load $path 307=item load $path
180 308
181Loads the image at the given C<$path>. The image is set to plane tiling 309Loads the image at the given C<$path>. The image is set to plane tiling
182mode. 310mode.
183 311
184Loaded images will be cached for one cycle. 312If the image is already in memory (e.g. because another terminal instance
313uses it), then the in-memory copy us returned instead.
185 314
315=item load_uc $path
316
317Load uncached - same as load, but does not cache the image, which means it
318is I<always> loaded from the filesystem again, even if another copy of it
319is in memory at the time.
320
186=cut 321=cut
322
323 sub load_uc($) {
324 $self->new_img_from_file ($_[0])
325 }
187 326
188 sub load($) { 327 sub load($) {
189 my ($path) = @_; 328 my ($path) = @_;
190 329
191 $new->{load}{$path} = $old->{load}{$path} || $self->new_img_from_file ($path); 330 $_IMG_CACHE{$path} || do {
331 my $img = load_uc $path;
332 Scalar::Util::weaken ($_IMG_CACHE{$path} = $img);
333 $img
334 }
192 } 335 }
193 336
194=item root 337=item root
195 338
196Returns the root window pixmap, that is, hopefully, the background image 339Returns the root window pixmap, that is, hopefully, the background image
197of your screen. The image is set to extend mode. 340of your screen.
198 341
199This function makes your expression root sensitive, that means it will be 342This function makes your expression root sensitive, that means it will be
200reevaluated when the bg image changes. 343reevaluated when the bg image changes.
201 344
202=cut 345=cut
203 346
204 sub root() { 347 sub root() {
205 $new->{rootpmap_sensitive} = 1; 348 $frame->[FR_AGAIN]{rootpmap} = 1;
206 die "root op not supported, exg, we need you"; 349 $self->new_img_from_root
207 } 350 }
208 351
209=item solid $colour 352=item solid $colour
210 353
211=item solid $width, $height, $colour 354=item solid $width, $height, $colour
212 355
213Creates a new image and completely fills it with the given colour. The 356Creates a new image and completely fills it with the given colour. The
214image is set to tiling mode. 357image is set to tiling mode.
215 358
216If <$width> and C<$height> are omitted, it creates a 1x1 image, which is 359If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
217useful for solid backgrounds or for use in filtering effects. 360useful for solid backgrounds or for use in filtering effects.
218 361
219=cut 362=cut
220 363
221 sub solid($$;$) { 364 sub solid($;$$) {
222 my $colour = pop; 365 my $colour = pop;
223 366
224 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); 367 my $img = $self->new_img (urxvt::PictStandardARGB32, 0, 0, $_[0] || 1, $_[1] || 1);
225 $img->fill ($colour); 368 $img->fill ($colour);
226 $img 369 $img
227 } 370 }
228 371
229=back 372=item clone $img
230 373
231=head2 VARIABLES 374Returns an exact copy of the image. This is useful if you want to have
375multiple copies of the same image to apply different effects to.
232 376
233The following functions provide variable data such as the terminal
234window dimensions. Most of them make your expression sensitive to some
235events, for example using C<TW> (terminal width) means your expression is
236evaluated again when the terminal is resized.
237
238=over 4
239
240=item TX
241
242=item TY
243
244Return the X and Y coordinates of the terminal window (the terminal
245window is the full window by default, and the character area only when in
246border-respect mode).
247
248Using these functions make your expression sensitive to window moves.
249
250These functions are mainly useful to align images to the root window.
251
252Example: load an image and align it so it looks as if anchored to the
253background.
254
255 move -TX, -TY, load "mybg.png"
256
257=item TW
258
259Return the width (C<TW>) and height (C<TH>) of the terminal window (the
260terminal window is the full window by default, and the character area only
261when in border-respect mode).
262
263Using these functions make your expression sensitive to window resizes.
264
265These functions are mainly useful to scale images, or to clip images to
266the window size to conserve memory.
267
268Example: take the screen background, clip it to the window size, blur it a
269bit, align it to the window position and use it as background.
270
271 clip move -TX, -TY, blur 5, root
272
273=cut 377=cut
274 378
275 sub TX() { $new->{position_sensitive} = 1; $x }
276 sub TY() { $new->{position_sensitive} = 1; $y }
277 sub TW() { $new->{size_sensitive} = 1; $w }
278 sub TH() { $new->{size_sensitive} = 1; $h }
279
280=item now
281
282Returns the current time as (fractional) seconds since the epoch.
283
284Using this expression does I<not> make your expression sensitive to time,
285but the next two functions do.
286
287=item again $seconds
288
289When this function is used the expression will be reevaluated again in
290C<$seconds> seconds.
291
292Example: load some image and rotate it according to the time of day (as if it were
293the hour pointer of a clock). Update this image every minute.
294
295 again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png"
296
297=item counter $seconds
298
299Like C<again>, but also returns an increasing counter value, starting at
3000, which might be useful for some simple animation effects.
301
302=cut
303
304 sub now() { urxvt::NOW }
305
306 sub again($) {
307 $new->{again} = $_[0];
308 }
309
310 sub counter($) { 379 sub clone($) {
311 $new->{again} = $_[0]; 380 $_[0]->clone
312 $self->{counter} + 0 381 }
382
383=item merge $img ...
384
385Takes any number of images and merges them together, creating a single
386image containing them all. The tiling mode of the first image is used as
387the tiling mode of the resulting image.
388
389This function is called automatically when an expression returns multiple
390images.
391
392=cut
393
394 sub merge(@) {
395 return $_[0] unless $#_;
396
397 # rather annoyingly clumsy, but optimisation is for another time
398
399 my $x0 = +1e9;
400 my $y0 = +1e9;
401 my $x1 = -1e9;
402 my $y1 = -1e9;
403
404 for (@_) {
405 my ($x, $y, $w, $h) = $_->geometry;
406
407 $x0 = $x if $x0 > $x;
408 $y0 = $y if $y0 > $y;
409
410 $x += $w;
411 $y += $h;
412
413 $x1 = $x if $x1 < $x;
414 $y1 = $y if $y1 < $y;
415 }
416
417 my $base = $self->new_img (urxvt::PictStandardARGB32, $x0, $y0, $x1 - $x0, $y1 - $y0);
418 $base->repeat_mode ($_[0]->repeat_mode);
419 $base->fill ([0, 0, 0, 0]);
420
421 $base->draw ($_)
422 for @_;
423
424 $base
313 } 425 }
314 426
315=back 427=back
316 428
317=head2 TILING MODES 429=head2 TILING MODES
350become transparent. This mode is most useful when you want to place an 462become transparent. This mode is most useful when you want to place an
351image over another image or the background colour while leaving all 463image over another image or the background colour while leaving all
352background pixels outside the image unchanged. 464background pixels outside the image unchanged.
353 465
354Example: load an image and display it in the upper left corner. The rest 466Example: load an image and display it in the upper left corner. The rest
355of the space is left "empty" (transparent or wahtever your compisotr does 467of the space is left "empty" (transparent or whatever your compositor does
356in alpha mode, else background colour). 468in alpha mode, else background colour).
357 469
358 pad load "mybg.png" 470 pad load "mybg.png"
359 471
360=item extend $img 472=item extend $img
361 473
362Extends the image over the whole plane, using the closest pixel in the 474Extends the image over the whole plane, using the closest pixel in the
363area outside the image. This mode is mostly useful when you more complex 475area outside the image. This mode is mostly useful when you use more complex
364filtering operations and want the pixels outside the image to have the 476filtering operations and want the pixels outside the image to have the
365same values as the pixels near the edge. 477same values as the pixels near the edge.
366 478
367Example: just for curiosity, how does this pixel extension stuff work? 479Example: just for curiosity, how does this pixel extension stuff work?
368 480
394 $img 506 $img
395 } 507 }
396 508
397=back 509=back
398 510
399=head2 PIXEL OPERATORS 511=head2 VARIABLE VALUES
400 512
401The following operators modify the image pixels in various ways. 513The following functions provide variable data such as the terminal window
514dimensions. They are not (Perl-) variables, they just return stuff that
515varies. Most of them make your expression sensitive to some events, for
516example using C<TW> (terminal width) means your expression is evaluated
517again when the terminal is resized.
402 518
403=over 4 519=over 4
404 520
405=item clone $img 521=item TX
406 522
407Returns an exact copy of the image. 523=item TY
408 524
409=cut 525Return the X and Y coordinates of the terminal window (the terminal
526window is the full window by default, and the character area only when in
527border-respect mode).
410 528
529Using these functions make your expression sensitive to window moves.
530
531These functions are mainly useful to align images to the root window.
532
533Example: load an image and align it so it looks as if anchored to the
534background (that's exactly what C<rootalign> does btw.):
535
536 move -TX, -TY, keep { load "mybg.png" }
537
538=item TW
539
540=item TH
541
542Return the width (C<TW>) and height (C<TH>) of the terminal window (the
543terminal window is the full window by default, and the character area only
544when in border-respect mode).
545
546Using these functions make your expression sensitive to window resizes.
547
548These functions are mainly useful to scale images, or to clip images to
549the window size to conserve memory.
550
551Example: take the screen background, clip it to the window size, blur it a
552bit, align it to the window position and use it as background.
553
554 clip move -TX, -TY, keep { blur 5, root }
555
556=cut
557
558 sub TX() { $frame->[FR_AGAIN]{position} = 1; $x }
559 sub TY() { $frame->[FR_AGAIN]{position} = 1; $y }
560 sub TW() { $frame->[FR_AGAIN]{size} = 1; $w }
561 sub TH() { $frame->[FR_AGAIN]{size} = 1; $h }
562
563=item now
564
565Returns the current time as (fractional) seconds since the epoch.
566
567Using this expression does I<not> make your expression sensitive to time,
568but the next two functions do.
569
570=item again $seconds
571
572When this function is used the expression will be reevaluated again in
573C<$seconds> seconds.
574
575Example: load some image and rotate it according to the time of day (as if it were
576the hour pointer of a clock). Update this image every minute.
577
578 again 60;
579 rotate 50, 50, (now % 86400) * -72 / 8640, scale keep { load "myclock.png" }
580
581=item counter $seconds
582
583Like C<again>, but also returns an increasing counter value, starting at
5840, which might be useful for some simple animation effects.
585
586=cut
587
588 sub now() { urxvt::NOW }
589
590 sub again($) {
591 $frame->[FR_AGAIN]{time} = $_[0];
592 }
593
411 sub clone($) { 594 sub counter($) {
412 $_[0]->clone 595 $frame->[FR_AGAIN]{time} = $_[0];
596 $frame->[FR_STATE]{counter} + 0
413 } 597 }
598
599=back
600
601=head2 SHAPE CHANGING OPERATORS
602
603The following operators modify the shape, size or position of the image.
604
605=over 4
414 606
415=item clip $img 607=item clip $img
416 608
417=item clip $width, $height, $img 609=item clip $width, $height, $img
418 610
421Clips an image to the given rectangle. If the rectangle is outside the 613Clips an image to the given rectangle. If the rectangle is outside the
422image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is 614image area (e.g. when C<$x> or C<$y> are negative) or the rectangle is
423larger than the image, then the tiling mode defines how the extra pixels 615larger than the image, then the tiling mode defines how the extra pixels
424will be filled. 616will be filled.
425 617
426If C<$x> an C<$y> are missing, then C<0> is assumed for both. 618If C<$x> and C<$y> are missing, then C<0> is assumed for both.
427 619
428If C<$width> and C<$height> are missing, then the window size will be 620If C<$width> and C<$height> are missing, then the window size will be
429assumed. 621assumed.
430 622
431Example: load an image, blur it, and clip it to the window size to save 623Example: load an image, blur it, and clip it to the window size to save
432memory. 624memory.
433 625
434 clip blur 10, load "mybg.png" 626 clip keep { blur 10, load "mybg.png" }
435 627
436=cut 628=cut
437 629
438 sub clip($;$$;$$) { 630 sub clip($;$$;$$) {
439 my $img = pop; 631 my $img = pop;
442 $img->sub_rect ($_[0], $_[1], $w, $h) 634 $img->sub_rect ($_[0], $_[1], $w, $h)
443 } 635 }
444 636
445=item scale $img 637=item scale $img
446 638
447=item scale $size_percent, $img 639=item scale $size_factor, $img
448 640
449=item scale $width_percent, $height_percent, $img 641=item scale $width_factor, $height_factor, $img
450 642
451Scales the image by the given percentages in horizontal 643Scales the image by the given factors in horizontal
452(C<$width_percent>) and vertical (C<$height_percent>) direction. 644(C<$width>) and vertical (C<$height>) direction.
453 645
454If only one percentage is give, it is used for both directions. 646If only one factor is give, it is used for both directions.
455 647
456If no percentages are given, scales the image to the window size without 648If no factors are given, scales the image to the window size without
457keeping aspect. 649keeping aspect.
458 650
459=item resize $width, $height, $img 651=item resize $width, $height, $img
460 652
461Resizes the image to exactly C<$width> times C<$height> pixels. 653Resizes the image to exactly C<$width> times C<$height> pixels.
462 654
463=cut 655=item fit $img
464 656
465#TODO: maximise, maximise_fill? 657=item fit $width, $height, $img
658
659Fits the image into the given C<$width> and C<$height> without changing
660aspect, or the terminal size. That means it will be shrunk or grown until
661the whole image fits into the given area, possibly leaving borders.
662
663=item cover $img
664
665=item cover $width, $height, $img
666
667Similar to C<fit>, but shrinks or grows until all of the area is covered
668by the image, so instead of potentially leaving borders, it will cut off
669image data that doesn't fit.
670
671=cut
466 672
467 sub scale($;$;$) { 673 sub scale($;$;$) {
468 my $img = pop; 674 my $img = pop;
469 675
470 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01) 676 @_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
471 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01) 677 : @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
472 : $img->scale (TW, TH) 678 : $img->scale (TW, TH)
473 } 679 }
474 680
475 sub resize($$$) { 681 sub resize($$$) {
476 my $img = pop; 682 my $img = pop;
477 $img->scale ($_[0], $_[1]) 683 $img->scale ($_[0], $_[1])
478 } 684 }
479 685
686 sub fit($;$$) {
687 my $img = pop;
688 my $w = ($_[0] || TW) / $img->w;
689 my $h = ($_[1] || TH) / $img->h;
690 scale +(min $w, $h), $img
691 }
692
693 sub cover($;$$) {
694 my $img = pop;
695 my $w = ($_[0] || TW) / $img->w;
696 my $h = ($_[1] || TH) / $img->h;
697 scale +(max $w, $h), $img
698 }
699
480=item move $dx, $dy, $img 700=item move $dx, $dy, $img
481 701
482Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in 702Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
483the vertical. 703the vertical.
484 704
485Example: move the image right by 20 pixels and down by 30. 705Example: move the image right by 20 pixels and down by 30.
486 706
487 move 20, 30, ... 707 move 20, 30, ...
708
709=item align $xalign, $yalign, $img
710
711Aligns the image according to a factor - C<0> means the image is moved to
712the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
713exactly centered and C<1> means it touches the right or bottom edge.
714
715Example: remove any visible border around an image, center it vertically but move
716it to the right hand side.
717
718 align 1, 0.5, pad $img
719
720=item center $img
721
722=item center $width, $height, $img
723
724Centers the image, i.e. the center of the image is moved to the center of
725the terminal window (or the box specified by C<$width> and C<$height> if
726given).
727
728Example: load an image and center it.
729
730 center keep { pad load "mybg.png" }
488 731
489=item rootalign $img 732=item rootalign $img
490 733
491Moves the image so that it appears glued to the screen as opposed to the 734Moves the image so that it appears glued to the screen as opposed to the
492window. This gives the illusion of a larger area behind the window. It is 735window. This gives the illusion of a larger area behind the window. It is
493exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the 736exactly equivalent to C<move -TX, -TY>, that is, it moves the image to the
494top left of the screen. 737top left of the screen.
495 738
496Example: load a background image, put it in mirror mode and root align it. 739Example: load a background image, put it in mirror mode and root align it.
497 740
498 rootalign mirror load "mybg.png" 741 rootalign keep { mirror load "mybg.png" }
499 742
500Example: take the screen background and align it, giving the illusion of 743Example: take the screen background and align it, giving the illusion of
501transparency as long as the window isn't in front of other windows. 744transparency as long as the window isn't in front of other windows.
502 745
503 rootalign root 746 rootalign root
504 747
505=cut 748=cut
506 749
507 sub move($$;$) { 750 sub move($$;$) {
508 my $img = pop->clone; 751 my $img = pop->clone;
509 $img->move ($_[0], $_[1]); 752 $img->move ($_[0], $_[1]);
510 $img 753 $img
511 } 754 }
512 755
756 sub align($;$$) {
757 my $img = pop;
758
759 move $_[0] * (TW - $img->w),
760 $_[1] * (TH - $img->h),
761 $img
762 }
763
764 sub center($;$$) {
765 my $img = pop;
766 my $w = $_[0] || TW;
767 my $h = $_[1] || TH;
768
769 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
770 }
771
513 sub rootalign($) { 772 sub rootalign($) {
514 move -TX, -TY, $_[0] 773 move -TX, -TY, $_[0]
515 } 774 }
516 775
776=item rotate $center_x, $center_y, $degrees, $img
777
778Rotates the image clockwise by C<$degrees> degrees, around the point at
779C<$center_x> and C<$center_y> (specified as factor of image width/height).
780
781Example: rotate the image by 90 degrees around it's center.
782
783 rotate 0.5, 0.5, 90, keep { load "$HOME/mybg.png" }
784
785=cut
786
787 sub rotate($$$$) {
788 my $img = pop;
789 $img->rotate (
790 $_[0] * ($img->w + $img->x),
791 $_[1] * ($img->h + $img->y),
792 $_[2] * (3.14159265 / 180),
793 )
794 }
795
796=back
797
798=head2 COLOUR MODIFICATIONS
799
800The following operators change the pixels of the image.
801
802=over 4
803
804=item tint $color, $img
805
806Tints the image in the given colour.
807
808Example: tint the image red.
809
810 tint "red", load "rgb.png"
811
812Example: the same, but specify the colour by component.
813
814 tint [1, 0, 0], load "rgb.png"
815
816=cut
817
818 sub tint($$) {
819 $_[1]->tint ($_[0])
820 }
821
517=item contrast $factor, $img 822=item contrast $factor, $img
518 823
519=item contrast $r, $g, $b, $img 824=item contrast $r, $g, $b, $img
520 825
521=item contrast $r, $g, $b, $a, $img 826=item contrast $r, $g, $b, $a, $img
522 827
523Adjusts the I<contrast> of an image. 828Adjusts the I<contrast> of an image.
524 829
525#TODO# 830The first form applies a single C<$factor> to red, green and blue, the
831second form applies separate factors to each colour channel, and the last
832form includes the alpha channel.
526 833
834Values from 0 to 1 lower the contrast, values higher than 1 increase the
835contrast.
836
837Due to limitations in the underlying XRender extension, lowering contrast
838also reduces brightness, while increasing contrast currently also
839increases brightness.
840
527=item brightness $factor, $img 841=item brightness $bias, $img
528 842
529=item brightness $r, $g, $b, $img 843=item brightness $r, $g, $b, $img
530 844
531=item brightness $r, $g, $b, $a, $img 845=item brightness $r, $g, $b, $a, $img
532 846
533Adjusts the brightness of an image. 847Adjusts the brightness of an image.
848
849The first form applies a single C<$bias> to red, green and blue, the
850second form applies separate biases to each colour channel, and the last
851form includes the alpha channel.
852
853Values less than 0 reduce brightness, while values larger than 0 increase
854it. Useful range is from -1 to 1 - the former results in a black, the
855latter in a white picture.
856
857Due to idiosyncrasies in the underlying XRender extension, biases less
858than zero can be I<very> slow.
859
860You can also try the experimental(!) C<muladd> operator.
534 861
535=cut 862=cut
536 863
537 sub contrast($$;$$;$) { 864 sub contrast($$;$$;$) {
538 my $img = pop; 865 my $img = pop;
539 my ($r, $g, $b, $a) = @_; 866 my ($r, $g, $b, $a) = @_;
540 867
541 ($g, $b) = ($r, $r) if @_ < 4; 868 ($g, $b) = ($r, $r) if @_ < 3;
542 $a = 1 if @_ < 5; 869 $a = 1 if @_ < 4;
543 870
544 $img = $img->clone; 871 $img = $img->clone;
545 $img->contrast ($r, $g, $b, $a); 872 $img->contrast ($r, $g, $b, $a);
546 $img 873 $img
547 } 874 }
548 875
549 sub brightness($$;$$;$) { 876 sub brightness($$;$$;$) {
550 my $img = pop; 877 my $img = pop;
551 my ($r, $g, $b, $a) = @_; 878 my ($r, $g, $b, $a) = @_;
552 879
553 ($g, $b) = ($r, $r) if @_ < 4; 880 ($g, $b) = ($r, $r) if @_ < 3;
554 $a = 1 if @_ < 5; 881 $a = 1 if @_ < 4;
555 882
556 $img = $img->clone; 883 $img = $img->clone;
557 $img->brightness ($r, $g, $b, $a); 884 $img->brightness ($r, $g, $b, $a);
558 $img 885 $img
559 } 886 }
560 887
888=item muladd $mul, $add, $img # EXPERIMENTAL
889
890First multipliesthe pixels by C<$mul>, then adds C<$add>. This cna be used
891to implement brightness and contrast at the same time, with a wider value
892range than contrast and brightness operators.
893
894Due to numerous bugs in XRender implementations, it can also introduce a
895number of visual artifacts.
896
897Example: increase contrast by a factor of C<$c> without changing image
898brightness too much.
899
900 muladd $c, (1 - $c) * 0.5, $img
901
902=cut
903
904 sub muladd($$$) {
905 $_[2]->muladd ($_[0], $_[1])
906 }
907
561=item blur $radius, $img 908=item blur $radius, $img
562 909
563=item blur $radius_horz, $radius_vert, $img 910=item blur $radius_horz, $radius_vert, $img
564 911
565Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii 912Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
566can also be specified separately. 913can also be specified separately.
914
915Blurring is often I<very> slow, at least compared or other
916operators. Larger blur radii are slower than smaller ones, too, so if you
917don't want to freeze your screen for long times, start experimenting with
918low values for radius (<5).
567 919
568=cut 920=cut
569 921
570 sub blur($$;$) { 922 sub blur($$;$) {
571 my $img = pop; 923 my $img = pop;
572 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 924 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
573 } 925 }
574 926
575=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
576
577Rotates the image by C<$degrees> degrees, counter-clockwise, around the
578pointer at C<$center_x> and C<$center_y> (specified as percentage of image
579width/height), generating a new image with width C<$new_width> and height
580C<$new_height>.
581
582#TODO# new width, height, maybe more operators?
583
584Example: rotate the image by 90 degrees
585
586=cut
587
588 sub rotate($$$$$$) {
589 my $img = pop;
590 $img->rotate (
591 $_[0],
592 $_[1],
593 $_[2] * $img->w * .01,
594 $_[3] * $img->h * .01,
595 $_[4] * (3.14159265 / 180),
596 )
597 }
598
599=back 927=back
600 928
929=head2 OTHER STUFF
930
931Anything that didn't fit any of the other categories, even after applying
932force and closing our eyes.
933
934=over 4
935
936=item keep { ... }
937
938This operator takes a code block as argument, that is, one or more
939statements enclosed by braces.
940
941The trick is that this code block is only evaluated when the outcome
942changes - on other calls the C<keep> simply returns the image it computed
943previously (yes, it should only be used with images). Or in other words,
944C<keep> I<caches> the result of the code block so it doesn't need to be
945computed again.
946
947This can be extremely useful to avoid redoing slow operations - for
948example, if your background expression takes the root background, blurs it
949and then root-aligns it it would have to blur the root background on every
950window move or resize.
951
952Another example is C<load>, which can be quite slow.
953
954In fact, urxvt itself encloses the whole expression in some kind of
955C<keep> block so it only is reevaluated as required.
956
957Putting the blur into a C<keep> block will make sure the blur is only done
958once, while the C<rootalign> is still done each time the window moves.
959
960 rootalign keep { blur 10, root }
961
962This leaves the question of how to force reevaluation of the block,
963in case the root background changes: If expression inside the block
964is sensitive to some event (root background changes, window geometry
965changes), then it will be reevaluated automatically as needed.
966
967=cut
968
969 sub keep(&) {
970 my $id = $_[0]+0;
971
972 local $frame = $self->{frame_cache}{$id} ||= [$frame];
973
974 unless ($frame->[FR_CACHE]) {
975 $frame->[FR_CACHE] = [ $_[0]() ];
976
977 my $self = $self;
978 my $frame = $frame;
979 Scalar::Util::weaken $frame;
980 $self->compile_frame ($frame, sub {
981 # clear this frame cache, also for all parents
982 for (my $frame = $frame; $frame; $frame = $frame->[0]) {
983 undef $frame->[FR_CACHE];
984 }
985
986 $self->recalculate;
987 });
988 };
989
990 # in scalar context we always return the first original result, which
991 # is not quite how perl works.
992 wantarray
993 ? @{ $frame->[FR_CACHE] }
994 : $frame->[FR_CACHE][0]
995 }
996
997# sub keep_clear() {
998# delete $self->{frame_cache};
999# }
1000
1001=back
1002
601=cut 1003=cut
602 1004
603} 1005}
604 1006
605sub parse_expr { 1007sub parse_expr {
606 my $expr = eval "sub {\npackage urxvt::bgdsl;\n#line 0 'background expression'\n$_[0]\n}"; 1008 my $expr = eval
1009 "sub {\n"
1010 . "package urxvt::bgdsl;\n"
1011 . "#line 0 'background expression'\n"
1012 . "$_[0]\n"
1013 . "}";
607 die if $@; 1014 die if $@;
608 $expr 1015 $expr
609} 1016}
610 1017
611# compiles a parsed expression 1018# compiles a parsed expression
612sub set_expr { 1019sub set_expr {
613 my ($self, $expr) = @_; 1020 my ($self, $expr) = @_;
614 1021
1022 $self->{root} = []; # the outermost frame
615 $self->{expr} = $expr; 1023 $self->{expr} = $expr;
616 $self->recalculate; 1024 $self->recalculate;
1025}
1026
1027# takes a hash of sensitivity indicators and installs watchers
1028sub compile_frame {
1029 my ($self, $frame, $cb) = @_;
1030
1031 my $state = $frame->[urxvt::bgdsl::FR_STATE] ||= {};
1032 my $again = $frame->[urxvt::bgdsl::FR_AGAIN];
1033
1034 # don't keep stuff alive
1035 Scalar::Util::weaken $state;
1036
1037 if ($again->{nested}) {
1038 $state->{nested} = 1;
1039 } else {
1040 delete $state->{nested};
1041 }
1042
1043 if (my $interval = $again->{time}) {
1044 $state->{time} = [$interval, urxvt::timer->new->after ($interval)->interval ($interval)]
1045 if $state->{time}[0] != $interval;
1046
1047 # callback *might* have changed, although we could just rule that out
1048 $state->{time}[1]->cb (sub {
1049 ++$state->{counter};
1050 $cb->();
1051 });
1052 } else {
1053 delete $state->{time};
1054 }
1055
1056 if ($again->{position}) {
1057 $state->{position} = $self->on (position_change => $cb);
1058 } else {
1059 delete $state->{position};
1060 }
1061
1062 if ($again->{size}) {
1063 $state->{size} = $self->on (size_change => $cb);
1064 } else {
1065 delete $state->{size};
1066 }
1067
1068 if ($again->{rootpmap}) {
1069 $state->{rootpmap} = $self->on (rootpmap_change => $cb);
1070 } else {
1071 delete $state->{rootpmap};
1072 }
617} 1073}
618 1074
619# evaluate the current bg expression 1075# evaluate the current bg expression
620sub recalculate { 1076sub recalculate {
621 my ($arg_self) = @_; 1077 my ($arg_self) = @_;
631 1087
632 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL; 1088 $arg_self->{next_refresh} = urxvt::NOW + $MIN_INTERVAL;
633 1089
634 # set environment to evaluate user expression 1090 # set environment to evaluate user expression
635 1091
636 local $self = $arg_self; 1092 local $self = $arg_self;
637
638 local $HOME = $ENV{HOME}; 1093 local $HOME = $ENV{HOME};
639 local $old = $self->{state}; 1094 local $frame = $self->{root};
640 local $new = my $state = $self->{state} = {};
641 1095
642 ($x, $y, $w, $h) =
643 $self->background_geometry ($self->{border}); 1096 ($x, $y, $w, $h) = $self->background_geometry ($self->{border});
644 1097
645 # evaluate user expression 1098 # evaluate user expression
646 1099
647 my $img = eval { $self->{expr}->() }; 1100 my @img = eval { $self->{expr}->() };
648 warn $@ if $@;#d# 1101 die $@ if $@;
1102 die "background-expr did not return anything.\n" unless @img;
1103 die "background-expr: expected image(s), got something else.\n"
649 die if !UNIVERSAL::isa $img, "urxvt::img"; 1104 if grep { !UNIVERSAL::isa $_, "urxvt::img" } @img;
650 1105
651 $state->{size_sensitive} = 1 1106 my $img = urxvt::bgdsl::merge @img;
1107
1108 $frame->[FR_AGAIN]{size} = 1
652 if $img->repeat_mode != urxvt::RepeatNormal; 1109 if $img->repeat_mode != urxvt::RepeatNormal;
653 1110
654 # if the expression is sensitive to external events, prepare reevaluation then 1111 # if the expression is sensitive to external events, prepare reevaluation then
655 1112 $self->compile_frame ($frame, sub { $arg_self->recalculate });
656 my $repeat;
657
658 if (my $again = $state->{again}) {
659 $repeat = 1;
660 my $self = $self;
661 $state->{timer} = $again == $old->{again}
662 ? $old->{timer}
663 : urxvt::timer->new->after ($again)->interval ($again)->cb (sub {
664 ++$self->{counter};
665 $self->recalculate
666 });
667 }
668
669 if (delete $state->{position_sensitive}) {
670 $repeat = 1;
671 $self->enable (position_change => sub { $_[0]->recalculate });
672 } else {
673 $self->disable ("position_change");
674 }
675
676 if (delete $state->{size_sensitive}) {
677 $repeat = 1;
678 $self->enable (size_change => sub { $_[0]->recalculate });
679 } else {
680 $self->disable ("size_change");
681 }
682
683 if (delete $state->{rootpmap_sensitive}) {
684 $repeat = 1;
685 $self->enable (rootpmap_change => sub { $_[0]->recalculate });
686 } else {
687 $self->disable ("rootpmap_change");
688 }
689 1113
690 # clear stuff we no longer need 1114 # clear stuff we no longer need
691 1115
692 %$old = (); 1116# unless (%{ $frame->[FR_STATE] }) {
693
694 unless ($repeat) {
695 delete $self->{state}; 1117# delete $self->{state};
696 delete $self->{expr}; 1118# delete $self->{expr};
697 } 1119# }
698 1120
699 # set background pixmap 1121 # set background pixmap
700 1122
701 $self->set_background ($img, $self->{border}); 1123 $self->set_background ($img, $self->{border});
702 $self->scr_recolour (0); 1124 $self->scr_recolour (0);
704} 1126}
705 1127
706sub on_start { 1128sub on_start {
707 my ($self) = @_; 1129 my ($self) = @_;
708 1130
709 my $expr = $self->x_resource ("background.expr") 1131 my $expr = $self->x_resource ("%.expr")
710 or return; 1132 or return;
711 1133
1134 $self->has_render
1135 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
1136
712 $self->set_expr (parse_expr $expr); 1137 $self->set_expr (parse_expr $expr);
713 $self->{border} = $self->x_resource_boolean ("background.border"); 1138 $self->{border} = $self->x_resource_boolean ("%.border");
1139
1140 $MIN_INTERVAL = $self->x_resource ("%.interval");
714 1141
715 () 1142 ()
716} 1143}
717 1144

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines