TwiceAsNice  2019-02-18
Classes | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | Static Private Member Functions | Private Attributes | List of all members
indi_webcam Class Reference

#include <indi_webcam.h>

Inheritance diagram for indi_webcam:
Inheritance graph
Collaboration diagram for indi_webcam:
Collaboration graph

Classes

struct  ExpStart
 

Public Member Functions

 indi_webcam ()
 
 ~indi_webcam ()
 
void ISGetProperties (const char *dev) override
 define the driver's properties to the client. More...
 
virtual bool ISNewNumber (const char *dev, const char *name, double values[], char *names[], int n) override
 Process the client newNumber command. More...
 
virtual bool ISNewSwitch (const char *dev, const char *name, ISState *states, char *names[], int n) override
 Process the client newSwitch command. More...
 
virtual bool ISNewText (const char *dev, const char *name, char *texts[], char *names[], int n) override
 Process the client newSwitch command. More...
 
- Public Member Functions inherited from INDI::CCD
 CCD ()
 
virtual ~CCD ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
 CCD ()
 
virtual ~CCD ()
 
virtual bool ISSnoopDevice (XMLEle *root)
 Process a snoop event from INDI server. More...
 
- Public Member Functions inherited from INDI::DefaultDevice
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
 DefaultDevice ()
 
virtual ~DefaultDevice ()
 
void addAuxControls ()
 Add Debug, Simulation, and Configuration options to the driver. More...
 
void addDebugControl ()
 Add Debug control to the driver. More...
 
void addSimulationControl ()
 Add Simulation control to the driver. More...
 
void addConfigurationControl ()
 Add Configuration control to the driver. More...
 
void addPollPeriodControl ()
 Add Polling period control to the driver. More...
 
void resetProperties ()
 Set all properties to IDLE state. More...
 
void defineNumber (INumberVectorProperty *nvp)
 Define number vector to client & register it. More...
 
void defineText (ITextVectorProperty *tvp)
 Define text vector to client & register it. More...
 
void defineSwitch (ISwitchVectorProperty *svp)
 Define switch vector to client & register it. More...
 
void defineLight (ILightVectorProperty *lvp)
 Define light vector to client & register it. More...
 
void defineBLOB (IBLOBVectorProperty *bvp)
 Define BLOB vector to client & register it. More...
 
virtual bool deleteProperty (const char *propertyName)
 Delete a property and unregister it. More...
 
virtual void setConnected (bool status, IPState state=IPS_OK, const char *msg=nullptr)
 Set connection switch status in the client. More...
 
int SetTimer (uint32_t ms)
 Set a timer to call the function TimerHit after ms milliseconds. More...
 
void RemoveTimer (int id)
 Remove timer added with SetTimer. More...
 
virtual const char * getDriverExec ()
 
virtual const char * getDriverName ()
 
void setVersion (uint16_t vMajor, uint16_t vMinor)
 Set driver version information to be defined in DRIVER_INFO property as vMajor.vMinor. More...
 
uint16_t getMajorVersion ()
 
uint16_t getMinorVersion ()
 
virtual bool ISNewBLOB (const char *dev, const char *name, int sizes[], int blobsizes[], char *blobs[], char *formats[], char *names[], int n)
 Process the client newBLOB command. More...
 
virtual uint16_t getDriverInterface ()
 
void setDriverInterface (uint16_t value)
 setInterface Set driver interface. More...
 
- Public Member Functions inherited from INDI::BaseDevice
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 
 BaseDevice ()
 
virtual ~BaseDevice ()
 
INumberVectorPropertygetNumber (const char *name)
 
ITextVectorPropertygetText (const char *name)
 
ISwitchVectorPropertygetSwitch (const char *name)
 
ILightVectorPropertygetLight (const char *name)
 
IBLOBVectorPropertygetBLOB (const char *name)
 
IPState getPropertyState (const char *name)
 
IPerm getPropertyPermission (const char *name)
 
void registerProperty (void *p, INDI_PROPERTY_TYPE type)
 
int removeProperty (const char *name, char *errmsg)
 Remove a property. More...
 
void * getRawProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
INDI::PropertygetProperty (const char *name, INDI_PROPERTY_TYPE type=INDI_UNKNOWN)
 Return a property and its type given its name. More...
 
std::vector< INDI::Property * > * getProperties ()
 Return a list of all properties in the device. More...
 
bool buildSkeleton (const char *filename)
 Build driver properties from a skeleton file. More...
 
bool isConnected ()
 
