1/* grabbag - Convenience lib for various routines common to several tools
2 * Copyright (C) 2002,2003,2004,2005,2006,2007  Josh Coalson
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2.1 of the License, or (at your option) any later version.
8 *
9 * This library 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 GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the Free Software
16 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
17 */
18
19/*
20 * This wraps the replaygain_analysis lib, which is LGPL.  This wrapper
21 * allows analysis of different input resolutions by automatically
22 * scaling the input signal
23 */
24
25/* This .h cannot be included by itself; #include "share/grabbag.h" instead. */
26
27#ifndef GRABBAG__REPLAYGAIN_H
28#define GRABBAG__REPLAYGAIN_H
29
30#include "FLAC/metadata.h"
31
32#ifdef __cplusplus
33extern "C" {
34#endif
35
36extern const unsigned GRABBAG__REPLAYGAIN_MAX_TAG_SPACE_REQUIRED;
37
38extern const FLAC__byte * const GRABBAG__REPLAYGAIN_TAG_REFERENCE_LOUDNESS; /* = "REPLAYGAIN_REFERENCE_LOUDNESS" */
39extern const FLAC__byte * const GRABBAG__REPLAYGAIN_TAG_TITLE_GAIN; /* = "REPLAYGAIN_TRACK_GAIN" */
40extern const FLAC__byte * const GRABBAG__REPLAYGAIN_TAG_TITLE_PEAK; /* = "REPLAYGAIN_TRACK_PEAK" */
41extern const FLAC__byte * const GRABBAG__REPLAYGAIN_TAG_ALBUM_GAIN; /* = "REPLAYGAIN_ALBUM_GAIN" */
42extern const FLAC__byte * const GRABBAG__REPLAYGAIN_TAG_ALBUM_PEAK; /* = "REPLAYGAIN_ALBUM_PEAK" */
43
44FLAC__bool grabbag__replaygain_is_valid_sample_frequency(unsigned sample_frequency);
45
46FLAC__bool grabbag__replaygain_init(unsigned sample_frequency);
47
48/* 'bps' must be valid for FLAC, i.e. >=4 and <= 32 */
49FLAC__bool grabbag__replaygain_analyze(const FLAC__int32 * const input[], FLAC__bool is_stereo, unsigned bps, unsigned samples);
50
51void grabbag__replaygain_get_album(float *gain, float *peak);
52void grabbag__replaygain_get_title(float *gain, float *peak);
53
54/* These three functions return an error string on error, or NULL if successful */
55const char *grabbag__replaygain_analyze_file(const char *filename, float *title_gain, float *title_peak);
56const char *grabbag__replaygain_store_to_vorbiscomment(FLAC__StreamMetadata *block, float album_gain, float album_peak, float title_gain, float title_peak);
57const char *grabbag__replaygain_store_to_vorbiscomment_reference(FLAC__StreamMetadata *block);
58const char *grabbag__replaygain_store_to_vorbiscomment_album(FLAC__StreamMetadata *block, float album_gain, float album_peak);
59const char *grabbag__replaygain_store_to_vorbiscomment_title(FLAC__StreamMetadata *block, float title_gain, float title_peak);
60const char *grabbag__replaygain_store_to_file(const char *filename, float album_gain, float album_peak, float title_gain, float title_peak, FLAC__bool preserve_modtime);
61const char *grabbag__replaygain_store_to_file_reference(const char *filename, FLAC__bool preserve_modtime);
62const char *grabbag__replaygain_store_to_file_album(const char *filename, float album_gain, float album_peak, FLAC__bool preserve_modtime);
63const char *grabbag__replaygain_store_to_file_title(const char *filename, float title_gain, float title_peak, FLAC__bool preserve_modtime);
64
65FLAC__bool grabbag__replaygain_load_from_vorbiscomment(const FLAC__StreamMetadata *block, FLAC__bool album_mode, FLAC__bool strict, double *reference, double *gain, double *peak);
66double grabbag__replaygain_compute_scale_factor(double peak, double gain, double preamp, FLAC__bool prevent_clipping);
67
68#ifdef __cplusplus
69}
70#endif
71
72#endif
73