8ac38c7dd6712887b701b18c522d000e59988af2
[deb_libcec.git] / src / LibCecSharp / CecSharpTypes.h
1 #pragma once
2 /*
3 * This file is part of the libCEC(R) library.
4 *
5 * libCEC(R) is Copyright (C) 2011-2013 Pulse-Eight Limited. All rights reserved.
6 * libCEC(R) is an original work, containing original code.
7 *
8 * libCEC(R) is a trademark of Pulse-Eight Limited.
9 *
10 * This program is dual-licensed; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software
22 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 *
24 *
25 * Alternatively, you can license this library under a commercial license,
26 * please contact Pulse-Eight Licensing for more information.
27 *
28 * For more information contact:
29 * Pulse-Eight Licensing <license@pulse-eight.com>
30 * http://www.pulse-eight.com/
31 * http://www.pulse-eight.net/
32 */
33
34 #include "../lib/platform/threads/mutex.h"
35 #include <vcclr.h>
36 #include <msclr/marshal.h>
37 #include "../../include/cec.h"
38 #include <vector>
39
40 #using <System.dll>
41
42 /// <summary>
43 /// LibCecSharp namespace
44 /// </summary>
45 /// <see cref="LibCecSharp" />
46 namespace CecSharp
47 {
48 /// <summary>
49 /// The device type. For client applications, libCEC only supports RecordingDevice, PlaybackDevice or Tuner.
50 /// libCEC uses RecordingDevice by default.
51 /// </summary>
52 public enum class CecDeviceType
53 {
54 /// <summary>
55 /// Television
56 /// </summary>
57 Tv = 0,
58 /// <summary>
59 /// Recording device
60 /// </summary>
61 RecordingDevice = 1,
62 /// <summary>
63 /// Reserved / do not use
64 /// </summary>
65 Reserved = 2,
66 /// <summary>
67 /// Tuner
68 /// </summary>
69 Tuner = 3,
70 /// <summary>
71 /// Playback device
72 /// </summary>
73 PlaybackDevice = 4,
74 /// <summary>
75 /// Audio system / AVR
76 /// </summary>
77 AudioSystem = 5
78 };
79
80 /// <summary>
81 /// Log level that can be used by the logging callback method to filter messages from libCEC.
82 /// </summary>
83 public enum class CecLogLevel
84 {
85 /// <summary>
86 /// No logging
87 /// </summary>
88 None = 0,
89 /// <summary>
90 /// libCEC encountered a serious problem, and couldn't complete an action.
91 /// </summary>
92 Error = 1,
93 /// <summary>
94 /// libCEC warns that it encountered a problem, but recovered.
95 /// </summary>
96 Warning = 2,
97 /// <summary>
98 /// libCEC informs the client about a CEC state change.
99 /// </summary>
100 Notice = 4,
101 /// <summary>
102 /// Raw CEC data traffic
103 /// </summary>
104 Traffic = 8,
105 /// <summary>
106 /// Debugging messages
107 /// </summary>
108 Debug = 16,
109 /// <summary>
110 /// Display all messages
111 /// </summary>
112 All = 31
113 };
114
115 /// <summary>
116 /// A logical address on the CEC bus
117 /// </summary>
118 public enum class CecLogicalAddress
119 {
120 /// <summary>
121 /// Not a valid logical address
122 /// </summary>
123 Unknown = -1,
124 /// <summary>
125 /// Television
126 /// </summary>
127 Tv = 0,
128 /// <summary>
129 /// Recording device 1
130 /// </summary>
131 RecordingDevice1 = 1,
132 /// <summary>
133 /// Recording device 2
134 /// </summary>
135 RecordingDevice2 = 2,
136 /// <summary>
137 /// Tuner 1
138 /// </summary>
139 Tuner1 = 3,
140 /// <summary>
141 /// Playback device 1
142 /// </summary>
143 PlaybackDevice1 = 4,
144 /// <summary>
145 /// Audio system / AVR
146 /// </summary>
147 AudioSystem = 5,
148 /// <summary>
149 /// Tuner 2
150 /// </summary>
151 Tuner2 = 6,
152 /// <summary>
153 /// Tuner 3
154 /// </summary>
155 Tuner3 = 7,
156 /// <summary>
157 /// Playback device 2
158 /// </summary>
159 PlaybackDevice2 = 8,
160 /// <summary>
161 /// Recording device 3
162 /// </summary>
163 RecordingDevice3 = 9,
164 /// <summary>
165 /// Tuner 4
166 /// </summary>
167 Tuner4 = 10,
168 /// <summary>
169 /// Playback device 3
170 /// </summary>
171 PlaybackDevice3 = 11,
172 /// <summary>
173 /// Reserved address 1
174 /// </summary>
175 Reserved1 = 12,
176 /// <summary>
177 /// Reserved address 2
178 /// </summary>
179 Reserved2 = 13,
180 /// <summary>
181 /// Free to use
182 /// </summary>
183 FreeUse = 14,
184 /// <summary>
185 /// Unregistered / new device
186 /// </summary>
187 Unregistered = 15,
188 /// <summary>
189 /// Broadcast address
190 /// </summary>
191 Broadcast = 15
192 };
193
194 /// <summary>
195 /// The type of alert when libCEC calls the CecAlert callback
196 /// </summary>
197 public enum class CecAlert
198 {
199 /// <summary>
200 /// The device needs servicing. This is set when the firmware can be upgraded, or when a problem with the firmware is detected.
201 /// The latest firmware flash tool can be downloaded from http://packages.pulse-eight.net/
202 /// </summary>
203 ServiceDevice = 0,
204 /// <summary>
205 /// The connection to the adapter was lost, probably because the device got unplugged.
206 /// </summary>
207 ConnectionLost,
208 /// <summary>
209 /// No permission from the OS to access the adapter.
210 /// </summary>
211 PermissionError,
212 /// <summary>
213 /// The device is being used by another program.
214 /// </summary>
215 PortBusy,
216 /// <summary>
217 /// The physical address that is assigned to the adapter is already being used.
218 /// </summary>
219 PhysicalAddressError,
220 /// <summary>
221 /// The TV does not respond to polls.
222 /// </summary>
223 TVPollFailed
224 };
225
226 /// <summary>
227 /// The type of parameter that is sent with the CecAlert callback
228 /// </summary>
229 public enum class CecParameterType
230 {
231 /// <summary>
232 /// The parameter is a string
233 /// </summary>
234 ParameterTypeString = 1
235 };
236
237 /// <summary>
238 /// A parameter for the CecAlert callback
239 /// </summary>
240 public ref class CecParameter
241 {
242 public:
243 /// <summary>
244 /// Create a new parameter
245 /// </summary>
246 /// <param name="type">The type of this parameter.</param>
247 /// <param name="data">The value of this parameter.</param>
248 CecParameter(CecParameterType type, System::String ^ data)
249 {
250 Type = type;
251 Data = data;
252 }
253
254 /// <summary>
255 /// The type of this parameter
256 /// </summary>
257 property CecParameterType Type;
258 /// <summary>
259 /// The value of this parameter
260 /// </summary>
261 property System::String ^ Data;
262 };
263
264 /// <summary>
265 /// The power status of a CEC device
266 /// </summary>
267 public enum class CecPowerStatus
268 {
269 /// <summary>
270 /// Powered on
271 /// </summary>
272 On = 0x00,
273 /// <summary>
274 /// In standby mode
275 /// </summary>
276 Standby = 0x01,
277 /// <summary>
278 /// In transition from standby to on
279 /// </summary>
280 InTransitionStandbyToOn = 0x02,
281 /// <summary>
282 /// In transition from on to standby
283 /// </summary>
284 InTransitionOnToStandby = 0x03,
285 /// <summary>
286 /// Unknown status
287 /// </summary>
288 Unknown = 0x99
289 };
290
291 /// <summary>
292 /// The CEC version of a CEC device
293 /// </summary>
294 public enum class CecVersion
295 {
296 /// <summary>
297 /// Unknown version
298 /// </summary>
299 Unknown = 0x00,
300 /// <summary>
301 /// Version 1.2
302 /// </summary>
303 V1_2 = 0x01,
304 /// <summary>
305 /// Version 1.2a
306 /// </summary>
307 V1_2A = 0x02,
308 /// <summary>
309 /// Version 1.3
310 /// </summary>
311 V1_3 = 0x03,
312 /// <summary>
313 /// Version 1.3a
314 /// </summary>
315 V1_3A = 0x04,
316 /// <summary>
317 /// Version 1.4
318 /// </summary>
319 V1_4 = 0x05
320 };
321
322 /// <summary>
323 /// Parameter for OSD string display, that controls how to display the string
324 /// </summary>
325 public enum class CecDisplayControl
326 {
327 /// <summary>
328 /// Display for the default time
329 /// </summary>
330 DisplayForDefaultTime = 0x00,
331 /// <summary>
332 /// Display until it is cleared by ClearPreviousMessage
333 /// </summary>
334 DisplayUntilCleared = 0x40,
335 /// <summary>
336 /// Clear message displayed by DisplayUntilCleared
337 /// </summary>
338 ClearPreviousMessage = 0x80,
339 /// <summary>
340 /// Reserved / do not use
341 /// </summary>
342 ReservedForFutureUse = 0xC0
343 };
344
345 /// <summary>
346 /// The menu state of a CEC device
347 /// </summary>
348 public enum class CecMenuState
349 {
350 /// <summary>
351 /// Menu active
352 /// </summary>
353 Activated = 0,
354 /// <summary>
355 /// Menu not active
356 /// </summary>
357 Deactivated = 1
358 };
359
360 /// <summary>
361 /// Deck control mode for playback and recording devices
362 /// </summary>
363 public enum class CecDeckControlMode
364 {
365 /// <summary>
366 /// Skip forward / wind
367 /// </summary>
368 SkipForwardWind = 1,
369 /// <summary>
370 /// Skip reverse / rewind
371 /// </summary>
372 SkipReverseRewind = 2,
373 /// <summary>
374 /// Stop
375 /// </summary>
376 Stop = 3,
377 /// <summary>
378 /// Eject
379 /// </summary>
380 Eject = 4
381 };
382
383 /// <summary>
384 /// Deck status for playback and recording devices
385 /// </summary>
386 public enum class CecDeckInfo
387 {
388 /// <summary>
389 /// Playing
390 /// </summary>
391 Play = 0x11,
392 /// <summary>
393 /// Recording
394 /// </summary>
395 Record = 0x12,
396 /// <summary>
397 /// Reverse
398 /// </summary>
399 Reverse = 0x13,
400 /// <summary>
401 /// Showing still frame
402 /// </summary>
403 Still = 0x14,
404 /// <summary>
405 /// Playing slow
406 /// </summary>
407 Slow = 0x15,
408 /// <summary>
409 /// Playing slow reverse
410 /// </summary>
411 SlowReverse = 0x16,
412 /// <summary>
413 /// Fast forward
414 /// </summary>
415 FastForward = 0x17,
416 /// <summary>
417 /// Fast reverse
418 /// </summary>
419 FastReverse = 0x18,
420 /// <summary>
421 /// No media detected
422 /// </summary>
423 NoMedia = 0x19,
424 /// <summary>
425 /// Stop / not playing
426 /// </summary>
427 Stop = 0x1A,
428 /// <summary>
429 /// Skip forward / wind
430 /// </summary>
431 SkipForwardWind = 0x1B,
432 /// <summary>
433 /// Skip reverse / rewind
434 /// </summary>
435 SkipReverseRewind = 0x1C,
436 /// <summary>
437 /// Index search forward
438 /// </summary>
439 IndexSearchForward = 0x1D,
440 /// <summary>
441 /// Index search reverse
442 /// </summary>
443 IndexSearchReverse = 0x1E,
444 /// <summary>
445 /// Other / unknown status
446 /// </summary>
447 OtherStatus = 0x1F
448 };
449
450 /// <summary>
451 /// User control code, the key code when the user presses or releases a button on the remote.
452 /// Used by SendKeypress() and the CecKey callback.
453 /// </summary>
454 public enum class CecUserControlCode
455 {
456 /// <summary>
457 /// Select / OK
458 /// </summary>
459 Select = 0x00,
460 /// <summary>
461 /// Direction up
462 /// </summary>
463 Up = 0x01,
464 /// <summary>
465 /// Direction down
466 /// </summary>
467 Down = 0x02,
468 /// <summary>
469 /// Direction left
470 /// </summary>
471 Left = 0x03,
472 /// <summary>
473 /// Direction right
474 /// </summary>
475 Right = 0x04,
476 /// <summary>
477 /// Direction right + up
478 /// </summary>
479 RightUp = 0x05,
480 /// <summary>
481 /// Direction right + down
482 /// </summary>
483 RightDown = 0x06,
484 /// <summary>
485 /// Direction left + up
486 /// </summary>
487 LeftUp = 0x07,
488 /// <summary>
489 /// Direction left + down
490 /// </summary>
491 LeftDown = 0x08,
492 /// <summary>
493 /// Root menu
494 /// </summary>
495 RootMenu = 0x09,
496 /// <summary>
497 /// Setup menu
498 /// </summary>
499 SetupMenu = 0x0A,
500 /// <summary>
501 /// Contents menu
502 /// </summary>
503 ContentsMenu = 0x0B,
504 /// <summary>
505 /// Favourite menu
506 /// </summary>
507 FavoriteMenu = 0x0C,
508 /// <summary>
509 /// Exit / back
510 /// </summary>
511 Exit = 0x0D,
512 /// <summary>
513 /// Number 0
514 /// </summary>
515 Number0 = 0x20,
516 /// <summary>
517 /// Number 1
518 /// </summary>
519 Number1 = 0x21,
520 /// <summary>
521 /// Number 2
522 /// </summary>
523 Number2 = 0x22,
524 /// <summary>
525 /// Number 3
526 /// </summary>
527 Number3 = 0x23,
528 /// <summary>
529 /// Number 4
530 /// </summary>
531 Number4 = 0x24,
532 /// <summary>
533 /// Number 5
534 /// </summary>
535 Number5 = 0x25,
536 /// <summary>
537 /// Number 6
538 /// </summary>
539 Number6 = 0x26,
540 /// <summary>
541 /// Number 7
542 /// </summary>
543 Number7 = 0x27,
544 /// <summary>
545 /// Number 8
546 /// </summary>
547 Number8 = 0x28,
548 /// <summary>
549 /// Number 9
550 /// </summary>
551 Number9 = 0x29,
552 /// <summary>
553 /// .
554 /// </summary>
555 Dot = 0x2A,
556 /// <summary>
557 /// Enter input
558 /// </summary>
559 Enter = 0x2B,
560 /// <summary>
561 /// Clear input
562 /// </summary>
563 Clear = 0x2C,
564 /// <summary>
565 /// Next favourite
566 /// </summary>
567 NextFavorite = 0x2F,
568 /// <summary>
569 /// Channel up
570 /// </summary>
571 ChannelUp = 0x30,
572 /// <summary>
573 /// Channel down
574 /// </summary>
575 ChannelDown = 0x31,
576 /// <summary>
577 /// Previous channel
578 /// </summary>
579 PreviousChannel = 0x32,
580 /// <summary>
581 /// Select sound track
582 /// </summary>
583 SoundSelect = 0x33,
584 /// <summary>
585 /// Select input
586 /// </summary>
587 InputSelect = 0x34,
588 /// <summary>
589 /// Display information
590 /// </summary>
591 DisplayInformation = 0x35,
592 /// <summary>
593 /// Show help
594 /// </summary>
595 Help = 0x36,
596 /// <summary>
597 /// Page up
598 /// </summary>
599 PageUp = 0x37,
600 /// <summary>
601 /// Page down
602 /// </summary>
603 PageDown = 0x38,
604 /// <summary>
605 /// Toggle powered on / standby
606 /// </summary>
607 Power = 0x40,
608 /// <summary>
609 /// Volume up
610 /// </summary>
611 VolumeUp = 0x41,
612 /// <summary>
613 /// Volume down
614 /// </summary>
615 VolumeDown = 0x42,
616 /// <summary>
617 /// Mute audio
618 /// </summary>
619 Mute = 0x43,
620 /// <summary>
621 /// Start playback
622 /// </summary>
623 Play = 0x44,
624 /// <summary>
625 /// Stop playback
626 /// </summary>
627 Stop = 0x45,
628 /// <summary>
629 /// Pause playback
630 /// </summary>
631 Pause = 0x46,
632 /// <summary>
633 /// Toggle recording
634 /// </summary>
635 Record = 0x47,
636 /// <summary>
637 /// Rewind
638 /// </summary>
639 Rewind = 0x48,
640 /// <summary>
641 /// Fast forward
642 /// </summary>
643 FastForward = 0x49,
644 /// <summary>
645 /// Eject media
646 /// </summary>
647 Eject = 0x4A,
648 /// <summary>
649 /// Forward
650 /// </summary>
651 Forward = 0x4B,
652 /// <summary>
653 /// Backward
654 /// </summary>
655 Backward = 0x4C,
656 /// <summary>
657 /// Stop recording
658 /// </summary>
659 StopRecord = 0x4D,
660 /// <summary>
661 /// Pause recording
662 /// </summary>
663 PauseRecord = 0x4E,
664 /// <summary>
665 /// Change angle
666 /// </summary>
667 Angle = 0x50,
668 /// <summary>
669 /// Toggle sub picture
670 /// </summary>
671 SubPicture = 0x51,
672 /// <summary>
673 /// Toggle video on demand
674 /// </summary>
675 VideoOnDemand = 0x52,
676 /// <summary>
677 /// Toggle electronic program guide (EPG)
678 /// </summary>
679 ElectronicProgramGuide = 0x53,
680 /// <summary>
681 /// Toggle timer programming
682 /// </summary>
683 TimerProgramming = 0x54,
684 /// <summary>
685 /// Set initial configuration
686 /// </summary>
687 InitialConfiguration = 0x55,
688 /// <summary>
689 /// Start playback function
690 /// </summary>
691 PlayFunction = 0x60,
692 /// <summary>
693 /// Pause playback function
694 /// </summary>
695 PausePlayFunction = 0x61,
696 /// <summary>
697 /// Toggle recording function
698 /// </summary>
699 RecordFunction = 0x62,
700 /// <summary>
701 /// Pause recording function
702 /// </summary>
703 PauseRecordFunction = 0x63,
704 /// <summary>
705 /// Stop playback function
706 /// </summary>
707 StopFunction = 0x64,
708 /// <summary>
709 /// Mute audio function
710 /// </summary>
711 MuteFunction = 0x65,
712 /// <summary>
713 /// Restore volume function
714 /// </summary>
715 RestoreVolumeFunction = 0x66,
716 /// <summary>
717 /// Tune function
718 /// </summary>
719 TuneFunction = 0x67,
720 /// <summary>
721 /// Select media function
722 /// </summary>
723 SelectMediaFunction = 0x68,
724 /// <summary>
725 /// Select AV input function
726 /// </summary>
727 SelectAVInputFunction = 0x69,
728 /// <summary>
729 /// Select audio input function
730 /// </summary>
731 SelectAudioInputFunction = 0x6A,
732 /// <summary>
733 /// Toggle powered on / standby function
734 /// </summary>
735 PowerToggleFunction = 0x6B,
736 /// <summary>
737 /// Power off function
738 /// </summary>
739 PowerOffFunction = 0x6C,
740 /// <summary>
741 /// Power on function
742 /// </summary>
743 PowerOnFunction = 0x6D,
744 /// <summary>
745 /// F1 / blue button
746 /// </summary>
747 F1Blue = 0x71,
748 /// <summary>
749 /// F2 / red button
750 /// </summary>
751 F2Red = 0X72,
752 /// <summary>
753 /// F3 / green button
754 /// </summary>
755 F3Green = 0x73,
756 /// <summary>
757 /// F4 / yellow button
758 /// </summary>
759 F4Yellow = 0x74,
760 /// <summary>
761 /// F5
762 /// </summary>
763 F5 = 0x75,
764 /// <summary>
765 /// Data / teletext
766 /// </summary>
767 Data = 0x76,
768 /// <summary>
769 /// Max. valid key code for standard buttons
770 /// </summary>
771 Max = 0x76,
772 /// <summary>
773 /// Extra return button on Samsung remotes
774 /// </summary>
775 SamsungReturn = 0x91,
776 /// <summary>
777 /// Unknown / invalid key code
778 /// </summary>
779 Unknown
780 };
781
782 /// <summary>
783 /// Vendor IDs for CEC devices
784 /// </summary>
785 public enum class CecVendorId
786 {
787 Toshiba = 0x000039,
788 Samsung = 0x0000F0,
789 Denon = 0x0005CD,
790 Marantz = 0x000678,
791 Loewe = 0x000982,
792 Onkyo = 0x0009B0,
793 Medion = 0x000CB8,
794 Toshiba2 = 0x000CE7,
795 Akai = 0x0020C7,
796 AOC = 0x002467,
797 Panasonic = 0x008045,
798 Philips = 0x00903E,
799 Daewoo = 0x009053,
800 Yamaha = 0x00A0DE,
801 Grundig = 0x00D0D5,
802 Pioneer = 0x00E036,
803 LG = 0x00E091,
804 Sharp = 0x08001F,
805 Sony = 0x080046,
806 Broadcom = 0x18C086,
807 Vizio = 0x6B746D,
808 Benq = 0x8065E9,
809 Unknown = 0
810 };
811
812 /// <summary>
813 /// Audio status of audio system / AVR devices
814 /// </summary>
815 public enum class CecAudioStatus
816 {
817 /// <summary>
818 /// Muted
819 /// </summary>
820 MuteStatusMask = 0x80,
821 /// <summary>
822 /// Not muted, volume status mask
823 /// </summary>
824 VolumeStatusMask = 0x7F,
825 /// <summary>
826 /// Minumum volume
827 /// </summary>
828 VolumeMin = 0x00,
829 /// <summary>
830 /// Maximum volume
831 /// </summary>
832 VolumeMax = 0x64,
833 /// <summary>
834 /// Unknown status
835 /// </summary>
836 VolumeStatusUnknown = 0x7F
837 };
838
839 /// <summary>
840 /// CEC opcodes, as described in the HDMI CEC specification
841 /// </summary>
842 public enum class CecOpcode
843 {
844 /// <summary>
845 /// Active source
846 /// </summary>
847 ActiveSource = 0x82,
848 /// <summary>
849 /// Image view on: power on display for image display
850 /// </summary>
851 ImageViewOn = 0x04,
852 /// <summary>
853 /// Text view on: power on display for text display
854 /// </summary>
855 TextViewOn = 0x0D,
856 /// <summary>
857 /// Device no longer is the active source
858 /// </summary>
859 InactiveSource = 0x9D,
860 /// <summary>
861 /// Request which device has the active source status
862 /// </summary>
863 RequestActiveSource = 0x85,
864 /// <summary>
865 /// Routing change for HDMI switches
866 /// </summary>
867 RoutingChange = 0x80,
868 /// <summary>
869 /// Routing information for HDMI switches
870 /// </summary>
871 RoutingInformation = 0x81,
872 /// <summary>
873 /// Change the stream path to the given physical address
874 /// </summary>
875 SetStreamPath = 0x86,
876 /// <summary>
877 /// Inform that a device went into standby mode
878 /// </summary>
879 Standby = 0x36,
880 /// <summary>
881 /// Stop recording
882 /// </summary>
883 RecordOff = 0x0B,
884 /// <summary>
885 /// Start recording
886 /// </summary>
887 RecordOn = 0x09,
888 /// <summary>
889 /// Recording status information
890 /// </summary>
891 RecordStatus = 0x0A,
892 /// <summary>
893 /// Record current display
894 /// </summary>
895 RecordTvScreen = 0x0F,
896 /// <summary>
897 /// Clear analogue timer
898 /// </summary>
899 ClearAnalogueTimer = 0x33,
900 /// <summary>
901 /// Clear digital timer
902 /// </summary>
903 ClearDigitalTimer = 0x99,
904 /// <summary>
905 /// Clear external timer
906 /// </summary>
907 ClearExternalTimer = 0xA1,
908 /// <summary>
909 /// Set analogue timer
910 /// </summary>
911 SetAnalogueTimer = 0x34,
912 /// <summary>
913 /// Set digital timer
914 /// </summary>
915 SetDigitalTimer = 0x97,
916 /// <summary>
917 /// Set external timer
918 /// </summary>
919 SetExternalTimer = 0xA2,
920 /// <summary>
921 /// Set program title of a timer
922 /// </summary>
923 SetTimerProgramTitle = 0x67,
924 /// <summary>
925 /// Timer status cleared
926 /// </summary>
927 TimerClearedStatus = 0x43,
928 /// <summary>
929 /// Timer status information
930 /// </summary>
931 TimerStatus = 0x35,
932 /// <summary>
933 /// CEC version used by a device
934 /// </summary>
935 CecVersion = 0x9E,
936 /// <summary>
937 /// Request CEC version of a device
938 /// </summary>
939 GetCecVersion = 0x9F,
940 /// <summary>
941 /// Request physical address of a device
942 /// </summary>
943 GivePhysicalAddress = 0x83,
944 /// <summary>
945 /// Request language code of the menu language of a device
946 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
947 /// </summary>
948 GetMenuLanguage = 0x91,
949 /// <summary>
950 /// Report the physical address
951 /// </summary>
952 ReportPhysicalAddress = 0x84,
953 /// <summary>
954 /// Report the language code of the menu language
955 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
956 /// </summary>
957 SetMenuLanguage = 0x32,
958 /// <summary>
959 /// Deck control for playback and recording devices
960 /// </summary>
961 DeckControl = 0x42,
962 /// <summary>
963 /// Deck status for playback and recording devices
964 /// </summary>
965 DeckStatus = 0x1B,
966 /// <summary>
967 /// Request deck status from playback and recording devices
968 /// </summary>
969 GiveDeckStatus = 0x1A,
970 /// <summary>
971 /// Start playback on playback and recording devices
972 /// </summary>
973 Play = 0x41,
974 /// <summary>
975 /// Request tuner status
976 /// </summary>
977 GiveTunerDeviceStatus = 0x08,
978 /// <summary>
979 /// Select analogue service on a tuner
980 /// </summary>
981 SelectAnalogueService = 0x92,
982 /// <summary>
983 /// Select digital service on a tuner
984 /// </summary>
985 SelectDigtalService = 0x93,
986 /// <summary>
987 /// Report tuner device status
988 /// </summary>
989 TunerDeviceStatus = 0x07,
990 /// <summary>
991 /// Tuner step decrement
992 /// </summary>
993 TunerStepDecrement = 0x06,
994 /// <summary>
995 /// Tuner step increment
996 /// </summary>
997 TunerStepIncrement = 0x05,
998 /// <summary>
999 /// Report device vendor ID
1000 /// </summary>
1001 DeviceVendorId = 0x87,
1002 /// <summary>
1003 /// Request device vendor ID
1004 /// </summary>
1005 GiveDeviceVendorId = 0x8C,
1006 /// <summary>
1007 /// Vendor specific command
1008 /// </summary>
1009 VendorCommand = 0x89,
1010 /// <summary>
1011 /// Vendor specific command with vendor ID
1012 /// </summary>
1013 VendorCommandWithId = 0xA0,
1014 /// <summary>
1015 /// Vendor specific remote button pressed
1016 /// </summary>
1017 VendorRemoteButtonDown = 0x8A,
1018 /// <summary>
1019 /// Vendor specific remote button released
1020 /// </summary>
1021 VendorRemoteButtonUp = 0x8B,
1022 /// <summary>
1023 /// Display / clear OSD string
1024 /// </summary>
1025 SetOsdString = 0x64,
1026 /// <summary>
1027 /// Request device OSD name
1028 /// </summary>
1029 GiveOsdName = 0x46,
1030 /// <summary>
1031 /// Report device OSD name
1032 /// </summary>
1033 SetOsdName = 0x47,
1034 /// <summary>
1035 /// Request device menu status
1036 /// </summary>
1037 MenuRequest = 0x8D,
1038 /// <summary>
1039 /// Report device menu status
1040 /// </summary>
1041 MenuStatus = 0x8E,
1042 /// <summary>
1043 /// Remote button pressed
1044 /// </summary>
1045 UserControlPressed = 0x44,
1046 /// <summary>
1047 /// Remote button released
1048 /// </summary>
1049 UserControlRelease = 0x45,
1050 /// <summary>
1051 /// Request device power status
1052 /// </summary>
1053 GiveDevicePowerStatus = 0x8F,
1054 /// <summary>
1055 /// Report device power status
1056 /// </summary>
1057 ReportPowerStatus = 0x90,
1058 /// <summary>
1059 /// Feature abort / unsupported command
1060 /// </summary>
1061 FeatureAbort = 0x00,
1062 /// <summary>
1063 /// Abort command
1064 /// </summary>
1065 Abort = 0xFF,
1066 /// <summary>
1067 /// Give audio status
1068 /// </summary>
1069 GiveAudioStatus = 0x71,
1070 /// <summary>
1071 /// Give audiosystem mode
1072 /// </summary>
1073 GiveSystemAudioMode = 0x7D,
1074 /// <summary>
1075 /// Report device audio status
1076 /// </summary>
1077 ReportAudioStatus = 0x7A,
1078 /// <summary>
1079 /// Set audiosystem mode
1080 /// </summary>
1081 SetSystemAudioMode = 0x72,
1082 /// <summary>
1083 /// Request audiosystem mode
1084 /// </summary>
1085 SystemAudioModeRequest = 0x70,
1086 /// <summary>
1087 /// Report audiosystem mode
1088 /// </summary>
1089 SystemAudioModeStatus = 0x7E,
1090 /// <summary>
1091 /// Set audio bitrate
1092 /// </summary>
1093 SetAudioRate = 0x9A,
1094 /// <summary>
1095 /// When this opcode is set, no opcode will be sent to the device / poll message
1096 /// This is one of the reserved numbers
1097 /// </summary>
1098 None = 0xFD
1099 };
1100
1101 /// <summary>
1102 /// Audiosystem status
1103 /// </summary>
1104 public enum class CecSystemAudioStatus
1105 {
1106 /// <summary>
1107 /// Turned off
1108 /// </summary>
1109 Off = 0,
1110 /// <summary>
1111 /// Turned on
1112 /// </summary>
1113 On = 1
1114 };
1115
1116 /// <summary>
1117 /// libCEC client application version
1118 /// </summary>
1119 public enum class CecClientVersion
1120 {
1121 /// <summary>
1122 /// before v1.5.0
1123 /// </summary>
1124 VersionPre1_5 = 0,
1125 /// <summary>
1126 /// v1.5.0
1127 /// </summary>
1128 Version1_5_0 = 0x1500,
1129 /// <summary>
1130 /// v1.5.1
1131 /// </summary>
1132 Version1_5_1 = 0x1501,
1133 /// <summary>
1134 /// v1.5.2
1135 /// </summary>
1136 Version1_5_2 = 0x1502,
1137 /// <summary>
1138 /// v1.5.3
1139 /// </summary>
1140 Version1_5_3 = 0x1503,
1141 /// <summary>
1142 /// v1.6.0
1143 /// </summary>
1144 Version1_6_0 = 0x1600,
1145 /// <summary>
1146 /// v1.6.1
1147 /// </summary>
1148 Version1_6_1 = 0x1601,
1149 /// <summary>
1150 /// v1.6.2
1151 /// </summary>
1152 Version1_6_2 = 0x1602,
1153 /// <summary>
1154 /// v1.6.3
1155 /// </summary>
1156 Version1_6_3 = 0x1603,
1157 /// <summary>
1158 /// v1.7.0
1159 /// </summary>
1160 Version1_7_0 = 0x1700,
1161 /// <summary>
1162 /// v1.7.1
1163 /// </summary>
1164 Version1_7_1 = 0x1701,
1165 /// <summary>
1166 /// v1.7.2
1167 /// </summary>
1168 Version1_7_2 = 0x1702,
1169 /// <summary>
1170 /// v1.8.0
1171 /// </summary>
1172 Version1_8_0 = 0x1800,
1173 /// <summary>
1174 /// v1.8.1
1175 /// </summary>
1176 Version1_8_1 = 0x1801,
1177 /// <summary>
1178 /// v1.8.2
1179 /// </summary>
1180 Version1_8_2 = 0x1802,
1181 /// <summary>
1182 /// v1.9.0
1183 /// </summary>
1184 Version1_9_0 = 0x1900,
1185 /// <summary>
1186 /// v2.0.0-pre
1187 /// </summary>
1188 Version1_99_0 = 0x1990,
1189 /// <summary>
1190 /// v2.0.0
1191 /// </summary>
1192 Version2_0_0 = 0x2000,
1193 /// <summary>
1194 /// v2.0.1
1195 /// </summary>
1196 Version2_0_1 = 0x2001,
1197 /// <summary>
1198 /// v2.0.2
1199 /// </summary>
1200 Version2_0_2 = 0x2002,
1201 /// <summary>
1202 /// v2.0.3
1203 /// </summary>
1204 Version2_0_3 = 0x2003,
1205 /// <summary>
1206 /// v2.0.4
1207 /// </summary>
1208 Version2_0_4 = 0x2004,
1209 /// <summary>
1210 /// v2.0.5
1211 /// </summary>
1212 Version2_0_5 = 0x2005,
1213 /// <summary>
1214 /// v2.1.0
1215 /// </summary>
1216 Version2_1_0 = 0x2100,
1217 /// <summary>
1218 /// v2.1.1
1219 /// </summary>
1220 Version2_1_1 = 0x2101,
1221 /// <summary>
1222 /// v2.1.2
1223 /// </summary>
1224 Version2_1_2 = 0x2102,
1225 /// <summary>
1226 /// v2.1.3
1227 /// </summary>
1228 Version2_1_3 = 0x2103,
1229 /// <summary>
1230 /// The current version
1231 /// </summary>
1232 CurrentVersion = 0x2103
1233 };
1234
1235 /// <summary>
1236 /// libCEC version
1237 /// </summary>
1238 public enum class CecServerVersion
1239 {
1240 /// <summary>
1241 /// before v1.5.0
1242 /// </summary>
1243 VersionPre1_5 = 0,
1244 /// <summary>
1245 /// v1.5.0
1246 /// </summary>
1247 Version1_5_0 = 0x1500,
1248 /// <summary>
1249 /// v1.5.1
1250 /// </summary>
1251 Version1_5_1 = 0x1501,
1252 /// <summary>
1253 /// v1.5.2
1254 /// </summary>
1255 Version1_5_2 = 0x1502,
1256 /// <summary>
1257 /// v1.5.3
1258 /// </summary>
1259 Version1_5_3 = 0x1503,
1260 /// <summary>
1261 /// v1.6.0
1262 /// </summary>
1263 Version1_6_0 = 0x1600,
1264 /// <summary>
1265 /// v1.6.1
1266 /// </summary>
1267 Version1_6_1 = 0x1601,
1268 /// <summary>
1269 /// v1.6.2
1270 /// </summary>
1271 Version1_6_2 = 0x1602,
1272 /// <summary>
1273 /// v1.6.3
1274 /// </summary>
1275 Version1_6_3 = 0x1603,
1276 /// <summary>
1277 /// v1.7.0
1278 /// </summary>
1279 Version1_7_0 = 0x1700,
1280 /// <summary>
1281 /// v1.7.1
1282 /// </summary>
1283 Version1_7_1 = 0x1701,
1284 /// <summary>
1285 /// v1.7.2
1286 /// </summary>
1287 Version1_7_2 = 0x1702,
1288 /// <summary>
1289 /// v1.8.0
1290 /// </summary>
1291 Version1_8_0 = 0x1800,
1292 /// <summary>
1293 /// v1.8.1
1294 /// </summary>
1295 Version1_8_1 = 0x1801,
1296 /// <summary>
1297 /// v1.8.2
1298 /// </summary>
1299 Version1_8_2 = 0x1802,
1300 /// <summary>
1301 /// v1.9.0
1302 /// </summary>
1303 Version1_9_0 = 0x1900,
1304 /// <summary>
1305 /// v2.0.0-pre
1306 /// </summary>
1307 Version1_99_0 = 0x1990,
1308 /// <summary>
1309 /// v2.0.0
1310 /// </summary>
1311 Version2_0_0 = 0x2000,
1312 /// <summary>
1313 /// v2.0.1
1314 /// </summary>
1315 Version2_0_1 = 0x2001,
1316 /// <summary>
1317 /// v2.0.2
1318 /// </summary>
1319 Version2_0_2 = 0x2002,
1320 /// <summary>
1321 /// v2.0.3
1322 /// </summary>
1323 Version2_0_3 = 0x2003,
1324 /// <summary>
1325 /// v2.0.4
1326 /// </summary>
1327 Version2_0_4 = 0x2004,
1328 /// <summary>
1329 /// v2.0.5
1330 /// </summary>
1331 Version2_0_5 = 0x2005,
1332 /// <summary>
1333 /// v2.1.0
1334 /// </summary>
1335 Version2_1_0 = 0x2100,
1336 /// <summary>
1337 /// v2.1.1
1338 /// </summary>
1339 Version2_1_1 = 0x2101,
1340 /// <summary>
1341 /// v2.1.2
1342 /// </summary>
1343 Version2_1_2 = 0x2102,
1344 /// <summary>
1345 /// v2.1.3
1346 /// </summary>
1347 Version2_1_3 = 0x2103,
1348 /// <summary>
1349 /// The current version
1350 /// </summary>
1351 CurrentVersion = 0x2103
1352 };
1353
1354 /// <summary>
1355 /// Type of adapter to which libCEC is connected
1356 /// </summary>
1357 public enum class CecAdapterType
1358 {
1359 /// <summary>
1360 /// Unknown adapter type
1361 /// </summary>
1362 Unknown = 0,
1363 /// <summary>
1364 /// Pulse-Eight USB-CEC adapter
1365 /// </summary>
1366 PulseEightExternal = 0x1,
1367 /// <summary>
1368 /// Pulse-Eight CEC daughterboard
1369 /// </summary>
1370 PulseEightDaughterboard = 0x2,
1371 /// <summary>
1372 /// Raspberry Pi
1373 /// </summary>
1374 RaspberryPi = 0x100,
1375 /// <summary>
1376 /// TDA995x
1377 /// </summary>
1378 TDA995x = 0x200
1379 };
1380
1381 /// <summary>
1382 /// Descriptor of a CEC adapter, returned when scanning for adapters that are connected to the system
1383 /// </summary>
1384 public ref class CecAdapter
1385 {
1386 public:
1387 /// <summary>
1388 /// Create a new CEC adapter descriptor
1389 /// </summary>
1390 /// <param name="path"> The path descriptor for this CEC adapter</param>
1391 /// <param name="comPort">The COM port of this CEC adapter</param>
1392 CecAdapter(System::String ^ path, System::String ^ comPort)
1393 {
1394 Path = path;
1395 ComPort = comPort;
1396 }
1397
1398 /// <summary>
1399 /// The path descriptor for this CEC adapter
1400 /// </summary>
1401 property System::String ^ Path;
1402
1403 /// <summary>
1404 /// The COM port of this CEC adapter
1405 /// </summary>
1406 property System::String ^ ComPort;
1407 };
1408
1409 /// <summary>
1410 /// A list of CEC device types
1411 /// </summary>
1412 public ref class CecDeviceTypeList
1413 {
1414 public:
1415 /// <summary>
1416 /// Create a new empty list of CEC device types
1417 /// </summary>
1418 CecDeviceTypeList(void)
1419 {
1420 Types = gcnew array<CecDeviceType>(5);
1421 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1422 Types[iPtr] = CecDeviceType::Reserved;
1423 }
1424
1425 /// <summary>
1426 /// The array with CecDeviceType instances in this list.
1427 /// </summary>
1428 property array<CecDeviceType> ^ Types;
1429 };
1430
1431 /// <summary>
1432 /// A list of logical addresses
1433 /// </summary>
1434 public ref class CecLogicalAddresses
1435 {
1436 public:
1437 /// <summary>
1438 /// Create a new empty list of logical addresses
1439 /// </summary>
1440 CecLogicalAddresses(void)
1441 {
1442 Addresses = gcnew array<CecLogicalAddress>(16);
1443 Clear();
1444 }
1445
1446 /// <summary>
1447 /// Clears this list
1448 /// </summary>
1449 void Clear(void)
1450 {
1451 Primary = CecLogicalAddress::Unknown;
1452 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1453 Addresses[iPtr] = CecLogicalAddress::Unknown;
1454 }
1455
1456 /// <summary>
1457 /// Checks whether a logical address is set in this list.
1458 /// </summary>
1459 /// <param name="address">The address to check.</param>
1460 /// <returns>True when set, false otherwise</returns>
1461 bool IsSet(CecLogicalAddress address)
1462 {
1463 return Addresses[(unsigned int)address] != CecLogicalAddress::Unknown;
1464 }
1465
1466 /// <summary>
1467 /// Add a logical address to this list (if it's not set already)
1468 /// </summary>
1469 /// <param name="address">The address to add.</param>
1470 void Set(CecLogicalAddress address)
1471 {
1472 Addresses[(unsigned int)address] = address;
1473 if (Primary == CecLogicalAddress::Unknown)
1474 Primary = address;
1475 }
1476
1477 /// <summary>
1478 /// The primary (first) address in this list
1479 /// </summary>
1480 property CecLogicalAddress Primary;
1481
1482 /// <summary>
1483 /// The list of addresses
1484 /// </summary>
1485 property array<CecLogicalAddress> ^ Addresses;
1486 };
1487
1488
1489 /// <summary>
1490 /// Byte array used for CEC command parameters
1491 /// </summary>
1492 public ref class CecDatapacket
1493 {
1494 public:
1495 /// <summary>
1496 /// Create a new byte array with maximum size 100
1497 /// </summary>
1498 CecDatapacket(void)
1499 {
1500 Data = gcnew array<uint8_t>(100);
1501 Size = 0;
1502 }
1503
1504 /// <summary>
1505 /// Adds a byte to this byte array
1506 /// </summary>
1507 /// <param name="data">The byte to add.</param>
1508 void PushBack(uint8_t data)
1509 {
1510 if (Size < 100)
1511 {
1512 Data[Size] = data;
1513 Size++;
1514 }
1515 }
1516
1517 /// <summary>
1518 /// Array data
1519 /// </summary>
1520 property array<uint8_t> ^ Data;
1521
1522 /// <summary>
1523 /// Current data size
1524 /// </summary>
1525 property uint8_t Size;
1526 };
1527
1528 /// <summary>
1529 /// A CEC command that is received or transmitted over the CEC bus
1530 /// </summary>
1531 public ref class CecCommand
1532 {
1533 public:
1534 /// <summary>
1535 /// Create a new CEC command instance
1536 /// </summary>
1537 /// <param name="initiator">The initiator of the command</param>
1538 /// <param name="destination">The receiver of the command</param>
1539 /// <param name="ack">True when the ack bit is set, false otherwise</param>
1540 /// <param name="eom">True when the eom bit is set, false otherwise</param>
1541 /// <param name="opcode">The CEC opcode of this command</param>
1542 /// <param name="transmitTimeout">The timeout to use when transmitting a command</param>
1543 CecCommand(CecLogicalAddress initiator, CecLogicalAddress destination, bool ack, bool eom, CecOpcode opcode, int32_t transmitTimeout)
1544 {
1545 Initiator = initiator;
1546 Destination = destination;
1547 Ack = ack;
1548 Eom = eom;
1549 Opcode = opcode;
1550 OpcodeSet = true;
1551 TransmitTimeout = transmitTimeout;
1552 Parameters = gcnew CecDatapacket;
1553 Empty = false;
1554 }
1555
1556 /// <summary>
1557 /// Create a new empty CEC command instance
1558 /// </summary>
1559 CecCommand(void)
1560 {
1561 Initiator = CecLogicalAddress::Unknown;
1562 Destination = CecLogicalAddress::Unknown;
1563 Ack = false;
1564 Eom = false;
1565 Opcode = CecOpcode::None;
1566 OpcodeSet = false;
1567 TransmitTimeout = 0;
1568 Parameters = gcnew CecDatapacket;
1569 Empty = true;
1570 }
1571
1572 /// <summary>
1573 /// Pushes a byte of data to this CEC command
1574 /// </summary>
1575 /// <param name="data">The byte to add</param>
1576 void PushBack(uint8_t data)
1577 {
1578 if (Initiator == CecLogicalAddress::Unknown && Destination == CecLogicalAddress::Unknown)
1579 {
1580 Initiator = (CecLogicalAddress) (data >> 4);
1581 Destination = (CecLogicalAddress) (data & 0xF);
1582 }
1583 else if (!OpcodeSet)
1584 {
1585 OpcodeSet = true;
1586 Opcode = (CecOpcode)data;
1587 }
1588 else
1589 {
1590 Parameters->PushBack(data);
1591 }
1592 }
1593
1594 /// <summary>
1595 /// True when this command is empty, false otherwise.
1596 /// </summary>
1597 property bool Empty;
1598 /// <summary>
1599 /// The initiator of the command
1600 /// </summary>
1601 property CecLogicalAddress Initiator;
1602 /// <summary>
1603 /// The destination of the command
1604 /// </summary>
1605 property CecLogicalAddress Destination;
1606 /// <summary>
1607 /// True when the ack bit is set, false otherwise
1608 /// </summary>
1609 property bool Ack;
1610 /// <summary>
1611 /// True when the eom bit is set, false otherwise
1612 /// </summary>
1613 property bool Eom;
1614 /// <summary>
1615 /// The CEC opcode of the command
1616 /// </summary>
1617 property CecOpcode Opcode;
1618 /// <summary>
1619 /// The parameters of this command
1620 /// </summary>
1621 property CecDatapacket ^ Parameters;
1622 /// <summary>
1623 /// True when an opcode is set, false otherwise (poll message)
1624 /// </summary>
1625 property bool OpcodeSet;
1626 /// <summary>
1627 /// The timeout to use when transmitting a command
1628 /// </summary>
1629 property int32_t TransmitTimeout;
1630 };
1631
1632 /// <summary>
1633 /// A key press that was received
1634 /// </summary>
1635 public ref class CecKeypress
1636 {
1637 public:
1638 /// <summary>
1639 /// Create a new key press instance
1640 /// </summary>
1641 /// <param name="keycode">The key code of this key press</param>
1642 /// <param name="duration">The duration of this key press in milliseconds</param>
1643 CecKeypress(CecUserControlCode keycode, unsigned int duration)
1644 {
1645 Keycode = keycode;
1646 Duration = duration;
1647 Empty = false;
1648 }
1649
1650 /// <summary>
1651 /// Create a new empty key press instance
1652 /// </summary>
1653 CecKeypress(void)
1654 {
1655 Keycode = CecUserControlCode::Unknown;
1656 Duration = 0;
1657 Empty = true;
1658 }
1659
1660 /// <summary>
1661 /// True when empty, false otherwise
1662 /// </summary>
1663 property bool Empty;
1664 /// <summary>
1665 /// The key code of this key press
1666 /// </summary>
1667 property CecUserControlCode Keycode;
1668 /// <summary>
1669 /// The duration of this key press in milliseconds
1670 /// </summary>
1671 property unsigned int Duration;
1672 };
1673
1674 /// <summary>
1675 /// A log message that libCEC generated
1676 /// </summary>
1677 public ref class CecLogMessage
1678 {
1679 public:
1680 /// <summary>
1681 /// Create a new log message
1682 /// </summary>
1683 /// <param name="message">The actual message</param>
1684 /// <param name="level">The log level, so the application can choose what type information to display</param>
1685 /// <param name="time">The timestamp of this message, in milliseconds after connecting</param>
1686 CecLogMessage(System::String ^ message, CecLogLevel level, int64_t time)
1687 {
1688 Message = message;
1689 Level = level;
1690 Time = time;
1691 Empty = false;
1692 }
1693
1694 /// <summary>
1695 /// Create a new empty log message
1696 /// </summary>
1697 CecLogMessage(void)
1698 {
1699 Message = "";
1700 Level = CecLogLevel::None;
1701 Time = 0;
1702 Empty = true;
1703 }
1704
1705 /// <summary>
1706 /// True when empty, false otherwise.
1707 /// </summary>
1708 property bool Empty;
1709 /// <summary>
1710 /// The actual message
1711 /// </summary>
1712 property System::String ^Message;
1713 /// <summary>
1714 /// The log level, so the application can choose what type information to display
1715 /// </summary>
1716 property CecLogLevel Level;
1717 /// <summary>
1718 /// The timestamp of this message, in milliseconds after connecting
1719 /// </summary>
1720 property int64_t Time;
1721 };
1722
1723 ref class CecCallbackMethods; //forward declaration
1724
1725 /// <summary>
1726 /// The configuration that libCEC uses.
1727 /// </summary>
1728 public ref class LibCECConfiguration
1729 {
1730 public:
1731 /// <summary>
1732 /// Create a new configuration instance with default settings.
1733 /// </summary>
1734 LibCECConfiguration(void)
1735 {
1736 DeviceName = "";
1737 DeviceTypes = gcnew CecDeviceTypeList();
1738 AutodetectAddress = true;
1739 PhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS;
1740 BaseDevice = (CecLogicalAddress)CEC_DEFAULT_BASE_DEVICE;
1741 HDMIPort = CEC_DEFAULT_HDMI_PORT;
1742 ClientVersion = CecClientVersion::CurrentVersion;
1743 ServerVersion = CecServerVersion::CurrentVersion;
1744 TvVendor = CecVendorId::Unknown;
1745
1746 GetSettingsFromROM = false;
1747 UseTVMenuLanguage = CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE == 1;
1748 ActivateSource = CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1;
1749
1750 WakeDevices = gcnew CecLogicalAddresses();
1751 if (CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1)
1752 WakeDevices->Set(CecLogicalAddress::Tv);
1753
1754 PowerOffDevices = gcnew CecLogicalAddresses();
1755 if (CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1)
1756 PowerOffDevices->Set(CecLogicalAddress::Broadcast);
1757
1758 PowerOffScreensaver = CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER == 1;
1759 PowerOffOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY == 1;
1760
1761 SendInactiveSource = CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE == 1;
1762 LogicalAddresses = gcnew CecLogicalAddresses();
1763 FirmwareVersion = 1;
1764 PowerOffDevicesOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY == 1;
1765 ShutdownOnStandby = CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY == 1;
1766 DeviceLanguage = "";
1767 FirmwareBuildDate = gcnew System::DateTime(1970,1,1,0,0,0,0);
1768 CECVersion = (CecVersion)CEC_DEFAULT_SETTING_CEC_VERSION;
1769 AdapterType = CecAdapterType::Unknown;
1770 }
1771
1772 /// <summary>
1773 /// Change the callback method pointers in this configuration instance.
1774 /// </summary>
1775 /// <param name="callbacks">The new callbacks</param>
1776 void SetCallbacks(CecCallbackMethods ^callbacks)
1777 {
1778 Callbacks = callbacks;
1779 }
1780
1781 /// <summary>
1782 /// Update this configuration with data received from libCEC
1783 /// </summary>
1784 /// <param name="config">The configuration that was received from libCEC</param>
1785 void Update(const CEC::libcec_configuration &config)
1786 {
1787 DeviceName = gcnew System::String(config.strDeviceName);
1788
1789 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1790 DeviceTypes->Types[iPtr] = (CecDeviceType)config.deviceTypes.types[iPtr];
1791
1792 AutodetectAddress = config.bAutodetectAddress == 1;
1793 PhysicalAddress = config.iPhysicalAddress;
1794 BaseDevice = (CecLogicalAddress)config.baseDevice;
1795 HDMIPort = config.iHDMIPort;
1796 ClientVersion = (CecClientVersion)config.clientVersion;
1797 ServerVersion = (CecServerVersion)config.serverVersion;
1798 TvVendor = (CecVendorId)config.tvVendor;
1799
1800 // player specific settings
1801 GetSettingsFromROM = config.bGetSettingsFromROM == 1;
1802 UseTVMenuLanguage = config.bUseTVMenuLanguage == 1;
1803 ActivateSource = config.bActivateSource == 1;
1804
1805 WakeDevices->Clear();
1806 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1807 if (config.wakeDevices[iPtr])
1808 WakeDevices->Set((CecLogicalAddress)iPtr);
1809
1810 PowerOffDevices->Clear();
1811 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1812 if (config.powerOffDevices[iPtr])
1813 PowerOffDevices->Set((CecLogicalAddress)iPtr);
1814
1815 PowerOffScreensaver = config.bPowerOffScreensaver == 1;
1816 PowerOffOnStandby = config.bPowerOffOnStandby == 1;
1817
1818 if (ServerVersion >= CecServerVersion::Version1_5_1)
1819 SendInactiveSource = config.bSendInactiveSource == 1;
1820
1821 if (ServerVersion >= CecServerVersion::Version1_5_3)
1822 {
1823 LogicalAddresses->Clear();
1824 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1825 if (config.logicalAddresses[iPtr])
1826 LogicalAddresses->Set((CecLogicalAddress)iPtr);
1827 }
1828
1829 if (ServerVersion >= CecServerVersion::Version1_6_0)
1830 {
1831 FirmwareVersion = config.iFirmwareVersion;
1832 PowerOffDevicesOnStandby = config.bPowerOffDevicesOnStandby == 1;
1833 ShutdownOnStandby = config.bShutdownOnStandby == 1;
1834 }
1835
1836 if (ServerVersion >= CecServerVersion::Version1_6_2)
1837 {
1838 DeviceLanguage = gcnew System::String(config.strDeviceLanguage);
1839 FirmwareBuildDate = gcnew System::DateTime(1970,1,1,0,0,0,0);
1840 FirmwareBuildDate = FirmwareBuildDate->AddSeconds(config.iFirmwareBuildDate);
1841 }
1842
1843 if (ServerVersion >= CecServerVersion::Version1_6_3)
1844 MonitorOnlyClient = config.bMonitorOnly == 1;
1845
1846 if (ServerVersion >= CecServerVersion::Version1_8_0)
1847 CECVersion = (CecVersion)config.cecVersion;
1848
1849 if (ServerVersion >= CecServerVersion::Version1_8_2)
1850 AdapterType = (CecAdapterType)config.adapterType;
1851
1852 if (ServerVersion >= CecServerVersion::Version2_1_0)
1853 PowerOnScreensaver = config.bPowerOnScreensaver == 1;
1854 }
1855
1856 /// <summary>
1857 /// The device name to use on the CEC bus
1858 /// </summary>
1859 property System::String ^ DeviceName;
1860
1861 /// <summary>
1862 /// The device type(s) to use on the CEC bus for libCEC
1863 /// </summary>
1864 property CecDeviceTypeList ^ DeviceTypes;
1865
1866 /// <summary>
1867 /// (read only) set to true by libCEC when the physical address was autodetected
1868 /// </summary>
1869 property bool AutodetectAddress;
1870
1871 /// <summary>
1872 /// The physical address of the CEC adapter
1873 /// </summary>
1874 property uint16_t PhysicalAddress;
1875
1876 /// <summary>
1877 /// The logical address of the device to which the adapter is connected. Only used when PhysicalAddress = 0 or when the adapter doesn't support autodetection
1878 /// </summary>
1879 property CecLogicalAddress BaseDevice;
1880
1881 /// <summary>
1882 /// The HDMI port to which the adapter is connected. Only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection
1883 /// </summary>
1884 property uint8_t HDMIPort;
1885
1886 /// <summary>
1887 /// The client API version to use
1888 /// </summary>
1889 property CecClientVersion ClientVersion;
1890
1891 /// <summary>
1892 /// The version of libCEC
1893 /// </summary>
1894 property CecServerVersion ServerVersion;
1895
1896 /// <summary>
1897 /// Override the vendor ID of the TV. Leave this untouched to autodetect
1898 /// </summary>
1899 property CecVendorId TvVendor;
1900
1901 /// <summary>
1902 /// True to read the settings from the EEPROM, which possibly override the settings passed here
1903 /// </summary>
1904 property bool GetSettingsFromROM;
1905
1906 /// <summary>
1907 /// Use the language setting of the TV in the client application. Must be implemented by the client application.
1908 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
1909 /// </summary>
1910 property bool UseTVMenuLanguage;
1911
1912 /// <summary>
1913 /// Make libCEC the active source when starting the client application
1914 /// </summary>
1915 property bool ActivateSource;
1916
1917 /// <summary>
1918 /// List of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter.
1919 /// </summary>
1920 property CecLogicalAddresses ^WakeDevices;
1921
1922 /// <summary>
1923 /// List of devices to power off when calling StandbyDevices() without any parameter.
1924 /// </summary>
1925 property CecLogicalAddresses ^PowerOffDevices;
1926
1927 /// <summary>
1928 /// Send standby commands when the client application activates the screensaver. Must be implemented by the client application.
1929 /// </summary>
1930 property bool PowerOffScreensaver;
1931
1932 /// <summary>
1933 /// Power off the PC when the TV powers off. Must be implemented by the client application.
1934 /// </summary>
1935 property bool PowerOffOnStandby;
1936
1937 /// <summary>
1938 /// Send an inactive source message when exiting the client application.
1939 /// </summary>
1940 property bool SendInactiveSource;
1941
1942 /// <summary>
1943 /// The list of logical addresses that libCEC is using
1944 /// </summary>
1945 property CecLogicalAddresses ^LogicalAddresses;
1946
1947 /// <summary>
1948 /// The firmware version of the adapter to which libCEC is connected
1949 /// </summary>
1950 property uint16_t FirmwareVersion;
1951
1952 /// <summary>
1953 /// Send standby commands when the client application activates standby mode (S3). Must be implemented by the client application.
1954 /// </summary>
1955 property bool PowerOffDevicesOnStandby;
1956
1957 /// <summary>
1958 /// Shutdown this PC when the TV is switched off. only used when PowerOffOnStandby = false
1959 /// </summary>
1960 property bool ShutdownOnStandby;
1961
1962 /// <summary>
1963 /// True to start a monitor-only client, false to start a standard client.
1964 /// </summary>
1965 property bool MonitorOnlyClient;
1966
1967 /// <summary>
1968 /// The language code of the menu language that libCEC reports to other devices.
1969 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
1970 /// </summary>
1971 property System::String ^ DeviceLanguage;
1972
1973 /// <summary>
1974 /// The callback methods to use.
1975 /// </summary>
1976 property CecCallbackMethods ^ Callbacks;
1977
1978 /// <summary>
1979 /// The build date of the firmware.
1980 /// </summary>
1981 property System::DateTime ^ FirmwareBuildDate;
1982
1983 /// <summary>
1984 /// The CEC version that libCEC uses.
1985 /// </summary>
1986 property CecVersion CECVersion;
1987
1988 /// <summary>
1989 /// The type of adapter that libCEC is connected to.
1990 /// </summary>
1991 property CecAdapterType AdapterType;
1992
1993 /// <summary>
1994 /// True to power on when quitting the screensaver.
1995 /// </summary>
1996 property bool PowerOnScreensaver;
1997 };
1998
1999 // the callback methods are called by unmanaged code, so we need some delegates for this
2000 #pragma unmanaged
2001 // unmanaged callback methods
2002 typedef int (__stdcall *LOGCB) (const CEC::cec_log_message &message);
2003 typedef int (__stdcall *KEYCB) (const CEC::cec_keypress &key);
2004 typedef int (__stdcall *COMMANDCB)(const CEC::cec_command &command);
2005 typedef int (__stdcall *CONFIGCB) (const CEC::libcec_configuration &config);
2006 typedef int (__stdcall *ALERTCB) (const CEC::libcec_alert, const CEC::libcec_parameter &data);
2007 typedef int (__stdcall *MENUCB) (const CEC::cec_menu_state newVal);
2008 typedef void (__stdcall *ACTICB) (const CEC::cec_logical_address logicalAddress, const uint8_t bActivated);
2009
2010 /// <summary>
2011 /// libCEC callback methods. Unmanaged code.
2012 /// </summary>
2013 typedef struct
2014 {
2015 /// <summary>
2016 /// Log message callback
2017 /// </summary>
2018 LOGCB logCB;
2019 /// <summary>
2020 /// Key press/release callback
2021 /// </summary>
2022 KEYCB keyCB;
2023 /// <summary>
2024 /// Raw CEC data callback
2025 /// </summary>
2026 COMMANDCB commandCB;
2027 /// <summary>
2028 /// Updated configuration callback
2029 /// </summary>
2030 CONFIGCB configCB;
2031 /// <summary>
2032 /// Alert message callback
2033 /// </summary>
2034 ALERTCB alertCB;
2035 /// <summary>
2036 /// Menu status change callback
2037 /// </summary>
2038 MENUCB menuCB;
2039 /// <summary>
2040 /// Source (de)activated callback
2041 /// </summary>
2042 ACTICB sourceActivatedCB;
2043 } UnmanagedCecCallbacks;
2044
2045 static PLATFORM::CMutex g_callbackMutex;
2046 static std::vector<UnmanagedCecCallbacks> g_unmanagedCallbacks;
2047 static CEC::ICECCallbacks g_cecCallbacks;
2048
2049 /// <summary>
2050 /// Called by libCEC to send back a log message to the application
2051 /// </summary>
2052 /// <param name="cbParam">Pointer to the callback struct</param>
2053 /// <param name="message">The log message</param>
2054 /// <return>1 when handled, 0 otherwise</return>
2055 int CecLogMessageCB(void *cbParam, const CEC::cec_log_message message)
2056 {
2057 if (cbParam)
2058 {
2059 size_t iPtr = (size_t)cbParam;
2060 PLATFORM::CLockObject lock(g_callbackMutex);
2061 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2062 return g_unmanagedCallbacks[iPtr].logCB(message);
2063 }
2064 return 0;
2065 }
2066
2067 /// <summary>
2068 /// Called by libCEC to send back a key press or release to the application
2069 /// </summary>
2070 /// <param name="cbParam">Pointer to the callback struct</param>
2071 /// <param name="key">The key press command that libCEC received</param>
2072 /// <return>1 when handled, 0 otherwise</return>
2073 int CecKeyPressCB(void *cbParam, const CEC::cec_keypress key)
2074 {
2075 if (cbParam)
2076 {
2077 size_t iPtr = (size_t)cbParam;
2078 PLATFORM::CLockObject lock(g_callbackMutex);
2079 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2080 return g_unmanagedCallbacks[iPtr].keyCB(key);
2081 }
2082 return 0;
2083 }
2084
2085 /// <summary>
2086 /// Called by libCEC to send back raw CEC data to the application
2087 /// </summary>
2088 /// <param name="cbParam">Pointer to the callback struct</param>
2089 /// <param name="command">The raw CEC data</param>
2090 /// <return>1 when handled, 0 otherwise</return>
2091 int CecCommandCB(void *cbParam, const CEC::cec_command command)
2092 {
2093 if (cbParam)
2094 {
2095 size_t iPtr = (size_t)cbParam;
2096 PLATFORM::CLockObject lock(g_callbackMutex);
2097 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2098 return g_unmanagedCallbacks[iPtr].commandCB(command);
2099 }
2100 return 0;
2101 }
2102
2103 /// <summary>
2104 /// Called by libCEC to send back an updated configuration to the application
2105 /// </summary>
2106 /// <param name="cbParam">Pointer to the callback struct</param>
2107 /// <param name="config">The new configuration</param>
2108 /// <return>1 when handled, 0 otherwise</return>
2109 int CecConfigCB(void *cbParam, const CEC::libcec_configuration config)
2110 {
2111 if (cbParam)
2112 {
2113 size_t iPtr = (size_t)cbParam;
2114 PLATFORM::CLockObject lock(g_callbackMutex);
2115 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2116 return g_unmanagedCallbacks[iPtr].configCB(config);
2117 }
2118 return 0;
2119 }
2120
2121 /// <summary>
2122 /// Called by libCEC to send back an alert message to the application
2123 /// </summary>
2124 /// <param name="cbParam">Pointer to the callback struct</param>
2125 /// <param name="data">The alert message</param>
2126 /// <return>1 when handled, 0 otherwise</return>
2127 int CecAlertCB(void *cbParam, const CEC::libcec_alert alert, const CEC::libcec_parameter data)
2128 {
2129 if (cbParam)
2130 {
2131 size_t iPtr = (size_t)cbParam;
2132 PLATFORM::CLockObject lock(g_callbackMutex);
2133 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2134 return g_unmanagedCallbacks[iPtr].alertCB(alert, data);
2135 }
2136 return 0;
2137 }
2138
2139 /// <summary>
2140 /// Called by libCEC to send back a menu state change to the application
2141 /// </summary>
2142 /// <param name="cbParam">Pointer to the callback struct</param>
2143 /// <param name="newVal">The new menu state</param>
2144 /// <return>1 when handled, 0 otherwise</return>
2145 int CecMenuCB(void *cbParam, const CEC::cec_menu_state newVal)
2146 {
2147 if (cbParam)
2148 {
2149 size_t iPtr = (size_t)cbParam;
2150 PLATFORM::CLockObject lock(g_callbackMutex);
2151 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2152 return g_unmanagedCallbacks[iPtr].menuCB(newVal);
2153 }
2154 return 0;
2155 }
2156
2157 /// <summary>
2158 /// Called by libCEC to notify the application that the source that is handled by libCEC was (de)activated
2159 /// </summary>
2160 /// <param name="cbParam">Pointer to the callback struct</param>
2161 /// <param name="logicalAddress">The logical address that was (de)activated</param>
2162 /// <param name="activated">True when activated, false when deactivated</param>
2163 void CecSourceActivatedCB(void *cbParam, const CEC::cec_logical_address logicalAddress, const uint8_t activated)
2164 {
2165 if (cbParam)
2166 {
2167 size_t iPtr = (size_t)cbParam;
2168 PLATFORM::CLockObject lock(g_callbackMutex);
2169 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2170 g_unmanagedCallbacks[iPtr].sourceActivatedCB(logicalAddress, activated);
2171 }
2172 }
2173
2174 #pragma managed
2175 /// <summary>
2176 /// Delegate method for the CecLogMessageCB callback in CecCallbackMethods
2177 /// </summary>
2178 public delegate int CecLogMessageManagedDelegate(const CEC::cec_log_message &);
2179 /// <summary>
2180 /// Delegate method for the CecKeyPressCB callback in CecCallbackMethods
2181 /// </summary>
2182 public delegate int CecKeyPressManagedDelegate(const CEC::cec_keypress &);
2183 /// <summary>
2184 /// Delegate method for the CecCommandCB callback in CecCallbackMethods
2185 /// </summary>
2186 public delegate int CecCommandManagedDelegate(const CEC::cec_command &);
2187 /// <summary>
2188 /// Delegate method for the CecConfigCB callback in CecCallbackMethods
2189 /// </summary>
2190 public delegate int CecConfigManagedDelegate(const CEC::libcec_configuration &);
2191 /// <summary>
2192 /// Delegate method for the CecAlertCB callback in CecCallbackMethods
2193 /// </summary>
2194 public delegate int CecAlertManagedDelegate(const CEC::libcec_alert, const CEC::libcec_parameter &);
2195 /// <summary>
2196 /// Delegate method for the CecMenuCB callback in CecCallbackMethods
2197 /// </summary>
2198 public delegate int CecMenuManagedDelegate(const CEC::cec_menu_state);
2199 /// <summary>
2200 /// Delegate method for the CecSourceActivatedCB callback in CecCallbackMethods
2201 /// </summary>
2202 public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address, const uint8_t);
2203
2204 /// <summary>
2205 /// Assign the callback methods in the g_cecCallbacks struct
2206 /// </summary>
2207 void AssignCallbacks()
2208 {
2209 g_cecCallbacks.CBCecLogMessage = CecLogMessageCB;
2210 g_cecCallbacks.CBCecKeyPress = CecKeyPressCB;
2211 g_cecCallbacks.CBCecCommand = CecCommandCB;
2212 g_cecCallbacks.CBCecConfigurationChanged = CecConfigCB;
2213 g_cecCallbacks.CBCecAlert = CecAlertCB;
2214 g_cecCallbacks.CBCecMenuStateChanged = CecMenuCB;
2215 g_cecCallbacks.CBCecSourceActivated = CecSourceActivatedCB;
2216 }
2217
2218 /// <summary>
2219 /// The callback methods that libCEC uses
2220 /// </summary>
2221 public ref class CecCallbackMethods
2222 {
2223 public:
2224 CecCallbackMethods(void)
2225 {
2226 m_iCallbackPtr = -1;
2227 AssignCallbacks();
2228 m_bHasCallbacks = false;
2229 m_bDelegatesCreated = false;
2230 }
2231
2232 ~CecCallbackMethods(void)
2233 {
2234 DestroyDelegates();
2235 }
2236
2237 /// <summary>
2238 /// Pointer to the callbacks struct entry
2239 /// </summary>
2240 size_t GetCallbackPtr(void)
2241 {
2242 PLATFORM::CLockObject lock(g_callbackMutex);
2243 return m_iCallbackPtr;
2244 }
2245
2246 protected:
2247 !CecCallbackMethods(void)
2248 {
2249 DestroyDelegates();
2250 }
2251
2252 public:
2253 /// <summary>
2254 /// Disable callback methods
2255 /// </summary>
2256 virtual void DisableCallbacks(void)
2257 {
2258 DestroyDelegates();
2259 }
2260
2261 /// <summary>
2262 /// Enable callback methods
2263 /// </summary>
2264 /// <param name="callbacks">Callback methods to activate</param>
2265 /// <return>true when handled, false otherwise</return>
2266 virtual bool EnableCallbacks(CecCallbackMethods ^ callbacks)
2267 {
2268 CreateDelegates();
2269 if (!m_bHasCallbacks)
2270 {
2271 m_bHasCallbacks = true;
2272 m_callbacks = callbacks;
2273 return true;
2274 }
2275
2276 return false;
2277 }
2278
2279 /// <summary>
2280 /// Called by libCEC to send back a log message to the application.
2281 /// Override in the application to handle this callback.
2282 /// </summary>
2283 /// <param name="message">The log message</param>
2284 /// <return>1 when handled, 0 otherwise</return>
2285 virtual int ReceiveLogMessage(CecLogMessage ^ message)
2286 {
2287 return 0;
2288 }
2289
2290 /// <summary>
2291 /// Called by libCEC to send back a key press or release to the application.
2292 /// Override in the application to handle this callback.
2293 /// </summary>
2294 /// <param name="key">The key press command that libCEC received</param>
2295 /// <return>1 when handled, 0 otherwise</return>
2296 virtual int ReceiveKeypress(CecKeypress ^ key)
2297 {
2298 return 0;
2299 }
2300
2301 /// <summary>
2302 /// Called by libCEC to send back raw CEC data to the application.
2303 /// Override in the application to handle this callback.
2304 /// </summary>
2305 /// <param name="command">The raw CEC data</param>
2306 /// <return>1 when handled, 0 otherwise</return>
2307 virtual int ReceiveCommand(CecCommand ^ command)
2308 {
2309 return 0;
2310 }
2311
2312 /// <summary>
2313 /// Called by libCEC to send back an updated configuration to the application.
2314 /// Override in the application to handle this callback.
2315 /// </summary>
2316 /// <param name="config">The new configuration</param>
2317 /// <return>1 when handled, 0 otherwise</return>
2318 virtual int ConfigurationChanged(LibCECConfiguration ^ config)
2319 {
2320 return 0;
2321 }
2322
2323 /// <summary>
2324 /// Called by libCEC to send back an alert message to the application.
2325 /// Override in the application to handle this callback.
2326 /// </summary>
2327 /// <param name="data">The alert message</param>
2328 /// <return>1 when handled, 0 otherwise</return>
2329 virtual int ReceiveAlert(CecAlert alert, CecParameter ^ data)
2330 {
2331 return 0;
2332 }
2333
2334 /// <summary>
2335 /// Called by libCEC to send back a menu state change to the application.
2336 /// Override in the application to handle this callback.
2337 /// </summary>
2338 /// <param name="newVal">The new menu state</param>
2339 /// <return>1 when handled, 0 otherwise</return>
2340 virtual int ReceiveMenuStateChange(CecMenuState newVal)
2341 {
2342 return 0;
2343 }
2344
2345 /// <summary>
2346 /// Called by libCEC to notify the application that the source that is handled by libCEC was (de)activated.
2347 /// Override in the application to handle this callback.
2348 /// </summary>
2349 /// <param name="logicalAddress">The logical address that was (de)activated</param>
2350 /// <param name="activated">True when activated, false when deactivated</param>
2351 virtual void SourceActivated(CecLogicalAddress logicalAddress, bool activated)
2352 {
2353 }
2354
2355 protected:
2356 // managed callback methods
2357 int CecLogMessageManaged(const CEC::cec_log_message &message)
2358 {
2359 int iReturn(0);
2360 if (m_bHasCallbacks)
2361 iReturn = m_callbacks->ReceiveLogMessage(gcnew CecLogMessage(gcnew System::String(message.message), (CecLogLevel)message.level, message.time));
2362 return iReturn;
2363 }
2364
2365 int CecKeyPressManaged(const CEC::cec_keypress &key)
2366 {
2367 int iReturn(0);
2368 if (m_bHasCallbacks)
2369 iReturn = m_callbacks->ReceiveKeypress(gcnew CecKeypress((CecUserControlCode)key.keycode, key.duration));
2370 return iReturn;
2371 }
2372
2373 int CecCommandManaged(const CEC::cec_command &command)
2374 {
2375 int iReturn(0);
2376 if (m_bHasCallbacks)
2377 {
2378 CecCommand ^ newCommand = gcnew CecCommand((CecLogicalAddress)command.initiator, (CecLogicalAddress)command.destination, command.ack == 1 ? true : false, command.eom == 1 ? true : false, (CecOpcode)command.opcode, command.transmit_timeout);
2379 for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
2380 newCommand->Parameters->PushBack(command.parameters[iPtr]);
2381 iReturn = m_callbacks->ReceiveCommand(newCommand);
2382 }
2383 return iReturn;
2384 }
2385
2386 int CecConfigManaged(const CEC::libcec_configuration &config)
2387 {
2388 int iReturn(0);
2389 if (m_bHasCallbacks)
2390 {
2391 LibCECConfiguration ^netConfig = gcnew LibCECConfiguration();
2392 netConfig->Update(config);
2393 iReturn = m_callbacks->ConfigurationChanged(netConfig);
2394 }
2395 return iReturn;
2396 }
2397
2398 int CecAlertManaged(const CEC::libcec_alert alert, const CEC::libcec_parameter &data)
2399 {
2400 int iReturn(0);
2401 if (m_bHasCallbacks)
2402 {
2403 CecParameterType newType = (CecParameterType)data.paramType;
2404 if (newType == CecParameterType::ParameterTypeString)
2405 {
2406 System::String ^ newData = gcnew System::String((const char *)data.paramData, 0, 128);
2407 CecParameter ^ newParam = gcnew CecParameter(newType, newData);
2408 iReturn = m_callbacks->ReceiveAlert((CecAlert)alert, newParam);
2409 }
2410 }
2411 return iReturn;
2412 }
2413
2414 int CecMenuManaged(const CEC::cec_menu_state newVal)
2415 {
2416 int iReturn(0);
2417 if (m_bHasCallbacks)
2418 {
2419 iReturn = m_callbacks->ReceiveMenuStateChange((CecMenuState)newVal);
2420 }
2421 return iReturn;
2422 }
2423
2424 void CecSourceActivatedManaged(const CEC::cec_logical_address logicalAddress, const uint8_t bActivated)
2425 {
2426 if (m_bHasCallbacks)
2427 m_callbacks->SourceActivated((CecLogicalAddress)logicalAddress, bActivated == 1);
2428 }
2429
2430 void DestroyDelegates()
2431 {
2432 m_bHasCallbacks = false;
2433 if (m_bDelegatesCreated)
2434 {
2435 m_bDelegatesCreated = false;
2436 m_logMessageGCHandle.Free();
2437 m_keypressGCHandle.Free();
2438 m_commandGCHandle.Free();
2439 m_alertGCHandle.Free();
2440 m_menuGCHandle.Free();
2441 m_sourceActivatedGCHandle.Free();
2442 }
2443 }
2444
2445 void CreateDelegates()
2446 {
2447 DestroyDelegates();
2448
2449 if (!m_bDelegatesCreated)
2450 {
2451 msclr::interop::marshal_context ^ context = gcnew msclr::interop::marshal_context();
2452
2453 // create the delegate method for the log message callback
2454 m_logMessageDelegate = gcnew CecLogMessageManagedDelegate(this, &CecCallbackMethods::CecLogMessageManaged);
2455 m_logMessageGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_logMessageDelegate);
2456 m_logMessageCallback = static_cast<LOGCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_logMessageDelegate).ToPointer());
2457
2458 // create the delegate method for the keypress callback
2459 m_keypressDelegate = gcnew CecKeyPressManagedDelegate(this, &CecCallbackMethods::CecKeyPressManaged);
2460 m_keypressGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_keypressDelegate);
2461 m_keypressCallback = static_cast<KEYCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_keypressDelegate).ToPointer());
2462
2463 // create the delegate method for the command callback
2464 m_commandDelegate = gcnew CecCommandManagedDelegate(this, &CecCallbackMethods::CecCommandManaged);
2465 m_commandGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_commandDelegate);
2466 m_commandCallback = static_cast<COMMANDCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_commandDelegate).ToPointer());
2467
2468 // create the delegate method for the configuration change callback
2469 m_configDelegate = gcnew CecConfigManagedDelegate(this, &CecCallbackMethods::CecConfigManaged);
2470 m_configGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_configDelegate);
2471 m_configCallback = static_cast<CONFIGCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_configDelegate).ToPointer());
2472
2473 // create the delegate method for the alert callback
2474 m_alertDelegate = gcnew CecAlertManagedDelegate(this, &CecCallbackMethods::CecAlertManaged);
2475 m_alertGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_alertDelegate);
2476 m_alertCallback = static_cast<ALERTCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_alertDelegate).ToPointer());
2477
2478 // create the delegate method for the menu callback
2479 m_menuDelegate = gcnew CecMenuManagedDelegate(this, &CecCallbackMethods::CecMenuManaged);
2480 m_menuGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_menuDelegate);
2481 m_menuCallback = static_cast<MENUCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_menuDelegate).ToPointer());
2482
2483 // create the delegate method for the source activated callback
2484 m_sourceActivatedDelegate = gcnew CecSourceActivatedManagedDelegate(this, &CecCallbackMethods::CecSourceActivatedManaged);
2485 m_sourceActivatedGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_sourceActivatedDelegate);
2486 m_sourceActivatedCallback = static_cast<ACTICB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_sourceActivatedDelegate).ToPointer());
2487
2488 delete context;
2489
2490 UnmanagedCecCallbacks unmanagedCallbacks;
2491 unmanagedCallbacks.logCB = m_logMessageCallback;
2492 unmanagedCallbacks.keyCB = m_keypressCallback;
2493 unmanagedCallbacks.commandCB = m_commandCallback;
2494 unmanagedCallbacks.configCB = m_configCallback;
2495 unmanagedCallbacks.alertCB = m_alertCallback;
2496 unmanagedCallbacks.menuCB = m_menuCallback;
2497 unmanagedCallbacks.sourceActivatedCB = m_sourceActivatedCallback;
2498
2499 PLATFORM::CLockObject lock(g_callbackMutex);
2500 g_unmanagedCallbacks.push_back(unmanagedCallbacks);
2501 m_iCallbackPtr = g_unmanagedCallbacks.size() - 1;
2502 m_bDelegatesCreated = true;
2503 }
2504 }
2505
2506 CecLogMessageManagedDelegate ^ m_logMessageDelegate;
2507 static System::Runtime::InteropServices::GCHandle m_logMessageGCHandle;
2508 LOGCB m_logMessageCallback;
2509
2510 CecKeyPressManagedDelegate ^ m_keypressDelegate;
2511 static System::Runtime::InteropServices::GCHandle m_keypressGCHandle;
2512 KEYCB m_keypressCallback;
2513
2514 CecCommandManagedDelegate ^ m_commandDelegate;
2515 static System::Runtime::InteropServices::GCHandle m_commandGCHandle;
2516 COMMANDCB m_commandCallback;
2517
2518 CecConfigManagedDelegate ^ m_configDelegate;
2519 static System::Runtime::InteropServices::GCHandle m_configGCHandle;
2520 CONFIGCB m_configCallback;
2521
2522 CecAlertManagedDelegate ^ m_alertDelegate;
2523 static System::Runtime::InteropServices::GCHandle m_alertGCHandle;
2524 ALERTCB m_alertCallback;
2525
2526 CecMenuManagedDelegate ^ m_menuDelegate;
2527 static System::Runtime::InteropServices::GCHandle m_menuGCHandle;
2528 MENUCB m_menuCallback;
2529
2530 CecSourceActivatedManagedDelegate ^ m_sourceActivatedDelegate;
2531 static System::Runtime::InteropServices::GCHandle m_sourceActivatedGCHandle;
2532 ACTICB m_sourceActivatedCallback;
2533
2534 CecCallbackMethods ^ m_callbacks;
2535 bool m_bHasCallbacks;
2536 bool m_bDelegatesCreated;
2537 size_t m_iCallbackPtr;
2538 };
2539 }