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