metadata.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 METADATA_H
#define METADATA_H

#include <vector>

#include <QDir>
#include <QXmlStreamReader>

#include "common.h"
#include "keyvaluecollection.h"
#include "sourcesettings.h"

using cavapa::CalibrationPoint;

namespace cavapa_gui
{
struct SourceInfo
{
    SourceID id;
    
    SourceType type;
    
    SourceSettings settings;
    
    FrameTime startOffset;
    
    std::vector<std::string> recordedVideos;
    
    std::vector<CalibrationPoint> calibrationPoints;
};

class Metadata : public KeyValueCollection
{
private:
    std::map<SourceID, SourceInfo> sources;
    std::vector<std::string> ignoredKeys; //list of key names that are not saved
    //to file
    std::vector<GraphMarker> graphMarkers;

    CalibrationPoint readCalibrationPoint(QXmlStreamReader& xml);
    void readMarker(QXmlStreamReader& xml);
    void readSource(QXmlStreamReader& xml);

public:
    Metadata();

    void addSource(SourceID id, SourceType type,
                   const SourceSettings& settings, FrameTime startOffset = 0);

    void addVideo(SourceID id, const std::string& path);

    void clearSources();

    std::vector<CalibrationPoint> getCalibrationPoints(SourceID source);
    
    QDir getContainingDirectory() const;
    
    std::vector<GraphMarker> getMarkers() const;

    std::vector<SourceID> getSources() const;

    SourceSettings getSourceSettings(SourceID source) const;
    
    FrameTime getStartOffset(SourceID source) const;

    int getVideoCount() const;
    
    std::vector<std::string> getVideos(SourceID id);

    bool readFromFile(const std::string& path);

    void setCalibrationPoints(
        const std::vector<CalibrationPoint>& points);

    void setCalibrationPoints(
        SourceID id,
        const std::vector<CalibrationPoint>& points);

    void setMarkers(const std::vector<GraphMarker>& markers);

    bool writeToFile() const;
    
    bool writeToFile(const std::string& path) const;

};
} //namespace cavapa_gui

#endif // METADATA_H