/*****************************************************************************
* svcdsub.c : Overlay Graphics Text (SVCD subtitles) decoder
*****************************************************************************
- * Copyright (C) 2003, 2004 VideoLAN
+ * Copyright (C) 2003, 2004 the VideoLAN team
* $Id$
*
* Authors: Rocky Bernstein
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston MA 02110-1301, USA.
*****************************************************************************/
-#define DEBUG_SVCD 1
-
/*****************************************************************************
* Preamble
*****************************************************************************/
-#include <vlc/vlc.h>
-#include <vlc/decoder.h>
+#ifdef HAVE_CONFIG_H
+# include "config.h"
+#endif
-#include "vlc_bits.h"
+#include <vlc_common.h>
+#include <vlc_plugin.h>
+#include <vlc_codec.h>
+#include <vlc_bits.h>
/*****************************************************************************
* Module descriptor.
static int PacketizerOpen( vlc_object_t * );
static void DecoderClose ( vlc_object_t * );
-vlc_module_begin();
- set_description( _("Philips OGT (SVCD subtitle) decoder") );
- set_shortname( N_("SVCD subtitles"));
- set_category( CAT_INPUT );
- set_subcategory( SUBCAT_INPUT_SCODEC );
- set_capability( "decoder", 50 );
- set_callbacks( DecoderOpen, DecoderClose );
+#define DEBUG_TEXT N_("Enable debug")
+
+#define DEBUG_LONGTEXT \
+ N_("This integer when viewed in binary is a debugging mask\n" \
+ "calls 1\n" \
+ "packet assembly info 2\n" )
+
+vlc_module_begin ()
+ set_description( N_("Philips OGT (SVCD subtitle) decoder") )
+ set_shortname( N_("SVCD subtitles") )
+ set_category( CAT_INPUT )
+ set_subcategory( SUBCAT_INPUT_SCODEC )
+ set_capability( "decoder", 50 )
+ set_callbacks( DecoderOpen, DecoderClose )
- add_submodule();
- set_description( _("Philips OGT (SVCD subtitle) packetizer") );
- set_capability( "packetizer", 50 );
- set_callbacks( PacketizerOpen, DecoderClose );
-vlc_module_end();
+ add_integer ( MODULE_STRING "-debug", 0, NULL,
+ DEBUG_TEXT, DEBUG_LONGTEXT, true )
+
+ add_submodule ()
+ set_description( N_("Philips OGT (SVCD subtitle) packetizer") )
+ set_capability( "packetizer", 50 )
+ set_callbacks( PacketizerOpen, DecoderClose )
+vlc_module_end ()
/*****************************************************************************
* Local prototypes
static block_t *Reassemble ( decoder_t *, block_t * );
static void ParseHeader( decoder_t *, block_t * );
static subpicture_t *DecodePacket( decoder_t *, block_t * );
-static void RenderImage( decoder_t *, block_t *, subpicture_region_t * );
+static void SVCDSubRenderImage( decoder_t *, block_t *, subpicture_region_t * );
+
+#define DECODE_DBG_CALL 1 /* calls */
+#define DECODE_DBG_PACKET 2 /* packet assembly info */
#define GETINT16(p) ( (p[0] << 8) + p[1] ) ; p +=2;
#define GETINT32(p) ( (p[0] << 24) + (p[1] << 16) + \
(p[2] << 8) + (p[3]) ) ; p += 4;
-#define SUBTITLE_BLOCK_EMPTY 0
-#define SUBTITLE_BLOCK_PARTIAL 1
-#define SUBTITLE_BLOCK_COMPLETE 2
+typedef enum {
+ SUBTITLE_BLOCK_EMPTY = 0,
+ SUBTITLE_BLOCK_PARTIAL = 1,
+ SUBTITLE_BLOCK_COMPLETE = 2
+} packet_state_t;
+
+#ifndef DECODE_DEBUG
+#define DECODE_DEBUG 1
+#endif
+#if DECODE_DEBUG
+#define dbg_print(mask, s, args...) \
+ if (p_sys && p_sys->i_debug & mask) \
+ msg_Dbg(p_dec, "%s: "s, __func__ , ##args)
+#else
+#define dbg_print(mask, s, args...)
+#endif
struct decoder_sys_t
{
- int b_packetizer;
+ int i_debug; /* debugging mask */
- int i_state; /* data-gathering state for this subtitle */
+ packet_state_t i_state; /* data-gathering state for this subtitle */
- block_t *p_spu; /* Bytes of the packet. */
+ block_t *p_spu; /* Bytes of the packet. */
- uint16_t i_image; /* image number in the subtitle stream */
- uint8_t i_packet; /* packet number for above image number */
+ uint16_t i_image; /* image number in the subtitle stream */
+ uint8_t i_packet; /* packet number for above image number */
- int i_spu_size; /* goal for subtitle_data_pos while gathering,
+ size_t i_spu_size; /* goal for subtitle_data_pos while gathering,
size of used subtitle_data later */
uint16_t i_image_offset; /* offset from subtitle_data to compressed
image data */
- int i_image_length; /* size of the compressed image data */
- int second_field_offset; /* offset of odd raster lines */
- int metadata_offset; /* offset to data describing the image */
- int metadata_length; /* length of metadata */
+ size_t i_image_length; /* size of the compressed image data */
+ size_t second_field_offset; /* offset of odd raster lines */
+ size_t metadata_offset; /* offset to data describing the image */
+ size_t metadata_length; /* length of metadata */
mtime_t i_duration; /* how long to display the image, 0 stands
for "until next subtitle" */
decoder_t *p_dec = (decoder_t*)p_this;
decoder_sys_t *p_sys;
- if( p_dec->fmt_in.i_codec != VLC_FOURCC( 'o','g','t',' ' ) )
- {
+ if( p_dec->fmt_in.i_codec != VLC_CODEC_OGT )
return VLC_EGENERIC;
- }
- p_dec->p_sys = p_sys = malloc( sizeof( decoder_sys_t ) );
+ p_dec->p_sys = p_sys = calloc( 1, sizeof( decoder_sys_t ) );
+ if( p_sys == NULL )
+ return VLC_ENOMEM;
- p_sys->b_packetizer = VLC_FALSE;
- p_sys->i_image = -1;
+ p_sys->i_debug = var_InheritInteger( p_this, MODULE_STRING "-debug" );
+
+ p_sys->i_image = -1;
p_sys->i_state = SUBTITLE_BLOCK_EMPTY;
p_sys->p_spu = NULL;
- es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_FOURCC( 'o','g','t',' ' ) );
+ es_format_Init( &p_dec->fmt_out, SPU_ES, VLC_CODEC_OGT );
p_dec->pf_decode_sub = Decode;
p_dec->pf_packetize = Packetize;
+ dbg_print( (DECODE_DBG_CALL) , "");
return VLC_SUCCESS;
}
*****************************************************************************/
static int PacketizerOpen( vlc_object_t *p_this )
{
- decoder_t *p_dec = (decoder_t*)p_this;
-
if( DecoderOpen( p_this ) != VLC_SUCCESS ) return VLC_EGENERIC;
- p_dec->p_sys->b_packetizer = VLC_TRUE;
-
return VLC_SUCCESS;
}
static subpicture_t *Decode( decoder_t *p_dec, block_t **pp_block )
{
block_t *p_block, *p_spu;
+ decoder_sys_t *p_sys = p_dec->p_sys;
+
+ dbg_print( (DECODE_DBG_CALL) , "");
if( pp_block == NULL || *pp_block == NULL ) return NULL;
uint16_t i_expected_image;
uint8_t i_packet, i_expected_packet;
+ if( p_block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED) )
+ {
+ block_Release( p_block );
+ return NULL;
+ }
+
if( p_block->i_buffer < SPU_HEADER_LEN )
{
- msg_Dbg( p_dec, "invalid packet header (size %d < %d)" ,
+ msg_Dbg( p_dec, "invalid packet header (size %zu < %u)" ,
p_block->i_buffer, SPU_HEADER_LEN );
block_Release( p_block );
return NULL;
p_buffer = p_block->p_buffer;
- /* Attach to our input thread and see if subtitle is selected. */
- {
- vlc_object_t * p_input;
- vlc_value_t val;
-
- p_input = vlc_object_find( p_dec, VLC_OBJECT_INPUT, FIND_PARENT );
-
- if( !p_input ) return NULL;
-
- if( var_Get( p_input, "spu-channel", &val ) )
- {
- vlc_object_release( p_input );
- return NULL;
- }
-
- vlc_object_release( p_input );
- msg_Dbg( p_dec, "val.i_int %x p_buffer[i] %x", val.i_int, p_buffer[1]);
-
- /* The dummy ES that the menu selection uses has an 0x70 at
- the head which we need to strip off. */
- if( val.i_int == -1 || (val.i_int & 0x03) != p_buffer[1] )
- {
- msg_Dbg( p_dec, "subtitle not for us." );
- return NULL;
- }
- }
-
if( p_sys->i_state == SUBTITLE_BLOCK_EMPTY )
{
i_expected_image = p_sys->i_image + 1;
i_expected_packet = p_sys->i_packet + 1;
}
+ /* The dummy ES that the menu selection uses has an 0x70 at
+ the head which we need to strip off. */
p_buffer += 2;
if( *p_buffer & 0x80 )
if( p_spu->i_buffer != p_sys->i_spu_size )
{
- msg_Warn( p_dec, "SPU packets size=%d should be %d",
+ msg_Warn( p_dec, "subtitle packets size=%zu should be %zu",
p_spu->i_buffer, p_sys->i_spu_size );
}
- msg_Dbg( p_dec, "subtitle packet complete, size=%d", p_spu->i_buffer);
+ dbg_print( (DECODE_DBG_PACKET),
+ "subtitle packet complete, size=%zu", p_spu->i_buffer );
p_sys->i_state = SUBTITLE_BLOCK_EMPTY;
p_sys->p_spu = 0;
size description
-------------------------------------------
- byte subtitle channel (0..7) in bits 0-3
+ byte subtitle channel (0..7) in bits 0-3
byte subtitle packet number of this subtitle image 0-N,
if the subtitle packet is complete, the top bit of the byte is 1.
u_int16 subtitle image number
u_int16 length in bytes of the rest
byte option flags, unknown meaning except bit 3 (0x08) indicates
presence of the duration field
- byte unknown
+ byte unknown
u_int32 duration in 1/90000ths of a second (optional), start time
is as indicated by the PTS in the PES header
u_int32 xpos
cmd>>6==1 indicates shift
(cmd>>4)&3 is direction from, (0=top,1=left,2=right,3=bottom)
u_int32 shift duration in 1/90000ths of a second
- u_int16 offset of odd-numbered scanlines - subtitle images are
+ u_int16 offset of odd-numbered scanlines - subtitle images are
given in interlace order
byte[] limited RLE image data in interlace order (0,2,4... 1,3,5) with
2-bits per palette number
p_sys->i_image_length = p_sys->i_spu_size - p_sys->i_image_offset;
p_sys->metadata_length = p_sys->i_image_offset;
-#ifdef DEBUG_SVCD
- msg_Dbg( p_dec, "x-start: %d, y-start: %d, width: %d, height %d, "
- "spu size: %d, duration: %lu (d:%d p:%d)",
- p_sys->i_x_start, p_sys->i_y_start,
- p_sys->i_width, p_sys->i_height,
- p_sys->i_spu_size, (long unsigned int) p_sys->i_duration,
- p_sys->i_image_length, p_sys->i_image_offset);
-
- for( i = 0; i < 4; i++ )
- {
- msg_Dbg( p_dec, "palette[%d]= T: %2x, Y: %2x, u: %2x, v: %2x", i,
- p_sys->p_palette[i][3], p_sys->p_palette[i][0],
- p_sys->p_palette[i][1], p_sys->p_palette[i][2] );
- }
-#endif
+ if( p_sys->i_debug & DECODE_DBG_PACKET )
+ {
+ msg_Dbg( p_dec, "x-start: %d, y-start: %d, width: %d, height %d, "
+ "spu size: %zu, duration: %"PRIu64" (d:%zu p:%"PRIu16")",
+ p_sys->i_x_start, p_sys->i_y_start,
+ p_sys->i_width, p_sys->i_height,
+ p_sys->i_spu_size, p_sys->i_duration,
+ p_sys->i_image_length, p_sys->i_image_offset);
+
+ for( i = 0; i < 4; i++ )
+ {
+ msg_Dbg( p_dec, "palette[%d]= T: %2x, Y: %2x, u: %2x, v: %2x", i,
+ p_sys->p_palette[i][3], p_sys->p_palette[i][0],
+ p_sys->p_palette[i][1], p_sys->p_palette[i][2] );
+ }
+ }
}
/*****************************************************************************
- * DecodePacket: parse and decode an SPU packet
+ * DecodePacket: parse and decode an subtitle packet
*****************************************************************************
* This function parses and decodes an SPU packet and, if valid, returns a
* subpicture.
subpicture_t *p_spu;
subpicture_region_t *p_region;
video_format_t fmt;
+ video_palette_t palette;
int i;
/* Allocate the subpicture internal data. */
- p_spu = p_dec->pf_spu_buffer_new( p_dec );
+ p_spu = decoder_NewSubpicture( p_dec, NULL );
if( !p_spu ) return NULL;
- p_spu->i_x = p_sys->i_x_start;
- p_spu->i_x = p_spu->i_x * 3 / 4; /* FIXME: use aspect ratio for x? */
- p_spu->i_y = p_sys->i_y_start;
p_spu->i_start = p_data->i_pts;
p_spu->i_stop = p_data->i_pts + p_sys->i_duration;
- p_spu->b_ephemer = VLC_TRUE;
+ p_spu->b_ephemer = true;
- /* Create new SPU region */
+ /* Create new subtitle region */
memset( &fmt, 0, sizeof(video_format_t) );
- fmt.i_chroma = VLC_FOURCC('Y','U','V','P');
- fmt.i_aspect = VOUT_ASPECT_FACTOR;
+ fmt.i_chroma = VLC_CODEC_YUVP;
+
+ /**
+ The video on which the subtitle sits, is scaled, probably
+ 4:3. However subtitle bitmaps assume an 1:1 aspect ratio.
+
+ FIXME: We should get the video aspect ratio from somewhere.
+ Two candidates are the video and the other possibility would be
+ the access module.
+ */
+ fmt.i_sar_num = p_sys->i_height;
+ fmt.i_sar_den = p_sys->i_width;
+
fmt.i_width = fmt.i_visible_width = p_sys->i_width;
fmt.i_height = fmt.i_visible_height = p_sys->i_height;
fmt.i_x_offset = fmt.i_y_offset = 0;
- p_region = p_spu->pf_create_region( VLC_OBJECT(p_dec), &fmt );
- if( !p_region )
- {
- msg_Err( p_dec, "cannot allocate SPU region" );
- //goto error;
- }
-
- p_spu->p_region = p_region;
- p_region->i_x = p_region->i_y = 0;
-
- /* Build palette */
+ fmt.p_palette = &palette;
fmt.p_palette->i_entries = 4;
for( i = 0; i < fmt.p_palette->i_entries; i++ )
{
fmt.p_palette->palette[i][3] = p_sys->p_palette[i][3];
}
- RenderImage( p_dec, p_data, p_region );
+ p_region = subpicture_region_New( &fmt );
+ if( !p_region )
+ {
+ msg_Err( p_dec, "cannot allocate SVCD subtitle region" );
+ decoder_DeleteSubpicture( p_dec, p_spu );
+ return NULL;
+ }
+
+ p_spu->p_region = p_region;
+ p_region->i_x = p_sys->i_x_start;
+ p_region->i_y = p_sys->i_y_start;
+
+ SVCDSubRenderImage( p_dec, p_data, p_region );
return p_spu;
}
/*****************************************************************************
- * ParseImage: parse the image part of the subtitle
+ * SVCDSubRenderImage: reorders bytes of image data in subpicture region.
*****************************************************************************
- This part parses the subtitle graphical data and renders it.
The image is encoded using two bits per pixel that select a palette
entry except that value 0 starts a limited run-length encoding for
However we'll transform this so that that the RLE is expanded and
interlacing will also be removed.
*****************************************************************************/
-static void RenderImage( decoder_t *p_dec, block_t *p_data,
- subpicture_region_t *p_region )
+static void SVCDSubRenderImage( decoder_t *p_dec, block_t *p_data,
+ subpicture_region_t *p_region )
{
decoder_sys_t *p_sys = p_dec->p_sys;
- uint8_t *p_dest = p_region->picture.Y_PIXELS;
+ uint8_t *p_dest = p_region->p_picture->Y_PIXELS;
int i_field; /* The subtitles are interlaced */
int i_row, i_column; /* scanline row/column number */
uint8_t i_color, i_count;
if( i_color == 0 && (i_count = bs_read( &bs, 2 )) )
{
i_count = __MIN( i_count, p_sys->i_width - i_column );
- memset( &p_dest[i_row * p_region->picture.Y_PITCH +
+ memset( &p_dest[i_row * p_region->p_picture->Y_PITCH +
i_column], 0, i_count + 1 );
i_column += i_count;
continue;
}
- p_dest[i_row * p_region->picture.Y_PITCH + i_column] = i_color;
+ p_dest[i_row * p_region->p_picture->Y_PITCH + i_column] = i_color;
}
bs_align( &bs );
projects / vlc / blobdiff