avcencoder.h

Nokia H.264/AVC Encoder/Decoder Usage Manual

/*
COPYRIGHT, LICENSE AND WARRANTY INFORMATION

This software module has been originally developed by Nokia Corporation. 

Provided that a person, entity or a company willing to use the Software 
(hereinafter Licensee) comply with all the terms and conditions of this 
Statement and subject to the limitations set forth in this Statement Nokia 
grants to such Licensee a non-exclusive, sub-licensable, worldwide, 
limited license under copyrights owned by Nokia to use the Software for 
the sole purpose of creating, manufacturing, selling, marketing, or  
distributing (including the right to make modifications to the Software) 
a fully compliant decoder implementation (hereinafter "Decoder") of 
ITU-T Recommendation H.264 / ISO/IEC International Standard 14496-10 and 
an encoder implementation producing output that is decodable with the 
Decoder.

Nokia retains the ownership of copyrights to the Software. There is no 
patent nor other intellectual property right of Nokia licensed under this 
Statement (except the copyright license above). Licensee hereby assumes 
sole responsibility to secure any other intellectual property rights 
needed, if any. For example, if patent licenses  are required, it is 
their responsibility to acquire the license before utilizing the Software.

The license by Nokia is subject to that the Licensee grants to Nokia the 
non-exclusive, worldwide, royalty-free, perpetual and irrevocable 
covenant that the Licensee(s) shall not bring a suit before any court or 
administrative agency or otherwise assert a claim for infringement under 
the Licensee intellectual property rights that, but for a license, would 
be infringed by the Software against  
   (a)  Nokia or Nokia's Affiliate; or  
   (b)  other recipient of a license and covenant not to sue with respect 
        to the Software from Nokia; or 
   (c)  contractor, customer or distributor of a party listed above in a 
        or b,  
which suit or claim is related to the Software or use thereof.

The Licensee(s) further agrees to grant a reciprocal license to Nokia 
(as granted by Nokia to the Licensee(s) on the modifications made by 
Licensee(s) to the Software. 

THE SOFTWARE IS PROVIDED "AS IS" AND THE ORIGINAL DEVELOPER DISCLAIMS 
ANY AND ALL WARRANTIES WHETHER EXPRESS, IMPLIED OR STATUTORY, INCLUDING 
BUT NOT LIMITED TO THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS 
FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. THOSE INTENDING TO USE 
THE SOFTWARE ARE EXPRESSLY ADVISED THAT ITS USE MAY INFRINGE EXISTING 
PATENTS AND BE SUBJECT TO ROYALTY PAYMENTS TO PATENT OWNERS. ANYONE 
USING THE SOFTWARE ON THE BASIS OF THIS LICENSE AGREES TO OBTAIN THE 
NECESSARY PERMISSIONS FROM ANY AND ALL APPLICABLE PATENT OWNERS FOR SUCH 
USE.

IN NO EVENT SHALL THE ORIGINAL DEVELOPER BE LIABLE FOR ANY CLAIM, 
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT 
OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE 
OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

This copyright, license and warranty information notice must be retained 
in all copies and derivative works of the Software or substantial 
portions thereof.
*/



#ifndef _AVCENCODER_H_
#define _AVCENCODER_H_


/* AVC encoder return codes */
#define AVCE_ERROR          -1
#define AVCE_OK             0
#define AVCE_FRAME_SKIPPED  1

#include "encparams.h"


typedef void avceEncoder_t;

typedef encParams_s avceOpenParams_s;


/* YUV buffer used to pass YUV data to and from encoder */
typedef struct _avceYUVbuffer_s 
{
  void *y;
  void *u;
  void *v;
} avceYUVbuffer_s;


/* Statistics returned by encder */
typedef struct _avceStatistics_s 
{
  double psnrY;
  double psnrU;
  double psnrV;
  int bits;
  int nFrames;

  int bufFullness;    // buffer occupancy at the end of a frame
  int numIntraMbs;    // number of macroblocks encoded as intra in this frame
} avceStatistics_s;


void avceLoad();

avceEncoder_t *avceOpen(avceOpenParams_s *param,void **nalBuffer, int *nalBufSize);

int avceEncodeOneFrame(avceEncoder_t *pSeq, avceYUVbuffer_s *origPic,
                       avceYUVbuffer_s *recoPic, int intraFlag, 
                       int idrFlag, int scutFlag, int nalRefIdc, int ltrCandidate,
                       int srcPicNum, int qp, void **nalBuffer, int *nalBufSize);

int avceEncodeSceneInfo(avceEncoder_t *pSeq, int sceneId, void **nalBuffer, int *nalBufSize);

void avceClose(avceEncoder_t *encoder);

void avceGetIntraStat(avceEncoder_t *seq, avceStatistics_s *stat);

void avceGetInterStat(avceEncoder_t *seq, avceStatistics_s *stat);

void avceGetSeqStat(avceEncoder_t *seq, avceStatistics_s *stat);

void avceGetFrmStat(avceEncoder_t *seq, avceStatistics_s *stat);

int avceGetBitsNAL(avceEncoder_t *seq);

int avceGetBitsSPS(avceEncoder_t *seq);

int avceGetBitsPPS(avceEncoder_t *seq);

void avceUpdateEncodingParameters(avceEncoder_t *encoder, avceOpenParams_s *param);

#endif