1 /*****************************************************************************
2 * image.c : wrapper for image reading/writing facilities
3 *****************************************************************************
4 * Copyright (C) 2004-2007 the VideoLAN team
7 * Author: Gildas Bazin <gbazin@videolan.org>
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., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
22 *****************************************************************************/
26 * This file contains the functions to handle the image_handler_t type
29 /*****************************************************************************
31 *****************************************************************************/
40 #include <vlc_common.h>
41 #include <vlc_codec.h>
43 #include <vlc_filter.h>
45 #include <vlc_image.h>
46 #include <vlc_stream.h>
47 #include <vlc_charset.h>
50 static picture_t *ImageRead( image_handler_t *, block_t *,
51 video_format_t *, video_format_t * );
52 static picture_t *ImageReadUrl( image_handler_t *, const char *,
53 video_format_t *, video_format_t * );
54 static block_t *ImageWrite( image_handler_t *, picture_t *,
55 video_format_t *, video_format_t * );
56 static int ImageWriteUrl( image_handler_t *, picture_t *,
57 video_format_t *, video_format_t *, const char * );
59 static picture_t *ImageConvert( image_handler_t *, picture_t *,
60 video_format_t *, video_format_t * );
61 static picture_t *ImageFilter( image_handler_t *, picture_t *,
62 video_format_t *, const char *psz_module );
64 static decoder_t *CreateDecoder( vlc_object_t *, video_format_t * );
65 static void DeleteDecoder( decoder_t * );
66 static encoder_t *CreateEncoder( vlc_object_t *, video_format_t *,
68 static void DeleteEncoder( encoder_t * );
69 static filter_t *CreateFilter( vlc_object_t *, es_format_t *,
70 video_format_t *, const char * );
71 static void DeleteFilter( filter_t * );
73 static vlc_fourcc_t Ext2Fourcc( const char * );
74 /*static const char *Fourcc2Ext( vlc_fourcc_t );*/
77 * Create an image_handler_t instance
80 image_handler_t *__image_HandlerCreate( vlc_object_t *p_this )
82 image_handler_t *p_image = calloc( 1, sizeof(image_handler_t) );
86 p_image->p_parent = p_this;
88 p_image->pf_read = ImageRead;
89 p_image->pf_read_url = ImageReadUrl;
90 p_image->pf_write = ImageWrite;
91 p_image->pf_write_url = ImageWriteUrl;
92 p_image->pf_convert = ImageConvert;
93 p_image->pf_filter = ImageFilter;
99 * Delete the image_handler_t instance
102 void image_HandlerDelete( image_handler_t *p_image )
104 if( !p_image ) return;
106 if( p_image->p_dec ) DeleteDecoder( p_image->p_dec );
107 if( p_image->p_enc ) DeleteEncoder( p_image->p_enc );
108 if( p_image->p_filter ) DeleteFilter( p_image->p_filter );
119 static picture_t *ImageRead( image_handler_t *p_image, block_t *p_block,
120 video_format_t *p_fmt_in,
121 video_format_t *p_fmt_out )
123 picture_t *p_pic = NULL, *p_tmp;
125 /* Check if we can reuse the current decoder */
126 if( p_image->p_dec &&
127 p_image->p_dec->fmt_in.i_codec != p_fmt_in->i_chroma )
129 DeleteDecoder( p_image->p_dec );
133 /* Start a decoder */
134 if( !p_image->p_dec )
136 p_image->p_dec = CreateDecoder( p_image->p_parent, p_fmt_in );
137 if( !p_image->p_dec ) return NULL;
140 p_block->i_pts = p_block->i_dts = mdate();
141 while( (p_tmp = p_image->p_dec->pf_decode_video( p_image->p_dec, &p_block ))
145 picture_Release( p_pic );
151 msg_Warn( p_image->p_parent, "no image decoded" );
155 if( !p_fmt_out->i_chroma )
156 p_fmt_out->i_chroma = p_image->p_dec->fmt_out.video.i_chroma;
157 if( !p_fmt_out->i_width && p_fmt_out->i_height )
158 p_fmt_out->i_width = p_fmt_out->i_height
159 * p_image->p_dec->fmt_out.video.i_aspect
160 / VOUT_ASPECT_FACTOR;
161 if( !p_fmt_out->i_height && p_fmt_out->i_width )
162 p_fmt_out->i_height = p_fmt_out->i_width * VOUT_ASPECT_FACTOR
163 / p_image->p_dec->fmt_out.video.i_aspect;
164 if( !p_fmt_out->i_width )
165 p_fmt_out->i_width = p_image->p_dec->fmt_out.video.i_width;
166 if( !p_fmt_out->i_height )
167 p_fmt_out->i_height = p_image->p_dec->fmt_out.video.i_height;
169 /* Check if we need chroma conversion or resizing */
170 if( p_image->p_dec->fmt_out.video.i_chroma != p_fmt_out->i_chroma ||
171 p_image->p_dec->fmt_out.video.i_width != p_fmt_out->i_width ||
172 p_image->p_dec->fmt_out.video.i_height != p_fmt_out->i_height )
174 if( p_image->p_filter )
175 if( p_image->p_filter->fmt_in.video.i_chroma !=
176 p_image->p_dec->fmt_out.video.i_chroma ||
177 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
179 /* We need to restart a new filter */
180 DeleteFilter( p_image->p_filter );
181 p_image->p_filter = 0;
185 if( !p_image->p_filter )
188 CreateFilter( p_image->p_parent, &p_image->p_dec->fmt_out,
191 if( !p_image->p_filter )
193 picture_Release( p_pic );
199 /* Filters should handle on-the-fly size changes */
200 p_image->p_filter->fmt_in = p_image->p_dec->fmt_out;
201 p_image->p_filter->fmt_out = p_image->p_dec->fmt_out;
202 p_image->p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
203 p_image->p_filter->fmt_out.video = *p_fmt_out;
206 p_pic = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
207 *p_fmt_out = p_image->p_filter->fmt_out.video;
209 else *p_fmt_out = p_image->p_dec->fmt_out.video;
214 static picture_t *ImageReadUrl( image_handler_t *p_image, const char *psz_url,
215 video_format_t *p_fmt_in,
216 video_format_t *p_fmt_out )
220 stream_t *p_stream = NULL;
223 p_stream = stream_UrlNew( p_image->p_parent, psz_url );
227 msg_Dbg( p_image->p_parent, "could not open %s for reading",
232 i_size = stream_Size( p_stream );
234 p_block = block_New( p_image->p_parent, i_size );
236 stream_Read( p_stream, p_block->p_buffer, i_size );
237 stream_Delete( p_stream );
239 if( !p_fmt_in->i_chroma )
241 /* Try to guess format from file name */
242 p_fmt_in->i_chroma = Ext2Fourcc( psz_url );
245 p_pic = ImageRead( p_image, p_block, p_fmt_in, p_fmt_out );
255 static block_t *ImageWrite( image_handler_t *p_image, picture_t *p_pic,
256 video_format_t *p_fmt_in,
257 video_format_t *p_fmt_out )
261 /* Check if we can reuse the current encoder */
262 if( p_image->p_enc &&
263 ( p_image->p_enc->fmt_out.i_codec != p_fmt_out->i_chroma ||
264 p_image->p_enc->fmt_out.video.i_width != p_fmt_out->i_width ||
265 p_image->p_enc->fmt_out.video.i_height != p_fmt_out->i_height ) )
267 DeleteEncoder( p_image->p_enc );
271 /* Start an encoder */
272 if( !p_image->p_enc )
274 p_image->p_enc = CreateEncoder( p_image->p_parent,
275 p_fmt_in, p_fmt_out );
276 if( !p_image->p_enc ) return NULL;
279 /* Check if we need chroma conversion or resizing */
280 if( p_image->p_enc->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
281 p_image->p_enc->fmt_in.video.i_width != p_fmt_in->i_width ||
282 p_image->p_enc->fmt_in.video.i_height != p_fmt_in->i_height )
284 picture_t *p_tmp_pic;
286 if( p_image->p_filter )
287 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
288 p_image->p_filter->fmt_out.video.i_chroma !=
289 p_image->p_enc->fmt_in.video.i_chroma )
291 /* We need to restart a new filter */
292 DeleteFilter( p_image->p_filter );
293 p_image->p_filter = 0;
297 if( !p_image->p_filter )
300 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
301 fmt_in.video = *p_fmt_in;
304 CreateFilter( p_image->p_parent, &fmt_in,
305 &p_image->p_enc->fmt_in.video, NULL );
307 if( !p_image->p_filter )
314 /* Filters should handle on-the-fly size changes */
315 p_image->p_filter->fmt_in.i_codec = p_fmt_in->i_chroma;
316 p_image->p_filter->fmt_out.video = *p_fmt_in;
317 p_image->p_filter->fmt_out.i_codec =p_image->p_enc->fmt_in.i_codec;
318 p_image->p_filter->fmt_out.video = p_image->p_enc->fmt_in.video;
321 picture_Hold( p_pic );
324 p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
326 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_tmp_pic );
328 p_image->p_filter->pf_vout_buffer_del( p_image->p_filter, p_tmp_pic );
332 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_pic );
337 msg_Dbg( p_image->p_parent, "no image encoded" );
344 static int ImageWriteUrl( image_handler_t *p_image, picture_t *p_pic,
345 video_format_t *p_fmt_in, video_format_t *p_fmt_out,
346 const char *psz_url )
351 if( !p_fmt_out->i_chroma )
353 /* Try to guess format from file name */
354 p_fmt_out->i_chroma = Ext2Fourcc( psz_url );
357 file = utf8_fopen( psz_url, "wb" );
360 msg_Err( p_image->p_parent, "%s: %m", psz_url );
364 p_block = ImageWrite( p_image, p_pic, p_fmt_in, p_fmt_out );
369 if( fwrite( p_block->p_buffer, p_block->i_buffer, 1, file ) != 1 )
371 block_Release( p_block );
374 if( fclose( file ) && !err )
380 msg_Err( p_image->p_parent, "%s: %m", psz_url );
383 return err ? VLC_EGENERIC : VLC_SUCCESS;
387 * Convert an image to a different format
391 static picture_t *ImageConvert( image_handler_t *p_image, picture_t *p_pic,
392 video_format_t *p_fmt_in,
393 video_format_t *p_fmt_out )
397 if( !p_fmt_out->i_width && !p_fmt_out->i_height &&
398 p_fmt_out->i_sar_num && p_fmt_out->i_sar_den &&
399 p_fmt_out->i_sar_num * p_fmt_in->i_sar_den !=
400 p_fmt_out->i_sar_den * p_fmt_in->i_sar_num )
403 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
404 p_fmt_in->i_width / p_fmt_in->i_sar_den / p_fmt_out->i_sar_num;
405 p_fmt_out->i_visible_width =
406 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
407 p_fmt_in->i_visible_width / p_fmt_in->i_sar_den /
408 p_fmt_out->i_sar_num;
411 if( !p_fmt_out->i_chroma ) p_fmt_out->i_chroma = p_fmt_in->i_chroma;
412 if( !p_fmt_out->i_width )
413 p_fmt_out->i_width = p_fmt_out->i_visible_width = p_fmt_in->i_width;
414 if( !p_fmt_out->i_height )
415 p_fmt_out->i_height = p_fmt_out->i_visible_height = p_fmt_in->i_height;
416 if( !p_fmt_out->i_sar_num ) p_fmt_out->i_sar_num = p_fmt_in->i_sar_num;
417 if( !p_fmt_out->i_sar_den ) p_fmt_out->i_sar_den = p_fmt_in->i_sar_den;
418 if( !p_fmt_out->i_aspect ) p_fmt_out->i_aspect = p_fmt_in->i_aspect;
420 if( p_image->p_filter )
421 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
422 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
424 /* We need to restart a new filter */
425 DeleteFilter( p_image->p_filter );
426 p_image->p_filter = NULL;
430 if( !p_image->p_filter )
433 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
434 fmt_in.video = *p_fmt_in;
437 CreateFilter( p_image->p_parent, &fmt_in, p_fmt_out, NULL );
439 if( !p_image->p_filter )
446 /* Filters should handle on-the-fly size changes */
447 p_image->p_filter->fmt_in.video = *p_fmt_in;
448 p_image->p_filter->fmt_out.video = *p_fmt_out;
451 picture_Hold( p_pic );
453 p_pif = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
455 if( p_fmt_in->i_chroma == p_fmt_out->i_chroma &&
456 p_fmt_in->i_width == p_fmt_out->i_width &&
457 p_fmt_in->i_height == p_fmt_out->i_height )
459 /* Duplicate image */
460 picture_Release( p_pif ); /* XXX: Better fix must be possible */
461 p_pif = p_image->p_filter->pf_vout_buffer_new( p_image->p_filter );
463 picture_Copy( p_pif, p_pic );
470 * Filter an image with a psz_module filter
474 static picture_t *ImageFilter( image_handler_t *p_image, picture_t *p_pic,
475 video_format_t *p_fmt, const char *psz_module )
478 if( !p_image->p_filter )
481 es_format_Init( &fmt, VIDEO_ES, p_fmt->i_chroma );
485 CreateFilter( p_image->p_parent, &fmt, &fmt.video, psz_module );
487 if( !p_image->p_filter )
494 /* Filters should handle on-the-fly size changes */
495 p_image->p_filter->fmt_in.video = *p_fmt;
496 p_image->p_filter->fmt_out.video = *p_fmt;
499 picture_Hold( p_pic );
501 return p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
510 vlc_fourcc_t i_codec;
515 { VLC_FOURCC('j','p','e','g'), "jpeg" },
516 { VLC_FOURCC('j','p','e','g'), "jpg" },
517 { VLC_FOURCC('l','j','p','g'), "ljpg" },
518 { VLC_FOURCC('p','n','g',' '), "png" },
519 { VLC_FOURCC('p','g','m',' '), "pgm" },
520 { VLC_FOURCC('p','g','m','y'), "pgmyuv" },
521 { VLC_FOURCC('p','b','m',' '), "pbm" },
522 { VLC_FOURCC('p','a','m',' '), "pam" },
523 { VLC_FOURCC('t','g','a',' '), "tga" },
524 { VLC_FOURCC('b','m','p',' '), "bmp" },
525 { VLC_FOURCC('p','n','m',' '), "pnm" },
526 { VLC_FOURCC('x','p','m',' '), "xpm" },
527 { VLC_FOURCC('x','c','f',' '), "xcf" },
528 { VLC_FOURCC('p','c','x',' '), "pcx" },
529 { VLC_FOURCC('g','i','f',' '), "gif" },
530 { VLC_FOURCC('t','i','f','f'), "tif" },
531 { VLC_FOURCC('t','i','f','f'), "tiff" },
532 { VLC_FOURCC('l','b','m',' '), "lbm" },
536 static vlc_fourcc_t Ext2Fourcc( const char *psz_name )
540 psz_name = strrchr( psz_name, '.' );
541 if( !psz_name ) return 0;
544 for( i = 0; ext_table[i].i_codec; i++ )
547 for( j = 0; toupper(ext_table[i].psz_ext[j]) == toupper(psz_name[j]);
550 if( !ext_table[i].psz_ext[j] && !psz_name[j] )
551 return ext_table[i].i_codec;
559 static const char *Fourcc2Ext( vlc_fourcc_t i_codec )
563 for( i = 0; ext_table[i].i_codec != 0; i++ )
565 if( ext_table[i].i_codec == i_codec ) return ext_table[i].psz_ext;
572 static picture_t *video_new_buffer( decoder_t *p_dec )
574 p_dec->fmt_out.video.i_chroma = p_dec->fmt_out.i_codec;
575 return picture_New( p_dec->fmt_out.video.i_chroma,
576 p_dec->fmt_out.video.i_width,
577 p_dec->fmt_out.video.i_height,
578 p_dec->fmt_out.video.i_aspect );
581 static void video_del_buffer( decoder_t *p_dec, picture_t *p_pic )
583 if( p_pic->i_refcount != 1 )
584 msg_Err( p_dec, "invalid picture reference count" );
586 p_pic->i_refcount = 0;
587 picture_Delete( p_pic );
590 static void video_link_picture( decoder_t *p_dec, picture_t *p_pic )
593 picture_Hold( p_pic );
596 static void video_unlink_picture( decoder_t *p_dec, picture_t *p_pic )
599 picture_Release( p_pic );
602 static decoder_t *CreateDecoder( vlc_object_t *p_this, video_format_t *fmt )
606 p_dec = vlc_object_create( p_this, VLC_OBJECT_DECODER );
610 p_dec->p_module = NULL;
611 es_format_Init( &p_dec->fmt_in, VIDEO_ES, fmt->i_chroma );
612 es_format_Init( &p_dec->fmt_out, VIDEO_ES, 0 );
613 p_dec->fmt_in.video = *fmt;
614 p_dec->b_pace_control = true;
616 p_dec->pf_vout_buffer_new = video_new_buffer;
617 p_dec->pf_vout_buffer_del = video_del_buffer;
618 p_dec->pf_picture_link = video_link_picture;
619 p_dec->pf_picture_unlink = video_unlink_picture;
621 vlc_object_attach( p_dec, p_this );
623 /* Find a suitable decoder module */
624 p_dec->p_module = module_need( p_dec, "decoder", "$codec", 0 );
625 if( !p_dec->p_module )
627 msg_Err( p_dec, "no suitable decoder module for fourcc `%4.4s'.\n"
628 "VLC probably does not support this image format.",
629 (char*)&p_dec->fmt_in.i_codec );
631 DeleteDecoder( p_dec );
638 static void DeleteDecoder( decoder_t * p_dec )
640 vlc_object_detach( p_dec );
642 if( p_dec->p_module ) module_unneed( p_dec, p_dec->p_module );
644 es_format_Clean( &p_dec->fmt_in );
645 es_format_Clean( &p_dec->fmt_out );
647 if( p_dec->p_description )
648 vlc_meta_Delete( p_dec->p_description );
650 vlc_object_release( p_dec );
654 static encoder_t *CreateEncoder( vlc_object_t *p_this, video_format_t *fmt_in,
655 video_format_t *fmt_out )
659 p_enc = vlc_object_create( p_this, VLC_OBJECT_ENCODER );
663 p_enc->p_module = NULL;
664 es_format_Init( &p_enc->fmt_in, VIDEO_ES, fmt_in->i_chroma );
665 p_enc->fmt_in.video = *fmt_in;
666 if( fmt_out->i_width > 0 && fmt_out->i_height > 0 )
668 p_enc->fmt_in.video.i_width = fmt_out->i_width;
669 p_enc->fmt_in.video.i_height = fmt_out->i_height;
671 if( fmt_out->i_visible_width > 0 &&
672 fmt_out->i_visible_height > 0 )
674 p_enc->fmt_in.video.i_visible_width = fmt_out->i_visible_width;
675 p_enc->fmt_in.video.i_visible_height = fmt_out->i_visible_height;
679 p_enc->fmt_in.video.i_visible_width = fmt_out->i_width;
680 p_enc->fmt_in.video.i_visible_height = fmt_out->i_height;
683 else if( fmt_out->i_sar_num && fmt_out->i_sar_den &&
684 fmt_out->i_sar_num * fmt_in->i_sar_den !=
685 fmt_out->i_sar_den * fmt_in->i_sar_num )
687 p_enc->fmt_in.video.i_width =
688 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den * fmt_in->i_width /
689 fmt_in->i_sar_den / fmt_out->i_sar_num;
690 p_enc->fmt_in.video.i_visible_width =
691 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den *
692 fmt_in->i_visible_width / fmt_in->i_sar_den / fmt_out->i_sar_num;
695 p_enc->fmt_in.video.i_frame_rate = 25;
696 p_enc->fmt_in.video.i_frame_rate_base = 1;
698 es_format_Init( &p_enc->fmt_out, VIDEO_ES, fmt_out->i_chroma );
699 p_enc->fmt_out.video = *fmt_out;
700 p_enc->fmt_out.video.i_width = p_enc->fmt_in.video.i_width;
701 p_enc->fmt_out.video.i_height = p_enc->fmt_in.video.i_height;
703 vlc_object_attach( p_enc, p_this );
705 /* Find a suitable decoder module */
706 p_enc->p_module = module_need( p_enc, "encoder", 0, 0 );
707 if( !p_enc->p_module )
709 msg_Err( p_enc, "no suitable encoder module for fourcc `%4.4s'.\n"
710 "VLC probably does not support this image format.",
711 (char*)&p_enc->fmt_out.i_codec );
713 DeleteEncoder( p_enc );
716 p_enc->fmt_in.video.i_chroma = p_enc->fmt_in.i_codec;
721 static void DeleteEncoder( encoder_t * p_enc )
723 vlc_object_detach( p_enc );
725 if( p_enc->p_module ) module_unneed( p_enc, p_enc->p_module );
727 es_format_Clean( &p_enc->fmt_in );
728 es_format_Clean( &p_enc->fmt_out );
730 vlc_object_release( p_enc );
734 static filter_t *CreateFilter( vlc_object_t *p_this, es_format_t *p_fmt_in,
735 video_format_t *p_fmt_out,
736 const char *psz_module )
738 static const char typename[] = "filter";
741 p_filter = vlc_custom_create( p_this, sizeof(filter_t),
742 VLC_OBJECT_GENERIC, typename );
743 vlc_object_attach( p_filter, p_this );
745 p_filter->pf_vout_buffer_new =
746 (picture_t *(*)(filter_t *))video_new_buffer;
747 p_filter->pf_vout_buffer_del =
748 (void (*)(filter_t *, picture_t *))video_del_buffer;
750 p_filter->fmt_in = *p_fmt_in;
751 p_filter->fmt_out = *p_fmt_in;
752 p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
753 p_filter->fmt_out.video = *p_fmt_out;
754 p_filter->p_module = module_need( p_filter, "video filter2",
757 if( !p_filter->p_module )
759 msg_Dbg( p_filter, "no video filter found" );
760 DeleteFilter( p_filter );
767 static void DeleteFilter( filter_t * p_filter )
769 vlc_object_detach( p_filter );
771 if( p_filter->p_module ) module_unneed( p_filter, p_filter->p_module );
773 es_format_Clean( &p_filter->fmt_in );
774 es_format_Clean( &p_filter->fmt_out );
776 vlc_object_release( p_filter );