ttml_processor 0.4.0

A Rust library for parsing and generating TTML lyrics files, specifically designed for Apple Music and AMLL formats.
Documentation
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
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
use compact_str::CompactString;
use quick_xml::{
    Reader,
    events::{
        BytesStart,
        Event,
    },
};

use crate::{
    constants::{
        attrs,
        meta_keys,
        tags,
    },
    error::{
        Result,
        TTMLProcessorError,
    },
    model::{
        Agent,
        PlatformId,
    },
    parser::{
        ext::{
            BytesStartExt as _,
            QNameExt as _,
        },
        state::ParserContext,
        sub_lyric::{
            SubLyricType,
            parse_sub_lyrics,
        },
        timestamp::parse_decimal_seconds,
        utils::{
            Walk,
            read_text_content,
            walk_inner,
        },
    },
};

/// 解析 `<head>` 标签
///
/// ## 示例
/// ```xml
/// <head>
///     <metadata>
///         <ttm:agent type="person" xml:id="v1" />
///         <ttm:agent type="person" xml:id="v2" />
///         <ttm:agent type="person" xml:id="v3" />
///         <ttm:agent type="group" xml:id="v4" />
///         <amll:meta key="title" value="We Don't Talk About Bruno" />
///         <iTunesMetadata xmlns="http://music.apple.com/lyric-ttml-internal">
///             <translations>
///                 <translation type="subtitle" xml:lang="zh-Hans">
///                     翻译内容...
///                 </translation>
///             </translations>
///             <transliterations>
///                 <transliteration>
///                     音译内容...
///                 </transliterations>
///             </transliterations>
///             <songwriters>
///                 <songwriter>Lin-Manuel Miranda</songwriter>
///             </songwriters>
///         </iTunesMetadata>
///     </metadata>
/// </head>
/// ```
pub fn parse_head(reader: &mut Reader<&[u8]>, context: &mut ParserContext) -> Result<()> {
    walk_inner(reader, context, tags::HEAD, |reader, context, event| {
        let Event::Start(e) = event else {
            return Ok(Walk::Continue);
        };
        let qname = e.name();
        let tag_name =
            std::str::from_utf8(qname.as_ref()).map_err(TTMLProcessorError::Utf8Error)?;

        match tag_name {
            tags::TRANSLATIONS => {
                parse_sub_lyrics(
                    reader,
                    context,
                    tags::TRANSLATIONS,
                    tags::TRANSLATION,
                    SubLyricType::Translation,
                )?;
                Ok(Walk::Handled)
            }
            tags::TRANSLITERATIONS => {
                parse_sub_lyrics(
                    reader,
                    context,
                    tags::TRANSLITERATIONS,
                    tags::TRANSLITERATION,
                    SubLyricType::Transliteration,
                )?;
                Ok(Walk::Handled)
            }

            tags::TTM_AGENT => {
                parse_agent(reader, &e, context)?;
                Ok(Walk::Handled)
            }

            tags::SONGWRITERS => {
                parse_songwriters(reader, context)?;
                Ok(Walk::Handled)
            }

            tags::TTM_TITLE => {
                let title = read_text_content(reader, context, tags::TTM_TITLE)?;
                let trimmed = title.trim();
                if !trimmed.is_empty() {
                    context.metadata.push_title(trimmed.into());
                }
                Ok(Walk::Handled)
            }

            tags::AMLL_META => {
                if let (Ok(key), Ok(value)) = (
                    e.get_required_attr(attrs::KEY, reader, context),
                    e.get_required_attr(attrs::VALUE, reader, context),
                ) {
                    parse_amll_meta(context, &key, &value);
                }
                Ok(Walk::Continue)
            }

            tags::ITUNES_METADATA => {
                if let Some(value) = e.get_attr_value(attrs::LEADING_SILENCE, reader, context)?
                    && let Some(ms) = parse_decimal_seconds(value.trim().as_bytes())
                    && let Ok(ms) = u32::try_from(ms)
                {
                    context.metadata.audio_mut().leading_silence = Some(ms);
                }
                Ok(Walk::Continue)
            }

            tags::AUDIO => {
                parse_audio_element(reader, &e, context)?;
                Ok(Walk::Continue)
            }
            _ => Ok(Walk::Continue),
        }
    })
}

