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 INCLUDE_PROFILER
31 #define INCLUDE_PROFILER
32 
33 #include <stdio.h>
34 
35 #include <cutils/properties.h>
36 #include <log/log.h>
37 #include <utils/Singleton.h>
38 
39 #ifndef DEBUG_CALC_FPS
40 #define CALC_FPS() ((void)0)
41 #define CALC_INIT() ((void)0)
42 #else
43 #define CALC_FPS() qdutils::CalcFps::getInstance().Fps()
44 #define CALC_INIT() qdutils::CalcFps::getInstance().Init()
45 using namespace android;
46 namespace qdutils {
47 class CalcFps : public Singleton<CalcFps> {
48     public:
49     CalcFps();
50     ~CalcFps();
51 
52     void Init();
53     void Fps();
54 
55     private:
56     static const unsigned int MAX_FPS_CALC_PERIOD_IN_FRAMES = 128;
57     static const unsigned int MAX_FRAMEARRIVAL_STEPS = 50;
58     static const unsigned int MAX_DEBUG_FPS_LEVEL = 2;
59 
60     struct debug_fps_metadata_t {
61         /*fps calculation based on time or number of frames*/
62         enum DfmType {
63             DFM_FRAMES = 0,
64             DFM_TIME   = 1,
65         };
66 
67         DfmType type;
68 
69         /* indicates how much time do we wait till we calculate FPS */
70         unsigned long time_period;
71 
72         /*indicates how much time elapsed since we report fps*/
73         float time_elapsed;
74 
75         /* indicates how many frames do we wait till we calculate FPS */
76         unsigned int period;
77         /* current frame, will go upto period, and then reset */
78         unsigned int curr_frame;
79         /* frame will arrive at a multiple of 16666 us at the display.
80            This indicates how many steps to consider for our calculations.
81            For example, if framearrival_steps = 10, then the frame that arrived
82            after 166660 us or more will be ignored.
83            */
84         unsigned int framearrival_steps;
85         /* ignorethresh_us = framearrival_steps * 16666 */
86         nsecs_t      ignorethresh_us;
87         /* used to calculate the actual frame arrival step, the times might not be
88            accurate
89            */
90         unsigned int margin_us;
91 
92         /* actual data storage */
93         nsecs_t      framearrivals[MAX_FPS_CALC_PERIOD_IN_FRAMES];
94         nsecs_t      accum_framearrivals[MAX_FRAMEARRIVAL_STEPS];
95     };
96 
97     private:
98     void populate_debug_fps_metadata(void);
99     void print_fps(float fps);
100     void calc_fps(nsecs_t currtime_us);
101 
102     private:
103     debug_fps_metadata_t debug_fps_metadata;
104     unsigned int debug_fps_level;
105 };
106 };//namespace qdutils
107 #endif
108 
109 #endif // INCLUDE_PROFILER
110