1 /* 2 * Copyright (c) 2011-2012, The Linux Foundation. All rights reserved. 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions are 6 * met: 7 * * Redistributions of source code must retain the above copyright 8 * notice, this list of conditions and the following disclaimer. 9 * * Redistributions in binary form must reproduce the above 10 * copyright notice, this list of conditions and the following 11 * disclaimer in the documentation and/or other materials provided 12 * with the distribution. 13 * * Neither the name of The Linux Foundation nor the names of its 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 17 * THIS SOFTWARE IS PROVIDED "AS IS" AND ANY EXPRESS OR IMPLIED 18 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT 20 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS 21 * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 22 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 23 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR 24 * BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 25 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE 26 * OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN 27 * IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 28 */ 29 30 #ifndef OVERLAY_GENERIC_PIPE_H 31 #define OVERLAY_GENERIC_PIPE_H 32 33 #include "overlayUtils.h" 34 #include "overlayRotator.h" 35 #include "overlayCtrlData.h" 36 37 namespace overlay { 38 39 40 class GenericPipe : utils::NoCopy { 41 public: 42 /* ctor */ 43 explicit GenericPipe(int dpy); 44 /* dtor */ 45 ~GenericPipe(); 46 /* CTRL/DATA init. Not owning rotator, will not init it */ 47 bool init(); 48 /* CTRL/DATA close. Not owning rotator, will not close it */ 49 bool close(); 50 51 /* Control APIs */ 52 /* set source using whf, orient and wait flag */ 53 bool setSource(const utils::PipeArgs& args); 54 /* set crop a.k.a the region of interest */ 55 bool setCrop(const utils::Dim& d); 56 /* set orientation*/ 57 bool setTransform(const utils::eTransform& param); 58 /* set mdp posision using dim */ 59 bool setPosition(const utils::Dim& dim); 60 /* commit changes to the overlay "set"*/ 61 bool commit(); 62 63 /* Data APIs */ 64 /* queue buffer to the overlay */ 65 bool queueBuffer(int fd, uint32_t offset); 66 67 /* return cached startup args */ 68 const utils::PipeArgs& getArgs() const; 69 70 /* retrieve screen info */ 71 utils::ScreenInfo getScreenInfo() const; 72 73 /* retrieve cached crop data */ 74 utils::Dim getCrop() const; 75 76 /* is closed */ 77 bool isClosed() const; 78 79 /* is open */ 80 bool isOpen() const; 81 82 /* return Ctrl fd. Used for S3D */ 83 int getCtrlFd() const; 84 85 /* dump the state of the object */ 86 void dump() const; 87 private: 88 /* set Closed pipe */ 89 bool setClosed(); 90 91 int mFbNum; 92 93 /* Ctrl/Data aggregator */ 94 CtrlData mCtrlData; 95 96 Rotator* mRot; 97 98 //Whether rotator is used for 0-rot or otherwise 99 bool mRotUsed; 100 101 /* Pipe open or closed */ 102 enum ePipeState { 103 CLOSED, 104 OPEN 105 }; 106 ePipeState pipeState; 107 }; 108 109 } //namespace overlay 110 111 #endif // OVERLAY_GENERIC_PIPE_H 112