Libdabdemod - Revision history

Albrechtl: Added flow charts

2016-02-15T20:06:43Z

Added flow charts

Albrechtl: /* API Description */ Add description

2016-02-10T21:16:17Z

API Description: Add description

Albrechtl: /* API Description */ Added class LibDABDemod

2016-02-10T21:06:18Z

API Description: Added class LibDABDemod

Albrechtl: /* API Description */ Some minor changes

2016-02-10T21:04:15Z

API Description: Some minor changes

Albrechtl: /* API Description */ Add AddServiceComponent() description

2016-02-10T20:47:46Z

API Description: Add AddServiceComponent() description

Albrechtl: Initial page

2016-02-09T21:55:36Z

Initial page

New page

=API Description=

<code>DemodError SetDevice(LibSDRSource* libSDRSource)</code>
{| class="wikitable"
|-
| '''Description'''
| Sets the SDR driver source from the library libsdrsource.
|-
| '''Parameter'''
| libSDRSource: libsdrsource object
|-
| '''return'''
| Error code enum object
|}

<code>DemodError OpenDevice(void)</code>
{| class="wikitable"
|-
| '''Description'''
| Opens the device
|-
| '''Parameter'''
| none
|-
| '''return'''
| Error code enum object
|}

<code>DemodError CloseDevice(void)</code>
{| class="wikitable"
|-
| '''Description'''
| Closes the device
|-
| '''Parameter'''
| none
|-
| '''return'''
| Error code enum object
|}

<code>DemodError Start(void)</code>
{| class="wikitable"
|-
| '''Description'''
| Starts the OFDM demodulation
|-
| '''Parameter'''
| none
|-
| '''return'''
| Error code enum object
|}

<code>DemodError Stop(void)</code>
{| class="wikitable"
|-
| '''Description'''
| Stops the OFDM demodulation
|-
| '''Parameter'''
| none
|-
| '''return'''
| Error code enum object
|}

<code>DemodError SetFrequency(int32_t FrequencyKHz)</code>
{| class="wikitable"
|-
| '''Description'''
| Sets the channel frequency in kHz
|-
| '''Parameter'''
| ''FrequencyKHz'': Channel frequency in kHz
|-
| '''return'''
| Error code enum object
|}

<code>DemodError SetChannel(string Channel)</code>
{| class="wikitable"
|-
| '''Description'''
| Sets the channel (Band III: 5A to 13F; L band: LA to LP)
|-
| '''Parameter'''
| ''Channel'': Channel string e.g.
|-
| '''return'''
| Error code enum object
|}

<code>DemodError GetFrequency(int32_t* FrequencyKHz)</code>
{| class="wikitable"
|-
| '''Description'''
| Gets the current frequency
|-
| '''Parameter'''
| ''FrequencyKHz'': Pointer to frequency in KHz
|-
| '''return'''
| Error code enum object
|}

<code>DemodError GetChannel(string* Channel)</code>
{| class="wikitable"
|-
| '''Description'''
| Gets the current channel
|-
| '''Parameter'''
| ''Channel'': Channel string e.g. “5A”
|-
| '''return'''
| Error code enum object
|}

<code>DemodError GetSignalStatus(CSignalStatus* SignalStatus)</code>
{| class="wikitable"
|-
| '''Description'''
| Gets the current signal status
|-
| '''Parameter'''
| ''SignalStatus'': Pinter to signal status object.
|-
| '''return'''
| Error code enum object
|}

<code>DemodError RemoveServiceComponent(CServiceComponent ServiceComponent)</code>
{| class="wikitable"
|-
| '''Description'''
| Removes a selected service component
|-
| '''Parameter'''
| ''ServiceComponent'': Service component object
|-
| '''return'''
| Error code enum object
|}

<code>CServiceComponent AddServiceComponent(char mode, char SubChId, short StartCU, char UEP_EEP, char UEPTabldx, char EEPIdx, short CUNum, short PacketAddr, char FECScheme)</code>
{| class="wikitable"
|-
| '''Description'''
| Adds a service component
|-
| '''Parameter'''
| Mode: TBD 
SubChId: TBD 
StartCU: TBD 
UEP_EEP: TBD 
UEPTabldx: TBD 
EEPIdx: TBD 
CUNum: TBD 
PacketAddr: TBD 
FECScheme: TBD 
|-
| '''return'''
| Service component object, NULL if an error occurred
|}

