psycho-movie-rating.C

Go to the documentation of this file.

/*!@file AppPsycho/psycho-movie-rating.C Psychophysics display of movies */

// //////////////////////////////////////////////////////////////////// //
// The iLab Neuromorphic Vision C++ Toolkit - Copyright (C) 2001 by the //
// University of Southern California (USC) and the iLab at USC.         //
// See http://iLab.usc.edu for information about this project.          //
// //////////////////////////////////////////////////////////////////// //
// Major portions of the iLab Neuromorphic Vision Toolkit are protected //
// under the U.S. patent ``Computation of Intrinsic Perceptual Saliency //
// in Visual Environments, and Applications'' by Christof Koch and      //
// Laurent Itti, California Institute of Technology, 2001 (patent       //
// pending; application number 09/912,225 filed July 23, 2001; see      //
// http://pair.uspto.gov/cgi-bin/final/home.pl for current status).     //
// //////////////////////////////////////////////////////////////////// //
// This file is part of the iLab Neuromorphic Vision C++ Toolkit.       //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit 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.     //
//                                                                      //
// The iLab Neuromorphic Vision C++ Toolkit 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 the iLab Neuromorphic Vision C++ Toolkit; if not, write   //
// to the Free Software Foundation, Inc., 59 Temple Place, Suite 330,   //
// Boston, MA 02111-1307 USA.                                           //
// //////////////////////////////////////////////////////////////////// //
//
// Primary maintainer for this file: Laurent Itti <itti@usc.edu>
// $HeadURL: svn://isvn.usc.edu/software/invt/trunk/saliency/src/AppPsycho/psycho-movie-rating.C $
// $Id: psycho-movie-rating.C 13712 2010-07-28 21:00:40Z itti $
//

#include "Component/ModelManager.H"
#include "Image/Image.H"
#include "GUI/GUIOpts.H"
#include "Media/MrawvInputStream.H"
#include "Media/MediaOpts.H"
#include "Psycho/PsychoDisplay.H"
#include "Psycho/EyeTrackerConfigurator.H"
#include "Psycho/EyeTracker.H"
#include "Psycho/PsychoOpts.H"
#include "Component/EventLog.H"
#include "Component/ComponentOpts.H"
#include "Util/MathFunctions.H"
#include "Util/Types.H"
#include "Video/VideoFrame.H"
#include "rutz/time.h"
#include "Util/sformat.H"

#include <deque>

#define CACHELEN 350

//! Like psycho-movie, but also asks for a subjective rating of each movie

// ######################################################################
static bool cacheFrame(nub::soft_ref<MrawvInputStream>& mp,
                       std::deque<VideoFrame>& cache)
{
  const VideoFrame frame = mp->readFrame().asVideo();
  if (!frame.initialized()) return false; // end of stream

  cache.push_front(frame);
  return true;
}

