av_subtitles.hpp

//
// av_subtitles.hpp
// ~~~~~~~~~~~~~~~~
//
// Copyright (c) 2013 Jack (jack dot wgm at gmail dot com)
//

#ifndef AV_SUBTITLES_HPP
#define AV_SUBTITLES_HPP

#if defined(_MSC_VER) && (_MSC_VER >= 1200)
# pragma once
#endif // defined(_MSC_VER) && (_MSC_VER >= 1200)

#include <vector>
#include <string>

class subtitles_impl;
class av_subtitles // : noncopyable
{
public:
	av_subtitles(void);
	virtual ~av_subtitles(void);

public:
	// filename 打开一个字幕(或内含字幕流的视频)文件.
	// width 指定将来渲染画面的宽, 必须和视频原宽一至.
	// height 指定将来渲染画面的高, 必须和视频原高一至.
	// index 字幕流索引, 默认第1个字幕流.
	// 打开成功返回true, 失败返回false.
	// !!!注意, 首次调用open将会自动使用fontconfig缓冲字体, 缓冲估计需要几分钟,
	// 会在执行目录下创建fonts-cache的目录, 你可以在open_subtitle前手工指定
	// 字体文件调用set_font, 将禁用fontconfig, 以避免cache字体长时间阻塞.
	bool open_subtilte(const std::string& filename, int width, int height, int index = 0);

	// 返回字幕列表, 在一些文件中, 可能包含多个字幕流.
	std::vector<std::string> subtitle_list();

	// 渲染一帧字幕到YUV420图片上.
	// yuv420_data 指定的yuv420数据, 必须按planar YUV 4:2:0, 12bpp, (1 Cr & Cb sample per 2x2 Y samples)编码.
	// 时间戳, 单位ms(毫秒).
	bool subtitle_do(void* yuv420_data, long long time_stamp);

	// 关闭字幕.
	void close();

	// 修改时间偏移.
	// offset 表示时间偏移, +向前, -向后. 单位ms(毫秒).
	void time_offset(long long offset);

	// 指定字体文件, 在调用open_subtilte前设置.
	// font 为指定的字体文件完整路径.
	void set_font(const std::string& font);

protected:
	av_subtitles(const av_subtitles&);
	av_subtitles& operator=(const av_subtitles&);

private:
	subtitles_impl *m_impl;
};

#endif // AV_SUBTITLES_HPP