1 /*
2  * Copyright (C) 2013 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_CAMERA2CLIENT_BASE_H
18 #define ANDROID_SERVERS_CAMERA_CAMERA2CLIENT_BASE_H
19 
20 #include "common/CameraDeviceBase.h"
21 #include "camera/CaptureResult.h"
22 
23 namespace android {
24 
25 class IMemory;
26 
27 class CameraService;
28 
29 template <typename TClientBase>
30 class Camera2ClientBase :
31         public TClientBase,
32         public NotificationListener
33 {
34 public:
35     typedef typename TClientBase::TCamCallbacks TCamCallbacks;
36 
37     /**
38      * Base binder interface (see ICamera/ICameraDeviceUser for details)
39      */
40     virtual status_t       connect(const sp<TCamCallbacks>& callbacks);
41     virtual binder::Status disconnect();
42 
43     /**
44      * Interface used by CameraService
45      */
46 
47     // TODO: too many params, move into a ClientArgs<T>
48     Camera2ClientBase(const sp<CameraService>& cameraService,
49                       const sp<TCamCallbacks>& remoteCallback,
50                       const String16& clientPackageName,
51                       const std::unique_ptr<String16>& clientFeatureId,
52                       const String8& cameraId,
53                       int api1CameraId,
54                       int cameraFacing,
55                       int clientPid,
56                       uid_t clientUid,
57                       int servicePid);
58     virtual ~Camera2ClientBase();
59 
60     virtual status_t      initialize(sp<CameraProviderManager> manager, const String8& monitorTags);
61     virtual status_t      dumpClient(int fd, const Vector<String16>& args);
62 
63     /**
64      * NotificationListener implementation
65      */
66 
67     virtual void          notifyError(int32_t errorCode,
68                                       const CaptureResultExtras& resultExtras);
69     virtual void          notifyIdle();
70     virtual void          notifyShutter(const CaptureResultExtras& resultExtras,
71                                         nsecs_t timestamp);
72     virtual void          notifyAutoFocus(uint8_t newState, int triggerId);
73     virtual void          notifyAutoExposure(uint8_t newState, int triggerId);
74     virtual void          notifyAutoWhitebalance(uint8_t newState,
75                                                  int triggerId);
76     virtual void          notifyPrepared(int streamId);
77     virtual void          notifyRequestQueueEmpty();
78     virtual void          notifyRepeatingRequestError(long lastFrameNumber);
79 
80     int                   getCameraId() const;
81     const sp<CameraDeviceBase>&
82                           getCameraDevice();
83     int                   getCameraDeviceVersion() const;
84     const sp<CameraService>&
85                           getCameraService();
86 
87     /**
88      * Interface used by independent components of CameraClient2Base.
89      */
90 
91     // Simple class to ensure that access to TCamCallbacks is serialized
92     // by requiring mRemoteCallbackLock to be locked before access to
93     // mRemoteCallback is possible.
94     class SharedCameraCallbacks {
95       public:
96         class Lock {
97           public:
98             explicit Lock(SharedCameraCallbacks &client);
99             ~Lock();
100             sp<TCamCallbacks> &mRemoteCallback;
101           private:
102             SharedCameraCallbacks &mSharedClient;
103         };
104         explicit SharedCameraCallbacks(const sp<TCamCallbacks>& client);
105         SharedCameraCallbacks& operator=(const sp<TCamCallbacks>& client);
106         void clear();
107       private:
108         sp<TCamCallbacks> mRemoteCallback;
109         mutable Mutex mRemoteCallbackLock;
110     } mSharedCameraCallbacks;
111 
112 protected:
113 
114     // The PID provided in the constructor call
115     pid_t mInitialClientPid;
116 
asBinderWrapper()117     virtual sp<IBinder> asBinderWrapper() {
118         return IInterface::asBinder(this);
119     }
120 
121     virtual status_t      dumpDevice(int fd, const Vector<String16>& args);
122 
123     /** Binder client interface-related private members */
124 
125     // Mutex that must be locked by methods implementing the binder client
126     // interface. Ensures serialization between incoming client calls.
127     // All methods in this class hierarchy that append 'L' to the name assume
128     // that mBinderSerializationLock is locked when they're called
129     mutable Mutex         mBinderSerializationLock;
130 
131     /** CameraDeviceBase instance wrapping HAL3+ entry */
132 
133     const int mDeviceVersion;
134 
135     // Set to const to avoid mDevice being updated (update of sp<> is racy) during
136     // dumpDevice (which is important to be lock free for debugging purpose)
137     const sp<CameraDeviceBase>  mDevice;
138 
139     /** Utility members */
140 
141     // Verify that caller is the owner of the camera
142     status_t              checkPid(const char *checkLocation) const;
143 
144     virtual void          detachDevice();
145 
146     bool                  mDeviceActive;
147 
148     const int             mApi1CameraId; // -1 if client is API2
149 
150 private:
151     template<typename TProviderPtr>
152     status_t              initializeImpl(TProviderPtr providerPtr, const String8& monitorTags);
153 };
154 
155 }; // namespace android
156 
157 #endif
158