overlayGenPipe.h revision b166940edca6e312463461438e2aa66e9852c26a 
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 "overlayRotator.h"
35#include "overlayCtrlData.h"
36
37namespace overlay {
38
39class GenericPipe : utils::NoCopy {
40public:
41    /* ctor */
42    explicit GenericPipe(int dpy);
43    /* dtor */
44    ~GenericPipe();
45    bool init();
46    bool close();
47    /* Control APIs */
48    /* set source using whf, orient and wait flag */
49    void setSource(const utils::PipeArgs& args);
50    /* set crop a.k.a the region of interest */
51    void setCrop(const utils::Dim& d);
52    /* set orientation*/
53    void setTransform(const utils::eTransform& param);
54    /* set mdp posision using dim */
55    void setPosition(const utils::Dim& dim);
56    /* set visual param */
57    bool setVisualParams(const MetaData_t &metadata);
58    /* commit changes to the overlay "set"*/
59    bool commit();
60    /* Data APIs */
61    /* queue buffer to the overlay */
62    bool queueBuffer(int fd, uint32_t offset);
63    /* return cached startup args */
64    const utils::PipeArgs& getArgs() const;
65    /* retrieve cached crop data */
66    utils::Dim getCrop() const;
67    /* is closed */
68    bool isClosed() const;
69    /* is open */
70    bool isOpen() const;
71    /* return Ctrl fd. Used for S3D */
72    int getCtrlFd() const;
73    /* dump the state of the object */
74    void dump() const;
75    /* Return the dump in the specified buffer */
76    void getDump(char *buf, size_t len);
77
78private:
79    /* set Closed pipe */
80    bool setClosed();
81
82    int mFbNum;
83    /* Ctrl/Data aggregator */
84    CtrlData mCtrlData;
85    Rotator* mRot;
86    //Whether rotator is used for 0-rot or otherwise
87    bool mRotUsed;
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    //Whether the source is prerotated.
92    bool mPreRotated;
93    /* Pipe open or closed */
94    enum ePipeState {
95        CLOSED,
96        OPEN
97    };
98    ePipeState pipeState;
99};
100
101} //namespace overlay
102
103#endif // OVERLAY_GENERIC_PIPE_H
104