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