pgssubdec.c File Reference

PGS subtitle decoder. More...

#include "avcodec.h"
#include "bytestream.h"
#include "codec_internal.h"
#include "decode.h"
#include "mathops.h"
#include "libavutil/colorspace.h"
#include "libavutil/mem.h"
#include "libavutil/opt.h"

Go to the source code of this file.

Data Structures
struct	PGSSubObjectRef
struct	PGSSubPresentation
struct	PGSSubObject
struct	PGSSubObjects
struct	PGSSubPalette
struct	PGSSubPalettes
struct	PGSSubContext

Macros
#define	RGBA(r, g, b, a)
#define	MAX_EPOCH_PALETTES   8
#define	MAX_EPOCH_OBJECTS   64
#define	MAX_OBJECT_REFS   2
#define	OFFSET(x)
#define	SD   AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Enumerations
enum	SegmentType {   PALETTE_SEGMENT = 0x14 , OBJECT_SEGMENT = 0x15 , PRESENTATION_SEGMENT = 0x16 , WINDOW_SEGMENT = 0x17 ,   DISPLAY_SEGMENT = 0x80 }

Functions
static void	flush_cache (AVCodecContext *avctx)
static PGSSubObject *	find_object (int id, PGSSubObjects *objects)
static PGSSubPalette *	find_palette (int id, PGSSubPalettes *palettes)
static av_cold int	init_decoder (AVCodecContext *avctx)
static av_cold int	close_decoder (AVCodecContext *avctx)
static int	decode_rle (AVCodecContext *avctx, AVSubtitleRect *rect, const uint8_t *buf, unsigned int buf_size)
	Decode the RLE data.
static int	parse_object_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size)
	Parse the picture segment packet.
static int	parse_palette_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size)
	Parse the palette segment packet.
static int	parse_presentation_segment (AVCodecContext *avctx, const uint8_t *buf, int buf_size, int64_t pts)
	Parse the presentation segment packet.
static int	display_end_segment (AVCodecContext *avctx, AVSubtitle *sub, const uint8_t *buf, int buf_size)
	Parse the display segment packet.
static int	decode (AVCodecContext *avctx, AVSubtitle *sub, int *got_sub_ptr, const AVPacket *avpkt)

Variables
static const AVOption	options []
static const AVClass	pgsdec_class
const FFCodec	ff_pgssub_decoder

Detailed Description

PGS subtitle decoder.

Definition in file pgssubdec.c.

Macro Definition Documentation

RGBA

#define RGBA	(		r,
			g,
			b,
			a )

Value:

(((unsigned)(a) << 24) | ((r) << 16) | ((g) << 8) | (b))

Definition at line 37 of file pgssubdec.c.

Referenced by parse_palette_segment().

MAX_EPOCH_PALETTES

#define MAX_EPOCH_PALETTES   8

Definition at line 38 of file pgssubdec.c.

Referenced by parse_palette_segment().

MAX_EPOCH_OBJECTS

#define MAX_EPOCH_OBJECTS   64

Definition at line 39 of file pgssubdec.c.

Referenced by parse_object_segment().

MAX_OBJECT_REFS

#define MAX_OBJECT_REFS   2

Definition at line 40 of file pgssubdec.c.

Referenced by parse_presentation_segment().

OFFSET

#define OFFSET

(

x

)

Value:

offsetof(PGSSubContext, x)

Definition at line 681 of file pgssubdec.c.

SD

#define SD   AV_OPT_FLAG_SUBTITLE_PARAM | AV_OPT_FLAG_DECODING_PARAM

Definition at line 682 of file pgssubdec.c.

Enumeration Type Documentation

SegmentType

enum SegmentType

Enumerator
PALETTE_SEGMENT
OBJECT_SEGMENT
PRESENTATION_SEGMENT
WINDOW_SEGMENT
DISPLAY_SEGMENT

Definition at line 42 of file pgssubdec.c.

Function Documentation

flush_cache()

static void flush_cache ( AVCodecContext * avctx )

static

Definition at line 102 of file pgssubdec.c.

Referenced by close_decoder(), and parse_presentation_segment().

find_object()

static PGSSubObject * find_object ( int id, PGSSubObjects * objects )

