Fixes a crash on destroy with the pull API
[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      - if (mapping != a projection family)
50        - C times channel origin
51           - if (C<2*M)
52              - stream = byte/2
53              - if (byte&0x1 == 0)
54                  - left
55                else
56                  - right
57           - else
58              - stream = byte-M
59     - else
60        - D demixing matrix (C*(N+M)*16 bits)
61 */
62
63 typedef struct {
64    unsigned char *data;
65    int maxlen;
66    int pos;
67 } Packet;
68
69 typedef struct {
70    const unsigned char *data;
71    int maxlen;
72    int pos;
73 } ROPacket;
74
75 static int write_uint32(Packet *p, opus_uint32 val)
76 {
77    if (p->pos>p->maxlen-4)
78       return 0;
79    p->data[p->pos  ] = (val    ) & 0xFF;
80    p->data[p->pos+1] = (val>> 8) & 0xFF;
81    p->data[p->pos+2] = (val>>16) & 0xFF;
82    p->data[p->pos+3] = (val>>24) & 0xFF;
83    p->pos += 4;
84    return 1;
85 }
86
87 static int write_uint16(Packet *p, opus_uint16 val)
88 {
89    if (p->pos>p->maxlen-2)
90       return 0;
91    p->data[p->pos  ] = (val    ) & 0xFF;
92    p->data[p->pos+1] = (val>> 8) & 0xFF;
93    p->pos += 2;
94    return 1;
95 }
96
97 static int write_chars(Packet *p, const unsigned char *str, int nb_chars)
98 {
99    int i;
100    if (p->pos>p->maxlen-nb_chars)
101       return 0;
102    for (i=0;i<nb_chars;i++)
103       p->data[p->pos++] = str[i];
104    return 1;
105 }
106
107 static int write_matrix_chars(Packet *p, const OpusGenericEncoder *st)
108 {
109 #ifdef OPUS_HAVE_OPUS_PROJECTION_H
110   opus_int32 size;
111   int ret;
112   ret=opeint_encoder_ctl(st, OPUS_PROJECTION_GET_DEMIXING_MATRIX_SIZE(&size));
113   if (ret != OPUS_OK) return 0;
114   if (size>p->maxlen-p->pos) return 0;
115   ret=opeint_encoder_ctl(st, OPUS_PROJECTION_GET_DEMIXING_MATRIX(&p->data[p->pos], size));
116   if (ret != OPUS_OK) return 0;
117   p->pos += size;
118   return 1;
119 #else
120   (void)p;
121   (void)st;
122   return 0;
123 #endif
124 }
125
126 int _ope_opus_header_get_size(const OpusHeader *h)
127 {
128   int len=0;
129   if (opeint_use_projection(h->channel_mapping))
130   {
131     /* 19 bytes from fixed header,
132      * 2 bytes for nb_streams & nb_coupled,
133      * 2 bytes per cell of demixing matrix, where:
134      *    rows=channels, cols=nb_streams+nb_coupled
135      */
136     len=21+(h->channels*(h->nb_streams+h->nb_coupled)*2);
137   }
138   else
139   {
140     /* 19 bytes from fixed header,
141      * 2 bytes for nb_streams & nb_coupled,
142      * 1 byte per channel
143      */
144     len=21+h->channels;
145   }
146   return len;
147 }
148
149 int _ope_opus_header_to_packet(const OpusHeader *h, unsigned char *packet, int len, const OpusGenericEncoder *st)
150 {
151    int i;
152    Packet p;
153    unsigned char ch;
154
155    p.data = packet;
156    p.maxlen = len;
157    p.pos = 0;
158    if (len<19)return 0;
159    if (!write_chars(&p, (const unsigned char*)"OpusHead", 8))
160       return 0;
161    /* Version is 1 */
162    ch = 1;
163    if (!write_chars(&p, &ch, 1))
164       return 0;
165
166    ch = h->channels;
167    if (!write_chars(&p, &ch, 1))
168       return 0;
169
170    if (!write_uint16(&p, h->preskip))
171       return 0;
172
173    if (!write_uint32(&p, h->input_sample_rate))
174       return 0;
175
176    if (opeint_use_projection(h->channel_mapping))
177    {
178 #ifdef OPUS_HAVE_OPUS_PROJECTION_H
179       opus_int32 matrix_gain;
180       int ret;
181       ret=opeint_encoder_ctl(st, OPUS_PROJECTION_GET_DEMIXING_MATRIX_GAIN(&matrix_gain));
182       if (ret != OPUS_OK) return 0;
183       if (!write_uint16(&p, h->gain + matrix_gain))
184          return 0;
185 #else
186       return 0;
187 #endif
188    }
189    else
190    {
191       if (!write_uint16(&p, h->gain))
192          return 0;
193    }
194
195    ch = h->channel_mapping;
196    if (!write_chars(&p, &ch, 1))
197       return 0;
198
199    if (h->channel_mapping != 0)
200    {
201       ch = h->nb_streams;
202       if (!write_chars(&p, &ch, 1))
203          return 0;
204
205       ch = h->nb_coupled;
206       if (!write_chars(&p, &ch, 1))
207          return 0;
208
209       /* Multi-stream support */
210       if (opeint_use_projection(h->channel_mapping))
211       {
212         if (!write_matrix_chars(&p, st))
213            return 0;
214       }
215       else
216       {
217         for (i=0;i<h->channels;i++)
218         {
219           if (!write_chars(&p, &h->stream_map[i], 1))
220              return 0;
221         }
222       }
223    }
224
225    return p.pos;
226 }
227
228 /*
229  Comments will be stored in the Vorbis style.
230  It is described in the "Structure" section of
231     http://www.xiph.org/ogg/vorbis/doc/v-comment.html
232
233  However, Opus and other non-vorbis formats omit the "framing_bit".
234
235 The comment header is decoded as follows:
236   1) [vendor_length] = read an unsigned integer of 32 bits
237   2) [vendor_string] = read a UTF-8 vector as [vendor_length] octets
238   3) [user_comment_list_length] = read an unsigned integer of 32 bits
239   4) iterate [user_comment_list_length] times {
240      5) [length] = read an unsigned integer of 32 bits
241      6) this iteration's user comment = read a UTF-8 vector as [length] octets
242      }
243   7) done.
244 */
245
246 #define readint(buf, base) (((buf[base+3]<<24)&0xff000000)| \
247                            ((buf[base+2]<<16)&0xff0000)| \
248                            ((buf[base+1]<<8)&0xff00)| \
249                            (buf[base]&0xff))
250 #define writeint(buf, base, val) do{ buf[base+3]=((val)>>24)&0xff; \
251                                      buf[base+2]=((val)>>16)&0xff; \
252                                      buf[base+1]=((val)>>8)&0xff; \
253                                      buf[base]=(val)&0xff; \
254                                  }while(0)
255
256 void _ope_comment_init(char **comments, int* length, const char *vendor_string)
257 {
258   /*The 'vendor' field should be the actual encoding library used.*/
259   int vendor_length=strlen(vendor_string);
260   int user_comment_list_length=0;
261   int len=8+4+vendor_length+4;
262   char *p=(char*)malloc(len);
263   if (p == NULL) {
264     len=0;
265   } else {
266     memcpy(p, "OpusTags", 8);
267     writeint(p, 8, vendor_length);
268     memcpy(p+12, vendor_string, vendor_length);
269     writeint(p, 12+vendor_length, user_comment_list_length);
270   }
271   *length=len;
272   *comments=p;
273 }
274
275 int _ope_comment_add(char **comments, int* length, const char *tag, const char *val)
276 {
277   char* p=*comments;
278   int vendor_length=readint(p, 8);
279   int user_comment_list_length=readint(p, 8+4+vendor_length);
280   int tag_len=(tag?strlen(tag)+1:0);
281   int val_len=strlen(val);
282   int len=(*length)+4+tag_len+val_len;
283
284   p=(char*)realloc(p, len);
285   if (p == NULL) return 1;
286
287   writeint(p, *length, tag_len+val_len);      /* length of comment */
288   if(tag){
289     memcpy(p+*length+4, tag, tag_len);        /* comment tag */
290     (p+*length+4)[tag_len-1] = '=';           /* separator */
291   }
292   memcpy(p+*length+4+tag_len, val, val_len);  /* comment */
293   writeint(p, 8+4+vendor_length, user_comment_list_length+1);
294   *comments=p;
295   *length=len;
296   return 0;
297 }
298
299 void _ope_comment_pad(char **comments, int* length, int amount)
300 {
301   if(amount>0){
302     int i;
303     int newlen;
304     char* p=*comments;
305     /*Make sure there is at least amount worth of padding free, and
306        round up to the maximum that fits in the current ogg segments.*/
307     newlen=(*length+amount+255)/255*255-1;
308     p=realloc(p,newlen);
309     if (p == NULL) return;
310     for(i=*length;i<newlen;i++)p[i]=0;
311     *comments=p;
312     *length=newlen;
313   }
314 }
315
316 #undef readint
317 #undef writeint
318