• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 /* libFLAC - Free Lossless Audio Codec
2  * Copyright (C) 2002-2009  Josh Coalson
3  * Copyright (C) 2011-2016  Xiph.Org Foundation
4  *
5  * Redistribution and use in source and binary forms, with or without
6  * modification, are permitted provided that the following conditions
7  * are met:
8  *
9  * - Redistributions of source code must retain the above copyright
10  * notice, this list of conditions and the following disclaimer.
11  *
12  * - Redistributions in binary form must reproduce the above copyright
13  * notice, this list of conditions and the following disclaimer in the
14  * documentation and/or other materials provided with the distribution.
15  *
16  * - Neither the name of the Xiph.org Foundation nor the names of its
17  * contributors may be used to endorse or promote products derived from
18  * this software without specific prior written permission.
19  *
20  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
21  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
22  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
23  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
24  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
25  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
26  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
27  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
28  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
29  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
30  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
31  */
32 
33 #ifndef FLAC__PRIVATE__OGG_DECODER_ASPECT_H
34 #define FLAC__PRIVATE__OGG_DECODER_ASPECT_H
35 
36 #include <ogg/ogg.h>
37 
38 #include "FLAC/ordinals.h"
39 #include "FLAC/stream_decoder.h" /* for FLAC__StreamDecoderReadStatus */
40 
41 typedef struct FLAC__OggDecoderAspect {
42 	/* these are storage for values that can be set through the API */
43 	FLAC__bool use_first_serial_number;
44 	long serial_number;
45 
46 	/* these are for internal state related to Ogg decoding */
47 	ogg_stream_state stream_state;
48 	ogg_sync_state sync_state;
49 	unsigned version_major, version_minor;
50 	FLAC__bool need_serial_number;
51 	FLAC__bool end_of_stream;
52 	FLAC__bool have_working_page; /* only if true will the following vars be valid */
53 	ogg_page working_page;
54 	FLAC__bool have_working_packet; /* only if true will the following vars be valid */
55 	ogg_packet working_packet; /* as we work through the packet we will move working_packet.packet forward and working_packet.bytes down */
56 } FLAC__OggDecoderAspect;
57 
58 void FLAC__ogg_decoder_aspect_set_serial_number(FLAC__OggDecoderAspect *aspect, long value);
59 void FLAC__ogg_decoder_aspect_set_defaults(FLAC__OggDecoderAspect *aspect);
60 FLAC__bool FLAC__ogg_decoder_aspect_init(FLAC__OggDecoderAspect *aspect);
61 void FLAC__ogg_decoder_aspect_finish(FLAC__OggDecoderAspect *aspect);
62 void FLAC__ogg_decoder_aspect_flush(FLAC__OggDecoderAspect *aspect);
63 void FLAC__ogg_decoder_aspect_reset(FLAC__OggDecoderAspect *aspect);
64 
65 typedef enum {
66 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_OK = 0,
67 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_END_OF_STREAM,
68 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_LOST_SYNC,
69 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_NOT_FLAC,
70 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_UNSUPPORTED_MAPPING_VERSION,
71 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_ABORT,
72 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_ERROR,
73 	FLAC__OGG_DECODER_ASPECT_READ_STATUS_MEMORY_ALLOCATION_ERROR
74 } FLAC__OggDecoderAspectReadStatus;
75 
76 typedef FLAC__OggDecoderAspectReadStatus (*FLAC__OggDecoderAspectReadCallbackProxy)(const void *decoder, FLAC__byte buffer[], size_t *bytes, void *client_data);
77 
78 FLAC__OggDecoderAspectReadStatus FLAC__ogg_decoder_aspect_read_callback_wrapper(FLAC__OggDecoderAspect *aspect, FLAC__byte buffer[], size_t *bytes, FLAC__OggDecoderAspectReadCallbackProxy read_callback, const FLAC__StreamDecoder *decoder, void *client_data);
79 
80 #endif
81