/usr/share/doc/libucommon-dev/a00026.html is in libucommon-doc 3.2.0-0ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 | <!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>UCommon: ucc::audiocodec 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="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
<li><a href="examples.html"><span>Examples</span></a></li>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="a00214.html">ucc</a>::<a class="el" href="a00026.html">audiocodec</a>
</div>
</div>
<div class="contents">
<h1>ucc::audiocodec Class Reference</h1><!-- doxytag: class="ucc::audiocodec" --><!-- doxytag: inherits="ucc::LinkedObject,ucc::audio" -->
<p>Convert audio media.
<a href="#_details">More...</a></p>
<p><code>#include <<a class="el" href="a00187_source.html">audio.h</a>></code></p>
<div class="dynheader">
Inheritance diagram for ucc::audiocodec:</div>
<div class="dynsection">
<div class="center"><img src="a00353.png" border="0" usemap="#ucc_1_1audiocodec_inherit__map" alt="Inheritance graph"/></div>
<map name="ucc_1_1audiocodec_inherit__map" id="ucc_1_1audiocodec_inherit__map">
<area shape="rect" id="node2" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="5,83,139,112"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="25,5,119,35"/><area shape="rect" id="node6" href="a00023.html" title="Common audio class for GNU telephonic audio." alt="" coords="163,83,248,112"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for ucc::audiocodec:</div>
<div class="dynsection">
<div class="center"><img src="a00354.png" border="0" usemap="#ucc_1_1audiocodec_coll__map" alt="Collaboration graph"/></div>
<map name="ucc_1_1audiocodec_coll__map" id="ucc_1_1audiocodec_coll__map">
<area shape="rect" id="node2" href="a00069.html" title="Common base class for all objects that can be formed into a linked list." alt="" coords="5,96,139,125"/><area shape="rect" id="node4" href="a00093.html" title="A common base class for all managed objects." alt="" coords="25,5,119,35"/><area shape="rect" id="node7" href="a00023.html" title="Common audio class for GNU telephonic audio." alt="" coords="216,96,301,125"/></map>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>
<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">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a147d8beb25c73d0af45d497c3fc4ca53">autype</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get autype number for .au files, if exists. <a href="#a147d8beb25c73d0af45d497c3fc4ca53"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00026.html">audiocodec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a25d878f2ea4a29c84a19872b4fe135ef">basetype</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Basic codec type we are derived from. <a href="#a25d878f2ea4a29c84a19872b4fe135ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00026.html">audiocodec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a03417d80dc4968b309e799f36326239e">create</a> (caddr_t destination=((void *) 0), <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> framing=0)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Derived copy operation. <a href="#a03417d80dc4968b309e799f36326239e"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#aa8fb6d2a8f188198cadbabaac3fa8e9d">decode</a> (encoded_t encoded, linear_t linear)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert codec to linear data format. <a href="#aa8fb6d2a8f188198cadbabaac3fa8e9d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a0efec813aef48660b480c40905d9d854">encode</a> (linear_t linear, encoded_t encoded)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Convert linear data to codec format. <a href="#a0efec813aef48660b480c40905d9d854"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a2e6e6eaf8f8e6edd2c37847465e85110">getActual</a> (audio::encoded_t encoded)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get actual size of frame from frame header data. <a href="#a2e6e6eaf8f8e6edd2c37847465e85110"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a80d4825b3fc4cd777b193f695a348458">getAlignment</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get data alignment requirements for direct i/o operations. <a href="#a80d4825b3fc4cd777b193f695a348458"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a5d3cb70437d22f296cfd575f5f37d2ef">getBuffered</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get constant frame size if fixed, otherwise 0 if variable framing. <a href="#a5d3cb70437d22f296cfd575f5f37d2ef"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#ad522de179aff82e7350bc03a5fa438e7">getBuffering</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the buffer size we use. <a href="#ad522de179aff82e7350bc03a5fa438e7"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a7c5b65295e31449e42d03d711e51982d">getChannels</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get channel count for format. <a href="#a7c5b65295e31449e42d03d711e51982d"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned long </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a4a864333a11aa7aeeb83912b636d3ad8">getClock</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get the effective clock speed. <a href="#a4a864333a11aa7aeeb83912b636d3ad8"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a828f3cc712c0574365ad50e6270689e0">getFraming</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get time impulse of frame. <a href="#a828f3cc712c0574365ad50e6270689e0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a86c8b2ff872ce00152ae2a46268deb55">getMaximum</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get maximum frame size for a given frame time. <a href="#a86c8b2ff872ce00152ae2a46268deb55"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#aaa4ea0dbfb4fde46475d77283cedb935">getMinimum</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get minimum i/o transfer size to determine frame size when variable framing is used. <a href="#aaa4ea0dbfb4fde46475d77283cedb935"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual char * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a1ba29fa4bd50a4c89fc49234a7a06cf0">getName</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get codec name. <a href="#a1ba29fa4bd50a4c89fc49234a7a06cf0"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual unsigned </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a18ab63ec7ec9fdf78dbf690c4f2ae8f9">getSize</a> (void)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get effective size of codec, including any additional buffering needed to support the object if staged buffering is needed. <a href="#a18ab63ec7ec9fdf78dbf690c4f2ae8f9"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a68fc0462a4326877762233d1f1d49642">reset</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Reset state information. <a href="#a68fc0462a4326877762233d1f1d49642"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">virtual bool </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#af2bdc203630acc9cd146adc36f6c0575">test</a> (char *name)=0</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Test by name or extension matching. <a href="#af2bdc203630acc9cd146adc36f6c0575"></a><br/></td></tr>
<tr><td colspan="2"><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00026.html">audiocodec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a5bdddfc52eb8ce27d0e6fe16ee4470f2">find</a> (char *name, <a class="el" href="a00026.html">audiocodec</a> *channel=((void *) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Find codec by family name. <a href="#a5bdddfc52eb8ce27d0e6fe16ee4470f2"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00026.html">audiocodec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#ab200b68c6ef3ed28769b1025aef3699f">first</a> (void)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get a listing of installed plugins. <a href="#ab200b68c6ef3ed28769b1025aef3699f"></a><br/></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">static <a class="el" href="a00026.html">audiocodec</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="a00026.html#a308bc92ececa48229723288ce89a2ec8">get</a> (char *name, <a class="el" href="a00026.html">audiocodec</a> *channel=((void *) 0))</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Get an instance of a audiocodec by family name. <a href="#a308bc92ececa48229723288ce89a2ec8"></a><br/></td></tr>
<tr><td colspan="2"><h2>Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a451089a28f5cf813034fca6cdd8d59ff"></a><!-- doxytag: member="ucc::audiocodec::type" ref="a451089a28f5cf813034fca6cdd8d59ff" args="" -->
type_t </td><td class="memItemRight" valign="bottom"><b>type</b></td></tr>
<tr><td colspan="2"><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a2263d68866118e182a4a08c0c6ae8d34"></a><!-- doxytag: member="ucc::audiocodec::audiocodec" ref="a2263d68866118e182a4a08c0c6ae8d34" args="(audiocodec *original)" -->
</td><td class="memItemRight" valign="bottom"><b>audiocodec</b> (<a class="el" href="a00026.html">audiocodec</a> *original)</td></tr>
<tr><td colspan="2"><h2>Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99a8ff3eed3367f5881026d946398f53"></a><!-- doxytag: member="ucc::audiocodec::framing" ref="a99a8ff3eed3367f5881026d946398f53" args="" -->
<a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td><td class="memItemRight" valign="bottom"><b>framing</b></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a09d8ce647209cd8e90cb126accf0a4c3"></a><!-- doxytag: member="ucc::audiocodec::rate" ref="a09d8ce647209cd8e90cb126accf0a4c3" args="" -->
unsigned long </td><td class="memItemRight" valign="bottom"><b>rate</b></td></tr>
<tr><td colspan="2"><h2>Friends</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a5bc0385c35d37e9c1e4abaf769908d63"></a><!-- doxytag: member="ucc::audiocodec::audiobuffer" ref="a5bc0385c35d37e9c1e4abaf769908d63" args="" -->
class </td><td class="memItemRight" valign="bottom"><b>audiobuffer</b></td></tr>
</table>
<hr/><a name="_details"></a><h2>Detailed Description</h2>
<p>Convert audio media. </p>
<p>This class is derived into media encoding format specific derived codec classes to support transcoding audio, usually to and from ulaw or linear audio frames. </p>
<dl class="author"><dt><b>Author:</b></dt><dd>David Sugar <<a href="mailto:dyfet@gnutelephony.org">dyfet@gnutelephony.org</a>> </dd></dl>
<p>Definition at line <a class="el" href="a00187_source.html#l00115">115</a> of file <a class="el" href="a00187_source.html">audio.h</a>.</p>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a147d8beb25c73d0af45d497c3fc4ca53"></a><!-- doxytag: member="ucc::audiocodec::autype" ref="a147d8beb25c73d0af45d497c3fc4ca53" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::autype </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get autype number for .au files, if exists. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>autype or 0 if not valid for au files. </dd></dl>
</div>
</div>
<a class="anchor" id="a25d878f2ea4a29c84a19872b4fe135ef"></a><!-- doxytag: member="ucc::audiocodec::basetype" ref="a25d878f2ea4a29c84a19872b4fe135ef" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00026.html">audiocodec</a>* ucc::audiocodec::basetype </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Basic codec type we are derived from. </p>
<p>This is a pointer to a static object and is a kind of "type" system. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>base object type pointer. </dd></dl>
</div>
</div>
<a class="anchor" id="a03417d80dc4968b309e799f36326239e"></a><!-- doxytag: member="ucc::audiocodec::create" ref="a03417d80dc4968b309e799f36326239e" args="(caddr_t destination=((void *) 0), timeout_t framing=0)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00026.html">audiocodec</a>* ucc::audiocodec::create </td>
<td>(</td>
<td class="paramtype">caddr_t </td>
<td class="paramname"> <em>destination</em> = <code>((void *) 0)</code>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> </td>
<td class="paramname"> <em>framing</em> = <code>0</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Derived copy operation. </p>
<p>This is used to create a new local instance with initialized state inside another object. Commonly used to embed a codec into an audio buffer. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>destination</em> </td><td>address to create object in, NULL if new. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>framing</em> </td><td>to use if inserting a streaming codec. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>address of object created. </dd></dl>
</div>
</div>
<a class="anchor" id="aa8fb6d2a8f188198cadbabaac3fa8e9d"></a><!-- doxytag: member="ucc::audiocodec::decode" ref="aa8fb6d2a8f188198cadbabaac3fa8e9d" args="(encoded_t encoded, linear_t linear)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::decode </td>
<td>(</td>
<td class="paramtype">encoded_t </td>
<td class="paramname"> <em>encoded</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">linear_t </td>
<td class="paramname"> <em>linear</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert codec to linear data format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>encoded</em> </td><td>samples to convert. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>linear</em> </td><td>result. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>bytes encoded out. </dd></dl>
</div>
</div>
<a class="anchor" id="a0efec813aef48660b480c40905d9d854"></a><!-- doxytag: member="ucc::audiocodec::encode" ref="a0efec813aef48660b480c40905d9d854" args="(linear_t linear, encoded_t encoded)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::encode </td>
<td>(</td>
<td class="paramtype">linear_t </td>
<td class="paramname"> <em>linear</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">encoded_t </td>
<td class="paramname"> <em>encoded</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Convert linear data to codec format. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>linear</em> </td><td>samples to convert. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>encoded</em> </td><td>result. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>bytes encoded out. </dd></dl>
</div>
</div>
<a class="anchor" id="a5bdddfc52eb8ce27d0e6fe16ee4470f2"></a><!-- doxytag: member="ucc::audiocodec::find" ref="a5bdddfc52eb8ce27d0e6fe16ee4470f2" args="(char *name, audiocodec *channel=((void *) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00026.html">audiocodec</a>* ucc::audiocodec::find </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00026.html">audiocodec</a> * </td>
<td class="paramname"> <em>channel</em> = <code>((void *) 0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Find codec by family name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>or extension to search for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>codec property to optionally match with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>codec object to use. </dd></dl>
</div>
</div>
<a class="anchor" id="ab200b68c6ef3ed28769b1025aef3699f"></a><!-- doxytag: member="ucc::audiocodec::first" ref="ab200b68c6ef3ed28769b1025aef3699f" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00026.html">audiocodec</a>* ucc::audiocodec::first </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get a listing of installed plugins. </p>
<p>This can be walked with the linked_pointer<> template. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>list of plugins. </dd></dl>
</div>
</div>
<a class="anchor" id="a308bc92ececa48229723288ce89a2ec8"></a><!-- doxytag: member="ucc::audiocodec::get" ref="a308bc92ececa48229723288ce89a2ec8" args="(char *name, audiocodec *channel=((void *) 0))" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="el" href="a00026.html">audiocodec</a>* ucc::audiocodec::get </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="a00026.html">audiocodec</a> * </td>
<td class="paramname"> <em>channel</em> = <code>((void *) 0)</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get an instance of a audiocodec by family name. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>or extension to search for. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>channel</em> </td><td>codec property to optionally match with. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>codec instance to use. </dd></dl>
</div>
</div>
<a class="anchor" id="a2e6e6eaf8f8e6edd2c37847465e85110"></a><!-- doxytag: member="ucc::audiocodec::getActual" ref="a2e6e6eaf8f8e6edd2c37847465e85110" args="(audio::encoded_t encoded)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getActual </td>
<td>(</td>
<td class="paramtype">audio::encoded_t </td>
<td class="paramname"> <em>encoded</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get actual size of frame from frame header data. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>encoded</em> </td><td>audio frame. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of encoded frame. </dd></dl>
</div>
</div>
<a class="anchor" id="a80d4825b3fc4cd777b193f695a348458"></a><!-- doxytag: member="ucc::audiocodec::getAlignment" ref="a80d4825b3fc4cd777b193f695a348458" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getAlignment </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get data alignment requirements for direct i/o operations. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>data alignment or 0. </dd></dl>
</div>
</div>
<a class="anchor" id="a5d3cb70437d22f296cfd575f5f37d2ef"></a><!-- doxytag: member="ucc::audiocodec::getBuffered" ref="a5d3cb70437d22f296cfd575f5f37d2ef" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getBuffered </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get constant frame size if fixed, otherwise 0 if variable framing. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>constant frame size or 0. </dd></dl>
</div>
</div>
<a class="anchor" id="ad522de179aff82e7350bc03a5fa438e7"></a><!-- doxytag: member="ucc::audiocodec::getBuffering" ref="ad522de179aff82e7350bc03a5fa438e7" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getBuffering </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the buffer size we use. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a7c5b65295e31449e42d03d711e51982d"></a><!-- doxytag: member="ucc::audiocodec::getChannels" ref="a7c5b65295e31449e42d03d711e51982d" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getChannels </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get channel count for format. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>number of channels. </dd></dl>
</div>
</div>
<a class="anchor" id="a4a864333a11aa7aeeb83912b636d3ad8"></a><!-- doxytag: member="ucc::audiocodec::getClock" ref="a4a864333a11aa7aeeb83912b636d3ad8" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned long ucc::audiocodec::getClock </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get the effective clock speed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>effective clock rate. </dd></dl>
</div>
</div>
<a class="anchor" id="a828f3cc712c0574365ad50e6270689e0"></a><!-- doxytag: member="ucc::audiocodec::getFraming" ref="a828f3cc712c0574365ad50e6270689e0" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual <a class="el" href="a00201.html#af412159e5cef839836a5e7b19ee75d1c">timeout_t</a> ucc::audiocodec::getFraming </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get time impulse of frame. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>actual framing that will be used. </dd></dl>
</div>
</div>
<a class="anchor" id="a86c8b2ff872ce00152ae2a46268deb55"></a><!-- doxytag: member="ucc::audiocodec::getMaximum" ref="a86c8b2ff872ce00152ae2a46268deb55" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getMaximum </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get maximum frame size for a given frame time. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>maximum size of frame for framing, or 0 if invalid. </dd></dl>
</div>
</div>
<a class="anchor" id="aaa4ea0dbfb4fde46475d77283cedb935"></a><!-- doxytag: member="ucc::audiocodec::getMinimum" ref="aaa4ea0dbfb4fde46475d77283cedb935" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getMinimum </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get minimum i/o transfer size to determine frame size when variable framing is used. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>same as maximum if fixed framing, else minimum io. </dd></dl>
</div>
</div>
<a class="anchor" id="a1ba29fa4bd50a4c89fc49234a7a06cf0"></a><!-- doxytag: member="ucc::audiocodec::getName" ref="a1ba29fa4bd50a4c89fc49234a7a06cf0" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual char* ucc::audiocodec::getName </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get codec name. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>name of codec. </dd></dl>
</div>
</div>
<a class="anchor" id="a18ab63ec7ec9fdf78dbf690c4f2ae8f9"></a><!-- doxytag: member="ucc::audiocodec::getSize" ref="a18ab63ec7ec9fdf78dbf690c4f2ae8f9" args="(void)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual unsigned ucc::audiocodec::getSize </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Get effective size of codec, including any additional buffering needed to support the object if staged buffering is needed. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>size of object + buffer. </dd></dl>
</div>
</div>
<a class="anchor" id="a68fc0462a4326877762233d1f1d49642"></a><!-- doxytag: member="ucc::audiocodec::reset" ref="a68fc0462a4326877762233d1f1d49642" args="(void)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual void ucc::audiocodec::reset </td>
<td>(</td>
<td class="paramtype">void </td>
<td class="paramname"></td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Reset state information. </p>
<p>This is used to clear lookahead states when switching files or streams. </p>
</div>
</div>
<a class="anchor" id="af2bdc203630acc9cd146adc36f6c0575"></a><!-- doxytag: member="ucc::audiocodec::test" ref="af2bdc203630acc9cd146adc36f6c0575" args="(char *name)=0" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual bool ucc::audiocodec::test </td>
<td>(</td>
<td class="paramtype">char * </td>
<td class="paramname"> <em>name</em></td>
<td> ) </td>
<td><code> [pure virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Test by name or extension matching. </p>
<dl><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>name</em> </td><td>to check. </td></tr>
</table>
</dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>true if this is us. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>ucommon/<a class="el" href="a00187_source.html">audio.h</a></li>
</ul>
</div>
<hr class="footer"/><address style="text-align: right;"><small>Generated on Tue Jul 6 08:22:25 2010 for UCommon 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>
|