/* 
 * PROJECT: NyARToolkitCS
 * --------------------------------------------------------------------------------
 * This work is based on the original ARToolKit developed by
 *   Hirokazu Kato
 *   Mark Billinghurst
 *   HITLab, University of Washington, Seattle
 * http://www.hitl.washington.edu/artoolkit/
 *
 * The NyARToolkitCS is C# version NyARToolkit class library.
 * Copyright (C)2008 R.Iizuka
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; either version 2
 * of the License, or (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this framework; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 * 
 * For further information please contact.
 *	http://nyatla.jp/nyatoolkit/
 *	<airmail(at)ebony.plala.or.jp>
 * 
 */
using System;
using System.Collections.Generic;

using jp.nyatla.nyartoolkit.cs.core;
using jp.nyatla.nyartoolkit.cs.match;
using jp.nyatla.nyartoolkit.cs.raster;

namespace jp.nyatla.nyartoolkit.cs.detector
{
    class NyARDetectMarkerResult
    {
        public int arcode_id;
        public int direction;
        public double confidence;
        public NyARSquare ref_square;
    }
    class NyARDetectMarkerResultHolder
    {
        public NyARDetectMarkerResult[] result_array=new NyARDetectMarkerResult[1];
        /**
         * result_holderを最大i_reserve_size個の要素を格納できるように予約します。
         * @param i_reserve_size
         */
        public void reservHolder(int i_reserve_size)
        {
	        if(i_reserve_size>=result_array.Length){
	            int new_size=i_reserve_size+5;
	            result_array=new NyARDetectMarkerResult[new_size];
	            for(int i=0;i<new_size;i++){
		        result_array[i]=new NyARDetectMarkerResult();
	            }
	        }
        }
    }
    /**
     * 複数のマーカーを検出し、それぞれに最も一致するARコードを、コンストラクタで登録したARコードから
     * 探すクラスです。最大300個を認識しますが、ゴミラベルを認識したりするので100個程度が限界です。
     *
     */
    public class NyARDetectMarker{
        private const int AR_SQUARE_MAX=300;
        private bool is_continue=false;
        private NyARMatchPatt_Color_WITHOUT_PCA match_patt;
        private NyARDetectSquare square;
        private NyARSquareList square_list=new NyARSquareList(AR_SQUARE_MAX);
        private NyARCode[] codes;
        protected NyARTransMat transmat;
        private double[] marker_width;
        private int number_of_code;
        //検出結果の保存用
        private NyARColorPatt patt;
        
        private NyARDetectMarkerResultHolder result_holder=new NyARDetectMarkerResultHolder();
        
