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.36 by root, Fri Jun 8 20:23:09 2012 UTC vs.
Revision 1.45 by root, Sun Jun 10 11:53:32 2012 UTC

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 5
6#TODO: once, rootalign 6#TODO: once, rootalign
7 7
8=head1 NAME
9
8=head1 background - manage terminal background 10 background - manage terminal background
9 11
10=head2 SYNOPSIS 12=head1 SYNOPSIS
11 13
12 urxvt --background-expr 'background expression' 14 urxvt --background-expr 'background expression'
13 --background-border 15 --background-border
14 16
15=head2 DESCRIPTION 17=head1 DESCRIPTION
16 18
17This extension manages the terminal background by creating a picture that 19This extension manages the terminal background by creating a picture that
18is behind the text, replacing the normal background colour. 20is behind the text, replacing the normal background colour.
19 21
20It does so by evaluating a Perl expression that I<calculates> the image on 22It does so by evaluating a Perl expression that I<calculates> the image on
30 32
31Or specified as a X resource: 33Or specified as a X resource:
32 34
33 URxvt.background-expr: scale load "/path/to/mybg.png" 35 URxvt.background-expr: scale load "/path/to/mybg.png"
34 36
35=head2 THEORY OF OPERATION 37=head1 THEORY OF OPERATION
36 38
37At startup, just before the window is mapped for the first time, the 39At startup, just before the window is mapped for the first time, the
38expression is evaluated and must yield an image. The image is then 40expression 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 41extended as necessary to cover the whole terminal window, and is set as a
40background pixmap. 42background pixmap.
57image to the window size, so it relies on the window size and will 59image to the window size, so it relies on the window size and will
58be reevaluated each time it is changed, but not when it moves for 60be reevaluated each time it is changed, but not when it moves for
59example. That ensures that the picture always fills the terminal, even 61example. That ensures that the picture always fills the terminal, even
60after it's size changes. 62after it's size changes.
61 63
62=head3 EXPRESSIONS 64=head2 EXPRESSIONS
63 65
64Expressions are normal Perl expressions, in fact, they are Perl blocks - 66Expressions are normal Perl expressions, in fact, they are Perl blocks -
65which means you could use multiple lines and statements: 67which means you could use multiple lines and statements:
66 68
67 again 3600; 69 again 3600;
70 } else { 72 } else {
71 return scale load "$HOME/sunday.png"; 73 return scale load "$HOME/sunday.png";
72 } 74 }
73 75
74This expression gets evaluated once per hour. It will set F<sunday.png> as 76This expression gets evaluated once per hour. It will set F<sunday.png> as
75background on sundays, and F<weekday.png> on all other days. 77background on Sundays, and F<weekday.png> on all other days.
76 78
77Fortunately, we expect that most expressions will be much simpler, with 79Fortunately, we expect that most expressions will be much simpler, with
78little Perl knowledge needed. 80little Perl knowledge needed.
79 81
80Basically, you always start with a function that "generates" an image 82Basically, you always start with a function that "generates" an image
97its result becomes the argument to the C<scale> function. 99its result becomes the argument to the C<scale> function.
98 100
99Many operators also allow some parameters preceding the input image 101Many operators also allow some parameters preceding the input image
100that modify its behaviour. For example, C<scale> without any additional 102that modify its behaviour. For example, C<scale> without any additional
101arguments scales the image to size of the terminal window. If you specify 103arguments scales the image to size of the terminal window. If you specify
102an additional argument, it uses it as a percentage: 104an additional argument, it uses it as a scale factor (multiply by 100 to
105get a percentage):
103 106
104 scale 200, load "$HOME/mypic.png" 107 scale 2, load "$HOME/mypic.png"
105 108
106This enlarges the image by a factor of 2 (200%). As you can see, C<scale> 109This 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 110has 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 111C<load> only has one argument. Arguments are separated from each other by
109commas. 112commas.
110 113
111Scale also accepts two arguments, which are then separate factors for both 114Scale also accepts two arguments, which are then separate factors for both
112horizontal and vertical dimensions. For example, this halves the image 115horizontal and vertical dimensions. For example, this halves the image
113width and doubles the image height: 116width and doubles the image height:
114 117
115 scale 50, 200, load "$HOME/mypic.png" 118 scale 0.5, 2, load "$HOME/mypic.png"
116 119
117TODO 120Other effects than scalign are also readily available, for exmaple, you can
121tile the image to fill the whole window, instead of resizing it:
118 122
123 tile load "$HOME/mypic.png"
124
125In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator
126is kind of superfluous.
127
128Another common effect is to mirror the image, so that the same edges touch:
129
130 mirror load "$HOME/mypic.png"
131
132This is also a typical background expression:
133
134 rootalign root
135
136It first takes a snapshot of the screen background image, and then
137moves it to the upper left corner of the screen - the result is
138pseudo-transparency, as the image seems to be static while the window is
139moved around.
140
119=head3 CYCLES AND CACHING 141=head2 CYCLES AND CACHING
120 142
121TODO 143As has been mentioned before, the expression might be evaluated multiple
122
123Each time the expression is reevaluated, a new cycle is said to have begun. Many operators 144times. Each time the expression is reevaluated, a new cycle is said to
124cache their results till the next cycle. For example 145have begun. Many operators cache their results till the next cycle.
125 146
147For example, the C<load> operator keeps a copy of the image. If it is
148asked to load the same image on the next cycle it will not load it again,
149but return the cached copy.
150
151This only works for one cycle though, so as long as you load the same
152image every time, it will always be cached, but when you load a different
153image, it will forget about the first one.
154
155This allows you to either speed things up by keeping multiple images in
156memory, or comserve memory by loading images more often.
157
158For example, you can keep two images in memory and use a random one like
159this:
160
161 my $img1 = load "img1.png";
162 my $img2 = load "img2.png";
163 (0.5 > rand) ? $img1 : $img2
164
165Since both images are "loaded" every time the expression is evaluated,
166they are always kept in memory. Contrast this version:
167
168 my $path1 = "img1.png";
169 my $path2 = "img2.png";
170 load ((0.5 > rand) ? $path1 : $path2)
171
172Here, a path is selected randomly, and load is only called for one image,
173so keeps only one image in memory. If, on the next evaluation, luck
174decides to use the other path, then it will have to load that image again.
175
126=head2 REFERENCE 176=head1 REFERENCE
127 177
128=head3 COMMAND LINE SWITCHES 178=head2 COMMAND LINE SWITCHES
129 179
130=over 4 180=over 4
131 181
132=item --background-expr perl-expression 182=item --background-expr perl-expression
133 183
142replaces the background of the character area. 192replaces the background of the character area.
143 193
144=back 194=back
145 195
146=cut 196=cut
147
148our $EXPR;#d#
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 197
161our $HOME; 198our $HOME;
162our ($self, $old, $new); 199our ($self, $old, $new);
163our ($x, $y, $w, $h); 200our ($x, $y, $w, $h);
164 201
166our $MIN_INTERVAL = 1/100; 203our $MIN_INTERVAL = 1/100;
167 204
168{ 205{
169 package urxvt::bgdsl; # background language 206 package urxvt::bgdsl; # background language
170 207
208 use List::Util qw(min max sum shuffle);
209
171=head2 PROVIDERS/GENERATORS 210=head2 PROVIDERS/GENERATORS
172 211
173These functions provide an image, by loading it from disk, grabbing it 212These 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 213from the root screen or by simply generating it. They are used as starting
175points to get an image you can play with. 214points to get an image you can play with.
211=item solid $width, $height, $colour 250=item solid $width, $height, $colour
212 251
213Creates a new image and completely fills it with the given colour. The 252Creates a new image and completely fills it with the given colour. The
214image is set to tiling mode. 253image is set to tiling mode.
215 254
216If <$width> and C<$height> are omitted, it creates a 1x1 image, which is 255If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
217useful for solid backgrounds or for use in filtering effects. 256useful for solid backgrounds or for use in filtering effects.
218 257
219=cut 258=cut
220 259
221 sub solid($$;$) { 260 sub solid($;$$) {
222 my $colour = pop; 261 my $colour = pop;
223 262
224 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); 263 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1);
225 $img->fill ($colour); 264 $img->fill ($colour);
226 $img 265 $img
227 } 266 }
228 267
268=item clone $img
269
270Returns an exact copy of the image. This is useful if you want to have
271multiple copies of the same image to apply different effects to.
272
273=cut
274
275 sub clone($) {
276 $_[0]->clone
277 }
278
229=back 279=back
230 280
281=head2 TILING MODES
282
283The following operators modify the tiling mode of an image, that is, the
284way that pixels outside the image area are painted when the image is used.
285
286=over 4
287
288=item tile $img
289
290Tiles the whole plane with the image and returns this new image - or in
291other words, it returns a copy of the image in plane tiling mode.
292
293Example: load an image and tile it over the background, without
294resizing. The C<tile> call is superfluous because C<load> already defaults
295to tiling mode.
296
297 tile load "mybg.png"
298
299=item mirror $img
300
301Similar to tile, but reflects the image each time it uses a new copy, so
302that top edges always touch top edges, right edges always touch right
303edges and so on (with normal tiling, left edges always touch right edges
304and top always touch bottom edges).
305
306Example: load an image and mirror it over the background, avoiding sharp
307edges at the image borders at the expense of mirroring the image itself
308
309 mirror load "mybg.png"
310
311=item pad $img
312
313Takes an image and modifies it so that all pixels outside the image area
314become transparent. This mode is most useful when you want to place an
315image over another image or the background colour while leaving all
316background pixels outside the image unchanged.
317
318Example: load an image and display it in the upper left corner. The rest
319of the space is left "empty" (transparent or wahtever your compisotr does
320in alpha mode, else background colour).
321
322 pad load "mybg.png"
323
324=item extend $img
325
326Extends the image over the whole plane, using the closest pixel in the
327area outside the image. This mode is mostly useful when you more complex
328filtering operations and want the pixels outside the image to have the
329same values as the pixels near the edge.
330
331Example: just for curiosity, how does this pixel extension stuff work?
332
333 extend move 50, 50, load "mybg.png"
334
335=cut
336
337 sub pad($) {
338 my $img = $_[0]->clone;
339 $img->repeat_mode (urxvt::RepeatNone);
340 $img
341 }
342
343 sub tile($) {
344 my $img = $_[0]->clone;
345 $img->repeat_mode (urxvt::RepeatNormal);
346 $img
347 }
348
349 sub mirror($) {
350 my $img = $_[0]->clone;
351 $img->repeat_mode (urxvt::RepeatReflect);
352 $img
353 }
354
355 sub extend($) {
356 my $img = $_[0]->clone;
357 $img->repeat_mode (urxvt::RepeatPad);
358 $img
359 }
360
361=back
362
231=head2 VARIABLES 363=head2 VARIABLE VALUES
232 364
233The following functions provide variable data such as the terminal 365The following functions provide variable data such as the terminal window
366dimensions. They are not (Perl-) variables, they just return stuff that
234window dimensions. Most of them make your expression sensitive to some 367varies. Most of them make your expression sensitive to some events, for
235events, for example using C<TW> (terminal width) means your expression is 368example using C<TW> (terminal width) means your expression is evaluated
236evaluated again when the terminal is resized. 369again when the terminal is resized.
237 370
238=over 4 371=over 4
239 372
240=item TX 373=item TX
241 374
312 $self->{counter} + 0 445 $self->{counter} + 0
313 } 446 }
314 447
315=back 448=back
316 449
317=head2 TILING MODES 450=head2 SHAPE CHANGING OPERATORS
318 451
319The following operators modify the tiling mode of an image, that is, the 452The following operators modify the shape, size or position of the image.
320way that pixels outside the image area are painted when the image is used.
321 453
322=over 4 454=over 4
323
324=item tile $img
325
326Tiles the whole plane with the image and returns this new image - or in
327other words, it returns a copy of the image in plane tiling mode.
328
329Example: load an image and tile it over the background, without
330resizing. The C<tile> call is superfluous because C<load> already defaults
331to tiling mode.
332
333 tile load "mybg.png"
334
335=item mirror $img
336
337Similar to tile, but reflects the image each time it uses a new copy, so
338that top edges always touch top edges, right edges always touch right
339edges and so on (with normal tiling, left edges always touch right edges
340and top always touch bottom edges).
341
342Example: load an image and mirror it over the background, avoiding sharp
343edges at the image borders at the expense of mirroring the image itself
344
345 mirror load "mybg.png"
346
347=item pad $img
348
349Takes an image and modifies it so that all pixels outside the image area
350become transparent. This mode is most useful when you want to place an
351image over another image or the background colour while leaving all
352background pixels outside the image unchanged.
353
354Example: 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
356in alpha mode, else background colour).
357
358 pad load "mybg.png"
359
360=item extend $img
361
362Extends 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
364filtering operations and want the pixels outside the image to have the
365same values as the pixels near the edge.
366
367Example: just for curiosity, how does this pixel extension stuff work?
368
369 extend move 50, 50, load "mybg.png"
370
371=cut
372
373 sub pad($) {
374 my $img = $_[0]->clone;
375 $img->repeat_mode (urxvt::RepeatNone);
376 $img
377 }
378
379 sub tile($) {
380 my $img = $_[0]->clone;
381 $img->repeat_mode (urxvt::RepeatNormal);
382 $img
383 }
384
385 sub mirror($) {
386 my $img = $_[0]->clone;
387 $img->repeat_mode (urxvt::RepeatReflect);
388 $img
389 }
390
391 sub extend($) {
392 my $img = $_[0]->clone;
393 $img->repeat_mode (urxvt::RepeatPad);
394 $img
395 }
396
397=back
398
399=head2 PIXEL OPERATORS
400
401The following operators modify the image pixels in various ways.
402
403=over 4
404
405=item clone $img
406
407Returns an exact copy of the image.
408
409=cut
410
411 sub clone($) {
412 $_[0]->clone
413 }
414 455
415=item clip $img 456=item clip $img
416 457
417=item clip $width, $height, $img 458=item clip $width, $height, $img
418 459
442 $img->sub_rect ($_[0], $_[1], $w, $h) 483 $img->sub_rect ($_[0], $_[1], $w, $h)
443 } 484 }
444 485
445=item scale $img 486=item scale $img
446 487
447=item scale $size_percent, $img 488=item scale $size_factor, $img
448 489
449=item scale $width_percent, $height_percent, $img 490=item scale $width_factor, $height_factor, $img
450 491
451Scales the image by the given percentages in horizontal 492Scales the image by the given factors in horizontal
452(C<$width_percent>) and vertical (C<$height_percent>) direction. 493(C<$width>) and vertical (C<$height>) direction.
453 494
454If only one percentage is give, it is used for both directions. 495If only one factor is give, it is used for both directions.
455 496
456If no percentages are given, scales the image to the window size without 497If no factors are given, scales the image to the window size without
457keeping aspect. 498keeping aspect.
458 499
459=item resize $width, $height, $img 500=item resize $width, $height, $img
460 501
461Resizes the image to exactly C<$width> times C<$height> pixels. 502Resizes the image to exactly C<$width> times C<$height> pixels.
462 503
463=cut 504=item fit $img
464 505
465#TODO: maximise, maximise_fill? 506=item fit $width, $height, $img
507
508Fits the image into the given C<$width> and C<$height> without changing
509aspect, or the terminal size. That means it will be shrunk or grown until
510the whole image fits into the given area, possibly leaving borders.
511
512=item cover $img
513
514=item cover $width, $height, $img
515
516Similar to C<fit>, but shrinks or grows until all of the area is covered
517by the image, so instead of potentially leaving borders, it will cut off
518image data that doesn't fit.
519
520=cut
466 521
467 sub scale($;$;$) { 522 sub scale($;$;$) {
468 my $img = pop; 523 my $img = pop;
469 524
470 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01) 525 @_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
471 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01) 526 : @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
472 : $img->scale (TW, TH) 527 : $img->scale (TW, TH)
473 } 528 }
474 529
475 sub resize($$$) { 530 sub resize($$$) {
476 my $img = pop; 531 my $img = pop;
477 $img->scale ($_[0], $_[1]) 532 $img->scale ($_[0], $_[1])
533 }
534
535 sub fit($;$$) {
536 my $img = pop;
537 my $w = ($_[0] || TW) / $img->w;
538 my $h = ($_[1] || TH) / $img->h;
539 scale +(min $w, $h), $img
540 }
541
542 sub cover($;$$) {
543 my $img = pop;
544 my $w = ($_[0] || TW) / $img->w;
545 my $h = ($_[1] || TH) / $img->h;
546 scale +(max $w, $h), $img
478 } 547 }
479 548
480=item move $dx, $dy, $img 549=item move $dx, $dy, $img
481 550
482Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in 551Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
483the vertical. 552the vertical.
484 553
485Example: move the image right by 20 pixels and down by 30. 554Example: move the image right by 20 pixels and down by 30.
486 555
487 move 20, 30, ... 556 move 20, 30, ...
557
558=item center $img
559
560=item center $width, $height, $img
561
562Centers the image, i.e. the center of the image is moved to the center of
563the terminal window (or the box specified by C<$width> and C<$height> if
564given).
488 565
489=item rootalign $img 566=item rootalign $img
490 567
491Moves the image so that it appears glued to the screen as opposed to the 568Moves 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 569window. This gives the illusion of a larger area behind the window. It is
508 my $img = pop->clone; 585 my $img = pop->clone;
509 $img->move ($_[0], $_[1]); 586 $img->move ($_[0], $_[1]);
510 $img 587 $img
511 } 588 }
512 589
590 sub center($;$$) {
591 my $img = pop;
592 my $w = $_[0] || TW;
593 my $h = $_[0] || TH;
594
595 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
596 }
597
513 sub rootalign($) { 598 sub rootalign($) {
514 move -TX, -TY, $_[0] 599 move -TX, -TY, $_[0]
515 } 600 }
516 601
602=back
603
604=head2 COLOUR MODIFICATIONS
605
606The following operators change the pixels of the image.
607
608=over 4
609
517=item contrast $factor, $img 610=item contrast $factor, $img
518 611
519=item contrast $r, $g, $b, $img 612=item contrast $r, $g, $b, $img
520 613
521=item contrast $r, $g, $b, $a, $img 614=item contrast $r, $g, $b, $a, $img
522 615
523Adjusts the I<contrast> of an image. 616Adjusts the I<contrast> of an image.
524 617
618The first form applies a single C<$factor> to red, green and blue, the
619second form applies separate factors to each colour channel, and the last
620form includes the alpha channel.
621
622Values from 0 to 1 lower the contrast, values higher than 1 increase the
623contrast.
624
625Due to limitations in the underlying XRender extension, lowering contrast
626also reduces brightness, while increasing contrast currently also
627increases brightness.
628
525=item brightness $factor, $img 629=item brightness $bias, $img
526 630
527=item brightness $r, $g, $b, $img 631=item brightness $r, $g, $b, $img
528 632
529=item brightness $r, $g, $b, $a, $img 633=item brightness $r, $g, $b, $a, $img
634
635Adjusts the brightness of an image.
636
637The first form applies a single C<$bias> to red, green and blue, the
638second form applies separate biases to each colour channel, and the last
639form includes the alpha channel.
640
641Values less than 0 reduce brightness, while values larger than 0 increase
642it. Useful range is from -1 to 1 - the former results in a black, the
643latter in a white picture.
644
645Due to idiosynchrasies in the underlying XRender extension, biases less
646than zero can be I<very> slow.
530 647
531=cut 648=cut
532 649
533 sub contrast($$;$$;$) { 650 sub contrast($$;$$;$) {
534 my $img = pop; 651 my $img = pop;
536 653
537 ($g, $b) = ($r, $r) if @_ < 4; 654 ($g, $b) = ($r, $r) if @_ < 4;
538 $a = 1 if @_ < 5; 655 $a = 1 if @_ < 5;
539 656
540 $img = $img->clone; 657 $img = $img->clone;
541# $img->contrast ($r, $g, $b, $a); 658 $img->contrast ($r, $g, $b, $a);
542 $img 659 $img
543 } 660 }
544 661
545 sub brightness($$;$$;$) { 662 sub brightness($$;$$;$) {
546 my $img = pop; 663 my $img = pop;
552 $img = $img->clone; 669 $img = $img->clone;
553 $img->brightness ($r, $g, $b, $a); 670 $img->brightness ($r, $g, $b, $a);
554 $img 671 $img
555 } 672 }
556 673
674=item blur $radius, $img
675
676=item blur $radius_horz, $radius_vert, $img
677
678Gaussian-blurs the image with (roughly) C<$radius> pixel radius. The radii
679can also be specified separately.
680
681Blurring is often I<very> slow, at least compared or other
682operators. Larger blur radii are slower than smaller ones, too, so if you
683don't want to freeze your screen for long times, start experimenting with
684low values for radius (<5).
685
686=cut
687
557 sub blur($$;$) { 688 sub blur($$;$) {
558 my $img = pop; 689 my $img = pop;
559 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) 690 $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0])
560 } 691 }
692
693=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
694
695Rotates the image by C<$degrees> degrees, counter-clockwise, around the
696pointer at C<$center_x> and C<$center_y> (specified as factor of image
697width/height), generating a new image with width C<$new_width> and height
698C<$new_height>.
699
700#TODO# new width, height, maybe more operators?
701
702Example: rotate the image by 90 degrees
703
704=cut
561 705
562 sub rotate($$$$$$) { 706 sub rotate($$$$$$) {
563 my $img = pop; 707 my $img = pop;
564 $img->rotate ( 708 $img->rotate (
565 $_[0], 709 $_[0],
566 $_[1], 710 $_[1],
567 $_[2] * $img->w * .01, 711 $_[2] * $img->w,
568 $_[3] * $img->h * .01, 712 $_[3] * $img->h,
569 $_[4] * (3.14159265 / 180), 713 $_[4] * (3.14159265 / 180),
570 ) 714 )
571 } 715 }
572 716
573=back 717=back

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines