/*
 * FILE:     ldgm.c
 * AUTHOR:   Martin Pulec <pulec@cesnet.cz>
 *
 * The routines in this file implement the Real-time Transport Protocol,
 * RTP, as specified in RFC1889 with current updates under discussion in
 * the IETF audio/video transport working group. Portions of the code are
 * derived from the algorithms published in that specification.
 *
 * Copyright (c) 2005-2010 CESNET z.s.p.o.
 * Copyright (c) 2001-2004 University of Southern California
 * Copyright (c) 2003-2004 University of Glasgow
 * Copyright (c) 1998-2001 University College London
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, is permitted provided that the following conditions 
 * are met:
 *
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 *
 * 2. 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.
 *
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *
 *      This product includes software developed by the Computer Science
 *      Department at University College London and by the University of
 *      Southern California Information Sciences Institute. This product also
 *      includes software developed by CESNET z.s.p.o.
 *
 * 4. Neither the name of the University, Department, CESNET 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 AUTHORS AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESSED 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 AUTHORS 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.
 */

#ifdef HAVE_CONFIG_H
#include "config.h"
#include "config_unix.h"
#include "config_win32.h"
#endif /* HAVE_CONFIG_H */

#include <iostream>
#include <errno.h>
#include <limits.h>
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <sys/stat.h>
#include <unistd.h>
#include <sys/types.h>

#include <limits>

#include "ldgm.h"

#include "ldgm-coding/ldgm-session.h"
#include "ldgm-coding/ldgm-session-cpu.h"
#include "ldgm-coding/matrix-gen/matrix-generator.h"
#include "ldgm-coding/matrix-gen/ldpc-matrix.h" // LDGM_MAX_K

using namespace std;

typedef enum {
        STD1500 = 1500,
        JUMBO9000 = 9000,
} packet_type_t;

typedef struct {
        packet_type_t packet_type;
        int frame_size;
        double loss;
        // result
        int k, m, c;

} configuration_t;


#define PCT2 2.0
#define PCT5 5.0
#define PCT10 10.0
typedef double loss_t;

loss_t losses[] = {
        std::numeric_limits<double>::min(),
                PCT2,
                PCT5,
                PCT10,
};

#define JPEG60_SIZE (144 * 1000)
#define JPEG80_SIZE (177 * 1000)
#define JPEG90_SIZE (217 * 1000)

#define UNCOMPRESSED_SIZE (1920 * 1080 * 2)

const configuration_t suggested_configurations[] = {
        // JPEG 60
        { STD1500, JPEG60_SIZE, PCT2, 750, 120, 5 },
        { STD1500, JPEG60_SIZE, PCT5, 1500, 450, 6 },
        { STD1500, JPEG60_SIZE, PCT10, 1000, 500, 7 },
        // JPEG 80
        { STD1500, JPEG80_SIZE, PCT2, 1500, 240, 5 },
        { STD1500, JPEG80_SIZE, PCT5, 1250, 375, 6 },
        { STD1500, JPEG80_SIZE, PCT10, 1500, 750, 8 },
        // JPEG 90
        { STD1500, JPEG90_SIZE, PCT2, 1500, 240, 6 },
        { STD1500, JPEG90_SIZE, PCT5, 1500, 450, 6 },
        { STD1500, JPEG90_SIZE, PCT10, 1500, 750, 8 },

        // uncompressed
        { JUMBO9000, UNCOMPRESSED_SIZE, PCT2, 1500, 180, 5 },
        { JUMBO9000, UNCOMPRESSED_SIZE, PCT5, 1000, 300, 6 },
        { JUMBO9000, UNCOMPRESSED_SIZE, PCT10, 1000, 500, 7 },

        { STD1500, UNCOMPRESSED_SIZE, PCT2, 1500, 250, 5 },
        { STD1500, UNCOMPRESSED_SIZE, PCT5, 1500, 650, 6 },
        { STD1500, UNCOMPRESSED_SIZE, PCT10, 1500, 1500, 8 },
};

#define MINIMAL_VALUE 64 // reasonable minimum (seems that 32 crashes sometimes)
#define DEFAULT_K 256
#define DEFAULT_M 192
#define SEED 1
#define DEFAULT_C 5
#define MIN_C 2 // reasonable minimum
#define MAX_C 63 // from packet format
#define MAX_K (1<<13) - 1

