138
Sources/libass.xcframework/Info.plist
Normal file
138
Sources/libass.xcframework/Info.plist
Normal file
@ -0,0 +1,138 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>AvailableLibraries</key>
|
||||
<array>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>ios-arm64_x86_64-maccatalyst</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
<string>x86_64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>ios</string>
|
||||
<key>SupportedPlatformVariant</key>
|
||||
<string>maccatalyst</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>macos-arm64_x86_64</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
<string>x86_64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>macos</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>xros-arm64</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>xros</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>tvos-arm64_x86_64-simulator</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
<string>x86_64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>tvos</string>
|
||||
<key>SupportedPlatformVariant</key>
|
||||
<string>simulator</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>ios-arm64</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>ios</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>ios-arm64_x86_64-simulator</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
<string>x86_64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>ios</string>
|
||||
<key>SupportedPlatformVariant</key>
|
||||
<string>simulator</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>tvos-arm64_arm64e</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
<string>arm64e</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>tvos</string>
|
||||
</dict>
|
||||
<dict>
|
||||
<key>BinaryPath</key>
|
||||
<string>libass.framework/libass</string>
|
||||
<key>LibraryIdentifier</key>
|
||||
<string>xros-arm64-simulator</string>
|
||||
<key>LibraryPath</key>
|
||||
<string>libass.framework</string>
|
||||
<key>SupportedArchitectures</key>
|
||||
<array>
|
||||
<string>arm64</string>
|
||||
</array>
|
||||
<key>SupportedPlatform</key>
|
||||
<string>xros</string>
|
||||
<key>SupportedPlatformVariant</key>
|
||||
<string>simulator</string>
|
||||
</dict>
|
||||
</array>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>XFWK</string>
|
||||
<key>XCFrameworkFormatVersion</key>
|
||||
<string>1.0</string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>13.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>iPhoneOS</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
BIN
Sources/libass.xcframework/ios-arm64/libass.framework/libass
Normal file
BIN
Sources/libass.xcframework/ios-arm64/libass.framework/libass
Normal file
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>14.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>MacOSX</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>13.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>iPhoneSimulator</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>10.15</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>MacOSX</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>13.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>AppleTVOS</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>13.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>AppleTVSimulator</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>1.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>XRSimulator</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
Binary file not shown.
@ -0,0 +1,812 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_ASS_H
|
||||
#define LIBASS_ASS_H
|
||||
|
||||
#include <stdio.h>
|
||||
#include <stdarg.h>
|
||||
#include "ass_types.h"
|
||||
|
||||
#define LIBASS_VERSION 0x01701000
|
||||
|
||||
#ifdef __cplusplus
|
||||
extern "C" {
|
||||
#endif
|
||||
|
||||
#if (defined(__GNUC__) && ((__GNUC__ > 3) || (__GNUC__ == 3 && __GNUC_MINOR__ >= 1))) || defined(__clang__)
|
||||
#if __GNUC__ > 4 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 5) || defined(__clang__)
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg) __attribute__((deprecated))
|
||||
#endif
|
||||
#if __GNUC__ > 5 || defined(__clang__)
|
||||
#define ASS_DEPRECATED_ENUM(msg) __attribute__((deprecated(msg)))
|
||||
#else
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
#elif defined(_MSC_VER)
|
||||
#define ASS_DEPRECATED(msg) __declspec(deprecated(msg))
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#else
|
||||
#define ASS_DEPRECATED(msg)
|
||||
#define ASS_DEPRECATED_ENUM(msg)
|
||||
#endif
|
||||
|
||||
|
||||
/*
|
||||
* A linked list of images produced by an ass renderer.
|
||||
*
|
||||
* These images have to be rendered in-order for the correct screen
|
||||
* composition. The libass renderer clips these bitmaps to the frame size.
|
||||
* w/h can be zero, in this case the bitmap should not be rendered at all.
|
||||
* The last bitmap row is not guaranteed to be padded up to stride size,
|
||||
* e.g. in the worst case a bitmap has the size stride * (h - 1) + w.
|
||||
*/
|
||||
typedef struct ass_image {
|
||||
int w, h; // Bitmap width/height
|
||||
int stride; // Bitmap stride
|
||||
unsigned char *bitmap; // 1bpp stride*h alpha buffer
|
||||
// Note: the last row may not be padded to
|
||||
// bitmap stride!
|
||||
uint32_t color; // Bitmap color and alpha, RGBA
|
||||
// For full VSFilter compatibility, the value
|
||||
// must be transformed as described in
|
||||
// ass_types.h for ASS_YCbCrMatrix
|
||||
int dst_x, dst_y; // Bitmap placement inside the video frame
|
||||
|
||||
struct ass_image *next; // Next image, or NULL
|
||||
|
||||
enum {
|
||||
IMAGE_TYPE_CHARACTER,
|
||||
IMAGE_TYPE_OUTLINE,
|
||||
IMAGE_TYPE_SHADOW
|
||||
} type;
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Image;
|
||||
|
||||
/*
|
||||
* Hinting type. (see ass_set_hinting below)
|
||||
*
|
||||
* Setting hinting to anything but ASS_HINTING_NONE will put libass in a mode
|
||||
* that reduces compatibility with vsfilter and many ASS scripts. The main
|
||||
* problem is that hinting conflicts with smooth scaling, which precludes
|
||||
* animations and precise positioning.
|
||||
*
|
||||
* In other words, enabling hinting might break some scripts severely.
|
||||
*
|
||||
* FreeType's native hinter is still buggy sometimes and it is recommended
|
||||
* to use the light autohinter, ASS_HINTING_LIGHT, instead. For best
|
||||
* compatibility with problematic fonts, disable hinting.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_HINTING_NONE = 0,
|
||||
ASS_HINTING_LIGHT,
|
||||
ASS_HINTING_NORMAL,
|
||||
ASS_HINTING_NATIVE
|
||||
} ASS_Hinting;
|
||||
|
||||
/**
|
||||
* \brief Text shaping levels.
|
||||
*
|
||||
* SIMPLE is a fast, font-agnostic shaper that can do only substitutions.
|
||||
* COMPLEX is a slower shaper using OpenType for substitutions and positioning.
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_SHAPING_SIMPLE = 0,
|
||||
ASS_SHAPING_COMPLEX
|
||||
} ASS_ShapingLevel;
|
||||
|
||||
/**
|
||||
* \brief Style override options. See
|
||||
* ass_set_selective_style_override_enabled() for details.
|
||||
*/
|
||||
typedef enum {
|
||||
/**
|
||||
* Default mode (with no other bits set). All selective override features
|
||||
* as well as the style set with ass_set_selective_style_override() are
|
||||
* disabled, but traditional overrides like ass_set_font_scale() are
|
||||
* applied unconditionally.
|
||||
*/
|
||||
ASS_OVERRIDE_DEFAULT = 0,
|
||||
/**
|
||||
* Apply the style as set with ass_set_selective_style_override() on events
|
||||
* which look like dialogue. Other style overrides are also applied this
|
||||
* way, except ass_set_font_scale(). How ass_set_font_scale() is applied
|
||||
* depends on the ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE flag.
|
||||
*
|
||||
* This is equivalent to setting all of the following bits:
|
||||
*
|
||||
* ASS_OVERRIDE_BIT_FONT_NAME
|
||||
* ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS
|
||||
* ASS_OVERRIDE_BIT_COLORS
|
||||
* ASS_OVERRIDE_BIT_BORDER
|
||||
* ASS_OVERRIDE_BIT_ATTRIBUTES
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_STYLE = 1 << 0,
|
||||
/**
|
||||
* Apply ass_set_font_scale() only on events which look like dialogue.
|
||||
* If not set, the font scale is applied to all events. (The behavior and
|
||||
* name of this flag are unintuitive, but exist for compatibility)
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE = 1 << 1,
|
||||
/**
|
||||
* Old alias for ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE. Deprecated. Do not use.
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE ASS_DEPRECATED_ENUM("replaced by ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE") = 1 << 1,
|
||||
/**
|
||||
* On dialogue events override: FontSize, Spacing, Blur, ScaleX, ScaleY
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS = 1 << 2,
|
||||
/**
|
||||
* On dialogue events override: FontName, treat_fontname_as_pattern
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_FONT_NAME = 1 << 3,
|
||||
/**
|
||||
* On dialogue events override: PrimaryColour, SecondaryColour, OutlineColour, BackColour
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_COLORS = 1 << 4,
|
||||
/**
|
||||
* On dialogue events override: Bold, Italic, Underline, StrikeOut
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ATTRIBUTES = 1 << 5,
|
||||
/**
|
||||
* On dialogue events override: BorderStyle, Outline, Shadow
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_BORDER = 1 << 6,
|
||||
/**
|
||||
* On dialogue events override: Alignment
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_ALIGNMENT = 1 << 7,
|
||||
/**
|
||||
* On dialogue events override: MarginL, MarginR, MarginV
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_MARGINS = 1 << 8,
|
||||
/**
|
||||
* Unconditionally replace all fields of all styles with the one provided
|
||||
* with ass_set_selective_style_override().
|
||||
* Does not apply ASS_OVERRIDE_BIT_SELECTIVE_FONT_SCALE.
|
||||
* Add ASS_OVERRIDE_BIT_FONT_SIZE_FIELDS and ASS_OVERRIDE_BIT_BORDER if
|
||||
* you want FontSize, Spacing, Outline, Shadow to be scaled to the script
|
||||
* resolution given by the ASS_Track.
|
||||
*/
|
||||
ASS_OVERRIDE_FULL_STYLE = 1 << 9,
|
||||
/**
|
||||
* On dialogue events override: Justify
|
||||
*/
|
||||
ASS_OVERRIDE_BIT_JUSTIFY = 1 << 10,
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_OverrideBits;
|
||||
|
||||
/**
|
||||
* \brief Return the version of library. This returns the value LIBASS_VERSION
|
||||
* was set to when the library was compiled.
|
||||
* \return library version
|
||||
*/
|
||||
int ass_library_version(void);
|
||||
|
||||
/**
|
||||
* \brief Default Font provider to load fonts in libass' database
|
||||
*
|
||||
* NONE don't use any default font provider for font lookup
|
||||
* AUTODETECT use the first available font provider
|
||||
* CORETEXT force a CoreText based font provider (OS X only)
|
||||
* DIRECTWRITE force a DirectWrite based font provider (Microsoft Win32 only)
|
||||
* FONTCONFIG force a Fontconfig based font provider
|
||||
*
|
||||
* libass uses the best shaper available by default.
|
||||
*/
|
||||
typedef enum {
|
||||
ASS_FONTPROVIDER_NONE = 0,
|
||||
ASS_FONTPROVIDER_AUTODETECT = 1,
|
||||
ASS_FONTPROVIDER_CORETEXT,
|
||||
ASS_FONTPROVIDER_FONTCONFIG,
|
||||
ASS_FONTPROVIDER_DIRECTWRITE,
|
||||
} ASS_DefaultFontProvider;
|
||||
|
||||
typedef enum {
|
||||
/**
|
||||
* Enable libass extensions that would display ASS subtitles incorrectly.
|
||||
* These may be useful for applications, which use libass as renderer for
|
||||
* subtitles converted from another format, or which use libass for other
|
||||
* purposes that do not involve actual ASS subtitles authored for
|
||||
* distribution.
|
||||
*/
|
||||
ASS_FEATURE_INCOMPATIBLE_EXTENSIONS,
|
||||
|
||||
/**
|
||||
* Match bracket pairs in bidirectional text according to the revised
|
||||
* Unicode Bidirectional Algorithm introduced in Unicode 6.3.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* (Directional isolates, also introduced in Unicode 6.3,
|
||||
* are unconditionally processed when FriBidi is new enough.)
|
||||
*
|
||||
* This feature may be unavailable at runtime (ass_track_set_feature
|
||||
* may return -1) if libass was compiled against old FriBidi.
|
||||
*/
|
||||
ASS_FEATURE_BIDI_BRACKETS,
|
||||
|
||||
/**
|
||||
* When this feature is disabled, text is split into VSFilter-compatible
|
||||
* segments and text in each segment is processed in isolation.
|
||||
* Notably, this includes running the Unicode Bidirectional
|
||||
* Algorithm and shaping the text within each run separately.
|
||||
* The individual runs are then laid out left-to-right,
|
||||
* even if they contain right-to-left text.
|
||||
*
|
||||
* When this feature is enabled, each event's text is processed as a whole
|
||||
* (as far as possible). In particular, the Unicode Bidirectional
|
||||
* Algorithm is run on the whole text, and text is shaped across
|
||||
* override tags.
|
||||
*
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* libass extensions to ASS such as Encoding -1 can cause individual
|
||||
* events to be always processed as if this feature is enabled.
|
||||
*/
|
||||
ASS_FEATURE_WHOLE_TEXT_LAYOUT,
|
||||
|
||||
/**
|
||||
* Break lines according to the Unicode Line Breaking Algorithm.
|
||||
* If the track language is set, some additional language-specific tweaks
|
||||
* may be applied. Setting this enables more breaking opportunities
|
||||
* compared to classic ASS. However, it is still possible for long words
|
||||
* without breaking opportunities to cause overfull lines.
|
||||
* This is incompatible with VSFilter and disabled by default.
|
||||
*
|
||||
* This feature may be unavailable at runtime if
|
||||
* libass was compiled without libunibreak support.
|
||||
*/
|
||||
ASS_FEATURE_WRAP_UNICODE,
|
||||
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_Feature;
|
||||
|
||||
/**
|
||||
* \brief Initialize the library.
|
||||
* \return library handle or NULL if failed
|
||||
*/
|
||||
ASS_Library *ass_library_init(void);
|
||||
|
||||
/**
|
||||
* \brief Finalize the library
|
||||
* \param priv library handle
|
||||
*/
|
||||
void ass_library_done(ASS_Library *priv);
|
||||
|
||||
/**
|
||||
* \brief Set additional fonts directory.
|
||||
* Optional directory that will be scanned for fonts. The fonts
|
||||
* found are used for font lookup.
|
||||
* NOTE: A valid font directory is not needed to support embedded fonts.
|
||||
* On Microsoft Windows, when using WIN32-APIs, fonts_dir must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param fonts_dir directory with additional fonts
|
||||
*/
|
||||
void ass_set_fonts_dir(ASS_Library *priv, const char *fonts_dir);
|
||||
|
||||
/**
|
||||
* \brief Whether fonts should be extracted from track data.
|
||||
* \param priv library handle
|
||||
* \param extract whether to extract fonts
|
||||
*/
|
||||
void ass_set_extract_fonts(ASS_Library *priv, int extract);
|
||||
|
||||
/**
|
||||
* \brief Register style overrides with a library instance.
|
||||
* The overrides should have the form [Style.]Param=Value, e.g.
|
||||
* SomeStyle.Font=Arial
|
||||
* ScaledBorderAndShadow=yes
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param list NULL-terminated list of strings
|
||||
*/
|
||||
void ass_set_style_overrides(ASS_Library *priv, char **list);
|
||||
|
||||
/**
|
||||
* \brief Explicitly process style overrides for a track.
|
||||
* \param track track handle
|
||||
*/
|
||||
void ass_process_force_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Register a callback for debug/info messages.
|
||||
* If a callback is registered, it is called for every message emitted by
|
||||
* libass. The callback receives a format string and a list of arguments,
|
||||
* to be used for the printf family of functions. Additionally, a log level
|
||||
* from 0 (FATAL errors) to 7 (verbose DEBUG) is passed. Usually, level 5
|
||||
* should be used by applications.
|
||||
* If no callback is set, all messages level < 5 are printed to stderr,
|
||||
* prefixed with [ass].
|
||||
*
|
||||
* \param priv library handle
|
||||
* \param msg_cb pointer to callback function
|
||||
* \param data additional data, will be passed to callback
|
||||
*/
|
||||
void ass_set_message_cb(ASS_Library *priv, void (*msg_cb)
|
||||
(int level, const char *fmt, va_list args, void *data),
|
||||
void *data);
|
||||
|
||||
/**
|
||||
* \brief Initialize the renderer.
|
||||
* \param priv library handle
|
||||
* \return renderer handle or NULL if failed
|
||||
*
|
||||
* NOTE: before rendering starts the renderer should also be
|
||||
* configured with at least ass_set_storage_size(),
|
||||
* ass_set_frame_size() and ass_set_fonts();
|
||||
* see respective docs.
|
||||
*/
|
||||
ASS_Renderer *ass_renderer_init(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Finalize the renderer.
|
||||
* \param priv renderer handle
|
||||
*/
|
||||
void ass_renderer_done(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set the frame size in pixels, including margins.
|
||||
* The renderer will never return images that are outside of the frame area.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* If after compensating for configured margins the frame size
|
||||
* is not an isotropically scaled version of the video display size,
|
||||
* you may have to use ass_set_pixel_aspect().
|
||||
* @see ass_set_pixel_aspect()
|
||||
* @see ass_set_margins()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: frame size must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_frame_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set the source image size in pixels.
|
||||
* This affects some ASS tags like e.g. 3D transforms and
|
||||
* is used to calculate the source aspect ratio and blur scale.
|
||||
* If subtitles specify valid LayoutRes* headers, those will take precedence.
|
||||
* The source image size can be reset to default by setting w and h to 0.
|
||||
* The value set with this function can influence the pixel aspect ratio used
|
||||
* for rendering.
|
||||
* The values must be the actual storage size of the video stream,
|
||||
* without any anamorphic de-squeeze applied.
|
||||
* @see ass_set_pixel_aspect()
|
||||
* \param priv renderer handle
|
||||
* \param w width
|
||||
* \param h height
|
||||
*
|
||||
* NOTE: storage size must be configured to get correct results,
|
||||
* otherwise libass is forced to make a fallible guess.
|
||||
*/
|
||||
void ass_set_storage_size(ASS_Renderer *priv, int w, int h);
|
||||
|
||||
/**
|
||||
* \brief Set shaping level. This is merely a hint, the renderer will use
|
||||
* whatever is available if the request cannot be fulfilled.
|
||||
* \param level shaping level
|
||||
*/
|
||||
void ass_set_shaper(ASS_Renderer *priv, ASS_ShapingLevel level);
|
||||
|
||||
/**
|
||||
* \brief Set frame margins. These values may be negative if pan-and-scan
|
||||
* is used. The margins are in pixels. Each value specifies the distance from
|
||||
* the video rectangle to the renderer frame. If a given margin value is
|
||||
* positive, there will be free space between renderer frame and video area.
|
||||
* If a given margin value is negative, the frame is inside the video, i.e.
|
||||
* the video has been cropped.
|
||||
*
|
||||
* The renderer will try to keep subtitles inside the frame area. If possible,
|
||||
* text is layout so that it is inside the cropped area. Subtitle events
|
||||
* that can't be moved are cropped against the frame area.
|
||||
*
|
||||
* ass_set_use_margins() can be used to allow libass to render subtitles into
|
||||
* the empty areas if margins are positive, i.e. the video area is smaller than
|
||||
* the frame. (Traditionally, this has been used to show subtitles in
|
||||
* the bottom "black bar" between video bottom screen border when playing 16:9
|
||||
* video on a 4:3 screen.)
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param t top margin
|
||||
* \param b bottom margin
|
||||
* \param l left margin
|
||||
* \param r right margin
|
||||
*/
|
||||
void ass_set_margins(ASS_Renderer *priv, int t, int b, int l, int r);
|
||||
|
||||
/**
|
||||
* \brief Whether margins should be used for placing regular events.
|
||||
* \param priv renderer handle
|
||||
* \param use whether to use the margins
|
||||
*/
|
||||
void ass_set_use_margins(ASS_Renderer *priv, int use);
|
||||
|
||||
/**
|
||||
* \brief Set pixel aspect ratio correction.
|
||||
* This is the ratio of pixel width to pixel height.
|
||||
*
|
||||
* Generally, this is (d_w / d_h) / (s_w / s_h), where s_w and s_h is the
|
||||
* video storage size, and d_w and d_h is the video display size. (Display
|
||||
* and storage size can be different for anamorphic video, such as DVDs.)
|
||||
*
|
||||
* If the pixel aspect ratio is 0, or if the aspect ratio has never been set
|
||||
* by calling this function, libass will calculate a default pixel aspect ratio
|
||||
* out of values set with ass_set_frame_size() and ass_set_storage_size(). Note
|
||||
* that this default assumes the frame size after compensating for margins
|
||||
* corresponds to an isotropically scaled version of the video display size.
|
||||
* If the storage size has not been set, a pixel aspect ratio of 1 is assumed.
|
||||
*
|
||||
* If subtitles specify valid LayoutRes* headers, the API-configured
|
||||
* pixel aspect value is discarded in favour of one calculated out of the
|
||||
* headers and values set with ass_set_frame_size().
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param par pixel aspect ratio (1.0 means square pixels, 0 means default)
|
||||
*/
|
||||
void ass_set_pixel_aspect(ASS_Renderer *priv, double par);
|
||||
|
||||
/**
|
||||
* \brief Set aspect ratio parameters.
|
||||
* This calls ass_set_pixel_aspect(priv, dar / sar).
|
||||
* @deprecated New code should use ass_set_pixel_aspect().
|
||||
* \param priv renderer handle
|
||||
* \param dar display aspect ratio (DAR), prescaled for output PAR
|
||||
* \param sar storage aspect ratio (SAR)
|
||||
*/
|
||||
ASS_DEPRECATED("use 'ass_set_pixel_aspect' instead")
|
||||
void ass_set_aspect_ratio(ASS_Renderer *priv, double dar, double sar);
|
||||
|
||||
/**
|
||||
* \brief Set a fixed font scaling factor.
|
||||
* \param priv renderer handle
|
||||
* \param font_scale scaling factor, default is 1.0
|
||||
*/
|
||||
void ass_set_font_scale(ASS_Renderer *priv, double font_scale);
|
||||
|
||||
/**
|
||||
* \brief Set font hinting method.
|
||||
* \param priv renderer handle
|
||||
* \param ht hinting method
|
||||
*/
|
||||
void ass_set_hinting(ASS_Renderer *priv, ASS_Hinting ht);
|
||||
|
||||
/**
|
||||
* \brief Set line spacing. Will not be scaled with frame size.
|
||||
* \param priv renderer handle
|
||||
* \param line_spacing line spacing in pixels
|
||||
*/
|
||||
void ass_set_line_spacing(ASS_Renderer *priv, double line_spacing);
|
||||
|
||||
/**
|
||||
* \brief Set vertical line position.
|
||||
* \param priv renderer handle
|
||||
* \param line_position vertical line position of subtitles in percent
|
||||
* (0-100: 0 = on the bottom (default), 100 = on top)
|
||||
*/
|
||||
void ass_set_line_position(ASS_Renderer *priv, double line_position);
|
||||
|
||||
/**
|
||||
* \brief Get the list of available font providers. The output array
|
||||
* is allocated with malloc and can be released with free(). If an
|
||||
* allocation error occurs, size is set to (size_t)-1.
|
||||
* \param priv library handle
|
||||
* \param providers output, list of default providers (malloc'ed array)
|
||||
* \param size output, number of providers
|
||||
* \return list of available font providers (user owns the returned array)
|
||||
*/
|
||||
void ass_get_available_font_providers(ASS_Library *priv,
|
||||
ASS_DefaultFontProvider **providers,
|
||||
size_t *size);
|
||||
|
||||
/**
|
||||
* \brief Set font lookup defaults.
|
||||
* \param default_font path to default font to use. Must be supplied if
|
||||
* all system fontproviders are disabled or unavailable.
|
||||
* \param default_family fallback font family, or NULL
|
||||
* \param dfp which font provider to use (one of ASS_DefaultFontProvider). In
|
||||
* older libass version, this could be 0 or 1, where 1 enabled fontconfig.
|
||||
* Newer relases also accept 0 (ASS_FONTPROVIDER_NONE) and 1
|
||||
* (ASS_FONTPROVIDER_AUTODETECT), which is almost backward-compatible.
|
||||
* If the requested fontprovider does not exist or fails to initialize, the
|
||||
* behavior is the same as when ASS_FONTPROVIDER_NONE was passed.
|
||||
* \param config path to fontconfig configuration file, or NULL. Only relevant
|
||||
* if fontconfig is used. The encoding must match the one accepted by fontconfig.
|
||||
* \param update whether fontconfig cache should be built/updated now. Only
|
||||
* relevant if fontconfig is used.
|
||||
*
|
||||
* NOTE: font lookup must be configured before an ASS_Renderer can be used.
|
||||
*/
|
||||
void ass_set_fonts(ASS_Renderer *priv, const char *default_font,
|
||||
const char *default_family, int dfp,
|
||||
const char *config, int update);
|
||||
|
||||
/**
|
||||
* \brief Set selective style override mode.
|
||||
* If enabled, the renderer attempts to override the ASS script's styling of
|
||||
* normal subtitles, without affecting explicitly positioned text. If an event
|
||||
* looks like a normal subtitle, parts of the font style are copied from the
|
||||
* user style set with ass_set_selective_style_override().
|
||||
* Warning: the heuristic used for deciding when to override the style is rather
|
||||
* rough, and enabling this option can lead to incorrectly rendered
|
||||
* subtitles. Since the ASS format doesn't have any support for
|
||||
* allowing end-users to customize subtitle styling, this feature can
|
||||
* only be implemented on "best effort" basis, and has to rely on
|
||||
* heuristics that can easily break.
|
||||
* \param priv renderer handle
|
||||
* \param bits bit mask comprised of ASS_OverrideBits values.
|
||||
*/
|
||||
void ass_set_selective_style_override_enabled(ASS_Renderer *priv, int bits);
|
||||
|
||||
/**
|
||||
* \brief Set style for selective style override.
|
||||
* See ass_set_selective_style_override_enabled().
|
||||
* \param style style settings to use if override is enabled. Applications
|
||||
* should initialize it with {0} before setting fields. Strings will be copied
|
||||
* by the function.
|
||||
*/
|
||||
void ass_set_selective_style_override(ASS_Renderer *priv, ASS_Style *style);
|
||||
|
||||
/**
|
||||
* \brief This is a stub and does nothing. Old documentation: Update/build font
|
||||
* cache. This needs to be called if it was disabled when ass_set_fonts was set.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \return success
|
||||
*/
|
||||
ASS_DEPRECATED("it does nothing")
|
||||
int ass_fonts_update(ASS_Renderer *priv);
|
||||
|
||||
/**
|
||||
* \brief Set hard cache limits. Do not set, or set to zero, for reasonable
|
||||
* defaults.
|
||||
*
|
||||
* \param priv renderer handle
|
||||
* \param glyph_max maximum number of cached glyphs
|
||||
* \param bitmap_max_size maximum bitmap cache size (in MB)
|
||||
*/
|
||||
void ass_set_cache_limits(ASS_Renderer *priv, int glyph_max,
|
||||
int bitmap_max_size);
|
||||
|
||||
/**
|
||||
* \brief Render a frame, producing a list of ASS_Image.
|
||||
* \param priv renderer handle
|
||||
* \param track subtitle track
|
||||
* \param now video timestamp in milliseconds
|
||||
* \param detect_change compare to the previous call and set to 1
|
||||
* if positions may have changed, or set to 2 if content may have changed.
|
||||
*/
|
||||
ASS_Image *ass_render_frame(ASS_Renderer *priv, ASS_Track *track,
|
||||
long long now, int *detect_change);
|
||||
|
||||
|
||||
/*
|
||||
* The following functions operate on track objects and do not need
|
||||
* an ass_renderer
|
||||
*/
|
||||
|
||||
/**
|
||||
* \brief Allocate a new empty track object.
|
||||
* \param library handle
|
||||
* \return pointer to empty track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_new_track(ASS_Library *);
|
||||
|
||||
/**
|
||||
* \brief Enable or disable certain features
|
||||
* This manages flags that control the behavior of the renderer and how certain
|
||||
* tags etc. within the track are interpreted. The defaults on a newly created
|
||||
* ASS_Track are such that rendering is compatible with traditional renderers
|
||||
* like VSFilter, and/or old versions of libass. Calling ass_process_data() or
|
||||
* ass_process_codec_private() may change some of these flags according to file
|
||||
* headers. (ass_process_chunk() will not change any of the flags.)
|
||||
* Additions to ASS_Feature are backward compatible to old libass releases (ABI
|
||||
* compatibility).
|
||||
* After calling ass_render_frame, changing features is no longer allowed.
|
||||
* \param track track
|
||||
* \param feature the specific feature to enable or disable
|
||||
* \param enable 0 for disable, any non-0 value for enable
|
||||
* \return 0 if feature set, -1 if feature is unknown
|
||||
*/
|
||||
int ass_track_set_feature(ASS_Track *track, ASS_Feature feature, int enable);
|
||||
|
||||
/**
|
||||
* \brief Deallocate track and all its child objects (styles and events).
|
||||
* \param track track to deallocate or NULL
|
||||
*/
|
||||
void ass_free_track(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new style.
|
||||
* \param track track
|
||||
* \return newly allocated style id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_style(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Allocate new event.
|
||||
* \param track track
|
||||
* \return newly allocated event id >= 0, or a value < 0 on failure
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
int ass_alloc_event(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Delete a style.
|
||||
* \param track track
|
||||
* \param sid style id
|
||||
* Deallocates style data. Does not modify track->n_styles.
|
||||
* Freeing a style without subsequently setting track->n_styles
|
||||
* to a value less than or equal to the freed style id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* Additionally a freed style style still being referenced by an event
|
||||
* in track->events will also result in undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h.
|
||||
*/
|
||||
void ass_free_style(ASS_Track *track, int sid);
|
||||
|
||||
/**
|
||||
* \brief Delete an event.
|
||||
* \param track track
|
||||
* \param eid event id
|
||||
* Deallocates event data. Does not modify track->n_events.
|
||||
* Freeing an event without subsequently setting track->n_events
|
||||
* to a value less than or equal to the freed event id before calling
|
||||
* any other libass API function on the track is undefined behaviour.
|
||||
* See GENERAL NOTE in ass_types.h
|
||||
*/
|
||||
void ass_free_event(ASS_Track *track, int eid);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_data(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse Codec Private section of the subtitle stream, in Matroska
|
||||
* format. See the Matroska specification for details.
|
||||
* \param track target track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
*/
|
||||
void ass_process_codec_private(ASS_Track *track, char *data, int size);
|
||||
|
||||
/**
|
||||
* \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
|
||||
* event in Matroska format. See the Matroska specification for details.
|
||||
* In later libass versions (since LIBASS_VERSION==0x01300001), using this
|
||||
* function means you agree not to modify events manually, or using other
|
||||
* functions manipulating the event list like ass_process_data(). If you do
|
||||
* anyway, the internal duplicate checking might break. Calling
|
||||
* ass_flush_events() is still allowed.
|
||||
* \param track track
|
||||
* \param data string to parse
|
||||
* \param size length of data
|
||||
* \param timecode starting time of the event (milliseconds)
|
||||
* \param duration duration of the event (milliseconds)
|
||||
*/
|
||||
void ass_process_chunk(ASS_Track *track, char *data, int size,
|
||||
long long timecode, long long duration);
|
||||
|
||||
/**
|
||||
* \brief Set whether the ReadOrder field when processing a packet with
|
||||
* ass_process_chunk() should be used for eliminating duplicates.
|
||||
* \param check_readorder 0 means do not try to eliminate duplicates; 1 means
|
||||
* use the ReadOrder field embedded in the packet as unique identifier, and
|
||||
* discard the packet if there was already a packet with the same ReadOrder.
|
||||
* Other values are undefined.
|
||||
* If this function is not called, the default value is 1.
|
||||
*/
|
||||
void ass_set_check_readorder(ASS_Track *track, int check_readorder);
|
||||
|
||||
/**
|
||||
* \brief Flush buffered events.
|
||||
* \param track track
|
||||
*/
|
||||
void ass_flush_events(ASS_Track *track);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from file.
|
||||
* \param library library handle
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
ASS_Track *ass_read_file(ASS_Library *library, char *fname,
|
||||
char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Read subtitles from memory.
|
||||
* \param library library handle
|
||||
* \param buf pointer to subtitles text
|
||||
* \param bufsize size of buffer
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return newly allocated track or NULL on failure
|
||||
*/
|
||||
ASS_Track *ass_read_memory(ASS_Library *library, char *buf,
|
||||
size_t bufsize, char *codepage);
|
||||
/**
|
||||
* \brief Read styles from file into already initialized track.
|
||||
* \param fname file name
|
||||
* \param codepage encoding (iconv format)
|
||||
* \return 0 on success
|
||||
* NOTE: On Microsoft Windows, when using WIN32-APIs, fname must be in either
|
||||
* UTF-8 mixed with lone or paired UTF-16 surrogates encoded like in CESU-8
|
||||
* or the encoding accepted by fopen with the former taking precedence
|
||||
* if both versions are valid and exist.
|
||||
* On all other systems there is no need for special considerations like that.
|
||||
*/
|
||||
int ass_read_styles(ASS_Track *track, char *fname, char *codepage);
|
||||
|
||||
/**
|
||||
* \brief Add a memory font.
|
||||
* \param library library handle
|
||||
* \param name attachment name
|
||||
* \param data binary font data
|
||||
* \param data_size data size
|
||||
*/
|
||||
void ass_add_font(ASS_Library *library, const char *name, const char *data,
|
||||
int data_size);
|
||||
|
||||
/**
|
||||
* \brief Remove all fonts stored in an ass_library object.
|
||||
* This can only be called safely if all ASS_Track and ASS_Renderer instances
|
||||
* associated with the library handle have been released first.
|
||||
* \param library library handle
|
||||
*/
|
||||
void ass_clear_fonts(ASS_Library *library);
|
||||
|
||||
/**
|
||||
* \brief Calculates timeshift from now to the start of some other subtitle
|
||||
* event, depending on movement parameter.
|
||||
* \param track subtitle track
|
||||
* \param now current time in milliseconds
|
||||
* \param movement how many events to skip from the one currently displayed
|
||||
* +2 means "the one after the next", -1 means "previous"
|
||||
* \return timeshift in milliseconds
|
||||
*/
|
||||
long long ass_step_sub(ASS_Track *track, long long now, int movement);
|
||||
|
||||
#undef ASS_DEPRECATED
|
||||
#undef ASS_DEPRECATED_ENUM
|
||||
|
||||
#ifdef __cplusplus
|
||||
}
|
||||
#endif
|
||||
|
||||
#endif /* LIBASS_ASS_H */
|
||||
@ -0,0 +1,292 @@
|
||||
/*
|
||||
* Copyright (C) 2006 Evgeniy Stepanov <eugeni.stepanov@gmail.com>
|
||||
* Copyright (C) 2011 Grigori Goronzy <greg@chown.ath.cx>
|
||||
*
|
||||
* This file is part of libass.
|
||||
*
|
||||
* Permission to use, copy, modify, and distribute this software for any
|
||||
* purpose with or without fee is hereby granted, provided that the above
|
||||
* copyright notice and this permission notice appear in all copies.
|
||||
*
|
||||
* THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
|
||||
* WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
|
||||
* MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
|
||||
* ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
|
||||
* WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
|
||||
* ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
|
||||
* OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
||||
*/
|
||||
|
||||
#ifndef LIBASS_TYPES_H
|
||||
#define LIBASS_TYPES_H
|
||||
|
||||
#include <stdint.h>
|
||||
|
||||
/**
|
||||
* GENERAL NOTE regarding the definitions exposed by this header
|
||||
*
|
||||
* The main use case for this is _reading_ the track fields, especially
|
||||
* track->YCbCrMatrix, to correctly display the rendering results.
|
||||
*
|
||||
* Furthermore, the exposed definitions also open up the possibility to _modify_
|
||||
* the exposed structs, working closer to library internals and bypassing
|
||||
* e.g. creation of intermediate ASS-text buffers when creating dynamic events.
|
||||
* This is an advanced use case and should only be done when well-versed in ASS
|
||||
* and aware of the effects and legal values of _all_ fields of the structs.
|
||||
* The burden of sanitising and correctly initialising fields is then also
|
||||
* placed on the API user.
|
||||
* By nature of direct struct modifications working closer to library internals,
|
||||
* workflows that make use of this possibility are also more likely to be
|
||||
* affected by future API breaks than those which do not.
|
||||
*
|
||||
* To avoid desynchronisation with internal states, there are some restrictions
|
||||
* on when and how direct struct modification can be performed.
|
||||
* Ignoring them may lead to undefined behaviour. See the following listing:
|
||||
*
|
||||
* - Manual struct edits and track-modifying (including modification to the
|
||||
* event and style elements of the track) API calls cannot be freely mixed:
|
||||
* - Before manual changes are performed, it is allowed to call any such API,
|
||||
* unless the documentation of the funtion says otherwise.
|
||||
* - After manual changes have been performed, no track-modifying API may be
|
||||
* invoked, except for ass_track_set_feature and ass_flush_events.
|
||||
* - After the first call to ass_render_frame, existing array members
|
||||
* (e.g. members of events) and non-array track fields (e.g. PlayResX
|
||||
* or event_format) must not be modified. Adding new members to arrays
|
||||
* and updating the corresponding counter remains allowed.
|
||||
* - Adding and removing members to array fields, like events or styles,
|
||||
* must be done through the corresponding API function, e.g. ass_alloc_event.
|
||||
* See the documentation of these functions.
|
||||
* - The memory pointed to by string fields (char *) must be
|
||||
* free'able by the implementation of free used by libass.
|
||||
*
|
||||
* A non-exhaustive list of examples of track-modifying API functions:
|
||||
* ass_process_data, ass_process_codec_private,
|
||||
* ass_process_chunk, ass_read_styles, ...
|
||||
*
|
||||
* Direct struct modification can be done safely, but it is also easy to
|
||||
* miss an initialisation or violate these restrictions, thus introducing bugs
|
||||
* that may not manifest immediately. It should be carefully considered
|
||||
* whether this is worthwhile for the desired use-case.
|
||||
*/
|
||||
|
||||
#define VALIGN_SUB 0
|
||||
#define VALIGN_CENTER 8
|
||||
#define VALIGN_TOP 4
|
||||
#define HALIGN_LEFT 1
|
||||
#define HALIGN_CENTER 2
|
||||
#define HALIGN_RIGHT 3
|
||||
#define ASS_JUSTIFY_AUTO 0
|
||||
#define ASS_JUSTIFY_LEFT 1
|
||||
#define ASS_JUSTIFY_CENTER 2
|
||||
#define ASS_JUSTIFY_RIGHT 3
|
||||
|
||||
#define FONT_WEIGHT_LIGHT 300
|
||||
#define FONT_WEIGHT_MEDIUM 400
|
||||
#define FONT_WEIGHT_BOLD 700
|
||||
#define FONT_SLANT_NONE 0
|
||||
#define FONT_SLANT_ITALIC 100
|
||||
#define FONT_SLANT_OBLIQUE 110
|
||||
#define FONT_WIDTH_CONDENSED 75
|
||||
#define FONT_WIDTH_NORMAL 100
|
||||
#define FONT_WIDTH_EXPANDED 125
|
||||
|
||||
|
||||
/* Opaque objects internally used by libass. Contents are private. */
|
||||
typedef struct ass_renderer ASS_Renderer;
|
||||
typedef struct render_priv ASS_RenderPriv;
|
||||
typedef struct parser_priv ASS_ParserPriv;
|
||||
typedef struct ass_library ASS_Library;
|
||||
|
||||
/* ASS Style: line */
|
||||
typedef struct ass_style {
|
||||
char *Name; //must be a valid non-NULL string pointer; may be an empty string
|
||||
char *FontName; //must be a valid non-NULL string pointer; may be an empty string
|
||||
double FontSize;
|
||||
uint32_t PrimaryColour;
|
||||
uint32_t SecondaryColour;
|
||||
uint32_t OutlineColour;
|
||||
uint32_t BackColour;
|
||||
int Bold; // 0 or 1 (boolean)
|
||||
int Italic; // 0 or 1 (boolean)
|
||||
int Underline; // 0 or 1 (boolean)
|
||||
int StrikeOut; // 0 or 1 (boolean)
|
||||
double ScaleX; // positive with 1.0 representing 100%
|
||||
double ScaleY; // positive with 1.0 representing 100%
|
||||
double Spacing;
|
||||
double Angle;
|
||||
int BorderStyle;
|
||||
double Outline;
|
||||
double Shadow;
|
||||
int Alignment; // use `VALIGN_* | HALIGN_*` as value
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
int Encoding;
|
||||
int treat_fontname_as_pattern; // does nothing (left in place for ABI-compatibility)
|
||||
double Blur; // sets a default \blur for the event; same values as \blur
|
||||
int Justify; // sets text justification independent of event alignment; use ASS_JUSTIFY_*
|
||||
} ASS_Style;
|
||||
|
||||
|
||||
/*
|
||||
* ASS_Event corresponds to a single Dialogue line;
|
||||
* text is stored as-is, style overrides will be parsed later.
|
||||
*/
|
||||
typedef struct ass_event {
|
||||
long long Start; // ms
|
||||
long long Duration; // ms
|
||||
|
||||
int ReadOrder;
|
||||
int Layer;
|
||||
int Style;
|
||||
char *Name;
|
||||
int MarginL;
|
||||
int MarginR;
|
||||
int MarginV;
|
||||
char *Effect;
|
||||
char *Text;
|
||||
|
||||
ASS_RenderPriv *render_priv;
|
||||
} ASS_Event;
|
||||
|
||||
/**
|
||||
* Support for (xy-)VSFilter mangled colors
|
||||
*
|
||||
* Generally, xy-VSFilter emulates the classic VSFilter behavior of
|
||||
* rendering directly into the (usually YCbCr) video. Classic
|
||||
* guliverkli(2)-VSFilter is hardcoded to use BT.601(TV) as target colorspace
|
||||
* when converting the subtitle RGB color to the video colorspace.
|
||||
* This led to odd results when other colorspaces were used, particular
|
||||
* once those became more common with the rise of HDTV video:
|
||||
* HDTV typically uses BT.709(TV), but VSFilter continued assuming
|
||||
* BT.601(TV) for conversion.
|
||||
*
|
||||
* This means classic vsfilter will mangle colors as follows:
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_bt601tv(ass_rgb))
|
||||
*
|
||||
* where video_csp is the colorspace of the video with which the
|
||||
* subtitle was muxed.
|
||||
*
|
||||
* Subtitle authors worked around this issue by adjusting the color
|
||||
* to look as intended *after* going through the mangling process. Still,
|
||||
* this behaviour isn't great and also limits the color range. Yet,
|
||||
* for backwards compatibility with existing files, the classic mangling
|
||||
* must be preserved for existing files to not break the display of
|
||||
* color-matched typesets created with older VSFilter versions. Thus,
|
||||
* on iniative of xy-VSFilter/XYSubFilter a new explicit "YCbCr Matrix"
|
||||
* header was introduced to allow new files to avoid this color mangling.
|
||||
* However due to a limitation of VSFilter API, VSFilters don't actually
|
||||
* know the real colorspace of the video they're rendering to, so the
|
||||
* header wasn't created as a simple "Use ColourMangling: yes/no", but instead
|
||||
* specifies exactly which colorspace to use for the initial conversion
|
||||
* from the subtitle's RGB values to the video's YCbCr. So we now got
|
||||
*
|
||||
* screen_rgb = video_csp_to_rgb(rgb_to_ycbcr_header_csp(ass_rgb))
|
||||
*
|
||||
* with rgb_to_ycbcr_header_csp defaulting to TV-range BT.601.
|
||||
*
|
||||
* XySubFilter, whose API was planned during introduction of this header,
|
||||
* is not affected by this VSFilter-API limitation, so for it and other
|
||||
* renderers like libass an additional special value "None" was also added.
|
||||
* "None" tells the renderer to directly use untouched RGB values without
|
||||
* any conversion.
|
||||
*
|
||||
* If the video itself is already in RGB natively, then no color mangling
|
||||
* happens regardless of the presence or value of a "YCbCr Matrix" header.
|
||||
*
|
||||
* The above mangling process with special value "None" to opt out
|
||||
* of any color mangling is the recommended default behaviour.
|
||||
*
|
||||
* Keep in mind though, that xy-VSFilter cannot accurately implement this and
|
||||
* will instead resort to a guessing the video colorspace based on resolution
|
||||
* and then convert RGB to the guessed space.
|
||||
* Also some versions of MPC-HC's Internal Subtitle Renderer don't implement
|
||||
* "None" and use TV.601 for unknown, but the video colorspace for no or an
|
||||
* empty header (which can break old subtitles).
|
||||
*
|
||||
* Aegisub's (the main application to produce ASS subtitle scripts) behaviour
|
||||
* regarding colorspaces is unfortunately a bit confusing.
|
||||
* As of time of writing there still is a config option to force BT.601(TV)
|
||||
* in some active forks (which should not be used to author subs and serves
|
||||
* at most as a tool to check how now ancient VSFilters would have rendered the
|
||||
* subs), the automatically chosen colorspace may depend on the fork and the
|
||||
* videoprovider used and furthermore Aegisub likes to override
|
||||
* "YCbCr Matrix: None" with the autodetected space of a loaded video.
|
||||
* Supposedly some Aegisub versions had an option that "tries not to mangle the
|
||||
* colors". It was said that if the header is not set to BT.601(TV), the colors
|
||||
* were supposed not to be mangled, even if the header was not set to "None".
|
||||
*
|
||||
* In general, misinterpreting this header or not using it will lead to
|
||||
* slightly different subtitle colors, which can matter if the subtitle
|
||||
* attempts to match solid colored areas in the video.
|
||||
* It is recommended to stick to XySubFilter-like behaviour described above.
|
||||
* A highly motivated application may also expose options to users to emulate
|
||||
* xy-VSFilter's resolution-depended guess or other (historic) mangling modes.
|
||||
* Completly ignoring the color mangling is likely to give bad results.
|
||||
*
|
||||
* Note that libass doesn't change colors based on this header. It
|
||||
* absolutely can't do that, because the video colorspace is required
|
||||
* in order to handle this as intended. API users must use the exposed
|
||||
* information to perform color mangling as described above.
|
||||
*/
|
||||
typedef enum ASS_YCbCrMatrix {
|
||||
YCBCR_DEFAULT = 0, // Header missing
|
||||
YCBCR_UNKNOWN, // Header could not be parsed correctly
|
||||
YCBCR_NONE, // "None" special value
|
||||
YCBCR_BT601_TV,
|
||||
YCBCR_BT601_PC,
|
||||
YCBCR_BT709_TV,
|
||||
YCBCR_BT709_PC,
|
||||
YCBCR_SMPTE240M_TV,
|
||||
YCBCR_SMPTE240M_PC,
|
||||
YCBCR_FCC_TV,
|
||||
YCBCR_FCC_PC
|
||||
// New enum values can be added here in new ABI-compatible library releases.
|
||||
} ASS_YCbCrMatrix;
|
||||
|
||||
/*
|
||||
* ass track represent either an external script or a matroska subtitle stream
|
||||
* (no real difference between them); it can be used in rendering after the
|
||||
* headers are parsed (i.e. events format line read).
|
||||
*/
|
||||
typedef struct ass_track {
|
||||
int n_styles; // amount used
|
||||
int max_styles; // amount allocated
|
||||
int n_events;
|
||||
int max_events;
|
||||
ASS_Style *styles; // array of styles, max_styles length, n_styles used
|
||||
ASS_Event *events; // the same as styles
|
||||
|
||||
char *style_format; // style format line (everything after "Format: ")
|
||||
char *event_format; // event format line
|
||||
|
||||
enum {
|
||||
TRACK_TYPE_UNKNOWN = 0,
|
||||
TRACK_TYPE_ASS,
|
||||
TRACK_TYPE_SSA
|
||||
} track_type;
|
||||
|
||||
// Script header fields
|
||||
int PlayResX;
|
||||
int PlayResY;
|
||||
double Timer;
|
||||
int WrapStyle;
|
||||
int ScaledBorderAndShadow; // 0 or 1 (boolean)
|
||||
int Kerning; // 0 or 1 (boolean)
|
||||
char *Language; // zero-terminated ISO-639-1 code
|
||||
ASS_YCbCrMatrix YCbCrMatrix;
|
||||
|
||||
int default_style; // index of default style
|
||||
char *name; // file name in case of external subs, 0 for streams
|
||||
|
||||
ASS_Library *library;
|
||||
ASS_ParserPriv *parser_priv;
|
||||
|
||||
int LayoutResX; // overrides values from ass_set_storage_size and
|
||||
int LayoutResY; // also takes precendence over ass_set_pixel_aspect
|
||||
|
||||
// New fields can be added here in new ABI-compatible library releases.
|
||||
} ASS_Track;
|
||||
|
||||
#endif /* LIBASS_TYPES_H */
|
||||
@ -0,0 +1,32 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
|
||||
<plist version="1.0">
|
||||
<dict>
|
||||
<key>CFBundleDevelopmentRegion</key>
|
||||
<string>en</string>
|
||||
<key>CFBundleExecutable</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundleIdentifier</key>
|
||||
<string>com.kintan.ksplayer.libass</string>
|
||||
<key>CFBundleInfoDictionaryVersion</key>
|
||||
<string>6.0</string>
|
||||
<key>CFBundleName</key>
|
||||
<string>libass</string>
|
||||
<key>CFBundlePackageType</key>
|
||||
<string>FMWK</string>
|
||||
<key>CFBundleShortVersionString</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleVersion</key>
|
||||
<string>87.88.520</string>
|
||||
<key>CFBundleSignature</key>
|
||||
<string>????</string>
|
||||
<key>MinimumOSVersion</key>
|
||||
<string>1.0</string>
|
||||
<key>CFBundleSupportedPlatforms</key>
|
||||
<array>
|
||||
<string>XROS</string>
|
||||
</array>
|
||||
<key>NSPrincipalClass</key>
|
||||
<string></string>
|
||||
</dict>
|
||||
</plist>
|
||||
@ -0,0 +1,4 @@
|
||||
framework module libass [system] {
|
||||
umbrella "."
|
||||
export *
|
||||
}
|
||||
BIN
Sources/libass.xcframework/xros-arm64/libass.framework/libass
Normal file
BIN
Sources/libass.xcframework/xros-arm64/libass.framework/libass
Normal file
Binary file not shown.
Reference in New Issue
Block a user