1 /* libxmms-flac - XMMS FLAC input plugin
2 * Copyright (C) 2000,2001,2002 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 "configure.h"
47 #define min(x,y) ((x)<(y)?(x):(y))
49 #define FLAC__DO_DITHER
52 FLAC__bool abort_flag;
53 FLAC__bool is_playing;
55 FLAC__bool play_thread_open; /* if true, is_playing must also be true */
56 unsigned total_samples;
57 unsigned bits_per_sample;
60 unsigned length_in_msec;
61 AFormat sample_format;
65 static void FLAC_XMMS__init();
66 static int FLAC_XMMS__is_our_file(char *filename);
67 static void FLAC_XMMS__play_file(char *filename);
68 static void FLAC_XMMS__stop();
69 static void FLAC_XMMS__pause(short p);
70 static void FLAC_XMMS__seek(int time);
71 static int FLAC_XMMS__get_time();
72 static void FLAC_XMMS__cleanup();
73 static void FLAC_XMMS__get_song_info(char *filename, char **title, int *length);
75 static void *play_loop_(void *arg);
76 static FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder);
77 static void safe_decoder_finish_(FLAC__FileDecoder *decoder);
78 static void safe_decoder_delete_(FLAC__FileDecoder *decoder);
79 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
80 static void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
81 static void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
87 "Reference FLAC Player v" VERSION,
91 FLAC_XMMS__is_our_file,
106 FLAC_XMMS__get_song_info,
107 NULL, /* file_info_box */
111 #define SAMPLES_PER_WRITE 512
112 static FLAC__int32 reservoir_[FLAC__MAX_BLOCK_SIZE * 2/*for overflow*/ * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS];
113 static FLAC__byte sample_buffer_[SAMPLES_PER_WRITE * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS * (24/8)]; /* (24/8) for max bytes per sample */
114 static unsigned wide_samples_in_reservoir_ = 0;
115 static FLAC__FileDecoder *decoder_ = 0;
116 static file_info_struct file_info_;
117 static pthread_t decode_thread_;
118 static FLAC__bool audio_error_ = false;
120 InputPlugin *get_iplugin_info()
122 flac_ip.description = g_strdup_printf("Reference FLAC Player v%s", FLAC__VERSION_STRING);
126 void FLAC_XMMS__init()
130 flac_cfg.tag_override = FALSE;
131 g_free(flac_cfg.tag_format);
132 flac_cfg.convert_char_set = FALSE;
134 cfg = xmms_cfg_open_default_file();
136 xmms_cfg_read_boolean(cfg, "flac", "tag_override", &flac_cfg.tag_override);
138 if(!xmms_cfg_read_string(cfg, "flac", "tag_format", &flac_cfg.tag_format))
139 flac_cfg.tag_format = g_strdup("%p - %t");
141 xmms_cfg_read_boolean(cfg, "flac", "convert_char_set", &flac_cfg.convert_char_set);
143 if(!xmms_cfg_read_string(cfg, "flac", "file_char_set", &flac_cfg.file_char_set))
144 flac_cfg.file_char_set = FLAC_plugin__charset_get_current();
146 if(!xmms_cfg_read_string(cfg, "flac", "user_char_set", &flac_cfg.user_char_set))
147 flac_cfg.user_char_set = FLAC_plugin__charset_get_current();
149 decoder_ = FLAC__file_decoder_new();
152 int FLAC_XMMS__is_our_file(char *filename)
156 ext = strrchr(filename, '.');
158 if(!strcasecmp(ext, ".flac") || !strcasecmp(ext, ".fla"))
163 void FLAC_XMMS__play_file(char *filename)
168 wide_samples_in_reservoir_ = 0;
169 audio_error_ = false;
170 file_info_.abort_flag = false;
171 file_info_.is_playing = false;
172 file_info_.eof = false;
173 file_info_.play_thread_open = false;
175 if(0 == (f = fopen(filename, "r")))
182 if(!safe_decoder_init_(filename, decoder_))
185 file_info_.is_playing = true;
187 if(flac_ip.output->open_audio(file_info_.sample_format, file_info_.sample_rate, file_info_.channels) == 0) {
189 safe_decoder_finish_(decoder_);
193 ret = flac_format_song_title(filename);
194 flac_ip.set_info(ret, file_info_.length_in_msec, file_info_.sample_rate * file_info_.channels * file_info_.bits_per_sample, file_info_.sample_rate, file_info_.channels);
198 file_info_.seek_to_in_sec = -1;
199 file_info_.play_thread_open = true;
200 pthread_create(&decode_thread_, NULL, play_loop_, NULL);
203 void FLAC_XMMS__stop()
205 if(file_info_.is_playing) {
206 file_info_.is_playing = false;
207 if(file_info_.play_thread_open) {
208 file_info_.play_thread_open = false;
209 pthread_join(decode_thread_, NULL);
211 flac_ip.output->close_audio();
212 safe_decoder_finish_(decoder_);
216 void FLAC_XMMS__pause(short p)
218 flac_ip.output->pause(p);
221 void FLAC_XMMS__seek(int time)
223 file_info_.seek_to_in_sec = time;
224 file_info_.eof = false;
226 while(file_info_.seek_to_in_sec != -1)
230 int FLAC_XMMS__get_time()
234 if(!file_info_.is_playing || (file_info_.eof && !flac_ip.output->buffer_playing()))
237 return flac_ip.output->output_time();
240 void FLAC_XMMS__cleanup()
242 safe_decoder_delete_(decoder_);
246 void FLAC_XMMS__get_song_info(char *filename, char **title, int *length_in_msec)
248 FLAC__StreamMetadata streaminfo;
253 if(!FLAC__metadata_get_streaminfo(filename, &streaminfo)) {
254 /* @@@ how to report the error? */
256 static const char *errtitle = "Invalid FLAC File: ";
257 *title = g_malloc(strlen(errtitle) + 1 + strlen(filename) + 1 + 1);
258 sprintf(*title, "%s\"%s\"", errtitle, filename);
261 *length_in_msec = -1;
266 *title = flac_format_song_title(filename);
269 *length_in_msec = streaminfo.data.stream_info.total_samples * 10 / (streaminfo.data.stream_info.sample_rate / 100);
272 /***********************************************************************
274 **********************************************************************/
276 void *play_loop_(void *arg)
280 while(file_info_.is_playing) {
281 if(!file_info_.eof) {
282 while(wide_samples_in_reservoir_ < SAMPLES_PER_WRITE) {
283 if(FLAC__file_decoder_get_state(decoder_) == FLAC__FILE_DECODER_END_OF_FILE) {
284 file_info_.eof = true;
287 else if(!FLAC__file_decoder_process_single(decoder_)) {
288 /*@@@ this should probably be a dialog */
289 fprintf(stderr, "libxmms-flac: READ ERROR processing frame\n");
290 file_info_.eof = true;
294 if(wide_samples_in_reservoir_ > 0) {
295 const unsigned channels = file_info_.channels;
296 const unsigned bits_per_sample = file_info_.bits_per_sample;
297 #ifdef FLAC__DO_DITHER
298 const unsigned target_bps = min(bits_per_sample, 16);
300 const unsigned target_bps = bits_per_sample;
302 const unsigned n = min(wide_samples_in_reservoir_, SAMPLES_PER_WRITE);
303 const unsigned delta = n * channels;
304 int bytes = (int)FLAC__plugin_common__pack_pcm_signed_little_endian(sample_buffer_, reservoir_, n, channels, bits_per_sample, target_bps);
307 for(i = delta; i < wide_samples_in_reservoir_ * channels; i++)
308 reservoir_[i-delta] = reservoir_[i];
309 wide_samples_in_reservoir_ -= n;
311 flac_ip.add_vis_pcm(flac_ip.output->written_time(), file_info_.sample_format, channels, bytes, sample_buffer_);
312 while(flac_ip.output->buffer_free() < (int)bytes && file_info_.is_playing && file_info_.seek_to_in_sec == -1)
314 if(file_info_.is_playing && file_info_.seek_to_in_sec == -1)
315 flac_ip.output->write_audio(sample_buffer_, bytes);
318 file_info_.eof = true;
324 if(file_info_.seek_to_in_sec != -1) {
325 const double distance = (double)file_info_.seek_to_in_sec * 1000.0 / (double)file_info_.length_in_msec;
326 unsigned target_sample = (unsigned)(distance * (double)file_info_.total_samples);
327 if(FLAC__file_decoder_seek_absolute(decoder_, (FLAC__uint64)target_sample)) {
328 flac_ip.output->flush(file_info_.seek_to_in_sec * 1000);
329 file_info_.seek_to_in_sec = -1;
330 file_info_.eof = false;
331 wide_samples_in_reservoir_ = 0;
336 safe_decoder_finish_(decoder_);
338 /* are these two calls necessary? */
339 flac_ip.output->buffer_free();
340 flac_ip.output->buffer_free();
343 return 0; /* to silence the compiler warning about not returning a value */
346 FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder)
351 safe_decoder_finish_(decoder);
353 FLAC__file_decoder_set_md5_checking(decoder, false);
354 FLAC__file_decoder_set_filename(decoder, filename);
355 FLAC__file_decoder_set_write_callback(decoder, write_callback_);
356 FLAC__file_decoder_set_metadata_callback(decoder, metadata_callback_);
357 FLAC__file_decoder_set_error_callback(decoder, error_callback_);
358 FLAC__file_decoder_set_client_data(decoder, &file_info_);
359 if(FLAC__file_decoder_init(decoder) != FLAC__FILE_DECODER_OK)
362 if(!FLAC__file_decoder_process_until_end_of_metadata(decoder))
368 void safe_decoder_finish_(FLAC__FileDecoder *decoder)
370 if(decoder && FLAC__file_decoder_get_state(decoder) != FLAC__FILE_DECODER_UNINITIALIZED)
371 FLAC__file_decoder_finish(decoder);
374 void safe_decoder_delete_(FLAC__FileDecoder *decoder)
377 safe_decoder_finish_(decoder);
378 FLAC__file_decoder_delete(decoder);
382 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
384 file_info_struct *file_info = (file_info_struct *)client_data;
385 const unsigned channels = file_info->channels, wide_samples = frame->header.blocksize;
386 unsigned wide_sample, offset_sample, channel;
390 if(file_info->abort_flag)
391 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
393 for(offset_sample = wide_samples_in_reservoir_ * channels, wide_sample = 0; wide_sample < wide_samples; wide_sample++)
394 for(channel = 0; channel < channels; channel++, offset_sample++)
395 reservoir_[offset_sample] = buffer[channel][wide_sample];
397 wide_samples_in_reservoir_ += wide_samples;
399 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
402 void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
404 file_info_struct *file_info = (file_info_struct *)client_data;
406 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
407 FLAC__ASSERT(metadata->data.stream_info.total_samples < 0x100000000); /* this plugin can only handle < 4 gigasamples */
408 file_info->total_samples = (unsigned)(metadata->data.stream_info.total_samples&0xffffffff);
409 file_info->bits_per_sample = metadata->data.stream_info.bits_per_sample;
410 file_info->channels = metadata->data.stream_info.channels;
411 file_info->sample_rate = metadata->data.stream_info.sample_rate;
413 #ifdef FLAC__DO_DITHER
414 if(file_info->bits_per_sample == 8) {
415 file_info->sample_format = FMT_S8;
417 else if(file_info->bits_per_sample == 16 || file_info->bits_per_sample == 24) {
418 file_info->sample_format = FMT_S16_LE;
421 /*@@@ 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); */
422 file_info->abort_flag = true;
426 if(file_info->bits_per_sample == 8) {
427 file_info->sample_format = FMT_S8;
429 else if(file_info->bits_per_sample == 16) {
430 file_info->sample_format = FMT_S16_LE;
433 /*@@@ 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); */
434 file_info->abort_flag = true;
438 file_info->length_in_msec = file_info->total_samples * 10 / (file_info->sample_rate / 100);
442 void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
444 file_info_struct *file_info = (file_info_struct *)client_data;
446 if(status != FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)
447 file_info->abort_flag = true;