2
* yuv4mpeg.c: Functions for reading and writing "new" YUV4MPEG streams
4
* Copyright (C) 2001 Matthew J. Marjanovic <maddog@mir.com>
6
* This file is part of the MJPEG Tools package (mjpeg.sourceforge.net).
7
* Ported to mplayer by Rik Snel <rsnel@cube.dyndns.org>
9
* This program is free software; you can redistribute it and/or
10
* modify it under the terms of the GNU General Public License
11
* as published by the Free Software Foundation; either version 2
12
* of the License, or (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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
32
#include "yuv4mpeg_intern.h"
35
static int _y4mparam_allow_unknown_tags = 1; /* default is forgiveness */
37
static void *(*_y4m_alloc)(size_t bytes) = malloc;
38
static void (*_y4m_free)(void *ptr) = free;
40
int y4m_allow_unknown_tags(int yn) {
41
int old = _y4mparam_allow_unknown_tags;
42
if (yn >= 0) _y4mparam_allow_unknown_tags = (yn) ? 1 : 0;
48
/*************************************************************************
50
* Convenience functions for fd read/write
52
* - guaranteed to transfer entire payload (or fail)
54
* 0 on complete success
55
* +(# of remaining bytes) on eof (for y4m_read)
56
* -(# of rem. bytes) on error (and ERRNO should be set)
58
*************************************************************************/
61
ssize_t y4m_read(stream_t *s, char *buf, size_t len)
66
n = stream_read(s, buf, len);
68
/* return amount left to read */
70
return len; /* n == 0 --> eof */
72
return -len; /* n < 0 --> error */
81
#if 0 /* not needed */
82
ssize_t y4m_write(int fd, char *buf, size_t len)
87
n = write(fd, buf, len);
88
if (n < 0) return -len; /* return amount left to write */
97
/*************************************************************************
99
* "Extra tags" handling
101
*************************************************************************/
104
static char *y4m_new_xtag(void)
106
return _y4m_alloc(Y4M_MAX_XTAG_SIZE);
110
void y4m_init_xtag_list(y4m_xtag_list_t *xtags)
114
for (i = 0; i < Y4M_MAX_XTAGS; i++) {
115
xtags->tags[i] = NULL;
120
void y4m_fini_xtag_list(y4m_xtag_list_t *xtags)
123
for (i = 0; i < Y4M_MAX_XTAGS; i++) {
124
if (xtags->tags[i] != NULL) {
125
_y4m_free(xtags->tags[i]);
126
xtags->tags[i] = NULL;
133
void y4m_copy_xtag_list(y4m_xtag_list_t *dest, const y4m_xtag_list_t *src)
136
for (i = 0; i < src->count; i++) {
137
if (dest->tags[i] == NULL)
138
dest->tags[i] = y4m_new_xtag();
139
strncpy(dest->tags[i], src->tags[i], Y4M_MAX_XTAG_SIZE);
141
dest->count = src->count;
147
static int y4m_snprint_xtags(char *s, int maxn, y4m_xtag_list_t *xtags)
151
for (i = 0, room = maxn - 1; i < xtags->count; i++) {
152
int n = snprintf(s, room + 1, " %s", xtags->tags[i]);
153
if ((n < 0) || (n > room)) return Y4M_ERR_HEADER;
157
s[0] = '\n'; /* finish off header with newline */
158
s[1] = '\0'; /* ...and end-of-string */
164
int y4m_xtag_count(const y4m_xtag_list_t *xtags)
170
const char *y4m_xtag_get(const y4m_xtag_list_t *xtags, int n)
172
if (n >= xtags->count)
175
return xtags->tags[n];
179
int y4m_xtag_add(y4m_xtag_list_t *xtags, const char *tag)
181
if (xtags->count >= Y4M_MAX_XTAGS) return Y4M_ERR_XXTAGS;
182
if (xtags->tags[xtags->count] == NULL) {
183
xtags->tags[xtags->count] = y4m_new_xtag();
185
strncpy(xtags->tags[xtags->count], tag, Y4M_MAX_XTAG_SIZE);
191
int y4m_xtag_remove(y4m_xtag_list_t *xtags, int n)
196
if ((n < 0) || (n >= xtags->count)) return Y4M_ERR_RANGE;
198
for (i = n; i < (xtags->count - 1); i++)
199
xtags->tags[i] = xtags->tags[i+1];
206
int y4m_xtag_clearlist(y4m_xtag_list_t *xtags)
213
int y4m_xtag_addlist(y4m_xtag_list_t *dest, const y4m_xtag_list_t *src)
217
if ((dest->count + src->count) > Y4M_MAX_XTAGS) return Y4M_ERR_XXTAGS;
218
for (i = dest->count, j = 0;
221
if (dest->tags[i] == NULL)
222
dest->tags[i] = y4m_new_xtag();
223
strncpy(dest->tags[i], src->tags[i], Y4M_MAX_XTAG_SIZE);
225
dest->count += src->count;
230
/*************************************************************************
232
* Creators/destructors for y4m_*_info_t structures
234
*************************************************************************/
237
void y4m_init_stream_info(y4m_stream_info_t *info)
239
if (info == NULL) return;
240
/* initialize info */
241
info->width = Y4M_UNKNOWN;
242
info->height = Y4M_UNKNOWN;
243
info->interlace = Y4M_UNKNOWN;
244
info->framerate = y4m_fps_UNKNOWN;
245
info->sampleaspect = y4m_sar_UNKNOWN;
246
y4m_init_xtag_list(&(info->x_tags));
250
void y4m_copy_stream_info(y4m_stream_info_t *dest, y4m_stream_info_t *src)
252
if ((dest == NULL) || (src == NULL)) return;
254
dest->width = src->width;
255
dest->height = src->height;
256
dest->interlace = src->interlace;
257
dest->framerate = src->framerate;
258
dest->sampleaspect = src->sampleaspect;
259
y4m_copy_xtag_list(&(dest->x_tags), &(src->x_tags));
263
void y4m_fini_stream_info(y4m_stream_info_t *info)
265
if (info == NULL) return;
266
y4m_fini_xtag_list(&(info->x_tags));
270
void y4m_si_set_width(y4m_stream_info_t *si, int width)
273
si->framelength = (si->height * si->width) * 3 / 2;
276
int y4m_si_get_width(y4m_stream_info_t *si)
277
{ return si->width; }
279
void y4m_si_set_height(y4m_stream_info_t *si, int height)
282
si->framelength = (si->height * si->width) * 3 / 2;
285
int y4m_si_get_height(y4m_stream_info_t *si)
286
{ return si->height; }
288
void y4m_si_set_interlace(y4m_stream_info_t *si, int interlace)
289
{ si->interlace = interlace; }
291
int y4m_si_get_interlace(y4m_stream_info_t *si)
292
{ return si->interlace; }
294
void y4m_si_set_framerate(y4m_stream_info_t *si, y4m_ratio_t framerate)
295
{ si->framerate = framerate; }
297
y4m_ratio_t y4m_si_get_framerate(y4m_stream_info_t *si)
298
{ return si->framerate; }
300
void y4m_si_set_sampleaspect(y4m_stream_info_t *si, y4m_ratio_t sar)
301
{ si->sampleaspect = sar; }
303
y4m_ratio_t y4m_si_get_sampleaspect(y4m_stream_info_t *si)
304
{ return si->sampleaspect; }
306
int y4m_si_get_framelength(y4m_stream_info_t *si)
307
{ return si->framelength; }
309
y4m_xtag_list_t *y4m_si_xtags(y4m_stream_info_t *si)
310
{ return &(si->x_tags); }
314
void y4m_init_frame_info(y4m_frame_info_t *info)
316
if (info == NULL) return;
317
/* initialize info */
318
y4m_init_xtag_list(&(info->x_tags));
322
void y4m_copy_frame_info(y4m_frame_info_t *dest, y4m_frame_info_t *src)
324
if ((dest == NULL) || (src == NULL)) return;
326
y4m_copy_xtag_list(&(dest->x_tags), &(src->x_tags));
330
void y4m_fini_frame_info(y4m_frame_info_t *info)
332
if (info == NULL) return;
333
y4m_fini_xtag_list(&(info->x_tags));
338
/*************************************************************************
342
*************************************************************************/
344
int y4m_parse_stream_tags(char *s, y4m_stream_info_t *i)
351
for (token = strtok(s, Y4M_DELIM);
353
token = strtok(NULL, Y4M_DELIM)) {
354
if (token[0] == '\0') continue; /* skip empty strings */
358
case 'W': /* width */
359
i->width = atoi(value);
360
if (i->width <= 0) return Y4M_ERR_RANGE;
362
case 'H': /* height */
363
i->height = atoi(value);
364
if (i->height <= 0) return Y4M_ERR_RANGE;
366
case 'F': /* frame rate (fps) */
367
if ((err = y4m_parse_ratio(&(i->framerate), value)) != Y4M_OK)
369
if (i->framerate.n < 0) return Y4M_ERR_RANGE;
371
case 'I': /* interlacing */
373
case 'p': i->interlace = Y4M_ILACE_NONE; break;
374
case 't': i->interlace = Y4M_ILACE_TOP_FIRST; break;
375
case 'b': i->interlace = Y4M_ILACE_BOTTOM_FIRST; break;
378
i->interlace = Y4M_UNKNOWN; break;
381
case 'A': /* sample (pixel) aspect ratio */
382
if ((err = y4m_parse_ratio(&(i->sampleaspect), value)) != Y4M_OK)
384
if (i->sampleaspect.n < 0) return Y4M_ERR_RANGE;
386
case 'X': /* 'X' meta-tag */
387
if ((err = y4m_xtag_add(&(i->x_tags), token)) != Y4M_OK) return err;
390
/* possible error on unknown options */
391
if (_y4mparam_allow_unknown_tags) {
392
/* unknown tags ok: store in xtag list and warn... */
393
if ((err = y4m_xtag_add(&(i->x_tags), token)) != Y4M_OK) return err;
394
mp_msg(MSGT_DEMUX, MSGL_WARN, "Unknown stream tag encountered: '%s'\n", token);
396
/* unknown tags are *not* ok */
397
return Y4M_ERR_BADTAG;
402
/* Error checking... width and height must be known since we can't
405
if( i->width == Y4M_UNKNOWN || i->height == Y4M_UNKNOWN )
406
return Y4M_ERR_HEADER;
413
static int y4m_parse_frame_tags(char *s, y4m_frame_info_t *i)
420
for (token = strtok(s, Y4M_DELIM);
422
token = strtok(NULL, Y4M_DELIM)) {
423
if (token[0] == '\0') continue; /* skip empty strings */
427
case 'X': /* 'X' meta-tag */
428
if ((err = y4m_xtag_add(&(i->x_tags), token)) != Y4M_OK) return err;
431
/* possible error on unknown options */
432
if (_y4mparam_allow_unknown_tags) {
433
/* unknown tags ok: store in xtag list and warn... */
434
if ((err = y4m_xtag_add(&(i->x_tags), token)) != Y4M_OK) return err;
435
mp_msg(MSGT_DEMUX, MSGL_WARN, "Unknown frame tag encountered: '%s'\n", token);
437
/* unknown tags are *not* ok */
438
return Y4M_ERR_BADTAG;
451
/*************************************************************************
453
* Read/Write stream header
455
*************************************************************************/
458
int y4m_read_stream_header(stream_t *s, y4m_stream_info_t *i)
460
char line[Y4M_LINE_MAX];
465
/* read the header line */
466
for (n = 0, p = line; n < Y4M_LINE_MAX; n++, p++) {
467
if (y4m_read(s, p, 1))
468
return Y4M_ERR_SYSTEM;
470
*p = '\0'; /* Replace linefeed by end of string */
474
if (n >= Y4M_LINE_MAX)
475
return Y4M_ERR_HEADER;
476
/* look for keyword in header */
477
if (strncmp(line, Y4M_MAGIC, strlen(Y4M_MAGIC)))
478
return Y4M_ERR_MAGIC;
479
if ((err = y4m_parse_stream_tags(line + strlen(Y4M_MAGIC), i)) != Y4M_OK)
482
i->framelength = (i->height * i->width) * 3 / 2;
488
int y4m_write_stream_header(int fd, y4m_stream_info_t *i)
490
char s[Y4M_LINE_MAX+1];
494
y4m_ratio_reduce(&(i->framerate));
495
y4m_ratio_reduce(&(i->sampleaspect));
496
n = snprintf(s, sizeof(s), "%s W%d H%d F%d:%d I%s A%d:%d",
500
i->framerate.n, i->framerate.d,
501
(i->interlace == Y4M_ILACE_NONE) ? "p" :
502
(i->interlace == Y4M_ILACE_TOP_FIRST) ? "t" :
503
(i->interlace == Y4M_ILACE_BOTTOM_FIRST) ? "b" : "?",
504
i->sampleaspect.n, i->sampleaspect.d);
505
if ((n < 0) || (n > Y4M_LINE_MAX)) return Y4M_ERR_HEADER;
506
if ((err = y4m_snprint_xtags(s + n, sizeof(s) - n - 1, &(i->x_tags)))
509
/* non-zero on error */
510
return (y4m_write(fd, s, strlen(s)) ? Y4M_ERR_SYSTEM : Y4M_OK);
517
/*************************************************************************
519
* Read/Write frame header
521
*************************************************************************/
523
int y4m_read_frame_header(stream_t *s, y4m_frame_info_t *i)
525
char line[Y4M_LINE_MAX];
530
/* This is more clever than read_stream_header...
531
Try to read "FRAME\n" all at once, and don't try to parse
532
if nothing else is there...
534
remain = y4m_read(s, line, sizeof(Y4M_FRAME_MAGIC));
537
/* A clean EOF should end exactly at a frame-boundary */
538
if( remain == sizeof(Y4M_FRAME_MAGIC) )
541
return Y4M_ERR_SYSTEM;
543
if (strncmp(line, Y4M_FRAME_MAGIC, sizeof(Y4M_FRAME_MAGIC)-1))
544
return Y4M_ERR_MAGIC;
545
if (line[sizeof(Y4M_FRAME_MAGIC)-1] == '\n')
546
return Y4M_OK; /* done -- no tags: that was the end-of-line. */
548
if (line[sizeof(Y4M_FRAME_MAGIC)-1] != Y4M_DELIM[0]) {
549
return Y4M_ERR_MAGIC; /* wasn't a space -- what was it? */
552
/* proceed to get the tags... (overwrite the magic) */
553
for (n = 0, p = line; n < Y4M_LINE_MAX; n++, p++) {
554
if (y4m_read(s, p, 1))
555
return Y4M_ERR_SYSTEM;
557
*p = '\0'; /* Replace linefeed by end of string */
561
if (n >= Y4M_LINE_MAX) return Y4M_ERR_HEADER;
562
/* non-zero on error */
563
return y4m_parse_frame_tags(line, i);
568
int y4m_write_frame_header(int fd, y4m_frame_info_t *i)
570
char s[Y4M_LINE_MAX+1];
574
n = snprintf(s, sizeof(s), "%s", Y4M_FRAME_MAGIC);
575
if ((n < 0) || (n > Y4M_LINE_MAX)) return Y4M_ERR_HEADER;
576
if ((err = y4m_snprint_xtags(s + n, sizeof(s) - n - 1, &(i->x_tags)))
579
/* non-zero on error */
580
return (y4m_write(fd, s, strlen(s)) ? Y4M_ERR_SYSTEM : Y4M_OK);
586
/*************************************************************************
588
* Read/Write entire frame
590
*************************************************************************/
592
int y4m_read_frame(stream_t *s, y4m_stream_info_t *si,
593
y4m_frame_info_t *fi, unsigned char *yuv[3])
599
/* Read frame header */
600
if ((err = y4m_read_frame_header(s, fi)) != Y4M_OK) return err;
601
/* Read luminance scanlines */
602
if (y4m_read(s, yuv[0], w*h)) return Y4M_ERR_SYSTEM;
603
/* Read chrominance scanlines */
604
if (y4m_read(s, yuv[1], w*h/4)) return Y4M_ERR_SYSTEM;
605
if (y4m_read(s, yuv[2], w*h/4)) return Y4M_ERR_SYSTEM;
613
int y4m_write_frame(int fd, y4m_stream_info_t *si,
614
y4m_frame_info_t *fi, unsigned char *yuv[3])
620
/* Write frame header */
621
if ((err = y4m_write_frame_header(fd, fi)) != Y4M_OK) return err;
622
/* Write luminance,chrominance scanlines */
623
if (y4m_write(fd, yuv[0], w*h) ||
624
y4m_write(fd, yuv[1], w*h/4) ||
625
y4m_write(fd, yuv[2], w*h/4))
626
return Y4M_ERR_SYSTEM;
632
/*************************************************************************
634
* Read/Write entire frame, (de)interleaved (to)from two separate fields
636
*************************************************************************/
639
int y4m_read_fields(int fd, y4m_stream_info_t *si, y4m_frame_info_t *fi,
640
unsigned char *upper_field[3],
641
unsigned char *lower_field[3])
644
int width = si->width;
645
int height = si->height;
647
/* Read frame header */
648
if ((err = y4m_read_frame_header(fd, fi)) != Y4M_OK) return err;
649
/* Read Y', Cb, and Cr planes */
650
for (i = 0; i < 3; i++) {
651
unsigned char *srctop = upper_field[i];
652
unsigned char *srcbot = lower_field[i];
653
/* alternately write one line from each */
654
for (y = 0; y < height; y += 2) {
655
if (y4m_read(fd, srctop, width)) return Y4M_ERR_SYSTEM;
657
if (y4m_read(fd, srcbot, width)) return Y4M_ERR_SYSTEM;
660
/* for chroma, width/height are half as big */
671
int y4m_write_fields(int fd, y4m_stream_info_t *si, y4m_frame_info_t *fi,
672
unsigned char *upper_field[3],
673
unsigned char *lower_field[3])
676
int width = si->width;
677
int height = si->height;
679
/* Write frame header */
680
if ((err = y4m_write_frame_header(fd, fi)) != Y4M_OK) return err;
681
/* Write Y', Cb, and Cr planes */
682
for (i = 0; i < 3; i++) {
683
unsigned char *srctop = upper_field[i];
684
unsigned char *srcbot = lower_field[i];
685
/* alternately write one line from each */
686
for (y = 0; y < height; y += 2) {
687
if (y4m_write(fd, srctop, width)) return Y4M_ERR_SYSTEM;
689
if (y4m_write(fd, srcbot, width)) return Y4M_ERR_SYSTEM;
692
/* for chroma, width/height are half as big */
703
/*************************************************************************
705
* Handy logging of stream info
707
*************************************************************************/
709
void y4m_log_stream_info(const char *prefix, y4m_stream_info_t *i)
713
snprintf(s, sizeof(s), " frame size: ");
714
if (i->width == Y4M_UNKNOWN)
715
snprintf(s+strlen(s), sizeof(s)-strlen(s), "(?)x");
717
snprintf(s+strlen(s), sizeof(s)-strlen(s), "%dx", i->width);
718
if (i->height == Y4M_UNKNOWN)
719
snprintf(s+strlen(s), sizeof(s)-strlen(s), "(?) pixels ");
721
snprintf(s+strlen(s), sizeof(s)-strlen(s), "%d pixels ", i->height);
722
if (i->framelength == Y4M_UNKNOWN)
723
snprintf(s+strlen(s), sizeof(s)-strlen(s), "(? bytes)");
725
snprintf(s+strlen(s), sizeof(s)-strlen(s), "(%d bytes)", i->framelength);
726
mp_msg(MSGT_DEMUX, MSGL_V, "%s%s\n", prefix, s);
727
if ((i->framerate.n == 0) && (i->framerate.d == 0))
728
mp_msg(MSGT_DEMUX, MSGL_V, "%s frame rate: ??? fps\n", prefix);
730
mp_msg(MSGT_DEMUX, MSGL_V, "%s frame rate: %d/%d fps (~%f)\n", prefix,
731
i->framerate.n, i->framerate.d,
732
(double) i->framerate.n / (double) i->framerate.d);
733
mp_msg(MSGT_DEMUX, MSGL_V, "%s interlace: %s\n", prefix,
734
(i->interlace == Y4M_ILACE_NONE) ? "none/progressive" :
735
(i->interlace == Y4M_ILACE_TOP_FIRST) ? "top-field-first" :
736
(i->interlace == Y4M_ILACE_BOTTOM_FIRST) ? "bottom-field-first" :
738
if ((i->sampleaspect.n == 0) && (i->sampleaspect.d == 0))
739
mp_msg(MSGT_DEMUX, MSGL_V, "%ssample aspect ratio: ?:?\n", prefix);
741
mp_msg(MSGT_DEMUX, MSGL_V, "%ssample aspect ratio: %d:%d\n", prefix,
742
i->sampleaspect.n, i->sampleaspect.d);
746
/*************************************************************************
748
* Convert error code to string
750
*************************************************************************/
752
const char *y4m_strerr(int err)
755
case Y4M_OK: return "no error";
756
case Y4M_ERR_RANGE: return "parameter out of range";
757
case Y4M_ERR_SYSTEM: return "stream ended unexpectedly (failed read/write)";
758
case Y4M_ERR_HEADER: return "bad stream or frame header";
759
case Y4M_ERR_BADTAG: return "unknown header tag";
760
case Y4M_ERR_MAGIC: return "bad header magic";
761
case Y4M_ERR_XXTAGS: return "too many xtags";
762
case Y4M_ERR_EOF: return "end-of-file";
764
return "unknown error code";