sdiinput.h

Go to the documentation of this file.

/*=============================================================================

  libvideo: a library for SDI video processing.

  Copyright (c) University College London (UCL). All rights reserved.

  This software is distributed WITHOUT ANY WARRANTY; without even
  the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  PURPOSE.

  See LICENSE.txt in the top level directory for details.

=============================================================================*/

#pragma once
#ifndef LIBVIDEO_SDIINPUT_H_3CD0DE9000FA4846B097E35979071A3B
#define LIBVIDEO_SDIINPUT_H_3CD0DE9000FA4846B097E35979071A3B

#include <video/device.h>
#include <video/frame.h>
#include <video/dllexport.h>
#include <string>


namespace video
{


class SDIInputImpl;
class LIBVIDEO_DLL_EXPORTS SDIInput
{
private:

protected:
    SDIInputImpl*   pimpl;


public:
    // what to do if format is interlaced
    // these are ignored if incoming video is progressive
    enum InterlacedBehaviour
    {
        // interlaced video is treated the same way as progressive
        DO_NOTHING_SPECIAL,
        // one of the fields (not specifying which one) is dropped
        DROP_ONE_FIELD,
        // both fields are captured and stacked vertically
        STACK_FIELDS,
        // for either progressive or interlaced input, alternating lines are split into two separate images.
        SPLIT_LINE_INTERLEAVED_STEREO
    };


public:
    SDIInput(SDIDevice* dev, InterlacedBehaviour interlaced = DO_NOTHING_SPECIAL, int ringbuffersize = 0);
    ~SDIInput();

private:
    // not implemented
    SDIInput(const SDIInput& copyme);
    SDIInput& operator=(const SDIInput& assignme);


public:
    int get_width() const;
    int get_height() const;


protected:
    // if true then capture() will prepare the textures, otherwise data is only in pbos
    bool  preparetextures;


public:
    int get_current_ringbuffer_slot() const;

    int get_texture_id(int streamno, int ringbufferslot = -1) const;

    FrameInfo capture();


    bool has_frame() const;


#pragma warning(push)
#pragma warning(disable: 4251)      //  class '...' needs to have dll-interface to be used by clients of class '...'

protected:
    std::string     logfilename;

#pragma warning(pop)


public:
    void set_log_filename(const std::string& fn);
    void flush_log();
};


} // namespace

#endif // LIBVIDEO_SDIINPUT_H_3CD0DE9000FA4846B097E35979071A3B