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>
35 #include <vlc_filter.h>
37 #ifdef HAVE_LIBSWSCALE_SWSCALE_H
38 # include <libswscale/swscale.h>
39 # include <libavcodec/avcodec.h>
40 #elif defined(HAVE_FFMPEG_SWSCALE_H)
41 # include <ffmpeg/swscale.h>
42 # include <ffmpeg/avcodec.h>
45 /* Gruikkkkkkkkkk!!!!! */
46 #include "../codec/avcodec/avcodec.h"
49 #define AVPALETTE_SIZE (256 * sizeof(uint32_t))
51 /*****************************************************************************
53 *****************************************************************************/
54 static int OpenScaler( vlc_object_t * );
55 static void CloseScaler( vlc_object_t * );
57 #define SCALEMODE_TEXT N_("Scaling mode")
58 #define SCALEMODE_LONGTEXT N_("Scaling mode to use.")
60 static const int pi_mode_values[] = { 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 };
61 const char *const ppsz_mode_descriptions[] =
62 { N_("Fast bilinear"), N_("Bilinear"), N_("Bicubic (good quality)"),
63 N_("Experimental"), N_("Nearest neighbour (bad quality)"),
64 N_("Area"), N_("Luma bicubic / chroma bilinear"), N_("Gauss"),
65 N_("SincR"), N_("Lanczos"), N_("Bicubic spline") };
68 set_description( N_("Video scaling filter") )
69 set_shortname( N_("Swscale" ) )
70 set_capability( "video filter2", 150 )
71 set_category( CAT_VIDEO )
72 set_subcategory( SUBCAT_VIDEO_VFILTER )
73 set_callbacks( OpenScaler, CloseScaler )
74 add_integer( "swscale-mode", 2, NULL, SCALEMODE_TEXT, SCALEMODE_LONGTEXT, true )
75 change_integer_list( pi_mode_values, ppsz_mode_descriptions, NULL );
78 /* Version checking */
79 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
80 /****************************************************************************
82 ****************************************************************************/
84 void *( *swscale_fast_memcpy )( void *, const void *, size_t );
87 * Internal swscale filter structure.
91 SwsFilter *p_src_filter;
92 SwsFilter *p_dst_filter;
93 int i_cpu_mask, i_sws_flags;
95 video_format_t fmt_in;
96 video_format_t fmt_out;
98 struct SwsContext *ctx;
99 struct SwsContext *ctxA;
109 static picture_t *Filter( filter_t *, picture_t * );
110 static int Init( filter_t * );
111 static void Clean( filter_t * );
121 } ScalerConfiguration;
123 static int GetParameters( ScalerConfiguration *,
124 const video_format_t *p_fmti,
125 const video_format_t *p_fmto,
126 int i_sws_flags_default );
128 static int GetSwsCpuMask(void);
130 /* SwScaler point resize quality seems really bad, let our scale module do it
131 * (change it to true to try) */
132 #define ALLOW_YUVP (false)
133 /* SwScaler does not like too small picture */
134 #define MINIMUM_WIDTH (32)
136 /* XXX is it always 3 even for BIG_ENDIAN (blend.c seems to think so) ? */
139 /*****************************************************************************
140 * OpenScaler: probe the filter and return score
141 *****************************************************************************/
142 static int OpenScaler( vlc_object_t *p_this )
144 filter_t *p_filter = (filter_t*)p_this;
149 if( GetParameters( NULL,
150 &p_filter->fmt_in.video,
151 &p_filter->fmt_out.video, 0 ) )
155 p_filter->pf_video_filter = Filter;
156 /* Allocate the memory needed to store the decoder's structure */
157 if( ( p_filter->p_sys = p_sys = malloc(sizeof(filter_sys_t)) ) == NULL )
160 /* FIXME pointer assignment may not be atomic */
161 swscale_fast_memcpy = vlc_memcpy;
163 /* Set CPU capabilities */
164 p_sys->i_cpu_mask = GetSwsCpuMask();
167 i_sws_mode = var_CreateGetInteger( p_filter, "swscale-mode" );
170 case 0: p_sys->i_sws_flags = SWS_FAST_BILINEAR; break;
171 case 1: p_sys->i_sws_flags = SWS_BILINEAR; break;
172 case 2: p_sys->i_sws_flags = SWS_BICUBIC; break;
173 case 3: p_sys->i_sws_flags = SWS_X; break;
174 case 4: p_sys->i_sws_flags = SWS_POINT; break;
175 case 5: p_sys->i_sws_flags = SWS_AREA; break;
176 case 6: p_sys->i_sws_flags = SWS_BICUBLIN; break;
177 case 7: p_sys->i_sws_flags = SWS_GAUSS; break;
178 case 8: p_sys->i_sws_flags = SWS_SINC; break;
179 case 9: p_sys->i_sws_flags = SWS_LANCZOS; break;
180 case 10: p_sys->i_sws_flags = SWS_SPLINE; break;
181 default: p_sys->i_sws_flags = SWS_BICUBIC; i_sws_mode = 2; break;
184 p_sys->p_src_filter = NULL;
185 p_sys->p_dst_filter = NULL;
190 p_sys->p_src_a = NULL;
191 p_sys->p_dst_a = NULL;
192 p_sys->p_src_e = NULL;
193 p_sys->p_dst_e = NULL;
194 memset( &p_sys->fmt_in, 0, sizeof(p_sys->fmt_in) );
195 memset( &p_sys->fmt_out, 0, sizeof(p_sys->fmt_out) );
197 if( Init( p_filter ) )
199 if( p_sys->p_src_filter )
200 sws_freeFilter( p_sys->p_src_filter );
205 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s with scaling using %s",
206 p_filter->fmt_in.video.i_width, p_filter->fmt_in.video.i_height,
207 (char *)&p_filter->fmt_in.video.i_chroma,
208 p_filter->fmt_out.video.i_width, p_filter->fmt_out.video.i_height,
209 (char *)&p_filter->fmt_out.video.i_chroma,
210 ppsz_mode_descriptions[i_sws_mode] );
215 /*****************************************************************************
216 * CloseFilter: clean up the filter
217 *****************************************************************************/
218 static void CloseScaler( vlc_object_t *p_this )
220 filter_t *p_filter = (filter_t*)p_this;
221 filter_sys_t *p_sys = p_filter->p_sys;
224 if( p_sys->p_src_filter )
225 sws_freeFilter( p_sys->p_src_filter );
229 /*****************************************************************************
231 *****************************************************************************/
232 static int GetSwsCpuMask(void)
234 const unsigned int i_cpu = vlc_CPU();
237 if( i_cpu & CPU_CAPABILITY_MMX )
238 i_sws_cpu |= SWS_CPU_CAPS_MMX;
239 #if (LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0))
240 if( i_cpu & CPU_CAPABILITY_MMXEXT )
241 i_sws_cpu |= SWS_CPU_CAPS_MMX2;
243 if( i_cpu & CPU_CAPABILITY_3DNOW )
244 i_sws_cpu |= SWS_CPU_CAPS_3DNOW;
246 if( i_cpu & CPU_CAPABILITY_ALTIVEC )
247 i_sws_cpu |= SWS_CPU_CAPS_ALTIVEC;
251 static bool IsFmtSimilar( const video_format_t *p_fmt1, const video_format_t *p_fmt2 )
253 return p_fmt1->i_chroma == p_fmt2->i_chroma &&
254 p_fmt1->i_width == p_fmt2->i_width &&
255 p_fmt1->i_height == p_fmt2->i_height;
258 static int GetParameters( ScalerConfiguration *p_cfg,
259 const video_format_t *p_fmti,
260 const video_format_t *p_fmto,
261 int i_sws_flags_default )
266 bool b_has_ai = false;
267 bool b_has_ao = false;
268 int i_sws_flags = i_sws_flags_default;
270 GetFfmpegChroma( &i_fmti, *p_fmti );
271 GetFfmpegChroma( &i_fmto, *p_fmto );
273 if( p_fmti->i_chroma == p_fmto->i_chroma )
275 if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'P' ) && ALLOW_YUVP )
277 i_fmti = i_fmto = PIX_FMT_GRAY8;
278 i_sws_flags = SWS_POINT;
282 if( p_fmti->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'A' ) )
284 i_fmti = PIX_FMT_YUV444P;
287 else if( p_fmti->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
289 i_fmti = PIX_FMT_BGR32;
293 if( p_fmto->i_chroma == VLC_FOURCC( 'Y', 'U', 'V', 'A' ) )
295 i_fmto = PIX_FMT_YUV444P;
298 else if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
300 i_fmto = PIX_FMT_BGR32;
306 p_cfg->i_fmti = i_fmti;
307 p_cfg->i_fmto = i_fmto;
308 p_cfg->b_has_a = b_has_ai && b_has_ao;
309 p_cfg->b_add_a = (!b_has_ai) && b_has_ao;
310 p_cfg->b_copy = i_fmti == i_fmto && p_fmti->i_width == p_fmto->i_width && p_fmti->i_height == p_fmto->i_height;
311 p_cfg->i_sws_flags = i_sws_flags;
314 if( i_fmti < 0 || i_fmto < 0 )
320 static int Init( filter_t *p_filter )
322 filter_sys_t *p_sys = p_filter->p_sys;
323 const video_format_t *p_fmti = &p_filter->fmt_in.video;
324 const video_format_t *p_fmto = &p_filter->fmt_out.video;
326 if( IsFmtSimilar( p_fmti, &p_sys->fmt_in ) &&
327 IsFmtSimilar( p_fmto, &p_sys->fmt_out ) &&
334 /* Init with new parameters */
335 ScalerConfiguration cfg;
336 if( GetParameters( &cfg, p_fmti, p_fmto, p_sys->i_sws_flags ) )
338 msg_Err( p_filter, "format not supported" );
341 if( p_fmti->i_width <= 0 || p_fmto->i_width <= 0 )
343 msg_Err( p_filter, "0 width not supported" );
347 /* swscale does not like too small width */
348 p_sys->i_extend_factor = 1;
349 while( __MIN( p_fmti->i_width, p_fmto->i_width ) * p_sys->i_extend_factor < MINIMUM_WIDTH)
350 p_sys->i_extend_factor++;
352 const unsigned i_fmti_width = p_fmti->i_width * p_sys->i_extend_factor;
353 const unsigned i_fmto_width = p_fmto->i_width * p_sys->i_extend_factor;
354 for( int n = 0; n < (cfg.b_has_a ? 2 : 1); n++ )
356 const int i_fmti = n == 0 ? cfg.i_fmti : PIX_FMT_GRAY8;
357 const int i_fmto = n == 0 ? cfg.i_fmto : PIX_FMT_GRAY8;
358 struct SwsContext *ctx;
360 ctx = sws_getContext( i_fmti_width, p_fmti->i_height, i_fmti,
361 i_fmto_width, p_fmto->i_height, i_fmto,
362 cfg.i_sws_flags | p_sys->i_cpu_mask,
363 p_sys->p_src_filter, p_sys->p_dst_filter, 0 );
371 p_sys->p_src_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmti_width, p_fmti->i_height, 0 );
372 p_sys->p_dst_a = picture_New( VLC_FOURCC( 'G', 'R', 'E', 'Y' ), i_fmto_width, p_fmto->i_height, 0 );
374 if( p_sys->i_extend_factor != 1 )
376 p_sys->p_src_e = picture_New( p_fmti->i_chroma, i_fmti_width, p_fmti->i_height, 0 );
377 p_sys->p_dst_e = picture_New( p_fmto->i_chroma, i_fmto_width, p_fmto->i_height, 0 );
379 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 );
380 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 );
384 ( cfg.b_has_a && ( !p_sys->ctxA || !p_sys->p_src_a || !p_sys->p_dst_a ) ) ||
385 ( p_sys->i_extend_factor != 1 && ( !p_sys->p_src_e || !p_sys->p_dst_e ) ) )
387 msg_Err( p_filter, "could not init SwScaler and/or allocate memory" );
392 p_sys->b_add_a = cfg.b_add_a;
393 p_sys->b_copy = cfg.b_copy;
394 p_sys->fmt_in = *p_fmti;
395 p_sys->fmt_out = *p_fmto;
398 msg_Dbg( p_filter, "%ix%i chroma: %4.4s -> %ix%i chroma: %4.4s extend by %d",
399 p_fmti->i_width, p_fmti->i_height, (char *)&p_fmti->i_chroma,
400 p_fmto->i_width, p_fmto->i_height, (char *)&p_fmto->i_chroma,
401 p_sys->i_extend_factor );
405 static void Clean( filter_t *p_filter )
407 filter_sys_t *p_sys = p_filter->p_sys;
410 picture_Release( p_sys->p_src_e );
412 picture_Release( p_sys->p_dst_e );
415 picture_Release( p_sys->p_src_a );
417 picture_Release( p_sys->p_dst_a );
420 sws_freeContext( p_sys->ctxA );
423 sws_freeContext( p_sys->ctx );
425 /* We have to set it to null has we call be called again :( */
428 p_sys->p_src_a = NULL;
429 p_sys->p_dst_a = NULL;
430 p_sys->p_src_e = NULL;
431 p_sys->p_dst_e = NULL;
434 static void GetPixels( uint8_t *pp_pixel[3], int pi_pitch[3],
435 const picture_t *p_picture,
436 int i_plane_start, int i_plane_count )
439 for( n = 0; n < __MIN(i_plane_count, p_picture->i_planes-i_plane_start ); n++ )
441 pp_pixel[n] = p_picture->p[i_plane_start+n].p_pixels;
442 pi_pitch[n] = p_picture->p[i_plane_start+n].i_pitch;
451 static void ExtractA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
453 plane_t *d = &p_dst->p[0];
454 const plane_t *s = &p_src->p[0];
456 for( unsigned y = 0; y < i_height; y++ )
457 for( unsigned x = 0; x < i_width; x++ )
458 d->p_pixels[y*d->i_pitch+x] = s->p_pixels[y*s->i_pitch+4*x+OFFSET_A];
460 static void InjectA( picture_t *p_dst, const picture_t *p_src, unsigned i_width, unsigned i_height )
462 plane_t *d = &p_dst->p[0];
463 const plane_t *s = &p_src->p[0];
465 for( unsigned y = 0; y < i_height; y++ )
466 for( unsigned x = 0; x < i_width; x++ )
467 d->p_pixels[y*d->i_pitch+4*x+OFFSET_A] = s->p_pixels[y*s->i_pitch+x];
469 static void FillA( plane_t *d, int i_offset )
471 for( int y = 0; y < d->i_visible_lines; y++ )
472 for( int x = 0; x < d->i_visible_pitch; x += d->i_pixel_pitch )
473 d->p_pixels[y*d->i_pitch+x+i_offset] = 0xff;
476 static void CopyPad( picture_t *p_dst, const picture_t *p_src )
478 picture_Copy( p_dst, p_src );
479 for( int n = 0; n < p_dst->i_planes; n++ )
481 const plane_t *s = &p_src->p[n];
482 plane_t *d = &p_dst->p[n];
484 for( int y = 0; y < s->i_lines; y++ )
486 for( int x = s->i_visible_pitch; x < d->i_visible_pitch; x += s->i_pixel_pitch )
487 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 );
492 static void Convert( filter_t *p_filter, struct SwsContext *ctx,
493 picture_t *p_dst, picture_t *p_src, int i_height, int i_plane_start, int i_plane_count )
495 uint8_t palette[AVPALETTE_SIZE];
497 uint8_t *src[3]; int src_stride[3];
498 uint8_t *dst[3]; int dst_stride[3];
500 GetPixels( src, src_stride, p_src, i_plane_start, i_plane_count );
501 if( p_filter->fmt_in.video.i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'P' ) )
503 memset( palette, 0, sizeof(palette) );
504 if( p_filter->fmt_in.video.p_palette )
505 memcpy( palette, p_filter->fmt_in.video.p_palette->palette,
506 __MIN( sizeof(video_palette_t), AVPALETTE_SIZE ) );
511 GetPixels( dst, dst_stride, p_dst, i_plane_start, i_plane_count );
513 #if LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0)
514 sws_scale( ctx, src, src_stride, 0, i_height,
517 sws_scale_ordered( ctx, src, src_stride, 0, i_height,
522 /****************************************************************************
523 * Filter: the whole thing
524 ****************************************************************************
525 * This function is called just after the thread is launched.
526 ****************************************************************************/
527 static picture_t *Filter( filter_t *p_filter, picture_t *p_pic )
529 filter_sys_t *p_sys = p_filter->p_sys;
530 const video_format_t *p_fmti = &p_filter->fmt_in.video;
531 const video_format_t *p_fmto = &p_filter->fmt_out.video;
532 picture_t *p_pic_dst;
534 /* Check if format properties changed */
535 if( Init( p_filter ) )
537 picture_Release( p_pic );
541 /* Request output picture */
542 p_pic_dst = filter_NewPicture( p_filter );
545 picture_Release( p_pic );
550 picture_t *p_src = p_pic;
551 picture_t *p_dst = p_pic_dst;
552 if( p_sys->i_extend_factor != 1 )
554 p_src = p_sys->p_src_e;
555 p_dst = p_sys->p_dst_e;
557 CopyPad( p_src, p_pic );
561 picture_CopyPixels( p_dst, p_src );
563 Convert( p_filter, p_sys->ctx, p_dst, p_src, p_fmti->i_height, 0, 3 );
566 /* We extract the A plane to rescale it, and then we reinject it. */
567 if( p_fmti->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
568 ExtractA( p_sys->p_src_a, p_src, p_fmti->i_width * p_sys->i_extend_factor, p_fmti->i_height );
570 plane_CopyPixels( p_sys->p_src_a->p, p_src->p+A_PLANE );
572 Convert( p_filter, p_sys->ctxA, p_sys->p_dst_a, p_sys->p_src_a, p_fmti->i_height, 0, 1 );
573 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
574 InjectA( p_dst, p_sys->p_dst_a, p_fmto->i_width * p_sys->i_extend_factor, p_fmto->i_height );
576 plane_CopyPixels( p_dst->p+A_PLANE, p_sys->p_dst_a->p );
578 else if( p_sys->b_add_a )
580 /* We inject a complete opaque alpha plane */
581 if( p_fmto->i_chroma == VLC_FOURCC( 'R', 'G', 'B', 'A' ) )
582 FillA( &p_dst->p[0], OFFSET_A );
584 FillA( &p_dst->p[A_PLANE], 0 );
587 if( p_sys->i_extend_factor != 1 )
589 picture_CopyPixels( p_pic_dst, p_dst );
592 picture_CopyProperties( p_pic_dst, p_pic );
593 picture_Release( p_pic );
597 #else /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */
599 int OpenScaler( vlc_object_t *p_this )
604 void CloseScaler( vlc_object_t *p_this )
608 #endif /* LIBSWSCALE_VERSION_INT >= ((0<<16)+(5<<8)+0) */