zoneminder/src/zm_eventstream.cpp

//
// ZoneMinder Event Class Implementation, $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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//

#include <fcntl.h>
#include <sys/socket.h>
#include <arpa/inet.h>
#include <sys/un.h>
#include <sys/uio.h>
#include <sys/ipc.h>
#include <sys/msg.h>
#include <getopt.h>
#include <arpa/inet.h>
#include <glob.h>
#include <cinttypes>

#include "zm.h"
#include "zm_db.h"
#include "zm_time.h"
#include "zm_mpeg.h"
#include "zm_signal.h"
#include "zm_event.h"
#include "zm_eventstream.h"
#include "zm_storage.h"
#include "zm_monitor.h"

#include "zm_sendfile.h"

bool EventStream::loadInitialEventData(int monitor_id, time_t event_time) {
  static char sql[ZM_SQL_SML_BUFSIZ];

  snprintf(sql, sizeof(sql), "SELECT `Id` FROM `Events` WHERE "
      "`MonitorId` = %d AND unix_timestamp(`EndTime`) > %ld "
      "ORDER BY `Id` ASC LIMIT 1", monitor_id, event_time);

  if ( mysql_query(&dbconn, sql) ) {
    Error("Can't run query: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  MYSQL_RES *result = mysql_store_result(&dbconn);
  if ( !result ) {
    Error("Can't use query result: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }
  MYSQL_ROW dbrow = mysql_fetch_row(result);

  if ( mysql_errno(&dbconn) ) {
    Error("Can't fetch row: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  uint64_t init_event_id = atoll(dbrow[0]);

  mysql_free_result(result);

  loadEventData(init_event_id);

  if ( event_time ) {
    curr_stream_time = event_time;
    curr_frame_id = 1; // curr_frame_id is 1-based
    if ( event_time >= event_data->start_time ) {
      Debug(2, "event time is after event start");
      for ( unsigned int i = 0; i < event_data->frame_count; i++ ) {
        //Info( "eft %d > et %d", event_data->frames[i].timestamp, event_time );
        if ( event_data->frames[i].timestamp >= event_time ) {
          curr_frame_id = i+1;
          Debug(3, "Set curr_stream_time:%.2f, curr_frame_id:%d", curr_stream_time, curr_frame_id);
          break;
        }
      } // end foreach frame
      Debug(3, "Skipping %ld frames", event_data->frame_count);
    } else {
      Warning("Requested an event time less than the start of the event. event_time %.2f < start_time %.2f",
          event_time, event_data->start_time);
    }
  } // end if have a start time
  return true;
} // bool EventStream::loadInitialEventData( int monitor_id, time_t event_time )

bool EventStream::loadInitialEventData(uint64_t init_event_id, unsigned int init_frame_id) {
  loadEventData(init_event_id);

  if ( init_frame_id ) {
    if ( init_frame_id >= event_data->frame_count ) {
      Error("Invalid frame id specified. %d > %d", init_frame_id, event_data->frame_count);
      curr_stream_time = event_data->start_time;
      curr_frame_id = 1;
    } else {
      curr_stream_time = event_data->frames[init_frame_id-1].timestamp;
      curr_frame_id = init_frame_id;
    }
  } else {
    curr_stream_time = event_data->start_time;
  }

  return true;
}

bool EventStream::loadEventData(uint64_t event_id) {
  static char sql[ZM_SQL_MED_BUFSIZ];

  snprintf(sql, sizeof(sql),
      "SELECT `MonitorId`, `StorageId`, `Frames`, unix_timestamp( `StartTime` ) AS StartTimestamp, "
      "(SELECT max(`Delta`)-min(`Delta`) FROM `Frames` WHERE `EventId`=`Events`.`Id`) AS Duration, "
      "`DefaultVideo`, `Scheme`, `SaveJPEGs`, `Orientation`+0 FROM `Events` WHERE `Id` = %" PRIu64, event_id);

  if ( mysql_query(&dbconn, sql) ) {
    Error("Can't run query: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  MYSQL_RES *result = mysql_store_result(&dbconn);
  if ( !result ) {
    Error("Can't use query result: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  if ( !mysql_num_rows(result) ) {
    Fatal("Unable to load event %d, not found in DB", event_id);
  }

  MYSQL_ROW dbrow = mysql_fetch_row(result);

  if ( mysql_errno(&dbconn) ) {
    Error("Can't fetch row: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  delete event_data;
  event_data = new EventData;
  event_data->event_id = event_id;

  event_data->monitor_id = atoi(dbrow[0]);
  event_data->storage_id = dbrow[1] ? atoi(dbrow[1]) : 0;
  event_data->frame_count = dbrow[2] == NULL ? 0 : atoi(dbrow[2]);
  event_data->start_time = atoi(dbrow[3]);
  event_data->duration = dbrow[4] ? atof(dbrow[4]) : 0.0;
  strncpy(event_data->video_file, dbrow[5], sizeof(event_data->video_file)-1);
  std::string scheme_str = std::string(dbrow[6]);
  if ( scheme_str == "Deep" ) {
    event_data->scheme = Storage::DEEP;
  } else if ( scheme_str == "Medium" ) {
    event_data->scheme = Storage::MEDIUM;
  } else {
    event_data->scheme = Storage::SHALLOW;
  }
  event_data->SaveJPEGs = dbrow[7] == NULL ? 0 : atoi(dbrow[7]);
  event_data->Orientation = (Monitor::Orientation)(dbrow[8] == NULL ? 0 : atoi(dbrow[8]));
  mysql_free_result(result);

  if ( !monitor ) {
    monitor = Monitor::Load(event_data->monitor_id, false, Monitor::QUERY);
  } else if ( monitor->Id() != event_data->monitor_id ) {
    delete monitor;
    monitor = Monitor::Load(event_data->monitor_id, false, Monitor::QUERY);
  }
  if ( !monitor ) {
    Fatal("Unable to load monitor id %d for streaming", event_data->monitor_id);
  }

  if ( !storage ) {
    storage = new Storage(event_data->storage_id);
  } else if ( storage->Id() != event_data->storage_id ) {
    delete storage;
    storage = new Storage(event_data->storage_id);
  }
  const char *storage_path = storage->Path();

  if ( event_data->scheme == Storage::DEEP ) {
    struct tm *event_time = localtime(&event_data->start_time);

    if ( storage_path[0] == '/' )
      snprintf(event_data->path, sizeof(event_data->path),
          "%s/%ld/%02d/%02d/%02d/%02d/%02d/%02d",
          storage_path, event_data->monitor_id,
          event_time->tm_year-100, event_time->tm_mon+1, event_time->tm_mday,
          event_time->tm_hour, event_time->tm_min, event_time->tm_sec);
    else
      snprintf(event_data->path, sizeof(event_data->path),
          "%s/%s/%ld/%02d/%02d/%02d/%02d/%02d/%02d",
          staticConfig.PATH_WEB.c_str(), storage_path, event_data->monitor_id,
          event_time->tm_year-100, event_time->tm_mon+1, event_time->tm_mday,
          event_time->tm_hour, event_time->tm_min, event_time->tm_sec);
  } else if ( event_data->scheme == Storage::MEDIUM ) {
    struct tm *event_time = localtime(&event_data->start_time);
    if ( storage_path[0] == '/' )
      snprintf(event_data->path, sizeof(event_data->path),
          "%s/%ld/%04d-%02d-%02d/%" PRIu64,
          storage_path, event_data->monitor_id,
          event_time->tm_year+1900, event_time->tm_mon+1, event_time->tm_mday,
          event_data->event_id);
    else
      snprintf(event_data->path, sizeof(event_data->path),
          "%s/%s/%ld/%04d-%02d-%02d/%" PRIu64,
          staticConfig.PATH_WEB.c_str(), storage_path, event_data->monitor_id,
          event_time->tm_year+1900, event_time->tm_mon+1, event_time->tm_mday, 
          event_data->event_id);

  } else {
    if ( storage_path[0] == '/' )
      snprintf(event_data->path, sizeof(event_data->path), "%s/%ld/%" PRIu64,
          storage_path, event_data->monitor_id, event_data->event_id);
    else
      snprintf(event_data->path, sizeof(event_data->path), "%s/%s/%ld/%" PRIu64, 
          staticConfig.PATH_WEB.c_str(), storage_path, event_data->monitor_id,
          event_data->event_id);
  }

  updateFrameRate((double)event_data->frame_count/event_data->duration);
  Debug(3, "fps set by frame_count(%d)/duration(%f)",
      event_data->frame_count, event_data->duration);

  snprintf(sql, sizeof(sql), "SELECT `FrameId`, unix_timestamp(`TimeStamp`), `Delta` "
      "FROM `Frames` WHERE `EventId` = %" PRIu64 " ORDER BY `FrameId` ASC", event_id);
  if ( mysql_query(&dbconn, sql) ) {
    Error("Can't run query: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  result = mysql_store_result(&dbconn);
  if ( !result ) {
    Error("Can't use query result: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  event_data->n_frames = mysql_num_rows(result);

  event_data->frames = new FrameData[event_data->frame_count];
  int last_id = 0;
  double last_timestamp = event_data->start_time;
  double last_delta = 0.0;

  while ( ( dbrow = mysql_fetch_row(result) ) ) {
    int id = atoi(dbrow[0]);
    //timestamp = atof(dbrow[1]);
    double delta = atof(dbrow[2]);
    int id_diff = id - last_id;
    double frame_delta = id_diff ? (delta-last_delta)/id_diff : (delta-last_delta);
    // Fill in data between bulk frames
    if ( id_diff > 1 ) {
      for ( int i = last_id+1; i < id; i++ ) {
        // Delta is the time since last frame, no since beginning of Event
        event_data->frames[i-1].delta = frame_delta;
        event_data->frames[i-1].timestamp = last_timestamp + ((i-last_id)*frame_delta);
        event_data->frames[i-1].offset = event_data->frames[i-1].timestamp - event_data->start_time;
        event_data->frames[i-1].in_db = false;
        Debug(3, "Frame %d timestamp:(%f), offset(%f) delta(%f), in_db(%d)",
            i,
            event_data->frames[i-1].timestamp,
            event_data->frames[i-1].offset,
            event_data->frames[i-1].delta,
            event_data->frames[i-1].in_db
            );
      }
    }
    event_data->frames[id-1].timestamp = event_data->start_time + delta;
    event_data->frames[id-1].offset = delta;
    event_data->frames[id-1].delta = frame_delta;
    event_data->frames[id-1].in_db = true;
    last_id = id;
    last_delta = delta;
    last_timestamp = event_data->frames[id-1].timestamp;
    Debug(4, "Frame %d timestamp:(%f), offset(%f) delta(%f), in_db(%d)",
        id,
        event_data->frames[id-1].timestamp,
        event_data->frames[id-1].offset,
        event_data->frames[id-1].delta,
        event_data->frames[id-1].in_db
        );
  }
  if ( mysql_errno(&dbconn) ) {
    Error("Can't fetch row: %s", mysql_error(&dbconn));
    exit(mysql_errno(&dbconn));
  }

  mysql_free_result(result);

  if ( event_data->video_file[0] || (monitor->GetOptVideoWriter() > 0) ) {
    if ( !event_data->video_file[0] ) {
      snprintf(event_data->video_file, sizeof(event_data->video_file), "%" PRIu64 "-%s", event_data->event_id, "video.mp4");
    }
    std::string filepath = std::string(event_data->path) + "/" + std::string(event_data->video_file);
    //char filepath[PATH_MAX];
    //snprintf(filepath, sizeof(filepath), "%s/%s", event_data->path, event_data->video_file);
    Debug(1, "Loading video file from %s", filepath.c_str());
    ffmpeg_input = new FFmpeg_Input();
    if ( 0 > ffmpeg_input->Open(filepath.c_str()) ) {
      Warning("Unable to open ffmpeg_input %s", filepath.c_str());
      delete ffmpeg_input;
      ffmpeg_input = NULL;
    }
  }

  if ( forceEventChange || mode == MODE_ALL_GAPLESS ) {
    if ( replay_rate > 0 )
      curr_stream_time = event_data->frames[0].timestamp;
    else
      curr_stream_time = event_data->frames[event_data->frame_count-1].timestamp;
  }
  Debug(2, "Event:%" PRIu64 ", Frames:%ld, Duration: %.2f",
      event_data->event_id, event_data->frame_count, event_data->duration);

  return true;
} // bool EventStream::loadEventData( int event_id )

void EventStream::processCommand(const CmdMsg *msg) {
  Debug(2, "Got message, type %d, msg %d", msg->msg_type, msg->msg_data[0]);
  // Check for incoming command
  switch ( (MsgCommand)msg->msg_data[0] ) {
    case CMD_PAUSE :
        Debug(1, "Got PAUSE command");

        // Set paused flag
        paused = true;
        replay_rate = ZM_RATE_BASE;
        last_frame_sent = TV_2_FLOAT(now);
        break;
    case CMD_PLAY :
        Debug(1, "Got PLAY command");
        if ( paused ) {
          paused = false;
        }

        // If we are in single event mode and at the last frame, replay the current event
        if (
            (mode == MODE_SINGLE || mode == MODE_NONE)
            &&
            ((unsigned int)curr_frame_id == event_data->frame_count)
            ) {
          Debug(1, "Was in single or no replay mode, and at last frame, so jumping to 1st frame");
          curr_frame_id = 1;
        } else {
          Debug(1, "mode is %s, current frame is %d, frame count is %d",
              (mode == MODE_SINGLE ? "single" : "not single"),
              curr_frame_id, event_data->frame_count );
        }

        replay_rate = ZM_RATE_BASE;
        break;
    case CMD_VARPLAY :
        Debug(1, "Got VARPLAY command");
        if ( paused ) {
          paused = false;
        }
        replay_rate = ntohs(((unsigned char)msg->msg_data[2]<<8)|(unsigned char)msg->msg_data[1])-32768;
        break;
    case CMD_STOP :
        Debug(1, "Got STOP command");
        paused = false;
        break;
    case CMD_FASTFWD :
        Debug(1, "Got FAST FWD command");
        if ( paused ) {
          paused = false;
        }
        // Set play rate
        switch ( replay_rate ) {
          case 2 * ZM_RATE_BASE :
            replay_rate = 5 * ZM_RATE_BASE;
            break;
          case 5 * ZM_RATE_BASE :
            replay_rate = 10 * ZM_RATE_BASE;
            break;
          case 10 * ZM_RATE_BASE :
            replay_rate = 25 * ZM_RATE_BASE;
            break;
          case 25 * ZM_RATE_BASE :
          case 50 * ZM_RATE_BASE :
            replay_rate = 50 * ZM_RATE_BASE;
            break;
          default :
            Debug(1,"Defaulting replay_rate to 2*ZM_RATE_BASE because it is %d", replay_rate);
            replay_rate = 2 * ZM_RATE_BASE;
            break;
        }
        break;
    case CMD_SLOWFWD :
        Debug(1, "Got SLOW FWD command");
        paused = true;
        replay_rate = ZM_RATE_BASE;
        step = 1;
        if ( (unsigned int)curr_frame_id < event_data->frame_count )
          curr_frame_id += 1;
        break;
    case CMD_SLOWREV :
        Debug(1, "Got SLOW REV command");
        paused = true;
        replay_rate = ZM_RATE_BASE;
        step = -1;
        curr_frame_id -= 1;
        if ( curr_frame_id < 1 ) curr_frame_id = 1;
        break;
    case CMD_FASTREV :
        Debug(1, "Got FAST REV command");
        paused = false;
        // Set play rate
        switch ( replay_rate ) {
          case -2 * ZM_RATE_BASE :
            replay_rate = -5 * ZM_RATE_BASE;
            break;
          case -5 * ZM_RATE_BASE :
            replay_rate = -10 * ZM_RATE_BASE;
            break;
          case -10 * ZM_RATE_BASE :
            replay_rate = -25 * ZM_RATE_BASE;
            break;
          case -25 * ZM_RATE_BASE :
          case -50 * ZM_RATE_BASE :
            replay_rate = -50 * ZM_RATE_BASE;
            break;
          default :
            replay_rate = -2 * ZM_RATE_BASE;
            break;
        }
        break;
    case CMD_ZOOMIN :
        x = ((unsigned char)msg->msg_data[1]<<8)|(unsigned char)msg->msg_data[2];
        y = ((unsigned char)msg->msg_data[3]<<8)|(unsigned char)msg->msg_data[4];
        Debug(1, "Got ZOOM IN command, to %d,%d", x, y);
        switch ( zoom ) {
          case 100:
            zoom = 150;
            break;
          case 150:
            zoom = 200;
            break;
          case 200:
            zoom = 300;
            break;
          case 300:
            zoom = 400;
            break;
          case 400:
          default :
            zoom = 500;
            break;
        }
        send_frame = true;
        break;
    case CMD_ZOOMOUT :
        Debug(1, "Got ZOOM OUT command");
        switch ( zoom ) {
          case 500:
            zoom = 400;
            break;
          case 400:
            zoom = 300;
            break;
          case 300:
            zoom = 200;
            break;
          case 200:
            zoom = 150;
            break;
          case 150:
          default :
            zoom = 100;
            break;
        }
        send_frame = true;
        break;
    case CMD_PAN :
        x = ((unsigned char)msg->msg_data[1]<<8)|(unsigned char)msg->msg_data[2];
        y = ((unsigned char)msg->msg_data[3]<<8)|(unsigned char)msg->msg_data[4];
        Debug(1, "Got PAN command, to %d,%d", x, y);
        break;
    case CMD_SCALE :
        scale = ((unsigned char)msg->msg_data[1]<<8)|(unsigned char)msg->msg_data[2];
        Debug(1, "Got SCALE command, to %d", scale);
        break;
    case CMD_PREV :
        Debug(1, "Got PREV command");
        if ( replay_rate >= 0 )
          curr_frame_id = 0;
        else
          curr_frame_id = event_data->frame_count+1;
        paused = false;
        forceEventChange = true;
        break;
    case CMD_NEXT :
        Debug(1, "Got NEXT command");
        if ( replay_rate >= 0 )
          curr_frame_id = event_data->frame_count+1;
        else
          curr_frame_id = 0;
        paused = false;
        forceEventChange = true;
        break;
    case CMD_SEEK :
      {
        // offset is in seconds

        int int_part = ((unsigned char)msg->msg_data[1]<<24)|((unsigned char)msg->msg_data[2]<<16)|((unsigned char)msg->msg_data[3]<<8)|(unsigned char)msg->msg_data[4];
       int dec_part =  ((unsigned char)msg->msg_data[5]<<24)|((unsigned char)msg->msg_data[6]<<16)|((unsigned char)msg->msg_data[7]<<8)|(unsigned char)msg->msg_data[8];

       double offset = (double)int_part + (double)(dec_part / (double)1000000);
        if ( offset < 0.0 ) {
          Warning("Invalid offset, not seeking");
          break;
        } 
        curr_frame_id = (int)(event_data->frame_count*offset/event_data->duration)+1;
        curr_stream_time = event_data->frames[curr_frame_id-1].timestamp;
        Debug(1, "Got SEEK command, to %f (new current frame id: %d offset %f)",
            offset, curr_frame_id, event_data->frames[curr_frame_id-1].offset);
        send_frame = true;
        break;
      }
    case CMD_QUERY :
        Debug(1, "Got QUERY command, sending STATUS");
        break;
    case CMD_QUIT :
        Info("User initiated exit - CMD_QUIT");
        break;
    default :
        // Do nothing, for now
        break;
  }
  struct {
    uint64_t event_id;
    double progress;
    int rate;
    int zoom;
    bool paused;
  } status_data;

  status_data.event_id = event_data->event_id;
  status_data.progress = event_data->frames[curr_frame_id-1].offset;
  status_data.rate = replay_rate;
  status_data.zoom = zoom;
  status_data.paused = paused;
  Debug(2, "Event:%" PRIu64 ", Paused:%d, progress:%f Rate:%d, Zoom:%d",
    status_data.event_id,
    status_data.paused,
    status_data.progress,
    status_data.rate,
    status_data.zoom
  );

  DataMsg status_msg;
  status_msg.msg_type = MSG_DATA_EVENT;
  memcpy(&status_msg.msg_data, &status_data, sizeof(status_data));
  Debug(1, "Size of msg %d", sizeof(status_data));
  if ( sendto(sd, &status_msg, sizeof(status_msg), MSG_DONTWAIT, (sockaddr *)&rem_addr, sizeof(rem_addr)) < 0 ) {
    //if ( errno != EAGAIN )
    {
      Error("Can't sendto on sd %d: %s", sd, strerror(errno));
      //exit(-1);
    }
  }
  // quit after sending a status, if this was a quit request
  if ( (MsgCommand)msg->msg_data[0] == CMD_QUIT )
    exit(0);

  updateFrameRate((double)event_data->frame_count/event_data->duration);
} // void EventStream::processCommand(const CmdMsg *msg)

bool EventStream::checkEventLoaded() {
  static char sql[ZM_SQL_SML_BUFSIZ];

  if ( curr_frame_id <= 0 ) {
    snprintf(sql, sizeof(sql),
        "SELECT `Id` FROM `Events` WHERE `MonitorId` = %ld AND `Id` < %" PRIu64 " ORDER BY `Id` DESC LIMIT 1",
        event_data->monitor_id, event_data->event_id);
  } else if ( (unsigned int)curr_frame_id > event_data->frame_count ) {
    snprintf(sql, sizeof(sql),
        "SELECT `Id` FROM `Events` WHERE `MonitorId` = %ld AND `Id` > %" PRIu64 " ORDER BY `Id` ASC LIMIT 1",
        event_data->monitor_id, event_data->event_id);
  } else {
    // No event change required
    Debug(3, "No event change required, as curr frame %d <=> event frames %d",
        curr_frame_id, event_data->frame_count);
    return false;
  }

  // Event change required.
  if ( forceEventChange || ( (mode != MODE_SINGLE) && (mode != MODE_NONE) ) ) {
    if ( mysql_query(&dbconn, sql) ) {
      Error("Can't run query: %s", mysql_error(&dbconn));
      exit(mysql_errno(&dbconn));
    }

    MYSQL_RES *result = mysql_store_result(&dbconn);
    if ( !result ) {
      Error("Can't use query result: %s", mysql_error(&dbconn));
      exit(mysql_errno(&dbconn));
    }
    MYSQL_ROW dbrow = mysql_fetch_row(result);

    if ( mysql_errno(&dbconn)) {
      Error("Can't fetch row: %s", mysql_error(&dbconn));
      exit(mysql_errno(&dbconn));
    }

    if ( dbrow ) {
      uint64_t event_id = atoll(dbrow[0]);
      Debug(1, "Loading new event %" PRIu64, event_id);

      loadEventData(event_id);

      if ( replay_rate < 0 )  // rewind
        curr_frame_id = event_data->frame_count;
      else
        curr_frame_id = 1;
      Debug(2, "New frame id = %d", curr_frame_id);
      return true;
    } else {
      Debug(2, "No next event loaded using %s. Pausing", sql);
      if ( curr_frame_id <= 0 )
        curr_frame_id = 1;
      else
        curr_frame_id = event_data->frame_count;
      paused = true;
      sendTextFrame("No more event data found");
    } // end if found a new event or not
    mysql_free_result(result);
    forceEventChange = false;
  } else {
    Debug(2, "Pausing because mode is %d", mode);
    if ( curr_frame_id <= 0 )
      curr_frame_id = 1;
    else
      curr_frame_id = event_data->frame_count;
    paused = true;
  }
  return false;
} // void EventStream::checkEventLoaded()

Image * EventStream::getImage( ) {
  static char filepath[PATH_MAX];

  snprintf(filepath, sizeof(filepath), staticConfig.capture_file_format, event_data->path, curr_frame_id);
  Debug(2, "EventStream::getImage path(%s) from %s frame(%d) ", filepath, event_data->path, curr_frame_id);
  Image *image = new Image(filepath);
  return image;
}

bool EventStream::sendFrame(int delta_us) {
  Debug(2, "Sending frame %d", curr_frame_id);

  static char filepath[PATH_MAX];
  static struct stat filestat;
  FILE *fdj = NULL;

  // This needs to be abstracted.  If we are saving jpgs, then load the capture file.
  // If we are only saving analysis frames, then send that.
  if ( event_data->SaveJPEGs & 1 ) {
    snprintf(filepath, sizeof(filepath), staticConfig.capture_file_format, event_data->path, curr_frame_id);
  } else if ( event_data->SaveJPEGs & 2 ) {
    snprintf(filepath, sizeof(filepath), staticConfig.analyse_file_format, event_data->path, curr_frame_id);
    if ( stat(filepath, &filestat) < 0 ) {
      Debug(1, "analyze file %s not found will try to stream from other", filepath);
      snprintf(filepath, sizeof(filepath), staticConfig.capture_file_format, event_data->path, curr_frame_id);
      if ( stat(filepath, &filestat) < 0 ) {
        Debug(1, "capture file %s not found either", filepath);
        filepath[0] = 0;
      }
    }

  } else if ( !ffmpeg_input ) {
    Fatal("JPEGS not saved. zms is not capable of streaming jpegs from mp4 yet");
    return false;
  }

#if HAVE_LIBAVCODEC
  if ( type == STREAM_MPEG ) {
    Image image(filepath);

    Image *send_image = prepareImage(&image);

    if ( !vid_stream ) {
      vid_stream = new VideoStream("pipe:", format, bitrate, effective_fps,
          send_image->Colours(), send_image->SubpixelOrder(), send_image->Width(), send_image->Height());
      fprintf(stdout, "Content-type: %s\r\n\r\n", vid_stream->MimeType());
      vid_stream->OpenStream();
    }
    /* double pts = */ vid_stream->EncodeFrame(send_image->Buffer(), send_image->Size(), config.mpeg_timed_frames, delta_us*1000);
  } else
#endif // HAVE_LIBAVCODEC
  {
    static unsigned char temp_img_buffer[ZM_MAX_IMAGE_SIZE];

    int img_buffer_size = 0;
    uint8_t *img_buffer = temp_img_buffer;

    bool send_raw = ((scale>=ZM_SCALE_BASE)&&(zoom==ZM_SCALE_BASE)) && filepath[0];

    fprintf(stdout, "--ZoneMinderFrame\r\n");

    if ( (type != STREAM_JPEG) || (!filepath[0]) )
      send_raw = false;

    if ( send_raw ) {
      fdj = fopen(filepath, "rb");
      if ( !fdj ) {
        Error("Can't open %s: %s", filepath, strerror(errno));
        return true; // returning false will cause us to terminate.
      }
#if HAVE_SENDFILE
      if ( fstat(fileno(fdj),&filestat) < 0 ) {
        Error("Failed getting information about file %s: %s", filepath, strerror(errno));
        return false;
      }
#else
      img_buffer_size = fread(img_buffer, 1, sizeof(temp_img_buffer), fdj);
#endif
    } else {
      Image *image = NULL;

      if ( filepath[0] ) {
Debug(1, "Loading image");
        image = new Image(filepath);
      } else if ( ffmpeg_input ) {
        // Get the frame from the mp4 input
        Debug(1,"Getting frame from ffmpeg");
        FrameData *frame_data = &event_data->frames[curr_frame_id-1];
        AVFrame *frame = ffmpeg_input->get_frame(
            ffmpeg_input->get_video_stream_id(),
            frame_data->offset);
        if ( frame ) {
          image = new Image(frame);
          //av_frame_free(&frame);
        } else {
          Error("Failed getting a frame.");
          return false;
        }

        // when stored as an mp4, we just have the rotation as a flag in the headers
        // so we need to rotate it before outputting
        if (
            (monitor->GetOptVideoWriter() == Monitor::H264PASSTHROUGH)
            and
            (event_data->Orientation != Monitor::ROTATE_0)
            ) {
          Debug(2, "Rotating image %d", event_data->Orientation);
          switch ( event_data->Orientation ) {
            case Monitor::ROTATE_0 :
              // No action required
              break;
            case Monitor::ROTATE_90 :
            case Monitor::ROTATE_180 :
            case Monitor::ROTATE_270 :
              image->Rotate((event_data->Orientation-1)*90);
              break;
            case Monitor::FLIP_HORI :
            case Monitor::FLIP_VERT :
              image->Flip(event_data->Orientation==Monitor::FLIP_HORI);
              break;
            default:
              Error("Invalid Orientation: %d", event_data->Orientation);
          }
        } else {
          Debug(2, "Not Rotating image %d", event_data->Orientation);
        } // end if have rotation
      } else {
        Error("Unable to get a frame");
        return false;
      }
      
      Image *send_image = prepareImage(image);

      switch ( type ) {
        case STREAM_JPEG :
          send_image->EncodeJpeg(img_buffer, &img_buffer_size);
          break;
        case STREAM_ZIP :
#if HAVE_ZLIB_H
          unsigned long zip_buffer_size;
          send_image->Zip(img_buffer, &zip_buffer_size);
          img_buffer_size = zip_buffer_size;
          break;
#else
          Error("zlib is required for zipped images. Falling back to raw image");
          type = STREAM_RAW;
#endif // HAVE_ZLIB_H
        case STREAM_RAW :
          img_buffer = (uint8_t*)(send_image->Buffer());
          img_buffer_size = send_image->Size();
          break;
        default:
          Fatal("Unexpected frame type %d", type);
          break;
      }
      delete image;
      image = NULL;
    } // end if send_raw or not

    switch ( type ) {
      case STREAM_JPEG :
        fputs("Content-Type: image/jpeg\r\n", stdout);
        break;
      case STREAM_RAW :
        fputs("Content-Type: image/x-rgb\r\n", stdout);
        break;
      case STREAM_ZIP :
        fputs("Content-Type: image/x-rgbz\r\n", stdout);
        break;
      default :
        Fatal("Unexpected frame type %d", type);
        break;
    }

    if ( send_raw ) {
#if HAVE_SENDFILE
      if ( 0 > fprintf(stdout, "Content-Length: %d\r\n\r\n", (int)filestat.st_size) ) {
        fclose(fdj); /* Close the file handle */
        Info("Unable to send raw frame %u: %s", curr_frame_id, strerror(errno));
        return false;
      }
      if ( zm_sendfile(fileno(stdout), fileno(fdj), 0, (int)filestat.st_size) != (int)filestat.st_size ) {
        /* sendfile() failed, use standard way instead */
        img_buffer_size = fread(img_buffer, 1, sizeof(temp_img_buffer), fdj);
        if ( fwrite(img_buffer, img_buffer_size, 1, stdout) != 1 ) {
          fclose(fdj); /* Close the file handle */
          Info("Unable to send raw frame %u: %s", curr_frame_id, strerror(errno));
          return false;
        }
      }
#else
      if ( 
          (0 > fprintf(stdout, "Content-Length: %d\r\n\r\n", img_buffer_size) )
          ||
          ( fwrite(img_buffer, img_buffer_size, 1, stdout) != 1 )
         ) {
        fclose(fdj); /* Close the file handle */
        Info("Unable to send raw frame %u: %s", curr_frame_id, strerror(errno));
        return false;
      }
#endif
      fclose(fdj); /* Close the file handle */
    } else {
      Debug(3, "Content length: %d", img_buffer_size);
      if ( 
          (0 > fprintf(stdout, "Content-Length: %d\r\n\r\n", img_buffer_size) )
          ||
          ( fwrite(img_buffer, img_buffer_size, 1, stdout) != 1 ) )  {
        Error("Unable to send stream frame: %s", strerror(errno));
        return false;
      }
    }  // end if send_raw or not

    fputs("\r\n\r\n", stdout);
    fflush(stdout);
  }  // end if stream MPEG or other
  last_frame_sent = TV_2_FLOAT(now);
  return true;
}  // bool EventStream::sendFrame( int delta_us )

void EventStream::runStream() {
  openComms();

  checkInitialised();

  if ( type == STREAM_JPEG )
    fputs("Content-Type: multipart/x-mixed-replace;boundary=ZoneMinderFrame\r\n\r\n", stdout);

  if ( !event_data ) {
    sendTextFrame("No event data found");
    exit(0);
  }

  Debug(3, "frame rate is: (%f)", (double)event_data->frame_count/event_data->duration);
  updateFrameRate((double)event_data->frame_count/event_data->duration);
  gettimeofday(&start, NULL);
  uint64_t start_usec = start.tv_sec * 1000000 + start.tv_usec;

  while ( !zm_terminate ) {
    gettimeofday(&now, NULL);

    int delta_us = 0;
    send_frame = false;

    if ( connkey ) {
      // commands may set send_frame to true
      while ( checkCommandQueue() && !zm_terminate ) {
        // The idea is to loop here processing all commands before proceeding.
      }

      // Update modified time of the socket .lock file so that we can tell which ones are stale.
      if ( now.tv_sec - last_comm_update.tv_sec > 3600 ) {
        touch(sock_path_lock);
        last_comm_update = now;
      }
    }

    // Get current frame data
    FrameData *frame_data = &event_data->frames[curr_frame_id-1];

    //Info( "cst:%.2f", curr_stream_time );
    //Info( "cfid:%d", curr_frame_id );
    //Info( "fdt:%d", frame_data->timestamp );
    if ( !paused ) {
      Debug(3, "Not paused at frame %d", curr_frame_id);

      // This next bit is to determine if we are in the current event time wise
      // and whether to show an image saying how long until the next event.
      bool in_event = true;
      double time_to_event = 0;
      if ( replay_rate > 0 ) {
        // As we are playing, curr_stream_time starts at first frame timestamp and increases so it should only be greater if event data has been loaded for the next event.
        time_to_event = event_data->frames[0].timestamp - curr_stream_time;
        if ( time_to_event > 0 )
          in_event = false;
      } else if ( replay_rate < 0 ) {
        time_to_event = curr_stream_time - event_data->frames[event_data->frame_count-1].timestamp;
        if ( time_to_event > 0 )
          in_event = false;
      }
      Debug(1, "replay rate(%d) in_event(%d) time_to_event(%f)=curr_stream_time(%f)-frame timestamp:%f",
          replay_rate, in_event, time_to_event, curr_stream_time, event_data->frames[event_data->frame_count-1].timestamp);
      if ( !in_event ) {
        double actual_delta_time = TV_2_FLOAT(now) - last_frame_sent;
        Debug(1, "Ctual delta time = %f = %f - %f", actual_delta_time , TV_2_FLOAT(now) , last_frame_sent);
        // > 1 second
        if ( actual_delta_time > 1 ) {
          Debug(1, "Sending time to next event frame");
          static char frame_text[64];
          snprintf(frame_text, sizeof(frame_text), "Time to next event = %d seconds", (int)time_to_event);
          if ( !sendTextFrame(frame_text) )
            zm_terminate = true;
        } else {
          Debug(1, "Not Sending time to next event frame because actual delta time is %f", actual_delta_time);
        }
        //else
        //{
        // FIXME ICON But we are not paused.  We are somehow still in the event?
          double sleep_time = (replay_rate>0?1:-1) * ((1.0L * replay_rate * STREAM_PAUSE_WAIT)/(ZM_RATE_BASE * 1000000));
          //double sleep_time = (replay_rate * STREAM_PAUSE_WAIT)/(ZM_RATE_BASE * 1000000);
          //// ZM_RATE_BASE == 100, and 1x replay_rate is 100
          //double sleep_time = ((replay_rate/ZM_RATE_BASE) * STREAM_PAUSE_WAIT)/1000000;
          if ( ! sleep_time ) {
            sleep_time += STREAM_PAUSE_WAIT/1000000;
          }
          curr_stream_time += sleep_time;
          Debug(2, "Sleeping (%dus) because we are not at the next event yet, adding %f", STREAM_PAUSE_WAIT, sleep_time);
          usleep(STREAM_PAUSE_WAIT);
          
          //curr_stream_time += (1.0L * replay_rate * STREAM_PAUSE_WAIT)/(ZM_RATE_BASE * 1000000);
        //}
        continue;
      } // end if !in_event

      // Figure out if we should send this frame
      Debug(3, "cur_frame_id (%d-1) mod frame_mod(%d)", curr_frame_id, frame_mod);
      // If we are streaming and this frame is due to be sent
      // frame mod defaults to 1 and if we are going faster than max_fps will get multiplied by 2
      // so if it is 2, then we send every other frame, if is it 4 then every fourth frame, etc.
      if ( (frame_mod == 1) || (((curr_frame_id-1)%frame_mod) == 0) ) {
        delta_us = (unsigned int)(frame_data->delta * 1000000);
        Debug(3, "frame delta %uus ", delta_us);
        // if effective > base we should speed up frame delivery
        delta_us = (unsigned int)((delta_us * base_fps)/effective_fps);
        Debug(3, "delta %u = base_fps(%f)/effective fps(%f)", delta_us, base_fps, effective_fps);
        // but must not exceed maxfps
        delta_us = max(delta_us, 1000000 / maxfps);
        Debug(3, "delta %u = base_fps(%f)/effective fps(%f) from 30fps", delta_us, base_fps, effective_fps);
        send_frame = true;
      }
    } else if ( step != 0 ) {
      Debug(2, "Paused with step %d", step);
      // We are paused and are just stepping forward or backward one frame
      step = 0;
      send_frame = true;
    } else if ( !send_frame ) {
      // We are paused, not stepping and doing nothing
      double actual_delta_time = TV_2_FLOAT(now) - last_frame_sent;
      if ( actual_delta_time > MAX_STREAM_DELAY ) {
        // Send keepalive
        Debug(2, "Sending keepalive frame");
        send_frame = true;
      //} else {
        //Debug(2, "Not Sending keepalive frame");
      }
    } // end if streaming stepping or doing nothing

    if ( send_frame ) {
      if ( !sendFrame(delta_us) ) {
        zm_terminate = true;
        break;
      }
    }

    curr_stream_time = frame_data->timestamp;

    if ( !paused ) {
      // +/- 1? What if we are skipping frames?
      curr_frame_id += (replay_rate>0) ? frame_mod : -1*frame_mod;
      // sending the frame may have taken some time, so reload now
      gettimeofday(&now, NULL);
      uint64_t now_usec = (now.tv_sec * 1000000 + now.tv_usec);

      // we incremented by replay_rate, so might have jumped past frame_count
      if ( (mode == MODE_SINGLE) && ((unsigned int)curr_frame_id >= event_data->frame_count) ) {
        Debug(2, "Have mode==MODE_SINGLE and at end of event, looping back to start");
        curr_frame_id = 1;
        // Have to reset start_usec to now when replaying
        start_usec = now_usec;
      }
      frame_data = &event_data->frames[curr_frame_id-1];

      // frame_data->delta is the time since last frame as a float in seconds
      // but what if we are skipping frames? We need the distance from the last frame sent
      // Also, what about reverse? needs to be absolute value

      // There are two ways to go about this, not sure which is correct.
      // you can calculate the relationship between now and the start
      // or calc the relationship from the last frame.  I think from the start is better as it self-corrects

      if ( send_frame && (type != STREAM_MPEG) ) {
        if ( delta_us > 0 ) {
          if ( delta_us > MAX_SLEEP_USEC ) {
            Debug(1, "Limiting sleep to %d because calculated sleep is too long %d", MAX_SLEEP_USEC, delta_us);
            delta_us = MAX_SLEEP_USEC;
          }
          usleep(delta_us);
          Debug(3, "Done sleeping: %d usec", delta_us);
        }
      }
    } else {
      delta_us = ((1000000 * ZM_RATE_BASE)/((base_fps?base_fps:1)*(replay_rate?abs(replay_rate*2):2)));

      Debug(2, "Sleeping %d because 1000000 * ZM_RATE_BASE(%d) / ( base_fps (%f), replay_rate(%d)",
          (unsigned long)((1000000 * ZM_RATE_BASE)/((base_fps?base_fps:1)*abs(replay_rate*2))),
          ZM_RATE_BASE,
          (base_fps?base_fps:1),
          (replay_rate?abs(replay_rate*2):0)
          );
      if ( delta_us > 0 ) {
        if ( delta_us > MAX_SLEEP_USEC ) {
          Debug(1, "Limiting sleep to %d because calculated sleep is too long %d", MAX_SLEEP_USEC, delta_us);
          delta_us = MAX_SLEEP_USEC;
        }
        usleep(delta_us);
      }
    } // end if !paused

    //if ( step != 0 )// Adding 0 is cheaper than an if 0
    // curr_frame_id starts at 1 though, so we might skip the first frame?
      curr_frame_id += step;

    // Detects when we hit end of event and will load the next event or previous event
    if ( !paused )
      checkEventLoaded();
  } // end while ! zm_terminate
#if HAVE_LIBAVCODEC
  if ( type == STREAM_MPEG )
    delete vid_stream;
#endif // HAVE_LIBAVCODEC

  closeComms();
} // void EventStream::runStream()

void EventStream::setStreamStart(
    uint64_t init_event_id,
    unsigned int init_frame_id=0) {
  loadInitialEventData(init_event_id, init_frame_id);
}  // end void EventStream::setStreamStart(init_event_id,init_frame_id=0)

void EventStream::setStreamStart(int monitor_id, time_t event_time) {
  loadInitialEventData(monitor_id, event_time);
}