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 = malloc( sizeof(image_handler_t) );
84 memset( p_image, 0, sizeof(image_handler_t) );
85 p_image->p_parent = p_this;
87 p_image->pf_read = ImageRead;
88 p_image->pf_read_url = ImageReadUrl;
89 p_image->pf_write = ImageWrite;
90 p_image->pf_write_url = ImageWriteUrl;
91 p_image->pf_convert = ImageConvert;
92 p_image->pf_filter = ImageFilter;
98 * Delete the image_handler_t instance
101 void image_HandlerDelete( image_handler_t *p_image )
103 if( !p_image ) return;
105 if( p_image->p_dec ) DeleteDecoder( p_image->p_dec );
106 if( p_image->p_enc ) DeleteEncoder( p_image->p_enc );
107 if( p_image->p_filter ) DeleteFilter( p_image->p_filter );
118 static picture_t *ImageRead( image_handler_t *p_image, block_t *p_block,
119 video_format_t *p_fmt_in,
120 video_format_t *p_fmt_out )
122 picture_t *p_pic = NULL, *p_tmp;
124 /* Check if we can reuse the current decoder */
125 if( p_image->p_dec &&
126 p_image->p_dec->fmt_in.i_codec != p_fmt_in->i_chroma )
128 DeleteDecoder( p_image->p_dec );
132 /* Start a decoder */
133 if( !p_image->p_dec )
135 p_image->p_dec = CreateDecoder( p_image->p_parent, p_fmt_in );
136 if( !p_image->p_dec ) return NULL;
139 p_block->i_pts = p_block->i_dts = mdate();
140 while( (p_tmp = p_image->p_dec->pf_decode_video( p_image->p_dec, &p_block ))
144 picture_Release( p_pic );
150 msg_Warn( p_image->p_parent, "no image decoded" );
154 if( !p_fmt_out->i_chroma )
155 p_fmt_out->i_chroma = p_image->p_dec->fmt_out.video.i_chroma;
156 if( !p_fmt_out->i_width && p_fmt_out->i_height )
157 p_fmt_out->i_width = p_fmt_out->i_height
158 * p_image->p_dec->fmt_out.video.i_aspect
159 / VOUT_ASPECT_FACTOR;
160 if( !p_fmt_out->i_height && p_fmt_out->i_width )
161 p_fmt_out->i_height = p_fmt_out->i_width * VOUT_ASPECT_FACTOR
162 / p_image->p_dec->fmt_out.video.i_aspect;
163 if( !p_fmt_out->i_width )
164 p_fmt_out->i_width = p_image->p_dec->fmt_out.video.i_width;
165 if( !p_fmt_out->i_height )
166 p_fmt_out->i_height = p_image->p_dec->fmt_out.video.i_height;
168 /* Check if we need chroma conversion or resizing */
169 if( p_image->p_dec->fmt_out.video.i_chroma != p_fmt_out->i_chroma ||
170 p_image->p_dec->fmt_out.video.i_width != p_fmt_out->i_width ||
171 p_image->p_dec->fmt_out.video.i_height != p_fmt_out->i_height )
173 if( p_image->p_filter )
174 if( p_image->p_filter->fmt_in.video.i_chroma !=
175 p_image->p_dec->fmt_out.video.i_chroma ||
176 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
178 /* We need to restart a new filter */
179 DeleteFilter( p_image->p_filter );
180 p_image->p_filter = 0;
184 if( !p_image->p_filter )
187 CreateFilter( p_image->p_parent, &p_image->p_dec->fmt_out,
190 if( !p_image->p_filter )
192 picture_Release( p_pic );
198 /* Filters should handle on-the-fly size changes */
199 p_image->p_filter->fmt_in = p_image->p_dec->fmt_out;
200 p_image->p_filter->fmt_out = p_image->p_dec->fmt_out;
201 p_image->p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
202 p_image->p_filter->fmt_out.video = *p_fmt_out;
205 p_pic = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
206 *p_fmt_out = p_image->p_filter->fmt_out.video;
208 else *p_fmt_out = p_image->p_dec->fmt_out.video;
213 static picture_t *ImageReadUrl( image_handler_t *p_image, const char *psz_url,
214 video_format_t *p_fmt_in,
215 video_format_t *p_fmt_out )
219 stream_t *p_stream = NULL;
222 p_stream = stream_UrlNew( p_image->p_parent, psz_url );
226 msg_Dbg( p_image->p_parent, "could not open %s for reading",
231 i_size = stream_Size( p_stream );
233 p_block = block_New( p_image->p_parent, i_size );
235 stream_Read( p_stream, p_block->p_buffer, i_size );
236 stream_Delete( p_stream );
238 if( !p_fmt_in->i_chroma )
240 /* Try to guess format from file name */
241 p_fmt_in->i_chroma = Ext2Fourcc( psz_url );
244 p_pic = ImageRead( p_image, p_block, p_fmt_in, p_fmt_out );
254 static block_t *ImageWrite( image_handler_t *p_image, picture_t *p_pic,
255 video_format_t *p_fmt_in,
256 video_format_t *p_fmt_out )
260 /* Check if we can reuse the current encoder */
261 if( p_image->p_enc &&
262 ( p_image->p_enc->fmt_out.i_codec != p_fmt_out->i_chroma ||
263 p_image->p_enc->fmt_out.video.i_width != p_fmt_out->i_width ||
264 p_image->p_enc->fmt_out.video.i_height != p_fmt_out->i_height ) )
266 DeleteEncoder( p_image->p_enc );
270 /* Start an encoder */
271 if( !p_image->p_enc )
273 p_image->p_enc = CreateEncoder( p_image->p_parent,
274 p_fmt_in, p_fmt_out );
275 if( !p_image->p_enc ) return NULL;
278 /* Check if we need chroma conversion or resizing */
279 if( p_image->p_enc->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
280 p_image->p_enc->fmt_in.video.i_width != p_fmt_in->i_width ||
281 p_image->p_enc->fmt_in.video.i_height != p_fmt_in->i_height )
283 picture_t *p_tmp_pic;
285 if( p_image->p_filter )
286 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
287 p_image->p_filter->fmt_out.video.i_chroma !=
288 p_image->p_enc->fmt_in.video.i_chroma )
290 /* We need to restart a new filter */
291 DeleteFilter( p_image->p_filter );
292 p_image->p_filter = 0;
296 if( !p_image->p_filter )
299 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
300 fmt_in.video = *p_fmt_in;
303 CreateFilter( p_image->p_parent, &fmt_in,
304 &p_image->p_enc->fmt_in.video, NULL );
306 if( !p_image->p_filter )
313 /* Filters should handle on-the-fly size changes */
314 p_image->p_filter->fmt_in.i_codec = p_fmt_in->i_chroma;
315 p_image->p_filter->fmt_out.video = *p_fmt_in;
316 p_image->p_filter->fmt_out.i_codec =p_image->p_enc->fmt_in.i_codec;
317 p_image->p_filter->fmt_out.video = p_image->p_enc->fmt_in.video;
320 picture_Hold( p_pic );
323 p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
325 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_tmp_pic );
327 p_image->p_filter->pf_vout_buffer_del( p_image->p_filter, p_tmp_pic );
331 p_block = p_image->p_enc->pf_encode_video( p_image->p_enc, p_pic );
336 msg_Dbg( p_image->p_parent, "no image encoded" );
343 static int ImageWriteUrl( image_handler_t *p_image, picture_t *p_pic,
344 video_format_t *p_fmt_in, video_format_t *p_fmt_out,
345 const char *psz_url )
350 if( !p_fmt_out->i_chroma )
352 /* Try to guess format from file name */
353 p_fmt_out->i_chroma = Ext2Fourcc( psz_url );
356 file = utf8_fopen( psz_url, "wb" );
359 msg_Err( p_image->p_parent, "%s: %m", psz_url );
363 p_block = ImageWrite( p_image, p_pic, p_fmt_in, p_fmt_out );
368 if( fwrite( p_block->p_buffer, p_block->i_buffer, 1, file ) != 1 )
370 block_Release( p_block );
373 if( fclose( file ) && !err )
379 msg_Err( p_image->p_parent, "%s: %m", psz_url );
382 return err ? VLC_EGENERIC : VLC_SUCCESS;
386 * Convert an image to a different format
390 static picture_t *ImageConvert( image_handler_t *p_image, picture_t *p_pic,
391 video_format_t *p_fmt_in,
392 video_format_t *p_fmt_out )
396 if( !p_fmt_out->i_width && !p_fmt_out->i_height &&
397 p_fmt_out->i_sar_num && p_fmt_out->i_sar_den &&
398 p_fmt_out->i_sar_num * p_fmt_in->i_sar_den !=
399 p_fmt_out->i_sar_den * p_fmt_in->i_sar_num )
402 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
403 p_fmt_in->i_width / p_fmt_in->i_sar_den / p_fmt_out->i_sar_num;
404 p_fmt_out->i_visible_width =
405 p_fmt_in->i_sar_num * (int64_t)p_fmt_out->i_sar_den *
406 p_fmt_in->i_visible_width / p_fmt_in->i_sar_den /
407 p_fmt_out->i_sar_num;
410 if( !p_fmt_out->i_chroma ) p_fmt_out->i_chroma = p_fmt_in->i_chroma;
411 if( !p_fmt_out->i_width )
412 p_fmt_out->i_width = p_fmt_out->i_visible_width = p_fmt_in->i_width;
413 if( !p_fmt_out->i_height )
414 p_fmt_out->i_height = p_fmt_out->i_visible_height = p_fmt_in->i_height;
415 if( !p_fmt_out->i_sar_num ) p_fmt_out->i_sar_num = p_fmt_in->i_sar_num;
416 if( !p_fmt_out->i_sar_den ) p_fmt_out->i_sar_den = p_fmt_in->i_sar_den;
417 if( !p_fmt_out->i_aspect ) p_fmt_out->i_aspect = p_fmt_in->i_aspect;
419 if( p_image->p_filter )
420 if( p_image->p_filter->fmt_in.video.i_chroma != p_fmt_in->i_chroma ||
421 p_image->p_filter->fmt_out.video.i_chroma != p_fmt_out->i_chroma )
423 /* We need to restart a new filter */
424 DeleteFilter( p_image->p_filter );
425 p_image->p_filter = NULL;
429 if( !p_image->p_filter )
432 es_format_Init( &fmt_in, VIDEO_ES, p_fmt_in->i_chroma );
433 fmt_in.video = *p_fmt_in;
436 CreateFilter( p_image->p_parent, &fmt_in, p_fmt_out, NULL );
438 if( !p_image->p_filter )
445 /* Filters should handle on-the-fly size changes */
446 p_image->p_filter->fmt_in.video = *p_fmt_in;
447 p_image->p_filter->fmt_out.video = *p_fmt_out;
450 picture_Hold( p_pic );
452 p_pif = p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
454 if( p_fmt_in->i_chroma == p_fmt_out->i_chroma &&
455 p_fmt_in->i_width == p_fmt_out->i_width &&
456 p_fmt_in->i_height == p_fmt_out->i_height )
458 /* Duplicate image */
459 picture_Release( p_pif ); /* XXX: Better fix must be possible */
460 p_pif = p_image->p_filter->pf_vout_buffer_new( p_image->p_filter );
462 picture_Copy( p_pif, p_pic );
469 * Filter an image with a psz_module filter
473 static picture_t *ImageFilter( image_handler_t *p_image, picture_t *p_pic,
474 video_format_t *p_fmt, const char *psz_module )
477 if( !p_image->p_filter )
480 es_format_Init( &fmt, VIDEO_ES, p_fmt->i_chroma );
484 CreateFilter( p_image->p_parent, &fmt, &fmt.video, psz_module );
486 if( !p_image->p_filter )
493 /* Filters should handle on-the-fly size changes */
494 p_image->p_filter->fmt_in.video = *p_fmt;
495 p_image->p_filter->fmt_out.video = *p_fmt;
498 picture_Hold( p_pic );
500 return p_image->p_filter->pf_video_filter( p_image->p_filter, p_pic );
509 vlc_fourcc_t i_codec;
514 { VLC_FOURCC('j','p','e','g'), "jpeg" },
515 { VLC_FOURCC('j','p','e','g'), "jpg" },
516 { VLC_FOURCC('l','j','p','g'), "ljpg" },
517 { VLC_FOURCC('p','n','g',' '), "png" },
518 { VLC_FOURCC('p','g','m',' '), "pgm" },
519 { VLC_FOURCC('p','g','m','y'), "pgmyuv" },
520 { VLC_FOURCC('p','b','m',' '), "pbm" },
521 { VLC_FOURCC('p','a','m',' '), "pam" },
522 { VLC_FOURCC('t','g','a',' '), "tga" },
523 { VLC_FOURCC('b','m','p',' '), "bmp" },
524 { VLC_FOURCC('p','n','m',' '), "pnm" },
525 { VLC_FOURCC('x','p','m',' '), "xpm" },
526 { VLC_FOURCC('x','c','f',' '), "xcf" },
527 { VLC_FOURCC('p','c','x',' '), "pcx" },
528 { VLC_FOURCC('g','i','f',' '), "gif" },
529 { VLC_FOURCC('t','i','f','f'), "tif" },
530 { VLC_FOURCC('t','i','f','f'), "tiff" },
531 { VLC_FOURCC('l','b','m',' '), "lbm" },
535 static vlc_fourcc_t Ext2Fourcc( const char *psz_name )
539 psz_name = strrchr( psz_name, '.' );
540 if( !psz_name ) return 0;
543 for( i = 0; ext_table[i].i_codec; i++ )
546 for( j = 0; toupper(ext_table[i].psz_ext[j]) == toupper(psz_name[j]);
549 if( !ext_table[i].psz_ext[j] && !psz_name[j] )
550 return ext_table[i].i_codec;
558 static const char *Fourcc2Ext( vlc_fourcc_t i_codec )
562 for( i = 0; ext_table[i].i_codec != 0; i++ )
564 if( ext_table[i].i_codec == i_codec ) return ext_table[i].psz_ext;
571 static picture_t *video_new_buffer( decoder_t *p_dec )
573 p_dec->fmt_out.video.i_chroma = p_dec->fmt_out.i_codec;
574 return picture_New( p_dec->fmt_out.video.i_chroma,
575 p_dec->fmt_out.video.i_width,
576 p_dec->fmt_out.video.i_height,
577 p_dec->fmt_out.video.i_aspect );
580 static void video_del_buffer( decoder_t *p_dec, picture_t *p_pic )
582 if( p_pic->i_refcount != 1 )
583 msg_Err( p_dec, "invalid picture reference count" );
585 p_pic->i_refcount = 0;
586 picture_Delete( p_pic );
589 static void video_link_picture( decoder_t *p_dec, picture_t *p_pic )
592 picture_Hold( p_pic );
595 static void video_unlink_picture( decoder_t *p_dec, picture_t *p_pic )
598 picture_Release( p_pic );
601 static decoder_t *CreateDecoder( vlc_object_t *p_this, video_format_t *fmt )
605 p_dec = vlc_object_create( p_this, VLC_OBJECT_DECODER );
609 p_dec->p_module = NULL;
610 es_format_Init( &p_dec->fmt_in, VIDEO_ES, fmt->i_chroma );
611 es_format_Init( &p_dec->fmt_out, VIDEO_ES, 0 );
612 p_dec->fmt_in.video = *fmt;
613 p_dec->b_pace_control = true;
615 p_dec->pf_vout_buffer_new = video_new_buffer;
616 p_dec->pf_vout_buffer_del = video_del_buffer;
617 p_dec->pf_picture_link = video_link_picture;
618 p_dec->pf_picture_unlink = video_unlink_picture;
620 vlc_object_attach( p_dec, p_this );
622 /* Find a suitable decoder module */
623 p_dec->p_module = module_need( p_dec, "decoder", "$codec", 0 );
624 if( !p_dec->p_module )
626 msg_Err( p_dec, "no suitable decoder module for fourcc `%4.4s'.\n"
627 "VLC probably does not support this image format.",
628 (char*)&p_dec->fmt_in.i_codec );
630 DeleteDecoder( p_dec );
637 static void DeleteDecoder( decoder_t * p_dec )
639 vlc_object_detach( p_dec );
641 if( p_dec->p_module ) module_unneed( p_dec, p_dec->p_module );
643 es_format_Clean( &p_dec->fmt_in );
644 es_format_Clean( &p_dec->fmt_out );
646 if( p_dec->p_description )
647 vlc_meta_Delete( p_dec->p_description );
649 vlc_object_release( p_dec );
653 static encoder_t *CreateEncoder( vlc_object_t *p_this, video_format_t *fmt_in,
654 video_format_t *fmt_out )
658 p_enc = vlc_object_create( p_this, VLC_OBJECT_ENCODER );
662 p_enc->p_module = NULL;
663 es_format_Init( &p_enc->fmt_in, VIDEO_ES, fmt_in->i_chroma );
664 p_enc->fmt_in.video = *fmt_in;
665 if( fmt_out->i_width > 0 && fmt_out->i_height > 0 )
667 p_enc->fmt_in.video.i_width = fmt_out->i_width;
668 p_enc->fmt_in.video.i_height = fmt_out->i_height;
670 if( fmt_out->i_visible_width > 0 &&
671 fmt_out->i_visible_height > 0 )
673 p_enc->fmt_in.video.i_visible_width = fmt_out->i_visible_width;
674 p_enc->fmt_in.video.i_visible_height = fmt_out->i_visible_height;
678 p_enc->fmt_in.video.i_visible_width = fmt_out->i_width;
679 p_enc->fmt_in.video.i_visible_height = fmt_out->i_height;
682 else if( fmt_out->i_sar_num && fmt_out->i_sar_den &&
683 fmt_out->i_sar_num * fmt_in->i_sar_den !=
684 fmt_out->i_sar_den * fmt_in->i_sar_num )
686 p_enc->fmt_in.video.i_width =
687 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den * fmt_in->i_width /
688 fmt_in->i_sar_den / fmt_out->i_sar_num;
689 p_enc->fmt_in.video.i_visible_width =
690 fmt_in->i_sar_num * (int64_t)fmt_out->i_sar_den *
691 fmt_in->i_visible_width / fmt_in->i_sar_den / fmt_out->i_sar_num;
694 p_enc->fmt_in.video.i_frame_rate = 25;
695 p_enc->fmt_in.video.i_frame_rate_base = 1;
697 es_format_Init( &p_enc->fmt_out, VIDEO_ES, fmt_out->i_chroma );
698 p_enc->fmt_out.video = *fmt_out;
699 p_enc->fmt_out.video.i_width = p_enc->fmt_in.video.i_width;
700 p_enc->fmt_out.video.i_height = p_enc->fmt_in.video.i_height;
702 vlc_object_attach( p_enc, p_this );
704 /* Find a suitable decoder module */
705 p_enc->p_module = module_need( p_enc, "encoder", 0, 0 );
706 if( !p_enc->p_module )
708 msg_Err( p_enc, "no suitable encoder module for fourcc `%4.4s'.\n"
709 "VLC probably does not support this image format.",
710 (char*)&p_enc->fmt_out.i_codec );
712 DeleteEncoder( p_enc );
715 p_enc->fmt_in.video.i_chroma = p_enc->fmt_in.i_codec;
720 static void DeleteEncoder( encoder_t * p_enc )
722 vlc_object_detach( p_enc );
724 if( p_enc->p_module ) module_unneed( p_enc, p_enc->p_module );
726 es_format_Clean( &p_enc->fmt_in );
727 es_format_Clean( &p_enc->fmt_out );
729 vlc_object_release( p_enc );
733 static filter_t *CreateFilter( vlc_object_t *p_this, es_format_t *p_fmt_in,
734 video_format_t *p_fmt_out,
735 const char *psz_module )
737 static const char typename[] = "filter";
740 p_filter = vlc_custom_create( p_this, sizeof(filter_t),
741 VLC_OBJECT_GENERIC, typename );
742 vlc_object_attach( p_filter, p_this );
744 p_filter->pf_vout_buffer_new =
745 (picture_t *(*)(filter_t *))video_new_buffer;
746 p_filter->pf_vout_buffer_del =
747 (void (*)(filter_t *, picture_t *))video_del_buffer;
749 p_filter->fmt_in = *p_fmt_in;
750 p_filter->fmt_out = *p_fmt_in;
751 p_filter->fmt_out.i_codec = p_fmt_out->i_chroma;
752 p_filter->fmt_out.video = *p_fmt_out;
753 p_filter->p_module = module_need( p_filter, "video filter2",
756 if( !p_filter->p_module )
758 msg_Dbg( p_filter, "no video filter found" );
759 DeleteFilter( p_filter );
766 static void DeleteFilter( filter_t * p_filter )
768 vlc_object_detach( p_filter );
770 if( p_filter->p_module ) module_unneed( p_filter, p_filter->p_module );
772 es_format_Clean( &p_filter->fmt_in );
773 es_format_Clean( &p_filter->fmt_out );
775 vlc_object_release( p_filter );