midware/stb/inc/stblzenc.h

Go to the documentation of this file.

/*******************************************************************************
 * Copyright © 2014 The DTVKit Open Software Foundation Ltd (www.dtvkit.org)
 * Copyright © 2004 Ocean Blue Software Ltd
 *
 * This file is part of a DTVKit Software Component
 * You are permitted to copy, modify or distribute this file subject to the terms
 * of the DTVKit 1.0 Licence which can be found in licence.txt or at www.dtvkit.org
 * 
 * THIS CODE AND INFORMATION ARE PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND,
 * EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR PURPOSE.
 * 
 * If you or your organisation is not a member of DTVKit then you have access
 * to this source code outside of the terms of the licence agreement
 * and you are expected to delete this and any associated files immediately.
 * Further information on DTVKit, membership and terms can be found at www.dtvkit.org
 *******************************************************************************/
#ifndef _STBLZENC_H

#define _STBLZENC_H

//---Constant and macro definitions for public use-----------------------------

//---Enumerations for public use-----------------------------------------------

typedef enum e_stbencode
{
   STBENCODE_SUCCESS = 0,
   STBENCODE_BADPARAM,
   STBENCODE_BADSOURCE,
   STBENCODE_USERBREAK,
   STBENCODE_NOMEMORY,
   STBENCODE_OVERFLOW,
   STBENCODE_BUSY
}
E_STBENCODE;

typedef enum e_stbencode_callback_type
{
   STBENCODE_CALLBACK_TYPE_REQUEST_GETMEMORY,
   STBENCODE_CALLBACK_TYPE_REQUEST_FREEMEMORY,
   STBENCODE_CALLBACK_TYPE_REQUEST_SOURCE,
   STBENCODE_CALLBACK_TYPE_NOTIFY_RESULT,
   STBENCODE_CALLBACK_TYPE_NOTIFY_KICK_WATCHDOG,
   STBENCODE_CALLBACK_TYPE_IDLE
}
E_STBENCODE_CALLBACK_TYPE;

//---Global type defs for public use-------------------------------------------

typedef struct s_stbencode_request_memory
{
   void *ptr;
   U32BIT size;
}
S_STBENCODE_REQUEST_MEMORY;

typedef struct s_stbencode_request_source
{
   void *ptr;
   U32BIT num_bytes;
   U32BIT max_num_bytes;

   U32BIT total_offset;
   U32BIT total_size;
}
S_STBENCODE_REQUEST_SOURCE;

typedef struct s_stbencode_notify_result
{
   void *ptr;
   U32BIT num_bytes;

   U32BIT total_offset;
   U32BIT max_total_size;
}
S_STBENCODE_NOTIFY_RESULT;

//---Global Function prototypes for public use---------------------------------

E_STBENCODE STB_LZEncode(U32BIT source_length, U32BIT required_dest_packet_size,
                         BOOLEAN (*callback_function)(E_STBENCODE_CALLBACK_TYPE, void *),
                         BOOLEAN watchdog_kick_required, BOOLEAN is_top_bit_cleared,
                         BOOLEAN is_header_required);


#endif //  _STBLZENC_H

//*****************************************************************************
// End of file
//*****************************************************************************