[SPIP] v3.2.1-->v3.2.3
[lhc/web/www.git] / www / plugins-dist / medias / lib / getid3 / module.audio.optimfrog.php
index 50e0ffd..1c12230 100644 (file)
@@ -1,11 +1,11 @@
 <?php
+
 /////////////////////////////////////////////////////////////////
 /// getID3() by James Heinrich <info@getid3.org>               //
-//  available at http://getid3.sourceforge.net                 //
-//            or http://www.getid3.org                         //
-//          also https://github.com/JamesHeinrich/getID3       //
-/////////////////////////////////////////////////////////////////
-// See readme.txt for more details                             //
+//  available at https://github.com/JamesHeinrich/getID3       //
+//            or https://www.getid3.org                        //
+//            or http://getid3.sourceforge.net                 //
+//  see readme.txt for more details                            //
 /////////////////////////////////////////////////////////////////
 //                                                             //
 // module.audio.optimfrog.php                                  //
@@ -18,7 +18,9 @@ getid3_lib::IncludeDependency(GETID3_INCLUDEPATH.'module.audio-video.riff.php',
 
 class getid3_optimfrog extends getid3_handler
 {
-
+       /**
+        * @return bool
+        */
        public function Analyze() {
                $info = &$this->getid3->info;
 
@@ -44,7 +46,9 @@ class getid3_optimfrog extends getid3_handler
                return false;
        }
 
-
+       /**
+        * @return bool
+        */
        public function ParseOptimFROGheader42() {
                // for fileformat of v4.21 and older
 
@@ -91,7 +95,9 @@ class getid3_optimfrog extends getid3_handler
                return true;
        }
 
-
+       /**
+        * @return bool
+        */
        public function ParseOptimFROGheader45() {
                // for fileformat of v4.50a and higher
 
@@ -313,7 +319,11 @@ class getid3_optimfrog extends getid3_handler
                return true;
        }
 
-
+       /**
+        * @param int $SampleType
+        *
+        * @return string|false
+        */
        public static function OptimFROGsampleTypeLookup($SampleType) {
                static $OptimFROGsampleTypeLookup = array(
                        0  => 'unsigned int (8-bit)',
@@ -331,6 +341,11 @@ class getid3_optimfrog extends getid3_handler
                return (isset($OptimFROGsampleTypeLookup[$SampleType]) ? $OptimFROGsampleTypeLookup[$SampleType] : false);
        }
 
+       /**
+        * @param int $SampleType
+        *
+        * @return int|false
+        */
        public static function OptimFROGbitsPerSampleTypeLookup($SampleType) {
                static $OptimFROGbitsPerSampleTypeLookup = array(
                        0  => 8,
@@ -348,6 +363,11 @@ class getid3_optimfrog extends getid3_handler
                return (isset($OptimFROGbitsPerSampleTypeLookup[$SampleType]) ? $OptimFROGbitsPerSampleTypeLookup[$SampleType] : false);
        }
 
+       /**
+        * @param int $ChannelConfiguration
+        *
+        * @return string|false
+        */
        public static function OptimFROGchannelConfigurationLookup($ChannelConfiguration) {
                static $OptimFROGchannelConfigurationLookup = array(
                        0 => 'mono',
@@ -356,6 +376,11 @@ class getid3_optimfrog extends getid3_handler
                return (isset($OptimFROGchannelConfigurationLookup[$ChannelConfiguration]) ? $OptimFROGchannelConfigurationLookup[$ChannelConfiguration] : false);
        }
 
+       /**
+        * @param int $ChannelConfiguration
+        *
+        * @return int|false
+        */
        public static function OptimFROGchannelConfigNumChannelsLookup($ChannelConfiguration) {
                static $OptimFROGchannelConfigNumChannelsLookup = array(
                        0 => 1,
@@ -365,13 +390,17 @@ class getid3_optimfrog extends getid3_handler
        }
 
 
-
        // static function OptimFROGalgorithmNameLookup($AlgorithID) {
        //     static $OptimFROGalgorithmNameLookup = array();
        //     return (isset($OptimFROGalgorithmNameLookup[$AlgorithID]) ? $OptimFROGalgorithmNameLookup[$AlgorithID] : false);
        // }
 
 
+       /**
+        * @param int $EncoderID
+        *
+        * @return string
+        */
        public static function OptimFROGencoderNameLookup($EncoderID) {
                // version = (encoderID >> 4) + 4500
                // system  =  encoderID & 0xF
@@ -387,6 +416,11 @@ class getid3_optimfrog extends getid3_handler
                return $EncoderVersion.' ('.(isset($OptimFROGencoderSystemLookup[$EncoderSystemID]) ? $OptimFROGencoderSystemLookup[$EncoderSystemID] : 'undefined encoder type (0x'.dechex($EncoderSystemID).')').')';
        }
 
+       /**
+        * @param int $CompressionID
+        *
+        * @return string
+        */
        public static function OptimFROGcompressionLookup($CompressionID) {
                // mode    = compression >> 3
                // speedup = compression & 0x07
@@ -409,6 +443,11 @@ class getid3_optimfrog extends getid3_handler
                return (isset($OptimFROGencoderModeLookup[$CompressionModeID]) ? $OptimFROGencoderModeLookup[$CompressionModeID] : 'undefined mode (0x'.str_pad(dechex($CompressionModeID), 2, '0', STR_PAD_LEFT).')');
        }
 
+       /**
+        * @param int $CompressionID
+        *
+        * @return string
+        */
        public static function OptimFROGspeedupLookup($CompressionID) {
                // mode    = compression >> 3
                // speedup = compression & 0x07