videofileset.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 VIDEOFILESET_H
#define VIDEOFILESET_H

#include "videofile.h"

namespace cavapa_gui
{
class VideoFileSet : public VideoFile
{
public:
    VideoFileSet(SourceID desired_id = UNDEFINED_SOURCE)
        : VideoFile(desired_id) {}

    FrameCapture get(FrameTime passed_time) override;

    double getBarrelCorrection() override;

    std::string getDescription() const override;

    double getFramerate() const override;

    std::vector<std::string> getFilenames() const override;

    cv::Size getResolution() const override;

    SourceType getSourceType() const override { return SourceType::VIDEOSET; }

    SourceStats getStats() override;

    bool hasNew() override
        { return index_has_changed ? true : getVideo(current_index)->hasNew(); }

    enum class OpenError {
        FILE_OPEN_FAILED,   // Opening one of the video files failed.
        INVALID_FRAMECOUNT, // A video file does not report frame count).
        OK,                 // No error.
        WRONG_FRAMERATE,    // Not all video file framerates match.
        WRONG_RESOLUTION    // Not all video file resolutions match.
    };

    bool open(const std::string& filename, bool get_first,
              FrameTime start_point) override
    {
        Q_UNUSED(get_first);
        return open({filename}, start_point) == OpenError::OK;
    }

    OpenError open(const std::vector<std::string>& paths,
                   FrameTime start_point);

    void play() override;

    bool skipFrame(int step) override;

    void setBarrelCorrection(double amount) override;

    void stop() override;

private:
    inline unsigned int frameIndex(int i) const;

    int getFrameStart(int i) const { return videos.at(i).second; }

    std::shared_ptr<VideoFile> getVideo(unsigned int i) const
        { return videos.at(i).first; }

    bool setActivePosition(int frame);

    inline bool setActiveVideo(unsigned int new_index, FrameTime start_seek);

    unsigned int current_index = 0; // Index of the currently played video.
    bool index_has_changed = true;  // Indicates if index changed from last get.
    std::vector<std::pair<std::shared_ptr<VideoFile>, int>> videos;
};
} // namespace

#endif // VIDEOFILESET_H