[313] | 1 | /* The copyright in this software is being made available under the BSD |
---|
| 2 | * License, included below. This software may be subject to other third party |
---|
| 3 | * and contributor rights, including patent rights, and no such rights are |
---|
[1029] | 4 | * granted under this license. |
---|
[313] | 5 | * |
---|
[1259] | 6 | * Copyright (c) 2010-2015, ITU/ISO/IEC |
---|
[313] | 7 | * All rights reserved. |
---|
| 8 | * |
---|
| 9 | * Redistribution and use in source and binary forms, with or without |
---|
| 10 | * modification, are permitted provided that the following conditions are met: |
---|
| 11 | * |
---|
| 12 | * * Redistributions of source code must retain the above copyright notice, |
---|
| 13 | * this list of conditions and the following disclaimer. |
---|
| 14 | * * Redistributions in binary form must reproduce the above copyright notice, |
---|
| 15 | * this list of conditions and the following disclaimer in the documentation |
---|
| 16 | * and/or other materials provided with the distribution. |
---|
| 17 | * * Neither the name of the ITU/ISO/IEC nor the names of its contributors may |
---|
| 18 | * be used to endorse or promote products derived from this software without |
---|
| 19 | * specific prior written permission. |
---|
| 20 | * |
---|
| 21 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
---|
| 22 | * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
---|
| 23 | * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
---|
| 24 | * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS |
---|
| 25 | * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
---|
| 26 | * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
---|
| 27 | * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
---|
| 28 | * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
---|
| 29 | * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
---|
| 30 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF |
---|
| 31 | * THE POSSIBILITY OF SUCH DAMAGE. |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | /** \file TEncBinCoderCABAC.cpp |
---|
| 35 | \brief binary entropy encoder of CABAC |
---|
| 36 | */ |
---|
| 37 | |
---|
| 38 | #include "TEncBinCoderCABAC.h" |
---|
| 39 | #include "TLibCommon/TComRom.h" |
---|
[1029] | 40 | #include "TLibCommon/Debug.h" |
---|
[313] | 41 | |
---|
| 42 | //! \ingroup TLibEncoder |
---|
| 43 | //! \{ |
---|
| 44 | |
---|
| 45 | |
---|
| 46 | TEncBinCABAC::TEncBinCABAC() |
---|
| 47 | : m_pcTComBitIf( 0 ) |
---|
| 48 | , m_binCountIncrement( 0 ) |
---|
| 49 | #if FAST_BIT_EST |
---|
| 50 | , m_fracBits( 0 ) |
---|
| 51 | #endif |
---|
| 52 | { |
---|
| 53 | } |
---|
| 54 | |
---|
| 55 | TEncBinCABAC::~TEncBinCABAC() |
---|
| 56 | { |
---|
| 57 | } |
---|
| 58 | |
---|
| 59 | Void TEncBinCABAC::init( TComBitIf* pcTComBitIf ) |
---|
| 60 | { |
---|
| 61 | m_pcTComBitIf = pcTComBitIf; |
---|
| 62 | } |
---|
| 63 | |
---|
| 64 | Void TEncBinCABAC::uninit() |
---|
| 65 | { |
---|
| 66 | m_pcTComBitIf = 0; |
---|
| 67 | } |
---|
| 68 | |
---|
| 69 | Void TEncBinCABAC::start() |
---|
| 70 | { |
---|
| 71 | m_uiLow = 0; |
---|
| 72 | m_uiRange = 510; |
---|
| 73 | m_bitsLeft = 23; |
---|
| 74 | m_numBufferedBytes = 0; |
---|
| 75 | m_bufferedByte = 0xff; |
---|
[1029] | 76 | #if FAST_BIT_EST |
---|
| 77 | m_fracBits = 0; |
---|
| 78 | #endif |
---|
[313] | 79 | } |
---|
| 80 | |
---|
| 81 | Void TEncBinCABAC::finish() |
---|
| 82 | { |
---|
| 83 | if ( m_uiLow >> ( 32 - m_bitsLeft ) ) |
---|
| 84 | { |
---|
| 85 | //assert( m_numBufferedBytes > 0 ); |
---|
| 86 | //assert( m_bufferedByte != 0xff ); |
---|
| 87 | m_pcTComBitIf->write( m_bufferedByte + 1, 8 ); |
---|
| 88 | while ( m_numBufferedBytes > 1 ) |
---|
| 89 | { |
---|
| 90 | m_pcTComBitIf->write( 0x00, 8 ); |
---|
| 91 | m_numBufferedBytes--; |
---|
| 92 | } |
---|
| 93 | m_uiLow -= 1 << ( 32 - m_bitsLeft ); |
---|
| 94 | } |
---|
| 95 | else |
---|
| 96 | { |
---|
| 97 | if ( m_numBufferedBytes > 0 ) |
---|
| 98 | { |
---|
| 99 | m_pcTComBitIf->write( m_bufferedByte, 8 ); |
---|
| 100 | } |
---|
| 101 | while ( m_numBufferedBytes > 1 ) |
---|
| 102 | { |
---|
| 103 | m_pcTComBitIf->write( 0xff, 8 ); |
---|
| 104 | m_numBufferedBytes--; |
---|
[1029] | 105 | } |
---|
[313] | 106 | } |
---|
| 107 | m_pcTComBitIf->write( m_uiLow >> 8, 24 - m_bitsLeft ); |
---|
| 108 | } |
---|
| 109 | |
---|
| 110 | Void TEncBinCABAC::flush() |
---|
| 111 | { |
---|
| 112 | encodeBinTrm(1); |
---|
| 113 | finish(); |
---|
| 114 | m_pcTComBitIf->write(1, 1); |
---|
| 115 | m_pcTComBitIf->writeAlignZero(); |
---|
| 116 | |
---|
| 117 | start(); |
---|
| 118 | } |
---|
| 119 | |
---|
| 120 | /** Reset BAC register and counter values. |
---|
| 121 | * \returns Void |
---|
| 122 | */ |
---|
| 123 | Void TEncBinCABAC::resetBac() |
---|
| 124 | { |
---|
| 125 | start(); |
---|
| 126 | } |
---|
| 127 | |
---|
| 128 | /** Encode PCM alignment zero bits. |
---|
| 129 | * \returns Void |
---|
| 130 | */ |
---|
| 131 | Void TEncBinCABAC::encodePCMAlignBits() |
---|
| 132 | { |
---|
| 133 | finish(); |
---|
| 134 | m_pcTComBitIf->write(1, 1); |
---|
| 135 | m_pcTComBitIf->writeAlignZero(); // pcm align zero |
---|
| 136 | } |
---|
| 137 | |
---|
| 138 | /** Write a PCM code. |
---|
| 139 | * \param uiCode code value |
---|
| 140 | * \param uiLength code bit-depth |
---|
| 141 | * \returns Void |
---|
| 142 | */ |
---|
| 143 | Void TEncBinCABAC::xWritePCMCode(UInt uiCode, UInt uiLength) |
---|
| 144 | { |
---|
| 145 | m_pcTComBitIf->write(uiCode, uiLength); |
---|
| 146 | } |
---|
| 147 | |
---|
[1029] | 148 | Void TEncBinCABAC::copyState( const TEncBinIf* pcTEncBinIf ) |
---|
[313] | 149 | { |
---|
[1029] | 150 | const TEncBinCABAC* pcTEncBinCABAC = pcTEncBinIf->getTEncBinCABAC(); |
---|
[313] | 151 | m_uiLow = pcTEncBinCABAC->m_uiLow; |
---|
| 152 | m_uiRange = pcTEncBinCABAC->m_uiRange; |
---|
| 153 | m_bitsLeft = pcTEncBinCABAC->m_bitsLeft; |
---|
| 154 | m_bufferedByte = pcTEncBinCABAC->m_bufferedByte; |
---|
| 155 | m_numBufferedBytes = pcTEncBinCABAC->m_numBufferedBytes; |
---|
| 156 | #if FAST_BIT_EST |
---|
| 157 | m_fracBits = pcTEncBinCABAC->m_fracBits; |
---|
| 158 | #endif |
---|
| 159 | } |
---|
| 160 | |
---|
| 161 | Void TEncBinCABAC::resetBits() |
---|
| 162 | { |
---|
| 163 | m_uiLow = 0; |
---|
| 164 | m_bitsLeft = 23; |
---|
| 165 | m_numBufferedBytes = 0; |
---|
| 166 | m_bufferedByte = 0xff; |
---|
| 167 | if ( m_binCountIncrement ) |
---|
| 168 | { |
---|
| 169 | m_uiBinsCoded = 0; |
---|
| 170 | } |
---|
| 171 | #if FAST_BIT_EST |
---|
| 172 | m_fracBits &= 32767; |
---|
| 173 | #endif |
---|
| 174 | } |
---|
| 175 | |
---|
| 176 | UInt TEncBinCABAC::getNumWrittenBits() |
---|
| 177 | { |
---|
| 178 | return m_pcTComBitIf->getNumberOfWrittenBits() + 8 * m_numBufferedBytes + 23 - m_bitsLeft; |
---|
| 179 | } |
---|
| 180 | |
---|
| 181 | /** |
---|
| 182 | * \brief Encode bin |
---|
| 183 | * |
---|
| 184 | * \param binValue bin value |
---|
| 185 | * \param rcCtxModel context model |
---|
| 186 | */ |
---|
| 187 | Void TEncBinCABAC::encodeBin( UInt binValue, ContextModel &rcCtxModel ) |
---|
| 188 | { |
---|
[1029] | 189 | //{ |
---|
| 190 | // DTRACE_CABAC_VL( g_nSymbolCounter++ ) |
---|
| 191 | // DTRACE_CABAC_T( "\tstate=" ) |
---|
| 192 | // DTRACE_CABAC_V( ( rcCtxModel.getState() << 1 ) + rcCtxModel.getMps() ) |
---|
| 193 | // DTRACE_CABAC_T( "\tsymbol=" ) |
---|
| 194 | // DTRACE_CABAC_V( binValue ) |
---|
| 195 | // DTRACE_CABAC_T( "\n" ) |
---|
| 196 | //} |
---|
| 197 | |
---|
| 198 | #ifdef DEBUG_CABAC_BINS |
---|
| 199 | const UInt startingRange = m_uiRange; |
---|
| 200 | #endif |
---|
| 201 | |
---|
[313] | 202 | m_uiBinsCoded += m_binCountIncrement; |
---|
| 203 | rcCtxModel.setBinsCoded( 1 ); |
---|
[1029] | 204 | |
---|
[313] | 205 | UInt uiLPS = TComCABACTables::sm_aucLPSTable[ rcCtxModel.getState() ][ ( m_uiRange >> 6 ) & 3 ]; |
---|
| 206 | m_uiRange -= uiLPS; |
---|
[1029] | 207 | |
---|
[313] | 208 | if( binValue != rcCtxModel.getMps() ) |
---|
| 209 | { |
---|
| 210 | Int numBits = TComCABACTables::sm_aucRenormTable[ uiLPS >> 3 ]; |
---|
| 211 | m_uiLow = ( m_uiLow + m_uiRange ) << numBits; |
---|
| 212 | m_uiRange = uiLPS << numBits; |
---|
| 213 | rcCtxModel.updateLPS(); |
---|
| 214 | m_bitsLeft -= numBits; |
---|
[1029] | 215 | testAndWriteOut(); |
---|
[313] | 216 | } |
---|
| 217 | else |
---|
| 218 | { |
---|
| 219 | rcCtxModel.updateMPS(); |
---|
[1029] | 220 | |
---|
| 221 | if ( m_uiRange < 256 ) |
---|
[313] | 222 | { |
---|
[1029] | 223 | m_uiLow <<= 1; |
---|
| 224 | m_uiRange <<= 1; |
---|
| 225 | m_bitsLeft--; |
---|
| 226 | testAndWriteOut(); |
---|
[313] | 227 | } |
---|
| 228 | } |
---|
[1029] | 229 | |
---|
| 230 | #ifdef DEBUG_CABAC_BINS |
---|
| 231 | if ((g_debugCounter + debugCabacBinWindow) >= debugCabacBinTargetLine) |
---|
[1246] | 232 | { |
---|
[1029] | 233 | std::cout << g_debugCounter << ": coding bin value " << binValue << ", range = [" << startingRange << "->" << m_uiRange << "]\n"; |
---|
[1246] | 234 | } |
---|
[1029] | 235 | |
---|
| 236 | if (g_debugCounter >= debugCabacBinTargetLine) |
---|
| 237 | { |
---|
| 238 | Char breakPointThis; |
---|
| 239 | breakPointThis = 7; |
---|
| 240 | } |
---|
[1246] | 241 | if (g_debugCounter >= (debugCabacBinTargetLine + debugCabacBinWindow)) |
---|
| 242 | { |
---|
| 243 | exit(0); |
---|
| 244 | } |
---|
| 245 | |
---|
[1029] | 246 | g_debugCounter++; |
---|
| 247 | #endif |
---|
[313] | 248 | } |
---|
| 249 | |
---|
| 250 | /** |
---|
| 251 | * \brief Encode equiprobable bin |
---|
| 252 | * |
---|
| 253 | * \param binValue bin value |
---|
| 254 | */ |
---|
| 255 | Void TEncBinCABAC::encodeBinEP( UInt binValue ) |
---|
| 256 | { |
---|
[1029] | 257 | if (false) |
---|
[313] | 258 | { |
---|
| 259 | DTRACE_CABAC_VL( g_nSymbolCounter++ ) |
---|
| 260 | DTRACE_CABAC_T( "\tEPsymbol=" ) |
---|
| 261 | DTRACE_CABAC_V( binValue ) |
---|
| 262 | DTRACE_CABAC_T( "\n" ) |
---|
| 263 | } |
---|
[1029] | 264 | |
---|
[313] | 265 | m_uiBinsCoded += m_binCountIncrement; |
---|
[1029] | 266 | |
---|
| 267 | if (m_uiRange == 256) |
---|
| 268 | { |
---|
| 269 | encodeAlignedBinsEP(binValue, 1); |
---|
| 270 | return; |
---|
| 271 | } |
---|
| 272 | |
---|
[313] | 273 | m_uiLow <<= 1; |
---|
| 274 | if( binValue ) |
---|
| 275 | { |
---|
| 276 | m_uiLow += m_uiRange; |
---|
| 277 | } |
---|
| 278 | m_bitsLeft--; |
---|
[1029] | 279 | |
---|
[313] | 280 | testAndWriteOut(); |
---|
| 281 | } |
---|
| 282 | |
---|
| 283 | /** |
---|
| 284 | * \brief Encode equiprobable bins |
---|
| 285 | * |
---|
| 286 | * \param binValues bin values |
---|
| 287 | * \param numBins number of bins |
---|
| 288 | */ |
---|
| 289 | Void TEncBinCABAC::encodeBinsEP( UInt binValues, Int numBins ) |
---|
| 290 | { |
---|
| 291 | m_uiBinsCoded += numBins & -m_binCountIncrement; |
---|
[1029] | 292 | |
---|
| 293 | if (false) |
---|
[313] | 294 | { |
---|
[1029] | 295 | for ( Int i = 0; i < numBins; i++ ) |
---|
| 296 | { |
---|
| 297 | DTRACE_CABAC_VL( g_nSymbolCounter++ ) |
---|
| 298 | DTRACE_CABAC_T( "\tEPsymbol=" ) |
---|
| 299 | DTRACE_CABAC_V( ( binValues >> ( numBins - 1 - i ) ) & 1 ) |
---|
| 300 | DTRACE_CABAC_T( "\n" ) |
---|
| 301 | } |
---|
[313] | 302 | } |
---|
[1029] | 303 | |
---|
| 304 | if (m_uiRange == 256) |
---|
| 305 | { |
---|
| 306 | encodeAlignedBinsEP(binValues, numBins); |
---|
| 307 | return; |
---|
| 308 | } |
---|
| 309 | |
---|
[313] | 310 | while ( numBins > 8 ) |
---|
| 311 | { |
---|
| 312 | numBins -= 8; |
---|
[1029] | 313 | UInt pattern = binValues >> numBins; |
---|
[313] | 314 | m_uiLow <<= 8; |
---|
| 315 | m_uiLow += m_uiRange * pattern; |
---|
| 316 | binValues -= pattern << numBins; |
---|
| 317 | m_bitsLeft -= 8; |
---|
[1029] | 318 | |
---|
[313] | 319 | testAndWriteOut(); |
---|
| 320 | } |
---|
[1029] | 321 | |
---|
[313] | 322 | m_uiLow <<= numBins; |
---|
| 323 | m_uiLow += m_uiRange * binValues; |
---|
| 324 | m_bitsLeft -= numBins; |
---|
[1029] | 325 | |
---|
[313] | 326 | testAndWriteOut(); |
---|
| 327 | } |
---|
| 328 | |
---|
[1029] | 329 | Void TEncBinCABAC::align() |
---|
| 330 | { |
---|
| 331 | m_uiRange = 256; |
---|
| 332 | } |
---|
| 333 | |
---|
| 334 | Void TEncBinCABAC::encodeAlignedBinsEP( UInt binValues, Int numBins ) |
---|
| 335 | { |
---|
| 336 | Int binsRemaining = numBins; |
---|
| 337 | |
---|
| 338 | assert(m_uiRange == 256); //aligned encode only works when range = 256 |
---|
| 339 | |
---|
| 340 | while (binsRemaining > 0) |
---|
| 341 | { |
---|
| 342 | const UInt binsToCode = std::min<UInt>(binsRemaining, 8); //code bytes if able to take advantage of the system's byte-write function |
---|
| 343 | const UInt binMask = (1 << binsToCode) - 1; |
---|
| 344 | |
---|
| 345 | const UInt newBins = (binValues >> (binsRemaining - binsToCode)) & binMask; |
---|
| 346 | |
---|
| 347 | //The process of encoding an EP bin is the same as that of coding a normal |
---|
| 348 | //bin where the symbol ranges for 1 and 0 are both half the range: |
---|
| 349 | // |
---|
| 350 | // low = (low + range/2) << 1 (to encode a 1) |
---|
| 351 | // low = low << 1 (to encode a 0) |
---|
| 352 | // |
---|
| 353 | // i.e. |
---|
| 354 | // low = (low + (bin * range/2)) << 1 |
---|
| 355 | // |
---|
| 356 | // which is equivalent to: |
---|
| 357 | // |
---|
| 358 | // low = (low << 1) + (bin * range) |
---|
| 359 | // |
---|
| 360 | // this can be generalised for multiple bins, producing the following expression: |
---|
| 361 | // |
---|
| 362 | m_uiLow = (m_uiLow << binsToCode) + (newBins << 8); //range is known to be 256 |
---|
| 363 | |
---|
| 364 | binsRemaining -= binsToCode; |
---|
| 365 | m_bitsLeft -= binsToCode; |
---|
| 366 | |
---|
| 367 | testAndWriteOut(); |
---|
| 368 | } |
---|
| 369 | } |
---|
| 370 | |
---|
[313] | 371 | /** |
---|
| 372 | * \brief Encode terminating bin |
---|
| 373 | * |
---|
| 374 | * \param binValue bin value |
---|
| 375 | */ |
---|
| 376 | Void TEncBinCABAC::encodeBinTrm( UInt binValue ) |
---|
| 377 | { |
---|
| 378 | m_uiBinsCoded += m_binCountIncrement; |
---|
| 379 | m_uiRange -= 2; |
---|
| 380 | if( binValue ) |
---|
| 381 | { |
---|
| 382 | m_uiLow += m_uiRange; |
---|
| 383 | m_uiLow <<= 7; |
---|
| 384 | m_uiRange = 2 << 7; |
---|
| 385 | m_bitsLeft -= 7; |
---|
| 386 | } |
---|
| 387 | else if ( m_uiRange >= 256 ) |
---|
| 388 | { |
---|
| 389 | return; |
---|
| 390 | } |
---|
| 391 | else |
---|
| 392 | { |
---|
| 393 | m_uiLow <<= 1; |
---|
| 394 | m_uiRange <<= 1; |
---|
[1029] | 395 | m_bitsLeft--; |
---|
[313] | 396 | } |
---|
[1029] | 397 | |
---|
[313] | 398 | testAndWriteOut(); |
---|
| 399 | } |
---|
| 400 | |
---|
| 401 | Void TEncBinCABAC::testAndWriteOut() |
---|
| 402 | { |
---|
| 403 | if ( m_bitsLeft < 12 ) |
---|
| 404 | { |
---|
| 405 | writeOut(); |
---|
| 406 | } |
---|
| 407 | } |
---|
| 408 | |
---|
| 409 | /** |
---|
| 410 | * \brief Move bits from register into bitstream |
---|
| 411 | */ |
---|
| 412 | Void TEncBinCABAC::writeOut() |
---|
| 413 | { |
---|
| 414 | UInt leadByte = m_uiLow >> (24 - m_bitsLeft); |
---|
| 415 | m_bitsLeft += 8; |
---|
| 416 | m_uiLow &= 0xffffffffu >> m_bitsLeft; |
---|
[1029] | 417 | |
---|
[313] | 418 | if ( leadByte == 0xff ) |
---|
| 419 | { |
---|
| 420 | m_numBufferedBytes++; |
---|
| 421 | } |
---|
| 422 | else |
---|
| 423 | { |
---|
| 424 | if ( m_numBufferedBytes > 0 ) |
---|
| 425 | { |
---|
| 426 | UInt carry = leadByte >> 8; |
---|
| 427 | UInt byte = m_bufferedByte + carry; |
---|
| 428 | m_bufferedByte = leadByte & 0xff; |
---|
| 429 | m_pcTComBitIf->write( byte, 8 ); |
---|
[1029] | 430 | |
---|
[313] | 431 | byte = ( 0xff + carry ) & 0xff; |
---|
| 432 | while ( m_numBufferedBytes > 1 ) |
---|
| 433 | { |
---|
| 434 | m_pcTComBitIf->write( byte, 8 ); |
---|
| 435 | m_numBufferedBytes--; |
---|
| 436 | } |
---|
| 437 | } |
---|
| 438 | else |
---|
| 439 | { |
---|
| 440 | m_numBufferedBytes = 1; |
---|
| 441 | m_bufferedByte = leadByte; |
---|
[1029] | 442 | } |
---|
| 443 | } |
---|
[313] | 444 | } |
---|
| 445 | |
---|
| 446 | //! \} |
---|