static

Definition at line 116 of file pgssubdec.c.

Referenced by display_end_segment(), and parse_object_segment().

find_palette()

static PGSSubPalette * find_palette ( int id, PGSSubPalettes * palettes )

static

Definition at line 127 of file pgssubdec.c.

Referenced by display_end_segment(), and parse_palette_segment().

init_decoder()

static av_cold int init_decoder ( AVCodecContext * avctx )

static

Definition at line 138 of file pgssubdec.c.

close_decoder()

static av_cold int close_decoder ( AVCodecContext * avctx )

static

Definition at line 145 of file pgssubdec.c.

decode_rle()

static int decode_rle ( AVCodecContext * avctx, AVSubtitleRect * rect, const uint8_t * buf, unsigned int buf_size )

static

Decode the RLE data.

The subtitle is stored as a Run Length Encoded image.

Parameters

avctx	contains the current codec context
sub	pointer to the processed subtitle data
buf	pointer to the RLE data to process
buf_size	size of the RLE data to process

Definition at line 162 of file pgssubdec.c.

Referenced by display_end_segment().

parse_object_segment()

static int parse_object_segment ( AVCodecContext * avctx, const uint8_t * buf, int buf_size )

static

Parse the picture segment packet.

The picture segment contains details on the sequence id, width, height and Run Length Encoded (RLE) bitmap data.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Definition at line 232 of file pgssubdec.c.

Referenced by decode().

parse_palette_segment()

static int parse_palette_segment ( AVCodecContext * avctx, const uint8_t * buf, int buf_size )

static

Parse the palette segment packet.

The palette segment contains details of the palette, a maximum of 256 colors can be defined.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Definition at line 327 of file pgssubdec.c.

Referenced by decode().

parse_presentation_segment()

static int parse_presentation_segment ( AVCodecContext * avctx, const uint8_t * buf, int buf_size, int64_t pts )

static

Parse the presentation segment packet.

The presentation segment contains details on the video width, video height, x & y subtitle position.

Parameters

avctx	contains the current codec context
buf	pointer to the packet to process
buf_size	size of packet to process

Todo

TODO: Implement cropping

Definition at line 389 of file pgssubdec.c.

Referenced by decode().

display_end_segment()

static int display_end_segment ( AVCodecContext * avctx, AVSubtitle * sub, const uint8_t * buf, int buf_size )

static

Parse the display segment packet.

The display segment controls the updating of the display.

Parameters

avctx	contains the current codec context
data	pointer to the data pertaining the subtitle to display
buf	pointer to the packet to process
buf_size	size of packet to process

Definition at line 497 of file pgssubdec.c.

Referenced by decode().

decode()

static int decode ( AVCodecContext * avctx, AVSubtitle * sub, int * got_sub_ptr, const AVPacket * avpkt )

static

Definition at line 594 of file pgssubdec.c.

Variable Documentation

options

const AVOption options[]

static

Initial value:

= {
    {"forced_subs_only", "Only show forced subtitles", OFFSET(forced_subs_only), AV_OPT_TYPE_BOOL, {.i64 = 0}, 0, 1, SD},
    { NULL },
}

Definition at line 683 of file pgssubdec.c.

pgsdec_class

const AVClass pgsdec_class

static

Initial value:

= {
    .class_name = "PGS subtitle decoder",
    .item_name  = av_default_item_name,
    .option     = options,
    .version    = LIBAVUTIL_VERSION_INT,
}

Definition at line 688 of file pgssubdec.c.

ff_pgssub_decoder

const FFCodec ff_pgssub_decoder

Initial value:

= {
    .p.name         = "pgssub",
    CODEC_LONG_NAME("HDMV Presentation Graphic Stream subtitles"),
    .p.type         = AVMEDIA_TYPE_SUBTITLE,
    .p.id           = AV_CODEC_ID_HDMV_PGS_SUBTITLE,
    .priv_data_size = sizeof(PGSSubContext),
    .init           = init_decoder,
    .close          = close_decoder,
    FF_CODEC_DECODE_SUB_CB(decode),
    .p.priv_class   = &pgsdec_class,
}

Definition at line 695 of file pgssubdec.c.