/// 解析 `<iTunesMetadata>` 下的 `<audio>` 标签
///
/// ## 示例
/// ```xml
/// <iTunesMetadata leadingSilence="0.040">
///     <audio lyricOffset="-0.271" role="spatial" />
/// </iTunesMetadata>
/// ```
///
/// 仅保留文档中第一个 `<audio>`,且只处理 `<iTunesMetadata>` 的直接子元素;
/// `role` 为空串时按缺失处理,其他无法识别的属性一律忽略。
fn parse_audio_element(
    reader: &Reader<&[u8]>,
    e: &BytesStart,
    context: &mut ParserContext,
) -> Result<()> {
    let is_direct_child = context
        .tag_stack
        .len()
        .checked_sub(2)
        .and_then(|idx| context.tag_stack.get(idx))
        .is_some_and(|parent| parent.as_str() == tags::ITUNES_METADATA);

    if !is_direct_child || context.seen_audio_element {
        return Ok(());
    }
    context.seen_audio_element = true;

    let role = e
        .get_attr_value(attrs::ROLE, reader, context)?
        .and_then(|value| {
            let value = value.trim();
            (!value.is_empty()).then(|| CompactString::from(value))
        });

    let lyric_offset = e
        .get_attr_value(attrs::LYRIC_OFFSET, reader, context)?
        .and_then(|value| parse_decimal_seconds(value.trim().as_bytes()))
        .and_then(|ms| i32::try_from(ms).ok());

    if role.is_some() || lyric_offset.is_some() {
        let audio = context.metadata.audio_mut();
        audio.role = role;
        audio.lyric_offset = lyric_offset;
    }

    Ok(())
}

/// 解析 `<ttm:agent>` 标签
///
/// ## 示例
/// ```xml
/// <ttm:agent type="person" xml:id="v1" />
/// ```
///
/// 带演唱者名称:
/// ```xml
/// <ttm:agent type="person" xml:id="v1">
///     <ttm:name type="full">Ryan Gosling</ttm:name>
/// </ttm:agent>
/// ```
fn parse_agent(
    reader: &mut Reader<&[u8]>,
    e: &BytesStart,
    context: &mut ParserContext,
) -> Result<()> {
    let id = e.get_required_attr(attrs::XML_ID, reader, context)?;
    let type_ = e.get_attr_value(attrs::TYPE, reader, context)?;
    let mut name = None;

    walk_inner(
        reader,
        context,
        tags::TTM_AGENT,
        |reader, context, event| {
            if let Event::Start(e) = event
                && e.name().is(tags::TTM_NAME)
            {
                name = Some(read_text_content(reader, context, tags::TTM_NAME)?);
                return Ok(Walk::Handled);
            }
            Ok(Walk::Continue)
        },
    )?;

    let agent = Agent { id, name, type_ };

    context.metadata.insert_agent(agent);

    Ok(())
}

fn parse_amll_meta(context: &mut ParserContext, key: &str, value: &str) {
    let meta = &mut context.metadata;
    let val: CompactString = value.trim().into();
    if val.is_empty() {
        return;
    }

    match key {
        meta_keys::MUSIC_NAME => meta.push_title(val),
        meta_keys::ARTISTS => meta.push_artist(val),
        meta_keys::ALBUM => meta.push_album(val),
        meta_keys::ISRC => meta.push_isrc(val),
        meta_keys::GITHUB_ID => meta.push_author_id(val),
        meta_keys::GITHUB_USER_NAME => meta.push_author_name(val),

        meta_keys::NCM_ID | meta_keys::QQ_ID | meta_keys::SPOTIFY_ID | meta_keys::APPLE_ID => {
            let platform = match key {
                meta_keys::NCM_ID => PlatformId::NcmMusicId,
                meta_keys::QQ_ID => PlatformId::QqMusicId,
                meta_keys::SPOTIFY_ID => PlatformId::SpotifyId,
                meta_keys::APPLE_ID => PlatformId::AppleMusicId,
                _ => unreachable!(),
            };
            meta.push_platform_id(platform, val);
        }

        _ => {
            meta.push_raw_property(key.into(), val);
        }
    }
}

/// 解析 `<songwriters>` 标签
///
/// ## 示例
/// ```xml
/// <songwriters>
///     <songwriter>Lin-Manuel Miranda</songwriter>
/// </songwriters>
/// ```
fn parse_songwriters(reader: &mut Reader<&[u8]>, context: &mut ParserContext) -> Result<()> {
    walk_inner(
        reader,
        context,
        tags::SONGWRITERS,
        |reader, context, event| {
            if let Event::Start(e) = event
                && e.name().is(tags::SONGWRITER)
            {
                let text = read_text_content(reader, context, tags::SONGWRITER)?;
                let text: CompactString = text.trim().into();
                if !text.is_empty() {
                    context.metadata.push_songwriter(text);
                }
                return Ok(Walk::Handled);
            }
            Ok(Walk::Continue)
        },
    )
}

#[cfg(test)]
mod tests {
    use quick_xml::{
        Reader,
        events::Event,
    };

    use super::*;
    use crate::parser::state::ParserContext;

    fn advance_to_start_tag(reader: &mut Reader<&[u8]>, tag_name: &str) {
        let mut buf = Vec::new();
        loop {
            match reader.read_event_into(&mut buf) {
                Ok(Event::Start(ref e)) if e.name().is(tag_name) => break,
                Ok(Event::Eof) => panic!("Reached EOF before finding tag: {tag_name}"),
                _ => (),
            }
            buf.clear();
        }
    }