void setDeviceName (const char *dev)
 Set the device name. More...
 
const char * getDeviceName ()
 
void addMessage (const std::string &msg)
 Add message to the driver's message queue. More...
 
void checkMessage (XMLEle *root)
 
void doMessage (XMLEle *msg)
 
std::string messageQueue (int index) const
 
std::string lastMessage ()
 
void setMediator (INDI::BaseMediator *med)
 Set the driver's mediator to receive notification of news devices and updated property values. More...
 
INDI::BaseMediatorgetMediator ()
 
const char * getDriverName ()
 
const char * getDriverExec ()
 
const char * getDriverVersion ()
 

Protected Member Functions

bool Connect () override
 Connect to the device. More...
 
bool Disconnect () override
 Disconnect from device. More...
 
const char * getDefaultName () override
 
bool initProperties () override
 Initilize properties initial state and value. More...
 
bool updateProperties () override
 updateProperties is called whenever there is a change in the CONNECTION status of the driver. More...
 
void debugTriggered (bool enabled) override
 Inform driver that the debug option was triggered. More...
 
bool StartExposure (float duration) override
 Start exposing primary CCD chip. More...
 
bool AbortExposure () override
 Abort ongoing exposure. More...
 
void finishExposure ()
 
void TimerHit () override
 Callback function to be called once SetTimer duration elapses. More...
 
float CalcTimeLeft ()
 
bool grabImage ()
 
bool UpdateCCDFrame (int x, int y, int w, int h) override
 CCD calls this function when CCD Frame dimension needs to be updated in the hardware. More...
 
virtual bool StartStreaming () override
 StartStreaming Start live video streaming. More...
 
virtual bool StopStreaming () override
 StopStreaming Stop live video streaming. More...
 
bool saveConfigItems (FILE *fp) override
 saveConfigItems Save configuration items in XML file. More...
 
- Protected Member Functions inherited from INDI::CCD
uint32_t GetCCDCapability () const
 GetCCDCapability returns the CCD capabilities. More...
 
void SetCCDCapability (uint32_t cap)
 SetCCDCapability Set the CCD capabilities. More...
 
bool CanAbort ()
 
bool CanBin ()
 
bool CanSubFrame ()
 
bool HasGuideHead ()
 
bool HasShutter ()
 
bool HasST4Port ()
 
bool HasCooler ()
 
bool HasBayer ()
 
bool HasStreaming ()
 
virtual int SetTemperature (double temperature)
 Set CCD temperature. More...
 
virtual bool ExposureComplete (CCDChip *targetChip)
 Uploads target Chip exposed buffer as FITS to the client. More...
 
virtual bool StartGuideExposure (float duration)
 Start exposing guide CCD chip. More...
 
virtual bool AbortGuideExposure ()
 Abort ongoing exposure. More...
 
virtual bool UpdateGuiderFrame (int x, int y, int w, int h)
 CCD calls this function when Guide head frame dimension is updated by the client. More...
 
virtual bool UpdateCCDBin (int hor, int ver)
 CCD calls this function when CCD Binning needs to be updated in the hardware. More...
 
virtual bool UpdateGuiderBin (int hor, int ver)
 CCD calls this function when Guide head binning is updated by the client. More...
 
virtual bool UpdateCCDFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when CCD frame type needs to be updated in the hardware. More...
 
virtual bool UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
 CCD calls this function when client upload mode switch is updated. More...
 
virtual bool UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when Guide frame type is updated by the client. More...
 
virtual void SetCCDParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for primary CCD. More...
 
virtual void SetGuiderParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for guide head CCD. More...
 
virtual IPState GuideNorth (uint32_t ms)
 Guide northward for ms milliseconds. More...
 
virtual IPState GuideSouth (uint32_t ms)
 Guide southward for ms milliseconds. More...
 
virtual IPState GuideEast (uint32_t ms)
 Guide easward for ms milliseconds. More...
 
virtual IPState GuideWest (uint32_t ms)
 Guide westward for ms milliseconds. More...
 
virtual void addFITSKeywords (fitsfile *fptr, CCDChip *targetChip)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
uint32_t GetCCDCapability () const
 GetCCDCapability returns the CCD capabilities. More...
 
void SetCCDCapability (uint32_t cap)
 SetCCDCapability Set the CCD capabilities. More...
 
bool CanAbort ()
 
bool CanBin ()
 
bool CanSubFrame ()
 
bool HasGuideHead ()
 
bool HasShutter ()
 
bool HasST4Port ()
 
