Dirac - A Video Codec

Created by the British Broadcasting Corporation.


frame.h

Go to the documentation of this file.
00001 /* ***** BEGIN LICENSE BLOCK *****
00002 *
00003 * $Id: frame.h,v 1.13 2007/09/03 11:30:29 asuraparaju Exp $ $Name: Dirac_0_9_0 $
00004 *
00005 * Version: MPL 1.1/GPL 2.0/LGPL 2.1
00006 *
00007 * The contents of this file are subject to the Mozilla Public License
00008 * Version 1.1 (the "License"); you may not use this file except in compliance
00009 * with the License. You may obtain a copy of the License at
00010 * http://www.mozilla.org/MPL/
00011 *
00012 * Software distributed under the License is distributed on an "AS IS" basis,
00013 * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for
00014 * the specific language governing rights and limitations under the License.
00015 *
00016 * The Original Code is BBC Research and Development code.
00017 *
00018 * The Initial Developer of the Original Code is the British Broadcasting
00019 * Corporation.
00020 * Portions created by the Initial Developer are Copyright (C) 2004.
00021 * All Rights Reserved.
00022 *
00023 * Contributor(s): Thomas Davies (Original Author)
00024 *
00025 * Alternatively, the contents of this file may be used under the terms of
00026 * the GNU General Public License Version 2 (the "GPL"), or the GNU Lesser
00027 * Public License Version 2.1 (the "LGPL"), in which case the provisions of
00028 * the GPL or the LGPL are applicable instead of those above. If you wish to
00029 * allow use of your version of this file only under the terms of the either
00030 * the GPL or LGPL and not to allow others to use your version of this file
00031 * under the MPL, indicate your decision by deleting the provisions above
00032 * and replace them with the notice and other provisions required by the GPL
00033 * or LGPL. If you do not delete the provisions above, a recipient may use
00034 * your version of this file under the terms of any one of the MPL, the GPL
00035 * or the LGPL.
00036 * ***** END LICENSE BLOCK ***** */
00037 
00038 #ifndef _FRAME_H_
00039 #define _FRAME_H_
00040 
00041 #include <libdirac_common/common.h>
00042 
00043 namespace dirac
00044 {
00046 
00050     class Frame
00051     {
00052 
00053     public:
00054 
00056 
00059         Frame( const FrameParams& fp );
00060 
00062         Frame(const Frame& cpy);
00063 
00065         virtual ~Frame();
00066 
00068         Frame& operator=( const Frame& rhs );
00069 
00071 
00075         void CopyContents(Frame& out ) const;
00076 
00078 
00081         void Fill(ValueType val );
00082 
00083         //gets and sets
00085         FrameParams& GetFparams() const  {return m_fparams;}
00086 
00088         void SetFrameSort( const FrameSort fs ){m_fparams.SetFSort( fs ); }
00089 
00091         void SetFrameType( const FrameType ftype ){m_fparams.SetFrameType( ftype ); }
00092 
00094         void SetReferenceType( const ReferenceType rtype ){m_fparams.SetReferenceType( rtype ); }
00095 
00097         void ReconfigFrame( const FrameParams &fp );
00098 
00100         PicArray& Ydata() {return *m_Y_data;}
00101 
00103         PicArray& Udata() {return *m_U_data;}
00104 
00106         PicArray& Vdata() {return *m_V_data;}
00107 
00109         const PicArray& Ydata() const {return *m_Y_data;}
00110 
00112         const PicArray& Udata() const {return *m_U_data;}
00113 
00115         const PicArray& Vdata() const {return *m_V_data;}
00116 
00118         PicArray& Data(CompSort cs);
00119 
00121         const PicArray& Data(CompSort cs) const;    
00122 
00124         PicArray& UpYdata();
00125 
00127         PicArray& UpUdata();
00128 
00130         PicArray& UpVdata();
00131 
00133         PicArray& UpData(CompSort cs);
00134 
00136         const PicArray& UpYdata() const;
00137 
00139         const PicArray& UpUdata() const;
00140 
00142         const PicArray& UpVdata() const;
00143 
00145         const PicArray& UpData(CompSort cs) const;
00146 
00148 
00151         void Clip();
00152 
00154 
00157         void ClipUpData();
00158 
00159     private:
00160         mutable FrameParams m_fparams;
00161         PicArray* m_Y_data;//the 
00162         PicArray* m_U_data;//component
00163         PicArray* m_V_data;//data
00164         mutable PicArray* m_upY_data;//upconverted data. Mutable because we
00165         mutable PicArray* m_upU_data;//create them on the fly even in const
00166         mutable PicArray* m_upV_data;//functions.
00167 
00169         void Init();
00170 
00172         void ClearData();
00173 
00175         void ClipComponent(PicArray& pic_data, CompSort cs) const;
00176 
00178         mutable bool m_redo_upYdata;
00179         mutable bool m_redo_upUdata;
00180         mutable bool m_redo_upVdata;
00181     };
00182 
00183 } // namespace dirac
00184 
00185 
00186 #endif

© 2004 British Broadcasting Corporation. Dirac code licensed under the Mozilla Public License (MPL) Version 1.1.
HTML documentation generated by Dimitri van Heesch's excellent Doxygen tool.