CameraRemoteAPI.py

#!/usr/bin/python
# -*- coding: utf-8 -*-
#
# Copyright 2014 Karl Mikaelsson <derfian@lysator.liu.se>
#
# 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 socket
import json
import random
import xml.etree.ElementTree as ElementTree
import requests
import StringIO
import httplib

CRA_SSDP_MGRP = '239.255.255.250'
CRA_SSDP_PORT = 1900
CRA_SSDP_GROUP = (CRA_SSDP_MGRP, CRA_SSDP_PORT)

CRA_SSDP_MX = 5      # Request timeout, seconds
CRA_SSDP_ST = 'urn:schemas-sony-com:service:ScalarWebAPI:1'
CRA_SSDP_MSG = "\r\n".join([
    'M-SEARCH * HTTP/1.1',
    'HOST: {h}:{p}',
    'MAN: "ssdp:discover"',
    'ST: {st}',
    'MX: 3',
    '',
    ''])

ALL = ['CameraRemoteError',
       'CameraRemoteServerError',
       'CameraRemoteAPI',
       'discover']

class SSDPResponse(object):
    class _FakeSocket(StringIO.StringIO):
        def makefile(self, *args, **kw):
            return self
    def __init__(self, response):
        r = httplib.HTTPResponse(self._FakeSocket(response))
        r.begin()
        self.location = r.getheader("location")
        self.usn = r.getheader("usn")
        self.st = r.getheader("st")
        try:
            self.cache = r.getheader("cache-control").split("=")[1]
        except:
            self.cache = None
    def __repr__(self):
        return "<SSDPResponse({location}, {st}, {usn})>".format(**self.__dict__)

class CameraRemoteError(Exception):
    """ Generic exception from within CameraRemoteAPI """
    pass

class CameraRemoteRPCError(CameraRemoteError):
    """ The API call failed. """
    pass

