src/LibCecSharp/CecSharpTypes.h

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