// ######################################################################
static int submain(const int argc, char** argv)
{
  MYLOGVERB = LOG_INFO;  // suppress debug messages

  // Instantiate a ModelManager:
  ModelManager manager("Psycho Movie");

  // Instantiate our various ModelComponents:
  nub::soft_ref<MrawvInputStream> mp
    (new MrawvInputStream(manager, "Input Raw Video Stream",
                          "MrawvInputStream"));
  manager.addSubComponent(mp);

  nub::soft_ref<EventLog> el(new EventLog(manager));
  manager.addSubComponent(el);

  nub::soft_ref<EyeTrackerConfigurator>
    etc(new EyeTrackerConfigurator(manager));
  manager.addSubComponent(etc);

  nub::soft_ref<PsychoDisplay> d(new PsychoDisplay(manager));
  manager.addSubComponent(d);

  //manager.setOptionValString(&OPT_InputMPEGStreamPreload, "true");
  manager.setOptionValString(&OPT_EventLogFileName, "psychodata.psy");
  manager.setOptionValString(&OPT_EyeTrackerType, "None");
  manager.setOptionValString(&OPT_SDLdisplayDims, "1280x1024");

  // Parse command-line:
  if (manager.parseCommandLine(argc, argv,
                               "<movie1.mraw> ... <movieN.mraw>",
                               1, -1) == false)
    return(1);

  // hook our various babies up and do post-command-line configs:
  nub::soft_ref<EyeTracker> et = etc->getET();
  d->setEyeTracker(et);
  d->setEventLog(el);
  et->setEventLog(el);

  // EyeLink opens the screen for us, so make sure SDLdisplay is slave:
  if (etc->getModelParamString("EyeTrackerType").compare("EL") == 0)
    d->setModelParamVal("SDLslaveMode", true);

  // let's get all our ModelComponent instances started:
  manager.start();

  // let's do an eye tracker calibration:
  et->calibrate(d);

  // ok, let's get going:
  d->clearScreen();
  d->displayText("<SPACE> for random play; other key for ordered");
  int c = d->waitForKey();

  // setup array of movie indices:
  uint nbmovies = manager.numExtraArgs(); int index[nbmovies];
  for (uint i = 0; i < nbmovies; i ++) index[i] = i;
  if (c == ' ') { LINFO("Randomizing movies..."); randShuffle(index,nbmovies);}

  // main loop:
  for (uint i = 0; i < nbmovies; i ++)
    {
      // cache initial movie frames:
      d->clearScreen();
      bool streaming = true;
      LINFO("Buffering '%s'...", manager.getExtraArg(index[i]).c_str());
      mp->setFileName(manager.getExtraArg(index[i]));

      std::deque<VideoFrame> cache;
      for (uint j = 0; j < CACHELEN; j ++)
        {
          streaming = cacheFrame(mp, cache);
          if (streaming == false) break;  // all movie frames got cached!
        }
      LINFO("'%s' ready.", manager.getExtraArg(index[i]).c_str());

      // give a chance to other processes (useful on single-CPU machines):
      sleep(1); if (system("/bin/sync")) LERROR("error in sync");

      // display fixation to indicate that we are ready:
      d->displayFixation();

      // ready to go whenever the user is ready:
      d->waitForKey(); int frame = 0;
      d->waitNextRequestedVsync(false, true);
      d->pushEvent(std::string("===== Playing movie: ") +
                   manager.getExtraArg(index[i]) + " =====");

      // start the eye tracker:
      et->track(true);

      // blink the fixation:
      d->displayFixationBlink();

      // create an overlay:
      if (cache.size() == 0) LFATAL("Zero-frame movie?");
      const int ovw = cache[0].getDims().w();
      const int ovh = cache[0].getDims().h();
      d->createVideoOverlay(VIDFMT_YUV420P, ovw, ovh);
      const int ovx = (d->getWidth() - ovw) / 2;
      const int ovy = (d->getHeight() - ovh) / 2;

      // play the movie:
      rutz::time start = rutz::time::wall_clock_now();
      while(cache.size())
        {
          // let's first cache one more frame:
          if (streaming) streaming = cacheFrame(mp, cache);

          // get next frame to display and put it into our overlay:
          VideoFrame vidframe = cache.back();
          d->displayVideoOverlay_pos(vidframe, frame,
                                     SDLdisplay::NEXT_VSYNC,
                                     ovx, ovy, ovw, ovh);
          cache.pop_back();

          ++frame;
        }
      rutz::time stop = rutz::time::wall_clock_now();
      const double secs = (stop-start).sec();
      LINFO("%d frames in %.02f sec (~%.02f fps)", frame, secs, frame/secs);

      // destroy the overlay. Somehow, mixing overlay displays and
      // normal displays does not work. With a single overlay created
      // before this loop and never destroyed, the first movie plays
      // ok but the other ones don't show up:
      d->destroyYUVoverlay();
      d->clearScreen();  // sometimes 2 clearScreen() are necessary

      // stop the eye tracker:
      usleep(50000);
      et->track(false);

      // collect subjective rating data (it will be in the psycho log):
      d->displayText("Please score this movie (1=bad .. 5=excellent)");
      do { c = d->waitForKey(); } while (c < '1' || c > '5');
      d->pushEvent(sformat("== Rating for %s = %d ==",
                           manager.getExtraArg(index[i]).c_str(), c - '0'));

      // let's do a quickie eye tracker recalibration:
      et->recalibrate(d);
    }

  d->clearScreen();
  d->displayText("Experiment complete. Thank you!");
  d->waitForKey();

  // stop all our ModelComponents
  manager.stop();

  // all done!
  return 0;
}

// ######################################################################
extern "C" int main(const int argc, char** argv)
{
  // simple wrapper around submain() to catch exceptions (because we
  // want to allow PsychoDisplay to shut down cleanly; otherwise if we
  // abort while SDL is in fullscreen mode, the X server won't return
  // to its original resolution)
  try
    {
      return submain(argc, argv);
    }
  catch (...)
    {
      REPORT_CURRENT_EXCEPTION;
    }

  return 1;
}

// ######################################################################
/* So things look consistent in everyone's emacs... */
/* Local Variables: */
/* indent-tabs-mode: nil */
/* End: */