minor comments
[flac.git] / src / libOggFLAC / ogg_encoder_aspect.c
1 /* libOggFLAC - Free Lossless Audio Codec + Ogg library
2  * Copyright (C) 2002,2003,2004  Josh Coalson
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  *
8  * - Redistributions of source code must retain the above copyright
9  * notice, this list of conditions and the following disclaimer.
10  *
11  * - Redistributions in binary form must reproduce the above copyright
12  * notice, this list of conditions and the following disclaimer in the
13  * documentation and/or other materials provided with the distribution.
14  *
15  * - Neither the name of the Xiph.org Foundation nor the names of its
16  * contributors may be used to endorse or promote products derived from
17  * this software without specific prior written permission.
18  *
19  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22  * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
23  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
24  * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
25  * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
26  * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
27  * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
28  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
29  * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30  */
31
32 #include <string.h> /* for memset() */
33 #include "FLAC/assert.h"
34 #include "private/ogg_encoder_aspect.h"
35
36 /***********************************************************************
37  *
38  * Public class methods
39  *
40  ***********************************************************************/
41
42 FLAC__bool OggFLAC__ogg_encoder_aspect_init(OggFLAC__OggEncoderAspect *aspect)
43 {
44         /* we will determine the serial number later if necessary */
45         if(ogg_stream_init(&aspect->stream_state, aspect->serial_number) != 0)
46                 return false;
47
48         aspect->is_first_packet = true;
49         aspect->samples_written = 0;
50 #if 0
51         /*@@@@@@ not used, get rid of it? */
52         aspect->bytes_written = 0;
53 #endif
54
55         return true;
56 }
57
58 void OggFLAC__ogg_encoder_aspect_finish(OggFLAC__OggEncoderAspect *aspect)
59 {
60         (void)ogg_stream_clear(&aspect->stream_state);
61         /*@@@ what aobut the page? */
62 }
63
64 void OggFLAC__ogg_encoder_aspect_set_serial_number(OggFLAC__OggEncoderAspect *aspect, long value)
65 {
66         aspect->serial_number = value;
67 }
68
69 void OggFLAC__ogg_encoder_aspect_set_defaults(OggFLAC__OggEncoderAspect *aspect)
70 {
71         aspect->serial_number = 0;
72 }
73
74 FLAC__StreamEncoderWriteStatus OggFLAC__ogg_encoder_aspect_write_callback_wrapper(OggFLAC__OggEncoderAspect *aspect, const FLAC__uint64 total_samples_estimate, const FLAC__byte buffer[], unsigned bytes, unsigned samples, unsigned current_frame, OggFLAC__OggEncoderAspectWriteCallbackProxy write_callback, void *encoder, void *client_data)
75 {
76         /* WATCHOUT:
77          * This depends on the behavior of FLAC__StreamEncoder that 'samples'
78          * will be 0 for metadata writes.
79          */
80         const FLAC__bool is_metadata = (samples == 0);
81         ogg_packet packet;
82
83         aspect->samples_written += samples;
84
85         memset(&packet, 0, sizeof(packet));
86         packet.packet = (unsigned char *)buffer;
87         packet.granulepos = aspect->samples_written;
88         packet.bytes = bytes;
89
90         if(aspect->is_first_packet) {
91                 packet.b_o_s = 1;
92                 aspect->is_first_packet = false;
93         }
94
95         if(total_samples_estimate > 0 && total_samples_estimate == aspect->samples_written)
96                 packet.e_o_s = 1;
97
98         if(ogg_stream_packetin(&aspect->stream_state, &packet) != 0)
99                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
100
101         /*
102          * For the initial fLaC header and metadata blocks, we will try and
103          * force them to all be on their own page.
104          *
105          * For audio frames, we let Ogg do the paging.
106          */
107         /*@@@@@@ combine fLaC header + STREAMINFO into the first page? 2 packets or 1 packet? */
108         /*@@@@@@ need our own implementation of ogg_stream_flush to max out the page instead of use its 4096 nominal page size */
109         /*@@@@@@ can't figure out a way to pass a useful number for 'samples' to the write_callback, so we'll just pass 0 */
110         if (is_metadata) {
111                 while(ogg_stream_flush(&aspect->stream_state, &aspect->page) != 0) {
112                         if(write_callback(encoder, aspect->page.header, aspect->page.header_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
113                                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
114 #if 0
115                         /*@@@@@@ not used, get rid of it? */
116                         aspect->bytes_written += aspect->page.header_len;
117 #endif
118                         if(write_callback(encoder, aspect->page.body, aspect->page.body_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
119                                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
120 #if 0
121                         /*@@@@@@ not used, get rid of it? */
122                         aspect->bytes_written += aspect->page.body_len;
123 #endif
124                 }
125         }
126         else {
127                 while(ogg_stream_pageout(&aspect->stream_state, &aspect->page) != 0) {
128                         if(write_callback(encoder, aspect->page.header, aspect->page.header_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
129                                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
130 #if 0
131                         /*@@@@@@ not used, get rid of it? */
132                         aspect->bytes_written += aspect->page.header_len;
133 #endif
134                         if(write_callback(encoder, aspect->page.body, aspect->page.body_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
135                                 return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
136 #if 0
137                         /*@@@@@@ not used, get rid of it? */
138                         aspect->bytes_written += aspect->page.body_len;
139 #endif
140                 }
141         }
142
143         return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
144 }