2 # Copyright © 2001-2015 Jamie Zawinski <jwz@jwz.org>.
4 # Permission to use, copy, modify, distribute, and sell this software and its
5 # documentation for any purpose is hereby granted without fee, provided that
6 # the above copyright notice appear in all copies and that both that
7 # copyright notice and this permission notice appear in supporting
8 # documentation. No representations are made about the suitability of this
9 # software for any purpose. It is provided "as is" without express or
12 # This program attempts to grab a single frame of video from the system's
13 # video capture card, and then load it on to the root window using the
14 # "xscreensaver-getimage-file" program. Various frame-grabbing programs
15 # are known, and the first one found is used.
17 # The various xscreensaver hacks that manipulate images ("slidescreen",
18 # "jigsaw", etc.) get the image to manipulate by running the
19 # "xscreensaver-getimage" program.
21 # The various screen savers invoke "xscreensaver-getimage", which will in
22 # turn invoke this program, depending on the value of the "grabVideoFrames"
23 # setting in the ~/.xscreensaver file (or in the app-defaults file, usually
24 # /usr/lib/X11/app-defaults/XScreenSaver).
26 # Created: 13-Apr-2001.
29 #use diagnostics; # Fails on some MacOS 10.5 systems
32 my $progname = $0; $progname =~ s@.*/@@g;
33 my $version = q{ $Revision: 1.23 $ }; $version =~ s/^[^0-9]+([0-9.]+).*$/$1/;
35 my $tmpdir = $ENV{TMPDIR} || "/tmp";
36 my $tmpfile = sprintf("%s/xssv.%08x.ppm", $tmpdir, rand(0xFFFFFFFF));
41 # These are programs that can be used to grab a video frame. The first one
42 # of these programs that exists on $PATH will be used, and the image file
43 # is assumed to be written to $tmpfile (in some image format acceptable to
44 # "xscreensaver-getimage-file", e.g., PPM or JPEG.)
46 # If you add other programs to this list, please let me know!
50 "bttvgrab -d q -Q -l 1 -o ppm -f $tmpfile", # BTTV
51 "qcam > $tmpfile", # Connectix Qcam
52 "gqcam -t PPM -d $tmpfile", # GTK+ Qcam clone
54 "v4lctl snap ppm full $tmpfile", # XawTV 3.94.
56 "streamer -a -s 768x576 -o $tmpfile", # XawTV
57 # the "-a" option ("mute audio") arrived with XawTV 3.76.
59 "atitv snap $tmpfile", # ATI video capture card
61 "grab -type ppm -format ntsc -source 1 " . # *BSD BT848 module
62 "-settle 0.75 -output $tmpfile",
64 "motioneye -j $tmpfile", # Sony Vaio MotionEye
65 # (hardware jpeg encoder)
67 "vidcat -b -f ppm -s 640x480 > $tmpfile 2>&-", # w3cam/ovcam
69 "vidtomem -f $tmpfile 2>&- " . # Silicon Graphics
70 "&& mv $tmpfile-00000.rgb $tmpfile",
73 # "ffmpeg -i /dev/video0 -ss 00:00:01 -vframes 1 $tmpfile 2>&-",
75 # "mplayer -really-quiet tv://0 " . # Maybe works with some cams?
76 # "-ao null -vo pnm -frames 1 2>&- " .
77 # "&& mv 00000001.ppm $tmpfile",
84 print STDERR "$progname: $e\n";
91 foreach my $cmd (@programs) {
93 my ($name) = m/^([^ ]+)/;
94 push @names, "\"$name\"";
95 print STDERR "$progname: looking for $name...\n" if ($verbose > 2);
96 foreach my $dir (split (/:/, $ENV{PATH})) {
97 print STDERR "$progname: checking $dir/$name\n" if ($verbose > 3);
98 if (-x "$dir/$name") {
104 $names[$#names] = "or " . $names[$#names];
105 error ("none of: " . join (", ", @names) . " were found on \$PATH.");
110 my $cmd = pick_grabber();
113 print STDERR "$progname: executing \"$cmd\"\n" if ($verbose);
118 error ("\"$cmd\" produced no data.");
121 print STDERR "$progname: wrote \"$tmpfile\"\n" if ($verbose);
122 print STDOUT "$tmpfile\n";
127 print STDERR "usage: $progname [--verbose] [--name | --stdout]\n";
132 while ($_ = $ARGV[0]) {
134 if (m/^--?verbose$/s) { $verbose++; }
135 elsif (m/^-v+$/s) { $verbose += length($_)-1; }
136 elsif (m/^--?name$/s) { } # ignored, for compatibility
137 elsif (m/^-./) { usage; }