bool HasCooler ()
 
bool HasBayer ()
 
bool HasStreaming ()
 
virtual int SetTemperature (double temperature)
 Set CCD temperature. More...
 
virtual bool ExposureComplete (CCDChip *targetChip)
 Uploads target Chip exposed buffer as FITS to the client. More...
 
virtual bool StartGuideExposure (float duration)
 Start exposing guide CCD chip. More...
 
virtual bool AbortGuideExposure ()
 Abort ongoing exposure. More...
 
virtual bool UpdateGuiderFrame (int x, int y, int w, int h)
 CCD calls this function when Guide head frame dimension is updated by the client. More...
 
virtual bool UpdateCCDBin (int hor, int ver)
 CCD calls this function when CCD Binning needs to be updated in the hardware. More...
 
virtual bool UpdateGuiderBin (int hor, int ver)
 CCD calls this function when Guide head binning is updated by the client. More...
 
virtual bool UpdateCCDFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when CCD frame type needs to be updated in the hardware. More...
 
virtual bool UpdateCCDUploadMode (CCD_UPLOAD_MODE mode)
 CCD calls this function when client upload mode switch is updated. More...
 
virtual bool UpdateGuiderFrameType (CCDChip::CCD_FRAME fType)
 CCD calls this function when Guide frame type is updated by the client. More...
 
virtual void SetCCDParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for primary CCD. More...
 
virtual void SetGuiderParams (int x, int y, int bpp, float xf, float yf)
 Setup CCD paramters for guide head CCD. More...
 
virtual IPState GuideNorth (uint32_t ms)
 Guide northward for ms milliseconds. More...
 
virtual IPState GuideSouth (uint32_t ms)
 Guide southward for ms milliseconds. More...
 
virtual IPState GuideEast (uint32_t ms)
 Guide easward for ms milliseconds. More...
 
virtual IPState GuideWest (uint32_t ms)
 Guide westward for ms milliseconds. More...
 
virtual void addFITSKeywords (fitsfile *fptr, CCDChip *targetChip)
 Add FITS keywords to a fits file. More...
 
void fits_update_key_s (fitsfile *fptr, int type, std::string name, void *p, std::string explanation, int *status)
 A function to just remove GCC warnings about deprecated conversion. More...
 
virtual void activeDevicesUpdated ()
 activeDevicesUpdated Inform children that ActiveDevices property was updated so they can snoop on the updated devices if desired. More...
 
void GuideComplete (INDI_EQ_AXIS axis)
 Call GuideComplete once the guiding pulse is complete. More...
 
- Protected Member Functions inherited from INDI::DefaultDevice
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
void setDynamicPropertiesBehavior (bool defineEnabled, bool deleteEnabled)
 setDynamicPropertiesBehavior controls handling of dynamic properties. More...
 
virtual bool loadConfig (bool silent=false, const char *property=nullptr)
 Load the last saved configuration file. More...
 
virtual bool saveConfig (bool silent=false, const char *property=nullptr)
 Save the current properties in a configuration file. More...
 
virtual bool saveAllConfigItems (FILE *fp)
 saveAllConfigItems Save all the drivers' properties in the configuration file More...
 
virtual bool loadDefaultConfig ()
 Load the default configuration file. More...
 
void setDebug (bool enable)
 Toggle driver debug status A driver can be more verbose if Debug option is enabled by the client. More...
 
void setSimulation (bool enable)
 Toggle driver simulation status A driver can run in simulation mode if Simulation option is enabled by the client. More...
 
virtual void simulationTriggered (bool enable)
 Inform driver that the simulation option was triggered. More...
 
bool isDebug ()
 
bool isSimulation ()
 
void registerConnection (Connection::Interface *newConnection)
 registerConnection Add new connection plugin to the existing connection pool. More...
 
bool unRegisterConnection (Connection::Interface *existingConnection)
 unRegisterConnection Remove connection from existing pool More...
 
Connection::InterfacegetActiveConnection ()
 
void setDefaultPollingPeriod (uint32_t period)
 
uint32_t getPollingPeriod ()
 
- Protected Member Functions inherited from INDI::BaseDevice
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 
int buildProp (XMLEle *root, char *errmsg)
 Build a property given the supplied XML element (defXXX) More...
 
int setValue (XMLEle *root, char *errmsg)
 handle SetXXX commands from client More...
 
int setBLOB (IBLOBVectorProperty *pp, XMLEle *root, char *errmsg)
 Parse and store BLOB in the respective vector. More...
 

