userinterface.h

/****************************************************************************
 * Copyright (c) 2014, Joel Kivelä, Erkki Koskenkorva, Oskari Leppäaho,
 * Mika Lehtinen and Petri Partanen.
 * 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 the copyright holders 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 HOLDERS 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 USERINTERFACE_H
#define USERINTERFACE_H

#include <QObject>

#include "cavapa/cavapa.h"
#include "common.h"
#include "generalsettings.h"
#include "metadata.h"
#include "results.h"
#include "sourcesettings.h"

using cavapa::CalibrationPoint;

namespace cavapa_gui
{
class UserInterface
{
    friend class Controller;
private:
    virtual void addSource(SourceID source, SourceType type, FrameTime length,
                           const std::string& path) = 0;

    virtual bool askConfirmation(const std::string& question) = 0;

    virtual void calculationCanceled() = 0;

    virtual void calculationCompleted() = 0;

    virtual void calculationContinued() = 0;
    
    virtual void calculationPaused() = 0;
    
    virtual void calculationStarted() = 0;

    virtual void calculationStopped() = 0;

    virtual std::vector<std::string> getMarkerHistory() = 0;
    
    virtual void newMeasurement() = 0;

    virtual void openMeasurement() = 0;

    virtual void removeSource(SourceID source) = 0;
    
    virtual void setCalibrationPoints(
            SourceID source,
            const std::vector<CalibrationPoint>& points) = 0;

    virtual void setCanPause(bool flag) = 0;
    
    virtual void setCanSaveVideos(bool flag) = 0;

    virtual void setMarkerHistory(const std::vector<std::string>& history) = 0;
    
    virtual void setSize(int width, int height, bool fullscreen) = 0;

    virtual void setLocation(int x, int y) = 0;

    virtual void showMessage(const std::string& message,
                             ErrorLevel level) = 0;

    virtual void sourcePaused(SourceID source) = 0;

    virtual void sourcePlayStarted(SourceID source) = 0;

    virtual void startInterface() = 0;

    virtual void updateCalculation(const FrameStats& statistics) = 0;

    virtual void updateFrame(const FrameCapture& frame) = 0;

    virtual void updateGeneralSettings(const GeneralSettings& settings) = 0;

    virtual void updateMarkers(const std::vector<GraphMarker>& markers) = 0;

    virtual void updateMetadata(const Metadata& metadata) = 0;

    virtual void updateSourceSettings(SourceID source,
                                      const SourceSettings& settings) = 0;

    virtual void updateStatistics(const std::vector<FrameStats>& stats) = 0;

protected:
    /*
     * In a derived class, the following functions are supposed
     * to be declared as signals:
     */

    virtual void calculationCancelRequested() = 0;

    virtual void calculationContinueRequested() = 0;
    
    virtual void calculationPauseRequested() = 0;
    
    virtual void calculationStartRequested() = 0;

    virtual void calculationStopRequested() = 0;

    virtual void calibrationPointsReady(
        const std::vector<CalibrationPoint>& points) = 0;

    virtual void exportRequested(const ExportOptions& options) = 0;

    virtual void generalSettingsChanged(const GeneralSettings& settings) = 0;

    virtual void graphPositionSelected(FrameTime time) = 0;

    virtual void locationChanged(int x, int y) = 0;

    virtual void markersReady(const std::vector<GraphMarker>& markers) = 0;

    virtual void metadataOpened(const std::string& path) = 0;

    virtual void metadataReady(const Metadata& metadata) = 0;

    virtual void newMeasurementRequested() = 0;

    virtual void openMeasurementRequested(const std::string& path) = 0;

    virtual void redoMeasurementRequested() = 0;

    virtual void refreshRequested() = 0;

    virtual void sizeChanged(int width, int height, bool fullscreen) = 0;

    virtual void sourceAddRequested(const std::string& path) = 0;

    virtual void sourcePauseRequested(SourceID source) = 0;

    virtual void sourcePlayRequested(SourceID source) = 0;

    virtual void sourceSeekRequested(SourceID source, FrameTime position) = 0;

    virtual void sourceRemoveRequested(SourceID source) = 0;

    virtual void sourceSettingsChanged(SourceID source,
                                       const SourceSettings& settings) = 0;

    virtual void sourceStepBackward(SourceID source) = 0;

    virtual void sourceStepForward(SourceID source) = 0;

    virtual void statisticsRequested(FrameTime start,
                                     FrameTime stop, int points) = 0;

    virtual void interfaceClosed() = 0;
};
} //namespace cavapa_gui

#endif // USERINTERFACE_H