static bool file_exists(char *filename);
static void usage(void);

static bool file_exists(char *filename)
{
        struct stat sb;
        if (stat(filename, &sb)) {
                perror("stat");
                return false;
        }

        return true;
}

struct ldgm_state_encoder {
        ldgm_state_encoder(unsigned int k_, unsigned int m_, unsigned int c_) :
                k(k_),
                m(m_),
                c(c_)
        {
                seed = SEED;
                coding_session.set_params(k, m, c);

                char filename[512];
                char path[256];
#ifdef WIN32
		TCHAR tmpPath[MAX_PATH];
		UINT ret = GetTempPath(MAX_PATH, tmpPath);
		if(ret == 0 || ret > MAX_PATH) {
			fprintf(stderr, "Unable to get temporary directory name.\n");
			throw 1;
		}
                snprintf(path, 256, "%s\\ultragrid\\", tmpPath);
#else
                snprintf(path, 256, "/var/tmp/ultragrid-%d/", (int) getuid());
#endif

                int res;

                res = platform_mkdir(path);
                if(res != 0) {
                        if(errno != EEXIST) {
                                perror("mkdir");
                                fprintf(stderr, "[LDGM] Unable to create data directory.\n");
                                throw 1;
                        }
                }
                snprintf(filename, 512, "%s/ldgm_matrix-%u-%u-%u-%u.bin", path, k, m, c, seed);
                if(!file_exists(filename)) {
                        int ret = generate_ldgm_matrix(filename, k, m, c, seed);
                        if(ret != 0) {
                                fprintf(stderr, "[LDGM] Unable to initialize LDGM matrix.\n");
                                throw 1;
                        }
                }

                coding_session.set_pcMatrix(filename);
        }

        char * encode(char *hdr, int hdr_len, char *frame, int size, int *out_size) {
                char *output = coding_session.encode_hdr_frame(hdr, hdr_len,
                                frame, size, out_size);
                return output;
        }

        void freeBuffer(char *buffer) {
                coding_session.free_out_buf(buffer);
        }

        virtual ~ldgm_state_encoder() {
        }

        unsigned int get_k() {
                return k;
        }

        unsigned int get_m() {
                return m;
        }

        unsigned int get_c() {
                return c;
        }

        unsigned int get_seed() {
                return seed;
        }

        private:
        LDGM_session_cpu coding_session;
        char *buffer;
        unsigned int k, m, c;
        unsigned int seed;
        char *left_matrix;
};

struct ldgm_state_decoder {
        ldgm_state_decoder(unsigned int k, unsigned int m, unsigned int c, unsigned int seed) {
                coding_session.set_params(k, m, c);
                char filename[512];
                char path[256];

                int res;

#ifdef WIN32
		TCHAR tmpPath[MAX_PATH];
		UINT ret = GetTempPath(MAX_PATH, tmpPath);
		if(ret == 0 || ret > MAX_PATH) {
			fprintf(stderr, "Unable to get temporary directory name.\n");
			throw 1;
		}
                snprintf(path, 256, "%s\\ultragrid\\", tmpPath);
#else
                snprintf(path, 256, "/var/tmp/ultragrid-%d/", (int) getuid());
#endif

                res = platform_mkdir(path);
                if(res != 0) {
                        if(errno != EEXIST) {
                                perror("mkdir");
                                fprintf(stderr, "[LDGM] Unable to create data directory.\n");
                                throw 1;
                        }
                }
                snprintf(filename, 512, "%s/ldgm_matrix-%u-%u-%u-%u.bin", path, k, m, c, seed);
                if(!file_exists(filename)) {
                        int ret = generate_ldgm_matrix(filename, k, m, c, seed);
                        if(ret != 0) {
                                fprintf(stderr, "[LDGM] Unable to initialize LDGM matrix.\n");
                                throw 1;
                        }
                }

                coding_session.set_pcMatrix(filename);
        }

        void decode(const char *frame, int size, char **out, int *out_size, struct linked_list *ll) {
                char *decoded;

                decoded = coding_session.decode_frame((char *) frame, size, out_size, ll_to_map(ll));

                *out = decoded;
        }

