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
use std::{borrow::Cow, fmt::Display, fs::File, io::BufReader, path::Path, str::FromStr};

use encoding_rs::Encoding;
use encoding_rs_io::DecodeReaderBytesBuilder;

use crate::{
    encoding::detect_file_encoding,
    timing::{frame_to_moment, moment_to_frame, Frame},
    traits::TimedSubtitle,
    AssSubtitle, Error, Moment, SsaSubtitle, SubRipSubtitle, Subtitle, TextEvent,
    TextEventInterface, TextSubtitle, TimedEvent, TimedEventInterface, WebVttSubtitle,
};

use super::parse::parse_microdvd;

type FrameRate = f32;

/// Timed version of MicroDVD (.sub) subtitle, using user-supplied framerate to calculate timings
///
/// When initialised without framerate, the default framerate is 24.
#[derive(Debug)]
pub struct TimedMicroDvdSubtitle {
    events: Vec<TimedMicroDvdEvent>,
    framerate: FrameRate,
}

/// Timed MicroDVD event
#[derive(Debug)]
pub struct TimedMicroDvdEvent {
    /// Start time of event
    pub start: Moment,
    /// End time of event
    pub end: Moment,
    /// Text to display during event
    pub text: String,
}

/// Unmodified MicroDVD subtitle, with events timed in terms of frames.
///
/// This is not well supported, so things like conversion are not implemented for this type.
/// If possible, use of [`MicroDvdSubtitle`], which represents subtitle events using actual timestamps, is better supported.
#[derive(Debug)]
pub struct MicroDvdSubtitle {
    events: Vec<MicroDvdEvent>,
}

/// Unmodified MicroDVD event, timed in terms of frames
#[derive(Debug)]
pub struct MicroDvdEvent {
    /// Frame at which event starts
    pub start: Frame,
    /// Frame at which event ends
    pub end: Frame,
    /// Text to display during event
    pub text: String,
}

impl TimedMicroDvdSubtitle {
    fn open_file_with_encoding(
        path: impl AsRef<Path>,
        encoding: Option<&'static Encoding>,
    ) -> Result<Self, Error> {
        let file = File::open(path)?;
        let transcoded = DecodeReaderBytesBuilder::new()
            .encoding(encoding)
            .build(file);
        let reader = BufReader::new(transcoded);

        Ok(Self::from_raw(&parse_microdvd(reader), Some(24.0)))
    }

    fn open_file_with_encoding_and_framerate(
        path: impl AsRef<Path>,
        encoding: Option<&'static Encoding>,
        framerate: FrameRate,
    ) -> Result<Self, Error> {
        let file = File::open(path)?;
        let transcoded = DecodeReaderBytesBuilder::new()
            .encoding(encoding)
            .build(file);
        let reader = BufReader::new(transcoded);

        Ok(Self::from_raw(&parse_microdvd(reader), Some(framerate)))
    }

    /// Convert raw MicroDVD subtitle data to timed MicroDVD data, given the framerate the subtitles were created for.
    /// If no framerate is given, the default of 24 is used.
    #[must_use]
    pub fn from_raw(raw: &MicroDvdSubtitle, framerate: Option<FrameRate>) -> Self {
        let framerate = framerate.unwrap_or(24.0);
        let events = raw
            .events
            .iter()
            .map(|event| TimedMicroDvdEvent {
                start: frame_to_moment(event.start, framerate),
                end: frame_to_moment(event.end, framerate),
                text: event.text.clone(),
            })
            .collect();

        Self { events, framerate }
    }

    /// Create MicroDVD from path given and calculate its timings using the given framerate.
    ///
    /// # Errors
    ///
    /// Returns [`Error::FileIoError`] if an error occurs while opening the file
    pub fn with_framerate(path: impl AsRef<Path>, framerate: FrameRate) -> Result<Self, Error> {
        let mut enc = detect_file_encoding(path.as_ref(), Some(30)).ok();
        let mut result = Self::open_file_with_encoding_and_framerate(path.as_ref(), enc, framerate);

        if result.is_err() {
            enc = detect_file_encoding(path.as_ref(), None).ok();
            result = Self::open_file_with_encoding_and_framerate(path.as_ref(), enc, framerate);
        }

        result
    }

    /// Get framerate used to create timings
    #[must_use]
    pub fn framerate(&self) -> FrameRate {
        self.framerate
    }

    /// Modify framerate associated with subtitle.
    /// Does not modify event timings at all.
    pub fn set_framerate(&mut self, framerate: FrameRate) {
        self.framerate = framerate;
    }

    /// Modify framerate associated with subtitle
    ///
    /// This will also recalculate and update all event timings to match the new framerate.
    pub fn update_framerate(&mut self, framerate: FrameRate) {
        let ratio = self.framerate / framerate;
        for event in &mut self.events {
            event.start =
                Moment::from(((i64::from(event.start) as FrameRate) * ratio).round() as i64);
            event.end = Moment::from(((i64::from(event.end) as FrameRate) * ratio).round() as i64);
        }
        self.framerate = framerate;
    }
}

impl Subtitle for TimedMicroDvdSubtitle {
    type Event = TimedMicroDvdEvent;

    fn from_path_with_encoding(
        path: impl AsRef<std::path::Path>,
        encoding: Option<&'static encoding_rs::Encoding>,
    ) -> Result<Self, Error> {
        let mut enc = encoding.or_else(|| detect_file_encoding(path.as_ref(), Some(30)).ok());
        let mut result = Self::open_file_with_encoding(path.as_ref(), enc);

        if encoding.is_none() && result.is_err() {
            enc = encoding.or_else(|| detect_file_encoding(path.as_ref(), None).ok());
            result = Self::open_file_with_encoding(path.as_ref(), enc);
        }

        result
    }

    fn events(&self) -> &[Self::Event] {
        self.events.as_slice()
    }

    fn events_mut(&mut self) -> &mut [Self::Event] {
        self.events.as_mut_slice()
    }
}

impl TextSubtitle for TimedMicroDvdSubtitle {}

impl TimedSubtitle for TimedMicroDvdSubtitle {}

impl Display for TimedMicroDvdSubtitle {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for event in &self.events {
            writeln!(
                f,
                "{{{}}}{{{}}}{}",
                moment_to_frame(event.start, self.framerate),
                moment_to_frame(event.end, self.framerate),
                event.text
            )?;
        }

        Ok(())
    }
}

impl FromStr for TimedMicroDvdSubtitle {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let reader = BufReader::new(s.as_bytes());

        Ok(Self::from_raw(&parse_microdvd(reader), None))
    }
}

impl From<&AssSubtitle> for TimedMicroDvdSubtitle {
    fn from(value: &AssSubtitle) -> Self {
        Self {
            events: value
                .events()
                .iter()
                .map(|line| TimedMicroDvdEvent {
                    text: line.as_plaintext().replace('\n', "|"),
                    start: line.start,
                    end: line.end,
                })
                .collect(),
            framerate: 24.0,
        }
    }
}

impl From<&SsaSubtitle> for TimedMicroDvdSubtitle {
    fn from(value: &SsaSubtitle) -> Self {
        Self {
            events: value
                .events()
                .iter()
                .map(|line| TimedMicroDvdEvent {
                    text: line.as_plaintext().replace('\n', "|"),
                    start: line.start,
                    end: line.end,
                })
                .collect(),
            framerate: 24.0,
        }
    }
}

impl From<&SubRipSubtitle> for TimedMicroDvdSubtitle {
    fn from(value: &SubRipSubtitle) -> Self {
        Self {
            events: value
                .events()
                .iter()
                .map(|line| TimedMicroDvdEvent {
                    text: line.as_plaintext().replace('\n', "|"),
                    start: line.start,
                    end: line.end,
                })
                .collect(),
            framerate: 24.0,
        }
    }
}

