|| || || || || || || ||

---

ShotDetailSidebar.h

Go to the documentation of this file.

#ifndef Impala_Visualization_GUI_ShotDetailSidebar_h
#define Impala_Visualization_GUI_ShotDetailSidebar_h

/*
 * This defines a small shot detail pane, as used in the MN6
 * GoldenDemo Investigator's Dashboard application.
 *
 * Author: Ork de Rooij
 * Code cleanup: R. van Balen
 */
#include "Core/VideoSet/SegmentationDocument.h"
#include "Core/VideoSet/Stills.h"
#include "Core/Trec/VisualQueryEngine.h"
#include "Core/Trec/ThreadSet.h"

#include "OglGui/Button.h"
#include "OglGui/Strut.h"
#include "OglGui/TextEdit.h"

#include "Visualization/GUI/KeyframeResultBar.h"

namespace Impala {
namespace Visualization {
namespace GUI {

using namespace Impala::Core::Trec;

class ShotDetailSidebarListener
{
public:
    virtual void
    QueryVisualEvent(String visname, int keyframe)
    {
    }
};


class ShotDetailSidebar : public OglGui::Window, 
                          public KeyframeResultBarListener
{
public:
    typedef Visualization::View                     View;
    typedef Core::Array::Array2dVec3UInt8           Array2dVec3UInt8;
    typedef Core::Array::Array2dScalarUInt8         Array2dScalarUInt8;
    typedef Core::VideoSet::SegmentationDocument    SegmentationDocument;
    typedef Core::VideoSet::Segmentation            Segmentation;
    typedef std::list<Thread*>                      ThreadList;

    ShotDetailSidebar(OglGui::Window *parent, int w, int h,
                      int thumbW, int thumbH, ThreadSet *threadset,
                      SegmentationDocument* segDoc) :
        OglGui::Window(parent, w, h, true)
    {
        Init(thumbW, thumbH, threadset, segDoc);
    }

    ShotDetailSidebar(OglGui::Window *parent, int x, int y, int w, int h,
                     int thumbW, int thumbH, ThreadSet *threadset,
                     SegmentationDocument* segDoc) :
        OglGui::Window(parent, x, y, w, h, true)
    {
        Init(thumbW, thumbH, threadset, segDoc);
    }

    virtual ~ShotDetailSidebar()
    {
        // RvB: 3-2-2009 OGL automatically cleans up. Now illegal here
        // RemovePreviewBars();
        if (mShotPreviewImage)
            delete mShotPreviewImage;
    }

    void Update()
    {
        UpdateCurrentShot();
    }

    void SetShowSimilarity(bool similarity)
    {
        mShowPreviewBars = similarity;
    }

    bool GetShowSimilarity()
    {
        return mShowPreviewBars;
    }

    void SetListener(ShotDetailSidebarListener *listener)
    {
        mSidebarListener = listener;
    }

    virtual void
    KeyframeSelectedEvent(String name, int selectedkeyframe)
    {
        if (!mSidebarListener) return;

        int shot = mSegDoc->CurShot();
        int keyframe = mThreadSet->GetKeyframes()->GetShotRKF(shot);
        mSidebarListener->QueryVisualEvent(name, keyframe);
    }

private:

    void Init(int thumbW, int thumbH, ThreadSet *threadset,
              SegmentationDocument* segDoc)
    {
        mThreadSet         = threadset;
        mSegDoc            = segDoc;
        mThumbWidth        = (thumbW / 4) * 3;
        mThumbHeight       = (thumbH / 4) * 3;
        mShotPreviewView   = NULL;
        mSidebarListener   = NULL;
        mShotPreviewImage  = NULL;
        mShowPreviewBars   = false;
        mPrecalcResults    = 20;

        mVisualQueryEngine = new VisualQueryEngine(mThreadSet, mPrecalcResults);

        mStills = new Core::VideoSet::Stills(segDoc->GetVideoSet(), "stills");

        int xpos, ypos, xwid, ywid;
        int labelBackColor = oglTrLIGHTGREY;

        xwid = mThumbWidth + 4;
        ywid = mThumbHeight + 4;
        xpos = (WndWidth() - xwid) / 2;
        ypos = WndHeight() - 6;
        mShotPreview = new Window(this, xpos, ypos-ywid, xwid, ywid, true);
        mShotPreview->ConnectTo(this, L2L|R2R|T2T|B2T);

        xpos = 2;
        ypos -= ywid + 6;
        xwid = WndWidth() - 4;
        ywid = 20;
        StaticText* labelStills =
            new StaticText(this, xpos, ypos-ywid, xwid, ywid, "Shot samples:");
        labelStills->ConnectTo(this, T2T|B2T);
        labelStills->SetBackground(labelBackColor);

        xpos = 2;
        ypos -= ywid + 1;
        xwid = WndWidth() - 4;
        ywid = (int)(mThumbHeight / 3.0f) + 20;
        mShotKeyframes = new Window(this, xpos, ypos-ywid, xwid, ywid, true);
        mShotKeyframes->ConnectTo(this, L2L|R2R|T2T|B2T);

        xpos = 2;
        ypos -= ywid + 8;
        xwid = WndWidth() - 4;
        ywid = 20;
        StaticText* labelDetails =
            new StaticText(this, xpos, ypos-ywid, xwid, ywid, "Information:");
        labelDetails->ConnectTo(this, T2T|B2T);
        labelDetails->SetBackground(labelBackColor);

        xpos = 2;
        ypos -= ywid + 1;
        xwid = WndWidth() - 4;
        ywid = 88;
        mShotDetailText = new OglGui::TextEdit(this, xpos, ypos-ywid, xwid,
                                               ywid, "Shot details here", 0);
        mShotDetailText->Editable(false);
        mShotDetailText->SetBackground(0);
        mShotDetailText->SetBorderType(0);
        mShotDetailText->ConnectTo(this, L2L|R2R|T2T|B2T);

        xpos = 2;
        ypos -= ywid + 1;
        xwid = WndWidth() - 4;
        ywid = 20;
        StaticText* labelSimilars =
            new StaticText(this, xpos, ypos-ywid, xwid, ywid, "Similarity:");
        labelSimilars->ConnectTo(this, T2T|B2T);
        labelSimilars->SetBackground(labelBackColor);

        xpos = 2;
        ypos -= ywid + 1;
        xwid = WndWidth() - 4;
        ywid = ypos - 4;
        mShotSimilarityPreview = new Window(this,xpos,ypos-ywid,xwid,ywid,true);
        mShotSimilarityPreview->ConnectTo(this, ALLSIDES);

        mSetFramesShown = mShotKeyframes->WndWidth() / (int)(thumbW/3.0f) + 1;
        mSetFrames = new Visualization::ImageSet(mShotKeyframes,thumbW, thumbH,
                                                 0.33, mSetFramesShown, 1);
        mSetFrames->SetMakeViewWithRect(true);
        mSetFrames->ActivateInfoBox(false);
        //mSetFrames->SetImagesListener(this, 0);
    }

    void UpdateCurrentShot()
    {
        if (mSegDoc == NULL || !mSegDoc->HasCurShot())
        {
            ILOG_WARN("UpdateCurrentShot() trying to update, " <<
                      "but no current shot found.");
            return;
        }

        int shotid = mSegDoc->CurShot();

        // steps:
        //  1. retrieve RKF, place in mShotPreview
        //  2. retrieve series of keyframes for shot, place in mShotKeyframes
        //  3. generate textual information for shot, place in mShotDetails
        //  4. retrieve forms of similarity, place in mShotSimilarityPreview

        // STEP 1
        ILOG_DEBUG("ShotDetailWindow::UpdateCurrentShot()");

        if (mShotPreviewView == NULL && mShotPreview)
        {
            OGLWND *oglWnd = mShotPreview->GetOGLWND();
            mShotPreviewView = new View(oglWnd,3,3,mThumbWidth,mThumbHeight,1.0,
                                        false,false,true,NULL);
        }

        if (mShotPreviewImage)
        {
            delete mShotPreviewImage;
            mShotPreviewImage = 0;
        }

        mShotPreviewImage = mThreadSet->GetImageByShotID(shotid);
        if (mShotPreviewImage == NULL)
        {
            ILOG_WARN("ShotDetailView::SetShot() could not retrieve RKF for " <<
                      shotid);
            mShotPreviewImage = 0;
            return;
        }
        mShotPreviewView->UpdateImage(mShotPreviewImage, "Direct");
        // STEP 2
        UpdateStills();
        // STEP 3
        UpdateDescription();
        // STEP 4
        UpdatePreviewBars();
    }

    void UpdateStills()
    {
        if (mSetFrames == NULL)
            return;

        mSetFrames->RemoveImages();

        Core::ImageSet::ImageSet* imSetStills = mSegDoc->GetImSetStills();
        if (!imSetStills)
            return;

        int shot  = mSegDoc->CurShot();
        int start = mStills->GetFirstStillShot(shot);
        int end   = start + mStills->GetNrStillsShot(shot);

        int totalstills = end - start;
        int increment   = 1;
        if (totalstills > mSetFramesShown)
            increment = totalstills / mSetFramesShown;

        ILOG_DEBUG("ShotDetailWindow::UpdateStills() with " << start <<
                   " to "<< end << " total " << totalstills << ", showing " <<
                   mSetFramesShown << " using inc " << increment);

        for (int i=start ; i<end ; i+=increment)
        {
            Array2dVec3UInt8* im = imSetStills->GetImage(i);
            mSetFrames->AddImage(im, String("Direct"), "", true);
        }
    }

    void UpdateDescription()
    {
        std::ostringstream m;

        Core::VideoSet::VideoSet*   vidSet = mSegDoc->GetVideoSet();
        Segmentation*               segm   = mSegDoc->GetSegmentation();

        int curShotId       = mSegDoc->CurShot();
        int curVideoId      = segm->GetVideoId(curShotId);
        int shotsInCurVideo = segm->GetNrShotsVideo(curVideoId);
        int start           = segm->GetStart(curShotId);
        int end             = segm->GetEnd(curShotId);

        // Ork - showing path and file crashes on my dataset -- temp removed.
        //String curVideoPath = vidSet->GetAsPath(curVideoId);

        m << "shot with ID: " << curShotId << std::endl;
        // assuming all shot id's for one video are consecutive:
        m << "is no. " << (curShotId - segm->GetFirstShotVideo(curVideoId)+1) <<
             " of " << shotsInCurVideo << " shots in the video" << std::endl;
        m << "and contains " << (end-start+1) << " frames."
        // RvB Added line below for debug purpose
        << std::endl <<"[" << vidSet->GetFile(curVideoId) << "]"
        << std::endl << std::endl;
        //m << "  frame ? of " << segm->GetNrFramesVideo(curVideoId) <<
        //     " frames in video" << std::endl;
        //m << "  shot ? of " << segm->GetNrShots() << " shots in set" <<
        //     std::endl;
        //m << "  Video " << (curVideoId + 1) << " of " << segm->GetNrVideos()<<
        //     " videos in set" << std::endl;
        //m << "file: " << vidSet->GetFile(curVideoId) << std::endl;
        //int posLastSep = curVideoPath.find_last_of("/");
        //m << "path: " << curVideoPath.substr(0, (posLastSep+1)) << std::endl;

        mShotDetailText->SetText(m.str());
    }

    void UpdatePreviewBars()
    {
        RemovePreviewBars();
        if (mShowPreviewBars)
            AddVisualPreviewBars();
    }

    void RemovePreviewBars()
    {
        std::list<KeyframeResultBar*>::iterator i;
        for (i = mPreviewBars.begin(); i != mPreviewBars.end(); i++)
            delete *i;
        mPreviewBars.clear();
    }

    void AddVisualPreviewBars()
    {
        ILOG_DEBUG("AddVisualPreviewBars()...");
        int shot     = mSegDoc->CurShot();
        int keyframe = mThreadSet->GetKeyframes()->GetShotRKF(shot);
        ILOG_DEBUG("SHOT: " << shot << " --> FRAME: " << keyframe);

        // temp fix:
        int     mThumbWidth  = 320;
        int     mThumbHeight = 240;
        double  mViewScale   = 0.6;

        ThreadList visuals = mThreadSet->GetThreadsByType(Thread::VISUAL);
        for (ThreadList::iterator i = visuals.begin(); i!=visuals.end(); i++)
        {
            ILOG_DEBUG("adding " << (*i)->GetName());
            std::list<KeyframeResult> visualresults =
                mVisualQueryEngine->QueryVisual(*i, keyframe);

            KeyframeResultBar *kfResultBar =
                new KeyframeResultBar(mShotSimilarityPreview,
                                      mShotSimilarityPreview->W()-2, 124,
                                      (*i)->GetName(), visualresults,
                                      mThreadSet->GetKeyframes(),
                                      mThreadSet->GetImageSetThumbnails(),
                                      mThumbWidth, mThumbHeight, 0.20);
            kfResultBar->SetListener(this);
            kfResultBar->ConnectTo(mShotSimilarityPreview);
            mPreviewBars.push_back(kfResultBar);
        }
        mShotSimilarityPreview->RepositionViewports();
        mShotSimilarityPreview->ScaleChildren(); 
    }

    // member variables:
    int                             mThumbWidth;
    int                             mThumbHeight;
    int                             mSetFramesShown;
    int                             mPrecalcResults;
    bool                            mShowPreviewBars;

    ShotDetailSidebarListener*      mSidebarListener;

    VisualQueryEngine*              mVisualQueryEngine;
    std::list<KeyframeResultBar*>   mPreviewBars;
    Core::VideoSet::Stills*         mStills;
    SegmentationDocument*           mSegDoc;
    ThreadSet*                      mThreadSet;
    Array2dVec3UInt8*               mShotPreviewImage;

    OglGui::Window*                 mShotPreview;
    OglGui::Window*                 mShotKeyframes;
    OglGui::Window*                 mShotSimilarityPreview;
    OglGui::TextEdit*               mShotDetailText;

    Visualization::ImageSet*        mSetFrames;
    Visualization::View*            mShotPreviewView;

    ILOG_VAR_DEC;

}; // class ShotDetailSidebar

ILOG_VAR_INIT(ShotDetailSidebar, Impala.Visualization.GUI);

} // namespace GUI
} // namespace Visualization
} // namespace Impala


#endif

---