include/camera/ICameraServiceListener.h

/*
 * Copyright (C) 2013 The Android Open Source Project
 *
 * 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.
 */

#ifndef ANDROID_HARDWARE_ICAMERASERVICE_LISTENER_H
#define ANDROID_HARDWARE_ICAMERASERVICE_LISTENER_H

#include <utils/RefBase.h>
#include <binder/IInterface.h>
#include <binder/Parcel.h>
#include <hardware/camera_common.h>

namespace android {

class ICameraServiceListener : public IInterface
{
    /**
     * Keep up-to-date with ICameraServiceListener.aidl in frameworks/base
     */
public:

    /**
     * Initial status will be transmitted with onStatusChange immediately
     * after this listener is added to the service listener list.
     *
     * Allowed transitions:
     *
     *     (Any)               -> NOT_PRESENT
     *     NOT_PRESENT         -> PRESENT
     *     NOT_PRESENT         -> ENUMERATING
     *     ENUMERATING         -> PRESENT
     *     PRESENT             -> NOT_AVAILABLE
     *     NOT_AVAILABLE       -> PRESENT
     *
     * A state will never immediately transition back to itself.
     */
    enum Status {
        // Device physically unplugged
        STATUS_NOT_PRESENT      = CAMERA_DEVICE_STATUS_NOT_PRESENT,
        // Device physically has been plugged in
        //  and the camera can be used exlusively
        STATUS_PRESENT          = CAMERA_DEVICE_STATUS_PRESENT,
        // Device physically has been plugged in
        //   but it will not be connect-able until enumeration is complete
        STATUS_ENUMERATING      = CAMERA_DEVICE_STATUS_ENUMERATING,

        // Camera can be used exclusively
        STATUS_AVAILABLE        = STATUS_PRESENT, // deprecated, will be removed

        // Camera is in use by another app and cannot be used exclusively
        STATUS_NOT_AVAILABLE    = 0x80000000,

        // Use to initialize variables only
        STATUS_UNKNOWN          = 0xFFFFFFFF,
    };

    /**
     * The torch mode status of a camera.
     *
     * Initial status will be transmitted with onTorchStatusChanged immediately
     * after this listener is added to the service listener list.
     *
     * The enums should be set to values matching
     * include/hardware/camera_common.h
     */
    enum TorchStatus {
        // The camera's torch mode has become not available to use via
        // setTorchMode().
        TORCH_STATUS_NOT_AVAILABLE  = TORCH_MODE_STATUS_NOT_AVAILABLE,
        // The camera's torch mode is off and available to be turned on via
        // setTorchMode().
        TORCH_STATUS_AVAILABLE_OFF  = TORCH_MODE_STATUS_AVAILABLE_OFF,
        // The camera's torch mode is on and available to be turned off via
        // setTorchMode().
        TORCH_STATUS_AVAILABLE_ON   = TORCH_MODE_STATUS_AVAILABLE_ON,

        // Use to initialize variables only
        TORCH_STATUS_UNKNOWN        = 0xFFFFFFFF,
    };

    DECLARE_META_INTERFACE(CameraServiceListener);

    virtual void onStatusChanged(Status status, int32_t cameraId) = 0;

    virtual void onTorchStatusChanged(TorchStatus status, const String16& cameraId) = 0;
};

// ----------------------------------------------------------------------------

class BnCameraServiceListener : public BnInterface<ICameraServiceListener>
{
public:
    virtual status_t    onTransact( uint32_t code,
                                    const Parcel& data,
                                    Parcel* reply,
                                    uint32_t flags = 0);
};

}; // namespace android

#endif