Home | History | Annotate | Download | only in pipes 
      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(const int& dpy);
     42     /* dtor */
     43     ~GenericPipe();
     44     /* Control APIs */
     45     /* set source using whf, orient and wait flag */
     46     void setSource(const utils::PipeArgs& args);
     47     /* set crop a.k.a the region of interest */
     48     void setCrop(const utils::Dim& d);
     49     /* set color for mdp pipe */
     50     void setColor(const uint32_t color);
     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     /* return pipe priority */
     73     uint8_t getPriority() const;
     74     /* dump the state of the object */
     75     void dump() const;
     76     /* Return the dump in the specified buffer */
     77     void getDump(char *buf, size_t len);
     78     int getPipeId();
     79 
     80     static bool validateAndSet(GenericPipe* pipeArray[], const int& count,
     81             const int& fbFd);
     82 private:
     83     /* set Closed pipe */
     84     bool setClosed();
     85 
     86     int mDpy;
     87     //Whether we will do downscale opt. This is just a request. If the frame is
     88     //not a candidate, we might not do it.
     89     bool mRotDownscaleOpt;
     90     /* Pipe open or closed */
     91     enum ePipeState {
     92         CLOSED,
     93         OPEN
     94     };
     95     ePipeState pipeState;
     96     Ctrl *mCtrl;
     97     Data *mData;
     98 };
     99 
    100 } //namespace overlay
    101 
    102 #endif // OVERLAY_GENERIC_PIPE_H
    103