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 #include <stdlib.h>
  28 #include <string.h>
  29
  30 #include "config.h"
  31 #include <vlc/vlc.h>
  32 #include <vlc_plugin.h>
  33 #include <vlc_vout.h>
  34 #include <vlc_codec.h>
  35 #include <vlc_osd.h>
  36 #include <vlc_block.h>
  37 #include <vlc_filter.h>
  38 #include <vlc_stream.h>
  39 #include <vlc_xml.h>
  40
  41 #include <math.h>
  42
  43 #ifdef HAVE_ERRNO_H
  44 #   include <errno.h>
  45 #endif
  46
  47 #include <csri/csri.h>
  48 #include <csri/stream.h>
  49
  50 /*****************************************************************************
  51  * Local prototypes
  52  *****************************************************************************/
  53 static int  Create ( vlc_object_t * );
  54 static void Destroy( vlc_object_t * );
  55
  56 static subpicture_t *DecodeBlock( decoder_t *, block_t ** );
  57 static void DestroySubpicture( subpicture_t * );
  58 static void PreRender( video_format_t *, spu_t *, subpicture_t *, mtime_t );
  59 static subpicture_region_t *UpdateRegions( video_format_t *, spu_t *,
  60                                            subpicture_t *, mtime_t );
  61
  62 /*****************************************************************************
  63  * Module descriptor
  64  *****************************************************************************/
  65
  66 vlc_module_begin();
  67     set_shortname( _("Subtitles (advanced)"));
  68     set_description( _("Wrapper for subtitle renderers using CSRI/asa") );
  69     set_capability( "decoder", 60 );
  70     set_category( CAT_INPUT );
  71     set_subcategory( SUBCAT_INPUT_SCODEC );
  72     set_callbacks( Create, Destroy );
  73 vlc_module_end();
  74
  75 /*****************************************************************************
  76  * decoder_sys_t: filter data
  77  *****************************************************************************/
  78 struct decoder_sys_t
  79 {
  80     subpicture_t *p_spu_final;
  81     video_format_t fmt_cached;
  82     csri_inst *p_instance;
  83     void (*pf_push_packet)(csri_inst *inst, const void *packet,
  84                            size_t packetlen, double pts_start,
  85                            double pts_end);
  86 };
  87
  88 struct subpicture_sys_t
  89 {
  90     decoder_t *p_dec;
  91     void *p_subs_data;
  92     int i_subs_len;
  93 };
  94
  95 /*****************************************************************************
  96  * Create: Open CSRI renderer
  97  *****************************************************************************
  98  * Comment me.
  99  *****************************************************************************/
 100 static int Create( vlc_object_t *p_this )
 101 {
 102     decoder_t *p_dec = (decoder_t *)p_this;
 103     decoder_sys_t *p_sys;
 104     csri_rend *p_render;
 105     struct csri_stream_ext *p_streamext;
 106
 107     if( p_dec->fmt_in.i_codec != VLC_FOURCC('s','s','a',' ') )
 108     {
 109         return VLC_EGENERIC;
 110     }
 111
 112     p_render = csri_renderer_default();
 113     if (!p_render)
 114     {
 115         msg_Err( p_dec, "can't load csri renderer" );
 116         return VLC_EGENERIC;
 117     }
 118     p_streamext = csri_query_ext(p_render, CSRI_EXT_STREAM_ASS);
 119     if (!p_streamext)
 120     {
 121         msg_Err( p_dec, "csri renderer does not support ASS streaming" );
 122         return VLC_EGENERIC;
 123     }
 124
 125     p_dec->pf_decode_sub = DecodeBlock;
 126
 127     p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
 128     if( !p_sys )
 129     {
 130         msg_Err( p_dec, "out of memory" );
 131         return VLC_ENOMEM;
 132     }
 133     memset( &p_dec->p_sys->fmt_cached, 0, sizeof( p_dec->p_sys->fmt_cached ) );
 134
 135     p_sys->pf_push_packet = p_streamext->push_packet;
 136     p_sys->p_instance = p_streamext->init_stream(p_render,
 137                                                  p_dec->fmt_in.p_extra,
 138                                                  p_dec->fmt_in.i_extra - 1,
 139                                                  NULL);
 140     return VLC_SUCCESS;
 141 }
 142
 143 /*****************************************************************************
 144  * Destroy: finish
 145  *****************************************************************************
 146  * Comment me.
 147  *****************************************************************************/
 148 static void Destroy( vlc_object_t *p_this )
 149 {
 150     filter_t *p_filter = (filter_t *)p_this;
 151     filter_sys_t *p_sys = p_filter->p_sys;
 152
 153     free( p_sys );
 154 }
 155
 156 /****************************************************************************
 157  * DecodeBlock: the whole thing
 158  ****************************************************************************
 159  * This function must be fed with complete subtitles units.
 160  ****************************************************************************/
 161 static subpicture_t *DecodeBlock( decoder_t *p_dec, block_t **pp_block )
 162 {
 163     subpicture_t *p_spu = NULL;
 164     block_t *p_block;
 165
 166     msg_Dbg( p_dec, "DecodeBlock %p", (void *)pp_block);
 167     if( !pp_block || *pp_block == NULL ) return NULL;
 168     p_block = *pp_block;
 169     if( p_block->i_buffer == 0 || p_block->p_buffer[0] == '\0' ) return NULL;
 170
 171     p_spu = p_dec->pf_spu_buffer_new( p_dec );
 172     if( !p_spu )
 173     {
 174         msg_Warn( p_dec, "can't get spu buffer" );
 175         block_Release( *pp_block );
 176         *pp_block = NULL;
 177         return NULL;
 178     }
 179
 180     p_spu->p_sys = malloc( sizeof( subpicture_sys_t ));
 181     if( !p_spu->p_sys )
 182     {
 183         msg_Err( p_dec, "out of memory" );
 184         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 185         block_Release( *pp_block );
 186         *pp_block = NULL;
 187         return NULL;
 188     }
 189     p_spu->p_sys->p_dec = p_dec;
 190
 191     p_spu->p_sys->i_subs_len = p_block->i_buffer;
 192     p_spu->p_sys->p_subs_data = malloc( p_block->i_buffer );
 193     if( !p_spu->p_sys->p_subs_data )
 194     {
 195         msg_Err( p_dec, "out of memory" );
 196         free( p_spu->p_sys );
 197         p_dec->pf_spu_buffer_del( p_dec, p_spu );
 198         block_Release( *pp_block );
 199         *pp_block = NULL;
 200         return NULL;
 201     }
 202     memcpy( p_spu->p_sys->p_subs_data, p_block->p_buffer,
 203             p_block->i_buffer );
 204
 205     p_spu->i_x = 0;
 206     p_spu->i_y = 0;
 207     p_spu->i_start = p_block->i_pts;
 208     p_spu->i_stop = p_block->i_pts + p_block->i_length;
 209     p_spu->b_ephemer = false;
 210     p_spu->b_absolute = false;
 211     p_spu->b_pausable = true;
 212
 213     msg_Dbg( p_dec, "BS %lf..%lf", p_spu->i_start * 0.000001, p_spu->i_stop * 0.000001);
 214     p_dec->p_sys->pf_push_packet(p_dec->p_sys->p_instance,
 215                                  p_spu->p_sys->p_subs_data, p_block->i_buffer,
 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( *pp_block );
 224     *pp_block = NULL;
 225
 226     return p_spu;
 227 }
 228
 229 static void DestroySubpicture( subpicture_t *p_subpic )
 230 {
 231     msg_Dbg( p_subpic->p_sys->p_dec, "drop spu %p", (void *)p_subpic );
 232     free( p_subpic->p_sys->p_subs_data );
 233     free( p_subpic->p_sys );
 234 }
 235
 236 static void PreRender( video_format_t *p_fmt, spu_t *p_spu,
 237                        subpicture_t *p_subpic, mtime_t ts )
 238 {
 239     decoder_t *p_dec = p_subpic->p_sys->p_dec;
 240     p_dec->p_sys->p_spu_final = p_subpic;
 241 }
 242
 243 static subpicture_region_t *UpdateRegions( video_format_t *p_fmt, spu_t *p_spu,
 244                                            subpicture_t *p_subpic, mtime_t ts )
 245 {
 246     decoder_t *p_dec = p_subpic->p_sys->p_dec;
 247     subpicture_region_t *p_spu_region;
 248     video_format_t fmt;
 249     struct csri_frame csri_frame;
 250
 251     if (p_subpic != p_dec->p_sys->p_spu_final)
 252     {
 253         return NULL;
 254     }
 255
 256     memcpy( &fmt, p_fmt, sizeof( fmt ) );
 257     fmt.i_chroma = VLC_FOURCC('R','G','B','A');
 258     fmt.i_width = fmt.i_visible_width;
 259     fmt.i_height = fmt.i_visible_height;
 260     fmt.i_bits_per_pixel = 0;
 261     fmt.i_x_offset = fmt.i_y_offset = 0;
 262
 263     if (memcmp(&fmt, &p_dec->p_sys->fmt_cached, sizeof(fmt)))
 264     {
 265         struct csri_fmt csri_fmt;
 266         memset(&csri_fmt, 0, sizeof(csri_fmt));
 267         csri_fmt.pixfmt = CSRI_F_RGBA;
 268         csri_fmt.width = fmt.i_width;
 269         csri_fmt.height = fmt.i_height;
 270         if( csri_request_fmt(p_dec->p_sys->p_instance, &csri_fmt) )
 271             msg_Dbg( p_dec, "csri error: format not supported" );
 272
 273         memcpy(&p_dec->p_sys->fmt_cached, &fmt, sizeof(fmt));
 274     }
 275
 276     p_spu_region = p_subpic->pf_create_region( VLC_OBJECT(p_dec), &fmt );
 277     p_spu_region->i_align = SUBPICTURE_ALIGN_TOP;
 278
 279     csri_frame.pixfmt = CSRI_F_RGBA;
 280     csri_frame.planes[0] = (unsigned char*)p_spu_region->picture.Y_PIXELS;
 281     csri_frame.strides[0] = p_spu_region->picture.Y_PITCH;
 282
 283     msg_Dbg( p_dec, "TS %lf", ts * 0.000001 );
 284     csri_render( p_dec->p_sys->p_instance, &csri_frame, ts * 0.000001 );
 285     memset(p_spu_region->picture.Y_PIXELS, 0xff, fmt.i_width);
 286     memset(p_spu_region->picture.Y_PIXELS + p_spu_region->picture.Y_PITCH
 287                     * (fmt.i_height - 1), 0x88, fmt.i_width);
 288
 289     p_subpic->p_region = p_spu_region;
 290     return p_spu_region;
 291 }
 292