Coverage Report

Created: 2025-12-05 06:49

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/gpac/src/media_tools/vobsub.c
Line
Count
Source
1
/*
2
 *          GPAC - Multimedia Framework C SDK
3
 *
4
 *          Copyright (c) by  Falco (Ivan Vecera) 2006
5
 *          Copyright (c) Jean Le Feuvre - Telecom ParisTech 2018_2020
6
 *                  All rights reserved
7
 *
8
 *  This file is part of GPAC / Media Tools sub-project
9
 *
10
 *  GPAC is free software; you can redistribute it and/or modify
11
 *  it under the terms of the GNU Lesser General Public License as published by
12
 *  the Free Software Foundation; either version 2, or (at your option)
13
 *  any later version.
14
 *
15
 *  GPAC is distributed in the hope that it will be useful,
16
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
17
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
 *  GNU Lesser General Public License for more details.
19
 *
20
 *  You should have received a copy of the GNU Lesser General Public
21
 *  License along with this library; see the file COPYING.  If not, write to
22
 *  the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
23
 *
24
 */
25
26
27
#include <gpac/list.h>
28
#include <gpac/internal/vobsub.h>
29
30
typedef struct _tag_lang_type
31
{
32
  char id[3];
33
  char lang[4];
34
} lang_type;
35
36
static lang_type lang_table[] =
37
{
38
  {"--", "und" },
39
  {"aa", "aar" },
40
  {"ab", "abk" },
41
  {"af", "afr" },
42
  {"am", "amh" },
43
  {"ar", "ara" },
44
  {"as", "ast" },
45
  {"ay", "aym" },
46
  {"az", "aze" },
47
  {"ba", "bak" },
48
  {"be", "bel" },
49
  {"bg", "bul" },
50
  {"bh", "bih" },
51
  {"bi", "bis" },
52
  {"bn", "ben" },
53
  {"bo", "bod" }, // was "tib" (Tibetan)
54
  {"br", "bre" },
55
  {"ca", "cat" },
56
  {"cc", "und" },
57
  {"co", "cos" },
58
  {"cs", "ces" }, // was "cze" (Czech)
59
  {"cy", "cym" }, // was "wel" (Welsh)
60
  {"da", "dan" },
61
  {"de", "deu" }, // was "ger" (German)
62
  {"dz", "dzo" },
63
  {"el", "ell" }, // was "gre" (Greek, Modern (1453-))
64
  {"en", "eng" },
65
  {"eo", "epo" },
66
  {"es", "spa" },
67
  {"et", "est" },
68
  {"eu", "eus" }, // was "baq" (Basque)
69
  {"fa", "fas" }, // was "per" (Persian)
70
  {"fi", "fin" },
71
  {"fj", "fij" },
72
  {"fo", "fao" },
73
  {"fr", "fra" }, // was "fre" (French)
74
  {"fy", "fry" },
75
  {"ga", "gle" },
76
  {"gl", "glg" },
77
  {"gn", "grn" },
78
  {"gu", "guj" },
79
  {"ha", "hau" },
80
  {"he", "heb" },
81
  {"hi", "hin" },
82
  {"hr", "scr" },
83
  {"hu", "hun" },
84
  {"hy", "hye" }, // was "arm" (Armenian)
85
  {"ia", "ina" },
86
  {"id", "ind" },
87
  {"ik", "ipk" },
88
  {"is", "isl" }, // was "ice" (Icelandic)
89
  {"it", "ita" },
90
  {"iu", "iku" },
91
  {"ja", "jpn" },
92
  {"jv", "jav" },
93
  {"ka", "kat" }, // was "geo" (Georgian)
94
  {"kk", "kaz" },
95
  {"kl", "kal" },
96
  {"km", "khm" },
97
  {"kn", "kan" },
98
  {"ko", "kor" },
99
  {"ks", "kas" },
100
  {"ku", "kur" },
101
  {"ky", "kir" },
102
  {"la", "lat" },
103
  {"ln", "lin" },
104
  {"lo", "lao" },
105
  {"lt", "lit" },
106
  {"lv", "lav" },
107
  {"mg", "mlg" },
108
  {"mi", "mri" }, // was "mao" (Maori)
109
  {"mk", "mkd" }, // was "mac" (Macedonian)
110
  {"ml", "mlt" },
111
  {"mn", "mon" },
112
  {"mo", "mol" },
113
  {"mr", "mar" },
114
  {"ms", "msa" }, // was "may" (Malay)
115
  {"my", "mya" }, // was "bur" (Burmese)
116
  {"na", "nau" },
117
  {"ne", "nep" },
118
  {"nl", "nld" }, // was "dut" (Dutch; Flemish)
119
  {"no", "nor" },
120
  {"oc", "oci" },
121
  {"om", "orm" },
122
  {"or", "ori" },
123
  {"pa", "pan" },
124
  {"pl", "pol" },
125
  {"ps", "pus" },
126
  {"pt", "por" },
127
  {"qu", "que" },
128
  {"rm", "roh" },
129
  {"rn", "run" },
130
  {"ro", "ron" }, // was "rum" (Romanian; Moldavian; Moldovan)
131
  {"ru", "rus" },
132
  {"rw", "kin" },
133
  {"sa", "san" },
134
  {"sd", "snd" },
135
  {"sg", "sag" },
136
  {"sh", "scr" },
137
  {"si", "sin" },
138
  {"sk", "slk" }, // was "slo" (Slovak)
139
  {"sl", "slv" },
140
  {"sm", "smo" },
141
  {"sn", "sna" },
142
  {"so", "som" },
143
  {"sq", "sqi" }, // was "alb" (Albanian)
144
  {"sr", "srp" },
145
  {"ss", "ssw" },
146
  {"st", "sot" },
147
  {"su", "sun" },
148
  {"sv", "swe" },
149
  {"sw", "swa" },
150
  {"ta", "tam" },
151
  {"te", "tel" },
152
  {"tg", "tgk" },
153
  {"th", "tha" },
154
  {"ti", "tir" },
155
  {"tk", "tuk" },
156
  {"tl", "tgl" },
157
  {"tn", "tsn" },
158
  {"to", "tog" },
159
  {"tr", "tur" },
160
  {"ts", "tso" },
161
  {"tt", "tat" },
162
  {"tw", "twi" },
163
  {"ug", "uig" },
164
  {"uk", "ukr" },
165
  {"ur", "urd" },
166
  {"uz", "uzb" },
167
  {"vi", "vie" },
168
  {"vo", "vol" },
169
  {"wo", "wol" },
170
  {"xh", "xho" },
171
  {"yi", "yid" },
172
  {"yo", "yor" },
173
  {"za", "zha" },
174
  {"zh", "zho" }, // was "chi" (Chinese)
175
  {"zu", "zul" }
176
};
177
178
179
180
s32 vobsub_lang_name(u16 id)
181
0
{
182
0
  u16 lang_id;
183
0
  s32 i, count;
184
185
0
  count = (sizeof(lang_table) / sizeof(lang_table[0]));
186
187
0
  for (i = 0; i < count; i++) {
188
0
    lang_id = (lang_table[i].id[0]<<8) | lang_table[i].id[1];
189
190
0
    if (id == lang_id) {
191
0
      return i;
192
0
    }
193
0
  }
194
195
0
  return 0; /* Undefined - und */
196
0
}
197
198
char *vobsub_lang_id(char *name)
199
0
{
200
0
  s32 i, count;
201
202
0
  count = (sizeof(lang_table) / sizeof(lang_table[0]));
203
204
0
  for (i = 0; i < count; i++) {
205
0
    if (!stricmp(lang_table[i].lang, name)) {
206
0
      return lang_table[i].id;
207
0
    }
208
0
  }
209
210
0
  return "--"; /* Undefined */
211
0
}
212
213
static char *strltrim(char *str)
214
0
{
215
0
  if (str == NULL) {
216
0
    return NULL;
217
0
  }
218
219
0
  while (*str) {
220
0
    if (!isspace(*str)) {
221
0
      return str;
222
0
    }
223
0
    str++;
224
0
  }
225
226
0
  return str;
227
0
}
228
229
static char *strrtrim(char *str)
230
0
{
231
0
  char *end;
232
233
0
  if (str == NULL) {
234
0
    return NULL;
235
0
  }
236
237
0
  end = str + strlen(str);
238
239
0
  while (end-- > str) {
240
0
    if (!isspace(*end)) {
241
0
      return str;
242
0
    }
243
0
    *end = '\0';
244
0
  }
245
246
0
  return str;
247
0
}
248
249
static char *strtrim(char *str)
250
0
{
251
0
  return strltrim(strrtrim(str));
252
0
}
253
254
GF_Err vobsub_read_idx(FILE *file, vobsub_file *vobsub, s32 *version)
255
0
{
256
0
  char  strbuf[257];
257
0
  char *str, *pos, *entry;
258
0
  s32   line, id =-1, delay = 0;
259
0
  Bool  error = 0;
260
261
0
  for (line = 0; !error && gf_fgets(strbuf, 256, file); line++)
262
0
  {
263
    //make sure we are null-terminated - cf #2520
264
0
    strbuf[256]=0;
265
0
    str = strtrim(strbuf);
266
267
0
    if (line == 0)
268
0
    {
269
0
      char *buf = "VobSub index file, v";
270
271
0
      pos = strstr(str, buf);
272
0
      if (pos == NULL || sscanf(pos + strlen(buf), "%d", version) != 1 || *version > VOBSUBIDXVER)
273
0
      {
274
0
        error = 1;
275
0
        continue;
276
0
      }
277
0
    }
278
0
    else if (strlen(str) == 0)
279
0
    {
280
0
      continue;
281
0
    }
282
0
    else if (str[0] == '#')
283
0
    {
284
0
      continue;
285
0
    }
286
287
0
    pos = strchr(str, ':');
288
0
    if (pos == NULL || pos == str)
289
0
    {
290
0
      continue;
291
0
    }
292
293
0
    entry = str;
294
0
    *pos  = '\0';
295
296
0
    str = strtrim(pos + 1);
297
0
    if (strlen(str) == 0)
298
0
    {
299
0
      continue;
300
0
    }
301
302
0
    if (stricmp(entry, "size") == 0)
303
0
    {
304
0
      s32 w, h;
305
0
      if (sscanf(str, "%dx%d", &w, &h) != 2)
306
0
      {
307
0
        error = 1;
308
0
      }
309
0
      vobsub->width  = w;
310
0
      vobsub->height = h;
311
0
    }
312
0
    else if (stricmp(entry, "palette") == 0)
313
0
    {
314
0
      s32 c;
315
0
      u8  palette[16][4];
316
317
0
      if (sscanf(str, "%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x,%x",
318
0
                 (u32 *) &palette[0], (u32 *) &palette[1], (u32 *) &palette[2], (u32 *) &palette[3],
319
0
                 (u32 *) &palette[4], (u32 *) &palette[5], (u32 *) &palette[6], (u32 *) &palette[7],
320
0
                 (u32 *) &palette[8], (u32 *) &palette[9], (u32 *) &palette[10], (u32 *) &palette[11],
321
0
                 (u32 *) &palette[12],(u32 *) &palette[13],(u32 *) &palette[14], (u32 *) &palette[15]) != 16)
322
0
      {
323
0
        error = 1;
324
0
        continue;
325
0
      }
326
327
0
      for (c = 0; c < 16; c++)
328
0
      {
329
0
        u8 r, g, b;
330
331
0
        r = palette[c][2];
332
0
        g = palette[c][1];
333
0
        b = palette[c][0];
334
0
        vobsub->palette[c][0] = 0;
335
0
        vobsub->palette[c][1] = (( 66 * r + 129 * g +  25 * b + 128 +  4096) >> 8) & 0xff;
336
0
        vobsub->palette[c][2] = ((112 * r -  94 * g -  18 * b + 128 + 32768) >> 8) & 0xff;
337
0
        vobsub->palette[c][3] = ((-38 * r -  74 * g + 112 * b + 128 + 32768) >> 8) & 0xff;
338
0
      }
339
0
    }
340
0
    else if (stricmp(entry, "id") == 0)
341
0
    {
342
0
      char *buf = "index:";
343
0
      s32   lang_id;
344
345
0
      strlwr(str);
346
0
      lang_id = ((str[0] & 0xff) << 8) | (str[1] & 0xff);
347
348
0
      pos = strstr(str, buf);
349
0
      if (pos == NULL)
350
0
      {
351
0
        error = 1;
352
0
        continue;
353
0
      }
354
355
0
      if (sscanf(pos + strlen(buf), "%d", &id) != 1 || id < 0 || id >= 32)
356
0
      {
357
0
        error = 1;
358
0
        continue;
359
0
      }
360
361
0
      vobsub->langs[id].id   = lang_id;
362
0
      vobsub->langs[id].name = lang_table[vobsub_lang_name((u16)lang_id)].lang;
363
0
      vobsub->langs[id].idx = id;
364
365
0
      vobsub->langs[id].subpos = gf_list_new();
366
0
      if (vobsub->langs[id].subpos == NULL)
367
0
      {
368
0
        error = 1;
369
0
        continue;
370
0
      }
371
372
0
      delay = 0;
373
0
      vobsub->num_langs++;
374
0
    }
375
0
    else if (id >= 0 && stricmp(entry, "delay") == 0)
376
0
    {
377
0
      s32  hh, mm, ss, ms;
378
0
      char c;
379
0
      s32  sign = (str[0] == '-') ? -1 : 1;
380
381
0
      pos = str;
382
0
      while (*pos == '-' || *pos == '+') pos++;
383
384
0
      if (sscanf(pos, "%d%c%d%c%d%c%d", &hh, &c, &mm, &c, &ss, &c, &ms) != 7)
385
0
      {
386
0
        error = 1;
387
0
        continue;
388
0
      }
389
390
0
      delay += (hh*60*60*1000 + mm*60*1000 + ss*1000 + ms) * sign;
391
0
    }
392
0
    else if (id >= 0 && stricmp(entry, "timestamp") == 0)
393
0
    {
394
0
      vobsub_pos *vspos;
395
0
      s32         sign;
396
0
      char        c;
397
0
      s32         hh, mm, ss, ms;
398
0
      char       *buf = "filepos:";
399
400
0
      vspos = (vobsub_pos*)gf_calloc(1, sizeof(vobsub_pos));
401
0
      if (vspos == NULL) {
402
0
        error = 1;
403
0
        continue;
404
0
      }
405
406
0
      sign = (str[0] == '-') ? -1 : 1;
407
0
      while (*str == '-' || *str == '+') str++;
408
409
0
      if (sscanf(str, "%d%c%d%c%d%c%d", &hh, &c, &mm, &c, &ss, &c, &ms) != 7)
410
0
      {
411
0
        gf_free(vspos);
412
0
        error = 1;
413
0
        continue;
414
0
      }
415
416
0
      vspos->start = (((hh*60 + mm)*60 + ss)*1000 + ms) * sign + delay;
417
418
0
      pos = strstr(str, buf);
419
0
      if (pos == NULL)
420
0
      {
421
0
        gf_free(vspos);
422
0
        error = 1;
423
0
        continue;
424
0
      }
425
426
0
      if (sscanf(pos + strlen(buf), LLX, &vspos->filepos) != 1)
427
0
      {
428
0
        gf_free(vspos);
429
0
        error = 1;
430
0
        continue;
431
0
      }
432
433
0
      if (delay < 0 && gf_list_count(vobsub->langs[id].subpos) > 0)
434
0
      {
435
0
        vobsub_pos *vspos_next;
436
437
0
        vspos_next = (vobsub_pos*)gf_list_get(vobsub->langs[id].subpos, gf_list_count(vobsub->langs[id].subpos) - 1);
438
0
        if (vspos->start < vspos_next->start)
439
0
        {
440
0
          delay += (s32)(vspos_next->start - vspos->start);
441
0
          vspos->start = vspos_next->start;
442
0
        }
443
0
      }
444
445
0
      if (gf_list_add(vobsub->langs[id].subpos, vspos) != GF_OK)
446
0
      {
447
0
        gf_free(vspos);
448
0
        error = 1;
449
0
        continue;
450
0
      }
451
0
    }
452
0
  }
453
454
0
  return error ? GF_CORRUPTED_DATA : GF_OK;
455
0
}
456
457
void vobsub_free(vobsub_file *vobsub)
458
0
{
459
0
  s32 i;
460
461
0
  if (vobsub == NULL)
462
0
    return;
463
464
0
  for (i = 0; i < 32; i++) {
465
0
    if (vobsub->langs[i].subpos) {
466
0
      GF_List *list = vobsub->langs[i].subpos;
467
0
      vobsub_pos *vspos;
468
0
      u32 pos = 0;
469
470
0
      do {
471
0
        vspos = (vobsub_pos*)gf_list_enum(list, &pos);
472
0
        gf_free(vspos);
473
0
      }
474
0
      while (vspos != NULL);
475
476
0
      gf_list_del(list);
477
0
    }
478
0
  }
479
0
  gf_free(vobsub);
480
0
}
481
482
GF_Err vobsub_get_subpic_duration(u8 *_data, u32 psize, u32 dsize, u32 *duration)
483
0
{
484
0
  u32 i, dcsq_stm, nxt_dcsq, start_stm, stop_stm;
485
0
  u8 *data = (u8 *)_data;
486
0
  start_stm = 0;
487
0
  stop_stm  = 0;
488
0
  nxt_dcsq  = dsize;
489
490
0
  if (psize) do {
491
0
    i = nxt_dcsq;
492
0
    dcsq_stm = (data[i+0] << 8) | data[i+1];
493
0
    nxt_dcsq = (data[i+2] << 8) | data[i+3];
494
0
    i += 4;
495
496
0
    if (nxt_dcsq > psize || nxt_dcsq < dsize) {
497
0
      return GF_CORRUPTED_DATA;
498
0
    }
499
500
0
    while (1) {
501
0
      u8  cmd;
502
0
      int len;
503
504
0
      cmd = data[i++];
505
0
      switch (cmd)
506
0
      {
507
0
      case 0x00:
508
0
        len = 0;
509
0
        break;
510
0
      case 0x01:
511
0
        len = 0;
512
0
        break;
513
0
      case 0x02:
514
0
        len = 0;
515
0
        break;
516
0
      case 0x03:
517
0
        len = 2;
518
0
        break;
519
0
      case 0x04:
520
0
        len = 2;
521
0
        break;
522
0
      case 0x05:
523
0
        len = 6;
524
0
        break;
525
0
      case 0x06:
526
0
        len = 4;
527
0
        break;
528
0
      default:
529
0
        len = 0;
530
0
        break;
531
0
      }
532
533
0
      if (i + len > psize) {
534
0
        return GF_CORRUPTED_DATA;
535
0
      }
536
537
0
      i += len;
538
539
0
      if (cmd == 0x00 || cmd == 0x01) {
540
        /* start normal or forced displaying */
541
0
        start_stm = dcsq_stm * 1024;
542
0
      } else if (cmd == 0x02) {
543
        /* stop displaying */
544
0
        stop_stm = dcsq_stm * 1024;
545
0
      } else if (cmd > 0x06) {
546
        /* unknown command or end of control block */
547
0
        break;
548
0
      }
549
0
    }
550
0
  } while (i <= nxt_dcsq && i < psize);
551
552
0
  *duration = stop_stm - start_stm;
553
554
0
  return GF_OK;
555
0
}
556
557
GF_Err vobsub_packetize_subpicture(FILE *fsub, u64 pts, u8 *data, u32 dataSize)
558
0
{
559
0
  u8  buf[0x800], ptsbuf[5];
560
0
  int put_pts = 1;
561
562
  /* Build PTS buffer */
563
0
  ptsbuf[0] = (u8)(((pts >> 29) & 0x0e) | 0x21);
564
0
  ptsbuf[1] = (u8)(((pts >> 22) & 0xff));
565
0
  ptsbuf[2] = (u8)(((pts >> 14) & 0xfe) | 0x01);
566
0
  ptsbuf[3] = (u8)(((pts >>  7) & 0xff));
567
0
  ptsbuf[4] = (u8)(((pts <<  1) & 0xfe) | 0x01);
568
569
0
  while (dataSize > 0) {
570
0
    u8  *p;
571
0
    u32 padLen = 0;
572
0
    u32 dataLen = sizeof(buf);
573
0
    u32 packLen;
574
575
    /* Zerofill packet */
576
0
    memset(buf, 0, sizeof(buf));
577
0
    p = buf;
578
579
    /* Put pack header */
580
0
    *p++ = 0x00;
581
0
    *p++ = 0x00;
582
0
    *p++ = 0x01;
583
0
    *p++ = 0xba;
584
0
    *p++ = 0x40;
585
586
    /* Jump to PES header */
587
0
    p += 9;
588
589
    /* Put PES header */
590
0
    *p++ = 0x00;
591
0
    *p++ = 0x00;
592
0
    *p++ = 0x01;
593
0
    *p++ = 0xbd;
594
595
    /* Compute max size of content */
596
0
    dataLen -= 14; /* Pack header */
597
0
    dataLen -=  4; /* Start code + Stream ID */
598
0
    dataLen -=  2; /* PES packet size */
599
0
    dataLen -=  3; /* PES header extension */
600
0
    dataLen -= put_pts ? 5 : 0; /* PTS */
601
0
    dataLen -=  1; /* Substream ID */
602
603
    /* Check if the subpicture data fits in packet */
604
0
    if (dataSize <= dataLen) {
605
0
      padLen  = dataLen - dataSize;
606
0
      dataLen = dataSize;
607
0
    }
608
609
    /* Compute and put packet size (PES header extension + PTS + Substream ID + data + padding) */
610
0
    packLen = 3 + (put_pts ? 5 : 0) + 1 + dataLen + ((padLen < 6) ? padLen : 0);
611
0
    *p++ = (packLen >> 8) & 0xff;
612
0
    *p++ = packLen & 0xff;
613
614
    /* Put PES header extension */
615
0
    *p++ = 0x80;
616
0
    *p++ = put_pts ? 0x80 : 0x00;
617
0
    *p++ = (put_pts ? 5 : 0) + ((padLen < 6) ? padLen : 0);
618
619
    /* Put PTS */
620
0
    if (put_pts) {
621
0
      *p++ = ptsbuf[0];
622
0
      *p++ = ptsbuf[1];
623
0
      *p++ = ptsbuf[2];
624
0
      *p++ = ptsbuf[3];
625
0
      *p++ = ptsbuf[4];
626
0
    }
627
628
    /* Skip padding bytes */
629
0
    if (padLen < 6) {
630
0
      p += padLen;
631
0
    }
632
633
    /* Put Substream ID */
634
0
    *p++ = 0x20;
635
636
    /* Copy data into packet buffer */
637
0
    memcpy(p, data, dataLen);
638
0
    p += dataLen;
639
640
    /* Put padding bytes if padding len >= 6 */
641
0
    if (padLen >= 6) {
642
0
      padLen -= 6;
643
0
      *p++ = 0x00;
644
0
      *p++ = 0x00;
645
0
      *p++ = 0x01;
646
0
      *p++ = 0xbe;
647
0
      *p++ = (padLen >> 8) & 0xff;
648
0
      *p++ = padLen & 0xff;
649
0
      memset(p, 0, padLen);
650
0
    }
651
652
    /* Write packet into file */
653
0
    if (gf_fwrite(buf, sizeof(buf), fsub) != sizeof(buf)) {
654
0
      return GF_IO_ERR;
655
0
    }
656
657
    /* Move data pointer... */
658
0
    data += dataLen;
659
0
    dataSize -= dataLen;
660
661
    /* Next packet (if any) will not contain PTS */
662
0
    put_pts = 0;
663
0
  }
664
665
0
  return GF_OK;
666
0
}