xref: /third_party/ffmpeg/libavcodec/mlz.h (revision cabdff1a)
1cabdff1aSopenharmony_ci/*
2cabdff1aSopenharmony_ci * Copyright (c) 2016 Umair Khan <omerjerk@gmail.com>
3cabdff1aSopenharmony_ci *
4cabdff1aSopenharmony_ci * This file is part of FFmpeg.
5cabdff1aSopenharmony_ci *
6cabdff1aSopenharmony_ci * FFmpeg is free software; you can redistribute it and/or
7cabdff1aSopenharmony_ci * modify it under the terms of the GNU Lesser General Public
8cabdff1aSopenharmony_ci * License as published by the Free Software Foundation; either
9cabdff1aSopenharmony_ci * version 2.1 of the License, or (at your option) any later version.
10cabdff1aSopenharmony_ci *
11cabdff1aSopenharmony_ci * FFmpeg is distributed in the hope that it will be useful,
12cabdff1aSopenharmony_ci * but WITHOUT ANY WARRANTY; without even the implied warranty of
13cabdff1aSopenharmony_ci * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
14cabdff1aSopenharmony_ci * Lesser General Public License for more details.
15cabdff1aSopenharmony_ci *
16cabdff1aSopenharmony_ci * You should have received a copy of the GNU Lesser General Public
17cabdff1aSopenharmony_ci * License along with FFmpeg; if not, write to the Free Software
18cabdff1aSopenharmony_ci * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
19cabdff1aSopenharmony_ci */
20cabdff1aSopenharmony_ci
21cabdff1aSopenharmony_ci#ifndef AVCODEC_MLZ_H
22cabdff1aSopenharmony_ci#define AVCODEC_MLZ_H
23cabdff1aSopenharmony_ci
24cabdff1aSopenharmony_ci#include "get_bits.h"
25cabdff1aSopenharmony_ci
26cabdff1aSopenharmony_ci#define CODE_UNSET          -1
27cabdff1aSopenharmony_ci#define CODE_BIT_INIT       9
28cabdff1aSopenharmony_ci#define DIC_INDEX_INIT      512     // 2^9
29cabdff1aSopenharmony_ci#define DIC_INDEX_MAX       32768   // 2^15
30cabdff1aSopenharmony_ci#define FLUSH_CODE          256
31cabdff1aSopenharmony_ci#define FREEZE_CODE         257
32cabdff1aSopenharmony_ci#define FIRST_CODE          258
33cabdff1aSopenharmony_ci#define MAX_CODE            32767
34cabdff1aSopenharmony_ci#define TABLE_SIZE          35023   // TABLE_SIZE must be a prime number
35cabdff1aSopenharmony_ci
36cabdff1aSopenharmony_ci/** Dictionary structure for mlz decompression
37cabdff1aSopenharmony_ci */
38cabdff1aSopenharmony_citypedef struct MLZDict {
39cabdff1aSopenharmony_ci    int  string_code;
40cabdff1aSopenharmony_ci    int  parent_code;
41cabdff1aSopenharmony_ci    int  char_code;
42cabdff1aSopenharmony_ci    int  match_len;
43cabdff1aSopenharmony_ci} MLZDict;
44cabdff1aSopenharmony_ci
45cabdff1aSopenharmony_ci/** MLZ data strucure
46cabdff1aSopenharmony_ci */
47cabdff1aSopenharmony_citypedef struct MLZ {
48cabdff1aSopenharmony_ci    int dic_code_bit;
49cabdff1aSopenharmony_ci    int current_dic_index_max;
50cabdff1aSopenharmony_ci    unsigned int bump_code;
51cabdff1aSopenharmony_ci    unsigned int flush_code;
52cabdff1aSopenharmony_ci    int next_code;
53cabdff1aSopenharmony_ci    int freeze_flag;
54cabdff1aSopenharmony_ci    MLZDict* dict;
55cabdff1aSopenharmony_ci    void* context;
56cabdff1aSopenharmony_ci} MLZ;
57cabdff1aSopenharmony_ci
58cabdff1aSopenharmony_ci/** Initialize the dictionary
59cabdff1aSopenharmony_ci */
60cabdff1aSopenharmony_ciint ff_mlz_init_dict(void *context, MLZ *mlz);
61cabdff1aSopenharmony_ci
62cabdff1aSopenharmony_ci/** Flush the dictionary
63cabdff1aSopenharmony_ci */
64cabdff1aSopenharmony_civoid ff_mlz_flush_dict(MLZ *dict);
65cabdff1aSopenharmony_ci
66cabdff1aSopenharmony_ci/** Run mlz decompression on the next size bits and the output will be stored in buff
67cabdff1aSopenharmony_ci */
68cabdff1aSopenharmony_ciint ff_mlz_decompression(MLZ* mlz, GetBitContext* gb, int size, unsigned char *buff);
69cabdff1aSopenharmony_ci
70cabdff1aSopenharmony_ci#endif /*AVCODEC_MLZ_H*/
71