Home > Articles > Programming > General Programming/Other Languages

📄 Contents

  1. Defining Properties
  2. An Example of DefineProperty()
  3. TddgWaveFile: An Example of DefineBinaryProperty()
  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

TddgWaveFile: An Example of DefineBinaryProperty()

We mentioned earlier that a good time to use DefineBinaryProperty() is when you need to store graphic or sound information along with a component. In fact, VCL uses this technique for storing images associated with components—the Glyph of a TBitBtn, for example, or the Icon of a TForm. In this section, you'll learn how to use this technique when storing the sound associated with the TddgWaveFile component.

The DefineProperties() method for TddgWaveFile is as follows:

procedure TddgWaveFile.DefineProperties(Filer: TFiler);
{ Defines binary property called "Data" for FData field. }
{ This allows FData to be read from and written to DFM file. }

 function DoWrite: Boolean;
 begin
  if Filer.Ancestor <> nil then
   Result := not (Filer.Ancestor is TddgWaveFile) or
    not Equal(TddgWaveFile(Filer.Ancestor))
  else
   Result := not Empty;
 end;

begin
 inherited DefineProperties(Filer);
 Filer.DefineBinaryProperty('Data', ReadData, WriteData, DoWrite);
end;

This method defines a binary property called Data, which is read and written using the component's ReadData() and WriteData() methods. Additionally, data is written only if the return value of DoWrite() is True. (You'll learn more about DoWrite() in just a moment.)

The ReadData() and WriteData() methods are defined as follows:

procedure TddgWaveFile.ReadData(Stream: TStream);
{ Reads WAV data from DFM stream. }
begin
 LoadFromStream(Stream);
end;

procedure TddgWaveFile.WriteData(Stream: TStream);
{ Writes WAV data to DFM stream }
begin
 SaveToStream(Stream);
end;

As you can see, there isn't much to these methods; they simply call the LoadFromStream() and SaveToStream() methods, which are also defined by the TddgWaveFile component. The LoadFromStream() method is as follows:

procedure TddgWaveFile.LoadFromStream(S: TStream);
{ Loads WAV data from stream S. This procedure will free }
{ any memory previously allocated for FData. }
begin
 if not Empty then
  FreeMem(FData, FDataSize);
 FDataSize := 0;
 FData := AllocMem(S.Size);
 FDataSize := S.Size;
 S.Read(FData^, FDataSize);
end;

This method first checks whether memory has been previously allocated by testing the value of the FDataSize field. If it's greater than zero, the memory pointed to by the FData field is freed. At that point, a new block of memory is allocated for FData, and FDataSize is set to the size of the incoming data stream. The contents of the stream are then read into the FData pointer.

The SaveToStream() method is much simpler; it's defined as follows:

procedure TddgWaveFile.SaveToStream(S: TStream);
{ Saves WAV data to stream S. }
begin
 if FDataSize > 0 then
  S.Write(FData^, FDataSize);
end;

This method writes the data pointed to by pointer FData to TStream S.

The local DoWrite() function inside the DefineProperties() method determines whether the Data property needs to be streamed. Of course, if FData is empty, there's no need to stream data. Additionally, you must take extra measures to ensure that your component works correctly with form inheritance: You must check whether the Ancestor property for Filer is non-nil. If it is, and it points to an ancestor version of the current component, you must check whether the data you're about to write is different from the ancestor. If you don't perform these additional tests, a copy of the data (the wave file, in this case) will be written in each of the descendant forms, and changes to the ancestor's wave file won't be copied to the descendant forms.

Listing 2 shows Wavez.pas, which includes the complete source code for the component.

Listing 2—Wavez.pas Illustrates a Component Encapsulating a Wave File

unit Wavez;

interface

uses
 SysUtils, Classes;

type
 { Special string "descendant" used to make a property editor. }
 TWaveFileString = type string;

 EWaveError = class(Exception);

 TWavePause = (wpAsync, wpsSync);
 TWaveLoop = (wlNoLoop, wlLoop);

 TddgWaveFile = class(TComponent)
 private
  FData: Pointer;
  FDataSize: Integer;
  FWaveName: TWaveFileString;
  FWavePause: TWavePause;
  FWaveLoop: TWaveLoop;
  FOnPlay: TNotifyEvent;
  FOnStop: TNotifyEvent;
  procedure SetWaveName(const Value: TWaveFileString);
  procedure WriteData(Stream: TStream);
  procedure ReadData(Stream: TStream);
 protected
  procedure DefineProperties(Filer: TFiler); override;
 public
  destructor Destroy; override;
  function Empty: Boolean;
  function Equal(Wav: TddgWaveFile): Boolean;
  procedure LoadFromFile(const FileName: String);
  procedure LoadFromStream(S: TStream);
  procedure Play;
  procedure SaveToFile(const FileName: String);
  procedure SaveToStream(S: TStream);
  procedure Stop;
 published
  property WaveLoop: TWaveLoop read FWaveLoop write FWaveLoop;
  property WaveName: TWaveFileString read FWaveName write SetWaveName;
  property WavePause: TWavePause read FWavePause write FWavePause;
  property OnPlay: TNotifyEvent read FOnPlay write FOnPlay;
  property OnStop: TNotifyEvent read FOnStop write FOnStop;
 end;

implementation

uses MMSystem, Windows;

{ TddgWaveFile }

destructor TddgWaveFile.Destroy;
{ Ensures that any allocated memory is freed }
begin
 if not Empty then
  FreeMem(FData, FDataSize);
 inherited Destroy;
end;

function StreamsEqual(S1, S2: TMemoryStream): Boolean;
begin
 Result := (S1.Size = S2.Size) and CompareMem(S1.Memory, S2.Memory, S1.Size);
end;

procedure TddgWaveFile.DefineProperties(Filer: TFiler);
{ Defines binary property called "Data" for FData field. }
{ This allows FData to be read from and written to DFM file. }

 function DoWrite: Boolean;
 begin
  if Filer.Ancestor <> nil then
   Result := not (Filer.Ancestor is TddgWaveFile) or
    not Equal(TddgWaveFile(Filer.Ancestor))
  else
   Result := not Empty;
 end;

begin
 inherited DefineProperties(Filer);
 Filer.DefineBinaryProperty('Data', ReadData, WriteData, DoWrite);
end;

function TddgWaveFile.Empty: Boolean;
begin
 Result := FDataSize = 0;
end;

function TddgWaveFile.Equal(Wav: TddgWaveFile): Boolean;
var
 MyImage, WavImage: TMemoryStream;
begin
 Result := (Wav <> nil) and (ClassType = Wav.ClassType);
 if Empty or Wav.Empty then
 begin
  Result := Empty and Wav.Empty;
  Exit;
 end;
 if Result then
 begin
  MyImage := TMemoryStream.Create;
  try
   SaveToStream(MyImage);
   WavImage := TMemoryStream.Create;
   try
    Wav.SaveToStream(WavImage);
    Result := StreamsEqual(MyImage, WavImage);
   finally
    WavImage.Free;
   end;
  finally
   MyImage.Free;
  end;
 end;
end;

procedure TddgWaveFile.LoadFromFile(const FileName: String);
{ Loads WAV data from FileName. Note that this procedure }
{ does not set the WaveName property. }
var
 F: TFileStream;
begin
 F := TFileStream.Create(FileName, fmOpenRead);
 try
  LoadFromStream(F);
 finally
  F.Free;
 end;
end;

procedure TddgWaveFile.LoadFromStream(S: TStream);
{ Loads WAV data from stream S. This procedure will free }
{ any memory previously allocated for FData. }
begin
 if not Empty then
  FreeMem(FData, FDataSize);
 FDataSize := 0;
 FData := AllocMem(S.Size);
 FDataSize := S.Size;
 S.Read(FData^, FDataSize);
end;

procedure TddgWaveFile.Play;
{ Plays the WAV sound in FData using the parameters found in }
{ FWaveLoop and FWavePause. }
const
 LoopArray: array[TWaveLoop] of DWORD = (0, SND_LOOP);
 PauseArray: array[TWavePause] of DWORD = (SND_ASYNC, SND_SYNC);
begin
 { Make sure component contains data }
 if Empty then
  raise EWaveError.Create('No wave data');
 if Assigned(FOnPlay) then FOnPlay(Self);  // fire event
 { attempt to play wave sound }
 if not PlaySound(FData, 0, SND_MEMORY or PauseArray[FWavePause] or
          LoopArray[FWaveLoop]) then
  raise EWaveError.Create('Error playing sound');
end;

procedure TddgWaveFile.ReadData(Stream: TStream);
{ Reads WAV data from DFM stream. }
begin
 LoadFromStream(Stream);
end;

procedure TddgWaveFile.SaveToFile(const FileName: String);
{ Saves WAV data to file FileName. }
var
 F: TFileStream;
begin
 F := TFileStream.Create(FileName, fmCreate);
 try
  SaveToStream(F);
 finally
  F.Free;
 end;
end;

procedure TddgWaveFile.SaveToStream(S: TStream);
{ Saves WAV data to stream S. }
begin
 if not Empty then
  S.Write(FData^, FDataSize);
end;

procedure TddgWaveFile.SetWaveName(const Value: TWaveFileString);
{ Write method for WaveName property. This method is in charge of }
{ setting WaveName property and loading WAV data from file Value. }
begin
 if Value <> '' then begin
  FWaveName := ExtractFileName(Value);
  { don't load from file when loading from DFM stream }
  { because DFM stream will already contain data. }
  if (not (csLoading in ComponentState)) and FileExists(Value) then
   LoadFromFile(Value);
 end
 else begin
  { If Value is an empty string, that is the signal to free }
  { memory allocated for WAV data. }
  FWaveName := '';
  if not Empty then
   FreeMem(FData, FDataSize);
  FDataSize := 0;
 end;
end;

procedure TddgWaveFile.Stop;
{ Stops currently playing WAV sound }
begin
 if Assigned(FOnStop) then FOnStop(Self); // fire event
 PlaySound(Nil, 0, SND_PURGE);
end;

procedure TddgWaveFile.WriteData(Stream: TStream);
{ Writes WAV data to DFM stream }
begin
 SaveToStream(Stream);
end;

end.
  • + Share This
  • 🔖 Save To Your Account

InformIT Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from InformIT and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites, develop new products and services, conduct educational research and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email information@informit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by InformIT. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.informit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020