git.sesse.net Git - vlc/blob - modules/codec/csri.c

   1 /*****************************************************************************
   2  * csri.c : Load CSRI subtitle renderer
   3  *****************************************************************************
   4  * Copyright (C) 2007 the VideoLAN team
   5  * $Id$
   6  *
   7  * Authors: David Lamparter <equinox@videolan.org>
   8  *
   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.
  13  *
  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.
  18  *
  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  *****************************************************************************/
  23
  24 /*****************************************************************************
  25  * Preamble
  26  *****************************************************************************/
  27
  28 #ifdef HAVE_CONFIG_H
  29 #   include "config.h"
  30 #endif
  31
  32 #include <string.h>
  33 #include <math.h>
  34
  35 #include <vlc_common.h>
  36 #include <vlc_plugin.h>
  37 #include <vlc_codec.h>
  38 #include <vlc_osd.h>
  39 #include <vlc_input.h>
  40
  41 #include <csri/csri.h>
  42 #include <csri/stream.h>
  43
  44 /*****************************************************************************
  45  * Module descriptor
  46  *****************************************************************************/
  47 static int  Create ( vlc_object_t * );
  48 static void Destroy( vlc_object_t * );
  49
  50 vlc_module_begin ()
  51     set_shortname( N_("Subtitles (advanced)"))
  52     set_description( N_("Wrapper for subtitle renderers using CSRI/asa") )
  53     set_capability( "decoder", 60 )
  54     set_category( CAT_INPUT )
  55     set_subcategory( SUBCAT_INPUT_SCODEC )
  56     set_callbacks( Create, Destroy )
  57 vlc_module_end ()
  58
  59 /*****************************************************************************
  60  * Local prototypes
  61  *****************************************************************************/
  62 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
  63 static void DestroySubpicture( subpicture_t * );
  64 static void PreRender( spu_t *, subpicture_t *, const video_format_t * );
  65 static void UpdateRegions( spu_t *, subpicture_t *,
  66                            const video_format_t *,  mtime_t );
  67
  68 /*****************************************************************************
  69  * decoder_sys_t: decoder data
  70  *****************************************************************************/
  71 struct decoder_sys_t
  72 {
  73     subpicture_t *p_spu_final;
  74     video_format_t fmt_cached;
  75     csri_inst *p_instance;
  76
  77     struct csri_stream_ext *p_stream_ext;
  78
  79     void (*pf_push_packet)(csri_inst *inst, const void *packet,
  80                            size_t packetlen, double pts_start,
  81                            double pts_end);
  82 };
  83
  84 struct subpicture_sys_t
  85 {
  86     decoder_t *p_dec;
  87     void      *p_subs_data;
  88     int       i_subs_len;
  89     mtime_t   i_pts;
  90 };
  91
  92 /*****************************************************************************
  93  * Create: Open CSRI renderer
  94  *****************************************************************************
  95  * Comment me.
  96  *****************************************************************************/
  97 static int Create( vlc_object_t *p_this )
  98 {
  99     decoder_t *p_dec = (decoder_t *)p_this;
 100     decoder_sys_t *p_sys;
 101     csri_rend *p_render;
 102     struct csri_stream_ext *p_stream_ext;
 103
 104     if( p_dec->fmt_in.i_codec != VLC_CODEC_SSA )
 105         return VLC_EGENERIC;
 106
 107     p_render = csri_renderer_default();
 108     if (!p_render)
 109     {
 110         msg_Err( p_dec, "can't load csri renderer" );
 111         return VLC_EGENERIC;
 112     }
 113     p_stream_ext = csri_query_ext(p_render, CSRI_EXT_STREAM_ASS);
 114     if (!p_stream_ext)
 115     {
 116         msg_Err( p_dec, "csri renderer does not support ASS streaming" );
 117         return VLC_EGENERIC;
 118     }
 119
 120     p_dec->pf_decode_sub = DecodeBlock;
 121
 122     p_dec->p_sys = p_sys = calloc( 1, sizeof( decoder_sys_t ) );
 123     if( !p_sys )
 124         return VLC_ENOMEM;
 125
 126     p_sys->p_stream_ext = p_stream_ext;
 127     p_sys->pf_push_packet = p_stream_ext->push_packet;
 128     p_sys->p_instance = p_stream_ext->init_stream( p_render,
 129                                                    p_dec->fmt_in.p_extra,
 130                                                    p_dec->fmt_in.p_extra ? strnlen( p_dec->fmt_in.p_extra, p_dec->fmt_in.i_extra ) : 0,
 131                                                    NULL);
 132     p_dec->fmt_out.i_cat = SPU_ES;
 133     p_dec->fmt_out.i_codec = VLC_CODEC_RGBA;
 134
 135     return VLC_SUCCESS;
 136 }
 137
 138 /*****************************************************************************
 139  * Destroy: finish
 140  *****************************************************************************
 141  * Comment me.
 142  *****************************************************************************/
 143 static void Destroy( vlc_object_t *p_this )
 144 {
 145     decoder_t *p_dec = (decoder_t *)p_this;
 146     decoder_sys_t *p_sys = p_dec->p_sys;
 147
 148     if( p_sys->p_stream_ext->discard )
 149         p_sys->p_stream_ext->discard( p_sys->p_instance, true );
 150     free( p_sys );
 151 }
 152
 153 /****************************************************************************
 154  * DecodeBlock: the whole thing
 155  ****************************************************************************
 156  * This function must be fed with complete subtitles units.
 157  ****************************************************************************/
 158 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 159 {
 160     decoder_sys_t *p_sys = p_dec->p_sys;
 161
 162     subpicture_t *p_spu = NULL;
 163     block_t *p_block;
 164
 165     //msg_Dbg( p_dec, "DecodeBlock %p", (void *)pp_block);
 166     if( !pp_block || *pp_block == NULL )
 167         return NULL;
 168
 169     p_block = *pp_block;
 170     *pp_block = NULL;
 171
 172     if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' )
 173     {
 174         block_Release( p_block );
 175         return NULL;
 176     }
 177
 178     p_spu = decoder_NewSubpicture( p_dec );
 179     if( !p_spu )
 180     {
 181         msg_Warn( p_dec, "can't get spu buffer" );
 182         block_Release( p_block );
 183         return NULL;
 184     }
 185
 186     p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
 187     if( !p_spu->p_sys )
 188     {
 189         decoder_DeleteSubpicture( p_dec, p_spu );
 190         block_Release( p_block );
 191         return NULL;
 192     }
 193     p_spu->p_sys->p_dec = p_dec;
 194
 195     p_spu->p_sys->i_subs_len = p_block->i_buffer;
 196     p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
 197     if( !p_spu->p_sys->p_subs_data )
 198     {
 199         free( p_spu->p_sys );
 200         decoder_DeleteSubpicture( p_dec, p_spu );
 201         block_Release( p_block );
 202         return NULL;
 203     }
 204     memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
 205             p_block->i_buffer );
 206     p_spu->p_sys->i_pts = p_block->i_pts;
 207
 208     p_spu->i_start = p_block->i_pts;
 209     p_spu->i_stop = p_block->i_pts + p_block->i_length;
 210     p_spu->b_ephemer = false;
 211     p_spu->b_absolute = false;
 212
 213     //msg_Dbg( p_dec, "BS %lf..%lf", p_spu->i_start * 0.000001, p_spu->i_stop * 0.000001);
 214     p_sys->pf_push_packet( p_sys->p_instance,
 215                            p_spu->p_sys->p_subs_data, p_spu->p_sys->i_subs_len,
 216                            p_spu->i_start * 0.000001,
 217                            p_spu->i_stop * 0.000001);
 218
 219     p_spu->pf_pre_render = PreRender;
 220     p_spu->pf_update_regions = UpdateRegions;
 221     p_spu->pf_destroy = DestroySubpicture;
 222
 223     block_Release( p_block );
 224
 225     return p_spu;
 226 }
 227
 228 static void DestroySubpicture( subpicture_t *p_subpic )
 229 {
 230     //msg_Dbg( p_subpic->p_sys->p_dec, "drop spu %p", (void *)p_subpic );
 231     free( p_subpic->p_sys->p_subs_data );
 232     free( p_subpic->p_sys );
 233 }
 234
 235 static void PreRender( spu_t *p_spu, subpicture_t *p_subpic,
 236                        const video_format_t *p_fmt )
 237 {
 238     decoder_t *p_dec = p_subpic->p_sys->p_dec;
 239     p_dec->p_sys->p_spu_final = p_subpic;
 240     VLC_UNUSED(p_fmt);
 241     VLC_UNUSED(p_spu);
 242 }
 243
 244 static void UpdateRegions( spu_t *p_spu, subpicture_t *p_subpic,
 245                            const video_format_t *p_fmt, mtime_t i_ts )
 246 {
 247     decoder_t *p_dec = p_subpic->p_sys->p_dec;
 248     decoder_sys_t *p_sys = p_dec->p_sys;
 249
 250     subpicture_region_t *p_spu_region;
 251     video_format_t fmt;
 252
 253     /* TODO maybe checking if we really need redrawing */
 254     subpicture_region_ChainDelete( p_subpic->p_region );
 255     p_subpic->p_region = NULL;
 256
 257     /* FIXME check why this is needed */
 258     if( p_subpic != p_sys->p_spu_final )
 259         return;
 260
 261 #if 0
 262     msg_Warn( p_dec, "---- fmt: %dx%d %dx%d chroma=%4.4s",
 263             p_fmt->i_width, p_fmt->i_height,
 264             p_fmt->i_visible_width, p_fmt->i_visible_height,
 265             (const char*)&p_fmt->i_chroma );
 266 #endif
 267     /* XXX On x86 at least our RGBA is mapped to their BGRA
 268      * TODO confirm that is the same on big endian cpu */
 269     fmt = *p_fmt;
 270     fmt.i_chroma = VLC_CODEC_RGBA;
 271     fmt.i_width = fmt.i_visible_width;
 272     fmt.i_height = fmt.i_visible_height;
 273     fmt.i_bits_per_pixel = 0;
 274     fmt.i_x_offset = fmt.i_y_offset = 0;
 275     fmt.i_sar_num = 1;
 276     fmt.i_sar_den = 1;
 277
 278     if( memcmp(&fmt, &p_sys->fmt_cached, sizeof(fmt)) )
 279     {
 280         //msg_Warn( p_dec, "---- fmt: new %dx%d", fmt.i_width, fmt.i_height );
 281
 282         struct csri_fmt csri_fmt;
 283         memset(&csri_fmt, 0, sizeof(csri_fmt));
 284         csri_fmt.pixfmt = CSRI_F_BGRA;
 285         csri_fmt.width = fmt.i_width;
 286         csri_fmt.height = fmt.i_height;
 287         if( csri_request_fmt( p_sys->p_instance, &csri_fmt ) )
 288             msg_Dbg( p_dec, "csri error: format not supported" );
 289
 290         p_sys->fmt_cached = fmt;
 291     }
 292
 293     p_subpic->i_original_picture_height = fmt.i_height;
 294     p_subpic->i_original_picture_width = fmt.i_width;
 295
 296     p_spu_region = p_subpic->p_region = subpicture_region_New( &fmt );
 297
 298     if( p_spu_region )
 299     {
 300         struct csri_frame csri_frame;
 301
 302         /* */
 303         p_spu_region->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
 304         memset( p_spu_region->p_picture->Y_PIXELS, 0x00, p_spu_region->p_picture->Y_PITCH * p_sys->fmt_cached.i_height );
 305
 306         /* */
 307         const mtime_t i_stream_date = p_subpic->p_sys->i_pts + (i_ts - p_subpic->i_start);
 308
 309         //msg_Dbg( p_dec, "TS %lf", ts * 0.000001 );
 310         memset( &csri_frame, 0, sizeof(csri_frame) );
 311         csri_frame.pixfmt = CSRI_F_BGRA;
 312         csri_frame.planes[0] = (unsigned char*)p_spu_region->p_picture->Y_PIXELS;
 313         csri_frame.strides[0] = p_spu_region->p_picture->Y_PITCH;
 314         csri_render( p_sys->p_instance, &csri_frame, i_stream_date * 0.000001 );
 315     }
 316 }
 317