flac/src/libOggFLAC/ogg_encoder_aspect.c

/* libOggFLAC - Free Lossless Audio Codec + Ogg library
 * Copyright (C) 2002,2003,2004  Josh Coalson
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * - Redistributions of source code must retain the above copyright
 * notice, this list of conditions and the following disclaimer.
 *
 * - Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * - Neither the name of the Xiph.org Foundation nor the names of its
 * contributors may be used to endorse or promote products derived from
 * this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#include <string.h> /* for memset() */
#include "FLAC/assert.h"
#include "private/ogg_encoder_aspect.h"

/***********************************************************************
 *
 * Public class methods
 *
 ***********************************************************************/

FLAC__bool OggFLAC__ogg_encoder_aspect_init(OggFLAC__OggEncoderAspect *aspect)
{
	/* we will determine the serial number later if necessary */
	if(ogg_stream_init(&aspect->stream_state, aspect->serial_number) != 0)
		return false;

	aspect->is_first_packet = true;
	aspect->samples_written = 0;
#if 0
	/*@@@@@@ not used, get rid of it? */
	aspect->bytes_written = 0;
#endif

	return true;
}

void OggFLAC__ogg_encoder_aspect_finish(OggFLAC__OggEncoderAspect *aspect)
{
	(void)ogg_stream_clear(&aspect->stream_state);
	/*@@@ what aobut the page? */
}

void OggFLAC__ogg_encoder_aspect_set_serial_number(OggFLAC__OggEncoderAspect *aspect, long value)
{
	aspect->serial_number = value;
}

void OggFLAC__ogg_encoder_aspect_set_defaults(OggFLAC__OggEncoderAspect *aspect)
{
	aspect->serial_number = 0;
}

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)
{
	ogg_packet packet;

	aspect->samples_written += samples;

	memset(&packet, 0, sizeof(packet));
	packet.packet = (unsigned char *)buffer;
	packet.granulepos = aspect->samples_written;
	/* WATCHOUT:
	 * This depends on the behavior of FLAC__StreamEncoder that 'samples'
	 * will be 0 for metadata writes.
	 */
	packet.packetno = (samples == 0? -1 : (int)current_frame);
	packet.bytes = bytes;

	if(aspect->is_first_packet) {
		packet.b_o_s = 1;
		aspect->is_first_packet = false;
	}

	if(total_samples_estimate > 0 && total_samples_estimate == aspect->samples_written)
		packet.e_o_s = 1;

	if(ogg_stream_packetin(&aspect->stream_state, &packet) != 0)
		return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;

	/*
	 * For the initial fLaC header and metadata blocks, we will try and
	 * force them to all be on their own page.
	 *
	 * For audio frames, we let Ogg do the paging.
	 */
	/*@@@@@@ combine fLaC header + STREAMINFO into the first page? 2 packets or 1 packet? */
	/*@@@@@@ need our own implementation of ogg_stream_flush to max out the page instead of use its 4096 nominal page size */
	/*@@@@@@ can't figure out a way to pass a useful number for 'samples' to the write_callback, so we'll just pass 0 */
	if (packet.packetno == -1) {
		while(ogg_stream_flush(&aspect->stream_state, &aspect->page) != 0) {
			if(write_callback(encoder, aspect->page.header, aspect->page.header_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
				return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
#if 0
			/*@@@@@@ not used, get rid of it? */
			aspect->bytes_written += aspect->page.header_len;
#endif
			if(write_callback(encoder, aspect->page.body, aspect->page.body_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
				return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
#if 0
			/*@@@@@@ not used, get rid of it? */
			aspect->bytes_written += aspect->page.body_len;
#endif
		}
	}
	else {
		while(ogg_stream_pageout(&aspect->stream_state, &aspect->page) != 0) {
			if(write_callback(encoder, aspect->page.header, aspect->page.header_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
				return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
#if 0
			/*@@@@@@ not used, get rid of it? */
			aspect->bytes_written += aspect->page.header_len;
#endif
			if(write_callback(encoder, aspect->page.body, aspect->page.body_len, 0, current_frame, client_data) != FLAC__STREAM_ENCODER_WRITE_STATUS_OK)
				return FLAC__STREAM_ENCODER_WRITE_STATUS_FATAL_ERROR;
#if 0
			/*@@@@@@ not used, get rid of it? */
			aspect->bytes_written += aspect->page.body_len;
#endif
		}
	}

	return FLAC__STREAM_ENCODER_WRITE_STATUS_OK;
}