1 /* libxmms-flac - XMMS FLAC input plugin
2 * Copyright (C) 2000,2001,2002,2003 Josh Coalson
4 * This program is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU 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 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.
25 #include <xmms/plugin.h>
26 #include <xmms/util.h>
27 #include <xmms/configfile.h>
28 #include <xmms/titlestring.h>
34 #ifdef HAVE_LANGINFO_CODESET
39 #include "plugin_common/all.h"
40 #include "share/grabbag.h"
41 #include "configure.h"
48 #define min(x,y) ((x)<(y)?(x):(y))
50 extern void FLAC_XMMS__file_info_box(char *filename);
53 FLAC__bool abort_flag;
54 FLAC__bool is_playing;
56 FLAC__bool play_thread_open; /* if true, is_playing must also be true */
57 unsigned total_samples;
58 unsigned bits_per_sample;
61 unsigned length_in_msec;
63 AFormat sample_format;
65 FLAC__bool has_replaygain;
67 DitherContext dither_context;
70 static void FLAC_XMMS__init();
71 static int FLAC_XMMS__is_our_file(char *filename);
72 static void FLAC_XMMS__play_file(char *filename);
73 static void FLAC_XMMS__stop();
74 static void FLAC_XMMS__pause(short p);
75 static void FLAC_XMMS__seek(int time);
76 static int FLAC_XMMS__get_time();
77 static void FLAC_XMMS__cleanup();
78 static void FLAC_XMMS__get_song_info(char *filename, char **title, int *length);
80 static void *play_loop_(void *arg);
81 static FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder);
82 static void safe_decoder_finish_(FLAC__FileDecoder *decoder);
83 static void safe_decoder_delete_(FLAC__FileDecoder *decoder);
84 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
85 static void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
86 static void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
92 "Reference FLAC Player v" VERSION,
96 FLAC_XMMS__is_our_file,
111 FLAC_XMMS__get_song_info,
112 FLAC_XMMS__file_info_box,
116 #define SAMPLES_PER_WRITE 512
117 static FLAC__int32 reservoir_[FLAC__MAX_BLOCK_SIZE * 2/*for overflow*/ * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS];
118 static FLAC__byte sample_buffer_[SAMPLES_PER_WRITE * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS * (24/8)]; /* (24/8) for max bytes per sample */
119 static unsigned wide_samples_in_reservoir_ = 0;
121 static FLAC__FileDecoder *decoder_ = 0;
122 static file_info_struct file_info_;
123 static pthread_t decode_thread_;
124 static FLAC__bool audio_error_ = false;
126 #define BITRATE_HIST_SEGMENT_MSEC 500
127 /* 500ms * 50 = 25s should be enough */
128 #define BITRATE_HIST_SIZE 50
129 static unsigned bitrate_history_[BITRATE_HIST_SIZE];
132 InputPlugin *get_iplugin_info()
134 flac_ip.description = g_strdup_printf("Reference FLAC Player v%s", FLAC__VERSION_STRING);
138 void FLAC_XMMS__init()
142 flac_cfg.title.tag_override = FALSE;
143 g_free(flac_cfg.title.tag_format);
144 flac_cfg.title.convert_char_set = FALSE;
146 cfg = xmms_cfg_open_default_file();
150 xmms_cfg_read_boolean(cfg, "flac", "title.tag_override", &flac_cfg.title.tag_override);
152 if(!xmms_cfg_read_string(cfg, "flac", "title.tag_format", &flac_cfg.title.tag_format))
153 flac_cfg.title.tag_format = g_strdup("%p - %t");
155 xmms_cfg_read_boolean(cfg, "flac", "title.convert_char_set", &flac_cfg.title.convert_char_set);
157 if(!xmms_cfg_read_string(cfg, "flac", "title.file_char_set", &flac_cfg.title.file_char_set))
158 flac_cfg.title.file_char_set = FLAC_plugin__charset_get_current();
160 if(!xmms_cfg_read_string(cfg, "flac", "title.user_char_set", &flac_cfg.title.user_char_set))
161 flac_cfg.title.user_char_set = FLAC_plugin__charset_get_current();
165 xmms_cfg_read_boolean(cfg, "flac", "output.replaygain.enable", &flac_cfg.output.replaygain.enable);
167 xmms_cfg_read_boolean(cfg, "flac", "output.replaygain.album_mode", &flac_cfg.output.replaygain.album_mode);
169 if(!xmms_cfg_read_int(cfg, "flac", "output.replaygain.preamp", &flac_cfg.output.replaygain.preamp))
170 flac_cfg.output.replaygain.preamp = 0;
172 xmms_cfg_read_boolean(cfg, "flac", "output.replaygain.hard_limit", &flac_cfg.output.replaygain.hard_limit);
174 xmms_cfg_read_boolean(cfg, "flac", "output.resolution.normal.dither_24_to_16", &flac_cfg.output.resolution.normal.dither_24_to_16);
175 xmms_cfg_read_boolean(cfg, "flac", "output.resolution.replaygain.dither", &flac_cfg.output.resolution.replaygain.dither);
177 if(!xmms_cfg_read_int(cfg, "flac", "output.resolution.replaygain.noise_shaping", &flac_cfg.output.resolution.replaygain.noise_shaping))
178 flac_cfg.output.resolution.replaygain.noise_shaping = 1;
180 if(!xmms_cfg_read_int(cfg, "flac", "output.resolution.replaygain.bps_out", &flac_cfg.output.resolution.replaygain.bps_out))
181 flac_cfg.output.resolution.replaygain.bps_out = 16;
183 decoder_ = FLAC__file_decoder_new();
186 int FLAC_XMMS__is_our_file(char *filename)
190 ext = strrchr(filename, '.');
192 if(!strcasecmp(ext, ".flac") || !strcasecmp(ext, ".fla"))
197 void FLAC_XMMS__play_file(char *filename)
201 wide_samples_in_reservoir_ = 0;
202 audio_error_ = false;
203 file_info_.abort_flag = false;
204 file_info_.is_playing = false;
205 file_info_.eof = false;
206 file_info_.play_thread_open = false;
207 file_info_.has_replaygain = false;
209 if(0 == (f = fopen(filename, "r")))
216 if(!safe_decoder_init_(filename, decoder_))
219 if(file_info_.has_replaygain && flac_cfg.output.replaygain.enable && flac_cfg.output.resolution.replaygain.dither)
220 FLAC__plugin_common__init_dither_context(&file_info_.dither_context, file_info_.bits_per_sample, flac_cfg.output.resolution.replaygain.noise_shaping);
222 file_info_.is_playing = true;
224 if(flac_ip.output->open_audio(file_info_.sample_format, file_info_.sample_rate, file_info_.channels) == 0) {
226 safe_decoder_finish_(decoder_);
230 file_info_.title = flac_format_song_title(filename);
231 flac_ip.set_info(file_info_.title, file_info_.length_in_msec, file_info_.sample_rate * file_info_.channels * file_info_.bits_per_sample, file_info_.sample_rate, file_info_.channels);
233 file_info_.seek_to_in_sec = -1;
234 file_info_.play_thread_open = true;
235 pthread_create(&decode_thread_, NULL, play_loop_, NULL);
238 void FLAC_XMMS__stop()
240 if(file_info_.is_playing) {
241 file_info_.is_playing = false;
242 if(file_info_.play_thread_open) {
243 file_info_.play_thread_open = false;
244 pthread_join(decode_thread_, NULL);
246 flac_ip.output->close_audio();
247 safe_decoder_finish_(decoder_);
251 void FLAC_XMMS__pause(short p)
253 flac_ip.output->pause(p);
256 void FLAC_XMMS__seek(int time)
258 file_info_.seek_to_in_sec = time;
259 file_info_.eof = false;
261 while(file_info_.seek_to_in_sec != -1)
265 int FLAC_XMMS__get_time()
269 if(!file_info_.is_playing || (file_info_.eof && !flac_ip.output->buffer_playing()))
272 return flac_ip.output->output_time();
275 void FLAC_XMMS__cleanup()
277 safe_decoder_delete_(decoder_);
281 void FLAC_XMMS__get_song_info(char *filename, char **title, int *length_in_msec)
283 FLAC__StreamMetadata streaminfo;
288 if(!FLAC__metadata_get_streaminfo(filename, &streaminfo)) {
289 /* @@@ how to report the error? */
291 static const char *errtitle = "Invalid FLAC File: ";
292 *title = g_malloc(strlen(errtitle) + 1 + strlen(filename) + 1 + 1);
293 sprintf(*title, "%s\"%s\"", errtitle, filename);
296 *length_in_msec = -1;
301 *title = flac_format_song_title(filename);
304 *length_in_msec = streaminfo.data.stream_info.total_samples * 10 / (streaminfo.data.stream_info.sample_rate / 100);
307 /***********************************************************************
309 **********************************************************************/
311 void *play_loop_(void *arg)
313 unsigned written_time_last = 0, bh_index_last_w = 0, bh_index_last_o = BITRATE_HIST_SIZE, blocksize = 1;
314 FLAC__uint64 decode_position_last = 0, decode_position_frame_last = 0, decode_position_frame = 0;
318 while(file_info_.is_playing) {
319 if(!file_info_.eof) {
320 while(wide_samples_in_reservoir_ < SAMPLES_PER_WRITE) {
323 s = wide_samples_in_reservoir_;
324 if(FLAC__file_decoder_get_state(decoder_) == FLAC__FILE_DECODER_END_OF_FILE) {
325 file_info_.eof = true;
328 else if(!FLAC__file_decoder_process_single(decoder_)) {
329 /*@@@ this should probably be a dialog */
330 fprintf(stderr, "libxmms-flac: READ ERROR processing frame\n");
331 file_info_.eof = true;
334 blocksize = wide_samples_in_reservoir_ - s;
335 decode_position_frame_last = decode_position_frame;
336 if(!FLAC__file_decoder_get_decode_position(decoder_, &decode_position_frame))
337 decode_position_frame = 0;
339 if(wide_samples_in_reservoir_ > 0) {
340 const unsigned channels = file_info_.channels;
341 const unsigned bits_per_sample = file_info_.bits_per_sample;
342 const unsigned n = min(wide_samples_in_reservoir_, SAMPLES_PER_WRITE);
343 const unsigned delta = n * channels;
345 unsigned i, written_time, bh_index_w;
346 FLAC__uint64 decode_position;
348 if(flac_cfg.output.replaygain.enable && file_info_.has_replaygain) {
349 bytes = (int)FLAC__plugin_common__apply_gain(
355 flac_cfg.output.resolution.replaygain.bps_out,
356 file_info_.replay_scale,
357 flac_cfg.output.replaygain.hard_limit,
358 flac_cfg.output.resolution.replaygain.dither,
359 (NoiseShaping)flac_cfg.output.resolution.replaygain.noise_shaping,
360 &file_info_.dither_context
364 bytes = (int)FLAC__plugin_common__pack_pcm_signed_little_endian(
370 flac_cfg.output.resolution.normal.dither_24_to_16?
371 min(bits_per_sample, 16) :
376 for(i = delta; i < wide_samples_in_reservoir_ * channels; i++)
377 reservoir_[i-delta] = reservoir_[i];
378 wide_samples_in_reservoir_ -= n;
380 flac_ip.add_vis_pcm(flac_ip.output->written_time(), file_info_.sample_format, channels, bytes, sample_buffer_);
381 while(flac_ip.output->buffer_free() < (int)bytes && file_info_.is_playing && file_info_.seek_to_in_sec == -1)
383 if(file_info_.is_playing && file_info_.seek_to_in_sec == -1)
384 flac_ip.output->write_audio(sample_buffer_, bytes);
386 /* compute current bitrate */
388 written_time = flac_ip.output->written_time();
389 bh_index_w = written_time / BITRATE_HIST_SEGMENT_MSEC % BITRATE_HIST_SIZE;
390 if(bh_index_w != bh_index_last_w) {
391 bh_index_last_w = bh_index_w;
392 decode_position = decode_position_frame - (double)wide_samples_in_reservoir_ * (double)(decode_position_frame - decode_position_frame_last) / (double)blocksize;
393 bitrate_history_[(bh_index_w + BITRATE_HIST_SIZE - 1) % BITRATE_HIST_SIZE] =
394 decode_position > decode_position_last && written_time > written_time_last ?
395 8000 * (decode_position - decode_position_last) / (written_time - written_time_last) :
396 file_info_.sample_rate * file_info_.channels * file_info_.bits_per_sample;
397 decode_position_last = decode_position;
398 written_time_last = written_time;
402 file_info_.eof = true;
408 if(file_info_.seek_to_in_sec != -1) {
409 const double distance = (double)file_info_.seek_to_in_sec * 1000.0 / (double)file_info_.length_in_msec;
410 unsigned target_sample = (unsigned)(distance * (double)file_info_.total_samples);
411 if(FLAC__file_decoder_seek_absolute(decoder_, (FLAC__uint64)target_sample)) {
412 flac_ip.output->flush(file_info_.seek_to_in_sec * 1000);
413 bh_index_last_w = bh_index_last_o = flac_ip.output->output_time() / BITRATE_HIST_SEGMENT_MSEC % BITRATE_HIST_SIZE;
414 if(!FLAC__file_decoder_get_decode_position(decoder_, &decode_position_frame))
415 decode_position_frame = 0;
416 file_info_.seek_to_in_sec = -1;
417 file_info_.eof = false;
418 wide_samples_in_reservoir_ = 0;
422 /* display the right bitrate from history */
423 unsigned bh_index_o = flac_ip.output->output_time() / BITRATE_HIST_SEGMENT_MSEC % BITRATE_HIST_SIZE;
424 if(bh_index_o != bh_index_last_o && bh_index_o != bh_index_last_w && bh_index_o != (bh_index_last_w + 1) % BITRATE_HIST_SIZE) {
425 bh_index_last_o = bh_index_o;
426 flac_ip.set_info(file_info_.title, file_info_.length_in_msec, bitrate_history_[bh_index_o], file_info_.sample_rate, file_info_.channels);
431 safe_decoder_finish_(decoder_);
433 /* are these two calls necessary? */
434 flac_ip.output->buffer_free();
435 flac_ip.output->buffer_free();
437 g_free(file_info_.title);
440 return 0; /* to silence the compiler warning about not returning a value */
443 FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder)
448 safe_decoder_finish_(decoder);
450 FLAC__file_decoder_set_md5_checking(decoder, false);
451 FLAC__file_decoder_set_filename(decoder, filename);
452 FLAC__file_decoder_set_metadata_ignore_all(decoder);
453 FLAC__file_decoder_set_metadata_respond(decoder, FLAC__METADATA_TYPE_STREAMINFO);
454 FLAC__file_decoder_set_metadata_respond(decoder, FLAC__METADATA_TYPE_VORBIS_COMMENT);
455 FLAC__file_decoder_set_write_callback(decoder, write_callback_);
456 FLAC__file_decoder_set_metadata_callback(decoder, metadata_callback_);
457 FLAC__file_decoder_set_error_callback(decoder, error_callback_);
458 FLAC__file_decoder_set_client_data(decoder, &file_info_);
459 if(FLAC__file_decoder_init(decoder) != FLAC__FILE_DECODER_OK)
462 if(!FLAC__file_decoder_process_until_end_of_metadata(decoder))
468 void safe_decoder_finish_(FLAC__FileDecoder *decoder)
470 if(decoder && FLAC__file_decoder_get_state(decoder) != FLAC__FILE_DECODER_UNINITIALIZED)
471 FLAC__file_decoder_finish(decoder);
474 void safe_decoder_delete_(FLAC__FileDecoder *decoder)
477 safe_decoder_finish_(decoder);
478 FLAC__file_decoder_delete(decoder);
482 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
484 file_info_struct *file_info = (file_info_struct *)client_data;
485 const unsigned channels = file_info->channels, wide_samples = frame->header.blocksize;
486 unsigned wide_sample, offset_sample, channel;
490 if(file_info->abort_flag)
491 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
493 for(offset_sample = wide_samples_in_reservoir_ * channels, wide_sample = 0; wide_sample < wide_samples; wide_sample++)
494 for(channel = 0; channel < channels; channel++, offset_sample++)
495 reservoir_[offset_sample] = buffer[channel][wide_sample];
497 wide_samples_in_reservoir_ += wide_samples;
499 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
502 void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
504 file_info_struct *file_info = (file_info_struct *)client_data;
506 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
507 FLAC__ASSERT(metadata->data.stream_info.total_samples < 0x100000000); /* this plugin can only handle < 4 gigasamples */
508 file_info->total_samples = (unsigned)(metadata->data.stream_info.total_samples&0xffffffff);
509 file_info->bits_per_sample = metadata->data.stream_info.bits_per_sample;
510 file_info->channels = metadata->data.stream_info.channels;
511 file_info->sample_rate = metadata->data.stream_info.sample_rate;
513 #ifdef FLAC__DO_DITHER
514 if(file_info->bits_per_sample == 8) {
515 file_info->sample_format = FMT_S8;
517 else if(file_info->bits_per_sample == 16 || file_info->bits_per_sample == 24) {
518 file_info->sample_format = FMT_S16_LE;
521 /*@@@ need some error here like wa2: MessageBox(mod_.hMainWindow, "ERROR: plugin can only handle 8/16/24-bit samples\n", "ERROR: plugin can only handle 8/16/24-bit samples", 0); */
522 file_info->abort_flag = true;
526 if(file_info->bits_per_sample == 8) {
527 file_info->sample_format = FMT_S8;
529 else if(file_info->bits_per_sample == 16) {
530 file_info->sample_format = FMT_S16_LE;
533 /*@@@ need some error here like wa2: MessageBox(mod_.hMainWindow, "ERROR: plugin can only handle 8/16-bit samples\n", "ERROR: plugin can only handle 8/16-bit samples", 0); */
534 file_info->abort_flag = true;
538 file_info->length_in_msec = file_info->total_samples * 10 / (file_info->sample_rate / 100);
540 else if(metadata->type == FLAC__METADATA_TYPE_VORBIS_COMMENT) {
542 if(grabbag__replaygain_load_from_vorbiscomment(metadata, flac_cfg.output.replaygain.album_mode, &gain, &peak)) {
543 file_info_.has_replaygain = true;
544 file_info_.replay_scale = grabbag__replaygain_compute_scale_factor(peak, gain, (double)flac_cfg.output.replaygain.preamp, /*prevent_clipping=*/!flac_cfg.output.replaygain.hard_limit);
549 void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
551 file_info_struct *file_info = (file_info_struct *)client_data;
553 if(status != FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)
554 file_info->abort_flag = true;