zoneminder/src/zm_event.h

//
// ZoneMinder Core Interfaces, $Date$, $Revision$
// Copyright (C) 2001-2008 Philip Coombes
// 
// 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 program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
// 

#ifndef ZM_EVENT_H
#define ZM_EVENT_H

#include <stdlib.h>
#include <string.h>
#include <unistd.h>
#include <errno.h>
#include <limits.h>
#include <time.h>
#include <sys/time.h>
#include <sys/stat.h>
#include <sys/types.h>
#include <mysql/mysql.h>

#include <set>
#include <map>

#include "zm.h"
#include "zm_image.h"
#include "zm_stream.h"

class Zone;
class Monitor;

#define MAX_PRE_ALARM_FRAMES  16 // Maximum number of prealarm frames that can be stored

//
// Class describing events, i.e. captured periods of activity.
//
class Event
{
friend class EventStream;

protected:
  static bool    initialised;
  static char    capture_file_format[PATH_MAX];
  static char    analyse_file_format[PATH_MAX];
  static char    general_file_format[PATH_MAX];

protected:
  static int    sd;

public:
  typedef std::set<std::string> StringSet;
  typedef std::map<std::string,StringSet> StringSetMap;

protected:
  typedef enum { NORMAL, BULK, ALARM } FrameType;

  struct PreAlarmData
  {
    Image *image;
    struct timeval timestamp;
    unsigned int score;
    Image *alarm_frame;
  };

  static int pre_alarm_count;
  static PreAlarmData pre_alarm_data[MAX_PRE_ALARM_FRAMES];

protected:
  unsigned int  id;
  Monitor      *monitor;
  struct timeval  start_time;
  struct timeval  end_time;
  std::string   cause;
  StringSetMap  noteSetMap;
  int        frames;
  int        alarm_frames;
  unsigned int  tot_score;
  unsigned int  max_score;
  char      path[PATH_MAX];

protected:
  int        last_db_frame;

protected:
  static void Initialise()
  {
    if ( initialised )
      return;

    snprintf( capture_file_format, sizeof(capture_file_format), "%%s/%%0%dd-capture.jpg", config.event_image_digits );
    snprintf( analyse_file_format, sizeof(analyse_file_format), "%%s/%%0%dd-analyse.jpg", config.event_image_digits );
    snprintf( general_file_format, sizeof(general_file_format), "%%s/%%0%dd-%%s", config.event_image_digits );

    initialised = true;
  }

  void createNotes( std::string &notes );

public:
  static bool OpenFrameSocket( int );
  static bool ValidateFrameSocket( int );

public:
  Event( Monitor *p_monitor, struct timeval p_start_time, const std::string &p_cause, const StringSetMap &p_noteSetMap );
  ~Event();

  int Id() const { return( id ); }
  const std::string &Cause() { return( cause ); }
  int Frames() const { return( frames ); }
  int AlarmFrames() const { return( alarm_frames ); }

  const struct timeval &StartTime() const { return( start_time ); }
  const struct timeval &EndTime() const { return( end_time ); }
  struct timeval &EndTime() { return( end_time ); }

  bool SendFrameImage( const Image *image, bool alarm_frame=false );
  bool WriteFrameImage( Image *image, struct timeval timestamp, const char *event_file, bool alarm_frame=false );

  void updateNotes( const StringSetMap &stringSetMap );

  void AddFrames( int n_frames, Image **images, struct timeval **timestamps );
  void AddFrame( Image *image, struct timeval timestamp, int score=0, Image *alarm_frame=NULL );

private:
  void AddFramesInternal( int n_frames, int start_frame, Image **images, struct timeval **timestamps );

public:
  static const char *getSubPath( struct tm *time )
  {
    static char subpath[PATH_MAX] = "";
    snprintf( subpath, sizeof(subpath), "%02d/%02d/%02d/%02d/%02d/%02d", time->tm_year-100, time->tm_mon+1, time->tm_mday, time->tm_hour, time->tm_min, time->tm_sec );
    return( subpath );
  }
  static const char *getSubPath( time_t *time )
  {
    return( Event::getSubPath( localtime( time ) ) );
  }

public:
  static int PreAlarmCount()
  {
    return( pre_alarm_count );
  }
  static void EmptyPreAlarmFrames()
  {
    if ( pre_alarm_count > 0 )
    {
      for ( int i = 0; i < MAX_PRE_ALARM_FRAMES; i++ )
      {
        delete pre_alarm_data[i].image;
        delete pre_alarm_data[i].alarm_frame;
      }
      memset( pre_alarm_data, 0, sizeof(pre_alarm_data) );
    }
    pre_alarm_count = 0;
  }
  static void AddPreAlarmFrame( Image *image, struct timeval timestamp, int score=0, Image *alarm_frame=NULL )
  {
    pre_alarm_data[pre_alarm_count].image = new Image( *image );
    pre_alarm_data[pre_alarm_count].timestamp = timestamp;
    pre_alarm_data[pre_alarm_count].score = score;
    if ( alarm_frame )
    {
      pre_alarm_data[pre_alarm_count].alarm_frame = new Image( *alarm_frame );
    }
    pre_alarm_count++;
  }
  void SavePreAlarmFrames()
  {
    for ( int i = 0; i < pre_alarm_count; i++ )
    {
      AddFrame( pre_alarm_data[i].image, pre_alarm_data[i].timestamp, pre_alarm_data[i].score, pre_alarm_data[i].alarm_frame );
    }
    EmptyPreAlarmFrames();
  }
};

class EventStream : public StreamBase
{
public:
  typedef enum { MODE_SINGLE, MODE_ALL, MODE_ALL_GAPLESS } StreamMode;

protected:
  struct FrameData {
    //unsigned long   id;
    time_t      timestamp;
    time_t      offset;
    double      delta;
    bool      in_db;
  };

  struct EventData
  {
    unsigned long   event_id;
    unsigned long   monitor_id;
    unsigned long   frame_count;
    time_t      start_time;
    double      duration;
    char      path[PATH_MAX];
    int       n_frames;
    FrameData     *frames;
  };

protected:
  static const int STREAM_PAUSE_WAIT = 250000; // Microseconds

  static const StreamMode DEFAULT_MODE = MODE_SINGLE;

protected:
  StreamMode mode;
  bool forceEventChange;

protected:
  int curr_frame_id;
  double curr_stream_time;

  EventData *event_data;

protected:
  bool loadEventData( int event_id );
  bool loadInitialEventData( int init_event_id, unsigned int init_frame_id );
  bool loadInitialEventData( int monitor_id, time_t event_time );

  void checkEventLoaded();
  void processCommand( const CmdMsg *msg );
  bool sendFrame( int delta_us );

public:
  EventStream()
  {
    mode = DEFAULT_MODE;

    forceEventChange = false;

    curr_frame_id = 0;
    curr_stream_time = 0.0;

    event_data = 0;
  }
  void setStreamStart( int init_event_id, unsigned int init_frame_id=0 )
  {
    loadInitialEventData( init_event_id, init_frame_id );
    loadMonitor( event_data->monitor_id );
  }
  void setStreamStart( int monitor_id, time_t event_time )
  {
    loadInitialEventData( monitor_id, event_time );
    loadMonitor( monitor_id );
  }
  void setStreamMode( StreamMode p_mode )
  {
    mode = p_mode;
  }
  void runStream();
};

#endif // ZM_EVENT_H