2 * FFM (ffserver live feed) encoder and decoder
3 * Copyright (c) 2001 Fabrice Bellard.
5 * This library is free software; you can redistribute it and/or
6 * modify it under the terms of the GNU Lesser General Public
7 * License as published by the Free Software Foundation; either
8 * version 2 of the License, or (at your option) any later version.
10 * This library is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13 * Lesser General Public License for more details.
15 * You should have received a copy of the GNU Lesser General Public
16 * License along with this library; if not, write to the Free Software
17 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
22 /* The FFM file is made of blocks of fixed size */
23 #define FFM_HEADER_SIZE 14
24 #define PACKET_ID 0x666d
26 /* each packet contains frames (which can span several packets */
27 #define FRAME_HEADER_SIZE 8
28 #define FLAG_KEY_FRAME 0x01
30 typedef struct FFMStream {
39 typedef struct FFMContext {
40 /* only reading mode */
41 offset_t write_index, file_size;
43 uint8_t header[FRAME_HEADER_SIZE];
46 int first_packet; /* true if first packet, needed to set the discontinuity tag */
47 int first_frame_in_packet; /* true if first frame in packet, needed to know if PTS information is valid */
51 uint8_t *packet_ptr, *packet_end;
52 uint8_t packet[FFM_PACKET_SIZE];
55 static int64_t get_pts(AVFormatContext *s, offset_t pos);
57 /* disable pts hack for testing */
61 static void flush_packet(AVFormatContext *s)
63 FFMContext *ffm = s->priv_data;
65 ByteIOContext *pb = &s->pb;
67 fill_size = ffm->packet_end - ffm->packet_ptr;
68 memset(ffm->packet_ptr, 0, fill_size);
70 if (url_ftell(pb) % ffm->packet_size)
74 put_be16(pb, PACKET_ID);
75 put_be16(pb, fill_size);
76 put_be64(pb, ffm->pts);
77 h = ffm->frame_offset;
78 if (ffm->first_packet)
81 put_buffer(pb, ffm->packet, ffm->packet_end - ffm->packet);
84 /* prepare next packet */
85 ffm->frame_offset = 0; /* no key frame */
86 ffm->pts = 0; /* no pts */
87 ffm->packet_ptr = ffm->packet;
88 ffm->first_packet = 0;
91 /* 'first' is true if first data of a frame */
92 static void ffm_write_data(AVFormatContext *s,
93 const uint8_t *buf, int size,
94 int64_t pts, int first)
96 FFMContext *ffm = s->priv_data;
99 if (first && ffm->frame_offset == 0)
100 ffm->frame_offset = ffm->packet_ptr - ffm->packet + FFM_HEADER_SIZE;
101 if (first && ffm->pts == 0)
104 /* write as many packets as needed */
106 len = ffm->packet_end - ffm->packet_ptr;
109 memcpy(ffm->packet_ptr, buf, len);
111 ffm->packet_ptr += len;
114 if (ffm->packet_ptr >= ffm->packet_end) {
115 /* special case : no pts in packet : we leave the current one */
124 static int ffm_write_header(AVFormatContext *s)
126 FFMContext *ffm = s->priv_data;
129 ByteIOContext *pb = &s->pb;
130 AVCodecContext *codec;
133 ffm->packet_size = FFM_PACKET_SIZE;
136 put_le32(pb, MKTAG('F', 'F', 'M', '1'));
137 put_be32(pb, ffm->packet_size);
138 /* XXX: store write position in other file ? */
139 put_be64(pb, ffm->packet_size); /* current write position */
141 put_be32(pb, s->nb_streams);
143 for(i=0;i<s->nb_streams;i++) {
145 bit_rate += st->codec->bit_rate;
147 put_be32(pb, bit_rate);
149 /* list of streams */
150 for(i=0;i<s->nb_streams;i++) {
152 fst = av_mallocz(sizeof(FFMStream));
155 av_set_pts_info(st, 64, 1, 1000000);
160 put_be32(pb, codec->codec_id);
161 put_byte(pb, codec->codec_type);
162 put_be32(pb, codec->bit_rate);
163 put_be32(pb, st->quality);
164 put_be32(pb, codec->flags);
165 put_be32(pb, codec->flags2);
166 put_be32(pb, codec->debug);
168 switch(codec->codec_type) {
169 case CODEC_TYPE_VIDEO:
170 put_be32(pb, codec->time_base.num);
171 put_be32(pb, codec->time_base.den);
172 put_be16(pb, codec->width);
173 put_be16(pb, codec->height);
174 put_be16(pb, codec->gop_size);
175 put_be32(pb, codec->pix_fmt);
176 put_byte(pb, codec->qmin);
177 put_byte(pb, codec->qmax);
178 put_byte(pb, codec->max_qdiff);
179 put_be16(pb, (int) (codec->qcompress * 10000.0));
180 put_be16(pb, (int) (codec->qblur * 10000.0));
181 put_be32(pb, codec->bit_rate_tolerance);
182 put_strz(pb, codec->rc_eq);
183 put_be32(pb, codec->rc_max_rate);
184 put_be32(pb, codec->rc_min_rate);
185 put_be32(pb, codec->rc_buffer_size);
186 put_be64(pb, av_dbl2int(codec->i_quant_factor));
187 put_be64(pb, av_dbl2int(codec->b_quant_factor));
188 put_be64(pb, av_dbl2int(codec->i_quant_offset));
189 put_be64(pb, av_dbl2int(codec->b_quant_offset));
190 put_be32(pb, codec->dct_algo);
191 put_be32(pb, codec->strict_std_compliance);
192 put_be32(pb, codec->max_b_frames);
193 put_be32(pb, codec->luma_elim_threshold);
194 put_be32(pb, codec->chroma_elim_threshold);
195 put_be32(pb, codec->mpeg_quant);
196 put_be32(pb, codec->intra_dc_precision);
197 put_be32(pb, codec->me_method);
198 put_be32(pb, codec->mb_decision);
199 put_be32(pb, codec->nsse_weight);
200 put_be32(pb, codec->frame_skip_cmp);
201 put_be64(pb, av_dbl2int(codec->rc_buffer_aggressivity));
203 case CODEC_TYPE_AUDIO:
204 put_be32(pb, codec->sample_rate);
205 put_le16(pb, codec->channels);
206 put_le16(pb, codec->frame_size);
211 /* hack to have real time */
215 fst->pts = av_gettime();
218 /* flush until end of block reached */
219 while ((url_ftell(pb) % ffm->packet_size) != 0)
222 put_flush_packet(pb);
224 /* init packet mux */
225 ffm->packet_ptr = ffm->packet;
226 ffm->packet_end = ffm->packet + ffm->packet_size - FFM_HEADER_SIZE;
227 assert(ffm->packet_end >= ffm->packet);
228 ffm->frame_offset = 0;
230 ffm->first_packet = 1;
234 for(i=0;i<s->nb_streams;i++) {
236 av_freep(&st->priv_data);
241 static int ffm_write_packet(AVFormatContext *s, AVPacket *pkt)
243 AVStream *st = s->streams[pkt->stream_index];
244 FFMStream *fst = st->priv_data;
246 uint8_t header[FRAME_HEADER_SIZE];
250 //XXX/FIXME use duration from pkt
251 if (st->codec->codec_type == CODEC_TYPE_AUDIO) {
252 duration = ((float)st->codec->frame_size / st->codec->sample_rate * 1000000.0);
254 duration = (1000000.0 * st->codec->time_base.num / (float)st->codec->time_base.den);
258 /* packet size & key_frame */
259 header[0] = pkt->stream_index;
261 if (pkt->flags & PKT_FLAG_KEY)
262 header[1] |= FLAG_KEY_FRAME;
263 header[2] = (size >> 16) & 0xff;
264 header[3] = (size >> 8) & 0xff;
265 header[4] = size & 0xff;
266 header[5] = (duration >> 16) & 0xff;
267 header[6] = (duration >> 8) & 0xff;
268 header[7] = duration & 0xff;
269 ffm_write_data(s, header, FRAME_HEADER_SIZE, pts, 1);
270 ffm_write_data(s, pkt->data, size, pts, 0);
272 fst->pts += duration;
276 static int ffm_write_trailer(AVFormatContext *s)
278 ByteIOContext *pb = &s->pb;
279 FFMContext *ffm = s->priv_data;
282 if (ffm->packet_ptr > ffm->packet)
285 put_flush_packet(pb);
287 if (!url_is_streamed(pb)) {
289 /* update the write offset */
290 size = url_ftell(pb);
291 url_fseek(pb, 8, SEEK_SET);
293 put_flush_packet(pb);
298 #endif //CONFIG_MUXERS
302 static int ffm_is_avail_data(AVFormatContext *s, int size)
304 FFMContext *ffm = s->priv_data;
305 offset_t pos, avail_size;
308 len = ffm->packet_end - ffm->packet_ptr;
310 /* XXX: I don't understand this test, so I disabled it for testing */
314 pos = url_ftell(&s->pb);
315 if (pos == ffm->write_index) {
316 /* exactly at the end of stream */
318 } else if (pos < ffm->write_index) {
319 avail_size = ffm->write_index - pos;
321 avail_size = (ffm->file_size - pos) + (ffm->write_index - FFM_PACKET_SIZE);
323 avail_size = (avail_size / ffm->packet_size) * (ffm->packet_size - FFM_HEADER_SIZE) + len;
324 if (size <= avail_size)
330 /* first is true if we read the frame header */
331 static int ffm_read_data(AVFormatContext *s,
332 uint8_t *buf, int size, int first)
334 FFMContext *ffm = s->priv_data;
335 ByteIOContext *pb = &s->pb;
336 int len, fill_size, size1, frame_offset;
341 len = ffm->packet_end - ffm->packet_ptr;
345 if (url_ftell(pb) == ffm->file_size)
346 url_fseek(pb, ffm->packet_size, SEEK_SET);
348 get_be16(pb); /* PACKET_ID */
349 fill_size = get_be16(pb);
350 ffm->pts = get_be64(pb);
351 ffm->first_frame_in_packet = 1;
352 frame_offset = get_be16(pb);
353 get_buffer(pb, ffm->packet, ffm->packet_size - FFM_HEADER_SIZE);
354 ffm->packet_end = ffm->packet + (ffm->packet_size - FFM_HEADER_SIZE - fill_size);
355 if (ffm->packet_end < ffm->packet)
357 /* if first packet or resynchronization packet, we must
358 handle it specifically */
359 if (ffm->first_packet || (frame_offset & 0x8000)) {
361 /* This packet has no frame headers in it */
362 if (url_ftell(pb) >= ffm->packet_size * 3) {
363 url_fseek(pb, -ffm->packet_size * 2, SEEK_CUR);
366 /* This is bad, we cannot find a valid frame header */
369 ffm->first_packet = 0;
370 if ((frame_offset & 0x7ffff) < FFM_HEADER_SIZE)
372 ffm->packet_ptr = ffm->packet + (frame_offset & 0x7fff) - FFM_HEADER_SIZE;
376 ffm->packet_ptr = ffm->packet;
380 memcpy(buf, ffm->packet_ptr, len);
382 ffm->packet_ptr += len;
390 static void adjust_write_index(AVFormatContext *s)
392 FFMContext *ffm = s->priv_data;
393 ByteIOContext *pb = &s->pb;
395 //offset_t orig_write_index = ffm->write_index;
396 offset_t pos_min, pos_max;
398 offset_t ptr = url_ftell(pb);
402 pos_max = ffm->file_size - 2 * FFM_PACKET_SIZE;
404 pts_start = get_pts(s, pos_min);
406 pts = get_pts(s, pos_max);
408 if (pts - 100000 > pts_start)
411 ffm->write_index = FFM_PACKET_SIZE;
413 pts_start = get_pts(s, pos_min);
415 pts = get_pts(s, pos_max);
417 if (pts - 100000 <= pts_start) {
422 newpos = ((pos_max + pos_min) / (2 * FFM_PACKET_SIZE)) * FFM_PACKET_SIZE;
424 if (newpos == pos_min)
427 newpts = get_pts(s, newpos);
429 if (newpts - 100000 <= pts) {
436 ffm->write_index += pos_max;
439 //printf("Adjusted write index from %lld to %lld: pts=%0.6f\n", orig_write_index, ffm->write_index, pts / 1000000.);
440 //printf("pts range %0.6f - %0.6f\n", get_pts(s, 0) / 1000000. , get_pts(s, ffm->file_size - 2 * FFM_PACKET_SIZE) / 1000000. );
443 url_fseek(pb, ptr, SEEK_SET);
447 static int ffm_read_header(AVFormatContext *s, AVFormatParameters *ap)
449 FFMContext *ffm = s->priv_data;
452 ByteIOContext *pb = &s->pb;
453 AVCodecContext *codec;
459 if (tag != MKTAG('F', 'F', 'M', '1'))
461 ffm->packet_size = get_be32(pb);
462 if (ffm->packet_size != FFM_PACKET_SIZE)
464 ffm->write_index = get_be64(pb);
465 /* get also filesize */
466 if (!url_is_streamed(pb)) {
467 ffm->file_size = url_fsize(pb);
468 adjust_write_index(s);
470 ffm->file_size = (uint64_t_C(1) << 63) - 1;
473 nb_streams = get_be32(pb);
474 get_be32(pb); /* total bitrate */
475 /* read each stream */
476 for(i=0;i<nb_streams;i++) {
479 st = av_new_stream(s, 0);
482 fst = av_mallocz(sizeof(FFMStream));
487 av_set_pts_info(st, 64, 1, 1000000);
493 codec->codec_id = get_be32(pb);
494 codec->codec_type = get_byte(pb); /* codec_type */
495 codec->bit_rate = get_be32(pb);
496 st->quality = get_be32(pb);
497 codec->flags = get_be32(pb);
498 codec->flags2 = get_be32(pb);
499 codec->debug = get_be32(pb);
501 switch(codec->codec_type) {
502 case CODEC_TYPE_VIDEO:
503 codec->time_base.num = get_be32(pb);
504 codec->time_base.den = get_be32(pb);
505 codec->width = get_be16(pb);
506 codec->height = get_be16(pb);
507 codec->gop_size = get_be16(pb);
508 codec->pix_fmt = get_be32(pb);
509 codec->qmin = get_byte(pb);
510 codec->qmax = get_byte(pb);
511 codec->max_qdiff = get_byte(pb);
512 codec->qcompress = get_be16(pb) / 10000.0;
513 codec->qblur = get_be16(pb) / 10000.0;
514 codec->bit_rate_tolerance = get_be32(pb);
515 codec->rc_eq = av_strdup(get_strz(pb, rc_eq_buf, sizeof(rc_eq_buf)));
516 codec->rc_max_rate = get_be32(pb);
517 codec->rc_min_rate = get_be32(pb);
518 codec->rc_buffer_size = get_be32(pb);
519 codec->i_quant_factor = av_int2dbl(get_be64(pb));
520 codec->b_quant_factor = av_int2dbl(get_be64(pb));
521 codec->i_quant_offset = av_int2dbl(get_be64(pb));
522 codec->b_quant_offset = av_int2dbl(get_be64(pb));
523 codec->dct_algo = get_be32(pb);
524 codec->strict_std_compliance = get_be32(pb);
525 codec->max_b_frames = get_be32(pb);
526 codec->luma_elim_threshold = get_be32(pb);
527 codec->chroma_elim_threshold = get_be32(pb);
528 codec->mpeg_quant = get_be32(pb);
529 codec->intra_dc_precision = get_be32(pb);
530 codec->me_method = get_be32(pb);
531 codec->mb_decision = get_be32(pb);
532 codec->nsse_weight = get_be32(pb);
533 codec->frame_skip_cmp = get_be32(pb);
534 codec->rc_buffer_aggressivity = av_int2dbl(get_be64(pb));
536 case CODEC_TYPE_AUDIO:
537 codec->sample_rate = get_be32(pb);
538 codec->channels = get_le16(pb);
539 codec->frame_size = get_le16(pb);
547 /* get until end of block reached */
548 while ((url_ftell(pb) % ffm->packet_size) != 0)
551 /* init packet demux */
552 ffm->packet_ptr = ffm->packet;
553 ffm->packet_end = ffm->packet;
554 ffm->frame_offset = 0;
556 ffm->read_state = READ_HEADER;
557 ffm->first_packet = 1;
560 for(i=0;i<s->nb_streams;i++) {
563 av_freep(&st->priv_data);
570 /* return < 0 if eof */
571 static int ffm_read_packet(AVFormatContext *s, AVPacket *pkt)
574 FFMContext *ffm = s->priv_data;
577 switch(ffm->read_state) {
579 if (!ffm_is_avail_data(s, FRAME_HEADER_SIZE)) {
583 printf("pos=%08Lx spos=%Lx, write_index=%Lx size=%Lx\n",
584 url_ftell(&s->pb), s->pb.pos, ffm->write_index, ffm->file_size);
586 if (ffm_read_data(s, ffm->header, FRAME_HEADER_SIZE, 1) !=
592 for(i=0;i<FRAME_HEADER_SIZE;i++)
593 printf("%02x ", ffm->header[i]);
597 ffm->read_state = READ_DATA;
600 size = (ffm->header[2] << 16) | (ffm->header[3] << 8) | ffm->header[4];
601 if (!ffm_is_avail_data(s, size)) {
605 duration = (ffm->header[5] << 16) | (ffm->header[6] << 8) | ffm->header[7];
607 av_new_packet(pkt, size);
608 pkt->stream_index = ffm->header[0];
609 pkt->pos = url_ftell(&s->pb);
610 if (ffm->header[1] & FLAG_KEY_FRAME)
611 pkt->flags |= PKT_FLAG_KEY;
613 ffm->read_state = READ_HEADER;
614 if (ffm_read_data(s, pkt->data, size, 0) != size) {
615 /* bad case: desynchronized packet. we cancel all the packet loading */
619 if (ffm->first_frame_in_packet)
622 ffm->first_frame_in_packet = 0;
624 pkt->duration = duration;
632 /* pos is between 0 and file_size - FFM_PACKET_SIZE. It is translated
633 by the write position inside this function */
634 static void ffm_seek1(AVFormatContext *s, offset_t pos1)
636 FFMContext *ffm = s->priv_data;
637 ByteIOContext *pb = &s->pb;
640 pos = pos1 + ffm->write_index;
641 if (pos >= ffm->file_size)
642 pos -= (ffm->file_size - FFM_PACKET_SIZE);
644 printf("seek to %Lx -> %Lx\n", pos1, pos);
646 url_fseek(pb, pos, SEEK_SET);
649 static int64_t get_pts(AVFormatContext *s, offset_t pos)
651 ByteIOContext *pb = &s->pb;
658 printf("pts=%0.6f\n", pts / 1000000.0);
663 /* seek to a given time in the file. The file read pointer is
664 positionned at or before pts. XXX: the following code is quite
666 static int ffm_seek(AVFormatContext *s, int stream_index, int64_t wanted_pts, int flags)
668 FFMContext *ffm = s->priv_data;
669 offset_t pos_min, pos_max, pos;
670 int64_t pts_min, pts_max, pts;
674 printf("wanted_pts=%0.6f\n", wanted_pts / 1000000.0);
676 /* find the position using linear interpolation (better than
677 dichotomy in typical cases) */
679 pos_max = ffm->file_size - 2 * FFM_PACKET_SIZE;
680 while (pos_min <= pos_max) {
681 pts_min = get_pts(s, pos_min);
682 pts_max = get_pts(s, pos_max);
683 /* linear interpolation */
684 pos1 = (double)(pos_max - pos_min) * (double)(wanted_pts - pts_min) /
685 (double)(pts_max - pts_min);
686 pos = (((int64_t)pos1) / FFM_PACKET_SIZE) * FFM_PACKET_SIZE;
689 else if (pos >= pos_max)
691 pts = get_pts(s, pos);
692 /* check if we are lucky */
693 if (pts == wanted_pts) {
695 } else if (pts > wanted_pts) {
696 pos_max = pos - FFM_PACKET_SIZE;
698 pos_min = pos + FFM_PACKET_SIZE;
701 pos = (flags & AVSEEK_FLAG_BACKWARD) ? pos_min : pos_max;
703 pos -= FFM_PACKET_SIZE;
709 #ifdef CONFIG_FFSERVER
710 offset_t ffm_read_write_index(int fd)
716 lseek(fd, 8, SEEK_SET);
720 pos |= (int64_t)buf[i] << (56 - i * 8);
724 void ffm_write_write_index(int fd, offset_t pos)
730 buf[i] = (pos >> (56 - i * 8)) & 0xff;
731 lseek(fd, 8, SEEK_SET);
735 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size)
737 FFMContext *ffm = s->priv_data;
738 ffm->write_index = pos;
739 ffm->file_size = file_size;
741 #endif // CONFIG_FFSERVER
743 static int ffm_read_close(AVFormatContext *s)
748 for(i=0;i<s->nb_streams;i++) {
750 av_freep(&st->priv_data);
755 static int ffm_probe(AVProbeData *p)
757 if (p->buf_size >= 4 &&
758 p->buf[0] == 'F' && p->buf[1] == 'F' && p->buf[2] == 'M' &&
760 return AVPROBE_SCORE_MAX + 1;
764 static AVInputFormat ffm_iformat = {
776 static AVOutputFormat ffm_oformat = {
782 /* not really used */
789 #endif //CONFIG_MUXERS
793 av_register_input_format(&ffm_iformat);
795 av_register_output_format(&ffm_oformat);
796 #endif //CONFIG_MUXERS