1 /* ***** BEGIN LICENSE BLOCK *****
2 *
3 * $Id: quality_monitor.h,v 1.19 2008/08/14 02:30:50 asuraparaju Exp $ $Name: Dirac_1_0_2 $
4 *
5 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
6 *
7 * The contents of this file are subject to the Mozilla Public License
8 * Version 1.1 (the "License"); you may not use this file except in compliance
9 * with the License. You may obtain a copy of the License at
10 * http://www.mozilla.org/MPL/
11 *
12 * Software distributed under the License is distributed on an "AS IS" basis,
13 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
14 * the specific language governing rights and limitations under the License.
15 *
16 * The Original Code is BBC Research and Development code.
17 *
18 * The Initial Developer of the Original Code is the British Broadcasting
19 * Corporation.
20 * Portions created by the Initial Developer are Copyright (C) 2004.
21 * All Rights Reserved.
22 *
23 * Contributor(s): Thomas Davies (Original Author)
24 *
25 * Alternatively, the contents of this file may be used under the terms of
26 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
27 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
28 * the GPL or the LGPL are applicable instead of those above. If you wish to
29 * allow use of your version of this file only under the terms of the either
30 * the GPL or LGPL and not to allow others to use your version of this file
31 * under the MPL, indicate your decision by deleting the provisions above
32 * and replace them with the notice and other provisions required by the GPL
33 * or LGPL. If you do not delete the provisions above, a recipient may use
34 * your version of this file under the terms of any one of the MPL, the GPL
35 * or the LGPL.
36 * ***** END LICENSE BLOCK ***** */
37 
38 #ifndef _QUALITY_MONITOR_H_
39 #define _QUALITY_MONITOR_H_
40 
41 #include <libdirac_common/common.h>
42 #include <libdirac_encoder/enc_picture.h>
43 #include <libdirac_common/wavelet_utils.h>
44 namespace dirac
45 {
46 
47     //! Class to monitor the quality of pictures and adjust coding parameters appropriately
48     class QualityMonitor
49     {
50     public:
51 
52         //! Constructor. Sets up initial Lagrangian values
53         /*
54            Constructor sets up initial Lagrangian values.
55         */
56         QualityMonitor(EncoderParams& ep);
57 
58 
59         //! Destructor
60         ~QualityMonitor();
61 
62         ////////////////////////////////////////////////////////////
63         //                                                        //
64         //    Assumes default copy constructor,  assignment =     //
65         //                 and destructor                         //
66         ////////////////////////////////////////////////////////////
67 
68         //! Update the mse factors, returning true if we need to recode
69         /*!
70             Update the mse factors, returning true if we need to recode
71             \param enc_picture the picture being encoded
72         */
73         void UpdateModel(const EncPicture& enc_picture );
74 
75         //! Reset the quality factors (say if there's been a cut)
76         void ResetAll();
77 
78         //! Write a log of the quality to date
79         void WriteLog();
80 
81     private:
82         //functions
83 
84 
85         //! Calculate the quality of coded wrt original picture
86         double QualityVal( const PicArray& coded_data ,
87                            const PicArray& orig_data,
88                            const int xlen,
89                            const int ylen);
90 
91         //member variables//
92         ////////////////////
93 
94         //! A reference to the encoder parameters
95         EncoderParams& m_encparams;
96 
97         //! The overall average Y mse
98         long double m_totalmse_averageY;
99 
100         //! The overall average U mse
101         long double m_totalmse_averageU;
102 
103         //! The overall average V mse
104         long double m_totalmse_averageV;
105 
106         //! The total number of pictures coded
107         int m_allpicture_total;
108 
109         //! The average Y mse for the picture types
110         OneDArray<long double> m_mse_averageY;
111 
112         //! The average U mse for the picture types
113         OneDArray<long double> m_mse_averageU;
114 
115         //! The average V mse for the picture types
116         OneDArray<long double> m_mse_averageV;
117 
118         //! The number of pictures of each type
119         OneDArray<int> m_picture_total;
120     };
121 
122 } // namespace dirac
123 
124 #endif
125