rtpdec_vp8: Avoid a warning about a possibly unused variable
[ffmpeg.git] / libavformat / rtpdec_vp8.c
1 /*
2  * RTP VP8 Depacketizer
3  * Copyright (c) 2010 Josh Allmann
4  * Copyright (c) 2012 Martin Storsjo
5  *
6  * This file is part of Libav.
7  *
8  * Libav is free software; you can redistribute it and/or
9  * modify it under the terms of the GNU Lesser General Public
10  * License as published by the Free Software Foundation; either
11  * version 2.1 of the License, or (at your option) any later version.
12  *
13  * Libav is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
16  * Lesser General Public License for more details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with Libav; if not, write to the Free Software
20  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
21  */
22
23 /**
24  * @file
25  * @brief RTP support for the VP8 payload
26  * @author Josh Allmann <joshua.allmann@gmail.com>
27  * @see http://tools.ietf.org/html/draft-ietf-payload-vp8-05
28  */
29
30 #include "libavcodec/bytestream.h"
31
32 #include "rtpdec_formats.h"
33
34 struct PayloadContext {
35     AVIOContext *data;
36     uint32_t     timestamp;
37     int          is_keyframe;
38     int          sequence_ok;
39     int          first_part_size;
40     uint16_t     prev_seq;
41     int          prev_pictureid;
42     int          broken_frame;
43 };
44
45 static void vp8_free_buffer(PayloadContext *vp8)
46 {
47     uint8_t *tmp;
48     if (!vp8->data)
49         return;
50     avio_close_dyn_buf(vp8->data, &tmp);
51     av_free(tmp);
52     vp8->data = NULL;
53 }
54
55 static int vp8_broken_sequence(AVFormatContext *ctx, PayloadContext *vp8,
56                                const char *msg)
57 {
58     vp8->sequence_ok = 0;
59     av_log(ctx, AV_LOG_WARNING, "%s", msg);
60     vp8_free_buffer(vp8);
61     return AVERROR(EAGAIN);
62 }
63
64 static int vp8_handle_packet(AVFormatContext *ctx, PayloadContext *vp8,
65                              AVStream *st, AVPacket *pkt, uint32_t *timestamp,
66                              const uint8_t *buf, int len, uint16_t seq,
67                              int flags)
68 {
69     int start_partition, end_packet;
70     int extended_bits, part_id;
71     int pictureid_present = 0, tl0picidx_present = 0, tid_present = 0,
72         keyidx_present = 0;
73     int pictureid = -1, pictureid_mask = 0;
74     int returned_old_frame = 0;
75     uint32_t old_timestamp;
76
77     if (!buf) {
78         if (vp8->data) {
79             int ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
80             if (ret < 0)
81                 return ret;
82             *timestamp = vp8->timestamp;
83             return 0;
84         }
85         return AVERROR(EAGAIN);
86     }
87
88     if (len < 1)
89         return AVERROR_INVALIDDATA;
90
91     extended_bits   = buf[0] & 0x80;
92     start_partition = buf[0] & 0x10;
93     part_id         = buf[0] & 0x0f;
94     end_packet      = flags & RTP_FLAG_MARKER;
95     buf++;
96     len--;
97     if (extended_bits) {
98         if (len < 1)
99             return AVERROR_INVALIDDATA;
100         pictureid_present = buf[0] & 0x80;
101         tl0picidx_present = buf[0] & 0x40;
102         tid_present       = buf[0] & 0x20;
103         keyidx_present    = buf[0] & 0x10;
104         buf++;
105         len--;
106     }
107     if (pictureid_present) {
108         if (len < 1)
109             return AVERROR_INVALIDDATA;
110         if (buf[0] & 0x80) {
111             if (len < 2)
112                 return AVERROR_INVALIDDATA;
113             pictureid = AV_RB16(buf) & 0x7fff;
114             pictureid_mask = 0x7fff;
115             buf += 2;
116             len -= 2;
117         } else {
118             pictureid = buf[0] & 0x7f;
119             pictureid_mask = 0x7f;
120             buf++;
121             len--;
122         }
123     }
124     if (tl0picidx_present) {
125         // Ignoring temporal level zero index
126         buf++;
127         len--;
128     }
129     if (tid_present || keyidx_present) {
130         // Ignoring temporal layer index, layer sync bit and keyframe index
131         buf++;
132         len--;
133     }
134     if (len < 1)
135         return AVERROR_INVALIDDATA;
136
137     if (start_partition && part_id == 0 && len >= 3) {
138         int res;
139         int non_key = buf[0] & 0x01;
140         if (!non_key) {
141             vp8_free_buffer(vp8);
142             // Keyframe, decoding ok again
143             vp8->sequence_ok = 1;
144         } else {
145             int can_continue = vp8->data && !vp8->is_keyframe &&
146                                avio_tell(vp8->data) >= vp8->first_part_size;
147             if (!vp8->sequence_ok)
148                 return AVERROR(EAGAIN);
149             if (pictureid >= 0) {
150                 if (pictureid != ((vp8->prev_pictureid + 1) & pictureid_mask)) {
151                     return vp8_broken_sequence(ctx, vp8,
152                                                "Missed a picture, sequence broken\n");
153                 } else {
154                     if (vp8->data && !can_continue)
155                         return vp8_broken_sequence(ctx, vp8,
156                                                    "Missed a picture, sequence broken\n");
157                 }
158             } else {
159                 uint16_t expected_seq = vp8->prev_seq + 1;
160                 int16_t diff = seq - expected_seq;
161                 if (vp8->data) {
162                     // No picture id, so we can't know if missed packets
163                     // contained any new frames. If diff == 0, we did get
164                     // later packets from the same frame (matching timestamp),
165                     // so we know we didn't miss any frame. If diff == 1 and
166                     // we still have data (not flushed by the end of frame
167                     // marker), the single missed packet must have been part
168                     // of the same frame.
169                     if ((diff == 0 || diff == 1) && can_continue) {
170                         // Proceed with what we have
171                     } else {
172                         return vp8_broken_sequence(ctx, vp8,
173                                                    "Missed too much, sequence broken\n");
174                     }
175                 } else {
176                     if (diff != 0)
177                         return vp8_broken_sequence(ctx, vp8,
178                                                    "Missed unknown data, sequence broken\n");
179                 }
180             }
181             if (vp8->data) {
182                 if (avio_tell(vp8->data) >= vp8->first_part_size) {
183                     int ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
184                     if (ret < 0)
185                         return ret;
186                     pkt->size = vp8->first_part_size;
187                     returned_old_frame = 1;
188                     old_timestamp = vp8->timestamp;
189                 } else {
190                     // Shouldn't happen
191                     vp8_free_buffer(vp8);
192                 }
193             }
194         }
195         vp8->first_part_size = (AV_RL16(&buf[1]) << 3 | buf[0] >> 5) + 3;
196         if ((res = avio_open_dyn_buf(&vp8->data)) < 0)
197             return res;
198         vp8->timestamp = *timestamp;
199         vp8->broken_frame = 0;
200         vp8->prev_pictureid = pictureid;
201         vp8->is_keyframe = !non_key;
202     } else {
203         uint16_t expected_seq = vp8->prev_seq + 1;
204
205         if (!vp8->sequence_ok)
206             return AVERROR(EAGAIN);
207
208         if (vp8->timestamp != *timestamp) {
209             // Missed the start of the new frame, sequence broken
210             vp8->sequence_ok = 0;
211             av_log(ctx, AV_LOG_WARNING,
212                    "Received no start marker; dropping frame\n");
213             vp8_free_buffer(vp8);
214             return AVERROR(EAGAIN);
215         }
216
217         if (seq != expected_seq) {
218             if (vp8->is_keyframe) {
219                 return vp8_broken_sequence(ctx, vp8,
220                                            "Missed part of a keyframe, sequence broken\n");
221             } else if (vp8->data && avio_tell(vp8->data) >= vp8->first_part_size) {
222                 vp8->broken_frame = 1;
223             } else {
224                 return vp8_broken_sequence(ctx, vp8,
225                                            "Missed part of the first partition, sequence broken\n");
226             }
227         }
228     }
229
230     if (!vp8->data)
231         return vp8_broken_sequence(ctx, vp8, "Received no start marker\n");
232
233     vp8->prev_seq = seq;
234     avio_write(vp8->data, buf, len);
235
236     if (returned_old_frame) {
237         *timestamp = old_timestamp;
238         return end_packet ? 1 : 0;
239     }
240
241     if (end_packet) {
242         int ret;
243         ret = ff_rtp_finalize_packet(pkt, &vp8->data, st->index);
244         if (ret < 0)
245             return ret;
246         if (vp8->broken_frame)
247             pkt->size = vp8->first_part_size;
248         return 0;
249     }
250
251     return AVERROR(EAGAIN);
252 }
253
254 static PayloadContext *vp8_new_context(void)
255 {
256     return av_mallocz(sizeof(PayloadContext));
257 }
258
259 static void vp8_free_context(PayloadContext *vp8)
260 {
261     vp8_free_buffer(vp8);
262     av_free(vp8);
263 }
264
265 RTPDynamicProtocolHandler ff_vp8_dynamic_handler = {
266     .enc_name       = "VP8",
267     .codec_type     = AVMEDIA_TYPE_VIDEO,
268     .codec_id       = AV_CODEC_ID_VP8,
269     .alloc          = vp8_new_context,
270     .free           = vp8_free_context,
271     .parse_packet   = vp8_handle_packet,
272 };