Updating Contact email
[BrunelResearch-dirac.git] / libdirac_motionest / me_subpel.h
blobecdefe88d937745a7682d41fa93e4bfe83cf1002
1 /* ***** BEGIN LICENSE BLOCK *****
3 * $Id$ $Name$
5 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
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/
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.
16 * The Original Code is BBC Research and Development code.
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.
23 * Contributor(s): Thomas Davies (Original Author)
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 ***** */
38 #ifndef _ME_SUBPEL_H_
39 #define _ME_SUBPEL_H_
41 #include <libdirac_common/common.h>
42 #include <libdirac_common/motion.h>
43 #include <libdirac_motionest/block_match.h>
44 namespace dirac
47 class EncQueue;
48 class MvData;
49 class PicArray;
51 //! The SubpelRefine class takes pixel-accurate motion vectors and refines them to 1/8-pixel accuracy
52 /*!
53 The SubpelRefine class takes pixel-accurate motion vectors and refines
54 them to 1/8-pixel accuracy. It uses references upconverted by a factor
55 of 2 in each dimension, with the remaining precision gained by doing
56 linear interpolation between values on-the-fly.
58 class SubpelRefine
60 public:
61 //! Constructor
62 /*!
63 The constructor initialises the encoder parameters.
64 \param encp the parameters used for controlling ME/MC
66 SubpelRefine(const EncoderParams& encp);
68 //! Destructor
69 ~SubpelRefine(){}
71 //! Does the actual sub-pixel refinement
72 /*!
73 Does the actual sub-pixel refinement.
74 \param my_buffer the buffer of pictures being used
75 \param pic_num the picture number on which motion estimation is being performed
77 void DoSubpel( EncQueue& my_buffer , int pic_num );
79 private:
80 //! Private, body-less copy constructor: this class should not be copied
81 SubpelRefine( const SubpelRefine& cpy );
83 //! Private, body-less assignment=: this class should not be assigned
84 SubpelRefine& operator=( const SubpelRefine& rhs );
86 //! Match a picture from its (upconverted) reference, and record the block mvs
87 void MatchPic(const PicArray& pic_data , const PicArray& refup_data , MEData& me_data ,
88 int ref_id);
90 //! Match an individual block
91 void DoBlock( const int xblock , const int yblock ,
92 BlockMatcher& my_bmatch, MEData& me_data , const int ref_id );
94 //! Get a prediction for a block MV from the neighbouring blocks
95 MVector GetPred( int xblock , int yblock , const MvArray& mvarray );
97 //member variables
99 //! Local reference to the encoder params
100 const EncoderParams& m_encparams;
102 //! A local pointer to the encoder params
103 const PicturePredParams* m_predparams;
105 //! The list of candidate vectors being tested
106 CandidateList m_cand_list;
108 //! The relative coords of the set of neighbours used to generate MV predictions
109 OneDArray<ImageCoords> m_nshift;
113 } // namespace dirac
115 #endif