Merge lp:~kdub/mir/mirscreencast-limited-capture into lp:mir

[Kevin DuBois]

mirscreencast: allow for a limited number of frames to be captured by setting -n <number> on the command line. Useful for taking a screenshot.

mirscreencast: allow for a limited number of frames to be captured by setting -n <number> on the command line. Useful for taking a screenshot.

$ mirscreencast -n 1
$ convert -depth 8 -size 768x1280 mir_screencast_768x1280.rgba out.png
will get you a png of the screencap

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1415
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/900/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/987
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/984
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/579
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/630
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/630/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/637
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/637/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/580
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/580/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/555
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4115

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/900/rebuild

review: Approve (continuous-integration)

[Alberto Aguirre (albaguirre)]

56 + number_of_captures = atoi(optarg);

Maybe replace with
std::stoi(std::string(optarg));

Then it will throw if it can't parse a number.

review: Needs Fixing

[Alan Griffiths (alan-griffiths)]

I agree that better handling would be appropriate - so stoi() or strtol() might be better. But I don't think atoi()s undefined behavior is dangerous.

review: Approve

[Kevin DuBois (kdub)]

> 56 + number_of_captures = atoi(optarg);
>
> Maybe replace with
> std::stoi(std::string(optarg));
>
> Then it will throw if it can't parse a number.

It should return 0 if it can't parse and then it would just exit. I don't mind fixing to print the help msg on a bad param though.

[PS Jenkins bot (ps-jenkins)]

FAILED: Continuous integration, rev:1416
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/909/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/997
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/995
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/589/console
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/639
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/639/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/646
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/646/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/590
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/590/artifact/work/output/*zip*/output.zip
    FAILURE: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/564/console
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4145

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/909/rebuild

review: Needs Fixing (continuous-integration)

[Alberto Aguirre (albaguirre)]

review: Approve

[PS Jenkins bot (ps-jenkins)]

PASSED: Continuous integration, rev:1416
http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-ci/913/
Executed test runs:
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-android-trusty-i386-build/1001
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-clang-trusty-amd64-build/999
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-trusty-touch/593
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/643
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-amd64-ci/643/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/650
        deb: http://jenkins.qa.ubuntu.com/job/mir-team-mir-development-branch-trusty-armhf-ci/650/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/594
        deb: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-builder-trusty-armhf/594/artifact/work/output/*zip*/output.zip
    SUCCESS: http://jenkins.qa.ubuntu.com/job/mir-mediumtests-runner-mako/568
    SUCCESS: http://s-jenkins.ubuntu-ci:8080/job/touch-flash-device/4155

Click here to trigger a rebuild:
http://s-jenkins.ubuntu-ci:8080/job/mir-team-mir-development-branch-ci/913/rebuild

review: Approve (continuous-integration)

=== modified file 'src/utils/screencast.cpp'
--- src/utils/screencast.cpp	2014-02-17 05:15:06 +0000
+++ src/utils/screencast.cpp	2014-02-20 17:19:20 +0000
@@ -114,6 +114,8 @@
     std::cout << "Usage " << std::endl
               << "    -m <Mir server socket>" << std::endl
               << "    -o <Output id>" << std::endl
+              << "    -n <Number of frames to capture>" << std::endl
+              << "        default (-1) is to capture infinite frames" << std::endl
               << "    -h: this help text" << std::endl;
 }
 
@@ -198,7 +200,7 @@
 };
 
 void do_screencast(MirConnection* connection, MirScreencast* screencast,
-                   uint32_t output_id)
+                   uint32_t output_id, int32_t number_of_captures)
 {
     static int const rgba_pixel_size{4};
 
@@ -218,7 +220,7 @@
     ss << (format == GL_BGRA_EXT ? ".bgra" : ".rgba");
     std::ofstream video_file(ss.str());
 
-    while (running)
+    while (running && (number_of_captures != 0))
     {
         read_pixels(format, frame_size, frame_data.data());
 
@@ -231,6 +233,9 @@
         egl_setup.swap_buffers();
 
         write_out_future.wait();
+
+        if (number_of_captures > 0)
+            number_of_captures--;
     }
 }
 
@@ -243,14 +248,18 @@
     opterr = 0;
     char const* socket_file = nullptr;
     uint32_t output_id = mir_display_output_id_invalid;
+    int32_t number_of_captures = -1;
 
     //avoid unused warning/error
     tls_hack[0] = 0;
 
-    while ((arg = getopt (argc, argv, "hm:o:")) != -1)
+    while ((arg = getopt (argc, argv, "hm:o:n:")) != -1)
     {
         switch (arg)
         {
+        case 'n':
+            number_of_captures = std::stoi(std::string(optarg)); 
+            break;
         case 'm':
             socket_file = optarg;
             break;
@@ -303,13 +312,18 @@
     if (screencast == nullptr)
         throw std::runtime_error("Failed to create screencast");
 
-    do_screencast(connection.get(), screencast.get(), output_id);
+    do_screencast(connection.get(), screencast.get(), output_id, number_of_captures);
 
     return EXIT_SUCCESS;
 }
+catch(std::invalid_argument const& e)
+{
+    std::cerr << "Invalid Argument" << std::endl;
+    print_usage();
+    return EXIT_FAILURE;
+}
 catch(std::exception const& e)
 {
     std::cerr << e.what() << std::endl;
-
     return EXIT_FAILURE;
 }