reportCameraCapabilitiesMessage.h 7.71 KB
Newer Older
pixhawk's avatar
pixhawk committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186
/*****************************************************************************
 *  Copyright (c) 2008, University of Florida
 *  All rights reserved.
 *  
 *  This file is part of OpenJAUS.  OpenJAUS is distributed under the BSD 
 *  license.  See the LICENSE file for details.
 * 
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *
 *     * Redistributions of source code must retain the above copyright
 *       notice, this list of conditions and the following disclaimer.
 *     * Redistributions in binary form must reproduce the above
 *       copyright notice, this list of conditions and the following
 *       disclaimer in the documentation and/or other materials provided
 *       with the distribution.
 *     * Neither the name of the University of Florida nor the names of its 
 *       contributors may be used to endorse or promote products derived from 
 *       this software without specific prior written permission.
 *
 *   THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *   "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *   LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 
 *   A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 
 *   OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 *   SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
 *   LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
 *   DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
 *   THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 *   (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 *   OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 ****************************************************************************/
// File Name: reportCameraCapabilitiesMessage.h
//
// Written By: Danny Kent (jaus AT dannykent DOT com), Tom Galluzzo 
//
// Version: 3.3.0a
//
// Date: 08/07/08
//
// Description: This file defines the attributes of a ReportCameraCapabilitiesMessage

#ifndef REPORT_CAMERA_CAPABILITIES_MESSAGE_H
#define REPORT_CAMERA_CAPABILITIES_MESSAGE_H

#include "jaus.h"

#define JAUS_CAMERA_DESCRIPTION_LENGTH_BYTES 50

#ifndef JAUS_REPORT_CAMERA_CAPABILITIES_PV
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_DESCRIPTION_BIT					0
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_HORIZONTAL_FOV_BIT			1
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_HORIZONTAL_FOV_BIT			2
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_VERTICAL_FOV_BIT				3
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_VERTICAL_FOV_BIT				4
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_HORIZONTAL_RESOLUTION_BIT	5
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_HORIZONTAL_RESOLUTION_BIT	6
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_VERTICAL_RESOLUTION_BIT		7
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_VERTICAL_RESOLUTION_BIT		8
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_FRAME_RATE_BIT				9
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_FRAME_RATE_BIT				10
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MAX_SHUTTER_SPEED_BIT			11
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_MIN_SHUTTER_SPEED_BIT			12
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_IMAGE_CONTROL_BIT				13
#define JAUS_REPORT_CAMERA_CAPABILITIES_PV_AUDIO_CONTROL_BIT				14
#endif

#ifndef JAUS_CAMERA_IMAGE_CONTROL_BF
#define JAUS_CAMERA_IMAGE_CONTROL_BF
#define JAUS_CAMERA_IMAGE_CONTROL_BF_AUTO_FOCUS_BIT				0
#define JAUS_CAMERA_IMAGE_CONTROL_BF_AUTO_IRIS_BIT				1
#define JAUS_CAMERA_IMAGE_CONTROL_BF_IMAGE_STABILIZATION_BIT	2
#define JAUS_CAMERA_IMAGE_CONTROL_BF_WHITE_BALANCE_BIT			3
#define JAUS_CAMERA_IMAGE_CONTROL_BF_SYNC_FLASH_BIT				4
#define JAUS_CAMERA_IMAGE_CONTROL_BF_RED_EYE_BIT				5	
#define JAUS_CAMERA_IMAGE_CONTROL_BF_AUTO_SHUTTER_BIT			6	
#define JAUS_CAMERA_IMAGE_CONTROL_BF_AUTO_GAIN_BIT				7	
#define JAUS_CAMERA_IMAGE_CONTROL_BF_INTERLACED_BIT				8	
#endif

#ifndef JAUS_CAMERA_AUDIO_CONTROL_BF 
#define JAUS_CAMERA_AUDIO_CONTROL_BF
#define JAUS_CAMERA_AUDIO_CONTROL_BF_AUDIO_BIT				0
#define JAUS_CAMERA_AUDIO_CONTROL_BF_AUTO_GAIN_BIT			1
#define JAUS_CAMERA_AUDIO_CONTROL_BF_STEREO_BIT				2
#define JAUS_CAMERA_AUDIO_CONTROL_BF_DIRECTIONAL_BIT		3
#define JAUS_CAMERA_AUDIO_CONTROL_BF_FRONT_MICROPHONE_BIT	4
#define JAUS_CAMERA_AUDIO_CONTROL_BF_REAR_MICROPHONE_BIT	5
#define JAUS_CAMERA_AUDIO_CONTROL_BF_LEFT_MICROPHONE_BIT	6
#define JAUS_CAMERA_AUDIO_CONTROL_BF_RIGHT_MICROPHONE_BIT	7
#endif

