Add "U8" character code table for binary STL.
[libsub.git] / src / stl_binary_tables.cc
1 /*
2     Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
3
4     This program is free software; you can redistribute it and/or modify
5     it under the terms of the GNU General Public License as published by
6     the Free Software Foundation; either version 2 of the License, or
7     (at your option) any later version.
8
9     This program is distributed in the hope that it will be useful,
10     but WITHOUT ANY WARRANTY; without even the implied warranty of
11     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12     GNU General Public License for more details.
13
14     You should have received a copy of the GNU General Public License
15     along with this program; if not, write to the Free Software
16     Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
17
18 */
19
20 #include "stl_binary_tables.h"
21 #include "exceptions.h"
22 #include "sub_assert.h"
23 #include "compose.hpp"
24
25 using std::map;
26 using std::string;
27 using namespace sub;
28
29 template <class E, class F>
30 void
31 code (map<F, STLBinaryCode<E> >& m, F k, E v, string d)
32 {
33         m[k] = STLBinaryCode<E> (v, d);
34 }
35
36 template <class E, class F>
37 E
38 file_to_enum (F k, map<F, STLBinaryCode<E> > m, string name)
39 {
40         typename map<F, STLBinaryCode<E> >::const_iterator i = m.find (k);
41         if (i == m.end ()) {
42                 throw STLError (String::compose ("Unknown %1 %2 in binary STL file", name, k));
43         }
44
45         return i->second.value;
46 }
47
48 template <class E, class F>
49 F
50 enum_to_file (E k, map<F, STLBinaryCode<E> > m)
51 {
52         for (typename map<F, STLBinaryCode<E> >::const_iterator i = m.begin(); i != m.end(); ++i) {
53                 if (i->second.value == k) {
54                         return i->first;
55                 }
56         }
57
58         SUB_ASSERT (false);
59         return F ();
60 }
61
62 template <class E, class F>
63 string
64 enum_to_description (E v, map<F, STLBinaryCode<E> > const & m)
65 {
66         for (typename map<F, STLBinaryCode<E> >::const_iterator i = m.begin(); i != m.end(); ++i) {
67                 if (i->second.value == v) {
68                         return i->second.description;
69                 }
70         }
71
72         return "";
73 }
74
75 template <class E, class F>
76 boost::optional<E>
77 description_to_enum (string d, map<F, STLBinaryCode<E> > const & m)
78 {
79         for (typename map<F, STLBinaryCode<E> >::const_iterator i = m.begin(); i != m.end(); ++i) {
80                 if (i->second.description == d) {
81                         return i->second.value;
82                 }
83         }
84
85         return boost::optional<E> ();
86 }
87
88 DisplayStandard
89 STLBinaryTables::display_standard_file_to_enum (string s) const
90 {
91         return file_to_enum (s, _display_standard_map, "display standard code");
92 }
93
94 LanguageGroup
95 STLBinaryTables::language_group_file_to_enum (string s) const
96 {
97         return file_to_enum (s, _language_group_map, "language group code");
98 }
99
100 Language
101 STLBinaryTables::language_file_to_enum (string s) const
102 {
103         return file_to_enum (s, _language_map, "language code");
104 }
105
106 TimecodeStatus
107 STLBinaryTables::timecode_status_file_to_enum (string s) const
108 {
109         return file_to_enum (s, _timecode_status_map, "timecode status code");
110 }
111
112 CumulativeStatus
113 STLBinaryTables::cumulative_status_file_to_enum (int s) const
114 {
115         return file_to_enum (s, _cumulative_status_map, "cumulative status code");
116 }
117
118 Justification
119 STLBinaryTables::justification_file_to_enum (int s) const
120 {
121         return file_to_enum (s, _justification_map, "justification code");
122 }
123
124 Comment
125 STLBinaryTables::comment_file_to_enum (int s) const
126 {
127         return file_to_enum (s, _comment_map, "comment code");
128 }
129
130 string
131 STLBinaryTables::language_enum_to_file (Language e) const
132 {
133         return enum_to_file (e, _language_map);
134 }
135
136 int
137 STLBinaryTables::cumulative_status_enum_to_file (CumulativeStatus v) const
138 {
139         return enum_to_file (v, _cumulative_status_map);
140 }
141
142 int
143 STLBinaryTables::justification_enum_to_file (Justification v) const
144 {
145         return enum_to_file (v, _justification_map);
146 }
147
148 int
149 STLBinaryTables::comment_enum_to_file (Comment v) const
150 {
151         return enum_to_file (v, _comment_map);
152 }
153
154 string
155 STLBinaryTables::display_standard_enum_to_description (DisplayStandard v) const
156 {
157         return enum_to_description (v, _display_standard_map);
158 }
159
160 string
161 STLBinaryTables::language_group_enum_to_description (LanguageGroup v) const
162 {
163         return enum_to_description (v, _language_group_map);
164 }
165
166 string
167 STLBinaryTables::language_enum_to_description (Language v) const
168 {
169         return enum_to_description (v, _language_map);
170 }
171
172 string
173 STLBinaryTables::timecode_status_enum_to_description (TimecodeStatus v) const
174 {
175         return enum_to_description (v, _timecode_status_map);
176 }
177
178 string
179 STLBinaryTables::cumulative_status_enum_to_description (CumulativeStatus v) const
180 {
181         return enum_to_description (v, _cumulative_status_map);
182 }
183
184 string
185 STLBinaryTables::justification_enum_to_description (Justification v) const
186 {
187         return enum_to_description (v, _justification_map);
188 }
189
190 string
191 STLBinaryTables::comment_enum_to_description (Comment v) const
192 {
193         return enum_to_description (v, _comment_map);
194 }
195
196 boost::optional<Language>
197 STLBinaryTables::language_description_to_enum (string d) const
198 {
199         return description_to_enum (d, _language_map);
200 }
201
202 STLBinaryTables::STLBinaryTables ()
203 {
204         code<DisplayStandard, string> (_display_standard_map, " ", DISPLAY_STANDARD_UNDEFINED, "Undefined");
205         code<DisplayStandard, string> (_display_standard_map, "0", DISPLAY_STANDARD_OPEN_SUBTITLING, "Open subtitling");
206         code<DisplayStandard, string> (_display_standard_map, "1", DISPLAY_STANDARD_LEVEL_1_TELETEXT, "Level 1 teletext");
207         code<DisplayStandard, string> (_display_standard_map, "2", DISPLAY_STANDARD_LEVEL_2_TELETEXT, "Level 2 teletext");
208
209         code<LanguageGroup, string> (_language_group_map, "00", LANGUAGE_GROUP_LATIN, "Latin");
210         code<LanguageGroup, string> (_language_group_map, "01", LANGUAGE_GROUP_LATIN_CYRILLIC, "Latin/Cyrillic");
211         code<LanguageGroup, string> (_language_group_map, "02", LANGUAGE_GROUP_LATIN_ARABIC, "Latin/Arabic");
212         code<LanguageGroup, string> (_language_group_map, "03", LANGUAGE_GROUP_LATIN_GREEK, "Latin/Greek");
213         code<LanguageGroup, string> (_language_group_map, "04", LANGUAGE_GROUP_LATIN_HEBREW, "Latin/Hebrew");
214         code<LanguageGroup, string> (_language_group_map, "U8", LANGUAGE_GROUP_LATIN_HEBREW, "UTF-8");
215
216         code<Language, string> (_language_map, "00", LANGUAGE_UNKNOWN, "Unknown");
217         code<Language, string> (_language_map, "01", LANGUAGE_ALBANIAN, "Albanian");
218         code<Language, string> (_language_map, "02", LANGUAGE_BRETON, "Breton");
219         code<Language, string> (_language_map, "03", LANGUAGE_CATALAN, "Catalan");
220         code<Language, string> (_language_map, "04", LANGUAGE_CROATIAN, "Croatian");
221         code<Language, string> (_language_map, "05", LANGUAGE_WELSH, "Welsh");
222         code<Language, string> (_language_map, "06", LANGUAGE_CZECH, "Czech");
223         code<Language, string> (_language_map, "07", LANGUAGE_DANISH, "Danish");
224         code<Language, string> (_language_map, "08", LANGUAGE_GERMAN, "German");
225         code<Language, string> (_language_map, "09", LANGUAGE_ENGLISH, "English");
226         code<Language, string> (_language_map, "0A", LANGUAGE_SPANISH, "Spanish");
227         code<Language, string> (_language_map, "0B", LANGUAGE_ESPERANTO, "Esperanto");
228         code<Language, string> (_language_map, "0C", LANGUAGE_ESTONIAN, "Estonian");
229         code<Language, string> (_language_map, "0D", LANGUAGE_BASQUE, "Basque");
230         code<Language, string> (_language_map, "0E", LANGUAGE_FAROESE, "Faroese");
231         code<Language, string> (_language_map, "0F", LANGUAGE_FRENCH, "French");
232         code<Language, string> (_language_map, "10", LANGUAGE_FRISIAN, "Frisian");
233         code<Language, string> (_language_map, "11", LANGUAGE_IRISH, "Irish");
234         code<Language, string> (_language_map, "12", LANGUAGE_GAELIC, "Gaelic");
235         code<Language, string> (_language_map, "13", LANGUAGE_GALACIAN, "Galacian");
236         code<Language, string> (_language_map, "14", LANGUAGE_ICELANDIC, "Icelandic");
237         code<Language, string> (_language_map, "15", LANGUAGE_ITALIAN, "Italian");
238         code<Language, string> (_language_map, "16", LANGUAGE_LAPPISH, "Lappish");
239         code<Language, string> (_language_map, "17", LANGUAGE_LATIN, "Latin");
240         code<Language, string> (_language_map, "18", LANGUAGE_LATVIAN, "Latvian");
241         code<Language, string> (_language_map, "19", LANGUAGE_LUXEMBORGIAN, "Luxemborgian");
242         code<Language, string> (_language_map, "1A", LANGUAGE_LITHUANIAN, "Lithuanian");
243         code<Language, string> (_language_map, "1B", LANGUAGE_HUNGARIAN, "Hungarian");
244         code<Language, string> (_language_map, "1C", LANGUAGE_MALTESE, "Maltese");
245         code<Language, string> (_language_map, "1D", LANGUAGE_DUTCH, "Dutch");
246         code<Language, string> (_language_map, "1E", LANGUAGE_NORWEGIAN, "Norwegian");
247         code<Language, string> (_language_map, "1F", LANGUAGE_OCCITAN, "Occitan");
248         code<Language, string> (_language_map, "20", LANGUAGE_POLISH, "Polish");
249         code<Language, string> (_language_map, "21", LANGUAGE_PORTUGESE, "Portugese");
250         code<Language, string> (_language_map, "22", LANGUAGE_ROMANIAN, "Romanian");
251         code<Language, string> (_language_map, "23", LANGUAGE_ROMANSH, "Romansh");
252         code<Language, string> (_language_map, "24", LANGUAGE_SERBIAN, "Serbian");
253         code<Language, string> (_language_map, "25", LANGUAGE_SLOVAK, "Slovak");
254         code<Language, string> (_language_map, "26", LANGUAGE_SLOVENIAN, "Slovenian");
255         code<Language, string> (_language_map, "27", LANGUAGE_FINNISH, "Finnish");
256         code<Language, string> (_language_map, "28", LANGUAGE_SWEDISH, "Swedish");
257         code<Language, string> (_language_map, "29", LANGUAGE_TURKISH, "Turkish");
258         code<Language, string> (_language_map, "2A", LANGUAGE_FLEMISH, "Flemish");
259         code<Language, string> (_language_map, "2B", LANGUAGE_WALLON, "Wallon");
260         code<Language, string> (_language_map, "7F", LANGUAGE_AMHARIC, "Amharic");
261         code<Language, string> (_language_map, "7E", LANGUAGE_ARABIC, "Arabic");
262         code<Language, string> (_language_map, "7D", LANGUAGE_ARMENIAN, "Armenian");
263         code<Language, string> (_language_map, "7C", LANGUAGE_ASSAMESE, "Assamese");
264         code<Language, string> (_language_map, "7B", LANGUAGE_AZERBAIJANI, "Azerbaijani");
265         code<Language, string> (_language_map, "7A", LANGUAGE_BAMBORA, "Bambora");
266         code<Language, string> (_language_map, "79", LANGUAGE_BIELORUSSIAN, "Bielorussian");
267         code<Language, string> (_language_map, "78", LANGUAGE_BENGALI, "Bengali");
268         code<Language, string> (_language_map, "77", LANGUAGE_BULGARIAN, "Bulgarian");
269         code<Language, string> (_language_map, "76", LANGUAGE_BURMESE, "Burmese");
270         code<Language, string> (_language_map, "75", LANGUAGE_CHINESE, "Chinese");
271         code<Language, string> (_language_map, "74", LANGUAGE_CHURASH, "Churash");
272         code<Language, string> (_language_map, "73", LANGUAGE_DARI, "Dari");
273         code<Language, string> (_language_map, "72", LANGUAGE_FULANI, "Fulani");
274         code<Language, string> (_language_map, "71", LANGUAGE_GEORGIAN, "Georgian");
275         code<Language, string> (_language_map, "70", LANGUAGE_GREEK, "Greek");
276         code<Language, string> (_language_map, "6F", LANGUAGE_GUJURATI, "Gujarati");
277         code<Language, string> (_language_map, "6E", LANGUAGE_GURANI, "Gurani");
278         code<Language, string> (_language_map, "6D", LANGUAGE_HAUSA, "Hausa");
279         code<Language, string> (_language_map, "6C", LANGUAGE_HEBREW, "Hebrew");
280         code<Language, string> (_language_map, "6B", LANGUAGE_HINDI, "Hindi");
281         code<Language, string> (_language_map, "6A", LANGUAGE_INDONESIAN, "Indonesian");
282         code<Language, string> (_language_map, "69", LANGUAGE_JAPANESE, "Japanese");
283         code<Language, string> (_language_map, "68", LANGUAGE_KANNADA, "Kannada");
284         code<Language, string> (_language_map, "67", LANGUAGE_KAZAKH, "Kazakh");
285         code<Language, string> (_language_map, "66", LANGUAGE_KHMER, "Khmer");
286         code<Language, string> (_language_map, "65", LANGUAGE_KOREAN, "Korean");
287         code<Language, string> (_language_map, "64", LANGUAGE_LAOTIAN, "Laotian");
288         code<Language, string> (_language_map, "63", LANGUAGE_MACEDONIAN, "Macedonian");
289         code<Language, string> (_language_map, "62", LANGUAGE_MALAGASAY, "Malagasay");
290         code<Language, string> (_language_map, "61", LANGUAGE_MALAYSIAN, "Malaysian");
291         code<Language, string> (_language_map, "60", LANGUAGE_MOLDAVIAN, "Moldavian");
292         code<Language, string> (_language_map, "5F", LANGUAGE_MARATHI, "Marathi");
293         code<Language, string> (_language_map, "5E", LANGUAGE_NDEBELE, "Ndebele");
294         code<Language, string> (_language_map, "5D", LANGUAGE_NEPALI, "Nepali");
295         code<Language, string> (_language_map, "5C", LANGUAGE_ORIYA, "Oriya");
296         code<Language, string> (_language_map, "5B", LANGUAGE_PAPAMIENTO, "Papamiento");
297         code<Language, string> (_language_map, "5A", LANGUAGE_PERSIAN, "Persian");
298         code<Language, string> (_language_map, "59", LANGUAGE_PUNJABI, "Punjabi");
299         code<Language, string> (_language_map, "58", LANGUAGE_PUSHTU, "Pushtu");
300         code<Language, string> (_language_map, "57", LANGUAGE_QUECHUA, "Quechua");
301         code<Language, string> (_language_map, "56", LANGUAGE_RUSSIAN, "Russian");
302         code<Language, string> (_language_map, "55", LANGUAGE_RUTHENIAN, "Ruthenian");
303         code<Language, string> (_language_map, "54", LANGUAGE_SERBO_CROAT, "Serbo Croat");
304         code<Language, string> (_language_map, "53", LANGUAGE_SHONA, "Shona");
305         code<Language, string> (_language_map, "52", LANGUAGE_SINHALESE, "Sinhalese");
306         code<Language, string> (_language_map, "51", LANGUAGE_SOMALI, "Somali");
307         code<Language, string> (_language_map, "50", LANGUAGE_SRANAN_TONGO, "Sranan Tongo");
308         code<Language, string> (_language_map, "4F", LANGUAGE_SWAHILI, "Swahili");
309         code<Language, string> (_language_map, "4E", LANGUAGE_TADZHIK, "Tadzhik");
310         code<Language, string> (_language_map, "4D", LANGUAGE_TAMIL, "Tamil");
311         code<Language, string> (_language_map, "4C", LANGUAGE_TATAR, "Tatar");
312         code<Language, string> (_language_map, "4B", LANGUAGE_TELUGU, "Telugu");
313         code<Language, string> (_language_map, "4A", LANGUAGE_THAI, "Thai");
314         code<Language, string> (_language_map, "49", LANGUAGE_UKRANIAN, "Ukranian");
315         code<Language, string> (_language_map, "48", LANGUAGE_URDU, "Urdu");
316         code<Language, string> (_language_map, "47", LANGUAGE_UZBEK, "Uzbek");
317         code<Language, string> (_language_map, "46", LANGUAGE_VIETNAMESE, "Vietnamese");
318         code<Language, string> (_language_map, "45", LANGUAGE_ZULU, "Zulu");
319
320         code<TimecodeStatus, string> (_timecode_status_map, "0", TIMECODE_STATUS_NOT_INTENDED_FOR_USE, "Not intended for use");
321         code<TimecodeStatus, string> (_timecode_status_map, "1", TIMECODE_STATUS_INTENDED_FOR_USE, "Intended for use");
322
323         code<CumulativeStatus, int> (_cumulative_status_map, 0, CUMULATIVE_STATUS_NOT_CUMULATIVE, "Not part of a cumulative set");
324         code<CumulativeStatus, int> (_cumulative_status_map, 1, CUMULATIVE_STATUS_FIRST, "First subtitle of a cumulative set");
325         code<CumulativeStatus, int> (_cumulative_status_map, 2, CUMULATIVE_STATUS_INTERMEDIATE, "Intermediate subtitle of a cumulative set");
326         code<CumulativeStatus, int> (_cumulative_status_map, 3, CUMULATIVE_STATUS_LAST, "Last subtitle of a cumulative set");
327
328         code<Justification, int> (_justification_map, 0, JUSTIFICATION_NONE, "No justification");
329         code<Justification, int> (_justification_map, 1, JUSTIFICATION_LEFT, "Left justification");
330         code<Justification, int> (_justification_map, 2, JUSTIFICATION_CENTRE, "Centre justification");
331         code<Justification, int> (_justification_map, 3, JUSTIFICATION_RIGHT, "Right justification");
332
333         code<Comment, int> (_comment_map, 0, COMMENT_NO, "Not a comment");
334         code<Comment, int> (_comment_map, 1, COMMENT_YES, "Is a comment");
335 }