da/d4f/ntv2ccgrabber_8h_source.html

/* SPDX-License-Identifier: MIT */

#ifndef _NTV2CCGRABBER_H

#define _NTV2CCGRABBER_H


#include "ntv2enums.h"

#include "ntv2devicefeatures.h"

#include "ntv2devicescanner.h"

#include "ntv2democommon.h"

#include "ntv2task.h"

#include "ntv2utils.h"

#include "ntv2vpid.h"

#include "ajabase/common/types.h"

#include "ajabase/common/videotypes.h"

#include "ajabase/common/timecode.h"

#include "ajabase/common/timecodeburn.h"

#include "ajabase/common/circularbuffer.h"

#include "ajabase/system/thread.h"

#include "ajabase/system/info.h"

#include "ajabase/system/systemtime.h"

#include "ajabase/system/process.h"

#include "ntv2captiondecoder608.h"

#include "ntv2captiondecoder708.h"


typedef enum _OutputMode

{

    kOutputMode_CaptionStream,

    kOutputMode_CaptionScreen,

    kOutputMode_CaptionFileSCC,

    kOutputMode_CaptionFileMCC,

    kOutputMode_Stats,

    kOutputMode_INVALID

} OutputMode;


#define IS_VALID_OutputMode(_x_)    ((_x_) >= kOutputMode_CaptionStream  &&  (_x_) < kOutputMode_INVALID)


typedef enum _CaptionDataSrc

{

    kCaptionDataSrc_Default,    //  Best available

    kCaptionDataSrc_Line21,

    kCaptionDataSrc_608FBVanc,

    kCaptionDataSrc_708FBVanc,

    kCaptionDataSrc_608Anc,

    kCaptionDataSrc_708Anc,

    kCaptionDataSrc_INVALID

} CaptionDataSrc;


#define IS_VALID_CaptionDataSrc(_x_)    ((_x_) >= kCaptionDataSrc_Default  &&  (_x_) < kCaptionDataSrc_INVALID)


typedef struct CCGrabberConfig  :   public CaptureConfig

{

    public:

        OutputMode              fOutputMode;

        CaptionDataSrc          fCaptionSrc;

        NTV2TCIndex             fTimecodeSrc;

        NTV2Line21Channel       fCaptionChannel;

        bool                    fBurnCaptions;

        bool                    fUseVanc;


        inline explicit CCGrabberConfig (const std::string & inDeviceSpecifier  = "0")

            :   CaptureConfig       (inDeviceSpecifier),

                fOutputMode         (kOutputMode_CaptionStream),

                fCaptionSrc         (kCaptionDataSrc_Default),

                fTimecodeSrc        (NTV2_TCINDEX_INVALID),

                fCaptionChannel     (NTV2_CC608_CC1),

                fBurnCaptions       (false),

                fUseVanc            (false)

        {

            fWithAnc = true;

            fWithAudio = false;

        }

        unsigned GetNumSourceSpecs (void) const {return (NTV2_IS_VALID_CHANNEL(fInputChannel)?1:0)

                                                    +   (NTV2_IS_VALID_INPUT_SOURCE(fInputSource)?1:0);}

        AJALabelValuePairs  Get (const bool inCompact = false) const;


        static std::string  GetLegalOutputModes (void);

        static std::string  OutputModeToString (const OutputMode inMode);

        static OutputMode   StringToOutputMode (const std::string & inModeStr);

        static std::string  GetLegalCaptionDataSources (void);

        static std::string  CaptionDataSrcToString (const CaptionDataSrc inDataSrc);

        static CaptionDataSrc   StringToCaptionDataSrc (const std::string & inDataSrcStr);

} CCGrabberConfig;


std::ostream &  operator << (std::ostream & ioStrm, const CCGrabberConfig & inObj);


class NTV2CCGrabber

{

    //  Public Class Methods

    public:

        static std::string      GetLine21ChannelNames (std::string inDelimiter = ", ");


    //  Public Instance Methods

    public:

                                NTV2CCGrabber (const CCGrabberConfig & inConfigData);

        virtual                 ~NTV2CCGrabber ();


        virtual AJAStatus       Init (void);


        virtual AJAStatus       Run (void);


        virtual void            Quit (void);


