source.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 SOURCE_H
#define SOURCE_H

#include <deque>
#include <mutex>
#include <thread>

#include "../common.h"

namespace cavapa_gui
{
class Source
{
public:
    virtual ~Source() {}

    DISALLOW_COPY_AND_ASSIGN(Source);

    virtual bool canRecord() const = 0;

    virtual FrameCapture get(FrameTime passed_time) = 0;

    virtual double getBarrelCorrection() = 0;

    virtual std::string getDescription() const = 0;

    virtual double getFramerate() const = 0;

    virtual SourceID getID() const final { return source_id; }

    virtual cv::Size getResolution() const = 0;

    virtual FrameTime getPosition() const = 0;

    virtual SourceType getSourceType() const { return SourceType::NOTHING; }

    virtual SourceStats getStats() = 0;

    virtual bool hasNew() = 0;

    virtual bool isOpen() const = 0;

    virtual bool isPlaying() const = 0;

    virtual void play() {}

    virtual bool record(const std::string& filename,
                        const std::string& codec = "") = 0;

    virtual void resetStats() final { statistics = EMPTY_SOURCE_STATS; }

    virtual void setBarrelCorrection(double amount) = 0;

    virtual bool setResolution(const cv::Size& new_size) = 0;

    virtual void stop() = 0;

private:
    SourceID source_id;

protected:
    Source(SourceID desired_id = UNDEFINED_SOURCE)
    {
        // Starting counter must differ from UNDEFINED_SOURCE.
        static SourceID id_counter = UNDEFINED_SOURCE + 1;

        // We will advance our ID-counter to the next available number to
        // prevent duplicating that number with our automated numbering system.
        if (desired_id != UNDEFINED_SOURCE) {
            id_counter = std::max(id_counter, desired_id+1);
            source_id = desired_id;
        } else {
            source_id = id_counter++;
        }
    }

    SourceStats statistics = EMPTY_SOURCE_STATS;
};
} // namespace

#endif // SOURCE_H