SphinxBase 0.6

include/sphinxbase/huff_code.h

Go to the documentation of this file.
00001 /* -*- c-basic-offset: 4; indent-tabs-mode: nil -*- */
00002 /* ====================================================================
00003  * Copyright (c) 2009 Carnegie Mellon University.  All rights
00004  * reserved.
00005  *
00006  * Redistribution and use in source and binary forms, with or without
00007  * modification, are permitted provided that the following conditions
00008  * are met:
00009  *
00010  * 1. Redistributions of source code must retain the above copyright
00011  *    notice, this list of conditions and the following disclaimer. 
00012  *
00013  * 2. Redistributions in binary form must reproduce the above copyright
00014  *    notice, this list of conditions and the following disclaimer in
00015  *    the documentation and/or other materials provided with the
00016  *    distribution.
00017  *
00018  * This work was supported in part by funding from the Defense Advanced 
00019  * Research Projects Agency and the National Science Foundation of the 
00020  * United States of America, and the CMU Sphinx Speech Consortium.
00021  *
00022  * THIS SOFTWARE IS PROVIDED BY CARNEGIE MELLON UNIVERSITY ``AS IS'' AND 
00023  * ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, 
00024  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
00025  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY
00026  * NOR ITS EMPLOYEES BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00027  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 
00028  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 
00029  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 
00030  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 
00031  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
00032  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
00033  *
00034  * ====================================================================
00035  *
00036  */
00037 
00048 #ifndef __HUFF_CODE_H__
00049 #define __HUFF_CODE_H__
00050 
00051 #include <stdio.h>
00052 
00053 #include <sphinxbase/sphinxbase_export.h>
00054 #include <sphinxbase/prim_type.h>
00055 #include <sphinxbase/cmd_ln.h>
00056 
00057 typedef struct huff_code_s huff_code_t;
00058 
00062 SPHINXBASE_EXPORT
00063 huff_code_t *huff_code_build_int(int32 const *values, int32 const *frequencies, int nvals);
00064 
00068 SPHINXBASE_EXPORT
00069 huff_code_t *huff_code_build_str(char * const *values, int32 const *frequencies, int nvals);
00070 
00074 SPHINXBASE_EXPORT
00075 huff_code_t *huff_code_read(FILE *infh);
00076 
00080 SPHINXBASE_EXPORT
00081 int huff_code_write(huff_code_t *hc, FILE *outfh);
00082 
00086 SPHINXBASE_EXPORT
00087 int huff_code_dump(huff_code_t *hc, FILE *dumpfh);
00088 
00092 SPHINXBASE_EXPORT
00093 huff_code_t *huff_code_retain(huff_code_t *hc);
00094 
00098 SPHINXBASE_EXPORT
00099 int huff_code_free(huff_code_t *hc);
00100 
00104 SPHINXBASE_EXPORT
00105 FILE *huff_code_attach(huff_code_t *hc, FILE *fh, char const *mode);
00106 
00110 SPHINXBASE_EXPORT
00111 FILE *huff_code_detach(huff_code_t *hc);
00112 
00116 SPHINXBASE_EXPORT
00117 int huff_code_encode_int(huff_code_t *hc, int32 sym, uint32 *outcw);
00118 
00122 SPHINXBASE_EXPORT
00123 int huff_code_encode_str(huff_code_t *hc, char const *sym, uint32 *outcw);
00124 
00128 SPHINXBASE_EXPORT
00129 int huff_code_decode_int(huff_code_t *hc, int *outval,
00130                          char const **inout_data,
00131                          size_t *inout_data_len,
00132                          int *inout_offset);
00133 
00137 SPHINXBASE_EXPORT
00138 char const *huff_code_decode_str(huff_code_t *hc,
00139                                  char const **inout_data,
00140                                  size_t *inout_data_len,
00141                                  int *inout_offset);
00142 
00143 #endif /* __HUFF_CODE_H__ */