        void decode(const char *frame, int size, char **out, int *out_size, const map<int, int> &packets) {
                char *decoded;

                decoded = coding_session.decode_frame((char *) frame, size, out_size, packets);

                *out = decoded;
        }

        virtual ~ldgm_state_decoder() {
        }

        private:
        LDGM_session_cpu coding_session;
        char *buffer;
};


//////////////////////////////////
// ENCODER
//////////////////////////////////
static void usage() {
        printf("LDGM usage:\n"
                        "\t-f ldgm:<expected_loss>%% | ldgm[:<k>:<m>[:c]]\n"
                        "\n"
                        "\t\t<expected_loss> - expected maximal loss in percent (including '%%'-sign)\n\n"
                        "\t\t<k> - matrix width\n"
                        "\t\t<m> - matrix height\n"
                        "\t\t<c> - number of ones per column\n"
                        "\t\t\tthe bigger ratio m/k, the better correction (but also needed bandwidth)\n"
                        "\t\t\tk,m should be in interval [%d, %d]; c in [%d, %d]\n"
                        "\t\t\tdefault: k = %d, m = %d, c = %d\n"
                        "\n",
                        MINIMAL_VALUE, MAX_K,
                        MIN_C, MAX_C,
                        DEFAULT_K, DEFAULT_M, DEFAULT_C
                        );
}
void *ldgm_encoder_init_with_cfg(char *cfg)
{
        unsigned int k = DEFAULT_K,
                     m = DEFAULT_M,
                     c = DEFAULT_C;

        struct ldgm_state_encoder *s = NULL;

        if(cfg && strlen(cfg) > 0) {
                if(strcasecmp(cfg, "help") == 0) {
                        usage();
                        return NULL;
                }
                char *save_ptr = NULL;
                char *item;
                item = strtok_r(cfg, ":", &save_ptr);
                if(item) {
                        k = atoi(item);
                }
                item = strtok_r(NULL, ":", &save_ptr);
                if(item) {
                        m = atoi(item);
                        item = strtok_r(NULL, ":", &save_ptr);
                        if(item) {
                                c = atoi(item);
                        }
                } else {
                        fprintf(stderr, "[LDGM] Was set k value but not m.\n");
                        return NULL;
                }
        }

        if(c < MIN_C || c > MAX_C) {
                fprintf(stderr, "[LDGM] C value shoud be inside interval [%d, %d].\n", MIN_C, MAX_C);
                return NULL;
        }

        if(k > MAX_K) {
                fprintf(stderr, "[LDGM] K value exceeds maximal value %d.\n", MAX_K);
                return NULL;
        }

        if(k < MINIMAL_VALUE || m < MINIMAL_VALUE) {
                fprintf(stderr, "[LDGM] Either k or m is lower than minimal value %d.\n", MINIMAL_VALUE);
                return NULL;
        }

        printf("[LDGM] Using values k = %u, m = %u, c = %u.\n", k, m, c);

        try {
                s = new ldgm_state_encoder(k, m, c);
        } catch(...) {
        }

        return (void *) s;
}

