Merge lp:~jibel/phablet-tools/lp1238839_phablet-screenshot into lp:phablet-tools

[Jean-Baptiste Lallement]

Add script phablet-screenshot to take screenshots on devices running Mir.

Add script phablet-screenshot to take screenshot of devices running Mir as Mir doesn't have a screencap equivalent.
Screenshot is taken by dumping first frame of /dev/fb.

Known issues:
- Doesn't work on maguro (device freezes), this device is blacklisted
- On dual boot devices, the dump shows the boot screen not the active buffer.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:224
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/243/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/15
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/15

Click here to trigger a rebuild:
http://s-jenkins:8080/job/phablet-tools-ci/243/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

imagemagick should be in debian/control

I can't really test this, as I have a maguro. So I've only tested the odd condition of unsupported.
The error message could be nicer though ./phablet-screenshot: 171: ./phablet-screenshot: SUPPORTED: parameter not set

SUPPORTED is not defined anywhere, which explains the wrong error message.

review: Needs Fixing

[Ricardo Salveti (rsalveti)]

Jean, any news on this MR? Would be nice to get it merged soon, as it's quite useful for bug reporting.

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:225
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/258/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/30
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/30
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/30

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/258/rebuild

review: Approve (continuous-integration)

[lp:~jibel/phablet-tools/lp1238839_phablet-screenshot]

226. By Jean-Baptiste Lallement on 2013-11-27

* phablet-screenshot: Add support for screencap if surfaceflinger is running instead of Mir

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:226
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/259/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/31
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/31
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/31

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/259/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

40 +# TODO:
41 +# - detect that it is running Mir and fallback to screencap if it is SF
42 +

This TODO should be removed.

Tested on maguro and manta, does the right thing.

review: Needs Fixing

[Ricardo Salveti (rsalveti)]

Tested with mako (mir), works fine.

review: Approve

[lp:~jibel/phablet-tools/lp1238839_phablet-screenshot]

227. By Jean-Baptiste Lallement on 2013-11-28

* phablet-screenshot: Mir support is added, removed TODO

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:227
http://jenkins.qa.ubuntu.com/job/phablet-tools-ci/260/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-amd64-ci/32
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-armhf-ci/32
    SUCCESS: http://jenkins.qa.ubuntu.com/job/phablet-tools-trusty-i386-ci/32

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/phablet-tools-ci/260/rebuild

review: Approve (continuous-integration)

