Skip to content

SDK / exoplayer

Go to a project
Commit 15413548 by hoangtc Committed by Andrew Lewis
Options

Support TTML font size using % correctly. 

For TTML, if the font size is expressed in %, the font size should be relative
to the cellResolution of the document which we did not support before. This CL
adds support for handling this correctly.
Note that this still does not support font size using c unit.

-------------
Created by MOE: https://github.com/google/moe
MOE_MIGRATED_REVID=196985694
parent 5e1b4308
Inline Side-by-side
Showing with 372 additions and 90 deletions
RELEASENOTES.md
...@@ -25,6 +25,8 @@ ...@@ -25,6 +25,8 @@
time that can make text size of each region much smaller than defined. time that can make text size of each region much smaller than defined.
* Fix an issue when the caption line has no text (empty line or only line * Fix an issue when the caption line has no text (empty line or only line
break), and the line's background is still displayed. break), and the line's background is still displayed.
* Support TTML font size using % correctly (as percentage of document cell
resolution).
### 2.8.0 ### ### 2.8.0 ###
...@@ -101,7 +103,7 @@ ...@@ -101,7 +103,7 @@
* Allow multiple listeners for `DefaultDrmSessionManager`. * Allow multiple listeners for `DefaultDrmSessionManager`.
* Pass `DrmSessionManager` to `ExoPlayerFactory` instead of `RendererFactory`. * Pass `DrmSessionManager` to `ExoPlayerFactory` instead of `RendererFactory`.
* Change minimum API requirement for CBC and pattern encryption from 24 to 25 * Change minimum API requirement for CBC and pattern encryption from 24 to 25
([#4022][https://github.com/google/ExoPlayer/issues/4022]). ([#4022](https://github.com/google/ExoPlayer/issues/4022)).
* Fix handling of 307/308 redirects when making license requests * Fix handling of 307/308 redirects when making license requests
([#4108](https://github.com/google/ExoPlayer/issues/4108)). ([#4108](https://github.com/google/ExoPlayer/issues/4108)).
* HLS: * HLS:
......
library/core/src/main/java/com/google/android/exoplayer2/text/Cue.java
...@@ -78,6 +78,25 @@ public class Cue { ...@@ -78,6 +78,25 @@ public class Cue {
*/ */
public static final int LINE_TYPE_NUMBER = 1; public static final int LINE_TYPE_NUMBER = 1;
/** The type of default text size for this cue, which may be unset. */
@Retention(RetentionPolicy.SOURCE)
@IntDef({
TYPE_UNSET,
TEXT_SIZE_TYPE_FRACTIONAL,
TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING,
TEXT_SIZE_TYPE_ABSOLUTE
})
public @interface TextSizeType {}
/** Text size is measured as a fraction of the viewport size minus the view padding. */
public static final int TEXT_SIZE_TYPE_FRACTIONAL = 0;
/** Text size is measured as a fraction of the viewport size, ignoring the view padding */
public static final int TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING = 1;
/** Text size is measured in number of pixels. */
public static final int TEXT_SIZE_TYPE_ABSOLUTE = 2;
/** /**
* The cue text, or null if this is an image cue. Note the {@link CharSequence} may be decorated * The cue text, or null if this is an image cue. Note the {@link CharSequence} may be decorated
* with styling spans. * with styling spans.
...@@ -106,40 +125,39 @@ public class Cue { ...@@ -106,40 +125,39 @@ public class Cue {
/** /**
* The type of the {@link #line} value. * The type of the {@link #line} value.
* <p> *
* {@link #LINE_TYPE_FRACTION} indicates that {@link #line} is a fractional position within the * <p>{@link #LINE_TYPE_FRACTION} indicates that {@link #line} is a fractional position within the
* viewport. * viewport.
* <p> *
* {@link #LINE_TYPE_NUMBER} indicates that {@link #line} is a line number, where the size of each * <p>{@link #LINE_TYPE_NUMBER} indicates that {@link #line} is a line number, where the size of
* line is taken to be the size of the first line of the cue. When {@link #line} is greater than * each line is taken to be the size of the first line of the cue. When {@link #line} is greater
* or equal to 0 lines count from the start of the viewport, with 0 indicating zero offset from * than or equal to 0 lines count from the start of the viewport, with 0 indicating zero offset
* the start edge. When {@link #line} is negative lines count from the end of the viewport, with * from the start edge. When {@link #line} is negative lines count from the end of the viewport,
* -1 indicating zero offset from the end edge. For horizontal text the line spacing is the height * with -1 indicating zero offset from the end edge. For horizontal text the line spacing is the
* of the first line of the cue, and the start and end of the viewport are the top and bottom * height of the first line of the cue, and the start and end of the viewport are the top and
* respectively. * bottom respectively.
* <p> *
* Note that it's particularly important to consider the effect of {@link #lineAnchor} when using * <p>Note that it's particularly important to consider the effect of {@link #lineAnchor} when
* {@link #LINE_TYPE_NUMBER}. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_START)} positions a * using {@link #LINE_TYPE_NUMBER}. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_START)}
* (potentially multi-line) cue at the very top of the viewport. * positions a (potentially multi-line) cue at the very top of the viewport. {@code (line == -1 &&
* {@code (line == -1 && lineAnchor == ANCHOR_TYPE_END)} positions a (potentially multi-line) cue * lineAnchor == ANCHOR_TYPE_END)} positions a (potentially multi-line) cue at the very bottom of
* at the very bottom of the viewport. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_END)} * the viewport. {@code (line == 0 && lineAnchor == ANCHOR_TYPE_END)} and {@code (line == -1 &&
* and {@code (line == -1 && lineAnchor == ANCHOR_TYPE_START)} position cues entirely outside of * lineAnchor == ANCHOR_TYPE_START)} position cues entirely outside of the viewport. {@code (line
* the viewport. {@code (line == 1 && lineAnchor == ANCHOR_TYPE_END)} positions a cue so that only * == 1 && lineAnchor == ANCHOR_TYPE_END)} positions a cue so that only the last line is visible
* the last line is visible at the top of the viewport. * at the top of the viewport. {@code (line == -2 && lineAnchor == ANCHOR_TYPE_START)} position a
* {@code (line == -2 && lineAnchor == ANCHOR_TYPE_START)} position a cue so that only its first * cue so that only its first line is visible at the bottom of the viewport.
* line is visible at the bottom of the viewport.
*/ */
@LineType public final int lineType; public final @LineType int lineType;
/** /**
* The cue box anchor positioned by {@link #line}. One of {@link #ANCHOR_TYPE_START}, * The cue box anchor positioned by {@link #line}. One of {@link #ANCHOR_TYPE_START}, {@link
* {@link #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}. * #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}.
* <p> *
* For the normal case of horizontal text, {@link #ANCHOR_TYPE_START}, {@link #ANCHOR_TYPE_MIDDLE} * <p>For the normal case of horizontal text, {@link #ANCHOR_TYPE_START}, {@link
* and {@link #ANCHOR_TYPE_END} correspond to the top, middle and bottom of the cue box * #ANCHOR_TYPE_MIDDLE} and {@link #ANCHOR_TYPE_END} correspond to the top, middle and bottom of
* respectively. * the cue box respectively.
*/ */
@AnchorType public final int lineAnchor; public final @AnchorType int lineAnchor;
/** /**
* The fractional position of the {@link #positionAnchor} of the cue box within the viewport in * The fractional position of the {@link #positionAnchor} of the cue box within the viewport in
...@@ -152,14 +170,14 @@ public class Cue { ...@@ -152,14 +170,14 @@ public class Cue {
public final float position; public final float position;
/** /**
* The cue box anchor positioned by {@link #position}. One of {@link #ANCHOR_TYPE_START}, * The cue box anchor positioned by {@link #position}. One of {@link #ANCHOR_TYPE_START}, {@link
* {@link #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}. * #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}.
* <p> *
* For the normal case of horizontal text, {@link #ANCHOR_TYPE_START}, {@link #ANCHOR_TYPE_MIDDLE} * <p>For the normal case of horizontal text, {@link #ANCHOR_TYPE_START}, {@link
* and {@link #ANCHOR_TYPE_END} correspond to the left, middle and right of the cue box * #ANCHOR_TYPE_MIDDLE} and {@link #ANCHOR_TYPE_END} correspond to the left, middle and right of
* respectively. * the cue box respectively.
*/ */
@AnchorType public final int positionAnchor; public final @AnchorType int positionAnchor;
/** /**
* The size of the cue box in the writing direction specified as a fraction of the viewport size * The size of the cue box in the writing direction specified as a fraction of the viewport size
...@@ -185,6 +203,18 @@ public class Cue { ...@@ -185,6 +203,18 @@ public class Cue {
public final int windowColor; public final int windowColor;
/** /**
* The default text size type for this cue's text, or {@link #TYPE_UNSET} if this cue has no
* default text size.
*/
public final @TextSizeType int textSizeType;
/**
* The default text size for this cue's text, or {@link #DIMEN_UNSET} if this cue has no default
* text size.
*/
public final float textSize;
/**
* Creates an image cue. * Creates an image cue.
* *
* @param bitmap See {@link #bitmap}. * @param bitmap See {@link #bitmap}.
...@@ -194,17 +224,36 @@ public class Cue { ...@@ -194,17 +224,36 @@ public class Cue {
* {@link #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}. * {@link #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}.
* @param verticalPosition The position of the vertical anchor within the viewport, expressed as a * @param verticalPosition The position of the vertical anchor within the viewport, expressed as a
* fraction of the viewport height. * fraction of the viewport height.
* @param verticalPositionAnchor The vertical anchor. One of {@link #ANCHOR_TYPE_START}, * @param verticalPositionAnchor The vertical anchor. One of {@link #ANCHOR_TYPE_START}, {@link
* {@link #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}. * #ANCHOR_TYPE_MIDDLE}, {@link #ANCHOR_TYPE_END} and {@link #TYPE_UNSET}.
* @param width The width of the cue as a fraction of the viewport width. * @param width The width of the cue as a fraction of the viewport width.
* @param height The height of the cue as a fraction of the viewport height, or * @param height The height of the cue as a fraction of the viewport height, or {@link
* {@link #DIMEN_UNSET} if the bitmap should be displayed at its natural height for the * #DIMEN_UNSET} if the bitmap should be displayed at its natural height for the specified
* specified {@code width}. * {@code width}.
*/ */
public Cue(Bitmap bitmap, float horizontalPosition, @AnchorType int horizontalPositionAnchor, public Cue(
float verticalPosition, @AnchorType int verticalPositionAnchor, float width, float height) { Bitmap bitmap,
this(null, null, bitmap, verticalPosition, LINE_TYPE_FRACTION, verticalPositionAnchor, float horizontalPosition,
horizontalPosition, horizontalPositionAnchor, width, height, false, Color.BLACK); @AnchorType int horizontalPositionAnchor,
float verticalPosition,
@AnchorType int verticalPositionAnchor,
float width,
float height) {
this(
/* text= */ null,
/* textAlignment= */ null,
bitmap,
verticalPosition,
/* lineType= */ LINE_TYPE_FRACTION,
verticalPositionAnchor,
horizontalPosition,
horizontalPositionAnchor,
/* textSizeType= */ TYPE_UNSET,
/* textSize= */ DIMEN_UNSET,
width,
height,
/* windowColorSet= */ false,
/* windowColor= */ Color.BLACK);
} }
/** /**
...@@ -214,7 +263,49 @@ public class Cue { ...@@ -214,7 +263,49 @@ public class Cue {
* @param text See {@link #text}. * @param text See {@link #text}.
*/ */
public Cue(CharSequence text) { public Cue(CharSequence text) {
this(text, null, DIMEN_UNSET, TYPE_UNSET, TYPE_UNSET, DIMEN_UNSET, TYPE_UNSET, DIMEN_UNSET); this(
text,
/* textAlignment= */ null,
/* line= */ DIMEN_UNSET,
/* lineType= */ TYPE_UNSET,
/* lineAnchor= */ TYPE_UNSET,
/* position= */ DIMEN_UNSET,
/* positionAnchor= */ TYPE_UNSET,
/* size= */ DIMEN_UNSET);
}
/**
* Creates a text cue.
*
* @param text See {@link #text}.
* @param textAlignment See {@link #textAlignment}.
* @param line See {@link #line}.
* @param lineType See {@link #lineType}.
* @param lineAnchor See {@link #lineAnchor}.
* @param position See {@link #position}.
* @param positionAnchor See {@link #positionAnchor}.
* @param size See {@link #size}.
*/
public Cue(
CharSequence text,
Alignment textAlignment,
float line,
@LineType int lineType,
@AnchorType int lineAnchor,
float position,
@AnchorType int positionAnchor,
float size) {
this(
text,
textAlignment,
line,
lineType,
lineAnchor,
position,
positionAnchor,
size,
/* windowColorSet= */ false,
/* windowColor= */ Color.BLACK);
} }
/** /**
...@@ -228,11 +319,35 @@ public class Cue { ...@@ -228,11 +319,35 @@ public class Cue {
* @param position See {@link #position}. * @param position See {@link #position}.
* @param positionAnchor See {@link #positionAnchor}. * @param positionAnchor See {@link #positionAnchor}.
* @param size See {@link #size}. * @param size See {@link #size}.
* @param textSizeType See {@link #textSizeType}.
* @param textSize See {@link #textSize}.
*/ */
public Cue(CharSequence text, Alignment textAlignment, float line, @LineType int lineType, public Cue(
@AnchorType int lineAnchor, float position, @AnchorType int positionAnchor, float size) { CharSequence text,
this(text, textAlignment, line, lineType, lineAnchor, position, positionAnchor, size, false, Alignment textAlignment,
Color.BLACK); float line,
@LineType int lineType,
@AnchorType int lineAnchor,
float position,
@AnchorType int positionAnchor,
float size,
@TextSizeType int textSizeType,
float textSize) {
this(
text,
textAlignment,
/* bitmap= */ null,
line,
lineType,
lineAnchor,
position,
positionAnchor,
textSizeType,
textSize,
size,
/* bitmapHeight= */ DIMEN_UNSET,
/* windowColorSet= */ false,
/* windowColor= */ Color.BLACK);
} }
/** /**
...@@ -249,16 +364,48 @@ public class Cue { ...@@ -249,16 +364,48 @@ public class Cue {
* @param windowColorSet See {@link #windowColorSet}. * @param windowColorSet See {@link #windowColorSet}.
* @param windowColor See {@link #windowColor}. * @param windowColor See {@link #windowColor}.
*/ */
public Cue(CharSequence text, Alignment textAlignment, float line, @LineType int lineType, public Cue(
@AnchorType int lineAnchor, float position, @AnchorType int positionAnchor, float size, CharSequence text,
boolean windowColorSet, int windowColor) { Alignment textAlignment,
this(text, textAlignment, null, line, lineType, lineAnchor, position, positionAnchor, size, float line,
DIMEN_UNSET, windowColorSet, windowColor); @LineType int lineType,
@AnchorType int lineAnchor,
float position,
@AnchorType int positionAnchor,
float size,
boolean windowColorSet,
int windowColor) {
this(
text,
textAlignment,
/* bitmap= */ null,
line,
lineType,
lineAnchor,
position,
positionAnchor,
/* textSizeType= */ TYPE_UNSET,
/* textSize= */ DIMEN_UNSET,
size,
/* bitmapHeight= */ DIMEN_UNSET,
windowColorSet,
windowColor);
} }
private Cue(CharSequence text, Alignment textAlignment, Bitmap bitmap, float line, private Cue(
@LineType int lineType, @AnchorType int lineAnchor, float position, CharSequence text,
@AnchorType int positionAnchor, float size, float bitmapHeight, boolean windowColorSet, Alignment textAlignment,
Bitmap bitmap,
float line,
@LineType int lineType,
@AnchorType int lineAnchor,
float position,
@AnchorType int positionAnchor,
@TextSizeType int textSizeType,
float textSize,
float size,
float bitmapHeight,
boolean windowColorSet,
int windowColor) { int windowColor) {
this.text = text; this.text = text;
this.textAlignment = textAlignment; this.textAlignment = textAlignment;
...@@ -272,6 +419,8 @@ public class Cue { ...@@ -272,6 +419,8 @@ public class Cue {
this.bitmapHeight = bitmapHeight; this.bitmapHeight = bitmapHeight;
this.windowColorSet = windowColorSet; this.windowColorSet = windowColorSet;
this.windowColor = windowColor; this.windowColor = windowColor;
this.textSizeType = textSizeType;
this.textSize = textSize;
} }
} }
library/core/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlDecoder.java
...@@ -38,6 +38,7 @@ import org.xmlpull.v1.XmlPullParserFactory; ...@@ -38,6 +38,7 @@ import org.xmlpull.v1.XmlPullParserFactory;
/** /**
* A {@link SimpleSubtitleDecoder} for TTML supporting the DFXP presentation profile. Features * A {@link SimpleSubtitleDecoder} for TTML supporting the DFXP presentation profile. Features
* supported by this decoder are: * supported by this decoder are:
*
* <ul> * <ul>
* <li>content * <li>content
* <li>core * <li>core
...@@ -51,7 +52,9 @@ import org.xmlpull.v1.XmlPullParserFactory; ...@@ -51,7 +52,9 @@ import org.xmlpull.v1.XmlPullParserFactory;
* <li>time-clock * <li>time-clock
* <li>time-offset-with-frames * <li>time-offset-with-frames
* <li>time-offset-with-ticks * <li>time-offset-with-ticks
* <li>cell-resolution
* </ul> * </ul>
*
* @see <a href="http://www.w3.org/TR/ttaf1-dfxp/">TTML specification</a> * @see <a href="http://www.w3.org/TR/ttaf1-dfxp/">TTML specification</a>
*/ */
public final class TtmlDecoder extends SimpleSubtitleDecoder { public final class TtmlDecoder extends SimpleSubtitleDecoder {
...@@ -74,11 +77,14 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -74,11 +77,14 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
private static final Pattern FONT_SIZE = Pattern.compile("^(([0-9]*.)?[0-9]+)(px|em|%)$"); private static final Pattern FONT_SIZE = Pattern.compile("^(([0-9]*.)?[0-9]+)(px|em|%)$");
private static final Pattern PERCENTAGE_COORDINATES = private static final Pattern PERCENTAGE_COORDINATES =
Pattern.compile("^(\\d+\\.?\\d*?)% (\\d+\\.?\\d*?)%$"); Pattern.compile("^(\\d+\\.?\\d*?)% (\\d+\\.?\\d*?)%$");
private static final Pattern CELL_RESOLUTION = Pattern.compile("^(\\d+) (\\d+)$");
private static final int DEFAULT_FRAME_RATE = 30; private static final int DEFAULT_FRAME_RATE = 30;
private static final FrameAndTickRate DEFAULT_FRAME_AND_TICK_RATE = private static final FrameAndTickRate DEFAULT_FRAME_AND_TICK_RATE =
new FrameAndTickRate(DEFAULT_FRAME_RATE, 1, 1); new FrameAndTickRate(DEFAULT_FRAME_RATE, 1, 1);
private static final CellResolution DEFAULT_CELL_RESOLUTION =
new CellResolution(/* columns= */ 32, /* rows= */ 15);
private final XmlPullParserFactory xmlParserFactory; private final XmlPullParserFactory xmlParserFactory;
...@@ -107,6 +113,7 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -107,6 +113,7 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
int unsupportedNodeDepth = 0; int unsupportedNodeDepth = 0;
int eventType = xmlParser.getEventType(); int eventType = xmlParser.getEventType();
FrameAndTickRate frameAndTickRate = DEFAULT_FRAME_AND_TICK_RATE; FrameAndTickRate frameAndTickRate = DEFAULT_FRAME_AND_TICK_RATE;
CellResolution cellResolution = DEFAULT_CELL_RESOLUTION;
while (eventType != XmlPullParser.END_DOCUMENT) { while (eventType != XmlPullParser.END_DOCUMENT) {
TtmlNode parent = nodeStack.peekLast(); TtmlNode parent = nodeStack.peekLast();
if (unsupportedNodeDepth == 0) { if (unsupportedNodeDepth == 0) {
...@@ -114,12 +121,13 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -114,12 +121,13 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
if (eventType == XmlPullParser.START_TAG) { if (eventType == XmlPullParser.START_TAG) {
if (TtmlNode.TAG_TT.equals(name)) { if (TtmlNode.TAG_TT.equals(name)) {
frameAndTickRate = parseFrameAndTickRates(xmlParser); frameAndTickRate = parseFrameAndTickRates(xmlParser);
cellResolution = parseCellResolution(xmlParser, DEFAULT_CELL_RESOLUTION);
} }
if (!isSupportedTag(name)) { if (!isSupportedTag(name)) {
Log.i(TAG, "Ignoring unsupported tag: " + xmlParser.getName()); Log.i(TAG, "Ignoring unsupported tag: " + xmlParser.getName());
unsupportedNodeDepth++; unsupportedNodeDepth++;
} else if (TtmlNode.TAG_HEAD.equals(name)) { } else if (TtmlNode.TAG_HEAD.equals(name)) {
parseHeader(xmlParser, globalStyles, regionMap); parseHeader(xmlParser, globalStyles, regionMap, cellResolution);
} else { } else {
try { try {
TtmlNode node = parseNode(xmlParser, parent, regionMap, frameAndTickRate); TtmlNode node = parseNode(xmlParser, parent, regionMap, frameAndTickRate);
...@@ -193,8 +201,36 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -193,8 +201,36 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
return new FrameAndTickRate(frameRate * frameRateMultiplier, subFrameRate, tickRate); return new FrameAndTickRate(frameRate * frameRateMultiplier, subFrameRate, tickRate);
} }
private Map<String, TtmlStyle> parseHeader(XmlPullParser xmlParser, private CellResolution parseCellResolution(XmlPullParser xmlParser, CellResolution defaultValue)
Map<String, TtmlStyle> globalStyles, Map<String, TtmlRegion> globalRegions) throws SubtitleDecoderException {
String cellResolution = xmlParser.getAttributeValue(TTP, "cellResolution");
if (cellResolution == null) {
return defaultValue;
}
Matcher cellResolutionMatcher = CELL_RESOLUTION.matcher(cellResolution);
if (!cellResolutionMatcher.matches()) {
Log.w(TAG, "Ignoring malformed cell resolution: " + cellResolution);
return defaultValue;
}
try {
int columns = Integer.parseInt(cellResolutionMatcher.group(1));
int rows = Integer.parseInt(cellResolutionMatcher.group(2));
if (columns == 0 || rows == 0) {
throw new SubtitleDecoderException("Invalid cell resolution " + columns + " " + rows);
}
return new CellResolution(columns, rows);
} catch (NumberFormatException e) {
Log.w(TAG, "Ignoring malformed cell resolution: " + cellResolution);
return defaultValue;
}
}
private Map<String, TtmlStyle> parseHeader(
XmlPullParser xmlParser,
Map<String, TtmlStyle> globalStyles,
Map<String, TtmlRegion> globalRegions,
CellResolution cellResolution)
throws IOException, XmlPullParserException { throws IOException, XmlPullParserException {
do { do {
xmlParser.next(); xmlParser.next();
...@@ -210,7 +246,7 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -210,7 +246,7 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
globalStyles.put(style.getId(), style); globalStyles.put(style.getId(), style);
} }
} else if (XmlPullParserUtil.isStartTag(xmlParser, TtmlNode.TAG_REGION)) { } else if (XmlPullParserUtil.isStartTag(xmlParser, TtmlNode.TAG_REGION)) {
TtmlRegion ttmlRegion = parseRegionAttributes(xmlParser); TtmlRegion ttmlRegion = parseRegionAttributes(xmlParser, cellResolution);
if (ttmlRegion != null) { if (ttmlRegion != null) {
globalRegions.put(ttmlRegion.id, ttmlRegion); globalRegions.put(ttmlRegion.id, ttmlRegion);
} }
...@@ -221,12 +257,12 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -221,12 +257,12 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
/** /**
* Parses a region declaration. * Parses a region declaration.
* <p> *
* If the region defines an origin and extent, it is required that they're defined as percentages * <p>If the region defines an origin and extent, it is required that they're defined as
* of the viewport. Region declarations that define origin and extent in other formats are * percentages of the viewport. Region declarations that define origin and extent in other formats
* unsupported, and null is returned. * are unsupported, and null is returned.
*/ */
private TtmlRegion parseRegionAttributes(XmlPullParser xmlParser) { private TtmlRegion parseRegionAttributes(XmlPullParser xmlParser, CellResolution cellResolution) {
String regionId = XmlPullParserUtil.getAttributeValue(xmlParser, TtmlNode.ATTR_ID); String regionId = XmlPullParserUtil.getAttributeValue(xmlParser, TtmlNode.ATTR_ID);
if (regionId == null) { if (regionId == null) {
return null; return null;
...@@ -305,7 +341,16 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -305,7 +341,16 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
} }
} }
return new TtmlRegion(regionId, position, line, Cue.LINE_TYPE_FRACTION, lineAnchor, width); float regionTextHeight = 1.0f / cellResolution.rows;
return new TtmlRegion(
regionId,
position,
line,
/* lineType= */ Cue.LINE_TYPE_FRACTION,
lineAnchor,
width,
/* textSizeType= */ Cue.TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING,
/* textSize= */ regionTextHeight);
} }
private String[] parseStyleIds(String parentStyleIds) { private String[] parseStyleIds(String parentStyleIds) {
...@@ -594,4 +639,15 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder { ...@@ -594,4 +639,15 @@ public final class TtmlDecoder extends SimpleSubtitleDecoder {
this.tickRate = tickRate; this.tickRate = tickRate;
} }
} }
/** Represents the cell resolution for a TTML file. */
private static final class CellResolution {
final int columns;
final int rows;
CellResolution(int columns, int rows) {
this.columns = columns;
this.rows = rows;
}
}
} }
library/core/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlNode.java
...@@ -179,8 +179,18 @@ import java.util.TreeSet; ...@@ -179,8 +179,18 @@ import java.util.TreeSet;
List<Cue> cues = new ArrayList<>(); List<Cue> cues = new ArrayList<>();
for (Entry<String, SpannableStringBuilder> entry : regionOutputs.entrySet()) { for (Entry<String, SpannableStringBuilder> entry : regionOutputs.entrySet()) {
TtmlRegion region = regionMap.get(entry.getKey()); TtmlRegion region = regionMap.get(entry.getKey());
cues.add(new Cue(cleanUpText(entry.getValue()), null, region.line, region.lineType, cues.add(
region.lineAnchor, region.position, Cue.TYPE_UNSET, region.width)); new Cue(
cleanUpText(entry.getValue()),
/* textAlignment= */ null,
region.line,
region.lineType,
region.lineAnchor,
region.position,
/* positionAnchor= */ Cue.TYPE_UNSET,
region.width,
region.textSizeType,
region.textSize));
} }
return cues; return cues;
} }
......
library/core/src/main/java/com/google/android/exoplayer2/text/ttml/TtmlRegion.java
...@@ -25,22 +25,41 @@ import com.google.android.exoplayer2.text.Cue; ...@@ -25,22 +25,41 @@ import com.google.android.exoplayer2.text.Cue;
public final String id; public final String id;
public final float position; public final float position;
public final float line; public final float line;
@Cue.LineType public final int lineType; public final @Cue.LineType int lineType;
@Cue.AnchorType public final int lineAnchor; public final @Cue.AnchorType int lineAnchor;
public final float width; public final float width;
public final @Cue.TextSizeType int textSizeType;
public final float textSize;
public TtmlRegion(String id) { public TtmlRegion(String id) {
this(id, Cue.DIMEN_UNSET, Cue.DIMEN_UNSET, Cue.TYPE_UNSET, Cue.TYPE_UNSET, Cue.DIMEN_UNSET); this(
id,
/* position= */ Cue.DIMEN_UNSET,
/* line= */ Cue.DIMEN_UNSET,
/* lineType= */ Cue.TYPE_UNSET,
/* lineAnchor= */ Cue.TYPE_UNSET,
/* width= */ Cue.DIMEN_UNSET,
/* textSizeType= */ Cue.TYPE_UNSET,
/* textSize= */ Cue.DIMEN_UNSET);
} }
public TtmlRegion(String id, float position, float line, @Cue.LineType int lineType, public TtmlRegion(
@Cue.AnchorType int lineAnchor, float width) { String id,
float position,
float line,
@Cue.LineType int lineType,
@Cue.AnchorType int lineAnchor,
float width,
int textSizeType,
float textSize) {
this.id = id; this.id = id;
this.position = position; this.position = position;
this.line = line; this.line = line;
this.lineType = lineType; this.lineType = lineType;
this.lineAnchor = lineAnchor; this.lineAnchor = lineAnchor;
this.width = width; this.width = width;
this.textSizeType = textSizeType;
this.textSize = textSize;
} }
} }
library/ui/src/main/java/com/google/android/exoplayer2/ui/SubtitleView.java
...@@ -51,14 +51,10 @@ public final class SubtitleView extends View implements TextOutput { ...@@ -51,14 +51,10 @@ public final class SubtitleView extends View implements TextOutput {
*/ */
public static final float DEFAULT_BOTTOM_PADDING_FRACTION = 0.08f; public static final float DEFAULT_BOTTOM_PADDING_FRACTION = 0.08f;
private static final int FRACTIONAL = 0;
private static final int FRACTIONAL_IGNORE_PADDING = 1;
private static final int ABSOLUTE = 2;
private final List<SubtitlePainter> painters; private final List<SubtitlePainter> painters;
private List<Cue> cues; private List<Cue> cues;
private int textSizeType; private @Cue.TextSizeType int textSizeType;
private float textSize; private float textSize;
private boolean applyEmbeddedStyles; private boolean applyEmbeddedStyles;
private boolean applyEmbeddedFontSizes; private boolean applyEmbeddedFontSizes;
...@@ -72,7 +68,7 @@ public final class SubtitleView extends View implements TextOutput { ...@@ -72,7 +68,7 @@ public final class SubtitleView extends View implements TextOutput {
public SubtitleView(Context context, AttributeSet attrs) { public SubtitleView(Context context, AttributeSet attrs) {
super(context, attrs); super(context, attrs);
painters = new ArrayList<>(); painters = new ArrayList<>();
textSizeType = FRACTIONAL; textSizeType = Cue.TEXT_SIZE_TYPE_FRACTIONAL;
textSize = DEFAULT_TEXT_SIZE_FRACTION; textSize = DEFAULT_TEXT_SIZE_FRACTION;
applyEmbeddedStyles = true; applyEmbeddedStyles = true;
applyEmbeddedFontSizes = true; applyEmbeddedFontSizes = true;
...@@ -120,7 +116,9 @@ public final class SubtitleView extends View implements TextOutput { ...@@ -120,7 +116,9 @@ public final class SubtitleView extends View implements TextOutput {
} else { } else {
resources = context.getResources(); resources = context.getResources();
} }
setTextSize(ABSOLUTE, TypedValue.applyDimension(unit, size, resources.getDisplayMetrics())); setTextSize(
Cue.TEXT_SIZE_TYPE_ABSOLUTE,
TypedValue.applyDimension(unit, size, resources.getDisplayMetrics()));
} }
/** /**
...@@ -154,10 +152,14 @@ public final class SubtitleView extends View implements TextOutput { ...@@ -154,10 +152,14 @@ public final class SubtitleView extends View implements TextOutput {
* height after the top and bottom padding has been subtracted. * height after the top and bottom padding has been subtracted.
*/ */
public void setFractionalTextSize(float fractionOfHeight, boolean ignorePadding) { public void setFractionalTextSize(float fractionOfHeight, boolean ignorePadding) {
setTextSize(ignorePadding ? FRACTIONAL_IGNORE_PADDING : FRACTIONAL, fractionOfHeight); setTextSize(
ignorePadding
? Cue.TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING
: Cue.TEXT_SIZE_TYPE_FRACTIONAL,
fractionOfHeight);
} }
private void setTextSize(int textSizeType, float textSize) { private void setTextSize(@Cue.TextSizeType int textSizeType, float textSize) {
if (this.textSizeType == textSizeType && this.textSize == textSize) { if (this.textSizeType == textSizeType && this.textSize == textSize) {
return; return;
} }
...@@ -255,17 +257,61 @@ public final class SubtitleView extends View implements TextOutput { ...@@ -255,17 +257,61 @@ public final class SubtitleView extends View implements TextOutput {
// No space to draw subtitles. // No space to draw subtitles.
return; return;
} }
int rawViewHeight = rawBottom - rawTop;
int viewHeightMinusPadding = bottom - top;
float textSizePx = textSizeType == ABSOLUTE ? textSize float defaultViewTextSizePx =
: textSize * (textSizeType == FRACTIONAL ? (bottom - top) : (rawBottom - rawTop)); resolveTextSize(textSizeType, textSize, rawViewHeight, viewHeightMinusPadding);
if (textSizePx <= 0) { if (defaultViewTextSizePx <= 0) {
// Text has no height. // Text has no height.
return; return;
} }
for (int i = 0; i < cueCount; i++) { for (int i = 0; i < cueCount; i++) {
painters.get(i).draw(cues.get(i), applyEmbeddedStyles, applyEmbeddedFontSizes, style, Cue cue = cues.get(i);
textSizePx, bottomPaddingFraction, canvas, left, top, right, bottom); float textSizePx =
resolveTextSizeForCue(cue, rawViewHeight, viewHeightMinusPadding, defaultViewTextSizePx);
SubtitlePainter painter = painters.get(i);
painter.draw(
cue,
applyEmbeddedStyles,
applyEmbeddedFontSizes,
style,
textSizePx,
bottomPaddingFraction,
canvas,
left,
top,
right,
bottom);
}
}
private float resolveTextSizeForCue(
Cue cue, int rawViewHeight, int viewHeightMinusPadding, float defaultViewTextSizePx) {
if (cue.textSizeType == Cue.TYPE_UNSET || cue.textSize == Cue.DIMEN_UNSET) {
return defaultViewTextSizePx;
}
float defaultCueTextSizePx =
resolveTextSize(cue.textSizeType, cue.textSize, rawViewHeight, viewHeightMinusPadding);
return defaultCueTextSizePx > 0 ? defaultCueTextSizePx : defaultViewTextSizePx;
}
private float resolveTextSize(
@Cue.TextSizeType int textSizeType,
float textSize,
int rawViewHeight,
int viewHeightMinusPadding) {
switch (textSizeType) {
case Cue.TEXT_SIZE_TYPE_ABSOLUTE:
return textSize;
case Cue.TEXT_SIZE_TYPE_FRACTIONAL:
return textSize * viewHeightMinusPadding;
case Cue.TEXT_SIZE_TYPE_FRACTIONAL_IGNORE_PADDING:
return textSize * rawViewHeight;
case Cue.TYPE_UNSET:
default:
return Cue.DIMEN_UNSET;
} }
} }
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or sign in to comment