/*
   Copyright (C) 2009 Red Hat, Inc.

   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, see <http://www.gnu.org/licenses/>.
*/

#ifndef _H_GLZ_ENCODER
#define _H_GLZ_ENCODER

/* Manging the lz encoding using a dictionary that is shared among encoders */

#include <stdint.h>
#include "lz_common.h"
#include "glz_encoder_dictionary.h"
#include "glz_encoder_config.h"

typedef void GlzEncoderContext;

GlzEncoderContext *glz_encoder_create(uint8_t id, GlzEncDictContext *dictionary,
                                      GlzEncoderUsrContext *usr);

void glz_encoder_destroy(GlzEncoderContext *opaque_encoder);

/*
        assumes width is in pixels and stride is in bytes
    usr_context       : when an image is released from the window due to capicity overflow,
                        usr_context is given as a parmater to the free_image callback.
    o_enc_dict_context: if glz_enc_dictionary_remove_image is called, it should be
                        called with the o_enc_dict_context that is associated with
                        the image.

        return: the number of bytes in the compressed data and sets o_enc_dict_context

        NOTE  :	currently supports only rgb images in which width*bytes_per_pixel = stride OR
                palette images in which stride eqauls the min number of bytes to hold a line.
                The stride should be > 0
*/
int glz_encode(GlzEncoderContext *opaque_encoder, LzImageType type, int width, int height,
               int top_down, uint8_t *lines, unsigned int num_lines, int stride,
               uint8_t *io_ptr, unsigned int num_io_bytes, GlzUsrImageContext *usr_context,
               GlzEncDictImageContext **o_enc_dict_context);


#endif // _H_GLZ_ENCODER