Camera3StreamInterface.h revision be83fa713da45b1c751d33ad69ce0017ebe9f707
1ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin/* 2ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Copyright (C) 2013 The Android Open Source Project 3ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 4ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Licensed under the Apache License, Version 2.0 (the "License"); 5ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * you may not use this file except in compliance with the License. 6ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * You may obtain a copy of the License at 7ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 8ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * http://www.apache.org/licenses/LICENSE-2.0 9ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 10ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Unless required by applicable law or agreed to in writing, software 11ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * distributed under the License is distributed on an "AS IS" BASIS, 12ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * See the License for the specific language governing permissions and 14ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * limitations under the License. 15ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 16ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 17ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin#ifndef ANDROID_SERVERS_CAMERA3_STREAM_INTERFACE_H 18ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin#define ANDROID_SERVERS_CAMERA3_STREAM_INTERFACE_H 19ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 20ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin#include <utils/RefBase.h> 21ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin#include "Camera3StreamBufferListener.h" 22be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh#include "Camera3StreamBufferFreedListener.h" 23ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 24ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkinstruct camera3_stream_buffer; 25ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 26ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkinnamespace android { 27ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 28ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkinnamespace camera3 { 29ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 30125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun Heenum { 31125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He /** 32125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He * This stream set ID indicates that the set ID is invalid, and this stream doesn't intend to 33125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He * share buffers with any other stream. It is illegal to register this kind of stream to 34125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He * Camera3BufferManager. 35125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He */ 36125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He CAMERA3_STREAM_SET_ID_INVALID = -1, 37125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He 38125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He /** 39125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He * Invalid output stream ID. 40125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He */ 41125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He CAMERA3_STREAM_ID_INVALID = -1, 42125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He}; 43125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He 44f1e98d857ec377f2c9b916073d40732e6ebb7cedEino-Ville Talvalaclass StatusTracker; 45f1e98d857ec377f2c9b916073d40732e6ebb7cedEino-Ville Talvala 46ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin/** 47ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * An interface for managing a single stream of input and/or output data from 48ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * the camera device. 49ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 50ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkinclass Camera3StreamInterface : public virtual RefBase { 51ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin public: 52c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk 53c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk enum { 54c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk ALLOCATE_PIPELINE_MAX = 0, // Allocate max buffers used by a given surface 55c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk }; 56c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk 57ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 58ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Get the stream's ID 59ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 60ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual int getId() const = 0; 61ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 62125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He /** 63125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He * Get the output stream set id. 64125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He */ 65125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He virtual int getStreamSetId() const = 0; 66125684aba1a11b7adbf5f9d607ee2bcc9449081cZhijun He 67ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 68ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Get the stream's dimensions and format 69ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 70ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual uint32_t getWidth() const = 0; 71ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual uint32_t getHeight() const = 0; 72ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual int getFormat() const = 0; 73d46a6b9fd8b2a4f9098757384711e2cd03a91651Eino-Ville Talvala virtual android_dataspace getDataSpace() const = 0; 74ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 75ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 760b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala * Get a HAL3 handle for the stream, without starting stream configuration. 770b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala */ 780b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala virtual camera3_stream* asHalStream() = 0; 790b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala 800b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala /** 81ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Start the stream configuration process. Returns a handle to the stream's 82ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * information to be passed into the HAL device's configure_streams call. 83ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 84ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Until finishConfiguration() is called, no other methods on the stream may 85ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * be called. The usage and max_buffers fields of camera3_stream may be 86ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * modified between start/finishConfiguration, but may not be changed after 87ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * that. The priv field of camera3_stream may be modified at any time after 88ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * startConfiguration. 89ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 90ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Returns NULL in case of error starting configuration. 91ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 92ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual camera3_stream* startConfiguration() = 0; 93ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 94ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 95ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Check if the stream is mid-configuration (start has been called, but not 96ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * finish). Used for lazy completion of configuration. 97ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 98ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual bool isConfiguring() const = 0; 99ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 100ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 101ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Completes the stream configuration process. During this call, the stream 102ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * may call the device's register_stream_buffers() method. The stream 103ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * information structure returned by startConfiguration() may no longer be 104ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * modified after this call, but can still be read until the destruction of 105ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * the stream. 106ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 107ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Returns: 108ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * OK on a successful configuration 109ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * NO_INIT in case of a serious error from the HAL device 110ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * NO_MEMORY in case of an error registering buffers 111ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * INVALID_OPERATION in case connecting to the consumer failed 112ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 1130b1cb14c804d7d4343fe91c78578da8db9a678d5Eino-Ville Talvala virtual status_t finishConfiguration() = 0; 114ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 115ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 1161754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala * Cancels the stream configuration process. This returns the stream to the 1171754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala * initial state, allowing it to be configured again later. 1181754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala * This is done if the HAL rejects the proposed combined stream configuration 1191754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala */ 1201754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala virtual status_t cancelConfiguration() = 0; 1211754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala 1221754351d9199721e7e7943461689e399ef015260Eino-Ville Talvala /** 1234d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Determine whether the stream has already become in-use (has received 1244d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * a valid filled buffer), which determines if a stream can still have 1254d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * prepareNextBuffer called on it. 1264d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala */ 1274d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala virtual bool isUnpreparable() = 0; 1284d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala 1294d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala /** 1304d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Start stream preparation. May only be called in the CONFIGURED state, 131c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk * when no valid buffers have yet been returned to this stream. Prepares 132c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk * up to maxCount buffers, or the maximum number of buffers needed by the 133c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk * pipeline if maxCount is ALLOCATE_PIPELINE_MAX. 1344d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * 1354d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * If no prepartion is necessary, returns OK and does not transition to 1364d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * PREPARING state. Otherwise, returns NOT_ENOUGH_DATA and transitions 1374d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * to PREPARING. 1384d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * 1394d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Returns: 1404d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * OK if no more buffers need to be preallocated 1414d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * NOT_ENOUGH_DATA if calls to prepareNextBuffer are needed to finish 1424d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * buffer pre-allocation, and transitions to the PREPARING state. 1434d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * NO_INIT in case of a serious error from the HAL device 1444d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * INVALID_OPERATION if called when not in CONFIGURED state, or a 1454d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * valid buffer has already been returned to this stream. 1464d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala */ 147c78ac26e3a65328fc0118f16ee76a800d0687eb7Ruben Brunk virtual status_t startPrepare(int maxCount) = 0; 1484d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala 1494d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala /** 1504d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Check if the stream is mid-preparing. 1514d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala */ 1524d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala virtual bool isPreparing() const = 0; 1534d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala 1544d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala /** 1554d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Continue stream buffer preparation by allocating the next 1564d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * buffer for this stream. May only be called in the PREPARED state. 1574d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * 1584d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Returns OK and transitions to the CONFIGURED state if all buffers 1594d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * are allocated after the call concludes. Otherwise returns NOT_ENOUGH_DATA. 1604d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * 1614d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Returns: 1624d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * OK if no more buffers need to be preallocated, and transitions 1634d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * to the CONFIGURED state. 1644d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * NOT_ENOUGH_DATA if more calls to prepareNextBuffer are needed to finish 1654d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * buffer pre-allocation. 1664d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * NO_INIT in case of a serious error from the HAL device 1674d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * INVALID_OPERATION if called when not in CONFIGURED state, or a 1684d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * valid buffer has already been returned to this stream. 1694d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala */ 1704d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala virtual status_t prepareNextBuffer() = 0; 1714d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala 1724d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala /** 1734d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Cancel stream preparation early. In case allocation needs to be 1744d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * stopped, this method transitions the stream back to the CONFIGURED state. 1754d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Buffers that have been allocated with prepareNextBuffer remain that way, 1764d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * but a later use of prepareNextBuffer will require just as many 1774d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * calls as if the earlier prepare attempt had not existed. 1784d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * 1794d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * Returns: 1804d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * OK if cancellation succeeded, and transitions to the CONFIGURED state 1814d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * INVALID_OPERATION if not in the PREPARING state 1824d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala * NO_INIT in case of a serious error from the HAL device 1834d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala */ 1844d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala virtual status_t cancelPrepare() = 0; 1854d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala 1864d44cad22ea925a651463f2d51d6586c14d4b787Eino-Ville Talvala /** 187b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * Tear down memory for this stream. This frees all unused gralloc buffers 188b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * allocated for this stream, but leaves it ready for operation afterward. 189b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * 190b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * May only be called in the CONFIGURED state, and keeps the stream in 191b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * the CONFIGURED state. 192b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * 193b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * Returns: 194b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * OK if teardown succeeded. 195b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * INVALID_OPERATION if not in the CONFIGURED state 196b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala * NO_INIT in case of a serious error from the HAL device 197b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala */ 198b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala virtual status_t tearDown() = 0; 199b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala 200b25e3c87724b6147ed1da7c1d6617c39bfce2fbfEino-Ville Talvala /** 201ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Fill in the camera3_stream_buffer with the next valid buffer for this 202ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * stream, to hand over to the HAL. 203ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 204bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * Multiple surfaces could share the same HAL stream, but a request may 205bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * be only for a subset of surfaces. In this case, the 206bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * Camera3StreamInterface object needs the surface ID information to acquire 207bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * buffers for those surfaces. For the case of single surface for a HAL 208bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * stream, surface_ids parameter has no effect. 209bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang * 210ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * This method may only be called once finishConfiguration has been called. 211ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * For bidirectional streams, this method applies to the output-side 212ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * buffers. 213ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 214ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 215bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang virtual status_t getBuffer(camera3_stream_buffer *buffer, 216bee0f0a5e7aa19aa7c59de03b508985b68bc6b5eShuzhen Wang const std::vector<size_t>& surface_ids = std::vector<size_t>()) = 0; 217ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 218ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 219ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Return a buffer to the stream after use by the HAL. 220ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 221ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * This method may only be called for buffers provided by getBuffer(). 222ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * For bidirectional streams, this method applies to the output-side buffers 223ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 224ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual status_t returnBuffer(const camera3_stream_buffer &buffer, 225ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin nsecs_t timestamp) = 0; 226ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 227ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 228ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Fill in the camera3_stream_buffer with the next valid buffer for this 229ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * stream, to hand over to the HAL. 230ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 231ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * This method may only be called once finishConfiguration has been called. 232ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * For bidirectional streams, this method applies to the input-side 233ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * buffers. 234ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 235ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 236ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual status_t getInputBuffer(camera3_stream_buffer *buffer) = 0; 237ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 238ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 239ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Return a buffer to the stream after use by the HAL. 240ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * 241ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * This method may only be called for buffers provided by getBuffer(). 242ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * For bidirectional streams, this method applies to the input-side buffers 243ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 244ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual status_t returnInputBuffer(const camera3_stream_buffer &buffer) = 0; 245ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 246ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 247618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen * Get the buffer producer of the input buffer queue. 248618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen * 249618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen * This method only applies to input streams. 250618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen */ 251618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen virtual status_t getInputBufferProducer(sp<IGraphicBufferProducer> *producer) = 0; 252618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen 253618ff8a48a0c895a78f91f5692510c2a809425c3Chien-Yu Chen /** 254ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Whether any of the stream's buffers are currently in use by the HAL, 255ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * including buffers that have been returned but not yet had their 256ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * release fence signaled. 257ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 258ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual bool hasOutstandingBuffers() const = 0; 259ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 260ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin enum { 261ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin TIMEOUT_NEVER = -1 262ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin }; 263f1e98d857ec377f2c9b916073d40732e6ebb7cedEino-Ville Talvala 264ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 265f1e98d857ec377f2c9b916073d40732e6ebb7cedEino-Ville Talvala * Set the state tracker to use for signaling idle transitions. 266ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 267f1e98d857ec377f2c9b916073d40732e6ebb7cedEino-Ville Talvala virtual status_t setStatusTracker(sp<StatusTracker> statusTracker) = 0; 268ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 269ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 270ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Disconnect stream from its non-HAL endpoint. After this, 271ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * start/finishConfiguration must be called before the stream can be used 272ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * again. This cannot be called if the stream has outstanding dequeued 273ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * buffers. 274ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 275ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual status_t disconnect() = 0; 276ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 277ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin /** 278e8c535e833ed135895e99ca81aa3b85d80d7cf3cChien-Yu Chen * Return if the buffer queue of the stream is abandoned. 279e8c535e833ed135895e99ca81aa3b85d80d7cf3cChien-Yu Chen */ 280e8c535e833ed135895e99ca81aa3b85d80d7cf3cChien-Yu Chen virtual bool isAbandoned() const = 0; 281e8c535e833ed135895e99ca81aa3b85d80d7cf3cChien-Yu Chen 282e8c535e833ed135895e99ca81aa3b85d80d7cf3cChien-Yu Chen /** 283ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin * Debug dump of the stream's state. 284ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin */ 285ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual void dump(int fd, const Vector<String16> &args) const = 0; 286ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 287ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual void addBufferListener( 288ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin wp<Camera3StreamBufferListener> listener) = 0; 289ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin virtual void removeBufferListener( 290ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin const sp<Camera3StreamBufferListener>& listener) = 0; 291be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh 292be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh /** 293be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh * Setting listner will remove previous listener (if exists) 294be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh * Only allow set listener during stream configuration because stream is guaranteed to be IDLE 295be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh * at this state, so setBufferFreedListener won't collide with onBufferFreed callbacks. 296be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh * Client is responsible to keep the listener object alive throughout the lifecycle of this 297be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh * Camera3Stream. 298be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh */ 299be83fa713da45b1c751d33ad69ce0017ebe9f707Yin-Chia Yeh virtual void setBufferFreedListener(Camera3StreamBufferFreedListener* listener) = 0; 300ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin}; 301ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 302ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin} // namespace camera3 303ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 304ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin} // namespace android 305ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin 306ae500e53efa1d26eb7c13e62d0ecc8d75db2473aIgor Murashkin#endif 307