Protected Attributes

int timerID
 
- Protected Attributes inherited from INDI::CCD
double RA
 
double Dec
 
double J2000RA
 
double J2000DE
 
double primaryFocalLength
 
double primaryAperture
 
double guiderFocalLength
 
double guiderAperture
 
bool InExposure
 
bool InGuideExposure
 
bool RapidGuideEnabled
 
bool GuiderRapidGuideEnabled
 
bool AutoLoop
 
bool GuiderAutoLoop
 
bool SendImage
 
bool GuiderSendImage
 
bool ShowMarker
 
bool GuiderShowMarker
 
float ExposureTime
 
float GuiderExposureTime
 
double MPSAS
 
double RotatorAngle
 
double Airmass
 
double Latitude
 
double Longitude
 
std::vector< std::string > FilterNames
 
int CurrentFilterSlot
 
std::unique_ptr< StreamManagerStreamer
 
CCDChip PrimaryCCD
 
CCDChip GuideCCD
 
INumberVectorProperty EqNP
 
INumber EqN [2]
 
ITextVectorProperty ActiveDeviceTP
 
IText ActiveDeviceT [4] {}
 
INumber TemperatureN [1]
 
INumberVectorProperty TemperatureNP
 
IText BayerT [3] {}
 
ITextVectorProperty BayerTP
 
IText FileNameT [1] {}
 
ITextVectorProperty FileNameTP
 
ISwitch UploadS [3]
 
ISwitchVectorProperty UploadSP
 
IText UploadSettingsT [2] {}
 
ITextVectorProperty UploadSettingsTP
 
ISwitch TelescopeTypeS [2]
 
ISwitchVectorProperty TelescopeTypeSP
 
ISwitch WorldCoordS [2]
 
ISwitchVectorProperty WorldCoordSP
 
INumber CCDRotationN [1]
 
INumberVectorProperty CCDRotationNP
 
ISwitch ExposureLoopS [2]
 
ISwitchVectorProperty ExposureLoopSP
 
INumber ExposureLoopCountN [1]
 
INumberVectorProperty ExposureLoopCountNP
 
double uploadTime = { 0 }
 
std::chrono::system_clock::time_point exposureLoopStartup
 
IText FITSHeaderT [2] {}
 
ITextVectorProperty FITSHeaderTP
 
- Protected Attributes inherited from INDI::DefaultDevice
uint32_t POLLMS = 1000
 Period in milliseconds to call TimerHit(). Default 1000 ms. More...
 

Private Member Functions

bool convertINDI_RGBtoFITS_RGB (uint8_t *originalImage, uint8_t *convertedImage)
 
bool ConnectToSource (std::string device, std::string source, int framerate, std::string videosize, std::string htmlSource)
 
bool ChangeSource (std::string newDevice, std::string newSource, int newFramerate, std::string newVideosize)
 
bool ChangeHTMLSource (std::string newIPAddress, std::string newPort, std::string newUserName, std::string newPassword)
 
bool reconnectSource ()
 
void findAVFoundationVideoSources ()
 
int getNumOfInputDevices ()
 
bool refreshInputDevices ()
 
bool refreshInputSources ()
 
bool addToStack ()
 
void copyFinalStackToPrimaryFrameBuffer ()
 
void setImageDataValueFromFloat (int x, int y, float value, bool roundAnswer)
 
void setRGBImageDataValueFromFloat (int x, int y, int channel, float value, bool roundAnswer)
 
float getImageDataFloatValue (int x, int y)
 
float getRGBImageDataFloatValue (int x, int y, int channel)
 
bool setupStreaming ()
 
void freeMemory ()
 
bool getStreamFrame ()
 
bool flush_frame_buffer ()
 
void run_capture ()
 
void start_capturing ()
 
void stop_capturing ()
 

Static Private Member Functions

static void RunCaptureThread (indi_webcam *webcam)
 

Private Attributes

float ExposureRequest { 0 }
 
ISwitch RefreshS [1]
 
ISwitchVectorProperty RefreshSP
 
bool webcamStacking
 
bool averaging
 
float * stackBuffer
 
int numberOfFramesInStack
 
bool use16Bit = true
 
std::string videoDevice
 
std::string videoSource
 
int frameRate
 
std::string videoSize
 
std::string outputFormat
 
std::string IPAddress
 
std::string port
 
std::string username
 
std::string password
 
std::string ffmpegTimeout
 
std::string bufferTimeout
 
IText InputOptionsT [4]
 
