GlobalPrefsActivity.java

/**
 * Mupen64PlusAE, an N64 emulator for the Android platform
 * 
 * Copyright (C) 2013 Paul Lamb
 * 
 * This file is part of Mupen64PlusAE.
 * 
 * Mupen64PlusAE is free software: you can redistribute it and/or modify it under the terms of the
 * GNU General Public License as published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 * 
 * Mupen64PlusAE is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY;
 * without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License along with Mupen64PlusAE. If
 * not, see <http://www.gnu.org/licenses/>.
 * 
 * Authors: littleguy77
 */
package paulscode.android.mupen64plusae.persistent;

import org.mupen64plusae.v3.alpha.R;

import paulscode.android.mupen64plusae.ActivityHelper;
import paulscode.android.mupen64plusae.compat.AppCompatPreferenceActivity;
import paulscode.android.mupen64plusae.dialog.Prompt;
import paulscode.android.mupen64plusae.dialog.Prompt.PromptConfirmListener;
import paulscode.android.mupen64plusae.preference.PrefUtil;
import android.annotation.TargetApi;
import android.content.DialogInterface;
import android.content.SharedPreferences;
import android.content.SharedPreferences.OnSharedPreferenceChangeListener;
import android.os.Bundle;
import android.preference.Preference;
import android.preference.Preference.OnPreferenceClickListener;
import android.preference.PreferenceManager;