<code>DemodError GetServiceData(CServiceComponent ServiceComponent, CServiceData &ServiceData)</code>
{| class="wikitable"
|-
| '''Description'''
| Gets the data of a selected service channel. This method is blocking. It blocks until new data is available.
|-
| '''Parameter'''
| ''ServiceComponent'': Service component buffer
|-
| '''return'''
| Error code enum object
|}

<code>DemodError GetFICData(CFICData &FICData)</code>
{| class="wikitable"
|-
| '''Description'''
| Gets the FIC data. This method is blocking. It blocks until new data is available.
|-
| '''Parameter'''
| ''FICData'': FIC data buffer
|-
| '''return'''
| Error code enum object
|}

@@ Line 2: / Line 2: @@
 libdabdemod is a library that demodulates the digital OFDM DAB signal and outputs the digital DAB stream.
 At the moment this library is in the concept phase.
 =API Description=

← Older revision		Revision as of 21:16, 10 February 2016
Line 1:		Line 1:
		+	=Introduction=
		+	libdabdemod is a library that demodulates the digital OFDM DAB signal and outputs the digital DAB stream.
		+	At the moment this library is in the concept phase.
		+
	=API Description=		=API Description=

@@ Line 162: / Line 162: @@
 |-
 | '''Parameter'''
-| Mode: DAB Mode. 0: DAB audio, 1: DAB+ audio, 2: packet, 3: stream<br/>
+| ''Mode'': DAB Mode. 0: DAB audio, 1: DAB+ audio, 2: packet, 3: stream<br/>
-SubChId: Sub-channel identifier<br/>
+''SubChId'': Sub-channel identifier<br/>
-StartCU: Address the first Capacity Unit (CU) of the sub-channel<br/>
+''StartCU'': Address the first Capacity Unit (CU) of the sub-channel<br/>
-UEP_EEP: Short or the long form of the size and protection field. 0: short form (UEP), 1: long form (EEP)<br/>
+''UEP_EEP'': Short or the long form of the size and protection field. 0: short form (UEP), 1: long form (EEP)<br/>
-UEPTabldx: UEP Table index. Only used if UEP_EEP=0<br/>
+''UEPTabldx'': UEP Table index. Only used if UEP_EEP=0<br/>
-EEPIdx: Protection level. Only used if UEP_EEP=1<br/>
+''EEPIdx'': Protection level. Only used if UEP_EEP=1<br/>
-CUNum: Sub-channel size (CUs)<br/>
+''CUNum'': Sub-channel size (CUs)<br/>
-PacketAddr: Address of the packet in which the service component is carried<br/>
+''PacketAddr'': Address of the packet in which the service component is carried<br/>
-FECScheme: FEC Scheme<br/>
+''FECScheme'': FEC Scheme<br/>
 |-
 | '''return'''

@@ Line 162: / Line 162: @@
 |-
 | '''Parameter'''
-| Mode: TBD<br/>
+| Mode: DAB Mode. 0: DAB audio, 1: DAB+ audio, 2: packet, 3: stream<br/>
-SubChId: TBD<br/>
+SubChId: Sub-channel identifier<br/>
-StartCU: TBD<br/>
+StartCU: Address the first Capacity Unit (CU) of the sub-channel<br/>
-UEP_EEP: TBD<br/>
+UEP_EEP: Short or the long form of the size and protection field. 0: short form (UEP), 1: long form (EEP)<br/>
-UEPTabldx: TBD<br/>
+UEPTabldx: UEP Table index. Only used if UEP_EEP=0<br/>
-EEPIdx: TBD<br/>
+EEPIdx: Protection level. Only used if UEP_EEP=1<br/>
-CUNum: TBD<br/>
+CUNum: Sub-channel size (CUs)<br/>
-PacketAddr: TBD<br/>
+PacketAddr: Address of the packet in which the service component is carried<br/>
-FECScheme: TBD<br/>
+FECScheme: FEC Scheme<br/>
 |-
 | '''return'''
 | Service component object, NULL if an error occurred
 |}