ITextVectorProperty InputOptionsTP
 
IText HTTPInputOptions [4]
 
ITextVectorProperty HTTPInputOptionsP
 
ISwitchCaptureDevices = nullptr
 
ISwitchVectorProperty CaptureDeviceSelection
 
ISwitchCaptureSources = nullptr
 
ISwitchVectorProperty CaptureSourceSelection
 
ISwitchFrameRates = nullptr
 
ISwitchVectorProperty FrameRateSelection
 
ISwitchVideoSizes = nullptr
 
ISwitchVectorProperty VideoSizeSelection
 
ISwitchRapidStacking = nullptr
 
ISwitchVectorProperty RapidStackingSelection
 
ISwitchOutputFormats = nullptr
 
ISwitchVectorProperty OutputFormatSelection
 
IText TimeoutOptionsT [2]
 
ITextVectorProperty TimeoutOptionsTP
 
std::thread capture_thread
 
bool is_capturing
 
bool is_streaming
 
struct SwsContext * sws_ctx
 
uint8_tbuffer
 
int numBytes
 
AVPixelFormat out_pix_fmt
 
AVFormatContext * pFormatCtx
 
int videoStream
 
AVCodecContext * pCodecCtx
 
AVCodec * pCodec
 
AVFrame * pFrame
 
AVFrame * pFrameOUT
 
AVDictionary * optionsDict
 

Additional Inherited Members

- Public Types inherited from INDI::CCD
enum  {
  CCD_CAN_BIN = 1 << 0, CCD_CAN_SUBFRAME = 1 << 1, CCD_CAN_ABORT = 1 << 2, CCD_HAS_GUIDE_HEAD = 1 << 3,
  CCD_HAS_ST4_PORT = 1 << 4, CCD_HAS_SHUTTER = 1 << 5, CCD_HAS_COOLER = 1 << 6, CCD_HAS_BAYER = 1 << 7,
  CCD_HAS_STREAMING = 1 << 8
}
 
enum  CCD_UPLOAD_MODE {
  UPLOAD_CLIENT, UPLOAD_LOCAL, UPLOAD_BOTH, UPLOAD_CLIENT,
  UPLOAD_LOCAL, UPLOAD_BOTH
}
 
enum  {
  CCD_CAN_BIN = 1 << 0, CCD_CAN_SUBFRAME = 1 << 1, CCD_CAN_ABORT = 1 << 2, CCD_HAS_GUIDE_HEAD = 1 << 3,
  CCD_HAS_ST4_PORT = 1 << 4, CCD_HAS_SHUTTER = 1 << 5, CCD_HAS_COOLER = 1 << 6, CCD_HAS_BAYER = 1 << 7,
  CCD_HAS_STREAMING = 1 << 8
}
 
enum  CCD_UPLOAD_MODE {
  UPLOAD_CLIENT, UPLOAD_LOCAL, UPLOAD_BOTH, UPLOAD_CLIENT,
  UPLOAD_LOCAL, UPLOAD_BOTH
}
 
- Public Types inherited from INDI::BaseDevice
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
enum  INDI_ERROR {
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4,
  INDI_DEVICE_NOT_FOUND = -1, INDI_PROPERTY_INVALID = -2, INDI_PROPERTY_DUPLICATED = -3, INDI_DISPATCH_ERROR = -4
}
 
enum  DRIVER_INTERFACE {
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15),
  GENERAL_INTERFACE = 0, TELESCOPE_INTERFACE = (1 << 0), CCD_INTERFACE = (1 << 1), GUIDER_INTERFACE = (1 << 2),
  FOCUSER_INTERFACE = (1 << 3), FILTER_INTERFACE = (1 << 4), DOME_INTERFACE = (1 << 5), GPS_INTERFACE = (1 << 6),
  WEATHER_INTERFACE = (1 << 7), AO_INTERFACE = (1 << 8), DUSTCAP_INTERFACE = (1 << 9), LIGHTBOX_INTERFACE = (1 << 10),
  DETECTOR_INTERFACE = (1 << 11), ROTATOR_INTERFACE = (1 << 12), SPECTROGRAPH_INTERFACE = (1 << 13), AUX_INTERFACE = (1 << 15)
}
 The DRIVER_INTERFACE enum defines the class of devices the driver implements. More...
 
- Public Attributes inherited from INDI::CCD
enum INDI::CCD:: { ... }  CCDCapability
 
enum INDI::CCD:: { ... }  CCDCapability
 
