596 lines
17 KiB
C++
596 lines
17 KiB
C++
/**********************************************************************
|
|
|
|
Audacity - A Digital Audio Editor
|
|
Copyright 1999-2018 Audacity Team
|
|
License: wxWidgets
|
|
|
|
James Crook
|
|
|
|
******************************************************************//**
|
|
|
|
\file GetInfoCommand.cpp
|
|
\brief Contains definitions for GetInfoCommand class.
|
|
This class now lists
|
|
- Commands
|
|
- Menus
|
|
- Tracks
|
|
- Clips
|
|
- Labels
|
|
- Boxes
|
|
|
|
*//*******************************************************************/
|
|
|
|
#include "../Audacity.h"
|
|
#include "GetInfoCommand.h"
|
|
#include "../Project.h"
|
|
#include "CommandManager.h"
|
|
#include "../effects/EffectManager.h"
|
|
#include "../widgets/Overlay.h"
|
|
#include "../widgets/OverlayPanel.h"
|
|
#include "../TrackPanel.h"
|
|
#include "../Track.h"
|
|
#include "../WaveTrack.h"
|
|
#include "../LabelTrack.h"
|
|
#include "../Envelope.h"
|
|
#include "CommandContext.h"
|
|
|
|
#include "SelectCommand.h"
|
|
#include "../Project.h"
|
|
#include "../ShuttleGui.h"
|
|
#include "CommandContext.h"
|
|
|
|
#include "../prefs/PrefsDialog.h"
|
|
#include "../ShuttleGui.h"
|
|
|
|
enum {
|
|
kCommands,
|
|
//kCommandsPlus,
|
|
kMenus,
|
|
kPreferences,
|
|
kTracks,
|
|
kClips,
|
|
kEnvelopes,
|
|
kLabels,
|
|
kBoxes,
|
|
nTypes
|
|
};
|
|
|
|
static const ComponentInterfaceSymbol kTypes[nTypes] =
|
|
{
|
|
{ XO("Commands") },
|
|
//{ wxT("CommandsPlus"), XO("Commands Plus") },
|
|
{ XO("Menus") },
|
|
{ XO("Preferences") },
|
|
{ XO("Tracks") },
|
|
{ XO("Clips") },
|
|
{ XO("Envelopes") },
|
|
{ XO("Labels") },
|
|
{ XO("Boxes") },
|
|
};
|
|
|
|
enum {
|
|
kJson,
|
|
kLisp,
|
|
kBrief,
|
|
nFormats
|
|
};
|
|
|
|
static const ComponentInterfaceSymbol kFormats[nFormats] =
|
|
{
|
|
// These are acceptable dual purpose internal/visible names
|
|
|
|
/* i18n-hint JavaScript Object Notation */
|
|
{ XO("JSON") },
|
|
/* i18n-hint name of a computer programming language */
|
|
{ XO("LISP") },
|
|
{ XO("Brief") }
|
|
};
|
|
|
|
|
|
|
|
bool GetInfoCommand::DefineParams( ShuttleParams & S ){
|
|
S.DefineEnum( mInfoType, wxT("Type"), 0, kTypes, nTypes );
|
|
S.DefineEnum( mFormat, wxT("Format"), 0, kFormats, nFormats );
|
|
return true;
|
|
}
|
|
|
|
void GetInfoCommand::PopulateOrExchange(ShuttleGui & S)
|
|
{
|
|
auto types = LocalizedStrings( kTypes, nTypes );
|
|
auto formats = LocalizedStrings( kFormats, nFormats );
|
|
S.AddSpace(0, 5);
|
|
|
|
S.StartMultiColumn(2, wxALIGN_CENTER);
|
|
{
|
|
S.TieChoice( _("Type:"), mInfoType, &types);
|
|
S.TieChoice( _("Format:"), mFormat, &formats);
|
|
}
|
|
S.EndMultiColumn();
|
|
}
|
|
|
|
bool GetInfoCommand::Apply(const CommandContext &context)
|
|
{
|
|
if( mFormat == kJson )
|
|
return ApplyInner( context );
|
|
|
|
if( mFormat == kLisp )
|
|
{
|
|
CommandContext LispyContext(
|
|
*(context.GetProject()),
|
|
std::make_unique<LispifiedCommandOutputTargets>( *context.pOutput.get() )
|
|
);
|
|
return ApplyInner( LispyContext );
|
|
}
|
|
|
|
if( mFormat == kBrief )
|
|
{
|
|
CommandContext BriefContext(
|
|
*(context.GetProject()),
|
|
std::make_unique<BriefCommandOutputTargets>( *context.pOutput.get() )
|
|
);
|
|
return ApplyInner( BriefContext );
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
bool GetInfoCommand::ApplyInner(const CommandContext &context)
|
|
{
|
|
switch( mInfoType ){
|
|
case kCommands : return SendCommands( context, 0 );
|
|
//case kCommandsPlus : return SendCommands( context, 1 );
|
|
case kMenus : return SendMenus( context );
|
|
case kPreferences : return SendPreferences( context );
|
|
case kTracks : return SendTracks( context );
|
|
case kClips : return SendClips( context );
|
|
case kEnvelopes : return SendEnvelopes( context );
|
|
case kLabels : return SendLabels( context );
|
|
case kBoxes : return SendBoxes( context );
|
|
default:
|
|
context.Status( "Command options not recognised" );
|
|
}
|
|
return false;
|
|
}
|
|
|
|
bool GetInfoCommand::SendMenus(const CommandContext &context)
|
|
{
|
|
wxMenuBar * pBar = context.GetProject()->GetMenuBar();
|
|
if(!pBar ){
|
|
wxLogDebug("No menus");
|
|
return false;
|
|
}
|
|
|
|
size_t cnt = pBar->GetMenuCount();
|
|
size_t i;
|
|
wxString Label;
|
|
context.StartArray();
|
|
for(i=0;i<cnt;i++)
|
|
{
|
|
Label = pBar->GetMenuLabelText( i );
|
|
context.StartStruct();
|
|
context.AddItem( 0, "depth" );
|
|
context.AddItem( 0, "flags" );
|
|
context.AddItem( Label, "label" );
|
|
context.AddItem( "", "accel" );
|
|
context.EndStruct();
|
|
ExploreMenu( context, pBar->GetMenu( i ), pBar->GetId(), 1 );
|
|
}
|
|
context.EndArray();
|
|
return true;
|
|
}
|
|
|
|
bool GetInfoCommand::SendPreferences(const CommandContext &context)
|
|
{
|
|
context.StartArray();
|
|
GlobalPrefsDialog dialog( context.GetProject() );
|
|
// wxCommandEvent Evt;
|
|
//dialog.Show();
|
|
wxWindow * pWin = context.GetProject();
|
|
ShuttleGuiGetDefinition S(pWin, *((context.pOutput)->mStatusTarget) );
|
|
dialog.ShuttleAll( S );
|
|
context.EndArray();
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
Send the list of commands.
|
|
*/
|
|
bool GetInfoCommand::SendCommands(const CommandContext &context, int flags )
|
|
{
|
|
context.StartArray();
|
|
PluginManager & pm = PluginManager::Get();
|
|
EffectManager & em = EffectManager::Get();
|
|
{
|
|
const PluginDescriptor *plug = pm.GetFirstPlugin(PluginTypeEffect | PluginTypeAudacityCommand);
|
|
while (plug)
|
|
{
|
|
auto command = em.GetCommandIdentifier(plug->GetID());
|
|
if (!command.IsEmpty()){
|
|
em.GetCommandDefinition( plug->GetID(), context, flags );
|
|
}
|
|
plug = pm.GetNextPlugin(PluginTypeEffect | PluginTypeAudacityCommand );
|
|
}
|
|
}
|
|
context.EndArray();
|
|
return true;
|
|
}
|
|
|
|
bool GetInfoCommand::SendBoxes(const CommandContext &context)
|
|
{
|
|
//context.Status("Boxes");
|
|
wxWindow * pWin = context.GetProject();
|
|
|
|
context.StartArray();
|
|
wxRect R = pWin->GetScreenRect();
|
|
|
|
//R.SetPosition( wxPoint(0,0) );
|
|
|
|
//wxString Name = pWin->GetName();
|
|
context.StartStruct();
|
|
context.AddItem( 0, "depth" );
|
|
context.AddItem( "Audacity Window", "name" );
|
|
context.StartField( "box" );
|
|
context.StartArray( );
|
|
context.AddItem( R.GetLeft() );
|
|
context.AddItem( R.GetTop() );
|
|
context.AddItem( R.GetRight() );
|
|
context.AddItem( R.GetBottom() );
|
|
context.EndArray( );
|
|
context.EndField();
|
|
context.EndStruct( );
|
|
|
|
ExploreAdornments( context, pWin->GetPosition()+wxSize( 6,-1), pWin, pWin->GetId(), 1 );
|
|
ExploreWindows( context, pWin->GetPosition()+wxSize( 6,-1), pWin, pWin->GetId(), 1 );
|
|
context.EndArray( );
|
|
return true;
|
|
}
|
|
|
|
bool GetInfoCommand::SendTracks(const CommandContext & context)
|
|
{
|
|
TrackList *projTracks = context.GetProject()->GetTracks();
|
|
context.StartArray();
|
|
for (auto trk : projTracks->Leaders())
|
|
{
|
|
|
|
TrackPanel *panel = context.GetProject()->GetTrackPanel();
|
|
Track * fTrack = panel->GetFocusedTrack();
|
|
|
|
context.StartStruct();
|
|
context.AddItem( trk->GetName(), "name" );
|
|
context.AddBool( (trk == fTrack), "focused");
|
|
context.AddBool( trk->GetSelected(), "selected" );
|
|
//JKC: Possibly add these two later...
|
|
//context.AddItem( trk->GetKind(), "kind" );
|
|
//context.AddItem( trk->GetHeight(), "height" );
|
|
trk->TypeSwitch( [&] (const WaveTrack* t ) {
|
|
context.AddItem( t->GetStartTime(), "start" );
|
|
context.AddItem( t->GetEndTime(), "end" );
|
|
context.AddItem( t->GetPan() , "pan");
|
|
context.AddItem( t->GetGain() , "gain");
|
|
context.AddItem( TrackList::Channels(t).size(), "channels");
|
|
context.AddBool( t->GetSolo(), "solo" );
|
|
context.AddBool( t->GetMute(), "mute");
|
|
} );
|
|
context.EndStruct();
|
|
}
|
|
context.EndArray();
|
|
return true;
|
|
}
|
|
|
|
bool GetInfoCommand::SendClips(const CommandContext &context)
|
|
{
|
|
TrackList *tracks = context.GetProject()->GetTracks();
|
|
int i=0;
|
|
context.StartArray();
|
|
for (auto waveTrack : tracks->Leaders<WaveTrack>()) {
|
|
WaveClipPointers ptrs( waveTrack->SortedClipArray());
|
|
for(WaveClip * pClip : ptrs ) {
|
|
context.StartStruct();
|
|
context.AddItem( (double)i, "track" );
|
|
context.AddItem( pClip->GetStartTime(), "start" );
|
|
context.AddItem( pClip->GetEndTime(), "end" );
|
|
context.AddItem( pClip->GetColourIndex(), "color" );
|
|
context.EndStruct();
|
|
}
|
|
i++;
|
|
}
|
|
context.EndArray();
|
|
|
|
return true;
|
|
}
|
|
|
|
bool GetInfoCommand::SendEnvelopes(const CommandContext &context)
|
|
{
|
|
TrackList *tracks = context.GetProject()->GetTracks();
|
|
int i=0;
|
|
int j=0;
|
|
context.StartArray();
|
|
for (auto waveTrack : tracks->Leaders<WaveTrack>()) {
|
|
WaveClipPointers ptrs( waveTrack->SortedClipArray());
|
|
for(WaveClip * pClip : ptrs ) {
|
|
context.StartStruct();
|
|
context.AddItem( (double)i, "track" );
|
|
context.AddItem( (double)j, "clip" );
|
|
context.AddItem( pClip->GetStartTime(), "start" );
|
|
Envelope * pEnv = pClip->GetEnvelope();
|
|
context.StartField( "points" );
|
|
context.StartArray();
|
|
double offset = pEnv->mOffset;
|
|
for( size_t k=0;k<pEnv->mEnv.size(); k++)
|
|
{
|
|
context.StartStruct( );
|
|
context.AddItem( pEnv->mEnv[k].GetT()+offset, "t" );
|
|
context.AddItem( pEnv->mEnv[k].GetVal(), "y" );
|
|
context.EndStruct();
|
|
}
|
|
context.EndArray();
|
|
context.EndField();
|
|
context.AddItem( pClip->GetEndTime(), "end" );
|
|
context.EndStruct();
|
|
j++;
|
|
}
|
|
}
|
|
context.EndArray();
|
|
|
|
return true;
|
|
}
|
|
|
|
|
|
bool GetInfoCommand::SendLabels(const CommandContext &context)
|
|
{
|
|
TrackList *tracks = context.GetProject()->GetTracks();
|
|
int i=0;
|
|
context.StartArray();
|
|
for (auto t : tracks->Leaders()) {
|
|
t->TypeSwitch( [&](LabelTrack *labelTrack) {
|
|
#ifdef VERBOSE_LABELS_FORMATTING
|
|
for (int nn = 0; nn< (int)labelTrack->mLabels.size(); nn++) {
|
|
const auto &label = labelTrack->mLabels[nn];
|
|
context.StartStruct();
|
|
context.AddItem( (double)i, "track" );
|
|
context.AddItem( label.getT0(), "start" );
|
|
context.AddItem( label.getT1(), "end" );
|
|
context.AddItem( label.title, "text" );
|
|
context.EndStruct();
|
|
}
|
|
#else
|
|
context.StartArray();
|
|
context.AddItem( (double)i ); // Track number.
|
|
context.StartArray();
|
|
for (int nn = 0; nn< (int)labelTrack->mLabels.size(); nn++) {
|
|
const auto &label = labelTrack->mLabels[nn];
|
|
context.StartArray();
|
|
context.AddItem( label.getT0() ); // start
|
|
context.AddItem( label.getT1() ); // end
|
|
context.AddItem( label.title ); //text.
|
|
context.EndArray();
|
|
}
|
|
context.EndArray();
|
|
context.EndArray();
|
|
#endif
|
|
} );
|
|
// Per track numbering counts all tracks
|
|
i++;
|
|
}
|
|
context.EndArray();
|
|
|
|
|
|
|
|
return true;
|
|
}
|
|
|
|
/*******************************************************************
|
|
The various Explore functions are called from the Send functions,
|
|
and may be recursive. 'Send' is the top level.
|
|
*******************************************************************/
|
|
|
|
void GetInfoCommand::ExploreMenu( const CommandContext &context, wxMenu * pMenu, int Id, int depth ){
|
|
static_cast<void>(Id);//compiler food.
|
|
if( !pMenu )
|
|
return;
|
|
|
|
CommandManager * pMan = context.GetProject()->GetCommandManager();
|
|
|
|
wxMenuItemList list = pMenu->GetMenuItems();
|
|
size_t lcnt = list.GetCount();
|
|
wxMenuItem * item;
|
|
wxString Label;
|
|
wxString Accel;
|
|
wxString Name;
|
|
|
|
for (size_t lndx = 0; lndx < lcnt; lndx++) {
|
|
item = list.Item(lndx)->GetData();
|
|
Label = item->GetItemLabelText();
|
|
Name = pMan->GetNameFromID( item->GetId() );
|
|
Accel = item->GetItemLabel();
|
|
if( Accel.Contains("\t") )
|
|
Accel = Accel.AfterLast('\t');
|
|
else
|
|
Accel = "";
|
|
if( item->IsSeparator() )
|
|
Label = "----";
|
|
int flags = 0;
|
|
if (item->IsSubMenu())
|
|
flags +=1;
|
|
if (item->IsCheck() && item->IsChecked())
|
|
flags +=2;
|
|
|
|
context.StartStruct();
|
|
context.AddItem( depth, "depth" );
|
|
context.AddItem( flags, "flags" );
|
|
context.AddItem( Label, "label" );
|
|
context.AddItem( Accel, "accel" );
|
|
if( !Name.IsEmpty() )
|
|
context.AddItem( Name, "id" );// It is called Scripting ID outside Audacity.
|
|
context.EndStruct();
|
|
|
|
if (item->IsSubMenu()) {
|
|
pMenu = item->GetSubMenu();
|
|
ExploreMenu( context, pMenu, item->GetId(), depth+1 );
|
|
}
|
|
}
|
|
}
|
|
|
|
void GetInfoCommand::ExploreAdornments( const CommandContext &context,
|
|
wxPoint WXUNUSED(P), wxWindow * pWin, int WXUNUSED(Id), int depth )
|
|
{
|
|
// Dang! wxMenuBar returns bogus screen rect.
|
|
// We're going to have to fake it instead.
|
|
//wxMenuBar * pBar = context.GetProject()->GetMenuBar();
|
|
//wxRect R = pBar->GetScreenRect();
|
|
//R.SetPosition( R.GetPosition() - P );
|
|
|
|
wxRect R1 = pWin->GetScreenRect();
|
|
wxSize s = pWin->GetWindowBorderSize();
|
|
wxRect R( 2,32, R1.GetWidth() - s.GetWidth() * 2 -16, 22 );
|
|
|
|
context.StartStruct();
|
|
context.AddItem( depth, "depth" );
|
|
context.AddItem( "MenuBar", "label" );
|
|
context.StartField( "box" );
|
|
context.StartArray();
|
|
context.AddItem( R.GetLeft() );
|
|
context.AddItem( R.GetTop() );
|
|
context.AddItem( R.GetRight() );
|
|
context.AddItem( R.GetBottom() );
|
|
context.EndArray();
|
|
context.EndField();
|
|
context.EndStruct();
|
|
}
|
|
|
|
void GetInfoCommand::ExploreTrackPanel( const CommandContext &context,
|
|
wxPoint P, wxWindow * pWin, int WXUNUSED(Id), int depth )
|
|
{
|
|
AudacityProject * pProj = context.GetProject();
|
|
TrackPanel * pTP = pProj->GetTrackPanel();
|
|
|
|
wxRect trackRect = pWin->GetRect();
|
|
|
|
for (auto t : pProj->GetTracks()->Any() + IsVisibleTrack{ pProj }) {
|
|
trackRect.y = t->GetY() - pTP->mViewInfo->vpos;
|
|
trackRect.height = t->GetHeight();
|
|
|
|
#if 0
|
|
// Work in progress on getting the TCP button positions and sizes.
|
|
wxRect rect = trackRect;
|
|
Track *l = t->GetLink();
|
|
|
|
if (t->GetLinked()) {
|
|
rect.height += l->GetHeight();
|
|
}
|
|
|
|
switch (t->GetKind()) {
|
|
case Track::Wave:
|
|
{
|
|
break;
|
|
}
|
|
#ifdef USE_MIDI
|
|
case Track::Note:
|
|
{
|
|
break;
|
|
}
|
|
#endif // USE_MIDI
|
|
case Track::Label:
|
|
break;
|
|
case Track::Time:
|
|
break;
|
|
}
|
|
{
|
|
// Start with whole track rect
|
|
wxRect R = trackRect;
|
|
|
|
// Now exclude left, right, and top insets
|
|
R.x += kLeftInset;
|
|
R.y += kTopInset;
|
|
R.width -= kLeftInset * 2;
|
|
R.height -= kTopInset;
|
|
|
|
int labelw = pTP->GetLabelWidth();
|
|
int vrul = pTP->GetVRulerOffset();
|
|
bool bIsWave = true;
|
|
//mTrackInfo.DrawBackground(dc, R, t->GetSelected(), bIsWave, labelw, vrul);
|
|
|
|
|
|
for (Overlay * pOverlay : pTP->mOverlays) {
|
|
auto R2(pOverlay->GetRectangle(trackRect.GetSize()).first);
|
|
context.Status( wxString::Format(" [ %2i, %3i, %3i, %3i, %3i, \"%s\" ],",
|
|
depth, R2.GetLeft(), R2.GetTop(), R2.GetRight(), R2.GetBottom(), "Overthing" ));
|
|
}
|
|
}
|
|
#endif
|
|
|
|
// The VRuler.
|
|
{
|
|
wxRect R = trackRect;
|
|
R.x += pTP->GetVRulerOffset();
|
|
R.y += kTopMargin;
|
|
R.width = pTP->GetVRulerWidth();
|
|
R.height -= (kTopMargin + kBottomMargin);
|
|
R.SetPosition( R.GetPosition() + P );
|
|
|
|
context.StartStruct();
|
|
context.AddItem( depth, "depth" );
|
|
context.AddItem( "VRuler", "label" );
|
|
context.StartField("box");
|
|
context.StartArray();
|
|
context.AddItem( R.GetLeft() );
|
|
context.AddItem( R.GetTop() );
|
|
context.AddItem( R.GetRight() );
|
|
context.AddItem( R.GetBottom() );
|
|
context.EndArray();
|
|
context.EndField();
|
|
context.EndStruct();
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
void GetInfoCommand::ExploreWindows( const CommandContext &context,
|
|
wxPoint P, wxWindow * pWin, int Id, int depth )
|
|
{
|
|
static_cast<void>(Id);//Compiler food.
|
|
|
|
if( pWin->GetName() == "Track Panel" )
|
|
{
|
|
wxRect R = pWin->GetScreenRect();
|
|
ExploreTrackPanel( context, R.GetPosition()-P, pWin, Id, depth );
|
|
return;
|
|
}
|
|
wxWindowList list = pWin->GetChildren();
|
|
size_t lcnt = list.GetCount();
|
|
|
|
for (size_t lndx = 0; lndx < lcnt; lndx++) {
|
|
wxWindow * item = list[lndx];
|
|
if( !item->IsShown() )
|
|
continue;
|
|
wxRect R = item->GetScreenRect();
|
|
R.SetPosition( R.GetPosition() - P );
|
|
wxString Name = item->GetName();
|
|
// Ignore staticLine and StaticBitmap.
|
|
if( Name.StartsWith( "static" ) )
|
|
continue;
|
|
// Ignore anonymous panels.
|
|
if( Name == "panel" )
|
|
continue;
|
|
if( Name.IsEmpty() )
|
|
Name = wxString("*") + item->GetToolTipText();
|
|
|
|
context.StartStruct();
|
|
context.AddItem( depth, "depth" );
|
|
context.AddItem( Name, "label" );
|
|
context.AddItem( item->GetId(), "id" );
|
|
context.StartField( "box" );
|
|
context.StartArray();
|
|
context.AddItem( R.GetLeft() );
|
|
context.AddItem( R.GetTop() );
|
|
context.AddItem( R.GetRight() );
|
|
context.AddItem( R.GetBottom() );
|
|
context.EndArray();
|
|
context.EndField();
|
|
context.EndStruct();
|
|
|
|
ExploreWindows( context, P, item, item->GetId(), depth+1 );
|
|
}
|
|
}
|
|
|