public class GlobalPrefsActivity extends AppCompatPreferenceActivity implements OnPreferenceClickListener,
        OnSharedPreferenceChangeListener
{
    // These constants must match the keys used in res/xml/preferences.xml
    
    private static final String SCREEN_ROOT = "screenRoot";
    private static final String CATEGORY_LIBRARY = "categoryLibrary";
    private static final String CATEGORY_DISPLAY = "categoryDisplay";
    private static final String CATEGORY_AUDIO = "categoryAudio";
    private static final String CATEGORY_TOUCHSCREEN = "categoryTouchscreen";
    private static final String CATEGORY_TOUCHPAD = "categoryTouchpad";
    private static final String CATEGORY_INPUT = "categoryInput";
    private static final String CATEGORY_DATA = "categoryData";
    
    private static final String DISPLAY_ORIENTATION = "displayOrientation";
    private static final String DISPLAY_RESOLUTION = "displayResolution";
    private static final String DISPLAY_IMMERSIVE_MODE = "displayImmersiveMode";
    private static final String DISPLAY_FPS_REFRESH = "displayFpsRefresh";
    private static final String VIDEO_POLYGON_OFFSET = "videoPolygonOffset";
    private static final String VIDEO_HARDWARE_TYPE = "videoHardwareType";
    private static final int VIDEO_HARDWARE_TYPE_CUSTOM = 999;
    private static final String AUDIO_SDL_BUFFER_SIZE = "audioSDLBufferSize";
    private static final String AUDIO_SLES_BUFFER_SIZE = "audioSLESBufferSize";
    private static final String AUDIO_SLES_BUFFER_NBR = "audioSLESBufferNbr";
    private static final String AUDIO_SYNCHRONIZE = "audioSynchronize";
    private static final String AUDIO_SWAP_CHANNELS = "audioSwapChannels";
    private static final String TOUCHSCREEN_FEEDBACK = "touchscreenFeedback";
    private static final String TOUCHSCREEN_AUTO_HOLD = "touchscreenAutoHold";
    private static final String NAVIGATION_MODE = "navigationMode";
    
    private static final String ACTION_RELOAD_ASSETS = "actionReloadAssets";
    private static final String ACTION_RESET_USER_PREFS = "actionResetUserPrefs";
    
    private static final String AUDIO_SDL_PLUGIN = "libmupen64plus-audio-sdl.so";
    private static final String AUDIO_SLES_PLUGIN = "libmupen64plus-audio-sles.so";
    
    // App data and user preferences
    private AppData mAppData = null;
    private GlobalPrefs mGlobalPrefs = null;
    private SharedPreferences mPrefs = null;
    
    @SuppressWarnings( "deprecation" )
    @Override
    protected void onCreate( Bundle savedInstanceState )
    {
        super.onCreate( savedInstanceState );
        
        // Get app data and user preferences
        mAppData = new AppData( this );
        mGlobalPrefs = new GlobalPrefs( this, mAppData );
        mGlobalPrefs.enforceLocale( this );
        mPrefs = PreferenceManager.getDefaultSharedPreferences( this );
        
        // Load user preference menu structure from XML and update view
        addPreferencesFromResource( R.xml.preferences_global );
        
        // Refresh the preference data wrapper
        mGlobalPrefs = new GlobalPrefs( this, mAppData );
        
        // Handle certain menu items that require extra processing or aren't actually preferences
        PrefUtil.setOnPreferenceClickListener( this, ACTION_RELOAD_ASSETS, this );
        PrefUtil.setOnPreferenceClickListener( this, ACTION_RESET_USER_PREFS, this );
        
        // Hide certain categories altogether if they're not applicable. Normally we just rely on
        // the built-in dependency disabler, but here the categories are so large that hiding them
        // provides a better user experience.
        if( !AppData.IS_KITKAT )
            PrefUtil.removePreference( this, CATEGORY_DISPLAY, DISPLAY_IMMERSIVE_MODE );

        if( !mAppData.hardwareInfo.isXperiaPlay )
            PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_TOUCHPAD );
        
        // Remove some menu items in some cases
        Bundle extras = getIntent().getExtras();
        if( extras != null )
        {
            int mode = extras.getInt( ActivityHelper.Keys.MENU_DISPLAY_MODE, 0 );
            if( mode == 1 )
            {
                // Remove distractions if this was launched from TouchscreenProfileActivity
                PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_LIBRARY );
                PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_AUDIO );
                PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_TOUCHPAD );
                PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_INPUT );
                PrefUtil.removePreference( this, SCREEN_ROOT, CATEGORY_DATA );
                PrefUtil.removePreference( this, SCREEN_ROOT, ACTION_RESET_USER_PREFS );
                PrefUtil.removePreference( this, CATEGORY_DISPLAY, DISPLAY_ORIENTATION );
                PrefUtil.removePreference( this, CATEGORY_DISPLAY, DISPLAY_RESOLUTION );
                PrefUtil.removePreference( this, CATEGORY_DISPLAY, DISPLAY_FPS_REFRESH );
                PrefUtil.removePreference( this, CATEGORY_DISPLAY, VIDEO_HARDWARE_TYPE );
                PrefUtil.removePreference( this, CATEGORY_DISPLAY, VIDEO_POLYGON_OFFSET );
                PrefUtil.removePreference( this, CATEGORY_TOUCHSCREEN, TOUCHSCREEN_FEEDBACK );
                PrefUtil.removePreference( this, CATEGORY_TOUCHSCREEN, TOUCHSCREEN_AUTO_HOLD );
            }
        }
    }
    
    @Override
    protected void onPause()
    {
        super.onPause();
        mPrefs.unregisterOnSharedPreferenceChangeListener( this );
    }
    
    @Override
    protected void onResume()
    {
        super.onResume();
        mPrefs.registerOnSharedPreferenceChangeListener( this );
        refreshViews();
    }
    
    @Override
    public void onSharedPreferenceChanged( SharedPreferences sharedPreferences, String key )
    {
        if( key.equals( NAVIGATION_MODE ) )
        {
            // Sometimes one preference change affects the hierarchy or layout of the views. In this
            // case it's easier just to restart the activity than try to figure out what to fix.
            ActivityHelper.restartActivity( this );
        }
        else
        {
            // Just refresh the preference screens in place
            refreshViews();
        }
    }
    
    @TargetApi( 9 )
    private void refreshViews()
    {
        // Refresh the preferences object
        mGlobalPrefs = new GlobalPrefs( this, mAppData );
        
        // Enable polygon offset pref if flicker reduction is custom
        PrefUtil.enablePreference( this, VIDEO_POLYGON_OFFSET, mGlobalPrefs.videoHardwareType == VIDEO_HARDWARE_TYPE_CUSTOM );
        
        // Enable audio prefs if audio is enabled
        PrefUtil.enablePreference( this, AUDIO_SDL_BUFFER_SIZE, mGlobalPrefs.audioPlugin.name.equals( AUDIO_SDL_PLUGIN ) );
        PrefUtil.enablePreference( this, AUDIO_SLES_BUFFER_SIZE, mGlobalPrefs.audioPlugin.name.equals( AUDIO_SLES_PLUGIN ) );
        PrefUtil.enablePreference( this, AUDIO_SLES_BUFFER_NBR, mGlobalPrefs.audioPlugin.name.equals( AUDIO_SLES_PLUGIN ) );
        PrefUtil.enablePreference( this, AUDIO_SYNCHRONIZE, mGlobalPrefs.audioPlugin.enabled );
        PrefUtil.enablePreference( this, AUDIO_SWAP_CHANNELS, mGlobalPrefs.audioPlugin.enabled );
    }
    
    @Override
    public boolean onPreferenceClick( Preference preference )
    {
        // Handle the clicks on certain menu items that aren't actually preferences
        String key = preference.getKey();
        
        if( key.equals( ACTION_RELOAD_ASSETS ) )
            actionReloadAssets();
        
        else if( key.equals( ACTION_RESET_USER_PREFS ) )
            actionResetUserPrefs();
        
        else
            // Let Android handle all other preference clicks
            return false;
        
        // Tell Android that we handled the click
        return true;
    }
    
    private void actionReloadAssets()
    {
        mAppData.putAssetVersion( 0 );
        ActivityHelper.startSplashActivity( this );
        finish();
    }
    
    private void actionResetUserPrefs()
    {
        String title = getString( R.string.confirm_title );
        String message = getString( R.string.actionResetUserPrefs_popupMessage );
        Prompt.promptConfirm( this, title, message, new PromptConfirmListener()
        {
            @Override
            public void onDialogClosed( int which )
            {
                if( which == DialogInterface.BUTTON_POSITIVE )
                {
                    // Reset the user preferences
                    mPrefs.unregisterOnSharedPreferenceChangeListener( GlobalPrefsActivity.this );
                    mPrefs.edit().clear().commit();
                    PreferenceManager.setDefaultValues( GlobalPrefsActivity.this, R.xml.preferences_global, true );
                
                    // Rebuild the menu system by restarting the activity
                    ActivityHelper.restartActivity( GlobalPrefsActivity.this );
                }
            }
        } );
    }
}