include/h224/h281handler.h

   1 /*
   2  * h281handler.h
   3  *
   4  * H.281 protocol handler implementation for the OpenH323 Project.
   5  *
   6  * Copyright (c) 2006-2007 Network for Educational Technology, ETH Zurich.
   7  * Written by Hannes Friederich.
   8  *
   9  * The contents of this file are subject to the Mozilla Public License
  10  * Version 1.0 (the "License"); you may not use this file except in
  11  * compliance with the License. You may obtain a copy of the License at
  12  * http://www.mozilla.org/MPL/
  13  *
  14  * Software distributed under the License is distributed on an "AS IS"
  15  * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
  16  * the License for the specific language governing rights and limitations
  17  * under the License.
  18  *
  19  * Contributor(s): ______________________________________.
  20  *
  21  * $Log$
  22  * Revision 1.4  2007/08/05 22:34:08  hfriederich
  23  * Merge from MediaTypeBranch.
  24  *
  25  * New features:
  26  * - Session ID replaced by OpalMediaType class
  27  * - Dynamic session ID assignment in H.323 according to H.245
  28  * - Attempt to dynamically handle different media types (audio / video /
  29  *    / fax / H.224 etc) instead of hardcoded in the core classes.
  30  *   (not completed yet)
  31  * - Improved propagation of media formats / options between connections
  32  * - New media command implementation, uses chain-like propagation
  33  * - SDP 'Capabilities' to ease handling of complex SDP parameters
  34  *   (like FMTP)
  35  * - New SIP Transaction handling, avoiding race conditions
  36  * - Re-written H.224 implementation as an example how to add additional
  37  *   media types without adding code to the base classes
  38  *   (connection / endpoint / manager etc)
  39  *
  40  * This commit breaks the following code:
  41  * - T38Fax implementation.
  42  * - Recently added FMTP handling in MediaFormat/Option and SDP.
  43  *
  44  * Revision 1.3  2007/04/19 06:17:20  csoutheren
  45  * Fixes for precompiled headers with gcc
  46  *
  47  * Revision 1.2  2006/04/23 18:52:19  dsandras
  48  * Removed warnings when compiling with gcc on Linux.
  49  *
  50  * Revision 1.1  2006/04/20 16:48:17  hfriederich
  51  * Initial version of H.224/H.281 implementation.
  52  *
  53  */
  54
  55 #ifndef __OPAL_H281HANDLER_H
  56 #define __OPAL_H281HANDLER_H
  57
  58 #ifdef P_USE_PRAGMA
  59 #pragma interface
  60 #endif
  61
  62 #ifndef _PTLIB_H
  63 #include <ptlib.h>
  64 #endif
  65
  66 #include <h224/h224handler.h>
  67 #include <h224/h281.h>
  68
  69 class OpalH224Handler;
  70
  71 /** This class implements a storage for which cameras are
  72 available at both the local or remote side
  73 */
  74 class H281VideoSource : public PObject
  75 {
  76   PCLASSINFO(H281VideoSource, PObject);
  77
  78 public:
  79
  80   H281VideoSource();
  81   ~H281VideoSource();
  82
  83   BOOL IsEnabled() const { return isEnabled; }
  84   void SetEnabled(BOOL flag) { isEnabled = flag; }
  85
  86   BYTE GetVideoSourceNumber() const { return (firstOctet >> 4) & 0x0f; }
  87   void SetVideoSourceNumber(BYTE number);
  88
  89   BOOL CanMotionVideo() const { return (firstOctet >> 2) & 0x01; }
  90   void SetCanMotionVideo(BOOL flag);
  91
  92   BOOL CanNormalResolutionStillImage() const { return (firstOctet >> 1) & 0x01; }
  93   void SetCanNormalResolutionStillImage(BOOL flag);
  94
  95   BOOL CanDoubleResolutionStillImage() const { return (firstOctet & 0x01); }
  96   void SetCanDoubleResolutionStillImage(BOOL flag);
  97
  98   BOOL CanPan() const { return (secondOctet >> 7) & 0x01; }
  99   void SetCanPan(BOOL flag);
 100
 101   BOOL CanTilt() const { return (secondOctet >> 6) & 0x01; }
 102   void SetCanTilt(BOOL flag);
 103
 104   BOOL CanZoom() const { return (secondOctet >> 5) & 0x01; }
 105   void SetCanZoom(BOOL flag);
 106
 107   BOOL CanFocus() const { return (secondOctet >> 4) & 0x01; }
 108   void SetCanFocus(BOOL flag);
 109
 110   void Encode(BYTE *data) const;
 111   BOOL Decode(const BYTE *data);
 112
 113 protected:
 114
 115         BOOL isEnabled;
 116   BYTE firstOctet;
 117   BYTE secondOctet;
 118
 119 };
 120
 121 /** This class implements a defalt H.281 handler
 122 */
 123 class OpalH281Handler : public OpalH224Client
 124 {
 125   PCLASSINFO(OpalH281Handler, OpalH224Client);
 126
 127 public:
 128
 129   OpalH281Handler();
 130   ~OpalH281Handler();
 131
 132   enum VideoSource {
 133     CurrentVideoSource      = 0x00,
 134     MainCamera              = 0x01,
 135     AuxiliaryCamera         = 0x02,
 136     DocumentCamera          = 0x03,
 137     AuxiliaryDocumentCamera = 0x04,
 138     VideoPlaybackSource     = 0x05
 139   };
 140
 141   /**Overriding default OpalH224Client methods */
 142   virtual BYTE GetClientID() const { return H281_CLIENT_ID; };
 143   virtual BOOL HasExtraCapabilities() const { return TRUE; };
 144
 145   /**Processing incoming frames. Overrides from OpalH224Client */
 146   virtual void OnReceivedExtraCapabilities(const BYTE *capabilities, PINDEX size);
 147   virtual void OnReceivedMessage(const H224_Frame & message);
 148
 149   BYTE GetLocalNumberOfPresets() const { return localNumberOfPresets; }
 150   void SetLocalNumberOfPresets(BYTE presets) { localNumberOfPresets = presets; }
 151
 152   BYTE GetRemoteNumberOfPresets() const { return remoteNumberOfPresets; }
 153
 154   H281VideoSource & GetLocalVideoSource(VideoSource source);
 155   H281VideoSource & GetRemoteVideoSource(VideoSource source);
 156
 157   /** Causes the H.281 handler to start the desired action
 158         The action will continue until StopAction() is called.
 159         */
 160   void StartAction(H281_Frame::PanDirection panDirection,
 161                    H281_Frame::TiltDirection tiltDirection,
 162                    H281_Frame::ZoomDirection zoomDireciton,
 163                    H281_Frame::FocusDirection focusDirection);
 164
 165   /** Stops any action currently ongoing
 166         */
 167   void StopAction();
 168
 169   /** Tells the remote side to select the desired video source using the
 170         mode specified. Does nothing if either video source or mode aren't
 171         available
 172         */
 173   void SelectVideoSource(BYTE videoSourceNumber, H281_Frame::VideoMode videoMode);
 174
 175   /** Tells the remote side to store the current camera settings as a preset
 176         with the preset number given
 177         */
 178   void StoreAsPreset(BYTE presetNumber);
 179
 180   /** Tells the remote side to activate the given preset
 181         */
 182   void ActivatePreset(BYTE presetNumber);
 183
 184   /** Causes the H.281 handler to send its capabilities.
 185         Capabilities include the number of available cameras, (default one)
 186   the camera abilities (default none) and the number of presets that
 187   can be stored (default zero)
 188   */
 189   void SendExtraCapabilities() const;
 190
 191   /*
 192    * methods that subclasses can override.
 193    * The default handler does not implement FECC on the local side.
 194    * Thus, the default behaviour is to do nothing.
 195    */
 196
 197   /** Called each time a remote endpoint sends its capability list
 198         */
 199   virtual void OnRemoteCapabilitiesUpdated();
 200
 201   /** Indicates to start the action specified
 202         */
 203   virtual void OnStartAction(H281_Frame::PanDirection panDirection,
 204                              H281_Frame::TiltDirection tiltDirection,
 205                              H281_Frame::ZoomDirection zoomDirection,
 206                              H281_Frame::FocusDirection focusDirection);
 207
 208   /** Indicates to stop the action stared with OnStartAction()
 209         */
 210   virtual void OnStopAction();
 211
 212   /** Indicates to select the desired video source
 213         */
 214   virtual void OnSelectVideoSource(BYTE videoSourceNumber, H281_Frame::VideoMode videoMode);
 215
 216   /** Indicates to store the current camera settings as a preset
 217         */
 218   virtual void OnStoreAsPreset(BYTE presetNumber);
 219
 220   /** Indicates to activate the given preset number
 221         */
 222   virtual void OnActivatePreset(BYTE presetNumber);
 223
 224 protected:
 225
 226         PDECLARE_NOTIFIER(PTimer, OpalH281Handler, ContinueAction);
 227   PDECLARE_NOTIFIER(PTimer, OpalH281Handler, StopActionLocally);
 228
 229   BYTE localNumberOfPresets;
 230   BYTE remoteNumberOfPresets;
 231   H281VideoSource localVideoSources[6];
 232   H281VideoSource remoteVideoSources[6];
 233
 234   H281_Frame transmitFrame;
 235   PTimer transmitTimer;
 236
 237   H281_Frame::PanDirection requestedPanDirection;
 238   H281_Frame::TiltDirection requestedTiltDirection;
 239   H281_Frame::ZoomDirection requestedZoomDirection;
 240   H281_Frame::FocusDirection requestedFocusDirection;
 241   PTimer receiveTimer;
 242 };
 243
 244 #endif // __OPAL_H281HANDLER_H
 245