1 /* 2 * Copyright (c) 2011-2013, 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 "overlayCtrlData.h" 35 36 namespace overlay { 37 38 class GenericPipe : utils::NoCopy { 39 public: 40 /* ctor */ 41 explicit GenericPipe(int dpy); 42 /* dtor */ 43 ~GenericPipe(); 44 bool init(); 45 bool close(); 46 /* Control APIs */ 47 /* set source using whf, orient and wait flag */ 48 void setSource(const utils::PipeArgs& args); 49 /* set crop a.k.a the region of interest */ 50 void setCrop(const utils::Dim& d); 51 /* set orientation*/ 52 void setTransform(const utils::eTransform& param); 53 /* set mdp posision using dim */ 54 void setPosition(const utils::Dim& dim); 55 /* set visual param */ 56 bool setVisualParams(const MetaData_t &metadata); 57 /* commit changes to the overlay "set"*/ 58 bool commit(); 59 /* Data APIs */ 60 /* queue buffer to the overlay */ 61 bool queueBuffer(int fd, uint32_t offset); 62 /* return cached startup args */ 63 const utils::PipeArgs& getArgs() const; 64 /* retrieve cached crop data */ 65 utils::Dim getCrop() const; 66 /* is closed */ 67 bool isClosed() const; 68 /* is open */ 69 bool isOpen() const; 70 /* return Ctrl fd. Used for S3D */ 71 int getCtrlFd() const; 72 /* dump the state of the object */ 73 void dump() const; 74 /* Return the dump in the specified buffer */ 75 void getDump(char *buf, size_t len); 76 /* Marks the pipe for forcible setting of params 77 * even if they haven't changed 78 */ 79 void forceSet(); 80 81 private: 82 /* set Closed pipe */ 83 bool setClosed(); 84 85 int mDpy; 86 /* Ctrl/Data aggregator */ 87 CtrlData mCtrlData; 88 //Whether we will do downscale opt. This is just a request. If the frame is 89 //not a candidate, we might not do it. 90 bool mRotDownscaleOpt; 91 /* Pipe open or closed */ 92 enum ePipeState { 93 CLOSED, 94 OPEN 95 }; 96 ePipeState pipeState; 97 }; 98 99 } //namespace overlay 100 101 #endif // OVERLAY_GENERIC_PIPE_H 102