ividanalytics.h

Go to the documentation of this file.

/*
 * Copyright (c) 2006-2012, Texas Instruments Incorporated
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * *  Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * *  Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * *  Neither the name of Texas Instruments Incorporated nor the names of
 *    its contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
 * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
 * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
 * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
 * OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
 * EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 */

#ifndef ti_xdais_dm_IVIDANALYTICS_
#define ti_xdais_dm_IVIDANALYTICS_

#include <ti/xdais/ialg.h>
#include <ti/xdais/xdas.h>
#include "xdm.h"

#ifdef __cplusplus
extern "C" {
#endif


#define IVIDANALYTICS_EOK       XDM_EOK        
#define IVIDANALYTICS_EFAIL     XDM_EFAIL      
#define IVIDANALYTICS_EUNSUPPORTED XDM_EUNSUPPORTED 
/* IVIDANALYTICS-specific control commands  */

#define IVIDANALYTICS_SETRULE           XDM_CLASSCMDBASE

#define IVIDANALYTICS_CLEARRULE         XDM_CLASSCMDBASE + 1

#define IVIDANALYTICS_MAXTARGETS 128

#define IVIDANALYTICS_MAXEVENTS 128

typedef enum {
    IVIDANALYTICS_MOTIONDETECT = 0,            
    IVIDANALYTICS_OBJECTTRACKING = 1,          
    IVIDANALYTICS_USERBASE = 16                
} IVIDANALYTICS_AnalysisMask;


typedef struct IVIDANALYTICS_Grid {   /* a grid/block is put on top of a video frame. Some blocks are MD-enabled, the others are MD-disabled... */
    XDAS_Int32 blockHeight;              
    XDAS_Int32 blockWidth;               
    XDAS_Int32 numBlockHorizontal;       
    XDAS_Int32 numBlockVertical;         
    XDM1_SingleBufDesc enableMaskArray;  
} IVIDANALYTICS_Grid;

typedef enum {
    IVIDANALYTICS_OBJECTTYPE_VEHICLE = 0,      
    IVIDANALYTICS_OBJECTTYPE_HUMAN = 1,        
    IVIDANALYTICS_OBJECTTYPE_USERBASE = 256    
} IVIDANALYTICS_ObjectType;

typedef enum {
    IVIDANALYTICS_ACTIONTYPE_LOITER = 0,       
    IVIDANALYTICS_ACTIONTYPE_ENTER = 1,        
    IVIDANALYTICS_ACTIONTYPE_EXIT = 2,         
    IVIDANALYTICS_ACTIONTYPE_APPEAR = 3,       
    IVIDANALYTICS_ACTIONTYPE_DISAPPEAR = 4,    
    IVIDANALYTICS_ACTIONTYPE_CROSSL2R = 5,     
    IVIDANALYTICS_ACTIONTYPE_CROSSR2L = 6,     
    IVIDANALYTICS_ACTIONTYPE_CROSSU2D = 7,     
    IVIDANALYTICS_ACTIONTYPE_CROSSD2U = 8,     
    IVIDANALYTICS_ACTIONTYPE_USERBASE = 256    
} IVIDANALYTICS_ActionType;


typedef struct IVIDANALYTICS_Rule{
    XDAS_Int32 size;            
    XDAS_Int32 id;              
    IVIDANALYTICS_ObjectType objectType;  
    IVIDANALYTICS_ActionType actionType;  
} IVIDANALYTICS_Rule;


typedef struct IVIDANALYTICS_Obj {
    struct IVIDANALYTICS_Fxns *fxns;
} IVIDANALYTICS_Obj;


typedef struct IVIDANALYTICS_Obj  *IVIDANALYTICS_Handle;


typedef enum {
    IVIDANALYTICS_VIEWSTATE_BAD = 0,
    IVIDANALYTICS_VIEWSTATE_GOOD = 1
} IVIDANALYTICS_ViewState;


typedef struct IVIDANALYTICS_Params {
    XDAS_Int32 size;            
    XDAS_Int32 maxHeight;       
    XDAS_Int32 maxWidth;        
    XDAS_Int32 maxFrameRate;    
    XDAS_Int32 dataEndianness;  
    XDAS_Int32 inputChromaFormat;
    XDAS_Int32 maxRules;         
}IVIDANALYTICS_Params;


typedef struct IVIDANALYTICS_DynamicParams {
    XDAS_Int32 size;               
    IVIDANALYTICS_Grid *grid;      
    XDM_Date      date;            
    /* Note, we've removed height & width - no way to change size at runtime - need to recreate the alg instance */

    IVIDANALYTICS_Rule rule;    
} IVIDANALYTICS_DynamicParams;


typedef struct IVIDANALYTICS_InArgs {
    XDAS_Int32    size;            
    XDM_Date      date;            
}IVIDANALYTICS_InArgs;


typedef struct IVIDANALYTICS_Status {
    XDAS_Int32 size;            
    XDAS_Int32 extendedError;   
    XDM1_BufDesc data;          
    XDM_AlgBufInfo bufInfo;     
    XDAS_Int32 viewState;       
} IVIDANALYTICS_Status;


typedef struct IVIDANALYTICS_OutArgs {
    XDAS_Int32 size;            
    XDAS_Int32 numTargets;      
    XDM_Rect targets[IVIDANALYTICS_MAXTARGETS]; 
    XDAS_Int32 numEvents;      
    XDAS_Int32 eventId[IVIDANALYTICS_MAXEVENTS];  
    XDAS_Int32 extendedError;   
    XDM_Date      date;            
} IVIDANALYTICS_OutArgs;


typedef  IALG_Cmd IVIDANALYTICS_Cmd;


typedef struct IVIDANALYTICS_Fxns {
    IALG_Fxns   ialg;             
    XDAS_Int32 (*process)(IVIDANALYTICS_Handle handle, XDM1_BufDesc *inBufs,
        XDM1_BufDesc *outBufs, IVIDANALYTICS_InArgs *inArgs,
        IVIDANALYTICS_OutArgs *outArgs);


    XDAS_Int32   (*control)(IVIDANALYTICS_Handle handle, IVIDANALYTICS_Cmd id,
            IVIDANALYTICS_DynamicParams *params, IVIDANALYTICS_Status *status);

} IVIDANALYTICS_Fxns;


#ifdef __cplusplus
}
#endif

#endif