apply timescale to BlockDuration
[libmkv.git] / src / matroska.c
blobe3995718bd256d8357dd9ccd835aea38bf6ef1e4
1 /*****************************************************************************
2 * matroska.c:
3 *****************************************************************************
4 * Copyright (C) 2005 x264 project
6 * Authors: Mike Matsnev
7 * Nathan Caldwell
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
22 *****************************************************************************/
23 #include "config.h"
24 #include "libmkv.h"
25 #include "matroska.h"
26 #include "md5.h"
28 #define RESERVED_SEEKHEAD 0x100
29 /* 256 bytes should be enough room for our Seek entries. */
30 #define RESERVED_CHAPTERS 0x800
31 /* 2048 bytes, hopefully enough for Chapters. */
33 int mk_seekFile(mk_Writer *w, uint64_t pos)
35 if (fseek(w->fp, pos, SEEK_SET))
36 return -1;
38 w->f_pos = pos;
40 if (pos > w->f_eof)
41 w->f_eof = pos;
43 return 0;
46 char *mk_laceXiph(uint64_t *sizes, uint8_t num_frames,
47 uint64_t *output_size)
49 unsigned i, j;
50 uint64_t offset = 0;
51 uint64_t alloc_size = num_frames * 6; /* Complete guess. It gets realloc'd
52 * below if we need more space, though.
54 char *laced = calloc(alloc_size, sizeof(*laced));
55 if (laced == NULL)
56 return NULL;
58 laced[offset++] = num_frames;
59 for (i = 0; i < num_frames; i++) {
60 for (j = sizes[i]; j >= 255; j -= 255) {
61 laced[offset++] = 255;
62 if (offset + 1 >= alloc_size) {
63 int avg_sz = offset / (i - 1); /* Compute approximate average bytes/frame */
64 alloc_size += avg_sz * (num_frames - i);
65 /* Sum average so far and number of frames left
66 * with alloc'd size
68 if ((laced = realloc(laced, alloc_size)) == NULL)
69 return NULL;
72 laced[offset++] = j;
75 if (output_size != NULL)
76 *output_size = offset;
78 return laced;
81 mk_Writer *mk_createWriter(const char *filename, int64_t timescale,
82 uint8_t vlc_compat)
84 mk_Writer *w = calloc(1, sizeof(*w));
85 if (w == NULL)
86 return NULL;
88 w->root = mk_createContext(w, NULL, 0);
89 if (w->root == NULL) {
90 free(w);
91 return NULL;
94 /* Cues */
95 if ((w->cues = mk_createContext(w, w->root, MATROSKA_ID_CUES)) == NULL)
97 mk_destroyContexts(w);
98 free(w);
99 return NULL;
102 /* Clusters SeekHead */
103 if ((w->cluster.seekhead = mk_createContext(w, w->root, MATROSKA_ID_SEEKHEAD)) == NULL)
105 mk_destroyContexts(w);
106 free(w);
107 return NULL;
110 w->fp = fopen(filename, "wb");
111 if (w->fp == NULL) {
112 mk_destroyContexts(w);
113 free(w);
114 return NULL;
117 w->timescale = timescale;
118 w->vlc_compat = vlc_compat;
120 return w;
123 int mk_writeHeader(mk_Writer *w, const char *writingApp)
125 mk_Context *c;
126 int64_t offset = 0;
128 if (w->wrote_header)
129 return -1;
131 md5_starts(&w->segment_md5); /* Initalize MD5 */
133 CHECK(mk_writeEbmlHeader(w, "matroska", MATROSKA_VERSION, MATROSKA_VERSION));
135 /* Segment */
136 if ((c = mk_createContext(w, w->root, MATROSKA_ID_SEGMENT)) == NULL)
137 return -1;
138 CHECK(mk_flushContextID(c));
139 w->segment_ptr = c->d_cur;
140 CHECK(mk_closeContext(c, &w->segment_ptr));
142 if (w->vlc_compat) {
143 CHECK(mk_writeVoid(w->root, RESERVED_SEEKHEAD)); /* Reserved space for SeekHead */
144 CHECK(mk_writeVoid(w->root, RESERVED_CHAPTERS)); /* Reserved space for Chapters */
145 } else {
146 w->seek_data.seekhead = 0x80000000;
147 CHECK(mk_writeSeekHead(w, &w->seekhead_ptr));
148 w->seek_data.seekhead = 0;
151 if ((c = mk_createContext(w, w->root, MATROSKA_ID_INFO)) == NULL) /* SegmentInfo */
152 return -1;
153 w->seek_data.segmentinfo = w->root->d_cur - w->segment_ptr;
154 CHECK(mk_writeVoid(c, 16)); /* Reserve space for a SegmentUID, to be written it later. */
155 CHECK(mk_writeStr(c, MATROSKA_ID_MUXINGAPP, PACKAGE_STRING)); /* MuxingApp */
156 CHECK(mk_writeStr(c, MATROSKA_ID_WRITINGAPP, writingApp)); /* WritingApp */
157 CHECK(mk_writeUInt(c, MATROSKA_ID_TIMECODESCALE, w->timescale)); /* TimecodeScale */
158 CHECK(mk_writeFloat(c, MATROSKA_ID_DURATION, 0)); /* Duration */
159 w->duration_ptr = c->d_cur - 4;
160 CHECK(mk_closeContext(c, &offset));
161 w->duration_ptr += offset;
162 w->segmentuid_ptr = offset;
164 w->seek_data.tracks = w->root->d_cur - w->segment_ptr;
166 if (w->tracks)
167 CHECK(mk_closeContext(w->tracks, 0));
169 CHECK(mk_flushContextData(w->root));
171 w->wrote_header = 1;
172 w->def_duration = w->tracks_arr[0]->default_duration;
173 return 0;
176 static int mk_closeCluster(mk_Writer *w)
178 if (w->cluster.context == NULL)
179 return 0;
180 w->cluster.count++;
181 CHECK(mk_closeContext(w->cluster.context, 0));
182 w->cluster.context = NULL;
183 CHECK(mk_flushContextData(w->root));
185 return 0;
188 int mk_flushFrame(mk_Writer *w, mk_Track *track)
190 mk_Context *c, *tp;
191 int64_t delta, ref = 0;
192 unsigned fsize, bgsize;
193 uint8_t flags, c_delta[2];
194 int i;
195 char *laced = NULL;
196 uint64_t length = 0;
197 uint64_t block_duration = 0;
199 if (!track->in_frame)
200 return 0;
202 delta = track->frame.timecode / w->timescale - w->cluster.tc_scaled;
203 block_duration = track->frame.duration / w->timescale;
204 /* If switch rapidly back-and-forth between tracks with drastically different timecodes
205 * this causes a new cluster to be written each time a switch is made. This causes
206 * unnecessary overhead.
209 if (delta > 20000ll || delta < -20000ll)
210 CHECK(mk_closeCluster(w));
212 if (w->cluster.context == NULL) {
213 w->cluster.tc_scaled = track->frame.timecode / w->timescale;
214 /* Cluster */
215 w->cluster.context = mk_createContext(w, w->root, MATROSKA_ID_CLUSTER);
216 if (w->cluster.context == NULL)
217 return -1;
219 w->cluster.pointer = w->f_pos - w->segment_ptr;
221 /* Cluster SeekEntry */
222 CHECK(mk_writeSeek(w, w->cluster.seekhead, MATROSKA_ID_CLUSTER,
223 w->cluster.pointer));
225 /* Cluster Timecode */
226 CHECK(mk_writeUInt(w->cluster.context, MATROSKA_ID_CLUSTERTIMECODE, w->cluster.tc_scaled));
228 delta = 0;
229 w->cluster.block_count = 0;
232 /* Calculate the encoded lacing sizes. */
233 switch (track->frame.lacing) {
234 case MK_LACING_XIPH:
235 laced = mk_laceXiph(track->frame.lacing_sizes,
236 track->frame.lacing_num_frames, &length);
237 break;
238 case MK_LACING_EBML:
240 uint64_t u_size = 0;
241 /* Add one below for the frame count. */
242 length += mk_ebmlSizeSize(track->frame.lacing_sizes[0]) + 1;
243 for (i = 1; i < track->frame.lacing_num_frames; i++) {
244 u_size = llabs(track->frame.lacing_sizes[i] -
245 track->frame.lacing_sizes[i - 1]);
246 /* Shift by one so we get the right size for a signed number. */
247 length += mk_ebmlSizeSize((u_size) << 1);
249 break;
251 case MK_LACING_FIXED:
253 laced = calloc(1, sizeof(*laced));
254 laced[0] = track->frame.lacing_num_frames;
255 ++length;
256 break;
258 default:
259 break;
262 fsize = track->frame.data ? track->frame.data->d_cur : 0;
263 bgsize = fsize + 4 + mk_ebmlSizeSize(fsize + 4 + length) + 1 + length;
264 if (!track->frame.keyframe) {
265 ref = track->prev_frame_tc_scaled - w->cluster.tc_scaled - delta;
266 bgsize += 1 + 1 + mk_ebmlSIntSize(ref);
268 if (block_duration > 0) /* BlockDuration */
270 bgsize += 1 + 1 + mk_ebmlUIntSize(block_duration);
273 CHECK(mk_writeID(w->cluster.context, MATROSKA_ID_BLOCKGROUP)); /* BlockGroup */
274 CHECK(mk_writeSize(w->cluster.context, bgsize));
275 CHECK(mk_writeID(w->cluster.context, MATROSKA_ID_BLOCK)); /* Block */
276 CHECK(mk_writeSize(w->cluster.context, fsize + 4 + length)); /* BlockSize */
277 CHECK(mk_writeSize(w->cluster.context, track->track_id)); /* track number */
279 w->cluster.block_count++;
281 c_delta[0] = delta >> 8;
282 c_delta[1] = delta;
283 /* Timecode relative to Cluster. */
284 CHECK(mk_appendContextData(w->cluster.context, c_delta, 2));
286 /* flags = ( track->frame.keyframe << 8 ) | track->frame.lacing; */
287 flags = track->frame.lacing << 1; /* Flags: Bit 5-6 describe what type of lacing to use. */
288 CHECK(mk_appendContextData(w->cluster.context, &flags, 1));
289 if (track->frame.lacing) {
290 if (track->frame.lacing == MK_LACING_EBML) {
291 /* Number of frames in lace - 1 */
292 CHECK(mk_appendContextData(w->cluster.context, &track->frame.lacing_num_frames, 1));
293 /* Size of 1st frame. */
294 CHECK(mk_writeSize(w->cluster.context, track->frame.lacing_sizes[0]));
295 for (i = 1; i < track->frame.lacing_num_frames; i++) {
296 /* Size difference between previous size and this size. */
297 CHECK(mk_writeSSize(w->cluster.context, track->frame.lacing_sizes[i] - track->frame.lacing_sizes[i - 1]));
299 } else if (length > 0 && laced != NULL) {
300 CHECK(mk_appendContextData(w->cluster.context, laced, length));
301 free(laced);
302 laced = NULL;
306 if (track->frame.data) {
307 CHECK(mk_appendContextData(w->cluster.context, track->frame.data->data,
308 track->frame.data->d_cur));
309 track->frame.data->d_cur = 0;
311 if (!track->frame.keyframe) /* ReferenceBlock */
312 CHECK(mk_writeSInt(w->cluster.context, MATROSKA_ID_REFERENCEBLOCK, ref));
314 if (block_duration > 0) /* BlockDuration */
315 CHECK(mk_writeUInt(w->cluster.context, 0x9b, block_duration));
317 /* This may get a little out of hand, but it seems sane enough for now. */
318 if (track->frame.keyframe && (track->track_type == MK_TRACK_VIDEO)) {
319 /* if (track->frame.keyframe && (track->track_type & MK_TRACK_VIDEO) && ((track->prev_cue_pos + 3*CLSIZE) <= w->f_pos || track->frame.timecode == 0)) { */
320 /* CuePoint */
321 if ((c = mk_createContext(w, w->cues, MATROSKA_ID_CUEPOINT)) == NULL)
322 return -1;
323 /* CueTime */
324 CHECK(mk_writeUInt(c, MATROSKA_ID_CUETIME, (track->frame.timecode / w->timescale)));
326 /* CueTrackPositions */
327 if ((tp = mk_createContext(w, c, MATROSKA_ID_CUETRACKPOSITIONS)) == NULL)
328 return -1;
329 /* CueTrack */
330 CHECK(mk_writeUInt(tp, MATROSKA_ID_CUETRACK, track->track_id));
331 /* CueClusterPosition */
332 CHECK(mk_writeUInt(tp, MATROSKA_ID_CUECLUSTERPOSITION, w->cluster.pointer));
333 /* CueBlockNumber */
334 /* CHECK(mk_writeUInt(c, MATROSKA_ID_CUEBLOCKNUMBER, w->cluster.block_count)); */
335 CHECK(mk_closeContext(tp, 0));
336 CHECK(mk_closeContext(c, 0));
337 track->prev_cue_pos = w->f_pos;
340 track->in_frame = 0;
341 track->prev_frame_tc_scaled = w->cluster.tc_scaled + delta;
343 /* Write a new Cluster ~ every 5MB */
344 if (w->cluster.context->d_cur > 5 * CLSIZE)
345 CHECK(mk_closeCluster(w));
347 return 0;
350 int mk_startFrame(mk_Writer *w, mk_Track *track)
352 if (mk_flushFrame(w, track) < 0)
353 return -1;
355 track->in_frame = 1;
356 track->frame.keyframe = 0;
357 track->frame.lacing = MK_LACING_NONE;
358 track->frame.lacing_num_frames = 0;
359 track->frame.lacing_sizes = NULL;
361 return 0;
364 int mk_setFrameFlags(mk_Writer *w, mk_Track *track, int64_t timestamp,
365 unsigned keyframe, uint64_t duration)
367 if (!track->in_frame)
368 return -1;
370 track->frame.timecode = timestamp;
371 track->frame.keyframe = keyframe != 0;
373 if (track->max_frame_tc < timestamp)
374 track->max_frame_tc = timestamp;
376 if (duration > 0)
377 track->frame.duration = duration;
379 return 0;
382 int mk_setFrameLacing(mk_Writer *w, mk_Track *track,
383 mk_LacingType lacing, uint8_t num_frames,
384 uint64_t sizes[])
386 if (!track->in_frame)
387 return -1;
388 track->frame.lacing_sizes = calloc(num_frames, sizeof(*sizes));
390 track->frame.lacing = lacing;
391 track->frame.lacing_num_frames = num_frames;
392 memcpy(track->frame.lacing_sizes, sizes,
393 num_frames * sizeof(*sizes));
395 return 0;
398 int mk_addFrameData(mk_Writer *w, mk_Track *track, const void *data,
399 unsigned size)
401 if (!track->in_frame)
402 return -1;
404 if (track->frame.data == NULL) {
405 if ((track->frame.data = mk_createContext(w, NULL, 0)) == NULL)
406 return -1;
409 md5_update(&w->segment_md5, (unsigned char *) data, size);
411 return mk_appendContextData(track->frame.data, data, size);
414 int mk_writeSeek(mk_Writer *w, mk_Context *c, unsigned seek_id,
415 uint64_t seek_pos)
417 mk_Context *s;
419 if ((s = mk_createContext(w, c, MATROSKA_ID_SEEKENTRY)) == NULL) /* Seek */
420 return -1;
421 CHECK(mk_writeUInt(s, MATROSKA_ID_SEEKID, seek_id)); /* SeekID */
422 CHECK(mk_writeUInt(s, MATROSKA_ID_SEEKPOSITION, seek_pos)); /* SeekPosition */
423 CHECK(mk_closeContext(s, 0));
425 return 0;
428 /* The offset of the SeekHead is returned in pointer. */
429 int mk_writeSeekHead(mk_Writer *w, int64_t *pointer)
431 mk_Context *c;
432 int64_t seekhead_ptr;
434 /* SeekHead */
435 if ((c = mk_createContext(w, w->root, MATROSKA_ID_SEEKHEAD)) == NULL)
436 return -1;
437 if (pointer != NULL)
438 seekhead_ptr = w->f_pos;
439 if (w->seek_data.seekhead)
440 CHECK(mk_writeSeek(w, c, MATROSKA_ID_SEEKHEAD, w->seek_data.seekhead));
441 if (w->seek_data.segmentinfo)
442 CHECK(mk_writeSeek(w, c, MATROSKA_ID_INFO, w->seek_data.segmentinfo));
443 if (w->seek_data.tracks)
444 CHECK(mk_writeSeek(w, c, MATROSKA_ID_TRACKS, w->seek_data.tracks));
445 if (w->seek_data.cues)
446 CHECK(mk_writeSeek(w, c, MATROSKA_ID_CUES, w->seek_data.cues));
447 if (w->seek_data.attachments)
448 CHECK(mk_writeSeek(w, c, MATROSKA_ID_ATTACHMENTS, w->seek_data.attachments));
449 if (w->seek_data.chapters)
450 CHECK(mk_writeSeek(w, c, MATROSKA_ID_CHAPTERS, w->seek_data.chapters));
451 if (w->seek_data.tags)
452 CHECK(mk_writeSeek(w, c, MATROSKA_ID_TAGS, w->seek_data.tags));
453 CHECK(mk_closeContext(c, 0));
455 if (pointer != NULL)
456 *pointer = seekhead_ptr;
458 return 0;
461 int mk_close(mk_Writer *w)
463 int i, ret = 0;
464 mk_Track *tk;
465 int64_t max_frame_tc = w->tracks_arr[0]->max_frame_tc;
466 uint64_t segment_size = 0;
467 unsigned char c_size[8];
468 unsigned char segment_uid[16];
470 md5_finish(&w->segment_md5, segment_uid);
472 for (i = w->num_tracks - 1; i >= 0; i--) {
473 tk = w->tracks_arr[i];
474 w->tracks_arr[i] = NULL;
475 --w->num_tracks;
476 if (mk_flushFrame(w, tk) < 0)
477 ret = -1;
478 free(tk);
479 tk = NULL;
482 if (mk_closeCluster(w) < 0)
483 ret = -1;
485 w->seek_data.cues = w->f_pos - w->segment_ptr;
486 if (mk_closeContext(w->cues, 0) < 0)
487 ret = -1;
488 if (mk_flushContextData(w->root) < 0)
489 ret = -1;
491 if (w->cluster.seekhead) {
492 w->seek_data.seekhead = w->f_pos - w->segment_ptr;
493 if (mk_closeContext(w->cluster.seekhead, 0) < 0)
494 ret = -1;
495 if (mk_flushContextData(w->root) < 0)
496 ret = -1;
499 if (w->chapters != NULL) {
500 if (w->vlc_compat) {
501 if (mk_flushContextData(w->root) < 0)
502 ret = -1;
503 if (mk_seekFile(w, w->segment_ptr + RESERVED_SEEKHEAD + 3) < 0)
504 ret = -1;
506 w->seek_data.chapters = w->f_pos - w->segment_ptr;
507 mk_writeChapters(w);
508 if (mk_flushContextData(w->root) < 0)
509 ret = -1;
510 if (w->vlc_compat) {
511 if (mk_writeVoid(w->root, (RESERVED_CHAPTERS - (w->f_pos - w->segment_ptr - RESERVED_SEEKHEAD - 3))) < 0)
512 ret = -1;
513 if (mk_flushContextData(w->root) < 0)
514 ret = -1;
518 if (w->tags != NULL) {
519 w->seek_data.tags = w->f_pos - w->segment_ptr;
520 mk_writeTags(w);
521 if (mk_flushContextData(w->root) < 0)
522 ret = -1;
525 if (w->wrote_header) {
526 if (w->vlc_compat) {
527 if (mk_seekFile(w, w->segment_ptr) < 0)
528 ret = -1;
531 if (mk_writeSeekHead(w, &w->seek_data.seekhead) < 0)
532 ret = -1;
533 w->seek_data.seekhead -= w->segment_ptr;
535 if (w->vlc_compat) {
536 if (mk_flushContextData(w->root) < 0)
537 ret = -1;
538 if (mk_writeVoid(w->root, (RESERVED_SEEKHEAD - (w->f_pos - w->segment_ptr))) < 0)
539 ret = -1;
542 if (mk_flushContextData(w->root) < 0)
543 ret = -1;
545 if (!w->vlc_compat) {
546 int i = w->seek_data.segmentinfo;
547 w->seek_data.segmentinfo = 0;
548 w->seek_data.tracks = 0;
549 w->seek_data.cues = 0;
550 w->seek_data.chapters = 0;
551 w->seek_data.attachments = 0;
552 w->seek_data.tags = 0;
553 if (mk_seekFile(w, w->segment_ptr) < 0)
554 ret = -1;
555 if (mk_writeSeekHead(w, NULL) < 0 || mk_flushContextData(w->root) < 0)
556 ret = -1;
557 // The conditional below is easier to understand, but incorrect
558 // because f_pos is unsigned and causes the lhs to be evaluated
559 // as an unsigned quantity.
560 // if (((i + w->segment_ptr) - w->f_pos - 2) > 1)
561 if ((i + w->segment_ptr) > (w->f_pos + 3))
562 if (mk_writeVoid(w->root, (i + w->segment_ptr) - w->f_pos - 2) < 0
563 || mk_flushContextData(w->root) < 0)
564 ret = -1;
567 if (mk_seekFile(w, w->duration_ptr) < 0)
568 ret = -1;
569 if (mk_writeFloatRaw(w->root,
570 (float) ((double) (max_frame_tc + w->def_duration) /
571 w->timescale)) < 0
572 || mk_flushContextData(w->root) < 0)
573 ret = -1;
574 if (mk_seekFile(w, w->segment_ptr - 8) < 0)
575 ret = -1;
576 segment_size = w->f_eof - w->segment_ptr;
577 for (i = 7; i > 0; --i)
578 c_size[i] = segment_size >> (8 * (7 - i));
579 c_size[i] = 0x01;
580 if (mk_appendContextData(w->root, &c_size, 8) < 0 ||
581 mk_flushContextData(w->root) < 0)
582 ret = -1;
583 if (mk_seekFile(w, w->segmentuid_ptr) < 0)
584 ret = -1;
585 if (mk_writeBin(w->root, MATROSKA_ID_SEGMENTUID, segment_uid,
586 sizeof(segment_uid)) < 0 ||
587 mk_flushContextData(w->root) < 0)
588 ret = -1;
591 if (mk_closeContext(w->root, 0) < 0)
592 ret = -1;
593 mk_destroyContexts(w);
594 fclose(w->fp);
595 free(w->tracks_arr);
596 free(w);
598 return ret;