[video_player_avplay] Add subtitle attributes which include type,startTime, stopTime and value to subtitle callback (#848)

Author: gin7773

packages/video_player_avplay/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 0.5.21
+
+* Upgrade native player.
+  1.[PLAYER]Add definitions of the subtitle attributes.
+  2.[PLAYER]Receive and pass subtitle attributes of streaming to video player in subtitle callback.
+* Handle the subtitle attributes which include type, startTime, stopTime and value.
+* Pass subtitle attributes to VideoPlayerController.
+
 ## 0.5.20
 
 * Add suspend and restore interface.

packages/video_player_avplay/README.md

@@ -12,7 +12,7 @@ To use this package, add `video_player_avplay` as a dependency in your `pubspec.
 
 ```yaml
 dependencies:
-  video_player_avplay: ^0.5.20
+  video_player_avplay: ^0.5.21
 ```
 
 Then you can import `video_player_avplay` in your Dart code:

packages/video_player_avplay/lib/src/closed_caption_file.dart

@@ -43,6 +43,7 @@ class Caption {
     required this.start,
     required this.end,
     required this.text,
+    this.subtitleAttributes,
   });
 
   /// The number that this caption was assigned.
@@ -58,13 +59,17 @@ class Caption {
   /// and [end].
   final String text;
 
+  /// The subtitile attributes associated with this caption.
+  final List<SubtitleAttribute?>? subtitleAttributes;
+
   /// A no caption object. This is a caption with [start] and [end] durations of zero,
   /// and an empty [text] string.
   static const Caption none = Caption(
     number: 0,
     start: Duration.zero,
     end: Duration.zero,
     text: '',
+    subtitleAttributes: <SubtitleAttribute?>[],
   );
 
   @override
@@ -73,7 +78,8 @@ class Caption {
         'number: $number, '
         'start: $start, '
         'end: $end, '
-        'text: $text)';
+        'text: $text, '
+        'subtitleAttributes: $subtitleAttributes)';
   }
 
   @override
@@ -84,8 +90,246 @@ class Caption {
           number == other.number &&
           start == other.start &&
           end == other.end &&
-          text == other.text;
+          text == other.text &&
+          subtitleAttributes == other.subtitleAttributes;
+
+  @override
+  int get hashCode => Object.hash(number, start, end, text, subtitleAttributes);
+}
+
+/// The different types of subtitle attributes that can be set on the player.
+enum SubtitleAttrType {
+  /// Subtitle attribute type region x position
+  subAttrRegionXPos(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type region y position
+  subAttrRegionYPos(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type region width
+  subAttrRegionWidth(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type region height
+  subAttrRegionHeight(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type window x padding
+  subAttrWindowXPadding(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type window y padding
+  subAttrWindowYPadding(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type window left margin
+  subAttrWindowLeftMargin(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type window right margin
+  subAttrWindowRightMargin(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type window top margin
+  subAttrWindowTopMargin(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type window bottom margin
+  subAttrWindowBottomMargin(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type window opacity
+  subAttrWindowBgColor(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type window opacity
+  subAttrWindowOpacity(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type window show background
+  subAttrWindowShowBg(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font family
+  subAttrFontFamily(SubtitleAttrValueType.string),
+
+  /// Subtitle attribute type font size
+  subAttrFontSize(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type font color
+  subAttrFontWeight(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font style
+  subAttrFontStyle(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font color
+  subAttrFontColor(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font bg color
+  subAttrFontBgColor(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font opacity
+  subAttrFontOpacity(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type font bg opacity
+  subAttrFontBgOpacity(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type font text outline color
+  subAttrFontTextOutlineColor(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font text outline thickness
+  subAttrFontTextOutlineThickness(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font text outline blur radius
+  subAttrFontTextOutlineBlurRadius(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font vertical align
+  subAttrFontVerticalAlign(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type font horizontal align
+  subAttrFontHorizontalAlign(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type raw subtitle
+  subAttrRawSubtitle(SubtitleAttrValueType.string),
+
+  /// Subtitle attribute type webvtt cue line num type
+  subAttrWebvttCueLine(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type webvtt cue line align
+  subAttrWebvttCueLineNum(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type webvtt cue line align
+  subAttrWebvttCueLineAlign(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type webvtt cue line align
+  subAttrWebvttCueAlign(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type webvtt cue size
+  subAttrWebvttCueSize(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type webvtt cue position
+  subAttrWebvttCuePosition(SubtitleAttrValueType.double),
+
+  /// Subtitle attribute type webvtt cue position align
+  subAttrWebvttCuePositionAlign(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type webvtt cue vertical
+  subAttrWebvttCueVertical(SubtitleAttrValueType.int),
+
+  /// Subtitle attribute type timestamp
+  subAttrTimestamp(SubtitleAttrValueType.int),
+
+  /// File index of external subtitle
+  subAttrExtsubInde(SubtitleAttrValueType.none),
+
+  /// Default type
+  subAttrTypeNone(SubtitleAttrValueType.none);
+
+  const SubtitleAttrType(this.valueType);
+
+  /// The type of the subtitle attribute value. Do not modify.
+  final SubtitleAttrValueType valueType;
+
+  /// Returns the subtitle attribute value type based on the index.
+  static SubtitleAttrValueType getValueType(int idx) {
+    return SubtitleAttrType.values[idx].valueType;
+  }
+}
+
+/// The different types of subtitle attribute values that can be set on the player.
+enum SubtitleAttrValueType {
+  /// Subtitle attribute value type integer or uint32_t
+  int,
+
+  /// Subtitle attribute value type float or double
+  double,
+
+  /// Subtitle attribute value type string or char*
+  string,
+
+  /// Subtitle attribute value type none
+  none,
+}
+
+/// A representation of a single attribute.
+///
+/// The subtitle attributes of the video.
+@immutable
+class SubtitleAttribute {
+  /// Creates a new instance of [SubtitleAttribute].
+  const SubtitleAttribute({
+    required this.attrType,
+    required this.startTime,
+    required this.stopTime,
+    required this.attrValue,
+  });
+
+  /// Subtitle attribute type of the video.
+  ///
+  /// Only used if [eventType] is [VideoEventType.subtitleAttrUpdate].
+  final SubtitleAttrType attrType;
+
+  /// Subtitle start time of the video.
+  ///
+  /// Only used if [eventType] is [VideoEventType.subtitleAttrUpdate].
+  final int startTime;
+
+  /// Subtitle stop time of the video.
+  ///
+  /// Only used if [eventType] is [VideoEventType.subtitleAttrUpdate].
+  final int stopTime;
+
+  /// Subtitle attribute value of the video.
+  ///
+  /// Only used if [eventType] is [VideoEventType.subtitleAttrUpdate].
+  final Object attrValue;
+
+  /// Parse a subtitle attribute list from the subtitle attribute list which given by eventListener.
+  static List<SubtitleAttribute> fromEventSubtitleAttrList(
+    List<dynamic>? eventSubtitleAttrList,
+  ) {
+    final List<SubtitleAttribute> subtitleAttributes = <SubtitleAttribute>[];
+    final List<Map<Object?, Object?>?> subtitleAttrList =
+        eventSubtitleAttrList!.cast<Map<Object?, Object?>?>();
+
+    for (final Map<Object?, Object?>? attr in subtitleAttrList) {
+      final int attrTypeNum = attr!['attrType']! as int;
+      final int startTime = attr['startTime']! as int;
+      final int stopTime = attr['stopTime']! as int;
+
+      Object attrValue;
+      if (SubtitleAttrType.getValueType(attrTypeNum) ==
+          SubtitleAttrValueType.double) {
+        attrValue = attr['attrValue']! as double;
+      } else if (SubtitleAttrType.getValueType(attrTypeNum) ==
+          SubtitleAttrValueType.int) {
+        attrValue = attr['attrValue']! as int;
+      } else if (SubtitleAttrType.getValueType(attrTypeNum) ==
+          SubtitleAttrValueType.string) {
+        attrValue = attr['attrValue']! as String;
+      } else {
+        attrValue = 'failed';
+      }
+
+      subtitleAttributes.add(
+        SubtitleAttribute(
+          attrType: SubtitleAttrType.values[attrTypeNum],
+          startTime: startTime,
+          stopTime: stopTime,
+          attrValue: attrValue,
+        ),
+      );
+    }
+    return subtitleAttributes;
+  }
+
+  @override
+  String toString() {
+    return '${objectRuntimeType(this, 'SubtitleAttribute')}('
+        'attrType: $attrType, '
+        'startTime: $startTime, '
+        'stopTime: $stopTime, '
+        'attrValue: $attrValue)';
+  }
+
+  @override
+  bool operator ==(Object other) =>
+      identical(this, other) ||
+      other is SubtitleAttribute &&
+          runtimeType == other.runtimeType &&
+          attrType == other.attrType &&
+          startTime == other.startTime &&
+          stopTime == other.stopTime &&
+          attrValue == other.attrValue;
 
   @override
-  int get hashCode => Object.hash(number, start, end, text);
+  int get hashCode => Object.hash(attrType, startTime, stopTime, attrValue);
 }

packages/video_player_avplay/lib/src/video_player_tizen.dart

@@ -436,6 +436,7 @@ class VideoPlayerTizen extends VideoPlayerPlatform {
           return VideoEvent(
             eventType: VideoEventType.subtitleUpdate,
             text: map['text']! as String,
+            subtitleAttributes: map['attributes']! as List<dynamic>,
           );
         case 'isPlayingStateUpdate':
           return VideoEvent(

packages/video_player_avplay/lib/video_player.dart

@@ -566,14 +566,18 @@ class VideoPlayerController extends ValueNotifier<VideoPlayerValue> {
         case VideoEventType.bufferingEnd:
           value = value.copyWith(isBuffering: false);
         case VideoEventType.subtitleUpdate:
+          final List<SubtitleAttribute> subtitleAttributes =
+              SubtitleAttribute.fromEventSubtitleAttrList(
+                event.subtitleAttributes,
+              );
           final Caption caption = Caption(
             number: 0,
             start: value.position,
             end: value.position + (event.duration?.end ?? Duration.zero),
             text: event.text ?? '',
+            subtitleAttributes: subtitleAttributes,
           );
           value = value.copyWith(caption: caption);
-
         case VideoEventType.isPlayingStateUpdate:
           if (event.isPlaying ?? false) {
             value = value.copyWith(

packages/video_player_avplay/lib/video_player_platform_interface.dart

@@ -473,6 +473,7 @@ class VideoEvent {
     this.buffered,
     this.text,
     this.isPlaying,
+    this.subtitleAttributes,
   });
 
   /// The type of the event.
@@ -503,6 +504,9 @@ class VideoEvent {
   /// Only used if [eventType] is [VideoEventType.isPlayingStateUpdate].
   final bool? isPlaying;
 
+  /// Attributes of the video subtitle.
+  final List<dynamic>? subtitleAttributes;
+
   @override
   bool operator ==(Object other) {
     return identical(this, other) ||

packages/video_player_avplay/pubspec.yaml

@@ -2,7 +2,7 @@ name: video_player_avplay
 description: Flutter plugin for displaying inline video on Tizen TV devices.
 homepage: https://github.com/flutter-tizen/plugins
 repository: https://github.com/flutter-tizen/plugins/tree/master/packages/video_player_avplay
-version: 0.5.20
+version: 0.5.21
 
 environment:
   sdk: ">=3.1.0 <4.0.0"