FFT cleanup
[opus.git] / libcelt / celt_header.h
1 /* Copyright (c) 2007 CSIRO
2    Copyright (c) 2007-2008 Xiph.Org Foundation
3    Written by Jean-Marc Valin */
4 /*
5    Redistribution and use in source and binary forms, with or without
6    modification, are permitted provided that the following conditions
7    are met:
8    
9    - Redistributions of source code must retain the above copyright
10    notice, this list of conditions and the following disclaimer.
11    
12    - Redistributions in binary form must reproduce the above copyright
13    notice, this list of conditions and the following disclaimer in the
14    documentation and/or other materials provided with the distribution.
15    
16    - Neither the name of the Xiph.org Foundation nor the names of its
17    contributors may be used to endorse or promote products derived from
18    this software without specific prior written permission.
19    
20    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31 */
32
33 #ifndef CELT_HEADER_H
34 #define CELT_HEADER_H
35
36 #ifdef __cplusplus
37 extern "C" {
38 #endif
39
40 #include "celt.h"
41 #include "celt_types.h"
42
43 /** Header data to be used for Ogg files (or possibly other encapsulation) 
44     @brief Header data 
45  */
46 typedef struct {
47    char         codec_id[8];       /**< MUST be "CELT    " (four spaces) */
48    char         codec_version[20]; /**< Version used (as string) */
49    celt_int32 version_id;        /**< Version id (negative for until stream is frozen) */
50    celt_int32 header_size;       /**< Size of this header */
51    celt_int32 sample_rate;       /**< Sampling rate of the original audio */
52    celt_int32 nb_channels;       /**< Number of channels */
53    celt_int32 frame_size;        /**< Samples per frame (per channel) */
54    celt_int32 overlap;           /**< Overlapping samples (per channel) */
55    celt_int32 bytes_per_packet;  /**< Number of bytes per compressed packet (0 if unknown) */
56    celt_int32 extra_headers;     /**< Number of additional headers that follow this header */
57 } CELTHeader;
58
59 /** Creates a basic header struct */
60 EXPORT int celt_header_init(CELTHeader *header, const CELTMode *m, int channels);
61
62 EXPORT int celt_header_to_packet(const CELTHeader *header, unsigned char *packet, celt_uint32 size);
63
64 EXPORT int celt_header_from_packet(const unsigned char *packet, celt_uint32 size, CELTHeader *header);
65
66 #ifdef __cplusplus
67 }
68 #endif
69
70 #endif /* CELT_HEADER_H */