enable silent rules by default
[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>
1162 Version1_99_0 = 0x1990
f9717bcc
LOK
1163 };
1164
8438c41f
LOK
1165 /// <summary>
1166 /// libCEC version
1167 /// </summary>
f9717bcc
LOK
1168 public enum class CecServerVersion
1169 {
8438c41f
LOK
1170 /// <summary>
1171 /// before v1.5.0
1172 /// </summary>
f9717bcc 1173 VersionPre1_5 = 0,
8438c41f
LOK
1174 /// <summary>
1175 /// v1.5.0
1176 /// </summary>
f9717bcc 1177 Version1_5_0 = 0x1500,
8438c41f
LOK
1178 /// <summary>
1179 /// v1.5.1
1180 /// </summary>
f9717bcc 1181 Version1_5_1 = 0x1501,
8438c41f
LOK
1182 /// <summary>
1183 /// v1.5.2
1184 /// </summary>
f9717bcc 1185 Version1_5_2 = 0x1502,
8438c41f
LOK
1186 /// <summary>
1187 /// v1.5.3
1188 /// </summary>
f9717bcc 1189 Version1_5_3 = 0x1503,
8438c41f
LOK
1190 /// <summary>
1191 /// v1.6.0
1192 /// </summary>
f9717bcc 1193 Version1_6_0 = 0x1600,
8438c41f
LOK
1194 /// <summary>
1195 /// v1.6.1
1196 /// </summary>
f9717bcc 1197 Version1_6_1 = 0x1601,
8438c41f
LOK
1198 /// <summary>
1199 /// v1.6.2
1200 /// </summary>
f9717bcc 1201 Version1_6_2 = 0x1602,
8438c41f
LOK
1202 /// <summary>
1203 /// v1.6.3
1204 /// </summary>
f9717bcc 1205 Version1_6_3 = 0x1603,
8438c41f
LOK
1206 /// <summary>
1207 /// v1.7.0
1208 /// </summary>
f9717bcc 1209 Version1_7_0 = 0x1700,
8438c41f
LOK
1210 /// <summary>
1211 /// v1.7.1
1212 /// </summary>
f9717bcc 1213 Version1_7_1 = 0x1701,
8438c41f
LOK
1214 /// <summary>
1215 /// v1.7.2
1216 /// </summary>
f9717bcc 1217 Version1_7_2 = 0x1702,
8438c41f
LOK
1218 /// <summary>
1219 /// v1.8.0
1220 /// </summary>
f9717bcc 1221 Version1_8_0 = 0x1800,
8438c41f
LOK
1222 /// <summary>
1223 /// v1.8.1
1224 /// </summary>
f9717bcc 1225 Version1_8_1 = 0x1801,
8438c41f
LOK
1226 /// <summary>
1227 /// v1.8.2
1228 /// </summary>
f9717bcc 1229 Version1_8_2 = 0x1802,
8438c41f
LOK
1230 /// <summary>
1231 /// v1.9.0
1232 /// </summary>
f81c0652
LOK
1233 Version1_9_0 = 0x1900,
1234 /// <summary>
1235 /// v2.0.0-pre
1236 /// </summary>
1237 Version1_99_0 = 0x1990
f9717bcc
LOK
1238 };
1239
8438c41f
LOK
1240 /// <summary>
1241 /// Type of adapter to which libCEC is connected
1242 /// </summary>
22190f06
LOK
1243 public enum class CecAdapterType
1244 {
8438c41f
LOK
1245 /// <summary>
1246 /// Unknown adapter type
1247 /// </summary>
22190f06 1248 Unknown = 0,
8438c41f
LOK
1249 /// <summary>
1250 /// Pulse-Eight USB-CEC adapter
1251 /// </summary>
22190f06 1252 PulseEightExternal = 0x1,
8438c41f
LOK
1253 /// <summary>
1254 /// Pulse-Eight CEC daughterboard
1255 /// </summary>
22190f06 1256 PulseEightDaughterboard = 0x2,
8438c41f
LOK
1257 /// <summary>
1258 /// Raspberry Pi
1259 /// </summary>
22190f06
LOK
1260 RaspberryPi = 0x100
1261 };
1262
f9717bcc 1263 /// <summary>
8438c41f 1264 /// Descriptor of a CEC adapter, returned when scanning for adapters that are connected to the system
f9717bcc
LOK
1265 /// </summary>
1266 public ref class CecAdapter
1267 {
1268 public:
1269 /// <summary>
1270 /// Create a new CEC adapter descriptor
1271 /// </summary>
1272 /// <param name="path"> The path descriptor for this CEC adapter</param>
1273 /// <param name="comPort">The COM port of this CEC adapter</param>
1274 CecAdapter(System::String ^ path, System::String ^ comPort)
1275 {
1276 Path = path;
1277 ComPort = comPort;
1278 }
1279
1280 /// <summary>
1281 /// The path descriptor for this CEC adapter
1282 /// </summary>
1283 property System::String ^ Path;
1284
1285 /// <summary>
1286 /// The COM port of this CEC adapter
1287 /// </summary>
1288 property System::String ^ ComPort;
1289 };
1290
1291 /// <summary>
1292 /// A list of CEC device types
1293 /// </summary>
1294 public ref class CecDeviceTypeList
1295 {
1296 public:
1297 /// <summary>
1298 /// Create a new empty list of CEC device types
1299 /// </summary>
1300 CecDeviceTypeList(void)
1301 {
1302 Types = gcnew array<CecDeviceType>(5);
1303 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1304 Types[iPtr] = CecDeviceType::Reserved;
1305 }
1306
1307 /// <summary>
1308 /// The array with CecDeviceType instances in this list.
1309 /// </summary>
1310 property array<CecDeviceType> ^ Types;
1311 };
1312
1313 /// <summary>
1314 /// A list of logical addresses
1315 /// </summary>
1316 public ref class CecLogicalAddresses
1317 {
1318 public:
1319 /// <summary>
1320 /// Create a new empty list of logical addresses
1321 /// </summary>
1322 CecLogicalAddresses(void)
1323 {
1324 Addresses = gcnew array<CecLogicalAddress>(16);
1325 Clear();
1326 }
1327
1328 /// <summary>
1329 /// Clears this list
1330 /// </summary>
1331 void Clear(void)
1332 {
1333 Primary = CecLogicalAddress::Unknown;
1334 for (unsigned int iPtr = 0; iPtr < 16; iPtr++)
1335 Addresses[iPtr] = CecLogicalAddress::Unknown;
1336 }
1337
1338 /// <summary>
1339 /// Checks whether a logical address is set in this list.
1340 /// </summary>
1341 /// <param name="address">The address to check.</param>
1342 /// <returns>True when set, false otherwise</returns>
1343 bool IsSet(CecLogicalAddress address)
1344 {
1345 return Addresses[(unsigned int)address] != CecLogicalAddress::Unknown;
1346 }
1347
1348 /// <summary>
1349 /// Add a logical address to this list (if it's not set already)
1350 /// </summary>
1351 /// <param name="address">The address to add.</param>
1352 void Set(CecLogicalAddress address)
1353 {
1354 Addresses[(unsigned int)address] = address;
1355 if (Primary == CecLogicalAddress::Unknown)
1356 Primary = address;
1357 }
1358
1359 /// <summary>
1360 /// The primary (first) address in this list
1361 /// </summary>
1362 property CecLogicalAddress Primary;
1363
1364 /// <summary>
1365 /// The list of addresses
1366 /// </summary>
1367 property array<CecLogicalAddress> ^ Addresses;
1368 };
1369
1370
1371 /// <summary>
1372 /// Byte array used for CEC command parameters
1373 /// </summary>
1374 public ref class CecDatapacket
1375 {
1376 public:
1377 /// <summary>
1378 /// Create a new byte array with maximum size 100
1379 /// </summary>
1380 CecDatapacket(void)
1381 {
1382 Data = gcnew array<uint8_t>(100);
1383 Size = 0;
1384 }
1385
1386 /// <summary>
1387 /// Adds a byte to this byte array
1388 /// </summary>
1389 /// <param name="data">The byte to add.</param>
1390 void PushBack(uint8_t data)
1391 {
1392 if (Size < 100)
1393 {
1394 Data[Size] = data;
1395 Size++;
1396 }
1397 }
1398
1399 /// <summary>
1400 /// Array data
1401 /// </summary>
1402 property array<uint8_t> ^ Data;
1403
1404 /// <summary>
1405 /// Current data size
1406 /// </summary>
1407 property uint8_t Size;
1408 };
1409
1410 /// <summary>
1411 /// A CEC command that is received or transmitted over the CEC bus
1412 /// </summary>
1413 public ref class CecCommand
1414 {
1415 public:
1416 /// <summary>
1417 /// Create a new CEC command instance
1418 /// </summary>
1419 /// <param name="initiator">The initiator of the command</param>
1420 /// <param name="destination">The receiver of the command</param>
1421 /// <param name="ack">True when the ack bit is set, false otherwise</param>
1422 /// <param name="eom">True when the eom bit is set, false otherwise</param>
1423 /// <param name="opcode">The CEC opcode of this command</param>
1424 /// <param name="transmitTimeout">The timeout to use when transmitting a command</param>
1425 CecCommand(CecLogicalAddress initiator, CecLogicalAddress destination, bool ack, bool eom, CecOpcode opcode, int32_t transmitTimeout)
1426 {
1427 Initiator = initiator;
1428 Destination = destination;
1429 Ack = ack;
1430 Eom = eom;
1431 Opcode = opcode;
1432 OpcodeSet = true;
1433 TransmitTimeout = transmitTimeout;
1434 Parameters = gcnew CecDatapacket;
1435 Empty = false;
1436 }
1437
1438 /// <summary>
1439 /// Create a new empty CEC command instance
1440 /// </summary>
1441 CecCommand(void)
1442 {
1443 Initiator = CecLogicalAddress::Unknown;
1444 Destination = CecLogicalAddress::Unknown;
1445 Ack = false;
1446 Eom = false;
1447 Opcode = CecOpcode::None;
1448 OpcodeSet = false;
1449 TransmitTimeout = 0;
1450 Parameters = gcnew CecDatapacket;
1451 Empty = true;
1452 }
1453
1454 /// <summary>
1455 /// Pushes a byte of data to this CEC command
1456 /// </summary>
1457 /// <param name="data">The byte to add</param>
1458 void PushBack(uint8_t data)
1459 {
1460 if (Initiator == CecLogicalAddress::Unknown && Destination == CecLogicalAddress::Unknown)
1461 {
1462 Initiator = (CecLogicalAddress) (data >> 4);
1463 Destination = (CecLogicalAddress) (data & 0xF);
1464 }
1465 else if (!OpcodeSet)
1466 {
1467 OpcodeSet = true;
1468 Opcode = (CecOpcode)data;
1469 }
1470 else
1471 {
1472 Parameters->PushBack(data);
1473 }
1474 }
1475
1476 /// <summary>
1477 /// True when this command is empty, false otherwise.
1478 /// </summary>
1479 property bool Empty;
1480 /// <summary>
1481 /// The initiator of the command
1482 /// </summary>
1483 property CecLogicalAddress Initiator;
1484 /// <summary>
1485 /// The destination of the command
1486 /// </summary>
1487 property CecLogicalAddress Destination;
1488 /// <summary>
1489 /// True when the ack bit is set, false otherwise
1490 /// </summary>
1491 property bool Ack;
1492 /// <summary>
1493 /// True when the eom bit is set, false otherwise
1494 /// </summary>
1495 property bool Eom;
1496 /// <summary>
1497 /// The CEC opcode of the command
1498 /// </summary>
1499 property CecOpcode Opcode;
1500 /// <summary>
1501 /// The parameters of this command
1502 /// </summary>
1503 property CecDatapacket ^ Parameters;
1504 /// <summary>
1505 /// True when an opcode is set, false otherwise (poll message)
1506 /// </summary>
1507 property bool OpcodeSet;
1508 /// <summary>
1509 /// The timeout to use when transmitting a command
1510 /// </summary>
1511 property int32_t TransmitTimeout;
1512 };
1513
1514 /// <summary>
1515 /// A key press that was received
1516 /// </summary>
1517 public ref class CecKeypress
1518 {
1519 public:
1520 /// <summary>
1521 /// Create a new key press instance
1522 /// </summary>
1523 /// <param name="keycode">The key code of this key press</param>
1524 /// <param name="duration">The duration of this key press in milliseconds</param>
1525 CecKeypress(CecUserControlCode keycode, unsigned int duration)
1526 {
1527 Keycode = keycode;
1528 Duration = duration;
1529 Empty = false;
1530 }
1531
1532 /// <summary>
1533 /// Create a new empty key press instance
1534 /// </summary>
1535 CecKeypress(void)
1536 {
1537 Keycode = CecUserControlCode::Unknown;
1538 Duration = 0;
1539 Empty = true;
1540 }
1541
1542 /// <summary>
1543 /// True when empty, false otherwise
1544 /// </summary>
1545 property bool Empty;
1546 /// <summary>
1547 /// The key code of this key press
1548 /// </summary>
1549 property CecUserControlCode Keycode;
1550 /// <summary>
1551 /// The duration of this key press in milliseconds
1552 /// </summary>
1553 property unsigned int Duration;
1554 };
1555
1556 /// <summary>
1557 /// A log message that libCEC generated
1558 /// </summary>
1559 public ref class CecLogMessage
1560 {
1561 public:
1562 /// <summary>
1563 /// Create a new log message
1564 /// </summary>
1565 /// <param name="message">The actual message</param>
1566 /// <param name="level">The log level, so the application can choose what type information to display</param>
1567 /// <param name="time">The timestamp of this message, in milliseconds after connecting</param>
1568 CecLogMessage(System::String ^ message, CecLogLevel level, int64_t time)
1569 {
1570 Message = message;
1571 Level = level;
1572 Time = time;
1573 Empty = false;
1574 }
1575
1576 /// <summary>
1577 /// Create a new empty log message
1578 /// </summary>
1579 CecLogMessage(void)
1580 {
1581 Message = "";
1582 Level = CecLogLevel::None;
1583 Time = 0;
1584 Empty = true;
1585 }
1586
1587 /// <summary>
1588 /// True when empty, false otherwise.
1589 /// </summary>
1590 property bool Empty;
1591 /// <summary>
1592 /// The actual message
1593 /// </summary>
1594 property System::String ^Message;
1595 /// <summary>
1596 /// The log level, so the application can choose what type information to display
1597 /// </summary>
1598 property CecLogLevel Level;
1599 /// <summary>
1600 /// The timestamp of this message, in milliseconds after connecting
1601 /// </summary>
1602 property int64_t Time;
1603 };
1604
1605 ref class CecCallbackMethods; //forward declaration
1606
1607 /// <summary>
1608 /// The configuration that libCEC uses.
1609 /// </summary>
1610 public ref class LibCECConfiguration
1611 {
1612 public:
1613 /// <summary>
1614 /// Create a new configuration instance with default settings.
1615 /// </summary>
1616 LibCECConfiguration(void)
1617 {
1618 DeviceName = "";
1619 DeviceTypes = gcnew CecDeviceTypeList();
1620 AutodetectAddress = true;
1621 PhysicalAddress = CEC_DEFAULT_PHYSICAL_ADDRESS;
1622 BaseDevice = (CecLogicalAddress)CEC_DEFAULT_BASE_DEVICE;
1623 HDMIPort = CEC_DEFAULT_HDMI_PORT;
1624 ClientVersion = CecClientVersion::VersionPre1_5;
1625 ServerVersion = CecServerVersion::VersionPre1_5;
1626 TvVendor = CecVendorId::Unknown;
1627
1628 GetSettingsFromROM = false;
1629 UseTVMenuLanguage = CEC_DEFAULT_SETTING_USE_TV_MENU_LANGUAGE == 1;
1630 ActivateSource = CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1;
1631
1632 WakeDevices = gcnew CecLogicalAddresses();
1633 if (CEC_DEFAULT_SETTING_ACTIVATE_SOURCE == 1)
1634 WakeDevices->Set(CecLogicalAddress::Tv);
1635
1636 PowerOffDevices = gcnew CecLogicalAddresses();
1637 if (CEC_DEFAULT_SETTING_POWER_OFF_SHUTDOWN == 1)
1638 PowerOffDevices->Set(CecLogicalAddress::Broadcast);
1639
1640 PowerOffScreensaver = CEC_DEFAULT_SETTING_POWER_OFF_SCREENSAVER == 1;
1641 PowerOffOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_ON_STANDBY == 1;
1642
1643 SendInactiveSource = CEC_DEFAULT_SETTING_SEND_INACTIVE_SOURCE == 1;
1644 LogicalAddresses = gcnew CecLogicalAddresses();
1645 FirmwareVersion = 1;
1646 PowerOffDevicesOnStandby = CEC_DEFAULT_SETTING_POWER_OFF_DEVICES_STANDBY == 1;
1647 ShutdownOnStandby = CEC_DEFAULT_SETTING_SHUTDOWN_ON_STANDBY == 1;
1648 DeviceLanguage = "";
22190f06
LOK
1649 FirmwareBuildDate = gcnew System::DateTime(1970,1,1,0,0,0,0);
1650 CECVersion = (CecVersion)CEC_DEFAULT_SETTING_CEC_VERSION;
1651 AdapterType = CecAdapterType::Unknown;
f9717bcc
LOK
1652 }
1653
1654 /// <summary>
1655 /// Change the callback method pointers in this configuration instance.
1656 /// </summary>
1657 /// <param name="callbacks">The new callbacks</param>
1658 void SetCallbacks(CecCallbackMethods ^callbacks)
1659 {
1660 Callbacks = callbacks;
1661 }
1662
1663 /// <summary>
1664 /// Update this configuration with data received from libCEC
1665 /// </summary>
1666 /// <param name="config">The configuration that was received from libCEC</param>
1667 void Update(const CEC::libcec_configuration &config)
1668 {
1669 DeviceName = gcnew System::String(config.strDeviceName);
1670
1671 for (unsigned int iPtr = 0; iPtr < 5; iPtr++)
1672 DeviceTypes->Types[iPtr] = (CecDeviceType)config.deviceTypes.types[iPtr];
1673
1674 AutodetectAddress = config.bAutodetectAddress == 1;
1675 PhysicalAddress = config.iPhysicalAddress;
1676 BaseDevice = (CecLogicalAddress)config.baseDevice;
1677 HDMIPort = config.iHDMIPort;
1678 ClientVersion = (CecClientVersion)config.clientVersion;
1679 ServerVersion = (CecServerVersion)config.serverVersion;
1680 TvVendor = (CecVendorId)config.tvVendor;
1681
1682 // player specific settings
1683 GetSettingsFromROM = config.bGetSettingsFromROM == 1;
1684 UseTVMenuLanguage = config.bUseTVMenuLanguage == 1;
1685 ActivateSource = config.bActivateSource == 1;
1686
1687 WakeDevices->Clear();
1688 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1689 if (config.wakeDevices[iPtr])
1690 WakeDevices->Set((CecLogicalAddress)iPtr);
1691
1692 PowerOffDevices->Clear();
1693 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1694 if (config.powerOffDevices[iPtr])
1695 PowerOffDevices->Set((CecLogicalAddress)iPtr);
1696
1697 PowerOffScreensaver = config.bPowerOffScreensaver == 1;
1698 PowerOffOnStandby = config.bPowerOffOnStandby == 1;
1699
1700 if (ServerVersion >= CecServerVersion::Version1_5_1)
1701 SendInactiveSource = config.bSendInactiveSource == 1;
1702
1703 if (ServerVersion >= CecServerVersion::Version1_5_3)
1704 {
1705 LogicalAddresses->Clear();
1706 for (uint8_t iPtr = 0; iPtr <= 16; iPtr++)
1707 if (config.logicalAddresses[iPtr])
1708 LogicalAddresses->Set((CecLogicalAddress)iPtr);
1709 }
1710
1711 if (ServerVersion >= CecServerVersion::Version1_6_0)
1712 {
1713 FirmwareVersion = config.iFirmwareVersion;
1714 PowerOffDevicesOnStandby = config.bPowerOffDevicesOnStandby == 1;
1715 ShutdownOnStandby = config.bShutdownOnStandby == 1;
1716 }
1717
1718 if (ServerVersion >= CecServerVersion::Version1_6_2)
22190f06 1719 {
f9717bcc 1720 DeviceLanguage = gcnew System::String(config.strDeviceLanguage);
22190f06
LOK
1721 FirmwareBuildDate = gcnew System::DateTime(1970,1,1,0,0,0,0);
1722 FirmwareBuildDate = FirmwareBuildDate->AddSeconds(config.iFirmwareBuildDate);
1723 }
f9717bcc
LOK
1724
1725 if (ServerVersion >= CecServerVersion::Version1_6_3)
1726 MonitorOnlyClient = config.bMonitorOnly == 1;
22190f06
LOK
1727
1728 if (ServerVersion >= CecServerVersion::Version1_8_0)
1729 CECVersion = (CecVersion)config.cecVersion;
1730
1731 if (ServerVersion >= CecServerVersion::Version1_8_2)
1732 AdapterType = (CecAdapterType)config.adapterType;
f9717bcc
LOK
1733 }
1734
1735 /// <summary>
1736 /// The device name to use on the CEC bus
1737 /// </summary>
1738 property System::String ^ DeviceName;
1739
1740 /// <summary>
1741 /// The device type(s) to use on the CEC bus for libCEC
1742 /// </summary>
1743 property CecDeviceTypeList ^ DeviceTypes;
1744
1745 /// <summary>
f81c0652 1746 /// (read only) set to true by libCEC when the physical address was autodetected
f9717bcc
LOK
1747 /// </summary>
1748 property bool AutodetectAddress;
1749
1750 /// <summary>
f81c0652 1751 /// The physical address of the CEC adapter
f9717bcc
LOK
1752 /// </summary>
1753 property uint16_t PhysicalAddress;
1754
1755 /// <summary>
f81c0652 1756 /// 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
1757 /// </summary>
1758 property CecLogicalAddress BaseDevice;
1759
1760 /// <summary>
f81c0652 1761 /// The HDMI port to which the adapter is connected. Only used when iPhysicalAddress = 0 or when the adapter doesn't support autodetection
f9717bcc
LOK
1762 /// </summary>
1763 property uint8_t HDMIPort;
1764
1765 /// <summary>
1766 /// The client API version to use
1767 /// </summary>
1768 property CecClientVersion ClientVersion;
1769
1770 /// <summary>
1771 /// The version of libCEC
1772 /// </summary>
1773 property CecServerVersion ServerVersion;
1774
1775 /// <summary>
f81c0652 1776 /// Override the vendor ID of the TV. Leave this untouched to autodetect
f9717bcc
LOK
1777 /// </summary>
1778 property CecVendorId TvVendor;
1779
1780 /// <summary>
1781 /// True to read the settings from the EEPROM, which possibly override the settings passed here
1782 /// </summary>
1783 property bool GetSettingsFromROM;
1784
1785 /// <summary>
1786 /// Use the language setting of the TV in the client application. Must be implemented by the client application.
f81c0652 1787 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
f9717bcc
LOK
1788 /// </summary>
1789 property bool UseTVMenuLanguage;
1790
1791 /// <summary>
1792 /// Make libCEC the active source when starting the client application
1793 /// </summary>
1794 property bool ActivateSource;
1795
1796 /// <summary>
f81c0652 1797 /// List of devices to wake when initialising libCEC or when calling PowerOnDevices() without any parameter.
f9717bcc
LOK
1798 /// </summary>
1799 property CecLogicalAddresses ^WakeDevices;
1800
1801 /// <summary>
f81c0652 1802 /// List of devices to power off when calling StandbyDevices() without any parameter.
f9717bcc
LOK
1803 /// </summary>
1804 property CecLogicalAddresses ^PowerOffDevices;
1805
1806 /// <summary>
1807 /// Send standby commands when the client application activates the screensaver. Must be implemented by the client application.
1808 /// </summary>
1809 property bool PowerOffScreensaver;
1810
1811 /// <summary>
1812 /// Power off the PC when the TV powers off. Must be implemented by the client application.
1813 /// </summary>
1814 property bool PowerOffOnStandby;
1815
1816 /// <summary>
1817 /// Send an inactive source message when exiting the client application.
1818 /// </summary>
1819 property bool SendInactiveSource;
1820
1821 /// <summary>
1822 /// The list of logical addresses that libCEC is using
1823 /// </summary>
1824 property CecLogicalAddresses ^LogicalAddresses;
1825
1826 /// <summary>
1827 /// The firmware version of the adapter to which libCEC is connected
1828 /// </summary>
1829 property uint16_t FirmwareVersion;
1830
1831 /// <summary>
1832 /// Send standby commands when the client application activates standby mode (S3). Must be implemented by the client application.
1833 /// </summary>
1834 property bool PowerOffDevicesOnStandby;
f81c0652
LOK
1835
1836 /// <summary>
1837 /// Shutdown this PC when the TV is switched off. only used when PowerOffOnStandby = false
1838 /// </summary>
f9717bcc
LOK
1839 property bool ShutdownOnStandby;
1840
1841 /// <summary>
1842 /// True to start a monitor-only client, false to start a standard client.
1843 /// </summary>
1844 property bool MonitorOnlyClient;
1845
1846 /// <summary>
1847 /// The language code of the menu language that libCEC reports to other devices.
f81c0652 1848 /// 3 character ISO 639-2 country code. see http://http://www.loc.gov/standards/iso639-2/
f9717bcc
LOK
1849 /// </summary>
1850 property System::String ^ DeviceLanguage;
1851
1852 /// <summary>
1853 /// The callback methods to use.
1854 /// </summary>
1855 property CecCallbackMethods ^ Callbacks;
22190f06
LOK
1856
1857 /// <summary>
1858 /// The build date of the firmware.
1859 /// </summary>
1860 property System::DateTime ^ FirmwareBuildDate;
1861
1862 /// <summary>
1863 /// The CEC version that libCEC uses.
1864 /// </summary>
1865 property CecVersion CECVersion;
1866
1867 /// <summary>
1868 /// The type of adapter that libCEC is connected to.
1869 /// </summary>
1870 property CecAdapterType AdapterType;
f9717bcc
LOK
1871 };
1872
1873 // the callback methods are called by unmanaged code, so we need some delegates for this
1874#pragma unmanaged
1875 // unmanaged callback methods
1876 typedef int (__stdcall *LOGCB) (const CEC::cec_log_message &message);
1877 typedef int (__stdcall *KEYCB) (const CEC::cec_keypress &key);
1878 typedef int (__stdcall *COMMANDCB)(const CEC::cec_command &command);
1879 typedef int (__stdcall *CONFIGCB) (const CEC::libcec_configuration &config);
1880 typedef int (__stdcall *ALERTCB) (const CEC::libcec_alert, const CEC::libcec_parameter &data);
1881 typedef int (__stdcall *MENUCB) (const CEC::cec_menu_state newVal);
1882 typedef void (__stdcall *ACTICB) (const CEC::cec_logical_address logicalAddress, const uint8_t bActivated);
1883
8438c41f
LOK
1884 /// <summary>
1885 /// libCEC callback methods. Unmanaged code.
1886 /// </summary>
f9717bcc
LOK
1887 typedef struct
1888 {
8438c41f
LOK
1889 /// <summary>
1890 /// Log message callback
1891 /// </summary>
f9717bcc 1892 LOGCB logCB;
8438c41f
LOK
1893 /// <summary>
1894 /// Key press/release callback
1895 /// </summary>
f9717bcc 1896 KEYCB keyCB;
8438c41f
LOK
1897 /// <summary>
1898 /// Raw CEC data callback
1899 /// </summary>
f9717bcc 1900 COMMANDCB commandCB;
8438c41f
LOK
1901 /// <summary>
1902 /// Updated configuration callback
1903 /// </summary>
f9717bcc 1904 CONFIGCB configCB;
8438c41f
LOK
1905 /// <summary>
1906 /// Alert message callback
1907 /// </summary>
f9717bcc 1908 ALERTCB alertCB;
8438c41f
LOK
1909 /// <summary>
1910 /// Menu status change callback
1911 /// </summary>
f9717bcc 1912 MENUCB menuCB;
8438c41f
LOK
1913 /// <summary>
1914 /// Source (de)activated callback
1915 /// </summary>
f9717bcc
LOK
1916 ACTICB sourceActivatedCB;
1917 } UnmanagedCecCallbacks;
1918
1919 static PLATFORM::CMutex g_callbackMutex;
1920 static std::vector<UnmanagedCecCallbacks> g_unmanagedCallbacks;
dc6366e8 1921 static CEC::ICECCallbacks g_cecCallbacks;
4ef3b314 1922
8438c41f
LOK
1923 /// <summary>
1924 /// Called by libCEC to send back a log message to the application
1925 /// </summary>
1926 /// <param name="cbParam">Pointer to the callback struct</param>
1927 /// <param name="message">The log message</param>
1928 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
1929 int CecLogMessageCB(void *cbParam, const CEC::cec_log_message &message)
1930 {
1931 if (cbParam)
1932 {
1933 size_t iPtr = (size_t)cbParam;
1934 PLATFORM::CLockObject lock(g_callbackMutex);
1935 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
1936 return g_unmanagedCallbacks[iPtr].logCB(message);
1937 }
1938 return 0;
1939 }
1940
8438c41f
LOK
1941 /// <summary>
1942 /// Called by libCEC to send back a key press or release to the application
1943 /// </summary>
1944 /// <param name="cbParam">Pointer to the callback struct</param>
1945 /// <param name="key">The key press command that libCEC received</param>
1946 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
1947 int CecKeyPressCB(void *cbParam, const CEC::cec_keypress &key)
1948 {
1949 if (cbParam)
1950 {
1951 size_t iPtr = (size_t)cbParam;
1952 PLATFORM::CLockObject lock(g_callbackMutex);
1953 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
1954 return g_unmanagedCallbacks[iPtr].keyCB(key);
1955 }
1956 return 0;
1957 }
1958
8438c41f
LOK
1959 /// <summary>
1960 /// Called by libCEC to send back raw CEC data to the application
1961 /// </summary>
1962 /// <param name="cbParam">Pointer to the callback struct</param>
1963 /// <param name="command">The raw CEC data</param>
1964 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
1965 int CecCommandCB(void *cbParam, const CEC::cec_command &command)
1966 {
1967 if (cbParam)
1968 {
1969 size_t iPtr = (size_t)cbParam;
1970 PLATFORM::CLockObject lock(g_callbackMutex);
1971 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
1972 return g_unmanagedCallbacks[iPtr].commandCB(command);
1973 }
1974 return 0;
1975 }
4ef3b314 1976
8438c41f
LOK
1977 /// <summary>
1978 /// Called by libCEC to send back an updated configuration to the application
1979 /// </summary>
1980 /// <param name="cbParam">Pointer to the callback struct</param>
1981 /// <param name="config">The new configuration</param>
1982 /// <return>1 when handled, 0 otherwise</return>
32403cc3 1983 int CecConfigCB(void *cbParam, const CEC::libcec_configuration &config)
f9717bcc
LOK
1984 {
1985 if (cbParam)
1986 {
1987 size_t iPtr = (size_t)cbParam;
1988 PLATFORM::CLockObject lock(g_callbackMutex);
1989 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
1990 return g_unmanagedCallbacks[iPtr].configCB(config);
1991 }
1992 return 0;
1993 }
1994
8438c41f
LOK
1995 /// <summary>
1996 /// Called by libCEC to send back an alert message to the application
1997 /// </summary>
1998 /// <param name="cbParam">Pointer to the callback struct</param>
1999 /// <param name="data">The alert message</param>
2000 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2001 int CecAlertCB(void *cbParam, const CEC::libcec_alert alert, const CEC::libcec_parameter &data)
2002 {
2003 if (cbParam)
2004 {
2005 size_t iPtr = (size_t)cbParam;
2006 PLATFORM::CLockObject lock(g_callbackMutex);
2007 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2008 return g_unmanagedCallbacks[iPtr].alertCB(alert, data);
2009 }
2010 return 0;
2011 }
2012
8438c41f
LOK
2013 /// <summary>
2014 /// Called by libCEC to send back a menu state change to the application
2015 /// </summary>
2016 /// <param name="cbParam">Pointer to the callback struct</param>
2017 /// <param name="newVal">The new menu state</param>
2018 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2019 int CecMenuCB(void *cbParam, const CEC::cec_menu_state newVal)
2020 {
2021 if (cbParam)
2022 {
2023 size_t iPtr = (size_t)cbParam;
2024 PLATFORM::CLockObject lock(g_callbackMutex);
2025 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
2026 return g_unmanagedCallbacks[iPtr].menuCB(newVal);
2027 }
2028 return 0;
2029 }
dc6366e8 2030
8438c41f
LOK
2031 /// <summary>
2032 /// Called by libCEC to notify the application that the source that is handled by libCEC was (de)activated
2033 /// </summary>
2034 /// <param name="cbParam">Pointer to the callback struct</param>
2035 /// <param name="logicalAddress">The logical address that was (de)activated</param>
2036 /// <param name="activated">True when activated, false when deactivated</param>
2037 void CecSourceActivatedCB(void *cbParam, const CEC::cec_logical_address logicalAddress, const uint8_t activated)
f9717bcc
LOK
2038 {
2039 if (cbParam)
2040 {
2041 size_t iPtr = (size_t)cbParam;
2042 PLATFORM::CLockObject lock(g_callbackMutex);
2043 if (iPtr >= 0 && iPtr < g_unmanagedCallbacks.size())
8438c41f 2044 g_unmanagedCallbacks[iPtr].sourceActivatedCB(logicalAddress, activated);
f9717bcc
LOK
2045 }
2046 }
2047
2048#pragma managed
1c7cd8f8
LOK
2049 /// <summary>
2050 /// Delegate method for the CecLogMessageCB callback in CecCallbackMethods
2051 /// </summary>
f9717bcc 2052 public delegate int CecLogMessageManagedDelegate(const CEC::cec_log_message &);
1c7cd8f8
LOK
2053 /// <summary>
2054 /// Delegate method for the CecKeyPressCB callback in CecCallbackMethods
2055 /// </summary>
f9717bcc 2056 public delegate int CecKeyPressManagedDelegate(const CEC::cec_keypress &);
1c7cd8f8
LOK
2057 /// <summary>
2058 /// Delegate method for the CecCommandCB callback in CecCallbackMethods
2059 /// </summary>
f9717bcc 2060 public delegate int CecCommandManagedDelegate(const CEC::cec_command &);
1c7cd8f8
LOK
2061 /// <summary>
2062 /// Delegate method for the CecConfigCB callback in CecCallbackMethods
2063 /// </summary>
f9717bcc 2064 public delegate int CecConfigManagedDelegate(const CEC::libcec_configuration &);
1c7cd8f8
LOK
2065 /// <summary>
2066 /// Delegate method for the CecAlertCB callback in CecCallbackMethods
2067 /// </summary>
f9717bcc 2068 public delegate int CecAlertManagedDelegate(const CEC::libcec_alert, const CEC::libcec_parameter &);
1c7cd8f8
LOK
2069 /// <summary>
2070 /// Delegate method for the CecMenuCB callback in CecCallbackMethods
2071 /// </summary>
2072 public delegate int CecMenuManagedDelegate(const CEC::cec_menu_state);
2073 /// <summary>
2074 /// Delegate method for the CecSourceActivatedCB callback in CecCallbackMethods
2075 /// </summary>
2076 public delegate void CecSourceActivatedManagedDelegate(const CEC::cec_logical_address, const uint8_t);
f9717bcc 2077
8438c41f
LOK
2078 /// <summary>
2079 /// Assign the callback methods in the g_cecCallbacks struct
2080 /// </summary>
f9717bcc
LOK
2081 void AssignCallbacks()
2082 {
2083 g_cecCallbacks.CBCecLogMessage = CecLogMessageCB;
2084 g_cecCallbacks.CBCecKeyPress = CecKeyPressCB;
2085 g_cecCallbacks.CBCecCommand = CecCommandCB;
2086 g_cecCallbacks.CBCecConfigurationChanged = CecConfigCB;
2087 g_cecCallbacks.CBCecAlert = CecAlertCB;
2088 g_cecCallbacks.CBCecMenuStateChanged = CecMenuCB;
2089 g_cecCallbacks.CBCecSourceActivated = CecSourceActivatedCB;
2090 }
2091
2092 /// <summary>
2093 /// The callback methods that libCEC uses
2094 /// </summary>
2095 public ref class CecCallbackMethods
2096 {
2097 public:
11fea069
LOK
2098 CecCallbackMethods(void)
2099 {
f9717bcc
LOK
2100 m_iCallbackPtr = -1;
2101 AssignCallbacks();
11fea069
LOK
2102 m_bHasCallbacks = false;
2103 m_bDelegatesCreated = false;
2104 }
4ef3b314 2105
f9717bcc 2106 ~CecCallbackMethods(void)
dc6366e8
LOK
2107 {
2108 DestroyDelegates();
2109 }
2110
8438c41f
LOK
2111 /// <summary>
2112 /// Pointer to the callbacks struct entry
2113 /// </summary>
f9717bcc
LOK
2114 size_t GetCallbackPtr(void)
2115 {
2116 PLATFORM::CLockObject lock(g_callbackMutex);
2117 return m_iCallbackPtr;
2118 }
2119
2120 protected:
2121 !CecCallbackMethods(void)
2122 {
2123 DestroyDelegates();
2124 }
2125
2126 public:
8438c41f
LOK
2127 /// <summary>
2128 /// Disable callback methods
2129 /// </summary>
f9717bcc
LOK
2130 virtual void DisableCallbacks(void)
2131 {
2132 DestroyDelegates();
2133 }
2134
8438c41f
LOK
2135 /// <summary>
2136 /// Enable callback methods
2137 /// </summary>
2138 /// <param name="callbacks">Callback methods to activate</param>
2139 /// <return>true when handled, false otherwise</return>
f9717bcc
LOK
2140 virtual bool EnableCallbacks(CecCallbackMethods ^ callbacks)
2141 {
11fea069 2142 CreateDelegates();
f9717bcc
LOK
2143 if (!m_bHasCallbacks)
2144 {
2145 m_bHasCallbacks = true;
2146 m_callbacks = callbacks;
2147 return true;
2148 }
2149
2150 return false;
2151 }
2152
2153 /// <summary>
8438c41f
LOK
2154 /// Called by libCEC to send back a log message to the application.
2155 /// Override in the application to handle this callback.
f9717bcc
LOK
2156 /// </summary>
2157 /// <param name="message">The log message</param>
8438c41f 2158 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2159 virtual int ReceiveLogMessage(CecLogMessage ^ message)
2160 {
2161 return 0;
2162 }
2163
2164 /// <summary>
8438c41f
LOK
2165 /// Called by libCEC to send back a key press or release to the application.
2166 /// Override in the application to handle this callback.
f9717bcc
LOK
2167 /// </summary>
2168 /// <param name="key">The key press command that libCEC received</param>
8438c41f 2169 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2170 virtual int ReceiveKeypress(CecKeypress ^ key)
2171 {
2172 return 0;
2173 }
2174
2175 /// <summary>
8438c41f
LOK
2176 /// Called by libCEC to send back raw CEC data to the application.
2177 /// Override in the application to handle this callback.
f9717bcc
LOK
2178 /// </summary>
2179 /// <param name="command">The raw CEC data</param>
8438c41f 2180 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2181 virtual int ReceiveCommand(CecCommand ^ command)
2182 {
2183 return 0;
2184 }
2185
2186 /// <summary>
8438c41f
LOK
2187 /// Called by libCEC to send back an updated configuration to the application.
2188 /// Override in the application to handle this callback.
f9717bcc
LOK
2189 /// </summary>
2190 /// <param name="config">The new configuration</param>
8438c41f 2191 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2192 virtual int ConfigurationChanged(LibCECConfiguration ^ config)
2193 {
2194 return 0;
2195 }
2196
2197 /// <summary>
8438c41f
LOK
2198 /// Called by libCEC to send back an alert message to the application.
2199 /// Override in the application to handle this callback.
f9717bcc
LOK
2200 /// </summary>
2201 /// <param name="data">The alert message</param>
8438c41f 2202 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2203 virtual int ReceiveAlert(CecAlert alert, CecParameter ^ data)
2204 {
2205 return 0;
2206 }
2207
2208 /// <summary>
8438c41f
LOK
2209 /// Called by libCEC to send back a menu state change to the application.
2210 /// Override in the application to handle this callback.
f9717bcc
LOK
2211 /// </summary>
2212 /// <param name="newVal">The new menu state</param>
8438c41f 2213 /// <return>1 when handled, 0 otherwise</return>
f9717bcc
LOK
2214 virtual int ReceiveMenuStateChange(CecMenuState newVal)
2215 {
2216 return 0;
2217 }
2218
2219 /// <summary>
8438c41f
LOK
2220 /// Called by libCEC to notify the application that the source that is handled by libCEC was (de)activated.
2221 /// Override in the application to handle this callback.
f9717bcc
LOK
2222 /// </summary>
2223 /// <param name="logicalAddress">The logical address that was (de)activated</param>
2224 /// <param name="activated">True when activated, false when deactivated</param>
2225 virtual void SourceActivated(CecLogicalAddress logicalAddress, bool activated)
2226 {
2227 }
2228
2229 protected:
2230 // managed callback methods
2231 int CecLogMessageManaged(const CEC::cec_log_message &message)
2232 {
2233 int iReturn(0);
2234 if (m_bHasCallbacks)
2235 iReturn = m_callbacks->ReceiveLogMessage(gcnew CecLogMessage(gcnew System::String(message.message), (CecLogLevel)message.level, message.time));
2236 return iReturn;
2237 }
2238
2239 int CecKeyPressManaged(const CEC::cec_keypress &key)
2240 {
2241 int iReturn(0);
2242 if (m_bHasCallbacks)
2243 iReturn = m_callbacks->ReceiveKeypress(gcnew CecKeypress((CecUserControlCode)key.keycode, key.duration));
2244 return iReturn;
2245 }
2246
2247 int CecCommandManaged(const CEC::cec_command &command)
2248 {
2249 int iReturn(0);
2250 if (m_bHasCallbacks)
2251 {
2252 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);
2253 for (uint8_t iPtr = 0; iPtr < command.parameters.size; iPtr++)
2254 newCommand->Parameters->PushBack(command.parameters[iPtr]);
2255 iReturn = m_callbacks->ReceiveCommand(newCommand);
2256 }
2257 return iReturn;
2258 }
2259
2260 int CecConfigManaged(const CEC::libcec_configuration &config)
2261 {
2262 int iReturn(0);
2263 if (m_bHasCallbacks)
2264 {
2265 LibCECConfiguration ^netConfig = gcnew LibCECConfiguration();
2266 netConfig->Update(config);
2267 iReturn = m_callbacks->ConfigurationChanged(netConfig);
2268 }
2269 return iReturn;
2270 }
2271
2272 int CecAlertManaged(const CEC::libcec_alert alert, const CEC::libcec_parameter &data)
2273 {
2274 int iReturn(0);
2275 if (m_bHasCallbacks)
2276 {
2277 CecParameterType newType = (CecParameterType)data.paramType;
2278 if (newType == CecParameterType::ParameterTypeString)
2279 {
2280 System::String ^ newData = gcnew System::String((const char *)data.paramData, 0, 128);
2281 CecParameter ^ newParam = gcnew CecParameter(newType, newData);
2282 iReturn = m_callbacks->ReceiveAlert((CecAlert)alert, newParam);
2283 }
2284 }
2285 return iReturn;
2286 }
2287
2288 int CecMenuManaged(const CEC::cec_menu_state newVal)
2289 {
2290 int iReturn(0);
2291 if (m_bHasCallbacks)
2292 {
2293 iReturn = m_callbacks->ReceiveMenuStateChange((CecMenuState)newVal);
2294 }
2295 return iReturn;
2296 }
2297
2298 void CecSourceActivatedManaged(const CEC::cec_logical_address logicalAddress, const uint8_t bActivated)
2299 {
2300 if (m_bHasCallbacks)
2301 m_callbacks->SourceActivated((CecLogicalAddress)logicalAddress, bActivated == 1);
2302 }
2303
2304 void DestroyDelegates()
2305 {
11fea069 2306 m_bHasCallbacks = false;
f9717bcc
LOK
2307 if (m_bDelegatesCreated)
2308 {
11fea069 2309 m_bDelegatesCreated = false;
f9717bcc
LOK
2310 m_logMessageGCHandle.Free();
2311 m_keypressGCHandle.Free();
2312 m_commandGCHandle.Free();
2313 m_alertGCHandle.Free();
2314 m_menuGCHandle.Free();
2315 m_sourceActivatedGCHandle.Free();
2316 }
2317 }
4ef3b314 2318
11fea069
LOK
2319 void CreateDelegates()
2320 {
2321 DestroyDelegates();
2322
2323 if (!m_bDelegatesCreated)
2324 {
2325 msclr::interop::marshal_context ^ context = gcnew msclr::interop::marshal_context();
2326
2327 // create the delegate method for the log message callback
dc6366e8
LOK
2328 m_logMessageDelegate = gcnew CecLogMessageManagedDelegate(this, &CecCallbackMethods::CecLogMessageManaged);
2329 m_logMessageGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_logMessageDelegate);
f9717bcc 2330 m_logMessageCallback = static_cast<LOGCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_logMessageDelegate).ToPointer());
11fea069
LOK
2331
2332 // create the delegate method for the keypress callback
dc6366e8
LOK
2333 m_keypressDelegate = gcnew CecKeyPressManagedDelegate(this, &CecCallbackMethods::CecKeyPressManaged);
2334 m_keypressGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_keypressDelegate);
f9717bcc 2335 m_keypressCallback = static_cast<KEYCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_keypressDelegate).ToPointer());
11fea069
LOK
2336
2337 // create the delegate method for the command callback
dc6366e8
LOK
2338 m_commandDelegate = gcnew CecCommandManagedDelegate(this, &CecCallbackMethods::CecCommandManaged);
2339 m_commandGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_commandDelegate);
f9717bcc 2340 m_commandCallback = static_cast<COMMANDCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_commandDelegate).ToPointer());
11fea069
LOK
2341
2342 // create the delegate method for the configuration change callback
dc6366e8
LOK
2343 m_configDelegate = gcnew CecConfigManagedDelegate(this, &CecCallbackMethods::CecConfigManaged);
2344 m_configGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_configDelegate);
f9717bcc 2345 m_configCallback = static_cast<CONFIGCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_configDelegate).ToPointer());
11fea069 2346
5ee37222 2347 // create the delegate method for the alert callback
dc6366e8
LOK
2348 m_alertDelegate = gcnew CecAlertManagedDelegate(this, &CecCallbackMethods::CecAlertManaged);
2349 m_alertGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_alertDelegate);
f9717bcc 2350 m_alertCallback = static_cast<ALERTCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_alertDelegate).ToPointer());
5ee37222 2351
c3a20edb 2352 // create the delegate method for the menu callback
dc6366e8
LOK
2353 m_menuDelegate = gcnew CecMenuManagedDelegate(this, &CecCallbackMethods::CecMenuManaged);
2354 m_menuGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_menuDelegate);
f9717bcc 2355 m_menuCallback = static_cast<MENUCB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_menuDelegate).ToPointer());
c3a20edb 2356
f9717bcc 2357 // create the delegate method for the source activated callback
dc6366e8
LOK
2358 m_sourceActivatedDelegate = gcnew CecSourceActivatedManagedDelegate(this, &CecCallbackMethods::CecSourceActivatedManaged);
2359 m_sourceActivatedGCHandle = System::Runtime::InteropServices::GCHandle::Alloc(m_sourceActivatedDelegate);
f9717bcc 2360 m_sourceActivatedCallback = static_cast<ACTICB>(System::Runtime::InteropServices::Marshal::GetFunctionPointerForDelegate(m_sourceActivatedDelegate).ToPointer());
29d5198c 2361
11fea069 2362 delete context;
dc6366e8 2363
f9717bcc
LOK
2364 UnmanagedCecCallbacks unmanagedCallbacks;
2365 unmanagedCallbacks.logCB = m_logMessageCallback;
2366 unmanagedCallbacks.keyCB = m_keypressCallback;
2367 unmanagedCallbacks.commandCB = m_commandCallback;
2368 unmanagedCallbacks.configCB = m_configCallback;
2369 unmanagedCallbacks.alertCB = m_alertCallback;
2370 unmanagedCallbacks.menuCB = m_menuCallback;
2371 unmanagedCallbacks.sourceActivatedCB = m_sourceActivatedCallback;
2372
2373 PLATFORM::CLockObject lock(g_callbackMutex);
2374 g_unmanagedCallbacks.push_back(unmanagedCallbacks);
2375 m_iCallbackPtr = g_unmanagedCallbacks.size() - 1;
2376 m_bDelegatesCreated = true;
11fea069
LOK
2377 }
2378 }
2379
f9717bcc
LOK
2380 CecLogMessageManagedDelegate ^ m_logMessageDelegate;
2381 static System::Runtime::InteropServices::GCHandle m_logMessageGCHandle;
2382 LOGCB m_logMessageCallback;
4ef3b314 2383
f9717bcc
LOK
2384 CecKeyPressManagedDelegate ^ m_keypressDelegate;
2385 static System::Runtime::InteropServices::GCHandle m_keypressGCHandle;
2386 KEYCB m_keypressCallback;
4ef3b314 2387
f9717bcc
LOK
2388 CecCommandManagedDelegate ^ m_commandDelegate;
2389 static System::Runtime::InteropServices::GCHandle m_commandGCHandle;
2390 COMMANDCB m_commandCallback;
4ef3b314 2391
f9717bcc
LOK
2392 CecConfigManagedDelegate ^ m_configDelegate;
2393 static System::Runtime::InteropServices::GCHandle m_configGCHandle;
2394 CONFIGCB m_configCallback;
32403cc3 2395
f9717bcc
LOK
2396 CecAlertManagedDelegate ^ m_alertDelegate;
2397 static System::Runtime::InteropServices::GCHandle m_alertGCHandle;
2398 ALERTCB m_alertCallback;
5ee37222 2399
f9717bcc
LOK
2400 CecMenuManagedDelegate ^ m_menuDelegate;
2401 static System::Runtime::InteropServices::GCHandle m_menuGCHandle;
2402 MENUCB m_menuCallback;
c3a20edb 2403
f9717bcc
LOK
2404 CecSourceActivatedManagedDelegate ^ m_sourceActivatedDelegate;
2405 static System::Runtime::InteropServices::GCHandle m_sourceActivatedGCHandle;
2406 ACTICB m_sourceActivatedCallback;
29d5198c 2407
f9717bcc
LOK
2408 CecCallbackMethods ^ m_callbacks;
2409 bool m_bHasCallbacks;
11fea069 2410 bool m_bDelegatesCreated;
f9717bcc
LOK
2411 size_t m_iCallbackPtr;
2412 };
4ef3b314 2413}