impl From<&WebVttSubtitle> for TimedMicroDvdSubtitle {
    fn from(value: &WebVttSubtitle) -> Self {
        Self {
            events: value
                .events()
                .iter()
                .map(|line| TimedMicroDvdEvent {
                    text: line.as_plaintext().replace('\n', "|"),
                    start: line.start,
                    end: line.end,
                })
                .collect(),
            framerate: 24.0,
        }
    }
}

impl TextEvent for TimedMicroDvdEvent {
    fn unformatted_text(&self) -> Cow<'_, String> {
        Cow::Borrowed(&self.text)
    }

    fn as_plaintext(&self) -> Cow<'_, String> {
        Cow::Owned(self.text.replace('|', "\n"))
    }
}

impl TextEventInterface for TimedMicroDvdEvent {
    fn text(&self) -> String {
        self.text.clone()
    }

    fn set_text(&mut self, text: String) {
        self.text = text;
    }
}

impl TimedEvent for TimedMicroDvdEvent {}

impl TimedEventInterface for TimedMicroDvdEvent {
    fn start(&self) -> Moment {
        self.start
    }

    fn end(&self) -> Moment {
        self.end
    }

    fn set_start(&mut self, moment: Moment) {
        self.start = moment;
    }

    fn set_end(&mut self, moment: Moment) {
        self.end = moment;
    }
}

impl From<&TimedMicroDvdSubtitle> for MicroDvdSubtitle {
    fn from(value: &TimedMicroDvdSubtitle) -> Self {
        Self {
            events: value
                .events
                .iter()
                .map(|event| MicroDvdEvent {
                    start: moment_to_frame(event.start, value.framerate),
                    end: moment_to_frame(event.end, value.framerate),
                    text: event.text.clone(),
                })
                .collect(),
        }
    }
}

impl MicroDvdSubtitle {
    /// Create new instance from already existing list of `MicroDvdEvent`s.
    #[must_use]
    pub fn from_events(events: Vec<MicroDvdEvent>) -> Self {
        Self { events }
    }

    fn open_file_with_encoding(
        path: impl AsRef<Path>,
        encoding: Option<&'static Encoding>,
    ) -> Result<Self, Error> {
        let file = File::open(path)?;
        let transcoded = DecodeReaderBytesBuilder::new()
            .encoding(encoding)
            .build(file);
        let reader = BufReader::new(transcoded);

        Ok(parse_microdvd(reader))
    }
}

impl Subtitle for MicroDvdSubtitle {
    type Event = MicroDvdEvent;

    fn from_path_with_encoding(
        path: impl AsRef<Path>,
        encoding: Option<&'static Encoding>,
    ) -> Result<Self, Error> {
        let mut enc = encoding.or_else(|| detect_file_encoding(path.as_ref(), Some(30)).ok());
        let mut result = Self::open_file_with_encoding(path.as_ref(), enc);

        if encoding.is_none() && result.is_err() {
            enc = encoding.or_else(|| detect_file_encoding(path.as_ref(), None).ok());
            result = Self::open_file_with_encoding(path.as_ref(), enc);
        }

        result
    }

    fn events(&self) -> &[Self::Event] {
        self.events.as_slice()
    }

    fn events_mut(&mut self) -> &mut [Self::Event] {
        self.events.as_mut_slice()
    }
}

impl TextSubtitle for MicroDvdSubtitle {}

impl Display for MicroDvdSubtitle {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        for event in &self.events {
            writeln!(f, "{{{}}}{{{}}}{}", event.start, event.end, event.text)?;
        }

        Ok(())
    }
}

impl FromStr for MicroDvdSubtitle {
    type Err = Error;

    fn from_str(s: &str) -> Result<Self, Self::Err> {
        let reader = BufReader::new(s.as_bytes());

        Ok(parse_microdvd(reader))
    }
}

impl TextEvent for MicroDvdEvent {
    fn unformatted_text(&self) -> Cow<'_, String> {
        Cow::Owned(self.text.replace('|', "\n"))
    }
}

impl TextEventInterface for MicroDvdEvent {
    fn text(&self) -> String {
        self.text.clone()
    }

    fn set_text(&mut self, text: String) {
        self.text = text;
    }
}