- Protected Types inherited from INDI::CCD
enum  { SNOOP_MOUNT, SNOOP_ROTATOR, SNOOP_FILTER_WHEEL, SNOOP_SQM }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY, TELESCOPE_GUIDE }
 
enum  { EXPOSURE_LOOP_ON, EXPOSURE_LOOP_OFF }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 
enum  { SNOOP_MOUNT, SNOOP_ROTATOR, SNOOP_FILTER_WHEEL, SNOOP_SQM }
 
enum  { UPLOAD_DIR, UPLOAD_PREFIX }
 
enum  { TELESCOPE_PRIMARY, TELESCOPE_GUIDE }
 
enum  { EXPOSURE_LOOP_ON, EXPOSURE_LOOP_OFF }
 
enum  { FITS_OBSERVER, FITS_OBJECT }
 

Constructor & Destructor Documentation

◆ indi_webcam()

indi_webcam::indi_webcam ( )

◆ ~indi_webcam()

indi_webcam::~indi_webcam ( )

Member Function Documentation

◆ AbortExposure()

bool indi_webcam::AbortExposure ( )
overrideprotectedvirtual

Abort ongoing exposure.

Returns
true is abort is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ addToStack()

bool indi_webcam::addToStack ( )
private

◆ CalcTimeLeft()

float indi_webcam::CalcTimeLeft ( )
protected

◆ ChangeHTMLSource()

bool indi_webcam::ChangeHTMLSource ( std::string  newIPAddress,
std::string  newPort,
std::string  newUserName,
std::string  newPassword 
)
private

◆ ChangeSource()

bool indi_webcam::ChangeSource ( std::string  newDevice,
std::string  newSource,
int  newFramerate,
std::string  newVideosize 
)
private

◆ Connect()

bool indi_webcam::Connect ( )
overrideprotectedvirtual

Connect to the device.

INDI::DefaultDevice implementation connects to appropriate connection interface (Serial or TCP) governed by connectionMode. If connection is successful, it proceed to call Handshake() function to ensure communication with device is successful. For other communication interface, override the method in the child class implementation

Returns
True if connection is successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ ConnectToSource()

bool indi_webcam::ConnectToSource ( std::string  device,
std::string  source,
int  framerate,
std::string  videosize,
std::string  htmlSource 
)
private

◆ convertINDI_RGBtoFITS_RGB()

bool indi_webcam::convertINDI_RGBtoFITS_RGB ( uint8_t originalImage,
uint8_t convertedImage 
)
private

◆ copyFinalStackToPrimaryFrameBuffer()

void indi_webcam::copyFinalStackToPrimaryFrameBuffer ( )
private

◆ debugTriggered()

void indi_webcam::debugTriggered ( bool  enable)
overrideprotectedvirtual

Inform driver that the debug option was triggered.

This function is called after setDebug is triggered by the client. Reimplement this function if your driver needs to take specific action after debug is enabled/disabled. Otherwise, you can use isDebug() to check if simulation is enabled or disabled.

Parameters
enableIf true, the debug option is set to ON.

Reimplemented from INDI::DefaultDevice.

◆ Disconnect()

bool indi_webcam::Disconnect ( )
overrideprotectedvirtual

Disconnect from device.

Returns
True if successful, false otherwise

Reimplemented from INDI::DefaultDevice.

◆ findAVFoundationVideoSources()

void indi_webcam::findAVFoundationVideoSources ( )
private

◆ finishExposure()

void indi_webcam::finishExposure ( )
protected

◆ flush_frame_buffer()

bool indi_webcam::flush_frame_buffer ( )
private

◆ freeMemory()

void indi_webcam::freeMemory ( )
private

◆ getDefaultName()

const char * indi_webcam::getDefaultName ( )
overrideprotectedvirtual
Returns
Default name of the device.

Implements INDI::DefaultDevice.

◆ getImageDataFloatValue()

float indi_webcam::getImageDataFloatValue ( int  x,
int  y 
)
private

◆ getNumOfInputDevices()

int indi_webcam::getNumOfInputDevices ( )
private

◆ getRGBImageDataFloatValue()

float indi_webcam::getRGBImageDataFloatValue ( int  x,
int  y,
int  channel 
)
private

◆ getStreamFrame()

bool indi_webcam::getStreamFrame ( )
private

◆ grabImage()

bool indi_webcam::grabImage ( )
protected

◆ initProperties()

bool indi_webcam::initProperties ( )
overrideprotectedvirtual

Initilize properties initial state and value.

The child class must implement this function.

Returns
True if initilization is successful, false otherwise.

