PASDK-218:Update ASOT top-level State Machine.
[processor-sdk/performance-audio-sr.git] / pasdk / test_dsp / framework / audioStreamOutProc.c
2 /*
3 Copyright (c) 2017, Texas Instruments Incorporated - http://www.ti.com/
4 All rights reserved.
6 * Redistribution and use in source and binary forms, with or without 
7 * modification, are permitted provided that the following conditions
8 * are met:
9 *
10 * Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 *
13 * Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the
16 * distribution.
17 *
18 * Neither the name of Texas Instruments Incorporated nor the names of
19 * its contributors may be used to endorse or promote products derived
20 * from this software without specific prior written permission.
21 *
22 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
23 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
24 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
25 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
26 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
27 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
28 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
29 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
30 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
31 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
32 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
33 *
34 */
36 /*
37  *  ======== audioStreamOutProc.c ========
38  */
40 #include <string.h> // for memset
41 #include <xdc/runtime/Log.h>
42 #include <xdc/runtime/Error.h>
43 #include <xdc/runtime/Memory.h>
44 #include <ti/sysbios/knl/Clock.h>
45 #include <ti/sysbios/knl/Task.h>
47 #include "paferr.h"
48 #include <acp_mds.h>
49 #include <pcm.h>
50 #include <pce.h>
51 #include <pafsio_ialg.h>
52 #include <stdasp.h>
53 #include <doberr.h>
54 #include "asperr.h"
56 #include "common.h"
57 #include "aspMsg_common.h"
58 #include "aspMsg_master.h"
59 #include "aspDecOpCircBuf_master.h"
60 #include "aspOutInitSync_master.h"
61 #include "audioStreamProc_common.h"
62 #include "audioStreamOutProc.h"
64 #include "pfp/pfp.h"
65 #include "pfp_app.h"        /* contains all PFP ID's */
66 Int32 gNumPfpAsot1=0; // debug
68 // FL: debug
69 #include "evmc66x_gpio_dbg.h"
72 #define TRACE_TIME(a)
74 //
75 // Audio Stream Definitions
76 //
78 //
79 // Audio Stream Processing Definitions
80 //
81 #define aspLinkInit pQ->i_aspLinkInit
83 //
84 // Encoder Definitions
85 //
86 #define encLinkInit pQ->i_encLinkInit
88 //
89 // Output Definitions
90 //
91 #define outLinkInit pP->i_outLinkInit
93 /* ---------------------------------------------------------------- */
94 /*              Parameter macro definitions end here.               */
95 /* ---------------------------------------------------------------- */
97 //
98 // Standardized Definitions
99 //
101 #define ENC_Handle PCE_Handle /* works for all: PCE */
103 #define __TASK_NAME__  "TaskAsop"
106 //
107 // Audio Stream Output Task definitions
108 //
110 // status codes
111 // Output FSM
112 #define ASOP_INITSYNC_NOTREADY      (  1 )  // ok, init-sync not ready
113 #define ASOP_SOK                    (  0 )  // ok
114 #define ASOP_FORWARD_ERR            ( -1 )  // forward (ASIT) error
115 #define ASOP_ENCRESET_ERR           ( -2 )  // enc reset error
116 #define ASOP_DECINFO1_ERR           ( -3 )  // dec info1 error
117 // Decode Processing
118 #define ASOP_DP_OUT_SIO_UPDATE      (  3 )  // new output selected
119 #define ASOP_DP_CB_DRAINED          (  2 )  // circular buffer drained
120 #define ASOP_DP_SOK                 (  0 )  // ok
121 #define ASOP_DP_FORWARD_ERR         ( -1 )  // forward (ASIT) error
122 #define ASOP_DP_DECINIT_ERR         ( -2 )  // decode init error
123 #define ASOP_DP_DECSTREAM_ERR       ( -3 )  // decode stream error
124 #define ASOP_DP_DECENC_ERR          ( -4 )  // decode encode error
125 #define ASOP_DP_DECINFO2_ERR        ( -5 )  // decode encode error
126 #define ASOP_DP_DECFINALTEST_ERR    ( -6 )  // decode final error
130 /* Check if at least one output selected */
131 static Int checkOutSel(
132     const PAF_ASOT_Params *pP, 
133     PAF_ASOT_Config *pAsotCfg,
134     Int *pOutSel
135 );
137 /* Check if at least one output sio changed */
138 static Int checkOutSio(
139     const PAF_ASOT_Params *pP, 
140     PAF_ASOT_Config *pAsotCfg,
141     Int *pOutSioUpdate
142 );
144 // Initialize Output Processing state function
145 static Int PAF_ASOT_initOutProc(
146     const PAF_ASOT_Params *pP, 
147     PAF_AST_Stream *xStr
148 );
150 // Initialize Output Processing state function
151 static Int PAF_ASOT_initSyncDecReset(
152     const PAF_ASOT_Params *pP, 
153     const PAF_ASOT_Patchs *pQ, 
154     PAF_ASOT_Config *pAsotCfg,
155     PAF_AudioFrame *pDecResetAf
156 );
158 //   Purpose:   ASOT Function for Output reset
159 static Int PAF_ASOT_outputReset(
160     const PAF_ASOT_Params *pP, 
161     const PAF_ASOT_Patchs *pQ, 
162     PAF_ASOT_Config *pAsotCfg
163 );
165 //   Purpose:   Init-Sync Dec Info1 state function.
166 //              Performes Dec Info1 Init-Sync.
167 static Int PAF_ASOT_initSyncDecInfo1(
168     const PAF_ASOT_Params *pP, 
169     const PAF_ASOT_Patchs *pQ, 
170     PAF_ASOT_Config *pAsotCfg,
171     PAF_AudioFrame *pDecInfo1Af
172 );
174 //   Purpose:   ASOT function for ASP chain reset and ENC info
175 static Int PAF_ASOT_outputInfo1(
176     const PAF_ASOT_Params *pP, 
177     const PAF_ASOT_Patchs *pQ, 
178     PAF_ASOT_Config *pAsotCfg
179 );
181 //   Purpose:   Init-Sync Dec Decode1 state function.
182 //              Performes Dec Decode1 Init-Sync.
183 static Int PAF_ASOT_initSyncDecDecode1(
184     const PAF_ASOT_Params *pP, 
185     const PAF_ASOT_Patchs *pQ, 
186     PAF_ASOT_Config *pAsotCfg
187 );
189 //   Purpose:   Init-Sync Re-Sync state function.
190 //              Peformed Init-Sync using stored Dec Reset/Info1 AFs.
191 static Int PAF_ASOT_initSyncResync(
192     const PAF_ASOT_Params *pP, 
193     const PAF_ASOT_Patchs *pQ, 
194     PAF_ASOT_Config *pAsotCfg,
195     PAF_AudioFrame *pDecResetAf,
196     PAF_AudioFrame *pDecInfo1Af  
197 );
199 #if 0
200 // Init-Sync update audio frame
201 static Int initSyncUpdateAf(
202     PAF_AudioFrame *dstAf, 
203     PAF_AudioFrame *srcAf
204 );
205 #endif
207 // Reset audio frames
208 static Void resetAfs(
209     const PAF_ASOT_Params *pP, 
210     PAF_AST_Stream *xStr
211 );
213 // Reset audio frame pointers to original values
214 static Void resetAfPointers(
215     const PAF_ASOT_Params *pP, 
216     PAF_AST_Stream *xStr
217 );
219 // Reset audio frame meta data elements
220 static Void resetAfMetadata(
221     const PAF_ASOT_Params *pP, 
222     PAF_AST_Stream *xStr
223 );
226 LINNO_DEFN(TaskAsop); /* Line number macros */
227 ERRNO_DEFN(TaskAsop); /* Error number macros */
229 // ASOT configuration
230 #pragma DATA_SECTION(gPAF_ASOT_config, ".globalSectionPafAsotConfig")
231 PAF_ASOT_Config gPAF_ASOT_config = {
232     NULL,               // taskHandle
233     NULL,               // acp
234     0,0,0,              // CB drained flags (size DECODE_MAXN)
235     &gPAF_ASPM_config,  // pAspmCfg
236     &gPAF_AST_config    // pAstCfg
237 };
239 // Underflow threshold before circular buffer reset and return error to Top-Level FSM
240 #define DEC_OP_CB_RDAF_UND_THR  ( 80 ) // FL: arbitrary setting
241 UInt32 gCbReadAfErr         =0; // read circular buffer error count, not including underflows
242 UInt32 gDecOpCbRdAfUnd      =0; // decoder output circular buffer underflow count
243 UInt32 gMaxDecOpCbRdAfUnd   =0; // max (consecutive) decoder output circular buffer underflow count
244 UInt32 gMasterCbResetCnt    =0; // master circular buffer reset count
246 // Global debug counters */
247 UInt32 gAsopInitOutProcCnt          =0;
248 UInt32 gAsopInitSyncDecResetCnt     =0;
249 UInt32 gAsopInitSyncDecInfo1Cnt     =0;
250 UInt32 gAsopInitSyncDecDecode1Cnt   =0;
251 UInt32 gAsopInitSyncResyncCnt       =0;
252 UInt32 gAsopOutProcCnt              =0;
253 UInt32 gAsopInitCnt                 =0;
254 UInt32 gAsopStreamCnt               =0;
255 UInt32 gAsopEncodeCnt               =0;
256 UInt32 gAsopFinalCnt                =0;
257 UInt32 gAsopOutSioUpdateCnt         =0;
258 UInt32 gAsopQuitCnt                 =0;
259 UInt32 gAsopTxSioReclaimCnt         =0;
262 /*
263  *  ======== taskAsopFxn ========
264  *  Audio Stream Output Processing task function
265  */
266 Void taskAsopFxn(
267 //    Int betaPrimeValue, // FL: revisit
268     const PAF_ASOT_Params *pP,
269     const PAF_ASOT_Patchs *pQ
272     PAF_ASOT_Config *pAsotCfg;      /* ASOT configuration pointer */
273     PAF_AST_Config *pAstCfg;        /* Common (shared) configuration pointer */
274     Int as;                         /* Audio Stream Number (1, 2, etc.) */
275     Int z;                          /* input/encode/stream/decode/output counter */
276     Int i;                          /* phase */
277     Int zMS;
278     Int errno;                      // error number
279     Int8 procSleep;                 // whether to sleep: 0: No, 1: Yes
280     Int8 procOutDevSel;             // whether to perform output device selection: 0: No, 1:Yes
281     Int outSel;                     // whether output device selected
282     enum { INIT_OUT_PROC_STATE, 
283            INITSYNC_DEC_RESET_STATE, INITSYNC_DEC_INFO1_STATE, INITSYNC_DEC_DECODE1_STATE, 
284            INITSYNC_RESYNC_STATE, 
285            OUT_PROC_STATE } state;
286     PAF_AudioFrame decResetAf;
287     PAF_AudioFrame decInfo1Af;
288     Int loopCount = 0;              // used to stop trace to see startup behavior.
289     
291     Log_info0("Enter taskAsopFxn()");    
293     //
294     // Audio Stream Output Task Parameters & Patch (*pP, *pQ)
295     //
296     if (!pP) 
297     {
298         TRACE_TERSE0("TaskAsop: No Parameters defined. Exiting.");
299         LINNO_RPRT(TaskAsop, -1);
300         return;
301     }
303     if (!pQ)
304     {
305         TRACE_TERSE0("TaskAsip: No Patchs defined. Exiting.");
306         LINNO_RPRT(TaskAsop, -1);
307         return;
308     }    
310     //
311     // Audio Stream Output Task Configuration (*pAsotCfg):
312     //
313     pAsotCfg = &gPAF_ASOT_config;       // initialize pointer to task configuration
314     pAsotCfg->taskHandle = Task_self(); // set task handle
315     pAstCfg = pAsotCfg->pAstCfg;        // get pointer to AST common (shared) configuration
317     /* Obtain Audio Stream Number (1, 2, etc.) */    
318     as = pAstCfg->as;
319     TRACE_TERSE1("TaskAsop: Started with AS%d.", as);
321     //
322     // Initialize message log trace and line number reporting
323     //
324     for (z=STREAM1; z < STREAMN; z++)
325     {
326         TRACE_TERSE1("TaskAsop: AS%d: initiated", as+z);
327     }
328     LINNO_RPRT(TaskAsop, -1);
329     
330     //
331     // Determine stream index
332     //
333     zMS = pAstCfg->masterStr;
335     // Initialize as per parametrized phases:
336     //
337     //   In standard form these are:
338     //      - Malloc: Memory Allocation
339     //      - Config: Configuration Initialization
340     //      - AcpAlg: ACP Algorithm Initialization and Local Attachment
341     //      - Common: Common Memory Initialization
342     //      - AlgKey: Dec/Enc chain to Array Initialization
343     //      - Device: I/O Device Initialization
344     //      - Unused: (available)
345     //      - Unused: (available)
346     //
347     LINNO_RPRT(TaskAsop, -2);
348     for (i=0; i < lengthof(pP->fxns->initPhase); i++)
349     {
350         Int linno;
351         if (pP->fxns->initPhase[i])
352         {
353             linno = pP->fxns->initPhase[i](pP, pQ, pAsotCfg);
354             if (linno) 
355             {
356                 LINNO_RPRT(TaskAsop, linno);
357                 return;
358             }
359         }
360         else 
361         {
362             TRACE_TERSE1("TaskAsop: AS%d: initialization phase - null", as+zMS);
363         }
364         TRACE_TERSE2("TaskAsop: AS%d: initialization phase - %d completed", as+zMS, i);
365         LINNO_RPRT(TaskAsop, -i-3);
366     }
367   
368     //
369     // End of Initialization -- display memory usage report.
370     //
371     if (pP->fxns->memStatusPrint)
372     {
373         pP->fxns->memStatusPrint("ASOT MEMSTAT REPORT",
374             HEAP_INTERNAL, HEAP_INTERNAL1, HEAP_EXTERNAL, 
375             HEAP_INTERNAL1_SHM, HEAP_EXTERNAL_SHM, HEAP_EXTERNAL_NONCACHED_SHM);
376     }
378     //
379     // Main processing loop
380     //   
381     for (z=STREAM1; z < STREAMN; z++)
382     {
383         TRACE_VERBOSE1("TaskAsip: AS%d: running", as+z);
384     }
385     
386     errno = 0;                      // init error indicator -- no error
387     procSleep = 1;                  // init sleep flag -- sleep
388     procOutDevSel = 1;              // init device output selection flag -- perform output device selection
389     state = INIT_OUT_PROC_STATE;    // init state
390     for (;;)
391     {
392         loopCount++;
393         TRACE_GEN2("TaskAsop (begin Main loop %d) (errno 0x%x)", loopCount, errno);
395         //
396         // Check forward (ASIT) error here, TBD
397         //
398         
399         // any error forces idling of output
400         if (errno) 
401         {
402             for (z=OUTPUT1; z < OUTPUTN; z++)
403             {
404                 if (pAstCfg->xOut[z].hTxSio)
405                 {
406                     SIO_idle(pAstCfg->xOut[z].hTxSio);
407                 }
408             }
409         
410             TRACE_TERSE1("TaskAsop: Trace stopped at loop %d.", loopCount);
411             ERRNO_RPRT(TaskAsop, errno);
412         }        
413     
414         if (procSleep == 1)
415         {
416             TRACE_VERBOSE1("TaskAsop: AS%d: ... sleeping ...", as+zMS);
417             Task_sleep(1);
418         }
420         if (procOutDevSel == 1)
421         {
422             // select output devices
423             TRACE_GEN1("TaskAsop: AS%d: Output device selection ...", as+zMS);
424             errno = pP->fxns->selectDevices(pP, pQ, pAsotCfg);
425             if (errno)
426             {
427                 TRACE_TERSE2("TaskAsop: AS%d: selectDevices returned errno = 0x%04x", as+zMS, errno);
429                 procSleep = 1;
430                 procOutDevSel = 1;
432                 continue;
433             }
435             // if no output selected skip remaining processing
436             errno = checkOutSel(pP, pAsotCfg, &outSel);
437             if (errno < 0)
438             {
439                 TRACE_TERSE2("TaskAsop: AS%d: checkOutSel returned errno = 0x%04x", as+zMS, errno);
441                 procSleep = 1;
442                 procOutDevSel = 1;
444                 continue;
445             }
446             else if (!outSel)
447             {
448                 TRACE_VERBOSE1("TaskAsop: AS%d: No output selected...", as+zMS);
450                 procSleep = 1;
451                 procOutDevSel = 1;
452                 
453                 continue;
454             }
455         }
456         
457         switch (state)
458         {
459             case INIT_OUT_PROC_STATE:
460                 gAsopInitOutProcCnt++;
461                 Log_info0("TaskAsop: state=INIT_OUT_PROC_STATE");
462                 
463                 //
464                 // Output Processing initialization.
465                 //
466                 errno = PAF_ASOT_initOutProc(pP, pAstCfg->xStr);
467                 if (errno < 0)
468                 {
469                     state = INIT_OUT_PROC_STATE;
470                     procSleep = 1;
471                     procOutDevSel = 1;
472                 }
473                 else
474                 {
475                     state = INITSYNC_DEC_RESET_STATE;
476                     procSleep = 0;
477                     procOutDevSel = 0;
478                 }
479             
480                 break;
481                 
482             case INITSYNC_DEC_RESET_STATE:
483                 gAsopInitSyncDecResetCnt++;
484                 Log_info0("TaskAsop: state=INITSYNC_DEC_RESET_STATE");
486                 //
487                 // Dec Reset Init-Sync.
488                 //  
489                 
490                 // Perform Dec Reset init-sync.
491                 // Latch Dec Reset AF.
492                 errno = PAF_ASOT_initSyncDecReset(pP, pQ, pAsotCfg, &decResetAf);
493                 if (errno < 0)
494                 {
495                     Log_info1("TaskAsop: state=INITSYNC_DEC_RESET_STATE errno=%d", errno);
497                     // sync error -- start over
498                     state = INIT_OUT_PROC_STATE;
499                     procSleep = 1;
500                     procOutDevSel = 1;
501                 }
502                 else if (errno == ASOP_INITSYNC_NOTREADY)
503                 {
504                     Log_info1("TaskAsop: state=INITSYNC_DEC_RESET_STATE not sync'd errno=%d", errno);
506                     // sync not ready -- try again
507                     state = INITSYNC_DEC_RESET_STATE;
508                     errno=0; // FL: temp hack
509                     procSleep = 1;
510                     procOutDevSel = 1;
511                 }
512                 else // errno==0
513                 {
514                     Log_info1("TaskAsop: state=INITSYNC_DEC_RESET_STATE sync'd, errno=%d", errno);
516                     // sync'd -- move on
517                     state = INITSYNC_DEC_INFO1_STATE;
518                     procSleep = 0;
519                     procOutDevSel = 0;
520                 }
521                 
522                 break;
523             
524             case INITSYNC_DEC_INFO1_STATE:
525                 gAsopInitSyncDecInfo1Cnt++;
526                 Log_info0("TaskAsop: state=INITSYNC_DEC_INFO1_STATE");
527                 
528                 //
529                 // Dec Info1 Init-Sync.
530                 //
532                 // Perform Dec Info1 init-sync.
533                 // Latch Dec Info1 AF.
534                 errno = PAF_ASOT_initSyncDecInfo1(pP, pQ, pAsotCfg, &decInfo1Af);
535                 if (errno < 0)
536                 {
537                     Log_info1("TaskAsop: state=INITSYNC_DEC_INFO1_STATE errno=%d", errno);
538                     
539                     // sync error -- start over
540                     state = INIT_OUT_PROC_STATE;
541                     procSleep = 1;
542                     procOutDevSel = 1;
543                 }
544                 else if (errno == ASOP_INITSYNC_NOTREADY)
545                 {
546                     Log_info1("TaskAsop: state=INITSYNC_DEC_INFO1_STATE not sync'd errno=%d", errno);
548                     // sync not ready -- try again
549                     state = INITSYNC_DEC_INFO1_STATE;
550                     errno=0; // FL: temp hack
551                     procSleep = 1;
552                     procOutDevSel = 0;
553                 }
554                 else // errno = 0
555                 {
556                     Log_info1("TaskAsop: state=INITSYNC_DEC_INFO1_STATE sync'd errno=%d", errno);
558                     // sync'd -- move on
559                     state = INITSYNC_DEC_DECODE1_STATE;
560                     procSleep = 0;
561                     procOutDevSel = 0;
562                 }
563                 
564                 break;
565             
566             case INITSYNC_DEC_DECODE1_STATE:
567                 gAsopInitSyncDecDecode1Cnt++;
568                 Log_info0("TaskAsop: state=INITSYNC_DEC_DECODE1_STATE");
569                 
570                 //
571                 // Dec Info1 Init-Sync.
572                 //
574                 // Perform Dec Info1 init-sync.
575                 // Latch Dec Info1 AF.
576                 errno = PAF_ASOT_initSyncDecDecode1(pP, pQ, pAsotCfg);
577                 if (errno < 0)
578                 {
579                     Log_info1("TaskAsop: state=INITSYNC_DEC_DECODE1_STATE errno=%d", errno);
581                     // sync error -- start over
582                     state = INIT_OUT_PROC_STATE;
583                     procSleep = 1;
584                     procOutDevSel = 1;
585                 }
586                 else if (errno == ASOP_INITSYNC_NOTREADY)
587                 {
588                     Log_info1("TaskAsop: state=INITSYNC_DEC_DECODE1_STATE not sync'd errno=%d", errno);
590                     // sync not ready -- try again
591                     state = INITSYNC_DEC_DECODE1_STATE;
592                     errno=0; // FL: temp hack
593                     procSleep = 1;
594                     procOutDevSel = 0;
595                 }
596                 else // errno = 0
597                 {
598                     Log_info1("TaskAsop: state=INITSYNC_DEC_DECODE1_STATE sync'd errno=%d", errno);
600                     // sync'd -- move on
601                     state = OUT_PROC_STATE;
602                     procSleep = 0;
603                     procOutDevSel = 0;
604                 }
605                 
606                 break;
607             
608             case INITSYNC_RESYNC_STATE:
609                 gAsopInitSyncResyncCnt++;
610                 Log_info0("TaskAsop: state=INITSYNC_RESYNC_STATE");
612                 //
613                 // Re-Sync.
614                 // Use stored AF info from init-sync.
615                 // This is done in case of local error.
616                 //
617                 
618                 // Perform Dec Info1 init-sync.
619                 errno = PAF_ASOT_initSyncResync(pP, pQ, pAsotCfg, &decResetAf, 
620                     &decInfo1Af);
621                 if (errno < 0)
622                 {
623                     Log_info1("TaskAsop: state=INITSYNC_RESYNC_STATE errno=%d", errno);
625                     // sync error -- start over
626                     state = INIT_OUT_PROC_STATE;
627                     procSleep = 1;
628                     procOutDevSel = 1;
629                 }
630                 else
631                 {
632                     Log_info1("TaskAsop: state=INITSYNC_RESYNC_STATE sync'd errno=%d", errno);
634                     // re-sync'd -- move on
635                     state = OUT_PROC_STATE;
636                     procSleep = 0;
637                     procOutDevSel = 0;
638                 }
639                     
640                 break;
641             
642             case OUT_PROC_STATE:        
643                 gAsopOutProcCnt++;
644                 Log_info0("TaskAsop: state=OUT_PROC_STATE");
645                 
646                 //
647                 // Output Processing.
648                 //
650                 TRACE_VERBOSE0("TaskAsop: calling decodeProcessing.");
651                 errno = pP->fxns->decodeProcessing(pP, pQ, pAsotCfg);
652                 if (errno < 0)
653                 {
654                     Log_info1("TaskAsop: state=OUT_PROC_STATE errno=%d", errno);
655                     
656                     //
657                     // Output Processing exit, due to error
658                     //
659                     
660                     TRACE_TERSE1("TaskAsop: decodeProcessing returns 0x%x, continue", errno);
661                     if (errno == ASOP_DP_FORWARD_ERR)
662                     {
663                         // forward (ASIT) error -- start over
664                         state = INIT_OUT_PROC_STATE;
665                         procSleep = 1;
666                         procOutDevSel = 1;
667                     }
668                     else
669                     {
670                         // local (ASOT) error
671                         state = INITSYNC_RESYNC_STATE;    
672                         procSleep = 1;
673                         procOutDevSel = 0; // disallow device re-select if local error during output processing
674                     }        
675                 }
676                 else if (errno > 0)
677                 {
678                     Log_info1("TaskAsop: state=OUT_PROC_STATE errno=%d", errno);
680                     //
681                     // Output Processing exit, not due to error
682                     //
684                     TRACE_TERSE1("TaskAsop: decodeProcessing returns 0x%x, continue", errno);                    
685                     if (errno == ASOP_DP_OUT_SIO_UPDATE)
686                     {
687                         // skip re-sync
688                         // resume output processing after new output selected
689                         state = OUT_PROC_STATE;
690                         procSleep = 1;
691                         procOutDevSel = 1;
692                     }
693                 }
694                 else
695                 {
696                     Log_info1("TaskAsop: state=OUT_PROC_STATE errno=%d", errno);
698                     //
699                     // Output Processing exit, normal
700                     //
701                     
702                     TRACE_VERBOSE0("TaskAsop: outputProcessing complete with no error.");
703                     
704                     // no error returned if CB drained 
705                     // (i.e. CB drained is normal behavior)
706                     state = INIT_OUT_PROC_STATE;
707                     procSleep = 1;
708                     procOutDevSel = 1;
709                 }
710                 
711                 break;
712             
713             default: // unknown state
714                 TRACE_TERSE2("TaskAsop: AS%d: state: unknown, 0x%x", as+zMS, state);
715                 break;
716         }
717     } // End of main processing loop for (;;)
718     
719     //Log_info0("Exit taskAsopFxn()");
722 // -----------------------------------------------------------------------------
723 // AST Initialization Function - Memory Allocation
724 //
725 //   Name:      PAF_ASOT_initPhaseMalloc
726 //   Purpose:   Audio Stream Output Task Function for initialization of data pointers
727 //              by allocation of memory.
728 //   From:      audioStream1Task or equivalent
729 //   Uses:      See code.
730 //   States:    x
731 //   Return:    0 on success.
732 //              Source code line number on MEM_calloc failure.
733 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
734 //              * State information as per parent.
735 //              * Memory allocation errors.
736 //
738 Int
739 PAF_ASOT_initPhaseMalloc (
740     const PAF_ASOT_Params *pP, 
741     const PAF_ASOT_Patchs *pQ, 
742     PAF_ASOT_Config *pAsotCfg
745     PAF_AST_Config *pAstCfg;
746     Int as;                     /* Audio Stream Number (1, 2, etc.) */
747     Int zMS;
748     Error_Block    eb;
749     //Int i;
751     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
752     as = pAstCfg->as;
753     zMS = pAstCfg->masterStr;
755     TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: initialization phase - memory allocation", as+zMS);
757     // Initialize error block
758     Error_init(&eb); 
760     /* Stream memory */
761     if (!(pAstCfg->xStr = Memory_calloc((IHeap_Handle)HEAP_INTERNAL, STREAMN * sizeof (*pAstCfg->xStr), 4, &eb)))
762     {
763         TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: Memory_calloc failed", as+zMS);
764         SW_BREAKPOINT;
765         return __LINE__;
766     }
767     TRACE_TERSE3("PAF_ASOT_initPhaseMalloc. (pAstCfg->xStr) %d bytes from space %d at 0x%x.",
768             STREAMN * sizeof (*pAstCfg->xStr),
769             HEAP_ID_INTERNAL, (IArg)pAstCfg->xStr);
771     {
772         Int z;                          /* stream counter */
774         PAF_AudioFrame *fBuf;
776         if (!(fBuf = (PAF_AudioFrame *)Memory_calloc((IHeap_Handle)HEAP_INTERNAL, STREAMS * sizeof (*fBuf), 4, &eb)))
777         {
778             TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: Memory_calloc failed", as+zMS);
779             SW_BREAKPOINT;
780             return __LINE__;
781         }
782         TRACE_TERSE3("PAF_ASOT_initPhaseMalloc. (fBuf) %d bytes from space %d at 0x%x.",
783                 STREAMS * sizeof (*fBuf),
784                 HEAP_ID_INTERNAL, (IArg)fBuf);
786         for (z=STREAM1; z < STREAMN; z++)
787         {
788             pAstCfg->xStr[z].pAudioFrame = &fBuf[z-STREAM1];
789             TRACE_TERSE2("pAstCfg->xStr[%d].pAudioFrame = 0x%x", z, (IArg)pAstCfg->xStr[z].pAudioFrame);
790         }
791     }
793     /* Encode memory */
794     if (!(pAstCfg->xEnc = Memory_calloc((IHeap_Handle)HEAP_INTERNAL, ENCODEN * sizeof (*pAstCfg->xEnc), 4, &eb)))
795     {
796         TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: Memory_calloc failed", as+zMS);
797         SW_BREAKPOINT;
798         return __LINE__;
799     }
800     TRACE_TERSE3("PAF_ASOT_initPhaseMalloc. (pAstCfg->xEnc) %d bytes from space %d at 0x%x.",
801             ENCODEN * sizeof (*pAstCfg->xEnc),
802             HEAP_ID_INTERNAL, (IArg)pAstCfg->xEnc);
804     /* Output memory */
805     if (!(pAstCfg->xOut = Memory_calloc((IHeap_Handle)HEAP_INTERNAL, OUTPUTN * sizeof (*pAstCfg->xOut), 4, &eb)))
806     {
807         TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: Memory_calloc failed", as+zMS);
808         SW_BREAKPOINT;
809         return __LINE__;
810     }
811     TRACE_TERSE3("PAF_ASOT_initPhaseMalloc. (pAstCfg->xOut) %d bytes from space %d at 0x%x.",
812             OUTPUTN * sizeof (*pAstCfg->xOut),
813             HEAP_ID_INTERNAL, (IArg)pAstCfg->xOut);
815     TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: initialization phase - memory allocation complete.", as+zMS);
816     return 0;
817 } //PAF_ASOT_initPhaseMalloc
819 // -----------------------------------------------------------------------------
820 // ASOT Initialization Function - Memory Initialization from Configuration
821 //
822 //   Name:      PAF_ASOT_initPhaseConfig
823 //   Purpose:   Audio Stream Output Task Function for initialization of data values
824 //              from parameters.
825 //   From:      audioStream1Task or equivalent
826 //   Uses:      See code.
827 //   States:    x
828 //   Return:    0 on success.
829 //              Other as per initFrame0 and initFrame1.
830 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
831 //              * State information as per parent.
832 //
833 Int
834 PAF_ASOT_initPhaseConfig(
835     const PAF_ASOT_Params *pP, 
836     const PAF_ASOT_Patchs *pQ, 
837     PAF_ASOT_Config *pAsotCfg
840     PAF_AST_Config *pAstCfg;
841     Int as;                     /* Audio Stream Number (1, 2, etc.) */
842     Int z;                      /* input/encode/stream/decode/output counter */
843     Int zMS;
845     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
846     as = pAstCfg->as;
847     zMS = pAstCfg->masterStr;
849     TRACE_TERSE1("PAF_ASOT_initPhaseConfig: AS%d: initialization phase - configuration", as+zMS);
851     //
852     // Unspecified elements have been initialized to zero during alloc
853     //
855     for (z=STREAM1; z < STREAMN; z++) 
856     {
857         Int linno;
858         if (linno = pP->fxns->initFrame0(pP, pQ, pAsotCfg, z))
859         {
860             return linno;           
861         }
862         if (linno = pP->fxns->initFrame1(pP, pQ, pAsotCfg, z, -1))
863         {
864             return linno;
865         }
866     }
868     for (z=ENCODE1; z < ENCODEN; z++) 
869     {
870         Int zO = pP->outputsFromEncodes[z];
871         Int zS = pP->streamsFromEncodes[z];
872         pAstCfg->xEnc[z].encodeControl.size = sizeof(pAstCfg->xEnc[z].encodeControl);
873         pAstCfg->xEnc[z].encodeControl.pAudioFrame = pAstCfg->xStr[zS].pAudioFrame;
874         pAstCfg->xEnc[z].encodeControl.pVolumeStatus = &pAstCfg->xEnc[z].volumeStatus;
875         pAstCfg->xEnc[z].encodeControl.pOutBufConfig = &pAstCfg->xOut[zO].outBufConfig;
876         pAstCfg->xEnc[z].encodeStatus = *pP->z_pEncodeStatus[z];
877         pAstCfg->xEnc[z].encodeControl.encActive = pAstCfg->xEnc[z].encodeStatus.select;
878         pAstCfg->xEnc[z].volumeStatus = *pP->pVolumeStatus;
879         pAstCfg->xEnc[z].encodeInStruct.pAudioFrame = pAstCfg->xStr[zS].pAudioFrame;
880     }
882     for (z=OUTPUT1; z < OUTPUTN; z++)
883     {
884         pAstCfg->xOut[z].outBufStatus = *pP->pOutBufStatus;
885     }
887     TRACE_TERSE1("PAF_ASOT_initPhaseConfig: AS%d: initialization phase - configuration complete.", as+zMS);
888     return 0;
889 } //PAF_ASOT_initPhaseConfig
891 // -----------------------------------------------------------------------------
892 // ASOT Initialization Function - ACP Algorithm Instantiation
893 //
894 //   Name:      PAF_ASOT_initPhaseAcpAlg
895 //   Purpose:   Audio Stream Input Task Function for initialization of ACP by
896 //              instantiation of the algorithm.
897 //   From:      audioStream1Task or equivalent
898 //   Uses:      See code.
899 //   States:    x
900 //   Return:    0 on success.
901 //              Source code line number on ACP Algorithm creation failure.
902 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
903 //              * State information as per parent.
904 //              * Memory allocation errors.
905 //
906 Int
907 PAF_ASOT_initPhaseAcpAlg(
908     const PAF_ASOT_Params *pP, 
909     const PAF_ASOT_Patchs *pQ, 
910     PAF_ASOT_Config *pAsotCfg
913     PAF_AST_Config *pAstCfg;
914     Int as;                     /* Audio Stream Number (1, 2, etc.) */
915     Int z;                      /* input/encode/stream/decode/output counter */
916     Int betaPrimeOffset;
917     ACP_Handle acp;
918     Int zMS;
919     Int zS, zX;
921     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
922     as = pAstCfg->as;
923     zMS = pAstCfg->masterStr;
925     TRACE_TERSE1("PAF_ASOT_initPhaseAcpAlg: AS%d: initialization phase - ACP Algorithm", as+zMS);
927     ACP_MDS_init();
929     if (!(acp = (ACP_Handle )ACP_MDS_create(NULL))) 
930     {
931         TRACE_TERSE1("PAF_ASOT_initPhaseAcpAlg: AS%d: ACP algorithm instance creation  failed", as+zMS);
932         return __LINE__;
933     }
934     pAsotCfg->acp = acp;
936     ((ALG_Handle)acp)->fxns->algControl((ALG_Handle) acp,
937         ACP_GETBETAPRIMEOFFSET, (IALG_Status *)&betaPrimeOffset);
939     for (z=ENCODE1; z < ENCODEN; z++) 
940     {
941         zS = pP->streamsFromEncodes[z];
942         acp->fxns->attach(acp, ACP_SERIES_STD,
943             STD_BETA_ENCODE + betaPrimeOffset * (as-1+zS),
944             (IALG_Status *)&pAstCfg->xEnc[z].encodeStatus);
945         acp->fxns->attach(acp, ACP_SERIES_STD,
946             STD_BETA_VOLUME + betaPrimeOffset * (as-1+zS),
947             (IALG_Status *)&pAstCfg->xEnc[z].volumeStatus);
948         /* Ignore errors, not reported. */
949     }
951     for (z=OUTPUT1; z < OUTPUTN; z++) 
952     {
953         zS = z;
954         for (zX = ENCODE1; zX < ENCODEN; zX++) 
955         {
956             if (pP->outputsFromEncodes[zX] == z) 
957             {
958                 zS = pP->streamsFromEncodes[zX];
959                 break;
960             }
961         }
962         acp->fxns->attach(acp, ACP_SERIES_STD,
963             STD_BETA_OB + betaPrimeOffset * (as-1+zS),
964             (IALG_Status *)&pAstCfg->xOut[z].outBufStatus);
965         /* Ignore errors, not reported. */
966     }
968     TRACE_TERSE1("PAF_ASOT_initPhaseAcpAlg: AS%d: initialization phase - ACP Algorithm complete.", as+zMS);
970     return 0;
971 } //PAF_ASOT_initPhaseAcpAlg
973 // -----------------------------------------------------------------------------
974 // ASOT Initialization Function - Common Memory
975 //
976 //   Name:      PAF_ASOT_initPhaseCommon
977 //   Purpose:   Audio Stream Output Task Function for allocation of common memory.
978 //   From:      audioStream1Task or equivalent
979 //   Uses:      See code.
980 //   States:    x
981 //   Return:    0 on success.
982 //              Source code line number on PAF_ALG_alloc failure.
983 //              Source code line number on PAF_ALG_mallocMemory failure.
984 //              Source code line number on Decode Chain initialization failure.
985 //              Source code line number on ASP Chain initialization failure.
986 //              Source code line number on Encode Chain initialization failure.
987 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
988 //              * State information as per parent.
989 //              * Memory allocation errors.
990 //
991 Int
992 PAF_ASOT_initPhaseCommon(
993     const PAF_ASOT_Params *pP, 
994     const PAF_ASOT_Patchs *pQ, 
995     PAF_ASOT_Config *pAsotCfg
998     PAF_AST_Config *pAstCfg;
999     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1000     Int z;                      /* stream counter */
1001     Int g;                      /* gear */
1002     ACP_Handle acp;
1003     PAF_IALG_Config pafAlgConfig;
1004     IALG_MemRec common[3][PAF_IALG_COMMON_MEMN+1];
1005    
1006     acp = pAsotCfg->acp;
1007     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1008     as = pAstCfg->as;
1010     TRACE_TERSE0("PAF_ASOT_initPhaseCommon: initialization phase - Common Memory");
1012     //
1013     // Determine memory needs and instantiate algorithms across audio streams
1014     //
1015     TRACE_TERSE0("PAF_ASOT_initPhaseCommon: calling PAF_ALG_setup.");
1016     PAF_ALG_setup(&pafAlgConfig, 
1017         HEAP_ID_INTERNAL,                 HEAP_INTERNAL, 
1018         HEAP_ID_INTERNAL1,                HEAP_INTERNAL1, 
1019         HEAP_ID_EXTERNAL,                 HEAP_EXTERNAL, 
1020         HEAP_ID_INTERNAL1_SHM,            HEAP_INTERNAL1_SHM, 
1021         HEAP_ID_EXTERNAL_SHM,             HEAP_EXTERNAL_SHM, 
1022         HEAP_ID_EXTERNAL_NONCACHED_SHM,   HEAP_EXTERNAL_NONCACHED_SHM,
1023         HEAP_CLEAR);
1025     if (pP->fxns->headerPrint)
1026     {
1027         pP->fxns->headerPrint();        
1028     }
1030     for (z = STREAM1; z < STREAMN; z++) 
1031     {
1032         //Int zD, zE, zX;
1033         Int zE, zX;
1035         TRACE_TERSE1("PAF_ASOT_initPhaseCommon: AS%d: initialization phase - Common Memory", as+z);
1037         //
1038         // Determine common memory needs for:
1039         //  (1) ASP Algorithms
1040         //  (2) Encode Algorithms
1041         //  (3) Logical Output drivers
1042         //
1043         PAF_ALG_init(common[z], lengthof(common[z]), COMMONSPACE);
1045         zE = -1;
1046         for (zX = ENCODE1; zX < ENCODEN; zX++) 
1047         {
1048             if (pP->streamsFromEncodes[zX] == z) 
1049             {
1050                 zE = zX;
1051                 break;
1052             }
1053         }
1055         TRACE_TERSE1("Calling PAF_ALG_ALLOC for stream common[%d].", z);
1056         if (PAF_ALG_ALLOC(aspLinkInit[z-STREAM1][0], common[z])) 
1057         {
1058             TRACE_TERSE1("PAF_ASOT_initPhaseCommon: AS%d: PAF_ALG_alloc failed", as+z);
1059             TRACE_TERSE2("Failed to alloc %d bytes from space %d ", common[z]->size, common[z]->space);
1060             SW_BREAKPOINT;
1061             return __LINE__;
1062         }
1063         TRACE_TERSE3("alloced %d bytes from space %d at 0x%x", common[z]->size, common[z]->space, (IArg)common[z]->base);
1064         if (pP->fxns->allocPrint)
1065         {
1066             pP->fxns->allocPrint((const PAF_ALG_AllocInit *)(aspLinkInit[z-STREAM1][0]), sizeof (*(aspLinkInit[z-STREAM1][0])), &pafAlgConfig);
1067         }
1069         if (zE >= 0) 
1070         {
1071             TRACE_TERSE1("PAF_ASOT_initPhaseCommon: calling PAF_ALG_ALLOC/ for encoder common[%d].", z);
1072             if (PAF_ALG_ALLOC(encLinkInit[zE-ENCODE1], common[z])) 
1073             {
1074                 TRACE_TERSE1("PAF_ASOT_initPhaseCommon: AS%d: PAF_ALG_alloc failed", as+z);
1075                 SW_BREAKPOINT;
1076                 return __LINE__;
1077             }
1078             TRACE_TERSE3("alloced %d bytes from space %d at 0x%x", common[z]->size, common[z]->space, (IArg)common[z]->base);
1079             if (pP->fxns->allocPrint)
1080             {
1081                 pP->fxns->allocPrint((const PAF_ALG_AllocInit *)(encLinkInit[z-ENCODE1]), sizeof (*(encLinkInit[z-ENCODE1])), &pafAlgConfig);
1082             }
1083         }
1085         //
1086         // Determine common memory needs of Logical IO drivers
1087         //
1089         if (OUTPUT1 <= z && z < OUTPUTN)
1090         {
1091             TRACE_TERSE1("PAF_ASOT_initPhaseCommon: calling PAF_ALG_ALLOC outLinkInit common[%d].", z);
1092             if (PAF_ALG_ALLOC(outLinkInit[z-OUTPUT1], common[z]))
1093             {
1094                 TRACE_TERSE1("PAF_ASOT_initPhaseMalloc: AS%d: PAF_ALG_alloc failed", as+z);
1095                 TRACE_TERSE2("Failed to alloc %d bytes from space %d", common[z]->size, (IArg)common[z]->space);
1096                 SW_BREAKPOINT;
1097                 return __LINE__;
1098             }
1099             TRACE_TERSE3("alloced %d bytes from space %d at 0x%x", common[z]->size, common[z]->space, (IArg)common[z]->base);
1100             if (pP->fxns->allocPrint)
1101             {
1102                 pP->fxns->allocPrint((const PAF_ALG_AllocInit *)(outLinkInit[z-INPUT1]), sizeof (*(outLinkInit[z-INPUT1])), &pafAlgConfig);
1103             }
1104         }
1105     }
1106     {
1107         // Changes made to share scratch between zones
1108         // Assume maximum 3 zones and scratch common memory is at offset 0;
1109         int max=0;
1110         for (z=STREAM1; z<STREAMN; z++)
1111         {
1112             if (max < common[z][0].size)
1113             {
1114                 max = common[z][0].size;
1115             }
1116         }
1117         common[STREAM1][0].size=max;
1118         for (z=STREAM1+1; z<STREAMN; z++)
1119         {
1120             common[z][0].size = 0;            
1121         }
1122     }
1123         
1124     //
1125     // Allocate common memory for:
1126     //  (1) ASP Algorithms
1127     //  (2) Encode Algorithms
1128     //  (3) Logical Output drivers
1129     //
1130     for (z = STREAM1; z < STREAMN; z++) 
1131     {
1132         //Int zD, zE, zX;
1133         Int zE, zX;
1135         TRACE_TERSE0("PAF_ASOT_initPhaseCommon: calling PAF_ALG_mallocMemory for common space.");
1136         if (PAF_ALG_mallocMemory(common[z], &pafAlgConfig)) 
1137         {
1138             TRACE_TERSE1("AS%d: PAF_ALG_mallocMemory failed", as+z);
1139             TRACE_TERSE3("AS%d: z: %d.  Size 0x%x", as+z, z, common[z][0].size);
1140             SW_BREAKPOINT;
1141             return __LINE__;
1142         }
1143         TRACE_TERSE3("alloced %d bytes from space %d at 0x%x", common[z]->size, common[z]->space, (IArg)common[z]->base);
1144         // share zone0 scratch with all zones 
1145         common[z][0].base = common[0][0].base;
1146         if (pP->fxns->commonPrint)
1147         {
1148             pP->fxns->commonPrint(common[z], &pafAlgConfig);
1149         }
1151         zE = -1;
1152         for (zX = ENCODE1; zX < ENCODEN; zX++) 
1153         {
1154             if (pP->streamsFromEncodes[zX] == z) 
1155             {
1156                 zE = zX;
1157                 break;
1158             }
1159         }
1161         pAstCfg->xStr[z].aspChain[0] = NULL;
1162         for (g=0; g < GEARS; g++) 
1163         {
1164             PAF_ASP_Chain *chain;
1165             TRACE_TERSE0("PAF_ASOT_initPhaseCommon: calling PAF_ASP_chainInit for ASPs.");
1166             chain = PAF_ASP_chainInit(&pAstCfg->xStr[z].aspChainData[g], pP->pChainFxns,
1167                 HEAP_INTERNAL, as+z, acp, &trace,
1168                 aspLinkInit[z-STREAM1][g], pAstCfg->xStr[z].aspChain[0], common[z], &pafAlgConfig);
1169             if (!chain) 
1170             {
1171                 TRACE_TERSE2("AS%d: ASP chain %d initialization failed", as+z, g);
1172                 return __LINE__;
1173             }
1174             else
1175             {
1176                 pAstCfg->xStr[z].aspChain[g] = chain;
1177             }
1178         }
1180         if (zE >= 0) 
1181         {
1182             PAF_ASP_Chain *chain;
1183             TRACE_TERSE0("PAF_ASOT_initPhaseCommon: calling PAF_ASP_chainInit for encode.");
1184             chain = PAF_ASP_chainInit(&pAstCfg->xEnc[zE].encChainData, pP->pChainFxns,
1185                 HEAP_INTERNAL, as+z, acp, &trace,
1186                 encLinkInit[zE-ENCODE1], NULL, common[z], &pafAlgConfig);
1187             if (!chain) 
1188             {
1189                 TRACE_TERSE1("AS%d: Encode chain initialization failed", as+z);
1190                 return __LINE__;
1191             }
1192         }
1194         //
1195         // Allocate non-common memories for Logical IO drivers
1196         //    Since these structures are used at run-time we allocate from external memory
1197         if (OUTPUT1 <= z && z < OUTPUTN) 
1198         {
1199             PAF_ASP_Chain *chain;
1200             TRACE_TERSE2("PAF_ASOT_initPhaseMalloc: AS%d: non-common output chain init for %d",
1201                            as+z, z);
1202             chain = PAF_ASP_chainInit (&pAstCfg->xOut[z].outChainData, pP->pChainFxns,
1203                         HEAP_EXTERNAL, as+z, acp, &trace,
1204                         outLinkInit[z-OUTPUT1], NULL, common[z], &pafAlgConfig);
1205             if (!chain) 
1206             {
1207                 TRACE_TERSE1("AS%d: Output chain initialization failed", as+z);
1208                 return __LINE__;
1209             }
1210         }
1211     }
1212     TRACE_TERSE1("AS%d: PAF_ASOT_initPhaseCommon: Returning complete.", as+z);
1214     return 0;
1215 } //PAF_ASOT_initPhaseCommon
1217 // -----------------------------------------------------------------------------
1218 // ASOT Initialization Function - Algorithm Keys
1219 //
1220 //   Name:      PAF_ASOT_initPhaseAlgKey
1221 //   Purpose:   Audio Stream Output Task Function for initialization of data values
1222 //              from parameters for Algorithm Keys.
1223 //   From:      audioStream1Task or equivalent
1224 //   Uses:      See code.
1225 //   States:    x
1226 //   Return:    0.
1227 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
1228 //              * State information as per parent.
1229 //
1230 // .............................................................................
1231 Int
1232 PAF_ASOT_initPhaseAlgKey(
1233     const PAF_ASOT_Params *pP, 
1234     const PAF_ASOT_Patchs *pQ, 
1235     PAF_ASOT_Config *pAsotCfg
1238     PAF_AST_Config *pAstCfg;
1239     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1240     Int z;                      /* decode/encode counter */
1241     Int s;                      /* key number */
1242     PAF_ASP_Link *that;
1244     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1245     as = pAstCfg->as;
1246     (void)as; // clear compiler warning in case not used with tracing disabled
1248     TRACE_VERBOSE1("PAF_ASOT_initPhaseAlgKey: AS%d: initialization phase - Algorithm Keys", as);
1250     for (z=ENCODE1; z < ENCODEN; z++) 
1251     {
1252         for (s=0; s < pP->pEncAlgKey->length; s++) 
1253         {
1254             if ((pP->pEncAlgKey->code[s].full != 0) && 
1255                 (that = PAF_ASP_chainFind(&pAstCfg->xEnc[z].encChainData, pP->pEncAlgKey->code[s])))
1256             {
1257                 pAstCfg->xEnc[z].encAlg[s] = (ALG_Handle )that->alg;
1258             }
1259             /* Cast in interface, for now --Kurt */
1260             else
1261             {
1262                 pAstCfg->xEnc[z].encAlg[s] = NULL;                
1263             }
1264         }
1265     }
1267     return 0;
1268 } //PAF_ASOT_initPhaseAlgKey
1270 // -----------------------------------------------------------------------------
1271 // ASOT Initialization Function - I/O Devices
1272 //
1273 //   Name:      PAF_ASOT_initPhaseDevice
1274 //   Purpose:   Audio Stream Output Task Function for initialization of I/O Devices.
1275 //   From:      audioStream1Task or equivalent
1276 //   Uses:      See code.
1277 //   States:    x
1278 //   Return:    0 on success.
1279 //              Source code line number on device allocation failure.
1280 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
1281 //              * State information as per parent.
1282 //              * Memory allocation errors.
1283 //
1284 Int
1285 PAF_ASOT_initPhaseDevice(
1286     const PAF_ASOT_Params *pP, 
1287     const PAF_ASOT_Patchs *pQ, 
1288     PAF_ASOT_Config *pAsotCfg
1291     PAF_AST_Config *pAstCfg;
1292     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1293     Int z;                      /* input/output counter */
1294     PAF_SIO_IALG_Obj    *pObj;
1295     PAF_SIO_IALG_Config *pAlgConfig;
1296     PAF_IALG_Config pafAlgConfig;
1298     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1299     as = pAstCfg->as;
1300     (void)as; // clear compiler warning in case not used with tracing disabled
1302     TRACE_TERSE1("PAF_ASOT_initPhaseDevice: AS%d: initialization phase - I/O Devices", as);
1304     if(pP->fxns->bufMemPrint)
1305     {
1306         PAF_ALG_setup (&pafAlgConfig, 
1307             HEAP_ID_INTERNAL,               HEAP_INTERNAL, 
1308             HEAP_ID_INTERNAL1,              HEAP_INTERNAL1,
1309             HEAP_ID_EXTERNAL,               HEAP_EXTERNAL,
1310             HEAP_ID_INTERNAL1_SHM,          HEAP_INTERNAL1_SHM,
1311             HEAP_ID_EXTERNAL_SHM,           HEAP_EXTERNAL_SHM,
1312             HEAP_ID_EXTERNAL_NONCACHED_SHM, HEAP_EXTERNAL_NONCACHED_SHM,
1313             HEAP_CLEAR);
1314         TRACE_TERSE2("PAF_ASOT_initPhaseDevice: AS%d: calling PAF_ALG_setup with clear at %d.", as, HEAP_CLEAR);
1315     }
1316     
1317     for (z=OUTPUT1; z < OUTPUTN; z++) 
1318     {
1319         PAF_OutBufConfig *pConfig = &pAstCfg->xOut[z].outBufConfig;
1321         pObj = (PAF_SIO_IALG_Obj *)pAstCfg->xOut[z].outChainData.head->alg;
1322         pAlgConfig = &pObj->config;
1324         pAstCfg->xOut[z].hTxSio = NULL;
1325         pConfig->base.pVoid     = pAlgConfig->pMemRec[0].base;
1326         pConfig->pntr.pVoid     = pAlgConfig->pMemRec[0].base;
1327         pConfig->head.pVoid     = pAlgConfig->pMemRec[0].base;
1328         pConfig->allocation     = pAlgConfig->pMemRec[0].size;
1329         pConfig->sizeofElement  = 3;
1330         pConfig->precision      = 24;
1331         if(pP->fxns->bufMemPrint)
1332         {
1333             pP->fxns->bufMemPrint(z,pAlgConfig->pMemRec[0].size,PAF_ALG_memSpaceToHeapId(&pafAlgConfig,pAlgConfig->pMemRec[0].space),1);
1334         }
1335     }
1336     TRACE_TERSE1("PAF_ASOT_initPhaseDevice: AS%d: initialization phase - I/O Devices complete.", as);
1338     return 0;
1339 } //PAF_ASOT_initPhaseDevice
1341 // -----------------------------------------------------------------------------
1342 // ASOT Initialization Function Helper - Initialization of Audio Frame
1343 //
1344 //   Name:      PAF_ASOT_initFrame0
1345 //   Purpose:   Audio Stream Output Task Function for initialization of the Audio
1346 //              Frame(s) by memory allocation and loading of data pointers
1347 //              and values.
1348 //   From:      AST Parameter Function -> decodeInfo
1349 //   Uses:      See code.
1350 //   States:    x
1351 //   Return:    0 on success.
1352 //              Source code line number on MEM_calloc failure.
1353 //              Source code line number on unsupported option.
1354 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
1355 //              * Memory allocation errors.
1356 //              * Unsupported option errors.
1357 //
1359 // MID 314
1360 extern const char AFChanPtrMap[PAF_MAXNUMCHAN+1][PAF_MAXNUMCHAN];
1361 extern PAF_ChannelConfigurationMaskTable PAF_ASP_stdCCMT_patch;
1363 Int
1364 PAF_ASOT_initFrame0(
1365     const PAF_ASOT_Params *pP, 
1366     const PAF_ASOT_Patchs *pQ, 
1367     PAF_ASOT_Config *pAsotCfg, 
1368     Int z
1371     PAF_AST_Config *pAstCfg;
1372     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1373     Int ch;
1374     //Int aLen;
1375     Int aLen_int=0,aLen_ext=0;
1376     Int aSize = sizeof(PAF_AudioData);
1377     Int aAlign = aSize < sizeof (int) ? sizeof (int) : aSize;
1378     Int maxFrameLength = pP->maxFramelength;
1379     Int zX;
1380     PAF_AudioData *aBuf_int=NULL;
1381     PAF_AudioData *aBuf_ext=NULL;
1382     XDAS_UInt8 *metadataBuf;
1383     char i;
1384     Error_Block    eb;
1386     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1387     as = pAstCfg->as;
1389     // Initialize error block
1390     Error_init(&eb); 
1392     // Compute maximum framelength (needed for ARC support)
1393     maxFrameLength += PA_MODULO - maxFrameLength % PA_MODULO;
1394     //aLen = numchan[z] * maxFrameLength;
1395     for (i=0; i < numchan[z]; i++)
1396     {
1397         if (pP->pAudioFrameBufStatus->space[i] == IALG_SARAM)
1398         {
1399             aLen_int += maxFrameLength;
1400         }
1401         else
1402         {
1403             aLen_ext += maxFrameLength;
1404         }
1405     }
1407     //
1408     // Initialize audio frame elements directly
1409     //
1410     pAstCfg->xStr[z].pAudioFrame->fxns = pP->pAudioFrameFunctions;
1411     pAstCfg->xStr[z].pAudioFrame->data.nChannels = PAF_MAXNUMCHAN; ///
1412 ///    pAstCfg->xStr[z].pAudioFrame->data.nChannels = PAF_MAXNUMCHAN_AF;
1413     pAstCfg->xStr[z].pAudioFrame->data.nSamples = FRAMELENGTH;
1414     pAstCfg->xStr[z].pAudioFrame->data.sample = pAstCfg->xStr[z].audioFrameChannelPointers;
1415     pAstCfg->xStr[z].pAudioFrame->data.samsiz = pAstCfg->xStr[z].audioFrameChannelSizes;
1416     pAstCfg->xStr[z].pAudioFrame->pChannelConfigurationMaskTable = &PAF_ASP_stdCCMT;
1418     //
1419     // Allocate memory for and initialize pointers to audio data buffers
1420     //
1421     //   The NUMCHANMASK is used to identify the channels for which data
1422     //   buffers can be allocated. Using this mask and switch statement
1423     //   rather than some other construct allows efficient code generation,
1424     //   providing just the code necessary (with significant savings).
1425     //
1426     if (pP->fxns->bufMemPrint)
1427     {
1428         pP->fxns->bufMemPrint(z, aLen_int*aSize, HEAP_ID_FRMBUF, 2);
1429         pP->fxns->bufMemPrint(z, aLen_ext*aSize, HEAP_ID_EXTERNAL, 2);
1430     }
1432     TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: Memory_calloc for audio buffers", as+z);
1433     
1434     if (aLen_int*aSize!=0) // check size != 0, otherwise malloc throws fatal error
1435     {
1436         if (!(aBuf_int = (PAF_AudioData *)Memory_calloc((IHeap_Handle)HEAP_FRMBUF, (aLen_int+(maxFrameLength-FRAMELENGTH))*aSize, aAlign, &eb))) //Qin: Add start offset
1437         {
1438             TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: Memory_calloc failed", as+z);
1439             TRACE_TERSE2("  maxFrameLength: %d.  aLen_int*aSize: %d", maxFrameLength, (aLen_int+(maxFrameLength-FRAMELENGTH))*aSize);
1440             SW_BREAKPOINT;
1441             return __LINE__;
1442         }
1443     }
1444         
1445     if (aLen_ext*aSize!=0)
1446     {
1447         if (!(aBuf_ext = (PAF_AudioData *)Memory_calloc((IHeap_Handle)HEAP_EXTERNAL, (aLen_ext+(maxFrameLength-FRAMELENGTH))*aSize, aAlign, &eb)))//Qin: Add start offset
1448         {
1449             TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: Memory_calloc failed", as+z);
1450             TRACE_TERSE2("  maxFrameLength: %d.  aLen_ext*aSize: %d", maxFrameLength, (aLen_ext+(maxFrameLength-FRAMELENGTH))*aSize);
1451             SW_BREAKPOINT;
1452             return __LINE__;
1453         }
1454     }
1455     
1456     TRACE_TERSE3("  maxFrameLength: %d.  aLen_int*aSize: %d.  aBuf_int: 0x%x", maxFrameLength, (aLen_int+(maxFrameLength-FRAMELENGTH))*aSize, (IArg)aBuf_int);
1457     TRACE_TERSE3("  maxFrameLength: %d.  aLen_ext*aSize: %d.  aBuf_ext: 0x%x", maxFrameLength, (aLen_ext+(maxFrameLength-FRAMELENGTH))*aSize, (IArg)aBuf_ext);
1459     TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: Memory_calloc for metadata buffers", as+z);
1460     if (!(metadataBuf = (XDAS_UInt8 *)Memory_calloc((IHeap_Handle)HEAP_MDBUF, pP->pMetadataBufStatus->bufSize*pP->pMetadataBufStatus->NumBuf, pP->pMetadataBufStatus->alignment, &eb)))
1461     {
1462         TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: Memory_calloc failed", as+z);
1463         TRACE_TERSE1("  bufSize*NumBuf: %d", pP->pMetadataBufStatus->bufSize*pP->pMetadataBufStatus->NumBuf);
1464         SW_BREAKPOINT;
1465         return __LINE__;
1466     }
1468     {
1469         Int i;
1471 #pragma UNROLL(1)
1472         for (i=0; i < PAF_MAXNUMCHAN_AF; i++)
1473         {
1474             pAstCfg->xStr[z].audioFrameChannelPointers[i] = NULL;
1475         }
1476     }
1478     // MID 314
1479     if((numchan[z] > PAF_MAXNUMCHAN) || (numchan[z] < 1)) 
1480     {
1481         TRACE_TERSE1("PAF_ASOT_initFrame0: AS%d: unsupported option", as+z);
1482         return __LINE__;
1483     }
1484     else 
1485     {
1486         Int j = 0;
1487         Int k = 0;
1488         TRACE_TERSE1("PAF_ASOT_initFrame0: AFChanPtrMap[%d][i]", numchan[z]);
1489         for(i=0;i<numchan[z];i++)
1490         {
1491             char chan = AFChanPtrMap[numchan[z]][i];
1492             if(chan != -1)
1493             {
1494                 if(pP->pAudioFrameBufStatus->space[i] == IALG_SARAM)
1495                 {
1496                     pAstCfg->xStr[z].audioFrameChannelPointers[chan] = aBuf_int + maxFrameLength*(j+1) - FRAMELENGTH;
1497                     j++;
1498                 }
1499                 else
1500                 {        
1501                     pAstCfg->xStr[z].audioFrameChannelPointers[chan] = aBuf_ext + maxFrameLength*(k+1) - FRAMELENGTH;
1502                     k++;
1503                 }    
1504                 TRACE_TERSE3("PAF_ASOT_initFrame0: chan = %d = AFChanPtrMap[%d][%d].", chan, numchan[z], i);
1505                 TRACE_TERSE2("PAF_ASOT_initFrame0: audioFrameChannelPointers[%d]: 0x%x", chan, (IArg)pAstCfg->xStr[z].audioFrameChannelPointers[chan]);
1506             }
1507         }
1508     }
1510     for (ch=PAF_LEFT; ch < PAF_MAXNUMCHAN_AF; ch++) 
1511     {
1512         if (pAstCfg->xStr[z].audioFrameChannelPointers[ch])
1513         {
1514             pAstCfg->xStr[z].origAudioFrameChannelPointers[ch] = pAstCfg->xStr[z].audioFrameChannelPointers[ch];
1515         }
1516     }
1518     //
1519     // Initialize meta data elements
1520     //
1521     pAstCfg->xStr[z].pAudioFrame->pafBsMetadataUpdate = XDAS_FALSE;
1522     pAstCfg->xStr[z].pAudioFrame->numPrivateMetadata = 0;
1523     pAstCfg->xStr[z].pAudioFrame->bsMetadata_offset = 0;
1524     pAstCfg->xStr[z].pAudioFrame->bsMetadata_type = PAF_bsMetadata_channelData;
1525     pAstCfg->xStr[z].pAudioFrame->privateMetadataBufSize = pP->pMetadataBufStatus->bufSize;
1526     for(i=0;i<pP->pMetadataBufStatus->NumBuf;i++)
1527     {
1528         pAstCfg->xStr[z].pAudioFrame->pafPrivateMetadata[i].offset = 0;
1529         pAstCfg->xStr[z].pAudioFrame->pafPrivateMetadata[i].size = 0;
1530         pAstCfg->xStr[z].pAudioFrame->pafPrivateMetadata[i].pMdBuf = metadataBuf + pP->pMetadataBufStatus->bufSize*i;
1531     }
1533     //
1534     // Initialize decoder elements directly
1535     //
1537     for (zX = DECODE1; zX < DECODEN; zX++) 
1538     {
1539         if (pP->streamsFromDecodes[zX] == z) 
1540         {
1541 #ifdef NOAUDIOSHARE
1542             pAstCfg->xDec[zX].decodeInStruct.audioShare.nSamples = 0;
1543             pAstCfg->xDec[zX].decodeInStruct.audioShare.sample = NULL;
1544 #else /* NOAUDIOSHARE */
1545             pAstCfg->xDec[zX].decodeInStruct.audioShare.nSamples = aLen_int;
1546             pAstCfg->xDec[zX].decodeInStruct.audioShare.sample = aBuf_int;
1547 #endif /* NOAUDIOSHARE */
1548         }
1549     }
1551     return 0;
1552 } //PAF_ASOT_initFrame0
1554 // -----------------------------------------------------------------------------
1555 // ASOT Initialization Function Helper - Reinitialization of Audio Frame
1556 // AST Decoding Function              - Reinitialization of Audio Frame
1557 //
1558 //   Name:      PAF_ASOT_initFrame1
1559 //   Purpose:   Audio Stream Task Function for initialization or reinitiali-
1560 //              zation of the Audio Frame(s) by loading of data values of a
1561 //              time-varying nature.
1562 //   From:      audioStream1Task or equivalent
1563 //              AST Parameter Function -> decodeInfo
1564 //              AST Parameter Function -> decodeDecode
1565 //   Uses:      See code.
1566 //   States:    x
1567 //   Return:    0.
1568 //   Trace:     None.
1569 //
1570 Int
1571 PAF_ASOT_initFrame1(
1572     const PAF_ASOT_Params *pP, 
1573     const PAF_ASOT_Patchs *pQ, 
1574     PAF_ASOT_Config *pAsotCfg, 
1575     Int z, 
1576     Int apply
1579     PAF_AST_Config *pAstCfg;
1581     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1583     //
1584     // Reinitialize audio frame elements:
1585     //
1586     //   Channel Configurations during sys init                 = Unknown
1587     //      "          "        during info or decode           = None
1588     //
1589     //   Sample Rate / Count    during sys init, info or decode = Unknown / 0
1590     //
1592     if (apply < 0) 
1593     {
1594         pAstCfg->xStr[z].pAudioFrame->channelConfigurationRequest.legacy = PAF_CC_UNKNOWN;
1595         pAstCfg->xStr[z].pAudioFrame->channelConfigurationStream.legacy = PAF_CC_UNKNOWN;
1596     }
1597     else 
1598     {
1599         pAstCfg->xStr[z].pAudioFrame->channelConfigurationRequest.legacy = PAF_CC_NONE;
1600         pAstCfg->xStr[z].pAudioFrame->channelConfigurationStream.legacy = PAF_CC_NONE;
1601     }
1603     if (apply < 1) 
1604     {
1605         pAstCfg->xStr[z].pAudioFrame->sampleRate = PAF_SAMPLERATE_UNKNOWN;
1606         pAstCfg->xStr[z].pAudioFrame->sampleCount = 0;
1607     }
1609     return 0;
1610 } //PAF_ASOT_initFrame1
1612 // -----------------------------------------------------------------------------
1613 // ASOT Selection Function - Output Device Selection
1614 //
1615 //   Name:      PAF_ASOT_selectDevices
1616 //   Purpose:   Audio Stream Output Task Function for selecting the devices used
1617 //              for output.
1618 //   From:      audioStream1Task or equivalent
1619 //   Uses:      See code.
1620 //   States:    x
1621 //   Return:    Error number in standard form (0 on success).
1622 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
1623 //              * State information as per parent.
1624 //
1625 Int
1626 PAF_ASOT_selectDevices(
1627     const PAF_ASOT_Params *pP, 
1628     const PAF_ASOT_Patchs *pQ, 
1629     PAF_ASOT_Config *pAsotCfg
1632     PAF_AST_Config *pAstCfg;
1633     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1634     Int z;                      /* input/output counter */
1635     Int errno = 0;              /* error number */
1636     Int errme;                  /* error number, local */
1637     Int device;
1639     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1640     as = pAstCfg->as;
1641     (void)as;  // clear compiler warning in case not used with tracing disabled
1643     // Select output devices
1644     for (z=OUTPUT1; z < OUTPUTN; z++) 
1645     {
1646         if ((device = pAstCfg->xOut[z].outBufStatus.sioSelect) >= 0) 
1647         {
1648             TRACE_VERBOSE2("PAF_ASOT_selectDevices: AS%d: output device %d selecting ...", as+z, device);
1650             /* check for valid index into device array */
1651             if (device >= pQ->devout->n)
1652             {
1653                 device = 0; /* treat as device None */
1654             }
1656             errme = pP->fxns->deviceSelect(&pAstCfg->xOut[z].hTxSio, SIO_OUTPUT, 
1657                 HEAP_ID_OUTBUF, (Ptr)pQ->devout->x[device]);
1658             if (errme)
1659             {
1660                 TRACE_VERBOSE2("PAF_ASOT_selectDevices: errme 0x%x, errno 0x%x", errme, errno);
1661                 if (!errno)
1662                 {
1663                     errno = ASPERR_DEVOUT + errme;
1664                 }
1665                 pAstCfg->xOut[z].outBufStatus.sioSelect = 0x80;
1666             }
1667             else 
1668             {
1669                 Int zE;
1671                 pAstCfg->xOut[z].outBufStatus.sioSelect = device | 0x80;
1672                 // register outBufStatus and encodeStatus pointers with output devices
1673                 // This enables proper IEC encapsulation.
1674                 if (pAstCfg->xOut[z].hTxSio) 
1675                 {
1676                     // set max # of output buffers (use override if necessary)
1677                     if (pAstCfg->xOut[z].outBufStatus.maxNumBufOverride == 0)
1678                     {
1679                         SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_SET_MAX_NUMBUF,
1680                             (Arg)pP->poutNumBufMap[z]->maxNumBuf);
1681                     }
1682                     else
1683                     {
1684                         SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_SET_MAX_NUMBUF,
1685                             (Arg)pAstCfg->xOut[z].outBufStatus.maxNumBufOverride);
1686                     }
1688                     // register PAF_SIO_IALG object address
1689                     SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_SET_IALGADDR,
1690                         (Arg)pAstCfg->xOut[z].outChainData.head->alg);
1691                     SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_SET_BUFSTATUSADDR, 
1692                         (Arg)&pAstCfg->xOut[z].outBufStatus);
1693                     for (zE=ENCODE1; zE < ENCODEN; zE++) 
1694                     {
1695                         if (pP->outputsFromEncodes[zE] == z) 
1696                         {
1697                             SIO_ctrl(pAstCfg->xOut[z].hTxSio, 
1698                                 PAF_SIO_CONTROL_SET_ENCSTATUSADDR, 
1699                                 (Arg)&pAstCfg->xEnc[zE].encodeStatus);
1700                             break;
1701                         }
1702                     }
1703                 }
1704             }
1705         }
1707         // if device selected and valid then enable stat tracking if
1708         // required and start clocking
1709         if ((pAstCfg->xOut[z].outBufStatus.sioSelect < 0) && (pAstCfg->xOut[z].hTxSio)) 
1710         {
1711             TRACE_VERBOSE0("PAF_ASOT_selectDevices: start SIO clocks");
1712             errme = SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_OUTPUT_START_CLOCKS, 0);
1713             if (errme)
1714             {
1715                 TRACE_VERBOSE2("PAF_ASOT_selectDevices: errme 0x%x, errno 0x%x", errme, errno);
1716                 SIO_idle(pAstCfg->xOut[z].hTxSio);
1717                 if (!errno)
1718                 {
1719                     errno = ASPERR_DEVOUT + errme;
1720                 }
1721             }
1722         }
1723     }
1725     return errno;
1726 } //PAF_ASOT_selectDevices
1729 // -----------------------------------------------------------------------------
1730 // ASOT Processing Function - Decode Processing
1731 //
1732 //   Name:      PAF_ASOT_decodeProcessing
1733 //   Purpose:   Audio Stream Output Task Function for processing audio data.
1734 //
1735 Int
1736 PAF_ASOT_decodeProcessing(
1737     const PAF_ASOT_Params *pP, 
1738     const PAF_ASOT_Patchs *pQ, 
1739     PAF_ASOT_Config *pAsotCfg 
1742     PAF_AST_Config *pAstCfg;
1743     Int errno;                          /* error number */
1744     Int getVal;
1745     enum { INIT, STREAM, ENCODE, FINAL, QUIT, OUT_SIO_UPDATE } state;
1746     state = INIT;
1747     errno = 0; /* error number */
1748     Int frame; // (***) FL: formerly -- decoder input frame count
1749     Int block; // decoder output block count / input frame
1750     Int outSioUpdate;
1751     
1752     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
1754     for (;;) 
1755     {
1756         //
1757         // Check forward (ASIT) error here, TBD
1758         //
1759         
1760         
1761         // Check if any change in output SIO, e.g. from Output shortcut.
1762         // Changes will break FSM and allow Output reconfiguration.
1763         errno = checkOutSio(pP, pAsotCfg, &outSioUpdate);
1764         if (errno < 0)
1765         {
1766             TRACE_TERSE1("PAF_ASOT_decodeProcessing: checkOutSio returned errno = 0x%04x", errno);
1767             break;
1768         }
1769         else if (outSioUpdate)
1770         {
1771             TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: Change in Output SIO selection");
1772             state = OUT_SIO_UPDATE;
1773         }
1774         
1775         // Process commands (encode)
1776         getVal = pP->fxns->encodeCommand(pP, pQ, pAsotCfg);
1777         if (getVal) 
1778         {
1779             /* ignore */;
1780         }
1782         // Process state (decode)
1783         switch (state) 
1784         {
1785             case INIT: // initial state
1786                 gAsopInitCnt++;
1787                 Log_info0("TaskAsop: state=INIT");
1788             
1789                 frame = 0;
1790                 block = 0;
1792 #if 0 // FL: moved to PAF_ASOT_initOutProc()
1793                 // Reset audio frame pointers to original values
1794                 // (may be needed if error occurred).
1795                 resetAfPointers(pP, pAstCfg->xStr);
1796                 // Reset audio frame meta data elements
1797                 resetAfMetadata(pP, pAstCfg->xStr);
1798 #endif
1800                 errno = pP->fxns->decodeInit(pP, pQ, pAsotCfg);
1801                 if (errno)
1802                 {
1803                     TRACE_VERBOSE1("PAF_ASOT_decodeProcessing: INIT, errno 0x%x.  break after decodeInit", errno);
1804                     errno = ASOP_DP_DECINIT_ERR;
1805                     break;
1806                 }
1807                 
1808                 //
1809                 // Setup output: setCheckRateX, start output
1810                 //
1811                 // Establish secondary timing
1812                 errno = pP->fxns->decodeInfo1(pP, pQ, pAsotCfg, frame, block);
1813                 if (errno)
1814                 {
1815                     TRACE_VERBOSE1("PAF_ASOT_decodeProcessing: INIT, errno 0x%x.  break after decodeInfo1", errno);
1816                     break;
1817                 }
1818                 
1819                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: INIT->STREAM");                
1820                 state = STREAM;
1821                 continue;
1822                 
1823             case STREAM: // stream state
1824                 gAsopStreamCnt++;
1825                 Log_info0("TaskAsop: state=STREAM");
1827                 errno = pP->fxns->decodeStream(pP, pQ, pAsotCfg, frame, block);
1828                 if (errno)
1829                 {
1830                     TRACE_TERSE1("PAF_ASOT_decodeProcessing: state: STREAM.  decodeStream err 0x%x", errno);
1831                     errno = ASOP_DP_DECSTREAM_ERR;
1832                     break;
1833                 }
1835                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: STREAM->ENCODE");
1836                 state = ENCODE;
1837                 continue;
1838                 
1839             case ENCODE: // encode state
1840                 gAsopEncodeCnt++;
1841                 Log_info0("TaskAsop: state=ENCODE");
1843                 errno = pP->fxns->decodeEncode(pP, pQ, pAsotCfg, frame, block);
1844                 if (errno)
1845                 {
1846                     TRACE_TERSE1("PAF_ASOT_decodeProcessing: state: ENCODE.  decodeEncode err 0x%x", errno);
1847                     errno = ASOP_DP_DECENC_ERR;
1848                     break;
1849                 }
1850                 
1851                 // Measure cycles in output processing loop.
1852                 // Only measures cycles spent in loop.
1853                 pfpEnd(PFP_ID_ASOT_1, PFP_FINISH_MEAS);
1854                 gNumPfpAsot1--;
1855                 pfpBegin(PFP_ID_ASOT_1, pAsotCfg->taskHandle);
1856                 gNumPfpAsot1++;
1857                 
1858                 // (***) FL: do we need this? 
1859                 //       AF pointers come from CB read, any resets occur in Decoder AF.
1860                 //
1861                 // Reset audio frame pointers to original values
1862                 // (may have been adjusted by ARC or the like).
1863                 resetAfPointers(pP, pAstCfg->xStr);
1865                 // (***) FL: update output (setCheckRateX)
1866                 //           Contained in INFO2 in combined FSM.
1867                 errno = pP->fxns->decodeInfo2(pP, pQ, pAsotCfg, frame, block);
1868                 if (errno)
1869                 {
1870                     TRACE_TERSE1("PAF_ASOT_decodeProcessing: ENCODE break on decodeInfo2. errno 0x%x", errno);
1871                     errno = ASOP_DP_DECINFO2_ERR;
1872                     break;
1873                 }
1875                 block++;
1876                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: ENCODE->FINAL");
1877                 state = FINAL;
1878                 continue;
1879                 
1880             case FINAL:
1881                 gAsopFinalCnt++;
1882                 Log_info0("TaskAsop: state=FINAL");
1883                 
1884                 //
1885                 // (***) FL: this needs to be fixed.
1886                 //       (1) Only require selected Output to be in this FSM
1887                 //           => Dec Status checks aren't valid, 
1888                 //              will probably always exit FSM if only Output running
1889                 //       (2) Checking Dec Status info asych to input events (maybe ok)
1890                 //
1891                 // Check for final frame, and if indicated:
1892                 // - Update audio flag to cause output buffer flush rather than
1893                 //   the default truncate in "complete" processing.
1894                 // - Exit state machine to "complete" processing.
1895 #if 0
1896                 if (pP->fxns->decodeFinalTest(pP, pQ, pAsotCfg, frame, block)) 
1897                 {
1898                     for (z=OUTPUT1; z < OUTPUTN; z++)
1899                     {
1900                         if ((pAstCfg->xOut[z].outBufStatus.audio & 0x0f) == PAF_OB_AUDIO_SOUND)
1901                         {
1902                             TRACE_VERBOSE0("PAF_ASOT_outputProcessing: state: FINAL: SOUND -> QUIET");
1903                             pAstCfg->xOut[z].outBufStatus.audio++; // SOUND -> QUIET
1904                         }
1905                     }
1906                     break;
1907                 }
1908 #endif
1909                 errno = pP->fxns->decodeFinalTest(pP, pQ, pAsotCfg, frame, block);
1910                 if (errno < 0)
1911                 {
1912                     TRACE_TERSE1("PAF_ASOT_decodeProcessing: DECODE FINAL break. errno 0x%x", errno);
1913                     errno = ASOP_DP_DECFINALTEST_ERR;
1914                     break;
1915                 }
1916                 else if (errno == ASOP_DP_CB_DRAINED)
1917                 {
1918                     // EOS, exit normally
1919                     TRACE_TERSE1("PAF_ASOT_decodeProcessing: DECODE FINAL normal exit. errno 0x%x", errno);
1920                     errno = ASOP_DP_SOK;
1921                     break;
1922                 }
1924                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: FINAL->STREAM");
1925                 state = STREAM;
1926                 continue;
1927                 
1928             case OUT_SIO_UPDATE:
1929                 gAsopOutSioUpdateCnt++;
1930                 Log_info0("TaskAsop: state=OUT_SIO_UPDATE");
1932                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: OUT_SIO_UPDATE");
1933                 errno = ASOP_DP_OUT_SIO_UPDATE;
1934                 break;
1935                 
1936             case QUIT:
1937                 gAsopQuitCnt++;
1938                 Log_info0("TaskAsop: state=QUIT");
1940                 TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: state: QUIT");
1941                 errno = ASPERR_QUIT;
1942                 break;
1944             default: // unknown state
1945                 // Unknown:
1946                 // - Set error number registers.
1947                 // - Exit state machine to "complete" processing.
1949                 TRACE_TERSE1("PAF_ASOT_decodeProcessing: state: unknown, 0x%x", state);
1950                 errno = ASPERR_UNKNOWNSTATE;
1951                 break;
1953         }  // End of switch (state).
1954         
1955         TRACE_VERBOSE0("PAF_ASOT_decodeProcessing: Calling decode complete");
1956         if (pP->fxns->decodeComplete(pP, pQ, pAsotCfg, NULL, frame, block))
1957         {
1958             /* ignored? */;
1959         }
1960         
1961         //pfpEnd(PFP_ID_ASOT_1, PFP_FINISH_MEAS); // PFP end -- outside of PFP for errors, EOS, or Output SIO change
1962         //gNumPfpAsot1--;
1963         
1964         //return errno;
1965         break;        
1966     } // End of for (;;)
1967         
1968     pfpEnd(PFP_ID_ASOT_1, PFP_FINISH_MEAS); // PFP end -- outside of PFP for errors, EOS, or Output SIO change
1969     gNumPfpAsot1--;
1970         
1971     return errno;
1974 // -----------------------------------------------------------------------------
1975 // ASOT Decoding Function - Encode Command Processing
1976 //
1977 //   Name:      PAF_ASOT_encodeCommand
1978 //   Purpose:   Decoding Function for processing Encode Commands.
1979 //   From:      AST Parameter Function -> decodeProcessing
1980 //   Uses:      See code.
1981 //   States:    x
1982 //   Return:    0.
1983 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
1984 //              * Command execution.
1985 //              * SIO control errors.
1986 //              * Error number macros.
1987 //
1988 Int
1989 PAF_ASOT_encodeCommand(
1990     const PAF_ASOT_Params *pP, 
1991     const PAF_ASOT_Patchs *pQ, 
1992     PAF_ASOT_Config *pAsotCfg
1995     PAF_AST_Config *pAstCfg;
1996     Int as;                     /* Audio Stream Number (1, 2, etc.) */
1997     Int z;                      /* encode counter */
1998     Int errno = 0;              /* error number */
1999     Int zO, zS;
2002     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2003     as = pAstCfg->as;
2005     for (z=ENCODE1; z < ENCODEN; z++) 
2006     {
2007         zO = pP->outputsFromEncodes[z];
2008         zS = pP->streamsFromEncodes[z];
2009         if (! (pAstCfg->xEnc[z].encodeStatus.command2 & 0x80)) 
2010         {
2011             switch (pAstCfg->xEnc[z].encodeStatus.command2) 
2012             {
2013                 case 0: // command none - process
2014                     pAstCfg->xEnc[z].encodeStatus.command2 |= 0x80;
2015                     break;
2016                 case 1: // mute command
2017                     TRACE_VERBOSE2("AS%d: PAF_ASOT_encodeCommand: encode command mute (0x%02x)", as+zS, 1);
2018                     if ((pAstCfg->xOut[zO].outBufStatus.audio & 0x0f) != PAF_OB_AUDIO_QUIET
2019                         && pAstCfg->xOut[zO].hTxSio
2020                         && (errno = SIO_ctrl (pAstCfg->xOut[zO].hTxSio, PAF_SIO_CONTROL_MUTE, 0))) 
2021                     {
2022                         errno = (errno & 0xff) | ASPERR_MUTE;
2023                         /* convert to sensical errno */
2024                         TRACE_TERSE1("AS%d: PAF_ASOT_encodeCommand: SIO control failed (mute)", as+zS);
2025                         TRACE_TERSE2("AS%d: PAF_ASOT_encodeCommand: errno = 0x%04x <ignored>", as+zS, errno);
2026                     }
2027                     else 
2028                     {
2029                         pAstCfg->xOut[zO].outBufStatus.audio |= PAF_OB_AUDIO_MUTED;
2030                     }
2031                     pAstCfg->xEnc[z].encodeStatus.command2 |= 0x80;
2032                     break;
2033                 case 2: // unmute command
2034                     TRACE_VERBOSE2("AS%d: PAF_ASOT_encodeCommand: encode command unmute (0x%02x)", as+zS, 2);
2035                     if ((pAstCfg->xOut[zO].outBufStatus.audio & 0x0f) != PAF_OB_AUDIO_QUIET
2036                         && pAstCfg->xOut[zO].hTxSio
2037                         && (errno = SIO_ctrl (pAstCfg->xOut[zO].hTxSio, PAF_SIO_CONTROL_UNMUTE, 0))) 
2038                     {
2039                         errno = (errno & 0xff) | ASPERR_MUTE;
2040                         /* convert to sensical errno */
2041                         TRACE_TERSE1("AS%d: PAF_ASOT_encodeCommand: SIO control failed (unmute)", as+zS);
2042                         TRACE_TERSE2("AS%d: PAF_ASOT_encodeCommand: errno = 0x%04x <ignored>", as+zS, errno);
2043                     }
2044                     else 
2045                     {
2046                         pAstCfg->xOut[zO].outBufStatus.audio &= ~PAF_OB_AUDIO_MUTED;
2047                     }
2048                     pAstCfg->xEnc[z].encodeStatus.command2 |= 0x80;
2049                     break;
2050                 default: // command unknown - ignore
2051                     break;
2052             }
2053         }
2054     }
2056     ERRNO_RPRT (TaskAsop, errno);
2058     return 0;
2059 } //PAF_ASOT_encodeCommand
2061 //   Purpose:   Decoding Function for reinitializing the decoding process.
2062 Int
2063 PAF_ASOT_decodeInit(
2064     const PAF_ASOT_Params *pP, 
2065     const PAF_ASOT_Patchs *pQ, 
2066     PAF_ASOT_Config *pAsotCfg
2069     //PAF_AST_Config *pAstCfg;
2070     PAF_AST_DecOpCircBufCtl *pCbCtl;    /* Decoder output circular buffer control */
2071     //Int as;                             /* Audio Stream Number (1, 2, etc.) */
2072     Int z;                              /* decode/encode counter */
2073     Int errno;                          /* error number */
2074     //Int zO, zS;
2076     //pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2077     //as = pAstCfg->as;
2079     pCbCtl = &pAsotCfg->pAspmCfg->decOpCircBufCtl; // get pointer to circular buffer control
2081     for (z=DECODE1; z < DECODEN; z++)
2082     {
2083         // Start decoder output circular buffer reads
2084         errno = cbReadStart(pCbCtl, z);
2085         if (errno)
2086         {
2087             TRACE_TERSE1("PAF_ASOT_decodeInit:cbReadStart() error=%d", errno);
2088             SW_BREAKPOINT; // debug
2089             return errno;
2090         }
2091         gCbReadAfErr=0;         // reset read circular buffer error count
2092         gDecOpCbRdAfUnd=0;      // reset decoder output circular buffer underflow count
2093         gMaxDecOpCbRdAfUnd=0;   // reset max decoder output circular buffer underflow count
2094         gMasterCbResetCnt=0;    // reset master circular buffer reset count
2096         // FL: debug, log circular buffer control variables
2097         cbLog(pCbCtl, z, 1, "PAF_ASOT_decodeInit:cbReadStart");
2098     }
2099     
2100 #if 0 // moved to PAF_ASOT_outputReset()
2101     // TODO: move this to start of this function so that it doesn't affect IO timing
2102     for (z=ENCODE1; z < ENCODEN; z++) 
2103     {
2104         zO = pP->outputsFromEncodes[z];
2105         zS = pP->streamsFromEncodes[z];
2106         if (pAstCfg->xOut[zO].hTxSio && pAstCfg->xEnc[z].encodeStatus.mode) 
2107         {
2108             Int select = pAstCfg->xEnc[z].encodeStatus.select;
2109             ALG_Handle encAlg = pAstCfg->xEnc[z].encAlg[select];
2110             ENC_Handle enc = (ENC_Handle )encAlg;
2111             TRACE_VERBOSE1("AS%d: PAF_ASOT_decodeInit: initializing encode", as+zS);
2112             if (encAlg->fxns->algActivate)
2113             {
2114                 encAlg->fxns->algActivate (encAlg);
2115             }
2116             if (enc->fxns->reset)
2117             {
2118                 errno = enc->fxns->reset(enc, NULL, 
2119                     &pAstCfg->xEnc[z].encodeControl, &pAstCfg->xEnc[z].encodeStatus);
2120                 if (errno)
2121                 {
2122                     return errno;
2123                 }
2124             }
2125         }
2126     }
2127 #endif
2128     
2129     return 0;
2132 // -----------------------------------------------------------------------------
2133 // ASOT Decoding Function - Info Processing, Initial
2134 //
2135 //   Name:      PAF_ASOT_decodeInfo1
2136 //   Purpose:   Decoding Function for processing information in a manner that
2137 //              is unique to initial frames of input data.
2138 //   From:      AST Parameter Function -> decodeProcessing
2139 //   Uses:      See code.
2140 //   States:    x
2141 //   Return:    Error number in standard or SIO form (0 on success).
2142 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2143 //              * State information as per parent.
2144 //
2145 Int
2146 PAF_ASOT_decodeInfo1(
2147     const PAF_ASOT_Params *pP, 
2148     const PAF_ASOT_Patchs *pQ, 
2149     PAF_ASOT_Config *pAsotCfg, 
2150     Int frame, 
2151     Int block
2154     //PAF_AST_Config *pAstCfg;
2155     //Int z;                              /* decode/encode counter */
2156     Int errno;                          /* error number */
2158 #if 0 // moved to PAF_ASOT_outputInfo1()
2159     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2161     // run the chain of ASP's on the stream.
2162     TRACE_VERBOSE0("PAF_ASOT_decodeInfo1: calling streamChainFunction.");
2163     errno = pP->fxns->streamChainFunction(pP, pQ, pAsotCfg, 
2164         PAF_ASP_CHAINFRAMEFXNS_RESET, 1, frame);
2165     if (errno)
2166     {
2167         TRACE_TERSE1("PAF_ASOT_decodeInfo1: streamChainFunction returns errno 0x%x ", errno);
2168         return errno;
2169     }
2171     TRACE_VERBOSE0("PAF_ASOT_decodeInfo1: calling enc->info.");
2172     for (z=ENCODE1; z < ENCODEN; z++) 
2173     {
2174         Int zO = pP->outputsFromEncodes[z];
2175         if (pAstCfg->xOut[zO].hTxSio && pAstCfg->xEnc[z].encodeStatus.mode) 
2176         {
2177             Int select = pAstCfg->xEnc[z].encodeStatus.select;
2178             ALG_Handle encAlg = pAstCfg->xEnc[z].encAlg[select];
2179             ENC_Handle enc = (ENC_Handle )encAlg;
2180             
2181             if (enc->fxns->info)
2182             {
2183                 errno = enc->fxns->info(enc, NULL,
2184                     &pAstCfg->xEnc[z].encodeControl, 
2185                     &pAstCfg->xEnc[z].encodeStatus);
2186                 if (errno)
2187                 {
2188                     TRACE_TERSE1("PAF_ASOT_decodeInfo1: info returns errno 0x%x ", errno);
2189                     return errno;
2190                 }
2191             }
2192         }
2193     }
2194 #endif    
2196     errno = pP->fxns->setCheckRateX(pP, pQ, pAsotCfg, 0);
2197     if (errno)
2198     {
2199         // ignore if rateX has changed since we haven't, but are about to,
2200         // start the output. If we didn't ignore this case then the state machine
2201         // would restart unnecessarily, e.g. in the case of SRC, resulting in
2202         // added latency.
2203         if (errno != ASPERR_INFO_RATECHANGE)
2204         {
2205             TRACE_TERSE1("PAF_ASOT_decodeInfo1: setCheckRateX returns errno 0x%x, not RATECHANGE", errno);
2206             return errno;
2207         }
2208         else
2209         {
2210             TRACE_TERSE0("PAF_ASOT_decodeInfo1: RATECHANGE returns RATECHANGE, ignoring");
2211         }
2212     }
2214     errno = pP->fxns->startOutput(pP, pQ, pAsotCfg);
2215     if (errno) 
2216     {
2217         if (errno == 0x105) 
2218         {
2219             TRACE_TERSE1("PAF_ASOT_decodeInfo1: startOutput returns RING BUFFER FULL (0x%x)", errno);
2220         }
2221         else
2222         {
2223             TRACE_TERSE1("PAF_ASOT_decodeInfo1: startOutput returns errno 0x%x", errno);
2224         }
2225         return errno;
2226     }
2227     
2228     return 0;
2231 // -----------------------------------------------------------------------------
2232 // ASOT Decoding Function - Info Processing, Subsequent
2233 //
2234 //   Name:      PAF_ASOT_decodeInfo2
2235 //   Purpose:   Decoding Function for processing information in a manner that
2236 //              is unique to frames of input data other than the initial one.
2237 //   From:      AST Parameter Function -> decodeProcessing
2238 //   Uses:      See code.
2239 //   States:    x
2240 //   Return:    Error number in standard form (0 on success).
2241 //   Trace:     None.
2242 //
2243 Int
2244 PAF_ASOT_decodeInfo2(
2245     const PAF_ASOT_Params *pP, 
2246     const PAF_ASOT_Patchs *pQ, 
2247     PAF_ASOT_Config *pAsotCfg, 
2248     Int frame, 
2249     Int block
2252     //PAF_AST_Config *pAstCfg;
2253     Int errno;
2255     
2256     //pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2258     errno = pP->fxns->setCheckRateX (pP, pQ, pAsotCfg, 1);
2259     TRACE_VERBOSE1("PAF_ASOT_decodeInfo2: return 0x%x", errno);
2260     return errno;
2261 } //PAF_ASOT_decodeInfo2
2264 PAF_AST_DecOpCircBufStats gCbStats; // FL: debug
2265 // -----------------------------------------------------------------------------
2266 // ASOT Decoding Function - Stream Processing
2267 //
2268 //   Name:      PAF_ASOT_decodeStream
2269 //   Purpose:   Decoding Function for processing of audio frame data by the
2270 //              ASP Algorithms.
2271 //   From:      AST Parameter Function -> decodeProcessing
2272 //   Uses:      See code.
2273 //   States:    x
2274 //   Return:    Error number in standard form (0 on success).
2275 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2276 //              * State information as per parent/child.
2277 //
2278 Int
2279 PAF_ASOT_decodeStream(
2280     const PAF_ASOT_Params *pP, 
2281     const PAF_ASOT_Patchs *pQ, 
2282     PAF_ASOT_Config *pAsotCfg, 
2283     Int frame, 
2284     Int block
2287     PAF_AST_Config *pAstCfg;
2288     PAF_AST_DecOpCircBufCtl *pCbCtl;    /* Decoder output circular buffer control */
2289     Int z;                              /* decode/stream counter */
2290     PAF_AudioFrame *pAfRd;
2291     Int cbErrno;
2292     PAF_AST_DecOpCircBufStats cbStats;  /* circular buffer statistics */
2293     Int errno;
2296     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2297     
2298     pCbCtl = &pAsotCfg->pAspmCfg->decOpCircBufCtl; // get pointer to circular buffer control
2299     
2300     for (z=DECODE1; z < DECODEN; z++) 
2301     {
2302         Int zS = pP->streamsFromDecodes[z];
2303         
2304         //
2305         // Read decoder output circular buffer
2306         //
2307         pAfRd = pAstCfg->xStr[zS].pAudioFrame;
2308         //GPIOSetOutput(GPIO_PORT_0, GPIO_PIN_106);
2309         cbErrno = cbReadAf(pCbCtl, z, pAfRd);
2310         if ((cbErrno < 0) && (cbErrno != ASP_DECOP_CB_READ_UNDERFLOW))
2311         {
2312             gCbReadAfErr++;
2313             TRACE_TERSE1("PAF_ASOT_decodeStream:cbReadAf() error=%d", cbErrno);
2314             //SW_BREAKPOINT; // FL: debug
2315             return cbErrno;
2316         }
2318         // Handle underflows
2319         if (cbErrno == ASP_DECOP_CB_READ_UNDERFLOW)
2320         {
2321             // FL: some number of underflows alway occur on start of stream when ASOT only depends on configured Output.
2322             //     DDP: ~2 underflows
2323             //     MAT-THD: ~16 underflows
2324             // Need to check behavior of cbReset().
2325             // Need to check behavior on exit/re-entry into Output processing.
2326             
2327             gDecOpCbRdAfUnd++; // increment circular buffer underflow count
2328             if (gDecOpCbRdAfUnd >= DEC_OP_CB_RDAF_UND_THR) 
2329             {
2330                 // Underflow count above threshold.
2331                 // (1) set max underflow count to threshold
2332                 // (2) reset underflow count
2333                 // (3) reset circular buffer
2334                 
2335                 gMaxDecOpCbRdAfUnd = DEC_OP_CB_RDAF_UND_THR; // update max underflow count
2336                 gDecOpCbRdAfUnd = 0; // reset underflow count
2338                 // Reset circular buffer
2339                 cbReset(pCbCtl, z);
2340                 gMasterCbResetCnt++; // increment master circular buffer reset count
2341                 Log_info0("ASOT:cbReset");
2342             
2343                 return cbErrno;
2344             }
2345         }
2346         else if ((cbErrno == ASP_DECOP_CB_SOK) && (gDecOpCbRdAfUnd > 0))
2347         {
2348             // No underflow detected.
2349             // update max underflow count,
2350             // reset underflow count
2351             
2352             // update max underflow count
2353             if (gDecOpCbRdAfUnd > gMaxDecOpCbRdAfUnd)
2354             {
2355                 gMaxDecOpCbRdAfUnd = gDecOpCbRdAfUnd;
2356             }
2357             gDecOpCbRdAfUnd = 0; // reset circular buffer underflow count
2358         }
2359         //Log_info0("PAF_ASOT_decodeStream:cbReadAf() complete.");
2360         //GPIOClearOutput(GPIO_PORT_0, GPIO_PIN_106);
2361         Log_info0("PAF_ASOT_decodeStream:cbReadAf() complete.");
2362         
2363 #if 0 // (***) FL: shows timing of CB read
2364             // (***) debug // B8
2365             {
2366                 static Uint8 toggleState = 0;
2367                 if (toggleState == 0)
2368                     GPIOSetOutput(GPIO_PORT_0, GPIO_PIN_106);
2369                 else
2370                     GPIOClearOutput(GPIO_PORT_0, GPIO_PIN_106);
2371                 toggleState = ~(toggleState);
2372             }
2373 #endif
2375         // FL: debug
2376         // Get circular buffer statistics (debug)
2377         //cbGetStats(pCbCtl, z, &cbStats);
2378         cbGetStats(pCbCtl, z, &gCbStats);
2380         // FL: debug
2381         cbLog(pCbCtl, z, 1, "PAF_ASOT_decodeStream:cbReadAf");
2382         //if (capAfWrite(pAfRd, 0) != CAP_AF_SOK)
2383         //{
2384         //    Log_info0("capAfWrite() error");
2385         //}
2386     }
2387             
2388     TRACE_VERBOSE0("PAF_ASOT_outputStream: calling streamChainFunction.");
2389     errno = pP->fxns->streamChainFunction(pP, pQ, pAsotCfg, 
2390         PAF_ASP_CHAINFRAMEFXNS_APPLY, 1, block);
2391     if (errno)
2392     {
2393         TRACE_TERSE1("PAF_ASOT_outputStream: streamChainFunction returns errno 0x%x ", errno);
2394         return errno;
2395     }
2397     return 0;
2399 } //PAF_ASOT_decodeStream
2401 // -----------------------------------------------------------------------------
2402 // ASOT Decoding Function - Encode Processing
2403 //
2404 //   Name:      PAF_ASOT_decodeEncode
2405 //   Purpose:   Decoding Function for processing of audio frame data by the
2406 //              Encode Algorithm.
2407 //   From:      AST Parameter Function -> decodeProcessing
2408 //   Uses:      See code.
2409 //   States:    x
2410 //   Return:    Error number in standard or SIO form (0 on success).
2411 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2412 //              * State information as per parent.
2413 //
2414 Int
2415 PAF_ASOT_decodeEncode(
2416     const PAF_ASOT_Params *pP, 
2417     const PAF_ASOT_Patchs *pQ, 
2418     PAF_ASOT_Config *pAsotCfg, 
2419     Int frame, 
2420     Int block
2423     PAF_AST_Config *pAstCfg;
2424     Int as;                     /* Audio Stream Number (1, 2, etc.) */
2425     Int z;                      /* encode/output counter */
2426     Int errno;                  /* error number */
2427     Int zX, zE, zS;
2428     UInt32 curTime;
2430     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2431     as = pAstCfg->as;
2433     // Await output buffers (but not first time)
2434     for (z=OUTPUT1; z < OUTPUTN; z++) 
2435     {
2436         // determine encoder associated with this output
2437         zE = z;
2438         for (zX = ENCODE1; zX < ENCODEN; zX++) 
2439         {
2440             if (pP->outputsFromEncodes[zX] == z) 
2441             {
2442                 zE = zX;
2443                 break;
2444             }
2445         }
2446         zS = pP->streamsFromEncodes[zE];
2448         if (pAstCfg->xOut[z].hTxSio) 
2449         {
2450             // update length (e.g. ARC may have changed)
2451             pAstCfg->xOut[z].outBufConfig.lengthofFrame = 
2452                 pAstCfg->xEnc[zE].encodeInStruct.pAudioFrame->sampleCount;
2453             TRACE_GEN2("PAF_ASOT_decodeEncode: AS%d: processing block %d -- idle", as+zS, block);
2454             errno = SIO_reclaim(pAstCfg->xOut[z].hTxSio,(Ptr *) &pAstCfg->xOut[z].pOutBuf, NULL);
2455             if (errno < 0)
2456             {
2457                 SIO_idle(pAstCfg->xOut[z].hTxSio);
2458                 TRACE_TERSE2("PAF_ASOT_decodeEncode: AS%d: SIO_reclaim returns error %d", as+zS, -errno);
2459                 return -errno; // SIO negates error codes
2460             }
2461             // TODO: use pC->xOut[z].pOutBuf in following ->encode call
2463 #if 0 // (***) FL: shows timing of Output Rx SIO reclaim
2464             // (***) debug // B8
2465             {
2466                 static Uint8 toggleState = 0;
2467                 if (toggleState == 0)
2468                     GPIOSetOutput(GPIO_PORT_0, GPIO_PIN_106);
2469                 else
2470                     GPIOClearOutput(GPIO_PORT_0, GPIO_PIN_106);
2471                 toggleState = ~(toggleState);
2472             }
2473 #endif            
2475             gAsopTxSioReclaimCnt++;
2477             //
2478             // Simulate Tx SIO_reclaim() pend
2479             //
2480             //Semaphore_pend(semaphoreTxAudio, BIOS_WAIT_FOREVER);
2481             curTime = Clock_getTicks();
2482             //System_printf("System time in TaskAsipFxn Tx audio = %lu\n", (ULong)curTime);
2483             //Log_info1("outputEncode():Tx SIO reclaim(), system time = %u", curTime);
2484         }
2485         else 
2486         {
2487             TRACE_VERBOSE2("AS%d: PAF_ASOT_decodeEncode: processing block %d -- idle <ignored>", as+zS, block);
2488         }
2489     }
2491     // Encode data
2492     for (z=ENCODE1; z < ENCODEN; z++) 
2493     {
2494         Int zO = pP->outputsFromEncodes[z];
2495         Int zS = pP->streamsFromEncodes[z];
2496         (void)zS; // clear compiler warning in case not used with tracing disabled
2497         if (pAstCfg->xOut[zO].hTxSio && pAstCfg->xEnc[z].encodeStatus.mode) 
2498         {
2499             Int select = pAstCfg->xEnc[z].encodeStatus.select;
2500             ALG_Handle encAlg = pAstCfg->xEnc[z].encAlg[select];
2501             ENC_Handle enc = (ENC_Handle )encAlg;
2502             if (select != pAstCfg->xEnc[z].encodeControl.encActive)
2503             {
2504                 pAstCfg->xEnc[z].encodeControl.encActive = select;
2505                 TRACE_TERSE0("PAF_ASOT_decodeEncode: return error");
2506                 return (-1);
2507             }
2508             TRACE_GEN2("AS%d: PAF_ASOT_decodeEncode: processing block %d -- encode", as+zS, block);
2510             // (MID 1933) temp. workaround for PCE2
2511             pAstCfg->xEnc[z].encodeInStruct.pAudioFrame->data.nChannels = PAF_MAXNUMCHAN;
2513           /*
2514           #if (CURRENT_TRACE_MASK & TRACE_MASK_DATA)
2515             {
2516                 PAF_AudioFrame *pAudioFrame = pC->xEnc[z].encodeInStruct.pAudioFrame;
2517                 int *wp;
2518                 wp = (int*)pAudioFrame->data.sample[0];
2519                 TRACE_DATA((&TR_MOD, "as1-f2: AS%d PAF_ASOT_outputEncode: encoding from ch 0 0x%x. line %d", z, wp, __LINE__));
2520                 TRACE_DATA((&TR_MOD, "as1-f2: [0]: 0x%x, [16]: 0x%x, [99]: 0x%x (ch0)", wp[0], wp[16], wp[99]));
2521                 wp = (int*)pAudioFrame->data.sample[1];
2522                 TRACE_DATA((&TR_MOD, "as1-f2: PAF_ASOT_outputEncode: encoding from ch 1 0x%x. line %d", wp, __LINE__));
2523                 TRACE_DATA((&TR_MOD, "as1-f2: [0]: 0x%x, [16]: 0x%x, [99]: 0x%x (ch1)", wp[0], wp[16], wp[99]));
2524                 wp = (int*)pAudioFrame->data.sample[2];
2525                 TRACE_DATA((&TR_MOD, "as1-f2: PAF_ASOT_outputEncode: encoding from ch 2 0x%x. line %d", wp, __LINE__));
2526                 TRACE_DATA((&TR_MOD, "as1-f2: [0]: 0x%x, [16]: 0x%x, [99]: 0x%x (ch2)", wp[0], wp[16], wp[99]));
2527             }
2528           #endif
2529           */
2531             if (enc->fxns->encode)
2532             {
2533                 pAstCfg->xEnc[z].encodeOutStruct.bypassFlag =
2534                         pP->z_pEncodeStatus[z]->encBypass;
2535                 errno = enc->fxns->encode(enc, NULL, 
2536                     &pAstCfg->xEnc[z].encodeInStruct, 
2537                     &pAstCfg->xEnc[z].encodeOutStruct);
2538                 if (errno)
2539                 {
2540                     if (errno != PCEERR_OUTPUT_POINTERNULL)
2541                     {
2542                         TRACE_TERSE1("PAF_ASOT_decodeEncode: return error %d line %d", errno);
2543                         return errno;
2544                     }
2545                 }
2546             /*  #if (CURRENT_TRACE_MASK & TRACE_MASK_DATA)
2547                 else
2548                 {
2549                     int *wp = (int*)pC->xOut[z].pOutBuf->pntr.pVoid;
2550                     TRACE_DATA((&TR_MOD, "as1-f2: PAF_ASOT_outputEncode: encoded to 0x%x. line %d", wp, __LINE__));
2551                     TRACE_DATA((&TR_MOD, "as1-f2: [0]: 0x%x, [16]: 0x%x, [99]: 0x%x", wp[0], wp[16], wp[99]));
2552                 }
2553               #endif
2554               */
2555             }
2556         }
2557         else 
2558         {
2559             TRACE_VERBOSE2("PAF_ASOT_decodeEncode: AS%d: processing block %d -- encode <ignored>",
2560                 as+pP->streamsFromEncodes[z], block);
2561         }
2562     }
2564     // Transmit data
2565     for (z=OUTPUT1; z < OUTPUTN; z++) 
2566     {
2567         // determine encoder associated with this output
2568         zE = z;
2569         for (zX = ENCODE1; zX < ENCODEN; zX++) 
2570         {
2571             if (pP->outputsFromEncodes[zX] == z) 
2572             {
2573                 zE = zX;
2574                 break;
2575             }
2576         }
2577         zS = pP->streamsFromEncodes[zE];
2579         if (pAstCfg->xOut[z].hTxSio) 
2580         {
2581             TRACE_GEN2("PAF_ASOT_decodeEncode: AS%d: processing block %d -- output", as+zS, block);
2582             errno = SIO_issue(pAstCfg->xOut[z].hTxSio, 
2583                 &pAstCfg->xOut[z].outBufConfig, sizeof (pAstCfg->xOut[z].outBufConfig), 0);
2584             if (errno)
2585             {
2586                 SIO_idle(pAstCfg->xOut[z].hTxSio);
2587                 if (errno == 0x105)     // 0x105 == RINGIO_EBUFFULL
2588                 {
2589 //                    statStruct_LogFullRing(STATSTRUCT_AS1_F2);
2590                     TRACE_TERSE1("PAF_ASOT_decodeEncode: SIO_idle returned RINGIO_EBUFFULL (0x%x)", errno);
2591                 }
2592                 if (errno > 0)
2593                 {
2594                     TRACE_TERSE1("PAF_ASOT_decodeEncode: return error 0x%x line %d", errno);
2595                     return (ASPERR_ISSUE + (z << 4));
2596                 }
2597                 else if (errno < 0)
2598                 {
2599                     TRACE_TERSE1("PAF_ASOT_decodeEncode: return neg error 0x%x line %d", -errno);
2600                     return -errno; // SIO negates error codes
2601                 }
2602             }
2603             if (errno > 0)
2604             {
2605                 return (ASPERR_ISSUE + (z << 4));
2606             }
2607             else if (errno < 0)
2608             {
2609                 return -errno; // SIO negates error codes
2610             }
2611         }
2612         else 
2613         {
2614             TRACE_GEN2("PAF_ASOT_decodeEncode: AS%d: processing block %d -- output <ignored>", as+zS, block);
2615         }
2616     }
2618     return 0;
2619 } //PAF_ASOT_decodeEncode
2621 // -----------------------------------------------------------------------------
2622 // ASOT Decoding Function - Stream-Final Processing
2623 //
2624 //   Name:      PAF_ASOT_decodeComplete
2625 //   Purpose:   Decoding Function for terminating the decoding process.
2626 //   From:      AST Parameter Function -> decodeProcessing
2627 //   Uses:      See code.
2628 //   States:    x
2629 //   Return:    0.
2630 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2631 //              * State information as per parent.
2632 //
2633 Int
2634 PAF_ASOT_decodeComplete(
2635     const PAF_ASOT_Params *pP, 
2636     const PAF_ASOT_Patchs *pQ, 
2637     PAF_ASOT_Config *pAsotCfg, 
2638     ALG_Handle decAlg[], 
2639     Int frame, 
2640     Int block
2643     PAF_AST_Config *pAstCfg;
2644     PAF_AST_DecOpCircBufCtl *pCbCtl;    /* Decoder output circular buffer control */
2645     Int as;                             /* Audio Stream Number (1, 2, etc.) */
2646     Int z;                              /* decode/encode counter */
2647     Int errno;                          /* error number */
2649     
2650     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2651     as = pAstCfg->as;
2652     (void)as;  // clear compiler warning in case not used with tracing disabled
2654     pCbCtl = &pAsotCfg->pAspmCfg->decOpCircBufCtl; // get pointer to circular buffer control
2655     
2656     for (z=DECODE1; z < DECODEN; z++)
2657     {
2658         // Stop decoder output circular buffer reads
2659         errno = cbReadStop(pCbCtl, z);
2660         if (errno)
2661         {
2662             TRACE_TERSE1("PAF_ASOT_decodeComplete:cbReadStop() error=%d", errno);
2663             SW_BREAKPOINT; // FL: debug
2664             return errno;
2665         }
2666         // FL: debug
2667         cbLog(pCbCtl, z, 1, "PAF_ASOT_decodeComplete:cbReadStop");
2668     }
2669     
2670     pP->fxns->streamChainFunction(pP, pQ, pAsotCfg, PAF_ASP_CHAINFRAMEFXNS_FINAL, 0, frame);
2672     for (z=ENCODE1; z < ENCODEN; z++) 
2673     {
2674         Int zO = pP->outputsFromEncodes[z];
2675         if (pAstCfg->xOut[zO].hTxSio && pAstCfg->xEnc[z].encodeStatus.mode) 
2676         {
2677             Int select = pAstCfg->xEnc[z].encodeStatus.select;
2678             ALG_Handle encAlg = pAstCfg->xEnc[z].encAlg[select];
2679 #ifdef PAF_ASP_FINAL
2680             ENC_Handle enc = (ENC_Handle)encAlg;
2681 #endif /* PAF_ASP_FINAL */
2682             TRACE_VERBOSE1("PAF_ASOT_decodeComplete: AS%d: finalizing encode", as+z);
2683 #ifdef PAF_ASP_FINAL
2684             if (enc->fxns->final)
2685                 enc->fxns->final(enc, NULL, &pAstCfg->xEnc[z].encodeControl,
2686                                  &pAstCfg->xEnc[z].encodeStatus);
2687 #endif /* PAF_ASP_FINAL */
2688             if (encAlg->fxns->algDeactivate)
2689             {
2690                 encAlg->fxns->algDeactivate(encAlg);
2691             }
2692         }
2693         else 
2694         {
2695             TRACE_VERBOSE1("PAF_ASOT_decodeComplete: AS%d: finalizing encode <ignored>", as+z);
2696         }
2697     }
2699     // wait for remaining data to be output
2700     pP->fxns->stopOutput(pP, pQ, pAsotCfg);
2702     return 0;
2703 } //PAF_ASOT_decodeComplete
2705 // -----------------------------------------------------------------------------
2706 // ASOT Decoding Function Helper - SIO Driver Start
2707 //
2708 //   Name:      PAF_ASOT_startOutput
2709 //   Purpose:   Decoding Function for initiating output.
2710 //   From:      AST Parameter Function -> decodeInfo1
2711 //   Uses:      See code.
2712 //   States:    x
2713 //   Return:    Error number in standard or SIO form (0 on success).
2714 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2715 //              * State information as per parent.
2716 //              * SIO control errors.
2717 //
2718 #define DEC_OUTNUMBUF_MAP(X) \
2719       pP->poutNumBufMap[z]->map[(X) >= pP->poutNumBufMap[z]->length ? 0 : (X)]
2721 Int
2722 PAF_ASOT_startOutput(
2723     const PAF_ASOT_Params *pP, 
2724     const PAF_ASOT_Patchs *pQ, 
2725     PAF_ASOT_Config *pAsotCfg
2726
2728     PAF_AST_Config *pAstCfg;
2729     Int as;                     /* Audio Stream Number (1, 2, etc.) */
2730     Int z;                      /* output counter */
2731     Int errno,nbufs;            /* error number */
2732     Int zE, zS, zX;
2733     Int zMD;
2734     PAF_SIO_IALG_Obj    *pObj;
2735     PAF_SIO_IALG_Config *pAlgConfig;
2737     
2738     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2739     as = pAstCfg->as;
2740     zMD = pAstCfg->masterDec;
2742     for (z=OUTPUT1; z < OUTPUTN; z++) 
2743     {
2744         if (pAstCfg->xOut[z].hTxSio) 
2745         {
2746             // determine associated encoder and stream
2747             zE = z;
2748             zS = z;
2749             for (zX = ENCODE1; zX < ENCODEN; zX++) 
2750             {
2751                 if (pP->outputsFromEncodes[zX] == z) 
2752                 {
2753                     zE = zX;
2754                     zS = pP->streamsFromEncodes[zE];
2755                     break;
2756                 }
2757             }
2759             // Set sample count so that DOB knows how much data to send
2760             pAstCfg->xOut[z].outBufConfig.lengthofFrame =
2761                 pAstCfg->xEnc[zE].encodeInStruct.pAudioFrame->sampleCount;
2763             if (pAstCfg->xOut[z].outBufStatus.markerMode == PAF_OB_MARKER_ENABLED) 
2764             {
2765                 pObj = (PAF_SIO_IALG_Obj *) pAstCfg->xOut[z].outChainData.head->alg;
2766                 pAlgConfig = &pObj->config;
2767                 memset(pAstCfg->xOut[z].outBufConfig.base.pVoid, 0xAA, 
2768                     pAlgConfig->pMemRec[0].size);
2769             }
2771             // The index to DEC_OUTNUMBUF_MAP will always come from the primary/master
2772             // decoder. How should we handle the sourceProgram for multiple decoders?
2773             // Override as needed
2774             nbufs = DEC_OUTNUMBUF_MAP(pAstCfg->xDec[zMD].decodeStatus.sourceProgram);
2775             if (pAstCfg->xOut[z].outBufStatus.numBufOverride[pAstCfg->xDec[zMD].decodeStatus.sourceProgram] > 0)
2776             {
2777                 nbufs = pAstCfg->xOut[z].outBufStatus.numBufOverride[pAstCfg->xDec[zMD].decodeStatus.sourceProgram];
2778             }
2779             SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_SET_NUMBUF, nbufs);
2781             if (errno = SIO_issue(pAstCfg->xOut[z].hTxSio,
2782                 &pAstCfg->xOut[z].outBufConfig, sizeof(pAstCfg->xOut[z].outBufConfig), 0)) 
2783             {
2784                 SIO_idle(pAstCfg->xOut[z].hTxSio);
2785                 TRACE_TERSE2("PAF_ASOT_startOutput: AS%d: SIO_issue failed (0x%x)", as+zS, errno);
2786                 return errno;
2787             }
2789             if (!(pAstCfg->xOut[z].outBufStatus.audio & 0xf0) && 
2790                 (errno =  SIO_ctrl (pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_UNMUTE, 0))) 
2791             {
2792                 errno = (errno & 0xff) | ASPERR_MUTE;
2793                 /* convert to sensical errno */
2794                 TRACE_TERSE2("as1-f2: PAF_ASOT_startOutput: AS%d: SIO control failed (unmute) 0x%x", as+zS, errno);
2795                 return (errno);
2796             }
2797             else
2798             {
2799                 pAstCfg->xOut[z].outBufStatus.audio
2800                     = (pAstCfg->xOut[z].outBufStatus.audio & 0xf0) | PAF_OB_AUDIO_SOUND;                
2801             }
2803             TRACE_VERBOSE1("PAF_ASOT_startOutput: AS%d: output started", as+zS);
2804         }
2805     }
2807     return 0;
2808 } //PAF_ASOT_startOutput
2810 // -----------------------------------------------------------------------------
2811 // ASOT Decoding Function Helper - SIO Driver Stop
2812 //
2813 //   Name:      PAF_ASOT_stopOutput
2814 //   Purpose:   Decoding Function for terminating output.
2815 //   From:      AST Parameter Function -> decodeProcessing
2816 //              AST Parameter Function -> decodeComplete
2817 //   Uses:      See code.
2818 //   States:    x
2819 //   Return:    Error number in standard or SIO form (0 on success).
2820 //   Trace:     Message Log "trace" in Debug Project Configuration reports:
2821 //              * SIO control errors.
2822 //
2823 Int
2824 PAF_ASOT_stopOutput(
2825     const PAF_ASOT_Params *pP, 
2826     const PAF_ASOT_Patchs *pQ, 
2827     PAF_ASOT_Config *pAsotCfg
2830     PAF_AST_Config *pAstCfg;
2831     Int as;                     /* Audio Stream Number (1, 2, etc.) */
2832     Int z;                      /* output counter */
2833     Int errno = 0, getVal;
2834     Int zS, zX;
2835     PAF_SIO_IALG_Obj    *pObj;
2836     PAF_SIO_IALG_Config *pAlgConfig;
2838     pAstCfg = pAsotCfg->pAstCfg; // get pointer to AST common (shared) configuration
2839     as = pAstCfg->as;
2840     (void)as;  // clear compiler warning in case not used with tracing disabled
2842     for (z=OUTPUT1; z < OUTPUTN; z++) 
2843     {
2844         if (pAstCfg->xOut[z].hTxSio) 
2845         {
2846             // determine associated encoder and stream
2847             zS = z;
2848             (void)zS;
2849             for (zX = ENCODE1; zX < ENCODEN; zX++) 
2850             {
2851                 if (pP->outputsFromEncodes[zX] == z) 
2852                 {
2853                     zS = pP->streamsFromEncodes[zX];
2854                     break;
2855                 }
2856             }
2858             // Mute output before audio data termination in the usual case,
2859             // where such termination is due to decode error or user command.
2860             // Identification of this as the usual case is provided by the
2861             // "decode processing" state machine.
2862             if (!(pAstCfg->xOut[z].outBufStatus.audio & 0xf0) &&
2863                 ((pAstCfg->xOut[z].outBufStatus.audio & 0x0f) == PAF_OB_AUDIO_SOUND) &&
2864                 (getVal = SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_MUTE, 0))) 
2865             {
2866                 if (!errno) 
2867                 {
2868                     errno = (getVal & 0xff) | ASPERR_MUTE;
2869                     /* convert to sensical errno */
2870                 }
2871                 TRACE_VERBOSE1("PAF_ASOT_stopOutput:  AS%d: SIO control failed (mute)", as+zS);
2872             }
2874             TRACE_TIME((&TIME_MOD, "... + %d = %d (stopOutput -- begin PAF_SIO_CONTROL_IDLE)", dtime(), TSK_time()));
2876             // Terminate audio data output, truncating (ignore) or flushing
2877             // (play out) final samples as per (1) control register set by
2878             // the user and (2) the type of audio data termination:
2880 #if 0
2881             // This form is not used because driver support for truncating
2882             // data is not supported for internal clocks, although it is
2883             // for external clocks.
2884             getVal = SIO_ctrl(pC->xOut[z].hTxSio, PAF_SIO_CONTROL_IDLE,
2885                 pC->xOut[z].outBufStatus.flush
2886                 & (pC->xOut[z].outBufStatus.audio & 0x0f) == PAF_OB_AUDIO_FLUSH
2887                 ? 1 : 0);
2888             /* UNTESTED */
2889 #else
2890             // This form should be used when driver support for truncating
2891             // data is supported for both internal and external clocks.
2892             getVal = SIO_ctrl(pAstCfg->xOut[z].hTxSio, PAF_SIO_CONTROL_IDLE,
2893                 pAstCfg->xOut[z].outBufStatus.flush ? 1 :
2894                 (pAstCfg->xOut[z].outBufStatus.audio & 0x0f) == PAF_OB_AUDIO_FLUSH
2895                 ? 1 : 0);
2896             /* TESTED */
2897 #endif
2899             TRACE_TIME((&TIME_MOD, "... + %d = %d (stopOutput -- after PAF_SIO_CONTROL_IDLE)", dtime(), TSK_time()));
2901             if (!errno)
2902             {
2903                 errno = getVal;