<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> <html xmlns="http://www.w3.org/1999/xhtml"> <head> <meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> <title>GNU Radio 3.3.0 C++ API: atsci_trellis_encoder Class Reference</title> <link href="tabs.css" rel="stylesheet" type="text/css"/> <link href="doxygen.css" rel="stylesheet" type="text/css"/> </head> <body> <!-- Generated by Doxygen 1.6.3 --> <div class="contents"> <h1>atsci_trellis_encoder Class Reference</h1><!-- doxytag: class="atsci_trellis_encoder" --> <p>fancy, schmancy 12-way interleaved trellis encoder for ATSC <a href="#_details">More...</a></p> <p><code>#include <<a class="el" href="atsci__trellis__encoder_8h_source.html">atsci_trellis_encoder.h</a>></code></p> <p><a href="classatsci__trellis__encoder-members.html">List of all members.</a></p> <table border="0" cellpadding="0" cellspacing="0"> <tr><td colspan="2"><h2>Public Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#adcf15e465af8f6f43ad997caa772417b">atsci_trellis_encoder</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a58c0b59f6a4d8dbb53ee65b7c5e0d3a6">~atsci_trellis_encoder</a> ()</td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a9e5b98f4cbc2cbcfaa831cdaa7927555">reset</a> ()</td></tr> <tr><td class="mdescLeft"> </td><td class="mdescRight">reset all encoder states <a href="#a9e5b98f4cbc2cbcfaa831cdaa7927555"></a><br/></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a6084798d2aded2665174691e1de99157">encode</a> (<a class="el" href="classatsc__data__segment.html">atsc_data_segment</a> out[<a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">NCODERS</a>], const <a class="el" href="classatsc__mpeg__packet__rs__encoded.html">atsc_mpeg_packet_rs_encoded</a> in[<a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">NCODERS</a>])</td></tr> <tr><td colspan="2"><h2>Static Public Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">NCODERS</a> = 12</td></tr> <tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#aedc38cba59a229549cdc274f13241d11">encode_helper</a> (unsigned char out[<a class="el" href="classatsci__trellis__encoder.html#afecf24b0711360dd6a939df9b90bf644">OUTPUT_SIZE</a>], const unsigned char in[<a class="el" href="classatsci__trellis__encoder.html#a650db430d766ff15c2372f3c9fba62ca">INPUT_SIZE</a>])</td></tr> <tr><td colspan="2"><h2>Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classatsci__basic__trellis__encoder.html">atsci_basic_trellis_encoder</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a3984f5c41bb9051d2bcfe98fc80a5f00">enc</a> [<a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">NCODERS</a>]</td></tr> <tr><td colspan="2"><h2>Static Protected Attributes</h2></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a3e2c569d172cf231dcc0c7e744a585d7">SEGMENT_SIZE</a> = <a class="el" href="atsc__consts_8h.html#a7c0eb90bde7d56f842375f332247c0a5">ATSC_MPEG_RS_ENCODED_LENGTH</a></td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#a650db430d766ff15c2372f3c9fba62ca">INPUT_SIZE</a> = (<a class="el" href="classatsci__trellis__encoder.html#a3e2c569d172cf231dcc0c7e744a585d7">SEGMENT_SIZE</a> * 12)</td></tr> <tr><td class="memItemLeft" align="right" valign="top">static const int </td><td class="memItemRight" valign="bottom"><a class="el" href="classatsci__trellis__encoder.html#afecf24b0711360dd6a939df9b90bf644">OUTPUT_SIZE</a> = (<a class="el" href="atsc__consts_8h.html#a06eb585fe7990a888ac9accd568c5230">ATSC_DATA_SEGMENT_LENGTH</a> * 12)</td></tr> </table> <hr/><a name="_details"></a><h2>Detailed Description</h2> <p>fancy, schmancy 12-way interleaved trellis encoder for ATSC </p> <hr/><h2>Constructor & Destructor Documentation</h2> <a class="anchor" id="adcf15e465af8f6f43ad997caa772417b"></a><!-- doxytag: member="atsci_trellis_encoder::atsci_trellis_encoder" ref="adcf15e465af8f6f43ad997caa772417b" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">atsci_trellis_encoder::atsci_trellis_encoder </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a58c0b59f6a4d8dbb53ee65b7c5e0d3a6"></a><!-- doxytag: member="atsci_trellis_encoder::~atsci_trellis_encoder" ref="a58c0b59f6a4d8dbb53ee65b7c5e0d3a6" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">atsci_trellis_encoder::~atsci_trellis_encoder </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/><h2>Member Function Documentation</h2> <a class="anchor" id="a6084798d2aded2665174691e1de99157"></a><!-- doxytag: member="atsci_trellis_encoder::encode" ref="a6084798d2aded2665174691e1de99157" args="(atsc_data_segment out[NCODERS], const atsc_mpeg_packet_rs_encoded in[NCODERS])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void atsci_trellis_encoder::encode </td> <td>(</td> <td class="paramtype"><a class="el" href="classatsc__data__segment.html">atsc_data_segment</a> </td> <td class="paramname"> <em>out</em>[NCODERS], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const <a class="el" href="classatsc__mpeg__packet__rs__encoded.html">atsc_mpeg_packet_rs_encoded</a> </td> <td class="paramname"> <em>in</em>[NCODERS]</td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td></td> </tr> </table> </div> <div class="memdoc"> <p>Take 12 RS encoded, convolutionally interleaved segments and produce 12 trellis coded data segments. We work in groups of 12 because that's the smallest number of segments that composes a single full cycle of the encoder mux. </p> </div> </div> <a class="anchor" id="aedc38cba59a229549cdc274f13241d11"></a><!-- doxytag: member="atsci_trellis_encoder::encode_helper" ref="aedc38cba59a229549cdc274f13241d11" args="(unsigned char out[OUTPUT_SIZE], const unsigned char in[INPUT_SIZE])" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void atsci_trellis_encoder::encode_helper </td> <td>(</td> <td class="paramtype">unsigned char </td> <td class="paramname"> <em>out</em>[OUTPUT_SIZE], </td> </tr> <tr> <td class="paramkey"></td> <td></td> <td class="paramtype">const unsigned char </td> <td class="paramname"> <em>in</em>[INPUT_SIZE]</td><td> </td> </tr> <tr> <td></td> <td>)</td> <td></td><td></td><td><code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a9e5b98f4cbc2cbcfaa831cdaa7927555"></a><!-- doxytag: member="atsci_trellis_encoder::reset" ref="a9e5b98f4cbc2cbcfaa831cdaa7927555" args="()" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">void atsci_trellis_encoder::reset </td> <td>(</td> <td class="paramname"></td> <td> ) </td> <td></td> </tr> </table> </div> <div class="memdoc"> <p>reset all encoder states </p> </div> </div> <hr/><h2>Member Data Documentation</h2> <a class="anchor" id="a3984f5c41bb9051d2bcfe98fc80a5f00"></a><!-- doxytag: member="atsci_trellis_encoder::enc" ref="a3984f5c41bb9051d2bcfe98fc80a5f00" args="[NCODERS]" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname"><a class="el" href="classatsci__basic__trellis__encoder.html">atsci_basic_trellis_encoder</a> <a class="el" href="classatsci__trellis__encoder.html#a3984f5c41bb9051d2bcfe98fc80a5f00">atsci_trellis_encoder::enc</a>[<a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">NCODERS</a>]<code> [protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a650db430d766ff15c2372f3c9fba62ca"></a><!-- doxytag: member="atsci_trellis_encoder::INPUT_SIZE" ref="a650db430d766ff15c2372f3c9fba62ca" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int <a class="el" href="classatsci__trellis__encoder.html#a650db430d766ff15c2372f3c9fba62ca">atsci_trellis_encoder::INPUT_SIZE</a> = (<a class="el" href="classatsci__trellis__encoder.html#a3e2c569d172cf231dcc0c7e744a585d7">SEGMENT_SIZE</a> * 12)<code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a03e72454b9a3e32233a862cae64a52a0"></a><!-- doxytag: member="atsci_trellis_encoder::NCODERS" ref="a03e72454b9a3e32233a862cae64a52a0" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int <a class="el" href="classatsci__trellis__encoder.html#a03e72454b9a3e32233a862cae64a52a0">atsci_trellis_encoder::NCODERS</a> = 12<code> [static]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="afecf24b0711360dd6a939df9b90bf644"></a><!-- doxytag: member="atsci_trellis_encoder::OUTPUT_SIZE" ref="afecf24b0711360dd6a939df9b90bf644" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int <a class="el" href="classatsci__trellis__encoder.html#afecf24b0711360dd6a939df9b90bf644">atsci_trellis_encoder::OUTPUT_SIZE</a> = (<a class="el" href="atsc__consts_8h.html#a06eb585fe7990a888ac9accd568c5230">ATSC_DATA_SEGMENT_LENGTH</a> * 12)<code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <a class="anchor" id="a3e2c569d172cf231dcc0c7e744a585d7"></a><!-- doxytag: member="atsci_trellis_encoder::SEGMENT_SIZE" ref="a3e2c569d172cf231dcc0c7e744a585d7" args="" --> <div class="memitem"> <div class="memproto"> <table class="memname"> <tr> <td class="memname">const int <a class="el" href="classatsci__trellis__encoder.html#a3e2c569d172cf231dcc0c7e744a585d7">atsci_trellis_encoder::SEGMENT_SIZE</a> = <a class="el" href="atsc__consts_8h.html#a7c0eb90bde7d56f842375f332247c0a5">ATSC_MPEG_RS_ENCODED_LENGTH</a><code> [static, protected]</code></td> </tr> </table> </div> <div class="memdoc"> </div> </div> <hr/>The documentation for this class was generated from the following file:<ul> <li><a class="el" href="atsci__trellis__encoder_8h_source.html">atsci_trellis_encoder.h</a></li> </ul> </div> <hr class="footer"/><address style="text-align: right;"><small>Generated on Wed Dec 29 19:52:31 2010 for GNU Radio 3.3.0 C++ API by <a href="http://www.doxygen.org/index.html"> <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.3 </small></address> </body> </html>