ntv2ccplayer.h

Go to the documentation of this file.

/* SPDX-License-Identifier: MIT */
#ifndef _NTV2CCPLAYER_H
#define _NTV2CCPLAYER_H

#include "ntv2democommon.h"
#include "ajabase/system/thread.h"
#include "ajabase/system/info.h"
#include "ntv2captionencoder608.h"
#include "ntv2captionencoder708.h"
#include "ntv2caption608types.h"
#include <vector>
#include <map>

#define SIG_AJA_STOP    31      //  Our own user-defined "stop" signal


typedef enum _AtEndAction_
{
    AtEndAction_Quit,       
    AtEndAction_Repeat,     
    AtEndAction_Idle,       
    AtEndAction_Max
} AtEndAction;


//  Declaration for function that sets the master "quit" flag (see main.cpp).
void SignalHandler (int inSignal);


typedef struct CCGenConfig
{
    public:
        NTV2StringList      fFilesToPlay;           
        AtEndAction         fEndAction;             
        NTV2Line21Mode      fCaptionMode;           
        NTV2Line21Channel   fCaptionChannel;        
        bool                fNewLinesAreNewRows;    
        double              fCharsPerMinute;        
        NTV2Line21Attrs     fAttributes;            

        inline explicit CCGenConfig ()
            :   fFilesToPlay        (NTV2StringList()),
                fEndAction          (AtEndAction_Quit),
                fCaptionMode        (NTV2_CC608_CapModeRollUp4),
                fCaptionChannel     (NTV2_CC608_CC1),
                fNewLinesAreNewRows (false),
                fCharsPerMinute     (500),
                fAttributes         ()
        {
        }

        AJALabelValuePairs Get (void) const;
}   CCGenConfig;


typedef std::map <NTV2Line21Channel, CCGenConfig>   CaptionChanGenMap;
typedef CaptionChanGenMap::const_iterator           CaptionChanGenMapCIter;
typedef CaptionChanGenMap::iterator                 CaptionChanGenMapIter;


typedef struct CCPlayerConfig : public PlayerConfig
{
    public:
        bool                fEmitStats;             
        bool                fSuppressLine21;        
        bool                fSuppress608;           
        bool                fSuppress708;           
        bool                fSuppressTimecode;      
        uint16_t            fForceRTP;              
        std::string         fTestPatternName;       
        CaptionChanGenMap   fCapChanGenConfigs;     

        inline explicit CCPlayerConfig (const std::string & inDeviceSpecifier   = "0")
            :   PlayerConfig        (inDeviceSpecifier),
                fEmitStats          (true),
                fSuppressLine21     (false),
                fSuppress608        (false),
                fSuppress708        (false),
                fSuppressTimecode   (false),
                fForceRTP           (0),
                fTestPatternName    ("Flat Field"),
                fCapChanGenConfigs  ()
        {
        }

        AJALabelValuePairs Get (const bool inCompact = false) const;

}   CCPlayerConfig;

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



class NTV2CCPlayer
{
    //  Public Instance Methods
    public:
                                NTV2CCPlayer (const CCPlayerConfig & inConfigData);

        virtual                 ~NTV2CCPlayer (void);

        virtual AJAStatus       Init (void);

        virtual AJAStatus       Run (void);

        virtual void            Quit (const bool inQuitImmediately = false);


        virtual void            GetStatus (size_t & outMessagesQueued, size_t & outBytesQueued,
                                            size_t & outTotMsgsEnq, size_t & outTotBytesEnq,
                                            size_t & outTotMsgsDeq, size_t & outTotBytesDeq,
                                            size_t & outMaxQueDepth, size_t & outDroppedFrames) const;


    //  Protected Instance Methods
    protected:
        virtual AJAStatus       SetUpBackgroundPatternBuffer (void);        
        virtual AJAStatus       SetUpOutputVideo (void);                    
        virtual AJAStatus       RouteOutputSignal (void);                   
        virtual void            StartPlayoutThread (void);                  
        virtual void            PlayoutFrames (void);                       
        virtual void            StartCaptionGeneratorThreads (void);        

        virtual void            GenerateCaptions (const NTV2Line21Channel inCCChannel);

        virtual bool            DeviceAncExtractorIsAvailable (void);


    //  Protected Class Methods
    protected:
        static void PlayThreadStatic (AJAThread * pThread, void * pContext);

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

        TimecodeFormat NTV2FrameRate2TimecodeFormat(NTV2FrameRate inFrameRate);

        typedef std::vector<AJAThread>          AJAThreadList;
        typedef AJAThreadList::const_iterator   AJAThreadListConstIter;


    //  Private Member Data
    private:
        CCPlayerConfig              mConfig;                
        AJAThread                   mPlayThread;            
        AJAThreadList               mGeneratorThreads;      
        AUTOCIRCULATE_STATUS        mACStatus;              
        mutable CNTV2Card           mDevice;                
        NTV2TaskMode                mSavedTaskMode;         
        NTV2Standard                mVideoStandard;         
        bool                        mPlayerQuit;            
        bool                        mCaptionGeneratorQuit;  
        CNTV2CaptionEncoder608Ptr   m608Encoder;            
        CNTV2CaptionEncoder708Ptr   m708Encoder;            
        NTV2Buffer                  mVideoBuffer;           
        NTV2ChannelSet              mActiveFrameStores;     
        NTV2XptConnections          mConnections;           

};  //  NTV2CCPlayer

#endif  //  _NTV2CCPLAYER_H