Reimplemented from INDI::CCD.

◆ ISGetProperties()

void indi_webcam::ISGetProperties ( const char *  dev)
overridevirtual

define the driver's properties to the client.

Usually, only a minimum set of properties are defined to the client in this function if the device is in disconnected state. Those properties should be enough to enable the client to establish a connection to the device. In addition to CONNECT/DISCONNECT, such properties may include port name, IP address, etc. You should check if the device is already connected, and if this is true, then you must define the remainder of the the properties to the client in this function. Otherwise, the remainder of the driver's properties are defined to the client in updateProperties() function which is called when a client connects/disconnects from a device.

Parameters
devname of the device
Note
This function is called by the INDI framework, do not call it directly. See LX200 Generic driver for an example implementation

Reimplemented from INDI::CCD.

◆ ISNewNumber()

bool indi_webcam::ISNewNumber ( const char *  dev,
const char *  name,
double  values[],
char *  names[],
int  n 
)
overridevirtual

Process the client newNumber command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISNewSwitch()

bool indi_webcam::ISNewSwitch ( const char *  dev,
const char *  name,
ISState states,
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ ISNewText()

bool indi_webcam::ISNewText ( const char *  dev,
const char *  name,
char *  texts[],
char *  names[],
int  n 
)
overridevirtual

Process the client newSwitch command.

Note
This function is called by the INDI framework, do not call it directly.
Returns
True if any property was successfully processed, false otherwise.

Reimplemented from INDI::CCD.

◆ reconnectSource()

bool indi_webcam::reconnectSource ( )
private

◆ refreshInputDevices()

bool indi_webcam::refreshInputDevices ( )
private

◆ refreshInputSources()

bool indi_webcam::refreshInputSources ( )
private

◆ run_capture()

void indi_webcam::run_capture ( )
private

◆ RunCaptureThread()

void indi_webcam::RunCaptureThread ( indi_webcam webcam)
staticprivate

◆ saveConfigItems()

bool indi_webcam::saveConfigItems ( FILE *  fp)
overrideprotectedvirtual

saveConfigItems Save configuration items in XML file.

Parameters
fppointer to file to write to
Returns
True if successful, false otherwise

Reimplemented from INDI::CCD.

◆ setImageDataValueFromFloat()

void indi_webcam::setImageDataValueFromFloat ( int  x,
int  y,
float  value,
bool  roundAnswer 
)
private

◆ setRGBImageDataValueFromFloat()

void indi_webcam::setRGBImageDataValueFromFloat ( int  x,
int  y,
int  channel,
float  value,
bool  roundAnswer 
)
private

◆ setupStreaming()

bool indi_webcam::setupStreaming ( )
private

◆ start_capturing()

void indi_webcam::start_capturing ( )
private

◆ StartExposure()

bool indi_webcam::StartExposure ( float  duration)
overrideprotectedvirtual

Start exposing primary CCD chip.

Parameters
durationDuration in seconds
Returns
true if OK and exposure will take some time to complete, false on error.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ StartStreaming()

bool indi_webcam::StartStreaming ( )
overrideprotectedvirtual

StartStreaming Start live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ stop_capturing()

void indi_webcam::stop_capturing ( )
private

◆ StopStreaming()

bool indi_webcam::StopStreaming ( )
overrideprotectedvirtual

StopStreaming Stop live video streaming.

Returns
True if successful, false otherwise.

Reimplemented from INDI::CCD.

◆ TimerHit()

void indi_webcam::TimerHit ( )
overrideprotectedvirtual

Callback function to be called once SetTimer duration elapses.

Reimplemented from INDI::DefaultDevice.

◆ UpdateCCDFrame()

bool indi_webcam::UpdateCCDFrame ( int  x,
int  y,
int  w,
int  h 
)
overrideprotectedvirtual

CCD calls this function when CCD Frame dimension needs to be updated in the hardware.

Derived classes should implement this function

Parameters
xSubframe X coordinate in pixels.
ySubframe Y coordinate in pixels.
wSubframe width in pixels.
hSubframe height in pixels.
Note
(0,0) is defined as most left, top pixel in the subframe.
Returns
true is CCD chip update is successful, false otherwise.
Note
This function is not implemented in CCD, it must be implemented in the child class

Reimplemented from INDI::CCD.

◆ updateProperties()

bool indi_webcam::updateProperties ( )
overrideprotectedvirtual

updateProperties is called whenever there is a change in the CONNECTION status of the driver.

This will enable the driver to react to changes of switching ON/OFF a device. For example, a driver may only define a set of properties after a device is connected, but not before.

Returns
True if update is successful, false otherwise.

Reimplemented from INDI::CCD.

Member Data Documentation

◆ averaging

bool indi_webcam::averaging
private

◆ buffer

uint8_t* indi_webcam::buffer
private

◆ bufferTimeout

std::string indi_webcam::bufferTimeout
private

◆ capture_thread

std::thread indi_webcam::capture_thread
private

◆ CaptureDevices

ISwitch* indi_webcam::CaptureDevices = nullptr
private

◆ CaptureDeviceSelection

ISwitchVectorProperty indi_webcam::CaptureDeviceSelection
private

◆ CaptureSources

ISwitch* indi_webcam::CaptureSources = nullptr
private

◆ CaptureSourceSelection

ISwitchVectorProperty indi_webcam::CaptureSourceSelection
private

◆ ExposureRequest

float indi_webcam::ExposureRequest { 0 }
private

◆ ffmpegTimeout

std::string indi_webcam::ffmpegTimeout
private

◆ frameRate

int indi_webcam::frameRate
private

◆ FrameRates

ISwitch* indi_webcam::FrameRates = nullptr
private

◆ FrameRateSelection

ISwitchVectorProperty indi_webcam::FrameRateSelection
private

◆ HTTPInputOptions

IText indi_webcam::HTTPInputOptions[4]
private

◆ HTTPInputOptionsP

ITextVectorProperty indi_webcam::HTTPInputOptionsP
private

◆ InputOptionsT

IText indi_webcam::InputOptionsT[4]
private

◆ InputOptionsTP

ITextVectorProperty indi_webcam::InputOptionsTP
private

◆ IPAddress

std::string indi_webcam::IPAddress
private

◆ is_capturing

bool indi_webcam::is_capturing
private

◆ is_streaming

bool indi_webcam::is_streaming
private

◆ numberOfFramesInStack

int indi_webcam::numberOfFramesInStack
private

◆ numBytes

int indi_webcam::numBytes
private

◆ optionsDict

AVDictionary* indi_webcam::optionsDict
private

◆ out_pix_fmt

AVPixelFormat indi_webcam::out_pix_fmt
private

◆ outputFormat

std::string indi_webcam::outputFormat
private

◆ OutputFormats

ISwitch* indi_webcam::OutputFormats = nullptr
private

◆ OutputFormatSelection

ISwitchVectorProperty indi_webcam::OutputFormatSelection
private

◆ password

std::string indi_webcam::password
private

◆ pCodec

AVCodec* indi_webcam::pCodec
private

◆ pCodecCtx

AVCodecContext* indi_webcam::pCodecCtx
private

◆ pFormatCtx

AVFormatContext* indi_webcam::pFormatCtx
private

◆ pFrame

AVFrame* indi_webcam::pFrame
private

◆ pFrameOUT

AVFrame* indi_webcam::pFrameOUT
private

◆ port

std::string indi_webcam::port
private

◆ RapidStacking

ISwitch* indi_webcam::RapidStacking = nullptr
private

◆ RapidStackingSelection

ISwitchVectorProperty indi_webcam::RapidStackingSelection
private

◆ RefreshS

ISwitch indi_webcam::RefreshS[1]
private

◆ RefreshSP

ISwitchVectorProperty indi_webcam::RefreshSP
private

◆ stackBuffer

float* indi_webcam::stackBuffer
private

◆ sws_ctx

struct SwsContext* indi_webcam::sws_ctx
private

◆ TimeoutOptionsT

IText indi_webcam::TimeoutOptionsT[2]
private

◆ TimeoutOptionsTP

ITextVectorProperty indi_webcam::TimeoutOptionsTP
private

◆ timerID

int indi_webcam::timerID
protected

◆ use16Bit

bool indi_webcam::use16Bit = true
private

◆ username

std::string indi_webcam::username
private

◆ videoDevice

std::string indi_webcam::videoDevice
private

◆ videoSize

std::string indi_webcam::videoSize
private

◆ VideoSizes

ISwitch* indi_webcam::VideoSizes = nullptr
private

◆ VideoSizeSelection

ISwitchVectorProperty indi_webcam::VideoSizeSelection
private

◆ videoSource

std::string indi_webcam::videoSource
private

◆ videoStream

int indi_webcam::videoStream
private

◆ webcamStacking

bool indi_webcam::webcamStacking
private

The documentation for this class was generated from the following files: