2 * FFM (ffserver live feed) muxer and demuxer
3 * Copyright (c) 2001 Fabrice Bellard.
5 * This file is part of FFmpeg.
7 * FFmpeg is free software; you can redistribute it and/or
8 * modify it under the terms of the GNU Lesser General Public
9 * License as published by the Free Software Foundation; either
10 * version 2.1 of the License, or (at your option) any later version.
12 * FFmpeg is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
15 * Lesser General Public License for more details.
17 * You should have received a copy of the GNU Lesser General Public
18 * License along with FFmpeg; if not, write to the Free Software
19 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
24 /* The FFM file is made of blocks of fixed size */
25 #define FFM_HEADER_SIZE 14
26 #define PACKET_ID 0x666d
28 /* each packet contains frames (which can span several packets */
29 #define FRAME_HEADER_SIZE 8
30 #define FLAG_KEY_FRAME 0x01
32 typedef struct FFMStream {
41 typedef struct FFMContext {
42 /* only reading mode */
43 offset_t write_index, file_size;
45 uint8_t header[FRAME_HEADER_SIZE];
48 int first_packet; /* true if first packet, needed to set the discontinuity tag */
49 int first_frame_in_packet; /* true if first frame in packet, needed to know if PTS information is valid */
53 uint8_t *packet_ptr, *packet_end;
54 uint8_t packet[FFM_PACKET_SIZE];
57 static int64_t get_pts(AVFormatContext *s, offset_t pos);
59 /* disable pts hack for testing */
63 static void flush_packet(AVFormatContext *s)
65 FFMContext *ffm = s->priv_data;
67 ByteIOContext *pb = s->pb;
69 fill_size = ffm->packet_end - ffm->packet_ptr;
70 memset(ffm->packet_ptr, 0, fill_size);
72 if (url_ftell(pb) % ffm->packet_size)
76 put_be16(pb, PACKET_ID);
77 put_be16(pb, fill_size);
78 put_be64(pb, ffm->pts);
79 h = ffm->frame_offset;
80 if (ffm->first_packet)
83 put_buffer(pb, ffm->packet, ffm->packet_end - ffm->packet);
86 /* prepare next packet */
87 ffm->frame_offset = 0; /* no key frame */
88 ffm->pts = 0; /* no pts */
89 ffm->packet_ptr = ffm->packet;
90 ffm->first_packet = 0;
93 /* 'first' is true if first data of a frame */
94 static void ffm_write_data(AVFormatContext *s,
95 const uint8_t *buf, int size,
96 int64_t pts, int first)
98 FFMContext *ffm = s->priv_data;
101 if (first && ffm->frame_offset == 0)
102 ffm->frame_offset = ffm->packet_ptr - ffm->packet + FFM_HEADER_SIZE;
103 if (first && ffm->pts == 0)
106 /* write as many packets as needed */
108 len = ffm->packet_end - ffm->packet_ptr;
111 memcpy(ffm->packet_ptr, buf, len);
113 ffm->packet_ptr += len;
116 if (ffm->packet_ptr >= ffm->packet_end) {
117 /* special case : no pts in packet : we leave the current one */
126 static int ffm_write_header(AVFormatContext *s)
128 FFMContext *ffm = s->priv_data;
131 ByteIOContext *pb = s->pb;
132 AVCodecContext *codec;
135 ffm->packet_size = FFM_PACKET_SIZE;
138 put_le32(pb, MKTAG('F', 'F', 'M', '1'));
139 put_be32(pb, ffm->packet_size);
140 /* XXX: store write position in other file ? */
141 put_be64(pb, ffm->packet_size); /* current write position */
143 put_be32(pb, s->nb_streams);
145 for(i=0;i<s->nb_streams;i++) {
147 bit_rate += st->codec->bit_rate;
149 put_be32(pb, bit_rate);
151 /* list of streams */
152 for(i=0;i<s->nb_streams;i++) {
154 fst = av_mallocz(sizeof(FFMStream));
157 av_set_pts_info(st, 64, 1, 1000000);
162 put_be32(pb, codec->codec_id);
163 put_byte(pb, codec->codec_type);
164 put_be32(pb, codec->bit_rate);
165 put_be32(pb, st->quality);
166 put_be32(pb, codec->flags);
167 put_be32(pb, codec->flags2);
168 put_be32(pb, codec->debug);
170 switch(codec->codec_type) {
171 case CODEC_TYPE_VIDEO:
172 put_be32(pb, codec->time_base.num);
173 put_be32(pb, codec->time_base.den);
174 put_be16(pb, codec->width);
175 put_be16(pb, codec->height);
176 put_be16(pb, codec->gop_size);
177 put_be32(pb, codec->pix_fmt);
178 put_byte(pb, codec->qmin);
179 put_byte(pb, codec->qmax);
180 put_byte(pb, codec->max_qdiff);
181 put_be16(pb, (int) (codec->qcompress * 10000.0));
182 put_be16(pb, (int) (codec->qblur * 10000.0));
183 put_be32(pb, codec->bit_rate_tolerance);
184 put_strz(pb, codec->rc_eq);
185 put_be32(pb, codec->rc_max_rate);
186 put_be32(pb, codec->rc_min_rate);
187 put_be32(pb, codec->rc_buffer_size);
188 put_be64(pb, av_dbl2int(codec->i_quant_factor));
189 put_be64(pb, av_dbl2int(codec->b_quant_factor));
190 put_be64(pb, av_dbl2int(codec->i_quant_offset));
191 put_be64(pb, av_dbl2int(codec->b_quant_offset));
192 put_be32(pb, codec->dct_algo);
193 put_be32(pb, codec->strict_std_compliance);
194 put_be32(pb, codec->max_b_frames);
195 put_be32(pb, codec->luma_elim_threshold);
196 put_be32(pb, codec->chroma_elim_threshold);
197 put_be32(pb, codec->mpeg_quant);
198 put_be32(pb, codec->intra_dc_precision);
199 put_be32(pb, codec->me_method);
200 put_be32(pb, codec->mb_decision);
201 put_be32(pb, codec->nsse_weight);
202 put_be32(pb, codec->frame_skip_cmp);
203 put_be64(pb, av_dbl2int(codec->rc_buffer_aggressivity));
204 put_be32(pb, codec->codec_tag);
206 case CODEC_TYPE_AUDIO:
207 put_be32(pb, codec->sample_rate);
208 put_le16(pb, codec->channels);
209 put_le16(pb, codec->frame_size);
214 /* hack to have real time */
218 fst->pts = av_gettime();
221 /* flush until end of block reached */
222 while ((url_ftell(pb) % ffm->packet_size) != 0)
225 put_flush_packet(pb);
227 /* init packet mux */
228 ffm->packet_ptr = ffm->packet;
229 ffm->packet_end = ffm->packet + ffm->packet_size - FFM_HEADER_SIZE;
230 assert(ffm->packet_end >= ffm->packet);
231 ffm->frame_offset = 0;
233 ffm->first_packet = 1;
237 for(i=0;i<s->nb_streams;i++) {
239 av_freep(&st->priv_data);
244 static int ffm_write_packet(AVFormatContext *s, AVPacket *pkt)
246 AVStream *st = s->streams[pkt->stream_index];
247 FFMStream *fst = st->priv_data;
249 uint8_t header[FRAME_HEADER_SIZE];
252 /* packet size & key_frame */
253 header[0] = pkt->stream_index;
255 if (pkt->flags & PKT_FLAG_KEY)
256 header[1] |= FLAG_KEY_FRAME;
257 AV_WB24(header+2, pkt->size);
258 AV_WB24(header+5, pkt->duration);
259 ffm_write_data(s, header, FRAME_HEADER_SIZE, pts, 1);
260 ffm_write_data(s, pkt->data, pkt->size, pts, 0);
262 fst->pts += pkt->duration;
266 static int ffm_write_trailer(AVFormatContext *s)
268 ByteIOContext *pb = s->pb;
269 FFMContext *ffm = s->priv_data;
272 if (ffm->packet_ptr > ffm->packet)
275 put_flush_packet(pb);
277 if (!url_is_streamed(pb)) {
279 /* update the write offset */
280 size = url_ftell(pb);
281 url_fseek(pb, 8, SEEK_SET);
283 put_flush_packet(pb);
288 #endif //CONFIG_MUXERS
292 static int ffm_is_avail_data(AVFormatContext *s, int size)
294 FFMContext *ffm = s->priv_data;
295 offset_t pos, avail_size;
298 len = ffm->packet_end - ffm->packet_ptr;
300 /* XXX: I don't understand this test, so I disabled it for testing */
304 pos = url_ftell(s->pb);
305 if (pos == ffm->write_index) {
306 /* exactly at the end of stream */
308 } else if (pos < ffm->write_index) {
309 avail_size = ffm->write_index - pos;
311 avail_size = (ffm->file_size - pos) + (ffm->write_index - FFM_PACKET_SIZE);
313 avail_size = (avail_size / ffm->packet_size) * (ffm->packet_size - FFM_HEADER_SIZE) + len;
314 if (size <= avail_size)
320 /* first is true if we read the frame header */
321 static int ffm_read_data(AVFormatContext *s,
322 uint8_t *buf, int size, int first)
324 FFMContext *ffm = s->priv_data;
325 ByteIOContext *pb = s->pb;
326 int len, fill_size, size1, frame_offset;
331 len = ffm->packet_end - ffm->packet_ptr;
335 if (url_ftell(pb) == ffm->file_size)
336 url_fseek(pb, ffm->packet_size, SEEK_SET);
338 get_be16(pb); /* PACKET_ID */
339 fill_size = get_be16(pb);
340 ffm->pts = get_be64(pb);
341 ffm->first_frame_in_packet = 1;
342 frame_offset = get_be16(pb);
343 get_buffer(pb, ffm->packet, ffm->packet_size - FFM_HEADER_SIZE);
344 ffm->packet_end = ffm->packet + (ffm->packet_size - FFM_HEADER_SIZE - fill_size);
345 if (ffm->packet_end < ffm->packet)
347 /* if first packet or resynchronization packet, we must
348 handle it specifically */
349 if (ffm->first_packet || (frame_offset & 0x8000)) {
351 /* This packet has no frame headers in it */
352 if (url_ftell(pb) >= ffm->packet_size * 3) {
353 url_fseek(pb, -ffm->packet_size * 2, SEEK_CUR);
356 /* This is bad, we cannot find a valid frame header */
359 ffm->first_packet = 0;
360 if ((frame_offset & 0x7ffff) < FFM_HEADER_SIZE)
362 ffm->packet_ptr = ffm->packet + (frame_offset & 0x7fff) - FFM_HEADER_SIZE;
366 ffm->packet_ptr = ffm->packet;
370 memcpy(buf, ffm->packet_ptr, len);
372 ffm->packet_ptr += len;
380 static void adjust_write_index(AVFormatContext *s)
382 FFMContext *ffm = s->priv_data;
383 ByteIOContext *pb = s->pb;
385 //offset_t orig_write_index = ffm->write_index;
386 offset_t pos_min, pos_max;
388 offset_t ptr = url_ftell(pb);
392 pos_max = ffm->file_size - 2 * FFM_PACKET_SIZE;
394 pts_start = get_pts(s, pos_min);
396 pts = get_pts(s, pos_max);
398 if (pts - 100000 > pts_start)
401 ffm->write_index = FFM_PACKET_SIZE;
403 pts_start = get_pts(s, pos_min);
405 pts = get_pts(s, pos_max);
407 if (pts - 100000 <= pts_start) {
412 newpos = ((pos_max + pos_min) / (2 * FFM_PACKET_SIZE)) * FFM_PACKET_SIZE;
414 if (newpos == pos_min)
417 newpts = get_pts(s, newpos);
419 if (newpts - 100000 <= pts) {
426 ffm->write_index += pos_max;
429 //printf("Adjusted write index from %"PRId64" to %"PRId64": pts=%0.6f\n", orig_write_index, ffm->write_index, pts / 1000000.);
430 //printf("pts range %0.6f - %0.6f\n", get_pts(s, 0) / 1000000. , get_pts(s, ffm->file_size - 2 * FFM_PACKET_SIZE) / 1000000. );
433 url_fseek(pb, ptr, SEEK_SET);
437 static int ffm_read_header(AVFormatContext *s, AVFormatParameters *ap)
439 FFMContext *ffm = s->priv_data;
442 ByteIOContext *pb = s->pb;
443 AVCodecContext *codec;
449 if (tag != MKTAG('F', 'F', 'M', '1'))
451 ffm->packet_size = get_be32(pb);
452 if (ffm->packet_size != FFM_PACKET_SIZE)
454 ffm->write_index = get_be64(pb);
455 /* get also filesize */
456 if (!url_is_streamed(pb)) {
457 ffm->file_size = url_fsize(pb);
458 adjust_write_index(s);
460 ffm->file_size = (UINT64_C(1) << 63) - 1;
463 nb_streams = get_be32(pb);
464 get_be32(pb); /* total bitrate */
465 /* read each stream */
466 for(i=0;i<nb_streams;i++) {
469 st = av_new_stream(s, 0);
472 fst = av_mallocz(sizeof(FFMStream));
477 av_set_pts_info(st, 64, 1, 1000000);
483 codec->codec_id = get_be32(pb);
484 codec->codec_type = get_byte(pb); /* codec_type */
485 codec->bit_rate = get_be32(pb);
486 st->quality = get_be32(pb);
487 codec->flags = get_be32(pb);
488 codec->flags2 = get_be32(pb);
489 codec->debug = get_be32(pb);
491 switch(codec->codec_type) {
492 case CODEC_TYPE_VIDEO:
493 codec->time_base.num = get_be32(pb);
494 codec->time_base.den = get_be32(pb);
495 codec->width = get_be16(pb);
496 codec->height = get_be16(pb);
497 codec->gop_size = get_be16(pb);
498 codec->pix_fmt = get_be32(pb);
499 codec->qmin = get_byte(pb);
500 codec->qmax = get_byte(pb);
501 codec->max_qdiff = get_byte(pb);
502 codec->qcompress = get_be16(pb) / 10000.0;
503 codec->qblur = get_be16(pb) / 10000.0;
504 codec->bit_rate_tolerance = get_be32(pb);
505 codec->rc_eq = av_strdup(get_strz(pb, rc_eq_buf, sizeof(rc_eq_buf)));
506 codec->rc_max_rate = get_be32(pb);
507 codec->rc_min_rate = get_be32(pb);
508 codec->rc_buffer_size = get_be32(pb);
509 codec->i_quant_factor = av_int2dbl(get_be64(pb));
510 codec->b_quant_factor = av_int2dbl(get_be64(pb));
511 codec->i_quant_offset = av_int2dbl(get_be64(pb));
512 codec->b_quant_offset = av_int2dbl(get_be64(pb));
513 codec->dct_algo = get_be32(pb);
514 codec->strict_std_compliance = get_be32(pb);
515 codec->max_b_frames = get_be32(pb);
516 codec->luma_elim_threshold = get_be32(pb);
517 codec->chroma_elim_threshold = get_be32(pb);
518 codec->mpeg_quant = get_be32(pb);
519 codec->intra_dc_precision = get_be32(pb);
520 codec->me_method = get_be32(pb);
521 codec->mb_decision = get_be32(pb);
522 codec->nsse_weight = get_be32(pb);
523 codec->frame_skip_cmp = get_be32(pb);
524 codec->rc_buffer_aggressivity = av_int2dbl(get_be64(pb));
525 codec->codec_tag = get_be32(pb);
527 case CODEC_TYPE_AUDIO:
528 codec->sample_rate = get_be32(pb);
529 codec->channels = get_le16(pb);
530 codec->frame_size = get_le16(pb);
538 /* get until end of block reached */
539 while ((url_ftell(pb) % ffm->packet_size) != 0)
542 /* init packet demux */
543 ffm->packet_ptr = ffm->packet;
544 ffm->packet_end = ffm->packet;
545 ffm->frame_offset = 0;
547 ffm->read_state = READ_HEADER;
548 ffm->first_packet = 1;
551 for(i=0;i<s->nb_streams;i++) {
554 av_freep(&st->priv_data);
561 /* return < 0 if eof */
562 static int ffm_read_packet(AVFormatContext *s, AVPacket *pkt)
565 FFMContext *ffm = s->priv_data;
568 switch(ffm->read_state) {
570 if (!ffm_is_avail_data(s, FRAME_HEADER_SIZE)) {
571 return AVERROR(EAGAIN);
574 printf("pos=%08"PRIx64" spos=%"PRIx64", write_index=%"PRIx64" size=%"PRIx64"\n",
575 url_ftell(s->pb), s->pb.pos, ffm->write_index, ffm->file_size);
577 if (ffm_read_data(s, ffm->header, FRAME_HEADER_SIZE, 1) !=
579 return AVERROR(EAGAIN);
583 for(i=0;i<FRAME_HEADER_SIZE;i++)
584 printf("%02x ", ffm->header[i]);
588 ffm->read_state = READ_DATA;
591 size = AV_RB24(ffm->header + 2);
592 if (!ffm_is_avail_data(s, size)) {
593 return AVERROR(EAGAIN);
596 duration = AV_RB24(ffm->header + 5);
598 av_new_packet(pkt, size);
599 pkt->stream_index = ffm->header[0];
600 if ((unsigned)pkt->stream_index >= s->nb_streams) {
601 av_log(s, AV_LOG_ERROR, "invalid stream index %d\n", pkt->stream_index);
603 ffm->read_state = READ_HEADER;
604 return AVERROR(EAGAIN);
606 pkt->pos = url_ftell(s->pb);
607 if (ffm->header[1] & FLAG_KEY_FRAME)
608 pkt->flags |= PKT_FLAG_KEY;
610 ffm->read_state = READ_HEADER;
611 if (ffm_read_data(s, pkt->data, size, 0) != size) {
612 /* bad case: desynchronized packet. we cancel all the packet loading */
614 return AVERROR(EAGAIN);
616 if (ffm->first_frame_in_packet)
619 ffm->first_frame_in_packet = 0;
621 pkt->duration = duration;
629 /* pos is between 0 and file_size - FFM_PACKET_SIZE. It is translated
630 by the write position inside this function */
631 static void ffm_seek1(AVFormatContext *s, offset_t pos1)
633 FFMContext *ffm = s->priv_data;
634 ByteIOContext *pb = s->pb;
637 pos = pos1 + ffm->write_index;
638 if (pos >= ffm->file_size)
639 pos -= (ffm->file_size - FFM_PACKET_SIZE);
641 printf("seek to %"PRIx64" -> %"PRIx64"\n", pos1, pos);
643 url_fseek(pb, pos, SEEK_SET);
646 static int64_t get_pts(AVFormatContext *s, offset_t pos)
648 ByteIOContext *pb = s->pb;
655 printf("pts=%0.6f\n", pts / 1000000.0);
660 /* seek to a given time in the file. The file read pointer is
661 positioned at or before pts. XXX: the following code is quite
663 static int ffm_seek(AVFormatContext *s, int stream_index, int64_t wanted_pts, int flags)
665 FFMContext *ffm = s->priv_data;
666 offset_t pos_min, pos_max, pos;
667 int64_t pts_min, pts_max, pts;
671 printf("wanted_pts=%0.6f\n", wanted_pts / 1000000.0);
673 /* find the position using linear interpolation (better than
674 dichotomy in typical cases) */
676 pos_max = ffm->file_size - 2 * FFM_PACKET_SIZE;
677 while (pos_min <= pos_max) {
678 pts_min = get_pts(s, pos_min);
679 pts_max = get_pts(s, pos_max);
680 /* linear interpolation */
681 pos1 = (double)(pos_max - pos_min) * (double)(wanted_pts - pts_min) /
682 (double)(pts_max - pts_min);
683 pos = (((int64_t)pos1) / FFM_PACKET_SIZE) * FFM_PACKET_SIZE;
686 else if (pos >= pos_max)
688 pts = get_pts(s, pos);
689 /* check if we are lucky */
690 if (pts == wanted_pts) {
692 } else if (pts > wanted_pts) {
693 pos_max = pos - FFM_PACKET_SIZE;
695 pos_min = pos + FFM_PACKET_SIZE;
698 pos = (flags & AVSEEK_FLAG_BACKWARD) ? pos_min : pos_max;
700 pos -= FFM_PACKET_SIZE;
706 #ifdef CONFIG_FFSERVER
707 offset_t ffm_read_write_index(int fd)
711 lseek(fd, 8, SEEK_SET);
716 void ffm_write_write_index(int fd, offset_t pos)
722 buf[i] = (pos >> (56 - i * 8)) & 0xff;
723 lseek(fd, 8, SEEK_SET);
727 void ffm_set_write_index(AVFormatContext *s, offset_t pos, offset_t file_size)
729 FFMContext *ffm = s->priv_data;
730 ffm->write_index = pos;
731 ffm->file_size = file_size;
733 #endif // CONFIG_FFSERVER
735 static int ffm_read_close(AVFormatContext *s)
740 for(i=0;i<s->nb_streams;i++) {
742 av_freep(&st->priv_data);
747 static int ffm_probe(AVProbeData *p)
750 p->buf[0] == 'F' && p->buf[1] == 'F' && p->buf[2] == 'M' &&
752 return AVPROBE_SCORE_MAX + 1;
756 #ifdef CONFIG_FFM_DEMUXER
757 AVInputFormat ffm_demuxer = {
768 #ifdef CONFIG_FFM_MUXER
769 AVOutputFormat ffm_muxer = {
775 /* not really used */
782 #endif //CONFIG_FFM_MUXER