aboutsummaryrefslogtreecommitdiffstats
path: root/src/jogl/classes/com/jogamp/opengl/util/av/SubTextEvent.java
blob: be8219634d92c030e82ce9a68ea1029293e27477 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
/**
 * Copyright 2024 JogAmp Community. All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without modification, are
 * permitted provided that the following conditions are met:
 *
 *    1. Redistributions of source code must retain the above copyright notice, this list of
 *       conditions and the following disclaimer.
 *
 *    2. Redistributions in binary form must reproduce the above copyright notice, this list
 *       of conditions and the following disclaimer in the documentation and/or other materials
 *       provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY JogAmp Community ``AS IS'' AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL JogAmp Community OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * The views and conclusions contained in the software and documentation are those of the
 * authors and should not be interpreted as representing official policies, either expressed
 * or implied, of JogAmp Community.
 */
package com.jogamp.opengl.util.av;

import java.time.format.DateTimeParseException;

import com.jogamp.common.av.PTS;
import com.jogamp.common.util.StringUtil;

/**
 * Text Event Line including ASS/SAA of {@link SubtitleEvent}
 * <p>
 * See http://www.tcax.org/docs/ass-specs.htm
 * </p>
 */
public class SubTextEvent extends SubtitleEvent {
    /** Text formatting */
    public enum TextFormat {
        /** Multiple ASS formats may be passed, see {@link ASSType}. */
        ASS,
        /** Just plain text */
        TEXT,
    };
    /** ASS Formatting Type */
    public enum ASSType {
        /**
         * ASS dialogue-line output w/ start and end (Given by FFmpeg 4.*)
         * <pre>
           0       1      2    3      4     5        6        7        8       9
           Marked, Start, End, Style, Name, MarginL, MarginR, MarginV, Effect, Text

           'Dialogue: 0,0:02:02.15,0:02:02.16,Default,,0,0,0,,trying to force him to travel to that'
         * </pre>
         */
        DIALOGUE,
        /**
         * FFMpeg ASS event-line output w/o start, end (Given by FFmpeg 5.*, 6.*, ..)
         * <pre>
           0    1      2      3     4        5        6        7       8
           Seq, Layer, Style, Name, MarginL, MarginR, MarginV, Effect, TEXT
         * </pre>
         */
        EVENT,
        /** Just plain text */
        TEXT
    }
    /** {@link TextFormat} of this text subtitle event. */
    public final TextFormat textFormat;
    /** {@link ASSType} sub-type */
    public final ASSType assType;
    /** Start time in milliseconds, or -1. */
    public final int start;
    /** End time in milliseconds, or -1. */
    public final int end;
    public final String style;

    public final int seqnr;
    public final int layer;

    public final String name;
    public final String effect;
    /** Actual subtitle text */
    public final String text;
    /** Number of lines of {@link #text}, i.e. occurrence of {@code \n} + 1. */
    public final int lines;

    private static boolean DEBUG = false;

    /**
     * ASS/SAA Event Line ctor
     * @param codec the {@link CodecID}
     * @param lang language code, supposed to be 3-letters of `ISO 639-2 language codes`
     * @param fmt input format of {@code ass}
     * @param ass ASS/SAA compatible event line according to {@link ASSType}
     * @param pts_start pts start in ms
     * @param pts_end pts end in ms
     */
    public SubTextEvent(final CodecID codec, final String lang, final TextFormat fmt, final String ass, final int pts_start, final int pts_end) {
        super(SubtitleEvent.Type.Text, codec, lang, pts_start, pts_end);
        this.textFormat = fmt;
        ASSType assType = ASSType.TEXT;
        int start = -1;
        int end = -1;
        int seqnr = 0;
        int layer = 0;
        String style = "Default";
        String name = "";
        String effect = "";
        String text = "";
        boolean done = false;
        if( TextFormat.ASS == fmt ) {
            final int len = null != ass ? ass.length() : 0;
            {
                // ASSType.DIALOGUE
                int part = 0;
                for(int i=0; 10 > part && len > i; ) {
                    if( 9 == part ) {
                        text = ass.substring(i);
                        done = true;
                        assType = ASSType.DIALOGUE;
                    } else {
                        final int j = ass.indexOf(',', i);
                        if( 0 > j ) {
                            break;
                        }
                        final String v = ass.substring(i, j);
                        try {
                            switch(part) {
                                case 1:
                                    start = PTS.toMillis(v, true);
                                    break;
                                case 2:
                                    end = PTS.toMillis(v, true);
                                    break;
                                case 3:
                                    style = v;
                                    break;
                                case 4:
                                    name = v;
                                    break;
                                case 8:
                                    effect = v;
                                    break;
                            }
                        } catch(final DateTimeParseException pe) {
                            if( DEBUG ) {
                                System.err.println("ASS.DIALG parsing error of part "+part+" '"+v+"' of '"+ass+"'");
                            }
                            break;
                        }
                        i = j + 1;
                    }
                    ++part;
                }
            }
            if( !done ) {
                // ASSType.EVENT
                int part = 0;
                for(int i=0; 9 > part && len > i; ) {
                    if( 8 == part ) {
                        text = ass.substring(i);
                        done = true;
                        assType = ASSType.EVENT;
                    } else {
                        final int j = ass.indexOf(',', i);
                        if( 0 > j ) {
                            break;
                        }
                        final String v = ass.substring(i, j);
                        try {
                            switch(part) {
                                case 0:
                                    seqnr = Integer.valueOf(v);
                                    break;
                                case 1:
                                    layer = Integer.valueOf(v);
                                    break;
                                case 2:
                                    style = v;
                                    break;
                                case 3:
                                    name = v;
                                    break;
                                case 7:
                                    effect = v;
                                    break;
                            }
                        } catch(final NumberFormatException nfe) {
                            if( DEBUG ) {
                                System.err.println("ASS.EVENT parsing error of part "+part+" '"+v+"' of '"+ass+"'");
                            }
                            break;
                        }
                        i = j + 1;
                    }
                    ++part;
                }
            }
        }
        if( !done && TextFormat.TEXT == fmt ) {
            text = ass;
            done = true;
            assType = ASSType.TEXT;
        }
        this.assType = assType;
        this.start = start;
        this.end = end;
        this.seqnr = seqnr;
        this.layer = layer;
        this.style = style;
        this.name = name;
        this.effect = effect;
        this.text = text.replace("\\N", "\n");
        this.lines = StringUtil.getLineCount(this.text);
    }

    @Override
    public void release() {} // nothing to be released back to the owner

    @Override
    public String toString() {
        final String start_s = 0 <= start ? PTS.toTimeStr(start, true) : "undef";
        final String end_s = 0 <= end ? PTS.toTimeStr(end, true) : "undef";
        final String fms_s = TextFormat.ASS == textFormat ? "ASS("+assType+")" : textFormat.toString();
        return getStartString()+", "+fms_s+", #"+seqnr+", l_"+layer+
               ", ["+start_s+".."+end_s+"], style "+style+", name '"+name+"', effect '"+effect+"': '"+text+"' ("+lines+")]";
    }
}