1 /*****************************************************************************
2 * swscale.c: scaling and chroma conversion using libswscale
3 *****************************************************************************
4 * Copyright (C) 1999-2008 the VideoLAN team
7 * Authors: Laurent Aimar <fenrir@via.ecp.fr>
8 * Gildas Bazin <gbazin@videolan.org>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
23 *****************************************************************************/
25 /*****************************************************************************
27 *****************************************************************************/
32 #include <vlc_common.h>
33 #include <vlc_plugin.h>
34 #include <vlc_filter.h>
36 #ifdef HAVE_LIBSWSCALE_SWSCALE_H
37 # include <libswscale/swscale.h>
38 # include <libavcodec/avcodec.h>
39 #elif defined(HAVE_FFMPEG_SWSCALE_H)
40 # include <ffmpeg/swscale.h>
41 # include <ffmpeg/avcodec.h>
44 /* Gruikkkkkkkkkk!!!!! */
45 #include "../codec/avcodec/avcodec.h"
48 #define AVPALETTE_SIZE (256 * sizeof(uint32_t))
50 /*****************************************************************************
52 *****************************************************************************/
53 static int OpenScaler( vlc_object_t * );
54 static void CloseScaler( vlc_object_t * );
56 #define SCALEMODE_TEXT N_("Scaling mode")
57 #define SCALEMODE_LONGTEXT N_("Scaling mode to use.")
59 static const int pi_mode_values[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
60 const char *const ppsz_mode_descriptions[] =
61 { N_("Fast bilinear"), N_("Bilinear"), N_("Bicubic (good quality)"),
62 N_("Experimental"), N_("Nearest neighbour (bad quality)"),
63 N_("Area"), N_("Luma bicubic / chroma bilinear"), N_("Gauss"),
64 N_("SincR"), N_("Lanczos"), N_("Bicubic spline") };
67 set_description( N_("Video scaling filter") )
68 set_shortname( N_("Swscale" ) )
69 set_capability( "video filter2", 150 )
70 set_category( CAT_VIDEO )
71 set_subcategory( SUBCAT_VIDEO_VFILTER )
72 set_callbacks( OpenScaler, CloseScaler )
73 add_integer( "swscale-mode", 2, NULL, SCALEMODE_TEXT, SCALEMODE_LONGTEXT, true )
74 change_integer_list( pi_mode_values, ppsz_mode_descriptions, NULL )
77 /* Version checking */
78 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
79 /****************************************************************************
81 ****************************************************************************/
83 void *( *swscale_fast_memcpy )( void *, const void *, size_t );
86 * Internal swscale filter structure.
90 SwsFilter *p_src_filter;
91 SwsFilter *p_dst_filter;
92 int i_cpu_mask, i_sws_flags;
94 video_format_t fmt_in;
95 video_format_t fmt_out;
97 struct SwsContext *ctx;
98 struct SwsContext *ctxA;
108 static picture_t *Filter( filter_t *, picture_t * );
109 static int Init( filter_t * );
110 static void Clean( filter_t * );
120 } ScalerConfiguration;
122 static int GetParameters( ScalerConfiguration *,
123 const video_format_t *p_fmti,
124 const video_format_t *p_fmto,
125 int i_sws_flags_default );
127 static int GetSwsCpuMask(void);
129 /* SwScaler point resize quality seems really bad, let our scale module do it
130 * (change it to true to try) */
131 #define ALLOW_YUVP (false)
132 /* SwScaler does not like too small picture */
133 #define MINIMUM_WIDTH (32)
135 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
138 /*****************************************************************************
139 * OpenScaler: probe the filter and return score
140 *****************************************************************************/
141 static int OpenScaler( vlc_object_t *p_this )
143 filter_t *p_filter = (filter_t*)p_this;
148 if( GetParameters( NULL,
149 &p_filter->fmt_in.video,
150 &p_filter->fmt_out.video, 0 ) )
154 p_filter->pf_video_filter = Filter;
155 /* Allocate the memory needed to store the decoder's structure */
156 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
159 /* FIXME pointer assignment may not be atomic */
160 swscale_fast_memcpy = vlc_memcpy;
162 /* Set CPU capabilities */
163 p_sys->i_cpu_mask = GetSwsCpuMask();
166 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
169 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
170 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
171 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
172 case 3: p_sys->i_sws_flags = SWS_X; break;
173 case 4: p_sys->i_sws_flags = SWS_POINT; break;
174 case 5: p_sys->i_sws_flags = SWS_AREA; break;
175 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
176 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
177 case 8: p_sys->i_sws_flags = SWS_SINC; break;
178 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
179 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
180 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
183 p_sys->p_src_filter = NULL;
184 p_sys->p_dst_filter = NULL;
189 p_sys->p_src_a = NULL;
190 p_sys->p_dst_a = NULL;
191 p_sys->p_src_e = NULL;
192 p_sys->p_dst_e = NULL;
193 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
194 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
196 if( Init( p_filter ) )
198 if( p_sys->p_src_filter )
199 sws_freeFilter( p_sys->p_src_filter );
204 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
205 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
206 (char *)&p_filter->fmt_in.video.i_chroma,
207 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
208 (char *)&p_filter->fmt_out.video.i_chroma,
209 ppsz_mode_descriptions[i_sws_mode] );
214 /*****************************************************************************
215 * CloseFilter: clean up the filter
216 *****************************************************************************/
217 static void CloseScaler( vlc_object_t *p_this )
219 filter_t *p_filter = (filter_t*)p_this;
220 filter_sys_t *p_sys = p_filter->p_sys;
223 if( p_sys->p_src_filter )
224 sws_freeFilter( p_sys->p_src_filter );
228 /*****************************************************************************
230 *****************************************************************************/
231 static int GetSwsCpuMask(void)
233 const unsigned int i_cpu = vlc_CPU();
236 if( i_cpu & CPU_CAPABILITY_MMX )
237 i_sws_cpu |= SWS_CPU_CAPS_MMX;
238 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
239 if( i_cpu & CPU_CAPABILITY_MMXEXT )
240 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
242 if( i_cpu & CPU_CAPABILITY_3DNOW )
243 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
245 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
246 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
250 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
252 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
253 p_fmt1->i_width == p_fmt2->i_width &&
254 p_fmt1->i_height == p_fmt2->i_height;
257 static int GetParameters( ScalerConfiguration *p_cfg,
258 const video_format_t *p_fmti,
259 const video_format_t *p_fmto,
260 int i_sws_flags_default )
265 bool b_has_ai = false;
266 bool b_has_ao = false;
267 int i_sws_flags = i_sws_flags_default;
269 GetFfmpegChroma( &i_fmti, *p_fmti );
270 GetFfmpegChroma( &i_fmto, *p_fmto );
272 if( p_fmti->i_chroma == p_fmto->i_chroma )
274 if( p_fmti->i_chroma == VLC_CODEC_YUVP && ALLOW_YUVP )
276 i_fmti = i_fmto = PIX_FMT_GRAY8;
277 i_sws_flags = SWS_POINT;
281 if( p_fmti->i_chroma == VLC_CODEC_YUVA )
283 i_fmti = PIX_FMT_YUV444P;
286 else if( p_fmti->i_chroma == VLC_CODEC_RGBA )
288 i_fmti = PIX_FMT_BGR32;
292 if( p_fmto->i_chroma == VLC_CODEC_YUVA )
294 i_fmto = PIX_FMT_YUV444P;
297 else if( p_fmto->i_chroma == VLC_CODEC_RGBA )
299 i_fmto = PIX_FMT_BGR32;
303 /* FIXME TODO removed when ffmpeg is fixed
304 * Without SWS_ACCURATE_RND the quality is really bad for some conversions */
310 i_sws_flags |= SWS_ACCURATE_RND;
316 p_cfg->i_fmti = i_fmti;
317 p_cfg->i_fmto = i_fmto;
318 p_cfg->b_has_a = b_has_ai && b_has_ao;
319 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
320 p_cfg->b_copy = i_fmti == i_fmto && p_fmti->i_width == p_fmto->i_width && p_fmti->i_height == p_fmto->i_height;
321 p_cfg->i_sws_flags = i_sws_flags;
324 if( i_fmti < 0 || i_fmto < 0 )
330 static int Init( filter_t *p_filter )
332 filter_sys_t *p_sys = p_filter->p_sys;
333 const video_format_t *p_fmti = &p_filter->fmt_in.video;
334 const video_format_t *p_fmto = &p_filter->fmt_out.video;
336 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
337 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
344 /* Init with new parameters */
345 ScalerConfiguration cfg;
346 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
348 msg_Err( p_filter, "format not supported" );
351 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
353 msg_Err( p_filter, "0 width not supported" );
357 /* swscale does not like too small width */
358 p_sys->i_extend_factor = 1;
359 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
360 p_sys->i_extend_factor++;
362 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
363 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
364 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
366 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
367 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
368 struct SwsContext *ctx;
370 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
371 i_fmto_width, p_fmto->i_height, i_fmto,
372 cfg.i_sws_flags | p_sys->i_cpu_mask,
373 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
381 p_sys->p_src_a = picture_New( VLC_CODEC_GREY, i_fmti_width, p_fmti->i_height, 0 );
382 p_sys->p_dst_a = picture_New( VLC_CODEC_GREY, i_fmto_width, p_fmto->i_height, 0 );
384 if( p_sys->i_extend_factor != 1 )
386 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0 );
387 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0 );
389 memset( p_sys->p_src_e->p[0].p_pixels, 0, p_sys->p_src_e->p[0].i_pitch * p_sys->p_src_e->p[0].i_lines );
390 memset( p_sys->p_dst_e->p[0].p_pixels, 0, p_sys->p_dst_e->p[0].i_pitch * p_sys->p_dst_e->p[0].i_lines );
394 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
395 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
397 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
402 p_sys->b_add_a = cfg.b_add_a;
403 p_sys->b_copy = cfg.b_copy;
404 p_sys->fmt_in = *p_fmti;
405 p_sys->fmt_out = *p_fmto;
408 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
409 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
410 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
411 p_sys->i_extend_factor );
415 static void Clean( filter_t *p_filter )
417 filter_sys_t *p_sys = p_filter->p_sys;
420 picture_Release( p_sys->p_src_e );
422 picture_Release( p_sys->p_dst_e );
425 picture_Release( p_sys->p_src_a );
427 picture_Release( p_sys->p_dst_a );
430 sws_freeContext( p_sys->ctxA );
433 sws_freeContext( p_sys->ctx );
435 /* We have to set it to null has we call be called again :( */
438 p_sys->p_src_a = NULL;
439 p_sys->p_dst_a = NULL;
440 p_sys->p_src_e = NULL;
441 p_sys->p_dst_e = NULL;
444 static void GetPixels( uint8_t *pp_pixel[4], int pi_pitch[4],
445 const picture_t *p_picture,
446 int i_plane_start, int i_plane_count )
449 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
451 pp_pixel[n] = p_picture->p[i_plane_start+n].p_pixels;
452 pi_pitch[n] = p_picture->p[i_plane_start+n].i_pitch;
461 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
463 plane_t *d = &p_dst->p[0];
464 const plane_t *s = &p_src->p[0];
466 for( unsigned y = 0; y < i_height; y++ )
467 for( unsigned x = 0; x < i_width; x++ )
468 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
470 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
472 plane_t *d = &p_dst->p[0];
473 const plane_t *s = &p_src->p[0];
475 for( unsigned y = 0; y < i_height; y++ )
476 for( unsigned x = 0; x < i_width; x++ )
477 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
479 static void FillA( plane_t *d, int i_offset )
481 for( int y = 0; y < d->i_visible_lines; y++ )
482 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
483 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
486 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
488 picture_Copy( p_dst, p_src );
489 for( int n = 0; n < p_dst->i_planes; n++ )
491 const plane_t *s = &p_src->p[n];
492 plane_t *d = &p_dst->p[n];
494 for( int y = 0; y < s->i_lines; y++ )
496 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
497 memcpy( &d->p_pixels[y*d->i_pitch + x], &d->p_pixels[y*d->i_pitch + s->i_visible_pitch - s->i_pixel_pitch], s->i_pixel_pitch );
502 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
503 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count )
505 uint8_t palette[AVPALETTE_SIZE];
507 uint8_t *src[4]; int src_stride[4];
508 uint8_t *dst[4]; int dst_stride[4];
510 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count );
511 if( p_filter->fmt_in.video.i_chroma == VLC_CODEC_RGBP )
513 memset( palette, 0, sizeof(palette) );
514 if( p_filter->fmt_in.video.p_palette )
515 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
516 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
521 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count );
523 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
524 sws_scale( ctx, src, src_stride, 0, i_height,
527 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
532 /****************************************************************************
533 * Filter: the whole thing
534 ****************************************************************************
535 * This function is called just after the thread is launched.
536 ****************************************************************************/
537 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
539 filter_sys_t *p_sys = p_filter->p_sys;
540 const video_format_t *p_fmti = &p_filter->fmt_in.video;
541 const video_format_t *p_fmto = &p_filter->fmt_out.video;
542 picture_t *p_pic_dst;
544 /* Check if format properties changed */
545 if( Init( p_filter ) )
547 picture_Release( p_pic );
551 /* Request output picture */
552 p_pic_dst = filter_NewPicture( p_filter );
555 picture_Release( p_pic );
560 picture_t *p_src = p_pic;
561 picture_t *p_dst = p_pic_dst;
562 if( p_sys->i_extend_factor != 1 )
564 p_src = p_sys->p_src_e;
565 p_dst = p_sys->p_dst_e;
567 CopyPad( p_src, p_pic );
571 picture_CopyPixels( p_dst, p_src );
573 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3 );
576 /* We extract the A plane to rescale it, and then we reinject it. */
577 if( p_fmti->i_chroma == VLC_CODEC_RGBA )
578 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
580 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
582 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1 );
583 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
584 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
586 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
588 else if( p_sys->b_add_a )
590 /* We inject a complete opaque alpha plane */
591 if( p_fmto->i_chroma == VLC_CODEC_RGBA )
592 FillA( &p_dst->p[0], OFFSET_A );
594 FillA( &p_dst->p[A_PLANE], 0 );
597 if( p_sys->i_extend_factor != 1 )
599 picture_CopyPixels( p_pic_dst, p_dst );
602 picture_CopyProperties( p_pic_dst, p_pic );
603 picture_Release( p_pic );
607 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
609 int OpenScaler( vlc_object_t *p_this )
614 void CloseScaler( vlc_object_t *p_this )
618 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */