Dev:Adding a Sound notification - Revision history

BobSynfig: /* synfig-studio/src/gui/app.cpp */

2018-12-18T23:54:19Z

‎synfig-studio/src/gui/app.cpp

BobSynfig at 20:25, 16 December 2018

2018-12-16T20:25:25Z

BobSynfig: 2nd part

2018-12-16T20:23:23Z

2nd part

BobSynfig: 1st Part

2018-12-16T19:40:55Z

1st Part

BobSynfig: Page creation

2018-12-16T13:59:55Z

Page creation

New page

=== WIP ===

=== synfig-studio/src/gui/app.h ===
Declare the sound (Mix_Chunk*) as a static member.

//The sound effects that will be used
static Mix_Chunk* gRenderDone;

You could add a bool declare as a static member for an option to play.
bool App::use_render_done_sound = true;

=== synfig-studio/src/gui/app.cpp ===
Initialize the sound (Mix_Chunk*) to NULL.
You could find the gRenderDone and add it after.

Mix_Chunk* App::gRenderDone = NULL;

As well you may add a bool for
bool App::use_render_done_sound = true;

=== synfig-studio/src/gui/<yourSource>.cpp ===
You should add
#include <SDL2/SDL.h>
#include <SDL2/SDL_mixer.h>

Add your sound effect play where it should be (end of an event for example)
//Sound effect - RenderDone (-1 : play on first free channel, 0 : no repeat)
Mix_PlayChannel( -1, App::gRenderDone, 0 );

@@ Line 89: / Line 89: @@
   toggle_play_sound_on_render_done.set_active(App::use_render_done_sound);
 === synfig-studio/src/gui/app.cpp ===
-* In ''class Preferences : public synfigapp::Settings'',
+* In ''class Preferences'',
 among the saving parts
   if(key=="use_render_done_sound")
@@ Line 105: / Line 105: @@
 * In the ret.push_back part, add
   ret.push_back("use_render_done_sound");
 Dont forget some parts have been done in the first section
 Hoping it will be sufficient to understand the whole system :)

@@ Line 17: / Line 17: @@
   static Mix_Chunk* gRenderDone;
-[[You could add a bool declared as a static member for an option to play the sound (to be defined in Preferences dialog).]]
+''You could add a bool declared as a static member for an option to play the sound (to be defined in Preferences dialog).''
   static bool use_render_done_sound;
@@ Line 25: / Line 25: @@
   Mix_Chunk* App::gRenderDone = NULL;
-[[As well you may initialize the bool for allow to play the sound; this will be connected later in the Preferences dialog]]
+''As well you may initialize the bool for allow to play the sound; this will be connected later in the Preferences dialog''
   bool App::use_render_done_sound = true;
 * Locate this part (at the end of the constructor App::App )
@@ Line 53: / Line 53: @@
   Mix_PlayChannel( -1, App::gRenderDone, 0 );
 '''or'''<br />
-) [[Play according the preferences]]
+) ''Play according the preferences''
   //Sound effect - RenderDone (-1 : play on first free channel, 0 : no repeat)
   if (App::use_render_done_sound) Mix_PlayChannel( -1, App::gRenderDone, 0 );

@@ Line 4: / Line 4: @@
 * Adding the sound notification
 * Adding an option to Preferences dialog
 == Adding the sound notification ==
@@ Line 10: / Line 9: @@
 === synfig-studio/sounds/ ===
 * Add your sample in this directory in your source tree<br />
-* Add a notice about the license of your sample in readme.txt (the asset should have a permissive license)<br />
+* Add a notice about the license of your sample in ''readme.txt'' (the asset should have a permissive license)<br />
-* Add your sound sample to the list in Makefile.am
+* Add your sound sample to the list in ''Makefile.am''
 === synfig-studio/src/gui/app.h ===
@@ Line 18: / Line 17: @@
   static Mix_Chunk* gRenderDone;
-You could add a bool declared as a static member for an option to play the sound (to be defined in Preferences dialog).
+[[You could add a bool declared as a static member for an option to play the sound (to be defined in Preferences dialog).]]
-  bool       App::use_render_done_sound = true;
+  static bool use_render_done_sound;
 === synfig-studio/src/gui/app.cpp ===
 * Initialize the sound (Mix_Chunk*) to NULL.<br />
 You could find the gRenderDone and add it after.
-  Mix_Chunk* App::gRenderDone           = NULL;
+  Mix_Chunk* App::gRenderDone = NULL;
-−
-As well you may add a bool for allow to play the sound; this will be connected later in the Preferences dialog
- bool       App::use_render_done_sound = true;
 * Locate this part (at the end of the constructor App::App )
   path_to_sounds += ETL_DIRECTORY_SEPARATOR;
 and load your sound as follow (the volume is set at 50% if success)
   //Load sound effects
@@ Line 40: / Line 37: @@
       Mix_VolumeChunk(App::gRenderDone, MIX_MAX_VOLUME/2);
+  }
 * Finally, free the sound in the destructor App::~App(and NULL the pointer)
   //<!- ----- SDL2 - Sound effects -----
@@ Line 51: / Line 47: @@
   #include <SDL2/SDL.h>
   #include <SDL2/SDL_mixer.h>
 * Add your sound effect play where it should be (end of an event for example)<br />
 You have 2 possibilities after this<br />
@@ Line 58: / Line 53: @@
   Mix_PlayChannel( -1, App::gRenderDone, 0 );
 '''or'''<br />
-) Play according the preferences
+) [[Play according the preferences]]
   //Sound effect - RenderDone (-1 : play on first free channel, 0 : no repeat)
   if (App::use_render_done_sound) Mix_PlayChannel( -1, App::gRenderDone, 0 );