1/*
2 * Copyright (C) 2012 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 *      http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17#ifndef ANDROID_SERVERS_CAMERA_CAMERACLIENT_H
18#define ANDROID_SERVERS_CAMERA_CAMERACLIENT_H
19
20#include "CameraService.h"
21
22namespace android {
23
24class MemoryHeapBase;
25class CameraHardwareInterface;
26
27/**
28 * Interface between android.hardware.Camera API and Camera HAL device for version
29 * CAMERA_DEVICE_API_VERSION_1_0.
30 */
31
32class CameraClient : public CameraService::Client
33{
34public:
35    // ICamera interface (see ICamera for details)
36    virtual void            disconnect();
37    virtual status_t        connect(const sp<ICameraClient>& client);
38    virtual status_t        lock();
39    virtual status_t        unlock();
40    virtual status_t        setPreviewTarget(const sp<IGraphicBufferProducer>& bufferProducer);
41    virtual void            setPreviewCallbackFlag(int flag);
42    virtual status_t        setPreviewCallbackTarget(
43            const sp<IGraphicBufferProducer>& callbackProducer);
44    virtual status_t        startPreview();
45    virtual void            stopPreview();
46    virtual bool            previewEnabled();
47    virtual status_t        storeMetaDataInBuffers(bool enabled);
48    virtual status_t        startRecording();
49    virtual void            stopRecording();
50    virtual bool            recordingEnabled();
51    virtual void            releaseRecordingFrame(const sp<IMemory>& mem);
52    virtual status_t        autoFocus();
53    virtual status_t        cancelAutoFocus();
54    virtual status_t        takePicture(int msgType);
55    virtual status_t        setParameters(const String8& params);
56    virtual String8         getParameters() const;
57    virtual status_t        sendCommand(int32_t cmd, int32_t arg1, int32_t arg2);
58
59    // Interface used by CameraService
60    CameraClient(const sp<CameraService>& cameraService,
61            const sp<ICameraClient>& cameraClient,
62            const String16& clientPackageName,
63            int cameraId,
64            int cameraFacing,
65            int clientPid,
66            int clientUid,
67            int servicePid);
68    ~CameraClient();
69
70    status_t initialize(camera_module_t *module);
71
72    status_t dump(int fd, const Vector<String16>& args);
73
74private:
75
76    // check whether the calling process matches mClientPid.
77    status_t                checkPid() const;
78    status_t                checkPidAndHardware() const;  // also check mHardware != 0
79
80    // these are internal functions used to set up preview buffers
81    status_t                registerPreviewBuffers();
82
83    // camera operation mode
84    enum camera_mode {
85        CAMERA_PREVIEW_MODE   = 0,  // frame automatically released
86        CAMERA_RECORDING_MODE = 1,  // frame has to be explicitly released by releaseRecordingFrame()
87    };
88    // these are internal functions used for preview/recording
89    status_t                startCameraMode(camera_mode mode);
90    status_t                startPreviewMode();
91    status_t                startRecordingMode();
92
93    // internal function used by sendCommand to enable/disable shutter sound.
94    status_t                enableShutterSound(bool enable);
95
96    // these are static callback functions
97    static void             notifyCallback(int32_t msgType, int32_t ext1, int32_t ext2, void* user);
98    static void             dataCallback(int32_t msgType, const sp<IMemory>& dataPtr,
99            camera_frame_metadata_t *metadata, void* user);
100    static void             dataCallbackTimestamp(nsecs_t timestamp, int32_t msgType, const sp<IMemory>& dataPtr, void* user);
101    // handlers for messages
102    void                    handleShutter(void);
103    void                    handlePreviewData(int32_t msgType, const sp<IMemory>& mem,
104            camera_frame_metadata_t *metadata);
105    void                    handlePostview(const sp<IMemory>& mem);
106    void                    handleRawPicture(const sp<IMemory>& mem);
107    void                    handleCompressedPicture(const sp<IMemory>& mem);
108    void                    handleGenericNotify(int32_t msgType, int32_t ext1, int32_t ext2);
109    void                    handleGenericData(int32_t msgType, const sp<IMemory>& dataPtr,
110            camera_frame_metadata_t *metadata);
111    void                    handleGenericDataTimestamp(nsecs_t timestamp, int32_t msgType, const sp<IMemory>& dataPtr);
112
113    void                    copyFrameAndPostCopiedFrame(
114        int32_t msgType,
115        const sp<ICameraClient>& client,
116        const sp<IMemoryHeap>& heap,
117        size_t offset, size_t size,
118        camera_frame_metadata_t *metadata);
119
120    int                     getOrientation(int orientation, bool mirror);
121
122    status_t                setPreviewWindow(
123        const sp<IBinder>& binder,
124        const sp<ANativeWindow>& window);
125
126
127    // these are initialized in the constructor.
128    sp<CameraHardwareInterface>     mHardware;       // cleared after disconnect()
129    int                             mPreviewCallbackFlag;
130    int                             mOrientation;     // Current display orientation
131    bool                            mPlayShutterSound;
132
133    // Ensures atomicity among the public methods
134    mutable Mutex                   mLock;
135    // This is a binder of Surface or Surface.
136    sp<IBinder>                     mSurface;
137    sp<ANativeWindow>               mPreviewWindow;
138
139    // If the user want us to return a copy of the preview frame (instead
140    // of the original one), we allocate mPreviewBuffer and reuse it if possible.
141    sp<MemoryHeapBase>              mPreviewBuffer;
142
143    // We need to avoid the deadlock when the incoming command thread and
144    // the CameraHardwareInterface callback thread both want to grab mLock.
145    // An extra flag is used to tell the callback thread that it should stop
146    // trying to deliver the callback messages if the client is not
147    // interested in it anymore. For example, if the client is calling
148    // stopPreview(), the preview frame messages do not need to be delivered
149    // anymore.
150
151    // This function takes the same parameter as the enableMsgType() and
152    // disableMsgType() functions in CameraHardwareInterface.
153    void                    enableMsgType(int32_t msgType);
154    void                    disableMsgType(int32_t msgType);
155    volatile int32_t        mMsgEnabled;
156
157    // This function keeps trying to grab mLock, or give up if the message
158    // is found to be disabled. It returns true if mLock is grabbed.
159    bool                    lockIfMessageWanted(int32_t msgType);
160};
161
162}
163
164#endif
165