@@ Line 1: / Line 1: @@
 =API Description=
-  <code>DemodError SetDevice(LibSDRSource* libSDRSource)</code>
+  <code>DemodError LibDABDemod::SetDevice(LibSDRSource* libSDRSource)</code>
 {| class="wikitable"
 |-
@@ Line 15: / Line 15: @@
-  <code>DemodError OpenDevice(void)</code>
+  <code>DemodError LibDABDemod::OpenDevice(void)</code>
 {| class="wikitable"
 |-
@@ Line 29: / Line 29: @@
-  <code>DemodError CloseDevice(void)</code>
+  <code>DemodError LibDABDemod::CloseDevice(void)</code>
 {| class="wikitable"
 |-
@@ Line 43: / Line 43: @@
-  <code>DemodError Start(void)</code>
+  <code>DemodError LibDABDemod::Start(void)</code>
 {| class="wikitable"
 |-
@@ Line 57: / Line 57: @@
-  <code>DemodError Stop(void)</code>
+  <code>DemodError LibDABDemod::Stop(void)</code>
 {| class="wikitable"
 |-
@@ Line 71: / Line 71: @@
-  <code>DemodError SetFrequency(int32_t FrequencyKHz)</code>
+  <code>DemodError LibDABDemod::SetFrequency(int32_t FrequencyKHz)</code>
 {| class="wikitable"
 |-
@@ Line 85: / Line 85: @@
-   <code>DemodError SetChannel(string Channel)</code>
+   <code>DemodError LibDABDemod::SetChannel(string Channel)</code>
 {| class="wikitable"
 |-
@@ Line 99: / Line 99: @@
-  <code>DemodError GetFrequency(int32_t* FrequencyKHz)</code>
+  <code>DemodError LibDABDemod::GetFrequency(int32_t* FrequencyKHz)</code>
 {| class="wikitable"
 |-
@@ Line 113: / Line 113: @@
-  <code>DemodError GetChannel(string* Channel)</code>
+  <code>DemodError LibDABDemod::GetChannel(string* Channel)</code>
 {| class="wikitable"
 |-
@@ Line 127: / Line 127: @@
-  <code>DemodError GetSignalStatus(CSignalStatus* SignalStatus)</code>
+  <code>DemodError LibDABDemod::GetSignalStatus(CSignalStatus* SignalStatus)</code>
 {| class="wikitable"
 |-
@@ Line 141: / Line 141: @@
-  <code>DemodError RemoveServiceComponent(CServiceComponent ServiceComponent)</code>
+  <code>DemodError LibDABDemod::RemoveServiceComponent(CServiceComponent ServiceComponent)</code>
 {| class="wikitable"
 |-
@@ Line 155: / Line 155: @@
-  <code>CServiceComponent AddServiceComponent(char mode, char SubChId, short StartCU, char UEP_EEP, char UEPTabldx, char EEPIdx, short CUNum, short PacketAddr, char FECScheme)</code>
+  <code>CServiceComponent LibDABDemod::AddServiceComponent(char mode, char SubChId, short StartCU, char UEP_EEP, char UEPTabldx, char EEPIdx, short CUNum, short PacketAddr, char FECScheme)</code>
 {| class="wikitable"
 |-
@@ Line 178: / Line 178: @@
-  <code>DemodError GetServiceData(CServiceComponent ServiceComponent, CServiceData &ServiceData)</code>
+  <code>DemodError LibDABDemod::GetServiceData(CServiceComponent ServiceComponent, CServiceData &ServiceData)</code>
 {| class="wikitable"
 |-
@@ Line 192: / Line 192: @@
-  <code>DemodError GetFICData(CFICData &FICData)</code>
+  <code>DemodError LibDABDemod::GetFICData(CFICData &FICData)</code>
 {| class="wikitable"
 |-