add support for RF64
[flac.git] / src / flac / foreign_metadata.h
1 /* flac - Command-line FLAC encoder/decoder
2  * Copyright (C) 2000,2001,2002,2003,2004,2005,2006,2007,2008  Josh Coalson
3  *
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.
8  *
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.
13  *
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.
17  */
18
19 #ifndef flac__foreign_metadata_h
20 #define flac__foreign_metadata_h
21
22 #if HAVE_CONFIG_H
23 #  include <config.h>
24 #endif
25
26 #include "FLAC/metadata.h"
27 #include "utils.h"
28
29 /* WATCHOUT: these enums are used to index internal arrays */
30 typedef enum {
31         FOREIGN_BLOCK_TYPE__AIFF = 0, /* for AIFF and AIFF-C */
32         FOREIGN_BLOCK_TYPE__RIFF = 1  /* for WAVE and RF64 */
33 } foreign_block_type_t;
34
35 typedef struct {
36         /* for encoding, this will be the offset in the WAVE/AIFF file of the chunk */
37         /* for decoding, this will be the offset in the FLAC file of the chunk data inside the APPLICATION block */
38         off_t offset;
39         /* size is the actual size in bytes of the chunk to be stored/recreated. */
40         /* It includes the 8 bytes of chunk type and size, and any padding byte for alignment. */
41         /* For 'data'/'SSND' chunks, the size does not include the actual sound or padding bytes */
42         /* because these are not stored, they are recreated from the compressed FLAC stream. */
43         /* So for RIFF 'data', size is 8, and for AIFF 'SSND', size is 8 + 8 + ssnd_offset_size */
44         FLAC__uint32 size;
45 } foreign_block_t;
46
47 typedef struct {
48         foreign_block_type_t type; /* currently we don't support multiple foreign types in a stream (and maybe never will) */
49         foreign_block_t *blocks;
50         size_t num_blocks;
51         size_t format_block; /* block number of 'fmt ' or 'COMM' chunk */
52         size_t audio_block; /* block number of 'data' or 'SSND' chunk */
53         FLAC__bool is_rf64; /* always false if type!=RIFF */
54         FLAC__uint32 ssnd_offset_size; /* 0 if type!=AIFF */
55 } foreign_metadata_t;
56
57 foreign_metadata_t *flac__foreign_metadata_new(foreign_block_type_t type);
58
59 void flac__foreign_metadata_delete(foreign_metadata_t *fm);
60
61 FLAC__bool flac__foreign_metadata_read_from_aiff(foreign_metadata_t *fm, const char *filename, const char **error);
62 FLAC__bool flac__foreign_metadata_read_from_wave(foreign_metadata_t *fm, const char *filename, const char **error);
63 FLAC__bool flac__foreign_metadata_write_to_flac(foreign_metadata_t *fm, const char *infilename, const char *outfilename, const char **error);
64
65 FLAC__bool flac__foreign_metadata_read_from_flac(foreign_metadata_t *fm, const char *filename, const char **error);
66 FLAC__bool flac__foreign_metadata_write_to_iff(foreign_metadata_t *fm, const char *infilename, const char *outfilename, off_t offset1, off_t offset2, off_t offset3, const char **error);
67
68 #endif