core: "clock-jitter" is in milliseconds
[vlc.git] / src / misc / es_format.c
blobb8bef340e8a3356d2ce60821eeac5b02effa032b
1 /*****************************************************************************
2 * es_format.c : es_format_t helpers.
3 *****************************************************************************
4 * Copyright (C) 2008 VLC authors and VideoLAN
5 * $Id$
7 * Author: Laurent Aimar <fenrir@videolan.org>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU Lesser General Public License as published by
11 * the Free Software Foundation; either version 2.1 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 Lesser General Public License for more details.
19 * You should have received a copy of the GNU Lesser General Public License
20 * along with this program; if not, write to the Free Software Foundation,
21 * Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
24 /*****************************************************************************
25 * Preamble
26 *****************************************************************************/
28 #ifdef HAVE_CONFIG_H
29 # include "config.h"
30 #endif
32 #include <assert.h>
34 #include <vlc_common.h>
35 #include <vlc_es.h>
38 /*****************************************************************************
39 * BinaryLog: computes the base 2 log of a binary value
40 *****************************************************************************
41 * This functions is used by MaskToShift, to get a bit index from a binary
42 * value.
43 *****************************************************************************/
44 static int BinaryLog( uint32_t i )
46 int i_log = 0;
48 if( i == 0 ) return -31337;
50 if( i & 0xffff0000 ) i_log += 16;
51 if( i & 0xff00ff00 ) i_log += 8;
52 if( i & 0xf0f0f0f0 ) i_log += 4;
53 if( i & 0xcccccccc ) i_log += 2;
54 if( i & 0xaaaaaaaa ) i_log += 1;
56 return i_log;
59 /**
60 * It transforms a color mask into right and left shifts
61 * FIXME copied from video_output.c
63 static void MaskToShift( int *pi_left, int *pi_right, uint32_t i_mask )
65 uint32_t i_low, i_high; /* lower and higher bits of the mask */
67 if( !i_mask )
69 *pi_left = *pi_right = 0;
70 return;
73 /* Get bits */
74 i_low = i_high = i_mask;
76 i_low &= - (int32_t)i_low; /* lower bit of the mask */
77 i_high += i_low; /* higher bit of the mask */
79 /* Transform bits into an index. Also deal with i_high overflow, which
80 * is faster than changing the BinaryLog code to handle 64 bit integers. */
81 i_low = BinaryLog (i_low);
82 i_high = i_high ? BinaryLog (i_high) : 32;
84 /* Update pointers and return */
85 *pi_left = i_low;
86 *pi_right = (8 - i_high + i_low);
89 /* */
90 void video_format_FixRgb( video_format_t *p_fmt )
92 /* FIXME find right default mask */
93 if( !p_fmt->i_rmask || !p_fmt->i_gmask || !p_fmt->i_bmask )
95 switch( p_fmt->i_chroma )
97 case VLC_CODEC_RGB15:
98 p_fmt->i_rmask = 0x7c00;
99 p_fmt->i_gmask = 0x03e0;
100 p_fmt->i_bmask = 0x001f;
101 break;
103 case VLC_CODEC_RGB16:
104 p_fmt->i_rmask = 0xf800;
105 p_fmt->i_gmask = 0x07e0;
106 p_fmt->i_bmask = 0x001f;
107 break;
109 case VLC_CODEC_RGB24:
110 p_fmt->i_rmask = 0xff0000;
111 p_fmt->i_gmask = 0x00ff00;
112 p_fmt->i_bmask = 0x0000ff;
113 break;
114 case VLC_CODEC_RGB32:
115 p_fmt->i_rmask = 0x00ff0000;
116 p_fmt->i_gmask = 0x0000ff00;
117 p_fmt->i_bmask = 0x000000ff;
118 break;
120 default:
121 return;
125 MaskToShift( &p_fmt->i_lrshift, &p_fmt->i_rrshift,
126 p_fmt->i_rmask );
127 MaskToShift( &p_fmt->i_lgshift, &p_fmt->i_rgshift,
128 p_fmt->i_gmask );
129 MaskToShift( &p_fmt->i_lbshift, &p_fmt->i_rbshift,
130 p_fmt->i_bmask );
133 void video_format_Setup( video_format_t *p_fmt, vlc_fourcc_t i_chroma,
134 int i_width, int i_height,
135 int i_visible_width, int i_visible_height,
136 int i_sar_num, int i_sar_den )
138 p_fmt->i_chroma = vlc_fourcc_GetCodec( VIDEO_ES, i_chroma );
139 p_fmt->i_width = i_width;
140 p_fmt->i_visible_width = i_visible_width;
141 p_fmt->i_height = i_height;
142 p_fmt->i_visible_height = i_visible_height;
143 p_fmt->i_x_offset =
144 p_fmt->i_y_offset = 0;
145 vlc_ureduce( &p_fmt->i_sar_num, &p_fmt->i_sar_den,
146 i_sar_num, i_sar_den, 0 );
148 switch( p_fmt->i_chroma )
150 case VLC_CODEC_YUVA:
151 p_fmt->i_bits_per_pixel = 32;
152 break;
153 case VLC_CODEC_YUV420A:
154 p_fmt->i_bits_per_pixel = 20;
155 break;
156 case VLC_CODEC_YUV422A:
157 p_fmt->i_bits_per_pixel = 24;
158 break;
159 case VLC_CODEC_I444:
160 case VLC_CODEC_J444:
161 p_fmt->i_bits_per_pixel = 24;
162 break;
163 case VLC_CODEC_I422:
164 case VLC_CODEC_YUYV:
165 case VLC_CODEC_YVYU:
166 case VLC_CODEC_UYVY:
167 case VLC_CODEC_VYUY:
168 case VLC_CODEC_J422:
169 p_fmt->i_bits_per_pixel = 16;
170 break;
171 case VLC_CODEC_I440:
172 case VLC_CODEC_J440:
173 p_fmt->i_bits_per_pixel = 16;
174 break;
175 case VLC_CODEC_P010:
176 p_fmt->i_bits_per_pixel = 15;
177 break;
178 case VLC_CODEC_I411:
179 case VLC_CODEC_YV12:
180 case VLC_CODEC_I420:
181 case VLC_CODEC_J420:
182 case VLC_CODEC_NV12:
183 p_fmt->i_bits_per_pixel = 12;
184 break;
185 case VLC_CODEC_YV9:
186 case VLC_CODEC_I410:
187 p_fmt->i_bits_per_pixel = 9;
188 break;
189 case VLC_CODEC_Y211:
190 p_fmt->i_bits_per_pixel = 8;
191 break;
192 case VLC_CODEC_YUVP:
193 p_fmt->i_bits_per_pixel = 8;
194 break;
196 case VLC_CODEC_RGB32:
197 case VLC_CODEC_RGBA:
198 case VLC_CODEC_ARGB:
199 case VLC_CODEC_BGRA:
200 p_fmt->i_bits_per_pixel = 32;
201 break;
202 case VLC_CODEC_RGB24:
203 p_fmt->i_bits_per_pixel = 24;
204 break;
205 case VLC_CODEC_RGB15:
206 case VLC_CODEC_RGB16:
207 p_fmt->i_bits_per_pixel = 16;
208 break;
209 case VLC_CODEC_RGB8:
210 p_fmt->i_bits_per_pixel = 8;
211 break;
213 case VLC_CODEC_GREY:
214 case VLC_CODEC_RGBP:
215 p_fmt->i_bits_per_pixel = 8;
216 break;
218 case VLC_CODEC_XYZ12:
219 p_fmt->i_bits_per_pixel = 48;
220 break;
222 default:
223 p_fmt->i_bits_per_pixel = 0;
224 break;
228 void video_format_CopyCrop( video_format_t *p_dst, const video_format_t *p_src )
230 p_dst->i_x_offset = p_src->i_x_offset;
231 p_dst->i_y_offset = p_src->i_y_offset;
232 p_dst->i_visible_width = p_src->i_visible_width;
233 p_dst->i_visible_height = p_src->i_visible_height;
236 void video_format_ScaleCropAr( video_format_t *p_dst, const video_format_t *p_src )
238 p_dst->i_x_offset = (uint64_t)p_src->i_x_offset * p_dst->i_width / p_src->i_width;
239 p_dst->i_y_offset = (uint64_t)p_src->i_y_offset * p_dst->i_height / p_src->i_height;
240 p_dst->i_visible_width = (uint64_t)p_src->i_visible_width * p_dst->i_width / p_src->i_width;
241 p_dst->i_visible_height = (uint64_t)p_src->i_visible_height * p_dst->i_height / p_src->i_height;
243 p_dst->i_sar_num *= p_src->i_width;
244 p_dst->i_sar_den *= p_dst->i_width;
245 vlc_ureduce(&p_dst->i_sar_num, &p_dst->i_sar_den,
246 p_dst->i_sar_num, p_dst->i_sar_den, 65536);
248 p_dst->i_sar_num *= p_dst->i_height;
249 p_dst->i_sar_den *= p_src->i_height;
250 vlc_ureduce(&p_dst->i_sar_num, &p_dst->i_sar_den,
251 p_dst->i_sar_num, p_dst->i_sar_den, 65536);
254 //Simplify transforms to have something more manageable. Order: angle, hflip.
255 static void transform_GetBasicOps( video_transform_t transform,
256 unsigned *restrict angle,
257 bool *restrict hflip )
259 *hflip = ORIENT_IS_MIRROR(transform);
261 switch ( transform )
263 case TRANSFORM_R90:
264 case TRANSFORM_TRANSPOSE:
265 *angle = 90;
266 break;
267 case TRANSFORM_R180:
268 case TRANSFORM_VFLIP:
269 *angle = 180;
270 break;
271 case TRANSFORM_R270:
272 case TRANSFORM_ANTI_TRANSPOSE:
273 *angle = 270;
274 break;
275 case TRANSFORM_HFLIP:
276 case TRANSFORM_IDENTITY:
277 *angle = 0;
278 break;
279 default:
280 vlc_assert_unreachable ();
284 static video_transform_t transform_FromBasicOps( unsigned angle, bool hflip )
286 switch ( angle )
288 case 90:
289 return hflip ? TRANSFORM_TRANSPOSE : TRANSFORM_R90;
290 case 180:
291 return hflip ? TRANSFORM_VFLIP : TRANSFORM_R180;
292 case 270:
293 return hflip ? TRANSFORM_ANTI_TRANSPOSE : TRANSFORM_R270;
294 default:
295 return hflip ? TRANSFORM_HFLIP : TRANSFORM_IDENTITY;
299 video_transform_t video_format_GetTransform( video_orientation_t src,
300 video_orientation_t dst )
302 unsigned angle1, angle2;
303 bool hflip1, hflip2;
305 transform_GetBasicOps( (video_transform_t)src, &angle1, &hflip1 );
306 transform_GetBasicOps( transform_Inverse( (video_transform_t)dst ),
307 &angle2, &hflip2 );
309 int angle = (angle1 + angle2) % 360;
310 bool hflip = hflip1 ^ hflip2;
312 return transform_FromBasicOps(angle, hflip);
315 void video_format_TransformBy( video_format_t *fmt, video_transform_t transform )
317 /* Get destination orientation */
318 unsigned angle1, angle2;
319 bool hflip1, hflip2;
321 transform_GetBasicOps( transform, &angle1, &hflip1 );
322 transform_GetBasicOps( (video_transform_t)fmt->orientation, &angle2, &hflip2 );
324 unsigned angle = (angle2 - angle1 + 360) % 360;
325 bool hflip = hflip2 ^ hflip1;
327 video_orientation_t dst_orient = ORIENT_NORMAL;
329 if( hflip ) {
331 if( angle == 0 )
332 dst_orient = ORIENT_HFLIPPED;
333 else if( angle == 90 )
334 dst_orient = ORIENT_ANTI_TRANSPOSED;
335 else if( angle == 180 )
336 dst_orient = ORIENT_VFLIPPED;
337 else if( angle == 270 )
338 dst_orient = ORIENT_TRANSPOSED;
340 else {
342 if( angle == 90 )
343 dst_orient = ORIENT_ROTATED_90;
344 else if( angle == 180 )
345 dst_orient = ORIENT_ROTATED_180;
346 else if( angle == 270 )
347 dst_orient = ORIENT_ROTATED_270;
350 /* Apply transform */
351 if( ORIENT_IS_SWAP( fmt->orientation ) != ORIENT_IS_SWAP( dst_orient ) )
353 video_format_t scratch = *fmt;
355 fmt->i_width = scratch.i_height;
356 fmt->i_visible_width = scratch.i_visible_height;
357 fmt->i_height = scratch.i_width;
358 fmt->i_visible_height = scratch.i_visible_width;
359 fmt->i_x_offset = scratch.i_y_offset;
360 fmt->i_y_offset = scratch.i_x_offset;
361 fmt->i_sar_num = scratch.i_sar_den;
362 fmt->i_sar_den = scratch.i_sar_num;
365 fmt->orientation = dst_orient;
368 void video_format_TransformTo( video_format_t *restrict fmt,
369 video_orientation_t dst_orientation )
371 video_transform_t transform = video_format_GetTransform(fmt->orientation,
372 dst_orientation);
373 video_format_TransformBy(fmt, transform);
376 void video_format_ApplyRotation( video_format_t *restrict out,
377 const video_format_t *restrict in )
379 *out = *in;
381 video_format_TransformTo(out, ORIENT_NORMAL);
384 bool video_format_IsSimilar( const video_format_t *f1,
385 const video_format_t *f2 )
387 if( f1->i_chroma != f2->i_chroma )
388 return false;
390 if( f1->i_width != f2->i_width || f1->i_height != f2->i_height ||
391 f1->i_visible_width != f2->i_visible_width ||
392 f1->i_visible_height != f2->i_visible_height ||
393 f1->i_x_offset != f2->i_x_offset || f1->i_y_offset != f2->i_y_offset )
394 return false;
395 if( (int64_t)f1->i_sar_num * f2->i_sar_den !=
396 (int64_t)f2->i_sar_num * f1->i_sar_den )
397 return false;
399 if( f1->orientation != f2->orientation)
400 return false;
402 if( f1->multiview_mode!= f2->multiview_mode )
403 return false;
405 if( f1->i_chroma == VLC_CODEC_RGB15 ||
406 f1->i_chroma == VLC_CODEC_RGB16 ||
407 f1->i_chroma == VLC_CODEC_RGB24 ||
408 f1->i_chroma == VLC_CODEC_RGB32 )
410 video_format_t v1 = *f1;
411 video_format_t v2 = *f2;
413 video_format_FixRgb( &v1 );
414 video_format_FixRgb( &v2 );
416 if( v1.i_rmask != v2.i_rmask ||
417 v1.i_gmask != v2.i_gmask ||
418 v1.i_bmask != v2.i_bmask )
419 return false;
421 return true;
423 void video_format_Print( vlc_object_t *p_this,
424 const char *psz_text, const video_format_t *fmt )
426 msg_Dbg( p_this,
427 "%s sz %ix%i, of (%i,%i), vsz %ix%i, 4cc %4.4s, sar %i:%i, msk r0x%x g0x%x b0x%x",
428 psz_text,
429 fmt->i_width, fmt->i_height, fmt->i_x_offset, fmt->i_y_offset,
430 fmt->i_visible_width, fmt->i_visible_height,
431 (char*)&fmt->i_chroma,
432 fmt->i_sar_num, fmt->i_sar_den,
433 fmt->i_rmask, fmt->i_gmask, fmt->i_bmask );
436 void es_format_Init( es_format_t *fmt,
437 int i_cat, vlc_fourcc_t i_codec )
439 memset(fmt, 0, sizeof (*fmt));
440 fmt->i_cat = i_cat;
441 fmt->i_codec = i_codec;
442 fmt->i_profile = -1;
443 fmt->i_level = -1;
444 fmt->i_id = -1;
445 fmt->i_priority = ES_PRIORITY_SELECTABLE_MIN;
446 fmt->psz_language = NULL;
447 fmt->psz_description = NULL;
448 fmt->p_extra_languages = NULL;
450 if (fmt->i_cat == VIDEO_ES)
451 video_format_Init(&fmt->video, 0);
453 fmt->b_packetized = true;
454 fmt->p_extra = NULL;
457 void es_format_InitFromVideo( es_format_t *p_es, const video_format_t *p_fmt )
459 es_format_Init( p_es, VIDEO_ES, p_fmt->i_chroma );
460 video_format_Copy( &p_es->video, p_fmt );
463 int es_format_Copy(es_format_t *restrict dst, const es_format_t *src)
465 int ret = VLC_SUCCESS;
467 *dst = *src;
469 if (src->psz_language != NULL)
471 dst->psz_language = strdup(src->psz_language);
472 if (unlikely(dst->psz_language == NULL))
473 ret = VLC_ENOMEM;
475 if (src->psz_description != NULL)
477 dst->psz_description = strdup(src->psz_description);
478 if (unlikely(dst->psz_description == NULL))
479 ret = VLC_ENOMEM;
482 if (src->i_extra > 0)
484 assert(src->p_extra != NULL);
485 dst->p_extra = malloc( src->i_extra );
487 if( likely(dst->p_extra != NULL) )
488 memcpy(dst->p_extra, src->p_extra, src->i_extra);
489 else
491 dst->i_extra = 0;
492 ret = VLC_ENOMEM;
495 else
496 dst->p_extra = NULL;
498 if (src->i_cat == VIDEO_ES)
499 ret = video_format_Copy( &dst->video, &src->video );
501 if (src->i_cat == SPU_ES)
503 if (src->subs.psz_encoding != NULL)
505 dst->subs.psz_encoding = strdup(src->subs.psz_encoding);
506 if (unlikely(dst->subs.psz_encoding == NULL))
507 ret = VLC_ENOMEM;
511 if (src->i_extra_languages > 0)
513 assert(src->p_extra_languages != NULL);
514 dst->p_extra_languages = calloc(dst->i_extra_languages,
515 sizeof (*dst->p_extra_languages));
516 if (likely(dst->p_extra_languages != NULL))
518 for (unsigned i = 0; i < dst->i_extra_languages; i++)
520 if (src->p_extra_languages[i].psz_language != NULL)
521 dst->p_extra_languages[i].psz_language = strdup(src->p_extra_languages[i].psz_language);
522 if (src->p_extra_languages[i].psz_description != NULL)
523 dst->p_extra_languages[i].psz_description = strdup(src->p_extra_languages[i].psz_description);
525 dst->i_extra_languages = src->i_extra_languages;
527 else
529 dst->i_extra_languages = 0;
530 ret = VLC_ENOMEM;
533 return ret;
536 void es_format_Clean(es_format_t *fmt)
538 free(fmt->psz_language);
539 free(fmt->psz_description);
540 assert(fmt->i_extra == 0 || fmt->p_extra != NULL);
541 free(fmt->p_extra);
543 if (fmt->i_cat == VIDEO_ES)
544 video_format_Clean( &fmt->video );
545 if (fmt->i_cat == SPU_ES)
546 free(fmt->subs.psz_encoding);
548 for (unsigned i = 0; i < fmt->i_extra_languages; i++)
550 free(fmt->p_extra_languages[i].psz_language);
551 free(fmt->p_extra_languages[i].psz_description);
553 free(fmt->p_extra_languages);
555 /* es_format_Clean can be called multiple times */
556 es_format_Init(fmt, UNKNOWN_ES, 0);
559 bool es_format_IsSimilar( const es_format_t *p_fmt1, const es_format_t *p_fmt2 )
561 if( p_fmt1->i_cat != p_fmt2->i_cat ||
562 vlc_fourcc_GetCodec( p_fmt1->i_cat, p_fmt1->i_codec ) !=
563 vlc_fourcc_GetCodec( p_fmt2->i_cat, p_fmt2->i_codec ) )
564 return false;
566 switch( p_fmt1->i_cat )
568 case AUDIO_ES:
570 audio_format_t a1 = p_fmt1->audio;
571 audio_format_t a2 = p_fmt2->audio;
573 if( a1.i_format && a2.i_format && a1.i_format != a2.i_format )
574 return false;
575 if( a1.channel_type != a2.channel_type ||
576 a1.i_rate != a2.i_rate ||
577 a1.i_channels != a2.i_channels ||
578 a1.i_physical_channels != a2.i_physical_channels ||
579 a1.i_chan_mode != a2.i_chan_mode )
580 return false;
581 if( p_fmt1->i_profile != p_fmt2->i_profile )
582 return false;
583 return true;
586 case VIDEO_ES:
588 video_format_t v1 = p_fmt1->video;
589 video_format_t v2 = p_fmt2->video;
590 if( !v1.i_chroma )
591 v1.i_chroma = vlc_fourcc_GetCodec( p_fmt1->i_cat, p_fmt1->i_codec );
592 if( !v2.i_chroma )
593 v2.i_chroma = vlc_fourcc_GetCodec( p_fmt2->i_cat, p_fmt2->i_codec );
594 return video_format_IsSimilar( &v1, &v2 );
597 case SPU_ES:
598 default:
599 return true;