        virtual void            SetCaptionDisplayChannel (const NTV2Line21Channel inNewChannel);


        virtual inline bool     IsCaptureThreadRunning (void) const     {return mCaptureThread.Active();}


        virtual inline bool     IsPlayThreadRunning (void) const        {return mPlayoutThread.Active();}


        virtual AJAStatus       StartPlayThread (void);


        virtual inline void     ToggleHUD (void)                        {mHeadUpDisplayOn = !mHeadUpDisplayOn;}


        virtual void            ToggleVANC (void);

        virtual void            SwitchOutput(void);

        virtual void            Switch608Source(void);

        virtual void            SwitchPixelFormat(void);


    //  Protected Instance Methods

    protected:

        virtual AJAStatus       SetupInputVideo (void);


        virtual AJAStatus       SetupAudio (void);


        virtual bool            RouteInputSignal (const NTV2VideoFormat inVideoFormat);


        virtual void            SetOutputStandards (const NTV2VideoFormat inVideoFormat);


        virtual AJAStatus       StartCaptureThread (void);


        virtual void            CaptureFrames (void);


        virtual NTV2VideoFormat WaitForStableInputSignal (void);


        virtual AJAStatus       SetupHostBuffers (const NTV2VideoFormat inVideoFormat);


        virtual void            ReleaseHostBuffers (void);


        virtual void            ExtractClosedCaptionData (const uint32_t inFrameCount, const NTV2VideoFormat inVideoFormat);


        virtual AJAStatus       SetupOutputVideo (const NTV2VideoFormat inVideoFormat);


        virtual void            DoCCOutput (const uint32_t inFrameNum, const CaptionData & inCCData, const NTV2VideoFormat inVideoFormat);


        virtual bool            RouteOutputSignal (const NTV2VideoFormat inVideoFormat);


        virtual void            PlayFrames (void);


        virtual void            CaptioningChanged (const NTV2Caption608ChangeInfo & inChangeInfo);


    //  Protected Class Methods

    protected:

        static void             CaptureThreadStatic (AJAThread * pThread, void * pContext);


        static void             PlayThreadStatic (AJAThread * pThread, void * pContext);


        static void             Caption608ChangedStatic (void * pInstance, const NTV2Caption608ChangeInfo & inChangeInfo);


    //  Instance Data

    private:

        CCGrabberConfig             mConfig;

        mutable AJAThread           mCaptureThread;

        CNTV2Card                   mDevice;

        NTV2DeviceID                mDeviceID;

        NTV2EveryFrameTaskMode      mSavedTaskMode;

        NTV2AudioSystem             mAudioSystem;

        NTV2VANCMode                mVancMode;

        bool                        mGlobalQuit;

        bool                        mSquares;

        std::string                 mLastOutStr;

        uint32_t                    mFirstOutFrame;

        uint32_t                    mLastOutFrame;

        ULWord                      mErrorTally;

        ULWord                      mCaptionDataTally;

        NTV2Line21Channel           m608Channel;

        NTV2Line21Mode              m608Mode;

        CNTV2CaptionDecoder608Ptr   m608Decoder;

        CNTV2CaptionDecoder708Ptr   m708DecoderAnc;

        CNTV2CaptionDecoder708Ptr   m708DecoderVanc;

        CNTV2VPID                   mVPIDInfoDS1;

        CNTV2VPID                   mVPIDInfoDS2;

        NTV2ChannelSet              mInputFrameStores;

        NTV2ChannelSet              mActiveSDIInputs;

        NTV2ChannelSet              mActiveCSCs;

        NTV2XptConnections          mInputConnections;

        NTV2FrameDataArray          mHostBuffers;

        FrameDataRingBuffer         mCircularBuffer;

        AUTOCIRCULATE_TRANSFER      mInputXferInfo;


        //  Instance data only used for caption burn-in:

        bool                        mHeadUpDisplayOn;

        NTV2Channel                 mOutputChannel;

        NTV2FrameBufferFormat       mPlayoutFBF;

        mutable AJAThread           mPlayoutThread;

        NTV2ChannelSet              mOutputFrameStores;

        NTV2XptConnections          mOutputConnections;


};  //  NTV2CCGrabber


#endif  //  _NTV2CCGRABBER_H