src/SyncEncoder.h

   1 /*
   2 Copyright (c) 2013-2013, John Hurst
   3 All rights reserved.
   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 1. Redistributions of source code must retain the above copyright
   9    notice, this list of conditions and the following disclaimer.
  10 2. Redistributions in binary form must reproduce the above copyright
  11    notice, this list of conditions and the following disclaimer in the
  12    documentation and/or other materials provided with the distribution.
  13 3. The name of the author may not be used to endorse or promote products
  14    derived from this software without specific prior written permission.
  15
  16 THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  17 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  18 OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  19 IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  20 INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  21 NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  22 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  23 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  24 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  25 THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  26 */
  27 /*! \file    SyncEncoder.h
  28     \version $Id$
  29     \brief   Declaration of Atmos Sync Frame Encoder
  30 */
  31
  32 #ifndef _SYNC_ENCODER_H_
  33 #define _SYNC_ENCODER_H_
  34
  35 #include "SyncCommon.h"
  36 #include "UUIDInformation.h"
  37
  38 #ifdef __cplusplus
  39 extern "C" {
  40 #endif
  41
  42 typedef struct SyncEncoder{
  43         INT                             iSampleRate;                    /* Signal sample rate */
  44         INT                             iSymbolLength;                  /* Symbol Length */
  45         INT                             iFrameRate;                             /* Frame rate */
  46         INT                             iFrameRateCode;                 /* Frame rate code */
  47         INT                             iAudioBufferLength;             /* Length of audio buffer */
  48         INT                             iPacketBits;                    /* Bits in each packet includes wash bits */
  49         INT                             iPacketsPerFrame;               /* Number of packets per frame */
  50         FLOAT                   fSymbolPhase;                   /* Symbol phase */
  51
  52         INT                             iUUIDSubIndex;                  /* UUID transmission sub index */
  53         UUIDINFORMATION UUID;                                   /* UUID */
  54
  55         BYTE                    abyPacket[MAX_PACKET];
  56
  57         INT                             iError;                                 /* Error state */
  58 }SYNCENCODER,*LPSYNCENCODER;
  59
  60 enum{
  61         SYNC_ENCODER_ERROR_NONE = 0,                    /* No error */
  62         SYNC_ENCODER_ERROR_INVALID_SR = -1,             /* Invalid sample rate */
  63         SYNC_ENCODER_ERROR_INVALID_FR = -2,             /* Invalid frame rate */
  64         SYNC_ENCODER_ERROR_INVALID_BL = -10,    /* Buffer length is incorrect */
  65         SYNC_ENCODER_ERROR_UNKNOWN = -100,              /* Unknown */
  66 };
  67
  68
  69 INT SyncEncoderInit(LPSYNCENCODER               pSyncEncoder,   /* Out: SYNCENCODER structure to be initialized */
  70                                         INT                                     iSampleRate,    /* In:  Signal sample rate */
  71                                         INT                                     iFrameRate,             /* In:  frame rate */
  72                                         LPUUIDINFORMATION       pUUID);                 /* In:  UUID */
  73
  74 INT GetSyncEncoderAudioBufferLength(LPSYNCENCODER pSyncEncoder);
  75
  76 INT EncodeSync( LPSYNCENCODER   pSyncEncoder,   /* In:  Sync encoder structure */
  77                                 INT                             iBufferLength,  /* In:  Length of audio buffer */
  78                                 FLOAT                   *pfAudioBuffer, /* Out: Audio buffer with signal */
  79                                 INT                             iFrameIndex);   /* In:  Frame Index */
  80
  81 #ifdef __cplusplus
  82 } /* extern "C" */
  83 #endif
  84
  85 #endif
  86