root/experimental/components/Packetizer/trunk/Packetizer-metadata/src/PacketizerDSP.h @ 5168

/****************************************************************************

Copyright 2007 Virginia Polytechnic Institute and State University

This file is part of the OSSIE Packetizer.

OSSIE Packetizer is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.

OSSIE Packetizer is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with OSSIE Packetizer; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA

****************************************************************************/


#ifndef PACKETIZERDSP_IMPL_H
#define PACKETIZERDSP_IMPL_H

#include <stdlib.h>
#include "PNCodes.h"
#include "sigproc/SigProc.h"

#define PN_SYNC_CODE_LENGTH     63
#define PN_CONTROL_CODE_LENGTH  7
#define NUM_CONTROL_CODES       7

/// Forward error correction scheme
enum FECScheme {
    REPEAT_1,       ///< Repeat code, rate 1/3
    RS_1,           ///< Reed solomon, rate... 
    CONV_1          ///< Convolutional, rate..., K=...
};

/// Interleaving scheme
enum InterleavingScheme {
    INT_1,          ///< Interleaving depth...
    INT_2           ///< Interleaving depth...
};

/// Cyclic redundancy check scheme
enum CRCScheme {
    CRC_1,
    CRC_2
};

/// Packet type
enum PacketType {
    LOW_LATENCY,    ///<
    RELIABLE_DATA   ///<
};

/** \brief
 *
 */
class PacketizerDSP
{
  public:
    /// Initializing constructor
    PacketizerDSP();

    /// Destructor
    ~PacketizerDSP();

  protected:
    // Physical layer definitions
    char * pnSyncCode;          ///< packet synchronization code
    char * pn_eom_code;         ///< packet eom sync code

    // Media Access Control layer definitions
    FECScheme fec_inner;
    FECScheme fec_outer;
    InterleavingScheme interleaving;
    CRCScheme crc;

    // Network layer definitions
    unsigned long src_id;       ///< source identifier
    unsigned long dst_id;       ///< destination identifier

    // Transport layer definitions
    PacketType packet_type;     ///< packet type identifier
    unsigned long packet_id;    ///< packet identifier
    unsigned long port_id;      ///< port identifier

    // Application layer definitions
    // ...

    /// Array of control code pointers
    char ** controlBlock;
    
    /// Sets pointers in controlBlock to appropriate control codes
    void ConfigureControl( unsigned char id );

    /// Correlate buffer with code
    int CorrelateSequence( char * _code, unsigned int _N );

    SigProc::CircularBuffer <char> b;   ///< circular input/output buffer
    int rxy;                            ///< cross-correlator output

  private:
    /// Disallow copy constructor
    PacketizerDSP(PacketizerDSP&);

};

#endif