    #[test]
    fn test_parse_amll_meta() {
        let mut context = ParserContext::default();

        parse_amll_meta(&mut context, meta_keys::MUSIC_NAME, "测试歌曲");
        parse_amll_meta(&mut context, meta_keys::ARTISTS, "测试歌手");

        parse_amll_meta(&mut context, meta_keys::NCM_ID, "12345");
        parse_amll_meta(&mut context, meta_keys::APPLE_ID, "67890");

        parse_amll_meta(&mut context, "customKey", "customValue");

        assert_eq!(context.metadata.title.as_ref().unwrap()[0], "测试歌曲");
        assert_eq!(context.metadata.artist.as_ref().unwrap()[0], "测试歌手");

        let platforms = context.metadata.platform_ids.as_ref().unwrap();
        assert_eq!(platforms.get(&PlatformId::NcmMusicId).unwrap()[0], "12345");
        assert_eq!(
            platforms.get(&PlatformId::AppleMusicId).unwrap()[0],
            "67890"
        );

        let raw_props = context.metadata.raw_properties.as_ref().unwrap();
        assert_eq!(raw_props.get("customKey").unwrap()[0], "customValue");
    }

    #[test]
    fn test_parse_songwriters() {
        let xml = r"
        <songwriters>
            <songwriter>Lin-Manuel Miranda</songwriter>
            <songwriter>Germaine Franco</songwriter>
            <songwriter>   </songwriter> 
        </songwriters>";

        let mut reader = Reader::from_str(xml);
        let mut context = ParserContext::default();

        advance_to_start_tag(&mut reader, tags::SONGWRITERS);

        parse_songwriters(&mut reader, &mut context).expect("Failed to parse songwriters");

        let writers = context.metadata.songwriters.as_ref().unwrap();
        assert_eq!(writers.len(), 2);
        assert_eq!(writers[0], "Lin-Manuel Miranda");
        assert_eq!(writers[1], "Germaine Franco");
    }

    #[test]
    fn test_parse_agent() {
        let xml = r#"
        <ttm:agent type="person" xml:id="v1">
            <ttm:name type="full">Ryan Gosling</ttm:name>
        </ttm:agent>"#;

        let mut reader = Reader::from_str(xml);
        let mut context = ParserContext::default();

        let mut buf = Vec::new();
        let start_event = loop {
            match reader.read_event_into(&mut buf).unwrap() {
                Event::Start(e) if e.name().is(tags::TTM_AGENT) => {
                    break e.into_owned();
                }
                _ => (),
            }
        };

        parse_agent(&mut reader, &start_event, &mut context).expect("Failed to parse agent");

        let agents = context.metadata.agents.as_ref().unwrap();
        assert!(agents.contains_key("v1"));

        let agent = agents.get("v1").unwrap();
        assert_eq!(agent.id, "v1");
        assert_eq!(agent.type_.as_deref(), Some("person"));
        assert_eq!(agent.name.as_deref(), Some("Ryan Gosling"));
    }

    #[test]
    fn test_parse_head() {
        let xml = r#"
        <head>
            <metadata>
                <ttm:title>We Don't Talk About Bruno</ttm:title>
                <amll:meta key="album" value="Encanto" />
            </metadata>
        </head>"#;

        let mut reader = Reader::from_str(xml);

        reader.config_mut().expand_empty_elements = true;

        let mut context = ParserContext::default();

        advance_to_start_tag(&mut reader, tags::HEAD);

        parse_head(&mut reader, &mut context).expect("Failed to parse head");

        assert_eq!(
            context.metadata.title.as_ref().unwrap()[0],
            "We Don't Talk About Bruno"
        );
        assert_eq!(context.metadata.album.as_ref().unwrap()[0], "Encanto");
    }

    #[test]
    fn test_parse_audio_metadata() {
        let xml = r#"
        <head>
            <metadata>
                <iTunesMetadata leadingSilence="0.040">
                    <audio lyricOffset="-0.271" role="spatial" />
                </iTunesMetadata>
            </metadata>
        </head>"#;

        let mut reader = Reader::from_str(xml);
        reader.config_mut().expand_empty_elements = true;

        let mut context = ParserContext::default();

        advance_to_start_tag(&mut reader, tags::HEAD);

        parse_head(&mut reader, &mut context).expect("Failed to parse head");

        let audio = context.metadata.audio.as_ref().unwrap();
        assert_eq!(audio.leading_silence, Some(40));
        assert_eq!(audio.lyric_offset, Some(-271));
        assert_eq!(audio.role.as_deref(), Some("spatial"));
    }

    #[test]
    fn test_parse_audio_element_outside_itunes_metadata() {
        let xml = r#"
        <head>
            <metadata>
                <audio lyricOffset="0.5" role="spatial" />
            </metadata>
        </head>"#;

        let mut reader = Reader::from_str(xml);
        reader.config_mut().expand_empty_elements = true;

        let mut context = ParserContext::default();

        advance_to_start_tag(&mut reader, tags::HEAD);

        parse_head(&mut reader, &mut context).expect("Failed to parse head");

        assert!(context.metadata.audio.is_none());
    }
}