Remove wav_permute_matrix[][]
[libopusenc.git] / src / opus_header.c
1 /* Copyright (C)2012 Xiph.Org Foundation
2    File: opus_header.c
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    THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
16    ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
17    LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
18    A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
19    CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
20    EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
21    PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
22    PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
23    LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
24    NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25    SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
31
32 #include "opus_header.h"
33 #include <string.h>
34 #include <stdio.h>
35
36 /* Header contents:
37   - "OpusHead" (64 bits)
38   - version number (8 bits)
39   - Channels C (8 bits)
40   - Pre-skip (16 bits)
41   - Sampling rate (32 bits)
42   - Gain in dB (16 bits, S7.8)
43   - Mapping (8 bits, 0=single stream (mono/stereo) 1=Vorbis mapping,
44              2..254: reserved, 255: multistream with no mapping)
45
46   - if (mapping != 0)
47      - N = total number of streams (8 bits)
48      - M = number of paired streams (8 bits)
49      - C times channel origin
50           - if (C<2*M)
51              - stream = byte/2
52              - if (byte&0x1 == 0)
53                  - left
54                else
55                  - right
56           - else
57              - stream = byte-M
58 */
59
60 typedef struct {
61    unsigned char *data;
62    int maxlen;
63    int pos;
64 } Packet;
65
66 typedef struct {
67    const unsigned char *data;
68    int maxlen;
69    int pos;
70 } ROPacket;
71
72 static int write_uint32(Packet *p, opus_uint32 val)
73 {
74    if (p->pos>p->maxlen-4)
75       return 0;
76    p->data[p->pos  ] = (val    ) & 0xFF;
77    p->data[p->pos+1] = (val>> 8) & 0xFF;
78    p->data[p->pos+2] = (val>>16) & 0xFF;
79    p->data[p->pos+3] = (val>>24) & 0xFF;
80    p->pos += 4;
81    return 1;
82 }
83
84 static int write_uint16(Packet *p, opus_uint16 val)
85 {
86    if (p->pos>p->maxlen-2)
87       return 0;
88    p->data[p->pos  ] = (val    ) & 0xFF;
89    p->data[p->pos+1] = (val>> 8) & 0xFF;
90    p->pos += 2;
91    return 1;
92 }
93
94 static int write_chars(Packet *p, const unsigned char *str, int nb_chars)
95 {
96    int i;
97    if (p->pos>p->maxlen-nb_chars)
98       return 0;
99    for (i=0;i<nb_chars;i++)
100       p->data[p->pos++] = str[i];
101    return 1;
102 }
103
104 int opus_header_to_packet(const OpusHeader *h, unsigned char *packet, int len)
105 {
106    int i;
107    Packet p;
108    unsigned char ch;
109
110    p.data = packet;
111    p.maxlen = len;
112    p.pos = 0;
113    if (len<19)return 0;
114    if (!write_chars(&p, (const unsigned char*)"OpusHead", 8))
115       return 0;
116    /* Version is 1 */
117    ch = 1;
118    if (!write_chars(&p, &ch, 1))
119       return 0;
120
121    ch = h->channels;
122    if (!write_chars(&p, &ch, 1))
123       return 0;
124
125    if (!write_uint16(&p, h->preskip))
126       return 0;
127
128    if (!write_uint32(&p, h->input_sample_rate))
129       return 0;
130
131    if (!write_uint16(&p, h->gain))
132       return 0;
133
134    ch = h->channel_mapping;
135    if (!write_chars(&p, &ch, 1))
136       return 0;
137
138    if (h->channel_mapping != 0)
139    {
140       ch = h->nb_streams;
141       if (!write_chars(&p, &ch, 1))
142          return 0;
143
144       ch = h->nb_coupled;
145       if (!write_chars(&p, &ch, 1))
146          return 0;
147
148       /* Multi-stream support */
149       for (i=0;i<h->channels;i++)
150       {
151          if (!write_chars(&p, &h->stream_map[i], 1))
152             return 0;
153       }
154    }
155
156    return p.pos;
157 }
158
159 /*
160  Comments will be stored in the Vorbis style.
161  It is described in the "Structure" section of
162     http://www.xiph.org/ogg/vorbis/doc/v-comment.html
163
164  However, Opus and other non-vorbis formats omit the "framing_bit".
165
166 The comment header is decoded as follows:
167   1) [vendor_length] = read an unsigned integer of 32 bits
168   2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
169   3) [user_comment_list_length] = read an unsigned integer of 32 bits
170   4) iterate [user_comment_list_length] times {
171      5) [length] = read an unsigned integer of 32 bits
172      6) this iteration's user comment = read a UTF-8 vector as [length] octets
173      }
174   7) done.
175 */
176
177 #define readint(buf, base) (((buf[base+3]<<24)&0xff000000)| \
178                            ((buf[base+2]<<16)&0xff0000)| \
179                            ((buf[base+1]<<8)&0xff00)| \
180                            (buf[base]&0xff))
181 #define writeint(buf, base, val) do{ buf[base+3]=((val)>>24)&0xff; \
182                                      buf[base+2]=((val)>>16)&0xff; \
183                                      buf[base+1]=((val)>>8)&0xff; \
184                                      buf[base]=(val)&0xff; \
185                                  }while(0)
186
187 void comment_init(char **comments, int* length, const char *vendor_string)
188 {
189   /*The 'vendor' field should be the actual encoding library used.*/
190   int vendor_length=strlen(vendor_string);
191   int user_comment_list_length=0;
192   int len=8+4+vendor_length+4;
193   char *p=(char*)malloc(len);
194   if (p == NULL) return;
195   memcpy(p, "OpusTags", 8);
196   writeint(p, 8, vendor_length);
197   memcpy(p+12, vendor_string, vendor_length);
198   writeint(p, 12+vendor_length, user_comment_list_length);
199   *length=len;
200   *comments=p;
201 }
202
203 int comment_add(char **comments, int* length, const char *tag, const char *val)
204 {
205   char* p=*comments;
206   int vendor_length=readint(p, 8);
207   int user_comment_list_length=readint(p, 8+4+vendor_length);
208   int tag_len=(tag?strlen(tag)+1:0);
209   int val_len=strlen(val);
210   int len=(*length)+4+tag_len+val_len;
211
212   p=(char*)realloc(p, len);
213   if (p == NULL) return 1;
214
215   writeint(p, *length, tag_len+val_len);      /* length of comment */
216   if(tag){
217     memcpy(p+*length+4, tag, tag_len);        /* comment tag */
218     (p+*length+4)[tag_len-1] = '=';           /* separator */
219   }
220   memcpy(p+*length+4+tag_len, val, val_len);  /* comment */
221   writeint(p, 8+4+vendor_length, user_comment_list_length+1);
222   *comments=p;
223   *length=len;
224   return 0;
225 }
226
227 void comment_pad(char **comments, int* length, int amount)
228 {
229   if(amount>0){
230     int i;
231     int newlen;
232     char* p=*comments;
233     /*Make sure there is at least amount worth of padding free, and
234        round up to the maximum that fits in the current ogg segments.*/
235     newlen=(*length+amount+255)/255*255-1;
236     p=realloc(p,newlen);
237     if (p == NULL) return;
238     for(i=*length;i<newlen;i++)p[i]=0;
239     *comments=p;
240     *length=newlen;
241   }
242 }
243
244 int comment_replace_vendor_string(char **comments, int* length, const char *vendor_string)
245 {
246   char* p=*comments;
247   int vendor_length;
248   int newlen;
249   int newvendor_length;
250   vendor_length=readint(p, 8);
251   newvendor_length=strlen(vendor_string);
252   newlen=*length+newvendor_length-vendor_length;
253   p=realloc(p, newlen);
254   if (p == NULL) return 1;
255   writeint(p, 8, newvendor_length);
256   memmove(p+12+newvendor_length, p+12+vendor_length, newlen-12-newvendor_length);
257   memcpy(p+12, vendor_string, newvendor_length);
258   *comments=p;
259   *length=newlen;
260   return 0;
261 }
262 #undef readint
263 #undef writeint
264