Skip to content

Instantly share code, notes, and snippets.

Embed
What would you like to do?
byzanz_window: Use byzanz to create a GIF screencast of a specific window
#!/usr/bin/env python
"""
Use byzanz to create a GIF screencast of a specific window.
Required tools:
sudo apt-get install byzanz x11-utils xdotool
A tip: use an extra-long duration (-d 100), record your shot, and use
gimp to shorten the duration of the last frame. You need to rename the layer
from "Frame 123 (100000 ms) (combine)" to "Frame 123 (1000 ms) (combine)".
"""
from __future__ import print_function
import sys
from subprocess import check_call, check_output, call
import re
def byzanz_window(filename, duration=10, delay=1, is_cursor=False,
is_audio=False, is_verbose=False):
print("Select the window you like to capture.")
winid = check_output('xdotool selectwindow'.split()).strip()
wininfo = check_output(['xwininfo', '-id', winid])
x = int(re.search(r'Absolute upper-left X:\s*(\d+)', wininfo).group(1))
y = int(re.search(r'Absolute upper-left Y:\s*(\d+)', wininfo).group(1))
width = int(re.search(r'Width:\s*(\d+)', wininfo).group(1))
height = int(re.search(r'Height:\s*(\d+)', wininfo).group(1))
xprop = check_output(['xprop', '-id', winid])
match = re.search(r'_NET_FRAME_EXTENTS\(CARDINAL\) = (\d+), (\d+), (\d+), (\d+)', xprop)
left, right, top, bottom = map(int, match.groups())
print("Press enter when you are ready to capture.")
raw_input()
check_call(['xdotool', 'windowactivate', winid])
byzanz_args = ['-d', str(duration), '--delay='+str(delay)]
if is_cursor: byzanz_args.append('-c')
if is_audio: byzanz_args.append('-a')
if is_verbose: byzanz_args.append('-v')
byzanz_args.append(filename)
args = ['byzanz-record', '-x', str(x-left), '-y', str(y-top),
'-w', str(width+left+right), '-h', str(height+top+bottom)] + byzanz_args
if is_verbose:
print(' '.join(args), file=sys.stderr)
r = call(args)
return r
def main():
import argparse
parser = argparse.ArgumentParser(description='Call byzanz to capture a window.')
parser.add_argument('filename', help='GIF file name to save')
parser.add_argument('-d', '--duration', metavar='SECS', type=int, default=10,
help='Duration of animation (default: 10 seconds)')
parser.add_argument('--delay', metavar='SECS', type=int, default=1,
help='Delay before start (default: 1 second)')
parser.add_argument('-c', '--cursor', action='store_true',
help='Record mouse cursor')
parser.add_argument('-a', '--audio', action='store_true',
help='Record audio')
parser.add_argument('-v', '--verbose', action='store_true',
help='Be verbose')
args = parser.parse_args()
sys.exit(byzanz_window(args.filename, args.duration, args.delay, args.cursor,
args.audio, args.verbose))
if __name__ == '__main__':
main()
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.