Increase reserved space for chapters to 4096 bytes.
[libmkv.git] / src / matroska.c
blob54cb84fa50aaee7a1a09ad7e2bd30203709fc4cb
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 #include <sys/time.h>
30 #define RESERVED_SEEKHEAD 0x100
31 /* 256 bytes should be enough room for our Seek entries. */
32 #define RESERVED_CHAPTERS 0x1000
33 /* 4096 bytes, hopefully enough for Chapters. */
35 int mk_seekFile(mk_Writer *w, uint64_t pos)
37 if (fseek(w->fp, pos, SEEK_SET))
38 return -1;
40 w->f_pos = pos;
42 if (pos > w->f_eof)
43 w->f_eof = pos;
45 return 0;
48 char *mk_laceXiph(uint64_t *sizes, uint8_t num_frames,
49 uint64_t *output_size)
51 unsigned i, j;
52 uint64_t offset = 0;
53 uint64_t alloc_size = num_frames * 6; /* Complete guess. It gets realloc'd
54 * below if we need more space, though.
56 char *laced = calloc(alloc_size, sizeof(*laced));
57 if (laced == NULL)
58 return NULL;
60 laced[offset++] = num_frames;
61 for (i = 0; i < num_frames; i++) {
62 for (j = sizes[i]; j >= 255; j -= 255) {
63 laced[offset++] = 255;
64 if (offset + 1 >= alloc_size) {
65 int avg_sz = offset / (i - 1); /* Compute approximate average bytes/frame */
66 alloc_size += avg_sz * (num_frames - i);
67 /* Sum average so far and number of frames left
68 * with alloc'd size
70 if ((laced = realloc(laced, alloc_size)) == NULL)
71 return NULL;
74 laced[offset++] = j;
77 if (output_size != NULL)
78 *output_size = offset;
80 return laced;
83 mk_Writer *mk_createWriter(const char *filename, int64_t timescale,
84 uint8_t vlc_compat)
86 mk_Writer *w = calloc(1, sizeof(*w));
87 struct timeval tv;
89 if (w == NULL)
90 return NULL;
92 w->root = mk_createContext(w, NULL, 0);
93 if (w->root == NULL) {
94 free(w);
95 return NULL;
98 /* Cues */
99 if ((w->cues = mk_createContext(w, w->root, MATROSKA_ID_CUES)) == NULL)
101 mk_destroyContexts(w);
102 free(w);
103 return NULL;
106 /* Clusters SeekHead */
107 if ((w->cluster.seekhead = mk_createContext(w, w->root, MATROSKA_ID_SEEKHEAD)) == NULL)
109 mk_destroyContexts(w);
110 free(w);
111 return NULL;
114 w->fp = fopen(filename, "wb");
115 if (w->fp == NULL) {
116 mk_destroyContexts(w);
117 free(w);
118 return NULL;
121 gettimeofday( &tv, NULL );
122 srandom(tv.tv_sec ^ tv.tv_usec);
124 w->timescale = timescale;
125 w->vlc_compat = vlc_compat;
127 return w;
130 int mk_writeHeader(mk_Writer *w, const char *writingApp)
132 mk_Context *c;
133 int64_t offset = 0;
135 if (w->wrote_header)
136 return -1;
138 md5_starts(&w->segment_md5); /* Initalize MD5 */
140 CHECK(mk_writeEbmlHeader(w, "matroska", MATROSKA_VERSION, MATROSKA_VERSION));
142 /* Segment */
143 if ((c = mk_createContext(w, w->root, MATROSKA_ID_SEGMENT)) == NULL)
144 return -1;
145 CHECK(mk_flushContextID(c));
146 w->segment_ptr = c->d_cur;
147 CHECK(mk_closeContext(c, &w->segment_ptr));
149 if (w->vlc_compat) {
150 CHECK(mk_writeVoid(w->root, RESERVED_SEEKHEAD)); /* Reserved space for SeekHead */
151 CHECK(mk_writeVoid(w->root, RESERVED_CHAPTERS)); /* Reserved space for Chapters */
152 } else {
153 w->seek_data.seekhead = 0x80000000;
154 CHECK(mk_writeSeekHead(w, &w->seekhead_ptr));
155 w->seek_data.seekhead = 0;
158 if ((c = mk_createContext(w, w->root, MATROSKA_ID_INFO)) == NULL) /* SegmentInfo */
159 return -1;
160 w->seek_data.segmentinfo = w->root->d_cur - w->segment_ptr;
161 CHECK(mk_writeVoid(c, 16)); /* Reserve space for a SegmentUID, to be written it later. */
162 CHECK(mk_writeStr(c, MATROSKA_ID_MUXINGAPP, PACKAGE_STRING)); /* MuxingApp */
163 CHECK(mk_writeStr(c, MATROSKA_ID_WRITINGAPP, writingApp)); /* WritingApp */
164 CHECK(mk_writeUInt(c, MATROSKA_ID_TIMECODESCALE, w->timescale)); /* TimecodeScale */
165 CHECK(mk_writeFloat(c, MATROSKA_ID_DURATION, 0)); /* Duration */
166 w->duration_ptr = c->d_cur - 4;
167 CHECK(mk_closeContext(c, &offset));
168 w->duration_ptr += offset;
169 w->segmentuid_ptr = offset;
171 w->seek_data.tracks = w->root->d_cur - w->segment_ptr;
173 if (w->tracks)
174 CHECK(mk_closeContext(w->tracks, 0));
176 CHECK(mk_flushContextData(w->root));
178 w->wrote_header = 1;
179 w->def_duration = w->tracks_arr[0]->default_duration;
180 return 0;
183 static int mk_closeCluster(mk_Writer *w)
185 if (w->cluster.context == NULL)
186 return 0;
187 w->cluster.count++;
188 CHECK(mk_closeContext(w->cluster.context, 0));
189 w->cluster.context = NULL;
190 CHECK(mk_flushContextData(w->root));
192 return 0;
195 int mk_flushFrame(mk_Writer *w, mk_Track *track)
197 mk_Context *c, *tp;
198 int64_t delta, ref = 0;
199 unsigned fsize, bgsize;
200 uint8_t flags, c_delta[2];
201 int i;
202 char *laced = NULL;
203 uint64_t length = 0;
205 if (!track->in_frame)
206 return 0;
208 delta = track->frame.timecode / w->timescale - w->cluster.tc_scaled;
209 /* If switch rapidly back-and-forth between tracks with drastically different timecodes
210 * this causes a new cluster to be written each time a switch is made. This causes
211 * unnecessary overhead.
214 if (delta > 20000ll || delta < -20000ll)
215 CHECK(mk_closeCluster(w));
217 if (w->cluster.context == NULL) {
218 w->cluster.tc_scaled = track->frame.timecode / w->timescale;
219 /* Cluster */
220 w->cluster.context = mk_createContext(w, w->root, MATROSKA_ID_CLUSTER);
221 if (w->cluster.context == NULL)
222 return -1;
224 w->cluster.pointer = w->f_pos - w->segment_ptr;
226 /* Cluster SeekEntry */
227 CHECK(mk_writeSeek(w, w->cluster.seekhead, MATROSKA_ID_CLUSTER,
228 w->cluster.pointer));
230 /* Cluster Timecode */
231 CHECK(mk_writeUInt(w->cluster.context, MATROSKA_ID_CLUSTERTIMECODE, w->cluster.tc_scaled));
233 delta = 0;
234 w->cluster.block_count = 0;
237 /* Calculate the encoded lacing sizes. */
238 switch (track->frame.lacing) {
239 case MK_LACING_XIPH:
240 laced = mk_laceXiph(track->frame.lacing_sizes,
241 track->frame.lacing_num_frames, &length);
242 break;
243 case MK_LACING_EBML:
245 uint64_t u_size = 0;
246 /* Add one below for the frame count. */
247 length += mk_ebmlSizeSize(track->frame.lacing_sizes[0]) + 1;
248 for (i = 1; i < track->frame.lacing_num_frames; i++) {
249 u_size = llabs(track->frame.lacing_sizes[i] -
250 track->frame.lacing_sizes[i - 1]);
251 /* Shift by one so we get the right size for a signed number. */
252 length += mk_ebmlSizeSize((u_size) << 1);
254 break;
256 case MK_LACING_FIXED:
258 laced = calloc(1, sizeof(*laced));
259 laced[0] = track->frame.lacing_num_frames;
260 ++length;
261 break;
263 default:
264 break;
267 fsize = track->frame.data ? track->frame.data->d_cur : 0;
268 bgsize = fsize + 4 + mk_ebmlSizeSize(fsize + 4 + length) + 1 + length;
269 if (!track->frame.keyframe) {
270 ref = track->prev_frame_tc_scaled - w->cluster.tc_scaled - delta;
271 bgsize += 1 + 1 + mk_ebmlSIntSize(ref);
274 CHECK(mk_writeID(w->cluster.context, MATROSKA_ID_BLOCKGROUP)); /* BlockGroup */
275 CHECK(mk_writeSize(w->cluster.context, bgsize));
276 CHECK(mk_writeID(w->cluster.context, MATROSKA_ID_BLOCK)); /* Block */
277 CHECK(mk_writeSize(w->cluster.context, fsize + 4 + length)); /* BlockSize */
278 CHECK(mk_writeSize(w->cluster.context, track->track_id)); /* track number */
280 w->cluster.block_count++;
282 c_delta[0] = delta >> 8;
283 c_delta[1] = delta;
284 /* Timecode relative to Cluster. */
285 CHECK(mk_appendContextData(w->cluster.context, c_delta, 2));
287 /* flags = ( track->frame.keyframe << 8 ) | track->frame.lacing; */
288 flags = track->frame.lacing << 1; /* Flags: Bit 5-6 describe what type of lacing to use. */
289 CHECK(mk_appendContextData(w->cluster.context, &flags, 1));
290 if (track->frame.lacing) {
291 if (track->frame.lacing == MK_LACING_EBML) {
292 /* Number of frames in lace - 1 */
293 CHECK(mk_appendContextData(w->cluster.context, &track->frame.lacing_num_frames, 1));
294 /* Size of 1st frame. */
295 CHECK(mk_writeSize(w->cluster.context, track->frame.lacing_sizes[0]));
296 for (i = 1; i < track->frame.lacing_num_frames; i++) {
297 /* Size difference between previous size and this size. */
298 CHECK(mk_writeSSize(w->cluster.context, track->frame.lacing_sizes[i] - track->frame.lacing_sizes[i - 1]));
300 } else if (length > 0 && laced != NULL) {
301 CHECK(mk_appendContextData(w->cluster.context, laced, length));
302 free(laced);
303 laced = NULL;
307 if (track->frame.data) {
308 CHECK(mk_appendContextData(w->cluster.context, track->frame.data->data,
309 track->frame.data->d_cur));
310 track->frame.data->d_cur = 0;
312 if (!track->frame.keyframe)
313 /* ReferenceBlock */
314 CHECK(mk_writeSInt(w->cluster.context, MATROSKA_ID_REFERENCEBLOCK, ref));
316 /* This may get a little out of hand, but it seems sane enough for now. */
317 if (track->frame.keyframe && (track->track_type == MK_TRACK_VIDEO)) {
318 /* if (track->frame.keyframe && (track->track_type & MK_TRACK_VIDEO) && ((track->prev_cue_pos + 3*CLSIZE) <= w->f_pos || track->frame.timecode == 0)) { */
319 /* CuePoint */
320 if ((c = mk_createContext(w, w->cues, MATROSKA_ID_CUEPOINT)) == NULL)
321 return -1;
322 /* CueTime */
323 CHECK(mk_writeUInt(c, MATROSKA_ID_CUETIME, (track->frame.timecode / w->timescale)));
325 /* CueTrackPositions */
326 if ((tp = mk_createContext(w, c, MATROSKA_ID_CUETRACKPOSITIONS)) == NULL)
327 return -1;
328 /* CueTrack */
329 CHECK(mk_writeUInt(tp, MATROSKA_ID_CUETRACK, track->track_id));
330 /* CueClusterPosition */
331 CHECK(mk_writeUInt(tp, MATROSKA_ID_CUECLUSTERPOSITION, w->cluster.pointer));
332 /* CueBlockNumber */
333 /* CHECK(mk_writeUInt(c, MATROSKA_ID_CUEBLOCKNUMBER, w->cluster.block_count)); */
334 CHECK(mk_closeContext(tp, 0));
335 CHECK(mk_closeContext(c, 0));
336 track->prev_cue_pos = w->f_pos;
339 track->in_frame = 0;
340 track->prev_frame_tc_scaled = w->cluster.tc_scaled + delta;
342 /* Write a new Cluster ~ every 5MB */
343 if (w->cluster.context->d_cur > 5 * CLSIZE)
344 CHECK(mk_closeCluster(w));
346 return 0;
349 int mk_startFrame(mk_Writer *w, mk_Track *track)
351 if (mk_flushFrame(w, track) < 0)
352 return -1;
354 track->in_frame = 1;
355 track->frame.keyframe = 0;
356 track->frame.lacing = MK_LACING_NONE;
357 track->frame.lacing_num_frames = 0;
358 track->frame.lacing_sizes = NULL;
360 return 0;
363 int mk_setFrameFlags(mk_Writer *w, mk_Track *track, int64_t timestamp,
364 unsigned keyframe)
366 if (!track->in_frame)
367 return -1;
369 track->frame.timecode = timestamp;
370 track->frame.keyframe = keyframe != 0;
372 if (track->max_frame_tc < timestamp)
373 track->max_frame_tc = timestamp;
375 return 0;
378 int mk_setFrameLacing(mk_Writer *w, mk_Track *track,
379 mk_LacingType lacing, uint8_t num_frames,
380 uint64_t sizes[])
382 if (!track->in_frame)
383 return -1;
384 track->frame.lacing_sizes = calloc(num_frames, sizeof(*sizes));
386 track->frame.lacing = lacing;
387 track->frame.lacing_num_frames = num_frames;
388 memcpy(track->frame.lacing_sizes, sizes,
389 num_frames * sizeof(*sizes));
391 return 0;
394 int mk_addFrameData(mk_Writer *w, mk_Track *track, const void *data,
395 unsigned size)
397 if (!track->in_frame)
398 return -1;
400 if (track->frame.data == NULL) {
401 if ((track->frame.data = mk_createContext(w, NULL, 0)) == NULL)
402 return -1;
405 md5_update(&w->segment_md5, (unsigned char *) data, size);
407 return mk_appendContextData(track->frame.data, data, size);
410 int mk_writeSeek(mk_Writer *w, mk_Context *c, unsigned seek_id,
411 uint64_t seek_pos)
413 mk_Context *s;
415 if ((s = mk_createContext(w, c, MATROSKA_ID_SEEKENTRY)) == NULL) /* Seek */
416 return -1;
417 CHECK(mk_writeUInt(s, MATROSKA_ID_SEEKID, seek_id)); /* SeekID */
418 CHECK(mk_writeUInt(s, MATROSKA_ID_SEEKPOSITION, seek_pos)); /* SeekPosition */
419 CHECK(mk_closeContext(s, 0));
421 return 0;
424 /* The offset of the SeekHead is returned in pointer. */
425 int mk_writeSeekHead(mk_Writer *w, int64_t *pointer)
427 mk_Context *c;
428 int64_t seekhead_ptr;
430 /* SeekHead */
431 if ((c = mk_createContext(w, w->root, MATROSKA_ID_SEEKHEAD)) == NULL)
432 return -1;
433 if (pointer != NULL)
434 seekhead_ptr = w->f_pos;
435 if (w->seek_data.seekhead)
436 CHECK(mk_writeSeek(w, c, MATROSKA_ID_SEEKHEAD, w->seek_data.seekhead));
437 if (w->seek_data.segmentinfo)
438 CHECK(mk_writeSeek(w, c, MATROSKA_ID_INFO, w->seek_data.segmentinfo));
439 if (w->seek_data.tracks)
440 CHECK(mk_writeSeek(w, c, MATROSKA_ID_TRACKS, w->seek_data.tracks));
441 if (w->seek_data.cues)
442 CHECK(mk_writeSeek(w, c, MATROSKA_ID_CUES, w->seek_data.cues));
443 if (w->seek_data.attachments)
444 CHECK(mk_writeSeek(w, c, MATROSKA_ID_ATTACHMENTS, w->seek_data.attachments));
445 if (w->seek_data.chapters)
446 CHECK(mk_writeSeek(w, c, MATROSKA_ID_CHAPTERS, w->seek_data.chapters));
447 if (w->seek_data.tags)
448 CHECK(mk_writeSeek(w, c, MATROSKA_ID_TAGS, w->seek_data.tags));
449 CHECK(mk_closeContext(c, 0));
451 if (pointer != NULL)
452 *pointer = seekhead_ptr;
454 return 0;
457 int mk_close(mk_Writer *w)
459 int i, ret = 0;
460 mk_Track *tk;
461 int64_t max_frame_tc = w->tracks_arr[0]->max_frame_tc;
462 uint64_t segment_size = 0;
463 unsigned char c_size[8];
464 unsigned char segment_uid[16];
466 md5_finish(&w->segment_md5, segment_uid);
468 for (i = w->num_tracks - 1; i >= 0; i--) {
469 tk = w->tracks_arr[i];
470 w->tracks_arr[i] = NULL;
471 --w->num_tracks;
472 if (mk_flushFrame(w, tk) < 0)
473 ret = -1;
474 free(tk);
475 tk = NULL;
478 if (mk_closeCluster(w) < 0)
479 ret = -1;
481 w->seek_data.cues = w->f_pos - w->segment_ptr;
482 if (mk_closeContext(w->cues, 0) < 0)
483 ret = -1;
484 if (mk_flushContextData(w->root) < 0)
485 ret = -1;
487 if (w->cluster.seekhead) {
488 w->seek_data.seekhead = w->f_pos - w->segment_ptr;
489 if (mk_closeContext(w->cluster.seekhead, 0) < 0)
490 ret = -1;
491 if (mk_flushContextData(w->root) < 0)
492 ret = -1;
495 if (w->attachments != NULL) {
496 w->seek_data.attachments = w->f_pos - w->segment_ptr;
497 mk_writeAttachments(w);
498 if (mk_flushContextData(w->root) < 0)
499 ret = -1;
502 if (w->tags != NULL) {
503 w->seek_data.tags = w->f_pos - w->segment_ptr;
504 mk_writeTags(w);
505 if (mk_flushContextData(w->root) < 0)
506 ret = -1;
509 if (w->chapters != NULL) {
510 if (w->vlc_compat) {
511 if (mk_flushContextData(w->root) < 0)
512 ret = -1;
513 if (mk_seekFile(w, w->segment_ptr + RESERVED_SEEKHEAD + 3) < 0)
514 ret = -1;
516 w->seek_data.chapters = w->f_pos - w->segment_ptr;
517 mk_writeChapters(w);
518 if (mk_flushContextData(w->root) < 0)
519 ret = -1;
520 if (w->vlc_compat) {
521 if (mk_writeVoid(w->root, (RESERVED_CHAPTERS - (w->f_pos - w->segment_ptr - RESERVED_SEEKHEAD - 3))) < 0)
522 ret = -1;
523 if (mk_flushContextData(w->root) < 0)
524 ret = -1;
528 if (w->wrote_header) {
529 if (w->vlc_compat) {
530 if (mk_seekFile(w, w->segment_ptr) < 0)
531 ret = -1;
534 if (mk_writeSeekHead(w, &w->seek_data.seekhead) < 0)
535 ret = -1;
536 w->seek_data.seekhead -= w->segment_ptr;
538 if (w->vlc_compat) {
539 if (mk_flushContextData(w->root) < 0)
540 ret = -1;
541 if (mk_writeVoid(w->root, (RESERVED_SEEKHEAD - (w->f_pos - w->segment_ptr))) < 0)
542 ret = -1;
545 if (mk_flushContextData(w->root) < 0)
546 ret = -1;
548 if (!w->vlc_compat) {
549 int i = w->seek_data.segmentinfo;
550 w->seek_data.segmentinfo = 0;
551 w->seek_data.tracks = 0;
552 w->seek_data.cues = 0;
553 w->seek_data.chapters = 0;
554 w->seek_data.attachments = 0;
555 w->seek_data.tags = 0;
556 if (mk_seekFile(w, w->segment_ptr) < 0)
557 ret = -1;
558 if (mk_writeSeekHead(w, NULL) < 0 || mk_flushContextData(w->root) < 0)
559 ret = -1;
560 // The conditional below is easier to understand, but incorrect
561 // because f_pos is unsigned and causes the lhs to be evaluated
562 // as an unsigned quantity.
563 // if (((i + w->segment_ptr) - w->f_pos - 2) > 1)
564 if ((i + w->segment_ptr) > (w->f_pos + 3))
565 if (mk_writeVoid(w->root, (i + w->segment_ptr) - w->f_pos - 2) < 0
566 || mk_flushContextData(w->root) < 0)
567 ret = -1;
570 if (mk_seekFile(w, w->duration_ptr) < 0)
571 ret = -1;
572 if (mk_writeFloatRaw(w->root,
573 (float) ((double) (max_frame_tc + w->def_duration) /
574 w->timescale)) < 0
575 || mk_flushContextData(w->root) < 0)
576 ret = -1;
577 if (mk_seekFile(w, w->segment_ptr - 8) < 0)
578 ret = -1;
579 segment_size = w->f_eof - w->segment_ptr;
580 for (i = 7; i > 0; --i)
581 c_size[i] = segment_size >> (8 * (7 - i));
582 c_size[i] = 0x01;
583 if (mk_appendContextData(w->root, &c_size, 8) < 0 ||
584 mk_flushContextData(w->root) < 0)
585 ret = -1;
586 if (mk_seekFile(w, w->segmentuid_ptr) < 0)
587 ret = -1;
588 if (mk_writeBin(w->root, MATROSKA_ID_SEGMENTUID, segment_uid,
589 sizeof(segment_uid)) < 0 ||
590 mk_flushContextData(w->root) < 0)
591 ret = -1;
594 if (mk_closeContext(w->root, 0) < 0)
595 ret = -1;
596 mk_destroyContexts(w);
597 fclose(w->fp);
598 free(w->tracks_arr);
599 free(w);
601 return ret;