2 * Copyright (C) 2008 by INdT
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.
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.
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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * @author Andre Moreira Magalhaes <andre.magalhaes@openbossa.org>
24 * asf/wma file parser.
27 #define _XOPEN_SOURCE 600
29 #include <lightmediascanner_plugin.h>
30 #include <lightmediascanner_db.h>
33 #include <sys/types.h>
41 #define NSEC100_PER_SEC 10000000ULL
42 #define MSEC_PER_SEC 1000ULL
45 STREAM_TYPE_UNKNOWN = 0,
51 ATTR_TYPE_UNICODE = 0,
61 struct lms_string_size title;
62 struct lms_string_size artist;
63 struct lms_string_size album;
64 struct lms_string_size genre;
65 unsigned char trackno;
69 struct lms_plugin plugin;
70 lms_db_audio_t *audio_db;
71 lms_db_video_t *video_db;
72 lms_charset_conv_t *cs_conv;
75 static const char _name[] = "asf";
76 static const struct lms_string_size _container = LMS_STATIC_STRING_SIZE("asf");
77 static const struct lms_string_size _exts[] = {
78 LMS_STATIC_STRING_SIZE(".wma"),
79 LMS_STATIC_STRING_SIZE(".wmv"),
80 LMS_STATIC_STRING_SIZE(".asf")
82 static const char *_cats[] = {
87 static const char *_authors[] = {
88 "Andre Moreira Magalhaes",
94 enum StreamTypes type;
100 uint32_t sampling_rate;
106 /* TODO: Add the gazillion of possible codecs -- possibly a task to gperf */
107 static const struct {
109 struct lms_string_size name;
111 { 0x0160, LMS_STATIC_STRING_SIZE("wmav1") },
112 { 0x0161, LMS_STATIC_STRING_SIZE("wmav2") },
113 { 0x0162, LMS_STATIC_STRING_SIZE("wmavpro") },
114 { 0x0163, LMS_STATIC_STRING_SIZE("wmavlossless") },
115 { 0x1600, LMS_STATIC_STRING_SIZE("aac") },
116 { 0x706d, LMS_STATIC_STRING_SIZE("aac") },
117 { 0x4143, LMS_STATIC_STRING_SIZE("aac") },
118 { 0xA106, LMS_STATIC_STRING_SIZE("aac") },
119 { 0xF1AC, LMS_STATIC_STRING_SIZE("flac") },
120 { 0x0055, LMS_STATIC_STRING_SIZE("mp3") },
126 * Microsoft defines these 16-byte (128-bit) GUIDs as:
127 * first 8 bytes are in little-endian order
128 * next 8 bytes are in big-endian order
130 * Eg.: AaBbCcDd-EeFf-GgHh-IiJj-KkLlMmNnOoPp:
132 * to convert to byte string do as follow:
134 * $Dd $Cc $Bb $Aa $Ff $Ee $Hh $Gg $Ii $Jj $Kk $Ll $Mm $Nn $Oo $Pp
136 * See http://www.microsoft.com/windows/windowsmedia/forpros/format/asfspec.aspx
138 static const char header_guid[16] = "\x30\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C";
139 static const char file_properties_guid[16] = "\xA1\xDC\xAB\x8C\x47\xA9\xCF\x11\x8E\xE4\x00\xC0\x0C\x20\x53\x65";
140 static const char stream_properties_guid[16] = "\x91\x07\xDC\xB7\xB7\xA9\xCF\x11\x8E\xE6\x00\xC0\x0C\x20\x53\x65";
141 static const char stream_type_audio_guid[16] = "\x40\x9E\x69\xF8\x4D\x5B\xCF\x11\xA8\xFD\x00\x80\x5F\x5C\x44\x2B";
142 static const char stream_type_video_guid[16] = "\xC0\xEF\x19\xBC\x4D\x5B\xCF\x11\xA8\xFD\x00\x80\x5F\x5C\x44\x2B";
143 static const char content_description_guid[16] = "\x33\x26\xB2\x75\x8E\x66\xCF\x11\xA6\xD9\x00\xAA\x00\x62\xCE\x6C";
144 static const char extended_content_description_guid[16] = "\x40\xA4\xD0\xD2\x07\xE3\xD2\x11\x97\xF0\x00\xA0\xC9\x5E\xA8\x50";
145 static const char header_extension_guid[16] = "\xb5\x03\xbf_.\xa9\xcf\x11\x8e\xe3\x00\xc0\x0c Se";
146 static const char metadata_guid[16] = "\xEA\xCB\xF8\xC5\xAF[wH\204g\xAA\214D\xFAL\xCA";
147 static const char metadata_library_guid[16] = "\224\034#D\230\224\321I\241A\x1d\x13NEpT";
148 static const char content_encryption_object_guid[16] = "\xFB\xB3\x11\x22\x23\xBD\xD2\x11\xB4\xB7\x00\xA0\xC9\x55\xFC\x6E";
149 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";
151 static const char attr_name_wm_album_artist[28] = "\x57\x00\x4d\x00\x2f\x00\x41\x00\x6c\x00\x62\x00\x75\x00\x6d\x00\x41\x00\x72\x00\x74\x00\x69\x00\x73\x00\x74\x00";
152 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";
153 static const char attr_name_wm_genre[16] = "\x57\x00\x4d\x00\x2f\x00\x47\x00\x65\x00\x6e\x00\x72\x00\x65\x00";
154 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";
157 _to_number(const char *data, unsigned int type_size, unsigned int data_size)
160 unsigned int last, i;
162 last = data_size > type_size ? type_size : data_size;
164 for (i = 0; i < last; i++)
165 sum |= (unsigned char) (data[i]) << (i * 8);
174 if (read(fd, &v, 2) != 2)
176 return (short) _to_number(v, sizeof(unsigned short), 2);
183 if (read(fd, &v, 4) != 4)
185 return (unsigned int) _to_number(v, sizeof(unsigned int), 4);
192 if (read(fd, &v, 8) != 8)
194 return _to_number(v, sizeof(unsigned long long), 8);
198 _read_string(int fd, size_t count, char **str, unsigned int *len)
201 ssize_t data_size, size;
203 data = malloc(sizeof(char) * count);
204 data_size = read(fd, data, count);
205 if (data_size == -1) {
212 if (data[size - 1] != '\0' || data[size - 2] != '\0')
224 _parse_file_properties(lms_charset_conv_t *cs_conv, int fd,
225 struct lms_audio_info *info)
230 uint64_t creation_date;
231 uint64_t data_packets_count;
232 uint64_t play_duration;
233 uint64_t send_duration;
236 uint32_t min_data_packet_size;
237 uint32_t max_data_packet_size;
238 uint32_t max_bitrate;
239 } __attribute__((packed)) props;
242 r = read(fd, &props, sizeof(props));
243 if (r != sizeof(props))
247 if (le32toh(props.flags) & 0x1)
250 /* ASF spec 01.20.06 sec. 3.2: we need to subtract the preroll value from
251 * the duration in order to obtain the real duration */
252 info->length = (unsigned int)((le64toh(props.play_duration) / NSEC100_PER_SEC)
253 - le64toh(props.preroll) / MSEC_PER_SEC);
258 static struct lms_string_size
259 _codec_id_to_str(uint16_t id)
263 for (i = 0; _codecs[i].name.str != NULL; i++)
264 if (_codecs[i].id == id)
265 return _codecs[i].name;
267 return _codecs[i].name;
271 _parse_stream_properties(int fd, struct stream **pstream)
274 char stream_type[16];
275 char error_correction_type[16];
276 uint64_t time_offset;
277 uint32_t type_specific_len;
278 uint32_t error_correction_data_len;
280 uint32_t reserved; /* don't use, unaligned */
281 } __attribute__((packed)) props;
288 s = calloc(1, sizeof(struct stream));
292 r = read(fd, &props, sizeof(props));
293 if (r != sizeof(props))
296 if (memcmp(props.stream_type, stream_type_audio_guid, 16) == 0)
297 s->type = STREAM_TYPE_AUDIO;
298 else if (memcmp(props.stream_type, stream_type_video_guid, 16) == 0)
299 s->type = STREAM_TYPE_VIDEO;
305 s->id = le16toh(props.flags) & 0x7F;
306 /* Not a valid stream */
310 if (s->type == STREAM_TYPE_AUDIO) {
311 if (le32toh(props.type_specific_len) < 18)
314 s->audio.codec_id = _read_word(fd);
315 s->audio.channels = _read_word(fd);
316 s->audio.sampling_rate = _read_dword(fd);
317 s->audio.byterate = _read_dword(fd);
331 _parse_content_description(lms_charset_conv_t *cs_conv, int fd, struct asf_info *info)
333 int title_length = _read_word(fd);
334 int artist_length = _read_word(fd);
335 int copyright_length = _read_word(fd);
336 int comment_length = _read_word(fd);
337 int rating_length = _read_word(fd);
339 _read_string(fd, title_length, &info->title.str, &info->title.len);
340 lms_charset_conv_force(cs_conv, &info->title.str, &info->title.len);
341 _read_string(fd, artist_length, &info->artist.str, &info->artist.len);
342 lms_charset_conv_force(cs_conv, &info->artist.str, &info->artist.len);
343 /* ignore copyright, comment and rating */
344 lseek(fd, copyright_length + comment_length + rating_length, SEEK_CUR);
348 _parse_attribute_name(int fd,
350 unsigned int *attr_name_len,
354 int attr_name_length;
356 attr_name_length = _read_word(fd);
357 _read_string(fd, attr_name_length, attr_name, attr_name_len);
358 *attr_type = _read_word(fd);
359 *attr_size = _read_word(fd);
363 _parse_attribute_string_data(lms_charset_conv_t *cs_conv,
367 unsigned int *attr_data_len)
369 _read_string(fd, attr_size, attr_data, attr_data_len);
370 lms_charset_conv_force(cs_conv, attr_data, attr_data_len);
374 _skip_attribute_data(int fd, int kind, int attr_type, int attr_size)
378 lseek(fd, 2, SEEK_CUR);
383 lseek(fd, 4, SEEK_CUR);
385 lseek(fd, 2, SEEK_CUR);
388 case ATTR_TYPE_DWORD:
389 lseek(fd, 4, SEEK_CUR);
392 case ATTR_TYPE_QWORD:
393 lseek(fd, 8, SEEK_CUR);
396 case ATTR_TYPE_UNICODE:
397 case ATTR_TYPE_BYTES:
399 lseek(fd, attr_size, SEEK_CUR);
408 _parse_extended_content_description_object(lms_charset_conv_t *cs_conv, int fd, struct asf_info *info)
410 int count = _read_word(fd);
412 unsigned int attr_name_len;
413 int attr_type, attr_size;
416 _parse_attribute_name(fd,
417 &attr_name, &attr_name_len,
418 &attr_type, &attr_size);
419 if (attr_type == ATTR_TYPE_UNICODE) {
420 if (memcmp(attr_name, attr_name_wm_album_title, attr_name_len) == 0)
421 _parse_attribute_string_data(cs_conv,
425 else if (memcmp(attr_name, attr_name_wm_genre, attr_name_len) == 0)
426 _parse_attribute_string_data(cs_conv,
430 else if (memcmp(attr_name, attr_name_wm_album_artist, attr_name_len) == 0)
431 _parse_attribute_string_data(cs_conv,
435 else if (memcmp(attr_name, attr_name_wm_track_number, attr_name_len) == 0) {
437 unsigned int trackno_len;
438 _parse_attribute_string_data(cs_conv,
443 info->trackno = atoi(trackno);
448 _skip_attribute_data(fd, 0, attr_type, attr_size);
451 _skip_attribute_data(fd, 0, attr_type, attr_size);
457 _match(struct plugin *p, const char *path, int len, int base)
461 i = lms_which_extension(path, len, _exts, LMS_ARRAY_SIZE(_exts));
465 return (void*)(i + 1);
469 _parse(struct plugin *plugin, struct lms_context *ctxt, const struct lms_file_info *finfo, void *match)
471 struct asf_info info = { };
472 struct lms_audio_info audio_info = { };
473 struct lms_video_info video_info = { };
474 int r, fd, num_objects, i;
477 int stream_type = STREAM_TYPE_UNKNOWN;
478 struct stream *streams = NULL;
480 fd = open(finfo->path, O_RDONLY);
486 if (read(fd, &guid, 16) != 16) {
491 if (memcmp(guid, header_guid, 16) != 0) {
492 fprintf(stderr, "ERROR: invalid header (%s).\n", finfo->path);
497 size = _read_qword(fd);
498 num_objects = _read_dword(fd);
500 lseek(fd, 2, SEEK_CUR);
502 for (i = 0; i < num_objects; ++i) {
504 size = _read_qword(fd);
506 if (memcmp(guid, file_properties_guid, 16) == 0) {
507 r = _parse_file_properties(plugin->cs_conv, fd, &audio_info);
510 lseek(fd, size - (24 + r), SEEK_CUR);
511 } else if (memcmp(guid, stream_properties_guid, 16) == 0) {
513 r = _parse_stream_properties(fd, &s);
517 lseek(fd, size - (24 + r), SEEK_CUR);
521 if (stream_type != STREAM_TYPE_VIDEO)
522 stream_type = s->type;
526 } else if (memcmp(guid, content_description_guid, 16) == 0)
527 _parse_content_description(plugin->cs_conv, fd, &info);
528 else if (memcmp(guid, extended_content_description_guid, 16) == 0)
529 _parse_extended_content_description_object(plugin->cs_conv, fd, &info);
530 else if (memcmp(guid, content_encryption_object_guid, 16) == 0 ||
531 memcmp(guid, extended_content_encryption_object_guid, 16) == 0) {
532 /* ignore DRM'd files */
533 fprintf(stderr, "ERROR: ignoring DRM'd file %s\n", finfo->path);
537 lseek(fd, size - 24, SEEK_CUR);
540 /* try to define stream type by extension */
541 if (stream_type == STREAM_TYPE_UNKNOWN) {
542 long ext_idx = ((long)match) - 1;
543 if (strcmp(_exts[ext_idx].str, ".wma") == 0)
544 stream_type = STREAM_TYPE_AUDIO;
545 /* consider wmv and asf as video */
547 stream_type = STREAM_TYPE_VIDEO;
550 lms_string_size_strip_and_free(&info.title);
551 lms_string_size_strip_and_free(&info.artist);
552 lms_string_size_strip_and_free(&info.album);
553 lms_string_size_strip_and_free(&info.genre);
555 if (!info.title.str) {
557 ext_idx = ((long)match) - 1;
558 info.title.len = finfo->path_len - finfo->base - _exts[ext_idx].len;
559 info.title.str = malloc((info.title.len + 1) * sizeof(char));
560 memcpy(info.title.str, finfo->path + finfo->base, info.title.len);
561 info.title.str[info.title.len] = '\0';
562 lms_charset_conv(ctxt->cs_conv, &info.title.str, &info.title.len);
566 fprintf(stderr, "file %s info\n", finfo->path);
567 fprintf(stderr, "\ttitle='%s'\n", info.title.str);
568 fprintf(stderr, "\tartist='%s'\n", info.artist.str);
569 fprintf(stderr, "\talbum='%s'\n", info.album.str);
570 fprintf(stderr, "\tgenre='%s'\n", info.genre.str);
571 fprintf(stderr, "\ttrackno=%d\n", info.trackno);
574 audio_info.container = _container;
576 if (stream_type == STREAM_TYPE_AUDIO) {
577 audio_info.id = finfo->id;
578 audio_info.title = info.title;
579 audio_info.artist = info.artist;
580 audio_info.album = info.album;
581 audio_info.genre = info.genre;
582 audio_info.trackno = info.trackno;
584 audio_info.channels = streams->audio.channels;
585 audio_info.bitrate = streams->audio.byterate * 8;
586 audio_info.sampling_rate = streams->audio.sampling_rate;
587 audio_info.codec = _codec_id_to_str(streams->audio.codec_id);
589 r = lms_db_audio_add(plugin->audio_db, &audio_info);
591 video_info.id = finfo->id;
592 video_info.title = info.title;
593 video_info.artist = info.artist;
594 r = lms_db_video_add(plugin->video_db, &video_info);
599 struct stream *s = streams;
604 free(info.title.str);
605 free(info.artist.str);
606 free(info.album.str);
607 free(info.genre.str);
609 posix_fadvise(fd, 0, 0, POSIX_FADV_DONTNEED);
616 _setup(struct plugin *plugin, struct lms_context *ctxt)
618 plugin->audio_db = lms_db_audio_new(ctxt->db);
619 if (!plugin->audio_db)
621 plugin->video_db = lms_db_video_new(ctxt->db);
622 if (!plugin->video_db)
624 plugin->cs_conv = lms_charset_conv_new();
625 if (!plugin->cs_conv)
627 lms_charset_conv_add(plugin->cs_conv, "UTF-16LE");
633 _start(struct plugin *plugin, struct lms_context *ctxt)
636 r = lms_db_audio_start(plugin->audio_db);
637 r |= lms_db_video_start(plugin->video_db);
642 _finish(struct plugin *plugin, struct lms_context *ctxt)
644 if (plugin->audio_db)
645 lms_db_audio_free(plugin->audio_db);
646 if (plugin->video_db)
647 lms_db_video_free(plugin->video_db);
649 lms_charset_conv_free(plugin->cs_conv);
655 _close(struct plugin *plugin)
661 API struct lms_plugin *
662 lms_plugin_open(void)
664 struct plugin *plugin;
666 plugin = (struct plugin *)malloc(sizeof(*plugin));
667 plugin->plugin.name = _name;
668 plugin->plugin.match = (lms_plugin_match_fn_t)_match;
669 plugin->plugin.parse = (lms_plugin_parse_fn_t)_parse;
670 plugin->plugin.close = (lms_plugin_close_fn_t)_close;
671 plugin->plugin.setup = (lms_plugin_setup_fn_t)_setup;
672 plugin->plugin.start = (lms_plugin_start_fn_t)_start;
673 plugin->plugin.finish = (lms_plugin_finish_fn_t)_finish;
675 return (struct lms_plugin *)plugin;
678 API const struct lms_plugin_info *
679 lms_plugin_info(void)
681 static struct lms_plugin_info info = {
684 "Microsoft WMA, WMV and ASF",
687 "http://lms.garage.maemo.org"