matrixlib.h

/*
 * Copyright (c) 2011 Apple Inc. All rights reserved.
 *
 * @APPLE_APACHE_LICENSE_HEADER_START@
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 * http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * 
 * @APPLE_APACHE_LICENSE_HEADER_END@
 */

/*
 File: matrixlib.h

 Contains: ALAC mixing/matrixing routines to/from 32-bit predictor buffers.

 Copyright: Copyright (C) 2004 to 2011 Apple, Inc.
*/

#ifndef__MATRIXLIB_H
#define__MATRIXLIB_H

#pragma once

#include<stdint.h>

#ifdef__cplusplus
extern"C" {
#endif

// 16-bit routines
voidmix16( int16_t*in, uint32_tstride, int32_t*u, int32_t*v, int32_tnumSamples, int32_tmixbits, int32_tmixres );
voidunmix16( int32_t*u, int32_t*v, int16_t*out, uint32_tstride, int32_tnumSamples, int32_tmixbits, int32_tmixres );

// 20-bit routines
voidmix20( uint8_t*in, uint32_tstride, int32_t*u, int32_t*v, int32_tnumSamples, int32_tmixbits, int32_tmixres );
voidunmix20( int32_t*u, int32_t*v, uint8_t*out, uint32_tstride, int32_tnumSamples, int32_tmixbits, int32_tmixres );

// 24-bit routines
// - 24-bit data sometimes compresses better by shifting off the bottom byte so these routines deal with
// the specified "unused lower bytes" in the combined "shift" buffer
voidmix24( uint8_t*in, uint32_tstride, int32_t*u, int32_t*v, int32_tnumSamples,
int32_tmixbits, int32_tmixres, uint16_t*shiftUV, int32_tbytesShifted );
voidunmix24( int32_t*u, int32_t*v, uint8_t*out, uint32_tstride, int32_tnumSamples,
int32_tmixbits, int32_tmixres, uint16_t*shiftUV, int32_tbytesShifted );

// 32-bit routines
// - note that these really expect the internal data width to be < 32-bit but the arrays are 32-bit
// - otherwise, the calculations might overflow into the 33rd bit and be lost
// - therefore, these routines deal with the specified "unused lower" bytes in the combined "shift" buffer
voidmix32( int32_t*in, uint32_tstride, int32_t*u, int32_t*v, int32_tnumSamples,
int32_tmixbits, int32_tmixres, uint16_t*shiftUV, int32_tbytesShifted );
voidunmix32( int32_t*u, int32_t*v, int32_t*out, uint32_tstride, int32_tnumSamples,
int32_tmixbits, int32_tmixres, uint16_t*shiftUV, int32_tbytesShifted );

// 20/24/32-bit <-> 32-bit helper routines (not really matrixing but convenient to put here)
voidcopy20ToPredictor( uint8_t*in, uint32_tstride, int32_t*out, int32_tnumSamples );
voidcopy24ToPredictor( uint8_t*in, uint32_tstride, int32_t*out, int32_tnumSamples );

voidcopyPredictorTo24( int32_t*in, uint8_t*out, uint32_tstride, int32_tnumSamples );
voidcopyPredictorTo24Shift( int32_t*in, uint16_t*shift, uint8_t*out, uint32_tstride, int32_tnumSamples, int32_tbytesShifted );
voidcopyPredictorTo20( int32_t*in, uint8_t*out, uint32_tstride, int32_tnumSamples );

voidcopyPredictorTo32( int32_t*in, int32_t*out, uint32_tstride, int32_tnumSamples );
voidcopyPredictorTo32Shift( int32_t*in, uint16_t*shift, int32_t*out, uint32_tstride, int32_tnumSamples, int32_tbytesShifted );

#ifdef__cplusplus
}
#endif

#endif/* __MATRIXLIB_H */