6b06d1f55cb47403f9384ca8178182b218f86e06
[lms] / lightmediascanner / src / plugins / asf / asf.c
1 /**
2  * Copyright (C) 2008 by INdT
3  *
4  * This program is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public License
6  * as published by the Free Software Foundation; either version 2
7  * of the License, or (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 Lesser General Public License
15  * along with this program; if not, write to the Free Software
16  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
17  *
18  * @author Andre Moreira Magalhaes <andre.magalhaes@openbossa.org>
19  */
20
21 /**
22  * @brief
23  *
24  * asf/wma file parser.
25  */
26
27 #ifdef HAVE_CONFIG_H
28 #include "config.h"
29 #endif
30
31 #include <lightmediascanner_plugin.h>
32 #include <lightmediascanner_db.h>
33 #include <sys/types.h>
34 #include <sys/stat.h>
35 #include <fcntl.h>
36 #include <stdio.h>
37 #include <stdlib.h>
38 #include <string.h>
39 #include <unistd.h>
40
41 enum StreamTypes {
42     STREAM_TYPE_UNKNOWN = 0,
43     STREAM_TYPE_AUDIO,
44     STREAM_TYPE_VIDEO
45 };
46
47 enum AttributeTypes {
48     ATTR_TYPE_UNICODE = 0,
49     ATTR_TYPE_BYTES,
50     ATTR_TYPE_BOOL,
51     ATTR_TYPE_DWORD,
52     ATTR_TYPE_QWORD,
53     ATTR_TYPE_WORD,
54     ATTR_TYPE_GUID
55 };
56
57 struct asf_info {
58     struct lms_string_size title;
59     struct lms_string_size artist;
60     struct lms_string_size album;
61     struct lms_string_size genre;
62     unsigned char trackno;
63 };
64
65 struct plugin {
66     struct lms_plugin plugin;
67     lms_db_audio_t *audio_db;
68     lms_db_video_t *video_db;
69     lms_charset_conv_t *cs_conv;
70 };
71
72 static const char _name[] = "asf";
73 static const struct lms_string_size _exts[] = {
74     LMS_STATIC_STRING_SIZE(".wma"),
75     LMS_STATIC_STRING_SIZE(".wmv"),
76     LMS_STATIC_STRING_SIZE(".asf")
77 };
78
79 /* ASF GUIDs
80  *
81  * Microsoft defines these 16-byte (128-bit) GUIDs as:
82  * first 8 bytes are in little-endian order
83  * next 8 bytes are in big-endian order
84  *
85  * Eg.: AaBbCcDd-EeFf-GgHh-IiJj-KkLlMmNnOoPp:
86  *
87  * to convert to byte string do as follow:
88  *
89  * $Dd $Cc $Bb $Aa $Ff $Ee $Hh $Gg $Ii $Jj $Kk $Ll $Mm $Nn $Oo $Pp
90  *
91  * See http://www.microsoft.com/windows/windowsmedia/forpros/format/asfspec.aspx
92  */
93 static const char header_guid[16] = "\x30\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C";
94 static const char file_properties_guid[16] = "\xA1\xDC\xAB\x8C\x47\xA9\xCF\x11\x8E\xE4\x00\xC0\x0C\x20\x53\x65";
95 static const char stream_properties_guid[16] = "\x91\x07\xDC\xB7\xB7\xA9\xCF\x11\x8E\xE6\x00\xC0\x0C\x20\x53\x65";
96 static const char stream_type_audio_guid[16] = "\x40\x9E\x69\xF8\x4D\x5B\xCF\x11\xA8\xFD\x00\x80\x5F\x5C\x44\x2B";
97 static const char stream_type_video_guid[16] = "\xC0\xEF\x19\xBC\x4D\x5B\xCF\x11\xA8\xFD\x00\x80\x5F\x5C\x44\x2B";
98 static const char content_description_guid[16] = "\x33\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C";
99 static const char extended_content_description_guid[16] = "\x40\xA4\xD0\xD2\x07\xE3\xD2\x11\x97\xF0\x00\xA0\xC9\x5E\xA8\x50";
100 static const char header_extension_guid[16] = "\xb5\x03\xbf_.\xa9\xcf\x11\x8e\xe3\x00\xc0\x0c Se";
101 static const char metadata_guid[16] = "\xEA\xCB\xF8\xC5\xAF[wH\204g\xAA\214D\xFAL\xCA";
102 static const char metadata_library_guid[16] = "\224\034#D\230\224\321I\241A\x1d\x13NEpT";
103 static const char content_encryption_object_guid[16] = "\xFB\xB3\x11\x22\x23\xBD\xD2\x11\xB4\xB7\x00\xA0\xC9\x55\xFC\x6E";
104 static const char extended_content_encryption_object_guid[16] = "\x14\xE6\x8A\x29\x22\x26\x17\x4C\xB9\x35\xDA\xE0\x7E\xE9\x28\x9C";
105
106 static const char attr_name_wm_album_title[26] = "\x57\x00\x4d\x00\x2f\x00\x41\x00\x6c\x00\x62\x00\x75\x00\x6d\x00\x54\x00\x69\x00\x74\x00\x6c\x00\x65\x00";
107 static const char attr_name_wm_genre[16] = "\x57\x00\x4d\x00\x2f\x00\x47\x00\x65\x00\x6e\x00\x72\x00\x65\x00";
108 static const char attr_name_wm_track_number[28] = "\x57\x00\x4d\x00\x2f\x00\x54\x00\x72\x00\x61\x00\x63\x00\x6b\x00\x4e\x00\x75\x00\x6d\x00\x62\x00\x65\x00\x72\x00";
109
110 static long long
111 _to_number(const char *data, unsigned int type_size, unsigned int data_size)
112 {
113     long long sum = 0;
114     unsigned int last, i;
115
116     last = data_size > type_size ? type_size : data_size;
117
118     for (i = 0; i < last; i++)
119         sum |= (unsigned char) (data[i]) << (i * 8);
120
121     return sum;
122 }
123
124 static short
125 _read_word(int fd)
126 {
127     char v[2];
128     if (read(fd, &v, 2) != 2)
129         return 0;
130     return (short) _to_number(v, sizeof(unsigned short), 2);
131 }
132
133 static unsigned int
134 _read_dword(int fd)
135 {
136     char v[4];
137     if (read(fd, &v, 4) != 4)
138         return 0;
139     return (unsigned int) _to_number(v, sizeof(unsigned int), 4);
140 }
141
142 static long long
143 _read_qword(int fd)
144 {
145     char v[8];
146     if (read(fd, &v, 8) != 8)
147         return 0;
148     return _to_number(v, sizeof(unsigned long long), 8);
149 }
150
151 static int
152 _read_string(int fd, size_t count, char **str, size_t *len)
153 {
154     char *data;
155     size_t data_size, size;
156
157     if (!str) {
158         lseek(fd, count, SEEK_CUR);
159         return 0;
160     }
161
162     data = malloc(sizeof(char) * count);
163     data_size = read(fd, data, count);
164     if (data_size == -1) {
165         free(data);
166         return -1;
167     }
168
169     size = data_size;
170     while (size >= 2) {
171         if (data[size - 1] != '\0' || data[size - 2] != '\0')
172             break;
173         size -= 2;
174     }
175
176     *str = data;
177     *len = size;
178
179     return 0;
180 }
181
182 static void
183 _parse_content_description(lms_charset_conv_t *cs_conv, int fd, struct asf_info *info)
184 {
185     int title_length = _read_word(fd);
186     int artist_length = _read_word(fd);
187     int copyright_length = _read_word(fd);
188     int comment_length = _read_word(fd);
189     int rating_length = _read_word(fd);
190
191     _read_string(fd, title_length, &info->title.str, &info->title.len);
192     lms_charset_conv_force(cs_conv, &info->title.str, &info->title.len);
193     _read_string(fd, artist_length, &info->artist.str, &info->artist.len);
194     lms_charset_conv_force(cs_conv, &info->artist.str, &info->artist.len);
195     /* ignore copyright, comment and rating */
196     lseek(fd, copyright_length + comment_length + rating_length, SEEK_CUR);
197 }
198
199 static void
200 _parse_attribute_name(int fd,
201                       int kind,
202                       char **attr_name,
203                       size_t *attr_name_len,
204                       int *attr_type,
205                       int *attr_size)
206 {
207     int attr_name_length;
208
209     /* extended content descriptor */
210     if (kind == 0) {
211         attr_name_length = _read_word(fd);
212         _read_string(fd, attr_name_length, attr_name, attr_name_len);
213         *attr_type = _read_word(fd);
214         *attr_size = _read_word(fd);
215     }
216     /* metadata & metadata library */
217     else {
218         lseek(fd, 2 + 2, SEEK_CUR); /* language and stream */
219         attr_name_length = _read_word(fd);
220         *attr_type = _read_word(fd);
221         *attr_size = _read_dword(fd);
222         _read_string(fd, attr_name_length, attr_name, attr_name_len);
223     }
224 }
225
226 static void
227 _parse_attribute_string_data(lms_charset_conv_t *cs_conv,
228                              int fd,
229                              int attr_size,
230                              char **attr_data,
231                              size_t *attr_data_len)
232 {
233     _read_string(fd, attr_size, attr_data, attr_data_len);
234     lms_charset_conv_force(cs_conv, attr_data, attr_data_len);
235 }
236
237 static void
238 _skip_attribute_data(int fd, int kind, int attr_type, int attr_size)
239 {
240     switch (attr_type) {
241     case ATTR_TYPE_WORD:
242         lseek(fd, 2, SEEK_CUR);
243         break;
244
245     case ATTR_TYPE_BOOL:
246         if (kind == 0)
247             lseek(fd, 4, SEEK_CUR);
248         else
249             lseek(fd, 2, SEEK_CUR);
250         break;
251
252     case ATTR_TYPE_DWORD:
253         lseek(fd, 4, SEEK_CUR);
254         break;
255
256     case ATTR_TYPE_QWORD:
257         lseek(fd, 8, SEEK_CUR);
258         break;
259
260     case ATTR_TYPE_UNICODE:
261     case ATTR_TYPE_BYTES:
262     case ATTR_TYPE_GUID:
263         lseek(fd, attr_size, SEEK_CUR);
264         break;
265
266     default:
267         break;
268     }
269 }
270
271 static void
272 _skip_attribute(int fd, int kind)
273 {
274     int attr_type, attr_size;
275     _parse_attribute_name(fd, kind, NULL, NULL, &attr_type, &attr_size);
276     _skip_attribute_data(fd, kind, attr_type, attr_size);
277 }
278
279 static void
280 _parse_extended_content_description_object(lms_charset_conv_t *cs_conv, int fd, struct asf_info *info)
281 {
282     int count = _read_word(fd);
283     char *attr_name;
284     size_t attr_name_len;
285     int attr_type, attr_size;
286     while (count--) {
287         attr_name = NULL;
288         _parse_attribute_name(fd, 0,
289                               &attr_name, &attr_name_len,
290                               &attr_type, &attr_size);
291         if (attr_type == ATTR_TYPE_UNICODE) {
292             if (memcmp(attr_name, attr_name_wm_album_title, attr_name_len) == 0)
293                 _parse_attribute_string_data(cs_conv,
294                                              fd, attr_size,
295                                              &info->album.str,
296                                              &info->album.len);
297             else if (memcmp(attr_name, attr_name_wm_genre, attr_name_len) == 0)
298                 _parse_attribute_string_data(cs_conv,
299                                              fd, attr_size,
300                                              &info->genre.str,
301                                              &info->genre.len);
302             else if (memcmp(attr_name, attr_name_wm_track_number, attr_name_len) == 0) {
303                 char *trackno;
304                 size_t trackno_len;
305                 _parse_attribute_string_data(cs_conv,
306                                              fd, attr_size,
307                                              &trackno,
308                                              &trackno_len);
309                 if (trackno) {
310                     info->trackno = atoi(trackno);
311                     free(trackno);
312                 }
313             }
314             else
315                 _skip_attribute_data(fd, 0, attr_type, attr_size);
316         }
317         else
318             _skip_attribute_data(fd, 0, attr_type, attr_size);
319         if (attr_name)
320             free(attr_name);
321     }
322 }
323
324 static void
325 _skip_metadata(int fd)
326 {
327     int count = _read_word(fd);
328     while (count--)
329         _skip_attribute(fd, 1);
330 }
331
332 static void
333 _skip_metadata_library(int fd)
334 {
335     int count = _read_word(fd);
336     while (count--)
337         _skip_attribute(fd, 2);
338 }
339
340 static void
341 _skip_header_extension(int fd)
342 {
343     char guid[16];
344     long long size, data_size, data_pos;
345
346     lseek(fd, 18, SEEK_CUR);
347     data_size = _read_dword(fd);
348     data_pos = 0;
349     while (data_pos < data_size) {
350         read(fd, &guid, 16);
351         size = _read_qword(fd);
352         if (size == 0)
353             break;
354         if (memcmp(guid, metadata_guid, 16) == 0)
355             _skip_metadata(fd);
356         else if (memcmp(guid, metadata_library_guid, 16) == 0)
357             _skip_metadata_library(fd);
358         else
359             lseek(fd, size - 24, SEEK_CUR);
360         data_pos += size;
361     }
362 }
363
364 static void
365 _strstrip(char **str, unsigned int *p_len)
366 {
367     if (*str)
368         lms_strstrip(*str, p_len);
369
370     if (*p_len == 0 && *str) {
371         free(*str);
372         *str = NULL;
373     }
374 }
375
376 static void *
377 _match(struct plugin *p, const char *path, int len, int base)
378 {
379     int i;
380
381     i = lms_which_extension(path, len, _exts, LMS_ARRAY_SIZE(_exts));
382     if (i < 0)
383       return NULL;
384     else
385       return (void*)(i + 1);
386 }
387
388 static int
389 _parse(struct plugin *plugin, struct lms_context *ctxt, const struct lms_file_info *finfo, void *match)
390 {
391     struct asf_info info = {{0}, {0}, {0}, {0}, 0};
392     struct lms_audio_info audio_info = {0};
393     struct lms_video_info video_info = {0};
394     int r, fd, num_objects, i;
395     char guid[16];
396     unsigned int size;
397     int stream_type = STREAM_TYPE_UNKNOWN;
398
399     fd = open(finfo->path, O_RDONLY);
400     if (fd < 0) {
401         perror("open");
402         return -1;
403     }
404
405     if (read(fd, &guid, 16) != 16) {
406         perror("read");
407         r = -2;
408         goto done;
409     }
410     if (memcmp(guid, header_guid, 16) != 0) {
411         fprintf(stderr, "ERROR: invalid header (%s).\n", finfo->path);
412         r = -3;
413         goto done;
414     }
415
416     size = _read_qword(fd);
417     num_objects = _read_dword(fd);
418
419     lseek(fd, 2, SEEK_CUR);
420
421     for (i = 0; i < num_objects; ++i) {
422         read(fd, &guid, 16);
423         size = _read_qword(fd);
424
425         if (memcmp(guid, file_properties_guid, 16) == 0)
426             lseek(fd, size - 24, SEEK_CUR);
427         else if (memcmp(guid, stream_properties_guid, 16) == 0) {
428             read(fd, &guid, 16);
429             if (memcmp(guid, stream_type_audio_guid, 16) == 0)
430                 stream_type = STREAM_TYPE_AUDIO;
431             else if (memcmp(guid, stream_type_video_guid, 16) == 0)
432                 stream_type = STREAM_TYPE_VIDEO;
433             lseek(fd, size - 40, SEEK_CUR);
434         }
435         else if (memcmp(guid, content_description_guid, 16) == 0)
436             _parse_content_description(plugin->cs_conv, fd, &info);
437         else if (memcmp(guid, extended_content_description_guid, 16) == 0)
438             _parse_extended_content_description_object(plugin->cs_conv, fd, &info);
439         else if (memcmp(guid, header_extension_guid, 16) == 0)
440             _skip_header_extension(fd);
441         else if (memcmp(guid, content_encryption_object_guid, 16) == 0 ||
442                  memcmp(guid, extended_content_encryption_object_guid, 16) == 0) {
443             /* ignore DRM'd files */
444             fprintf(stderr, "ERROR: ignoring DRM'd file %s\n", finfo->path);
445             r = -4;
446             goto done;
447         }
448         else
449             lseek(fd, size - 24, SEEK_CUR);
450     }
451
452     /* try to define stream type by extension */
453     if (stream_type == STREAM_TYPE_UNKNOWN) {
454         int ext_idx = ((int)match) - 1;
455         if (strcmp(_exts[ext_idx].str, ".wma") == 0)
456             stream_type = STREAM_TYPE_AUDIO;
457         /* consider wmv and asf as video */
458         else
459             stream_type = STREAM_TYPE_VIDEO;
460     }
461
462     _strstrip(&info.title.str, &info.title.len);
463     _strstrip(&info.artist.str, &info.artist.len);
464     _strstrip(&info.album.str, &info.album.len);
465     _strstrip(&info.genre.str, &info.genre.len);
466
467     if (!info.title.str) {
468         int ext_idx;
469         ext_idx = ((int)match) - 1;
470         info.title.len = finfo->path_len - finfo->base - _exts[ext_idx].len;
471         info.title.str = malloc((info.title.len + 1) * sizeof(char));
472         memcpy(info.title.str, finfo->path + finfo->base, info.title.len);
473         info.title.str[info.title.len] = '\0';
474         lms_charset_conv(ctxt->cs_conv, &info.title.str, &info.title.len);
475     }
476
477 #if 0
478     fprintf(stderr, "file %s info\n", finfo->path);
479     fprintf(stderr, "\ttitle='%s'\n", info.title.str);
480     fprintf(stderr, "\tartist='%s'\n", info.artist.str);
481     fprintf(stderr, "\talbum='%s'\n", info.album.str);
482     fprintf(stderr, "\tgenre='%s'\n", info.genre.str);
483     fprintf(stderr, "\ttrackno=%d\n", info.trackno);
484 #endif
485
486     if (stream_type == STREAM_TYPE_AUDIO) {
487         audio_info.id = finfo->id;
488         audio_info.title = info.title;
489         audio_info.artist = info.artist;
490         audio_info.album = info.album;
491         audio_info.genre = info.genre;
492         audio_info.trackno = info.trackno;
493         r = lms_db_audio_add(plugin->audio_db, &audio_info);
494     }
495     else {
496         video_info.id = finfo->id;
497         video_info.title = info.title;
498         video_info.artist = info.artist;
499         r = lms_db_video_add(plugin->video_db, &video_info);
500     }
501
502   done:
503     if (info.title.str)
504         free(info.title.str);
505     if (info.artist.str)
506         free(info.artist.str);
507     if (info.album.str)
508         free(info.album.str);
509     if (info.genre.str)
510         free(info.genre.str);
511
512     posix_fadvise(fd, 0, 0, POSIX_FADV_DONTNEED);
513     close(fd);
514
515     return r;
516 }
517
518 static int
519 _setup(struct plugin *plugin, struct lms_context *ctxt)
520 {
521     plugin->audio_db = lms_db_audio_new(ctxt->db);
522     if (!plugin->audio_db)
523         return -1;
524     plugin->video_db = lms_db_video_new(ctxt->db);
525     if (!plugin->video_db)
526         return -1;
527     plugin->cs_conv = lms_charset_conv_new();
528     if (!plugin->cs_conv)
529         return -1;
530     lms_charset_conv_add(plugin->cs_conv, "UTF-16LE");
531
532     return 0;
533 }
534
535 static int
536 _start(struct plugin *plugin, struct lms_context *ctxt)
537 {
538     int r;
539     r = lms_db_audio_start(plugin->audio_db);
540     r |= lms_db_video_start(plugin->video_db);
541     return r;
542 }
543
544 static int
545 _finish(struct plugin *plugin, struct lms_context *ctxt)
546 {
547     if (plugin->audio_db)
548         lms_db_audio_free(plugin->audio_db);
549     if (plugin->video_db)
550         lms_db_video_free(plugin->video_db);
551     if (plugin->cs_conv)
552         lms_charset_conv_free(plugin->cs_conv);
553
554     return 0;
555 }
556
557 static int
558 _close(struct plugin *plugin)
559 {
560     free(plugin);
561     return 0;
562 }
563
564 API struct lms_plugin *
565 lms_plugin_open(void)
566 {
567     struct plugin *plugin;
568
569     plugin = (struct plugin *)malloc(sizeof(*plugin));
570     plugin->plugin.name = _name;
571     plugin->plugin.match = (lms_plugin_match_fn_t)_match;
572     plugin->plugin.parse = (lms_plugin_parse_fn_t)_parse;
573     plugin->plugin.close = (lms_plugin_close_fn_t)_close;
574     plugin->plugin.setup = (lms_plugin_setup_fn_t)_setup;
575     plugin->plugin.start = (lms_plugin_start_fn_t)_start;
576     plugin->plugin.finish = (lms_plugin_finish_fn_t)_finish;
577
578     return (struct lms_plugin *)plugin;
579 }