class CameraRemoteAPI:
    urls = {}
    _json_headers = {'Content-Type': "application/json",}
    trace = False

    def __init__(self, ddxml):
        """Initialize the CameraRemoteAPI Object with a device description XML
        file. FIXME: Reconsider this approach"""
        _x = ElementTree.fromstring(ddxml)

        ns = "urn:schemas-sony-com:av"

        for service in _x.findall('.//{%(ns)s}X_ScalarWebAPI_ServiceList/{%(ns)s}X_ScalarWebAPI_Service' % locals()):
            servicetype = service.find('{%(ns)s}X_ScalarWebAPI_ServiceType' % locals()).text
            serviceurl = service.find('{%(ns)s}X_ScalarWebAPI_ActionList_URL' % locals()).text
            self.urls[servicetype] = serviceurl + '/' + servicetype

    def _apicall(self, endpoint, **params):
        """ Perform an actual API call. """

        if not 'id' in params:
            params['id'] = random.randint(1, 0x7FFFFFF)

        if not endpoint in self.urls:
            raise CameraRemoteError("Unknown endpoint %r" % endpoint)

        if self.trace:
            print self.urls[endpoint], "<-", params

        r = requests.post(self.urls[endpoint], data=json.dumps(params), headers=self._json_headers)
        j = r.json()
        r.close()

        if self.trace:
            print self.urls[endpoint], "->", j

        # FIXME: Long exposures may signal errors while they're
        # processing. Look into that.
        if 'error' in j:
            raise CameraRemoteRPCError({'code': j['error'][0],
                                        'message': j['error'][1]})
        return j

    # Implement methods here:
    def getVersions(self):
        resp = self._apicall('camera',
                             method='getVersions',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def setShootMode(self, shootmode):
        resp = self._apicall('camera',
                             method="setShootMode",
                             params=[shootmode],
                             version="1.0")
        return

    def getShootMode(self):
        resp = self._apicall('camera',
                             method="getShootMode",
                             params=[],
                             version="1.0")
        return resp['result'][0]

    def getSupportedShootMode(self):
        resp = self._apicall('camera',
                             method="getSupportedShootMode",
                             params=[],
                             version="1.0")
        return resp['result']

    def getAvailableShootMode(self):
        resp = self._apicall('camera',
                             method="getAvailableShootMode",
                             params=[],
                             version="1.0")
        return resp['result']

    def actTakePicture(self):
        resp = self._apicall('camera',
                             method='actTakePicture',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def awaitTakePicture(self):
        resp = self._apicall('camera',
                             method='awaitTakePicture',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def startContShooting(self):
        resp = self._apicall('camera',
                             method='startContShooting',
                             params=[],
                             version='1.0')
        return

    def stopContShooting(self):
        resp = self._apicall('camera',
                             method='stopContShooting',
                             params=[],
                             version='1.0')
        return

    def startMovieRec(self):
        resp = self._apicall('camera',
                             method='startMovieRec',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def stopMovieRec(self):
        resp = self._apicall('camera',
                             method='stopMovieRec',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def startAudioRec(self):
        resp = self._apicall('camera',
                             method='startAudioRec',
                             params=[],
                             version='1.0')
        return resp['result'][0]


    def stopAudioRec(self):
        resp = self._apicall('camera',
                             method='stopAudioRec',
                             params=[],
                             version='1.0')
        return resp['result'][0]


    def startIntervalStillRec(self):
        resp = self._apicall('camera',
                             method='stopAudioRec',
                             params=[],
                             version='1.0')
        return resp['result'][0]

    def stopIntervalStillRec(self):
        raise NotImplemented

    def startLiveview(self):
        raise NotImplemented

    def stopLiveview(self):
        raise NotImplemented

    def startLiveviewWithSize(self):
        raise NotImplemented

    def getLiveviewSize(self):
        raise NotImplemented

    def getSupportedLiveviewSize(self):
        raise NotImplemented

    def getAvailableLiveviewSize(self):
        raise NotImplemented

    def setLiveviewFrameInfo(self):
        raise NotImplemented

    def getLiveviewFrameInfo(self):
        raise NotImplemented

    def actZoom(self):
        raise NotImplemented

    def setZoomSetting(self):
        raise NotImplemented

    def getZoomSetting(self):
        raise NotImplemented

    def getSupportedZoomSetting(self):
        raise NotImplemented

    def getAvailableZoomSetting(self):
        raise NotImplemented

    def actHalfPressShutter(self):
        raise NotImplemented

    def cancelHalfPressShutter(self):
        raise NotImplemented

    def setTouchAFPosition(self):
        raise NotImplemented

    def getTouchAFPosition(self):
        raise NotImplemented

    def cancelTouchAFPosition(self):
        raise NotImplemented

    def actTrackingFocus(self):
        raise NotImplemented

    def cancelTrackingFocus(self):
        raise NotImplemented

    def setTrackingFocus(self):
        raise NotImplemented

    def getTrackingFocus(self):
        raise NotImplemented

    def getSupportedTrackingFocus(self):
        raise NotImplemented

    def getAvailableTrackingFocus(self):
        raise NotImplemented

    def setContShootingMode(self):
        raise NotImplemented

    def getContShootingMode(self):
        raise NotImplemented

    def getSupportedContShootingMode(self):
        raise NotImplemented

    def getAvailableContShootingMode(self):
        raise NotImplemented

    def setContShootingSpeed(self):
        raise NotImplemented

    def getContShootingSpeed(self):
        raise NotImplemented

    def getSupportedContShootingSpeed(self):
        raise NotImplemented

    def getAvailableContShootingSpeed(self):
        raise NotImplemented

    def setSelfTimer(self):
        raise NotImplemented

    def getSelfTimer(self):
        raise NotImplemented

    def getSupportedSelfTimer(self):
        raise NotImplemented

    def getAvailableSelfTimer(self):
        raise NotImplemented

    def setExposureMode(self):
        raise NotImplemented

    def getExposureMode(self):
        raise NotImplemented

    def getSupportedExposureMode(self):
        raise NotImplemented

    def getAvailableExposureMode(self):
        raise NotImplemented

    def setFocusMode(self):
        raise NotImplemented

    def getFocusMode(self):
        raise NotImplemented

    def getSupportedFocusMode(self):
        raise NotImplemented

    def getAvailableFocusMode(self):
        raise NotImplemented

    def getExposureCompensation(self):
        raise NotImplemented

    def setExposureCompensation(self):
        raise NotImplemented

    def getSupportedExposureCompensation(self):
        raise NotImplemented

    def getAvailableExposureCompensation(self):
        raise NotImplemented

    def setFNumber(self):
        raise NotImplemented

    def getFNumber(self):
        raise NotImplemented

    def getSupportedFNumber(self):
        raise NotImplemented

    def getAvailableFNumber(self):
        raise NotImplemented

    def setShutterSpeed(self):
        raise NotImplemented

    def getShutterSpeed(self):
        raise NotImplemented

    def getSupportedShutterSpeed(self):
        raise NotImplemented

    def getAvailableShutterSpeed(self):
        raise NotImplemented

    def setIsoSpeedRate(self):
        raise NotImplemented

    def getIsoSpeedRate(self):
        raise NotImplemented

    def getSupportedIsoSpeedRate(self):
        raise NotImplemented

    def getAvailableIsoSpeedRate(self):
        raise NotImplemented

    def setWhiteBalance(self):
        raise NotImplemented

    def getWhiteBalance(self):
        raise NotImplemented

    def getSupportedWhiteBalance(self):
        raise NotImplemented

    def getAvailableWhiteBalance(self):
        raise NotImplemented

    def setProgramShift(self):
        raise NotImplemented

    def getSupportedProgramShift(self):
        raise NotImplemented

    def setFlashMode(self):
        raise NotImplemented

    def getFlashMode(self):
        raise NotImplemented

    def getSupportedFlashMode(self):
        raise NotImplemented

    def getAvailableFlashMode(self):
        raise NotImplemented

    def setStillSize(self):
        raise NotImplemented

    def getStillSize(self):
        raise NotImplemented

    def getSupportedStillSize(self):
        raise NotImplemented

    def getAvailableStillSize(self):
        raise NotImplemented

    def setStillQuality(self):
        raise NotImplemented

    def getStillQuality(self):
        raise NotImplemented

    def getSupportedStillQuality(self):
        raise NotImplemented

    def getAvailableStillQuality(self):
        raise NotImplemented

    def setPostviewImageSize(self):
        raise NotImplemented

    def getPostviewImageSize(self):
        raise NotImplemented

    def getSupportedPostviewImageSize(self):
        raise NotImplemented

    def getAvailablePostviewImageSize(self):
        raise NotImplemented

    def setMovieFileFormat(self):
        raise NotImplemented

    def getMovieFileFormat(self):
        raise NotImplemented

    def getSupportedMovieFileFormat(self):
        raise NotImplemented

    def getAvailableMovieFileFormat(self):
        raise NotImplemented

    def setMovieQuality(self):
        raise NotImplemented

    def getMovieQuality(self):
        raise NotImplemented

    def getSupportedMovieQuality(self):
        raise NotImplemented

    def getAvailableMovieQuality(self):
        raise NotImplemented

    def setSteadyMode(self):
        raise NotImplemented

    def getSteadyMode(self):
        raise NotImplemented

    def getSupportedSteadyMode(self):
        raise NotImplemented

    def getAvailableSteadyMode(self):
        raise NotImplemented

    def setViewAngle(self):
        raise NotImplemented

    def getViewAngle(self):
        raise NotImplemented

    def getSupportedViewAngle(self):
        raise NotImplemented

    def getAvailableViewAngle(self):
        raise NotImplemented

    def setSceneSelection(self):
        raise NotImplemented

    def getSceneSelection(self):
        raise NotImplemented

    def getSupportedSceneSelection(self):
        raise NotImplemented

    def getAvailableSceneSelection(self):
        raise NotImplemented

    def setColorSetting(self):
        raise NotImplemented

    def getColorSetting(self):
        raise NotImplemented

    def getSupportedColorSetting(self):
        raise NotImplemented

    def getAvailableColorSetting(self):
        raise NotImplemented

    def setIntervalTime(self):
        raise NotImplemented

    def getIntervalTime(self):
        raise NotImplemented

    def getSupportedIntervalTime(self):
        raise NotImplemented

    def getAvailableIntervalTime(self):
        raise NotImplemented

    def setFlipSetting(self):
        raise NotImplemented

    def getFlipSetting(self):
        raise NotImplemented

    def getSupportedFlipSetting(self):
        raise NotImplemented

    def getAvailableFlipSetting(self):
        raise NotImplemented

    def setTvColorSystem(self):
        raise NotImplemented

    def getTvColorSystem(self):
        raise NotImplemented

    def getSupportedTvColorSystem(self):
        raise NotImplemented

    def getAvailableTvColorSystem(self):
        raise NotImplemented

    def startRecMode(self):
        raise NotImplemented

    def stopRecMode(self):
        raise NotImplemented

    def setCameraFunction(self):
        raise NotImplemented

    def getCameraFunction(self):
        raise NotImplemented

    def getSupportedCameraFunction(self):
        raise NotImplemented

    def getAvailableCameraFunction(self):
        raise NotImplemented

    def getSchemeList(self):
        raise NotImplemented

    def getSourceList(self):
        raise NotImplemented

    def getContentCount(self):
        raise NotImplemented

    def getContentList(self):
        raise NotImplemented

    def setStreamingContent(self):
        raise NotImplemented

    def startStreaming(self):
        raise NotImplemented

    def pauseStreaming(self):
        raise NotImplemented

    def seekStreamingPosition(self):
        raise NotImplemented

    def stopStreaming(self):
        raise NotImplemented

    def requestToNotifyStreamingStatus(self):
        raise NotImplemented

    def deleteContent(self):
        raise NotImplemented

    def setInfraredRemoteControl(self):
        raise NotImplemented

    def getInfraredRemoteControl(self):
        raise NotImplemented

    def getSupportedInfraredControl(self):
        raise NotImplemented

    def getAvailableInfraredControl(self):
        raise NotImplemented

    def setAutoPowerOff(self):
        raise NotImplemented

    def getAutoPowerOff(self):
        raise NotImplemented

    def getSupportedAutoPowerOff(self):
        raise NotImplemented

    def getAvailableAutoPowerOff(self):
        raise NotImplemented

    def setBeepMode(self):
        raise NotImplemented

    def getBeepMode(self):
        raise NotImplemented

    def getSupportedBeepMode(self):
        raise NotImplemented

    def getAvailableBeepMode(self):
        raise NotImplemented

    def setCurrentTime(self):
        raise NotImplemented

    def getStorageInformation(self):
        raise NotImplemented

    def getEvent(self):
        raise NotImplemented

    def getEvent(self):
        raise NotImplemented

    def getEvent(self):
        raise NotImplemented

    def getAvailableApiList(self):
        raise NotImplemented

    def getApplicationInfo(self):
        raise NotImplemented

    def getMethodTypes(self):
        raise NotImplemented

    
def discover():
    resp = __msearch()
    _ddurl = resp.location

    _ddr = requests.get(_ddurl)
    if _ddr.status_code != 200:
        raise CameraRemoteError("Failed to get Device Description from %s" % _ddurl)

    return CameraRemoteAPI(_ddr.text)

def __msearch(st=CRA_SSDP_ST):
    """Send a M-SEARCH * HTTP/1.1 request and return the response"""
    sender = socket.socket(socket.AF_INET, socket.SOCK_DGRAM)
    sender.setsockopt(socket.IPPROTO_IP,
                      socket.IP_MULTICAST_TTL,
                      1)
    # FIXME: Need to figure out which interface is the right one if
    # there are more than one. This is wrong.
    sender.setsockopt(socket.SOL_IP,
                      socket.IP_MULTICAST_IF,
                      socket.inet_pton(socket.AF_INET,
                                       '192.168.122.173'))
    sender.setsockopt(socket.SOL_IP,
                      socket.IP_MULTICAST_LOOP,
                      1)
    sender.sendto(CRA_SSDP_MSG.format(h=CRA_SSDP_MGRP,
                                      p=CRA_SSDP_PORT,
                                      st=st),
                  CRA_SSDP_GROUP)
    responses = {}

    _msg, _from = sender.recvfrom(1024)
    r = SSDPResponse(_msg)

    if sender:
        sender.close()

    return r