Source code for stepler.third_party.video_recorder

"""
------------------------
Video capture of display
------------------------
"""

# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#    http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
# implied.
# See the License for the specific language governing permissions and
# limitations under the License.

import logging
import os
import signal
import subprocess
from threading import Thread
import time

LOGGER = logging.getLogger(__name__)


class VideoRecorder(object):
    """Video capture of display."""

    def __init__(self, file_path, frame_rate=30):
        """Constructor."""
        try:
            subprocess.check_call(['which', 'avconv'], stdout=subprocess.PIPE)
        except subprocess.CalledProcessError:
            raise RuntimeError(
                "`avconv` is not found on current system. Be sure that you "
                "have installed `avconv` to capture video. More details in "
                "http://stepler.readthedocs.io/horizon.html#tests-launching.")

        if 'DISPLAY' not in os.environ:
            raise RuntimeError(
                "Environment variable `DISPLAY` is undefined. Can't determine "
                "X11 display to capture video. Be sure that you have "
                "installed X11 display or xvfb. More details in "
                "http://stepler.readthedocs.io/horizon.html#tests-launching.")

        self.is_launched = False
        self.file_path = file_path
        # avconv -f x11grab -r 15 -s 1920x1080 -i :0.0 -codec libx264 out.mp4
        self._cmd = ['avconv', '-f', 'x11grab', '-r', str(frame_rate),
                     '-s', '{}x{}'.format(1920, 1080),
                     '-i', os.environ['DISPLAY'], '-an',
                     '-codec', 'libx264', self.file_path]

    def start(self):
        """Start video capture."""
        if self.is_launched:
            LOGGER.warn('Video recording is running already')
            return

        fnull = open(os.devnull, 'w')
        LOGGER.info('Record video via {!r}'.format(' '.join(self._cmd)))
        self._popen = subprocess.Popen(self._cmd, stdout=fnull, stderr=fnull)
        self.is_launched = True

    def stop(self):
        """Stop video capture."""
        if not self.is_launched:
            LOGGER.warn('Video recording is stopped already')
            return

        LOGGER.info('Stop video recording')
        self._popen.send_signal(signal.SIGINT)

        def terminate_avconv():
            limit = time.time() + 10

            while time.time() < limit:
                time.sleep(0.1)
                if self._popen.poll() is not None:
                    return

            os.kill(self._popen.pid, signal.SIGTERM)

        t = Thread(target=terminate_avconv)
        t.start()

        self._popen.communicate()
        t.join()
        self.is_launched = False

    def clear(self):
        """Remove video file."""
        if self.is_launched:
            LOGGER.error("Video recording is running still")
            return

        if not os.path.isfile(self.file_path):
            LOGGER.warn("{!r} is absent already".format(self.file_path))
            return

        os.remove(self.file_path)