[Sergio Schvezov (sergiusens)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

review: Approve (continuous-integration)

=== modified file 'debian/control'
--- debian/control	2013-09-07 11:39:27 +0000
+++ debian/control	2013-11-28 06:00:08 +0000
@@ -40,6 +40,7 @@
  ${misc:Depends},
  ${python:Depends},
 Recommends:
+ imagemagick,
  ubuntu-dev-tools,
 Description: Scripts to work with Phablet.
  Installs Touch Developer Preview on Nexus devices, specifically the following:

=== added file 'phablet-screenshot'
--- phablet-screenshot	1970-01-01 00:00:00 +0000
+++ phablet-screenshot	2013-11-28 06:00:08 +0000
@@ -0,0 +1,220 @@
+#!/bin/sh
+
+#
+# Screen capture of Mir devices
+#
+
+# Copyright (C) 2013 Canonical
+#
+# Authors: Jean-Baptiste Lallement <[e-mail]>
+#
+# This program is free software; you can redistribute it and/or modify it #
+# under the terms of the GNU General Public License as published by the Free #
+# Software Foundation; version 3.
+#
+# This program is distributed in the hope that it will be useful, but WITHOUT
+# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or #
+# FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
+# # details.
+#
+# You should have received a copy of the GNU General Public License along with
+# this program; if not, write to the Free Software Foundation, Inc., 51 Franklin
+# Street, Fifth Floor, Boston, MA 02110-1301 USA
+set -eu
+
+PICDIR=$(mktemp -d /tmp/$(basename $0).XXXXXX)
+FBDEV=fb0
+ADBOPTS=""
+CONVERTOPTS="-alpha off"
+UNSUPPORTED="maguro"
+REQUIREDPKGS="android-tools-adb imagemagick"
+
+size=""
+
+cleanup() {
+    #
+    # Cleanup temporary files
+    #
+    [ -d "$PICDIR" ] && rm -Rf "$PICDIR"
+}
+trap cleanup EXIT INT QUIT ABRT PIPE TERM
+
+usage() {
+    #
+    # Print usage and exit
+    #
+    cat <<EOF
+Usage: $(basename $0) [OPTIONS...] <FILENAME>
+Dump /dev/$FBDEV from a touch device and write it to FILENAME
+
+Arguments:
+    FILENAME    Name of the output image, the output format must be supported by
+                convert from the package imagemagick.
+Options
+    -d,--debug  Enable debug
+    -h,--help   This help
+    -s,--serial SERIAL   
+                Serial number of the device
+    -r,--resolution GEOMETRY
+                Width and height of the image instead of default for device
+                (e.g 720x1280)
+    -z,--resize FACTOR
+                Resize the image
+
+EOF
+    exit 1
+}
+
+check_prerequisites() {
+    # Check list of required packages
+    okay=1
+    pkgs="$REQUIREDPKGS"
+    for pkg in $pkgs; do
+        if ! dpkg-query -W -f '${Status}\t${Package}\n' $pkg 2>/dev/null| grep "ok installed" >/dev/null 2>&1; then
+            okay=0
+            echo "E: Package '$pkg' is required and is not installed."
+        fi
+    done
+
+    if [ $okay -ne 1 ]; then
+        echo "E: pre-requisites are not met. Exiting!"
+        exit 1
+    fi
+}
+
+get_device() {
+    # Get device name
+    device=$(adb $ADBOPTS shell getprop ro.cm.device)
+    echo "$device"|tr -d '\r'
+}
+
+is_supported() {
+    # Returns 0 is a device is supported
+    if echo "$UNSUPPORTED"|grep -qw $1 >/dev/null 2>&1; then
+        return 1
+    else
+        return 0
+    fi
+}
+
+get_mode() {
+    # Find graphics mode
+    size=$(adb $ADBOPTS shell head -1 /sys/devices/virtual/graphics/$FBDEV/modes| cut -d: -f2|cut -d 'p' -f1)
+
+    # Fallback to hardcoded values
+    #if ! echo "$size"|grep -qE '^\[0-9\]+x\[0-9\]+$' >/dev/null 2>&1; then
+    if ! echo "$size"|grep -qE '^[0-9]+x[0-9]+$' >/dev/null 2>&1; then
+        device="$(get_device)"
+        case "$device" in
+            maguro)
+                size=720x1280
+                ;;
+            mako)
+                size=768x1280
+                ;;
+            manta)
+                size=1600x2560
+                ;;
+            grouper)
+                size=800x1280
+                ;;
+            *)
+                size=""
+                ;;
+        esac
+    fi
+    echo $size
+}
+
+sf_is_running() {
+    #  Return 0 if surface flinger is running then we'll use screencap
+    #  instead
+    sf=$(adb $ADBOPTS shell pidof surfaceflinger)
+    if [ -z "$sf" ]; then
+        return 1
+    else
+        echo "I: surfaceflinger detected"
+        return 0
+    fi
+}
+
+screenshot_mir() {
+    # Dump framebuffer to capture Mir screenshot
+    #
+    # Arguments:
+    #   $1: Size
+    #   $2: Depth
+    size=$1
+    depth=$2
+
+    CONVERTOPTS="$CONVERTOPTS -depth $depth -size $size"
+
+    echo "I: Dumping $FBDEV ..."
+    adb $ADBOPTS shell "kill -SIGSTOP \$(pidof unity8)"
+    adb $ADBOPTS pull /dev/$FBDEV ${PICDIR}/fb
+    adb $ADBOPTS shell "kill -SIGCONT \$(pidof unity8)"
+
+    [ ! -e "${PICDIR}/fb" ] && echo "E: Capture failed!" && return
+    convert $CONVERTOPTS rgba:${PICDIR}/fb[0] $DST
+}
+
+screenshot_sf() {
+    # Use screencap if surfaceflinger is running
+    echo "I: Capturing screenshot with screencap ..."
+    capfile=screencap.png
+    adb $ADBOPTS shell /system/bin/screencap /tmp/$capfile
+    adb $ADBOPTS pull /tmp/$capfile ${PICDIR}/$capfile
+
+    [ ! -e "${PICDIR}/${capfile}" ] && echo "E: Capture failed!" && return
+    convert $CONVERTOPTS ${PICDIR}/$capfile $DST
+}
+
+SHORTOPTS="hdr:s:z:"
+LONGOPTS="help,debug,resolution:,serial:,resize:"
+
+TEMP=$(getopt -o $SHORTOPTS --long $LONGOPTS -- "$@")
+eval set -- "$TEMP"
+
+while true ; do
+    case "$1" in
+        -h|--help)
+            usage;;
+        -d|--debug)
+            set -x
+            shift;;
+        -r|--resolution)
+            size=$2
+            shift 2;;
+        -s|--serial)
+            ADBOPTS="$ADBOPTS -s $2"
+            shift 2;; 
+        -z|--resize)
+            CONVERTOPTS="$CONVERTOPTS -resize $2"
+            shift 2;;
+        --) shift;
+            break;;
+        *) usage;;
+    esac
+done
+
+[ $# -eq 0 ] && usage
+DST=$1
+
+check_prerequisites
+
+if sf_is_running; then
+    # Use screencap for surfaceflinger
+    screenshot_sf
+else
+    # Otherwise just dump the framebuffer
+    # Set resolution and depth for device
+    depth=8
+    [ -z "$size" ] && size="$(get_mode)"
+    device="$(get_device)"
+    if [ -z "$size" ] || ! is_supported "$device"; then
+        echo "E: Device '$device' is not supported."
+        exit 1
+    fi
+    screenshot_mir "$size" "$depth"
+fi
+echo "I: Done"

=== modified file 'setup.py'
--- setup.py	2013-09-23 01:43:32 +0000
+++ setup.py	2013-11-28 06:00:08 +0000
@@ -14,6 +14,7 @@
 
 SH_SCRIPTS = [
     'phablet-network',
+    'phablet-screenshot',
     'phablet-test-run',
     ]