1 /* ***** BEGIN LICENSE BLOCK *****
2 *
3 * $Id: comp_compress.h,v 1.19 2008/05/07 05:47:00 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), Scott R Ladd
24 *                 Andrew Kennedy
25 *
26 * Alternatively, the contents of this file may be used under the terms of
27 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
28 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
29 * the GPL or the LGPL are applicable instead of those above. If you wish to
30 * allow use of your version of this file only under the terms of the either
31 * the GPL or LGPL and not to allow others to use your version of this file
32 * under the MPL, indicate your decision by deleting the provisions above
33 * and replace them with the notice and other provisions required by the GPL
34 * or LGPL. If you do not delete the provisions above, a recipient may use
35 * your version of this file under the terms of any one of the MPL, the GPL
36 * or the LGPL.
37 * ***** END LICENSE BLOCK ***** */
38 
39 
40 #ifndef _COMP_COMPRESS_H_
41 #define _COMP_COMPRESS_H_
42 
43 #include <libdirac_common/arrays.h>
44 #include <libdirac_common/wavelet_utils.h>
45 #include <libdirac_common/common.h>
46 #include <libdirac_byteio/component_byteio.h>
47 
48 namespace dirac
49 {
50     class MEData;
51 
52     //! Compress a picture component
53     /*!
54         This class compresses one of the three components (Y, U, or V) of a
55         picture according to a given set or parameters. CompCompressor is used
56         by PictureCompressor.
57     */
58     class CompCompressor
59     {
60     public:
61         //! Constructor
62         /*!
63             Create and initialize a component compressor with the given
64             characteristics.
65             \param  encp    encoding parameters
66             \param  fp      picture parameters
67         */
68         CompCompressor( EncoderParams & encp, const PictureParams& fp);
69 
70         //! Compress a picture component
71         /*!
72             Compress a PicArray containing a picture component (Y, U, or V).
73             \param  coeff_data      the component data to be compressed
74             \param  bands           Subbands list
75             \param  csort           Chroma format
76             \param  estimated_bits  the list of estimated number of bits in each subband
77             \return Picture-component in Dirac-bytestream format
78         */
79         ComponentByteIO* Compress( CoeffArray& coeff_data ,
80                                  SubbandList& bands,
81                                  CompSort csort,
82                                  const OneDArray<unsigned int>& estimated_bits);
83 
84     private:
85         //! Copy constructor is private and body-less. This class should not be copied.
86         CompCompressor(const CompCompressor& cpy);
87 
88         //! Assignment = is private and body-less. This class should not be assigned.
89         CompCompressor& operator=(const CompCompressor& rhs);
90 
91         //! Set a subband to a constant value
92         void SetToVal(CoeffArray& coeff_data,const Subband& node,ValueType val);
93 
94 
95     private:
96 
97         // member variables
98         EncoderParams& m_encparams;
99 
100         const PictureParams& m_pparams;
101 
102         const PictureSort& m_psort;
103 
104         const ChromaFormat& m_cformat;
105 
106         float m_lambda;
107 
108     };
109 
110 } // namespace dirac
111 
112 
113 
114 #endif
115