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>
30 #ifdef HAVE_LANGINFO_CODESET
35 #include "plugin_common/all.h"
36 #include "configure.h"
43 #define min(x,y) ((x)<(y)?(x):(y))
45 #define FLAC__DO_DITHER
48 FLAC__bool abort_flag;
49 FLAC__bool is_playing;
51 FLAC__bool play_thread_open; /* if true, is_playing must also be true */
52 unsigned total_samples;
53 unsigned bits_per_sample;
56 unsigned length_in_msec;
57 AFormat sample_format;
61 static void FLAC_XMMS__init();
62 static int FLAC_XMMS__is_our_file(char *filename);
63 static void FLAC_XMMS__play_file(char *filename);
64 static void FLAC_XMMS__stop();
65 static void FLAC_XMMS__pause(short p);
66 static void FLAC_XMMS__seek(int time);
67 static int FLAC_XMMS__get_time();
68 static void FLAC_XMMS__cleanup();
69 static void FLAC_XMMS__get_song_info(char *filename, char **title, int *length);
71 static void *play_loop_(void *arg);
72 static FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder);
73 static void safe_decoder_finish_(FLAC__FileDecoder *decoder);
74 static void safe_decoder_delete_(FLAC__FileDecoder *decoder);
75 static FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data);
76 static void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data);
77 static void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data);
83 "Reference FLAC Player v" FLAC__VERSION_STRING,
87 FLAC_XMMS__is_our_file,
102 FLAC_XMMS__get_song_info,
103 NULL, /* file_info_box */
107 #define SAMPLES_PER_WRITE 512
108 static FLAC__int32 reservoir_[FLAC__MAX_BLOCK_SIZE * 2/*for overflow*/ * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS];
109 static FLAC__byte sample_buffer_[SAMPLES_PER_WRITE * FLAC_PLUGIN__MAX_SUPPORTED_CHANNELS * (24/8)]; /* (24/8) for max bytes per sample */
110 static unsigned wide_samples_in_reservoir_ = 0;
111 static FLAC__FileDecoder *decoder_ = 0;
112 static file_info_struct file_info_;
113 static pthread_t decode_thread_;
114 static FLAC__bool audio_error_ = false;
116 InputPlugin *get_iplugin_info()
118 flac_ip.description = g_strdup_printf("Reference FLAC Player v%s", FLAC__VERSION_STRING);
122 void FLAC_XMMS__init()
126 flac_cfg.tag_override = FALSE;
127 g_free(flac_cfg.tag_format);
128 flac_cfg.convert_char_set = FALSE;
130 cfg = xmms_cfg_open_default_file();
132 xmms_cfg_read_boolean(cfg, "flac", "tag_override", &flac_cfg.tag_override);
134 if(!xmms_cfg_read_string(cfg, "flac", "tag_format", &flac_cfg.tag_format))
135 flac_cfg.tag_format = g_strdup("%p - %t");
137 xmms_cfg_read_boolean(cfg, "flac", "convert_char_set", &flac_cfg.convert_char_set);
139 if(!xmms_cfg_read_string(cfg, "flac", "file_char_set", &flac_cfg.file_char_set))
140 flac_cfg.file_char_set = FLAC_plugin__charset_get_current();
142 if(!xmms_cfg_read_string(cfg, "flac", "user_char_set", &flac_cfg.user_char_set))
143 flac_cfg.user_char_set = FLAC_plugin__charset_get_current();
145 decoder_ = FLAC__file_decoder_new();
148 int FLAC_XMMS__is_our_file(char *filename)
152 ext = strrchr(filename, '.');
154 if(!strcasecmp(ext, ".flac") || !strcasecmp(ext, ".fla"))
159 void FLAC_XMMS__play_file(char *filename)
163 const AFormat output_format = file_info_.sample_format;
165 wide_samples_in_reservoir_ = 0;
166 audio_error_ = false;
167 file_info_.abort_flag = false;
168 file_info_.is_playing = false;
169 file_info_.eof = false;
170 file_info_.play_thread_open = false;
172 if(0 == (f = fopen(filename, "r")))
179 if(!safe_decoder_init_(filename, decoder_))
182 file_info_.is_playing = true;
184 if(flac_ip.output->open_audio(output_format, file_info_.sample_rate, file_info_.channels) == 0) {
186 safe_decoder_finish_(decoder_);
190 ret = flac_format_song_title(filename);
191 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);
195 file_info_.seek_to_in_sec = -1;
196 file_info_.play_thread_open = true;
197 pthread_create(&decode_thread_, NULL, play_loop_, NULL);
200 void FLAC_XMMS__stop()
202 if(file_info_.is_playing) {
203 file_info_.is_playing = false;
204 if(file_info_.play_thread_open) {
205 file_info_.play_thread_open = false;
206 pthread_join(decode_thread_, NULL);
208 flac_ip.output->close_audio();
209 safe_decoder_finish_(decoder_);
213 void FLAC_XMMS__pause(short p)
215 flac_ip.output->pause(p);
218 void FLAC_XMMS__seek(int time)
220 file_info_.seek_to_in_sec = time;
221 file_info_.eof = false;
223 while(file_info_.seek_to_in_sec != -1)
227 int FLAC_XMMS__get_time()
231 if(!file_info_.is_playing || (file_info_.eof && !flac_ip.output->buffer_playing()))
234 return flac_ip.output->output_time();
237 void FLAC_XMMS__cleanup()
239 safe_decoder_delete_(decoder_);
243 void FLAC_XMMS__get_song_info(char *filename, char **title, int *length_in_msec)
245 FLAC__StreamMetadata streaminfo;
250 if(!FLAC__metadata_get_streaminfo(filename, &streaminfo)) {
251 /* @@@ how to report the error? */
253 static const char *errtitle = "Invalid FLAC File: ";
254 *title = g_malloc(strlen(errtitle) + 1 + strlen(filename) + 1 + 1);
255 sprintf(*title, "%s\"%s\"", errtitle, filename);
258 *length_in_msec = -1;
263 *title = flac_format_song_title(filename);
266 *length_in_msec = streaminfo.data.stream_info.total_samples * 10 / (streaminfo.data.stream_info.sample_rate / 100);
269 /***********************************************************************
271 **********************************************************************/
273 void *play_loop_(void *arg)
277 while(file_info_.is_playing) {
278 if(!file_info_.eof) {
279 while(wide_samples_in_reservoir_ < SAMPLES_PER_WRITE) {
280 if(FLAC__file_decoder_get_state(decoder_) == FLAC__FILE_DECODER_END_OF_FILE) {
281 file_info_.eof = true;
284 else if(!FLAC__file_decoder_process_single(decoder_)) {
285 /*@@@ this should probably be a dialog */
286 fprintf(stderr, "libxmms-flac: READ ERROR processing frame\n");
287 file_info_.eof = true;
291 if(wide_samples_in_reservoir_ > 0) {
292 const unsigned channels = file_info_.channels;
293 const unsigned bits_per_sample = file_info_.bits_per_sample;
294 #ifdef FLAC__DO_DITHER
295 const unsigned target_bps = min(bits_per_sample, 16);
297 const unsigned target_bps = bits_per_sample;
299 const unsigned n = min(wide_samples_in_reservoir_, SAMPLES_PER_WRITE);
300 const unsigned delta = n * channels;
301 int bytes = (int)FLAC__plugin_common__pack_pcm_signed_little_endian(sample_buffer_, reservoir_, n, channels, bits_per_sample, target_bps);
304 for(i = delta; i < wide_samples_in_reservoir_ * channels; i++)
305 reservoir_[i-delta] = reservoir_[i];
306 wide_samples_in_reservoir_ -= n;
308 flac_ip.add_vis_pcm(flac_ip.output->written_time(), file_info_.sample_format, channels, bytes, sample_buffer_);
309 while(flac_ip.output->buffer_free() < (int)bytes && file_info_.is_playing && file_info_.seek_to_in_sec == -1)
311 if(file_info_.is_playing && file_info_.seek_to_in_sec == -1)
312 flac_ip.output->write_audio(sample_buffer_, bytes);
315 file_info_.eof = true;
321 if(file_info_.seek_to_in_sec != -1) {
322 const double distance = (double)file_info_.seek_to_in_sec * 1000.0 / (double)file_info_.length_in_msec;
323 unsigned target_sample = (unsigned)(distance * (double)file_info_.total_samples);
324 if(FLAC__file_decoder_seek_absolute(decoder_, (FLAC__uint64)target_sample)) {
325 flac_ip.output->flush(file_info_.seek_to_in_sec * 1000);
326 file_info_.seek_to_in_sec = -1;
327 file_info_.eof = false;
328 wide_samples_in_reservoir_ = 0;
333 safe_decoder_finish_(decoder_);
335 /* are these two calls necessary? */
336 flac_ip.output->buffer_free();
337 flac_ip.output->buffer_free();
340 return 0; /* to silence the compiler warning about not returning a value */
343 FLAC__bool safe_decoder_init_(const char *filename, FLAC__FileDecoder *decoder)
348 safe_decoder_finish_(decoder);
350 FLAC__file_decoder_set_md5_checking(decoder, false);
351 FLAC__file_decoder_set_filename(decoder, filename);
352 FLAC__file_decoder_set_write_callback(decoder, write_callback_);
353 FLAC__file_decoder_set_metadata_callback(decoder, metadata_callback_);
354 FLAC__file_decoder_set_error_callback(decoder, error_callback_);
355 FLAC__file_decoder_set_client_data(decoder, &file_info_);
356 if(FLAC__file_decoder_init(decoder) != FLAC__FILE_DECODER_OK)
359 if(!FLAC__file_decoder_process_until_end_of_metadata(decoder))
365 void safe_decoder_finish_(FLAC__FileDecoder *decoder)
367 if(decoder && FLAC__file_decoder_get_state(decoder) != FLAC__FILE_DECODER_UNINITIALIZED)
368 FLAC__file_decoder_finish(decoder);
371 void safe_decoder_delete_(FLAC__FileDecoder *decoder)
374 safe_decoder_finish_(decoder);
375 FLAC__file_decoder_delete(decoder);
379 FLAC__StreamDecoderWriteStatus write_callback_(const FLAC__FileDecoder *decoder, const FLAC__Frame *frame, const FLAC__int32 * const buffer[], void *client_data)
381 file_info_struct *file_info = (file_info_struct *)client_data;
382 const unsigned channels = file_info->channels, wide_samples = frame->header.blocksize;
383 unsigned wide_sample, offset_sample, channel;
387 if(file_info->abort_flag)
388 return FLAC__STREAM_DECODER_WRITE_STATUS_ABORT;
390 for(offset_sample = wide_samples_in_reservoir_ * channels, wide_sample = 0; wide_sample < wide_samples; wide_sample++)
391 for(channel = 0; channel < channels; channel++, offset_sample++)
392 reservoir_[offset_sample] = buffer[channel][wide_sample];
394 wide_samples_in_reservoir_ += wide_samples;
396 return FLAC__STREAM_DECODER_WRITE_STATUS_CONTINUE;
399 void metadata_callback_(const FLAC__FileDecoder *decoder, const FLAC__StreamMetadata *metadata, void *client_data)
401 file_info_struct *file_info = (file_info_struct *)client_data;
403 if(metadata->type == FLAC__METADATA_TYPE_STREAMINFO) {
404 FLAC__ASSERT(metadata->data.stream_info.total_samples < 0x100000000); /* this plugin can only handle < 4 gigasamples */
405 file_info->total_samples = (unsigned)(metadata->data.stream_info.total_samples&0xffffffff);
406 file_info->bits_per_sample = metadata->data.stream_info.bits_per_sample;
407 file_info->channels = metadata->data.stream_info.channels;
408 file_info->sample_rate = metadata->data.stream_info.sample_rate;
410 #ifdef FLAC__DO_DITHER
411 if(file_info->bits_per_sample == 8) {
412 file_info->sample_format = FMT_S8;
414 else if(file_info->bits_per_sample == 16 || file_info->bits_per_sample == 24) {
415 file_info->sample_format = FMT_S16_LE;
418 /*@@@ 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); */
419 file_info->abort_flag = true;
423 if(file_info->bits_per_sample == 8) {
424 file_info->sample_format = FMT_S8;
426 else if(file_info->bits_per_sample == 16) {
427 file_info->sample_format = FMT_S16_LE;
430 /*@@@ 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); */
431 file_info->abort_flag = true;
435 file_info->length_in_msec = file_info->total_samples * 10 / (file_info->sample_rate / 100);
439 void error_callback_(const FLAC__FileDecoder *decoder, FLAC__StreamDecoderErrorStatus status, void *client_data)
441 file_info_struct *file_info = (file_info_struct *)client_data;
443 if(status != FLAC__STREAM_DECODER_ERROR_STATUS_LOST_SYNC)
444 file_info->abort_flag = true;