File: HalTimecode.cpp

package info (click to toggle)
oss4 4.2-build2020-6
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 15,332 kB
  • sloc: ansic: 239,151; cpp: 18,981; sh: 4,590; pascal: 3,863; asm: 1,189; makefile: 553; php: 53; xml: 46
file content (739 lines) | stat: -rw-r--r-- 22,102 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
/****************************************************************************
 HalTimecode.cpp

 Description:	Lynx Application Programming Interface Header File

 Created: David A. Hoatson, September 2000
	
 Copyright  2000 Lynx Studio Technology, Inc.

 This software contains the valuable TRADE SECRETS and CONFIDENTIAL INFORMATION 
 of Lynx Studio Technology, Inc. The software is protected under copyright 
 laws as an unpublished work of Lynx Studio Technology, Inc.  Notice is 
 for informational purposes only and does not imply publication.  The user 
 of this software may make copies of the software for use with products 
 manufactured by Lynx Studio Technology, Inc. or under license from 
 Lynx Studio Technology, Inc. and for no other use.

 THIS CODE AND INFORMATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY
 KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
 IMPLIED WARRANTIES OF MERCHANTABILITY AND/OR FITNESS FOR A PARTICULAR
 PURPOSE.

 Environment: 

 4 spaces per tab

 Revision History
 
 When      Who  Description
 --------- ---  ------------------------------------------------------------
 Oct 19 04 DAH	Set the m_ulDeviceNumber so SetDefaults would not fail.
 Aug 09 04 DAH	Reset the MTC position so it will be invalid until the next 
				valid MTC message comes in
****************************************************************************/

