xref: /utopia/UTPA2-700.0.x/modules/mfe/drv/mfe_ex/cModel/mfe_h263_rc.h (revision 53ee8cc121a030b8d368113ac3e966b4705770ef)
1 //<MStar Software>
2 //******************************************************************************
3 // MStar Software
4 // Copyright (c) 2010 - 2012 MStar Semiconductor, Inc. All rights reserved.
5 // All software, firmware and related documentation herein ("MStar Software") are
6 // intellectual property of MStar Semiconductor, Inc. ("MStar") and protected by
7 // law, including, but not limited to, copyright law and international treaties.
8 // Any use, modification, reproduction, retransmission, or republication of all
9 // or part of MStar Software is expressly prohibited, unless prior written
10 // permission has been granted by MStar.
11 //
12 // By accessing, browsing and/or using MStar Software, you acknowledge that you
13 // have read, understood, and agree, to be bound by below terms ("Terms") and to
14 // comply with all applicable laws and regulations:
15 //
16 // 1. MStar shall retain any and all right, ownership and interest to MStar
17 //    Software and any modification/derivatives thereof.
18 //    No right, ownership, or interest to MStar Software and any
19 //    modification/derivatives thereof is transferred to you under Terms.
20 //
21 // 2. You understand that MStar Software might include, incorporate or be
22 //    supplied together with third party`s software and the use of MStar
23 //    Software may require additional licenses from third parties.
24 //    Therefore, you hereby agree it is your sole responsibility to separately
25 //    obtain any and all third party right and license necessary for your use of
26 //    such third party`s software.
27 //
28 // 3. MStar Software and any modification/derivatives thereof shall be deemed as
29 //    MStar`s confidential information and you agree to keep MStar`s
30 //    confidential information in strictest confidence and not disclose to any
31 //    third party.
32 //
33 // 4. MStar Software is provided on an "AS IS" basis without warranties of any
34 //    kind. Any warranties are hereby expressly disclaimed by MStar, including
35 //    without limitation, any warranties of merchantability, non-infringement of
36 //    intellectual property rights, fitness for a particular purpose, error free
37 //    and in conformity with any international standard.  You agree to waive any
38 //    claim against MStar for any loss, damage, cost or expense that you may
39 //    incur related to your use of MStar Software.
40 //    In no event shall MStar be liable for any direct, indirect, incidental or
41 //    consequential damages, including without limitation, lost of profit or
42 //    revenues, lost or damage of data, and unauthorized system use.
43 //    You agree that this Section 4 shall still apply without being affected
44 //    even if MStar Software has been modified by MStar in accordance with your
45 //    request or instruction for your use, except otherwise agreed by both
46 //    parties in writing.
47 //
48 // 5. If requested, MStar may from time to time provide technical supports or
49 //    services in relation with MStar Software to you for your use of
50 //    MStar Software in conjunction with your or your customer`s product
51 //    ("Services").
52 //    You understand and agree that, except otherwise agreed by both parties in
53 //    writing, Services are provided on an "AS IS" basis and the warranty
54 //    disclaimer set forth in Section 4 above shall apply.
55 //
56 // 6. Nothing contained herein shall be construed as by implication, estoppels
57 //    or otherwise:
58 //    (a) conferring any license or right to use MStar name, trademark, service
59 //        mark, symbol or any other identification;
60 //    (b) obligating MStar or any of its affiliates to furnish any person,
61 //        including without limitation, you and your customers, any assistance
62 //        of any kind whatsoever, or any information; or
63 //    (c) conferring any license or right under any intellectual property right.
64 //
65 // 7. These terms shall be governed by and construed in accordance with the laws
66 //    of Taiwan, R.O.C., excluding its conflict of law rules.
67 //    Any and all dispute arising out hereof or related hereto shall be finally
68 //    settled by arbitration referred to the Chinese Arbitration Association,
69 //    Taipei in accordance with the ROC Arbitration Law and the Arbitration
70 //    Rules of the Association by three (3) arbitrators appointed in accordance
71 //    with the said Rules.
72 //    The place of arbitration shall be in Taipei, Taiwan and the language shall
73 //    be English.
74 //    The arbitration award shall be final and binding to both parties.
75 //
76 //******************************************************************************
77 //<MStar Software>
78 #ifndef _MFE_RATECTRL_H_
79 #define _MFE_RATECTRL_H_
80 
81 //#define CHECK_1SEC_BITRATE
82 
83 #include "mfe_type.h"
84 #include "msRateCtrl.h"
85 #define MAX_FRAMERATE   30UL
86 
87 #define SPEC_MAX_QP (31UL)
88 #define SPEC_MIN_QP (1UL)
89 /* Input for rate control */
90 typedef struct {
91     MS_S32 nWidth, nHeight;
92     MS_FLOAT fTargetFrameRate, fMinFrameRate;
93     MS_S32 m_nBitrate;
94     MS_S32 nPCount;    // Number of P-frames betweeen I-frames
95     RC_GRANULARITY rcGranularity;
96     RC_METHOD rcMethod;
97 } H263RCInfo;
98 
99 typedef struct RateCtrl {
100     /* Input parameters */
101 
102     MS_S32 m_nWidth, m_nHeight;
103     MS_FLOAT m_fTargetFrameRate, m_fMinFrameRate;
104     MS_S32 m_nBitrate;
105     MS_S32 m_nPCount;
106     RC_GRANULARITY m_rcGranularity;
107     RC_METHOD m_rcMethod;
108     // Derived variables
109     MS_FLOAT m_fAvgBitsPerFrame;
110 
111     /* rate control variables */
112 
113     MS_S32 m_nFrameCount;  // How many frame coded
114     MS_S32 m_nBufFullness;  // Rate control buffer
115     MS_U64 m_nTotalBits;
116     // Last-frame status
117     MS_S32 m_nLastFrameBits, m_nLastFrameAvgQP;
118     MS_S32 m_nLastTargetBits;
119 
120     /* Bitrate usage compensation */
121     MS_S32 m_nTargetFullness;
122     MS_S32 m_nDeputyCount, m_nMinDeputyCount;
123 
124     /* Variable bitrate */
125     MS_FLOAT m_fLongTermQP;
126 
127     // Model parameters
128     MS_S32 m_nTargetBits;   // target number of bits of current frame
129     MS_S32 m_nNFrame;    // number of macroblocks in a frame
130     MS_S32 m_nWidthInMb;   // Frame width in MB
131 
132     /* Below are for STRICT_CONST_BITRATE */
133 
134     // Dynamic framerate
135     MS_U8 m_bDropFrameEnabled;  // Enabled when min-framerate < max-framerate.
136     MS_S32 m_nSkipCount;          // The historic accumulated skip-frame count in one second
137     MS_S32 m_nSkipCountMax;       // Constant: The allowable maximal dropped frame count in 1sec, depends on Min&Max framerate.
138     MS_S32 m_nContSkipCount;   // Result: The determined continuous skip-frame count.
139     // Keep track of historic skip-frame status.
140     MS_U32 m_nWinIndex;
141     MS_U32 m_nWinIndexMax;    // Constant: corresponds to 1 sec.
142     MS_U8 m_SkipFrameHistory[MAX_FRAMERATE]; // Skip-frame history: 1 is Skipped, 0 is not.
143     // Bitrate monitoring
144     // Over-usage: Skip following frame(s) to compensate immediately
145     // Shortage: Keep a lower-bound to assure low-delay in constant-bandwidth network.
146     MS_S32 m_nBitrateOverUsage;   // Accumulated bitrate over-usage.
147     // Determine how many spare bitcount of skipped frames will be transfered into next coded frame.
148     MS_S32 m_nCompensateBitrate;    // Bitrate transferred to next coded frame.
149     MS_S32 m_nCompensateFrame;     // How many skipped frame will contribute bitrate compenstaion.
150     // The maximal bitrate is set to caller-input bitrate
151     // And re-calculate internal target bitrate < m_nBitrateMax.
152     MS_S32 m_nBitrateMax;
153     // When continuous good frame, gently reducing frameerate to avoid CPU high usage.
154     MS_S32 m_nContGoodFrameCount;
155 
156 #if defined(CHECK_1SEC_BITRATE)
157     // Runtime bitrate
158     MS_S32 m_nBrHistIndex;
159     MS_S32 m_BitrateHistory[MAX_FRAMERATE];
160     // Runtime delay: Assuming constant-bandwidth channel
161     MS_S32 m_nUnsentBits;
162 #endif
163 } RateCtrl_t;
164 
165 void rc_Create(RateCtrl_t* rcctx);
166 void rc_Destroy(RateCtrl_t* rcctx);
167 // Global
168 void rc_Init(RateCtrl_t* rcctx, H263RCInfo* pRCInfo);
169 void rc_Finish(RateCtrl_t* rcctx);
170 // Each frame
171 MS_S32 rc_CheckSkippedFrame(RateCtrl_t* rcctx);
172 MS_S32 rc_InitFrame(RateCtrl_t* rcctx, MS_S8 chFrameType);    // Return the initial frame qp
173 void rc_UpdateFrame(RateCtrl_t* rcctx, const MS_S32 totalUsedBits,const MS_S32 lastAvgQP, MS_BOOL bDummyFrame);
174 
175 #endif
176