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