nuttx-apps/include/graphics/nxwm/cmediaplayer.hxx
Alin Jerpelea 324155cd1e include: update licenses to Apache
Gregory Nutt is has submitted the SGA

Uros Platise has submitted the ICLA

Ken Pettit has submitted the ICLA

Sebastien Lorquet has submitted the ICLA

Pierre-Noel Bouteville has submitted the ICLA

as a result we can migrate the licenses to Apache.

Signed-off-by: Alin Jerpelea <alin.jerpelea@sony.com>
2021-06-11 05:05:27 -05:00

470 lines
15 KiB
C++

/****************************************************************************
* apps/include/graphics/nxwm/cmediaplayer.hxx
*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership. The
* ASF licenses this file to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance with the
* License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
* WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and limitations
* under the License.
*
****************************************************************************/
#ifndef __APPS_INCLUDE_GRAPHICS_NXWM_CMEDIAPLAYER_HXX
#define __APPS_INCLUDE_GRAPHICS_NXWM_CMEDIAPLAYER_HXX
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/config.h>
#include <sys/types.h>
#include <nuttx/nx/nxtk.h>
#include <nuttx/nx/nxterm.h>
#include "graphics/nxwidgets/cnxfont.hxx"
#include "graphics/nxwidgets/cimage.hxx"
#include "graphics/nxwidgets/cstickyimage.hxx"
#include "graphics/nxwidgets/clabel.hxx"
#include "graphics/nxwidgets/clistbox.hxx"
#include "graphics/nxwidgets/clistboxdataitem.hxx"
#include "graphics/nxwidgets/cglyphsliderhorizontal.hxx"
#include "graphics/nxwm/iapplication.hxx"
#include "graphics/nxwm/capplicationwindow.hxx"
#include "graphics/nxwm/ctaskbar.hxx"
/****************************************************************************
* Pre-Processor Definitions
****************************************************************************/
#define NXWM_MEDIAPLAYER_NROWS 6
#define NXWM_MEDIAPLAYER_NCOLUMNS 6
/****************************************************************************
* Implementation Classes
****************************************************************************/
#if defined(__cplusplus)
namespace NxWM
{
/**
* This class implements the CMediaPlayer application.
*/
class CMediaPlayer : public IApplication,
private IApplicationCallback,
private NXWidgets::CWidgetEventHandler
{
private:
/**
* This enumeration identifies the state of the media player
*
* State Transition Table
* ---------+----------+----------+----------+----------+----------+----------+
* | FILE | FILE | | | FAST | |
* STATE | SELECTED |DESELECTED| PLAY | PAUSE | FORWARD | REWIND |
* ---------+----------+----------+----------+----------+----------+----------+
* STOPPED | STAGED | X | X | X | X | X |
* STAGED | STAGED | STOPPED | PLAYING | X | X | X |
* PLAYING | X | X | X | PAUSED |FFORWARD2 | REWIND2 |
* PAUSED | STAGED | STOPPED | PLAYING | X |FFORWARD1 | REWIND1 |
* FFORWARD1| X | X | PAUSED | X |FFORWARD1 | REWIND1 |
* REWIND1 | X | X | PAUSED | X |FFORWARD1 | REWIND1 |
* FFORWARD2| X | X | X | PLAYING | PLAYING | REWIND1 |
* REWIND2 | X | X | X | PLAYING |FFORWARD1 | PLAYING |
* ---------+----------+----------+----------+----------+----------+----------+
*
* Configuration Dependencies. States in the above state transition table may
* not be supported if any of the following features are excluded from the
* configuration:
*
* CONFIG_AUDIO_EXCLUDE_STOP
* CONFIG_AUDIO_EXCLUDE_PAUSE_RESUME
* CONFIG_AUDIO_EXCLUDE_VOLUME
* CONFIG_AUDIO_EXCLUDE_FFORWARD
* CONFIG_AUDIO_EXCLUDE_REWIND
*/
enum EMediaPlayerState
{
MPLAYER_STOPPED = 0, /**< No media file has been selected */
MPLAYER_STAGED, /**< Media file selected, not playing */
MPLAYER_PLAYING, /**< Playing a media file */
MPLAYER_PAUSED, /**< Playing a media file but paused */
MPLAYER_FFORWARD, /**< Fast forwarding through a media file */
MPLAYER_FREWIND, /**< Rewinding a media file */
};
/**
* Describes the state of an image touch. Some image touch cannot be
* processed until the image contact is lost. This enumeration arms and
* manages those cases.
*/
enum EPendingRelease
{
PENDING_NONE = 0, /**< Nothing is pending */
PENDING_PLAY_RELEASE, /**< Expect play image to be released */
PENDING_PAUSE_RELEASE /**< Expect pause image to be released */
};
/**
* The structure defines a pending operation.
*/
struct SPendingOperation
{
int64_t value; /**< Accumulated value */
uint8_t operation; /**< Identifies the operations */
};
/**
* Media player state data.
*/
FAR struct nxplayer_s *m_player; /**< NxPlayer handle */
enum EMediaPlayerState m_state; /**< Media player current state */
enum EMediaPlayerState m_prevState; /**< Media player previous state */
enum EPendingRelease m_pending; /**< Pending image release event */
NXWidgets::CNxString m_filePath; /**< The full path to the selected file */
int m_fileIndex; /**< Last selected text box selection */
bool m_fileReady; /**< True: Ready to play */
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
uint8_t m_level; /**< Current volume level, range 0-100 */
#endif
#if !defined(CONFIG_AUDIO_EXCLUDE_FFORWARD) || !defined(CONFIG_AUDIO_EXCLUDE_REWIND)
uint8_t m_subSample; /**< Current FFFORWARD subsampling index */
#endif
/**
* Media player geometry.
*/
struct nxgl_size_s m_windowSize; /**< The size of the media player window */
/**
* Cached constructor parameters.
*/
CTaskbar *m_taskbar; /**< Reference to the "parent" taskbar */
CApplicationWindow *m_window; /**< Reference to the application window */
/**
* Widgets
*/
NXWidgets::CListBox *m_listbox; /**< List box containing media files selections */
NXWidgets::CNxFont *m_font; /**< The font used in the media player */
NXWidgets::CImage *m_play; /**< Play control */
NXWidgets::CImage *m_pause; /**< Pause control */
NXWidgets::CStickyImage *m_rewind; /**< Rewind control */
NXWidgets::CStickyImage *m_fforward; /**< Fast forward control */
NXWidgets::CGlyphSliderHorizontal *m_volume; /**< Volume control */
#if !defined(CONFIG_AUDIO_EXCLUDE_FFORWARD) || !defined(CONFIG_AUDIO_EXCLUDE_REWIND)
NXWidgets::CLabel *m_speed; /**< FForward/rewind speed */
#endif
/**
* Bitmaps
*
* These are retained only so that they can be released when the media
* is closed player
*/
NXWidgets::CRlePaletteBitmap *m_playBitmap; /**< Bitmap for the play control */
NXWidgets::CRlePaletteBitmap *m_pauseBitmap; /**< Bitmap for the pause control */
NXWidgets::CRlePaletteBitmap *m_rewindBitmap; /**< Bitmap for the rewind control */
NXWidgets::CRlePaletteBitmap *m_fforwardBitmap; /**< Bitmap for the fast forward control */
NXWidgets::CRlePaletteBitmap *m_volumeBitmap; /**< Volume control grip bitmap */
/**
* Get the full media file path and make ready for playing. Called
* after a file has been selected from the list box.
*/
bool getMediaFile(const NXWidgets::CListBoxDataItem *item);
/**
* Get the full media file path and make ready for playing. Called
* after a file has been selected from the list box.
*/
bool openMediaFile(const NXWidgets::CListBoxDataItem *item);
/**
* Stop playing the current file. Called when a new media file is selected,
* when a media file is de-selected, or when destroying the media player
* instance.
*/
void stopPlaying(void);
/**
* Select the geometry of the media player given the current window size.
* Only called as part of construction.
*/
inline void setGeometry(void);
/**
* Load media files into the list box.
*/
inline bool showMediaFiles(FAR const char *mediaPath);
#ifdef CONFIG_NXPLAYER_INCLUDE_PREFERRED_DEVICE
/**
* Set the preferred audio device for playback
*/
inline bool setDevice(FAR const char *devPath);
#endif
/**
* Configure the NxPlayer.
*/
inline bool configureNxPlayer(void);
/**
* Create the Media Player controls. Only start as part of the application
* start method.
*/
inline bool createPlayer(void);
/**
* Called when the window minimize image is pressed.
*/
void minimize(void);
/**
* Called when the window minimize close is pressed.
*/
void close(void);
/**
* Redraw all widgets. Called from redraw() and also on any state
* change.
*
* @param state The new state to enter.
*/
void redrawWidgets(void);
/**
* Transition to a new media player state.
*
* @param state The new state to enter.
*/
void setMediaPlayerState(enum EMediaPlayerState state);
#ifndef CONFIG_AUDIO_EXCLUDE_VOLUME
/**
* Set the new volume level based on the position of the volume slider.
*/
void setVolumeLevel(void);
#endif
/**
* Check if a new file has been selected (or de-selected) in the list box
*/
inline void checkFileSelection(void);
#if !defined(CONFIG_AUDIO_EXCLUDE_FFORWARD) || !defined(CONFIG_AUDIO_EXCLUDE_REWIND)
/**
* Update fast forward/rewind speed indicator. Called on each state
* change and after each change in the speed of motion.
*/
void updateMotionIndicator(void);
#endif
/**
* Handle a widget action event. For this application, that means image
* pre-release events.
*
* @param e The event data.
*/
void handleActionEvent(const NXWidgets::CWidgetEventArgs &e);
/**
* Handle a widget release event. Only the play and pause image release
* are of interest.
*
* @param e The event data.
*/
void handleReleaseEvent(const NXWidgets::CWidgetEventArgs &e);
/**
* Handle a widget release event when the widget WAS dragged outside of
* its original bounding box. Only the play and pause image release
* are of interest.
*
* @param e The event data.
*/
void handleReleaseOutsideEvent(const NXWidgets::CWidgetEventArgs &e);
/**
* Handle value changes. This will get events when there is a change in the
* volume level or a file is selected or deselected.
*
* @param e The event data.
*/
void handleValueChangeEvent(const NXWidgets::CWidgetEventArgs &e);
public:
/**
* CMediaPlayer constructor
*
* @param window. The application window
*
* @param taskbar. A pointer to the parent task bar instance
* @param window. The window to be used by this application.
*/
CMediaPlayer(CTaskbar *taskbar, CApplicationWindow *window);
/**
* CMediaPlayer destructor
*/
~CMediaPlayer(void);
/**
* Each implementation of IApplication must provide a method to recover
* the contained CApplicationWindow instance.
*/
IApplicationWindow *getWindow(void) const;
/**
* Get the icon associated with the application
*
* @return An instance if IBitmap that may be used to rend the
* application's icon. This is an new IBitmap instance that must
* be deleted by the caller when it is no long needed.
*/
NXWidgets::IBitmap *getIcon(void);
/**
* Get the name string associated with the application
*
* @return A copy if CNxString that contains the name of the application.
*/
NXWidgets::CNxString getName(void);
/**
* Start the application (perhaps in the minimized state).
*
* @return True if the application was successfully started.
*/
bool run(void);
/**
* Stop the application.
*/
void stop(void);
/**
* Destroy the application and free all of its resources. This method
* will initiate blocking of messages from the NX server. The server
* will flush the window message queue and reply with the blocked
* message. When the block message is received by CWindowMessenger,
* it will send the destroy message to the start window task which
* will, finally, safely delete the application.
*/
void destroy(void);
/**
* The application window is hidden (either it is minimized or it is
* maximized, but not at the top of the hierarchy
*/
void hide(void);
/**
* Redraw the entire window. The application has been maximized or
* otherwise moved to the top of the hierarchy. This method is call from
* CTaskbar when the application window must be displayed
*/
void redraw(void);
/**
* Report of this is a "normal" window or a full screen window. The
* primary purpose of this method is so that window manager will know
* whether or not it show draw the task bar.
*
* @return True if this is a full screen window.
*/
bool isFullScreen(void) const;
};
class CMediaPlayerFactory : public IApplicationFactory
{
private:
CTaskbar *m_taskbar; /**< The taskbar */
public:
/**
* CMediaPlayerFactory Constructor
*
* @param taskbar. The taskbar instance used to terminate calibration
*/
CMediaPlayerFactory(CTaskbar *taskbar);
/**
* CMediaPlayerFactory Destructor
*/
inline ~CMediaPlayerFactory(void) { }
/**
* Create a new instance of an CMediaPlayer (as IApplication).
*/
IApplication *create(void);
/**
* Get the icon associated with the application
*
* @return An instance if IBitmap that may be used to rend the
* application's icon. This is an new IBitmap instance that must
* be deleted by the caller when it is no long needed.
*/
NXWidgets::IBitmap *getIcon(void);
};
}
#endif // __cplusplus
#endif // __APPS_INCLUDE_GRAPHICS_NXWM_CMEDIAPLAYER_HXX