#include <StdAfx.h>
#include "HalAdapter.h"

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::Open (PHALADAPTER pHalAdapter, ULONG ulDeviceNumber)
/////////////////////////////////////////////////////////////////////////////
{
  PLYNXTWOREGISTERS pRegisters = pHalAdapter->GetRegisters ();

  m_pRegLTCControl = pHalAdapter->GetRegLTCControl ();

  m_CurrentPosition.ulTimecode = 0;

  m_bDropFrame = TRUE;
  m_ucMTCFrameRate = MTC_FRAMERATE_30DROP;
  m_ucMaxFrame = 0;
  m_bHasValidTimecode = FALSE;

  m_bMTCRunning = FALSE;

  // must be setup before SetDefaults
  m_ulDeviceNumber = ulDeviceNumber;

  if (IsRx ())
    {
      m_RegLTCRxRate.Init (pHalAdapter, &pRegisters->TCBlock.LTCRxFrameRate,
			   REG_READONLY);
      m_RegTCStatus.Init (pHalAdapter, &pRegisters->TCBlock.TCStatus,
			  REG_READONLY);

      // enable the TC Receiver
      m_pRegLTCControl->BitSet (REG_LTCCONTROL_LRXEN | REG_LTCCONTROL_LRXIE,
				TRUE);
    }
  else
    {
      SetDefaults ();
    }

  m_bOpen = TRUE;

  return (CHalDevice::Open (pHalAdapter, ulDeviceNumber));
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::Close ()
/////////////////////////////////////////////////////////////////////////////
{
  //cmn_err((CE_WARN,"CHalTimecode::Close\n");
  if (m_bOpen)
    Stop ();

  m_bOpen = FALSE;
  return (CHalDevice::Close ());
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::Start ()
/////////////////////////////////////////////////////////////////////////////
{
  ULONG PCBuffer[TCBUFFER_SIZE];

  if (!m_bOpen)
    return (HSTATUS_ADAPTER_NOT_OPEN);

  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  // Transmit Start

  // Preload two buffers worth of timecode data to the hardware
  EncodeTxBuffer (PCBuffer);
  WriteTimecode (TC_BUFFERA, PCBuffer);
  IncrementTimecode ();

  EncodeTxBuffer (PCBuffer);
  WriteTimecode (TC_BUFFERB, PCBuffer);
  IncrementTimecode ();

  // turn on the transmitter
  m_pRegLTCControl->BitSet (REG_LTCCONTROL_LTXEN | REG_LTCCONTROL_LTXIE,
			    TRUE);

  return (CHalDevice::Start ());
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::Stop ()
/////////////////////////////////////////////////////////////////////////////
{
  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  // Transmit Stop
  m_pRegLTCControl->BitSet (REG_LTCCONTROL_LTXEN | REG_LTCCONTROL_LTXIE,
			    FALSE);

  m_bMTCRunning = FALSE;

  return (CHalDevice::Stop ());
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::EnableMTC (BOOLEAN bEnable)
/////////////////////////////////////////////////////////////////////////////
{
  if (!IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  if (bEnable)
    {
      m_pRegLTCControl->BitSet (REG_LTCCONTROL_LRXQFIE, TRUE);
      //m_pRegLTCControl->BitSet( REG_LTCCONTROL_LRXEN | REG_LTCCONTROL_LRXIE, TRUE );
    }
  else
    {
      m_pRegLTCControl->BitSet (REG_LTCCONTROL_LRXQFIE, FALSE);
      //m_pRegLTCControl->BitSet( REG_LTCCONTROL_LRXEN | REG_LTCCONTROL_LRXIE, FALSE );
    }
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::GetMTCFrameRate (PBYTE pucMTCFrameRate)
/////////////////////////////////////////////////////////////////////////////
{
  if (!IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  if (!IsInputLocked ())
    return (HSTATUS_INVALID_MODE);

  *pucMTCFrameRate = m_ucMTCFrameRate;

  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetFrameRate (ULONG ulFrameRate)
/////////////////////////////////////////////////////////////////////////////
{
  BOOLEAN bDropFrame = m_bDropFrame;

  //cmn_err((CE_WARN,"CHalTimecode::SetFrameRate %lu\n", ulFrameRate );

  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  if (IsRunning ())
    return (HSTATUS_INVALID_MODE);

  switch (ulFrameRate)
    {
    case MIXVAL_TCFRAMERATE_24FPS:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXRATE_24FPS,
			       REG_LTCCONTROL_LTXRATE_MASK);
      m_ucMaxFrame = 23;	// 0..23
      m_bDropFrame = FALSE;
      break;
    case MIXVAL_TCFRAMERATE_25FPS:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXRATE_25FPS,
			       REG_LTCCONTROL_LTXRATE_MASK);
      m_ucMaxFrame = 24;	// 0..24
      m_bDropFrame = FALSE;
      break;
    case MIXVAL_TCFRAMERATE_2997FPS:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXRATE_2997FPS,
			       REG_LTCCONTROL_LTXRATE_MASK);
      m_ucMaxFrame = 29;	// 0..29
      break;
    case MIXVAL_TCFRAMERATE_30FPS:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXRATE_30FPS,
			       REG_LTCCONTROL_LTXRATE_MASK);
      m_ucMaxFrame = 29;	// 0..29
      break;
    default:
      return (HSTATUS_INVALID_PARAMETER);
    }

  // if we changed the drop from status, update the mixer
  if (m_bDropFrame != bDropFrame)
    m_pHalAdapter->GetMixer ()->ControlChanged (LINE_ADAPTER, LINE_NO_SOURCE,
						CONTROL_LTCOUT_DROPFRAME);

  m_ulFrameRate = ulFrameRate;

  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
BOOLEAN
CHalTimecode::IsInputLocked (void)
/////////////////////////////////////////////////////////////////////////////
{
  BOOLEAN bLocked;

  if (!IsRx ())
    return ((BOOLEAN) - 1);

  bLocked = m_RegTCStatus & TCSTATUS_LRXLOCK ? TRUE : FALSE;
  if (!bLocked)
    {
      // Do not reset the current position, or the mixer UI will show 0 when we go unlocked!
      m_bDropFrame = 0;
      m_ucMaxFrame = 0;
      m_bHasValidTimecode = FALSE;
    }

  return (bLocked);
}

/////////////////////////////////////////////////////////////////////////////
ULONG
CHalTimecode::GetInputDirection (void)
// returns TRUE for forward, FALSE for backward
/////////////////////////////////////////////////////////////////////////////
{
  if (!IsRx ())
    return ((ULONG) - 1);

  if (!IsInputLocked ())
    return ((ULONG) - 1);

  return (m_RegTCStatus & TCSTATUS_LRXDIR_MASK ? TRUE : FALSE);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::GetFrameRate (PULONG pulFrameRate)
/////////////////////////////////////////////////////////////////////////////
{
  *pulFrameRate = 50000000;	// this is identified as 'invalid'

  if (IsRx ())
    {
      if (!IsInputLocked ())
	return (HSTATUS_INVALID_MODE);

      ULONG ulCount = (m_RegLTCRxRate & LTCRXRATE_MASK) + 1;	// get the rate from the hardware
      //cmn_err((CE_WARN,"%04lx ", ulCount );
      m_ulFrameRate = (50000000 + (ulCount / 2)) / ulCount;	// the rate is in (frames/second) * 1000 (with rounding)
    }

  //cmn_err((CE_WARN,"CHalTimecode::GetFrameRate %lu\n", m_ulFrameRate );

  *pulFrameRate = m_ulFrameRate;
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetPosition (ULONG ulPosition)
/////////////////////////////////////////////////////////////////////////////
{
  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  if (IsRunning ())
    return (HSTATUS_INVALID_MODE);

  m_CurrentPosition.ulTimecode = ulPosition;
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::GetPosition (PULONG pulPosition)
/////////////////////////////////////////////////////////////////////////////
{
  *pulPosition = m_CurrentPosition.ulTimecode;
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
BOOLEAN
CHalTimecode::HasValidTimecode (void)
// only used by the MTC code to see if valid timecode was just read on this 
// interrupt
/////////////////////////////////////////////////////////////////////////////
{
  return (m_bHasValidTimecode);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::ResetValidTimecode (void)
// Only called by the MTC code to reset the valid timecode flag
/////////////////////////////////////////////////////////////////////////////
{
  m_bHasValidTimecode = FALSE;
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetDropFrame (BOOLEAN bDropFrame)
/////////////////////////////////////////////////////////////////////////////
{
  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  switch (m_ulFrameRate)
    {
    case MIXVAL_TCFRAMERATE_2997FPS:
    case MIXVAL_TCFRAMERATE_30FPS:
      m_bDropFrame = bDropFrame;
      break;
    default:
      m_bDropFrame = FALSE;
      return (HSTATUS_INVALID_PARAMETER);
    }
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetSyncSource (ULONG ulSyncSource)
/////////////////////////////////////////////////////////////////////////////
{
  if (IsRx ())
    return (HSTATUS_INVALID_PARAMETER);

  switch (ulSyncSource)
    {
    case MIXVAL_TCSYNCSOURCE_INTERNAL:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXSYNC_FREERUNNING,
			       REG_LTCCONTROL_LTXSYNC_MASK);
      break;
    case MIXVAL_TCSYNCSOURCE_VIDEOIN:
      m_pRegLTCControl->Write (REG_LTCCONTROL_LTXSYNC_VIDEOLINE5,
			       REG_LTCCONTROL_LTXSYNC_MASK);
      break;
    default:
      return (HSTATUS_INVALID_PARAMETER);
    }
  m_ulSyncSource = ulSyncSource;

  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
void
CHalTimecode::WriteTimecode (ULONG ulBufferID, PULONG pulTxBuffer)
// private
/////////////////////////////////////////////////////////////////////////////
{
  PULONG pHWBuffer;

  if (ulBufferID == TC_BUFFERA)
    {
      //DC('A');
      pHWBuffer =
	(PULONG) & m_pHalAdapter->GetRegisters ()->TCBlock.LTCTxBufA;
    }
  else
    {
      //DC('B');
      pHWBuffer =
	(PULONG) & m_pHalAdapter->GetRegisters ()->TCBlock.LTCTxBufB;
    }

  WRITE_REGISTER_BUFFER_ULONG (pHWBuffer, pulTxBuffer, TCBUFFER_SIZE);
}

/////////////////////////////////////////////////////////////////////////////
void
CHalTimecode::EncodeTxBuffer (PULONG pulTxBuffer)
// private
/////////////////////////////////////////////////////////////////////////////
{
  ULONG ulTens, ulUnits;

  ulTens = m_CurrentPosition.Bytes.ucFrame / 10;
  ulUnits = m_CurrentPosition.Bytes.ucFrame - (ulTens * 10);
  pulTxBuffer[0] = (ulTens << TCBUFFER_TENS_OFFSET) | ulUnits;
  if (m_bDropFrame)
    pulTxBuffer[0] |= TCBUFFER_DROPFRAME_MASK;

  ulTens = m_CurrentPosition.Bytes.ucSecond / 10;
  ulUnits = m_CurrentPosition.Bytes.ucSecond - (ulTens * 10);
  pulTxBuffer[1] = (ulTens << TCBUFFER_TENS_OFFSET) | ulUnits;

  ulTens = m_CurrentPosition.Bytes.ucMinute / 10;
  ulUnits = m_CurrentPosition.Bytes.ucMinute - (ulTens * 10);
  pulTxBuffer[2] = (ulTens << TCBUFFER_TENS_OFFSET) | ulUnits;

  ulTens = m_CurrentPosition.Bytes.ucHour / 10;
  ulUnits = m_CurrentPosition.Bytes.ucHour - (ulTens * 10);
  pulTxBuffer[3] = (ulTens << TCBUFFER_TENS_OFFSET) | ulUnits;
}

/////////////////////////////////////////////////////////////////////////////
void
CHalTimecode::IncrementTimecode ()
// private
/////////////////////////////////////////////////////////////////////////////
{
  m_CurrentPosition.Bytes.ucFrame++;
  if (m_CurrentPosition.Bytes.ucFrame > m_ucMaxFrame)
    {
      m_CurrentPosition.Bytes.ucFrame = 0;

      // there actually is no such thing as 30FPS Drop Frame.  It is really 29.97 (30/1.001) Drop Frame.
      if ((m_ulFrameRate == MIXVAL_TCFRAMERATE_2997FPS)
	  || (m_ulFrameRate == MIXVAL_TCFRAMERATE_30FPS))
	{
	  // Drop frame: Every frame :00 & :01 are dropped for each minute change (60 X 2 = 120 frames per hour) 
	  // except for minutes with 0s (00:, 10:, 20:, 30:, 40: & 50:) (6 X 2 = 12, 120 - 12 = 108 frames in one hour)
	  if (m_bDropFrame && (m_CurrentPosition.Bytes.ucSecond == 59)
	      && !((m_CurrentPosition.Bytes.ucMinute % 10) == 9))
	    m_CurrentPosition.Bytes.ucFrame = 2;
	}

      m_CurrentPosition.Bytes.ucSecond++;
      if (m_CurrentPosition.Bytes.ucSecond > 59)
	{
	  m_CurrentPosition.Bytes.ucSecond = 0;
	  m_CurrentPosition.Bytes.ucMinute++;
	  if (m_CurrentPosition.Bytes.ucMinute > 59)
	    {
	      m_CurrentPosition.Bytes.ucMinute = 0;
	      m_CurrentPosition.Bytes.ucHour++;
	      if (m_CurrentPosition.Bytes.ucHour > 63)
		{
		  m_CurrentPosition.Bytes.ucHour = 0;
		  // no futher rollover possible
		}
	    }
	}
    }
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetDefaults (void)
/////////////////////////////////////////////////////////////////////////////
{
  //cmn_err((CE_WARN,"CHalTimecode::SetDefaults\n");

  if (!IsRx ())
    {
      //cmn_err((CE_WARN,"SetDefaults TC_TX\n");

      Stop ();
      SetFrameRate (MIXVAL_TCFRAMERATE_2997FPS);
      SetDropFrame (TRUE);
      SetSyncSource (MIXVAL_TCSYNCSOURCE_INTERNAL);
      SetPosition (0);
    }

  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::SetMixerControl (USHORT usControl, ULONG ulValue)
/////////////////////////////////////////////////////////////////////////////
{
  switch (usControl)
    {
      // Timecode
    case CONTROL_LTCOUT_ENABLE:	// boolean
      if (ulValue)
	Start ();
      else
	Stop ();
      break;
    case CONTROL_LTCOUT_FRAMERATE:	// mux
      SetFrameRate (ulValue);
      break;
    case CONTROL_LTCOUT_DROPFRAME:	// boolean
      SetDropFrame ((BOOLEAN) ulValue);
      break;
    case CONTROL_LTCOUT_SYNCSOURCE:
      SetSyncSource (ulValue);
      break;
    case CONTROL_LTCOUT_POSITION:	// ulong
      SetPosition (ulValue);
      break;

    default:
      return (HSTATUS_INVALID_MIXER_CONTROL);
    }
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::GetMixerControl (USHORT usControl, PULONG pulValue)
/////////////////////////////////////////////////////////////////////////////
{
  USHORT usDeviceID = m_pHalAdapter->GetDeviceID ();

  // only the LynxTWO-A -B & -C have LTC controls

  if (!
      ((usDeviceID == PCIDEVICE_LYNXTWO_A)
       || (usDeviceID == PCIDEVICE_LYNXTWO_B)
       || (usDeviceID == PCIDEVICE_LYNXTWO_C)))
    return (HSTATUS_INVALID_MIXER_CONTROL);

  switch (usControl)
    {
      // LTC In
    case CONTROL_LTCIN_FRAMERATE:
      GetFrameRate (pulValue);
      break;
    case CONTROL_LTCIN_LOCKED:
      *pulValue = (ULONG) IsInputLocked ();
      break;
    case CONTROL_LTCIN_DIRECTION:
      *pulValue = (ULONG) GetInputDirection ();
      break;
    case CONTROL_LTCIN_DROPFRAME:
      *pulValue = (ULONG) GetDropFrame ();
      break;
    case CONTROL_LTCIN_POSITION:
      GetPosition (pulValue);
      break;

      // LTC Out
    case CONTROL_LTCOUT_ENABLE:
      *pulValue = (ULONG) IsRunning ();
      break;
    case CONTROL_LTCOUT_FRAMERATE:
      GetFrameRate (pulValue);
      break;
    case CONTROL_LTCOUT_DROPFRAME:
      *pulValue = (ULONG) GetDropFrame ();
      break;
    case CONTROL_LTCOUT_SYNCSOURCE:
      *pulValue = GetSyncSource ();
      break;
    case CONTROL_LTCOUT_POSITION:
      GetPosition (pulValue);
      break;

    default:
      return (HSTATUS_INVALID_MIXER_CONTROL);
    }
  return (HSTATUS_OK);
}

/////////////////////////////////////////////////////////////////////////////
USHORT
CHalTimecode::Service (ULONG ulBufferID)
/////////////////////////////////////////////////////////////////////////////
{
  ULONG PCBuffer[TCBUFFER_SIZE];
  PULONG pHWBuffer;
  BYTE ucNewMTCFrameRate;

  DB ('t', COLOR_BOLD);
  //cmn_err((CE_WARN,"CHalTimecode::Service\n");

  if (IsRx ())
    {
      if (ulBufferID == TC_BUFFERA)
	pHWBuffer =
	  (PULONG) & m_pHalAdapter->GetRegisters ()->TCBlock.LTCRxBufA;
      else
	pHWBuffer =
	  (PULONG) & m_pHalAdapter->GetRegisters ()->TCBlock.LTCRxBufB;

      READ_REGISTER_BUFFER_ULONG (pHWBuffer, PCBuffer, TCBUFFER_SIZE);

      // Decode the Rx buffer
      m_CurrentPosition.Bytes.ucFrame =
	(BYTE) (PCBuffer[0] & TCBUFFER_FRAME_UNITS_MASK);
      m_CurrentPosition.Bytes.ucFrame +=
	(BYTE) (((PCBuffer[0] & TCBUFFER_FRAME_TENS_MASK) >>
		 TCBUFFER_TENS_OFFSET) * 10);
      m_CurrentPosition.Bytes.ucFrame &= 0x1F;
      m_bDropFrame = (PCBuffer[0] & TCBUFFER_DROPFRAME_MASK) ? TRUE : FALSE;

      m_CurrentPosition.Bytes.ucSecond =
	(BYTE) (PCBuffer[1] & TCBUFFER_SECONDS_UNITS_MASK);
      m_CurrentPosition.Bytes.ucSecond +=
	(BYTE) (((PCBuffer[1] & TCBUFFER_SECONDS_TENS_MASK) >>
		 TCBUFFER_TENS_OFFSET) * 10);
      m_CurrentPosition.Bytes.ucSecond &= 0x3F;

      m_CurrentPosition.Bytes.ucMinute =
	(BYTE) (PCBuffer[2] & TCBUFFER_MINUTES_UNITS_MASK);
      m_CurrentPosition.Bytes.ucMinute +=
	(BYTE) (((PCBuffer[2] & TCBUFFER_MINUTES_TENS_MASK) >>
		 TCBUFFER_TENS_OFFSET) * 10);
      m_CurrentPosition.Bytes.ucMinute &= 0x3F;

      m_CurrentPosition.Bytes.ucHour =
	(BYTE) (PCBuffer[3] & TCBUFFER_HOURS_UNITS_MASK);
      m_CurrentPosition.Bytes.ucHour +=
	(BYTE) (((PCBuffer[3] & TCBUFFER_HOURS_TENS_MASK) >>
		 TCBUFFER_TENS_OFFSET) * 10);
      m_CurrentPosition.Bytes.ucHour &= 0x1F;

      m_bHasValidTimecode = TRUE;

      // see if the frame rate needs to be updated.  Valid minimum range is 0..23
      if (m_CurrentPosition.Bytes.ucFrame > 22)
	{
	  // for the receiver, m_ucMaxFrame is only evaluated below
	  m_ucMaxFrame = m_CurrentPosition.Bytes.ucFrame;
	  //cmn_err((CE_WARN,"Updating Max Frame to %u ", (USHORT)m_ucMaxFrame );
	}

      // only update the frame rate on frame zero
      if (m_CurrentPosition.Bytes.ucFrame == 0)
	{
	  switch (m_ucMaxFrame)
	    {
	    case 23:		// 0..23 is 24fps
	      ucNewMTCFrameRate = MTC_FRAMERATE_24;
	      break;
	    case 24:		// 0..24 is 25fps
	      ucNewMTCFrameRate = MTC_FRAMERATE_25;
	      break;
	    default:
	      if (m_bDropFrame)
		ucNewMTCFrameRate = MTC_FRAMERATE_30DROP;
	      else
		ucNewMTCFrameRate = MTC_FRAMERATE_30;
	      break;
	    }
	  //cmn_err((CE_WARN, "[%02d:%02d:%02d:%02d]\n", m_CurrentPosition.Bytes.ucHour, m_CurrentPosition.Bytes.ucMinute, m_CurrentPosition.Bytes.ucSecond, m_CurrentPosition.Bytes.ucFrame );

	  // if the frame rate changed, update it now (since we are on the 'zero' frame, it is a good time!)
	  if (ucNewMTCFrameRate != m_ucMTCFrameRate)
	    {
	      m_ucMTCFrameRate = ucNewMTCFrameRate;
	      //cmn_err((CE_WARN, "New Frame Rate is %u [%02d:%02d:%02d:%02d]\n", m_ucMTCFrameRate, m_CurrentPosition.Bytes.ucHour, m_CurrentPosition.Bytes.ucMinute, m_CurrentPosition.Bytes.ucSecond, m_CurrentPosition.Bytes.ucFrame );
	    }
	}

    }
  else
    {
      EncodeTxBuffer (PCBuffer);
      WriteTimecode (ulBufferID, PCBuffer);
      IncrementTimecode ();

      LYNXTIMECODE MTCPosition;

      // Go get the current MTC position from the MIDI Output Driver
      if (m_pHalAdapter->GetMIDIOutDevice (0)->
	  GetMTCPosition (&MTCPosition.ulTimecode))
	{
	  // the GetMTCPosition returned an error, was MTC running?
	  if (m_bMTCRunning)
	    {
	      cmn_err (CE_WARN,
		       "Stopping LTC Generator because MTC stopped\n");
	      Stop ();
	      m_pHalAdapter->GetMixer ()->ControlChanged (LINE_ADAPTER,
							  LINE_NO_SOURCE,
							  CONTROL_LTCOUT_ENABLE);
	    }
	}
      else			// MIDI Out Is Open & Started
	{
	  // if the timecode is not -1, then MTC Out is running
	  if (MTCPosition.ulTimecode != 0xFFFFFFFF)
	    {
	      int nLTCSeconds;
	      int nMTCSeconds;

	      nLTCSeconds = m_CurrentPosition.Bytes.ucHour * 3600;
	      nLTCSeconds += m_CurrentPosition.Bytes.ucMinute * 60;
	      nLTCSeconds += m_CurrentPosition.Bytes.ucSecond;

	      nMTCSeconds = MTCPosition.Bytes.ucHour * 3600;
	      nMTCSeconds += MTCPosition.Bytes.ucMinute * 60;
	      nMTCSeconds += MTCPosition.Bytes.ucSecond;

	      m_bMTCRunning = TRUE;

#define abs( n )	((n)<0?(n)*-1:(n))

	      // if the difference between the MTC time and the LTC time is more than 2 seconds
	      if (abs (nLTCSeconds - nMTCSeconds) > 2)
		{
		  // turn off the LTC Generator
		  //cmn_err((CE_WARN,"Stopping LTC Generator because MTC is more than 2 seconds off %ld %ld\n", nLTCSeconds, nMTCSeconds );
		  Stop ();
		  m_pHalAdapter->GetMIDIOutDevice (0)->ResetMTCPosition ();	// DAH Aug 9, 2004: Reset the MTC position so it will be invalid until the next valid MTC message comes in
		  m_pHalAdapter->GetMixer ()->ControlChanged (LINE_ADAPTER,
							      LINE_NO_SOURCE,
							      CONTROL_LTCOUT_ENABLE);
		}
	    }
	}
    }

  //CHalDevice::Service( kReasonTimecode );

  return (HSTATUS_OK);
}