| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml"> |
| <head> |
| <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" /> |
| <title>Doxygen-Generated Content</title> |
| <link href="doxygen.css" rel="stylesheet" type="text/css" /> |
| <style type="text/css"> |
| <!-- |
| .navigation { |
| display: none; |
| } |
| --> |
| </style> |
| </head> |
| <body> |
| <!-- Generated by Doxygen 1.5.6 --> |
| <div class="navigation" id="top"> |
| <div class="tabs"> |
| <ul> |
| <li><a href="index.html"><span>Main Page</span></a></li> |
| <li><a href="namespaces.html"><span>Namespaces</span></a></li> |
| <li><a href="annotated.html"><span>Data Structures</span></a></li> |
| <li class="current"><a href="files.html"><span>Files</span></a></li> |
| </ul> |
| </div> |
| </div> |
| <h1>CameraHardwareInterface.h</h1><a href="_camera_hardware_interface_8h.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">/*</span> |
| <a name="l00002"></a>00002 <span class="comment"> * Copyright (C) 2008 The Android Open Source Project</span> |
| <a name="l00003"></a>00003 <span class="comment"> *</span> |
| <a name="l00004"></a>00004 <span class="comment"> * Licensed under the Apache License, Version 2.0 (the "License");</span> |
| <a name="l00005"></a>00005 <span class="comment"> * you may not use this file except in compliance with the License.</span> |
| <a name="l00006"></a>00006 <span class="comment"> * You may obtain a copy of the License at</span> |
| <a name="l00007"></a>00007 <span class="comment"> *</span> |
| <a name="l00008"></a>00008 <span class="comment"> * http://www.apache.org/licenses/LICENSE-2.0</span> |
| <a name="l00009"></a>00009 <span class="comment"> *</span> |
| <a name="l00010"></a>00010 <span class="comment"> * Unless required by applicable law or agreed to in writing, software</span> |
| <a name="l00011"></a>00011 <span class="comment"> * distributed under the License is distributed on an "AS IS" BASIS,</span> |
| <a name="l00012"></a>00012 <span class="comment"> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.</span> |
| <a name="l00013"></a>00013 <span class="comment"> * See the License for the specific language governing permissions and</span> |
| <a name="l00014"></a>00014 <span class="comment"> * limitations under the License.</span> |
| <a name="l00015"></a>00015 <span class="comment"> */</span> |
| <a name="l00016"></a>00016 |
| <a name="l00017"></a>00017 <span class="preprocessor">#ifndef ANDROID_HARDWARE_CAMERA_HARDWARE_INTERFACE_H</span> |
| <a name="l00018"></a>00018 <span class="preprocessor"></span><span class="preprocessor">#define ANDROID_HARDWARE_CAMERA_HARDWARE_INTERFACE_H</span> |
| <a name="l00019"></a>00019 <span class="preprocessor"></span> |
| <a name="l00020"></a>00020 <span class="preprocessor">#include <utils/IMemory.h></span> |
| <a name="l00021"></a>00021 <span class="preprocessor">#include <utils/RefBase.h></span> |
| <a name="l00022"></a>00022 <span class="preprocessor">#include <ui/CameraParameters.h></span> |
| <a name="l00023"></a>00023 |
| <a name="l00024"></a>00024 <span class="keyword">namespace </span>android { |
| <a name="l00025"></a>00025 <span class="comment"></span> |
| <a name="l00026"></a>00026 <span class="comment">/** Callback for startPreview() */</span> |
| <a name="l00027"></a><a class="code" href="namespaceandroid.html#d32b08663d42356404e2eb971e271636">00027</a> <span class="keyword">typedef</span> void (*<a class="code" href="namespaceandroid.html#d32b08663d42356404e2eb971e271636" title="Callback for startPreview().">preview_callback</a>)(<span class="keyword">const</span> sp<IMemory>& mem, <span class="keywordtype">void</span>* user); |
| <a name="l00028"></a>00028 <span class="comment"></span> |
| <a name="l00029"></a>00029 <span class="comment">/** Callback for takePicture() */</span> |
| <a name="l00030"></a><a class="code" href="namespaceandroid.html#04c83209c2627e2d303320712ca9ee65">00030</a> <span class="keyword">typedef</span> void (*<a class="code" href="namespaceandroid.html#04c83209c2627e2d303320712ca9ee65" title="Callback for takePicture().">shutter_callback</a>)(<span class="keywordtype">void</span>* user); |
| <a name="l00031"></a>00031 <span class="comment"></span> |
| <a name="l00032"></a>00032 <span class="comment">/** Callback for takePicture() */</span> |
| <a name="l00033"></a><a class="code" href="namespaceandroid.html#a97926709e452d66360cb9b24736969e">00033</a> <span class="keyword">typedef</span> void (*<a class="code" href="namespaceandroid.html#a97926709e452d66360cb9b24736969e" title="Callback for takePicture().">raw_callback</a>)(<span class="keyword">const</span> sp<IMemory>& mem, <span class="keywordtype">void</span>* user); |
| <a name="l00034"></a>00034 <span class="comment"></span> |
| <a name="l00035"></a>00035 <span class="comment">/** Callback for takePicture() */</span> |
| <a name="l00036"></a><a class="code" href="namespaceandroid.html#c21980d4be1e0cc458399ecf5374d473">00036</a> <span class="keyword">typedef</span> void (*<a class="code" href="namespaceandroid.html#c21980d4be1e0cc458399ecf5374d473" title="Callback for takePicture().">jpeg_callback</a>)(<span class="keyword">const</span> sp<IMemory>& mem, <span class="keywordtype">void</span>* user); |
| <a name="l00037"></a>00037 <span class="comment"></span> |
| <a name="l00038"></a>00038 <span class="comment">/** Callback for autoFocus() */</span> |
| <a name="l00039"></a><a class="code" href="namespaceandroid.html#4dca8d8b824ca9a684358133da0ec8f2">00039</a> <span class="keyword">typedef</span> void (*<a class="code" href="namespaceandroid.html#4dca8d8b824ca9a684358133da0ec8f2" title="Callback for autoFocus().">autofocus_callback</a>)(<span class="keywordtype">bool</span> focused, <span class="keywordtype">void</span>* user); |
| <a name="l00040"></a>00040 <span class="comment"></span> |
| <a name="l00041"></a>00041 <span class="comment">/**</span> |
| <a name="l00042"></a>00042 <span class="comment"> * CameraHardwareInterface.h defines the interface to the</span> |
| <a name="l00043"></a>00043 <span class="comment"> * camera hardware abstraction layer, used for setting and getting</span> |
| <a name="l00044"></a>00044 <span class="comment"> * parameters, live previewing, and taking pictures.</span> |
| <a name="l00045"></a>00045 <span class="comment"> *</span> |
| <a name="l00046"></a>00046 <span class="comment"> * It is a referenced counted interface with RefBase as its base class.</span> |
| <a name="l00047"></a>00047 <span class="comment"> * CameraService calls openCameraHardware() to retrieve a strong pointer to the</span> |
| <a name="l00048"></a>00048 <span class="comment"> * instance of this interface and may be called multiple times. The</span> |
| <a name="l00049"></a>00049 <span class="comment"> * following steps describe a typical sequence:</span> |
| <a name="l00050"></a>00050 <span class="comment"> *</span> |
| <a name="l00051"></a>00051 <span class="comment"> * -# After CameraService calls openCameraHardware(), getParameters() and</span> |
| <a name="l00052"></a>00052 <span class="comment"> * setParameters() are used to initialize the camera instance.</span> |
| <a name="l00053"></a>00053 <span class="comment"> * CameraService calls getPreviewHeap() to establish access to the</span> |
| <a name="l00054"></a>00054 <span class="comment"> * preview heap so it can be registered with SurfaceFlinger for</span> |
| <a name="l00055"></a>00055 <span class="comment"> * efficient display updating while in preview mode.</span> |
| <a name="l00056"></a>00056 <span class="comment"> * -# startPreview() is called, which is passed a preview_callback()</span> |
| <a name="l00057"></a>00057 <span class="comment"> * function and a user parameter. The camera instance then periodically</span> |
| <a name="l00058"></a>00058 <span class="comment"> * calls preview_callback() each time a new preview frame is available.</span> |
| <a name="l00059"></a>00059 <span class="comment"> * The callback routine has two parameters: the first is a pointer to</span> |
| <a name="l00060"></a>00060 <span class="comment"> * the IMemory containing the frame and the second a user parameter. If</span> |
| <a name="l00061"></a>00061 <span class="comment"> * the preview_callback code needs to use this memory after returning,</span> |
| <a name="l00062"></a>00062 <span class="comment"> * it must copy the data.</span> |
| <a name="l00063"></a>00063 <span class="comment"> *</span> |
| <a name="l00064"></a>00064 <span class="comment"> * Prior to taking a picture, CameraService calls autofocus() with</span> |
| <a name="l00065"></a>00065 <span class="comment"> * autofocus_callback() and a user parameter. When auto focusing has</span> |
| <a name="l00066"></a>00066 <span class="comment"> * completed, the camera instance calls autofocus_callback(), which informs</span> |
| <a name="l00067"></a>00067 <span class="comment"> * the application whether focusing was successful. The camera instance</span> |
| <a name="l00068"></a>00068 <span class="comment"> * only calls autofocus_callback() once and it is up to the application to</span> |
| <a name="l00069"></a>00069 <span class="comment"> * call autoFocus() again if refocusing is desired.</span> |
| <a name="l00070"></a>00070 <span class="comment"> *</span> |
| <a name="l00071"></a>00071 <span class="comment"> * CameraService calls takePicture() to request the camera instance take a</span> |
| <a name="l00072"></a>00072 <span class="comment"> * picture. This method has two callbacks: raw_callback() and jpeg_callback().</span> |
| <a name="l00073"></a>00073 <span class="comment"> * When the raw image is available, raw_callback() is called with a pointer</span> |
| <a name="l00074"></a>00074 <span class="comment"> * to the IMemory containing the raw image. When the jpeg image is available,</span> |
| <a name="l00075"></a>00075 <span class="comment"> * jpeg_callback() is called with a pointer to the IMemory containing the</span> |
| <a name="l00076"></a>00076 <span class="comment"> * jpeg image. As with preview_callback(), the memory must be copied if it's</span> |
| <a name="l00077"></a>00077 <span class="comment"> * needed after returning.</span> |
| <a name="l00078"></a>00078 <span class="comment"> */</span> |
| <a name="l00079"></a><a class="code" href="classandroid_1_1_camera_hardware_interface.html">00079</a> <span class="keyword">class </span><a class="code" href="classandroid_1_1_camera_hardware_interface.html" title="CameraHardwareInterface.h defines the interface to the camera hardware abstraction...">CameraHardwareInterface</a> : <span class="keyword">public</span> <span class="keyword">virtual</span> RefBase { |
| <a name="l00080"></a>00080 <span class="keyword">public</span>: |
| <a name="l00081"></a><a class="code" href="classandroid_1_1_camera_hardware_interface.html#99f4ab74b58cd4b23e0fb00a46a60cb1">00081</a> <span class="keyword">virtual</span> <a class="code" href="classandroid_1_1_camera_hardware_interface.html#99f4ab74b58cd4b23e0fb00a46a60cb1">~CameraHardwareInterface</a>() { } |
| <a name="l00082"></a>00082 <span class="comment"></span> |
| <a name="l00083"></a>00083 <span class="comment"> /** Return the IMemoryHeap for the preview image heap */</span> |
| <a name="l00084"></a>00084 <span class="keyword">virtual</span> sp<IMemoryHeap> <a class="code" href="classandroid_1_1_camera_hardware_interface.html#9d4071fb234a0c2e7bf6ea78e723f2f4" title="Return the IMemoryHeap for the preview image heap.">getPreviewHeap</a>() <span class="keyword">const</span> = 0; |
| <a name="l00085"></a>00085 <span class="comment"></span> |
| <a name="l00086"></a>00086 <span class="comment"> /**</span> |
| <a name="l00087"></a>00087 <span class="comment"> * Start preview mode. When a preview image is available</span> |
| <a name="l00088"></a>00088 <span class="comment"> * preview_callback is called with the user parameter. The</span> |
| <a name="l00089"></a>00089 <span class="comment"> * call back parameter may be null.</span> |
| <a name="l00090"></a>00090 <span class="comment"> */</span> |
| <a name="l00091"></a>00091 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#62def8031dee8bdab7933770708a6312" title="Start preview mode.">startPreview</a>(<a class="code" href="namespaceandroid.html#d32b08663d42356404e2eb971e271636" title="Callback for startPreview().">preview_callback</a> cb, <span class="keywordtype">void</span>* user) = 0; |
| <a name="l00092"></a>00092 <span class="comment"></span> |
| <a name="l00093"></a>00093 <span class="comment"> /**</span> |
| <a name="l00094"></a>00094 <span class="comment"> * Stop a previously started preview.</span> |
| <a name="l00095"></a>00095 <span class="comment"> */</span> |
| <a name="l00096"></a>00096 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classandroid_1_1_camera_hardware_interface.html#34faa77065f415b93cb1acf84fc788bf" title="Stop a previously started preview.">stopPreview</a>() = 0; |
| <a name="l00097"></a>00097 <span class="comment"></span> |
| <a name="l00098"></a>00098 <span class="comment"> /**</span> |
| <a name="l00099"></a>00099 <span class="comment"> * Start auto focus, the callback routine is called</span> |
| <a name="l00100"></a>00100 <span class="comment"> * once when focusing is complete. autoFocus() will</span> |
| <a name="l00101"></a>00101 <span class="comment"> * be called again if another auto focus is needed.</span> |
| <a name="l00102"></a>00102 <span class="comment"> */</span> |
| <a name="l00103"></a>00103 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#0dda73938e9b18326dd48bd721dbd515" title="Start auto focus, the callback routine is called once when focusing is complete.">autoFocus</a>(<a class="code" href="namespaceandroid.html#4dca8d8b824ca9a684358133da0ec8f2" title="Callback for autoFocus().">autofocus_callback</a>, |
| <a name="l00104"></a>00104 <span class="keywordtype">void</span>* user) = 0; |
| <a name="l00105"></a>00105 <span class="comment"></span> |
| <a name="l00106"></a>00106 <span class="comment"> /**</span> |
| <a name="l00107"></a>00107 <span class="comment"> * Take a picture. The raw_callback is called when</span> |
| <a name="l00108"></a>00108 <span class="comment"> * the uncompressed image is available. The jpeg_callback</span> |
| <a name="l00109"></a>00109 <span class="comment"> * is called when the compressed image is available. These</span> |
| <a name="l00110"></a>00110 <span class="comment"> * call backs may be null. The user parameter is passed</span> |
| <a name="l00111"></a>00111 <span class="comment"> * to each of the call back routines.</span> |
| <a name="l00112"></a>00112 <span class="comment"> */</span> |
| <a name="l00113"></a>00113 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#2aedf65cad695ce439029f37a7cb66c4" title="Take a picture.">takePicture</a>(<a class="code" href="namespaceandroid.html#04c83209c2627e2d303320712ca9ee65" title="Callback for takePicture().">shutter_callback</a>, |
| <a name="l00114"></a>00114 <a class="code" href="namespaceandroid.html#a97926709e452d66360cb9b24736969e" title="Callback for takePicture().">raw_callback</a>, |
| <a name="l00115"></a>00115 <a class="code" href="namespaceandroid.html#c21980d4be1e0cc458399ecf5374d473" title="Callback for takePicture().">jpeg_callback</a>, |
| <a name="l00116"></a>00116 <span class="keywordtype">void</span>* user) = 0; |
| <a name="l00117"></a>00117 <span class="comment"></span> |
| <a name="l00118"></a>00118 <span class="comment"> /**</span> |
| <a name="l00119"></a>00119 <span class="comment"> * Cancel a picture that was started with takePicture. You may cancel any</span> |
| <a name="l00120"></a>00120 <span class="comment"> * of the shutter, raw, or jpeg callbacks. Calling this method when no</span> |
| <a name="l00121"></a>00121 <span class="comment"> * picture is being taken is a no-op.</span> |
| <a name="l00122"></a>00122 <span class="comment"> */</span> |
| <a name="l00123"></a>00123 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#da8faf376215a605357d26afa1b79386" title="Cancel a picture that was started with takePicture.">cancelPicture</a>(<span class="keywordtype">bool</span> cancel_shutter, |
| <a name="l00124"></a>00124 <span class="keywordtype">bool</span> cancel_raw, |
| <a name="l00125"></a>00125 <span class="keywordtype">bool</span> cancel_jpeg) = 0; |
| <a name="l00126"></a>00126 <span class="comment"></span> |
| <a name="l00127"></a>00127 <span class="comment"> /** Set the camera parameters. */</span> |
| <a name="l00128"></a>00128 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#82e54ede14bd263274bbc8777bafc384" title="Set the camera parameters.">setParameters</a>(<span class="keyword">const</span> CameraParameters& params) = 0; |
| <a name="l00129"></a>00129 <span class="comment"></span> |
| <a name="l00130"></a>00130 <span class="comment"> /** Return the camera parameters. */</span> |
| <a name="l00131"></a>00131 <span class="keyword">virtual</span> CameraParameters <a class="code" href="classandroid_1_1_camera_hardware_interface.html#4c748a3c0aa3c5f2333e0abcdbeb15cb" title="Return the camera parameters.">getParameters</a>() <span class="keyword">const</span> = 0; |
| <a name="l00132"></a>00132 <span class="comment"></span> |
| <a name="l00133"></a>00133 <span class="comment"> /**</span> |
| <a name="l00134"></a>00134 <span class="comment"> * Release the hardware resources owned by this object. Note that this is</span> |
| <a name="l00135"></a>00135 <span class="comment"> * *not* done in the destructor.</span> |
| <a name="l00136"></a>00136 <span class="comment"> */</span> |
| <a name="l00137"></a>00137 <span class="keyword">virtual</span> <span class="keywordtype">void</span> <a class="code" href="classandroid_1_1_camera_hardware_interface.html#df65310b8aa176e0ce5f08b87d6b7eb8" title="Release the hardware resources owned by this object.">release</a>() = 0; |
| <a name="l00138"></a>00138 <span class="comment"></span> |
| <a name="l00139"></a>00139 <span class="comment"> /**</span> |
| <a name="l00140"></a>00140 <span class="comment"> * Dump state of the camera hardware</span> |
| <a name="l00141"></a>00141 <span class="comment"> */</span> |
| <a name="l00142"></a>00142 <span class="keyword">virtual</span> status_t <a class="code" href="classandroid_1_1_camera_hardware_interface.html#06df1bf91b8af07964dca314a6031b32" title="Dump state of the camera hardware.">dump</a>(<span class="keywordtype">int</span> fd, <span class="keyword">const</span> Vector<String16>& args) <span class="keyword">const</span> = 0; |
| <a name="l00143"></a>00143 }; |
| <a name="l00144"></a>00144 <span class="comment"></span> |
| <a name="l00145"></a>00145 <span class="comment">/** factory function to instantiate a camera hardware object */</span> |
| <a name="l00146"></a>00146 <span class="keyword">extern</span> <span class="stringliteral">"C"</span> sp<CameraHardwareInterface> <a class="code" href="namespaceandroid.html#24c243f7f9ba0d1d881be17ae06254a2" title="factory function to instantiate a camera hardware object">openCameraHardware</a>(); |
| <a name="l00147"></a>00147 |
| <a name="l00148"></a>00148 }; <span class="comment">// namespace android</span> |
| <a name="l00149"></a>00149 |
| <a name="l00150"></a>00150 <span class="preprocessor">#endif</span> |
| </pre></div></div> |
| </body> |
| </html> |