typedef struct
{
	// Include all parameters from a JausMessage structure:
	// Header Properties
	struct
	{
		// Properties by bit fields
		#ifdef JAUS_BIG_ENDIAN
			JausUnsignedShort reserved:2;
			JausUnsignedShort version:6;
			JausUnsignedShort expFlag:1;
			JausUnsignedShort scFlag:1;
			JausUnsignedShort ackNak:2;
			JausUnsignedShort priority:4; 
		#elif JAUS_LITTLE_ENDIAN
			JausUnsignedShort priority:4; 
			JausUnsignedShort ackNak:2;
			JausUnsignedShort scFlag:1; 
			JausUnsignedShort expFlag:1;
			JausUnsignedShort version:6; 
			JausUnsignedShort reserved:2;
		#else
			#error "Please define system endianess (see jaus.h)"
		#endif
	}properties;

	JausUnsignedShort commandCode; 

	JausAddress destination;

	JausAddress source;

	JausUnsignedInteger dataSize;

	JausUnsignedInteger dataFlag;
	
	JausUnsignedShort sequenceNumber;

	// MESSAGE DATA MEMBERS GO HERE
	JausUnsignedShort presenceVector;
	JausByte cameraID;
	char cameraDescription[JAUS_CAMERA_DESCRIPTION_LENGTH_BYTES];
	JausDouble maxHorizontalFovRadians;			// Scaled UShort (0, JAUS_PI) 
	JausDouble minHorizontalFovRadians;			// Scaled UShort (0, JAUS_PI) 
	JausDouble maxVerticalFovRadians;			// Scaled UShort (0, JAUS_PI) 
	JausDouble minVerticalFovRadians;			// Scaled UShort (0, JAUS_PI) 
	JausUnsignedShort maxHorizontalResolution;
	JausUnsignedShort minHorizontalResolution;
	JausUnsignedShort maxVerticalResolution;
	JausUnsignedShort minVerticalResolution;
	JausUnsignedShort maxFrameRate;
	JausUnsignedShort minFrameRate;
	JausUnsignedShort maxShutterSpeed;
	JausUnsignedShort minShutterSpeed;
	
	// Image Control
	JausBoolean autoFocusAvailable;
	JausBoolean autoIrisAvailable;
	JausBoolean imageStabilizationAvailable;
	JausBoolean whiteBalanceAvailable;
	JausBoolean syncFlashAvailable;
	JausBoolean redEyeAvailable;
	JausBoolean autoShutterAvailable;
	JausBoolean videoAutoGainAvailable;
	JausBoolean interlacedVideoAvailable;

	// Audio Control
	JausBoolean audioEnabledAvailable;
	JausBoolean audioAutoGainAvailable;
	JausBoolean stereoAudioAvailable;
	JausBoolean directionalAudioAvailable;
	JausBoolean frontMicrophoneAvailable;
	JausBoolean rearMicrophoneAvailable;
	JausBoolean leftMicrophoneAvailable;
	JausBoolean rightMicrophoneAvailable;
		
}ReportCameraCapabilitiesMessageStruct;

typedef ReportCameraCapabilitiesMessageStruct* ReportCameraCapabilitiesMessage;

JAUS_EXPORT ReportCameraCapabilitiesMessage reportCameraCapabilitiesMessageCreate(void);
JAUS_EXPORT void reportCameraCapabilitiesMessageDestroy(ReportCameraCapabilitiesMessage);

JAUS_EXPORT JausBoolean reportCameraCapabilitiesMessageFromBuffer(ReportCameraCapabilitiesMessage message, unsigned char* buffer, unsigned int bufferSizeBytes);
JAUS_EXPORT JausBoolean reportCameraCapabilitiesMessageToBuffer(ReportCameraCapabilitiesMessage message, unsigned char *buffer, unsigned int bufferSizeBytes);

JAUS_EXPORT ReportCameraCapabilitiesMessage reportCameraCapabilitiesMessageFromJausMessage(JausMessage jausMessage);
JAUS_EXPORT JausMessage reportCameraCapabilitiesMessageToJausMessage(ReportCameraCapabilitiesMessage message);

JAUS_EXPORT unsigned int reportCameraCapabilitiesMessageSize(ReportCameraCapabilitiesMessage message);

#endif // REPORT_CAMERA_CAPABILITIES_MESSAGE_H