summaryrefslogtreecommitdiff
path: root/cesar/ce/rx/bitloading/inc/initial.h
blob: 05802894e5236daca3716d511d69b0fad7d48bb3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
#ifndef ce_rx_bitloading_inc_initial_h
#define ce_rx_bitloading_inc_initial_h
/* Cesar project {{{
 *
 * Copyright (C) 2009 Spidcom
 *
 * <<<Licence>>>
 *
 * }}} */
/**
 * \file    ce/rx/bitloading/inc/initial.h
 * \brief   Bit Loading initial functions generation.
 * \ingroup ce_rx
 *
 * This file contains the functions to generate the tone map initial for the
 * bit loading initial.
 */

#include "ce/rx/bitloading/bitloading.h"
#include "mac/common/tonemask.h"

BEGIN_DECLS

/**
 * Generate an initial tone map.
 * \param  tonemask  the tone mask context.
 * \param  bl  the bit loading context.
 * \return  the optimized tone map (iterative version) or NULL when the
 * computation is impossible.
 *
 * This function generates a tone map with only one iteration of the bit
 * loading algorithm.
 */
tonemap_t *
ce_rx_bl_initial (tonemask_info_t *tonemask, ce_rx_bitloading_t *bl);

END_DECLS

#endif /* ce_rx_bitloading_inc_initial_h */