void *ldgm_encoder_init_with_param(int packet_size, int frame_size, double max_expected_loss)
{
        struct ldgm_state_encoder *s = NULL;
        packet_type_t packet_type;
        int nearest = INT_MAX;
        loss_t loss = -1.0;
        int k, m, c;

        assert(max_expected_loss >= 0.0 && max_expected_loss <= 100.0);

        if(frame_size < 2000000 && packet_size >= (STD1500 + JUMBO9000) / 2) {
                fprintf(stderr, "LDGM: with frames smaller than 2M you should use standard Ethernet frames.\n");
                return NULL;
        }

        if(packet_size < (STD1500 + JUMBO9000) / 2) {
                packet_type = STD1500;
        } else {
                packet_type = JUMBO9000;
        }

        for(int i = 1; i < sizeof(losses) / sizeof(loss_t); ++i) {
                if(max_expected_loss >= losses[i - 1] && max_expected_loss <= losses[i]) {
                        loss = losses[i];
                        break;
                }
        }

        if(loss == -1.0) {
                fprintf(stderr, "LDGM: Cannot provide predefined settings for correction of loss of %.2f%%.\n", max_expected_loss);
                fprintf(stderr, "LDGM: You have to try and set LDGM parameters manually. You can inform us if you need better protection.\n");
                return NULL;
        }

        printf("LDGM: Choosing maximal loss %2.2f percent.\n", loss);

        for(int i = 0; i < sizeof(suggested_configurations) / sizeof(configuration_t); ++i) {
                if(suggested_configurations[i].packet_type == packet_type &&
                                suggested_configurations[i].loss == loss) {
                        if(abs(suggested_configurations[i].frame_size - frame_size) < abs(nearest - frame_size)) {
                                nearest = suggested_configurations[i].frame_size;
                                k = suggested_configurations[i].k;
                                m = suggested_configurations[i].m;
                                c = suggested_configurations[i].c;
                        }
                }
        }

        if (nearest == INT_MAX) {
                // TODO: This is only temporal - because we miss JUMBO frame setting (uncompressed)
                // then there should be assertion, because first is picked packet size and loss
                // (table for any combination of loss and PS should be filled). At last, the nearest
                // frame size is found.
                fprintf(stderr, "LDGM: Could not find configuration matching your parameters.\n"
                                "Please, set LDGM parameter manually.");
                return NULL;
        }

        double difference_from_frame_size = abs(nearest - frame_size) / (double) frame_size;
        if(difference_from_frame_size > 0.2) {
                fprintf(stderr, "LDGM: Chosen frame size setting is %.2f percent %s than your frame size.\n",
                                difference_from_frame_size * 100.0, (nearest - frame_size > 0 ? "higher" : "lower"));
                fprintf(stderr, "LDGM: This is the most approching one to your values.\n");
                fprintf(stderr, "You may wish to set the parameters manually.\n");
        }

        if(difference_from_frame_size > 0.5) {
                return NULL;
        }

        try {
                fprintf(stderr, "%d %d %d %d\n", nearest, k, m, c);
                s = new ldgm_state_encoder(k, m, c);
        } catch(...) {
        }

        return (void *) s;
}

unsigned int ldgm_encoder_get_k(void *state)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;
        return s->get_k();
}

unsigned int ldgm_encoder_get_m(void *state)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;
        return s->get_m();
}

unsigned int ldgm_encoder_get_c(void *state)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;
        return s->get_c();
}

unsigned int ldgm_encoder_get_seed(void *state)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;
        return s->get_seed();
}

void ldgm_encoder_encode(void *state, const char *hdr, int hdr_len, const char *in, int in_len, char **out, int *len)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;
        char *output_buffer;

        output_buffer = s->encode(const_cast<char *>(hdr), hdr_len, const_cast<char *>(in), in_len, len);

        *out = output_buffer;
}

void ldgm_encoder_free_buffer(void *state, char *buffer)
{
        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;

        s->freeBuffer(buffer);
}

void ldgm_encoder_destroy(void *state)
{
        if(!state) {
                return;
        }

        struct ldgm_state_encoder *s = (struct ldgm_state_encoder *) state;

        delete s;
}


//////////////////////////////////
// DECODER
//////////////////////////////////
void * ldgm_decoder_init(unsigned int k, unsigned int m, unsigned int c, unsigned int seed) {
        struct ldgm_state_decoder *s = NULL;
       
        try {
                s = new ldgm_state_decoder(k, m, c, seed);
        } catch (...) {
        }

        return s;
}

void ldgm_decoder_decode(void *state, const char *in, int in_len, char **out, int *len, struct linked_list  *ll)
{
        struct ldgm_state_decoder *s = (struct ldgm_state_decoder *) state;

        s->decode(in, in_len, out, len, ll);
}

void ldgm_decoder_decode_map(void *state, const char *in, int in_len, char **out,
                int *len, const map<int, int> &packets)
{
        struct ldgm_state_decoder *s = (struct ldgm_state_decoder *) state;

        s->decode(in, in_len, out, len, packets);
}

void ldgm_decoder_destroy(void *state)
{
        if(!state) {
                return;
        }

        struct ldgm_state_decoder *s = (struct ldgm_state_decoder *) state;

        delete s;
}

