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.41 by root, Fri Jun 8 22:21:48 2012 UTC vs.
Revision 1.49 by root, Sun Jun 10 15:29:18 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#TODO: once, rootalign
7 8
8=head1 NAME 9=head1 NAME
9 10
… …
11 12
12=head1 SYNOPSIS 13=head1 SYNOPSIS
13 14
14 urxvt --background-expr 'background expression' 15 urxvt --background-expr 'background expression'
15 --background-border 16 --background-border
17 --background-interval seconds
16 18
17=head1 DESCRIPTION 19=head1 DESCRIPTION
18 20
19This extension manages the terminal background by creating a picture that 21This extension manages the terminal background by creating a picture that
20is behind the text, replacing the normal background colour. 22is behind the text, replacing the normal background colour.
… …
99its result becomes the argument to the C<scale> function. 101its result becomes the argument to the C<scale> function.
100 102
101Many operators also allow some parameters preceding the input image 103Many operators also allow some parameters preceding the input image
102that modify its behaviour. For example, C<scale> without any additional 104that modify its behaviour. For example, C<scale> without any additional
103arguments scales the image to size of the terminal window. If you specify 105arguments scales the image to size of the terminal window. If you specify
104an additional argument, it uses it as a percentage: 106an additional argument, it uses it as a scale factor (multiply by 100 to
107get a percentage):
105 108
106 scale 200, load "$HOME/mypic.png" 109 scale 2, load "$HOME/mypic.png"
107 110
108This enlarges the image by a factor of 2 (200%). As you can see, C<scale> 111This enlarges the image by a factor of 2 (200%). As you can see, C<scale>
109has now two arguments, the C<200> and the C<load> expression, while 112has now two arguments, the C<200> and the C<load> expression, while
110C<load> only has one argument. Arguments are separated from each other by 113C<load> only has one argument. Arguments are separated from each other by
111commas. 114commas.
112 115
113Scale also accepts two arguments, which are then separate factors for both 116Scale also accepts two arguments, which are then separate factors for both
114horizontal and vertical dimensions. For example, this halves the image 117horizontal and vertical dimensions. For example, this halves the image
115width and doubles the image height: 118width and doubles the image height:
116 119
117 scale 50, 200, load "$HOME/mypic.png" 120 scale 0.5, 2, load "$HOME/mypic.png"
118 121
119Other effects than scalign are also readily available, for exmaple, you can 122Other effects than scalign are also readily available, for exmaple, you can
120tile the image to fill the whole window, instead of resizing it: 123tile the image to fill the whole window, instead of resizing it:
121 124
122 tile load "$HOME/mypic.png" 125 tile load "$HOME/mypic.png"
… …
188overwriting borders and any other areas, such as the scrollbar. 191overwriting borders and any other areas, such as the scrollbar.
189 192
190Specifying this flag changes the behaviour, so that the image only 193Specifying this flag changes the behaviour, so that the image only
191replaces the background of the character area. 194replaces the background of the character area.
192 195
196=item --background-interval seconds
197
198Since some operations in the underlying XRender extension can effetively
199freeze your X-server for prolonged time, this extension enforces a minimum
200time between updates, which is normally about 0.1 seconds.
201
202If you want to do updates more often, you can decrease this safety
203interval with this switch.
204
193=back 205=back
194 206
195=cut 207=cut
196 208
209our %_IMGCACHE;
197our $HOME; 210our $HOME;
198our ($self, $old, $new); 211our ($self, $old, $new);
199our ($x, $y, $w, $h); 212our ($x, $y, $w, $h);
200 213
201# enforce at least this interval between updates 214# enforce at least this interval between updates
202our $MIN_INTERVAL = 1/100; 215our $MIN_INTERVAL = 6/59.951;
203 216
204{ 217{
205 package urxvt::bgdsl; # background language 218 package urxvt::bgdsl; # background language
219
220 use List::Util qw(min max sum shuffle);
206 221
207=head2 PROVIDERS/GENERATORS 222=head2 PROVIDERS/GENERATORS
208 223
209These functions provide an image, by loading it from disk, grabbing it 224These functions provide an image, by loading it from disk, grabbing it
210from the root screen or by simply generating it. They are used as starting 225from the root screen or by simply generating it. They are used as starting
… …
252If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is 267If C<$width> and C<$height> are omitted, it creates a 1x1 image, which is
253useful for solid backgrounds or for use in filtering effects. 268useful for solid backgrounds or for use in filtering effects.
254 269
255=cut 270=cut
256 271
257 sub solid($$;$) { 272 sub solid($;$$) {
258 my $colour = pop; 273 my $colour = pop;
259 274
260 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1); 275 my $img = $self->new_img (urxvt::PictStandardARGB32, $_[0] || 1, $_[1] || 1);
261 $img->fill ($colour); 276 $img->fill ($colour);
262 $img 277 $img
263 } 278 }
264 279
280=item clone $img
281
282Returns an exact copy of the image. This is useful if you want to have
283multiple copies of the same image to apply different effects to.
284
285=cut
286
287 sub clone($) {
288 $_[0]->clone
289 }
290
265=back 291=back
266 292
293=head2 TILING MODES
294
295The following operators modify the tiling mode of an image, that is, the
296way that pixels outside the image area are painted when the image is used.
297
298=over 4
299
300=item tile $img
301
302Tiles the whole plane with the image and returns this new image - or in
303other words, it returns a copy of the image in plane tiling mode.
304
305Example: load an image and tile it over the background, without
306resizing. The C<tile> call is superfluous because C<load> already defaults
307to tiling mode.
308
309 tile load "mybg.png"
310
311=item mirror $img
312
313Similar to tile, but reflects the image each time it uses a new copy, so
314that top edges always touch top edges, right edges always touch right
315edges and so on (with normal tiling, left edges always touch right edges
316and top always touch bottom edges).
317
318Example: load an image and mirror it over the background, avoiding sharp
319edges at the image borders at the expense of mirroring the image itself
320
321 mirror load "mybg.png"
322
323=item pad $img
324
325Takes an image and modifies it so that all pixels outside the image area
326become transparent. This mode is most useful when you want to place an
327image over another image or the background colour while leaving all
328background pixels outside the image unchanged.
329
330Example: load an image and display it in the upper left corner. The rest
331of the space is left "empty" (transparent or wahtever your compisotr does
332in alpha mode, else background colour).
333
334 pad load "mybg.png"
335
336=item extend $img
337
338Extends the image over the whole plane, using the closest pixel in the
339area outside the image. This mode is mostly useful when you more complex
340filtering operations and want the pixels outside the image to have the
341same values as the pixels near the edge.
342
343Example: just for curiosity, how does this pixel extension stuff work?
344
345 extend move 50, 50, load "mybg.png"
346
347=cut
348
349 sub pad($) {
350 my $img = $_[0]->clone;
351 $img->repeat_mode (urxvt::RepeatNone);
352 $img
353 }
354
355 sub tile($) {
356 my $img = $_[0]->clone;
357 $img->repeat_mode (urxvt::RepeatNormal);
358 $img
359 }
360
361 sub mirror($) {
362 my $img = $_[0]->clone;
363 $img->repeat_mode (urxvt::RepeatReflect);
364 $img
365 }
366
367 sub extend($) {
368 my $img = $_[0]->clone;
369 $img->repeat_mode (urxvt::RepeatPad);
370 $img
371 }
372
373=back
374
267=head2 VARIABLES 375=head2 VARIABLE VALUES
268 376
269The following functions provide variable data such as the terminal window 377The following functions provide variable data such as the terminal window
270dimensions. They are not (Perl-) variables, they jsut return stuff that 378dimensions. They are not (Perl-) variables, they just return stuff that
271varies. Most of them make your expression sensitive to some events, for 379varies. Most of them make your expression sensitive to some events, for
272example using C<TW> (terminal width) means your expression is evaluated 380example using C<TW> (terminal width) means your expression is evaluated
273again when the terminal is resized. 381again when the terminal is resized.
274 382
275=over 4 383=over 4
… …
349 $self->{counter} + 0 457 $self->{counter} + 0
350 } 458 }
351 459
352=back 460=back
353 461
354=head2 TILING MODES 462=head2 SHAPE CHANGING OPERATORS
355 463
356The following operators modify the tiling mode of an image, that is, the 464The following operators modify the shape, size or position of the image.
357way that pixels outside the image area are painted when the image is used.
358 465
359=over 4 466=over 4
360
361=item tile $img
362
363Tiles the whole plane with the image and returns this new image - or in
364other words, it returns a copy of the image in plane tiling mode.
365
366Example: load an image and tile it over the background, without
367resizing. The C<tile> call is superfluous because C<load> already defaults
368to tiling mode.
369
370 tile load "mybg.png"
371
372=item mirror $img
373
374Similar to tile, but reflects the image each time it uses a new copy, so
375that top edges always touch top edges, right edges always touch right
376edges and so on (with normal tiling, left edges always touch right edges
377and top always touch bottom edges).
378
379Example: load an image and mirror it over the background, avoiding sharp
380edges at the image borders at the expense of mirroring the image itself
381
382 mirror load "mybg.png"
383
384=item pad $img
385
386Takes an image and modifies it so that all pixels outside the image area
387become transparent. This mode is most useful when you want to place an
388image over another image or the background colour while leaving all
389background pixels outside the image unchanged.
390
391Example: load an image and display it in the upper left corner. The rest
392of the space is left "empty" (transparent or wahtever your compisotr does
393in alpha mode, else background colour).
394
395 pad load "mybg.png"
396
397=item extend $img
398
399Extends the image over the whole plane, using the closest pixel in the
400area outside the image. This mode is mostly useful when you more complex
401filtering operations and want the pixels outside the image to have the
402same values as the pixels near the edge.
403
404Example: just for curiosity, how does this pixel extension stuff work?
405
406 extend move 50, 50, load "mybg.png"
407
408=cut
409
410 sub pad($) {
411 my $img = $_[0]->clone;
412 $img->repeat_mode (urxvt::RepeatNone);
413 $img
414 }
415
416 sub tile($) {
417 my $img = $_[0]->clone;
418 $img->repeat_mode (urxvt::RepeatNormal);
419 $img
420 }
421
422 sub mirror($) {
423 my $img = $_[0]->clone;
424 $img->repeat_mode (urxvt::RepeatReflect);
425 $img
426 }
427
428 sub extend($) {
429 my $img = $_[0]->clone;
430 $img->repeat_mode (urxvt::RepeatPad);
431 $img
432 }
433
434=back
435
436=head2 PIXEL OPERATORS
437
438The following operators modify the image pixels in various ways.
439
440=over 4
441
442=item clone $img
443
444Returns an exact copy of the image.
445
446=cut
447
448 sub clone($) {
449 $_[0]->clone
450 }
451 467
452=item clip $img 468=item clip $img
453 469
454=item clip $width, $height, $img 470=item clip $width, $height, $img
455 471
… …
479 $img->sub_rect ($_[0], $_[1], $w, $h) 495 $img->sub_rect ($_[0], $_[1], $w, $h)
480 } 496 }
481 497
482=item scale $img 498=item scale $img
483 499
484=item scale $size_percent, $img 500=item scale $size_factor, $img
485 501
486=item scale $width_percent, $height_percent, $img 502=item scale $width_factor, $height_factor, $img
487 503
488Scales the image by the given percentages in horizontal 504Scales the image by the given factors in horizontal
489(C<$width_percent>) and vertical (C<$height_percent>) direction. 505(C<$width>) and vertical (C<$height>) direction.
490 506
491If only one percentage is give, it is used for both directions. 507If only one factor is give, it is used for both directions.
492 508
493If no percentages are given, scales the image to the window size without 509If no factors are given, scales the image to the window size without
494keeping aspect. 510keeping aspect.
495 511
496=item resize $width, $height, $img 512=item resize $width, $height, $img
497 513
498Resizes the image to exactly C<$width> times C<$height> pixels. 514Resizes the image to exactly C<$width> times C<$height> pixels.
499 515
500=cut 516=item fit $img
501 517
502#TODO: maximise, maximise_fill? 518=item fit $width, $height, $img
519
520Fits the image into the given C<$width> and C<$height> without changing
521aspect, or the terminal size. That means it will be shrunk or grown until
522the whole image fits into the given area, possibly leaving borders.
523
524=item cover $img
525
526=item cover $width, $height, $img
527
528Similar to C<fit>, but shrinks or grows until all of the area is covered
529by the image, so instead of potentially leaving borders, it will cut off
530image data that doesn't fit.
531
532=cut
503 533
504 sub scale($;$;$) { 534 sub scale($;$;$) {
505 my $img = pop; 535 my $img = pop;
506 536
507 @_ == 2 ? $img->scale ($_[0] * $img->w * 0.01, $_[1] * $img->h * 0.01) 537 @_ == 2 ? $img->scale ($_[0] * $img->w, $_[1] * $img->h)
508 : @_ ? $img->scale ($_[0] * $img->w * 0.01, $_[0] * $img->h * 0.01) 538 : @_ ? $img->scale ($_[0] * $img->w, $_[0] * $img->h)
509 : $img->scale (TW, TH) 539 : $img->scale (TW, TH)
510 } 540 }
511 541
512 sub resize($$$) { 542 sub resize($$$) {
513 my $img = pop; 543 my $img = pop;
514 $img->scale ($_[0], $_[1]) 544 $img->scale ($_[0], $_[1])
545 }
546
547 sub fit($;$$) {
548 my $img = pop;
549 my $w = ($_[0] || TW) / $img->w;
550 my $h = ($_[1] || TH) / $img->h;
551 scale +(min $w, $h), $img
552 }
553
554 sub cover($;$$) {
555 my $img = pop;
556 my $w = ($_[0] || TW) / $img->w;
557 my $h = ($_[1] || TH) / $img->h;
558 scale +(max $w, $h), $img
515 } 559 }
516 560
517=item move $dx, $dy, $img 561=item move $dx, $dy, $img
518 562
519Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in 563Moves the image by C<$dx> pixels in the horizontal, and C<$dy> pixels in
520the vertical. 564the vertical.
521 565
522Example: move the image right by 20 pixels and down by 30. 566Example: move the image right by 20 pixels and down by 30.
523 567
524 move 20, 30, ... 568 move 20, 30, ...
569
570=item align $xalign, $yalign, $img
571
572Aligns the image according to a factor - C<0> means the image is moved to
573the left or top edge (for C<$xalign> or C<$yalign>), C<0.5> means it is
574exactly centered and C<1> means it touches the right or bottom edge.
575
576Example: remove any visible border around an image, center it vertically but move
577it to the right hand side.
578
579 align 1, 0.5, pad $img
580
581=item center $img
582
583=item center $width, $height, $img
584
585Centers the image, i.e. the center of the image is moved to the center of
586the terminal window (or the box specified by C<$width> and C<$height> if
587given).
588
589Example: load an image and center it.
590
591 center pad load "mybg.png"
525 592
526=item rootalign $img 593=item rootalign $img
527 594
528Moves the image so that it appears glued to the screen as opposed to the 595Moves the image so that it appears glued to the screen as opposed to the
529window. This gives the illusion of a larger area behind the window. It is 596window. This gives the illusion of a larger area behind the window. It is
… …
535 rootalign mirror load "mybg.png" 602 rootalign mirror load "mybg.png"
536 603
537Example: take the screen background and align it, giving the illusion of 604Example: take the screen background and align it, giving the illusion of
538transparency as long as the window isn't in front of other windows. 605transparency as long as the window isn't in front of other windows.
539 606
540 rootalign root 607 rootalign root
541 608
542=cut 609=cut
543 610
544 sub move($$;$) { 611 sub move($$;$) {
545 my $img = pop->clone; 612 my $img = pop->clone;
546 $img->move ($_[0], $_[1]); 613 $img->move ($_[0], $_[1]);
547 $img 614 $img
548 } 615 }
549 616
617 sub align($;$$) {
618 my $img = pop;
619
620 move $_[0] * (TW - $img->w),
621 $_[1] * (TH - $img->h),
622 $img
623 }
624
625 sub center($;$$) {
626 my $img = pop;
627 my $w = $_[0] || TW;
628 my $h = $_[1] || TH;
629
630 move 0.5 * ($w - $img->w), 0.5 * ($h - $img->h), $img
631 }
632
550 sub rootalign($) { 633 sub rootalign($) {
551 move -TX, -TY, $_[0] 634 move -TX, -TY, $_[0]
552 } 635 }
553 636
637=back
638
639=head2 COLOUR MODIFICATIONS
640
641The following operators change the pixels of the image.
642
643=over 4
644
554=item contrast $factor, $img 645=item contrast $factor, $img
555 646
556=item contrast $r, $g, $b, $img 647=item contrast $r, $g, $b, $img
557 648
558=item contrast $r, $g, $b, $a, $img 649=item contrast $r, $g, $b, $a, $img
559 650
560Adjusts the I<contrast> of an image. 651Adjusts the I<contrast> of an image.
561 652
562#TODO# 653The first form applies a single C<$factor> to red, green and blue, the
654second form applies separate factors to each colour channel, and the last
655form includes the alpha channel.
563 656
657Values from 0 to 1 lower the contrast, values higher than 1 increase the
658contrast.
659
660Due to limitations in the underlying XRender extension, lowering contrast
661also reduces brightness, while increasing contrast currently also
662increases brightness.
663
564=item brightness $factor, $img 664=item brightness $bias, $img
565 665
566=item brightness $r, $g, $b, $img 666=item brightness $r, $g, $b, $img
567 667
568=item brightness $r, $g, $b, $a, $img 668=item brightness $r, $g, $b, $a, $img
569 669
570Adjusts the brightness of an image. 670Adjusts the brightness of an image.
571 671
672The first form applies a single C<$bias> to red, green and blue, the
673second form applies separate biases to each colour channel, and the last
674form includes the alpha channel.
675
676Values less than 0 reduce brightness, while values larger than 0 increase
677it. Useful range is from -1 to 1 - the former results in a black, the
678latter in a white picture.
679
680Due to idiosynchrasies in the underlying XRender extension, biases less
681than zero can be I<very> slow.
682
572=cut 683=cut
573 684
574 sub contrast($$;$$;$) { 685 sub contrast($$;$$;$) {
575 my $img = pop; 686 my $img = pop;
576 my ($r, $g, $b, $a) = @_; 687 my ($r, $g, $b, $a) = @_;
577 688
578 ($g, $b) = ($r, $r) if @_ < 4; 689 ($g, $b) = ($r, $r) if @_ < 3;
579 $a = 1 if @_ < 5; 690 $a = 1 if @_ < 4;
580 691
581 $img = $img->clone; 692 $img = $img->clone;
582 $img->contrast ($r, $g, $b, $a); 693 $img->contrast ($r, $g, $b, $a);
583 $img 694 $img
584 } 695 }
585 696
586 sub brightness($$;$$;$) { 697 sub brightness($$;$$;$) {
587 my $img = pop; 698 my $img = pop;
588 my ($r, $g, $b, $a) = @_; 699 my ($r, $g, $b, $a) = @_;
589 700
590 ($g, $b) = ($r, $r) if @_ < 4; 701 ($g, $b) = ($r, $r) if @_ < 3;
591 $a = 1 if @_ < 5; 702 $a = 1 if @_ < 4;
592 703
593 $img = $img->clone; 704 $img = $img->clone;
594 $img->brightness ($r, $g, $b, $a); 705 $img->brightness ($r, $g, $b, $a);
595 $img 706 $img
596 } 707 }
… …
615 } 726 }
616 727
617=item rotate $new_width, $new_height, $center_x, $center_y, $degrees 728=item rotate $new_width, $new_height, $center_x, $center_y, $degrees
618 729
619Rotates the image by C<$degrees> degrees, counter-clockwise, around the 730Rotates the image by C<$degrees> degrees, counter-clockwise, around the
620pointer at C<$center_x> and C<$center_y> (specified as percentage of image 731pointer at C<$center_x> and C<$center_y> (specified as factor of image
621width/height), generating a new image with width C<$new_width> and height 732width/height), generating a new image with width C<$new_width> and height
622C<$new_height>. 733C<$new_height>.
623 734
624#TODO# new width, height, maybe more operators? 735#TODO# new width, height, maybe more operators?
625 736
… …
630 sub rotate($$$$$$) { 741 sub rotate($$$$$$) {
631 my $img = pop; 742 my $img = pop;
632 $img->rotate ( 743 $img->rotate (
633 $_[0], 744 $_[0],
634 $_[1], 745 $_[1],
635 $_[2] * $img->w * .01, 746 $_[2] * $img->w,
636 $_[3] * $img->h * .01, 747 $_[3] * $img->h,
637 $_[4] * (3.14159265 / 180), 748 $_[4] * (3.14159265 / 180),
638 ) 749 )
639 } 750 }
640 751
641=back 752=back
… …
686 797
687 # evaluate user expression 798 # evaluate user expression
688 799
689 my $img = eval { $self->{expr}->() }; 800 my $img = eval { $self->{expr}->() };
690 warn $@ if $@;#d# 801 warn $@ if $@;#d#
691 die if !UNIVERSAL::isa $img, "urxvt::img"; 802 die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img";
692 803
693 $state->{size_sensitive} = 1 804 $state->{size_sensitive} = 1
694 if $img->repeat_mode != urxvt::RepeatNormal; 805 if $img->repeat_mode != urxvt::RepeatNormal;
695 806
696 # if the expression is sensitive to external events, prepare reevaluation then 807 # if the expression is sensitive to external events, prepare reevaluation then
… …
746} 857}
747 858
748sub on_start { 859sub on_start {
749 my ($self) = @_; 860 my ($self) = @_;
750 861
751 my $expr = $self->x_resource ("background.expr") 862 my $expr = $self->x_resource ("%.expr")
752 or return; 863 or return;
753 864
865 $self->has_render
866 or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n";
867
754 $self->set_expr (parse_expr $expr); 868 $self->set_expr (parse_expr $expr);
755 $self->{border} = $self->x_resource_boolean ("background.border"); 869 $self->{border} = $self->x_resource_boolean ("%.border");
870
871 $MIN_INTERVAL = $self->x_resource ("%.interval");
756 872
757 () 873 ()
758} 874}
759 875

Diff Legend

– Removed lines
+ Added lines
< Changed lines
> Changed lines