overlay.h

Go to the documentation of this file.

/* ***** BEGIN LICENSE BLOCK *****
*
* $Id: overlay.h,v 1.7 2008/03/14 08:17:37 asuraparaju Exp $ $Name: Dirac_1_0_2 $
*
* Version: MPL 1.1/GPL 2.0/LGPL 2.1
*
* The contents of this file are subject to the Mozilla Public License
* Version 1.1 (the "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
* http://www.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
* the specific language governing rights and limitations under the License.
*
* The Original Code is BBC Research and Development code.
*
* The Initial Developer of the Original Code is the British Broadcasting
* Corporation.
* Portions created by the Initial Developer are Copyright (C) 2004.
* All Rights Reserved.
*
* Contributor(s): Chris Bowley (Original Author)
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
* Public License Version 2.1 (the "LGPL"), in which case the provisions of
* the GPL or the LGPL are applicable instead of those above. If you wish to
* allow use of your version of this file only under the terms of the either
* the GPL or LGPL and not to allow others to use your version of this file
* under the MPL, indicate your decision by deleting the provisions above
* and replace them with the notice and other provisions required by the GPL
* or LGPL. If you do not delete the provisions above, a recipient may use
* your version of this file under the terms of any one of the MPL, the GPL
* or the LGPL.
* ***** END LICENSE BLOCK ***** */
 
#ifndef __OVERLAY_H__
#define __OVERLAY_H__
 
 
#include <libdirac_common/common.h>
#include <libdirac_common/motion.h>
#include <libdirac_common/picture.h>
#include <util/instrumentation/libdirac_instrument/motion_colour.h>
#include <util/instrumentation/libdirac_instrument/motion_colour_arrows.h>
#include <util/instrumentation/libdirac_instrument/sad.h>
#include <util/instrumentation/libdirac_instrument/split_mode.h>
#include <util/instrumentation/libdirac_instrument/pred_mode.h>
#include <util/instrumentation/libdirac_instrument/overlay_symbols.h>
#include <util/instrumentation/libdirac_instrument/gm_inliers.h>
 
using dirac::MEData;
using dirac::OLBParams;
 
namespace dirac_instr
{
#define NO_REF -1
 
    enum OverlayOption
    {
        motion_arrows, motion_colour, motion_colour_arrows,
        gm_arrows, gm_colour, gm_colour_arrows,
        gm_diff_arrows, gm_diff_colour, gm_diff_colour_arrows,
        gm_inliers, split_mode, SAD, pred_mode
    };
 
    class OverlayParams
    {
    public:
 
        //                                                        //
        //    Assumes default constructor, copy constructor       //
        //    and assignment =                                    //
        //                                                        //
        
        OverlayOption Option() const {return m_option;}
 
        int Reference() const {return m_ref;}
 
        int Background() const {return m_bg;}
 
        int Legend() const {return m_legend;}
 
        int MvClip() const {return m_mv_clip;}
 
        int SADClip() const {return m_sad_clip;}
        
        void SetOption(OverlayOption o) {m_option=o;}
 
        void SetReference(int r) {m_ref=r;}
 
        void SetBackground(bool b) {m_bg=b;}
 
        void SetLegend(bool l) {m_legend=l;}
 
        void SetMvClip(int c) {m_mv_clip=c;}
 
        void SetSADClip(int c) {m_sad_clip=c;}
        
    private:
        OverlayOption m_option;
 
        int m_ref;
 
        bool m_bg;
 
        bool m_legend;
 
        int m_mv_clip;
 
        int m_sad_clip;
    };
 
    class Overlay
    {
    public:
        Overlay(const OverlayParams &, Picture &);
 
        ~Overlay();
 
        //                                                        //
        //    Assumes default copy constructor and assignment =   //
        //                                                        //
 
        void ProcessPicture(const MEData &, const OLBParams &);
 
        void ProcessPicture();
        
    private:
 
        /*
            Main overlay is carried out on a motion vector block by block basis
        */
        void DoOverlay(const MEData &);
 
        /*
            Difference picture formats use different chroma resolutions with
            respect to luma
        */
        void CalculateFactors(const ChromaFormat &);
 
        /*
            Pictures must have an integer number of macroblocks, more
            macroblocks may have been used during encoding and hence the picture
            must be padded now in order for the correct macroblock (and motion
            vector block) size to be calculated
        */
        void PadPicture(const MEData &);
 
        void GlobalMotionDifference(const MEData &, MvArray &);
 
        int m_mv_scale;
 
        int m_ref;
 
        const OverlayParams m_oparams;
 
        Picture & m_picture;
 
        DrawPictureMotionParams m_draw_params;
    };
 
} // namespace dirac_instr
 
#endif