iphoneoverlay.py

#!/usr/bin/python
"""Takes an iOS video screen recording from an iPhone XS Max and adds an overlay of an iPhone XS Max device frame, then outputs to a new video file."""

import argparse
import os
import subprocess
import sys

NAME = 'iphoneoverlay.py'
VERSION = '1.0.3.20181021'
AUTHOR = 'Carl Windus'
LICENSE = 'Python code is licensed under Apache License 2.0.'
APPLE_COPYRIGHT = 'Apple, the Apple logo, Apple TV, Apple Watch, iPad, iPhone, iPod, iPod touch, iTunes, the iTunes logo, Mac, iMac, MacBook, MacBook Pro, MacBook Air, macOS, and QuickTime are trademarks of Apple Inc., registered in the U.S. and other countries.'

DEVICE_FRAMES_PATH = os.path.dirname(os.path.realpath(__file__)) + '/device_frames'

DEVICE_FRAMES = {
    # Dimensions in this dict are designed to maintain the original screen recording resolution where possible
    # 'padding': width:height size of the overlay
    # 'scale':  width:height to re-scale the video, use -1 to preserve that dimension dynamically
    # 'overlay_position': width:height of device frame overlay placement
    # 'video_position': x:y positioning of video
    'landscape': {
        'ipadPro129S': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPadPro-129-Landscape-Silver.png'),
            'padding': '2268:1648',
            'scale': 'transpose=2,transpose=2,transpose=2,scale=1920:-1',  # Only need to do this on landscape recording
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'ipadPro129SG': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPadPro-129-Landscape-SpaceGray.png'),
            'padding': '2268:1648',
            'scale': 'transpose=2,transpose=2,transpose=2,scale=1920:-1',  # Only need to do this on landscape recording
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8Silver': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8-Landscape-Silver.png'),
            'padding': '1800:920',
            'scale': 'scale=1334:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8SpaceGray': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8-Landscape-SpaceGray.png'),
            'padding': '1800:920',
            'scale': 'scale=1334:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8plusS': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8Plus-Landscape-Silver.png'),
            'padding': '2540:1280',
            'scale': 'scale=1920:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8plusSG': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8Plus-Landscape-SpaceGray.png'),
            'padding': '2540:1280',
            'scale': 'scale=1920:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphoneXS': {  # Face ID equipped devices home screen no longer rotates == no orientation metadata?
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-XS-Landscape-Space-Gray.png'),
            'padding': '2062:1044',
            'scale': 'scale=1920:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphoneXSmax': {  # Face ID equipped devices home screen no longer rotates == no orientation metadata?
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-XS-Max-Landscape-Space-Gray.png'),
            'padding': '2050:1032',
            'scale': 'scale=1920:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        }
    },
    'portrait': {
        'ipadPro129S': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPadPro-129-Portrait-Silver.png'),
            'padding': '1648:2268',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'ipadPro129SG': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPadPro-129-Portrait-SpaceGray.png'),
            'padding': '1648:2268',
            'scale': 'scale=1440:-1',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8S': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8-Portrait-Silver.png'),
            'padding': '920:1800',
            'scale': 'scale=-1:1334',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8SG': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8-Portrait-SpaceGray.png'),
            'padding': '920:1800',
            'scale': 'scale=-1:1334',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8plusS': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8Plus-Portrait-Silver.png'),
            'padding': '1280:2540',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphone8plusSG': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-8Plus-Portrait-SpaceGray.png'),
            'padding': '1280:2540',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphoneXS': {  # Face ID equipped devices home screen no longer rotates == no orientation metadata?
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-XS-Portrait-Space-Gray.png'),
            'padding': '1044:2062',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphoneXSsilver': {  # Face ID equipped devices home screen no longer rotates == no orientation metadata?
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-XS-Portrait-Silver.png'),
            'padding': '1018:2038',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'iphoneXSmax': {  # Face ID equipped devices home screen no longer rotates == no orientation metadata?
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iPhone-XS-Max-Portrait-Space-Gray.png'),
            'padding': '1032:2050',
            'scale': 'scale=-1:1920',
            'overlay_position': '(main_w-overlay_w)/2:(main_h-overlay_h)/2',
            'video_position': '(ow-iw)/2:(oh-ih)/2',
        },
        'imac27': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iMac-27-Silver.png'),
            'padding': '2820:2270',
            'scale': 'scale=2560:-1',
            'overlay_position': '0:0',
            'video_position': '(ow-iw)/2:125',
        },
        'imac27r': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iMac-27-5K-Silver.png'),
            'padding': '5640:4540',
            'scale': 'scale=5640:-1',
            'overlay_position': '0:0',
            'video_position': '(ow-iw)/2:250',
        },
        'imac27pro': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'iMac-Pro-27-SpaceGray.png'),
            'padding': '5640:4690',
            'scale': 'scale=2560:-1',
            'overlay_position': '0:0',
            'video_position': '(ow-iw)/2:250',
        },
        'watch44white': {
            'filename': os.path.join(DEVICE_FRAMES_PATH, 'Watch-44m-White.png'),
            'padding': '508:856',
            'scale': 'scale=-1:-1',
            'overlay_position': '0:0',
            'video_position': '59:205',
        }
    },
}

DEVICE_FRAMES_SUPPORTED = list(set(DEVICE_FRAMES['landscape'].keys() + DEVICE_FRAMES['portrait'].keys()))
IPAD_PRO_DEVICES = [x for x in DEVICE_FRAMES_SUPPORTED if 'ipadPro' in x]


class DeviceFrameOverlayToVideo():
    @staticmethod
    def overlay(video_in, device_frame, orientation=None, video_out=None, colour=None, keep_audio=False, debug=False):
        try:
            # Video input
            video_in = os.path.expanduser(video_in) if video_in.startswith('~') else video_in
            video_in = os.path.expandvars(video_in) if '$' in video_in else video_in
            video_in_ext = os.path.splitext(video_in)[1]

            # Device frame to use
            if device_frame in DEVICE_FRAMES_SUPPORTED:
                # Assume an orientation if not provided. Default is portrait
                if not orientation:
                    orientation = 'portrait'
                else:
                    orientation = orientation

                # Create variables used in the ffmpeg command
                device = device_frame  # used for device tests (check if iPad Pro, etc)
                padding = DEVICE_FRAMES[orientation][device_frame]['padding']
                scale = DEVICE_FRAMES[orientation][device_frame]['scale']
                overlay_position = DEVICE_FRAMES[orientation][device_frame]['overlay_position']
                video_position = DEVICE_FRAMES[orientation][device_frame]['video_position']
                device_frame = DEVICE_FRAMES[orientation][device_frame]['filename']

                # Add the transpose option 2 for 90deg counter clockwise rotation for landscape
                if 'landscape' in orientation:
                    scale = 'transpose=2,{}'.format(scale)

            else:
                print('Please specify a device frame. Supported device frames are listed below.')
                print('\t{}'.format(DEVICE_FRAMES['landscape'].keys()))
                print('\t{}'.format(DEVICE_FRAMES['portrait'].keys()))
                sys.exit(1)

            # Video output (final file)
            if not video_out:
                video_out = video_in.replace(video_in_ext, '_overlay{}'.format(video_in_ext))
            else:
                video_out = os.path.expanduser(video_out) if video_out.startswith('~') else video_out
                video_out = os.path.expandvars(video_out) if '$' in video_out else video_out

            if video_in == video_out:
                print('Please use a different filename for the output video.')
                sys.exit(1)

            # Background colour
            if colour:
                colour = colour
            else:
                colour = '#000000'

            # Resize and centre
            print('Resizing source video to match device frame {} image size in {} orientation and applying overlay.'.format(os.path.basename(device_frame), orientation))
            resize_cmd = [
                '/usr/local/bin/ffmpeg',
                '-y',
                '-i',
                '"{}"'.format(video_in),
                '-i',
                '"{}"'.format(device_frame),
                '-filter_complex',
                '"{},pad={}:{}:color={},setsar=1,format=rgb24,overlay={}"'.format(scale, padding, video_position, colour, overlay_position),
            ]

            # If the device is an iPad Pro, then need to treat this differently because orientation metadata
            if device in IPAD_PRO_DEVICES and 'landscape' in orientation:
                resize_cmd.extend(['-map_metadata', '0', '-metadata:s:v:0', 'rotate=0'])

            # Add whether keeping audio or not
            if keep_audio:
                resize_cmd.extend(['-codec:a', 'copy'])
            else:
                resize_cmd.extend(['-an'])

            # Add the video_out
            resize_cmd.extend(['"{}"'.format(video_out)])

            # Debug
            if not debug:
                resize_cmd.extend(['-v', 'quiet', '-stats'])

            # Join into one long string because there's some arguments in here that require shell=True
            resize_cmd = ' '.join(resize_cmd)

            if debug:
                print('ffmpeg command:\t{}\n'.format(resize_cmd))
            try:
                subprocess.check_call(resize_cmd, shell=True)

                if os.path.exists(video_out):
                    print('Video saved to: {}'.format(video_out))
            except subprocess.CalledProcessError as e:
                if not debug:
                    print('Conversion failed! Try again with the --debug argument.')
                sys.exit(1)

        except Exception as e:
            raise
            print(e)
            sys.exit(1)


class SaneUsageFormat(argparse.HelpFormatter):
    """Sane Help Output. https://stackoverflow.com/a/9643162 (Matt Wilkie)"""
    def _format_action_invocation(self, action):
        if not action.option_strings:
            default = self._get_default_metavar_for_positional(action)
            metavar, = self._metavar_formatter(action, default)(1)
            return metavar

        else:
            parts = []

            # if the Optional doesn't take a value, format is:
            #    -s, --long
            if action.nargs == 0:
                parts.extend(action.option_strings)

            # if the Optional takes a value, format is:
            #    -s ARGS, --long ARGS
            else:
                default = self._get_default_metavar_for_optional(action)
                args_string = self._format_args(action, default)
                for option_string in action.option_strings:
                    parts.append(option_string)

                return '%s %s' % (', '.join(parts), args_string)

            return ', '.join(parts)

    def _get_default_metavar_for_optional(self, action):
        return action.dest.upper()


def parse_args():
    parser = argparse.ArgumentParser(formatter_class=SaneUsageFormat)

    parser.add_argument('-a', '--keep-audio',
                        action='store_true',
                        dest='keep_audio',
                        help='Keep audio.',
                        required=False,
                        default=False)

    parser.add_argument('-i', '--input',
                        type=str,
                        nargs=1,
                        dest='video_in',
                        metavar='<filename.mp4>',
                        help='Screen recording to add device frame to.',
                        required=True)

    parser.add_argument('-o', '--output',
                        type=str,
                        nargs=1,
                        dest='video_out',
                        metavar='<filename.mp4>',
                        help='Destination video filename.',
                        required=False)

    parser.add_argument('-c', '--bg-colour',  # Queen's English!
                        type=str,
                        nargs=1,
                        dest='bg_colour',
                        metavar='"#ffffff"',
                        help='Background colour. If specifying RGB code, quote the code. For example: "#ffffff"',
                        required=False,
                        default=['#000000'])

    parser.add_argument('--overlay',
                        type=str,
                        nargs=1,
                        dest='dev_frame',
                        metavar='<device frame>',
                        choices=DEVICE_FRAMES_SUPPORTED,
                        help='Device frame to use as overlay.',
                        required=True,
                        default=['iphoneXSmax'])

    parser.add_argument('--orientation',
                        type=str,
                        nargs=1,
                        dest='orientation',
                        metavar='<orientation>',
                        choices=['portrait', 'landscape'],
                        help='Orientation of final video. Defaults to portrait.',
                        required=False,
                        default=['portrait'])

    parser.add_argument('-d', '--debug',
                        action='store_true',
                        dest='debug',
                        help='Debug output.',
                        required=False,
                        default=False)

    parser.add_argument('-v', '--version',
                        action='version',
                        version='{} version {} by {}. {}\n{}'.format(NAME, VERSION, AUTHOR, LICENSE, APPLE_COPYRIGHT))

    if not len(sys.argv) > 1:
        parser.print_usage()
        sys.exit(1)
    else:
        args = parser.parse_args()
        args = vars(args)

        result = dict()
        keep_audio = args['keep_audio']
        video_in = args.get('video_in')[0]
        extension = os.path.splitext(video_in)[1]
        video_out = args['video_out'][0] if args['video_out'] else video_in.replace(extension, '_overlay{}'.format(extension))
        bg_colour = args['bg_colour'][0]
        dev_frame = args['dev_frame'][0]
        orientation = args['orientation'][0]
        debug = args['debug']

        result['keep_audio'] = keep_audio
        result['video_in'] = video_in
        result['video_out'] = video_out
        result['bg_colour'] = bg_colour
        result['dev_frame'] = dev_frame
        result['orientation'] = orientation
        result['debug'] = debug

        return result


def main():
    args = parse_args()

    recording = DeviceFrameOverlayToVideo()
    recording.overlay(video_in=args['video_in'], device_frame=args['dev_frame'], orientation=args['orientation'], video_out=args['video_out'], colour=args['bg_colour'], keep_audio=args['keep_audio'], debug=args['debug'])


if __name__ == '__main__':
    main()