        /**
         * 複数のマーカーを検出し、最も一致するARCodeをi_codeから検索するオブジェクトを作ります。
         * @param i_param
         * カメラパラメータを指定します。
         * @param i_code
         * 検出するマーカーのARCode配列を指定します。配列要素のインデックス番号が、そのままgetARCodeIndex関数で
         * 得られるARCodeインデックスになります。
         * 例えば、要素[1]のARCodeに一致したマーカーである場合は、getARCodeIndexは1を返します。
         * 先頭からi_number_of_code個の要素には、有効な値を指定する必要があります。
         * @param i_marker_width
         * i_codeのマーカーサイズをミリメートルで指定した配列を指定します。
         * 先頭からi_number_of_code個の要素には、有効な値を指定する必要があります。
         * @param i_number_of_code
         * i_codeに含まれる、ARCodeの数を指定します。
         * @throws NyARException
         */
        public NyARDetectMarker(NyARParam i_param,NyARCode[] i_code,double[] i_marker_width,int i_number_of_code)
        {
	    //解析オブジェクトを作る
	    this.square=new NyARDetectSquare(i_param);
	    this.transmat=new NyARTransMat_O2(i_param);
	    //比較コードを保存
	    this.codes=i_code;
	    //比較コードの解像度は全部同じかな？（違うとパターンを複数種つくらないといけないから）
	    int cw=i_code[0].getWidth();
	    int ch=i_code[0].getHeight();
	    for(int i=1;i<i_number_of_code;i++){
	        if(cw!=i_code[i].getWidth() || ch!=i_code[i].getHeight()){
		    //違う解像度のが混ざっている。
		    throw new NyARException();
	        }
	    }	
	    //評価パターンのホルダを作る
	    this.patt=new NyARColorPatt_O3(cw,ch);
	    this.number_of_code=i_number_of_code;

	    this.marker_width=i_marker_width;
	    //評価器を作る。
	    this.match_patt=new NyARMatchPatt_Color_WITHOUT_PCA();	
        }
        /**
         * i_imageにマーカー検出処理を実行し、結果を記録します。
         * @param i_image
         * マーカーを検出するイメージを指定します。
         * @param i_thresh
         * 検出閾値を指定します。0～255の範囲で指定してください。
         * 通常は100～130くらいを指定します。
         * @return
         * 見つかったマーカーの数を返します。
         * マーカーが見つからない場合は0を返します。
         * @throws NyARException
         */
        public int detectMarkerLite(NyARRaster i_image,int i_thresh)
        {
	        NyARSquareList l_square_list=this.square_list;
	        //スクエアコードを探す
	        square.detectSquare(i_image, i_thresh,l_square_list);
        	
	        int number_of_square=l_square_list.getSquareNum();
	        //コードは見つかった？
	        if(number_of_square<1){
	            //ないや。おしまい。
	            return 0;
	        }
	        //保持リストのサイズを調整
	        this.result_holder.reservHolder(number_of_square);	
        	
	        //1スクエア毎に、一致するコードを決定していく
	        for(int i=0;i<number_of_square;i++)
	        {
	            NyARSquare csquare=l_square_list.getSquare(i);
	            //評価基準になるパターンをイメージから切り出す
                if (!this.patt.pickFromRaster(i_image, csquare))
                {
    	            //イメージの切り出しは失敗することもある。
    	            continue;
                }
                //パターンを評価器にセット
                if(!this.match_patt.setPatt(this.patt)){
                    //計算に失敗した。    	
                    throw new NyARException();
                }
                //コードと順番に比較していく
                int code_index=0;
                match_patt.evaluate(codes[0]);
                double confidence=match_patt.getConfidence();
                int direction=match_patt.getDirection();
                for(int i2=1;i2<this.number_of_code;i2++)
                {
                    //コードと比較する
                    match_patt.evaluate(codes[i2]);
                    double c2=match_patt.getConfidence();
                    if(confidence>c2){
                        continue;
                    }
                    //より一致するARCodeの情報を保存
                    code_index  =i2;
                    direction   =match_patt.getDirection();
                    confidence  =c2;
                }
                //i番目のパターン情報を保存する。
                NyARDetectMarkerResult result=this.result_holder.result_array[i];
                result.arcode_id =code_index;
                result.confidence=confidence;
                result.direction =direction;
                result.ref_square=csquare;
	        }
	        return number_of_square;
        }
        /**
         * i_indexのマーカーに対する変換行列を計算し、結果値をo_resultへ格納します。
         * 直前に実行したdetectMarkerLiteが成功していないと使えません。
         * @param i_index
         * マーカーのインデックス番号を指定します。
         * 直前に実行したdetectMarkerLiteの戻り値未満かつ0以上である必要があります。
         * @param o_result
         * 結果値を受け取るオブジェクトを指定してください。
         * @throws NyARException
         */
        public void getTransmationMatrix(int i_index,NyARTransMatResult o_result)
        {
	        NyARDetectMarkerResult result=this.result_holder.result_array[i_index];
	        //一番一致したマーカーの位置とかその辺を計算
	        if(is_continue){
	            transmat.transMatContinue(result.ref_square,result.direction,marker_width[result.arcode_id],o_result);
	        }else{
	            transmat.transMat(result.ref_square,result.direction,marker_width[result.arcode_id],o_result);
	        }
	        return;
        }
        /**
         * i_indexのマーカーの一致度を返します。
         * @param i_index
         * マーカーのインデックス番号を指定します。
         * 直前に実行したdetectMarkerLiteの戻り値未満かつ0以上である必要があります。
         * @return
         * マーカーの一致度を返します。0～1までの値をとります。
         * 一致度が低い場合には、誤認識の可能性が高くなります。
         * @throws NyARException
         */
        public double getConfidence(int i_index)
        {
	    return this.result_holder.result_array[i_index].confidence;
        }
        /**
         * i_indexのマーカーの方位を返します。
         * @param i_index
         * マーカーのインデックス番号を指定します。
         * 直前に実行したdetectMarkerLiteの戻り値未満かつ0以上である必要があります。
         * @return
         * 0,1,2,3の何れかを返します。
         */    
        public int getDirection(int i_index)
        {
	    return this.result_holder.result_array[i_index].direction;
        }
        /**
         * i_indexのマーカーのARCodeインデックスを返します。
         * @param i_index
         * マーカーのインデックス番号を指定します。
         * 直前に実行したdetectMarkerLiteの戻り値未満かつ0以上である必要があります。
         * @return
         */    
        public int getARCodeIndex(int i_index)
        {
	        return this.result_holder.result_array[i_index].arcode_id;
        }    
        /**
         * getTransmationMatrixの計算モードを設定します。
         * @param i_is_continue
         * TRUEなら、transMatContinueを使用します。
         * FALSEなら、transMatを使用します。
         */
        public void setContinueMode(bool i_is_continue)
        {
	        this.is_continue=i_is_continue;
        }
    	
    }
}
