src/main/java/net/pterodactylus/sonitus/data/filter/LameMp3Encoder.java

   1 /*
   2  * Sonitus - LameMp3Encoder.java - Copyright © 2013 David Roden
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation, either version 3 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17
  18 package net.pterodactylus.sonitus.data.filter;
  19
  20 import java.util.Arrays;
  21
  22 import net.pterodactylus.sonitus.data.Format;
  23
  24 import com.google.common.base.Optional;
  25 import com.google.common.collect.ImmutableList;
  26
  27 /**
  28  * {@link ExternalMp3Encoder} implementation that uses LAME to encode MP3s.
  29  *
  30  * @author <a href="mailto:bombe@pterodactylus.net">David ‘Bombe’ Roden</a>
  31  */
  32 public class LameMp3Encoder extends ExternalMp3Encoder {
  33
  34         /** Preset for LAME. */
  35         public enum Preset {
  36
  37                 /** “medium” preset. */
  38                 MEDIUM,
  39
  40                 /** “standard” preset. */
  41                 STANDARD,
  42
  43                 /** “extreme” preset. */
  44                 EXTREME,
  45
  46                 /** “insane” preset. */
  47                 INSANE
  48
  49         }
  50
  51         /** The location of the binary. */
  52         private final String binary;
  53
  54         /** Whether to swap bytes in the input. */
  55         private final boolean swapBytes;
  56
  57         /** The preset to use. */
  58         private final Optional<Preset> preset;
  59
  60         /** The bitrate to encode to. */
  61         private final Optional<Integer> bitrate;
  62
  63         /**
  64          * Creates a new LAME MP3 encoder.
  65          *
  66          * @param binary
  67          *              The location of the binary
  68          * @param swapBytes
  69          *              {@code true} to swap bytes in the input, {@code false} to use platform
  70          *              endianness
  71          * @param preset
  72          *              The preset to use
  73          */
  74         public LameMp3Encoder(String binary, boolean swapBytes, Preset preset) {
  75                 this(binary, swapBytes, preset, -1);
  76         }
  77
  78         /**
  79          * Creates a new LAME MP3 encoder.
  80          *
  81          * @param binary
  82          *              The location of the binary
  83          * @param swapBytes
  84          *              {@code true} to swap bytes in the input, {@code false} to use platform
  85          *              endianness
  86          * @param bitrate
  87          *              The bitrate to encode to (in kbps)
  88          */
  89         public LameMp3Encoder(String binary, boolean swapBytes, int bitrate) {
  90                 this(binary, swapBytes, null, bitrate);
  91         }
  92
  93         /**
  94          * Creates a new LAME MP3 encoder.
  95          *
  96          * @param binary
  97          *              The location of the binary
  98          * @param swapBytes
  99          *              {@code true} to swap bytes in the input, {@code false} to use platform
 100          *              endianness
 101          * @param preset
 102          *              The preset to use
 103          * @param bitrate
 104          *              The bitrate to encode to (in kbps)
 105          */
 106         private LameMp3Encoder(String binary, boolean swapBytes, Preset preset, int bitrate) {
 107                 this.binary = binary;
 108                 this.swapBytes = swapBytes;
 109                 this.preset = Optional.fromNullable(preset);
 110                 this.bitrate = (bitrate < 0) ? Optional.<Integer>absent() : Optional.<Integer>of(bitrate);
 111         }
 112
 113         //
 114         // EXTERNALFILTER METHODS
 115         //
 116
 117         @Override
 118         protected String binary(Format format) {
 119                 return binary;
 120         }
 121
 122         @Override
 123         protected Iterable<String> parameters(Format format) {
 124                 ImmutableList.Builder parameters = ImmutableList.builder();
 125                 parameters.add("-r");
 126                 parameters.add("-s").add(String.valueOf(format.frequency() / 1000.0));
 127                 if (swapBytes) {
 128                         parameters.add("-x");
 129                 }
 130                 parameters.add("--preset");
 131                 if (preset.isPresent()) {
 132                         parameters.add(preset.get().name().toLowerCase());
 133                 }
 134                 if (bitrate.isPresent()) {
 135                         if (isSignificant(bitrate.get())) {
 136                                 parameters.add("cbr");
 137                         }
 138                         parameters.add(String.valueOf(bitrate.get()));
 139                 }
 140                 parameters.add("-p");
 141                 parameters.add("-q").add("0");
 142                 parameters.add("-").add("-");
 143                 return parameters.build();
 144         }
 145
 146         //
 147         // STATIC METHODS
 148         //
 149
 150         /**
 151          * Returns whether the given bitrate is one of the significant bitrates of
 152          * MP3.
 153          *
 154          * @param bitrate
 155          *              The bitrate to check (in kbps)
 156          * @return {@code true} if the given bitrate is one of the significant MP3
 157          *         bitrates, {@code false} otherwise
 158          */
 159         private static boolean isSignificant(int bitrate) {
 160                 return Arrays.asList(80, 96, 112, 128, 160, 192, 224, 256, 320).contains(bitrate);
 161         }
 162
 163 }