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