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 | #:META:X_RESOURCE:%.interval:seconds:minimum time between updates |
6 | |
|
|
7 | #TODO: once, rootalign |
|
|
8 | |
6 | |
9 | =head1 NAME |
7 | =head1 NAME |
10 | |
8 | |
11 | background - manage terminal background |
9 | background - manage terminal background |
12 | |
10 | |
… | |
… | |
59 | |
57 | |
60 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
58 | For example, an expression such as C<scale load "$HOME/mybg.png"> scales the |
61 | image to the window size, so it relies on the window size and will |
59 | image to the window size, so it relies on the window size and will |
62 | be reevaluated each time it is changed, but not when it moves for |
60 | be reevaluated each time it is changed, but not when it moves for |
63 | example. That ensures that the picture always fills the terminal, even |
61 | example. That ensures that the picture always fills the terminal, even |
64 | after it's size changes. |
62 | after its size changes. |
65 | |
63 | |
66 | =head2 EXPRESSIONS |
64 | =head2 EXPRESSIONS |
67 | |
65 | |
68 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
66 | Expressions are normal Perl expressions, in fact, they are Perl blocks - |
69 | which means you could use multiple lines and statements: |
67 | which means you could use multiple lines and statements: |
… | |
… | |
117 | horizontal and vertical dimensions. For example, this halves the image |
115 | horizontal and vertical dimensions. For example, this halves the image |
118 | width and doubles the image height: |
116 | width and doubles the image height: |
119 | |
117 | |
120 | scale 0.5, 2, load "$HOME/mypic.png" |
118 | scale 0.5, 2, load "$HOME/mypic.png" |
121 | |
119 | |
122 | Other effects than scalign are also readily available, for exmaple, you can |
120 | Other effects than scaling are also readily available, for example, you can |
123 | tile the image to fill the whole window, instead of resizing it: |
121 | tile the image to fill the whole window, instead of resizing it: |
124 | |
122 | |
125 | tile load "$HOME/mypic.png" |
123 | tile load "$HOME/mypic.png" |
126 | |
124 | |
127 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
125 | In fact, images returned by C<load> are in C<tile> mode by default, so the C<tile> operator |
… | |
… | |
153 | This only works for one cycle though, so as long as you load the same |
151 | This only works for one cycle though, so as long as you load the same |
154 | image every time, it will always be cached, but when you load a different |
152 | image every time, it will always be cached, but when you load a different |
155 | image, it will forget about the first one. |
153 | image, it will forget about the first one. |
156 | |
154 | |
157 | This allows you to either speed things up by keeping multiple images in |
155 | This allows you to either speed things up by keeping multiple images in |
158 | memory, or comserve memory by loading images more often. |
156 | memory, or conserve memory by loading images more often. |
159 | |
157 | |
160 | For example, you can keep two images in memory and use a random one like |
158 | For example, you can keep two images in memory and use a random one like |
161 | this: |
159 | this: |
162 | |
160 | |
163 | my $img1 = load "img1.png"; |
161 | my $img1 = load "img1.png"; |
… | |
… | |
193 | Specifying this flag changes the behaviour, so that the image only |
191 | Specifying this flag changes the behaviour, so that the image only |
194 | replaces the background of the character area. |
192 | replaces the background of the character area. |
195 | |
193 | |
196 | =item --background-interval seconds |
194 | =item --background-interval seconds |
197 | |
195 | |
198 | Since some operations in the underlying XRender extension can effetively |
196 | Since some operations in the underlying XRender extension can effectively |
199 | freeze your X-server for prolonged time, this extension enforces a minimum |
197 | freeze your X-server for prolonged time, this extension enforces a minimum |
200 | time between updates, which is normally about 0.1 seconds. |
198 | time between updates, which is normally about 0.1 seconds. |
201 | |
199 | |
202 | If you want to do updates more often, you can decrease this safety |
200 | If you want to do updates more often, you can decrease this safety |
203 | interval with this switch. |
201 | interval with this switch. |
204 | |
202 | |
205 | =back |
203 | =back |
206 | |
204 | |
207 | =cut |
205 | =cut |
208 | |
206 | |
|
|
207 | our %_IMG_CACHE; |
|
|
208 | our %_ONCE_CACHE; |
209 | our $HOME; |
209 | our $HOME; |
210 | our ($self, $old, $new); |
210 | our ($self, $old, $new); |
211 | our ($x, $y, $w, $h); |
211 | our ($x, $y, $w, $h); |
212 | |
212 | |
213 | # enforce at least this interval between updates |
213 | # enforce at least this interval between updates |
… | |
… | |
251 | |
251 | |
252 | =cut |
252 | =cut |
253 | |
253 | |
254 | sub root() { |
254 | sub root() { |
255 | $new->{rootpmap_sensitive} = 1; |
255 | $new->{rootpmap_sensitive} = 1; |
256 | die "root op not supported, exg, we need you"; |
256 | $self->new_img_from_root |
257 | } |
257 | } |
258 | |
258 | |
259 | =item solid $colour |
259 | =item solid $colour |
260 | |
260 | |
261 | =item solid $width, $height, $colour |
261 | =item solid $width, $height, $colour |
… | |
… | |
284 | =cut |
284 | =cut |
285 | |
285 | |
286 | sub clone($) { |
286 | sub clone($) { |
287 | $_[0]->clone |
287 | $_[0]->clone |
288 | } |
288 | } |
289 | |
|
|
290 | =back |
|
|
291 | |
289 | |
292 | =head2 TILING MODES |
290 | =head2 TILING MODES |
293 | |
291 | |
294 | The following operators modify the tiling mode of an image, that is, the |
292 | The following operators modify the tiling mode of an image, that is, the |
295 | way that pixels outside the image area are painted when the image is used. |
293 | way that pixels outside the image area are painted when the image is used. |
… | |
… | |
325 | become transparent. This mode is most useful when you want to place an |
323 | become transparent. This mode is most useful when you want to place an |
326 | image over another image or the background colour while leaving all |
324 | image over another image or the background colour while leaving all |
327 | background pixels outside the image unchanged. |
325 | background pixels outside the image unchanged. |
328 | |
326 | |
329 | Example: load an image and display it in the upper left corner. The rest |
327 | Example: load an image and display it in the upper left corner. The rest |
330 | of the space is left "empty" (transparent or wahtever your compisotr does |
328 | of the space is left "empty" (transparent or whatever your compositor does |
331 | in alpha mode, else background colour). |
329 | in alpha mode, else background colour). |
332 | |
330 | |
333 | pad load "mybg.png" |
331 | pad load "mybg.png" |
334 | |
332 | |
335 | =item extend $img |
333 | =item extend $img |
336 | |
334 | |
337 | Extends the image over the whole plane, using the closest pixel in the |
335 | Extends the image over the whole plane, using the closest pixel in the |
338 | area outside the image. This mode is mostly useful when you more complex |
336 | area outside the image. This mode is mostly useful when you use more complex |
339 | filtering operations and want the pixels outside the image to have the |
337 | filtering operations and want the pixels outside the image to have the |
340 | same values as the pixels near the edge. |
338 | same values as the pixels near the edge. |
341 | |
339 | |
342 | Example: just for curiosity, how does this pixel extension stuff work? |
340 | Example: just for curiosity, how does this pixel extension stuff work? |
343 | |
341 | |
… | |
… | |
434 | C<$seconds> seconds. |
432 | C<$seconds> seconds. |
435 | |
433 | |
436 | Example: load some image and rotate it according to the time of day (as if it were |
434 | Example: load some image and rotate it according to the time of day (as if it were |
437 | the hour pointer of a clock). Update this image every minute. |
435 | the hour pointer of a clock). Update this image every minute. |
438 | |
436 | |
439 | again 60; rotate TW, TH, 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
437 | again 60; rotate 50, 50, (now % 86400) * -720 / 86400, scale load "myclock.png" |
440 | |
438 | |
441 | =item counter $seconds |
439 | =item counter $seconds |
442 | |
440 | |
443 | Like C<again>, but also returns an increasing counter value, starting at |
441 | Like C<again>, but also returns an increasing counter value, starting at |
444 | 0, which might be useful for some simple animation effects. |
442 | 0, which might be useful for some simple animation effects. |
… | |
… | |
631 | |
629 | |
632 | sub rootalign($) { |
630 | sub rootalign($) { |
633 | move -TX, -TY, $_[0] |
631 | move -TX, -TY, $_[0] |
634 | } |
632 | } |
635 | |
633 | |
|
|
634 | =item rotate $center_x, $center_y, $degrees |
|
|
635 | |
|
|
636 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
|
|
637 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
|
|
638 | width/height). |
|
|
639 | |
|
|
640 | #TODO# new width, height, maybe more operators? |
|
|
641 | |
|
|
642 | Example: rotate the image by 90 degrees |
|
|
643 | |
|
|
644 | =cut |
|
|
645 | |
|
|
646 | sub rotate($$$$) { |
|
|
647 | my $img = pop; |
|
|
648 | $img->rotate ( |
|
|
649 | $_[0] * $img->w, |
|
|
650 | $_[1] * $img->h, |
|
|
651 | $_[2] * (3.14159265 / 180), |
|
|
652 | ) |
|
|
653 | } |
|
|
654 | |
636 | =back |
655 | =back |
637 | |
656 | |
638 | =head2 COLOUR MODIFICATIONS |
657 | =head2 COLOUR MODIFICATIONS |
639 | |
658 | |
640 | The following operators change the pixels of the image. |
659 | The following operators change the pixels of the image. |
… | |
… | |
674 | |
693 | |
675 | Values less than 0 reduce brightness, while values larger than 0 increase |
694 | Values less than 0 reduce brightness, while values larger than 0 increase |
676 | it. Useful range is from -1 to 1 - the former results in a black, the |
695 | it. Useful range is from -1 to 1 - the former results in a black, the |
677 | latter in a white picture. |
696 | latter in a white picture. |
678 | |
697 | |
679 | Due to idiosynchrasies in the underlying XRender extension, biases less |
698 | Due to idiosyncrasies in the underlying XRender extension, biases less |
680 | than zero can be I<very> slow. |
699 | than zero can be I<very> slow. |
681 | |
700 | |
682 | =cut |
701 | =cut |
683 | |
702 | |
684 | sub contrast($$;$$;$) { |
703 | sub contrast($$;$$;$) { |
685 | my $img = pop; |
704 | my $img = pop; |
686 | my ($r, $g, $b, $a) = @_; |
705 | my ($r, $g, $b, $a) = @_; |
687 | |
706 | |
688 | ($g, $b) = ($r, $r) if @_ < 4; |
707 | ($g, $b) = ($r, $r) if @_ < 3; |
689 | $a = 1 if @_ < 5; |
708 | $a = 1 if @_ < 4; |
690 | |
709 | |
691 | $img = $img->clone; |
710 | $img = $img->clone; |
692 | $img->contrast ($r, $g, $b, $a); |
711 | $img->contrast ($r, $g, $b, $a); |
693 | $img |
712 | $img |
694 | } |
713 | } |
695 | |
714 | |
696 | sub brightness($$;$$;$) { |
715 | sub brightness($$;$$;$) { |
697 | my $img = pop; |
716 | my $img = pop; |
698 | my ($r, $g, $b, $a) = @_; |
717 | my ($r, $g, $b, $a) = @_; |
699 | |
718 | |
700 | ($g, $b) = ($r, $r) if @_ < 4; |
719 | ($g, $b) = ($r, $r) if @_ < 3; |
701 | $a = 1 if @_ < 5; |
720 | $a = 1 if @_ < 4; |
702 | |
721 | |
703 | $img = $img->clone; |
722 | $img = $img->clone; |
704 | $img->brightness ($r, $g, $b, $a); |
723 | $img->brightness ($r, $g, $b, $a); |
705 | $img |
724 | $img |
706 | } |
725 | } |
… | |
… | |
722 | sub blur($$;$) { |
741 | sub blur($$;$) { |
723 | my $img = pop; |
742 | my $img = pop; |
724 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
743 | $img->blur ($_[0], @_ >= 2 ? $_[1] : $_[0]) |
725 | } |
744 | } |
726 | |
745 | |
727 | =item rotate $new_width, $new_height, $center_x, $center_y, $degrees |
746 | =back |
728 | |
747 | |
729 | Rotates the image by C<$degrees> degrees, counter-clockwise, around the |
748 | =head2 OTHER STUFF |
730 | pointer at C<$center_x> and C<$center_y> (specified as factor of image |
|
|
731 | width/height), generating a new image with width C<$new_width> and height |
|
|
732 | C<$new_height>. |
|
|
733 | |
749 | |
734 | #TODO# new width, height, maybe more operators? |
750 | Anything that didn't fit any of the other categories, even after appliyng |
|
|
751 | force and closing our eyes. |
735 | |
752 | |
736 | Example: rotate the image by 90 degrees |
753 | =over 4 |
737 | |
754 | |
738 | =cut |
755 | =item once { ... } |
739 | |
756 | |
740 | sub rotate($$$$$$) { |
757 | This function takes a code block as argument, that is, one or more |
741 | my $img = pop; |
758 | statements enclosed by braces. |
742 | $img->rotate ( |
759 | |
743 | $_[0], |
760 | The trick is that this code block is only evaluated once - future calls |
744 | $_[1], |
761 | will simply return the original image (yes, it should only be used with |
745 | $_[2] * $img->w, |
762 | images). |
746 | $_[3] * $img->h, |
763 | |
747 | $_[4] * (3.14159265 / 180), |
764 | This can be extremely useful to avoid redoign the same slow operations |
748 | ) |
765 | again and again- for example, if your background expression takes the root |
|
|
766 | background, blurs it and then root-aligns it it would have to blur the |
|
|
767 | root background on every window move or resize. |
|
|
768 | |
|
|
769 | Putting the blur into a C<once> block will make sure the blur is only done |
|
|
770 | once: |
|
|
771 | |
|
|
772 | rootlign once { blur 10, root } |
|
|
773 | |
|
|
774 | This leaves the question of how to force reevaluation of the block, in |
|
|
775 | case the root background changes: Right now, all once blocks forget that |
|
|
776 | they ahve been executed before each time the root background changes (if |
|
|
777 | the expression is sensitive to that) or when C<once_again> is called. |
|
|
778 | |
|
|
779 | =item once_again |
|
|
780 | |
|
|
781 | Resets all C<once> block as if they had never been called, i.e. on the |
|
|
782 | next call they will be reevaluated again. |
|
|
783 | |
|
|
784 | =cut |
|
|
785 | |
|
|
786 | sub once(&) { |
|
|
787 | $_ONCE_CACHE{$_[0]+0} ||= $_[0]() |
|
|
788 | } |
|
|
789 | |
|
|
790 | sub once_again() { |
|
|
791 | %_ONCE_CACHE = (); |
749 | } |
792 | } |
750 | |
793 | |
751 | =back |
794 | =back |
752 | |
795 | |
753 | =cut |
796 | =cut |
… | |
… | |
796 | |
839 | |
797 | # evaluate user expression |
840 | # evaluate user expression |
798 | |
841 | |
799 | my $img = eval { $self->{expr}->() }; |
842 | my $img = eval { $self->{expr}->() }; |
800 | warn $@ if $@;#d# |
843 | warn $@ if $@;#d# |
801 | die if !UNIVERSAL::isa $img, "urxvt::img"; |
844 | die "background-expr did not return an image.\n" if !UNIVERSAL::isa $img, "urxvt::img"; |
802 | |
845 | |
803 | $state->{size_sensitive} = 1 |
846 | $state->{size_sensitive} = 1 |
804 | if $img->repeat_mode != urxvt::RepeatNormal; |
847 | if $img->repeat_mode != urxvt::RepeatNormal; |
805 | |
848 | |
806 | # if the expression is sensitive to external events, prepare reevaluation then |
849 | # if the expression is sensitive to external events, prepare reevaluation then |
… | |
… | |
859 | my ($self) = @_; |
902 | my ($self) = @_; |
860 | |
903 | |
861 | my $expr = $self->x_resource ("%.expr") |
904 | my $expr = $self->x_resource ("%.expr") |
862 | or return; |
905 | or return; |
863 | |
906 | |
|
|
907 | $self->has_render |
|
|
908 | or die "background extension needs RENDER extension 0.10 or higher, ignoring background-expr.\n"; |
|
|
909 | |
864 | $self->set_expr (parse_expr $expr); |
910 | $self->set_expr (parse_expr $expr); |
865 | $self->{border} = $self->x_resource_boolean ("%.border"); |
911 | $self->{border} = $self->x_resource_boolean ("%.border"); |
866 | |
912 | |
867 | $MIN_INTERVAL = $self->x_resource ("%.interval"); |
913 | $MIN_INTERVAL = $self->x_resource ("%.interval"); |
868 | |
914 | |