Adds functions for multistream padding/unpadding and single-stream unpadding
[opus.git] / src / repacketizer.c
1 /* Copyright (c) 2011 Xiph.Org Foundation
2    Written by Jean-Marc Valin */
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 COPYRIGHT OWNER
19    OR 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.h"
33 #include "opus_private.h"
34 #include "os_support.h"
35
36
37 int opus_repacketizer_get_size(void)
38 {
39    return sizeof(OpusRepacketizer);
40 }
41
42 OpusRepacketizer *opus_repacketizer_init(OpusRepacketizer *rp)
43 {
44    rp->nb_frames = 0;
45    return rp;
46 }
47
48 OpusRepacketizer *opus_repacketizer_create(void)
49 {
50    OpusRepacketizer *rp;
51    rp=(OpusRepacketizer *)opus_alloc(opus_repacketizer_get_size());
52    if(rp==NULL)return NULL;
53    return opus_repacketizer_init(rp);
54 }
55
56 void opus_repacketizer_destroy(OpusRepacketizer *rp)
57 {
58    opus_free(rp);
59 }
60
61 int opus_repacketizer_cat(OpusRepacketizer *rp, const unsigned char *data, opus_int32 len)
62 {
63    unsigned char tmp_toc;
64    int curr_nb_frames,ret;
65    /* Set of check ToC */
66    if (len<1) return OPUS_INVALID_PACKET;
67    if (rp->nb_frames == 0)
68    {
69       rp->toc = data[0];
70       rp->framesize = opus_packet_get_samples_per_frame(data, 8000);
71    } else if ((rp->toc&0xFC) != (data[0]&0xFC))
72    {
73       /*fprintf(stderr, "toc mismatch: 0x%x vs 0x%x\n", rp->toc, data[0]);*/
74       return OPUS_INVALID_PACKET;
75    }
76    curr_nb_frames = opus_packet_get_nb_frames(data, len);
77    if(curr_nb_frames<1) return OPUS_INVALID_PACKET;
78
79    /* Check the 120 ms maximum packet size */
80    if ((curr_nb_frames+rp->nb_frames)*rp->framesize > 960)
81    {
82       return OPUS_INVALID_PACKET;
83    }
84
85    ret=opus_packet_parse(data, len, &tmp_toc, &rp->frames[rp->nb_frames], &rp->len[rp->nb_frames], NULL);
86    if(ret<1)return ret;
87
88    rp->nb_frames += curr_nb_frames;
89    return OPUS_OK;
90 }
91
92 int opus_repacketizer_get_nb_frames(OpusRepacketizer *rp)
93 {
94    return rp->nb_frames;
95 }
96
97 opus_int32 opus_repacketizer_out_range_impl(OpusRepacketizer *rp, int begin, int end,
98       unsigned char *data, opus_int32 maxlen, int self_delimited, int pad)
99 {
100    int i, count;
101    opus_int32 tot_size;
102    opus_int16 *len;
103    const unsigned char **frames;
104    unsigned char * ptr;
105
106    if (begin<0 || begin>=end || end>rp->nb_frames)
107    {
108       /*fprintf(stderr, "%d %d %d\n", begin, end, rp->nb_frames);*/
109       return OPUS_BAD_ARG;
110    }
111    count = end-begin;
112
113    len = rp->len+begin;
114    frames = rp->frames+begin;
115    if (self_delimited)
116       tot_size = 1 + (len[count-1]>=252);
117    else
118       tot_size = 0;
119
120    ptr = data;
121    if (count==1)
122    {
123       /* Code 0 */
124       tot_size += len[0]+1;
125       if (tot_size > maxlen)
126          return OPUS_BUFFER_TOO_SMALL;
127       *ptr++ = rp->toc&0xFC;
128    } else if (count==2)
129    {
130       if (len[1] == len[0])
131       {
132          /* Code 1 */
133          tot_size += 2*len[0]+1;
134          if (tot_size > maxlen)
135             return OPUS_BUFFER_TOO_SMALL;
136          *ptr++ = (rp->toc&0xFC) | 0x1;
137       } else {
138          /* Code 2 */
139          tot_size += len[0]+len[1]+2+(len[0]>=252);
140          if (tot_size > maxlen)
141             return OPUS_BUFFER_TOO_SMALL;
142          *ptr++ = (rp->toc&0xFC) | 0x2;
143          ptr += encode_size(len[0], ptr);
144       }
145    }
146    if (count > 2 || (pad && tot_size < maxlen))
147    {
148       /* Code 3 */
149       int vbr;
150       int pad_amount=0;
151
152       /* Restart the process for the padding case */
153       ptr = data;
154       if (self_delimited)
155          tot_size = 1 + (len[count-1]>=252);
156       else
157          tot_size = 0;
158       vbr = 0;
159       for (i=1;i<count;i++)
160       {
161          if (len[i] != len[0])
162          {
163             vbr=1;
164             break;
165          }
166       }
167       if (vbr)
168       {
169          tot_size += 2;
170          for (i=0;i<count-1;i++)
171             tot_size += 1 + (len[i]>=252) + len[i];
172          tot_size += len[count-1];
173
174          if (tot_size > maxlen)
175             return OPUS_BUFFER_TOO_SMALL;
176          *ptr++ = (rp->toc&0xFC) | 0x3;
177          *ptr++ = count | 0x80;
178       } else {
179          tot_size += count*len[0]+2;
180          if (tot_size > maxlen)
181             return OPUS_BUFFER_TOO_SMALL;
182          *ptr++ = (rp->toc&0xFC) | 0x3;
183          *ptr++ = count;
184       }
185       pad_amount = pad ? (maxlen-tot_size) : 0;
186       if (pad_amount != 0)
187       {
188          int nb_255s;
189          data[1] |= 0x40;
190          nb_255s = (pad_amount-1)/255;
191          for (i=0;i<nb_255s;i++)
192             *ptr++ = 255;
193          *ptr++ = pad_amount-255*nb_255s-1;
194          tot_size += pad_amount;
195       }
196       if (vbr)
197       {
198          for (i=0;i<count-1;i++)
199             ptr += encode_size(len[i], ptr);
200       }
201    }
202    if (self_delimited) {
203       int sdlen = encode_size(len[count-1], ptr);
204       ptr += sdlen;
205    }
206    /* Copy the actual data */
207    for (i=0;i<count;i++)
208    {
209       /* Using OPUS_MOVE() instead of OPUS_COPY() in case we're doing in-place
210          padding from opus_packet_pad or opus_packet_strip(). */
211       OPUS_MOVE(ptr, frames[i], len[i]);
212       ptr += len[i];
213    }
214    if (pad)
215    {
216       for (i=ptr-data;i<maxlen;i++)
217          data[i] = 0;
218    }
219    return tot_size;
220 }
221
222 opus_int32 opus_repacketizer_out_range(OpusRepacketizer *rp, int begin, int end, unsigned char *data, opus_int32 maxlen)
223 {
224    return opus_repacketizer_out_range_impl(rp, begin, end, data, maxlen, 0, 0);
225 }
226
227 opus_int32 opus_repacketizer_out(OpusRepacketizer *rp, unsigned char *data, opus_int32 maxlen)
228 {
229    return opus_repacketizer_out_range_impl(rp, 0, rp->nb_frames, data, maxlen, 0, 0);
230 }
231
232 int opus_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len)
233 {
234    OpusRepacketizer rp;
235    opus_int32 ret;
236    if (len < 1)
237       return OPUS_BAD_ARG;
238    if (len==new_len)
239       return OPUS_OK;
240    else if (len > new_len)
241       return OPUS_BAD_ARG;
242    opus_repacketizer_init(&rp);
243    /* Moving payload to the end of the packet so we can do in-place padding */
244    OPUS_MOVE(data+new_len-len, data, len);
245    opus_repacketizer_cat(&rp, data+new_len-len, len);
246    ret = opus_repacketizer_out_range_impl(&rp, 0, rp.nb_frames, data, new_len, 0, 1);
247    if (ret > 0)
248       return OPUS_OK;
249    else
250       return ret;
251 }
252
253 opus_int32 opus_packet_unpad(unsigned char *data, opus_int32 len)
254 {
255    OpusRepacketizer rp;
256    opus_int32 ret;
257    if (len < 1)
258       return OPUS_BAD_ARG;
259    opus_repacketizer_init(&rp);
260    ret = opus_repacketizer_cat(&rp, data, len);
261    if (ret < 0)
262       return ret;
263    ret = opus_repacketizer_out_range_impl(&rp, 0, rp.nb_frames, data, len, 0, 0);
264    celt_assert(ret > 0);
265    return ret;
266 }
267
268 int opus_multistream_packet_pad(unsigned char *data, opus_int32 len, opus_int32 new_len, int nb_streams)
269 {
270    int s;
271    int count;
272    unsigned char toc;
273    opus_int16 size[48];
274    opus_int32 packet_offset;
275    opus_int32 amount;
276
277    if (len < 1)
278       return OPUS_BAD_ARG;
279    if (len==new_len)
280       return OPUS_OK;
281    else if (len > new_len)
282       return OPUS_BAD_ARG;
283    amount = new_len - len;
284    /* Seek to last stream */
285    for (s=0;s<nb_streams-1;s++)
286    {
287       if (len<=0)
288          return OPUS_INVALID_PACKET;
289       count = opus_packet_parse_impl(data, len, 0, &toc, NULL,
290                                      size, NULL, &packet_offset);
291       if (count<0)
292          return count;
293       data += packet_offset;
294       len -= packet_offset;
295    }
296    return opus_packet_pad(data, len, len+amount);
297 }
298
299 opus_int32 opus_multistream_packet_unpad(unsigned char *data, opus_int32 len, int nb_streams)
300 {
301    int s;
302    unsigned char toc;
303    opus_int16 size[48];
304    opus_int32 packet_offset;
305    OpusRepacketizer rp;
306    unsigned char *dst;
307    opus_int32 dst_len;
308
309    if (len < 1)
310       return OPUS_BAD_ARG;
311    dst = data;
312    dst_len = 0;
313    /* Seek to last stream */
314    for (s=0;s<nb_streams;s++)
315    {
316       opus_int32 ret;
317       int self_delimited = s!=nb_streams-1;
318       if (len<=0)
319          return OPUS_INVALID_PACKET;
320       opus_repacketizer_init(&rp);
321       ret = opus_packet_parse_impl(data, len, self_delimited, &toc, NULL,
322                                      size, NULL, &packet_offset);
323       if (ret<0)
324          return ret;
325       ret = opus_repacketizer_cat(&rp, data, packet_offset);
326       if (ret < 0)
327          return ret;
328       ret = opus_repacketizer_out_range_impl(&rp, 0, rp.nb_frames, dst, len, self_delimited, 0);
329       if (ret < 0)
330          return ret;
331       else
332          dst_len += ret;
333       dst += ret;
334       data += packet_offset;
335       len -= packet_offset;
336    }
337    return dst_len;
338 }
339