ntv2serialcontrol.h

Go to the documentation of this file.

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

#include "ajaexport.h"
#include "basemachinecontrol.h"
#include "ntv2card.h"

#define NTV2_SERIAL_RESPONSE_SIZE   64


typedef struct
{
    UByte   length;
    UByte   buffer [NTV2_SERIAL_RESPONSE_SIZE];
} SerialMachineResponse;



class AJAExport CNTV2SerialControl : public CBaseMachineControl
{
    //  Instance Methods
    public:
        //  Constructors & Destructors
        explicit                CNTV2SerialControl (const UWord inDeviceIndex = 0, const UWord inSerialPortIndexNum = 0);
        virtual                 ~CNTV2SerialControl ();

        //  Control Methods
        virtual inline bool     Open (void)                                         {return _ntv2Card.IsOpen ();}
        virtual inline void     Close (void)                                        {}
        virtual ULWord          Play (void);
        virtual ULWord          ReversePlay (void);
        virtual ULWord          Stop (void);
        virtual ULWord          FastForward (void);
        virtual ULWord          Rewind (void);
        virtual ULWord          AdvanceFrame (void);
        virtual ULWord          BackFrame (void);
        virtual ULWord          GotoFrameByHMS (UByte inHrs, UByte inMins, UByte inSecs, UByte inFrames);
        virtual ULWord          GetTimecodeString (SByte * timecodeString);

        //  Accessors
        virtual inline const SerialMachineResponse &    GetLastResponse (void) const    {return _serialMachineResponse;}    //  Warning: Not thread safe!

        virtual bool            WriteCommand (const UByte * txBuffer, bool response = true);

        virtual bool            WriteTxBuffer (const UByte * txBuffer, UWord length);
        virtual bool            ReadRxBuffer (UByte * rxBuffer, UWord & actualLength, UWord maxlength);

        virtual bool            GotACK (void);

        virtual bool            WaitForRxInterrupt (void);
        virtual bool            WaitForTxInterrupt (void);

    //  Instance Variables
    protected:
        CNTV2Card               _ntv2Card;
        SerialMachineResponse   _serialMachineResponse;
        RegisterNum             _controlRegisterNum;    
        RegisterNum             _receiveRegisterNum;    
        RegisterNum             _transmitRegisterNum;   

};  //  CNTV2SerialControl


#if !defined (NTV2_DEPRECATE)
    typedef CNTV2SerialControl  CXenaSerialControl;     
#endif

#endif  //  _NTV2SERIALCONTROL_H