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

   1 /*****************************************************************************
   2  * subtitle.c: subtitle decoder using ffmpeg library
   3  *****************************************************************************
   4  * Copyright (C) 2009 Laurent Aimar
   5  * $Id$
   6  *
   7  * Authors: Laurent Aimar <fenrir _AT_ videolan _DOT_ 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 #ifdef HAVE_CONFIG_H
  28 # include "config.h"
  29 #endif
  30 #include <assert.h>
  31
  32 #include <vlc_common.h>
  33 #include <vlc_codec.h>
  34 #include <vlc_avcodec.h>
  35
  36 /* ffmpeg header */
  37 #include <libavcodec/avcodec.h>
  38 #include <libavutil/mem.h>
  39 #ifdef HAVE_AVCODEC_VAAPI
  40 #    include <libavcodec/vaapi.h>
  41 #endif
  42
  43 #include "avcodec.h"
  44
  45 struct decoder_sys_t {
  46     AVCODEC_COMMON_MEMBERS
  47 };
  48
  49 static subpicture_t *ConvertSubtitle(decoder_t *, AVSubtitle *, mtime_t pts);
  50
  51 /**
  52  * Initialize subtitle decoder
  53  */
  54 int InitSubtitleDec(decoder_t *dec, AVCodecContext *context,
  55                     AVCodec *codec, int codec_id, const char *namecodec)
  56 {
  57     decoder_sys_t *sys;
  58
  59     /* */
  60     switch (codec_id) {
  61     case CODEC_ID_HDMV_PGS_SUBTITLE:
  62     case CODEC_ID_XSUB:
  63         break;
  64     default:
  65         msg_Warn(dec, "refusing to decode non validated subtitle codec");
  66         return VLC_EGENERIC;
  67     }
  68
  69     /* */
  70     dec->p_sys = sys = malloc(sizeof(*sys));
  71     if (!sys)
  72         return VLC_ENOMEM;
  73
  74     codec->type = AVMEDIA_TYPE_SUBTITLE;
  75     context->codec_type = AVMEDIA_TYPE_SUBTITLE;
  76     context->codec_id = codec_id;
  77     sys->p_context = context;
  78     sys->p_codec = codec;
  79     sys->i_codec_id = codec_id;
  80     sys->psz_namecodec = namecodec;
  81     sys->b_delayed_open = false;
  82
  83     /* */
  84     context->extradata_size = 0;
  85     context->extradata = NULL;
  86
  87     /* */
  88     int ret;
  89     vlc_avcodec_lock();
  90 #if LIBAVCODEC_VERSION_MAJOR < 54
  91     ret = avcodec_open(context, codec);
  92 #else
  93     ret = avcodec_open2(context, codec, NULL /* options */);
  94 #endif
  95     vlc_avcodec_unlock();
  96     if (ret < 0) {
  97         msg_Err(dec, "cannot open codec (%s)", namecodec);
  98         free(context->extradata);
  99         free(sys);
 100         return VLC_EGENERIC;
 101     }
 102
 103     /* */
 104     msg_Dbg(dec, "ffmpeg codec (%s) started", namecodec);
 105     dec->fmt_out.i_cat = SPU_ES;
 106
 107     return VLC_SUCCESS;
 108 }
 109
 110 /**
 111  * Decode one subtitle
 112  */
 113 subpicture_t *DecodeSubtitle(decoder_t *dec, block_t **block_ptr)
 114 {
 115     decoder_sys_t *sys = dec->p_sys;
 116
 117     if (!block_ptr || !*block_ptr)
 118         return NULL;
 119
 120     block_t *block = *block_ptr;
 121
 122     if (block->i_flags & (BLOCK_FLAG_DISCONTINUITY|BLOCK_FLAG_CORRUPTED)) {
 123         block_Release(block);
 124         avcodec_flush_buffers(sys->p_context);
 125         return NULL;
 126     }
 127
 128     if (block->i_buffer <= 0) {
 129         block_Release(block);
 130         return NULL;
 131     }
 132
 133     *block_ptr =
 134     block      = block_Realloc(block,
 135                                0,
 136                                block->i_buffer + FF_INPUT_BUFFER_PADDING_SIZE);
 137     if (!block)
 138         return NULL;
 139     block->i_buffer -= FF_INPUT_BUFFER_PADDING_SIZE;
 140     memset(&block->p_buffer[block->i_buffer], 0, FF_INPUT_BUFFER_PADDING_SIZE);
 141
 142     /* */
 143     AVSubtitle subtitle;
 144     memset(&subtitle, 0, sizeof(subtitle));
 145
 146     AVPacket pkt;
 147     av_init_packet(&pkt);
 148     pkt.data = block->p_buffer;
 149     pkt.size = block->i_buffer;
 150
 151     int has_subtitle = 0;
 152     int used = avcodec_decode_subtitle2(sys->p_context,
 153                                         &subtitle, &has_subtitle, &pkt);
 154
 155     if (used < 0) {
 156         msg_Warn(dec, "cannot decode one subtitle (%zu bytes)",
 157                  block->i_buffer);
 158
 159         block_Release(block);
 160         return NULL;
 161     } else if ((size_t)used > block->i_buffer) {
 162         used = block->i_buffer;
 163     }
 164
 165     block->i_buffer -= used;
 166     block->p_buffer += used;
 167
 168     /* */
 169     subpicture_t *spu = NULL;
 170     if (has_subtitle)
 171         spu = ConvertSubtitle(dec, &subtitle,
 172                               block->i_pts > 0 ? block->i_pts : block->i_dts);
 173
 174     /* */
 175     if (!spu)
 176         block_Release(block);
 177     return spu;
 178 }
 179
 180 /**
 181  * Clean up private data
 182  */
 183 void EndSubtitleDec(decoder_t *dec)
 184 {
 185     VLC_UNUSED(dec);
 186 }
 187
 188 /**
 189  * Convert a RGBA ffmpeg region to our format.
 190  */
 191 static subpicture_region_t *ConvertRegionRGBA(AVSubtitleRect *ffregion)
 192 {
 193     if (ffregion->w <= 0 || ffregion->h <= 0)
 194         return NULL;
 195
 196     video_format_t fmt;
 197     memset(&fmt, 0, sizeof(fmt));
 198     fmt.i_chroma         = VLC_FOURCC('R','G','B','A');
 199     fmt.i_width          =
 200     fmt.i_visible_width  = ffregion->w;
 201     fmt.i_height         =
 202     fmt.i_visible_height = ffregion->h;
 203     fmt.i_x_offset       = 0;
 204     fmt.i_y_offset       = 0;
 205
 206     subpicture_region_t *region = subpicture_region_New(&fmt);
 207     if (!region)
 208         return NULL;
 209
 210     region->i_x = ffregion->x;
 211     region->i_y = ffregion->y;
 212     region->i_align = SUBPICTURE_ALIGN_TOP | SUBPICTURE_ALIGN_LEFT;
 213
 214     const plane_t *p = &region->p_picture->p[0];
 215     for (int y = 0; y < ffregion->h; y++) {
 216         for (int x = 0; x < ffregion->w; x++) {
 217             /* I don't think don't have paletized RGB_A_ */
 218             const uint8_t index = ffregion->pict.data[0][y * ffregion->w+x];
 219             assert(index < ffregion->nb_colors);
 220
 221             uint32_t color;
 222             memcpy(&color, &ffregion->pict.data[1][4*index], 4);
 223
 224             uint8_t *p_rgba = &p->p_pixels[y * p->i_pitch + x * p->i_pixel_pitch];
 225             p_rgba[0] = (color >> 16) & 0xff;
 226             p_rgba[1] = (color >>  8) & 0xff;
 227             p_rgba[2] = (color >>  0) & 0xff;
 228             p_rgba[3] = (color >> 24) & 0xff;
 229         }
 230     }
 231
 232     return region;
 233 }
 234
 235 /**
 236  * Convert a ffmpeg subtitle to our format.
 237  */
 238 static subpicture_t *ConvertSubtitle(decoder_t *dec, AVSubtitle *ffsub, mtime_t pts)
 239 {
 240     subpicture_t *spu = decoder_NewSubpicture(dec, NULL);
 241     if (!spu)
 242         return NULL;
 243
 244     //msg_Err(dec, "%lld %d %d",
 245     //        pts, ffsub->start_display_time, ffsub->end_display_time);
 246     spu->i_start    = pts + ffsub->start_display_time * INT64_C(1000);
 247     spu->i_stop     = pts + ffsub->end_display_time * INT64_C(1000);
 248     spu->b_absolute = true; /* FIXME How to set it right ? */
 249     spu->b_ephemer  = true; /* FIXME How to set it right ? */
 250     spu->i_original_picture_width =
 251         dec->fmt_in.subs.spu.i_original_frame_width;
 252     spu->i_original_picture_height =
 253         dec->fmt_in.subs.spu.i_original_frame_height;
 254
 255     subpicture_region_t **region_next = &spu->p_region;
 256
 257     for (unsigned i = 0; i < ffsub->num_rects; i++) {
 258         AVSubtitleRect *rec = ffsub->rects[i];
 259
 260         //msg_Err(dec, "SUBS RECT[%d]: %dx%d @%dx%d",
 261         //         i, rec->w, rec->h, rec->x, rec->y);
 262
 263         subpicture_region_t *region = NULL;
 264         switch (ffsub->format) {
 265         case 0:
 266             region = ConvertRegionRGBA(rec);
 267             break;
 268         default:
 269             msg_Warn(dec, "unsupported subtitle type");
 270             region = NULL;
 271             break;
 272         }
 273         if (region) {
 274             *region_next = region;
 275             region_next = &region->p_next;
 276         }
 277         /* Free AVSubtitleRect */
 278         avpicture_free(&rec->pict);
 279         av_free(rec);
 280     }
 281     av_free(ffsub->rects);
 282
 283     return spu;
 284 }
 285