q922.h

Go to the documentation of this file.

/*
 * q922.h
 *
 * Q.922 PDU implementation for the OpenH323 Project.
 *
 * Copyright (c) 2006 Network for Educational Technology, ETH Zurich.
 * Written by Hannes Friederich.
 *
 * The contents of this file are subject to the Mozilla Public License
 * Version 1.0 (the "License"); you may not use this file except in
 * compliance with the License. You may obtain a copy of the License at
 * http://www.mozilla.org/MPL/
 *
 * Software distributed under the License is distributed on an "AS IS"
 * basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
 * the License for the specific language governing rights and limitations
 * under the License.
 *
 * Contributor(s): ______________________________________.
 */

#ifndef OPAL_H224_Q922_H
#define OPAL_H224_Q922_H

#ifdef P_USE_PRAGMA
#pragma interface
#endif

#ifndef _PTLIB_H
#include <ptlib.h>
#endif

#include <opal_config.h>

#if OPAL_HAS_H224

#define Q922_HEADER_SIZE 3

class Q922_Frame : public PBYTEArray
{
  PCLASSINFO(Q922_Frame, PBYTEArray);

public:

  Q922_Frame(PINDEX informationFieldSize = 260);
  ~Q922_Frame();

  BYTE GetHighOrderAddressOctet() const { return theArray[0]; }
  BYTE GetLowOrderAddressOctet() const { return theArray[1]; }
  void SetHighOrderAddressOctet(BYTE octet) { theArray[0] = octet; }
  void SetLowOrderAddressOctet(BYTE octet) { theArray[1] = octet; }

  BYTE GetControlFieldOctet() const { return theArray[2]; }
  void SetControlFieldOctet(BYTE octet) { theArray[2] = octet; }

  BYTE *GetInformationFieldPtr() const { return (BYTE *)(theArray + Q922_HEADER_SIZE); }

  PINDEX GetInformationFieldSize() const { return m_informationFieldSize; }
  void SetInformationFieldSize(PINDEX size);

  bool DecodeAnnexQ(const BYTE *buffer, PINDEX size);

  PINDEX GetAnnexQEncodedSize() const;

  bool EncodeAnnexQ(BYTE *buffer, PINDEX & size) const;

  bool DecodeHDLC(const BYTE *data, PINDEX size);

  PINDEX GetHDLCEncodedSize() const;

  bool EncodeHDLC(BYTE *buffer, PINDEX & size) const;

  bool EncodeHDLC(BYTE *buffer, PINDEX & size, PINDEX & bitPosition) const;

protected:

  PINDEX m_informationFieldSize;

private:

  // for HDLC mode
  inline bool FindFlagEnd(const BYTE *buffer, PINDEX bufferSize, PINDEX & octetIndex, PINDEX & bitIndex);
  inline BYTE DecodeOctet(const BYTE *buffer, BYTE *destination, PINDEX & octetIndex, PINDEX & bitIndex, PINDEX & onesCounter);
  inline BYTE DecodeBit(const BYTE *buffer, PINDEX & octetIndex, PINDEX & bitIndex);

  inline void EncodeOctet(BYTE octet, BYTE *buffer, PINDEX & octetIndex, PINDEX & bitIndex, PINDEX & onesCounter) const;
  inline void EncodeOctetNoEscape(BYTE octet, BYTE *buffer, PINDEX & octetIndex, PINDEX & bitIndex) const;
  inline void EncodeBit(BYTE bit, BYTE *buffer, PINDEX & octetIndex, PINDEX & bitIndex) const;

  inline WORD CalculateFCS(const BYTE*data, PINDEX length) const;
};


#endif // OPAL_HAS_H224

#endif // OPAL_H224_Q922_H