rohc_decomp.h

Go to the documentation of this file.

/*
 * This program 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.
 *
 * This program 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 this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 */

#ifndef DECOMP_H
#define DECOMP_H

#include "rohc.h"
#include "rohc_comp.h"

#define D_NUM_PROFILES 5


typedef enum
{
        NO_CONTEXT = 1,
        STATIC_CONTEXT = 2,
        FULL_CONTEXT = 3,
} rohc_d_state;


struct d_decode_data
{
        int cid;
        int addcidUsed;
        int largecidUsed;
        unsigned int large_cid_size;
        struct d_context *active;
};


struct d_statistics
{
        unsigned int packets_received;
        unsigned int packets_failed_crc;
        unsigned int packets_failed_no_context;
        unsigned int packets_failed_package;
        unsigned int packets_feedback;
};


struct rohc_decomp
{
        struct rohc_comp *compressor;

        struct medium *medium;

        struct d_context **contexts;
        int num_contexts;
        struct d_context *last_context;

        unsigned int maxval;
        unsigned int errval;
        unsigned int okval;
        int curval;

        struct d_statistics statistics;
};


struct d_context
{
        struct d_profile *profile;
        void *specific;

        rohc_mode mode;
        rohc_d_state state;

        unsigned int latest_used;
        unsigned int first_used;

        int curval;

        /* below are some statistics */

        int total_uncompressed_size;
        int total_compressed_size;
        int header_uncompressed_size;
        int header_compressed_size; 

        int num_recv_packets;
        int num_recv_ir;
        int num_recv_ir_dyn;
        int num_sent_feedbacks;

        int num_decomp_failures;
        int num_decomp_repairs;

        struct c_wlsb *total_16_uncompressed;
        struct c_wlsb *total_16_compressed;
        struct c_wlsb *header_16_uncompressed;
        struct c_wlsb *header_16_compressed;
};


struct d_profile
{
        int id;

        char *version;
        char *description;

        int (*decode)(struct rohc_decomp *decomp, struct d_context *context,
                      unsigned char *packet, int size, int second_byte,
                      unsigned char *dest);

        int (*decode_ir)(struct rohc_decomp *decomp, struct d_context *context,
                         unsigned char *packet, int size, int large_cid_len,
                         int is_addcid_used, unsigned char *dest);

        void * (*allocate_decode_data)(void);

        void (*free_decode_data)(void *);

        unsigned int (*detect_ir_size)(struct d_context *context,
                                       unsigned char *packet,
                                       unsigned int plen,
                                       unsigned int large_cid_len);

        unsigned int (*detect_ir_dyn_size)(struct d_context *context,
                                           unsigned char *packet,
                                           unsigned int plen,
                                           unsigned int large_cid_len);
        
        int (*get_static_part)(void);

        int (*get_sn)(struct d_context * context);
};

/*
 * Functions related to decompressor:
 */

void context_array_increase(struct rohc_decomp *decomp, int highestcid);
void context_array_decrease(struct rohc_decomp *decomp);

struct rohc_decomp * rohc_alloc_decompressor(struct rohc_comp *compressor);
void rohc_free_decompressor(struct rohc_decomp *decomp);

int rohc_decompress(struct rohc_decomp *decomp, unsigned char *ibuf, int isize,
                    unsigned char *obuf, int osize);
int rohc_decompress_both(struct rohc_decomp *decomp, unsigned char *ibuf,
                         int isize, unsigned char * obuf, int osize, int large);
int d_decode_header(struct rohc_decomp *decomp, unsigned char *ibuf, int isize,
                    unsigned char *obuf, int osize,
                    struct d_decode_data *ddata);

/*
 * Functions related to context:
 */

struct d_context * find_context(struct rohc_decomp *decomp, int cid);
struct d_context * context_create(struct rohc_decomp *decomp, int with_cid, struct d_profile * profile);
void context_free(struct d_context * context);


/*
 * Functions related to feedback:
 */

void d_operation_mode_feedback(struct rohc_decomp *decomp, int rohc_status, int cid,
                               int addcidUsed, int largecidUsed, int mode,
                               struct d_context *context);
void d_change_mode_feedback(struct rohc_decomp *decomp, struct d_context *context);


/*
 * Functions related to CRC of IR and IR-DYN packets:
 */

int rohc_ir_packet_crc_ok(struct d_context *context,
                          unsigned char *walk, unsigned int plen,
                          const int largecid, const int addcidUsed,
                          const struct d_profile *profile);
int rohc_ir_dyn_packet_crc_ok(unsigned char *walk,
                              unsigned int plen,
                              const int largecid,
                              const int addcidUsed,
                              const struct d_profile *profile,
                              struct d_context *context);


/*
 * Functions related to statistics:
 */

int rohc_d_statistics(struct rohc_decomp *decomp, unsigned int indent,
                      char *buffer);
int rohc_d_context(struct rohc_decomp *decomp, int index, unsigned int indent,
                   char *buffer);
void clear_statistics(struct rohc_decomp *decomp);


/*
 * Functions related to user interaction:
 */

void user_interactions(struct rohc_decomp *decomp, int feedback_maxval);


#endif